ggetopt.h

Go to the documentation of this file.

//
// Copyright (C) 2001-2013 Graeme Walker <graeme_walker@users.sourceforge.net>
// 
// 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 3 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, see <http://www.gnu.org/licenses/>.
// ===

#ifndef G_GETOPT_H
#define G_GETOPT_H

#include "gdef.h"
#include "garg.h"
#include "gstrings.h"
#include "gexception.h"
#include <string>
#include <list>
#include <map>

namespace G
{
        class GetOpt ;
}

class G::GetOpt 
{
public:
        struct Level 
                { unsigned int level ; explicit Level(unsigned int l) : level(l) {} } ;
        G_EXCEPTION( InvalidSpecification , "invalid options specification string" ) ;
        typedef std::string::size_type size_type ;
        struct SwitchSpec 
        { 
                char c ; 
                std::string name ; 
                std::string description ; 
                std::string description_extra ; 
                bool valued ; 
                bool hidden ;
                std::string value_description ;
                unsigned int level ;
                SwitchSpec( char c_ , const std::string & name_ , 
                        const std::string & description_ ,
                        const std::string & description_extra_ ,
                        bool v_ , const std::string & vd_ , unsigned int level_ ) :
                                c(c_) , name(name_) , description(description_) , 
                                description_extra(description_extra_) ,
                                valued(v_) , hidden(description_.empty()||level_==0U) ,
                                value_description(vd_) , level(level_) {}
        } ;

        GetOpt( const Arg & arg , const std::string & spec , 
                char sep_major = '|' , char sep_minor = '/' , char escape = '\\' ) ;

        Arg args() const ;

        Strings errorList() const ;

        static size_type wrapDefault() ;

        static size_type tabDefault() ;

        static Level levelDefault() ;

        static std::string introducerDefault() ;

        std::string usageSummary( const std::string & exe , const std::string & args , 
                const std::string & introducer = introducerDefault() ,
                Level level = levelDefault() , size_type wrap_width = wrapDefault() ) const ;

        std::string usageSummarySwitches( Level level = levelDefault() ) const ;

        std::string usageHelp( Level level = levelDefault() ,
                size_type tab_stop = tabDefault() , size_type wrap_width = wrapDefault() ,
                bool level_exact = false , bool extra = true ) const ;

        void showUsage( std::ostream & stream , const std::string & exe , 
                const std::string & args , const std::string & introducer = introducerDefault() ,
                Level level = levelDefault() , size_type tab_stop = tabDefault() , 
                size_type wrap_width = wrapDefault() , bool extra = true ) const ;

        void showUsage( std::ostream & stream , const std::string & args , bool verbose ) const ;

        bool hasErrors() const ;

        void showErrors( std::ostream & stream , std::string prefix_1 , 
                std::string prefix_2 = std::string(": ") ) const ;

        void showErrors( std::ostream & stream ) const ;

        void show( std::ostream & stream , std::string prefix ) const ;

        bool contains( char switch_letter ) const ;

        bool contains( const std::string & switch_name ) const ;

        std::string value( const std::string & switch_name ) const ;

        std::string value( char switch_letter ) const ;

private:
        typedef std::map<std::string,SwitchSpec> SwitchSpecMap ;
        typedef std::pair<bool,std::string> Value ;
        typedef std::map<char,Value> SwitchMap ;

        void operator=( const GetOpt & ) ;
        GetOpt( const GetOpt & ) ;
        void parseSpec( const std::string & spec , char , char , char ) ;
        void addSpec( const std::string & , char c , const std::string & , 
                const std::string & , const std::string & , bool , 
                const std::string & , unsigned int ) ;
        size_type parseArgs( const Arg & args_in ) ;
        bool isOldSwitch( const std::string & arg ) const ;
        bool isNewSwitch( const std::string & arg ) const ;
        bool isSwitchSet( const std::string & arg ) const ;
        void processSwitch( char c ) ;
        void processSwitch( char c , const std::string & value ) ;
        void processSwitch( const std::string & s ) ;
        void processSwitch( const std::string & s , const std::string & value ) ;
        bool valued( char c ) const ;
        bool valued( const std::string & ) const ;
        void errorNoValue( char c ) ;
        void errorNoValue( const std::string & ) ;
        void errorUnknownSwitch( char c ) ;
        void errorUnknownSwitch( const std::string & ) ;
        char key( const std::string & s ) const ;
        void remove( size_type n ) ;
        bool valid( const std::string & ) const ;
        bool valid( char c ) const ;
        std::string usageSummaryPartOne( Level ) const ;
        std::string usageSummaryPartTwo( Level ) const ;
        std::string usageHelpCore( const std::string & , Level , size_type , 
                size_type , bool , bool ) const ;
        static size_type widthLimit( size_type ) ;
        static bool visible( SwitchSpecMap::const_iterator , Level , bool ) ;
        static size_type eqPos( const std::string & ) ;
        static std::string eqValue( const std::string & , size_type ) ;

private:
        SwitchSpecMap m_spec_map ;
        SwitchMap m_map ;
        Strings m_errors ;
        Arg m_args ;
} ;

#endif