commandline.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_MAIN_COMMAND_LINE_H
#define G_MAIN_COMMAND_LINE_H

#include "gdef.h"
#include "gsmtp.h"
#include "garg.h"
#include "configuration.h"
#include "output.h"
#include "gstrings.h"
#include <string>

namespace Main
{
        class CommandLine ;
        class CommandLineImp ;
}

class Main::CommandLine 
{
public: 
        static std::string switchSpec( bool is_windows ) ;

        CommandLine( Main::Output & output , const G::Arg & arg , const std::string & spec , 
                const std::string & version , const std::string & capabilities ) ;

        ~CommandLine() ;

        Configuration cfg() const ;

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

        bool contains( const char * switch_ ) const ;

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

        std::string value( const char * switch_ ) const ;

        unsigned int value( const std::string & switch_ , unsigned int default_ ) const ;

        unsigned int value( const char * switch_ , unsigned int default_ ) const ;

        G::Strings value( const std::string & switch_ , const std::string & separators ) const ;

        G::Strings value( const char * switch_ , const char * separators ) const ;

        G::Arg::size_type argc() const ;

        bool hasUsageErrors() const ;

        bool hasSemanticError() const ;

        void showHelp( bool error_stream = false ) const ;

        void showUsageErrors( bool error_stream = true ) const ;

        void showSemanticError( bool error_stream = true ) const ;

        void logSemanticWarnings() const ;

        void showArgcError( bool error_stream = true ) const ;

        void showNoop( bool error_stream = false ) const ;

        void showError( const std::string & reason , bool error_stream = true ) const ;

        void showVersion( bool error_stream = false ) const ;

        void showBanner( bool error_stream = false , const std::string & = std::string() ) const ;

        void showCopyright( bool error_stream = false , const std::string & = std::string() ) const ;

        void showCapabilities( bool error_stream = false , const std::string & = std::string() ) const ;

private:
        CommandLine( const CommandLine & ) ; // not implemented
        void operator=( const CommandLine & ) ; // not implemented

private:
        CommandLineImp * m_imp ;
} ;

#endif