/usr/include/BoxLib/ParmParse.H is in libbox-dev 2.5-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 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 | /*
** (c) 1996-2000 The Regents of the University of California (through
** E.O. Lawrence Berkeley National Laboratory), subject to approval by
** the U.S. Department of Energy. Your use of this software is under
** license -- the license agreement is attached and included in the
** directory as license.txt or you may contact Berkeley Lab's Technology
** Transfer Department at TTD@lbl.gov. NOTICE OF U.S. GOVERNMENT RIGHTS.
** The Software was developed under funding from the U.S. Government
** which consequently retains certain rights as follows: the
** U.S. Government has been granted for itself and others acting on its
** behalf a paid-up, nonexclusive, irrevocable, worldwide license in the
** Software to reproduce, prepare derivative works, and perform publicly
** and display publicly. Beginning five (5) years after the date
** permission to assert copyright is obtained from the U.S. Department of
** Energy, and subject to any subsequent five (5) year renewals, the
** U.S. Government is granted for itself and others acting on its behalf
** a paid-up, nonexclusive, irrevocable, worldwide license in the
** Software to reproduce, prepare derivative works, distribute copies to
** the public, perform publicly and display publicly, and to permit
** others to do so.
*/
#ifndef BL_PARMPARSE_H
#define BL_PARMPARSE_H
//
// $Id: ParmParse.H,v 1.28 2001/08/13 01:54:26 car Exp $
//
#include <stack>
#include <string>
#include <iosfwd>
#include <vector>
#include <list>
//
// ParmParse class implements a simple database for the storage and
// retrieval of command-line and input-file arguments. The entries are
// stored in a static table in (name,value_list) pairs.
//
// The format of the input file is a series of DEFINITIONS.
//
// A DEFINITION is of the form <name> = <value> <value> ...
// The equal sign is important since the list of values can span multiple
// lines.
//
// Comments in an input file include all text from a '#' character to the
// end of the line. Here is an example input file:
//
// niter = 100 # niter is an integer
// title = "Double Wammy" # example of a string with spaces
// cell_size = 0.5 0.75 # cell spacing in each dimension
// plot.var = Density 1 10 # a list of values
// plot.var = Energy 5 12 # another list of values
// bigarray = 1 2 3 4 5 6 7 8 # first part of array
// 9 10 11 12 # continuation of bigarray
// test = apple "boy blue" 10 20 30 40
// FILE = prob_file # insert contents of this "prob_file" here
//
// The "FILE = <filename>" definition is special. Rather than just
// adding this entry to the database, it reads the contents of <filename>
// into the database.
//
// ParmParse stores all entries in a static table which is built the
// first time a ParmParse object is constructed (usually in main()).
// Subsequent invocations have access to this table.
// A ParmParse constructor has an optional "prefix" argument that will
// limit the searches to only those entries of the table with this prefix
// in name. For example:
// ParmParse pp("plot");
// will find only those entries with name given by "plot.<string>".
//
// All values in the table are stored as strings. For example, the
// values of "cell_size" in the above input file are stored as the
// strings "0.5" and "0.75". These strings can be returned as either
// string of numeric values by the query functions.
// Character strings with spaces must be delimited by double quotes
// in the input file but the quotes are stripped before they are entered
// into the table. For example, 'title' in the above input file has a
// single value, the string 'Double Wammy' (without the quotes).
// Each value in the list associated with a definition can be referred to
// by its index number. The index numbers start at 0 just like an array
// in the C programming language. Consider the definition of "test" in
// the above input file. The first value 'apple'is a string with index
// 0. The second value 'boy blue' is a string with index 1. The
// remaining four values are integers indexed 2, 3, 4, and 5.
//
// For a string value to represent an integer or float it must fit the
// following regular experssion:
// Sign ::= '+' | '-'
// Digit ::= '0' | '1' | ... | '9'
// Integer ::= [Sign]Digit+
// Exp ::= ('e'|'E')Integer
// Float ::= ( Integer[.Digit*][Exp] | [Integer].Digit+[Exp] )
//
// Where '+' indicates one or more occurences, '*' represents zero or
// more occurences, '|' means one or the other and '[]' represents zero
// or one occurence.
//
// Note that floats and doubles have the same string representation and
// that the FORTRAN "double" exponent format is not supported.
// That is, 1.0d+3 is not a valid representation of a floating point
// number but that 1.0e+3 is acceptable.
//
// There are a host of functions allowing the user to query the database
// and retrieve values. Here are some general rules about the names of
// the member functions:
//
// * Functions with the string "get" in their names attempt to get a
// value or an array of values from the table. They generate a
// run-time error if they are not successful.
//
// * Functions with the string "query" in their names attempt to get a
// value or an array of values from the table. They return the value 1
// (true) if they are successful and 0 (false) if not.
//
// * Functions with the string "kth" in their names get values from
// the Kth entry with the given name in the database. This is
// necessary since there may be multiple definitions with the same
// name in the database.
//
// * Functions without the string "kth" in their names get values from
// the last entry with the given name in the database. Note that the
// definitions from the command line are appended to the database table
// and hence will be the last entries.
//
// * Functions with the string "arr" in their names get an Array of
// values from the given entry in the table. The array argument is
// resized (if necessary) to hold all the values requested.
//
// * Functions without the string "arr" in their names get single
// values from the given entry in the table.
//
// The following is a code sample showing how to use ParmParse:
//
// main(int argc, char **argv)
// {
// char* in_file_name = argv[1];
// ParmParse::Initialize(argc-2, argv+2, in_file_name);
//
// // Query table for value of "niter". If not in table
// // then set to default value
// if (!pp.query("niter",niter)) niter = 20;
//
// // read array of cell sizes if in table
// Array<float> dx;
// if (nx=pp.countval("cell_size")) {
// // get nx values starting at index 0 and store in dx.
// // dx is automatically resized here.
// pp.getarr("cell_size",dx,0,nx);
// }
// ParmParse::Finalize();
// }
//
// void do_graphics()
// {
// //
// // Will only query entries with the "plot" prefix:
// //
// ParmParse pp("plot");
// //
// // Read all variables with "plot.var" keyword.
// //
// std::string var_name;
// Array<int> range;
// int num = pp.countname("var");
// for (int k = 0; k < num; k++)
// {
// //
// // Element 0 in list is a string.
// //
// pp.getkth("var",k,var_name,0);
// //
// // Elements 1 and 2 are integers.
// // Note that "range" will be resized to hold 2 elements.
// //
// pp.getktharr("var",k,range,1,2);
// cout << "variable = " << var_name << "lo, hi = ",
// << range[0] << " " << range[1] << endl;
// }
// }
// -----------------------------------------------------------------
// ----------------------- END COMMENTS ---------------------------
// -----------------------------------------------------------------
//@Man:
//@Memo: Parse Parameters From Command Line and Input Files
/*@Doc:
The ParmParse class is used to interpret parameters passed in to a program
from the command line and an arbitrary collection of input files. The
parameters are stored in static table that can be queried by any object
of type ParmParse. A parameter is a "definition". A definition is
of the form "<name> = <value><value>...<value>". It is stored in the table
as a name, value-list pair.
In the following example, niter is a definition with the single
integer value 10; name is a definition with the string value "big
code" and dx is a definition with the two floating point values 0.5
and 0.75 and iv is an IntVect(5,4)
prog niter = 10 name = "big code" dx = 0.5 0.75 iv=(5,4)
The ParmParse class has two constructors. The first is responsible for
building the table and is usually called by the main routine of an
application. It has arguments for the command line argc and argv parameters,
as well as an optional filename argument for reading definitions from an
input file. The table is built by reading the input file first (if it
exists) with the command line arguments added to the end of the table.
The order of a definition in the table is significant, so command line
parameters can be used to override definitions in the input file. A
definition of the explicit form: FILE=<filename> is not added to the table
but is a directive to include the named file at that point in the table.
The second constructor is generally used by other classes in the code. It
permits access to the table via a large collection of query functions.
Both constructors have an optional prefix argument that narrows the search
to entries in the table with the same prefix. For example, let PlanR be a
ParmParse object with code prefix "ope". PlanR.get("val",v) will look for
an entry in the parameter list of the form: ope.val==<value>, and will
reject all entries not starting with the correct code prefix.
The query functions search the table for definition names that match a given
string (and prefix) and return values from the corresponding value list.
The values can be returned as ints, Array<int>s, floats, Array<float>s,
doubles, Array<double>s, std::strings, or Array<aSring>s. All values in the
table are stored as std::string objects, but if an int, float, or double is
requested, the translation is done automatically. In the previous example,
the value of niter could be returned as either an std::string, an int, a double,
or a float. The values of dx can be returned as std::strings, floats, or
doubles, but the value of name can be returned only as an std::string.
Comments in an input file include all text from a `\#' character to the
end of the line. Here is a sample input file:
niter = 100
title = "Double Wammy"
cell\_size = 0.5 0.75
plot.var = Density 1 10
plot.var = Energy 5 12
bigarray = 1 2 3 4 5 6 7 8
9 10 11 12
aBox = ((0,0) (5,5))
test = apple "boy blue" 10 20 30 40
FILE = prob\_file
*/
class Box;
class IntVect;
class ParmParse
{
public:
class Frame;
class Record;
enum { LAST = -1, FIRST = 0, ALL = -1 };
/*@ManDoc: Construct an additional ParmParse object sharing the same
internal table as any other such objects in existence. If
prefix is specified, load this string as the code prefix
for this particular ParmParse object.
*/
explicit ParmParse (const std::string& prefix = std::string());
//
//@ManDoc: Returns true if name is in table.
//
bool contains (const char* name) const;
/*@ManDoc: Returns the number of values associated with nth occurence of
name (prepended with the prefix) in the table. n == -1 implies
the last occurence.
*/
int countval (const char* name,
int n = LAST) const;
/*@ManDoc: Returns the number of times the given name (prepended with
prefix) appears in the table.
*/
int countname (const std::string& name) const;
/** Returns the number of records of the given name (prepended with prefix) appears
in the table
*/
int countRecords (const std::string& name) const;
/// Returns the nth record of the given name, or zero if none found.
Record getRecord (const std::string& name, int n = LAST) const;
//
//@ManDoc: Write the contents of the table in ASCII to the ostream.
//
static void dumpTable (std::ostream& os);
/*@ManDoc: Get the ival'th value of kth occurrence of the requested name.
If successful, the value is converted to a bool and stored
in reference ref. If the kth occurrence does not exist or
ival'th value does not exist, or if the printed representation
of the value cannot be converted to an bool, an error message is
output and the program halts. Note that ival == 0 is the first
value in the list. ParmParse converte the value 'true', and non-zero
integers or floats to bool(true), and bool(false) for 'false'
or zero integer or float values.
*/
void getkth (const char* name,
int k,
bool& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as getkth() but searches for the last occurrence of name.
//
void get (const char* name,
bool& ref,
int ival = FIRST) const;
/*@ManDoc: Similar to getkth() but returns 0 if there is no kth occurrence
of name. If successful, it returns 1 and stores the value in
ref. If the kth occurrence exists, but ival'th value of that
occurrence does not, or if there is a type mismatch, then the
program signals an error and halts.
*/
int querykth (const char* name,
int k,
bool& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as querykth() but searches for the last occurrence of name.
//
int query (const char* name,
bool& ref,
int ival = FIRST) const;
/*@ManDoc: Get the ival'th value of kth occurrence of the requested name.
If successful, the value is converted to an int and stored
in reference ref. If the kth occurrence does not exist or
ival'th value does not exist, or if the printed representation
of the value cannot be converted to an int, an error message is
output and the program halts. Note that ival == 0 is the first
value in the list.
*/
void getkth (const char* name,
int k,
int& ref,
int ival = FIRST) const;
//@ManDoc: Same as getkth() but searches for the last occurrence of name.
//
void get (const char* name,
int& ref,
int ival = FIRST) const;
/*@ManDoc: Similar to getkth() but returns 0 if there is no kth occurrence
of name. If successful, it returns 1 and stores the value in
ref. If the kth occurrence exists, but ival'th value of that
occurrence does not, or if there is a type mismatch, then the
program signals an error and halts.
*/
int querykth (const char* name,
int k,
int& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as querykth() but searches for the last occurrence of name.
//
int query (const char* name,
int& ref,
int ival = FIRST) const;
/*@ManDoc: Get the ival'th value of kth occurrence of the requested name.
If successful, the value is converted to a float and stored
in reference ref. If the kth occurrence does not exist or
ival'th value does not exist, or if the printed representation
of the value cannot be converted to a float, an error message
is output and the program halts. Note that ival == 0 is the
first value in the list.
*/
void getkth (const char* name,
int k,
float& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as getkth() but searches for the last occurrence of name.
//
void get (const char* name,
float& ref,
int ival = FIRST) const;
/*@ManDoc: Similar to getkth() but returns 0 if there is no kth occurrence
of name. If successful, it returns 1 and stores the value in
ref. If the kth occurrence exists, but ival'th value of that
occurrence does not, or if there is a type mismatch, then the
program signals an error and halts.
*/
int querykth (const char* name,
int k,
float& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as querykth() but searches for the last occurrence of name.
//
int query (const char* name,
float& ref,
int ival = FIRST) const;
/*@ManDoc: Get the ival'th value of kth occurrence of the requested name.
If successful, the value is converted to a double and stored
in reference ref. If the kth occurrence does not exist or
ival'th value does not exist, or if the printed representation
of the value cannot be converted to a double, an error message
is output and the program halts. Note that ival = 0 is the
first value in the list.
*/
void getkth (const char* name,
int k,
double& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as getkth() but searches for the last occurrence of name.
//
void get (const char* name,
double& ref,
int ival = FIRST) const;
/*@ManDoc: Similar to getkth() but returns 0 if there is no kth occurrence
of name. If successful, it returns 1 and stores the value in
ref. If the kth occurrence exists, but ival'th value of that
occurrence does not, or if there is a type mismatch, then the
program signals an error and halts.
*/
int querykth (const char* name,
int k,
double& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as querykth() but searches for the last occurrence of name.
//
int query (const char* name,
double& ref,
int ival = FIRST) const;
/*@ManDoc: Get the ival'th value of kth occurrence of the requested name.
If successful, the value is converted to a std::string and stored
in reference ref. If the kth occurrence does not exist or
ival'th value does not exist, or if the printed representation
of the value cannot be converted to a std::string, an error message
is output and the program halts. Note that ival = 0 is the
first value in the list.
*/
void getkth (const char* name,
int k,
std::string& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as getkth() but searches for the last occurrence of name.
//
void get (const char* name,
std::string& ref,
int ival = FIRST) const;
/*@ManDoc: Similar to getkth() but returns 0 if there is no kth occurrence
of name. If successful, it returns 1 and stores the value in
ref. If the kth occurrence exists, but ival'th value of that
occurrence does not, or if there is a type mismatch, then the
program signals an error and halts.
*/
int querykth (const char* name,
int k,
std::string& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as querykth() but searches for the last occurrence of name.
//
int query (const char* name,
std::string& ref,
int ival = FIRST) const;
/*@ManDoc: Get the ival'th value of kth occurrence of the requested name.
If successful, the value is converted to an IntVect and stored
in reference ref. If the kth occurrence does not exist or
ival'th value does not exist, or if the printed representation
of the value cannot be converted to a IntVect, an error message
is output and the program halts. Note that ival = 0 is the
first value in the list.
*/
void getkth (const char* name,
int k,
IntVect& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as getkth() but searches for the last occurrence of name.
//
void get (const char* name,
IntVect& ref,
int ival = FIRST) const;
/*@ManDoc: Similar to getkth() but returns 0 if there is no kth occurrence
of name. If successful, it returns 1 and stores the value in
ref. If the kth occurrence exists, but ival'th value of that
occurrence does not, or if there is a type mismatch, then the
program signals an error and halts.
*/
int querykth (const char* name,
int k,
IntVect& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as querykth() but searches for the last occurrence of name.
//
int query (const char* name,
IntVect& ref,
int ival = FIRST) const;
/*@ManDoc: Get the ival'th value of kth occurrence of the requested name.
If successful, the value is converted to a Box and stored
in reference ref. If the kth occurrence does not exist or
ival'th value does not exist, or if the printed representation
of the value cannot be converted to a Box, an error message
is output and the program halts. Note that ival = 0 is the
first value in the list.
*/
void getkth (const char* name,
int k,
Box& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as getkth() but searches for the last occurrence of name.
//
void get (const char* name,
Box& ref,
int ival = FIRST) const;
/*@ManDoc: Similar to getkth() but returns 0 if there is no kth occurrence
of name. If successful, it returns 1 and stores the value in
ref. If the kth occurrence exists, but ival'th value of that
occurrence does not, or if there is a type mismatch, then the
program signals an error and halts.
*/
int querykth (const char* name,
int k,
Box& ref,
int ival = FIRST) const;
//
//@ManDoc: Same as querykth() but searches for the last occurrence of name.
//
int query (const char* name,
Box& ref,
int ival = FIRST) const;
/*@ManDoc: Gets an std::vector<int> of num\_val values from kth occurrence of
given name. If successful, the values are converted to an int
and stored in the std::vector<int> object ref. ref is resized (if
necessary) to hold num\_val values. The value in the list
indexed by start\_ix is copied into std::vector<int>[0], std::vector<int>[1]
holds start\_ix+1, etc. If the kth occurrence does not exist
or there are fewer than start\_ix + num\_val values associated
with the kth occurrence, or if some of the values cannot be
converted to an int, an error message is reported and the
program halts.
*/
void getktharr (const char* name,
int k,
std::vector<int>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as getktharr() but searches for last occurrence of name.
//
void getarr (const char* name,
std::vector<int>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: queryktharr() is to querykth() as getktharr() is to getkth().
//
int queryktharr (const char* name,
int k,
std::vector<int>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as queryktharr() but searches for last occurrence of name.
//
int queryarr (const char* name,
std::vector<int>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
/*@ManDoc: Gets an std::vector<float> of num\_val values from kth occurrence of
given name. If successful, the values are converted to a float
and stored in the std::vector<float> object ref. ref is resized (if
necessary) to hold num\_val values. The value in the list
indexed by start\_ix is copied into std::vector<float>[0],
std::vector<float>[1] holds start\_ix+1, etc. If the kth occurrence
does not exist or there are fewer than start\_ix + num\_val
values associated with the kth occurrence, or if some of the
values cannot be converted to a float, an error message is
reported and the program halts.
*/
void getktharr (const char* name,
int k,
std::vector<float>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as getktharr() but searches for last occurrence of name.
//
void getarr (const char* name,
std::vector<float>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: queryktharr() is to querykth() as getktharr() is to getkth().
//
int queryktharr (const char* name,
int k,
std::vector<float>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as queryktharr() but searches for last occurrence of name.
//
int queryarr (const char* name,
std::vector<float>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
/*@ManDoc: Gets an std::vector<double> of num\_val values from kth occurrence of
given name. If successful, the values are converted to a double
and stored in the std::vector<double> object ref. ref is resized (if
necessary) to hold num\_val values. The value in the list
indexed by start\_ix is copied into std::vector<double>[0],
std::vector<double>[1] holds start\_ix+1, etc. If the kth occurrence
does not exist or there are fewer than start\_ix + num\_val
values associated with the kth occurrence, or if some of the
values cannot be converted to a double, an error message is
reported and the program halts.
*/
void getktharr (const char* name,
int k,
std::vector<double>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as getktharr() but searches for last occurrence of name.
//
void getarr (const char* name,
std::vector<double>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: queryktharr() is to querykth() as getktharr() is to getkth().
//
int queryktharr (const char* name,
int k,
std::vector<double>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as queryktharr() but searches for last occurrence of name.
//
int queryarr (const char* name,
std::vector<double>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
/*@ManDoc: Gets an std::vector<std::string> of num\_val values from kth occurrence of
given name. If successful, the values are converted to an
std::string and stored in the std::vector<std::string> object ref. ref is
resized (if necessary) to hold num\_val values. The value in
the list indexed by start\_ix is copied into std::vector<std::string>[0],
std::vector<std::string>[1] holds start\_ix+1, etc. If the kth occurrence
does not exist or there are fewer than start\_ix + num\_val
values associated with the kth occurrence, or if some of the
values cannot be converted to an std::string, an error message is
reported and the program halts.
*/
void getktharr (const char* name,
int k,
std::vector<std::string>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as getktharr() but searches for last occurrence of name.
//
void getarr (const char* name,
std::vector<std::string>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: queryktharr() is to querykth() as getktharr() is to getkth().
//
int queryktharr (const char* name,
int k,
std::vector<std::string>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as queryktharr() but searches for last occurrence of name.2
//
int queryarr (const char* name,
std::vector<std::string>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
/*@ManDoc: Gets an std::vector<IntVect> of num\_val values from kth occurrence of
given name. If successful, the values are converted to an
IntVect and stored in the std::vector<IntVect> object ref. ref is
resized (if necessary) to hold num\_val values. The value in
the list indexed by start\_ix is copied into std::vector<IntVect>[0],
std::vector<IntVect>[1] holds start\_ix+1, etc. If the kth occurrence
does not exist or there are fewer than start\_ix + num\_val
values associated with the kth occurrence, or if some of the
values cannot be converted to an IntVect, an error message is
reported and the program halts.
*/
void getktharr (const char* name,
int k,
std::vector<IntVect>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as getktharr() but searches for last occurrence of name.
//
void getarr (const char* name,
std::vector<IntVect>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: queryktharr() is to querykth() as getktharr() is to getkth().
//
int queryktharr (const char* name,
int k,
std::vector<IntVect>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as queryktharr() but searches for last occurrence of name.2
//
int queryarr (const char* name,
std::vector<IntVect>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
/*@ManDoc: Gets an std::vector<Box> of num\_val values from kth occurrence of
given name. If successful, the values are converted to an
Box and stored in the std::vector<Box> object ref. ref is
resized (if necessary) to hold num\_val values. The value in
the list indexed by start\_ix is copied into std::vector<Box>[0],
std::vector<Box>[1] holds start\_ix+1, etc. If the kth occurrence
does not exist or there are fewer than start\_ix + num\_val
values associated with the kth occurrence, or if some of the
values cannot be converted to an Box, an error message is
reported and the program halts.
*/
void getktharr (const char* name,
int k,
std::vector<Box>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as getktharr() but searches for last occurrence of name.
//
void getarr (const char* name,
std::vector<Box>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: queryktharr() is to querykth() as getktharr() is to getkth().
//
int queryktharr (const char* name,
int k,
std::vector<Box>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
//
//@ManDoc: Same as queryktharr() but searches for last occurrence of name.2
//
int queryarr (const char* name,
std::vector<Box>& ref,
int start_ix = FIRST,
int num_val = ALL) const;
/*@ManDoc: Construct an initial ParmParse object from the argc and argv
passed in to main(). An error will be signalled if another
ParmParse object currently exists. If parfile is specified,
read the parameters in from that file first and then append
those derived from argv to the table. If prefix is specified,
load this string as the code prefix for this particular
ParmParse object.
*/
static void Initialize(int argc,
char** argv,
const char* parfile);
/*@ManDoc: The destructor. The internal static table will only be deleted
if there are no other ParmParse objects in existence.
*/
static void Finalize();
/* publicly needed helpers */
struct PP_entry;
typedef std::list<PP_entry> Table;
private:
friend class Frame;
friend class Record;
explicit ParmParse (const Table& tbl);
/// Set/Get the prefix.
std::string getPrefix() const;
std::string setPrefix(const std::string& str);
void pushPrefix(const std::string& str);
void popPrefix();
std::string prefixedName (const std::string& str) const;
//
// Prefix used in keyword search.
//
std::stack<std::string> m_pstack;
const Table& m_table;
};
struct ParmParse::PP_entry
{
PP_entry (const std::string& name,
const std::list<std::string>& vals);
PP_entry (const std::string& name,
const Table& table);
PP_entry (const PP_entry& pe);
PP_entry& operator= (const PP_entry& pe);
~PP_entry ();
std::string m_name;
std::vector<std::string> m_vals;
Table* m_table;
mutable bool m_queried;
};
class ParmParse::Frame
{
public:
Frame (ParmParse& pp, const std::string& str);
~Frame ();
void push(const std::string& str);
void pop();
std::string getPrefix() const;
private:
ParmParse& m_pp;
int m_np;
};
class ParmParse::Record
{
public:
const ParmParse* operator->() const;
const ParmParse& operator* () const;
private:
friend class ParmParse;
explicit Record (const ParmParse& pp);
ParmParse m_pp;
};
#endif /*BL_PARMPARSE_H*/
|