57 lines
1.7 KiB
C
57 lines
1.7 KiB
C
|
// Copyright 2020 The Tint Authors.
|
||
|
|
//
|
||
|
|
// 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 SRC_TRANSFORM_TRANSFORM_H_
|
||
|
|
#define SRC_TRANSFORM_TRANSFORM_H_
|
||
|
|
|
||
|
|
#include <memory>
|
||
|
|
#include <string>
|
||
|
|
#include <utility>
|
||
|
|
|
||
|
|
#include "src/ast/module.h"
|
||
|
|
#include "src/diagnostic/diagnostic.h"
|
||
|
|
|
||
|
|
namespace tint {
|
||
|
|
namespace transform {
|
||
|
|
|
||
|
|
/// Interface for ast::Module transforms
|
||
|
|
class Transform {
|
||
|
|
public:
|
||
|
|
/// Constructor
|
||
|
|
Transform();
|
||
|
|
/// Destructor
|
||
|
|
virtual ~Transform();
|
||
|
|
|
||
|
|
/// The return type of Run()
|
||
|
|
struct Output {
|
||
|
|
/// The transformed module. May be empty on error.
|
||
|
|
ast::Module module;
|
||
|
|
/// Diagnostics raised while running the Transform.
|
||
|
|
diag::List diagnostics;
|
||
|
|
};
|
||
|
|
|
||
|
|
/// Runs the transform on `module`, returning the transformation result.
|
||
|
|
/// @note Users of Tint should register the transform with transform manager
|
||
|
|
/// and invoke its Run(), instead of directly calling the transform's Run().
|
||
|
|
/// Calling Run() directly does not perform module state cleanup operations.
|
||
|
|
/// @param module the source module to transform
|
||
|
|
/// @returns the transformation result
|
||
|
|
virtual Output Run(ast::Module* module) = 0;
|
||
|
|
};
|
||
|
|
|
||
|
|
} // namespace transform
|
||
|
|
} // namespace tint
|
||
|
|
|
||
|
|
#endif // SRC_TRANSFORM_TRANSFORM_H_
|