42 #ifndef TEUCHOS_COMMAND_LINE_PROCESSOR_HPP
43 #define TEUCHOS_COMMAND_LINE_PROCESSOR_HPP
56 #include "Teuchos_Ptr.hpp"
84 {
public:
ParseError(
const std::string& what_arg) : std::logic_error(what_arg) {}};
100 ,PARSE_HELP_PRINTED = 1
101 ,PARSE_UNRECOGNIZED_OPTION = 2
126 bool throwExceptions =
true
127 ,
bool recogniseAllOptions =
true
128 ,
bool addOutputSetupOptions =
false
141 void throwExceptions(
const bool & throwExceptions );
144 bool throwExceptions()
const;
147 void recogniseAllOptions(
const bool & recogniseAllOptions );
150 bool recogniseAllOptions()
const;
153 void addOutputSetupOptions(
const bool &addOutputSetupOptions );
156 bool addOutputSetupOptions()
const;
165 void setDocString(
const char doc_string[] );
180 const char option_true[]
181 ,
const char option_false[]
183 ,
const char documentation[] = NULL
197 const char option_name[]
199 ,
const char documentation[] = NULL
200 ,
const bool required =
false
214 const char option_name[]
215 ,
long int *option_val
216 ,
const char documentation[] = NULL
217 ,
const bool required =
false
231 const char option_name[]
233 ,
const char documentation[] = NULL
234 ,
const bool required =
false
248 const char option_name[]
249 ,
long long int *option_val
250 ,
const char documentation[] = NULL
251 ,
const bool required =
false
265 const char option_name[]
267 ,
const char documentation[] = NULL
268 ,
const bool required =
false
282 const char option_name[]
284 ,
const char documentation[] = NULL
285 ,
const bool required =
false
299 const char option_name[]
300 ,std::string *option_val
301 ,
const char documentation[] = NULL
302 ,
const bool required =
false
333 template <
class EType>
335 const char enum_option_name[],
336 EType* enum_option_val,
337 const int num_enum_opt_values,
338 const EType enum_opt_values[],
339 const char *
const enum_opt_names[],
340 const char documentation[] =
nullptr,
341 const bool required =
false );
407 EParseCommandLineReturn parse(
410 ,std::ostream *errout = &std::cerr
426 void printHelpMessage(
const char program_name[], std::ostream &out )
const;
439 enum EOptType { OPT_NONE, OPT_BOOL_TRUE, OPT_BOOL_FALSE, OPT_INT, OPT_LONG_INT, OPT_SIZE_T,
441 OPT_DOUBLE, OPT_FLOAT, OPT_STRING, OPT_ENUM_INT };
458 struct opt_val_val_t {
464 opt_val_val_t( EOptType opt_type_in,
const any& opt_val_in,
bool required_in )
465 :opt_type(opt_type_in),opt_val(opt_val_in),required(required_in),was_read(false)
481 opt_doc_t(EOptType opt_type_in,
const std::string& opt_name_in,
const std::string& opt_name_false_in
482 ,
const std::string &documentation_in,
const any &default_val_in )
483 :opt_type(opt_type_in),opt_name(opt_name_in),opt_name_false(opt_name_false_in)
484 ,documentation(documentation_in),default_val(default_val_in)
487 std::string opt_name;
488 std::string opt_name_false;
489 std::string documentation;
494 typedef std::vector<opt_doc_t> options_documentation_list_t;
497 struct enum_opt_data_t {
499 :enum_option_val(NULL), num_enum_opt_values(0)
502 int* _enum_option_val
503 ,
const int _num_enum_opt_values
504 ,
const int _enum_opt_values[]
505 ,
const char *
const _enum_opt_names[]
507 :enum_option_val(_enum_option_val),
508 num_enum_opt_values(_num_enum_opt_values),
509 enum_opt_values(_enum_opt_values,_enum_opt_values+_num_enum_opt_values)
511 for(
int k = 0; k < num_enum_opt_values; ++k )
512 enum_opt_names.push_back(std::string(_enum_opt_names[k]));
514 int *enum_option_val;
515 int num_enum_opt_values;
516 std::vector<int> enum_opt_values;
517 std::vector<std::string> enum_opt_names;
521 typedef std::vector<enum_opt_data_t> enum_opt_data_list_t;
526 bool throwExceptions_;
527 bool recogniseAllOptions_;
528 bool addOutputSetupOptions_;
529 std::string doc_string_;
533 #pragma warning(push)
534 #pragma warning(disable:4251)
536 mutable options_list_t options_list_;
537 options_documentation_list_t options_documentation_list_;
538 enum_opt_data_list_t enum_opt_data_list_;
543 bool output_all_front_matter_;
544 bool output_show_line_prefix_;
545 bool output_show_tab_count_;
546 bool output_show_proc_rank_;
547 int output_to_root_rank_only_;
548 bool print_rcpnode_statistics_on_exit_;
549 bool show_timer_summary_on_exit_;
551 bool printed_timer_summary_;
553 bool added_extra_output_setup_options_;
554 bool in_add_extra_output_setup_options_;
556 static const bool output_all_front_matter_default_;
557 static const bool output_show_line_prefix_default_;
558 static const bool output_show_tab_count_default_;
559 static const bool output_show_proc_rank_default_;
560 static const int output_to_root_rank_only_default_;
561 static const bool print_rcpnode_statistics_on_exit_default_;
562 static const bool show_timer_summary_on_exit_default_;
568 void add_extra_output_setup_options()
const;
572 const char enum_option_name[],
573 int* enum_option_val,
574 const int num_enum_opt_values,
575 const int enum_opt_values[],
576 const char *
const enum_opt_names[],
577 const char documentation[],
585 ,
const std::string &enum_opt_name
587 ,
const std::string &enum_str_val
588 ,std::ostream *errout
592 void print_enum_opt_names(
598 std::string enum_opt_default_val_name(
599 const std::string &enum_name
601 ,std::ostream *errout
605 int find_enum_opt_index(
606 const std::string &enum_opt_name
608 ,
const enum_opt_data_t &enum_data
609 ,std::ostream *errout
616 ,std::string *opt_name
617 ,std::string *opt_val_str
621 std::string opt_type_str( EOptType )
const;
627 ,std::ostream *errout
671 virtual void summarize(std::ostream &out=std::cout) = 0;
694 { throwExceptions_ = throwExceptions_in; }
699 {
return throwExceptions_; }
704 { recogniseAllOptions_ = recogniseAllOptions_in; }
709 {
return recogniseAllOptions_; }
714 { addOutputSetupOptions_ = addOutputSetupOptions_in; }
719 {
return addOutputSetupOptions_; }
722 template <
class EType>
725 const char enum_option_name[],
726 EType* enum_option_val,
727 const int num_enum_opt_values,
728 const EType enum_opt_values[],
729 const char *
const enum_opt_names[],
730 const char documentation[],
745 reinterpret_cast<int*>(enum_option_val),
747 reinterpret_cast<const int*>(enum_opt_values),
755 std::string CommandLineProcessor::opt_type_str( EOptType opt_type )
const
771 case OPT_LONG_LONG_INT:
772 str =
"long long int";
796 #endif // TEUCHOS_COMMAND_LINE_PROCESSOR_HPP
Modified boost::any class for holding a templated value.
Thrown if –help was specified and throwExceptions==true.
Template classes for testing assertions at compile time.
bool throwExceptions() const
Returns true if an std::exception is thrown, there is a parse error, or help is printed.
virtual ~TimeMonitorSurrogate()
! brief.
Thrown if an unrecognized option was found and throwExceptions==true.
void setOption(const char option_true[], const char option_false[], bool *option_val, const char documentation[]=NULL)
Set a boolean option.
Interface by which CommandLineProcessor may use TimeMonitor.
bool addOutputSetupOptions() const
Returns true options will be automatically added to setup Teuchos::VerboseObjectBase::getDefaultOStre...
Provides std::map class for deficient platforms.
EParseCommandLineReturn
Return value for CommandLineProcessor::parse(). Note: These enums are all given non-negative values s...
bool recogniseAllOptions() const
Returns true if all options must be recognized by the parser.
Smart reference counting pointer class for automatic garbage collection.
If instantiated (for Test!=0) then this should not compile!
Thrown if a parse std::exception occurs and throwExceptions==true.
Class that helps parse command line input arguments from (argc,argv[]) and set options.
Simple wrapper class for raw pointers to single objects where no persisting relationship exists...