qconfig.cxx

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#include <cstdio>
#include <cstdlib>
#include <memory.h>
#include <utility>
#include <vector>
#include <functional>
#include <iostream>
#include <tuple>
#include "qconfig.h"
#include "qconfig_helpers.h"
#include "qconfig_internal_helpers.h"
 
// Create config instances
#define QCONFIG_PARSER_CXX
#define QCONFIG_INSTANCE
#include "qconfig_internal.h"
#undef QCONFIG_INSTANCE
 
namespace qConfig
{
 
static inline const char* getOptName(const char** argv, int32_t i)
{
  while (i > 1 && argv[i][0] != '-') {
    i--;
  }
  return (argv[i]);
}
 
template <typename T>
struct qConfigSettings {
  qConfigSettings() : checkMin(false), checkMax(false), doSet(false), doDefault(false), min(), max(), set(), message(nullptr), allowEmpty(false) {};
  template <typename S>
  qConfigSettings(const qConfigSettings<S> v) : checkMin(false), checkMax(false), doSet(false), doDefault(false), min(), max(), set(), message(v.message), allowEmpty(v.allowEmpty){};
  bool checkMin, checkMax;
  bool doSet, doDefault;
  T min, max;
  T set;
  const char* message;
  bool allowEmpty;
};
 
template <typename T>
static int32_t qAddOptionType(qConfigSettings<T>& settings, T& ref, int32_t& i, const char** argv, const int argc, T def);
template <typename T>
static void qAddOptionMessage(qConfigSettings<T>& settings, T& ref);
template <typename T>
static int32_t qAddOptionMinMax(qConfigSettings<T>& settings, T& ref, const char* arg);
 
template <typename T>
struct qSettingsType {
  typedef T settingsType;
};
template <typename... X>
struct qSettingsType<std::tuple<X...>> {
  typedef int32_t settingsType;
};
 
template <typename T>
struct qConfigTypeSpecialized {
  static inline int32_t qAddOptionMain(qConfigSettings<T>& settings, T& ref, int32_t& i, const char** argv, const int argc, T def);
};
template <typename... X>
struct qConfigTypeSpecialized<std::tuple<X...>> {
  static inline int32_t qAddOptionMain(qConfigSettings<typename qSettingsType<std::tuple<X...>>::settingsType>& settings, std::tuple<X...>& ref, int32_t& i, const char** argv, const int argc, std::tuple<X...>& def);
};
 
// Main processing function for arguments
template <class T>
inline int32_t qConfigTypeSpecialized<T>::qAddOptionMain(qConfigSettings<T>& settings, T& ref, int32_t& i, const char** argv, const int argc, T def)
{
  int32_t retVal = 0;
  int32_t iOrg = i;
  if (settings.doSet) {
    ref = settings.set;
  } else if ((retVal = qAddOptionType<T>(settings, ref, i, argv, argc, def))) {
    return (retVal);
  }
  if ((retVal = qAddOptionMinMax<T>(settings, ref, iOrg < argc ? argv[iOrg] : ""))) {
    return (retVal);
  }
  qAddOptionMessage<T>(settings, ref);
  return (0);
}
template <typename T>
static inline int32_t qAddOptionMainTupleElem(qConfigSettings<typename qSettingsType<T>::settingsType> settingsTup, T& ref, int32_t& i, const char** argv, const int argc)
{
  T def = T();
  qConfigSettings<T> settings = settingsTup;
  return (qAddOptionType<T>(settings, ref, i, argv, argc, def));
}
template <typename T, int32_t index = 0, int32_t left = std::tuple_size_v<T>>
struct qAddOptionMainTupleStruct {
  static inline int32_t qAddOptionMainTuple(qConfigSettings<typename qSettingsType<T>::settingsType> settings, T& tup, int32_t& i, const char** argv, const int argc)
  {
    auto& ref = std::get<index>(tup);
    int32_t retVal = qAddOptionMainTupleElem(settings, ref, i, argv, argc);
    if (retVal) {
      if (retVal == qcrArgMissing && index != 0) {
        printf("Invalid number of arguments for option %s\n", getOptName(argv, i));
        retVal = qcrArgIncomplete;
      }
      return (retVal);
    }
    return (qAddOptionMainTupleStruct<T, index + 1, left - 1>::qAddOptionMainTuple(settings, tup, i, argv, argc));
  }
};
template <typename T, int32_t index>
struct qAddOptionMainTupleStruct<T, index, 0> {
  static inline int32_t qAddOptionMainTuple(qConfigSettings<typename qSettingsType<T>::settingsType> /*settings*/, T& /*tup*/, int32_t& /*i*/, const char** /*argv*/, const int32_t /*argc*/) { return 0; }
};
template <typename... X>
inline int32_t qConfigTypeSpecialized<std::tuple<X...>>::qAddOptionMain(qConfigSettings<typename qSettingsType<std::tuple<X...>>::settingsType>& settings, std::tuple<X...>& ref, int32_t& i, const char** argv, const int argc, std::tuple<X...>& /*def*/)
{
  return (qAddOptionMainTupleStruct<std::tuple<X...>>::qAddOptionMainTuple(settings, ref, i, argv, argc));
}
 
template <typename T>
struct qConfigType {
  // Recursive handling of additional settings
  static inline void qProcessSetting(qConfigSettings<T>& settings, qmin_t<T> minval)
  {
    static_assert(!std::is_same_v<T, bool>, "min option not supported for boolean settings");
    settings.checkMin = true;
    settings.min = minval.v;
  }
  static inline void qProcessSetting(qConfigSettings<T>& settings, qmax_t<T> maxval)
  {
    static_assert(!std::is_same_v<T, bool>, "max option not supported for boolean settings");
    settings.checkMax = true;
    settings.max = maxval.v;
  }
  static inline void qProcessSetting(qConfigSettings<T>& settings, qmessage_t msg) { settings.message = msg.v; }
  template <typename S>
  static inline void qProcessSetting(qConfigSettings<T>& settings, qset_t<S> set)
  {
    settings.doSet = true;
    settings.set = set.v;
  }
  template <typename S>
  static inline void qProcessSetting(qConfigSettings<T>& settings, qdef_t<S> set)
  {
    settings.doDefault = true;
    settings.set = set.v;
  }
 
