/usr/include/cxxtools/arg.h is in libcxxtools-dev 2.2.1-2.
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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 | /*
* Copyright (C) 2003,2004,2010 Tommi Maekitalo
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* As a special exception, you may use this file as part of a free
* software library without restriction. Specifically, if other files
* instantiate templates or use macros or inline functions from this
* file, or you compile this file and link it with other files to
* produce an executable, this file does not by itself cause the
* resulting executable to be covered by the GNU General Public
* License. This exception does not however invalidate any other
* reasons why the executable file might be covered by the GNU Library
* General Public License.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef CXXTOOLS_ARG_H
#define CXXTOOLS_ARG_H
#include <sstream>
#include <string.h>
namespace cxxtools
{
class ArgBase
{
protected:
bool m_isset;
static void removeArg(int& argc, char* argv[], int pos, int n)
{
for ( ; pos < argc - n; ++pos)
argv[pos] = argv[pos + n];
argc -= n;
argv[argc] = 0;
}
public:
ArgBase()
: m_isset(false)
{ }
/**
* returns true if the option was found and the default value was not used
*/
bool isSet() const { return m_isset; }
};
template <typename T>
class ArgBaseT : public ArgBase
{
T m_value;
protected:
explicit ArgBaseT(const T& def)
: m_value(def)
{ }
bool extract(const char* str, int& argc, char* argv[], int i, int n)
{
std::istringstream s(str);
s >> m_value;
if (!s.fail())
{
m_isset = true;
removeArg(argc, argv, i, n);
return true;
}
return false;
}
public:
/**
returns the value.
*/
const T& getValue() const { return m_value; }
/** @brief Read and extract commandline parameters from argc/argv.
Programs usually need some parameters. Usually they start with a '-'
followed by a single character and optionally a value.
Arg<T> extracts these and other parameters.
This default class processes paramters with a value, which defines
a input-extractor-operator operator>> (istream&, T&).
Options are removed from the option-list, so programs can easily check
after all options are extracted, if there are parameters left.
example:
\code
int main(int argc, char* argv[])
{
cxxtools::Arg<int> option_n(argc, argv, 'n', 0);
std::cout << "value for -n: " << option_n << endl;
}
\endcode
*/
operator T() const { return m_value; }
ArgBaseT<T>& operator= (const T& value)
{
m_value = value;
return *this;
}
};
template <>
class ArgBaseT<const char*> : public ArgBase
{
const char* m_value;
protected:
explicit ArgBaseT(const char* def)
: m_value(def)
{ }
bool extract(const char* str, int& argc, char* argv[], int i, int n)
{
m_value = str;
m_isset = true;
removeArg(argc, argv, i, n);
return true;
}
public:
/// returns the extracted value.
const char* getValue() const { return m_value; }
/// class is convertible to "const char*"
operator const char*() const { return m_value; }
ArgBaseT<const char*>& operator= (const char* value)
{
m_value = value;
return *this;
}
};
template <>
class ArgBaseT<std::string> : public ArgBase
{
std::string m_value;
protected:
explicit ArgBaseT(const std::string& def)
: m_value(def)
{ }
bool extract(const char* str, int& argc, char* argv[], int i, int n)
{
m_value = str;
m_isset = true;
removeArg(argc, argv, i, n);
return true;
}
public:
/// returns the extracted value.
const std::string& getValue() const { return m_value; }
/// class is convertible to "const std::string&"
operator const std::string&() const { return m_value; }
ArgBaseT<std::string>& operator= (const std::string& value)
{
m_value = value;
return *this;
}
};
/** @brief Read and extract commandline parameters from argc/argv.
Programs usually need some parameters. Usually they start with a '-'
followed by a single character and optionally a value.
Arg<T> extracts these and other parameters.
This default class processes paramters with a value, which defines
a input-extractor-operator operator>> (istream&, T&).
Options are removed from the option-list, so programs can easily check
after all options are extracted, if there are parameters left.
example:
\code
int main(int argc, char* argv[])
{
cxxtools::Arg<int> option_n(argc, argv, 'n', 0);
std::cout << "value for -n: " << option_n << endl;
}
\endcode
*/
template <typename T>
class Arg : public ArgBaseT<T>
{
public:
/**
default constructor. Initializes value.
\param def initial value
*/
explicit Arg(const T& def = T())
: ArgBaseT<T>(def)
{ }
/**
extract parameter.
\param argc 1. parameter of main
\param argv 2. of main
\param ch optioncharacter
\param def default-value
example:
\code
cxxtools::Arg<unsigned> offset(argc, argv, 'o', 0);
unsigned value = offset.getValue();
\endcode
*/
Arg(int& argc, char* argv[], char ch, const T& def = T())
: ArgBaseT<T>(def)
{
set(argc, argv, ch);
}
/**
GNU defines long options starting with "--". This (and more) is
supported here. Instead of giving a single option-character, you
specify a string.
example:
\code
cxxtools::Arg<int> option_number(argc, argv, "--number", 0);
std::cout << "number =" << option_number.getValue() << std::endl;
\endcode
*/
Arg(int& argc, char* argv[], const char* str, const T& def = T())
: ArgBaseT<T>(def)
{
this->m_isset = set(argc, argv, str);
}
Arg(int& argc, char* argv[])
: ArgBaseT<T>(T())
{
this->m_isset = set(argc, argv);
}
/**
extract parameter.
\param argc 1. parameter of main
\param argv 2. of main
\param ch optioncharacter
example:
\code
cxxtools::Arg<unsigned> offset;
offset.set(argc, argv, 'o');
unsigned value = offset.getValue();
\endcode
*/
bool set(int& argc, char* argv[], char ch)
{
// don't extract value, when already found
if (this->m_isset)
return false;
for (int i = 1; i < argc; ++i)
{
if (argv[i][0] == '-' && argv[i][1] == ch)
{
if (argv[i][2] == '\0' && i < argc - 1)
{
// -O foo
if (this->extract(argv[i + 1], argc, argv, i, 2))
return true;
}
// -Ofoo
if (this->extract(argv[i] + 2, argc, argv, i, 1))
return true;
}
}
return false;
}
/**
GNU defines long options starting with "--". This (and more) is
supported here. Instead of giving a single option-character, you
specify a string.
example:
\code
cxxtools::Arg<int> option_number;
number.set(argc, argv, "--number");
std::cout << "number =" << option_number.getValue() << std::endl;
\endcode
*/
bool set(int& argc, char* argv[], const char* str)
{
// don't extract value, when already found
if (this->m_isset)
return false;
unsigned n = strlen(str);
for (int i = 1; i < argc; ++i)
{
if (strncmp(argv[i], str, n) == 0)
{
if (i < argc - 1 && argv[i][n] == '\0')
{
// --option value
if (this->extract(argv[i + 1], argc, argv, i, 2))
return true;
}
if (argv[i][n] == '=')
{
// --option=vlaue
if (this->extract(argv[i] + n + 1, argc, argv, i, 1))
return true;
}
}
}
return false;
}
/**
Reads next parameter and removes it.
*/
bool set(int& argc, char* argv[])
{
// don't extract value, when already found
if (this->m_isset)
return false;
if (argc > 1)
this->extract(argv[1], argc, argv, 1, 1);
return this->m_isset;
}
};
////////////////////////////////////////////////////////////////////////
/**
specialization for bool.
Often programs need some switches, which are switched on or off.
Users just enter a option without parameter.
example:
\code
cxxtools::Arg<bool> debug(argc, argv, 'd');
if (debug)
std::cout << "debug-mode is set" << std::endl;
\endcode
*/
template <>
class Arg<bool> : public ArgBase
{
public:
/**
default constructor. Initializes value.
\param def initial value
*/
Arg(bool def = false)
: m_value(def)
{ }
/**
Use this constructor to extract a bool-parameter.
As a special case options can be grouped. The parameter is
recognized also in a argument, which starts with a '-' and contains
somewhere the given character.
example:
\code
cxxtools::Arg<bool> debug(argc, argv, 'd');
cxxtools::Arg<bool> ignore(argc, argv, 'i');
\endcode
Arguments debug and ignore are both set when the program is called
with:
\code
prog -id
prog -i -d
\endcode
Options can also switched off with a following '-' like this:
\code
prog -d-
\endcode
In the program use:
\code
Arg<bool> debug(argc, argv, 'd');
if (debug.isSet())
{
if (debug)
std::cout << "you entered -d" << std::endl;
else
std::cout << "you entered -d-" << std::endl;
}
else
std::cout << "no -d option given" << std::endl;
\endcode
This is useful, if a program defaults to some enabled feature,
which can be disabled.
*/
Arg(int& argc, char* argv[], char ch, bool def = false)
: m_value(def)
{
m_isset = set(argc, argv, ch);
}
Arg(int& argc, char* argv[], const char* str, bool def = false)
: m_value(def)
{
m_isset = set(argc, argv, str);
}
bool set(int& argc, char* argv[], char ch)
{
// don't extract value, when already found
if (m_isset)
return false;
for (int i = 1; i < argc; ++i)
{
if (argv[i][0] == '-' && argv[i][1] != '-')
{
// starts with a '-', but not with "--"
if (argv[i][1] == ch && argv[i][2] == '\0')
{
// single option found
m_value = true;
m_isset = true;
removeArg(argc, argv, i, 1);
return true;
}
else if (argv[i][1] == ch && argv[i][2] == '-' && argv[i][3] == '\0')
{
// Option was explicitly disabled with -x-
m_value = false;
m_isset = true;
removeArg(argc, argv, i, 1);
return true;
}
else
{
// look, if we find the option in an optiongroup
for (char* p = argv[i] + 1; *p != '\0'; ++p)
if (*p == ch)
{
// here it is - extract it
m_value = true;
m_isset = true;
do
{
*p = *(p + 1);
} while (*p++ != '\0');
return true;
}
}
}
}
return false;
}
/**
Setter for long-options.
The option-parameter is defined with a string. This can extract
long-options like:
\code
prog --debug
\endcode
with
\code
Arg<bool> debug(argc, argv, "--debug");
\endcode
*/
bool set(int& argc, char* argv[], const char* str)
{
// don't extract value, when already found
if (m_isset)
return false;
for (int i = 1; i < argc; ++i)
{
if (strcmp(argv[i], str) == 0)
{
m_value = true;
m_isset = true;
removeArg(argc, argv, i, 1);
return true;
}
}
return false;
}
/**
returns true, if options is set.
*/
bool isTrue() const { return m_value; }
/**
returns true, if options is not set.
*/
bool isFalse() const { return !m_value; }
/**
convertable to bool.
*/
operator bool() const { return m_value; }
private:
bool m_value;
};
template <typename T>
std::ostream& operator<< (std::ostream& out, const ArgBaseT<T> arg)
{
return out << arg.getValue();
}
}
#endif // CXXTOOLS_ARG_H
|