src/options/options_template.cpp

   1 /******************************************************************************
   2  * Top contributors (to current version):
   3  *   Morgan Deters, Tim King, Andrew Reynolds
   4  *
   5  * This file is part of the cvc5 project.
   6  *
   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.
  11  * ****************************************************************************
  12  *
  13  * Contains code for handling command-line options.
  14  */
  15
  16 #if !defined(_BSD_SOURCE) && defined(__MINGW32__) && !defined(__MINGW64__)
  17 // force use of optreset; mingw32 croaks on argv-switching otherwise
  18 #include "cvc4autoconfig.h"
  19 #define _BSD_SOURCE
  20 #undef HAVE_DECL_OPTRESET
  21 #define HAVE_DECL_OPTRESET 1
  22 #define CVC5_IS_NOT_REALLY_BSD
  23 #endif /* !_BSD_SOURCE && __MINGW32__ && !__MINGW64__ */
  24
  25 #ifdef __MINGW64__
  26 extern int optreset;
  27 #endif /* __MINGW64__ */
  28
  29 #include <getopt.h>
  30
  31 // clean up
  32 #ifdef CVC5_IS_NOT_REALLY_BSD
  33 #  undef _BSD_SOURCE
  34 #endif /* CVC5_IS_NOT_REALLY_BSD */
  35
  36 #include <unistd.h>
  37 #include <string.h>
  38 #include <time.h>
  39
  40 #include <cstdio>
  41 #include <cstdlib>
  42 #include <cstring>
  43 #include <iomanip>
  44 #include <new>
  45 #include <string>
  46 #include <sstream>
  47 #include <limits>
  48
  49 #include "base/check.h"
  50 #include "base/exception.h"
  51 #include "base/output.h"
  52 #include "options/didyoumean.h"
  53 #include "options/language.h"
  54 #include "options/options_handler.h"
  55 #include "options/options_listener.h"
  56
  57 // clang-format off
  58 ${headers_module}$
  59
  60 #include "options/options_holder.h"
  61 #include "cvc4autoconfig.h"
  62 #include "options/base_handlers.h"
  63
  64 ${headers_handler}$
  65
  66 using namespace cvc5;
  67 using namespace cvc5::options;
  68 // clang-format on
  69
  70 namespace cvc5 {
  71
  72 thread_local Options* Options::s_current = NULL;
  73
  74 /**
  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.
  80  *
  81  * This implements default behavior when e.g. an option is
  82  * unsigned but the user specifies a negative argument; etc.
  83  */
  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<> */
  88
  89 /** Variant for integral C++ types */
  90 template <class T>
  91 struct OptionHandler<T, true, true> {
  92   static bool stringToInt(T& t, const std::string& str) {
  93     std::istringstream ss(str);
  94     ss >> t;
  95     char tmp;
  96     return !(ss.fail() || ss.get(tmp));
  97   }
  98
  99   static bool containsMinus(const std::string& str) {
 100     return str.find('-') != std::string::npos;
 101   }
 102
 103   static T handle(const std::string& option, const std::string& optionarg) {
 104     try {
 105       T i;
 106       bool success = stringToInt(i, optionarg);
 107
 108       if(!success){
 109         throw OptionException(option + ": failed to parse "+ optionarg +
 110                               " as an integer of the appropriate type.");
 111       }
 112
 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());
 130       }
 131
 132       return i;
 133
 134       // if(std::numeric_limits<T>::is_signed) {
 135       //   return T(i.getLong());
 136       // } else {
 137       //   return T(i.getUnsignedLong());
 138       // }
 139     } catch(std::invalid_argument&) {
 140       // user gave something other than an integer
 141       throw OptionException(option + " requires an integer argument");
 142     }
 143   }
 144 };/* struct OptionHandler<T, true, true> */
 145
 146 /** Variant for numeric but non-integral C++ types */
 147 template <class T>
 148 struct OptionHandler<T, true, false> {
 149   static T handle(std::string option, std::string optionarg) {
 150     std::stringstream in(optionarg);
 151     long double r;
 152     in >> r;
 153     if(! in.eof()) {
 154       // we didn't consume the whole string (junk at end)
 155       throw OptionException(option + " requires a numeric argument");
 156     }
 157
 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());
 173     }
 174
 175     return T(r);
 176   }
 177 };/* struct OptionHandler<T, true, false> */
 178
 179 /** Variant for non-numeric C++ types */
 180 template <class T>
 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
 188     // and warnings.
 189     return *(T*)0;
 190   }
 191 };/* struct OptionHandler<T, false, false> */
 192
 193 /** Handle an option of type T in the default way. */
 194 template <class T>
 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);
 197 }
 198
 199 /** Handle an option of type std::string in the default way. */
 200 template <>
 201 std::string handleOption<std::string>(std::string option, std::string optionarg) {
 202   return optionarg;
 203 }
 204
 205 /**
 206  * Run handler, and any user-given predicates, for option T.
 207  * If a user specifies a :handler or :predicates, it overrides this.
 208  */
 209 template <class T>
 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.
 214
 215   return handleOption<typename T::type>(option, optionarg);
 216 }
 217
 218 template <class T>
 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.
 223 }
 224
 225 Options::Options(OptionsListener* ol)
 226     : d_holder(new options::OptionsHolder()),
 227       d_handler(new options::OptionsHandler(this)),
 228       d_olisten(ol)
 229 {}
 230
 231 Options::~Options() {
 232   delete d_handler;
 233   delete d_holder;
 234 }
 235
 236 void Options::copyValues(const Options& options){
 237   if(this != &options) {
 238     delete d_holder;
 239     d_holder = new options::OptionsHolder(*options.d_holder);
 240   }
 241 }
 242
 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";
 248   return ss.str();
 249 }
 250
 251 void Options::setListener(OptionsListener* ol) { d_olisten = ol; }
 252
 253 // clang-format off
 254 ${custom_handlers}$
 255 // clang-format on
 256
 257 #if defined(CVC5_MUZZLED) || defined(CVC5_COMPETITION_MODE)
 258 #  define DO_SEMANTIC_CHECKS_BY_DEFAULT false
 259 #else /* CVC5_MUZZLED || CVC5_COMPETITION_MODE */
 260 #  define DO_SEMANTIC_CHECKS_BY_DEFAULT true
 261 #endif /* CVC5_MUZZLED || CVC5_COMPETITION_MODE */
 262
 263 // clang-format off
 264 options::OptionsHolder::OptionsHolder() :
 265   ${module_defaults}$
 266 {
 267 }
 268 // clang-format on
 269
 270 static const std::string mostCommonOptionsDescription =
 271     "\
 272 Most commonly-used cvc5 options:\n"
 273     // clang-format off
 274 ${help_common}$
 275     // clang-format on
 276     ;
 277
 278 // clang-format off
 279 static const std::string optionsDescription =
 280     mostCommonOptionsDescription + "\n\nAdditional cvc5 options:\n"
 281 ${help_others}$;
 282 // clang-format on
 283
 284 static const std::string optionsFootnote = "\n\
 285 [*] Each of these options has a --no-OPTIONNAME variant, which reverses the\n\
 286     sense of the option.\n\
 287 ";
 288
 289 static const std::string languageDescription =
 290     "\
 291 Languages currently supported as arguments to the -L / --lang option:\n\
 292   auto                           attempt to automatically determine language\n\
 293   cvc | presentation | pl        CVC presentation language\n\
 294   smt | smtlib | smt2 |\n\
 295   smt2.6 | smtlib2.6             SMT-LIB format 2.6 with support for the strings standard\n\
 296   tptp                           TPTP format (cnf, fof and tff)\n\
 297   sygus | sygus2                 SyGuS version 2.0\n\
 298 \n\
 299 Languages currently supported as arguments to the --output-lang option:\n\
 300   auto                           match output language to input language\n\
 301   cvc | presentation | pl        CVC presentation language\n\
 302   smt | smtlib | smt2 |\n\
 303   smt2.6 | smtlib2.6             SMT-LIB format 2.6 with support for the strings standard\n\
 304   tptp                           TPTP format\n\
 305   ast                            internal format (simple syntax trees)\n\
 306 ";
 307
 308 std::string Options::getDescription() const {
 309   return optionsDescription;
 310 }
 311
 312 void Options::printUsage(const std::string msg, std::ostream& out) {
 313   out << msg << optionsDescription << std::endl
 314       << optionsFootnote << std::endl << std::flush;
 315 }
 316
 317 void Options::printShortUsage(const std::string msg, std::ostream& out) {
 318   out << msg << mostCommonOptionsDescription << std::endl
 319       << optionsFootnote << std::endl
 320       << "For full usage, please use --help."
 321       << std::endl << std::endl << std::flush;
 322 }
 323
 324 void Options::printLanguageHelp(std::ostream& out) {
 325   out << languageDescription << std::flush;
 326 }
 327
 328 /**
 329  * This is a table of long options.  By policy, each short option
 330  * should have an equivalent long option (but the reverse isn't the
 331  * case), so this table should thus contain all command-line options.
 332  *
 333  * Each option in this array has four elements:
 334  *
 335  * 1. the long option string
 336  * 2. argument behavior for the option:
 337  *    no_argument - no argument permitted
 338  *    required_argument - an argument is expected
 339  *    optional_argument - an argument is permitted but not required
 340  * 3. this is a pointer to an int which is set to the 4th entry of the
 341  *    array if the option is present; or NULL, in which case
 342  *    getopt_long() returns the 4th entry
 343  * 4. the return value for getopt_long() when this long option (or the
 344  *    value to set the 3rd entry to; see #3)
 345  *
 346  * If you add something here, you should add it in src/main/usage.h
 347  * also, to document it.
 348  *
 349  * If you add something that has a short option equivalent, you should
 350  * add it to the getopt_long() call in parseOptions().
 351  */
 352 // clang-format off
 353 static struct option cmdlineOptions[] = {
 354   ${cmdline_options}$
 355   {nullptr, no_argument, nullptr, '\0'}};
 356 // clang-format on
 357
 358 namespace options {
 359
 360 /** Set a given Options* as "current" just for a particular scope. */
 361 class OptionsGuard {
 362   Options** d_field;
 363   Options* d_old;
 364 public:
 365   OptionsGuard(Options** field, Options* opts) :
 366     d_field(field),
 367     d_old(*field) {
 368     *field = opts;
 369   }
 370   ~OptionsGuard() {
 371     *d_field = d_old;
 372   }
 373 };/* class OptionsGuard */
 374
 375 }  // namespace options
 376
 377 /**
 378  * Parse argc/argv and put the result into a cvc5::Options.
 379  * The return value is what's left of the command line (that is, the
 380  * non-option arguments).
 381  *
 382  * Throws OptionException on failures.
 383  */
 384 std::vector<std::string> Options::parseOptions(Options* options,
 385                                                int argc,
 386                                                char* argv[])
 387 {
 388   Assert(options != NULL);
 389   Assert(argv != NULL);
 390
 391   options::OptionsGuard guard(&s_current, options);
 392
 393   const char *progName = argv[0];
 394
 395   // To debug options parsing, you may prefer to simply uncomment this
 396   // and recompile. Debug flags have not been parsed yet so these have
 397   // not been set.
 398   //DebugChannel.on("options");
 399
 400   Debug("options") << "Options::parseOptions == " << options << std::endl;
 401   Debug("options") << "argv == " << argv << std::endl;
 402
 403   // Find the base name of the program.
 404   const char *x = strrchr(progName, '/');
 405   if(x != NULL) {
 406     progName = x + 1;
 407   }
 408   options->d_holder->binary_name = std::string(progName);
 409
 410   std::vector<std::string> nonoptions;
 411   parseOptionsRecursive(options, argc, argv, &nonoptions);
 412   if(Debug.isOn("options")){
 413     for(std::vector<std::string>::const_iterator i = nonoptions.begin(),
 414           iend = nonoptions.end(); i != iend; ++i){
 415       Debug("options") << "nonoptions " << *i << std::endl;
 416     }
 417   }
 418
 419   return nonoptions;
 420 }
 421
 422 void Options::parseOptionsRecursive(Options* options,
 423                                     int argc,
 424                                     char* argv[],
 425                                     std::vector<std::string>* nonoptions)
 426 {
 427
 428   if(Debug.isOn("options")) {
 429     Debug("options") << "starting a new parseOptionsRecursive with "
 430                      << argc << " arguments" << std::endl;
 431     for( int i = 0; i < argc ; i++ ){
 432       Assert(argv[i] != NULL);
 433       Debug("options") << "  argv[" << i << "] = " << argv[i] << std::endl;
 434     }
 435   }
 436
 437   // Having this synonym simplifies the generation code in mkoptions.
 438   options::OptionsHandler* handler = options->d_handler;
 439
 440   // Reset getopt(), in the case of multiple calls to parseOptions().
 441   // This can be = 1 in newer GNU getopt, but older (< 2007) require = 0.
 442   optind = 0;
 443 #if HAVE_DECL_OPTRESET
 444   optreset = 1; // on BSD getopt() (e.g. Mac OS), might need this
 445 #endif /* HAVE_DECL_OPTRESET */
 446
 447   // We must parse the binary name, which is manually ignored below. Setting
 448   // this to 1 leads to incorrect behavior on some platforms.
 449   int main_optind = 0;
 450   int old_optind;
 451
 452
 453   while(true) { // Repeat Forever
 454
 455     optopt = 0;
 456     std::string option, optionarg;
 457
 458     optind = main_optind;
 459     old_optind = main_optind;
 460
 461     // If we encounter an element that is not at zero and does not start
 462     // with a "-", this is a non-option. We consume this element as a
 463     // non-option.
 464     if (main_optind > 0 && main_optind < argc &&
 465         argv[main_optind][0] != '-') {
 466       Debug("options") << "enqueueing " << argv[main_optind]
 467                        << " as a non-option." << std::endl;
 468       nonoptions->push_back(argv[main_optind]);
 469       ++main_optind;
 470       continue;
 471     }
 472
 473
 474     Debug("options") << "[ before, main_optind == " << main_optind << " ]"
 475                      << std::endl;
 476     Debug("options") << "[ before, optind == " << optind << " ]" << std::endl;
 477     Debug("options") << "[ argc == " << argc << ", argv == " << argv << " ]"
 478                      << std::endl;
 479     // clang-format off
 480     int c = getopt_long(argc, argv,
 481                         "+:${options_short}$",
 482                         cmdlineOptions, NULL);
 483     // clang-format on
 484
 485     main_optind = optind;
 486
 487     Debug("options") << "[ got " << int(c) << " (" << char(c) << ") ]"
 488                      << "[ next option will be at pos: " << optind << " ]"
 489                      << std::endl;
 490
 491     // The initial getopt_long call should always determine that argv[0]
 492     // is not an option and returns -1. We always manually advance beyond
 493     // this element.
 494     if ( old_optind == 0  && c == -1 ) {
 495       Assert(main_optind > 0);
 496       continue;
 497     }
 498
 499     if ( c == -1 ) {
 500       if(Debug.isOn("options")) {
 501         Debug("options") << "done with option parsing" << std::endl;
 502         for(int index = optind; index < argc; ++index) {
 503           Debug("options") << "remaining " << argv[index] << std::endl;
 504         }
 505       }
 506       break;
 507     }
 508
 509     option = argv[old_optind == 0 ? 1 : old_optind];
 510     optionarg = (optarg == NULL) ? "" : optarg;
 511
 512     Debug("preemptGetopt") << "processing option " << c
 513                            << " (`" << char(c) << "'), " << option << std::endl;
 514
 515     // clang-format off
 516     switch(c)
 517     {
 518 ${options_handler}$
 519
 520       case ':' :
 521       // This can be a long or short option, and the way to get at the
 522       // name of it is different.
 523       throw OptionException(std::string("option `") + option
 524                             + "' missing its required argument");
 525
 526       case '?':
 527       default:
 528         throw OptionException(std::string("can't understand option `") + option
 529                               + "'" + suggestCommandLineOptions(option));
 530     }
 531   }
 532   // clang-format on
 533
 534   Debug("options") << "got " << nonoptions->size()
 535                    << " non-option arguments." << std::endl;
 536 }
 537
 538 std::string Options::suggestCommandLineOptions(const std::string& optionName)
 539 {
 540   DidYouMean didYouMean;
 541
 542   const char* opt;
 543   for(size_t i = 0; (opt = cmdlineOptions[i].name) != NULL; ++i) {
 544     didYouMean.addWord(std::string("--") + cmdlineOptions[i].name);
 545   }
 546
 547   return didYouMean.getMatchAsString(optionName.substr(0, optionName.find('=')));
 548 }
 549
 550 // clang-format off
 551 static const char* smtOptions[] = {
 552   ${options_smt}$
 553   nullptr};
 554 // clang-format on
 555
 556 std::vector<std::string> Options::suggestSmtOptions(
 557     const std::string& optionName)
 558 {
 559   std::vector<std::string> suggestions;
 560
 561   const char* opt;
 562   for(size_t i = 0; (opt = smtOptions[i]) != NULL; ++i) {
 563     if(std::strstr(opt, optionName.c_str()) != NULL) {
 564       suggestions.push_back(opt);
 565     }
 566   }
 567
 568   return suggestions;
 569 }
 570
 571 // clang-format off
 572 std::vector<std::vector<std::string> > Options::getOptions() const
 573 {
 574   std::vector< std::vector<std::string> > opts;
 575
 576   ${options_getoptions}$
 577
 578   return opts;
 579 }
 580 // clang-format on
 581
 582 void Options::setOption(const std::string& key, const std::string& optionarg)
 583 {
 584   Trace("options") << "setOption(" << key << ", " << optionarg << ")"
 585                    << std::endl;
 586   // first update this object
 587   setOptionInternal(key, optionarg);
 588   // then, notify the provided listener
 589   if (d_olisten != nullptr)
 590   {
 591     d_olisten->notifySetOption(key);
 592   }
 593 }
 594
 595 // clang-format off
 596 void Options::setOptionInternal(const std::string& key,
 597                                 const std::string& optionarg)
 598 {
 599   options::OptionsHandler* handler = d_handler;
 600   Options* options = this;
 601   ${setoption_handlers}$
 602   throw UnrecognizedOptionException(key);
 603 }
 604 // clang-format on
 605
 606 // clang-format off
 607 std::string Options::getOption(const std::string& key) const
 608 {
 609   Trace("options") << "Options::getOption(" << key << ")" << std::endl;
 610   ${getoption_handlers}$
 611
 612   throw UnrecognizedOptionException(key);
 613 }
 614 // clang-format on
 615
 616 #undef USE_EARLY_TYPE_CHECKING_BY_DEFAULT
 617 #undef DO_SEMANTIC_CHECKS_BY_DEFAULT
 618
 619 }  // namespace cvc5
 620 // clang-format on