Options merge. This commit:

1. changes the way options are declared (see http://church.cims.nyu.edu/wiki/Options)
2. moves module-specific options enumerations (SimplificationMode, DecisionMode, ArithUnateLemmaMode, etc.) to their own header files, also they are no longer inside the Options:: class namespace.
3. includes many SMT-LIBv2 compliance fixes, especially to (set-option..) and (get-option..)

The biggest syntactical changes (outside of adding new options) you'll notice are in accessing and setting options:

* to access an option, write (e.g.) options::unconstrainedSimp() instead of Options::current()->unconstrainedSimp.
* to determine if an option value was set by the user, check (e.g.) options::unconstrainedSimp.wasSetByUser().
* ensure that you have the option available (you have to #include the right module's options.h file, e.g. #include "theory/uf/options.h" for UF options)
*** this point is important.  If you access an option and it tells you the option doesn't exist, you aren't #including the appropriate options.h header file ***

Note that if you want an option to be directly set (i.e., other than via command-line parsing or SmtEngine::setOption()), you need to mark the option :read-write in its options file (otherwise it's read-only), and you then write (e.g.) options::unconstrainedSimp.set(true).

Adding new options is incredibly simple for primitive types (int, unsigned, bool, string, double).  For option settings that you need to turn into a member of an enumerated type, you write a custom "handler" for the option---this is no additional work than it was before, and there are many examples to copy from (a good one is stringToSimplificationMode() in src/smt/options_handlers.h).

Benefits of the new options system include:

1. changes to options declarations don't require a full-source rebuild (you only have to rebuild those sources that depend on the set of options that changed).
2. lots of sanity checks (that the same option isn't declared twice, that option values are in range for their type, that all options are documented properly, etc.)
3. consistency: Boolean-valued option --foo gets a --no-foo automatically, documentation is generated consistently, the option-parsing matches the documented option name, etc.
4. setting options programmatically via SmtEngine::setOption() is enabled, and behaves the same as command-line equivalents (including checking the value is in range, etc.)
5. the notion of options being "set by the user" is now primitive; you can use (e.g.) options::unconstrainedSimp.wasSetByUser() instead of having to use (and maintain) a separate Boolean option for the purpose

I've taken lots of care not to break anything.  Hopefully, I've succeeded in that.

1 files changed, 173 insertions, 0 deletions

diff --git a/src/options/base_options_handlers.h b/src/options/base_options_handlers.h
new file mode 100644
index 000000000..5f82280da
--- /dev/null
+++ b/src/options/base_options_handlers.h
@@ -0,0 +1,173 @@
+/*********************                                                        */
+/*! \file base_options_handlers.h
+ ** \verbatim
+ ** Original author: mdeters
+ ** Major contributors: none
+ ** Minor contributors (to current version): none
+ ** This file is part of the CVC4 prototype.
+ ** Copyright (c) 2009-2012  The Analysis of Computer Systems Group (ACSys)
+ ** Courant Institute of Mathematical Sciences
+ ** New York University
+ ** See the file COPYING in the top-level source directory for licensing
+ ** information.\endverbatim
+ **
+ ** \brief [[ Add one-line brief description here ]]
+ **
+ ** [[ Add lengthier description here ]]
+ ** \todo document this file
+ **/
+
+#ifndef __CVC4__BASE_OPTIONS_HANDLERS_H
+#define __CVC4__BASE_OPTIONS_HANDLERS_H
+
+#include <iostream>
+#include <string>
+#include <sstream>
+
+#include "expr/command.h"
+
+namespace CVC4 {
+namespace options {
+
+inline void increaseVerbosity(std::string option, SmtEngine* smt) {
+  options::verbosity.set(options::verbosity() + 1);
+}
+
+inline void decreaseVerbosity(std::string option, SmtEngine* smt) {
+  options::verbosity.set(options::verbosity() - 1);
+}
+
+inline OutputLanguage stringToOutputLanguage(std::string option, std::string optarg, SmtEngine* smt) throw(OptionException) {
+  if(optarg == "cvc4" || optarg == "pl") {
+    return language::output::LANG_CVC4;
+  } else if(optarg == "smtlib" || optarg == "smt") {
+    return language::output::LANG_SMTLIB;
+  } else if(optarg == "smtlib2" || optarg == "smt2") {
+    return language::output::LANG_SMTLIB_V2;
+  } else if(optarg == "tptp") {
+    return language::output::LANG_TPTP;
+  } else if(optarg == "ast") {
+    return language::output::LANG_AST;
+  } else if(optarg == "auto") {
+    return language::output::LANG_AUTO;
+  }
+
+  if(optarg != "help") {
+    throw OptionException(std::string("unknown language for --output-lang: `") +
+                          optarg + "'.  Try --output-lang help.");
+  }
+
+  options::languageHelp.set(true);
+  return language::output::LANG_AUTO;
+}
+
+inline InputLanguage stringToInputLanguage(std::string option, std::string optarg, SmtEngine* smt) throw(OptionException) {
+  if(optarg == "cvc4" || optarg == "pl" || optarg == "presentation") {
+    return language::input::LANG_CVC4;
+  } else if(optarg == "smtlib" || optarg == "smt") {
+    return language::input::LANG_SMTLIB;
+  } else if(optarg == "smtlib2" || optarg == "smt2") {
+    return language::input::LANG_SMTLIB_V2;
+  } else if(optarg == "tptp") {
+    return language::input::LANG_TPTP;
+  } else if(optarg == "auto") {
+    return language::input::LANG_AUTO;
+  }
+
+  if(optarg != "help") {
+    throw OptionException(std::string("unknown language for --lang: `") +
+                          optarg + "'.  Try --lang help.");
+  }
+
+  options::languageHelp.set(true);
+  return language::input::LANG_AUTO;
+}
+
+inline void addTraceTag(std::string option, std::string optarg, SmtEngine* smt) {
+  if(Configuration::isTracingBuild()) {
+    if(!Configuration::isTraceTag(optarg.c_str()))
+      throw OptionException(std::string("trace tag ") + optarg +
+                            std::string(" not available"));
+  } else {
+    throw OptionException("trace tags not available in non-tracing builds");
+  }
+  Trace.on(optarg);
+}
+
+inline void addDebugTag(std::string option, std::string optarg, SmtEngine* smt) {
+  if(Configuration::isDebugBuild() && Configuration::isTracingBuild()) {
+    if(!Configuration::isDebugTag(optarg.c_str()) &&
+       !Configuration::isTraceTag(optarg.c_str())) {
+      throw OptionException(std::string("debug tag ") + optarg +
+                            std::string(" not available"));
+    }
+  } else if(! Configuration::isDebugBuild()) {
+    throw OptionException("debug tags not available in non-debug builds");
+  } else {
+    throw OptionException("debug tags not available in non-tracing builds");
+  }
+  Debug.on(optarg);
+  Trace.on(optarg);
+}
+
+inline void setPrintSuccess(std::string option, bool value, SmtEngine* smt) {
+  Debug.getStream() << Command::printsuccess(value);
+  Trace.getStream() << Command::printsuccess(value);
+  Notice.getStream() << Command::printsuccess(value);
+  Chat.getStream() << Command::printsuccess(value);
+  Message.getStream() << Command::printsuccess(value);
+  Warning.getStream() << Command::printsuccess(value);
+  *options::out() << Command::printsuccess(value);
+}
+
+template <template <class U> class Cmp>
+class comparator {
+  long d_lbound;
+  double d_dbound;
+  bool d_hasLbound;
+
+public:
+  comparator(long l) throw() : d_lbound(l), d_dbound(0.0), d_hasLbound(true) {}
+  comparator(double d) throw() : d_lbound(0), d_dbound(d), d_hasLbound(false) {}
+
+  template <class T>
+  void operator()(std::string option, const T& value, SmtEngine* smt) {
+    if((d_hasLbound && !(Cmp<T>()(value, T(d_lbound)))) ||
+       (!d_hasLbound && !(Cmp<T>()(value, T(d_dbound))))) {
+      std::stringstream ss;
+      ss << option << ": " << value << " is not a legal setting";
+      throw OptionException(ss.str());
+    }
+  }
+};/* class comparator */
+
+struct greater : public comparator<std::greater> {
+  greater(long l) throw() : comparator<std::greater>(l) {}
+  greater(double d) throw() : comparator<std::greater>(d) {}
+};/* struct greater */
+
+struct greater_equal : public comparator<std::greater_equal> {
+  greater_equal(long l) throw() : comparator<std::greater_equal>(l) {}
+  greater_equal(double d) throw() : comparator<std::greater_equal>(d) {}
+};/* struct greater_equal */
+
+struct less : public comparator<std::less> {
+  less(long l) throw() : comparator<std::less>(l) {}
+  less(double d) throw() : comparator<std::less>(d) {}
+};/* struct less */
+
+struct less_equal : public comparator<std::less_equal> {
+  less_equal(long l) throw() : comparator<std::less_equal>(l) {}
+  less_equal(double d) throw() : comparator<std::less_equal>(d) {}
+};/* struct less_equal */
+
+struct not_equal : public comparator<std::not_equal_to> {
+  not_equal(long l) throw() : comparator<std::not_equal_to>(l) {}
+  not_equal(double d) throw() : comparator<std::not_equal_to>(d) {}
+};/* struct not_equal_to */
+
+}/* CVC4::options namespace */
+}/* CVC4 namespace */
+
+#endif /* __CVC4__BASE_OPTIONS_HANDLERS_H */
+