include/shell.h

/*
 *  Copyright (C) 2002-2020  The DOSBox Team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */


#ifndef DOSBOX_SHELL_H
#define DOSBOX_SHELL_H

#include <ctype.h>
#ifndef DOSBOX_DOSBOX_H
#include "dosbox.h"
#endif
#ifndef DOSBOX_PROGRAMS_H
#include "programs.h"
#endif

#include <string>
#include <list>
#include <map>

#include <SDL.h>
#if SDL_VERSION_ATLEAST(2, 0, 0)
#define SDL_STRING "SDL2"
#else
#define SDL_STRING "SDL1"
#endif

#define CMD_MAXLINE 4096
#define CMD_MAXCMDS 20
#define CMD_OLDSIZE 4096
extern Bitu call_shellstop;
class DOS_Shell;

/* first_shell is used to add and delete stuff from the shell env 
 * by "external" programs. (config) */
extern DOS_Shell * first_shell;


class BatchFile {
public:
        BatchFile(DOS_Shell * host,char const* const resolved_name,char const* const entered_name, char const * const cmd_line);
        virtual ~BatchFile();
        virtual bool ReadLine(char * line);
        bool Goto(const char * where);
        void Shift(void);
        Bit16u file_handle;
        Bit32u location;
        bool echo;
        DOS_Shell * shell;
        BatchFile * prev;
        CommandLine * cmd;
        std::string filename;
};

class AutoexecEditor;

class DOS_Shell : public Program {
private:
        friend class AutoexecEditor;
        std::list<std::string> l_history, l_completion;
    template<class _Type>
    struct less_ignore_case {
        typedef _Type first_argument_type;
        typedef _Type second_argument_type;
        typedef bool result_type;

        constexpr bool operator()(const _Type& _Left, const _Type& _Right) const {
            return strcasecmp(_Left.c_str(), _Right.c_str()) < 0;
        }
    };
    typedef std::map<std::string, std::string, less_ignore_case<std::string> > cmd_alias_map_t;
    cmd_alias_map_t cmd_alias;

        Bit16u completion_index;
        
private:
        void ProcessCmdLineEnvVarStitution(char * line);

public:

        DOS_Shell();
        virtual ~DOS_Shell();

        void Run(void);

        void RunInternal(void); //for command /C

/* A load of subfunctions */

        void ParseLine(char * line);

        Bitu GetRedirection(char *s, char **ifn, char **ofn, char **toc,bool * append);

        void InputCommand(char * line);

        void ShowPrompt();

        void DoCommand(char * line);

    bool Execute(char* name, const char* args);

        bool CheckConfig(char* cmd_in,char*line);

        char * Which(char * name);

        void CMD_HELP(char * args);

        void CMD_BREAK(char * args);

        void CMD_CLS(char * args);

        void CMD_COPY(char * args);

        void CMD_DATE(char * args);

        void CMD_TIME(char * args);

        void CMD_DIR(char * args);

        void CMD_DELETE(char * args);

        void CMD_ECHO(char * args);

        void CMD_EXIT(char * args);

        void CMD_MKDIR(char * args);

        void CMD_CHDIR(char * args);

        void CMD_RMDIR(char * args);

        void CMD_SET(char * args);

        void CMD_IF(char * args);

        void CMD_GOTO(char * args);

        void CMD_TYPE(char * args);

        void CMD_REM(char * args);

        void CMD_RENAME(char * args);

        void CMD_CALL(char * args);

        void SyntaxError(void);

        void CMD_PAUSE(char * args);

        void CMD_SUBST(char* args);

        void CMD_LOADHIGH(char* args);

        void CMD_CHOICE(char * args);

        void CMD_ATTRIB(char * args);

        void CMD_PATH(char * args);

        void CMD_SHIFT(char * args);

        void CMD_VERIFY(char * args);

        void CMD_VER(char * args);

        void CMD_ADDKEY(char * args);

        void CMD_VOL(char * args);

        void CMD_PROMPT(char * args);

        void CMD_MORE(char * args);

        void CMD_CTTY(char * args);

        void CMD_COUNTRY(char * args);
    void CMD_TRUENAME(char * args);
    void CMD_DXCAPTURE(char * args);

        void CMD_FOR(char * args);

        void CMD_LFNFOR(char * args);

        void CMD_ALIAS(char* args);

        void CMD_LS(char *args);

#if C_DEBUG

        void CMD_DEBUGBOX(char * args);

        void CMD_INT2FDBG(char * args);
#endif

        /* The shell's variables */
        Bit16u input_handle;
        BatchFile * bf;                     
        bool echo;
        bool exit;
        bool call;
        bool lfnfor;
    /* Status */
    bool input_eof;                     
};

struct SHELL_Cmd {
        const char * name;                                                              /* Command name*/
        Bit32u flags;                                                                   /* Flags about the command */
        void (DOS_Shell::*handler)(char * args);                /* Handler for this command */
        const char * help;                                                              /* String with command help */
};

/* Object to manage lines in the autoexec.bat The lines get removed from
 * the file if the object gets destroyed. The environment is updated
 * as well if the line set a a variable */
class AutoexecObject{
private:
        bool installed;
        std::string buf;
public:
        AutoexecObject():installed(false){ };
        void Install(std::string const &in);
        void InstallBefore(std::string const &in);
        void Uninstall();
        ~AutoexecObject();
private:
        void CreateAutoexec(void);
};

#endif