Node.hpp

Go to the documentation of this file.

//===- Node.hpp -------------------------------------------------*- C++ -*-===//
//
//  Copyright (C) 2020 GrammaTech, Inc.
//
//  This code is licensed under the MIT license. See the LICENSE file in the
//  project root for license terms.
//
//  This project is sponsored by the Office of Naval Research, One Liberty
//  Center, 875 N. Randolph Street, Arlington, VA 22203 under contract #
//  N68335-17-C-0700.  The content of the information does not necessarily
//  reflect the position or policy of the Government and no official
//  endorsement should be inferred.
//
//===----------------------------------------------------------------------===//
#ifndef GTIRB_NODE_H
#define GTIRB_NODE_H
 
#include <gtirb/Casting.hpp>
#include <gtirb/Context.hpp>
#include <gtirb/Export.hpp>
#include <functional>
#include <string>
 
 
namespace gtirb {
class Node;
 
class GTIRB_EXPORT_API Node {
public:
 
  // The enum constants below must be grouped according to the inheritance
  // hierarchy such that all descendants of a type X must appear between the
  // constant for X and LAST_X. This allows us to quickly check whether a type
  // is a descendant of X by checking if the enum constant falls in that range.
  enum class Kind {
    Node,
    CfgNode,
    CodeBlock,
    ProxyBlock,
    LAST_CfgNode = ProxyBlock, // Mark last descendant of CfgNode
    DataBlock,
    IR,
    Module,
    Section,
    Symbol,
    ByteInterval,
    LAST_Node = ByteInterval, // Mark last descendant of Node
  };
 
  static Node* getByUUID(Context& C, const UUID& Uuid) {
    return C.findNode(Uuid);
  }
 
  static const Node* getByUUID(const Context& C, const UUID& Uuid) {
    return C.findNode(Uuid);
  }
 
  static Node* Create(Context& C) { return C.Create<Node>(C, Kind::Node); }
 
  Node(const Node&) = delete;
 
  Node(Node&&) = delete;
 
  ~Node() noexcept;
 
  Node& operator=(const Node&) = delete;
 
  Node& operator=(Node&&) = delete;
 
  const UUID& getUUID() const { return Uuid; }
 
  Kind getKind() const { return K; }
 
  static bool classof(const Node* N) { return classofKind(N->getKind()); }
  static bool classofKind(Kind K) {
    return K >= Kind::Node && K <= Kind::LAST_Node;
  }
 
protected:
  Node(Context& C, Kind Knd);
  Node(Context& C, Kind Knd, const UUID& U);
 
private:
  Kind K;
  UUID Uuid;
  // The Context object can never be null as it can only be passed to the Node
  // constructor by reference. However, we don't want to store a reference to
  // the Context object because we want to keep the Node class copyable and
  // Context needs to own a move-only allocator.
  Context* Ctx;
 
  friend class Context; // Enables Context::Create
};
 
} // namespace gtirb
 
#endif // GTIRB_NODE_H