OptionsLoader.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-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
/****************************************************************************/
// A SAX-Handler for loading options
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <xercesc/sax/HandlerBase.hpp>
#include <xercesc/sax/AttributeList.hpp>
#include <xercesc/sax/SAXParseException.hpp>
#include <xercesc/sax/SAXException.hpp>
#include <string>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class OptionsCont;
 
// ===========================================================================
// class definitions
// ===========================================================================
class OptionsLoader : public XERCES_CPP_NAMESPACE::HandlerBase {
 
public:
    OptionsLoader(OptionsCont& customOptions, const bool routeOnly = false);
 
    ~OptionsLoader();
 
 
    virtual void startElement(const XMLCh* const name,
                              XERCES_CPP_NAMESPACE::AttributeList& attributes);
 
    void characters(const XMLCh* const chars, const XERCES3_SIZE_t length);
 
    void endElement(const XMLCh* const name);
 
 
 
    void warning(const XERCES_CPP_NAMESPACE::SAXParseException& exception);
 
    void error(const XERCES_CPP_NAMESPACE::SAXParseException& exception);
 
    void fatalError(const XERCES_CPP_NAMESPACE::SAXParseException& exception);
 
    bool errorOccurred() const;
 
    const std::string& getItem() const {
        return myItem;
    }
 
private:
    const bool myRootOnly;
 
    bool myError = false;
 
    OptionsCont& myOptions;
 
    std::string myItem;
 
    std::string myValue;
 
    void setValue(const std::string& key, const std::string& value);
 
    bool setSecure(OptionsCont& options, const std::string& name, const std::string& value) const;
 
    OptionsLoader(const OptionsLoader& s) = delete;
 
    OptionsLoader& operator=(const OptionsLoader& s) = delete;
};