ProgramDef Class Reference

#include <argsparser.h>

Inheritance diagram for ProgramDef:

Collaboration diagram for ProgramDef:

Public Member Functions
	ProgramDef ()
	~ProgramDef ()
virtual bool	parse ()
virtual void	check (std::stringstream &errors)
ParamDef *	findParam (const String &param)
ParamDef *	findAndFillParam (const String &param)
const char *	getParam (const char *paramName, size_t paramNumber=0)
const char *	getParam (const char *paramName, const char *subParam, size_t paramNumber=0)
void	addParamName (const String &name, ParamDef *param)
void	addParamRequires (const String &name)
void	addParamExclusiveGroup (ParamDef *param)
void	clear ()
	clear read arguments More...
void	read (int argc, const char **argv, bool reportErrors=true)
	Read and validate commmand line. More...
SectionDef *	addSection (String sectionName, int visibility=0)
Public Member Functions inherited from ASTNode
	ASTNode (ArgLexer *lexer=NULL, ASTNode *parent=NULL)
virtual	~ASTNode ()
virtual bool	consume (ArgTokenType type)
ArgTokenType	lookahead () const
bool	lookahead (ArgTokenType type) const
ArgToken *	currentToken () const
void	nextToken ()
bool	parseCommentList (CommentList &comments)
void	error (String msg)
void	unexpectedToken (String msg="")

Public Attributes
std::vector< SectionDef * >	sections
CommentList	usageComments
	comments of usage More...
CommentList	examples
	examples of use More...
std::map< String, ParamDef * >	paramsMap
	Dictionary with all params and alias names. More...
StringVector	pendingRequires
	This is for checking that requires names exists. More...
String	keywords
String	seeAlso
bool	singleOption
Public Attributes inherited from ASTNode
ASTNode *	parent
ArgLexer *	pLexer
ArgToken	token
String	name
int	visible

Detailed Description

Definition at line 236 of file argsparser.h.

Constructor & Destructor Documentation

ProgramDef()

ProgramDef::ProgramDef

(

)

Definition at line 810 of file argsparser.cpp.

                       :
        ASTNode()
{
    pLexer = new ArgLexer();
    singleOption = false;
    exclusiveGroup = NULL;
}

~ProgramDef()

ProgramDef::~ProgramDef

(

)

Definition at line 818 of file argsparser.cpp.

{
    delete pLexer;
    for (size_t i = 0; i < sections.size(); ++i)
        delete sections[i];
}

Member Function Documentation

addParamExclusiveGroup()

void ProgramDef::addParamExclusiveGroup

(

ParamDef *

param

)

Definition at line 925 of file argsparser.cpp.

{
    if (exclusiveGroup == NULL || param->orBefore == false)
        exclusiveGroup = new std::vector<ParamDef*>();
    exclusiveGroup->push_back(param);
    param->exclusiveGroup = exclusiveGroup;
}

addParamName()

void ProgramDef::addParamName	(	const String &	name,
		ParamDef *	param
	)

Definition at line 912 of file argsparser.cpp.

{
    if (paramsMap.find(name) != paramsMap.end())
        error((String) "The param '" + name + "' is repeated.");
    else
        paramsMap[name] = param;
}

addParamRequires()

void ProgramDef::addParamRequires

(

const String &

name

)

Definition at line 920 of file argsparser.cpp.

{
    pendingRequires.push_back(name);
}

addSection()

SectionDef * ProgramDef::addSection	(	String	sectionName,
		int	visibility = 0
	)

Add a section to the program definition and return a pointer to it, useful for manually

Definition at line 1009 of file argsparser.cpp.

{
    SectionDef * section = new SectionDef(NULL, this);
    section->name = sectionName;
    section->visible = visibility;
    sections.push_back(section);
    return section;
}

check()

void ProgramDef::check ( std::stringstream &  errors )

virtual

Implements ASTNode.

Definition at line 883 of file argsparser.cpp.

{
    std::vector<ParamDef*> exclusive;
    SectionDef * section;
    ParamDef * param;

    for (size_t i = 0; i < sections.size(); ++i)
    {
        section = sections[i];
        for (size_t j = 0; j < section->params.size(); ++j)
        {
            param = section->params[j];
            //Doesn't check for alias, for doesn't repeat error messages
            param->check(errors);
            if (!param->orBefore)
                reportExclusiveErrors(errors, exclusive);
            exclusive.push_back(param);
        }
    }
    reportExclusiveErrors(errors, exclusive);
}

clear()

void ProgramDef::clear

(

)

clear read arguments

Definition at line 933 of file argsparser.cpp.

{

    SectionDef * section;
    ParamDef * param;

    for (size_t i = 0; i < sections.size(); ++i)
    {
        section = sections[i];
        for (size_t j = 0; j < section->params.size(); ++j)
        {
            param = section->params[j];
            param->counter = 0;
            param->cmdArguments.clear();
        }
    }
}

findAndFillParam()

ParamDef * ProgramDef::findAndFillParam

(

const String &

param

)

Find a param and if not provided in cmd line, fill with its defaults values

Param was provided, not need to fill it

Definition at line 1018 of file argsparser.cpp.

