Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
GenericSAXHandler Class Reference

A handler which converts occurring elements and attributes into enums. More...

#include <GenericSAXHandler.h>

Inheritance diagram for GenericSAXHandler:
[legend]
Collaboration diagram for GenericSAXHandler:
[legend]

Public Member Functions

void characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
 The inherited method called when characters occurred.
 
void endElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname)
 The inherited method called when a tag is being closed.
 
 GenericSAXHandler (SequentialStringBijection::Entry *tags, int terminatorTag, SequentialStringBijection::Entry *attrs, int terminatorAttr, const std::string &file, const std::string &expectedRoot="")
 Constructor.
 
const std::string & getFileName () const
 returns the current file name
 
void registerParent (const int tag, GenericSAXHandler *handler)
 Assigning a parent handler which is enabled when the specified tag is closed.
 
void setFileName (const std::string &name)
 Sets the current file name.
 
void startElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname, const XERCES_CPP_NAMESPACE::Attributes &attrs)
 The inherited method called when a new tag opens.
 
virtual ~GenericSAXHandler ()
 Destructor.
 

attributes parsing

typedef std::vector< XMLCh * > AttrMap
 
AttrMap myPredefinedTags
 
std::vector< std::string > myPredefinedTagsMML
 the map from ids to their string representation
 

elements parsing

typedef std::map< std::string, int > TagMap
 
TagMap myTagMap
 
std::vector< std::string > myCharactersVector
 A list of character strings obtained so far to build the complete characters string at the end.
 
GenericSAXHandlermyParentHandler
 The handler to give control back to.
 
int myParentIndicator
 The tag indicating that control should be given back.
 
std::string myFileName
 The name of the currently parsed file.
 
std::string myExpectedRoot
 The root element to expect, empty string disables the check.
 
bool myCollectCharacterData = false
 whether the reader should collect character data
 
bool myRootSeen = false
 whether the reader has already seen the root element
 
int mySection = -1
 The tag indicating the current section to parse.
 
bool mySectionSeen = false
 whether the reader has already seen the begin of the section
 
bool mySectionEnded = false
 whether the reader has already seen the end of the section
 
bool mySectionOpen = false
 whether an element of the current section is open
 
std::pair< int, SUMOSAXAttributes * > myNextSectionStart
 
 GenericSAXHandler (const GenericSAXHandler &s)
 invalidated copy constructor
 
const GenericSAXHandleroperator= (const GenericSAXHandler &s)
 invalidated assignment operator
 

SAX ErrorHandler callbacks

class SUMOSAXReader
 
void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-warnings.
 
void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors.
 
void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors.
 
void setSection (const int element, const bool seen)
 
bool sectionFinished () const
 
std::pair< int, SUMOSAXAttributes * > retrieveNextSectionStart ()
 
void needsCharacterData (const bool value=true)
 
std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Builds an error message.
 
virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Callback method for an opening tag to implement by derived classes.
 
virtual void myCharacters (int element, const std::string &chars)
 Callback method for characters to implement by derived classes.
 
virtual void myEndElement (int element)
 Callback method for a closing tag to implement by derived classes.
 
void callParentEnd (int element)
 signal endElement to the parent handler (special case for MSCalibrator)
 
XMLCh * convert (const std::string &name) const
 converts from c++-string into unicode
 
int convertTag (const std::string &tag) const
 Converts a tag from its string into its numerical representation.
 

Detailed Description

A handler which converts occurring elements and attributes into enums.

Normally, when using a standard SAX-handler, we would have to compare the incoming XMLCh*-element names with the ones we can parse. The same applies to parsing the attributes. This was assumed to be very time consuming, that's why we derive our handlers from this class.

The idea behind this second handler layer was avoid repeated conversion from strings/whatever to XMLCh* and back again. The usage is quite straight forward, the only overhead is the need to define the enums - both elements and attributes within "SUMOXMLDefinitions". Still, it maybe helps to avoid typos.

This class implements the SAX-callback and offers a new set of callbacks which must be implemented by derived classes. Instead of XMLCh*-values, element names are supplied to the derived classes as enums (int).

Also, this class allows to retrieve attributes using enums (int) within the implemented "myStartElement" method.

