Class used to parse file with possibility of inclusion. More...

#include <PMultiFileParser.h>

Collaboration diagram for PMultiFileParser:

Public Member Functions
void	addCommentConfig (const PMultiCommentConfig &commentConfig)
	Adds a comment config for the parser.

void	addCommentConfig (const PString &beginStringComment, const PString &endStringComment="\n")
	Adds a comment config for the parser.

bool	checkExpectedMatch (const PString &tokenExpected, const PString &tokenBefore="")
	Check if the tokenExpected match.

bool	checkExpectedToken (const PString &tokenExpected, const PString &tokenBefore="")
	Check if the p_currentToken == tokenExpected.

void	clearComment ()
	Clear comment.

void	errorAt ()
	Write a parsing error.

bool	fullParsing ()
	Perform the full parsing pf data.

PFileParser *	getCurrentParser ()
	Gets the current parser.

void	getCurrentTokenWithoutComment ()
	Get the current token and skip the comment.

PString &	getLastComment ()
	Get the last comment.

const PString &	getLastComment () const
	Get the last comment.

PString	getStrComposedOf (const PString &charset)
	Get the string composed of charset charcters.

bool	isMatch (const PString &patern, const PString &forbiddenCharBefore)
	Says if the patern match with the current caracters of the PFileParser.

bool	isMatch (const PString &token)
	Check if the given token matches the current read file.

PString	isMatch (const PVecString &vecToken)
	Check if the one entry of the vector of token matches.

bool	isMatchRewind (const PString &token)
	Check if the given token matches the current read file and goes back even if the token matches.

bool	isMatchSeq (const PVecString &patern, bool alwaysPopBack=false)
	Match a sequence of token in a vector.

PString	isMatchToken (const PVecString &vecToken)
	Check the matching between the current caracters and all the string in the vector but treats the string as a token (cannot be part of a word)

bool	load (const PPath &configFile)
	Load the PMultiFileParser with the configFile.

	PMultiFileParser (const PPath &inputDirectory=PPath(), const PPath &outputDirectory=PPath())
	Default constructeur of PMultiFileParser.

void	pointAtRow ()
	Point the problem.

void	setFileContent (const PString &fileContent)
	Set the file content to be parsed.

void	skipComment ()
	Skip comment.

void	stopParsing ()
	Stop the parsing of all the files.

void	unexpectedToken ()
	Print unexpected token error.

virtual	~PMultiFileParser ()
	Destructeur of PMultiFileParser.

Protected Member Functions
virtual bool	parseFile ()=0

virtual void	postLoadFile ()
	Post load file.

virtual void	preLoadFile ()
	Pre load file.

Protected Attributes
PString	p_currentToken
	CurrentToken parsed.

PPath	p_inputDirectory
	Input directory of the parser.

PString	p_lastComment
	last comment

std::list< PFileParser >	p_listFileParser
	List of all the parsers for all the loaded files.

PPath	p_outputDirectory
	Output directory of the parser.

PFileParser *	p_parser
	Parser helper for the config file.

bool	p_run
	Run the parsing if true.

Private Member Functions
void	initialisationPMultiFileParser (const PPath &inputDirectory, const PPath &outputDirectory)
	Initialisation function of the class PMultiFileParser.

Private Attributes
PListMultiCommentConfig	p_listCommentConfig
	Defines the differents comments we allow in the parsing.

Detailed Description

Class used to parse file with possibility of inclusion.

Definition at line 28 of file PMultiFileParser.h.

Constructor & Destructor Documentation

◆ PMultiFileParser()

PMultiFileParser::PMultiFileParser	(	const PPath &	inputDirectory = PPath(),
		const PPath &	outputDirectory = PPath() )

Default constructeur of PMultiFileParser.

Parameters

inputDirectory	: input directory of the PMultiFileParser
outputDirectory	: output directory of the PMultiFileParser

Definition at line 14 of file PMultiFileParser.cpp.

                                                                                             {
        initialisationPMultiFileParser(inputDirectory, outputDirectory);
}

