cmdoptns.h

Go to the documentation of this file.

// Copyright (C) 2001 Gianni Mariani
//
// 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// As a special exception to the GNU General Public License, permission is
// granted for additional uses of the text contained in its release
// of Common C++.
//
// The exception is that, if you link the Common C++ library with other
// files to produce an executable, this does not by itself cause the
// resulting executable to be covered by the GNU General Public License.
// Your use of that executable is in no way restricted on account of
// linking the Common C++ library code into it.
//
// This exception does not however invalidate any other reasons why
// the executable file might be covered by the GNU General Public License.
//
// This exception applies only to the code released under the
// name Common C++.  If you copy code from other releases into a copy of
// Common C++, as the General Public License permits, the exception does
// not apply to the code that you add in this way.  To avoid misleading
// anyone as to the status of such modified files, you must delete
// this exception notice from them.
//
// If you write modifications of your own for Common C++, it is your choice
// whether to permit this exception to apply to your modifications.
// If you do not wish that, delete this exception notice.
//

#ifndef CCXX_CMDOPTNS_H_
#define CCXX_CMDOPTNS_H_

#ifndef CCXX_STRING_H_
#include <cc++/string.h>
#endif

#ifdef  CCXX_NAMESPACES
namespace ost {
#endif

class CommandOption;
class CommandOptionParse;

extern __EXPORT CommandOption * defaultCommandOptionList;

class __EXPORT CommandOption {
public:

        const char      * optionName;

        const char      * optionLetter;

        const char      * description;

        enum OptionType {
                hasArg,
                noArg,
                trailing,
                collect
        };

        OptionType        optionType;   // HasArg, NoArg or Trailing

        bool              required;             // Option is required - fail without it

        CommandOption   * next;
                
        virtual ~CommandOption();

        CommandOption(
                const char              * inOptionName,
                const char              * inOptionLetter,
                const char              * inDescription,
                OptionType                inOptionType,
                bool                      inRequired = false,
                CommandOption  ** ppNext = & defaultCommandOptionList
        );

        virtual void foundOption( CommandOptionParse * cop, const char * value = 0 );
        
        virtual void foundOption( CommandOptionParse * cop, const char ** value, int num );
        
        virtual void parseDone( CommandOptionParse * cop );
        
        virtual void performTask( CommandOptionParse * cop );

        virtual bool hasValue();
        
};

class __EXPORT CommandOptionWithArg : public CommandOption {
public:

        const char ** values;

        int                       numValue;

        CommandOptionWithArg(
                const char              * inOptionName,
                const char              * inOptionLetter,
                const char              * inDescription,
                OptionType                inOptionType,
                bool                      inRequired = false,
                CommandOption  ** ppNext = & defaultCommandOptionList
        );

        virtual ~CommandOptionWithArg();
        
        virtual void foundOption( CommandOptionParse * cop, const char * value = 0 );
        virtual void foundOption( CommandOptionParse * cop, const char ** value, int num );
        virtual bool hasValue();
};
        
class __EXPORT CommandOptionArg : public CommandOptionWithArg {
public:

        CommandOptionArg(
                const char              * inOptionName,
                const char              * inOptionLetter,
                const char              * inDescription,
                bool                      inRequired = false,
                CommandOption  ** ppNext = & defaultCommandOptionList
        );

        virtual ~CommandOptionArg();


};
        
class __EXPORT CommandOptionRest : public CommandOptionWithArg {
public:

        CommandOptionRest(
                const char              * inOptionName,
                const char              * inOptionLetter,
                const char              * inDescription,
                bool                      inRequired = false,
                CommandOption  ** ppNext = & defaultCommandOptionList
        );

};
        
class __EXPORT CommandOptionCollect : public CommandOptionWithArg {
public:

        CommandOptionCollect(
                const char              * inOptionName,
                const char              * inOptionLetter,
                const char              * inDescription,
                bool                      inRequired = false,
                CommandOption  ** ppNext = & defaultCommandOptionList
        );

};
        
class __EXPORT CommandOptionNoArg : public CommandOption {
public:

        int                       numSet;       // The number of times this argument is set

        CommandOptionNoArg(
                const char              * inOptionName,
                const char              * inOptionLetter,
                const char              * inDescription,
                bool                      inRequired = false,
                CommandOption  ** ppNext = & defaultCommandOptionList
        );

        virtual void foundOption( CommandOptionParse * cop, const char * value = 0 );

};

class __EXPORT CommandOptionParse {
public:

        virtual ~CommandOptionParse() = 0;

        virtual bool argsHaveError() = 0;

        virtual const char * printErrors() = 0;

        virtual const char * printUsage() = 0;

        virtual void registerError( const char * errMsg ) = 0;

        virtual void performTask() = 0;

};

__EXPORT CommandOptionParse * makeCommandOptionParse(
        int                                argc,
        char                    ** argv,
        char                     * comment,
        CommandOption    * options = defaultCommandOptionList
);

#ifdef  CCXX_NAMESPACES
}
#endif

#endif

---