1 files changed, 265 insertions, 0 deletions
diff --git a/trunk/qpid/cpp/include/qpid/Options.h b/trunk/qpid/cpp/include/qpid/Options.h
new file mode 100644
index 0000000000..078a6b4d95
--- /dev/null
+++ b/trunk/qpid/cpp/include/qpid/Options.h
@@ -0,0 +1,265 @@
+#ifndef QPID_COMMONOPTIONS_H
+#define QPID_COMMONOPTIONS_H
+
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+
+#include "qpid/Exception.h"
+
+// Disable warnings triggered by boost.
+#ifdef _MSC_VER
+#  pragma warning(push)
+#  pragma warning(disable : 4251 4275)
+#endif
+
+#include <boost/program_options.hpp>
+#include <boost/format.hpp>
+
+#ifdef _MSC_VER
+#  pragma warning(pop)
+#endif
+
+#include <sstream>
+#include <iterator>
+#include <algorithm>
+#include <string>
+#include "qpid/CommonImportExport.h"
+
+namespace qpid {
+namespace po=boost::program_options;
+
+
+
+///@internal
+QPID_COMMON_EXTERN std::string prettyArg(const std::string&, const std::string&);
+
+/** @internal Normally only constructed by optValue() */
+template <class T>
+class OptionValue : public po::typed_value<T> {
+  public:
+    OptionValue(T& value, const std::string& arg)
+        : po::typed_value<T>(&value), argName(arg) {}
+    std::string name() const { return argName; }
+
+  private:
+    std::string argName;
+};
+
+
+/** Create an option value.
+ * name, value appear after the option name in help like this:
+ * <name> (=<value>)
+ * T must support operator <<.
+ *@see Options for example of use.
+ */
+template<class T>
+po::value_semantic* optValue(T& value, const char* name) {
+    std::string valstr(boost::lexical_cast<std::string>(value));
+    return new OptionValue<T>(value, prettyArg(name, valstr));
+}
+
+/** Create a vector value. Multiple occurences of the option are
+ * accumulated into the vector
+ */
+template <class T>
+po::value_semantic* optValue(std::vector<T>& value, const char* name) {
+    using namespace std;
+    ostringstream os;
+    copy(value.begin(), value.end(), ostream_iterator<T>(os, " "));
+    string val=os.str();
+    if (!val.empty())
+        val.erase(val.end()-1); // Remove trailing " "
+    return (new OptionValue<vector<T> >(value, prettyArg(name, val)));
+}
+
+/** Create a boolean switch value. Presence of the option sets the value. */
+inline po::value_semantic* optValue(bool& value) { return po::bool_switch(&value); }
+
+/**
+ * Base class for options.
+ * Example of use:
+ @code
+ struct MySubOptions : public Options {
+   int x;
+   string y;
+   MySubOptions() : Options("Sub options") {
+     addOptions()
+     ("x", optValue(x,"XUNIT"), "Option X")
+     ("y", optValue(y, "YUNIT"), "Option Y");
+   }
+ };
+
+ struct MyOptions : public Options {
+   bool z;
+   vector<string> foo;
+   MySubOptions subOptions;
+   MyOptions() : Options("My Options") {
+    addOptions()
+      ("z", boolSwitch(z), "Option Z")
+      ("foo", optValue(foo), "Multiple option foo");
+    add(subOptions);
+ }
+
+ main(int argc, char** argv) {
+   Options opts;
+   opts.parse(argc, char** argv);
+   // Use values
+   dosomething(opts.subOptions.x);
+   if (error)
+     cout << opts << end;       // Help message.
+ }
+
+ @endcode
+ */
+
+
+
+
+/*
+ *  ---------------------------------------------
+ *  Explanation for Boost 103200 conditional code
+ *  ---------------------------------------------
+ *
+ *  This boost version has an implementation of the program_options library
+ *  that has no provision for allowing unregistered options to pass by.
+ *
+ *  But that means that, if you have a program that loads optional modules
+ *  after start-up, and those modules each have their own set of options,
+ *  then if you parse the command line too soon, you will get spurious
+ *  reports of unrecognized options -- and the program will exit!
+ *
+ *  And we must process the command-line before module-loading, because we
+ *  need to look at the "bootstrap" options.
+ *
+ *  This conditional code:
+ *
+ *      1. implements it's own functor class, derived from the Boost
+ *         "options_description_easy_init" class.  This functor is used
+ *         to process added options and do the functor chaining, so that
+ *         I can snoop on the arguments before doing an explicit call
+ *         to its parent.
+ *
+ *      2. It implements two static vectors, one to hold long names, and
+ *         one for short names, so that options declared by modules are
+ *         not forgotten when their options_description goes out of scope.
+ *
+ *  I will be thrilled to personally delete this code if we ever decide
+ *  that qpid doesn't really need to support this antique version of Boost.
+ *
+ */
+
+#if ( BOOST_VERSION == 103200 )
+struct Options;
+
+
+struct
+options_description_less_easy_init
+  : public po::options_description_easy_init
+{
+  options_description_less_easy_init ( Options * my_owner,
+                                       po::options_description * my_parents_owner
+                                     )
+    : po::options_description_easy_init(my_parents_owner)
+  {
+    owner = my_owner;
+  }
+
+
+  options_description_less_easy_init&
+  operator()(char const * name,
+             char const * description);
+
+
+  options_description_less_easy_init&
+  operator()(char const * name,
+             const po::value_semantic* s);
+
+
+  options_description_less_easy_init&
+  operator()(const char* name,
+             const po::value_semantic* s,
+             const char* description);
+
+
+  Options * owner;
+};
+#endif
+
+
+struct Options : public po::options_description {
+
+    struct Exception : public qpid::Exception {
+        Exception(const std::string& msg) : qpid::Exception(msg) {}
+    };
+
+    QPID_COMMON_EXTERN Options(const std::string& name=std::string());
+
+    /**
+     * Parses options from argc/argv, environment variables and config file.
+     * Note the filename argument can reference an options variable that
+     * is updated by argc/argv or environment variable parsing.
+     */
+    QPID_COMMON_EXTERN void parse(int argc, char const* const* argv,
+               const std::string& configfile=std::string(),
+               bool  allowUnknown = false);
+
+
+  #if ( BOOST_VERSION == 103200 )
+  options_description_less_easy_init m_less_easy;
+
+  options_description_less_easy_init addOptions() {
+      return m_less_easy;
+  }
+
+  bool
+  is_registered_option ( std::string s );
+
+  void
+  register_names ( std::string s );
+
+  static std::vector<std::string> long_names;
+  static std::vector<std::string> short_names;
+  #else
+  boost::program_options::options_description_easy_init addOptions() {
+      return add_options();
+  }
+  #endif
+};
+
+
+
+/**
+ * Standard options for configuration
+ */
+struct CommonOptions : public Options {
+    QPID_COMMON_EXTERN CommonOptions(const std::string& name=std::string(),
+                  const std::string& configfile=std::string());
+    bool help;
+    bool version;
+    std::string config;
+};
+
+
+
+
+} // namespace qpid
+
+#endif  /*!QPID_COMMONOPTIONS_H*/