base class for xml parsers, runtime independant More...

#include <xmlParserBase.hxx>

Inheritance diagram for xmlParserBase:

[legend]

Collaboration diagram for xmlParserBase:

[legend]

Public Member Functions
void	setAttribute (std::string key, std::string value)

std::string	getAttribute (std::string key)

virtual void	addData (std::string value)

virtual void	init (const xmlChar *p, xmlParserBase father=0)

Static Public Member Functions
static void XMLCALL	start_document (void *userData)

static void XMLCALL	end_document (void *userData)

static void XMLCALL	start_element (void userData, const xmlChar name, const xmlChar **p)

static void XMLCALL	end_element (void userData, const xmlChar name)

static void XMLCALL	characters (void userData, const xmlChar ch, int len)

static void XMLCALL	comment (void userData, const xmlChar value)

static void XMLCALL	warning (void userData, const char fmt,...)

static void XMLCALL	error (void userData, const char fmt,...)

static void XMLCALL	fatal_error (void userData, const char fmt,...)

static void XMLCALL	cdata_block (void userData, const xmlChar value, int len)

static void	cleanGarbage ()

static int	getGarbageSize ()

static void	XML_SetUserData (_xmlParserCtxt ctxt, xmlParserBase parser)

Public Attributes
std::map< std::string, int >	counts

Static Public Attributes
static _xmlParserCtxt *	_xmlParser

static std::stack< xmlParserBase * >	_stackParser

Protected Member Functions
void	getAttributes (const xmlChar **p)

virtual void	onStart (const XML_Char elem, const xmlChar *p)

virtual void	onEnd (const XML_Char *name)

virtual void	charData (std::string data)

virtual void	incrCount (const XML_Char *elem)

virtual void	end ()

virtual void	stopParse (std::string what)

Protected Attributes
std::map< std::string, std::string >	_mapAttrib

std::string	_data

xmlParserBase *	_father

Static Protected Attributes
static std::list< xmlParserBase * >	_garbage

Detailed Description

base class for xml parsers, runtime independant

Definition at line 51 of file xmlParserBase.hxx.

Member Function Documentation

◆ addData()

void xmlParserBase::addData ( std::string value )

virtual

Add data on the data attribute of the parser object dedicated to an xml tag

Reimplemented in outputParser, YACS::ENGINE::dataParser, YACS::ENGINE::arrayParser, YACS::ENGINE::valueParser, and YACS::ENGINE::portParser.

Definition at line 267 of file xmlParserBase.cxx.

 {
   //  DEBTRACE("xmlParserBase::addData()");
   _data += value;
 }

◆ cdata_block()

void XMLCALL xmlParserBase::cdata_block	(	void *	userData,
		const xmlChar *	value,
		int	len
	)

static

callback called for CDATA inside tags:

<tag>![CDATA[content]]></tag>

used only by libxml2

Definition at line 204 of file xmlParserBase.cxx.

 {
   //DEBTRACE("xmlParserBase::cdata_block");
   xmlParserBase *currentParser = static_cast<xmlParserBase *> (userData);
   string data((char*)value,len);
   currentParser->charData(data);
 }

References charData().

Referenced by xmlReader::parse().

◆ characters()

void XMLCALL xmlParserBase::characters	(	void *	userData,
		const xmlChar *	ch,
		int	len
	)

static

callback called for significant characters inside tags:

<tag>content</tag>

or outside tags, like space or new line; get also the CDATA tags:

<tag>![CDATA[content]]></tag>

Definition at line 108 of file xmlParserBase.cxx.

 {
   //DEBTRACE("xmlParserBase::characters " << len);
   xmlParserBase *currentParser = (xmlParserBase *) (userData);
   string data((char*)ch,len);
   currentParser->charData(data);
 }

References charData().

Referenced by xmlReader::parse().

◆ charData()

void xmlParserBase::charData ( std::string data )

protectedvirtual

to be specialized following the kind of xml tag

Reimplemented in YACS::ENGINE::sampleParser, YACS::ENGINE::loopPortParser, YACS::ENGINE::simpleTypeParser, YACS::ENGINE::attrParser, and YACS::ENGINE::stateParser.