References initialisationPMultiFileParser().

Here is the call graph for this function:

◆ ~PMultiFileParser()

PMultiFileParser::~PMultiFileParser ( )

virtual

Destructeur of PMultiFileParser.

Definition at line 19 of file PMultiFileParser.cpp.

                                   {
        
}

Member Function Documentation

◆ addCommentConfig() [1/2]

void PMultiFileParser::addCommentConfig ( const PMultiCommentConfig & commentConfig )

Adds a comment config for the parser.

Parameters

commentConfig : comment config for the PMultiFileParser

Definition at line 84 of file PMultiFileParser.cpp.

                                                                                {
        p_listCommentConfig.push_back(commentConfig);
}

References p_listCommentConfig.

◆ addCommentConfig() [2/2]

void PMultiFileParser::addCommentConfig	(	const PString &	beginStringComment,
		const PString &	endStringComment = "\n" )

Adds a comment config for the parser.

Parameters

beginStringComment	: string which defines the begining of a comment
endStringComment	: string which defines the ending of a comment

Definition at line 92 of file PMultiFileParser.cpp.

                                                                                                           {
        p_listCommentConfig.push_back(PMultiCommentConfig(beginStringComment, endStringComment));
}

References p_listCommentConfig.

◆ checkExpectedMatch()

bool PMultiFileParser::checkExpectedMatch	(	const PString &	tokenExpected,
		const PString &	tokenBefore = "" )

Check if the tokenExpected match.

Parameters

tokenExpected	: token we expect
tokenBefore	: token before the exprected one

Returns: true if the p_currentToken == tokenExpected, false otherwise with an error message

Definition at line 166 of file PMultiFileParser.cpp.

                                                                                                   {
        if(p_parser->isMatch(tokenExpected)) return true;
        errorAt();
        std::cerr << "Unexpected token '"<<p_parser->getNextToken()<<"'" << std::endl;
        std::cerr << "Expected token '"<<tokenExpected<<"'" << std::endl;
        if(tokenBefore != "") std::cerr << " after " << tokenBefore << std::endl;
        stopParsing();
        return false;
}

References errorAt(), p_parser, and stopParsing().

Here is the call graph for this function:

◆ checkExpectedToken()

bool PMultiFileParser::checkExpectedToken	(	const PString &	tokenExpected,
		const PString &	tokenBefore = "" )

Check if the p_currentToken == tokenExpected.

Parameters

tokenExpected	: token we expect
tokenBefore	: token before the exprected one

Returns: true if the p_currentToken == tokenExpected, false otherwise with an error message

Definition at line 151 of file PMultiFileParser.cpp.

                                                                                                   {
        if(tokenExpected == p_currentToken) return true;
        errorAt();
        std::cerr << "Unexpected token '"<<p_currentToken<<"'" << std::endl;
        std::cerr << "Expected token '"<<tokenExpected<<"'" << std::endl;
        if(tokenBefore != "") std::cerr << " after " << tokenBefore << std::endl;
        stopParsing();
        return false;
}

References errorAt(), p_currentToken, and stopParsing().

Here is the call graph for this function:

◆ clearComment()

void PMultiFileParser::clearComment ( )

Clear comment.

Definition at line 193 of file PMultiFileParser.cpp.

                                   {
        p_lastComment = "";
}

References p_lastComment.

Referenced by initialisationPMultiFileParser().

Here is the caller graph for this function:

◆ errorAt()

void PMultiFileParser::errorAt ( )

Write a parsing error.

Definition at line 126 of file PMultiFileParser.cpp.

                              {
        std::cerr << "\033[31mError at " << p_parser->getLocation() << " :\033[0m" << std::endl;
}

References p_parser.

Referenced by checkExpectedMatch(), checkExpectedToken(), and unexpectedToken().

Here is the caller graph for this function:

◆ fullParsing()

bool PMultiFileParser::fullParsing ( )

Perform the full parsing pf data.

Returns: true on success, false otherwise

