SUMOSAXReader.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2012-2024 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
/****************************************************************************/
// SAX-reader encapsulation containing binary reader
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <memory>
#include <vector>
#include <xercesc/sax2/SAX2XMLReader.hpp>
#include <xercesc/sax/EntityResolver.hpp>
#include <xercesc/sax/InputSource.hpp>
#include "SUMOXMLDefinitions.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GenericSAXHandler;
class IStreamInputSource;
class SUMOSAXAttributes;
 
// ===========================================================================
// class definitions
// ===========================================================================
class SUMOSAXReader {
 
public:
    SUMOSAXReader(GenericSAXHandler& handler, const std::string& validationScheme, XERCES_CPP_NAMESPACE::XMLGrammarPool* grammarPool);
 
    ~SUMOSAXReader();
 
    void setHandler(GenericSAXHandler& handler);
 
    void setValidation(std::string validationScheme = "");
 
    void parse(std::string systemID);
 
    void parseString(std::string content);
 
    bool parseFirst(std::string systemID);
 
    bool parseNext();
 
    bool parseSection(SumoXMLTag element);
 
private:
    class LocalSchemaResolver : public XERCES_CPP_NAMESPACE::EntityResolver {
 
    public:
        LocalSchemaResolver(const bool haveFallback, const bool noOp);
 
        XERCES_CPP_NAMESPACE::InputSource* resolveEntity(const XMLCh* const publicId, const XMLCh* const systemId);
 
    private:
        const bool myHaveFallback;
 
        const bool myNoOp;
    };
 
    void ensureSAXReader();
 
    GenericSAXHandler* myHandler;
 
    std::string myValidationScheme;
 
    XERCES_CPP_NAMESPACE::XMLGrammarPool* myGrammarPool;
 
    XERCES_CPP_NAMESPACE::XMLPScanToken myToken;
 
    XERCES_CPP_NAMESPACE::SAX2XMLReader* myXMLReader;
 
    std::unique_ptr<std::istream> myIStream;
 
    std::unique_ptr<IStreamInputSource> myInputStream;
 
    std::vector<SumoXMLTag> myXMLStack;
 
    LocalSchemaResolver mySchemaResolver;
 
    LocalSchemaResolver myLocalResolver;
 
    LocalSchemaResolver myNoOpResolver;
 
    std::pair<int, SUMOSAXAttributes*> myNextSection;
 
    SUMOSAXReader(const SUMOSAXReader& s) = delete;
 
    const SUMOSAXReader& operator=(const SUMOSAXReader& s) = delete;
};