Basically, GenericSAXHandler is not derived within SUMO directly, but via SUMOSAXHandler which knows all tags/attributes used by SUMO. It is still kept separate for an easier maintainability and later extensions.

Definition at line 65 of file GenericSAXHandler.h.

Member Typedef Documentation

◆ AttrMap

typedef std::vector<XMLCh*> GenericSAXHandler::AttrMap
private

Definition at line 303 of file GenericSAXHandler.h.

◆ TagMap

typedef std::map<std::string, int> GenericSAXHandler::TagMap
private

Definition at line 317 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ GenericSAXHandler() [1/2]

GenericSAXHandler::GenericSAXHandler ( SequentialStringBijection::Entry tags,
int  terminatorTag,
SequentialStringBijection::Entry attrs,
int  terminatorAttr,
const std::string &  file,
const std::string &  expectedRoot = "" 
)

Constructor.

This constructor gets the lists of known tag and attribute names with their enums (sumotags and sumoattrs in most cases). The end of the list is signaled by terminatorTag/terminatorAttr respectively.

The attribute names are converted into XMLCh* and stored within an internal container. This container is cleared within the destructor.

Parameters
[in]tagsThe list of known tags
[in]terminatorTagThe tag which indicates the end of tags (usually the last entry)
[in]attrsThe list of known attributes
[in]terminatorAttrThe attr which indicates the end of attrs (usually the last entry)
[in]fileThe name of the processed file
[in]expectedRootThe expected root element, empty string disables the check
Todo:
Why are both lists non-const and given as pointers?

Definition at line 39 of file GenericSAXHandler.cpp.

References convert(), SequentialStringBijection::Entry::key, myPredefinedTags, myPredefinedTagsMML, myTagMap, and SequentialStringBijection::Entry::str.

◆ ~GenericSAXHandler()

GenericSAXHandler::~GenericSAXHandler ( )
virtual

Destructor.

Definition at line 65 of file GenericSAXHandler.cpp.

References myNextSectionStart, and myPredefinedTags.

◆ GenericSAXHandler() [2/2]

GenericSAXHandler::GenericSAXHandler ( const GenericSAXHandler s)
private

invalidated copy constructor

Member Function Documentation

◆ buildErrorMessage()

std::string GenericSAXHandler::buildErrorMessage ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)
protected

Builds an error message.

The error message includes the file name and the line/column information as supported by the given SAXParseException

Parameters
[in]exceptionThe name of the currently processed file
Returns
A string describing the given exception

Definition at line 205 of file GenericSAXHandler.cpp.

References getFileName(), and TL.

Referenced by error(), fatalError(), and warning().

Here is the caller graph for this function:

◆ callParentEnd()

void GenericSAXHandler::callParentEnd ( int  element)
protected

signal endElement to the parent handler (special case for MSCalibrator)

Definition at line 247 of file GenericSAXHandler.cpp.

References myEndElement(), and myParentHandler.

Referenced by MSCalibrator::myEndElement().

Here is the caller graph for this function:

◆ characters()

void GenericSAXHandler::characters ( const XMLCh *const  chars,
const XERCES3_SIZE_t  length 
)

The inherited method called when characters occurred.

The retrieved characters are converted into a string and appended into a private buffer. They are reported as soon as the element ends.

Todo:

recheck/describe what happens with characters when a new element is opened

describe characters processing in the class' head

Definition at line 186 of file GenericSAXHandler.cpp.

References myCharactersVector, myCollectCharacterData, and StringUtils::transcode().

◆ convert()

XMLCh * GenericSAXHandler::convert ( const std::string &  name) const
private

converts from c++-string into unicode

Todo:
recheck encoding
Parameters
[in]nameThe string to convert
Returns
The string converted into a XMLCh-string

Definition at line 86 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler().

Here is the caller graph for this function:

◆ convertTag()

int GenericSAXHandler::convertTag ( const std::string &  tag) const
private

Converts a tag from its string into its numerical representation.

Returns the enum-representation stored for the given tag. If the tag is not known, SUMO_TAG_NOTHING is returned.

Parameters
[in]tagThe string to convert
Returns
The int-value that represents the string, SUMO_TAG_NOTHING if the named attribute is not known

Definition at line 195 of file GenericSAXHandler.cpp.

