include/programs.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_PROGRAMS_H
#define DOSBOX_PROGRAMS_H

#ifndef DOSBOX_DOSBOX_H
#include "dosbox.h"
#endif
#ifndef DOSBOX_DOS_INC_H
#include "dos_inc.h"
#endif

#ifndef CH_LIST
#define CH_LIST
#include <list>
#endif

#ifndef CH_STRING
#define CH_STRING
#include <string>
#endif

class CommandLine {
public:
        enum opt_style {
                dos=0,          // MS-DOS style /switches
                gnu,            // GNU style --switches or -switches, switch parsing stops at --
                gnu_getopt,     // GNU style --long or -a -b -c -d or -abcd (short as single char), switch parsing stops at --
                either,         // Both DOS and GNU styles, switch parsing stops at --
                either_except   // Both DOS and GNU styles, except for paths to executables
        };
public:
        CommandLine(int argc,char const * const argv[],enum opt_style opt=CommandLine::either);
        CommandLine(char const * const name,char const * const cmdline,enum opt_style opt=CommandLine::either);
        const char * GetFileName(){ return file_name.c_str();}

        bool FindExist(char const * const name,bool remove=false);
        bool FindHex(char const * const name,int & value,bool remove=false);
        bool FindInt(char const * const name,int & value,bool remove=false);
        bool FindString(char const * const name,std::string & value,bool remove=false);
        bool FindCommand(unsigned int which,std::string & value);
        bool FindStringBegin(char const * const begin,std::string & value, bool remove=false);
        bool FindStringRemain(char const * const name,std::string & value);
        bool FindStringRemainBegin(char const * const name,std::string & value);
        bool GetStringRemain(std::string & value);
        int GetParameterFromList(const char* const params[], std::vector<std::string> & output);
        void FillVector(std::vector<std::string> & vector);
        unsigned int GetCount(void);
        void Shift(unsigned int amount=1);
        Bit16u Get_arglength();

        bool BeginOpt(bool eat_argv=true);
        bool GetOpt(std::string &name);
        bool NextOptArgv(std::string &argv);
        bool GetOptGNUSingleCharCheck(std::string &name);
        void ChangeOptStyle(enum opt_style opt_style);
        void EndOpt();

    bool GetCurrentArgv(std::string &argv);
    bool CurrentArgvEnd(void);
    void EatCurrentArgv(void);
    void NextArgv(void);

    const std::string &GetRawCmdline(void);
private:
        typedef std::list<std::string>::iterator cmd_it;
        std::string opt_gnu_getopt_singlechar;          /* non-empty if we hit GNU options like -abcd => -a -b -c -d */
        cmd_it opt_scan;
        bool opt_eat_argv = false;
        std::list<std::string> cmds;
        std::string file_name;
    std::string raw_cmdline;
        enum opt_style opt_style;
        bool FindEntry(char const * const name,cmd_it & it,bool neednext=false);
};

class Program {
public:
        Program();                                          
        virtual ~Program(){                                 
                if (cmd != NULL) delete cmd;
                if (psp != NULL) delete psp;
        }

        unsigned char exit_status;                          

        std::string temp_line;                              
        CommandLine * cmd;                                  
        DOS_PSP * psp;                                      
        virtual void Run(void)=0;                           
        bool GetEnvStr(const char * entry,std::string & result); 
        bool GetEnvNum(Bitu want_num,std::string & result);      
        Bitu GetEnvCount(void);                             
        bool SetEnv(const char * entry,const char * new_string); 
        void WriteOut(const char * format,...);                         
        void WriteOut_NoParsing(const char * format);           
        void ChangeToLongCmd();                             
        void DebugDumpEnv();                                
        void WriteExitStatus();                             
};

typedef void (PROGRAMS_Main)(Program * * make);
void PROGRAMS_MakeFile(char const * const name,PROGRAMS_Main * SDL_main);

#endif