---

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_CONFIG_H__
#include <cc++/config.h>
#endif

#ifdef  __NAMESPACES__
namespace ost {
#endif

#ifdef HAVE_GETOPT_LONG

class CommandOption;
class CommandOptionParse;

extern CommandOption * DefaultCommandOptionList;

class CommandOption {
public:

        const char      * option_name;
        
        const char      * option_letter;

        const char      * description;

        enum OptionType {
                HasArg,
                NoArg,
                Trailing,
                Collect
        };

        OptionType        option_type;  // HasArg, NoArg or Trailing

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

        CommandOption   * next;
                
        virtual ~CommandOption();

        CommandOption(
                const char              * in_option_name,
                const char              * in_option_letter,
                const char              * in_description,
                OptionType                in_option_type,
                bool                      in_required = false,
                CommandOption  ** pp_next = & 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 CommandOptionWithArg : public CommandOption {
public:

        const char ** values;

        int                       numvalue;

        CommandOptionWithArg(
                const char              * in_option_name,
                const char              * in_option_letter,
                const char              * in_description,
                OptionType                in_option_type,
                bool                      in_required = false,
                CommandOption  ** pp_next = & 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 CommandOptionArg : public CommandOptionWithArg {
public:

        CommandOptionArg(
                const char              * in_option_name,
                const char              * in_option_letter,
                const char              * in_description,
                bool                      in_required = false,
                CommandOption  ** pp_next = & DefaultCommandOptionList
        );

        virtual ~CommandOptionArg();
        

};
        
class CommandOptionRest : public CommandOptionWithArg {
public:

        CommandOptionRest(
                const char              * in_option_name,
                const char              * in_option_letter,
                const char              * in_description,
                bool                      in_required = false,
                CommandOption  ** pp_next = & DefaultCommandOptionList
        );

};
        
class CommandOptionCollect : public CommandOptionWithArg {
public:

        CommandOptionCollect(
                const char              * in_option_name,
                const char              * in_option_letter,
                const char              * in_description,
                bool                      in_required = false,
                CommandOption  ** pp_next = & DefaultCommandOptionList
        );

};
        
class CommandOptionNoArg : public CommandOption {
public:

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

        CommandOptionNoArg(
                const char              * in_option_name,
                const char              * in_option_letter,
                const char              * in_description,
                bool                      in_required = false,
                CommandOption  ** pp_next = & DefaultCommandOptionList
        );

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

};

class CommandOptionParse {
public:

        virtual ~CommandOptionParse() = 0;

        virtual bool ArgsHaveError() = 0;

        virtual const char * PrintErrors() = 0;

        virtual const char * PrintUsage() = 0;

        virtual void RegisterError( const char * err_msg ) = 0;

        virtual void PerformTask() = 0;

};

CommandOptionParse * MakeCommandOptionParse(
        int                                argc,
        char                    ** argv,
        char                     * comment,
        CommandOption    * options = DefaultCommandOptionList
);
#endif

#ifdef  __NAMESPACES__
};
#endif

#endif

---