References myTagMap, and SUMO_TAG_NOTHING.

Referenced by endElement(), and startElement().

Here is the caller graph for this function:

◆ endElement()

void GenericSAXHandler::endElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname 
)

The inherited method called when a tag is being closed.

This method calls the user-implemented methods myCharacters with the previously collected and converted characters.

Then, myEndElement is called, supplying it the qname converted to its enum- and string-representations.

Todo:

recheck/describe encoding of the string-representation

do not generate and report the string-representation

Definition at line 134 of file GenericSAXHandler.cpp.

References convertTag(), myCharacters(), myCharactersVector, myEndElement(), myParentHandler, myParentIndicator, mySection, mySectionOpen, XMLSubSys::setHandler(), SUMO_TAG_INCLUDE, SUMO_TAG_NOTHING, and StringUtils::transcode().

◆ error()

void GenericSAXHandler::error ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Parameters
[in]exceptionThe occurred exception to process
Exceptions
ProcessErrorOn any call

Definition at line 224 of file GenericSAXHandler.cpp.

References buildErrorMessage().

Referenced by MSRouteHandler::addFlowTransportable(), MSRouteHandler::addTransportable(), MSRouteHandler::closeTransportable(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::interpretDepartPosLat().

Here is the caller graph for this function:

◆ fatalError()

void GenericSAXHandler::fatalError ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Exceptions
ProcessErrorOn any call
Parameters
[in]exceptionThe occurred exception to process

Definition at line 230 of file GenericSAXHandler.cpp.

References buildErrorMessage().

◆ getFileName()

◆ myCharacters()

void GenericSAXHandler::myCharacters ( int  element,
const std::string &  chars 
)
protectedvirtual

Callback method for characters to implement by derived classes.

Called by "endElement" (see there).

Parameters
[in]elementThe opened element, given as a int
[in]charsThe complete embedded character string @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_ITSUMO::Handler, and NIImporter_OpenDrive.

Definition at line 240 of file GenericSAXHandler.cpp.

Referenced by endElement().

Here is the caller graph for this function:

◆ myEndElement()

void GenericSAXHandler::myEndElement ( int  element)
protectedvirtual

Callback method for a closing tag to implement by derived classes.

Called by "endElement" (see there).

Parameters
[in]elementThe closed element, given as a int @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in GUITriggeredRerouter, ROMARouteHandler, VehicleEngineHandler, MSStateHandler, MSCalibrator, MSLaneSpeedTrigger, MSTriggeredRerouter, NIImporter_ITSUMO::Handler, NIImporter_OpenDrive, NIImporter_SUMO, NIXMLConnectionsHandler, NIXMLEdgesHandler, NIXMLNodesHandler, NIXMLPTHandler, NIXMLTrafficLightsHandler, NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition, NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition, NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition, NLHandler, ODDistrictHandler, PCLoaderOSM::NodesHandler, PCLoaderOSM::RelationsHandler, PCLoaderOSM::EdgesHandler, RONetHandler, GUISettingsHandler, DataHandler, GeneralHandler, ShapeHandler, SUMORouteHandler, NIImporter_OpenStreetMap::NodesHandler, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_OpenStreetMap::RelationHandler, and SAXWeightsHandler.

Definition at line 244 of file GenericSAXHandler.cpp.

Referenced by callParentEnd(), and endElement().

Here is the caller graph for this function:

◆ myStartElement()

void GenericSAXHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
protectedvirtual

Callback method for an opening tag to implement by derived classes.

Called by "startElement" (see there).

Parameters
[in]elementThe element that contains the characters, given as a int
[in]attrsThe SAX-attributes, wrapped as SUMOSAXAttributes @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in AGActivityGenHandler, RODFDetectorHandler, GUINet::DiscoverAttributes, ROJTRTurnDefLoader, ROMARouteHandler, VehicleEngineHandler, MSStateHandler::MSStateTimeHandler, MSStateHandler, MSCalibrator, MSLaneSpeedTrigger, MSTriggeredRerouter, GNEMultipleParametersDialog::ParametersOperations::GNEParameterHandler, GNESingleParametersDialog::ParametersOperations::GNEParameterHandler, GNEVTypeDistributionsDialog::ParametersOperations::GNEParameterHandler, NIImporter_ITSUMO::Handler, NIImporter_MATSim::NodesHandler, NIImporter_MATSim::EdgesHandler, NIImporter_OpenDrive, NIImporter_SUMO, NIXMLConnectionsHandler, NIXMLEdgesHandler, NIXMLNodesHandler, NIXMLPTHandler, NIXMLTrafficLightsHandler, NIXMLTypesHandler, NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition, NIImporter_Vissim::NIVissimXMLHandler_Zuflussdefinition, NIImporter_Vissim::NIVissimXMLHandler_Parkplatzdefinition, NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition, NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_ConflictArea, NLHandler, NLNetShapeHandler, ODAmitranHandler, ODDistrictHandler, PCLoaderOSM::NodesHandler, PCLoaderOSM::RelationsHandler, PCLoaderOSM::EdgesHandler, PCLoaderXML, PCNetProjectionLoader, PCTypeDefHandler, RONetHandler, TrajectoriesHandler, GUISettingsHandler, DataHandler, GeneralHandler, ShapeHandler, SUMORouteHandler, SAXWeightsHandler, MSDevice_FCDReplay::FCDHandler, MSRouteHandler, NIImporter_OpenStreetMap::NodesHandler, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_OpenStreetMap::RelationHandler, and RORouteHandler.

Definition at line 236 of file GenericSAXHandler.cpp.

Referenced by SUMOSAXReader::parseSection(), and startElement().

Here is the caller graph for this function:

◆ needsCharacterData()

void GenericSAXHandler::needsCharacterData ( const bool  value = true)
inline

Definition at line 220 of file GenericSAXHandler.h.

References myCollectCharacterData.

Referenced by NIImporter_ITSUMO::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), and NIImporter_OpenDrive::myCharacters().