Definition at line 299 of file xmlParserBase.cxx.

300 {

301 }

Referenced by cdata_block(), and characters().

◆ cleanGarbage()

void xmlParserBase::cleanGarbage ( )

static

Definition at line 214 of file xmlParserBase.cxx.

 {
   while (!_garbage.empty())
     {
       delete (_garbage.front());
       _garbage.pop_front();
     }
 }

Referenced by xmlReader::parse().

◆ comment()

void XMLCALL xmlParserBase::comment	(	void *	userData,
		const xmlChar *	value
	)

static

callback usable only with libxml2

Definition at line 122 of file xmlParserBase.cxx.

 {
   //DEBTRACE("xmlParserBase::comment");
   xmlParserBase *currentParser = static_cast<xmlParserBase *> (userData);
 }

Referenced by xmlReader::parse().

◆ end()

void xmlParserBase::end ( )

protectedvirtual

to be specialized for each kind of xml tag

Definition at line 318 of file xmlParserBase.cxx.

319 {

320 }

Referenced by end_element().

◆ end_document()

void XMLCALL xmlParserBase::end_document ( void * userData )

static

callback usable only with libxml2

Definition at line 63 of file xmlParserBase.cxx.

 {
   //DEBTRACE("xmlParserBase::end_document");
   xmlParserBase *currentParser = static_cast<xmlParserBase *> (userData);
 }

Referenced by xmlReader::parse().

◆ end_element()

void XMLCALL xmlParserBase::end_element	(	void *	userData,
		const xmlChar *	name
	)

static

callback called on end of an xml element:

</name>

Definition at line 88 of file xmlParserBase.cxx.

 {
   //DEBTRACE("xmlParserBase::end_element");
   const XML_Char *aName = tochar(name);
   xmlParserBase *childParser = static_cast<xmlParserBase *> (userData);
   _garbage.push_back(_stackParser.top());
   DEBTRACE("xmlParserBase::end_element " << _garbage.size());
   _stackParser.pop();
   XML_SetUserData(_xmlParser, _stackParser.top());
   childParser->onEnd(aName);
   childParser->end();
  }

References DEBTRACE, end(), onEnd(), tochar(), and XML_Char.

Referenced by xmlReader::parse().

◆ error()

void XMLCALL xmlParserBase::error	(	void *	userData,
		const char *	fmt,
			...
	)

static

callback usable only with libxml2

Definition at line 156 of file xmlParserBase.cxx.

 {
   DEBTRACE("xmlParserBase::error");
   xmlParserBase *currentParser = static_cast<xmlParserBase *> (userData);
   va_list args;
   va_start(args, fmt);
   string format = "%s";
   if (format == fmt)
     {
       char* parv;
       parv = va_arg(args, char*);
       cerr << parv ;
       xmlParserBase *currentParser = (xmlParserBase *) userData;
       //cerr << currentParser->element << endl;
     }
   else cerr << __FILE__ << " [" << __LINE__ << "] : " 
             << "error format not taken into account: " << fmt << endl;
   va_end(args);
 }

References driver_internal::args, and DEBTRACE.

Referenced by xmlReader::parse().

◆ fatal_error()

void XMLCALL xmlParserBase::fatal_error	(	void *	userData,
		const char *	fmt,
			...
	)

static

callback usable only with libxml2

Definition at line 181 of file xmlParserBase.cxx.

 {
   DEBTRACE("xmlParserBase::fatal_error");
   xmlParserBase *currentParser = static_cast<xmlParserBase *> (userData);
   va_list args;
   va_start(args, fmt);
   string format = "%s";
   if (format == fmt)
     {
       char* parv;
       parv = va_arg(args, char*);
       cerr << parv ;
     }
   else cerr << __FILE__ << " [" << __LINE__ << "] : " 
             << "error format not taken into account: " << fmt << endl;
   va_end(args);
 }

References driver_internal::args, and DEBTRACE.

Referenced by xmlReader::parse().

◆ getAttribute()

std::string xmlParserBase::getAttribute ( std::string key )

