Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/commandline/CommandLineParser.h @ 11071

Last change on this file since 11071 was 11071, checked in by landauf, 8 years ago

merged branch cpp11_v3 back to trunk

  • Property svn:eol-style set to native
File size: 7.6 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @defgroup CmdArgs Commandline arguments
31    @ingroup Config
32    @brief For a reference of all commandline arguments see @ref cmdargspage
33*/
34
35/**
36    @file
37    @ingroup Config CmdArgs
38    @brief Declaration of CommandLineParser and CommandLineArgument, definition of the SetCommandLineArgument() macros.
39*/
40
41#ifndef _CommandLine_H__
42#define _CommandLine_H__
43
44#include "core/CorePrereqs.h"
45
46#include <fstream>
47#include <map>
48#include "util/OrxAssert.h"
49#include "util/MultiType.h"
50#include "util/Singleton.h"
51
52namespace orxonox
53{
54    /**
55    @brief
56        Container class for a command line argument of any type supported by MultiType.
57
58        Whenever you want to have an option specified by a command line switch,
59        you need to first define it with SetCommandLineArgument(name, defaultValue).
60        It is then added to a map and possibly changed when the command line is being parsed.
61        If the option was not given, you can detect this by asking hasDefaultValue().
62
63        There is a possibility to define a short cut so you can write "-p 20" instead of "--port 20".
64        Note the difference between "-" and "--"!
65        Also, there is no restriction to the number of strings you add after --name.
66        So "--startVector {2, 4, 5}" is perfectly legal.
67
68        Retrieving an argument is possible with the getCommandLineArgument function of the
69        CommandLineParser class. It is a Singleton, but the public interface is static.
70    */
71    class _CoreExport CommandLineArgument
72    {
73        friend class CommandLineParser;
74
75    public:
76        //! Constructor initialises both value_ and defaultValue_ with defaultValue.
77        CommandLineArgument(const std::string& name, const MultiType& defaultValue)
78            : bHasDefaultValue_(true)
79            , name_(name)
80            , value_(defaultValue)
81            , defaultValue_(defaultValue)
82        { }
83        ~CommandLineArgument() { }
84
85        //! Tells whether the value has been changed by the command line.
86        bool hasDefaultValue() const { return bHasDefaultValue_; }
87        //! Returns the name of the argument.
88        const std::string& getName() const { return name_; }
89
90        //! Returns the shortcut (example: "-p 22" for "--port 22") of the argument.
91        //! Evaluates to "" if there is none.
92        const std::string& getShortcut() const { return shortcut_; }
93        //! Sets the shortcut for the argument
94        CommandLineArgument& shortcut(const std::string& shortcut)
95        { this->shortcut_ = shortcut; return *this; }
96
97        //! Returns the usage information
98        const std::string& getInformation() const { return this->usageInformation_; }
99        //! Sets the option information when displaying orxonox usage.
100        CommandLineArgument& information(const std::string& usage)
101        { this->usageInformation_ = usage; return *this; }
102
103        //! Returns the actual value of the argument. Can be equal to default value.
104        const MultiType& getValue() const { return value_; }
105        //! Returns the given default value as type T.
106        const MultiType& getDefaultValue() const { return defaultValue_; }
107
108    private:
109        // non-copyable:
110        CommandLineArgument(const CommandLineArgument&) = delete;
111        CommandLineArgument& operator=(const CommandLineArgument&) = delete;
112
113        //! Parses the value string of a command line argument.
114        void parse(const std::string& value);
115
116        //! Tells whether the value has been changed by the command line.
117        bool bHasDefaultValue_;
118
119    private:
120        std::string name_;             //!< Name of the argument
121        std::string shortcut_;         //!< Shortcut of the argument. @see getShortcut().
122        std::string usageInformation_; //!< Tells about the usage of this parameter
123
124        MultiType   value_;            //!< The actual value
125        MultiType   defaultValue_;     //!< Default value. Should not be changed.
126    };
127
128
129    /**
130    @brief
131        Global interface to command line options.
132        Allows to add and retrieve command line arguments. Also does the parsing.
133    @note
134        Internally it is a Singleton, but the public interface is static.
135    @see
136        CommandLineArgument
137    */
138    class _CoreExport CommandLineParser : public Singleton<CommandLineParser>
139    {
140        friend class Singleton<CommandLineParser>;
141
142    public:
143        //! Constructor initialises bFirstTimeParse_ with true.
144        CommandLineParser() : bFirstTimeParse_(true) { }
145        ~CommandLineParser();
146
147        //! Parse redirection to internal member method.
148        static void parse(const std::string& cmdLine)
149        { getInstance()._parse(cmdLine); }
150
151        static std::string getUsageInformation();
152
153        static const CommandLineArgument* getArgument(const std::string& name);
154        //! Writes the argument value in the given parameter.
155        template <class T>
156        static void getValue(const std::string& name, T* value)
157        { *value = (T)(getArgument(name)->getValue()); }
158        static const MultiType& getValue(const std::string& name)
159        { return getArgument(name)->getValue(); }
160
161        static void addArgument(CommandLineArgument* argument);
162        static void removeArgument(CommandLineArgument* argument);
163
164        static bool existsArgument(const std::string& name)
165        {
166            std::map<std::string, CommandLineArgument*>::const_iterator it = getInstance().cmdLineArgs_.find(name);
167            return !(it == getInstance().cmdLineArgs_.end());
168        }
169
170        static void generateDoc(std::ofstream& file);
171
172    private:
173        //! Undefined copy constructor
174        CommandLineParser(const CommandLineParser& instance);
175
176        void _parse(const std::string& cmdLine);
177        void checkFullArgument(const std::string& name, const std::string& value);
178        void checkShortcut(const std::string& shortcut, const std::string& value);
179
180        /**
181            Tells whether we parsed for the first time. The CommmandLineArguments are added before main().
182            So when we call parse() the first time, we need to create a map with all shortcuts since these
183            get added after addCommandLineArgument().
184        */
185        bool bFirstTimeParse_;
186
187        //! Holds all pointers to the arguments and serves as a search map by name.
188        std::map<std::string, CommandLineArgument*> cmdLineArgs_;
189        //! Search map by shortcut for the arguments.
190        std::map<std::string, CommandLineArgument*> cmdLineArgsShortcut_;
191
192        static CommandLineParser* singletonPtr_s;
193    };
194
195    template <>
196    inline void CommandLineParser::getValue<std::string>(const std::string& name, std::string* value)
197    {
198        *value = getArgument(name)->getValue().get<std::string>();
199    }
200}
201
202#endif /* _CommandLine_H__ */
Note: See TracBrowser for help on using the repository browser.