ProxyBlock.hpp

Go to the documentation of this file.

//===- ProxyBlock.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_PROX_BLOCK_H
#define GTIRB_PROX_BLOCK_H
 
#include <gtirb/CfgNode.hpp>
#include <gtirb/Node.hpp>
 
 
namespace gtirb {
namespace proto {
class ProxyBlock;
}
 
template <class T> class ErrorOr;
class Module;
 
class GTIRB_EXPORT_API ProxyBlock : public CfgNode {
public:
  static ProxyBlock* Create(Context& C) { return C.Create<ProxyBlock>(C); }
 
  Module* getModule() { return Parent; }
  const Module* getModule() const { return Parent; }
 
  static bool classof(const Node* N) {
    return N->getKind() == Kind::ProxyBlock;
  }
 
private:
  ProxyBlock(Context& C) : CfgNode(C, Kind::ProxyBlock) {}
  ProxyBlock(Context& C, const UUID& U) : CfgNode(C, Kind::ProxyBlock, U) {}
 
  static ProxyBlock* Create(Context& C, const UUID& U) {
    return C.Create<ProxyBlock>(C, U);
  }
 
  void setModule(Module* M) { Parent = M; }
 
  using MessageType = proto::ProxyBlock;
 
  void toProtobuf(MessageType* Message) const;
 
  static ErrorOr<ProxyBlock*> fromProtobuf(Context& C,
                                           const MessageType& Message);
 
  // Present for testing purposes only.
  void save(std::ostream& Out) const;
 
  // Present for testing purposes only.
  static ProxyBlock* load(Context& C, std::istream& In);
 
  Module* Parent{nullptr};
 
  friend class Context; // Allow Context to construct proxies.
  friend class Module;  // Allow Module to call setModule, Create, etc.
  // Allows serializaton from Module via sequenceToProtobuf.
  template <typename T> friend typename T::MessageType toProtobuf(const T&);
  friend class SerializationTestHarness; // Testing support.
};
 
} // namespace gtirb
 
#endif // GTIRB_PROXY_BLOCK_H