Eclipse SUMO - Simulation of Urban MObility
|
A handler which converts occurring elements and attributes into enums. More...
#include <GenericSAXHandler.h>
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. | |
GenericSAXHandler * | myParentHandler |
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 GenericSAXHandler & | operator= (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. | |
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.
|
private |
Definition at line 303 of file GenericSAXHandler.h.
|
private |
Definition at line 317 of file GenericSAXHandler.h.
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.
[in] | tags | The list of known tags |
[in] | terminatorTag | The tag which indicates the end of tags (usually the last entry) |
[in] | attrs | The list of known attributes |
[in] | terminatorAttr | The attr which indicates the end of attrs (usually the last entry) |
[in] | file | The name of the processed file |
[in] | expectedRoot | The expected root element, empty string disables the check |
Definition at line 39 of file GenericSAXHandler.cpp.
References convert(), SequentialStringBijection::Entry::key, myPredefinedTags, myPredefinedTagsMML, myTagMap, and SequentialStringBijection::Entry::str.
|
virtual |
Destructor.
Definition at line 65 of file GenericSAXHandler.cpp.
References myNextSectionStart, and myPredefinedTags.
|
private |
invalidated copy constructor
|
protected |
Builds an error message.
The error message includes the file name and the line/column information as supported by the given SAXParseException
[in] | exception | The name of the currently processed file |
Definition at line 205 of file GenericSAXHandler.cpp.
References getFileName(), and TL.
Referenced by error(), fatalError(), and warning().
|
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().
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.
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().
|
private |
converts from c++-string into unicode
[in] | name | The string to convert |
Definition at line 86 of file GenericSAXHandler.cpp.
Referenced by GenericSAXHandler().
|
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.
[in] | tag | The string to convert |
Definition at line 195 of file GenericSAXHandler.cpp.
References myTagMap, and SUMO_TAG_NOTHING.
Referenced by endElement(), and startElement().
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.
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().
void GenericSAXHandler::error | ( | const XERCES_CPP_NAMESPACE::SAXParseException & | exception | ) |
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.
[in] | exception | The occurred exception to process |
ProcessError | On any call |
Definition at line 224 of file GenericSAXHandler.cpp.
References buildErrorMessage().
Referenced by MSRouteHandler::addFlowTransportable(), MSRouteHandler::addTransportable(), MSRouteHandler::closeTransportable(), NIImporter_OpenDrive::geomFromSpiral(), MSRouteHandler::interpretDepartPosLat(), and DataHandler::writeError().
void GenericSAXHandler::fatalError | ( | const XERCES_CPP_NAMESPACE::SAXParseException & | exception | ) |
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.
ProcessError | On any call |
[in] | exception | The occurred exception to process |
Definition at line 230 of file GenericSAXHandler.cpp.
References buildErrorMessage().
const std::string & GenericSAXHandler::getFileName | ( | ) | const |
returns the current file name
Definition at line 80 of file GenericSAXHandler.cpp.
References myFileName.
Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), ShapeHandler::addPOI(), ShapeHandler::addPoly(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), buildErrorMessage(), PCNetProjectionLoader::load(), NLHandler::myEndElement(), RODFDetectorHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), NIXMLConnectionsHandler::myStartElement(), NIXMLEdgesHandler::myStartElement(), NIXMLNodesHandler::myStartElement(), NLHandler::myStartElement(), GUISettingsHandler::myStartElement(), SUMORouteHandler::myStartElement(), DataHandler::parse(), GeneralHandler::parse(), XMLSubSys::runParser(), startElement(), and SUMORouteLoader::SUMORouteLoader().
|
protectedvirtual |
Callback method for characters to implement by derived classes.
Called by "endElement" (see there).
[in] | element | The opened element, given as a int |
[in] | chars | The 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().
|
protectedvirtual |
Callback method for a closing tag to implement by derived classes.
Called by "endElement" (see there).
[in] | element | The 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().
|
protectedvirtual |
Callback method for an opening tag to implement by derived classes.
Called by "startElement" (see there).
[in] | element | The element that contains the characters, given as a int |
[in] | attrs | The 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().
|
inline |
Definition at line 220 of file GenericSAXHandler.h.
References myCollectCharacterData.
Referenced by NIImporter_ITSUMO::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), and NIImporter_OpenDrive::myCharacters().
|
private |
invalidated assignment operator
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().
|
inline |
Definition at line 213 of file GenericSAXHandler.h.
References myNextSectionStart.
Referenced by SUMOSAXReader::parseSection().
|
inline |
Definition at line 209 of file GenericSAXHandler.h.
References mySectionEnded.
Referenced by SUMOSAXReader::parseSection().
void GenericSAXHandler::setFileName | ( | const std::string & | name | ) |
Sets the current file name.
[in] | name | The name of the currently processed file |
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().
|
inline |
Definition at line 202 of file GenericSAXHandler.h.
References mySection, mySectionEnded, mySectionOpen, and mySectionSeen.
Referenced by SUMOSAXReader::parseSection().
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.
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.
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.
[in] | exception | The occurred exception to process |
Definition at line 218 of file GenericSAXHandler.cpp.
References buildErrorMessage(), and WRITE_WARNING.
|
friend |
Definition at line 225 of file GenericSAXHandler.h.
|
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().
|
private |
whether the reader should collect character data
Definition at line 339 of file GenericSAXHandler.h.
Referenced by characters(), and needsCharacterData().
|
private |
The root element to expect, empty string disables the check.
Definition at line 336 of file GenericSAXHandler.h.
Referenced by startElement().
|
private |
The name of the currently parsed file.
Definition at line 333 of file GenericSAXHandler.h.
Referenced by getFileName(), and setFileName().
|
private |
Definition at line 356 of file GenericSAXHandler.h.
Referenced by retrieveNextSectionStart(), startElement(), and ~GenericSAXHandler().
|
private |
The handler to give control back to.
Definition at line 327 of file GenericSAXHandler.h.
Referenced by callParentEnd(), endElement(), and registerParent().
|
private |
The tag indicating that control should be given back.
Definition at line 330 of file GenericSAXHandler.h.
Referenced by endElement(), and registerParent().
|
private |
Definition at line 306 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler(), startElement(), and ~GenericSAXHandler().
|
private |
the map from ids to their string representation
Definition at line 309 of file GenericSAXHandler.h.
Referenced by GenericSAXHandler(), and startElement().
|
private |
whether the reader has already seen the root element
Definition at line 342 of file GenericSAXHandler.h.
Referenced by startElement().
|
private |
The tag indicating the current section to parse.
Definition at line 345 of file GenericSAXHandler.h.
Referenced by endElement(), setSection(), and startElement().
|
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().
|
private |
whether an element of the current section is open
Definition at line 354 of file GenericSAXHandler.h.
Referenced by endElement(), setSection(), and startElement().
|
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().
|
private |
Definition at line 320 of file GenericSAXHandler.h.
Referenced by convertTag(), and GenericSAXHandler().