1 /********************* */
2 /*! \file options_template.cpp
4 ** Top contributors (to current version):
5 ** Morgan Deters, Tim King, Andrew Reynolds
6 ** This file is part of the CVC4 project.
7 ** Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
8 ** in the top-level source directory and their institutional affiliations.
9 ** All rights reserved. See the file COPYING in the top-level source
10 ** directory for licensing information.\endverbatim
12 ** \brief Contains code for handling command-line options.
14 ** Contains code for handling command-line options
17 #if !defined(_BSD_SOURCE) && defined(__MINGW32__) && !defined(__MINGW64__)
18 // force use of optreset; mingw32 croaks on argv-switching otherwise
19 # include "cvc4autoconfig.h"
21 # undef HAVE_DECL_OPTRESET
22 # define HAVE_DECL_OPTRESET 1
23 # define CVC4_IS_NOT_REALLY_BSD
24 #endif /* !_BSD_SOURCE && __MINGW32__ && !__MINGW64__ */
28 #endif /* __MINGW64__ */
33 #ifdef CVC4_IS_NOT_REALLY_BSD
35 #endif /* CVC4_IS_NOT_REALLY_BSD */
50 #include "base/check.h"
51 #include "base/exception.h"
52 #include "base/output.h"
53 #include "options/didyoumean.h"
54 #include "options/language.h"
55 #include "options/options_handler.h"
56 #include "options/options_listener.h"
61 #include "options/options_holder.h"
62 #include "cvc4autoconfig.h"
63 #include "options/base_handlers.h"
68 using namespace cvc5::options
;
72 thread_local Options
* Options::s_current
= NULL
;
75 * This is a default handler for options of built-in C++ type. This
76 * template is really just a helper for the handleOption() template,
77 * below. Variants of this template handle numeric and non-numeric,
78 * integral and non-integral, signed and unsigned C++ types.
79 * handleOption() makes sure to instantiate the right one.
81 * This implements default behavior when e.g. an option is
82 * unsigned but the user specifies a negative argument; etc.
84 template <class T
, bool is_numeric
, bool is_integer
>
85 struct OptionHandler
{
86 static T
handle(std::string option
, std::string optionarg
);
87 };/* struct OptionHandler<> */
89 /** Variant for integral C++ types */
91 struct OptionHandler
<T
, true, true> {
92 static bool stringToInt(T
& t
, const std::string
& str
) {
93 std::istringstream
ss(str
);
96 return !(ss
.fail() || ss
.get(tmp
));
99 static bool containsMinus(const std::string
& str
) {
100 return str
.find('-') != std::string::npos
;
103 static T
handle(const std::string
& option
, const std::string
& optionarg
) {
106 bool success
= stringToInt(i
, optionarg
);
109 throw OptionException(option
+ ": failed to parse "+ optionarg
+
110 " as an integer of the appropriate type.");
113 // Depending in the platform unsigned numbers with '-' signs may parse.
114 // Reject these by looking for any minus if it is not signed.
115 if( (! std::numeric_limits
<T
>::is_signed
) && containsMinus(optionarg
) ) {
116 // unsigned type but user gave negative argument
117 throw OptionException(option
+ " requires a nonnegative argument");
118 } else if(i
< std::numeric_limits
<T
>::min()) {
119 // negative overflow for type
120 std::stringstream ss
;
121 ss
<< option
<< " requires an argument >= "
122 << std::numeric_limits
<T
>::min();
123 throw OptionException(ss
.str());
124 } else if(i
> std::numeric_limits
<T
>::max()) {
125 // positive overflow for type
126 std::stringstream ss
;
127 ss
<< option
<< " requires an argument <= "
128 << std::numeric_limits
<T
>::max();
129 throw OptionException(ss
.str());
134 // if(std::numeric_limits<T>::is_signed) {
135 // return T(i.getLong());
137 // return T(i.getUnsignedLong());
139 } catch(std::invalid_argument
&) {
140 // user gave something other than an integer
141 throw OptionException(option
+ " requires an integer argument");
144 };/* struct OptionHandler<T, true, true> */
146 /** Variant for numeric but non-integral C++ types */
148 struct OptionHandler
<T
, true, false> {
149 static T
handle(std::string option
, std::string optionarg
) {
150 std::stringstream
in(optionarg
);
154 // we didn't consume the whole string (junk at end)
155 throw OptionException(option
+ " requires a numeric argument");
158 if(! std::numeric_limits
<T
>::is_signed
&& r
< 0.0) {
159 // unsigned type but user gave negative value
160 throw OptionException(option
+ " requires a nonnegative argument");
161 } else if(r
< -std::numeric_limits
<T
>::max()) {
162 // negative overflow for type
163 std::stringstream ss
;
164 ss
<< option
<< " requires an argument >= "
165 << -std::numeric_limits
<T
>::max();
166 throw OptionException(ss
.str());
167 } else if(r
> std::numeric_limits
<T
>::max()) {
168 // positive overflow for type
169 std::stringstream ss
;
170 ss
<< option
<< " requires an argument <= "
171 << std::numeric_limits
<T
>::max();
172 throw OptionException(ss
.str());
177 };/* struct OptionHandler<T, true, false> */
179 /** Variant for non-numeric C++ types */
181 struct OptionHandler
<T
, false, false> {
182 static T
handle(std::string option
, std::string optionarg
) {
183 T::unsupported_handleOption_call___please_write_me
;
184 // The above line causes a compiler error if this version of the template
185 // is ever instantiated (meaning that a specialization is missing). So
186 // don't worry about the segfault in the next line, the "return" is only
187 // there to keep the compiler from giving additional, distracting errors
191 };/* struct OptionHandler<T, false, false> */
193 /** Handle an option of type T in the default way. */
195 T
handleOption(std::string option
, std::string optionarg
) {
196 return OptionHandler
<T
, std::numeric_limits
<T
>::is_specialized
, std::numeric_limits
<T
>::is_integer
>::handle(option
, optionarg
);
199 /** Handle an option of type std::string in the default way. */
201 std::string handleOption
<std::string
>(std::string option
, std::string optionarg
) {
206 * Run handler, and any user-given predicates, for option T.
207 * If a user specifies a :handler or :predicates, it overrides this.
210 typename
T::type
runHandlerAndPredicates(T
, std::string option
, std::string optionarg
, options::OptionsHandler
* handler
) {
211 // By default, parse the option argument in a way appropriate for its type.
212 // E.g., for "unsigned int" options, ensure that the provided argument is
213 // a nonnegative integer that fits in the unsigned int type.
215 return handleOption
<typename
T::type
>(option
, optionarg
);
219 void runBoolPredicates(T
, std::string option
, bool b
, options::OptionsHandler
* handler
) {
220 // By default, nothing to do for bool. Users add things with
221 // :predicate in options files to provide custom checking routines
222 // that can throw exceptions.
225 Options::Options(OptionsListener
* ol
)
226 : d_holder(new options::OptionsHolder()),
227 d_handler(new options::OptionsHandler(this)),
231 Options::~Options() {
236 void Options::copyValues(const Options
& options
){
237 if(this != &options
) {
239 d_holder
= new options::OptionsHolder(*options
.d_holder
);
243 std::string
Options::formatThreadOptionException(const std::string
& option
) {
244 std::stringstream ss
;
245 ss
<< "can't understand option `" << option
246 << "': expected something like --threadN=\"--option1 --option2\","
247 << " where N is a nonnegative integer";
251 void Options::setListener(OptionsListener
* ol
) { d_olisten
= ol
; }
255 #if defined(CVC4_MUZZLED) || defined(CVC4_COMPETITION_MODE)
256 # define DO_SEMANTIC_CHECKS_BY_DEFAULT false
257 #else /* CVC4_MUZZLED || CVC4_COMPETITION_MODE */
258 # define DO_SEMANTIC_CHECKS_BY_DEFAULT true
259 #endif /* CVC4_MUZZLED || CVC4_COMPETITION_MODE */
261 options::OptionsHolder::OptionsHolder() :
267 static const std::string mostCommonOptionsDescription
= "\
268 Most commonly-used CVC4 options:\n"
272 static const std::string optionsDescription
= mostCommonOptionsDescription
+ "\n\
274 Additional CVC4 options:\n"
278 static const std::string optionsFootnote
= "\n\
279 [*] Each of these options has a --no-OPTIONNAME variant, which reverses the\n\
280 sense of the option.\n\
283 static const std::string languageDescription
=
285 Languages currently supported as arguments to the -L / --lang option:\n\
286 auto attempt to automatically determine language\n\
287 cvc4 | presentation | pl CVC4 presentation language\n\
288 smt | smtlib | smt2 |\n\
289 smt2.6 | smtlib2.6 SMT-LIB format 2.6 with support for the strings standard\n\
290 tptp TPTP format (cnf, fof and tff)\n\
291 sygus | sygus2 SyGuS version 2.0\n\
293 Languages currently supported as arguments to the --output-lang option:\n\
294 auto match output language to input language\n\
295 cvc4 | presentation | pl CVC4 presentation language\n\
296 cvc3 CVC3 presentation language\n\
297 smt | smtlib | smt2 |\n\
298 smt2.6 | smtlib2.6 SMT-LIB format 2.6 with support for the strings standard\n\
300 ast internal format (simple syntax trees)\n\
303 std::string
Options::getDescription() const {
304 return optionsDescription
;
307 void Options::printUsage(const std::string msg
, std::ostream
& out
) {
308 out
<< msg
<< optionsDescription
<< std::endl
309 << optionsFootnote
<< std::endl
<< std::flush
;
312 void Options::printShortUsage(const std::string msg
, std::ostream
& out
) {
313 out
<< msg
<< mostCommonOptionsDescription
<< std::endl
314 << optionsFootnote
<< std::endl
315 << "For full usage, please use --help."
316 << std::endl
<< std::endl
<< std::flush
;
319 void Options::printLanguageHelp(std::ostream
& out
) {
320 out
<< languageDescription
<< std::flush
;
324 * This is a table of long options. By policy, each short option
325 * should have an equivalent long option (but the reverse isn't the
326 * case), so this table should thus contain all command-line options.
328 * Each option in this array has four elements:
330 * 1. the long option string
331 * 2. argument behavior for the option:
332 * no_argument - no argument permitted
333 * required_argument - an argument is expected
334 * optional_argument - an argument is permitted but not required
335 * 3. this is a pointer to an int which is set to the 4th entry of the
336 * array if the option is present; or NULL, in which case
337 * getopt_long() returns the 4th entry
338 * 4. the return value for getopt_long() when this long option (or the
339 * value to set the 3rd entry to; see #3)
341 * If you add something here, you should add it in src/main/usage.h
342 * also, to document it.
344 * If you add something that has a short option equivalent, you should
345 * add it to the getopt_long() call in parseOptions().
347 static struct option cmdlineOptions
[] = {
349 { NULL
, no_argument
, NULL
, '\0' }
350 };/* cmdlineOptions */
354 /** Set a given Options* as "current" just for a particular scope. */
359 OptionsGuard(Options
** field
, Options
* opts
) :
367 };/* class OptionsGuard */
369 } // namespace options
372 * Parse argc/argv and put the result into a cvc5::Options.
373 * The return value is what's left of the command line (that is, the
374 * non-option arguments).
376 * Throws OptionException on failures.
378 std::vector
<std::string
> Options::parseOptions(Options
* options
,
382 Assert(options
!= NULL
);
383 Assert(argv
!= NULL
);
385 options::OptionsGuard
guard(&s_current
, options
);
387 const char *progName
= argv
[0];
389 // To debug options parsing, you may prefer to simply uncomment this
390 // and recompile. Debug flags have not been parsed yet so these have
392 //DebugChannel.on("options");
394 Debug("options") << "Options::parseOptions == " << options
<< std::endl
;
395 Debug("options") << "argv == " << argv
<< std::endl
;
397 // Find the base name of the program.
398 const char *x
= strrchr(progName
, '/');
402 options
->d_holder
->binary_name
= std::string(progName
);
404 std::vector
<std::string
> nonoptions
;
405 parseOptionsRecursive(options
, argc
, argv
, &nonoptions
);
406 if(Debug
.isOn("options")){
407 for(std::vector
<std::string
>::const_iterator i
= nonoptions
.begin(),
408 iend
= nonoptions
.end(); i
!= iend
; ++i
){
409 Debug("options") << "nonoptions " << *i
<< std::endl
;
416 void Options::parseOptionsRecursive(Options
* options
,
419 std::vector
<std::string
>* nonoptions
)
422 if(Debug
.isOn("options")) {
423 Debug("options") << "starting a new parseOptionsRecursive with "
424 << argc
<< " arguments" << std::endl
;
425 for( int i
= 0; i
< argc
; i
++ ){
426 Assert(argv
[i
] != NULL
);
427 Debug("options") << " argv[" << i
<< "] = " << argv
[i
] << std::endl
;
431 // Having this synonym simplifies the generation code in mkoptions.
432 options::OptionsHandler
* handler
= options
->d_handler
;
434 // Reset getopt(), in the case of multiple calls to parseOptions().
435 // This can be = 1 in newer GNU getopt, but older (< 2007) require = 0.
437 #if HAVE_DECL_OPTRESET
438 optreset
= 1; // on BSD getopt() (e.g. Mac OS), might need this
439 #endif /* HAVE_DECL_OPTRESET */
441 // We must parse the binary name, which is manually ignored below. Setting
442 // this to 1 leads to incorrect behavior on some platforms.
447 while(true) { // Repeat Forever
450 std::string option
, optionarg
;
452 optind
= main_optind
;
453 old_optind
= main_optind
;
455 // If we encounter an element that is not at zero and does not start
456 // with a "-", this is a non-option. We consume this element as a
458 if (main_optind
> 0 && main_optind
< argc
&&
459 argv
[main_optind
][0] != '-') {
460 Debug("options") << "enqueueing " << argv
[main_optind
]
461 << " as a non-option." << std::endl
;
462 nonoptions
->push_back(argv
[main_optind
]);
468 Debug("options") << "[ before, main_optind == " << main_optind
<< " ]"
470 Debug("options") << "[ before, optind == " << optind
<< " ]" << std::endl
;
471 Debug("options") << "[ argc == " << argc
<< ", argv == " << argv
<< " ]"
473 int c
= getopt_long(argc
, argv
,
474 "+:${options_short}$",
475 cmdlineOptions
, NULL
);
477 main_optind
= optind
;
479 Debug("options") << "[ got " << int(c
) << " (" << char(c
) << ") ]"
480 << "[ next option will be at pos: " << optind
<< " ]"
483 // The initial getopt_long call should always determine that argv[0]
484 // is not an option and returns -1. We always manually advance beyond
486 if ( old_optind
== 0 && c
== -1 ) {
487 Assert(main_optind
> 0);
492 if(Debug
.isOn("options")) {
493 Debug("options") << "done with option parsing" << std::endl
;
494 for(int index
= optind
; index
< argc
; ++index
) {
495 Debug("options") << "remaining " << argv
[index
] << std::endl
;
501 option
= argv
[old_optind
== 0 ? 1 : old_optind
];
502 optionarg
= (optarg
== NULL
) ? "" : optarg
;
504 Debug("preemptGetopt") << "processing option " << c
505 << " (`" << char(c
) << "'), " << option
<< std::endl
;
513 // This can be a long or short option, and the way to get at the
514 // name of it is different.
515 throw OptionException(std::string("option `") + option
+
516 "' missing its required argument");
520 throw OptionException(std::string("can't understand option `") + option
+
521 "'" + suggestCommandLineOptions(option
));
525 Debug("options") << "got " << nonoptions
->size()
526 << " non-option arguments." << std::endl
;
529 std::string
Options::suggestCommandLineOptions(const std::string
& optionName
)
531 DidYouMean didYouMean
;
534 for(size_t i
= 0; (opt
= cmdlineOptions
[i
].name
) != NULL
; ++i
) {
535 didYouMean
.addWord(std::string("--") + cmdlineOptions
[i
].name
);
538 return didYouMean
.getMatchAsString(optionName
.substr(0, optionName
.find('=')));
541 static const char* smtOptions
[] = {
546 std::vector
<std::string
> Options::suggestSmtOptions(
547 const std::string
& optionName
)
549 std::vector
<std::string
> suggestions
;
552 for(size_t i
= 0; (opt
= smtOptions
[i
]) != NULL
; ++i
) {
553 if(std::strstr(opt
, optionName
.c_str()) != NULL
) {
554 suggestions
.push_back(opt
);
561 std::vector
<std::vector
<std::string
> > Options::getOptions() const
563 std::vector
< std::vector
<std::string
> > opts
;
565 $
{options_getoptions
}$
571 void Options::setOption(const std::string
& key
, const std::string
& optionarg
)
573 Trace("options") << "setOption(" << key
<< ", " << optionarg
<< ")"
575 // first update this object
576 setOptionInternal(key
, optionarg
);
577 // then, notify the provided listener
578 if (d_olisten
!= nullptr)
580 d_olisten
->notifySetOption(key
);
584 void Options::setOptionInternal(const std::string
& key
,
585 const std::string
& optionarg
)
587 options::OptionsHandler
* handler
= d_handler
;
588 Options
* options
= this;
589 $
{setoption_handlers
}$
590 throw UnrecognizedOptionException(key
);
593 std::string
Options::getOption(const std::string
& key
) const
595 Trace("options") << "Options::getOption(" << key
<< ")" << std::endl
;
596 $
{getoption_handlers
}$
598 throw UnrecognizedOptionException(key
);
601 #undef USE_EARLY_TYPE_CHECKING_BY_DEFAULT
602 #undef DO_SEMANTIC_CHECKS_BY_DEFAULT