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 "base/cvc5config.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 "base/cvc5config.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 }
 234
 235 void Options::copyValues(const Options& options){
 236   if(this != &options) {
 237     *d_holder = *options.d_holder;
 238   }
 239 }
 240
 241 std::string Options::formatThreadOptionException(const std::string& option) {
 242   std::stringstream ss;
 243   ss << "can't understand option `" << option
 244      << "': expected something like --threadN=\"--option1 --option2\","
 245      << " where N is a nonnegative integer";
 246   return ss.str();
 247 }
 248
 249 void Options::setListener(OptionsListener* ol) { d_olisten = ol; }
 250
 251 // clang-format off
 252 ${custom_handlers}$
 253 // clang-format on
 254
 255 static const std::string mostCommonOptionsDescription =
 256     "\
 257 Most commonly-used cvc5 options:\n"
 258     // clang-format off
 259 ${help_common}$
 260     // clang-format on
 261     ;
 262
 263 // clang-format off
 264 static const std::string optionsDescription =
 265     mostCommonOptionsDescription + "\n\nAdditional cvc5 options:\n"
 266 ${help_others}$;
 267 // clang-format on
 268
 269 static const std::string optionsFootnote = "\n\
 270 [*] Each of these options has a --no-OPTIONNAME variant, which reverses the\n\
 271     sense of the option.\n\
 272 ";
 273
 274 static const std::string languageDescription =
 275     "\
 276 Languages currently supported as arguments to the -L / --lang option:\n\
 277   auto                           attempt to automatically determine language\n\
 278   cvc | presentation | pl        CVC presentation language\n\
 279   smt | smtlib | smt2 |\n\
 280   smt2.6 | smtlib2.6             SMT-LIB format 2.6 with support for the strings standard\n\
 281   tptp                           TPTP format (cnf, fof and tff)\n\
 282   sygus | sygus2                 SyGuS version 2.0\n\
 283 \n\
 284 Languages currently supported as arguments to the --output-lang option:\n\
 285   auto                           match output language to input language\n\
 286   cvc | presentation | pl        CVC presentation language\n\
 287   smt | smtlib | smt2 |\n\
 288   smt2.6 | smtlib2.6             SMT-LIB format 2.6 with support for the strings standard\n\
 289   tptp                           TPTP format\n\
 290   ast                            internal format (simple syntax trees)\n\
 291 ";
 292
 293 std::string Options::getDescription() const {
 294   return optionsDescription;
 295 }
 296
 297 void Options::printUsage(const std::string msg, std::ostream& out) {
 298   out << msg << optionsDescription << std::endl
 299       << optionsFootnote << std::endl << std::flush;
 300 }
 301
 302 void Options::printShortUsage(const std::string msg, std::ostream& out) {
 303   out << msg << mostCommonOptionsDescription << std::endl
 304       << optionsFootnote << std::endl
 305       << "For full usage, please use --help."
 306       << std::endl << std::endl << std::flush;
 307 }
 308
 309 void Options::printLanguageHelp(std::ostream& out) {
 310   out << languageDescription << std::flush;
 311 }
 312
 313 /**
 314  * This is a table of long options.  By policy, each short option
 315  * should have an equivalent long option (but the reverse isn't the
 316  * case), so this table should thus contain all command-line options.
 317  *
 318  * Each option in this array has four elements:
 319  *
 320  * 1. the long option string
 321  * 2. argument behavior for the option:
 322  *    no_argument - no argument permitted
 323  *    required_argument - an argument is expected
 324  *    optional_argument - an argument is permitted but not required
 325  * 3. this is a pointer to an int which is set to the 4th entry of the
 326  *    array if the option is present; or NULL, in which case
 327  *    getopt_long() returns the 4th entry
 328  * 4. the return value for getopt_long() when this long option (or the
 329  *    value to set the 3rd entry to; see #3)
 330  *
 331  * If you add something here, you should add it in src/main/usage.h
 332  * also, to document it.
 333  *
 334  * If you add something that has a short option equivalent, you should
 335  * add it to the getopt_long() call in parseOptions().
 336  */
 337 // clang-format off
 338 static struct option cmdlineOptions[] = {
 339   ${cmdline_options}$
 340   {nullptr, no_argument, nullptr, '\0'}};
 341 // clang-format on
 342
 343 namespace options {
 344
 345 /** Set a given Options* as "current" just for a particular scope. */
 346 class OptionsGuard {
 347   Options** d_field;
 348   Options* d_old;
 349 public:
 350   OptionsGuard(Options** field, Options* opts) :
 351     d_field(field),
 352     d_old(*field) {
 353     *field = opts;
 354   }
 355   ~OptionsGuard() {
 356     *d_field = d_old;
 357   }
 358 };/* class OptionsGuard */
 359
 360 }  // namespace options
 361
 362 /**
 363  * Parse argc/argv and put the result into a cvc5::Options.
 364  * The return value is what's left of the command line (that is, the
 365  * non-option arguments).
 366  *
 367  * Throws OptionException on failures.
 368  */
 369 std::vector<std::string> Options::parseOptions(Options* options,
 370                                                int argc,
 371                                                char* argv[])
 372 {
 373   Assert(options != NULL);
 374   Assert(argv != NULL);
 375
 376   options::OptionsGuard guard(&s_current, options);
 377
 378   const char *progName = argv[0];
 379
 380   // To debug options parsing, you may prefer to simply uncomment this
 381   // and recompile. Debug flags have not been parsed yet so these have
 382   // not been set.
 383   //DebugChannel.on("options");
 384
 385   Debug("options") << "Options::parseOptions == " << options << std::endl;
 386   Debug("options") << "argv == " << argv << std::endl;
 387
 388   // Find the base name of the program.
 389   const char *x = strrchr(progName, '/');
 390   if(x != NULL) {
 391     progName = x + 1;
 392   }
 393   options->d_holder->binary_name = std::string(progName);
 394
 395   std::vector<std::string> nonoptions;
 396   options->parseOptionsRecursive(argc, argv, &nonoptions);
 397   if(Debug.isOn("options")){
 398     for(std::vector<std::string>::const_iterator i = nonoptions.begin(),
 399           iend = nonoptions.end(); i != iend; ++i){
 400       Debug("options") << "nonoptions " << *i << std::endl;
 401     }
 402   }
 403
 404   return nonoptions;
 405 }
 406
 407 std::string suggestCommandLineOptions(const std::string& optionName)
 408 {
 409   DidYouMean didYouMean;
 410
 411   const char* opt;
 412   for(size_t i = 0; (opt = cmdlineOptions[i].name) != nullptr; ++i) {
 413     didYouMean.addWord(std::string("--") + cmdlineOptions[i].name);
 414   }
 415
 416   return didYouMean.getMatchAsString(optionName.substr(0, optionName.find('=')));
 417 }
 418
 419 void Options::parseOptionsRecursive(int argc,
 420                                     char* argv[],
 421                                     std::vector<std::string>* nonoptions)
 422 {
 423
 424   if(Debug.isOn("options")) {
 425     Debug("options") << "starting a new parseOptionsRecursive with "
 426                      << argc << " arguments" << std::endl;
 427     for( int i = 0; i < argc ; i++ ){
 428       Assert(argv[i] != NULL);
 429       Debug("options") << "  argv[" << i << "] = " << argv[i] << std::endl;
 430     }
 431   }
 432
 433   // Reset getopt(), in the case of multiple calls to parseOptions().
 434   // This can be = 1 in newer GNU getopt, but older (< 2007) require = 0.
 435   optind = 0;
 436 #if HAVE_DECL_OPTRESET
 437   optreset = 1; // on BSD getopt() (e.g. Mac OS), might need this
 438 #endif /* HAVE_DECL_OPTRESET */
 439
 440   // We must parse the binary name, which is manually ignored below. Setting
 441   // this to 1 leads to incorrect behavior on some platforms.
 442   int main_optind = 0;
 443   int old_optind;
 444
 445
 446   while(true) { // Repeat Forever
 447
 448     optopt = 0;
 449     std::string option, optionarg;
 450
 451     optind = main_optind;
 452     old_optind = main_optind;
 453
 454     // If we encounter an element that is not at zero and does not start
 455     // with a "-", this is a non-option. We consume this element as a
 456     // non-option.
 457     if (main_optind > 0 && main_optind < argc &&
 458         argv[main_optind][0] != '-') {
 459       Debug("options") << "enqueueing " << argv[main_optind]
 460                        << " as a non-option." << std::endl;
 461       nonoptions->push_back(argv[main_optind]);
 462       ++main_optind;
 463       continue;
 464     }
 465
 466
 467     Debug("options") << "[ before, main_optind == " << main_optind << " ]"
 468                      << std::endl;
 469     Debug("options") << "[ before, optind == " << optind << " ]" << std::endl;
 470     Debug("options") << "[ argc == " << argc << ", argv == " << argv << " ]"
 471                      << std::endl;
 472     // clang-format off
 473     int c = getopt_long(argc, argv,
 474                         "+:${options_short}$",
 475                         cmdlineOptions, NULL);
 476     // clang-format on
 477
 478     main_optind = optind;
 479
 480     Debug("options") << "[ got " << int(c) << " (" << char(c) << ") ]"
 481                      << "[ next option will be at pos: " << optind << " ]"
 482                      << std::endl;
 483
 484     // The initial getopt_long call should always determine that argv[0]
 485     // is not an option and returns -1. We always manually advance beyond
 486     // this element.
 487     if ( old_optind == 0  && c == -1 ) {
 488       Assert(main_optind > 0);
 489       continue;
 490     }
 491
 492     if ( c == -1 ) {
 493       if(Debug.isOn("options")) {
 494         Debug("options") << "done with option parsing" << std::endl;
 495         for(int index = optind; index < argc; ++index) {
 496           Debug("options") << "remaining " << argv[index] << std::endl;
 497         }
 498       }
 499       break;
 500     }
 501
 502     option = argv[old_optind == 0 ? 1 : old_optind];
 503     optionarg = (optarg == NULL) ? "" : optarg;
 504
 505     Debug("preemptGetopt") << "processing option " << c
 506                            << " (`" << char(c) << "'), " << option << std::endl;
 507
 508     // clang-format off
 509     switch(c)
 510     {
 511 ${options_handler}$
 512
 513       case ':' :
 514       // This can be a long or short option, and the way to get at the
 515       // name of it is different.
 516       throw OptionException(std::string("option `") + option
 517                             + "' missing its required argument");
 518
 519       case '?':
 520       default:
 521         throw OptionException(std::string("can't understand option `") + option
 522                               + "'" + suggestCommandLineOptions(option));
 523     }
 524   }
 525   // clang-format on
 526
 527   Debug("options") << "got " << nonoptions->size()
 528                    << " non-option arguments." << std::endl;
 529 }
 530
 531 // clang-format off
 532 std::vector<std::vector<std::string> > Options::getOptions() const
 533 {
 534   std::vector< std::vector<std::string> > opts;
 535
 536   ${options_getoptions}$
 537
 538   return opts;
 539 }
 540 // clang-format on
 541
 542 void Options::setOption(const std::string& key, const std::string& optionarg)
 543 {
 544   Trace("options") << "setOption(" << key << ", " << optionarg << ")"
 545                    << std::endl;
 546   // first update this object
 547   setOptionInternal(key, optionarg);
 548   // then, notify the provided listener
 549   if (d_olisten != nullptr)
 550   {
 551     d_olisten->notifySetOption(key);
 552   }
 553 }
 554
 555 // clang-format off
 556 void Options::setOptionInternal(const std::string& key,
 557                                 const std::string& optionarg)
 558 {
 559   options::OptionsHandler* handler = d_handler;
 560   ${setoption_handlers}$
 561   throw UnrecognizedOptionException(key);
 562 }
 563 // clang-format on
 564
 565 // clang-format off
 566 std::string Options::getOption(const std::string& key) const
 567 {
 568   Trace("options") << "Options::getOption(" << key << ")" << std::endl;
 569   ${getoption_handlers}$
 570
 571   throw UnrecognizedOptionException(key);
 572 }
 573 // clang-format on
 574
 575 }  // namespace cvc5
 576