/usr/include/ns3.17/ns3/command-line.h is in libns3-dev 3.17+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008 INRIA
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef COMMAND_LINE_H
#define COMMAND_LINE_H
#include <string>
#include <sstream>
#include <list>
#include "callback.h"
namespace ns3 {
/**
* \brief parse command-line arguments
* \ingroup core
*
* Instances of this class can be used to parse command-line
* arguments: users can register new arguments with
* CommandLine::AddValue but the most important functionality
* provided by this class is that it can be used to set the
* 'initial value' of every attribute in the system with the
* \verbatim
* --TypeIdName::AttributeName=value
* \endverbatim
* syntax and it can be used to set the value of every GlobalValue
* in the system with the
* \verbatim
* --GlobalValueName=value
* \endverbatim
* syntax.
*/
class CommandLine
{
public:
CommandLine ();
CommandLine (const CommandLine &cmd);
CommandLine &operator = (const CommandLine &cmd);
~CommandLine ();
/**
* \param name the name of the user-supplied argument
* \param help some help text used by --PrintHelp
* \param value a reference to the variable where the
* value parsed will be stored (if no value
* is parsed, this variable is not modified).
*/
template <typename T>
void AddValue (const std::string &name,
const std::string &help,
T &value);
/**
* \param name the name of the user-supplied argument
* \param help some help text used by --PrintHelp
* \param callback a callback function that will be invoked to parse
* and collect the value. This normally used by language bindings.
*/
void AddValue (const std::string &name,
const std::string &help,
Callback<bool, std::string> callback);
/**
* \param argc the 'argc' variable: number of arguments (including the
* main program name as first element).
* \param argv the 'argv' variable: a null-terminated array of strings,
* each of which identifies a command-line argument.
*
* Obviously, this method will parse the input command-line arguments and
* will attempt to handle them all.
*/
void Parse (int argc, char *argv[]) const;
private:
class Item
{
public:
std::string m_name;
std::string m_help;
virtual ~Item ();
virtual bool Parse (std::string value) = 0;
};
template <typename T>
class UserItem : public Item
{
public:
virtual bool Parse (std::string value);
T *m_valuePtr;
};
class CallbackItem : public Item
{
public:
virtual bool Parse (std::string value);
Callback<bool, std::string> m_callback;
};
void HandleArgument (std::string name, std::string value) const;
void PrintHelp (void) const;
void PrintGlobals (void) const;
void PrintAttributes (std::string type) const;
void PrintGroup (std::string group) const;
void PrintTypeIds (void) const;
void PrintGroups (void) const;
void Copy (const CommandLine &cmd);
void Clear (void);
typedef std::list<Item *> Items;
Items m_items;
};
} // namespace ns3
namespace ns3 {
template <typename T>
void
CommandLine::AddValue (const std::string &name,
const std::string &help,
T &value)
{
UserItem<T> *item = new UserItem<T> ();
item->m_name = name;
item->m_help = help;
item->m_valuePtr = &value;
m_items.push_back (item);
}
template <typename T>
bool
CommandLine::UserItem<T>::Parse (std::string value)
{
std::istringstream iss;
iss.str (value);
iss >> (*m_valuePtr);
return !iss.bad () && !iss.fail ();
}
} // namespace ns3
#endif /* COMMAND_LINE_H */
|