ConsolePrinter Class Reference

#include <argsprinter.h>

Inheritance diagram for ConsolePrinter:

Collaboration diagram for ConsolePrinter:

Public Member Functions
	ConsolePrinter (std::ostream &out=std::cout, bool color=true)
virtual void	printProgram (const ProgramDef &program, int v=0)
virtual void	printSection (const SectionDef &section, int v=0)
virtual void	printParam (const ParamDef &param, int v=0)
virtual void	printArgument (const ArgumentDef &argument, int v=0)
virtual void	printCommentList (const CommentList &comments, int v=0)
Public Member Functions inherited from Printer
virtual	~Printer ()
virtual void	printToken (ArgToken *token)

Public Attributes
bool	color

Protected Member Functions
void	printRequiresList (StringVector requires)

Protected Attributes
std::ostream *	pOut

Detailed Description

Just print to out stream

Definition at line 52 of file argsprinter.h.

Constructor & Destructor Documentation

ConsolePrinter()

ConsolePrinter::ConsolePrinter	(	std::ostream &	out = std::cout,
		bool	color = true
	)

Constructor

Definition at line 44 of file argsprinter.cpp.

{
    this->pOut = &out;
    this->color = color;
}

Member Function Documentation

printArgument()

void ConsolePrinter::printArgument ( const ArgumentDef &  argument, int  v = 0  )

virtual

Implements Printer.

Definition at line 170 of file argsprinter.cpp.

{
    *pOut << "<" << argument.name;
    if (argument.hasDefault)
        *pOut << "=" << argument.argDefault;
    *pOut << ">";
}

printCommentList()

void ConsolePrinter::printCommentList ( const CommentList &  comments, int  v = 0  )

virtual

Implements Printer.

Definition at line 178 of file argsprinter.cpp.

{
    for (size_t i = 0; i < comments.size(); ++i)
        if (comments.visibility[i] <= v)
            *pOut << "          " << comments.comments[i] << std::endl;
}

printParam()

void ConsolePrinter::printParam ( const ParamDef &  param, int  v = 0  )

virtual

Implements Printer.

Definition at line 114 of file argsprinter.cpp.

{
    if (param.visible <= v)
    {
        if (param.orBefore)
            *pOut << "   OR" << std::endl;

        *pOut << "   ";
        int pColor = BLUE;
        if (!param.notOptional)
        {
            *pOut << "[";
            pColor = GREEN;
        }
        *pOut << COLOR(param.name.c_str(), pColor);
        //print alias
        for (size_t i = 0; i < param.aliases.size(); ++i)
            *pOut << ", " << param.aliases[i];
        //print arguments
        for (size_t i = 0; i < param.arguments.size(); ++i)
        {
            *pOut << " ";
            printArgument(*param.arguments[i], v);
        }
        if (!param.notOptional)
            *pOut << "]";

        printRequiresList(param.requires);
        *pOut << std::endl;
        printCommentList(param.comments, v);

        for (size_t i = 0; i < param.arguments.size(); ++i)
        {
            ArgumentDef &arg = *param.arguments[i];
            if (!arg.subParams.empty())
            {
                *pOut << "      where <" << arg.name << "> can be:" << std::endl;
                for (size_t j = 0; j < arg.subParams.size(); ++j)
                {
                    *pOut << "        " << arg.subParams[j]->name;
                    for (size_t k = 0; k < arg.subParams[j]->arguments.size(); ++k)
                    {
                        *pOut << " ";
                        printArgument(*(arg.subParams[j]->arguments[k]));
                    }
                    printRequiresList(arg.subParams[j]->requires);
                    *pOut << std::endl;
                    printCommentList(arg.subParams[j]->comments, v);

                }
            }
        }

    }
}

printProgram()

void ConsolePrinter::printProgram ( const ProgramDef &  program, int  v = 0  )

virtual

Implements Printer.

Definition at line 50 of file argsprinter.cpp.

{
    //print program name and usage
    *pOut << COLOR("PROGRAM", RED) << std::endl << "   " << program.name << std::endl;
    if (program.usageComments.size() > 0)
    {
        *pOut << COLOR("USAGE", RED) << std::endl;
        for (size_t i = 0; i < program.usageComments.size(); ++i)
            if (program.usageComments.visibility[i] <= v)
                *pOut << "   " << program.usageComments.comments[i] << std::endl;
    }
    //print see also
    if (!program.seeAlso.empty())
    {
        *pOut << COLOR("SEE ALSO", RED) << std::endl;
        *pOut << "   " << program.seeAlso << std::endl;
    }

    //print sections and params
    if (program.sections.size() > 0)
    {
        *pOut << COLOR("OPTIONS", RED) << std::endl;
        for (size_t i = 0; i < program.sections.size(); ++i)
            printSection(*program.sections[i], v);
    }
    //print examples
    if (program.examples.size() > 0)
    {
        *pOut << COLOR("EXAMPLES", RED) << std::endl;
        for (size_t i = 0; i < program.examples.size(); ++i)
            if (program.examples.visibility[i] <= v)
            {
                if (program.examples.wikiVerbatim[i])
                    *pOut << "      " << COLOR(program.examples.comments[i].c_str(), BLUE) << std::endl;
                else
                    *pOut << "   " << program.examples.comments[i] << std::endl;
            }

    }
}

printRequiresList()

void ConsolePrinter::printRequiresList ( StringVector  requires )

protected

Definition at line 103 of file argsprinter.cpp.

{
    if (!requires.empty())
    {
        *pOut << " ( requires ";
        for (size_t i = 0; i < requires.size(); ++i)
            *pOut << requires[i] << " ";
        *pOut << ")";
    }
}

printSection()

void ConsolePrinter::printSection ( const SectionDef &  section, int  v = 0  )

virtual

Implements Printer.

Definition at line 91 of file argsprinter.cpp.

{
    if (section.visible <= v)
    {
        *pOut << std::endl;
        if (section.name.length() > 0)
            *pOut << COLOR(section.name.c_str(), RED) << std::endl;
        for (size_t i = 0; i < section.params.size(); ++i)
            printParam(*section.params[i], v);
    }
}

Member Data Documentation

color

bool ConsolePrinter::color

Definition at line 58 of file argsprinter.h.

pOut

std::ostream* ConsolePrinter::pOut

protected

Definition at line 55 of file argsprinter.h.

---

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

• xmippCore/core/argsprinter.h
• xmippCore/core/argsprinter.cpp