Here is the caller graph for this function:

◆ operator=()

const GenericSAXHandler & GenericSAXHandler::operator= ( const GenericSAXHandler s)
private

invalidated assignment operator

◆ registerParent()

void GenericSAXHandler::registerParent ( const int  tag,
GenericSAXHandler handler 
)

Assigning a parent handler which is enabled when the specified tag is closed.

Definition at line 178 of file GenericSAXHandler.cpp.

References myParentHandler, myParentIndicator, and XMLSubSys::setHandler().

Referenced by NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), and NLTriggerBuilder::parseAndBuildRerouter().

Here is the caller graph for this function:

◆ retrieveNextSectionStart()

std::pair< int, SUMOSAXAttributes * > GenericSAXHandler::retrieveNextSectionStart ( )
inline

Definition at line 213 of file GenericSAXHandler.h.

References myNextSectionStart.

Referenced by SUMOSAXReader::parseSection().

Here is the caller graph for this function:

◆ sectionFinished()

bool GenericSAXHandler::sectionFinished ( ) const
inline

Definition at line 209 of file GenericSAXHandler.h.

References mySectionEnded.

Referenced by SUMOSAXReader::parseSection().

Here is the caller graph for this function:

◆ setFileName()

void GenericSAXHandler::setFileName ( const std::string &  name)

Sets the current file name.

Parameters
[in]nameThe name of the currently processed file
Todo:
Hmmm - this is as unsafe as having a direct access to the variable; recheck

Definition at line 74 of file GenericSAXHandler.cpp.

References myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), MSStateHandler::MSStateTimeHandler::getTime(), GUISettingsHandler::GUISettingsHandler(), NIImporter_OpenStreetMap::load(), NIImporter_Vissim::load(), PCNetProjectionLoader::load(), NITypeLoader::load(), loadNet(), ROLoader::loadNet(), NIImporter_ITSUMO::loadNetwork(), NIImporter_MATSim::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), main(), and XMLSubSys::runParser().

Here is the caller graph for this function:

◆ setSection()

void GenericSAXHandler::setSection ( const int  element,
const bool  seen 
)
inline

Definition at line 202 of file GenericSAXHandler.h.

References mySection, mySectionEnded, mySectionOpen, and mySectionSeen.

Referenced by SUMOSAXReader::parseSection().

Here is the caller graph for this function:

◆ startElement()

void GenericSAXHandler::startElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname,
const XERCES_CPP_NAMESPACE::Attributes &  attrs 
)

The inherited method called when a new tag opens.