{
    ParamDef * paramDef = findParam(param);
    if (paramDef == NULL)
        REPORT_ERROR(ERR_ARG_INCORRECT, formatString("Doesn't exists param: %s", param.c_str()));
    //if (paramDef->counter == 1)
    //    return paramDef;
    std::stringstream errors;
    size_t argIndex = 0;
    for (size_t i = 0; i < paramDef->arguments.size(); ++i)
        if (!paramDef->arguments[i]->acceptArguments(errors, argIndex, paramDef->cmdArguments))
        {
            errors << " parameter: " << paramDef->name << std::endl;
            REPORT_ERROR(ERR_ARG_INCORRECT, errors.str());
        }
    return paramDef;
}

findParam()

ParamDef * ProgramDef::findParam

(

const String &

param

)

Definition at line 905 of file argsparser.cpp.

{
    if (paramsMap.find(name) != paramsMap.end())
        return paramsMap[name];
    return NULL;
}

getParam() [1/2]

const char * ProgramDef::getParam	(	const char *	paramName,
		size_t	paramNumber = 0
	)

Definition at line 1037 of file argsparser.cpp.

{
    ParamDef * param = findAndFillParam(paramName);
    if (param == NULL)
        REPORT_ERROR(ERR_ARG_INCORRECT, formatString("Doesn't exists param: %s", paramName));
    if (argNumber < 0 || argNumber >= param->cmdArguments.size())
        REPORT_ERROR(ERR_ARG_INCORRECT, formatString("Argument index %d in param %s out of bounds.", argNumber, paramName));
    return param->cmdArguments.at(argNumber);
}

getParam() [2/2]

const char * ProgramDef::getParam	(	const char *	paramName,
		const char *	subParam,
		size_t	paramNumber = 0
	)

Definition at line 1047 of file argsparser.cpp.

{
    ParamDef * param = findAndFillParam(paramName);

    size_t i = 0;
    for (i = 0; i < param->cmdArguments.size(); ++i)
        if (strcmp(param->cmdArguments[i], subParam) == 0)
            break;

    if (i == param->cmdArguments.size())
        REPORT_ERROR(ERR_ARG_INCORRECT, formatString("Sub-param %s was not supplied in command line.", subParam));

    return param->cmdArguments.at(i + 1 + argNumber);
}

parse()

bool ProgramDef::parse ( )

virtual

Parse the program definition.

Implements ASTNode.

Definition at line 825 of file argsparser.cpp.

{

    // P -> ID CL OL
    //consume(TOK_ID);
    //name = token.lexeme;
    //Usage comments
    //parseCommentList(usageComments);

    //Ask for first token
    pLexer->nextToken();

    while (!lookahead(TOK_END))
    {
        SectionDef * s = new SectionDef(pLexer, this);
        s->parse();
        String name = s->name;
        sections.push_back(s);
    }
    consume(TOK_END);

    return true;
}

read()

void ProgramDef::read	(	int	argc,
		const char **	argv,
		bool	reportErrors = true
	)

Read and validate commmand line.

Definition at line 951 of file argsparser.cpp.

{
    clear();
    std::stringstream errors;
    //Set the name with the first argument
    name = argv[0];
    singleOption = false;

    ParamDef * param = NULL;

    //We assume that all options start with -
    if (argc > 1 && argv[1][0] != '-')
    {
        //Assume if the first is missing, treat as -i
        if ((param = findParam("-i")) == NULL) //-i is not allowed, report error
            REPORT_ERROR(ERR_ARG_INCORRECT, "Parameters should start with a -");
        else
        {
            ++(param->counter);
            if (param->independent)
                singleOption = true;
        }
        //Assume if the first is missing, treat as -i
    }

    //Read command line params and arguments
    for (int i = 1; i < argc; ++i)
    {

        if (argv[i][0] == '-' && !isdigit(argv[i][1]))
        {
            param = findParam(argv[i]);
            if (param == NULL)
                errors << "Unrecognized parameter: " << argv[i] << std::endl;
            else
            {
                ++(param->counter);
                if (param->independent)
                    singleOption = true;
            }
        }
        else if (param != NULL)
            param->cmdArguments.push_back(argv[i]);
    }

    if (!singleOption)
        check(errors);

    //Report errors found
    if (reportErrors && errors.str().length() > 0)
    {
        //Unrecognized parameters
        //for (size_t i = 0; i < unrecognized.size(); ++i)
        //    std::cerr << "Unrecognized parameter: " << unrecognized[i] << std::endl;
        REPORT_ERROR(ERR_ARG_BADCMDLINE, errors.str().c_str());
    }
}

Member Data Documentation

examples

CommentList ProgramDef::examples

examples of use

Definition at line 243 of file argsparser.h.

keywords

String ProgramDef::keywords

Definition at line 246 of file argsparser.h.

paramsMap

std::map<String, ParamDef*> ProgramDef::paramsMap

Dictionary with all params and alias names.

Definition at line 244 of file argsparser.h.

pendingRequires

StringVector ProgramDef::pendingRequires

This is for checking that requires names exists.

Definition at line 245 of file argsparser.h.

sections

std::vector<SectionDef*> ProgramDef::sections

Definition at line 241 of file argsparser.h.

seeAlso

String ProgramDef::seeAlso

Definition at line 247 of file argsparser.h.

singleOption

bool ProgramDef::singleOption

This flag is used to check if an independent option was found like: –more, –help that avoid others options restrictions.

Definition at line 250 of file argsparser.h.

usageComments

CommentList ProgramDef::usageComments

comments of usage

Definition at line 242 of file argsparser.h.

---

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

• xmippCore/core/argsparser.h
• xmippCore/core/argsparser.cpp