function_symbol.h

Go to the documentation of this file.

// Author(s): Wieger Wesselink, Jan Friso Groote
// Copyright: see the accompanying file COPYING or copy at
// https://github.com/mCRL2org/mCRL2/blob/master/COPYING
//
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
 
 
#ifndef MCRL2_ATERMPP_FUNCTION_SYMBOL_H
#define MCRL2_ATERMPP_FUNCTION_SYMBOL_H
 
#include <utility>
#include "mcrl2/atermpp/detail/function_symbol.h"
 
namespace atermpp
{
namespace detail
{
class function_symbol_pool;
class _aterm;
}
 
class function_symbol
{
  friend class function_symbol_generator;
  friend class detail::function_symbol_pool;
  friend class detail::_aterm;
 
  friend struct std::hash<function_symbol>;
 
public:
  function_symbol() = default;
 
  function_symbol(const std::string& name, const std::size_t arity_)
   : function_symbol(name, arity_, true)
  {}
 
  function_symbol(std::string&& name, const std::size_t arity_)
   : function_symbol(std::forward<std::string>(name), arity_, true)
  {}
 
  function_symbol(const function_symbol& other) noexcept = default;
  function_symbol& operator=(const function_symbol& other) noexcept = default;
  function_symbol(function_symbol&& other) noexcept = default;
  function_symbol& operator=(function_symbol&& other) noexcept = default;
 
  bool defined() const
  {
    return m_function_symbol.defined();
  }
 
  const std::string& name() const
  {
    return m_function_symbol->name();
  }
 
  std::size_t arity() const
  {
    return m_function_symbol->arity();
  }
 
  bool operator ==(const function_symbol& f) const
  {
    return m_function_symbol == f.m_function_symbol;
  }
 
  bool operator !=(const function_symbol& f) const
  {
    return m_function_symbol != f.m_function_symbol;
  }
 
  bool operator <(const function_symbol& f) const
  {
    return m_function_symbol < f.m_function_symbol;
  }
 
  bool operator >(const function_symbol& f) const
  {
    return m_function_symbol > f.m_function_symbol;
  }
 
  bool operator <=(const function_symbol& f) const
  {
    return m_function_symbol <= f.m_function_symbol;
  }
 
  bool operator >=(const function_symbol& f) const
  {
    return m_function_symbol >= f.m_function_symbol;
  }
 
  void swap(function_symbol& f)
  {
    using std::swap;
    swap(f.m_function_symbol, m_function_symbol);
  }
 
private:
  function_symbol(detail::_function_symbol::ref&& f)
   : m_function_symbol(std::forward<detail::_function_symbol::ref>(f))
  {}
 
  function_symbol(const std::string& name, const std::size_t arity, const bool check_for_registered_functions);
 
  function_symbol(std::string&& name, const std::size_t arity, const bool check_for_registered_functions);
 
  void destroy();
 
  detail::_function_symbol::ref m_function_symbol;
};
 
class global_function_symbol : public function_symbol
{
public:
  global_function_symbol(const std::string& name, const std::size_t arity);
};
 
namespace detail
{
  extern function_symbol g_as_int;
  extern function_symbol g_as_list;
  extern function_symbol g_as_empty_list;
}
 
} // namespace atermpp
 
#endif // MCRL2_ATERMPP_FUNCTION_SYMBOL_H