  static inline void qAddOptionSettings(qConfigSettings<T>& /*settings*/) {}
  template <typename Arg1, typename... Args>
  static inline void qAddOptionSettings(qConfigSettings<T>& settings, Arg1&& arg1, Args&&... args)
  {
    qProcessSetting(settings, arg1);
    qAddOptionSettings(settings, args...);
  }
 
  template <typename... Args>
  static inline int32_t qAddOption(T& ref, int32_t& i, const char** argv, const int argc, T def, const char* /*help*/, Args&&... args)
  {
    auto settings = qConfigGetSettings(args...);
    return qConfigTypeSpecialized<T>::qAddOptionMain(settings, ref, i, argv, argc, def);
  }
 
  template <typename... Args>
  static inline int32_t qAddOptionVec(std::vector<T>& ref, int32_t& i, const char** argv, const int argc, const char* /*help*/, Args&&... args)
  {
    auto settings = qConfigGetSettings(args...);
    int32_t iFirst = i, iLast;
    do {
      iLast = i;
      T tmp = T(), def = T();
      settings.allowEmpty = (i != iFirst);
      int32_t retVal = qConfigTypeSpecialized<T>::qAddOptionMain(settings, tmp, i, argv, argc, def);
      if (retVal) {
        return (retVal != qcrArgMissing || i == iFirst ? retVal : 0);
      }
      if (i == iFirst || i != iLast) {
        ref.push_back(tmp);
      }
    } while (i != iLast);
    return (0);
  }
 
  template <typename... Args>
  static inline int32_t qAddOptionArray(T* ref, int32_t count, int32_t& i, const char** argv, const int argc, const char* /*help*/, Args&&... args)
  {
    auto settings = qConfigGetSettings(args...);
    int32_t iFirst = i, iLast;
    do {
      iLast = i;
      T tmp = T(), def = T();
      settings.allowEmpty = (i != iFirst);
      int32_t retVal = qConfigTypeSpecialized<T>::qAddOptionMain(settings, tmp, i, argv, argc, def);
      if (retVal) {
        return (retVal != qcrArgMissing || i == iFirst ? retVal : 0);
      }
      if (i - iFirst >= count) {
        printf("Too many values provided for option %s\n", getOptName(argv, i));
        return (qcrArrayOverflow);
      }
      if (i == iFirst || i != iLast) {
        ref[i - iFirst] = tmp;
      }
    } while (i != iLast);
    return (0);
  }
 
