symbol.h

Go to the documentation of this file.

 
#if !defined(ULTRA_SYMBOL_H)
#define      ULTRA_SYMBOL_H
 
#include "utility/assert.h"
 
#include <limits>
#include <string>
 
namespace ultra
{

class symbol
{
public:
  // ---- Member types ----

  using category_t = unsigned;

  static constexpr category_t default_category = 0;

  static constexpr category_t undefined_category =
    std::numeric_limits<category_t>::max();

  using opcode_t = unsigned;

  enum format {c_format, cpp_format, python_format, sup_format};
 
  // ---- Constructors ----
  explicit symbol(const std::string &, category_t = default_category);

  virtual ~symbol() = default;
 
  // ---- Observers ----
  [[nodiscard]] category_t category() const noexcept;
  [[nodiscard]] opcode_t opcode() const noexcept;
  [[nodiscard]] const std::string &name() const noexcept;
 
  [[nodiscard]] virtual std::string to_string(format = c_format) const = 0;
 
  // ---- Modifiers ----
  void category(category_t) noexcept;
 
  // ---- Misc ----
  [[nodiscard]] virtual bool is_valid() const;
 
private:
  std::string name_;
  category_t category_;
  opcode_t opcode_;
};
 
template<class S> concept Symbol = std::derived_from<S, symbol>;

template<Symbol S>
[[nodiscard]] auto get_if(const symbol *s)
{
  return dynamic_cast<const S *>(s);
}

template<Symbol S>
[[nodiscard]] auto get_if(const symbol &s)
{
  return get_if<S>(&s);
}

template<Symbol S>
[[nodiscard]] bool is(const symbol *s)
{
  return get_if<S>(s);
}

template<Symbol S>
[[nodiscard]] bool is(const symbol &s)
{
  return is<S>(&s);
}
 
}  // namespace ultra
 
#endif  // include guard