OptionsCont.h

Go to the documentation of this file.

/****************************************************************************/
// A storage for options (typed value containers)
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2012 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef OptionsCont_h
#define OptionsCont_h
// ===========================================================================
// compiler pragmas
// ===========================================================================
#ifdef _MSC_VER
#pragma warning(disable: 4786)
#pragma warning(disable: 4503)
#endif


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <map>
#include <string>
#include <vector>
#include <iostream>
#include "Option.h"


// ===========================================================================
// class definitions
// ===========================================================================
class OptionsCont {
public:
    static OptionsCont& getOptions();


    OptionsCont();


    ~OptionsCont();




    void setApplicationName(const std::string& appName, const std::string& fullName);


    void setApplicationDescription(const std::string& appDesc);


    void addCallExample(const std::string& example);


    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 writeConfiguration(std::ostream& os, bool filled,
                            bool complete, bool addComments);


    void writeSchema(std::ostream& os, bool addComments);


    void writeXMLHeader(std::ostream& os, const std::string xmlParams = "");





    void doRegister(const std::string& name, Option* v);


    void doRegister(const std::string& name, char abbr, Option* v);


    void addSynonyme(const std::string& name1, const std::string& name2, bool isDeprecated = false);


    void addDescription(const std::string& name, const std::string& subtopic,
                        const std::string& description);





    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;


    bool isWriteable(const std::string& name);





    std::string getString(const std::string& name) const;


    SUMOReal 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;


    std::vector<std::string> getStringVector(const std::string& name) const;


    bool isInStringVector(const std::string& optionName,
                          const std::string& itemName);





    bool set(const std::string& name, const std::string& value);


    void resetWritable();

    friend std::ostream& operator<<(std::ostream& os, const OptionsCont& oc);


    void clear();


    bool processMetaOptions(bool missingOptions) ;


    const std::vector<std::string> & getSubTopics() const {
        return mySubTopics;
    }


    std::vector<std::string> getSubTopicsEntries(const std::string& subtopic) const {
        if (mySubTopicEntries.count(subtopic) > 0) {
            return mySubTopicEntries.find(subtopic)->second;
        } else {
            return std::vector<std::string>();
        }
    }


    std::string getTypeName(const std::string name) {
        return getSecure(name)->getTypeName();
    }

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,
                    size_t offset, size_t nextOffset);


private:
    static OptionsCont myOptions;

    typedef std::vector<Option*> ItemAddressContType;

    typedef std::map<std::string, Option*> KnownContType;

    ItemAddressContType myAddresses;

    KnownContType myValues;

    std::string myAppName, myFullName, myAppDescription, myAdditionalMessage;

    std::vector<std::string> myCallExamples, mySubTopics, myCopyrightNotices;

    std::map<std::string, std::vector<std::string> > mySubTopicEntries;

    mutable std::map<std::string, bool> myDeprecatedSynonymes;

    mutable bool myHaveInformedAboutDeprecatedDivider;


private:
    class abbreviation_finder {
    public:
        explicit abbreviation_finder() { }

        bool operator()(const std::string& s) {
            return s.length() == 1;
        }
    };


private:
    OptionsCont(const OptionsCont& s);

    OptionsCont& operator=(const OptionsCont& s);

};


#endif

/****************************************************************************/