Parser.h

// Copyright 2024, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include <filesystem>
 
#include "neml2/misc/string_utils.h"
#include "neml2/misc/errors.h"
#include "neml2/misc/types.h"
 
namespace neml2
{
class InputFile;
class LabeledAxisAccessor;
using VariableName = LabeledAxisAccessor;
class EnumSelection;
class MultiEnumSelection;
 
class Parser
{
public:
  Parser() = default;
 
  Parser(const Parser &) = default;
  Parser(Parser &&) noexcept = default;
  Parser & operator=(const Parser &) = default;
  Parser & operator=(Parser &&) noexcept = default;
  virtual ~Parser() = default;
 
  static const std::vector<std::string> sections;
 
  virtual InputFile parse(const std::filesystem::path & filename,
                          const std::string & additional_input = "") const = 0;
};
 
namespace utils
{
template <typename T>
std::string
parse_failure_message(const std::string & raw_str)
{
  if constexpr (std::is_same_v<T, bool>)
    return "Failed to parse '" + raw_str +
           "' as a boolean. Only 'true' and 'false' (case-sensitive) are recognized.";
 
  if constexpr (std::is_same_v<T, TensorShape>)
    return "Failed to parse '" + raw_str +
           "' as a tensor shape. Tensor shapes must be of the form "
           "'(d1,d2,...,dn)': It must begin with '(' and end with ')', d1, d2, "
           "... must be integers, and there must be no white spaces.";
 
  return "Failed to parse '" + raw_str + "' as a " + utils::demangle(typeid(T).name());
}
 
template <typename T>
bool
parse_(T & val, const std::string & raw_str)
{
  std::stringstream ss(trim(raw_str));
  ss >> val;
  return !ss.fail();
}
 
template <typename T>
T
parse(const std::string & raw_str)
{
  T val;
  auto success = parse_(val, raw_str);
  if (!success)
    throw ParserException(parse_failure_message<T>(raw_str));
  return val;
}
 
template <typename T>
bool
parse_vector_(std::vector<T> & vals, const std::string & raw_str)
{
  auto tokens = split(raw_str, " \t\n\v\f\r");
  if constexpr (std::is_same_v<T, Device>)
    vals.resize(tokens.size(), kCPU);
  else
    vals.resize(tokens.size());
  for (size_t i = 0; i < tokens.size(); i++)
  {
    auto success = parse_<T>(vals[i], tokens[i]);
    if (!success)
      return false;
  }
  return true;
}
 
template <typename T>
std::vector<T>
parse_vector(const std::string & raw_str)
{
  std::vector<T> vals;
  auto success = parse_vector_(vals, raw_str);
  if (!success)
    throw ParserException("Failed to parse '" + raw_str + "' as a vector of " +
                          utils::demangle(typeid(T).name()));
  return vals;
}
 
template <typename T>
bool
parse_vector_vector_(std::vector<std::vector<T>> & vals, const std::string & raw_str)
{
  auto token_vecs = split(raw_str, ";");
  vals.resize(token_vecs.size());
  for (size_t i = 0; i < token_vecs.size(); i++)
  {
    auto success = parse_vector_<T>(vals[i], token_vecs[i]);
    if (!success)
      return false;
  }
  return true;
}
 
template <typename T>
std::vector<std::vector<T>>
parse_vector_vector(const std::string & raw_str)
{
  std::vector<std::vector<T>> vals;
  auto success = parse_vector_vector_(vals, raw_str);
  if (!success)
    throw ParserException("Failed to parse '" + raw_str + "' as a vector of vector of " +
                          utils::demangle(typeid(T).name()));
  return vals;
}
 
// template specializations for special option types
template <>
bool parse_<bool>(bool &, const std::string & raw_str);
template <>
bool parse_vector_<bool>(std::vector<bool> &, const std::string & raw_str);
template <>
bool parse_<TensorShape>(TensorShape &, const std::string & raw_str);
template <>
bool parse_<VariableName>(VariableName &, const std::string & raw_str);
template <>
Device parse<Device>(const std::string & raw_str);
template <>
bool parse_<Device>(Device &, const std::string & raw_str);
} // namespace utils
} // namespace neml2