summaryrefslogtreecommitdiff
path: root/compiler/coco/core/include/coco/IR/Entity.h
blob: 4bf9df6513e37779a40696e1186f72593e7d8810 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __COCO_IR_ENTITY_H__
#define __COCO_IR_ENTITY_H__

#include "coco/IR/Module.forward.h"

namespace coco
{

/**
 * @brief A base class for IR entities
 *
 * NOTE Each IR entity has a link to a module that it belongs to
 */
class Entity
{
public:
  friend class EntityBuilder;

public:
  virtual ~Entity() = default;

public:
  Module *module(void) const { return _module; }

private:
  // WARN Only EntityBuilder is allowed to access this method
  void module(Module *m) { _module = m; }

private:
  Module *_module = nullptr;
};

} // namespace coco

#endif // __COCO_IR_ENTITY_H__