Make wrapper device capable of handling boost program options

- Getter for custom options of device and component
- Building component command line options from the boost variable map

Author: matthiasrichter

Utilities/aliceHLTwrapper/include/aliceHLTwrapper/WrapperDevice.h

@@ -5,8 +5,8 @@
 //****************************************************************************
 //* This file is free software: you can redistribute it and/or modify        *
 //* it under the terms of the GNU General Public License as published by     *
-//* the Free Software Foundation, either version 3 of the License, or	     *
-//* (at your option) any later version.					     *
+//* the Free Software Foundation, either version 3 of the License, or        *
+//* (at your option) any later version.                                      *
 //*                                                                          *
 //* Primary Authors: Matthias Richter <richterm@scieq.net>                   *
 //*                                                                          *
@@ -21,6 +21,9 @@
 
 #include <FairMQDevice.h>
 #include <vector>
+#include <boost/program_options.hpp>
+
+namespace bpo = boost::program_options;
 
 class FairMQMessage;
 
@@ -38,10 +41,13 @@ class Component;
 class WrapperDevice : public FairMQDevice {
 public:
   /// default constructor
-  WrapperDevice(int argc, char** argv, int verbosity = 0);
+  WrapperDevice(int verbosity = 0);
   /// destructor
   ~WrapperDevice() override;
 
+  /// get description of options
+  static bpo::options_description GetOptionsDescription();
+
   /////////////////////////////////////////////////////////////////
   // the FairMQDevice interface
 
@@ -82,7 +88,6 @@ class WrapperDevice : public FairMQDevice {
   unsigned char* createMessageBuffer(unsigned size);
 
   Component* mComponent;     // component instance
-  std::vector<char*> mArgv;       // array of arguments for the component
   std::vector<std::unique_ptr<FairMQMessage>> mMessages; // array of output messages
 
   int mPollingPeriod;        // period of polling on input sockets in ms

Utilities/aliceHLTwrapper/src/WrapperDevice.cxx

@@ -1,8 +1,8 @@
 //****************************************************************************
 //* This file is free software: you can redistribute it and/or modify        *
 //* it under the terms of the GNU General Public License as published by     *
-//* the Free Software Foundation, either version 3 of the License, or	     *
-//* (at your option) any later version.					     *
+//* the Free Software Foundation, either version 3 of the License, or        *
+//* (at your option) any later version.                                      *
 //*                                                                          *
 //* Primary Authors: Matthias Richter <richterm@scieq.net>                   *
 //*                                                                          *
@@ -19,6 +19,8 @@
 #include "aliceHLTwrapper/Component.h"
 #include <FairMQLogger.h>
 #include <FairMQPoller.h>
+#include <options/FairProgOptions.h>
+#include <options/FairMQProgOptions.h>
 
 #include <boost/thread.hpp>
 #include <boost/bind.hpp>
@@ -36,9 +38,8 @@ using namespace ALICE::HLT;
 using std::chrono::system_clock;
 using TimeScale = std::chrono::milliseconds;
 
-WrapperDevice::WrapperDevice(int argc, char** argv, int verbosity)
+WrapperDevice::WrapperDevice(int verbosity)
   : mComponent(nullptr)
-  , mArgv()
   , mMessages()
   , mPollingPeriod(10)
   , mSkipProcessing(0)
@@ -51,12 +52,19 @@ WrapperDevice::WrapperDevice(int argc, char** argv, int verbosity)
   , mNSamples(-1)
   , mVerbosity(verbosity)
 {
-  mArgv.insert(mArgv.end(), argv, argv+argc);
 }
 
 WrapperDevice::~WrapperDevice()
 = default;
 
+bpo::options_description WrapperDevice::GetOptionsDescription()
+{
+  // assemble the options for the device class and component
+  bpo::options_description od("WrapperDevice options");
+  od.add(Component::GetOptionsDescription());
+  return od;
+}
+
 void WrapperDevice::Init()
 {
 }
@@ -66,18 +74,55 @@ void WrapperDevice::InitTask()
   /// inherited from FairMQDevice
 
   int iResult=0;
+
   std::unique_ptr<Component> component(new ALICE::HLT::Component);
   if (!component.get()) return /*-ENOMEM*/;
 
+  // loop over program options, check if the option was used and
+  // add it together with the parameter to the argument vector.
+  // would have been easier to iterate over the individual
+  // option_description entires, but options_description does not
+  // provide such a functionality
+  vector<std::string> argstrings;
+  bpo::options_description descriptions = GetOptionsDescription();
+  const auto * config = GetConfig();
+  if (config) {
+    const auto varmap = config->GetVarMap();
+    for (const auto varit : varmap) {
+      // check if this key belongs to the options of the device
+      const auto * description = descriptions.find_nothrow(varit.first, false);
+      if (description && varmap.count(varit.first) && !varit.second.defaulted()) {
+        argstrings.push_back("--");
+        argstrings.back() += varit.first;
+        // check the semantics of the value
+        auto semantic = description->semantic();
+        if (semantic) {
+          // the value semantics allows different properties like
+          // multitoken, zero_token and composing
+          // currently only the simple case is supported
+          assert(semantic->min_tokens() <= 1);
+          assert(semantic->max_tokens() && semantic->min_tokens());
+          if (semantic->min_tokens() > 0 ) {
+            // add the token
+            argstrings.push_back(varit.second.as<std::string>());
+          }
+        }
+      }
+    }
+  }
+
+  // TODO: probably one can get rid of this option, the instance/device
+  // id is now specified with the --id option of FairMQProgOptions
   string idkey="--instance-id";
   string id="";
   id=GetProperty(FairMQDevice::Id, id);
   vector<char*> argv;
-  argv.push_back(mArgv[0]);
   argv.push_back(&idkey[0]);
   argv.push_back(&id[0]);
-  if (mArgv.size()>1)
-    argv.insert(argv.end(), mArgv.begin()+1, mArgv.end());
+  for (auto& argstringiter : argstrings) {
+    argv.push_back(&argstringiter[0]);
+  }
+
   if ((iResult=component->init(argv.size(), &argv[0]))<0) {
     LOG(ERROR) << "component init failed with error code " << iResult;
     throw std::runtime_error("component init failed");