Eclipse SUMO - Simulation of Urban MObility
XMLSubSys.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2002-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
16 // Utility methods for initialising, closing and using the XML-subsystem
17 /****************************************************************************/
18 
19 
20 // ===========================================================================
21 // included modules
22 // ===========================================================================
23 #include <config.h>
24 
25 #include <cstdint>
26 #include <xercesc/util/PlatformUtils.hpp>
29 #include "SUMOSAXHandler.h"
30 #include "SUMOSAXReader.h"
31 #include "XMLSubSys.h"
32 
33 
34 // ===========================================================================
35 // static member variables
36 // ===========================================================================
37 std::vector<SUMOSAXReader*> XMLSubSys::myReaders;
39 XERCES_CPP_NAMESPACE::SAX2XMLReader::ValSchemes XMLSubSys::myValidationScheme = XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Auto;
40 XERCES_CPP_NAMESPACE::SAX2XMLReader::ValSchemes XMLSubSys::myNetValidationScheme = XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Auto;
41 
42 
43 // ===========================================================================
44 // method definitions
45 // ===========================================================================
46 void
48  try {
49  XERCES_CPP_NAMESPACE::XMLPlatformUtils::Initialize();
50  myNextFreeReader = 0;
51  } catch (const XERCES_CPP_NAMESPACE::XMLException& e) {
52  throw ProcessError("Error during XML-initialization:\n " + StringUtils::transcode(e.getMessage()));
53  }
54 }
55 
56 
57 void
58 XMLSubSys::setValidation(const std::string& validationScheme, const std::string& netValidationScheme) {
59  if (validationScheme == "never") {
60  myValidationScheme = XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Never;
61  } else if (validationScheme == "auto") {
62  myValidationScheme = XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Auto;
63  } else if (validationScheme == "always") {
64  myValidationScheme = XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Always;
65  } else {
66  throw ProcessError("Unknown xml validation scheme + '" + validationScheme + "'.");
67  }
68  if (netValidationScheme == "never") {
69  myNetValidationScheme = XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Never;
70  } else if (netValidationScheme == "auto") {
71  myNetValidationScheme = XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Auto;
72  } else if (netValidationScheme == "always") {
73  myNetValidationScheme = XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Always;
74  } else {
75  throw ProcessError("Unknown network validation scheme + '" + netValidationScheme + "'.");
76  }
77 }
78 
79 
80 bool
81 XMLSubSys::isValidating(const bool net) {
82  if (net) {
83  return myNetValidationScheme != XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Never;
84  }
85  return myValidationScheme != XERCES_CPP_NAMESPACE::SAX2XMLReader::Val_Never;
86 }
87 
88 
89 void
91  for (std::vector<SUMOSAXReader*>::iterator i = myReaders.begin(); i != myReaders.end(); ++i) {
92  delete *i;
93  }
94  myReaders.clear();
95  XERCES_CPP_NAMESPACE::XMLPlatformUtils::Terminate();
96 }
97 
98 
101  return new SUMOSAXReader(handler, myValidationScheme);
102 }
103 
104 
105 void
107  myReaders[myNextFreeReader - 1]->setHandler(handler);
108 }
109 
110 
111 bool
113  const std::string& file, const bool isNet) {
115  try {
116  XERCES_CPP_NAMESPACE::SAX2XMLReader::ValSchemes validationScheme = isNet ? myNetValidationScheme : myValidationScheme;
117  if (myNextFreeReader == (int)myReaders.size()) {
118  myReaders.push_back(new SUMOSAXReader(handler, validationScheme));
119  } else {
120  myReaders[myNextFreeReader]->setValidation(validationScheme);
121  myReaders[myNextFreeReader]->setHandler(handler);
122  }
124  std::string prevFile = handler.getFileName();
125  handler.setFileName(file);
126  myReaders[myNextFreeReader - 1]->parse(file);
127  handler.setFileName(prevFile);
129  } catch (ProcessError& e) {
130  WRITE_ERROR(std::string(e.what()) != std::string("") ? std::string(e.what()) : std::string("Process Error"));
131  return false;
132  } catch (const std::runtime_error& re) {
133  WRITE_ERROR("Runtime error: " + std::string(re.what()) + " while parsing '" + file + "'");
134  return false;
135  } catch (const std::exception& ex) {
136  WRITE_ERROR("Error occurred: " + std::string(ex.what()) + " while parsing '" + file + "'");
137  return false;
138  } catch (...) {
139  WRITE_ERROR("Unspecified error occurred wile parsing '" + file + "'");
140  return false;
141  }
143 }
144 
145 
146 /****************************************************************************/
147 
XMLSubSys::myReaders
static std::vector< SUMOSAXReader * > myReaders
The XML Readers used for repeated parsing.
Definition: XMLSubSys.h:154
XMLSubSys::runParser
static bool runParser(GenericSAXHandler &handler, const std::string &file, const bool isNet=false)
Runs the given handler on the given file; returns if everything's ok.
Definition: XMLSubSys.cpp:112
SUMOSAXHandler
SAX-handler base for SUMO-files.
Definition: SUMOSAXHandler.h:41
MsgHandler::wasInformed
bool wasInformed() const
Returns the information whether any messages were added.
Definition: MsgHandler.cpp:279
XMLSubSys::close
static void close()
Closes the xml-subsystem.
Definition: XMLSubSys.cpp:90
MsgHandler.h
SUMOSAXReader
SAX-reader encapsulation containing binary reader.
Definition: SUMOSAXReader.h:55
SUMOSAXHandler.h
XMLSubSys::setHandler
static void setHandler(GenericSAXHandler &handler)
Sets the given handler for the default reader.
Definition: XMLSubSys.cpp:106
XMLSubSys::myNextFreeReader
static int myNextFreeReader
Information whether the reader is parsing.
Definition: XMLSubSys.h:157
MsgHandler::clear
virtual void clear()
Clears information whether an error occurred previously.
Definition: MsgHandler.cpp:160
XMLSubSys::setValidation
static void setValidation(const std::string &validationScheme, const std::string &netValidationScheme)
Enables or disables validation.
Definition: XMLSubSys.cpp:58
ProcessError
Definition: UtilExceptions.h:39
XMLSubSys::init
static void init()
Initialises the xml-subsystem.
Definition: XMLSubSys.cpp:47
StringUtils.h
StringUtils::transcode
static std::string transcode(const XMLCh *const data)
converts a 0-terminated XMLCh* array (usually UTF-16, stemming from Xerces) into std::string in UTF-8
Definition: StringUtils.h:136
XMLSubSys::isValidating
static bool isValidating(const bool net=false)
Returns whether validation is enabled.
Definition: XMLSubSys.cpp:81
XMLSubSys::myValidationScheme
static XERCES_CPP_NAMESPACE::SAX2XMLReader::ValSchemes myValidationScheme
Information whether built reader/parser shall validate XML-documents against schemata.
Definition: XMLSubSys.h:160
GenericSAXHandler::getFileName
const std::string & getFileName() const
returns the current file name
Definition: GenericSAXHandler.cpp:74
config.h
SUMOSAXReader.h
MsgHandler::getErrorInstance
static MsgHandler * getErrorInstance()
Returns the instance to add errors to.
Definition: MsgHandler.cpp:81
GenericSAXHandler
A handler which converts occuring elements and attributes into enums.
Definition: GenericSAXHandler.h:67
XMLSubSys::getSAXReader
static SUMOSAXReader * getSAXReader(SUMOSAXHandler &handler)
Builds a reader and assigns the handler to it.
Definition: XMLSubSys.cpp:100
WRITE_ERROR
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:283
GenericSAXHandler::setFileName
void setFileName(const std::string &name)
Sets the current file name.
Definition: GenericSAXHandler.cpp:68
XMLSubSys.h
XMLSubSys::myNetValidationScheme
static XERCES_CPP_NAMESPACE::SAX2XMLReader::ValSchemes myNetValidationScheme
Information whether built reader/parser shall validate SUMO networks against schemata.
Definition: XMLSubSys.h:163