Gets an attribute value given a string key. If the key does not exist, throws an Exception.

Definition at line 254 of file xmlParserBase.cxx.

 {
   if (_mapAttrib.find(key) == _mapAttrib.end())
     {
       string what = "Attribute does not exist: " + key;
       throw Exception(what);
     }
   return _mapAttrib[key];
 }

◆ getAttributes()

void xmlParserBase::getAttributes ( const xmlChar ** p )

protected

Stores the tag attributes on a map. The map is an attribute of the parser object dedicated to the current xml tag

Definition at line 227 of file xmlParserBase.cxx.

 {
   if (p) while (*p)
     {
       string attributeName = (char*)*p;
       //cerr << "attribute name " << attributeName << endl;
       p++;
       string attributeValue = (char*)*p;
       //cerr << "attribute value " << attributeValue << endl;
       p++;
       _mapAttrib[attributeName] = attributeValue;
     }
 }

References p.

Referenced by YACS::ENGINE::sampleParser::init().

◆ getGarbageSize()

static int xmlParserBase::getGarbageSize ( )

inlinestatic

Definition at line 78 of file xmlParserBase.hxx.

78 {return _garbage.size(); };

References _garbage.

Referenced by xmlReader::parse().

◆ incrCount()

void xmlParserBase::incrCount ( const XML_Char * elem )

protectedvirtual

May be specialized for each kind of xml tag. Counts the number of tag occurences of a given type inside a context.

Definition at line 307 of file xmlParserBase.cxx.

 {
   if(counts.find(elem)==counts.end())
     counts[elem]=1;
   else
     counts[elem]=counts[elem]+1;
 }

Referenced by start_element().

◆ init()

void xmlParserBase::init	(	const xmlChar **	p,
		xmlParserBase *	father = `0`
	)

virtual

all parsers must know their father parser (father tag), in order to set values or attributes in father.

Reimplemented in YACS::ENGINE::sampleParser, YACS::ENGINE::loopPortParser, YACS::ENGINE::simpleTypeParser, YACS::ENGINE::dataParser, YACS::ENGINE::arrayParser, YACS::ENGINE::valueParser, YACS::ENGINE::portParser, YACS::ENGINE::attrParser, YACS::ENGINE::nodeParser, YACS::ENGINE::graphParser, YACS::ENGINE::stateParser, and outputParser.

Definition at line 277 of file xmlParserBase.cxx.

 {
   _father = father;
 }

Referenced by xmlReader::parse().

◆ onEnd()

void xmlParserBase::onEnd ( const XML_Char * name )

protectedvirtual

to be specialized for each kind of xml tag

Reimplemented in outputParser.

Definition at line 292 of file xmlParserBase.cxx.

293 {

294 }

Referenced by end_element().

◆ onStart()

void xmlParserBase::onStart	(	const XML_Char *	elem,
		const xmlChar **	p
	)

protectedvirtual

to be specialized for each kind of xml tag

Reimplemented in outputParser.

Definition at line 285 of file xmlParserBase.cxx.

286 {

287 }

Referenced by start_element().

◆ setAttribute()

void xmlParserBase::setAttribute	(	std::string	key,
		std::string	value
	)

Stores an attribute (key, value) on the map attribute. used for attributes defined at another tag level (child tags).

Definition at line 245 of file xmlParserBase.cxx.

 {
   _mapAttrib[key] = value;
 }

◆ start_document()

void XMLCALL xmlParserBase::start_document ( void * userData )

static

callback usable only with libxml2

Definition at line 54 of file xmlParserBase.cxx.

 {
   //DEBTRACE("xmlParserBase::start_document");
   xmlParserBase *currentParser = static_cast<xmlParserBase *> (userData);
 }

Referenced by xmlReader::parse().

◆ start_element()

void XMLCALL xmlParserBase::start_element	(	void *	userData,
		const xmlChar *	name,
		const xmlChar **	p
	)

static

callback called on start of an xml element:

<name>