Definition at line 57 of file PMultiFileParser.cpp.

                                  {
        if(p_parser == NULL){
                std::cerr << "PMultiFileParser::fullParsing : the parser is not initialised, please call PMultiFileParser::load or PMultiFileParser::setFileContent before this function" << std::endl;
                return false;
        }
        preLoadFile();
        bool isParseGood(true);
        while(!p_parser->isEndOfFile() && isParseGood && p_run){
                long unsigned int currentPos = p_parser->getCurrentCharIdx();
                isParseGood = parseFile();
                if(currentPos == p_parser->getCurrentCharIdx() && !p_parser->isEndOfFile()){
                        std::cerr << "PMultiFileParser::fullParsing : the parser is stucked at the position :" << std::endl << "\t" << p_parser->getLocation() << std::endl;
                        unexpectedToken();
                        pointAtRow();
                        p_run = false;
                }
        }
        if(p_run) postLoadFile();
        p_listFileParser.pop_back();
        if(p_listFileParser.size() > 0lu) p_parser =  &p_listFileParser.back();
        else p_parser = NULL;
        return p_run;
}

References p_listFileParser, p_parser, p_run, parseFile(), pointAtRow(), postLoadFile(), preLoadFile(), and unexpectedToken().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentParser()

PFileParser * PMultiFileParser::getCurrentParser ( )

Gets the current parser.

Returns: pointer to the current parser

Definition at line 303 of file PMultiFileParser.cpp.

                                                {
        return p_parser;
}

References p_parser.

◆ getCurrentTokenWithoutComment()

void PMultiFileParser::getCurrentTokenWithoutComment ( )

Get the current token and skip the comment.

Definition at line 280 of file PMultiFileParser.cpp.

                                                    {
        if(!p_run) return;
        p_lastComment = "";
        if(p_listCommentConfig.size() != 0lu){
                bool currentTokenIsComment(true);
                while(currentTokenIsComment && p_run && !p_parser->isEndOfFile()){
                        PListMultiCommentConfig::iterator it(p_listCommentConfig.begin());
                        currentTokenIsComment = false;
                        while(it != p_listCommentConfig.end() && !currentTokenIsComment){
                                if(p_parser->isMatch(it->first)){
                                        p_lastComment = p_parser->getUntilKey(it->second);
                                        currentTokenIsComment = true;
                                }
                                ++it;
                        }
                }
        }
        p_currentToken = p_parser->getNextToken();
}

References p_currentToken, p_lastComment, p_listCommentConfig, p_parser, and p_run.

◆ getLastComment() [1/2]

PString & PMultiFileParser::getLastComment ( )

Get the last comment.

Returns: last comment

Definition at line 106 of file PMultiFileParser.cpp.

                                          {
        return p_lastComment;
}

References p_lastComment.

◆ getLastComment() [2/2]

const PString & PMultiFileParser::getLastComment ( ) const

Get the last comment.

Returns: last comment

Definition at line 99 of file PMultiFileParser.cpp.

                                                      {
        return p_lastComment;
}

References p_lastComment.

◆ getStrComposedOf()

PString PMultiFileParser::getStrComposedOf ( const PString & charset )

Get the string composed of charset charcters.

Parameters

charset : set of allowed characters

Returns: corresponding string composed of characters in the given charset

Definition at line 272 of file PMultiFileParser.cpp.

                                                                 {
        //Remove comments
        skipComment();
        //Check if the token matches
        return p_parser->getStrComposedOf(charset);
}

References p_parser, and skipComment().

Here is the call graph for this function:

◆ initialisationPMultiFileParser()

void PMultiFileParser::initialisationPMultiFileParser	(	const PPath &	inputDirectory,
		const PPath &	outputDirectory )

private

Initialisation function of the class PMultiFileParser.

Parameters

inputDirectory	: input directory of the PMultiFileParser
outputDirectory	: output directory of the PMultiFileParser

