OptionBase.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 <string>
#include <memory>
#include <iosfwd>
 
#include "neml2/misc/types.h"
 
namespace neml2
{
class OptionBase;
 
// Streaming operators
std::ostream & operator<<(std::ostream &, const OptionBase &);

class OptionBase
{
public:
  OptionBase() = default;
 
  OptionBase(OptionBase &&) = delete;
  OptionBase(const OptionBase &) = delete;
  OptionBase & operator=(const OptionBase &) = delete;
  OptionBase & operator=(OptionBase &&) = delete;
  virtual ~OptionBase() = default;

  virtual bool operator==(const OptionBase & other) const = 0;

  virtual bool operator!=(const OptionBase & other) const = 0;

  const std::string & name() const { return _metadata.name; }

  const std::string & type() const { return _metadata.type; }

  const FType & ftype() const { return _metadata.ftype; }
  FType & ftype() { return _metadata.ftype; }

  const std::string & doc() const { return _metadata.doc; }
  std::string & doc() { return _metadata.doc; }

  bool required() const { return _metadata.required; }
  bool & required() { return _metadata.required; }

  bool suppressed() const { return _metadata.suppressed; }
  bool & suppressed() { return _metadata.suppressed; }

  bool user_specified() const { return _metadata.user_specified; }
  bool & user_specified() { return _metadata.user_specified; }

  bool defined() const { return _metadata.defined; }
  bool & defined() { return _metadata.defined; }

  virtual void print(std::ostream &) const = 0;

  virtual std::unique_ptr<OptionBase> clone() const = 0;
 
protected:
  struct Metadata
  {
    std::string name = "";
    std::string type = "";
    FType ftype = FType::NONE;
    std::string doc = "";
    bool required = false;
    bool suppressed = false;
    bool user_specified = false;
    bool defined = false;
 
    bool operator==(const Metadata & other) const
    {
      return name == other.name && type == other.type && ftype == other.ftype && doc == other.doc &&
             required == other.required && suppressed == other.suppressed &&
             user_specified == other.user_specified && defined == other.defined;
    }
 
    bool operator!=(const Metadata & other) const { return !(*this == other); }
 
  } _metadata;
};
} // namespace neml2