pxml_utils.h File Reference

#include "PFileParser.h"
#include "PXml.h"

Include dependency graph for pxml_utils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef std::vector< PXml >	PVecXml
	Vector of PXml. More...
typedef std::vector< PXmlAttr >	PVecXmlAttr
	Vector of PXml. More...

Functions
PString	pxml_attrStr (const PXmlAttr &xmlAttr, bool isSvg=false)
	Convert attribute in string. More...
PString	pxml_baliseStr (const PXml &xml, bool isSvg=false)
	Convert xml in string. More...
PXml	pxml_eraseVecChild (const PXml &xml, const PString &childName)
	Erase the childs of the current xml if it has childName as name. More...
bool	pxml_getAttrIfExist (PXmlAttr &attr, const PXml &xml, const PString &attrName)
	Get the attribute with given name if exist. More...
bool	pxml_getChildIfExist (PXml &match, const PXml &xml, const PString &childName)
	Get the child with given name if exist. More...
PXml *	pxml_getChildPtr (PXml &xml, const PString &childName)
	Get the child with given name if exist. More...
PString	pxml_getFullContent (const PXml &xml)
	Get the content of the PXml (children or value) More...
bool	pxml_getVecChildIfExist (PVecXml &vecMatch, const PXml &xml, const PString &childName)
	Get the vector of childs with given name if exist. More...
bool	pxml_parserContent (PXml &xml, const PString &fileContent, bool isSvg=false)
	Parse a PXml with a file content. More...
bool	pxml_parserFile (PXml &xml, const PPath &fileName, bool isSvg=false)
	Parse a PXml with a file. More...
bool	pxml_parserXmlAttribute (PXml &parent, PFileParser &parser)
	Parse the attribute of a xml balise. More...
bool	pxml_parserXmlContent (PXml &parent, PFileParser &parser, bool isMainBalise=false)
	Parse the content of an xml balise. More...
bool	pxml_saveFile (const PPath &fileName, const PXml &xml, bool isSvg=false)
	Save a xml in a file. More...
void	pxml_setAttr (PXml &xml, const PString &nameAttr, const PString &valueAttr)
	Set a value to an attribute. More...
PFileParser	pxml_setXmlParser (const PString &fileContent, bool isSvg=false)
	Set the PFileParser for xml. More...
PString	pxml_vecAttrStr (const PVecXmlAttr &vecXmlAttr, bool isSvg)
	Convert attributes in string. More...
PString	pxml_vecXmlStr (const PVecXml &vecXml, bool isSvg=false)
	Convert a vecto of xml in string. More...

Typedef Documentation

PVecXml

typedef std::vector<PXml> PVecXml

Vector of PXml.

Definition at line 14 of file pxml_utils.h.

PVecXmlAttr

typedef std::vector<PXmlAttr> PVecXmlAttr

Vector of PXml.

Definition at line 16 of file pxml_utils.h.

Function Documentation

pxml_attrStr()

PString pxml_attrStr	(	const PXmlAttr &	xmlAttr,
		bool	isSvg
	)

Convert attribute in string.

Parameters