Definition at line 311 of file PMultiFileParser.cpp.

                                                                                                                {
        p_run = true;
        p_inputDirectory = inputDirectory;
        p_outputDirectory = outputDirectory;
        p_currentToken = "";
        clearComment();
        p_parser = NULL;
}

References clearComment(), p_currentToken, p_inputDirectory, p_outputDirectory, p_parser, and p_run.

Referenced by PMultiFileParser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMatch() [1/3]

bool PMultiFileParser::isMatch	(	const PString &	patern,
		const PString &	forbiddenCharBefore )

Says if the patern match with the current caracters of the PFileParser.

Parameters

patern	: patern we want to check (this patern should not begin with white caracters)
forbiddenCharBefore	: lisr of characters which cannot be just before the first character of the patern

Returns: true if the patern match, false otherwise If the patern match, the current char will be in the next char of the patern

Definition at line 239 of file PMultiFileParser.cpp.

                                                                                         {
        //Remove comments
        skipComment();
        //Check if the token matches
        return p_parser->isMatch(patern, forbiddenCharBefore);
}

References p_parser, and skipComment().

Here is the call graph for this function:

◆ isMatch() [2/3]

bool PMultiFileParser::isMatch ( const PString & token )

Check if the given token matches the current read file.

Parameters

token : token to be checked

Returns: true on success, false otherwise This function isMatch takes account the comments

Definition at line 202 of file PMultiFileParser.cpp.

                                                   {
        //Remove comments
        skipComment();
        //Check if the token matches
        return p_parser->isMatch(token);
}

References p_parser, and skipComment().

Here is the call graph for this function:

◆ isMatch() [3/3]

PString PMultiFileParser::isMatch ( const PVecString & vecToken )

Check if the one entry of the vector of token matches.

Parameters

vecToken : vector of token

Returns: matched string, or empty string if there is no match

Definition at line 250 of file PMultiFileParser.cpp.

                                                            {
        //Remove comments
        skipComment();
        //Check if the token matches
        return p_parser->isMatch(vecToken);
}

References p_parser, and skipComment().

Here is the call graph for this function:

◆ isMatchRewind()

bool PMultiFileParser::isMatchRewind ( const PString & token )

Check if the given token matches the current read file and goes back even if the token matches.

Parameters

token : token to be checked

Returns: true on success, false otherwise This function isMatch takes account the comments

Definition at line 214 of file PMultiFileParser.cpp.

                                                         {
        //Remove comments
        skipComment();
        //Check if the token matches
        return p_parser->isMatchRewind(token);
}

References p_parser, and skipComment().

Here is the call graph for this function:

◆ isMatchSeq()

bool PMultiFileParser::isMatchSeq	(	const PVecString &	patern,
		bool	alwaysPopBack = false )

Match a sequence of token in a vector.

Parameters

patern	: set of token to match in this order and totally
alwaysPopBack	: true to make the PFileParser at the exact same place before the check even is the sequence matches

Returns: true if the full sequence matches, false otherwise

Definition at line 226 of file PMultiFileParser.cpp.

                                                                              {
        //Remove comments
        skipComment();
        //Check if the token matches
        return p_parser->isMatchSeq(patern, alwaysPopBack);
}

References p_parser, and skipComment().

Here is the call graph for this function:

◆ isMatchToken()

PString PMultiFileParser::isMatchToken ( const PVecString & vecToken )

Check the matching between the current caracters and all the string in the vector but treats the string as a token (cannot be part of a word)

Parameters

vecToken : vector of token

Returns: matched string, or empty string if there is no match

Definition at line 261 of file PMultiFileParser.cpp.

                                                                 {
        //Remove comments
        skipComment();
        //Check if the token matches
        return p_parser->isMatchToken(vecToken);
}

References p_parser, and skipComment().

Here is the call graph for this function:

◆ load()

bool PMultiFileParser::load ( const PPath & configFile )

Load the PMultiFileParser with the configFile.

Parameters

configFile : file name of the cnofiguration file

Returns: true on success, false otherwise

