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_CMD_LINE_INTERFACE_H
#define TCLAP_CMD_LINE_INTERFACE_H
 
#include <tclap/ArgContainer.h>
 
#include <algorithm>
#include <iostream>
#include <list>
#include <string>
#include <vector>
 
namespace TCLAP {
 
class Arg;
class ArgGroup;
class CmdLineOutput;
 
class CmdLineInterface : public ArgContainer {
    friend class ArgGroup;
protected:
    // Return true when the implementation handles the whole attachment.
    // The default lets ArgGroup keep the legacy custom-parser path.
    virtual bool attachGroup(ArgGroup &) { return false; }
 
public:
    virtual ~CmdLineInterface() {}
 
    virtual ArgContainer &add(Arg &a) = 0;
 
    virtual ArgContainer &add(Arg *a) = 0;
 
    // TODO: Rename this to something smarter or refactor this logic so
    // it's not needed.
    // Internal - do not use
    virtual void addToArgList(Arg *a) = 0;
 
    virtual ArgContainer &add(ArgGroup &args) = 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 void setOutput(CmdLineOutput *co) = 0;
 
    virtual std::string getVersion() const = 0;
 
    virtual std::string getProgramName() const = 0;
 
    virtual std::list<ArgGroup *> getArgGroups() = 0;
    virtual std::list<Arg *> getArgList() const = 0;  // TODO: get rid of this
 
    virtual char getDelimiter() const = 0;
 
    virtual std::string getMessage() const = 0;
 
    virtual std::string translateMessage(const std::string &messageId,
                                         const std::string &fallback) const = 0;
 
    virtual bool hasHelpAndVersion() const = 0;
 
    virtual void reset() = 0;
 
    virtual void beginIgnoring() = 0;
 
    virtual bool ignoreRest() = 0;
};
 
}  // namespace TCLAP
 
#endif  // TCLAP_CMD_LINE_INTERFACE_H