src/options/options_template.cpp

   1 /*********************                                                        */
   2 /*! \file options_template.cpp
   3  ** \verbatim
   4  ** Top contributors (to current version):
   5  **   Tim King, Morgan Deters, Mathias Preiner
   6  ** This file is part of the CVC4 project.
   7  ** Copyright (c) 2009-2019 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
  11  **
  12  ** \brief Contains code for handling command-line options.
  13  **
  14  ** Contains code for handling command-line options
  15  **/
  16
  17 #if !defined(_BSD_SOURCE) && defined(__MINGW32__) && !defined(__MINGW64__)
  18 // force use of optreset; mingw32 croaks on argv-switching otherwise
  19 #  include "cvc4autoconfig.h"
  20 #  define _BSD_SOURCE
  21 #  undef HAVE_DECL_OPTRESET
  22 #  define HAVE_DECL_OPTRESET 1
  23 #  define CVC4_IS_NOT_REALLY_BSD
  24 #endif /* !_BSD_SOURCE && __MINGW32__ && !__MINGW64__ */
  25
  26 #ifdef __MINGW64__
  27 extern int optreset;
  28 #endif /* __MINGW64__ */
  29
  30 #include <getopt.h>
  31
  32 // clean up
  33 #ifdef CVC4_IS_NOT_REALLY_BSD
  34 #  undef _BSD_SOURCE
  35 #endif /* CVC4_IS_NOT_REALLY_BSD */
  36
  37 #include <unistd.h>
  38 #include <string.h>
  39 #include <stdint.h>
  40 #include <time.h>
  41
  42 #include <cstdio>
  43 #include <cstdlib>
  44 #include <cstring>
  45 #include <iomanip>
  46 #include <new>
  47 #include <string>
  48 #include <sstream>
  49 #include <limits>
  50
  51 #include "base/check.h"
  52 #include "base/exception.h"
  53 #include "base/output.h"
  54 #include "options/argument_extender.h"
  55 #include "options/argument_extender_implementation.h"
  56 #include "options/didyoumean.h"
  57 #include "options/language.h"
  58 #include "options/options_handler.h"
  59
  60 ${headers_module}$
  61
  62
  63 #include "options/options_holder.h"
  64 #include "cvc4autoconfig.h"
  65 #include "options/base_handlers.h"
  66
  67 ${headers_handler}$
  68
  69
  70 using namespace CVC4;
  71 using namespace CVC4::options;
  72
  73 namespace CVC4 {
  74
  75 thread_local Options* Options::s_current = NULL;
  76
  77
  78
  79 /**
  80  * This is a default handler for options of built-in C++ type.  This
  81  * template is really just a helper for the handleOption() template,
  82  * below.  Variants of this template handle numeric and non-numeric,
  83  * integral and non-integral, signed and unsigned C++ types.
  84  * handleOption() makes sure to instantiate the right one.
  85  *
  86  * This implements default behavior when e.g. an option is
  87  * unsigned but the user specifies a negative argument; etc.
  88  */
  89 template <class T, bool is_numeric, bool is_integer>
  90 struct OptionHandler {
  91   static T handle(std::string option, std::string optionarg);
  92 };/* struct OptionHandler<> */
  93
  94 /** Variant for integral C++ types */
  95 template <class T>
  96 struct OptionHandler<T, true, true> {
  97   static bool stringToInt(T& t, const std::string& str) {
  98     std::istringstream ss(str);
  99     ss >> t;
 100     char tmp;
 101     return !(ss.fail() || ss.get(tmp));
 102   }
 103
 104   static bool containsMinus(const std::string& str) {
 105     return str.find('-') != std::string::npos;
 106   }
 107
 108   static T handle(const std::string& option, const std::string& optionarg) {
 109     try {
 110       T i;
 111       bool success = stringToInt(i, optionarg);
 112
 113       if(!success){
 114         throw OptionException(option + ": failed to parse "+ optionarg +
 115                               " as an integer of the appropriate type.");
 116       }
 117
 118       // Depending in the platform unsigned numbers with '-' signs may parse.
 119       // Reject these by looking for any minus if it is not signed.
 120       if( (! std::numeric_limits<T>::is_signed) && containsMinus(optionarg) ) {
 121         // unsigned type but user gave negative argument
 122         throw OptionException(option + " requires a nonnegative argument");
 123       } else if(i < std::numeric_limits<T>::min()) {
 124         // negative overflow for type
 125         std::stringstream ss;
 126         ss << option << " requires an argument >= "
 127            << std::numeric_limits<T>::min();
 128         throw OptionException(ss.str());
 129       } else if(i > std::numeric_limits<T>::max()) {
 130         // positive overflow for type
 131         std::stringstream ss;
 132         ss << option << " requires an argument <= "
 133            << std::numeric_limits<T>::max();
 134         throw OptionException(ss.str());
 135       }
 136
 137       return i;
 138
 139       // if(std::numeric_limits<T>::is_signed) {
 140       //   return T(i.getLong());
 141       // } else {
 142       //   return T(i.getUnsignedLong());
 143       // }
 144     } catch(std::invalid_argument&) {
 145       // user gave something other than an integer
 146       throw OptionException(option + " requires an integer argument");
 147     }
 148   }
 149 };/* struct OptionHandler<T, true, true> */
 150
 151 /** Variant for numeric but non-integral C++ types */
 152 template <class T>
 153 struct OptionHandler<T, true, false> {
 154   static T handle(std::string option, std::string optionarg) {
 155     std::stringstream in(optionarg);
 156     long double r;
 157     in >> r;
 158     if(! in.eof()) {
 159       // we didn't consume the whole string (junk at end)
 160       throw OptionException(option + " requires a numeric argument");
 161     }
 162
 163     if(! std::numeric_limits<T>::is_signed && r < 0.0) {
 164       // unsigned type but user gave negative value
 165       throw OptionException(option + " requires a nonnegative argument");
 166     } else if(r < -std::numeric_limits<T>::max()) {
 167       // negative overflow for type
 168       std::stringstream ss;
 169       ss << option << " requires an argument >= "
 170          << -std::numeric_limits<T>::max();
 171       throw OptionException(ss.str());
 172     } else if(r > std::numeric_limits<T>::max()) {
 173       // positive overflow for type
 174       std::stringstream ss;
 175       ss << option << " requires an argument <= "
 176          << std::numeric_limits<T>::max();
 177       throw OptionException(ss.str());
 178     }
 179
 180     return T(r);
 181   }
 182 };/* struct OptionHandler<T, true, false> */
 183
 184 /** Variant for non-numeric C++ types */
 185 template <class T>
 186 struct OptionHandler<T, false, false> {
 187   static T handle(std::string option, std::string optionarg) {
 188     T::unsupported_handleOption_call___please_write_me;
 189     // The above line causes a compiler error if this version of the template
 190     // is ever instantiated (meaning that a specialization is missing).  So
 191     // don't worry about the segfault in the next line, the "return" is only
 192     // there to keep the compiler from giving additional, distracting errors
 193     // and warnings.
 194     return *(T*)0;
 195   }
 196 };/* struct OptionHandler<T, false, false> */
 197
 198 /** Handle an option of type T in the default way. */
 199 template <class T>
 200 T handleOption(std::string option, std::string optionarg) {
 201   return OptionHandler<T, std::numeric_limits<T>::is_specialized, std::numeric_limits<T>::is_integer>::handle(option, optionarg);
 202 }
 203
 204 /** Handle an option of type std::string in the default way. */
 205 template <>
 206 std::string handleOption<std::string>(std::string option, std::string optionarg) {
 207   return optionarg;
 208 }
 209
 210 /**
 211  * Run handler, and any user-given predicates, for option T.
 212  * If a user specifies a :handler or :predicates, it overrides this.
 213  */
 214 template <class T>
 215 typename T::type runHandlerAndPredicates(T, std::string option, std::string optionarg, options::OptionsHandler* handler) {
 216   // By default, parse the option argument in a way appropriate for its type.
 217   // E.g., for "unsigned int" options, ensure that the provided argument is
 218   // a nonnegative integer that fits in the unsigned int type.
 219
 220   return handleOption<typename T::type>(option, optionarg);
 221 }
 222
 223 template <class T>
 224 void runBoolPredicates(T, std::string option, bool b, options::OptionsHandler* handler) {
 225   // By default, nothing to do for bool.  Users add things with
 226   // :predicate in options files to provide custom checking routines
 227   // that can throw exceptions.
 228 }
 229
 230
 231 Options::Options()
 232     : d_holder(new options::OptionsHolder())
 233     , d_handler(new options::OptionsHandler(this))
 234     , d_beforeSearchListeners()
 235     , d_tlimitListeners()
 236     , d_tlimitPerListeners()
 237     , d_rlimitListeners()
 238     , d_rlimitPerListeners()
 239 {}
 240
 241 Options::~Options() {
 242   delete d_handler;
 243   delete d_holder;
 244 }
 245
 246 void Options::copyValues(const Options& options){
 247   if(this != &options) {
 248     delete d_holder;
 249     d_holder = new options::OptionsHolder(*options.d_holder);
 250   }
 251 }
 252
 253 std::string Options::formatThreadOptionException(const std::string& option) {
 254   std::stringstream ss;
 255   ss << "can't understand option `" << option
 256      << "': expected something like --threadN=\"--option1 --option2\","
 257      << " where N is a nonnegative integer";
 258   return ss.str();
 259 }
 260
 261 ListenerCollection::Registration* Options::registerAndNotify(
 262     ListenerCollection& collection, Listener* listener, bool notify)
 263 {
 264   ListenerCollection::Registration* registration =
 265       collection.registerListener(listener);
 266   if(notify) {
 267     try
 268     {
 269       listener->notify();
 270     }
 271     catch (OptionException& e)
 272     {
 273       // It can happen that listener->notify() throws an OptionException. In
 274       // that case, we have to make sure that we delete the registration of our
 275       // listener before rethrowing the exception. Otherwise the
 276       // ListenerCollection deconstructor will complain that not all
 277       // registrations have been removed before invoking the deconstructor.
 278       delete registration;
 279       throw OptionException(e.getRawMessage());
 280     }
 281   }
 282   return registration;
 283 }
 284
 285 ListenerCollection::Registration* Options::registerBeforeSearchListener(
 286    Listener* listener)
 287 {
 288   return d_beforeSearchListeners.registerListener(listener);
 289 }
 290
 291 ListenerCollection::Registration* Options::registerTlimitListener(
 292    Listener* listener, bool notifyIfSet)
 293 {
 294   bool notify = notifyIfSet &&
 295       wasSetByUser(options::cumulativeMillisecondLimit);
 296   return registerAndNotify(d_tlimitListeners, listener, notify);
 297 }
 298
 299 ListenerCollection::Registration* Options::registerTlimitPerListener(
 300    Listener* listener, bool notifyIfSet)
 301 {
 302   bool notify = notifyIfSet && wasSetByUser(options::perCallMillisecondLimit);
 303   return registerAndNotify(d_tlimitPerListeners, listener, notify);
 304 }
 305
 306 ListenerCollection::Registration* Options::registerRlimitListener(
 307    Listener* listener, bool notifyIfSet)
 308 {
 309   bool notify = notifyIfSet && wasSetByUser(options::cumulativeResourceLimit);
 310   return registerAndNotify(d_rlimitListeners, listener, notify);
 311 }
 312
 313 ListenerCollection::Registration* Options::registerRlimitPerListener(
 314    Listener* listener, bool notifyIfSet)
 315 {
 316   bool notify = notifyIfSet && wasSetByUser(options::perCallResourceLimit);
 317   return registerAndNotify(d_rlimitPerListeners, listener, notify);
 318 }
 319
 320 ListenerCollection::Registration* Options::registerSetDefaultExprDepthListener(
 321     Listener* listener, bool notifyIfSet)
 322 {
 323   bool notify = notifyIfSet && wasSetByUser(options::defaultExprDepth);
 324   return registerAndNotify(d_setDefaultExprDepthListeners, listener, notify);
 325 }
 326
 327 ListenerCollection::Registration* Options::registerSetDefaultExprDagListener(
 328     Listener* listener, bool notifyIfSet)
 329 {
 330   bool notify = notifyIfSet && wasSetByUser(options::defaultDagThresh);
 331   return registerAndNotify(d_setDefaultDagThreshListeners, listener, notify);
 332 }
 333
 334 ListenerCollection::Registration* Options::registerSetPrintExprTypesListener(
 335     Listener* listener, bool notifyIfSet)
 336 {
 337   bool notify = notifyIfSet && wasSetByUser(options::printExprTypes);
 338   return registerAndNotify(d_setPrintExprTypesListeners, listener, notify);
 339 }
 340
 341 ListenerCollection::Registration* Options::registerSetDumpModeListener(
 342     Listener* listener, bool notifyIfSet)
 343 {
 344   bool notify = notifyIfSet && wasSetByUser(options::dumpModeString);
 345   return registerAndNotify(d_setDumpModeListeners, listener, notify);
 346 }
 347
 348 ListenerCollection::Registration* Options::registerSetPrintSuccessListener(
 349     Listener* listener, bool notifyIfSet)
 350 {
 351   bool notify = notifyIfSet && wasSetByUser(options::printSuccess);
 352   return registerAndNotify(d_setPrintSuccessListeners, listener, notify);
 353 }
 354
 355 ListenerCollection::Registration* Options::registerDumpToFileNameListener(
 356     Listener* listener, bool notifyIfSet)
 357 {
 358   bool notify = notifyIfSet && wasSetByUser(options::dumpToFileName);
 359   return registerAndNotify(d_dumpToFileListeners, listener, notify);
 360 }
 361
 362 ListenerCollection::Registration*
 363 Options::registerSetRegularOutputChannelListener(
 364     Listener* listener, bool notifyIfSet)
 365 {
 366   bool notify = notifyIfSet && wasSetByUser(options::regularChannelName);
 367   return registerAndNotify(d_setRegularChannelListeners, listener, notify);
 368 }
 369
 370 ListenerCollection::Registration*
 371 Options::registerSetDiagnosticOutputChannelListener(
 372     Listener* listener, bool notifyIfSet)
 373 {
 374   bool notify = notifyIfSet && wasSetByUser(options::diagnosticChannelName);
 375   return registerAndNotify(d_setDiagnosticChannelListeners, listener, notify);
 376 }
 377
 378 ${custom_handlers}$
 379
 380
 381 #ifdef CVC4_DEBUG
 382 #  define USE_EARLY_TYPE_CHECKING_BY_DEFAULT true
 383 #else /* CVC4_DEBUG */
 384 #  define USE_EARLY_TYPE_CHECKING_BY_DEFAULT false
 385 #endif /* CVC4_DEBUG */
 386
 387 #if defined(CVC4_MUZZLED) || defined(CVC4_COMPETITION_MODE)
 388 #  define DO_SEMANTIC_CHECKS_BY_DEFAULT false
 389 #else /* CVC4_MUZZLED || CVC4_COMPETITION_MODE */
 390 #  define DO_SEMANTIC_CHECKS_BY_DEFAULT true
 391 #endif /* CVC4_MUZZLED || CVC4_COMPETITION_MODE */
 392
 393 options::OptionsHolder::OptionsHolder() :
 394   ${module_defaults}$
 395 {
 396 }
 397
 398
 399 static const std::string mostCommonOptionsDescription = "\
 400 Most commonly-used CVC4 options:\n"
 401 ${help_common}$;
 402
 403
 404 static const std::string optionsDescription = mostCommonOptionsDescription + "\n\
 405 \n\
 406 Additional CVC4 options:\n"
 407 ${help_others}$;
 408
 409
 410 static const std::string optionsFootnote = "\n\
 411 [*] Each of these options has a --no-OPTIONNAME variant, which reverses the\n\
 412     sense of the option.\n\
 413 ";
 414
 415 static const std::string languageDescription =
 416     "\
 417 Languages currently supported as arguments to the -L / --lang option:\n\
 418   auto                           attempt to automatically determine language\n\
 419   cvc4 | presentation | pl       CVC4 presentation language\n\
 420   smt | smtlib | smt2 |\n\
 421   smt2.0 | smtlib2 | smtlib2.0   SMT-LIB format 2.0\n\
 422   smt2.5 | smtlib2.5             SMT-LIB format 2.5\n\
 423   smt2.6 | smtlib2.6             SMT-LIB format 2.6\n\
 424   smt2.6.1 | smtlib2.6.1         SMT-LIB format 2.6 with support for the strings standard\n\
 425   tptp                           TPTP format (cnf, fof and tff)\n\
 426   sygus | sygus2                 SyGuS version 1.0 and 2.0 formats\n\
 427 \n\
 428 Languages currently supported as arguments to the --output-lang option:\n\
 429   auto                           match output language to input language\n\
 430   cvc4 | presentation | pl       CVC4 presentation language\n\
 431   cvc3                           CVC3 presentation language\n\
 432   smt | smtlib | smt2 |\n\
 433   smt2.0 | smtlib2.0 | smtlib2   SMT-LIB format 2.0\n\
 434   smt2.5 | smtlib2.5             SMT-LIB format 2.5\n\
 435   smt2.6 | smtlib2.6             SMT-LIB format 2.6\n\
 436   smt2.6.1 | smtlib2.6.1         SMT-LIB format 2.6 with support for the strings standard\n\
 437   tptp                           TPTP format\n\
 438   z3str                          SMT-LIB 2.0 with Z3-str string constraints\n\
 439   ast                            internal format (simple syntax trees)\n\
 440 ";
 441
 442 std::string Options::getDescription() const {
 443   return optionsDescription;
 444 }
 445
 446 void Options::printUsage(const std::string msg, std::ostream& out) {
 447   out << msg << optionsDescription << std::endl
 448       << optionsFootnote << std::endl << std::flush;
 449 }
 450
 451 void Options::printShortUsage(const std::string msg, std::ostream& out) {
 452   out << msg << mostCommonOptionsDescription << std::endl
 453       << optionsFootnote << std::endl
 454       << "For full usage, please use --help."
 455       << std::endl << std::endl << std::flush;
 456 }
 457
 458 void Options::printLanguageHelp(std::ostream& out) {
 459   out << languageDescription << std::flush;
 460 }
 461
 462 /**
 463  * This is a table of long options.  By policy, each short option
 464  * should have an equivalent long option (but the reverse isn't the
 465  * case), so this table should thus contain all command-line options.
 466  *
 467  * Each option in this array has four elements:
 468  *
 469  * 1. the long option string
 470  * 2. argument behavior for the option:
 471  *    no_argument - no argument permitted
 472  *    required_argument - an argument is expected
 473  *    optional_argument - an argument is permitted but not required
 474  * 3. this is a pointer to an int which is set to the 4th entry of the
 475  *    array if the option is present; or NULL, in which case
 476  *    getopt_long() returns the 4th entry
 477  * 4. the return value for getopt_long() when this long option (or the
 478  *    value to set the 3rd entry to; see #3)
 479  *
 480  * If you add something here, you should add it in src/main/usage.h
 481  * also, to document it.
 482  *
 483  * If you add something that has a short option equivalent, you should
 484  * add it to the getopt_long() call in parseOptions().
 485  */
 486 static struct option cmdlineOptions[] = {
 487   ${cmdline_options}$
 488   { NULL, no_argument, NULL, '\0' }
 489 };/* cmdlineOptions */
 490
 491
 492 // static void preemptGetopt(int& argc, char**& argv, const char* opt) {
 493
 494 //   Debug("preemptGetopt") << "preempting getopt() with " << opt << std::endl;
 495
 496 //   AlwaysAssert(opt != NULL && *opt != '\0');
 497 //   AlwaysAssert(strlen(opt) <= maxoptlen);
 498
 499 //   ++argc;
 500 //   unsigned i = 1;
 501 //   while(argv[i] != NULL && argv[i][0] != '\0') {
 502 //     ++i;
 503 //   }
 504
 505 //   if(argv[i] == NULL) {
 506 //     argv = (char**) realloc(argv, (i + 6) * sizeof(char*));
 507 //     for(unsigned j = i; j < i + 5; ++j) {
 508 //       argv[j] = (char*) malloc(sizeof(char) * maxoptlen);
 509 //       argv[j][0] = '\0';
 510 //     }
 511 //     argv[i + 5] = NULL;
 512 //   }
 513
 514 //   strncpy(argv[i], opt, maxoptlen - 1);
 515 //   argv[i][maxoptlen - 1] = '\0'; // ensure NUL-termination even on overflow
 516 // }
 517
 518 namespace options {
 519
 520 /** Set a given Options* as "current" just for a particular scope. */
 521 class OptionsGuard {
 522   Options** d_field;
 523   Options* d_old;
 524 public:
 525   OptionsGuard(Options** field, Options* opts) :
 526     d_field(field),
 527     d_old(*field) {
 528     *field = opts;
 529   }
 530   ~OptionsGuard() {
 531     *d_field = d_old;
 532   }
 533 };/* class OptionsGuard */
 534
 535 }/* CVC4::options namespace */
 536
 537 /**
 538  * Parse argc/argv and put the result into a CVC4::Options.
 539  * The return value is what's left of the command line (that is, the
 540  * non-option arguments).
 541  *
 542  * Throws OptionException on failures.
 543  */
 544 std::vector<std::string> Options::parseOptions(Options* options,
 545                                                int argc,
 546                                                char* argv[])
 547 {
 548   Assert(options != NULL);
 549   Assert(argv != NULL);
 550
 551   options::OptionsGuard guard(&s_current, options);
 552
 553   const char *progName = argv[0];
 554
 555   // To debug options parsing, you may prefer to simply uncomment this
 556   // and recompile. Debug flags have not been parsed yet so these have
 557   // not been set.
 558   //DebugChannel.on("options");
 559
 560   Debug("options") << "Options::parseOptions == " << options << std::endl;
 561   Debug("options") << "argv == " << argv << std::endl;
 562
 563   // Find the base name of the program.
 564   const char *x = strrchr(progName, '/');
 565   if(x != NULL) {
 566     progName = x + 1;
 567   }
 568   options->d_holder->binary_name = std::string(progName);
 569
 570   ArgumentExtender* argumentExtender = new ArgumentExtenderImplementation();
 571   for(int position = 1; position < argc; position++) {
 572     argumentExtender->pushBackArgument(argv[position]);
 573   }
 574
 575   std::vector<std::string> nonoptions;
 576   parseOptionsRecursive(options, argumentExtender, &nonoptions);
 577   if(Debug.isOn("options")){
 578     for(std::vector<std::string>::const_iterator i = nonoptions.begin(),
 579           iend = nonoptions.end(); i != iend; ++i){
 580       Debug("options") << "nonoptions " << *i << std::endl;
 581     }
 582   }
 583
 584   delete argumentExtender;
 585   return nonoptions;
 586 }
 587
 588 void Options::parseOptionsRecursive(Options* options,
 589                                     ArgumentExtender* extender,
 590                                     std::vector<std::string>* nonoptions)
 591 {
 592   int argc;
 593   char** argv;
 594
 595   extender->movePreemptionsToArguments();
 596   extender->pushFrontArgument("");
 597   extender->getArguments(&argc, &argv);
 598
 599   if(Debug.isOn("options")) {
 600     Debug("options") << "starting a new parseOptionsRecursive with "
 601                      << argc << " arguments" << std::endl;
 602     for( int i = 0; i < argc ; i++ ){
 603       Assert(argv[i] != NULL);
 604       Debug("options") << "  argv[" << i << "] = " << argv[i] << std::endl;
 605     }
 606   }
 607
 608   // Having this synonym simplifies the generation code in mkoptions.
 609   options::OptionsHandler* handler = options->d_handler;
 610
 611   // Reset getopt(), in the case of multiple calls to parseOptions().
 612   // This can be = 1 in newer GNU getopt, but older (< 2007) require = 0.
 613   optind = 0;
 614 #if HAVE_DECL_OPTRESET
 615   optreset = 1; // on BSD getopt() (e.g. Mac OS), might need this
 616 #endif /* HAVE_DECL_OPTRESET */
 617
 618
 619   int main_optind = 0;
 620   int old_optind;
 621
 622
 623   while(true) { // Repeat Forever
 624
 625     if(extender->hasPreemptions()){
 626       // Stop this round of parsing. We now parse recursively
 627       // to start on a new character array for argv.
 628       parseOptionsRecursive(options, extender, nonoptions);
 629       break;
 630     }
 631
 632     optopt = 0;
 633     std::string option, optionarg;
 634
 635     optind = main_optind;
 636     old_optind = main_optind;
 637     //optind_ref = &main_optind;
 638     //argv = main_argv;
 639
 640     // If we encounter an element that is not at zero and does not start
 641     // with a "-", this is a non-option. We consume this element as a
 642     // non-option.
 643     if (main_optind > 0 && main_optind < argc &&
 644         argv[main_optind][0] != '-') {
 645       Debug("options") << "enqueueing " << argv[main_optind]
 646                        << " as a non-option." << std::endl;
 647       nonoptions->push_back(argv[main_optind]);
 648       ++main_optind;
 649       extender->popFrontArgument();
 650       continue;
 651     }
 652
 653
 654     Debug("options") << "[ before, main_optind == " << main_optind << " ]"
 655                      << std::endl;
 656     Debug("options") << "[ before, optind == " << optind << " ]" << std::endl;
 657     Debug("options") << "[ argc == " << argc << ", argv == " << argv << " ]"
 658                      << std::endl;
 659     int c = getopt_long(argc, argv,
 660                         "+:${options_short}$",
 661                         cmdlineOptions, NULL);
 662
 663     while(main_optind < optind) {
 664       main_optind++;
 665       extender->popFrontArgument();
 666     }
 667
 668     Debug("options") << "[ got " << int(c) << " (" << char(c) << ") ]"
 669                      << "[ next option will be at pos: " << optind << " ]"
 670                      << std::endl;
 671
 672     // The initial getopt_long call should always determine that argv[0]
 673     // is not an option and returns -1. We always manually advance beyond
 674     // this element.
 675     //
 676     // We have to reinitialize optind to 0 instead of 1 as we need to support
 677     // changing the argv array passed to getopt.
 678     // This is needed as are using GNU extensions.
 679     // From: http://man7.org/linux/man-pages/man3/getopt.3.html
 680     // A program that scans multiple argument vectors, or rescans the same
 681     // vector more than once, and wants to make use of GNU extensions such
 682     // as '+' and '-' at the start of optstring, or changes the value of
 683     //  POSIXLY_CORRECT between scans, must reinitialize getopt() by
 684     //  resetting optind to 0, rather than the traditional value of 1.
 685     //  (Resetting to 0 forces the invocation of an internal initialization
 686     //  routine that rechecks POSIXLY_CORRECT and checks for GNU extensions
 687     //  in optstring.)
 688     if ( old_optind == 0  && c == -1 ) {
 689       Assert(main_optind > 0);
 690       continue;
 691     }
 692
 693     if ( c == -1 ) {
 694       if(Debug.isOn("options")) {
 695         Debug("options") << "done with option parsing" << std::endl;
 696         for(int index = optind; index < argc; ++index) {
 697           Debug("options") << "remaining " << argv[index] << std::endl;
 698         }
 699       }
 700       break;
 701     }
 702
 703     option = argv[old_optind == 0 ? 1 : old_optind];
 704     optionarg = (optarg == NULL) ? "" : optarg;
 705
 706     Debug("preemptGetopt") << "processing option " << c
 707                            << " (`" << char(c) << "'), " << option << std::endl;
 708
 709     switch(c) {
 710 ${options_handler}$
 711
 712
 713     case ':':
 714       // This can be a long or short option, and the way to get at the
 715       // name of it is different.
 716       throw OptionException(std::string("option `") + option +
 717                             "' missing its required argument");
 718
 719     case '?':
 720     default:
 721       throw OptionException(std::string("can't understand option `") + option +
 722                             "'" + suggestCommandLineOptions(option));
 723     }
 724   }
 725
 726   Debug("options") << "got " << nonoptions->size()
 727                    << " non-option arguments." << std::endl;
 728
 729   free(argv);
 730 }
 731
 732 std::string Options::suggestCommandLineOptions(const std::string& optionName)
 733 {
 734   DidYouMean didYouMean;
 735
 736   const char* opt;
 737   for(size_t i = 0; (opt = cmdlineOptions[i].name) != NULL; ++i) {
 738     didYouMean.addWord(std::string("--") + cmdlineOptions[i].name);
 739   }
 740
 741   return didYouMean.getMatchAsString(optionName.substr(0, optionName.find('=')));
 742 }
 743
 744 static const char* smtOptions[] = {
 745   ${options_smt}$
 746   NULL
 747 };/* smtOptions[] */
 748
 749 std::vector<std::string> Options::suggestSmtOptions(
 750     const std::string& optionName)
 751 {
 752   std::vector<std::string> suggestions;
 753
 754   const char* opt;
 755   for(size_t i = 0; (opt = smtOptions[i]) != NULL; ++i) {
 756     if(std::strstr(opt, optionName.c_str()) != NULL) {
 757       suggestions.push_back(opt);
 758     }
 759   }
 760
 761   return suggestions;
 762 }
 763
 764 std::vector<std::vector<std::string> > Options::getOptions() const
 765 {
 766   std::vector< std::vector<std::string> > opts;
 767
 768   ${options_getoptions}$
 769
 770
 771   return opts;
 772 }
 773
 774 void Options::setOption(const std::string& key, const std::string& optionarg)
 775 {
 776   options::OptionsHandler* handler = d_handler;
 777   Options *options = Options::current();
 778   Trace("options") << "SMT setOption(" << key << ", " << optionarg << ")"
 779                    << std::endl;
 780
 781   ${setoption_handlers}$
 782
 783
 784   throw UnrecognizedOptionException(key);
 785 }
 786
 787 std::string Options::getOption(const std::string& key) const
 788 {
 789   Trace("options") << "SMT getOption(" << key << ")" << std::endl;
 790
 791   ${getoption_handlers}$
 792
 793
 794   throw UnrecognizedOptionException(key);
 795 }
 796
 797 #undef USE_EARLY_TYPE_CHECKING_BY_DEFAULT
 798 #undef DO_SEMANTIC_CHECKS_BY_DEFAULT
 799
 800 }  // namespace CVC4