OptionsCont.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 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 storage for options (typed value containers)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <map>
#include <string>
#include <vector>
#include <iostream>
#include "Option.h"
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class OptionsCont {
 
public:
    static OptionsCont& getOptions();
 
    static OptionsCont EMPTY_OPTIONS;
 
    OptionsCont();
 
    ~OptionsCont();
 
 
    void setApplicationName(const std::string& appName, const std::string& fullName);
 
    void setApplicationDescription(const std::string& appDesc);
 
    void addCallExample(const std::string& example, const std::string& desc);
 
    void setAdditionalHelpMessage(const std::string& add);
 
    void addCopyrightNotice(const std::string& copyrightLine);
 
    void clearCopyrightNotices();
 
    void addOptionSubTopic(const std::string& topic);
 
    void printHelp(std::ostream& os);
 
    void printHelpOnTopic(const std::string& topic, int tooLarge, int maxSize, std::ostream& os);
 
    void writeConfiguration(std::ostream& os, const bool filled,
                            const bool complete, const bool addComments, const std::string& relativeTo = "",
                            const bool forceRelative = false, const bool inComment = false, const std::string& indent = "") const;
 
    void writeSchema(std::ostream& os);
 
    void writeXMLHeader(std::ostream& os, const bool includeConfig = true) const;
 
 
 
    void doRegister(const std::string& name, Option* o);
 
    void doRegister(const std::string& name, char abbr, Option* o);
 
    void addSynonyme(const std::string& name1, const std::string& name2, bool isDeprecated = false);
 
    void addXMLDefault(const std::string& name, const std::string& xmlRoot = "");
 
    void addDescription(const std::string& name, const std::string& subtopic, const std::string& description);
 
    void setFurtherAttributes(const std::string& name, const std::string& subtopic, bool required, bool positional, const std::string& listSep);
 
    void setOptionEditable(const std::string& name, const bool value);
 
 
 
    bool exists(const std::string& name) const;
 
    bool isSet(const std::string& name, bool failOnNonExistant = true) const;
 
    bool isDefault(const std::string& name) const;
 
    bool isBool(const std::string& name) const;
 
    bool isUsableFileList(const std::string& name) const;
 
    bool checkDependingSuboptions(const std::string& name, const std::string& prefix) const;
 
    void relocateFiles(const std::string& configuration) const;
 
    std::vector<std::string> getSynonymes(const std::string& name) const;
 
    const std::string& getDescription(const std::string& name) const;
 
    const std::string& getSubTopic(const std::string& name) const;
 
    bool isWriteable(const std::string& name);
 
    bool isEditable(const std::string& name);
 
 
 
    std::string getValueString(const std::string& name) const;
 
    std::string getString(const std::string& name) const;
 
    double getFloat(const std::string& name) const;
 
    int getInt(const std::string& name) const;
 
    bool getBool(const std::string& name) const;
 
    const IntVector& getIntVector(const std::string& name) const;
 
    const StringVector& getStringVector(const std::string& name) const;
 
    bool isInStringVector(const std::string& optionName, const std::string& itemName) const;
 
 
 
    bool set(const std::string& name, const std::string& value, const bool append = false);
 
    bool setDefault(const std::string& name, const std::string& value);
 
    bool setByRootElement(const std::string& name, const std::string& value);
 
 
    void resetWritable();
 
    void resetDefault();
 
    void resetDefault(const std::string& name);
 
    friend std::ostream& operator<<(std::ostream& os, const OptionsCont& oc);
 
    void clear();
 
    bool processMetaOptions(bool missingOptions);
 
    void localizeDescriptions();
 
    const std::vector<std::string>& getSubTopics() const;
 
    std::vector<std::string> getSubTopicsEntries(const std::string& subtopic) const;
 
    std::string getTypeName(const std::string name);
 
    const std::string& getFullName() const;
 
    bool isEmpty() const;
 
    std::vector<std::pair<std::string, Option*> >::const_iterator begin() const;
 
    std::vector<std::pair<std::string, Option*> >::const_iterator end() const;
 
    OptionsCont* clone() const;
 
private:
    Option* getSecure(const std::string& name) const;
 
    void reportDoubleSetting(const std::string& arg) const;
 
    std::string convertChar(char abbr) const;
 
    void splitLines(std::ostream& os, std::string what, int offset, int nextOffset);
 
    bool myAmLocalized = false;
 
    static OptionsCont myOptions;
 
    std::vector<std::pair<std::string, Option*> > myAddresses;
 
    std::map<std::string, Option*> myValues;
 
    std::string myAppName, myFullName, myAppDescription, myAdditionalMessage;
 
    std::vector< std::pair<std::string, std::string> > myCallExamples;
 
    std::vector<std::string> mySubTopics, myCopyrightNotices;
 
    std::map<std::string, std::vector<std::string> > mySubTopicEntries;
 
    std::map<std::string, std::string> myXMLDefaults;
 
    mutable std::map<std::string, bool> myDeprecatedSynonymes;
 
    OptionsCont(const OptionsCont& s) = default;
 
    OptionsCont& operator=(const OptionsCont& s) = delete;
};