  template <typename... Args>
  static inline void qConfigHelpOption(const char* name, const char* type, const char* def, const char* optname, char optnameshort, const char* preopt, char preoptshort, int32_t optionType, const char* help, Args&&... args)
  {
    auto settings = qConfigGetSettings(args...);
    const bool boolType = optionType != 1 && std::is_same_v<T, bool>;
    const char* arguments = settings.doSet ? " (" : (settings.doDefault || optionType == 1 || boolType) ? " [arg] (" : optionType == 2 ? " [...] (" : " arg (";
    char argBuffer[4] = {0};
    uint32_t argBufferPos = 0;
    if (optnameshort && preoptshort) {
      argBuffer[argBufferPos++] = '-';
    }
    if (optnameshort) {
      argBuffer[argBufferPos++] = preoptshort == 0 ? '-' : preoptshort;
      argBuffer[argBufferPos++] = optnameshort;
    }
    std::cout << "\t" << name << ": " << argBuffer << (optnameshort == 0 ? "" : arguments) << "--";
    if (optname[0] == 0) {
      std::cout << preopt << name;
    } else {
      std::cout << optname;
    }
    std::cout << (optnameshort == 0 ? arguments : ", ") << "type: " << type;
    if (optionType == 0) {
      std::cout << ", default: " << def;
    }
    if (optionType == 1) {
      std::cout << ", sets " << name << " to " << def;
    }
    if (settings.checkMin) {
      std::cout << ", minimum: " << settings.min;
    }
    if (settings.checkMax) {
      std::cout << ", maximum: " << settings.max;
    }
    std::cout << ")\n\t\t" << help << ".\n";
    if (settings.doSet) {
      std::cout << "\t\tSets " << name << " to " << settings.set << ".\n";
    } else if (settings.doDefault) {
      std::cout << "\t\tIf no argument is supplied, " << name << " is set to " << settings.set << ".\n";
    } else if (boolType) {
      std::cout << "\t\tIf no argument is supplied, " << name << " is set to true.\n";
    }
    if (optionType == 2) {
      std::cout << "\t\tCan be set multiple times, accepts multiple arguments.\n";
    }
    std::cout << "\n";
  }
 
