HeaderParser Class Reference

Parse the configuration a create the vector of sources. More...

#include <HeaderParser.h>

Inheritance diagram for HeaderParser:

Collaboration diagram for HeaderParser:

Public Member Functions
const PVecSource &	getVecSource () const
	Get the parsed vector of PSource.
	HeaderParser ()
	Default constructor of HeaderParser.
	HeaderParser (const HeaderParser &other)
	Copy constructor of HeaderParser.
HeaderParser &	operator= (const HeaderParser &other)
	Definition of equal operator of HeaderParser.
virtual	~HeaderParser ()
	Destructor of HeaderParser.

Protected Member Functions
void	copyHeaderParser (const HeaderParser &other)
	Copy function of HeaderParser.
virtual bool	parseFile ()
	Parse the input file.
virtual void	postLoadFile ()
	Initialisation to be done just after loading a file.
virtual void	preLoadFile ()
	Initialisation to be done just before loading a file.

Private Member Functions
void	incrementCurrentChar ()
	Increment current char position.
void	initialisationHeaderParser ()
	Initialisation function of the class HeaderParser.
bool	parseArgument (PArgument &argument)
	Parse a PAttribute.
bool	parseDocString ()
	Parse a doc string.
bool	parseFunction (PFunction &function)
	Parse a PFunction.
bool	parseMacro ()
	Parse a macro.
void	parseTemplateDef (PString &templateDef)
	Parse a template definition.
void	parseType (PString &type)
	Parse a data type.
void	playOtherCode ()
	Add the other code parsed into the current PSource.

Private Attributes
PSource	p_currentSource
	Current source to be parsed.
PString	p_lastDocString
	Last documentation string.
PString	p_otherCode
	Other code which is not a function prototype.
PVecSource	p_vecSource
	Vector of parsed PSource.

Detailed Description

Parse the configuration a create the vector of sources.

Definition at line 14 of file HeaderParser.h.

Constructor & Destructor Documentation

HeaderParser() [1/2]

HeaderParser::HeaderParser

(

)

Default constructor of HeaderParser.

Definition at line 10 of file HeaderParser.cpp.

                          {
        initialisationHeaderParser();
}

References initialisationHeaderParser().