xmlAttr	: xml attribute to be converted into string
isSvg	: say if the output xml has to be SVG like (with no space between chevron and newline between attribute

Returns

output string

Definition at line 368 of file pxml_utils.cpp.

                                                          {
        PString body(" ");
        body += xmlAttr.getName() + "=\"" + xmlAttr.getValue() + "\"";
        if(isSvg){
                body += "\n\t";
        }
        return body;
}

References PXmlAttr::getName(), and PXmlAttr::getValue().

Referenced by pxml_vecAttrStr().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_baliseStr()

PString pxml_baliseStr	(	const PXml &	xml,
		bool	isSvg
	)

Convert xml in string.

Parameters

xml	: xml to be converted into string
isSvg	: say if the output xml has to be SVG like (with no space between chevron and newline between attribute

Returns

output string

Definition at line 318 of file pxml_utils.cpp.

                                                    {
        PString body(""), name(xml.getName());
        PString baseXmlNewLine("\n");
        if(isSvg){
                baseXmlNewLine = "";
        }
        if(xml.getIsText()){
                body += xml.getValue();
        }else{
                if(name != ""){
                        body += "<";
                        body += name;
                        body += pxml_vecAttrStr(xml.getVecAttr(), isSvg);
                        
                        if(name == "?xml"){body += " ?>\n";}
                        else if(name == "!--"){body += " -->\n";}
                        else if(xml.getIsCompact()){
                                body += " />"+baseXmlNewLine;
                        }else{
                                body += ">"+baseXmlNewLine;
                                body += pxml_vecXmlStr(xml.getVecChild(), isSvg);
                                body += xml.getValue();
                                body += "</"+ name + ">" + baseXmlNewLine;
                        }
                }else{
                        
                        body += pxml_vecXmlStr(xml.getVecChild(), isSvg);
                }
        }
        return body;
}

References PXml::getIsCompact(), PXml::getIsText(), PXml::getName(), PXml::getValue(), PXml::getVecAttr(), PXml::getVecChild(), pxml_vecAttrStr(), and pxml_vecXmlStr().

Referenced by checkParseXmlFile(), checkXmlString(), pxml_saveFile(), pxml_vecXmlStr(), and saveSlides().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_eraseVecChild()

PXml pxml_eraseVecChild	(	const PXml &	xml,
		const PString &	childName
	)

Erase the childs of the current xml if it has childName as name.

Parameters

xml	: current input
childName	: name of the childs to be erased

Returns

output xml without childs named childName

Definition at line 288 of file pxml_utils.cpp.

                                                                    {
        PXml out;
        out.setName(xml.getName());
        out.setValue(xml.getValue());
        out.setVecAttr(xml.getVecAttr());
        const PVecXml & vecXml = xml.getVecChild();
        for(PVecXml::const_iterator it(vecXml.begin()); it != vecXml.end(); ++it){
                if(it->getName() != childName){
                        out.getVecChild().push_back(*it);
                }
        }
        return out;
}

References PXml::getName(), PXml::getValue(), PXml::getVecAttr(), PXml::getVecChild(), PXml::setName(), PXml::setValue(), and PXml::setVecAttr().

Referenced by processFileSvg(), and testCreateXml().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_getAttrIfExist()

bool pxml_getAttrIfExist	(	PXmlAttr &	attr,
		const PXml &	xml,
		const PString &	attrName
	)

Get the attribute with given name if exist.

Parameters

[out]	attr	: vector of matched child
	xml	: xml input
	attrName	: name of the searched child

Returns

true if the attribute exists, false otherwise

Definition at line 251 of file pxml_utils.cpp.

                                                                                     {
        bool isSearched(true);
        const PVecXmlAttr & vecAttr = xml.getVecAttr();
        PVecXmlAttr::const_iterator it(vecAttr.begin());
        while(it != vecAttr.end() && isSearched){
                if(it->getName() == attrName){
                        attr = *it;
                        isSearched = false;
                }
                ++it;
        }
        return !isSearched;
}

References PXml::getVecAttr().

Referenced by getInkscapeLabel(), and loadParserSeq().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_getChildIfExist()

bool pxml_getChildIfExist	(	PXml &	match,
		const PXml &	xml,
		const PString &	childName
	)

Get the child with given name if exist.

Parameters

[out]	match	: matched child
	xml	: xml input
	childName	: name of the searched child

Returns

true if the child exist, false otherwise

Definition at line 215 of file pxml_utils.cpp.

                                                                                    {
        bool isSearched(true);
        const PVecXml & vecChild = xml.getVecChild();
        PVecXml::const_iterator it(vecChild.begin());
        while(it != vecChild.end() && isSearched){
                if(it->getName() == childName){
                        match = *it;
                        isSearched = false;
                }
                ++it;
        }
        return !isSearched;
}

References PXml::getVecChild().

Referenced by checkXmlString(), and processFileSvg().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_getChildPtr()

PXml* pxml_getChildPtr	(	PXml &	xml,
		const PString &	childName
	)

Get the child with given name if exist.

Parameters

xml	: xml input
childName	: name of the searched child

Returns

pointer to the existing child, NULL otherwise

Definition at line 234 of file pxml_utils.cpp.

                                                              {
        PXml * out = NULL;
        PVecXml & vecChild = xml.getVecChild();
        for(PVecXml::iterator it(vecChild.begin()); it != vecChild.end() && out == NULL; ++it){
                if(it->getName() == childName){
                        out = &(*it);
                }
        }
        return out;
}

References PXml::getVecChild().

Referenced by checkParseSeq(), processFileSvg(), and saveSlides().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_getFullContent()

PString pxml_getFullContent

(

const PXml &

xml

)

Get the content of the PXml (children or value)

Parameters

xml	: PXml to be used

Returns

content of the PXml (children or value)

Definition at line 395 of file pxml_utils.cpp.

                                             {
        const PVecXml & vecXml = xml.getVecChild();
        if(vecXml.size() != 0lu){
                return pxml_vecXmlStr(vecXml);
        }else{
                return xml.getValue();
        }
}

References PXml::getValue(), PXml::getVecChild(), and pxml_vecXmlStr().

Referenced by checkParseSeq(), and loadParserSeq().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_getVecChildIfExist()

bool pxml_getVecChildIfExist	(	PVecXml &	vecMatch,
		const PXml &	xml,
		const PString &	childName
	)

Get the vector of childs with given name if exist.

Parameters

[out]	vecMatch	: vector of matched childs
	xml	: xml input
	childName	: name of the searched childs

Returns

true if the childs exist, false otherwise

Definition at line 197 of file pxml_utils.cpp.

                                                                                             {
        bool isFound(false);
        const PVecXml & vecChild = xml.getVecChild();
        for(PVecXml::const_iterator it(vecChild.begin()); it != vecChild.end(); ++it){
                if(it->getName() == childName){
                        vecMatch.push_back(*it);
                        isFound = true;
                }
        }
        return isFound;
}

References PXml::getVecChild().

Referenced by loadParserSeq(), and processFileSvg().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_parserContent()

bool pxml_parserContent	(	PXml &	xml,
		const PString &	fileContent,
		bool	isSvg
	)

Parse a PXml with a file content.

Parameters

[out]	xml	: PXml to be initialised
	fileContent	: file content
	isSvg	: true if the parsed file is a svg

Returns

true on success, false otherwise

Definition at line 48 of file pxml_utils.cpp.

                                                                            {
        PFileParser parser(pxml_setXmlParser(fileContent, isSvg));
        xml.setName("root");
        
        return pxml_parserXmlContent(xml, parser, true);
        
//      return pxml_parserVecXml(xml.getVecChild(), parser, isSvg);
}

References pxml_parserXmlContent(), pxml_setXmlParser(), and PXml::setName().

Referenced by checkXmlString(), and pxml_parserFile().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_parserFile()

bool pxml_parserFile	(	PXml &	xml,
		const PPath &	fileName,
		bool	isSvg
	)

Parse a PXml with a file.

Parameters

[out]	xml	: PXml to be initialised
	fileName	: name of the intialisation file
	isSvg	: true if the parsed file is a svg

Returns

true on success, false otherwise

Definition at line 38 of file pxml_utils.cpp.

                                                                    {
        return pxml_parserContent(xml, fileName.loadFileContent(), isSvg);
}

References PPath::loadFileContent(), and pxml_parserContent().

Referenced by checkParseSeq(), checkParseXmlFile(), and processFileSvg().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_parserXmlAttribute()

bool pxml_parserXmlAttribute	(	PXml &	parent,
		PFileParser &	parser
	)

Parse the attribute of a xml balise.

Parameters

[out]	parent	: xml parent in wich to put the attribute
[out]	parser	: parser to be used

Returns

true on success, false otherwise

Definition at line 79 of file pxml_utils.cpp.

                                                                 {
        parser.setWhiteSpace(" \t\n");
        while(!pxml_isAttributeEnd(parent, parser) && !parser.isEndOfFile()){
                PString attributeName(parser.getStrComposedOf(ALLOWED_ATTRIBUTE_CHAR));
                if(attributeName == ""){
                        std::cerr << "pxml_parserXmlAttribute : error at : " << parser.getLocation() << std::endl;
                        std::cerr << "\tcannot parse the attributes name as '"<<parser.getNextToken()<<"'" << std::endl;
                        return false;
                }
                if(!parser.isMatch("=")){
                        std::cerr << "pxml_parserXmlAttribute : error at : " << parser.getLocation() << std::endl;
                        std::cerr << "\texpected '=' after attribute '"<<attributeName<<"'" << std::endl;
                        return false;
                }
                if(!parser.isMatch("\"")){
                        std::cerr << "pxml_parserXmlAttribute : error at : " << parser.getLocation() << std::endl;
                        std::cerr << "\texpected '\"' after attribute '"<<attributeName<<"='" << std::endl;
                        return false;
                }
                PString attributeValue(parser.getUntilKeyWithoutPatern("\""));
                PXmlAttr tmpAttribute;
                tmpAttribute.setName(attributeName);
                tmpAttribute.setValue(attributeValue);
                parent.getVecAttr().push_back(tmpAttribute);
        }
        parser.setWhiteSpace("");
        return true;
}

References ALLOWED_ATTRIBUTE_CHAR, PFileParser::getLocation(), PFileParser::getNextToken(), PFileParser::getStrComposedOf(), PFileParser::getUntilKeyWithoutPatern(), PXml::getVecAttr(), PFileParser::isEndOfFile(), PFileParser::isMatch(), pxml_isAttributeEnd(), PXmlAttr::setName(), PXmlAttr::setValue(), and PFileParser::setWhiteSpace().

Referenced by pxml_parserXmlContent().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_parserXmlContent()

bool pxml_parserXmlContent	(	PXml &	parent,
		PFileParser &	parser,
		bool	isMainBalise
	)

Parse the content of an xml balise.

Parameters

[out]	parent	: xml parent in wich to put the content
[out]	parser	: parser to be used
	isMainBalise	: true if the parent balise if the main one, false otherwise

Returns

true on success, false otherwise

Definition at line 115 of file pxml_utils.cpp.

                                                                                  {
        parser.setSeparator("<>\"=");
        parser.setWhiteSpace("");
        PString balisePartialEnd("/" + parent.getName() + ">");
        PString baliseEnd("<" + balisePartialEnd);
        PXml text;
        text.setIsText(true);
        while(!parser.isMatch(baliseEnd) && !parser.isEndOfFile()){
                PString textString(parser.getUntilKeyWithoutPatern("<"));
                if(textString != ""){   //If the next token is not a < it is a text
                        text.getValue() += textString;
                        if(parent.getVecChild().size() == 0lu){
                                if(parser.isMatch(balisePartialEnd)){
                                        parent.setValue(text.getValue());
                                        return true;
                                }else{
                                        parent.getVecChild().push_back(text);
                                }
                        }else{
                                parent.getVecChild().push_back(text);
                        }
                        text.setValue("");      //Reset value for next one
                }
                if(parser.isEndOfFile()){
                        if(isMainBalise){
                                return true;
                        }else{
                                std::cerr << "pxml_parserXmlContent : error at : " << parser.getLocation() << std::endl;
                                std::cerr << "\tunexpected end of file. We are supposed to be in the balise '"<<parent.getName()<<"'" << std::endl;
                                return false;
                        }
                }
                if(parser.isMatch(balisePartialEnd)){   //We find the end of the balise
                        return true;
                }else{  //Or it can be another balise
                        PString childBaliseName(parser.getStrComposedOf(ALLOWED_BALISE_CHAR));
                        if(childBaliseName != ""){      //We find a new balise
                                PXml xml;
                                xml.setName(childBaliseName);
                                if(childBaliseName == "!--"){
                                        parser.getUntilKeyWithoutPatern("-->"); //Skip the comment
                                }else if(childBaliseName == "?xml"){
                                        parser.getUntilKeyWithoutPatern("?>");  //Skip the svg balise
                                }else{
                                        if(!pxml_parserXmlAttribute(xml, parser)){      //Let's parse the attribute
                                                std::cerr << "pxml_parserXmlContent : error at : " << parser.getLocation() << std::endl;
                                                std::cerr << "\tcannot parse the attributes of balise '"<<childBaliseName<<"'" << std::endl;
                                                return false;
                                        }
                                        if(!xml.getIsCompact()){
                                                //Let's parse the content
                                                if(!pxml_parserXmlContent(xml, parser, false)){
                                                        std::cerr << "pxml_parserXmlContent : error at : " << parser.getLocation() << std::endl;
                                                        std::cerr << "\tcannot parse balise '"<<childBaliseName<<"'" << std::endl;
                                                        return false;
                                                }
                                        }
                                        parent.getVecChild().push_back(xml);
                                }
                        }else if(parser.isMatch("/")){
                                std::cerr << "pxml_parserXmlContent : in balise '"<<parent.getName()<<"' unexpected '</' at : " << parser.getLocation() << std::endl;
                                return false;
                        }else{  //It was just a text <
                                text.getValue() += "<";
                        }
                }
        }
        return true;
}

References ALLOWED_BALISE_CHAR, PXml::getIsCompact(), PFileParser::getLocation(), PXml::getName(), PFileParser::getStrComposedOf(), PFileParser::getUntilKeyWithoutPatern(), PXml::getValue(), PXml::getVecChild(), PFileParser::isEndOfFile(), PFileParser::isMatch(), pxml_parserXmlAttribute(), PXml::setIsText(), PXml::setName(), PFileParser::setSeparator(), PXml::setValue(), and PFileParser::setWhiteSpace().

Referenced by pxml_parserContent().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_saveFile()

bool pxml_saveFile	(	const PPath &	fileName,
		const PXml &	xml,
		bool	isSvg
	)

Save a xml in a file.

Parameters

fileName	: name of the output file
xml	: xml to be saved
isSvg	: say if the output xml has to be SVG like (with no space between chevron and newline between attribute

Returns

true on success, false otherwise

Definition at line 308 of file pxml_utils.cpp.

                                                                        {
        PString body(pxml_baliseStr(xml, isSvg));
        return fileName.saveFileContent(body);
}

References pxml_baliseStr(), and PPath::saveFileContent().

Referenced by testCreateXml().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_setAttr()

void pxml_setAttr	(	PXml &	xml,
		const PString &	nameAttr,
		const PString &	valueAttr
	)

Set a value to an attribute.

Parameters

[out]	xml	: xml to be modified
	nameAttr	: name of the attribute
	valueAttr	: value of the attribute

Definition at line 270 of file pxml_utils.cpp.

                                                                                  {
        bool isSearched(true);
        PVecXmlAttr & vecAttr = xml.getVecAttr();
        PVecXmlAttr::iterator it(vecAttr.begin());
        while(it != vecAttr.end() && isSearched){
                if(it->getName() == nameAttr){
                        it->setValue(valueAttr);
                        isSearched = false;
                }
                ++it;
        }
}

References PXml::getVecAttr().

Referenced by saveSlides(), and testCreateXml().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_setXmlParser()

PFileParser pxml_setXmlParser	(	const PString &	fileContent,
		bool	isSvg
	)

Set the PFileParser for xml.

Parameters

fileContent	: content to be parsed
isSvg	: true if the parsed file is a svg

Returns

PFileParser

Definition at line 20 of file pxml_utils.cpp.

                                                                      {
        PFileParser parser;
        parser.setSeparator("<>\"=");
        if(isSvg){
                parser.setWhiteSpace("");
        }else{
                parser.setWhiteSpace("\t\n ");
        }
        parser.setFileContent(fileContent);
        return parser;
}

References PFileParser::setFileContent(), PFileParser::setSeparator(), and PFileParser::setWhiteSpace().

Referenced by pxml_parserContent().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_vecAttrStr()

PString pxml_vecAttrStr	(	const PVecXmlAttr &	vecXmlAttr,
		bool	isSvg
	)

Convert attributes in string.

Parameters

vecXmlAttr	: xml attributes to be converted into string
isSvg	: say if the output xml has to be SVG like (with no space between chevron and newline between attribute

Returns

output string

Definition at line 382 of file pxml_utils.cpp.

                                                                   {
        if(vecXmlAttr.size() == 0lu){return "";}
        PString body("");
        for(PVecXmlAttr::const_iterator it(vecXmlAttr.begin()); it != vecXmlAttr.end(); ++it){
                body += pxml_attrStr(*it, isSvg);
        }
        return body;
}

References pxml_attrStr().

Referenced by pxml_baliseStr().

Here is the call graph for this function:

Here is the caller graph for this function:

pxml_vecXmlStr()

PString pxml_vecXmlStr	(	const PVecXml &	vecXml,
		bool	isSvg
	)

Convert a vecto of xml in string.

Parameters

vecXml	: vecor of xml to be converted into string
isSvg	: say if the output xml has to be SVG like (with no space between chevron and newline between attribute

Returns

output string

Definition at line 355 of file pxml_utils.cpp.

                                                          {
        PString body("");
        for(PVecXml::const_iterator it(vecXml.begin()); it != vecXml.end(); ++it){
                body += pxml_baliseStr(*it, isSvg);
        }
        return body;
}

References pxml_baliseStr().

Referenced by pxml_baliseStr(), and pxml_getFullContent().

Here is the call graph for this function:

Here is the caller graph for this function: