src/options/options_template.cpp

   1 /*********************                                                        */
   2 /*! \file options_template.cpp
   3  ** \verbatim
   4  ** Original author: Morgan Deters
   5  ** Major contributors: none
   6  ** Minor contributors (to current version): Kshitij Bansal
   7  ** This file is part of the CVC4 project.
   8  ** Copyright (c) 2009-2013  New York University and The University of Iowa
   9  ** See the file COPYING in the top-level source directory for licensing
  10  ** 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 <cstdio>
  38 #include <cstdlib>
  39 #include <new>
  40 #include <string>
  41 #include <sstream>
  42 #include <limits>
  43 #include <unistd.h>
  44 #include <string.h>
  45 #include <stdint.h>
  46 #include <time.h>
  47
  48 #include "expr/expr.h"
  49 #include "util/configuration.h"
  50 #include "util/didyoumean.h"
  51 #include "util/exception.h"
  52 #include "util/language.h"
  53 #include "util/tls.h"
  54
  55 ${include_all_option_headers}
  56
  57 #line 58 "${template}"
  58
  59 #include "util/output.h"
  60 #include "options/options_holder.h"
  61 #include "cvc4autoconfig.h"
  62 #include "options/base_options_handlers.h"
  63
  64 ${option_handler_includes}
  65
  66 #line 67 "${template}"
  67
  68 using namespace CVC4;
  69 using namespace CVC4::options;
  70
  71 namespace CVC4 {
  72
  73 CVC4_THREADLOCAL(Options*) Options::s_current = NULL;
  74
  75 /**
  76  * This is a default handler for options of built-in C++ type.  This
  77  * template is really just a helper for the handleOption() template,
  78  * below.  Variants of this template handle numeric and non-numeric,
  79  * integral and non-integral, signed and unsigned C++ types.
  80  * handleOption() makes sure to instantiate the right one.
  81  *
  82  * This implements default behavior when e.g. an option is
  83  * unsigned but the user specifies a negative argument; etc.
  84  */
  85 template <class T, bool is_numeric, bool is_integer>
  86 struct OptionHandler {
  87   static T handle(std::string option, std::string optionarg);
  88 };/* struct OptionHandler<> */
  89
  90 /** Variant for integral C++ types */
  91 template <class T>
  92 struct OptionHandler<T, true, true> {
  93   static T handle(std::string option, std::string optionarg) {
  94     try {
  95       Integer i(optionarg, 10);
  96
  97       if(! std::numeric_limits<T>::is_signed && i < 0) {
  98         // unsigned type but user gave negative argument
  99         throw OptionException(option + " requires a nonnegative argument");
 100       } else if(i < std::numeric_limits<T>::min()) {
 101         // negative overflow for type
 102         std::stringstream ss;
 103         ss << option << " requires an argument >= " << std::numeric_limits<T>::min();
 104         throw OptionException(ss.str());
 105       } else if(i > std::numeric_limits<T>::max()) {
 106         // positive overflow for type
 107         std::stringstream ss;
 108         ss << option << " requires an argument <= " << std::numeric_limits<T>::max();
 109         throw OptionException(ss.str());
 110       }
 111
 112       if(std::numeric_limits<T>::is_signed) {
 113         return T(i.getLong());
 114       } else {
 115         return T(i.getUnsignedLong());
 116       }
 117     } catch(std::invalid_argument&) {
 118       // user gave something other than an integer
 119       throw OptionException(option + " requires an integer argument");
 120     }
 121   }
 122 };/* struct OptionHandler<T, true, true> */
 123
 124 /** Variant for numeric but non-integral C++ types */
 125 template <class T>
 126 struct OptionHandler<T, true, false> {
 127   static T handle(std::string option, std::string optionarg) {
 128     std::stringstream in(optionarg);
 129     long double r;
 130     in >> r;
 131     if(! in.eof()) {
 132       // we didn't consume the whole string (junk at end)
 133       throw OptionException(option + " requires a numeric argument");
 134     }
 135
 136     if(! std::numeric_limits<T>::is_signed && r < 0.0) {
 137       // unsigned type but user gave negative value
 138       throw OptionException(option + " requires a nonnegative argument");
 139     } else if(r < -std::numeric_limits<T>::max()) {
 140       // negative overflow for type
 141       std::stringstream ss;
 142       ss << option << " requires an argument >= " << -std::numeric_limits<T>::max();
 143       throw OptionException(ss.str());
 144     } else if(r > std::numeric_limits<T>::max()) {
 145       // positive overflow for type
 146       std::stringstream ss;
 147       ss << option << " requires an argument <= " << std::numeric_limits<T>::max();
 148       throw OptionException(ss.str());
 149     }
 150
 151     return T(r);
 152   }
 153 };/* struct OptionHandler<T, true, false> */
 154
 155 /** Variant for non-numeric C++ types */
 156 template <class T>
 157 struct OptionHandler<T, false, false> {
 158   static T handle(std::string option, std::string optionarg) {
 159     T::unsupported_handleOption_call___please_write_me;
 160     // The above line causes a compiler error if this version of the template
 161     // is ever instantiated (meaning that a specialization is missing).  So
 162     // don't worry about the segfault in the next line, the "return" is only
 163     // there to keep the compiler from giving additional, distracting errors
 164     // and warnings.
 165     return *(T*)0;
 166   }
 167 };/* struct OptionHandler<T, false, false> */
 168
 169 /** Handle an option of type T in the default way. */
 170 template <class T>
 171 T handleOption(std::string option, std::string optionarg) {
 172   return OptionHandler<T, std::numeric_limits<T>::is_specialized, std::numeric_limits<T>::is_integer>::handle(option, optionarg);
 173 }
 174
 175 /** Handle an option of type std::string in the default way. */
 176 template <>
 177 std::string handleOption<std::string>(std::string option, std::string optionarg) {
 178   return optionarg;
 179 }
 180
 181 /**
 182  * Run handler, and any user-given predicates, for option T.
 183  * If a user specifies a :handler or :predicates, it overrides this.
 184  */
 185 template <class T>
 186 typename T::type runHandlerAndPredicates(T, std::string option, std::string optionarg, SmtEngine* smt) {
 187   // By default, parse the option argument in a way appropriate for its type.
 188   // E.g., for "unsigned int" options, ensure that the provided argument is
 189   // a nonnegative integer that fits in the unsigned int type.
 190
 191   return handleOption<typename T::type>(option, optionarg);
 192 }
 193
 194 template <class T>
 195 void runBoolPredicates(T, std::string option, bool b, SmtEngine* smt) {
 196   // By default, nothing to do for bool.  Users add things with
 197   // :predicate in options files to provide custom checking routines
 198   // that can throw exceptions.
 199 }
 200
 201 ${all_custom_handlers}
 202
 203 #line 204 "${template}"
 204
 205 #ifdef CVC4_DEBUG
 206 #  define USE_EARLY_TYPE_CHECKING_BY_DEFAULT true
 207 #else /* CVC4_DEBUG */
 208 #  define USE_EARLY_TYPE_CHECKING_BY_DEFAULT false
 209 #endif /* CVC4_DEBUG */
 210
 211 #if defined(CVC4_MUZZLED) || defined(CVC4_COMPETITION_MODE)
 212 #  define DO_SEMANTIC_CHECKS_BY_DEFAULT false
 213 #else /* CVC4_MUZZLED || CVC4_COMPETITION_MODE */
 214 #  define DO_SEMANTIC_CHECKS_BY_DEFAULT true
 215 #endif /* CVC4_MUZZLED || CVC4_COMPETITION_MODE */
 216
 217 Options::Options() :
 218   d_holder(new options::OptionsHolder()) {
 219 }
 220
 221 Options::Options(const Options& options) :
 222   d_holder(new options::OptionsHolder(*options.d_holder)) {
 223 }
 224
 225 Options::~Options() {
 226   delete d_holder;
 227 }
 228
 229 options::OptionsHolder::OptionsHolder() : ${all_modules_defaults}
 230 {
 231 }
 232
 233 #line 234 "${template}"
 234
 235 static const std::string mostCommonOptionsDescription = "\
 236 Most commonly-used CVC4 options:${common_documentation}";
 237
 238 #line 239 "${template}"
 239
 240 static const std::string optionsDescription = mostCommonOptionsDescription + "\n\
 241 \n\
 242 Additional CVC4 options:${remaining_documentation}";
 243
 244 #line 245 "${template}"
 245
 246 static const std::string optionsFootnote = "\n\
 247 [*] Each of these options has a --no-OPTIONNAME variant, which reverses the\n\
 248     sense of the option.\n\
 249 ";
 250
 251 static const std::string languageDescription = "\
 252 Languages currently supported as arguments to the -L / --lang option:\n\
 253   auto                           attempt to automatically determine language\n\
 254   cvc4 | presentation | pl       CVC4 presentation language\n\
 255   smt1 | smtlib1                 SMT-LIB format 1.2\n\
 256   smt | smtlib | smt2 | smtlib2  SMT-LIB format 2.0\n\
 257   tptp                           TPTP format (cnf and fof)\n\
 258 \n\
 259 Languages currently supported as arguments to the --output-lang option:\n\
 260   auto                           match output language to input language\n\
 261   cvc4 | presentation | pl       CVC4 presentation language\n\
 262   smt1 | smtlib1                 SMT-LIB format 1.2\n\
 263   smt | smtlib | smt2 | smtlib2  SMT-LIB format 2.0\n\
 264   z3str                          SMT-LIB 2.0 with Z3-str string constraints\n\
 265   tptp                           TPTP format\n\
 266   ast                            internal format (simple syntax trees)\n\
 267 ";
 268
 269 std::string Options::getDescription() const {
 270   return optionsDescription;
 271 }
 272
 273 void Options::printUsage(const std::string msg, std::ostream& out) {
 274   out << msg << optionsDescription << std::endl
 275       << optionsFootnote << std::endl << std::flush;
 276 }
 277
 278 void Options::printShortUsage(const std::string msg, std::ostream& out) {
 279   out << msg << mostCommonOptionsDescription << std::endl
 280       << optionsFootnote << std::endl
 281       << "For full usage, please use --help." << std::endl << std::endl << std::flush;
 282 }
 283
 284 void Options::printLanguageHelp(std::ostream& out) {
 285   out << languageDescription << std::flush;
 286 }
 287
 288 /**
 289  * This is a table of long options.  By policy, each short option
 290  * should have an equivalent long option (but the reverse isn't the
 291  * case), so this table should thus contain all command-line options.
 292  *
 293  * Each option in this array has four elements:
 294  *
 295  * 1. the long option string
 296  * 2. argument behavior for the option:
 297  *    no_argument - no argument permitted
 298  *    required_argument - an argument is expected
 299  *    optional_argument - an argument is permitted but not required
 300  * 3. this is a pointer to an int which is set to the 4th entry of the
 301  *    array if the option is present; or NULL, in which case
 302  *    getopt_long() returns the 4th entry
 303  * 4. the return value for getopt_long() when this long option (or the
 304  *    value to set the 3rd entry to; see #3)
 305  *
 306  * If you add something here, you should add it in src/main/usage.h
 307  * also, to document it.
 308  *
 309  * If you add something that has a short option equivalent, you should
 310  * add it to the getopt_long() call in parseOptions().
 311  */
 312 static struct option cmdlineOptions[] = {${all_modules_long_options}
 313   { NULL, no_argument, NULL, '\0' }
 314 };/* cmdlineOptions */
 315
 316 #line 317 "${template}"
 317
 318 static void preemptGetopt(int& argc, char**& argv, const char* opt) {
 319   const size_t maxoptlen = 128;
 320
 321   Debug("preemptGetopt") << "preempting getopt() with " << opt << std::endl;
 322
 323   AlwaysAssert(opt != NULL && *opt != '\0');
 324   AlwaysAssert(strlen(opt) <= maxoptlen);
 325
 326   ++argc;
 327   unsigned i = 1;
 328   while(argv[i] != NULL && argv[i][0] != '\0') {
 329     ++i;
 330   }
 331
 332   if(argv[i] == NULL) {
 333     argv = (char**) realloc(argv, (i + 6) * sizeof(char*));
 334     for(unsigned j = i; j < i + 5; ++j) {
 335       argv[j] = (char*) malloc(sizeof(char) * maxoptlen);
 336       argv[j][0] = '\0';
 337     }
 338     argv[i + 5] = NULL;
 339   }
 340
 341   strncpy(argv[i], opt, maxoptlen - 1);
 342   argv[i][maxoptlen - 1] = '\0'; // ensure NUL-termination even on overflow
 343 }
 344
 345 namespace options {
 346
 347 /** Set a given Options* as "current" just for a particular scope. */
 348 class OptionsGuard {
 349   CVC4_THREADLOCAL_TYPE(Options*)* d_field;
 350   Options* d_old;
 351 public:
 352   OptionsGuard(CVC4_THREADLOCAL_TYPE(Options*)* field, Options* opts) :
 353     d_field(field),
 354     d_old(*field) {
 355     *field = opts;
 356   }
 357   ~OptionsGuard() {
 358     *d_field = d_old;
 359   }
 360 };/* class OptionsGuard */
 361
 362 }/* CVC4::options namespace */
 363
 364 /**
 365  * Parse argc/argv and put the result into a CVC4::Options.
 366  * The return value is what's left of the command line (that is, the
 367  * non-option arguments).
 368  */
 369 std::vector<std::string> Options::parseOptions(int argc, char* main_argv[]) throw(OptionException) {
 370   options::OptionsGuard guard(&s_current, this);
 371
 372   const char *progName = main_argv[0];
 373   SmtEngine* const smt = NULL;
 374
 375   Debug("options") << "main_argv == " << main_argv << std::endl;
 376
 377   // Reset getopt(), in the case of multiple calls to parseOptions().
 378   // This can be = 1 in newer GNU getopt, but older (< 2007) require = 0.
 379   optind = 0;
 380 #if HAVE_DECL_OPTRESET
 381   optreset = 1; // on BSD getopt() (e.g. Mac OS), might need this
 382 #endif /* HAVE_DECL_OPTRESET */
 383
 384   // find the base name of the program
 385   const char *x = strrchr(progName, '/');
 386   if(x != NULL) {
 387     progName = x + 1;
 388   }
 389   d_holder->binary_name = std::string(progName);
 390
 391   int extra_argc = 1;
 392   char **extra_argv = (char**) malloc(2 * sizeof(char*));
 393   extra_argv[0] = NULL;
 394   extra_argv[1] = NULL;
 395
 396   int extra_optind = 0, main_optind = 0;
 397   int old_optind;
 398   int *optind_ref = &main_optind;
 399
 400   char** argv = main_argv;
 401
 402   std::vector<std::string> nonOptions;
 403
 404   for(;;) {
 405     int c = -1;
 406     optopt = 0;
 407     std::string option, optionarg;
 408     Debug("preemptGetopt") << "top of loop, extra_optind == " << extra_optind << ", extra_argc == " << extra_argc << std::endl;
 409     if((extra_optind == 0 ? 1 : extra_optind) < extra_argc) {
 410 #if HAVE_DECL_OPTRESET
 411       if(optind_ref != &extra_optind) {
 412         optreset = 1; // on BSD getopt() (e.g. Mac OS), might need this
 413       }
 414 #endif /* HAVE_DECL_OPTRESET */
 415       old_optind = optind = extra_optind;
 416       optind_ref = &extra_optind;
 417       argv = extra_argv;
 418       Debug("preemptGetopt") << "in preempt code, next arg is " << extra_argv[optind == 0 ? 1 : optind] << std::endl;
 419       if(extra_argv[extra_optind == 0 ? 1 : extra_optind][0] != '-') {
 420         InternalError("preempted args cannot give non-options command-line args (found `%s')", extra_argv[extra_optind == 0 ? 1 : extra_optind]);
 421       }
 422       c = getopt_long(extra_argc, extra_argv,
 423                       "+:${all_modules_short_options}",
 424                       cmdlineOptions, NULL);
 425       Debug("preemptGetopt") << "in preempt code, c == " << c << " (`" << char(c) << "') optind == " << optind << std::endl;
 426       if(optopt == 0 ||
 427          ( optopt >= ${long_option_value_begin} && optopt <= ${long_option_value_end} )) {
 428         // long option
 429         option = argv[old_optind == 0 ? 1 : old_optind];
 430         optionarg = (optarg == NULL) ? "" : optarg;
 431       } else {
 432         // short option
 433         option = std::string("-") + char(optopt);
 434         optionarg = (optarg == NULL) ? "" : optarg;
 435       }
 436       if(optind >= extra_argc) {
 437         Debug("preemptGetopt") << "-- no more preempt args" << std::endl;
 438         unsigned i = 1;
 439         while(extra_argv[i] != NULL && extra_argv[i][0] != '\0') {
 440           extra_argv[i][0] = '\0';
 441           ++i;
 442         }
 443         extra_argc = 1;
 444         extra_optind = 0;
 445       } else {
 446         Debug("preemptGetopt") << "-- more preempt args" << std::endl;
 447         extra_optind = optind;
 448       }
 449     }
 450     if(c == -1) {
 451 #if HAVE_DECL_OPTRESET
 452       if(optind_ref != &main_optind) {
 453         optreset = 1; // on BSD getopt() (e.g. Mac OS), might need this
 454       }
 455 #endif /* HAVE_DECL_OPTRESET */
 456       old_optind = optind = main_optind;
 457       optind_ref = &main_optind;
 458       argv = main_argv;
 459       if(main_optind < argc && main_argv[main_optind][0] != '-') {
 460         do {
 461           if(main_optind != 0) {
 462             nonOptions.push_back(main_argv[main_optind]);
 463           }
 464           ++main_optind;
 465         } while(main_optind < argc && main_argv[main_optind][0] != '-');
 466         continue;
 467       }
 468       Debug("options") << "[ before, optind == " << optind << " ]" << std::endl;
 469 #if defined(__MINGW32__) || defined(__MINGW64__)
 470       if(optreset == 1 && optind > 1) {
 471         // on mingw, optreset will reset the optind, so we have to
 472         // manually advance argc, argv
 473         main_argv[optind - 1] = main_argv[0];
 474         argv = main_argv += optind - 1;
 475         argc -= optind - 1;
 476         old_optind = optind = main_optind = 1;
 477         if(argc > 0) {
 478           Debug("options") << "looking at : " << argv[0] << std::endl;
 479         }
 480         /*c = getopt_long(argc, main_argv,
 481                         "+:${all_modules_short_options}",
 482                         cmdlineOptions, NULL);
 483         Debug("options") << "pre-emptory c is " << c << " (" << char(c) << ")" << std::endl;
 484         Debug("options") << "optind was reset to " << optind << std::endl;
 485         optind = main_optind;
 486         Debug("options") << "I restored optind to " << optind << std::endl;*/
 487       }
 488 #endif /* __MINGW32__ || __MINGW64__ */
 489       Debug("options") << "[ argc == " << argc << ", main_argv == " << main_argv << " ]" << std::endl;
 490       c = getopt_long(argc, main_argv,
 491                       "+:${all_modules_short_options}",
 492                       cmdlineOptions, NULL);
 493       main_optind = optind;
 494       Debug("options") << "[ got " << int(c) << " (" << char(c) << ") ]" << std::endl;
 495       Debug("options") << "[ next option will be at pos: " << optind << " ]" << std::endl;
 496       if(c == -1) {
 497         Debug("options") << "done with option parsing" << std::endl;
 498         break;
 499       }
 500       option = argv[old_optind == 0 ? 1 : old_optind];
 501       optionarg = (optarg == NULL) ? "" : optarg;
 502     }
 503
 504     Debug("preemptGetopt") << "processing option " << c << " (`" << char(c) << "'), " << option << std::endl;
 505
 506     switch(c) {
 507 ${all_modules_option_handlers}
 508
 509 #line 510 "${template}"
 510
 511     case ':':
 512       // This can be a long or short option, and the way to get at the
 513       // name of it is different.
 514       throw OptionException(std::string("option `") + option + "' missing its required argument");
 515
 516     case '?':
 517     default:
 518       if( ( optopt == 0 || ( optopt >= ${long_option_value_begin} && optopt <= ${long_option_value_end} ) ) &&
 519           !strncmp(argv[optind - 1], "--thread", 8) &&
 520           strlen(argv[optind - 1]) > 8 ) {
 521         if(! isdigit(argv[optind - 1][8])) {
 522           throw OptionException(std::string("can't understand option `") + option + "': expected something like --threadN=\"--option1 --option2\", where N is a nonnegative integer");
 523         }
 524         std::vector<std::string>& threadArgv = d_holder->threadArgv;
 525         char *end;
 526         long tnum = strtol(argv[optind - 1] + 8, &end, 10);
 527         if(tnum < 0 || (*end != '\0' && *end != '=')) {
 528           throw OptionException(std::string("can't understand option `") + option + "': expected something like --threadN=\"--option1 --option2\", where N is a nonnegative integer");
 529         }
 530         if(threadArgv.size() <= size_t(tnum)) {
 531           threadArgv.resize(tnum + 1);
 532         }
 533         if(threadArgv[tnum] != "") {
 534           threadArgv[tnum] += " ";
 535         }
 536         if(*end == '\0') { // e.g., we have --thread0 "foo"
 537           if(argc <= optind) {
 538             throw OptionException(std::string("option `") + option + "' missing its required argument");
 539           }
 540           Debug("options") << "thread " << tnum << " gets option " << argv[optind] << std::endl;
 541           threadArgv[tnum] += argv[(*optind_ref)++];
 542         } else { // e.g., we have --thread0="foo"
 543           if(end[1] == '\0') {
 544             throw OptionException(std::string("option `") + option + "' missing its required argument");
 545           }
 546           Debug("options") << "thread " << tnum << " gets option " << (end + 1) << std::endl;
 547           threadArgv[tnum] += end + 1;
 548         }
 549         Debug("options") << "thread " << tnum << " now has " << threadArgv[tnum] << std::endl;
 550         break;
 551       }
 552
 553       throw OptionException(std::string("can't understand option `") + option + "'"
 554                             + suggestCommandLineOptions(option));
 555     }
 556   }
 557
 558   Debug("options") << "returning " << nonOptions.size() << " non-option arguments." << std::endl;
 559
 560   return nonOptions;
 561 }
 562
 563 std::string Options::suggestCommandLineOptions(const std::string& optionName) throw() {
 564   DidYouMean didYouMean;
 565
 566   const char* opt;
 567   for(size_t i = 0; (opt = cmdlineOptions[i].name) != NULL; ++i) {
 568     didYouMean.addWord(std::string("--") + cmdlineOptions[i].name);
 569   }
 570
 571   return didYouMean.getMatchAsString(optionName);
 572 }
 573
 574 static const char* smtOptions[] = {
 575   ${all_modules_smt_options},
 576 #line 589 "${template}"
 577   NULL
 578 };/* smtOptions[] */
 579
 580 std::vector<std::string> Options::suggestSmtOptions(const std::string& optionName) throw() {
 581   std::vector<std::string> suggestions;
 582
 583   const char* opt;
 584   for(size_t i = 0; (opt = smtOptions[i]) != NULL; ++i) {
 585     if(std::strstr(opt, optionName.c_str()) != NULL) {
 586       suggestions.push_back(opt);
 587     }
 588   }
 589
 590   return suggestions;
 591 }
 592
 593 SExpr Options::getOptions() const throw() {
 594   std::vector<SExpr> opts;
 595
 596   ${all_modules_get_options}
 597
 598 #line 611 "${template}"
 599
 600   return SExpr(opts);
 601 }
 602
 603 #undef USE_EARLY_TYPE_CHECKING_BY_DEFAULT
 604 #undef DO_SEMANTIC_CHECKS_BY_DEFAULT
 605
 606 }/* CVC4 namespace */