BaseLib::TCLAPCustomOutput Class Reference

Detailed Description

TCLAP standard output modified as follows

• Print arguments in the order of added to Command object

Definition at line 30 of file TCLAPCustomOutput.h.

#include <TCLAPCustomOutput.h>

Inheritance diagram for BaseLib::TCLAPCustomOutput:

Collaboration diagram for BaseLib::TCLAPCustomOutput:

Public Member Functions
virtual void	usage (TCLAP::CmdLineInterface &cmd_)
virtual void	failure (TCLAP::CmdLineInterface &cmd_, TCLAP::ArgException &e)

Protected Member Functions
void	shortUsage_ (TCLAP::CmdLineInterface &cmd_, std::ostream &os) const
void	longUsage_ (TCLAP::CmdLineInterface &cmd_, std::ostream &os) const

Member Function Documentation

failure()

void BaseLib::TCLAPCustomOutput::failure ( TCLAP::CmdLineInterface &  cmd_, TCLAP::ArgException &  e  )

inlinevirtual

Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior.

Parameters

cmd_	- The CmdLine object the output is generated for.
e	- The ArgException that caused the failure.

Definition at line 78 of file TCLAPCustomOutput.h.

{
    std::string progName = cmd_.getProgramName();
 
    std::cerr << "PARSE ERROR: " << e.argId() << std::endl
              << "             " << e.error() << std::endl
              << std::endl;
 
    if (cmd_.hasHelpAndVersion())
    {
        std::cerr << "Brief USAGE: " << std::endl;
 
        shortUsage_(cmd_, std::cerr);
 
        std::cerr << std::endl
                  << "For complete USAGE and HELP type: " << std::endl
                  << "   " << progName << " --help" << std::endl
                  << std::endl;
    }
    else
    {
        usage(cmd_);
    }
 
    throw TCLAP::ExitException(1);
}

References shortUsage_(), and usage().

longUsage_()

void BaseLib::TCLAPCustomOutput::longUsage_ ( TCLAP::CmdLineInterface &  cmd_, std::ostream &  os  ) const

inlineprotected

Writes a longer usage message with long and short args, provides descriptions and prints message.

Parameters

cmd_	- The CmdLine object the output is generated for.
os	- The stream to write the message to.

Definition at line 149 of file TCLAPCustomOutput.h.

{
    std::list<TCLAP::Arg*> argList = cmd_.getArgList();
    std::string message = cmd_.getMessage();
    TCLAP::XorHandler xorHandler = cmd_.getXorHandler();
    std::vector<std::vector<TCLAP::Arg*>> xorList = xorHandler.getXorList();
 
    // first the xor
    for (int i = 0; static_cast<unsigned int>(i) < xorList.size(); i++)
    {
        for (TCLAP::ArgVectorIterator it = xorList[i].begin();
             it != xorList[i].end();
             it++)
        {
            this->spacePrint(os, (*it)->longID(), 75, 3, 3);
            spacePrint(os, (*it)->getDescription(), 75, 5, 0);
 
            if (it + 1 != xorList[i].end())
            {
                spacePrint(os, "-- OR --", 75, 9, 0);
            }
        }
        os << std::endl << std::endl;
    }
 
    // then the rest
    for (auto it = argList.rbegin(); it != argList.rend(); it++)
    {  // here modified
        if (!xorHandler.contains((*it)))
        {
            spacePrint(os, (*it)->longID(), 75, 3, 3);
            spacePrint(os, (*it)->getDescription(), 75, 5, 0);
            os << std::endl;
        }
    }
 
    os << std::endl;
 
    spacePrint(os, message, 75, 3, 0);
}

Referenced by usage().

shortUsage_()

void BaseLib::TCLAPCustomOutput::shortUsage_ ( TCLAP::CmdLineInterface &  cmd_, std::ostream &  os  ) const

inlineprotected

Writes a brief usage message with short args.

Parameters

cmd_	- The CmdLine object the output is generated for.
os	- The stream to write the message to.

Definition at line 106 of file TCLAPCustomOutput.h.

{
    std::list<TCLAP::Arg*> argList = cmd_.getArgList();
    std::string progName = cmd_.getProgramName();
    TCLAP::XorHandler xorHandler = cmd_.getXorHandler();
    std::vector<std::vector<TCLAP::Arg*>> xorList = xorHandler.getXorList();
 
    std::string s = progName + " ";
 
    // first the xor
    for (int i = 0; static_cast<unsigned int>(i) < xorList.size(); i++)
    {
        s += " {";
        for (TCLAP::ArgVectorIterator it = xorList[i].begin();
             it != xorList[i].end();
             it++)
        {
            s += (*it)->shortID() + "|";
        }
 
        s[s.length() - 1] = '}';
    }
 
    // then the rest
    for (auto it = argList.rbegin(); it != argList.rend(); ++it)
    {  // here modified
        if (!xorHandler.contains((*it)))
        {
            s += " " + (*it)->shortID();
        }
    }
 
    // if the program name is too long, then adjust the second line offset
    int secondLineOffset = static_cast<int>(progName.length()) + 2;
    if (secondLineOffset > 75 / 2)
    {
        secondLineOffset = static_cast<int>(75 / 2);
    }
 
    spacePrint(os, s, 75, 3, secondLineOffset);
}

Referenced by failure(), and usage().

usage()

void BaseLib::TCLAPCustomOutput::usage ( TCLAP::CmdLineInterface &  cmd_ )

inlinevirtual

Prints the usage to stdout. Can be overridden to produce alternative behavior.

Parameters

cmd_	- The CmdLine object the output is generated for.

Definition at line 65 of file TCLAPCustomOutput.h.

{
    std::cout << std::endl << "USAGE: " << std::endl << std::endl;
 
    shortUsage_(cmd_, std::cout);
 
    std::cout << std::endl << std::endl << "Where: " << std::endl << std::endl;
 
    longUsage_(cmd_, std::cout);
 
    std::cout << std::endl;
}

References longUsage_(), and shortUsage_().

Referenced by failure().

---

The documentation for this class was generated from the following file:

• BaseLib/TCLAPCustomOutput.h