Referenced by copyHeaderParser(), HeaderParser(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

HeaderParser() [2/2]

HeaderParser::HeaderParser

(

const HeaderParser &

other

)

Copy constructor of HeaderParser.

Parameters

other

: class to copy

Definition at line 17 of file HeaderParser.cpp.

                                                    {
        copyHeaderParser(other);
}

References copyHeaderParser(), and HeaderParser().

Here is the call graph for this function:

~HeaderParser()

HeaderParser::~HeaderParser ( )

virtual

Destructor of HeaderParser.

Definition at line 22 of file HeaderParser.cpp.

                           {
        
}

Member Function Documentation

copyHeaderParser()

void HeaderParser::copyHeaderParser ( const HeaderParser & other )

protected

Copy function of HeaderParser.

Parameters

other

: class to copy

Definition at line 45 of file HeaderParser.cpp.

                                                             {
        p_vecSource = other.p_vecSource;
}

References HeaderParser(), and p_vecSource.

Referenced by HeaderParser(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

getVecSource()

const PVecSource & HeaderParser::getVecSource

(

)

const

Get the parsed vector of PSource.

Returns

parsed vector of PSource

Definition at line 38 of file HeaderParser.cpp.

                                                   {
        return p_vecSource;
}

References p_vecSource.

Referenced by createSourceFromConfig().

Here is the caller graph for this function:

incrementCurrentChar()

void HeaderParser::incrementCurrentChar ( )

private

Increment current char position.

Parameters

[out]

textObj

: obh to be used to store text

Definition at line 96 of file HeaderParser.cpp.

                                       {
        //If nothing is known I need to save the current char in the other code
        char ch = p_parser->getCurrentCh();
        if(ch == '~'){ch = ' ';}
        p_otherCode += ch;
        p_parser->getNextChar();
}

References p_otherCode.

Referenced by parseFile().

Here is the caller graph for this function:

initialisationHeaderParser()

void HeaderParser::initialisationHeaderParser ( )

private

Initialisation function of the class HeaderParser.

Definition at line 89 of file HeaderParser.cpp.

                                             {
        
}

Referenced by HeaderParser().

Here is the caller graph for this function:

operator=()

HeaderParser & HeaderParser::operator=

(

const HeaderParser &

other

)

Definition of equal operator of HeaderParser.

Parameters

other

: class to copy

Returns

copied class

Definition at line 30 of file HeaderParser.cpp.

                                                                  {
        copyHeaderParser(other);
        return *this;
}

References copyHeaderParser(), and HeaderParser().

Here is the call graph for this function:

parseArgument()

bool HeaderParser::parseArgument ( PArgument & arg )

private

Parse a PAttribute.

Parameters

[out]

arg

: PArgument to be parsed

Returns

true on success, false otherwise

Definition at line 223 of file HeaderParser.cpp.

                                               {
        if(p_parser->isMatchRewind(")")){return true;}
        PString type("");
        parseType(type);
        
        PString varName(""), ptrRef(""), tmpPtrRef("");
        
        tmpPtrRef = p_parser->getNextToken();
        
        if(isPtrRef(tmpPtrRef)){
                do{
                        ptrRef += tmpPtrRef;
                        tmpPtrRef = p_parser->getNextToken();
//                      if(tmpPtrRef == "__restrict__"){ptrRef += " ";}
                        
                }while(isPtrRef(tmpPtrRef));
                
                varName = tmpPtrRef;
        }else{
                ptrRef = tmpPtrRef;
                varName = ptrRef;
                ptrRef = "";
        }
        std::cerr << "HeaderParser::parseArgument : type = '"<<type<<", ptrRef = '"<<ptrRef<<"', varName = '"<<varName<<"'" << std::endl;
        PString defaultValue("");
        if(p_parser->isMatch("=")){             //Some default value
                defaultValue = p_parser->getNextToken();
                //If double quote are not token, even default strings are single token
                p_parser->pushPosition();
                PString nexToken(p_parser->getNextToken());
                if(nexToken == "("){    //We call a function/constructor
                        defaultValue += p_parser->getUntilKeyWithoutPaternRecurse(")", "(");
                }else{
                        p_parser->popPosition();        //It was not a function/constructor call
                }
        }
        arg.setName(varName);
        arg.setPtrRef(ptrRef);
        arg.setType(type);
        arg.setDefaultValue(defaultValue);
        return true;
}

References isPtrRef(), parseType(), PArgument::setDefaultValue(), PArgument::setName(), PArgument::setPtrRef(), and PArgument::setType().

Referenced by parseFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

parseDocString()

bool HeaderParser::parseDocString ( )

private

Parse a doc string.

Returns

true on success, false otherwise

Definition at line 129 of file HeaderParser.cpp.

                                 {
        if(!p_parser->isMatch("///")){return false;}
        p_lastDocString = p_parser->getUntilKeyWithoutPatern("\n");
        
        return true;
}

References p_lastDocString.

Referenced by parseFile(), and parseFunction().

Here is the caller graph for this function:

parseFile()

bool HeaderParser::parseFile ( )

protectedvirtual

Parse the input file.

Returns

true on success, false otherwise

Definition at line 52 of file HeaderParser.cpp.

                            {
        if(!p_run) return false;
        p_lastDocString = "";
        p_otherCode = "";
        p_currentSource.setName(p_parser->getFileName().getFileName());
        p_parser->skipWhiteSpace();
        //To parse the file we need to read char by char until we get something we know
        while(!p_parser->isEndOfFile() && p_run){                       //If we are not at the end of the file
                PFunction function;
                if(parseDocString()){}
                else if(p_parser->isMatch("//")){p_parser->getUntilKeyWithoutPatern("\n");}     //Skip comment
                else if(p_parser->isMatch("/*")){p_parser->getUntilKeyWithoutPatern("*/");}     //Skip comment
                else if(parseMacro()){}
                else if(parseFunction(function)){
                        p_currentSource.getVecFunction().push_back(function);
                }else{
                        incrementCurrentChar();
                }
                p_parser->skipWhiteSpace();
        }
        p_vecSource.push_back(p_currentSource);
        return true;
}

References incrementCurrentChar(), p_currentSource, p_lastDocString, p_otherCode, p_vecSource, parseDocString(), parseFunction(), and parseMacro().

Here is the call graph for this function:

parseFunction()

bool HeaderParser::parseFunction ( PFunction & function )

private

Parse a PFunction.

Parameters

[out]

function

: PFunction to be parsed

Returns

true on success, false otherwise

Definition at line 140 of file HeaderParser.cpp.

                                                    {
        p_parser->pushPosition();
        PString templateDef(""), returnType("");
        parseTemplateDef(templateDef);
        parseType(returnType);
        std::cerr << "HeaderParser::parseFunction : returnType = '"<<returnType<<"'" << std::endl;
        PString functionName(p_parser->getNextToken());
        if(functionName == ""){return false;}   //This is not a function
        function.setDocString(p_lastDocString);
        p_lastDocString = "";
        //Let's get the arguments of the function
        if(!p_parser->isMatch("(")){return false;}      //This is not a function
        function.setName(functionName);
        function.setOutputType(returnType);
        while(!p_parser->isEndOfFile() && !p_parser->isMatch(")") && p_run){
                PArgument arg;
                if(parseDocString()){}
                else if(p_parser->isMatch("//")){p_parser->getUntilKeyWithoutPatern("\n");}     //Skip comment
                else if(p_parser->isMatch("/*")){p_parser->getUntilKeyWithoutPatern("*/");}     //Skip comment
                else if(parseArgument(arg)){
                        function.getVecArgument().push_back(arg);
                        if(!p_parser->isMatch(",") && !isMatchRewind(")")){
                                errorAt();
                                std::cerr << "HeaderParser::parseFunction : expect ',' or ')' after function definition '"<<functionName<<"'" << std::endl;
                                return true;
                        }
                }else{
                        errorAt();
                        std::cerr << "HeaderParser::parseFunction : cannot parse attribute" << std::endl;
                        return true;
                }
                p_parser->skipWhiteSpace();
                
        }
        if(!p_parser->isMatch(";")){
                errorAt();
                std::cerr << "HeaderParser::parseFunction : expect ';' after function definition '"<<functionName<<"'" << std::endl;
                return true;
        }
        playOtherCode();
        return true;
 
}

References PFunction::getVecArgument(), p_lastDocString, parseArgument(), parseDocString(), parseTemplateDef(), parseType(), playOtherCode(), PFunction::setDocString(), PFunction::setName(), and PFunction::setOutputType().

Referenced by parseFile().

Here is the call graph for this function:

Here is the caller graph for this function:

parseMacro()

bool HeaderParser::parseMacro ( )

private

Parse a macro.

Returns

true on success, false otherwise

Definition at line 117 of file HeaderParser.cpp.

                             {
        if(!p_parser->isMatch("#")){return false;}
        PString macro("#" + p_parser->getUntilKeyWithoutPatern("\n") + "\n");
        PFunction func;
        func.setOtherCode(macro);
        p_currentSource.getVecFunction().push_back(func);
        return true;
}

References p_currentSource, and PFunction::setOtherCode().

Referenced by parseFile().

Here is the call graph for this function:

Here is the caller graph for this function:

parseTemplateDef()

void HeaderParser::parseTemplateDef ( PString & templateDef )

private

Parse a template definition.

Parameters

[out]

templateDef

: template definition

Definition at line 187 of file HeaderParser.cpp.

                                                        {
        if(!p_parser->isMatchToken("template")){return;}
        
        if(!p_parser->isMatch("<")){
                errorAt();
                std::cerr << "HeaderParser::parseTemplateDef : expect '<' after 'template' token" << std::endl;
                return;
        }
        templateDef += "template<";
        bool isTemplate(true);
        while(!p_parser->isEndOfFile() && isTemplate && p_run){
                templateDef += p_parser->getNextToken();                //Some typename
                templateDef += " ";
                templateDef += p_parser->getNextToken();                //Some T
                if(p_parser->isMatch(">")){isTemplate = false;}
                else if(!p_parser->isMatch(",")){
                        errorAt();
                        std::cerr << "HeaderParser::parseTemplateDef : expect '>' or ',' after template definition '"<<templateDef<<"'" << std::endl;
                        return;
                }
        }
        templateDef += ">";
}

Referenced by parseFunction().

Here is the caller graph for this function:

parseType()

void HeaderParser::parseType ( PString & type )

private

Parse a data type.

Parameters

[out]

type

: type to be parsed

Definition at line 269 of file HeaderParser.cpp.

                                          {
        type = "";
        PString token(p_parser->getNextToken());
        while(token == "const" || token == "unsigned" || token == "long"){
                type += token + " ";
                token = p_parser->getNextToken();
        }
        type += token;
}

Referenced by parseArgument(), and parseFunction().

Here is the caller graph for this function:

playOtherCode()

void HeaderParser::playOtherCode ( )

private

Add the other code parsed into the current PSource.

Definition at line 105 of file HeaderParser.cpp.

                                {
        if(p_otherCode != ""){
                PFunction other;
                other.setOtherCode(p_otherCode);
                p_currentSource.getVecFunction().push_back(other);
                p_otherCode = "";
        }
}

References p_currentSource, p_otherCode, and PFunction::setOtherCode().

Referenced by parseFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

postLoadFile()

void HeaderParser::postLoadFile ( )

protectedvirtual

Initialisation to be done just after loading a file.

Definition at line 84 of file HeaderParser.cpp.

                               {
        
}

preLoadFile()

void HeaderParser::preLoadFile ( )

protectedvirtual

Initialisation to be done just before loading a file.

Definition at line 77 of file HeaderParser.cpp.

                              {
        //Save the current source
        p_parser->setWhiteSpace(" \t\n");
        p_parser->setSeparator(",;{}()");
}

Member Data Documentation

p_currentSource

PSource HeaderParser::p_currentSource

private

Current source to be parsed.

Definition at line 48 of file HeaderParser.h.

Referenced by parseFile(), parseMacro(), and playOtherCode().

p_lastDocString

PString HeaderParser::p_lastDocString

private

Last documentation string.

Definition at line 44 of file HeaderParser.h.

Referenced by parseDocString(), parseFile(), and parseFunction().

p_otherCode

PString HeaderParser::p_otherCode

private

Other code which is not a function prototype.

Definition at line 46 of file HeaderParser.h.

Referenced by incrementCurrentChar(), parseFile(), and playOtherCode().

p_vecSource

PVecSource HeaderParser::p_vecSource

private

Vector of parsed PSource.

Definition at line 50 of file HeaderParser.h.

Referenced by copyHeaderParser(), getVecSource(), and parseFile().

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/hardware/PhoenixHPCProxy/src/FrontEnd/HeaderParser.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/hardware/PhoenixHPCProxy/src/FrontEnd/HeaderParser.cpp