CapabilityUtils.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "StreamArguments.h"

#include <exception>
#include <variant>
#include <string>
#include <sstream>
#include <tuple>
#include <map>

namespace CapabilityUtils
{

class CapabilityException : public std::runtime_error
{
public:
  CapabilityException(const CapabilityException &) = default;

  template <typename... Args>
  static std::string stringify(Args &&... args)
  {
    std::ostringstream ss;
    streamArguments(ss, args...);
    return ss.str();
  }

  template <typename... Args>
  explicit CapabilityException(Args &&... args) : std::runtime_error(stringify(args...))
  {
  }

  ~CapabilityException() throw() {}
};

enum CheckState
{
  CERTAIN_FAIL = 0,
  POSSIBLE_FAIL = 1,
  UNKNOWN = 2,
  POSSIBLE_PASS = 3,
  CERTAIN_PASS = 4,
  PARSE_FAIL = 5
};

typedef std::variant<bool, int, std::string> Type;
typedef std::tuple<CheckState, std::string, std::string> Result;
typedef std::map<std::string, std::pair<Type, std::string>> Registry;

Result check(std::string requirements, const Registry & capabilities);

} // namespace CapabilityUtils