OptionParser.h

Go to the documentation of this file.

/***************************************
        Auteur : Pierre Aubert
        Mail : pierre.aubert@lapp.in2p3.fr
        Licence : CeCILL-C
****************************************/
 
#ifndef __POPTIONPARSER_H__
#define __POPTIONPARSER_H__
 
#include "OptionMode.h"
 
 
class OptionParser{
        public:
                OptionParser(bool enableHelpOption = true, const PString & programVersion = "");
                OptionParser(const OptionParser & other);
                virtual ~OptionParser();
                OptionParser & operator = (const OptionParser & other);
                
                void setExampleLongOption(const PString & example);
                void setExampleShortOption(const PString & example);
                
                void addMode(const PString & modeName);
                void closeMode();
                
                void addOption(const PString & longOption, const PString & shortOption, OptionType::OptionType optionType,
                                bool isRequired, const PString & docString);
                void addOption(const PString & longOption, const PString & shortOption, OptionType::OptionType optionType,
                                bool isRequired, bool isAllowEmpty, const PString & docString);
                void addOption(const PString & longOption, const PString & shortOption, OptionType::OptionType optionType,
                                bool isRequired, bool isAllowEmpty, const PVecString & vecPossibleValue, const PString & docString);
                
                template<typename T>
                void addOption(const PString & longOption, const PString & shortOption, const T defaultValue, const PString & docString);
                
                template<typename T>
                void addOption(const PString & longOption, const PString & shortOption, const T defaultValue,
                                OptionType::OptionType optionType, const PString & docString);
                
                void print() const;
                void parseArgument(int argc, char** argv);
                
                const OptionMode & getDefaultMode() const;
                OptionMode & getDefaultMode();
                
                const OptionMode & getMode(const PString & name) const;
                OptionMode & getMode(const PString & name);
                
                bool isModeExist(const PString & name) const;
                
        protected:
                void copyOptionParser(const OptionParser & other);
                
        private:
                void initialisationOptionParser();
                void parseArgumentNormalUse(ArgParser & parser);
                void parseArgumentBashCompletion(ArgParser & parser);
                bool checkArgument() const;
                
                template<typename T>
                void checkOptionType(OptionType::OptionType optionType);
                
                OptionMode & getParserMode(ArgParser & parser);
                const OptionMode * getCurrentlyParsedMode() const;
                
                bool completeOptionValue(PString & possibleValue, const PString & cursorOption, const PString & prevCursorOption) const;
                const Option * getLongOptionValue(PString & valueToBeCompleted, const PString & cursorOption) const;
                const Option * getSplitOptionValue(PString & valueToBeCompleted, const PString & cursorOption, const PString & prevCursorOption) const;
                
                void getPossibleOption(PString & possibleOption, const PString & cursorOption) const;
                void getPossibleOtherOption(PString & possibleOption, const PString & cursorOption) const;
                
                OptionMode* p_currentParserMode;
                VecMode p_vecMode;
                size_t p_currentMode;
                PString p_exempleLongOption;
                PString p_exempleShortOption;
                bool p_enableHelpOption;
                PString p_programVersion;
};
 
#include "OptionParser_impl.h"
 
#endif