Registry.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 <memory>
#include <map>
#include <filesystem>
 
#include "neml2/misc/string_utils.h"
#include "neml2/base/OptionSet.h"
 
namespace neml2
{
#define register_NEML2_object(classname)                                                           \
  static const char dummyvar_for_registering_obj_##classname = Registry::add<classname>(#classname)
 
#define register_NEML2_object_alias(classname, registryname)                                       \
  static const char dummyvar_for_registering_obj_##classname =                                     \
      Registry::add<classname>(registryname)
 
class NEML2Object;
 
using BuildPtr = std::shared_ptr<NEML2Object> (*)(const OptionSet & options);
 
struct NEML2ObjectInfo
{
  std::string type_name;
  OptionSet expected_options;
  BuildPtr build = nullptr;
};
 
class Registry
{
public:
  static Registry & get();
 
  template <typename T>
  static char add(const std::string & name)
  {
    add_inner(name, utils::demangle(typeid(T).name()), T::expected_options(), &build<T>);
    return 0;
  }
 
  static void load(const std::filesystem::path &);
 
  static const std::map<std::string, NEML2ObjectInfo> & info();
 
  static const NEML2ObjectInfo & info(const std::string &);
 
private:
  Registry() = default;
 
  static void add_inner(const std::string &, const std::string &, const OptionSet &, BuildPtr);
 
  template <typename T>
  static std::shared_ptr<NEML2Object> build(const OptionSet & options)
  {
    return std::make_shared<T>(options);
  }
 
  std::map<std::string, NEML2ObjectInfo> _info;
};
} // namespace neml2