Definition at line 27 of file PMultiFileParser.cpp.

                                                   {
        if(configFile == "") return false;
        PFileParser parser;
        p_listFileParser.push_back(parser);
        p_listFileParser.back().setSeparator(MULTI_PARSER_SEPARATORS_STRING);
        p_parser = &p_listFileParser.back();
        if(!p_parser->open(configFile)){
                std::cerr << "PMultiFileParser::load : can't open file '" << configFile << "'" << std::endl;
                return false;
        }
        return fullParsing();
}

References fullParsing(), MULTI_PARSER_SEPARATORS_STRING, p_listFileParser, and p_parser.

Here is the call graph for this function:

◆ parseFile()

virtual bool PMultiFileParser::parseFile ( )

protectedpure virtual

Referenced by fullParsing().

Here is the caller graph for this function:

◆ pointAtRow()

void PMultiFileParser::pointAtRow ( )

Point the problem.

Definition at line 138 of file PMultiFileParser.cpp.

                                 {
        std::cerr << "\tAt row :\n" << p_parser->getCurrentRow() << std::endl;
        for(size_t i(0lu); i < p_parser->getColumn(); ++i){
                std::cerr << " ";
        }
        std::cerr << "^" << std::endl;
}

References p_parser.

Referenced by fullParsing().

Here is the caller graph for this function:

◆ postLoadFile()

void PMultiFileParser::postLoadFile ( )

protectedvirtual

Post load file.

Definition at line 116 of file PMultiFileParser.cpp.

                                   {
        
}

Referenced by fullParsing().

Here is the caller graph for this function:

◆ preLoadFile()

void PMultiFileParser::preLoadFile ( )

protectedvirtual

Pre load file.

Definition at line 111 of file PMultiFileParser.cpp.

                                  {
        
}

Referenced by fullParsing().

Here is the caller graph for this function:

◆ setFileContent()

void PMultiFileParser::setFileContent ( const PString & fileContent )

Set the file content to be parsed.

Parameters

fileContent : file content to be parsed

Definition at line 43 of file PMultiFileParser.cpp.

                                                                {
        if(p_parser == NULL){
                PFileParser parser;
                p_listFileParser.push_back(parser);
                p_listFileParser.back().setSeparator(MULTI_PARSER_SEPARATORS_STRING);
                p_parser = &p_listFileParser.back();
        }
        p_parser = &p_listFileParser.back();
        p_parser->setFileContent(fileContent);
}

References MULTI_PARSER_SEPARATORS_STRING, p_listFileParser, and p_parser.

◆ skipComment()

void PMultiFileParser::skipComment ( )

Skip comment.

Definition at line 177 of file PMultiFileParser.cpp.

                                  {
        bool isCommentFound(false);
        do{
                isCommentFound = false;
                PListMultiCommentConfig::iterator it(p_listCommentConfig.begin());
                while(it != p_listCommentConfig.end() && !isCommentFound && p_run && !p_parser->isEndOfFile()){
                        if(p_parser->isMatch(it->first)){
                                p_lastComment += it->first + p_parser->getUntilKey(it->second);
                                isCommentFound = true;
                        }
                        ++it;
                }
        }while(isCommentFound && p_run && !p_parser->isEndOfFile());
}

References p_lastComment, p_listCommentConfig, p_parser, and p_run.

Referenced by getStrComposedOf(), isMatch(), isMatch(), isMatch(), isMatchRewind(), isMatchSeq(), and isMatchToken().

Here is the caller graph for this function:

◆ stopParsing()

void PMultiFileParser::stopParsing ( )

Stop the parsing of all the files.

Definition at line 121 of file PMultiFileParser.cpp.

                                  {
        p_run = false;
}

References p_run.

Referenced by checkExpectedMatch(), checkExpectedToken(), and unexpectedToken().

Here is the caller graph for this function:

◆ unexpectedToken()

void PMultiFileParser::unexpectedToken ( )

Print unexpected token error.

