CmdLineInterface.h

Go to the documentation of this file.

// -*- Mode: c++; c-basic-offset: 4; tab-width: 4; -*-


/****************************************************************************** 
 * 
 *  file:  CmdLineInterface.h
 * 
 *  Copyright (c) 2003, Michael E. Smoot .
 *  Copyright (c) 2004, Michael E. Smoot, Daniel Aarno.
 *  Copyright (c) 2017, Google LLC
 *  All rights reserved.
 *
 *  See the file COPYING in the top directory of this distribution for
 *  more information.
 *  
 *  THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS 
 *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
 *  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 *  DEALINGS IN THE SOFTWARE.  
 *  
 *****************************************************************************/ 

#ifndef TCLAP_COMMANDLINE_INTERFACE_H
#define TCLAP_COMMANDLINE_INTERFACE_H

#include <string>
#include <vector>
#include <list>
#include <iostream>
#include <algorithm>


namespace TCLAP {
     
class Arg;
class CmdLineOutput;
class XorHandler;

class CmdLineInterface
{
    public:

        virtual ~CmdLineInterface() {}

        virtual void add( Arg& a )=0;

        virtual void add( Arg* a )=0;

        virtual void xorAdd( Arg& a, Arg& b )=0;

        virtual void xorAdd( const std::vector<Arg*>& xors )=0;

        virtual void parse(int argc, const char * const * argv)=0;

        void parse(std::vector<std::string>& args);

        virtual CmdLineOutput* getOutput()=0;

        virtual void setOutput(CmdLineOutput* co)=0;

        virtual std::string& getVersion()=0;

        virtual std::string& getProgramName()=0;

        virtual std::list<Arg*>& getArgList()=0;

        virtual XorHandler& getXorHandler()=0;

        virtual char getDelimiter()=0;

        virtual std::string& getMessage()=0;

        virtual bool hasHelpAndVersion()=0;

        virtual void reset()=0;
};

} //namespace


#endif