WikiPrinter Class Reference

#include <argsprinter.h>

Inheritance diagram for WikiPrinter:

Collaboration diagram for WikiPrinter:

Public Member Functions
	WikiPrinter (std::ostream &out=std::cout)
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)

Protected Member Functions
void	printRequiresList (StringVector requires)

Protected Attributes
std::ostream *	pOut

Detailed Description

Print wiki text

Definition at line 87 of file argsprinter.h.

Constructor & Destructor Documentation

WikiPrinter()

WikiPrinter::WikiPrinter

(

std::ostream &

out = std::cout

)

Constructor

Definition at line 305 of file argsprinter.cpp.

{
    this->pOut = &out;
}

Member Function Documentation

printArgument()

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

virtual

Implements Printer.

Definition at line 457 of file argsprinter.cpp.

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

printCommentList()

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

virtual

Implements Printer.

Definition at line 465 of file argsprinter.cpp.

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

printParam()

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

virtual

Implements Printer.

Definition at line 400 of file argsprinter.cpp.

{
    //* =%BLUE%-i [selfile] %ENDCOLOR%= This file contains all the images that are to build the 3D reconstruction
    //* =%GREEN% -o [output file root name] %ENDCOLOR%= If you don't supply this parameter, the same as the input selection one is taken without extension. If you give, for instance, =-o art0001= the following files are created:
    if (param.visible <= v)
    {
        *pOut << "   $";

        if (param.orBefore)
            *pOut << " or";

        String color = param.notOptional ? "BLUE" : "GREEN";

        *pOut << " =%" << color << "%" << param.name;
        //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);
        }
        *pOut << " %ENDCOLOR%=";
        printRequiresList(param.requires);
        *pOut <<": " ;
        printCommentList(param.comments, v);

        if (param.comments.size() == 0)
            *pOut << "%BR%" << std::endl;

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

                }
            }
        }

    }
}

printProgram()

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

virtual

Implements Printer.

Definition at line 310 of file argsprinter.cpp.

{
    //print program name and usage
    *pOut << "---+ !!" << program.name << " (v" << XMIPP_MAJOR <<"." << XMIPP_MINOR << ")" << std::endl;
    *pOut << "%TOC%" << std::endl;
    //print usage
    if (program.usageComments.size() > 0)
    {
        *pOut << "---++ Usage" << std::endl;
        for (size_t i = 0; i < program.usageComments.size(); ++i)
            if (program.usageComments.wikiVerbatim[i])
                *pOut << "   <pre>" << program.usageComments.comments[i] << "</pre>\n";
            else
                *pOut << "   " << program.usageComments.comments[i] << std::endl;
    }
    if (!program.seeAlso.empty())
    {
        *pOut << std::endl << "*See also* %BR%" << std::endl;
        StringVector links;
        splitString(program.seeAlso, ",", links);
        for (size_t i = 0; i < links.size(); ++i)
            *pOut << "[[" << links[i] << "_v" << XMIPP_MAJOR << "][" << links[i] <<"]]  ";
        *pOut << "%BR%" << std::endl;
    }
    //print sections and params
    if (program.sections.size() > 0)
    {
        *pOut << std::endl << "*Parameters*" << 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 << "---++ Examples and notes" << std::endl;
        bool verbatim = false;
        for (size_t i = 0; i < program.examples.size(); ++i)
        {
            if (program.examples.wikiVerbatim[i])
            {
                if (!verbatim)
                {
                    *pOut << "<pre>" << std::endl;
                    verbatim = true;
                }
            }
            else
            {
                if (verbatim)
                {
                    *pOut << "</pre>" << std::endl;
                    verbatim = false;
                }
            }
            *pOut << program.examples.comments[i] << std::endl;
        }
        if (verbatim)
            *pOut << "</pre>" << std::endl;
    }
    //print user comments
    *pOut << "---++ User's comments" << std::endl;
    *pOut << "%COMMENT{type=\"tableappend\"}%" << std::endl;
}

printRequiresList()

void WikiPrinter::printRequiresList ( StringVector  requires )

protected

Definition at line 389 of file argsprinter.cpp.

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

printSection()

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

virtual

Implements Printer.

Definition at line 374 of file argsprinter.cpp.

{
    if (section.name != " Common options "
        && section.visible <= v)
    {
        *pOut << std::endl;
        String name = section.name;
        trim(name);
        if (name.length() > 0)
            *pOut << "_" << name << "_" << std::endl;
        for (size_t i = 0; i < section.params.size(); ++i)
            printParam(*section.params[i], v);
    }
}

Member Data Documentation

pOut

std::ostream* WikiPrinter::pOut

protected

Definition at line 90 of file argsprinter.h.

---

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

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