Definition at line 72 of file xmlParserBase.cxx.

 {
   //DEBTRACE("xmlParserBase::start_element " << name);
   cleanGarbage();
   xmlParserBase *currentParser = static_cast<xmlParserBase *> (userData);
   const XML_Char *aName = tochar(name);
   currentParser->incrCount(aName);
   currentParser->onStart(aName, p);
 }

References incrCount(), onStart(), p, tochar(), and XML_Char.

Referenced by xmlReader::parse().

◆ stopParse()

void xmlParserBase::stopParse ( std::string what )

protectedvirtual

Throws an exception.

Definition at line 325 of file xmlParserBase.cxx.

 {
   xmlStopParser(_xmlParser);
 }

Referenced by YACS::ENGINE::sampleParser::onEnd(), and YACS::ENGINE::sampleParser::onStart().

◆ warning()

void XMLCALL xmlParserBase::warning	(	void *	userData,
		const char *	fmt,
			...
	)

static

callback usable only with libxml2

Definition at line 133 of file xmlParserBase.cxx.

 {
   DEBTRACE("xmlParserBase::warning");
   xmlParserBase *currentParser = static_cast<xmlParserBase *> (userData);
   va_list args;
   va_start(args, fmt);
   string format = "%s";
   if (format == fmt)
     {
       char* parv;
       parv = va_arg(args, char*);
       cerr << parv ;
     }
   else cerr << __FILE__ << " [" << __LINE__ << "] : " 
             << "error format not taken into account: " << fmt << endl;
   va_end(args);
 }

References driver_internal::args, and DEBTRACE.

Referenced by xmlReader::parse().

◆ XML_SetUserData()

void xmlParserBase::XML_SetUserData	(	_xmlParserCtxt *	ctxt,
		xmlParserBase *	parser
	)

static

Definition at line 37 of file xmlParserBase.cxx.

 {
   ctxt->userData = parser;
 }

Referenced by YACS::ENGINE::sampleParser::onStart().

Member Data Documentation

◆ _data

std::string xmlParserBase::_data

protected

Definition at line 106 of file xmlParserBase.hxx.

Referenced by YACS::ENGINE::sampleParser::charData(), and YACS::ENGINE::sampleParser::onEnd().

◆ _father

xmlParserBase* xmlParserBase::_father

protected

Definition at line 107 of file xmlParserBase.hxx.

Referenced by YACS::ENGINE::sampleParser::init().

◆ _garbage

std::list< xmlParserBase * > xmlParserBase::_garbage

staticprotected

Definition at line 105 of file xmlParserBase.hxx.

Referenced by getGarbageSize().

◆ _mapAttrib

std::map<std::string, std::string> xmlParserBase::_mapAttrib

protected

Definition at line 104 of file xmlParserBase.hxx.

Referenced by YACS::ENGINE::sampleParser::onEnd().

◆ _stackParser

std::stack< xmlParserBase * > xmlParserBase::_stackParser

static

Definition at line 91 of file xmlParserBase.hxx.

Referenced by YACS::ENGINE::sampleParser::onStart(), and xmlReader::parse().

◆ _xmlParser

_xmlParserCtxt * xmlParserBase::_xmlParser

static

Definition at line 87 of file xmlParserBase.hxx.

Referenced by YACS::ENGINE::sampleParser::onStart(), and xmlReader::parse().

◆ counts

std::map< std::string, int > xmlParserBase::counts

Definition at line 85 of file xmlParserBase.hxx.

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

src/yacsloader/xmlParserBase.hxx
src/yacsloader/xmlParserBase.cxx

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ addData()

◆ cdata_block()

◆ characters()

◆ charData()

◆ cleanGarbage()

◆ comment()

◆ end()

◆ end_document()

◆ end_element()

◆ error()

◆ fatal_error()

◆ getAttribute()

◆ getAttributes()

◆ getGarbageSize()

◆ incrCount()

◆ init()

◆ onEnd()

◆ onStart()

◆ setAttribute()

◆ start_document()

◆ start_element()

◆ stopParse()

◆ warning()

◆ XML_SetUserData()

Member Data Documentation

◆ _data

◆ _father

◆ _garbage

◆ _mapAttrib

◆ _stackParser

◆ _xmlParser

◆ counts