Definition at line 131 of file PMultiFileParser.cpp.

                                      {
        errorAt();
        std::cerr << "PMultiFileParser::parseFile : unexpected token '"<<p_parser->getNextToken()<<"'" << std::endl;
        stopParsing();
}

References errorAt(), p_parser, and stopParsing().

Referenced by fullParsing().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ p_currentToken

PString PMultiFileParser::p_currentToken

protected

CurrentToken parsed.

Definition at line 78 of file PMultiFileParser.h.

Referenced by checkExpectedToken(), getCurrentTokenWithoutComment(), and initialisationPMultiFileParser().

◆ p_inputDirectory

PPath PMultiFileParser::p_inputDirectory

protected

Input directory of the parser.

Definition at line 80 of file PMultiFileParser.h.

Referenced by initialisationPMultiFileParser().

◆ p_lastComment

PString PMultiFileParser::p_lastComment

protected

last comment

Definition at line 76 of file PMultiFileParser.h.

Referenced by clearComment(), getCurrentTokenWithoutComment(), getLastComment(), getLastComment(), and skipComment().

◆ p_listCommentConfig

PListMultiCommentConfig PMultiFileParser::p_listCommentConfig

private

Defines the differents comments we allow in the parsing.

Definition at line 88 of file PMultiFileParser.h.

Referenced by addCommentConfig(), addCommentConfig(), getCurrentTokenWithoutComment(), and skipComment().

◆ p_listFileParser

std::list<PFileParser> PMultiFileParser::p_listFileParser

protected

List of all the parsers for all the loaded files.

Definition at line 72 of file PMultiFileParser.h.

Referenced by fullParsing(), load(), and setFileContent().

◆ p_outputDirectory

PPath PMultiFileParser::p_outputDirectory

protected

Output directory of the parser.

Definition at line 82 of file PMultiFileParser.h.

Referenced by initialisationPMultiFileParser().

◆ p_parser

PFileParser* PMultiFileParser::p_parser

protected

Parser helper for the config file.

Definition at line 70 of file PMultiFileParser.h.

Referenced by checkExpectedMatch(), errorAt(), fullParsing(), getCurrentParser(), getCurrentTokenWithoutComment(), getStrComposedOf(), initialisationPMultiFileParser(), isMatch(), isMatch(), isMatch(), isMatchRewind(), isMatchSeq(), isMatchToken(), load(), pointAtRow(), setFileContent(), skipComment(), and unexpectedToken().

◆ p_run

bool PMultiFileParser::p_run

protected

Run the parsing if true.

Definition at line 74 of file PMultiFileParser.h.

Referenced by fullParsing(), getCurrentTokenWithoutComment(), initialisationPMultiFileParser(), skipComment(), and stopParsing().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/config/PhoenixFileParser/src/PMultiFileParser.h
/builds/CTA-LAPP/PHOENIX_LIBS2/config/PhoenixFileParser/src/PMultiFileParser.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PMultiFileParser()

◆ ~PMultiFileParser()

Member Function Documentation

◆ addCommentConfig() [1/2]

◆ addCommentConfig() [2/2]

◆ checkExpectedMatch()

◆ checkExpectedToken()

◆ clearComment()

◆ errorAt()

◆ fullParsing()

◆ getCurrentParser()

◆ getCurrentTokenWithoutComment()

◆ getLastComment() [1/2]

◆ getLastComment() [2/2]

◆ getStrComposedOf()

◆ initialisationPMultiFileParser()

◆ isMatch() [1/3]

◆ isMatch() [2/3]

◆ isMatch() [3/3]

◆ isMatchRewind()

◆ isMatchSeq()

◆ isMatchToken()

◆ load()

◆ parseFile()

◆ pointAtRow()

◆ postLoadFile()

◆ preLoadFile()

◆ setFileContent()

◆ skipComment()

◆ stopParsing()

◆ unexpectedToken()

Member Data Documentation

◆ p_currentToken

◆ p_inputDirectory

◆ p_lastComment

◆ p_listCommentConfig

◆ p_listFileParser

◆ p_outputDirectory

◆ p_parser

◆ p_run