The method parses the supplied XMLCh*-qname using the internal name/enum-map to obtain the enum representation of the attribute name.

Then, "myStartElement" is called supplying the enumeration value, the string-representation of the name and the attributes.

Todo:

recheck/describe encoding of the string-representation

do not generate and report the string-representation

Definition at line 99 of file GenericSAXHandler.cpp.

References convertTag(), FileHelpers::getConfigurationRelative(), getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), myCharactersVector, myExpectedRoot, myNextSectionStart, myPredefinedTags, myPredefinedTagsMML, myRootSeen, mySection, mySectionEnded, mySectionOpen, mySectionSeen, myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, SUMO_TAG_INCLUDE, TL, StringUtils::transcode(), and WRITE_WARNINGF.

◆ warning()

void GenericSAXHandler::warning ( const XERCES_CPP_NAMESPACE::SAXParseException &  exception)

Handler for XML-warnings.

The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.

Parameters
[in]exceptionThe occurred exception to process

Definition at line 218 of file GenericSAXHandler.cpp.

References buildErrorMessage(), and WRITE_WARNING.

Friends And Related Symbol Documentation

◆ SUMOSAXReader

friend class SUMOSAXReader
friend

Definition at line 225 of file GenericSAXHandler.h.

Field Documentation

◆ myCharactersVector

std::vector<std::string> GenericSAXHandler::myCharactersVector
private

A list of character strings obtained so far to build the complete characters string at the end.

Definition at line 324 of file GenericSAXHandler.h.

Referenced by characters(), endElement(), and startElement().

◆ myCollectCharacterData

bool GenericSAXHandler::myCollectCharacterData = false
private

whether the reader should collect character data

Definition at line 339 of file GenericSAXHandler.h.

Referenced by characters(), and needsCharacterData().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot
private

The root element to expect, empty string disables the check.

Definition at line 336 of file GenericSAXHandler.h.

Referenced by startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName
private

The name of the currently parsed file.

Definition at line 333 of file GenericSAXHandler.h.

Referenced by getFileName(), and setFileName().

◆ myNextSectionStart

std::pair<int, SUMOSAXAttributes*> GenericSAXHandler::myNextSectionStart
private

Definition at line 356 of file GenericSAXHandler.h.

Referenced by retrieveNextSectionStart(), startElement(), and ~GenericSAXHandler().

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler
private

The handler to give control back to.

Definition at line 327 of file GenericSAXHandler.h.

Referenced by callParentEnd(), endElement(), and registerParent().

◆ myParentIndicator

int GenericSAXHandler::myParentIndicator
private

The tag indicating that control should be given back.

Definition at line 330 of file GenericSAXHandler.h.

Referenced by endElement(), and registerParent().

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags
private

Definition at line 306 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), startElement(), and ~GenericSAXHandler().

◆ myPredefinedTagsMML

std::vector<std::string> GenericSAXHandler::myPredefinedTagsMML
private

the map from ids to their string representation

Definition at line 309 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler(), and startElement().

◆ myRootSeen

bool GenericSAXHandler::myRootSeen = false
private

whether the reader has already seen the root element

Definition at line 342 of file GenericSAXHandler.h.

Referenced by startElement().

◆ mySection

int GenericSAXHandler::mySection = -1
private

The tag indicating the current section to parse.

Definition at line 345 of file GenericSAXHandler.h.

Referenced by endElement(), setSection(), and startElement().

◆ mySectionEnded

bool GenericSAXHandler::mySectionEnded = false
private

whether the reader has already seen the end of the section

Definition at line 351 of file GenericSAXHandler.h.

Referenced by sectionFinished(), setSection(), and startElement().

◆ mySectionOpen

bool GenericSAXHandler::mySectionOpen = false
private

whether an element of the current section is open

Definition at line 354 of file GenericSAXHandler.h.

Referenced by endElement(), setSection(), and startElement().

◆ mySectionSeen

bool GenericSAXHandler::mySectionSeen = false
private

whether the reader has already seen the begin of the section

Definition at line 348 of file GenericSAXHandler.h.

Referenced by setSection(), and startElement().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap
private

Definition at line 320 of file GenericSAXHandler.h.

Referenced by convertTag(), and GenericSAXHandler().


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