command_args.cpp

Go to the documentation of this file.

// g2o - General Graph Optimization
// Copyright (C) 2011 R. Kuemmerle, G. Grisetti, W. Burgard
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
//   notice, this list of conditions and the following disclaimer in the
//   documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
#include "command_args.h"
 
#include <algorithm>
#include <cstdlib>
#include <cstring>
#include <fstream>
#include <functional>
 
#include "misc.h"
#include "os_specific.h"
#include "string_tools.h"
using namespace std;
 
namespace g2o {
 
namespace {
 
template <typename T>
void readVector(const std::string& s, std::vector<T>& v) {
  v.clear();
 
  std::vector<std::string> elements = strSplit(s, ",;");
  for (const std::string& s : elements) {
    T val = stringToType<T>(s);
    v.emplace_back(val);
  }
}
 
template <typename T>
std::string writeVectorAsString(const std::vector<T>& v) {
  std::stringstream os;
  if (v.size()) os << v[0];
  for (size_t i = 1; i < v.size(); i++) os << "," << v[i];
  return os.str();
}
 
template <typename T>
void parseArgument(const std::string& input, CommandArgs::CommandArgument& ca) {
  T aux;
  bool convertStatus = convertString(input, aux);
  if (convertStatus) {
    T* data = static_cast<T*>(ca.data);
    *data = aux;
  }
}
 
template <typename T>
void parseVector(const std::string& input, CommandArgs::CommandArgument& ca) {
  std::vector<T> aux;
  readVector(input, aux);
  bool convertStatus = aux.size() > 0;
  if (convertStatus) {
    std::vector<T>* data = static_cast<std::vector<T>*>(ca.data);
    *data = aux;
  }
}
 
template <typename T>
std::string argument2String(const CommandArgs::CommandArgument& ca) {
  T* data = static_cast<T*>(ca.data);
  stringstream auxStream;
  auxStream << *data;
  return auxStream.str();
}
 
}  // namespace
 
enum CommandArgumentType {
  CAT_DOUBLE,
  CAT_FLOAT,
  CAT_INT,
  CAT_STRING,
  CAT_BOOL,
  CAT_VECTOR_INT,
  CAT_VECTOR_DOUBLE
};
 
CommandArgs::~CommandArgs() {}
 
bool CommandArgs::parseArgs(int argc, char** argv, bool exitOnError) {
  _progName = argv[0];
  int i;
  for (i = 1; i < argc; i++) {
    string name = argv[i];
 
    if (name[0] != '-') {  // each param has to start with at least one dash
      // cerr << "Error: expecting parameter, got " << name << endl;
      // printHelp(cerr);
      // if (exitOnError)
      // exit(1);
      // return false;
      break;
    }
    /* first check whether it's -- and we should not continue parsing */
    if (name == "--") {
      ++i;
      break;
    }
 
    string::size_type dashPos = name.find_first_not_of('-');
    if (dashPos != string::npos) name = name.substr(dashPos);
 
    if (name == "help" || name == "h") {
      printHelp(cout);
      exit(0);
    } else {
      // command line argument parsing
      std::vector<CommandArgument>::iterator it = _args.begin();
      for (; it != _args.end(); ++it) {
        if (it->name == name) {
          if (it->type == CAT_BOOL) {
            if (!it->parsed) {
              bool* data = static_cast<bool*>(it->data);
              *data = !(*data);
            }
            it->parsed = true;
          } else {
            if (i >= argc - 1) {
              cerr << "Argument " << name << "needs value.\n";
              printHelp(cerr);
              if (exitOnError) exit(1);
              return false;
            }
            i++;
            str2arg(argv[i], *it);
            it->parsed = true;
          }
          break;
        }
      }
      if (it == _args.end()) {
        cerr << "Error: Unknown Option '" << name
             << "' (use -help to get list of options).\n";
        if (exitOnError) exit(1);
        return false;
      }
    }
  }  // for argv[i]
 
  if ((int)_leftOvers.size() > argc - i) {
    cerr << "Error: program requires parameters" << endl;
    printHelp(cerr);
    if (exitOnError) exit(1);
    return false;
  }
  for (size_t j = 0; (i < argc && j < _leftOvers.size()); i++, j++) {
    string* s = static_cast<string*>(_leftOvers[j].data);
    *s = argv[i];
    _leftOvers[j].parsed = true;
  }
 
  // the optional leftOvers
  for (size_t j = 0; (i < argc && j < _leftOversOptional.size()); i++, j++) {
    string* s = static_cast<string*>(_leftOversOptional[j].data);
    *s = argv[i];
    _leftOversOptional[j].parsed = true;
  }
 
  return true;
}
 
void CommandArgs::param(const std::string& name, bool& p, bool defValue,
                        const std::string& desc) {
  CommandArgument ca;
  ca.name = name;
  ca.description = desc;
  ca.type = CAT_BOOL;
  ca.data = static_cast<void*>(&p);
  ca.parsed = false;
  p = defValue;
  _args.push_back(ca);
}
 
void CommandArgs::param(const std::string& name, int& p, int defValue,
                        const std::string& desc) {
  CommandArgument ca;
  ca.name = name;
  ca.description = desc;
  ca.type = CAT_INT;
  ca.data = static_cast<void*>(&p);
  ca.parsed = false;
  p = defValue;
  _args.push_back(ca);
}
 
void CommandArgs::param(const std::string& name, float& p, float defValue,
                        const std::string& desc) {
  CommandArgument ca;
  ca.name = name;
  ca.description = desc;
  ca.type = CAT_FLOAT;
  ca.data = static_cast<void*>(&p);
  ca.parsed = false;
  p = defValue;
  _args.push_back(ca);
}
 
void CommandArgs::param(const std::string& name, double& p, double defValue,
                        const std::string& desc) {
  CommandArgument ca;
  ca.name = name;
  ca.description = desc;
  ca.type = CAT_DOUBLE;
  ca.data = static_cast<void*>(&p);
  ca.parsed = false;
  p = defValue;
  _args.push_back(ca);
}
 
void CommandArgs::param(const std::string& name, std::string& p,
                        const std::string& defValue, const std::string& desc) {
  CommandArgument ca;
  ca.name = name;
  ca.description = desc;
  ca.type = CAT_STRING;
  ca.data = static_cast<void*>(&p);
  ca.parsed = false;
  p = defValue;
  _args.push_back(ca);
}
 
void CommandArgs::param(const std::string& name, std::vector<int>& p,
                        const std::vector<int>& defValue,
                        const std::string& desc) {
  CommandArgument ca;
  ca.name = name;
  ca.description = desc;
  ca.type = CAT_VECTOR_INT;
  ca.data = static_cast<void*>(&p);
  ca.parsed = false;
  p = defValue;
  _args.push_back(ca);
}
 
void CommandArgs::param(const std::string& name, std::vector<double>& p,
                        const std::vector<double>& defValue,
                        const std::string& desc) {
  CommandArgument ca;
  ca.name = name;
  ca.description = desc;
  ca.type = CAT_VECTOR_DOUBLE;
  ca.data = static_cast<void*>(&p);
  ca.parsed = false;
  p = defValue;
  _args.push_back(ca);
}
 
void CommandArgs::printHelp(std::ostream& os) {
  if (_banner.size()) os << _banner << endl;
  os << "Usage: " << _progName << (_args.size() > 0 ? " [options] " : " ");
  if (_leftOvers.size() > 0) {
    for (size_t i = 0; i < _leftOvers.size(); ++i) {
      if (i > 0) os << " ";
      os << _leftOvers[i].name;
    }
  }
  if (_leftOversOptional.size() > 0) {
    if (_leftOvers.size() > 0) os << " ";
    for (size_t i = 0; i < _leftOversOptional.size(); ++i) {
      if (i > 0) os << " ";
      os << "[" << _leftOversOptional[i].name << "]";
    }
  }
  os << endl << endl;
  os << "General options:" << endl;
  os << "-------------------------------------------" << endl;
  os << "-help / -h           Displays this help." << endl << endl;
  if (_args.size() > 0) {
    os << "Program Options:" << endl;
    os << "-------------------------------------------" << endl;
    // build up option string to print as table
    vector<pair<string, string> > tableStrings;
    tableStrings.reserve(_args.size());
    size_t maxArgLen = 0;
    for (size_t i = 0; i < _args.size(); ++i) {
      if (_args[i].type != CAT_BOOL) {
        string defaultValueStr = arg2str(_args[i]);
        if (!defaultValueStr.empty())
          tableStrings.push_back(make_pair(
              _args[i].name + " " + type2str(_args[i].type),
              _args[i].description + " (default: " + defaultValueStr + ")"));
        else
          tableStrings.push_back(
              make_pair(_args[i].name + " " + type2str(_args[i].type),
                        _args[i].description));
      } else
        tableStrings.push_back(make_pair(_args[i].name, _args[i].description));
      maxArgLen = (std::max)(maxArgLen, tableStrings.back().first.size());
    }
    sort(tableStrings.begin(), tableStrings.end(),
         CmpPairFirst<string, string>());
    maxArgLen += 3;
    for (size_t i = 0; i < tableStrings.size(); ++i) {
      os << "-" << tableStrings[i].first;
      for (size_t l = tableStrings[i].first.size(); l < maxArgLen; ++l)
        os << " ";
      os << tableStrings[i].second << endl;
    }
    // TODO should output description for leftOver params?
  }
}
 
void CommandArgs::setBanner(const std::string& banner) { _banner = banner; }
 
void CommandArgs::paramLeftOver(const std::string& name, std::string& p,
                                const std::string& defValue,
                                const std::string& desc, bool optional) {
  CommandArgument ca;
  ca.name = name;
  ca.description = desc;
  ca.type = CAT_STRING;
  ca.data = static_cast<void*>(&p);
  ca.parsed = false;
  ca.optional = optional;
  p = defValue;
  if (optional)
    _leftOversOptional.push_back(ca);
  else
    _leftOvers.push_back(ca);
}
 
const char* CommandArgs::type2str(int t) const {
  switch (t) {
    case CAT_DOUBLE:
      return "<double>";
    case CAT_FLOAT:
      return "<float>";
    case CAT_INT:
      return "<int>";
    case CAT_STRING:
      return "<string>";
    case CAT_BOOL:
      return "<bool>";
    case CAT_VECTOR_INT:
      return "<vector_int>";
    case CAT_VECTOR_DOUBLE:
      return "<vector_double>";
  }
  return "";
}
 
void CommandArgs::str2arg(const std::string& input, CommandArgument& ca) const {
  switch (ca.type) {
    case CAT_FLOAT:
      parseArgument<float>(input, ca);
      break;
    case CAT_DOUBLE:
      parseArgument<double>(input, ca);
      break;
    case CAT_INT:
      parseArgument<int>(input, ca);
      break;
    case CAT_BOOL:
      parseArgument<bool>(input, ca);
      break;
    case CAT_STRING: {
      string* data = static_cast<string*>(ca.data);
      *data = input;
    } break;
    case CAT_VECTOR_INT: {
      parseVector<int>(input, ca);
    } break;
    case CAT_VECTOR_DOUBLE: {
      parseVector<double>(input, ca);
    } break;
  }
}
 
std::string CommandArgs::arg2str(const CommandArgument& ca) const {
  switch (ca.type) {
    case CAT_FLOAT:
      return argument2String<float>(ca);
    case CAT_DOUBLE:
      return argument2String<double>(ca);
    case CAT_INT:
      return argument2String<int>(ca);
    case CAT_BOOL:
      return argument2String<bool>(ca);
    case CAT_STRING: {
      string* data = static_cast<string*>(ca.data);
      return *data;
    }
    case CAT_VECTOR_INT: {
      std::vector<int>* data = static_cast<std::vector<int>*>(ca.data);
      return writeVectorAsString(*data);
    }
    case CAT_VECTOR_DOUBLE: {
      std::vector<double>* data = static_cast<std::vector<double>*>(ca.data);
      return writeVectorAsString(*data);
    }
  }
  return "";
}
 
bool CommandArgs::parsedParam(const std::string& param) const {
  std::vector<CommandArgument>::const_iterator it = _args.begin();
  for (; it != _args.end(); ++it) {
    if (it->name == param) {
      return it->parsed;
    }
  }
  return false;
}
 
}  // end namespace g2o