  template <typename... Args>
  static inline auto qConfigGetSettings(Args&... args)
  {
    qConfigSettings<typename qSettingsType<T>::settingsType> settings;
    qConfigType<typename qSettingsType<T>::settingsType>::qAddOptionSettings(settings, args...);
    return (settings);
  }
};
 
static inline const char* getArg(int32_t& i, const char** argv, const int argc, bool allowOption = false)
{
  if (i + 1 < argc && argv[i + 1][0] && ((allowOption && argv[i + 1][0] == '-' && argv[i + 1][1] != '-') || argv[i + 1][0] != '-')) {
    return (argv[++i]);
  }
  return (nullptr);
}
 
template <class T>
static inline int32_t qAddOptionGeneric(qConfigSettings<T>& settings, T& ref, int32_t& i, const char** argv, const int argc, T def, std::function<T(const char*)> func, bool allowDefault = false)
{
  const char* arg = getArg(i, argv, argc, !allowDefault);
  if (arg) {
    ref = func(arg);
    return (0);
  } else if (allowDefault) {
    ref = def;
    return (0);
  }
  if (!settings.allowEmpty) {
    printf("Argument missing for option %s!\n", getOptName(argv, i));
  }
  return (qcrArgMissing);
}
 
// Handling of all supported types
template <>
inline int32_t qAddOptionType<bool>(qConfigSettings<bool>& settings, bool& ref, int32_t& i, const char** argv, const int argc, bool /*def*/)
{
  return qAddOptionGeneric<bool>(
    settings, ref, i, argv, argc, settings.doDefault ? settings.set : true, [](const char* a) -> bool {
      return atoi(a);
    },
    true);
}
template <>
inline int32_t qAddOptionType<int8_t>(qConfigSettings<int8_t>& settings, int8_t& ref, int32_t& i, const char** argv, const int argc, int8_t /*def*/)
{
  return qAddOptionGeneric<int8_t>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> int8_t {
      return atoi(a);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<uint8_t>(qConfigSettings<uint8_t>& settings, uint8_t& ref, int32_t& i, const char** argv, const int argc, uint8_t /*def*/)
{
  return qAddOptionGeneric<uint8_t>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> uint8_t {
      return atoi(a);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<int32_t>(qConfigSettings<int32_t>& settings, int32_t& ref, int32_t& i, const char** argv, const int argc, int32_t /*def*/)
{
  return qAddOptionGeneric<int32_t>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> int32_t {
      return atoi(a);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<uint32_t>(qConfigSettings<uint32_t>& settings, uint32_t& ref, int32_t& i, const char** argv, const int argc, uint32_t /*def*/)
{
  return qAddOptionGeneric<uint32_t>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> uint32_t {
      return strtoul(a, nullptr, 0);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<int16_t>(qConfigSettings<int16_t>& settings, int16_t& ref, int32_t& i, const char** argv, const int argc, int16_t /*def*/)
{
  return qAddOptionGeneric<int16_t>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> int16_t {
      return atoi(a);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<uint16_t>(qConfigSettings<uint16_t>& settings, uint16_t& ref, int32_t& i, const char** argv, const int argc, uint16_t /*def*/)
{
  return qAddOptionGeneric<uint16_t>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> uint16_t {
      return strtoul(a, nullptr, 0);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<int64_t>(qConfigSettings<int64_t>& settings, int64_t& ref, int32_t& i, const char** argv, const int argc, int64_t /*def*/)
{
  return qAddOptionGeneric<int64_t>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> int64_t {
      return strtoll(a, nullptr, 0);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<uint64_t>(qConfigSettings<uint64_t>& settings, uint64_t& ref, int32_t& i, const char** argv, const int argc, uint64_t /*def*/)
{
  return qAddOptionGeneric<uint64_t>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> uint64_t {
      return strtoull(a, nullptr, 0);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<float>(qConfigSettings<float>& settings, float& ref, int32_t& i, const char** argv, const int argc, float /*def*/)
{
  return qAddOptionGeneric<float>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> float {
      return (float)atof(a);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<double>(qConfigSettings<double>& settings, double& ref, int32_t& i, const char** argv, const int argc, double /*def*/)
{
  return qAddOptionGeneric<double>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> double {
      return atof(a);
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<const char*>(qConfigSettings<const char*>& settings, const char*& ref, int32_t& i, const char** argv, const int argc, const char* /*def*/)
{
  return qAddOptionGeneric<const char*>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> const char* {
      return a;
    },
    settings.doDefault);
}
template <>
inline int32_t qAddOptionType<std::string>(qConfigSettings<std::string>& settings, std::string& ref, int32_t& i, const char** argv, const int argc, std::string /*def*/)
{
  return qAddOptionGeneric<std::string>(
    settings, ref, i, argv, argc, settings.set, [](const char* a) -> std::string {
      return a;
    },
    settings.doDefault);
}
 
// Checks and messages for additional settings
template <typename T>
static inline int32_t qAddOptionMinMax(qConfigSettings<T>& settings, T& ref, const char* arg)
{
  if (settings.checkMin && ref < settings.min) {
    std::cout << "Invalid setting for " << arg << ": minimum threshold exceeded (" << ref << " < " << settings.min << ")!\n";
    return (qcrMinFailure);
  }
  if (settings.checkMax && ref > settings.max) {
    std::cout << "Invalid setting for " << arg << ": maximum threshold exceeded (" << ref << " > " << settings.max << ")!\n";
    return (qcrMaxFailure);
  }
  return (0);
}
template <>
inline int32_t qAddOptionMinMax<bool>(qConfigSettings<bool>& /*settings*/, bool& /*ref*/, const char* /*arg*/)
{
  return (0);
}
 
template <typename T>
inline void qAddOptionMessage(qConfigSettings<T>& settings, T& ref)
{
  if (settings.message) {
    std::string tmp = print_type(ref);
    std::string msg = std::string(settings.message) + "\n";
    printf(msg.c_str(), tmp.c_str());
  }
}
 
static inline void qConfigHelp(const char* subConfig = nullptr, int32_t followSub = 0)
{
  if (followSub < 2) {
    printf("Usage Info:");
  }
#define QCONFIG_HELP
#include "qconfig_internal.h"
#undef QCONFIG_HELP
  if (followSub < 2) {
    printf("\n");
  }
}
 
// Create parser for configuration
int32_t qConfigParse(int argc, const char** argv, const char* /*filename*/)
{
  for (int32_t i = 1; i < argc; i++) {
    const char* thisoption = argv[i];
  repeat:
    bool found = false;
#define QCONFIG_PARSE
#include "qconfig_internal.h"
#undef QCONFIG_PARSE
    if (found == false) {
      printf("Invalid argument: %s\n", argv[i]);
      return (1);
      goto repeat; // Suppress GCC warnings, this is never executed, label might be accessed from qconfig.h
    }
  }
  return (0);
}
 
std::vector<std::function<void()>> qprint_global;
#define QCONFIG_PRINT
#include "qconfig_internal.h"
#undef QCONFIG_PRINT
 
void qConfigPrint()
{
  for (auto& f : qprint_global) {
    f();
  }
}
} // end namespace qConfig