XMLSubSys.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Utility methods for initialising, closing and using the XML-subsystem
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <xercesc/sax2/SAX2XMLReader.hpp>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GenericSAXHandler;
class SUMOSAXHandler;
class SUMOSAXReader;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class XMLSubSys {
public:
    static void init();
 
 
    static void setValidation(const std::string& validationScheme, const std::string& netValidationScheme, const std::string& routeValidationScheme);
 
 
    static void close();
 
 
    static SUMOSAXReader* getSAXReader(SUMOSAXHandler& handler,
                                       const bool isNet = false, const bool isRoute = false);
 
 
    static void setHandler(GenericSAXHandler& handler);
 
 
    static bool runParser(GenericSAXHandler& handler, const std::string& file,
                          const bool isNet = false, const bool isRoute = false,
                          const bool isExternal = false, const bool catchExceptions = true);
 
 
    static std::string transcode(const XMLCh* const data, int length = -1);
 
    static std::string transcodeFromLocal(const std::string& localString);
 
    static std::string transcodeToLocal(const std::string& utf8String);
 
 
private:
    static std::string warnLocalScheme(const std::string& newScheme, const bool haveSUMO_HOME);
 
private:
    static std::vector<SUMOSAXReader*> myReaders;
 
    static int myNextFreeReader;
 
    static std::string myValidationScheme;
 
    static std::string myNetValidationScheme;
 
    static std::string myRouteValidationScheme;
 
    static XERCES_CPP_NAMESPACE::XMLGrammarPool* myGrammarPool;
 
    static bool myNeedsValidationWarning;
 
    static XERCES_CPP_NAMESPACE::XMLLCPTranscoder* myLCPTranscoder;
 
};