summaryrefslogtreecommitdiff
path: root/compiler/nnc/include/pass/Pass.h
blob: d07d688f18310f11fd09b9d9f51e5683ba79f874 (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
52
53
/*
 * 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 NNCC_PASS_H
#define NNCC_PASS_H

#include <string>

#include "pass/PassData.h"

namespace nnc
{

/**
 * @brief this class represent an interface for all compiler passes like that frontend, backend etc
 */
class Pass
{
public:
  /**
   * @brief run compiler pass
   * @param data - data that pass is taken
   * @return data that can be passed to the next pass
   * @throw PassException object if errors occured
   */
  virtual PassData run(PassData data) = 0;

  /**
   * @brief clean compiler pass data
   */
  virtual void cleanup(){};

  virtual ~Pass() = default;

  virtual std::string getName() { return "pass"; }
};

} // namespace nnc

#endif // NNCC_PASS_H