DDS  ver. 1.6
dds-commander/src/Options.h
Go to the documentation of this file.
1 // Copyright 2014 GSI, Inc. All rights reserved.
2 //
3 //
4 //
5 #ifndef DDSOPTIONS_H
6 #define DDSOPTIONS_H
7 //=============================================================================
8 // BOOST
9 #include <boost/program_options/options_description.hpp>
10 #include <boost/program_options/parsers.hpp>
11 // DDS
12 #include "ProtocolCommands.h"
13 #include "Res.h"
14 #include "SubmitCmd.h"
15 #include "version.h"
16 //=============================================================================
17 namespace bpo = boost::program_options;
18 //=============================================================================
19 namespace dds
20 {
21  namespace commander_cmd
22  {
24  typedef struct SOptions
25  {
26  enum ECommands
27  {
31  };
34  {
35  }
36 
37  static ECommands getCommandByName(const std::string& _name)
38  {
39  if ("start" == _name)
40  return cmd_start;
41  if ("stop" == _name)
42  return cmd_stop;
43 
44  return cmd_unknown;
45  }
46 
48  std::string m_sTopoFile;
50  std::string m_sRMS;
51  std::string m_sCfgFile;
52  } SOptions_t;
53  //=============================================================================
54  inline void PrintVersion()
55  {
56  LOG(MiscCommon::log_stdout) << " v" << PROJECT_VERSION_STRING << "\n"
57  << "DDS configuration"
58  << " v" << USER_DEFAULTS_CFG_VERSION << "\n"
60  }
61  //=============================================================================
62  // Command line parser
63  inline bool ParseCmdLine(int _argc, char* _argv[], SOptions* _options) throw(std::exception)
64  {
65  if (nullptr == _options)
66  throw std::runtime_error("Internal error: options' container is empty.");
67 
68  // Generic options
69  bpo::options_description options("dds-commander options");
70  options.add_options()("help,h", "Produce help message");
71  options.add_options()("version,v", "Version information");
72  options.add_options()(
73  "command",
74  bpo::value<std::string>(),
75  "The command is a name of a dds-commander command."
76  " Can be one of the following: start, and stop.\n"
77  "For user's convenience it is allowed to call dds-commander without \"--command\" option"
78  " by just specifying the command name directly, like:\ndds-commander start or dds-commander stop.\n\n"
79  "Commands:\n"
80  " start: \tStart dds-commander daemon\n"
81  " stop: \tStop dds-commander daemon\n");
82 
83  //...positional
84  bpo::positional_options_description pd;
85  pd.add("command", 1);
86 
87  // Parsing command-line
88  bpo::variables_map vm;
89  bpo::store(bpo::command_line_parser(_argc, _argv).options(options).positional(pd).run(), vm);
90  bpo::notify(vm);
91 
92  if (vm.count("help") || vm.empty())
93  {
94  LOG(MiscCommon::log_stdout) << options;
95  return false;
96  }
97  if (vm.count("version"))
98  {
99  PrintVersion();
100  return false;
101  }
102 
103  // Command
104  if (vm.count("command"))
105  {
106  if (SOptions::cmd_unknown == SOptions::getCommandByName(vm["command"].as<std::string>()))
107  {
108  LOG(MiscCommon::log_stderr) << "unknown command: " << vm["command"].as<std::string>() << "\n\n"
109  << options;
110  return false;
111  }
112  }
113  else
114  {
115  LOG(MiscCommon::log_stderr) << "Nothing to do\n\n" << options;
116  return false;
117  }
118 
119  _options->m_Command = SOptions::getCommandByName(vm["command"].as<std::string>());
120 
121  return true;
122  }
123  }
124 }
125 #endif
Definition: def.h:156
Definition: def.h:154
SOptions()
Definition: dds-commander/src/Options.h:32
ECommands
Definition: dds-commander/src/Options.h:26
bool ParseCmdLine(int _argc, char *_argv[], SOptions *_options)
Definition: dds-commander/src/Options.h:63
#define LOG(severity)
Definition: Logger.h:54
std::string m_sRMS
Definition: dds-commander/src/Options.h:50
std::string m_sTopoFile
Definition: dds-commander/src/Options.h:48
const LPCSTR g_cszReportBugsAddr("Report bugs/comments to fairroot@gsi.de")
struct dds::commander_cmd::SOptions SOptions_t
dds-commander&#39;s container of options
Definition: dds-agent/src/AgentConnectionManager.h:16
Definition: dds-commander/src/Options.h:30
dds-commander&#39;s container of options
Definition: dds-commander/src/Options.h:24
void PrintVersion()
Definition: dds-commander/src/Options.h:54
std::string m_sCfgFile
Definition: dds-commander/src/Options.h:51
bool m_needCommanderPid
Definition: dds-commander/src/Options.h:49
ECommands m_Command
Definition: dds-commander/src/Options.h:47
static ECommands getCommandByName(const std::string &_name)
Definition: dds-commander/src/Options.h:37
Definition: dds-commander/src/Options.h:29
Definition: dds-commander/src/Options.h:28