66 myCopyrightNotices.push_back(
TL(
"Copyright (C) 2001-2023 German Aerospace Center (DLR) and others; https://sumo.dlr.de"));
83 throw ProcessError(name +
" is an already used option name.");
86 bool isSynonym =
false;
88 if (addresse.second == o) {
112 throw ProcessError(
"Neither the option '" + name1 +
"' nor the option '" + name2 +
"' is known yet");
115 if ((*i1).second == (*i2).second) {
118 throw ProcessError(
"Both options '" + name1 +
"' and '" + name2 +
"' do exist and differ.");
151 if (failOnNonExistant) {
152 throw ProcessError(
TLF(
"Internal request for unknown option '%'!", name));
157 return (*i).second->isSet();
167 return (*i).second->isDefault();
173 const auto& valuesFinder =
myValues.find(name);
174 if (valuesFinder ==
myValues.end()) {
179 std::string defaultName;
181 for (
const auto& value : subtopicEntry.second) {
182 const auto l =
myValues.find(value);
183 if ((l !=
myValues.end()) && (l->second == valuesFinder->second)) {
188 if (defaultName !=
"") {
192 WRITE_WARNINGF(
TL(
"Please note that '%' is deprecated.\n Use '%' instead."), name, defaultName);
193 synonymFinder->second =
true;
195 return valuesFinder->second;
260 WRITE_ERROR(
"While processing option '" + name +
"':\n " + e.what());
290std::vector<std::string>
293 std::vector<std::string> synonymes;
294 for (
const auto& value :
myValues) {
295 if ((value.second == o) && (name != value.first)) {
296 synonymes.push_back(value.first);
317 std::vector<std::string> done;
318 os <<
"Options set:" << std::endl;
319 for (
const auto& value : oc.
myValues) {
320 const auto& finder = std::find(done.begin(), done.end(), value.first);
321 if (finder == done.end()) {
322 std::vector<std::string> synonymes = oc.
getSynonymes(value.first);
323 if (synonymes.size() != 0) {
324 os << value.first <<
" (";
325 for (
auto synonym = synonymes.begin(); synonym != synonymes.end(); synonym++) {
326 if (synonym != synonymes.begin()) {
335 if (value.second->isSet()) {
336 os <<
": " << value.second->getValueString() << std::endl;
338 os <<
": <INVALID>" << std::endl;
340 done.push_back(value.first);
341 copy(synonymes.begin(), synonymes.end(), back_inserter(done));
351 if (addresse.second->isFileName() && addresse.second->isSet()) {
353 for (
auto& file : fileList) {
362 for (
auto& file : rawList) {
366 if (conv !=
joinToString(addresse.second->getStringVector(),
',')) {
367 const bool hadDefault = addresse.second->isDefault();
368 addresse.second->set(conv,
joinToString(rawList,
','),
false);
370 addresse.second->resetDefault();
387 if (files.size() == 0) {
391 for (
const auto& file : files) {
394 WRITE_ERRORF(
TL(
"File '%' is not accessible (%)."), file, std::strerror(errno));
412 std::vector<std::string> seenSynonymes;
413 for (
const auto& value :
myValues) {
414 if (std::find(seenSynonymes.begin(), seenSynonymes.end(), value.first) != seenSynonymes.end()) {
417 if (value.second->isSet() && !value.second->isDefault() && value.first.find(prefix) == 0) {
418 WRITE_ERRORF(
TL(
"Option '%' needs option '%'."), value.first, name);
419 std::vector<std::string> synonymes =
getSynonymes(value.first);
420 std::copy(synonymes.begin(), synonymes.end(), std::back_inserter(seenSynonymes));
431 std::ostringstream s;
432 s <<
"A value for the option '" + arg +
"' was already set.\n Possible synonymes: ";
433 auto synonym = synonymes.begin();
434 while (synonym != synonymes.end()) {
437 if (synonym != synonymes.end()) {
465 addresse.second->resetWritable();
473 addresse.second->resetDefault();
495 delete addresse.second;
506 const std::string& description) {
512 throw ProcessError(
"SubTopic '" + subtopic +
"' doesn't exist");
527 throw ProcessError(
"SubTopic '" + subtopic +
"' doesn't exist");
541 const std::string& fullName) {
586 int offset,
int nextOffset) {
587 while (what.length() > 0) {
588 if ((
int)what.length() > 79 - offset) {
589 std::string::size_type splitPos = what.rfind(
';', 79 - offset);
590 if (splitPos == std::string::npos) {
591 splitPos = what.rfind(
' ', 79 - offset);
595 if (splitPos != std::string::npos) {
596 os << what.substr(0, splitPos) << std::endl;
597 what = what.substr(splitPos + 1);
598 for (
int r = 0; r < (nextOffset + 1); ++r) {
618 if (missingOptions) {
621 std::cout <<
TL(
" Build features: ") << HAVE_ENABLED << std::endl;
623 std::cout <<
" " << copyrightNotice.data() << std::endl;
625 std::cout <<
TL(
" License EPL-2.0: Eclipse Public License Version 2 <https://eclipse.org/legal/epl-v20.html>") << std::endl;
626 std::cout <<
TL(
" Use --help to get the list of options.") << std::endl;
635 std::cout <<
" " << copyrightNotice.data() << std::endl;
643 std::cout <<
TL(
" Build features: ") << HAVE_ENABLED << std::endl;
645 std::cout <<
" " << copyrightNotice.data() << std::endl;
647 std::cout <<
"\n" <<
myFullName <<
" is part of SUMO.\n";
648 std::cout <<
"This program and the accompanying materials\n";
649 std::cout <<
"are made available under the terms of the Eclipse Public License v2.0\n";
650 std::cout <<
"which accompanies this distribution, and is available at\n";
651 std::cout <<
"http://www.eclipse.org/legal/epl-v20.html\n";
652 std::cout <<
"This program may also be made available under the following Secondary\n";
653 std::cout <<
"Licenses when the conditions for such availability set forth in the Eclipse\n";
654 std::cout <<
"Public License 2.0 are satisfied: GNU General Public License, version 2\n";
655 std::cout <<
"or later which is available at\n";
656 std::cout <<
"https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html\n";
657 std::cout <<
"SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later" << std::endl;
661 if (
getBool(
"print-options")) {
662 std::cout << (*this);
666 if (
isSet(
"save-configuration")) {
667 const std::string& configPath =
getString(
"save-configuration");
668 if (configPath ==
"-" || configPath ==
"stdout") {
674 throw ProcessError(
TLF(
"Could not save configuration to '%'", configPath));
684 if (
isSet(
"save-template")) {
700 if (
isSet(
"save-schema")) {
720const std::vector<std::string>&
726std::vector<std::string>
731 return std::vector<std::string>();
754std::vector<std::pair<std::string, Option*> >::const_iterator
760std::vector<std::pair<std::string, Option*> >::const_iterator
780 int csize = (int)entry.length() + 2 + 4;
783 for (
const auto& synonym : synonymes) {
795 if (csize < tooLarge && maxSize < csize) {
802 if (helpTopic !=
"") {
803 bool foundTopic =
false;
812 os <<
"Help Topics:" << std::endl;
814 os <<
" " << t << std::endl;
820 os <<
"Usage: " <<
myAppName <<
" [OPTION]*" << std::endl;
832 os <<
"Examples:" << std::endl;
834 os <<
" " <<
myAppName <<
' ' << callExample.first << std::endl;
835 os <<
" " << callExample.second << std::endl;
839 os <<
"Report bugs at <https://github.com/eclipse/sumo/issues>." << std::endl;
840 os <<
"Get in contact via <sumo@dlr.de>." << std::endl;
846 os << topic <<
" Options:" << std::endl;
849 int csize = (int)entry.length() + 2;
854 for (
const auto& synonym : synonymes) {
856 os <<
'-' << synonym <<
", ";
874 for (
int r = maxSize; r > csize; --r) {
877 int offset = csize > tooLarge ? csize : maxSize;
886 const bool complete,
const bool addComments,
const std::string& relativeTo,
887 const bool forceRelative,
const bool inComment)
const {
891 os <<
"<configuration xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"http://sumo.dlr.de/xsd/";
897 os <<
"Configuration.xsd\">" << std::endl << std::endl;
899 if (subtopic ==
"Configuration" && !complete) {
902 const std::vector<std::string>& entries =
mySubTopicEntries.find(subtopic)->second;
903 std::replace(subtopic.begin(), subtopic.end(),
' ',
'_');
906 for (
const std::string& name : entries) {
908 bool write = complete || (filled && !o->
isDefault());
912 if (name ==
"registry-viewport" && !complete) {
916 os <<
" <" << subtopic <<
">" << std::endl;
923 os <<
" <" << name <<
" value=\"";
927 for (
auto& file : fileList) {
931 forceRelative ||
getBool(
"save-configuration.relative"));
939 std::vector<std::string> synonymes =
getSynonymes(name);
940 if (!synonymes.empty()) {
941 os <<
"\" synonymes=\"";
942 for (
auto synonym = synonymes.begin(); synonym != synonymes.end(); synonym++) {
943 if (synonym != synonymes.begin()) {
954 os <<
"\"/>" << std::endl;
962 os <<
" </" << subtopic <<
">" << std::endl << std::endl;
965 os <<
"</configuration>" << std::endl;
972 os <<
"<xsd:schema elementFormDefault=\"qualified\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\">\n\n";
973 os <<
" <xsd:include schemaLocation=\"baseTypes.xsd\"/>\n";
974 os <<
" <xsd:element name=\"configuration\" type=\"configurationType\"/>\n\n";
975 os <<
" <xsd:complexType name=\"configurationType\">\n";
976 os <<
" <xsd:all>\n";
978 if (subtopic ==
"Configuration") {
981 std::replace(subtopic.begin(), subtopic.end(),
' ',
'_');
983 os <<
" <xsd:element name=\"" << subtopic <<
"\" type=\"" << subtopic <<
"TopicType\" minOccurs=\"0\"/>\n";
985 os <<
" </xsd:all>\n";
986 os <<
" </xsd:complexType>\n\n";
988 if (subtopic ==
"Configuration") {
991 const std::vector<std::string>& entries =
mySubTopicEntries.find(subtopic)->second;
992 std::replace(subtopic.begin(), subtopic.end(),
' ',
'_');
994 os <<
" <xsd:complexType name=\"" << subtopic <<
"TopicType\">\n";
995 os <<
" <xsd:all>\n";
996 for (
const auto& entry : entries) {
1000 if (type ==
"int[]") {
1003 if (type ==
"str[]") {
1006 os <<
" <xsd:element name=\"" << entry <<
"\" type=\"" << type <<
"OptionType\" minOccurs=\"0\"/>\n";
1008 os <<
" </xsd:all>\n";
1009 os <<
" </xsd:complexType>\n\n";
1011 os <<
"</xsd:schema>\n";
1022 strftime(buffer, 80,
"<!-- generated on %F %T by ", localtime(&rawtime));
1025 os <<
"This data file and the accompanying materials\n"
1026 "are made available under the terms of the Eclipse Public License v2.0\n"
1027 "which accompanies this distribution, and is available at\n"
1028 "http://www.eclipse.org/legal/epl-v20.html\n"
1029 "This file may also be made available under the following Secondary\n"
1030 "Licenses when the conditions for such availability set forth in the Eclipse\n"
1031 "Public License 2.0 are satisfied: GNU General Public License, version 2\n"
1032 "or later which is available at\n"
1033 "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html\n"
1034 "SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later\n";
1036 if (includeConfig) {
1045 const std::string& itemName)
const {
1046 if (
isSet(optionName)) {
1048 return std::find(values.begin(), values.end(), itemName) != values.end();
#define WRITE_WARNINGF(...)
#define WRITE_MESSAGEF(...)
#define WRITE_ERRORF(...)
#define WRITE_WARNING(msg)
std::vector< std::string > StringVector
Definition of a vector of strings.
std::vector< int > IntVector
Definition of a vector of ints.
std::ostream & operator<<(std::ostream &os, const OptionsCont &oc)
std::string joinToString(const std::vector< T > &v, const T_BETWEEN &between, std::streamsize accuracy=gPrecision)
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
static std::string fixRelative(const std::string &filename, const std::string &basePath, const bool force, std::string curDir="")
Fixes the relative path for the given filename in relation to the basePath (usually a config file).
static std::string checkForRelativity(const std::string &filename, const std::string &basePath)
Returns the path from a configuration so that it is accessable from the current working directory.
static bool isReadable(std::string path)
Checks whether the given file is readable.
static void setupI18n(const std::string &locale="")
set up gettext stuff
A class representing a single program option.
bool isWriteable() const
Returns the information whether the option may be set a further time.
bool isSet() const
returns the information whether this options holds a valid value
virtual bool isDefault() const
Returns the information whether the option holds the default value.
void setRequired()
mark option as required
virtual std::string getString() const
Returns the stored string value.
virtual const IntVector & getIntVector() const
Returns the stored integer vector.
const std::string & getDescription() const
Returns the description of what this option does.
void setListSeparator(const std::string &listSep)
set list separator
virtual bool isFileName() const
Returns the information whether this option is a file name.
virtual const StringVector & getStringVector() const
Returns the stored string vector.
void setDescription(const std::string &desc)
Sets the description of what this option does.
virtual const std::string & getTypeName() const
Returns the mml-type name of this option.
virtual int getInt() const
Returns the stored integer value.
virtual double getFloat() const
Returns the stored double value.
virtual bool getBool() const
Returns the stored boolean value.
void setPositional()
mark option as positional
void resetDefault()
Resets the option to be on its default value.
const std::string & getSubTopic() const
Returns the subtopic to which this option belongs.
virtual bool set(const std::string &v, const std::string &orig, const bool append)=0
Stores the given value.
virtual bool isBool() const
Returns the information whether the option is a bool option.
const std::string & getValueString() const
Returns the string-representation of the value.
void setSubtopic(const std::string &subtopic)
Sets the subtopic to which this option belongs.
A storage for options typed value containers)
void setAdditionalHelpMessage(const std::string &add)
Sets an additional message to be printed at the begin of the help screen.
~OptionsCont()
Destructor.
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
void resetDefault()
Resets all options to default.
void setFurtherAttributes(const std::string &name, const std::string &subtopic, bool required, bool positional, const std::string &listSep)
mark option as required
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
std::vector< std::pair< std::string, std::string > > myCallExamples
list of call examples
bool isWriteable(const std::string &name)
Returns the information whether the named option may be set.
std::map< std::string, std::vector< std::string > > mySubTopicEntries
A map from subtopic to option.
void writeXMLHeader(std::ostream &os, const bool includeConfig=true) const
Writes a standard XML header, including the configuration.
double getFloat(const std::string &name) const
Returns the double-value of the named option (only for Option_Float)
int getInt(const std::string &name) const
Returns the int-value of the named option (only for Option_Integer)
void splitLines(std::ostream &os, std::string what, int offset, int nextOffset)
Writes the given string 'formatted'.
void setApplicationName(const std::string &appName, const std::string &fullName)
Sets the application name.
void printHelpOnTopic(const std::string &topic, int tooLarge, int maxSize, std::ostream &os)
Prints help on the given topic.
const std::string & getSubTopic(const std::string &name) const
Returns the option category.
std::map< std::string, Option * > myValues
option maps sorted by name (for adresses AND their synonyms)
bool isEmpty() const
check if options container is empty
std::string myAdditionalMessage
std::vector< std::string > myCopyrightNotices
const std::vector< std::string > & getSubTopics() const
return the list of subtopics
std::vector< std::pair< std::string, Option * > > myAddresses
option-adresses
const IntVector & getIntVector(const std::string &name) const
Returns the list of integer-value of the named option (only for Option_IntVector)
std::vector< std::string > getSynonymes(const std::string &name) const
Returns the synonymes of an option name.
void reportDoubleSetting(const std::string &arg) const
Reports an error that the option has already been set.
std::vector< std::string > mySubTopics
lists of option subtopics and copyright notices
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
static OptionsCont EMPTY_OPTIONS
empty option container
bool myWriteLicense
Information whether we should always include license information in file headers.
void addSynonyme(const std::string &name1, const std::string &name2, bool isDeprecated=false)
Adds a synonyme for an options name (any order)
bool isDefault(const std::string &name) const
Returns the information whether the named option has still the default value.
bool setDefault(const std::string &name, const std::string &value)
Sets the given value for the named option as new default value.
void doRegister(const std::string &name, Option *o)
Adds an option under the given name.
bool exists(const std::string &name) const
Returns the information whether the named option is known.
const std::string & getFullName() const
get options full name
bool isBool(const std::string &name) const
Returns the information whether the option is a boolean option.
void addCopyrightNotice(const std::string ©rightLine)
Adds a copyright notice to the help output.
std::string getTypeName(const std::string name)
return the type name for the given option
void writeSchema(std::ostream &os)
Writes the xml schema for the configuration.
void clear()
Removes all information from the container.
void setApplicationDescription(const std::string &appDesc)
Sets the application description.
std::vector< std::pair< std::string, Option * > >::const_iterator begin() const
get begin adresses iterator
bool set(const std::string &name, const std::string &value, const bool append=false)
Sets the given value for the named option.
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
Writes the configuration.
void clearCopyrightNotices()
Removes all copyright information.
std::string convertChar(char abbr) const
Converts an abbreviation into a name.
void addOptionSubTopic(const std::string &topic)
Adds an option subtopic.
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
const StringVector & getStringVector(const std::string &name) const
Returns the list of string-value of the named option (only for Option_StringVector)
OptionsCont()
Constructor.
void printHelp(std::ostream &os)
Prints the help.
std::vector< std::pair< std::string, Option * > >::const_iterator end() const
get begin adresses iterator
std::string getValueString(const std::string &name) const
Returns the string-value of the named option (all options)
std::string myAppDescription
const std::string & getDescription(const std::string &name) const
Returns the option description.
bool setByRootElement(const std::string &name, const std::string &value)
Sets the given value for the option which can handle the given XML root.
std::map< std::string, bool > myDeprecatedSynonymes
A map from deprecated options to a bool indicating whether we warned about deprecation.
static OptionsCont myOptions
The static options container used.
bool checkDependingSuboptions(const std::string &name, const std::string &prefix) const
Checks whether an option is set, which has options with a prefix depending on it.
std::map< std::string, std::string > myXMLDefaults
A map from XML root element to option.
std::string myAppName
some information on the application
void resetWritable()
Resets all options to be writeable.
void addXMLDefault(const std::string &name, const std::string &xmlRoot="")
Adds an XML root element to handle by default. The special root "" denotes the default handler.
static OptionsCont & getOptions()
Retrieves the options.
std::vector< std::string > getSubTopicsEntries(const std::string &subtopic) const
return the list of entries for the given subtopic
Option * getSecure(const std::string &name) const
Returns the named option.
void relocateFiles(const std::string &configuration) const
Modifies file name options according to the configuration path.
bool isInStringVector(const std::string &optionName, const std::string &itemName) const
Returns the named option is a list of string values containing the specified item.
bool processMetaOptions(bool missingOptions)
Checks for help and configuration output, returns whether we should exit.
bool isUsableFileList(const std::string &name) const
Checks whether the named option is usable as a file list (with at least a single file)
void addCallExample(const std::string &example, const std::string &desc)
Add a call example.
static const std::chrono::time_point< std::chrono::system_clock > & getLoadTime()
Return the time stamp of the last init.
static const std::string ENCODING
The encoding of parsed strings.
std::vector< std::string > getVector()
return vector of strings
static std::string urlEncode(const std::string &url, const std::string encodeWhich="")
encode url (stem from http://bogomip.net/blog/cpp-url-encoding-and-decoding/)
static std::string urlDecode(const std::string &encoded)
decode url (stem from http://bogomip.net/blog/cpp-url-encoding-and-decoding/)
static std::string to_lower_case(const std::string &str)
Transfers the content to lower case.
static std::string escapeXML(const std::string &orig, const bool maskDoubleHyphen=false)
Replaces the standard escapes by their XML entities.
static std::string substituteEnvironment(const std::string &str, const std::chrono::time_point< std::chrono::system_clock > *const timeRef=nullptr)
Replaces an environment variable with its value (similar to bash); syntax for a variable is ${NAME}.
static std::string transcodeToLocal(const std::string &utf8String)
convert a string from UTF-8 to the local codepage