src/writer/spirv/generator.h

// 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_WRITER_SPIRV_GENERATOR_H_
#define SRC_WRITER_SPIRV_GENERATOR_H_

#include <memory>
#include <string>
#include <vector>

#include "src/ast/module.h"
#include "src/namer.h"
#include "src/writer/spirv/binary_writer.h"
#include "src/writer/spirv/builder.h"
#include "src/writer/writer.h"

namespace tint {
namespace writer {
namespace spirv {

/// Class to generate SPIR-V from a Tint module
class Generator : public writer::Writer {
 public:
  /// Constructor
  /// DEPRECATED
  /// @param module the module to convert
  explicit Generator(ast::Module module);
  /// Constructor
  /// @param module the module to convert
  explicit Generator(ast::Module* module);
  ~Generator() override;

  /// Resets the generator
  void Reset() override;

  /// Generates the result data
  /// @returns true on successful generation; false otherwise
  bool Generate() override;

  /// Generates the result data
  /// DO NOT USE. Temporary fix for Dawn usage of SPRIV-Cross
  /// @returns true on successful generation; false otherwise
  bool GenerateUnsafe();

  /// Converts a single entry point
  /// @param stage the pipeline stage
  /// @param name the entry point name
  /// @returns true on succes; false on failure
  bool GenerateEntryPoint(ast::PipelineStage stage,
                          const std::string& name) override;

  /// @returns the result data
  const std::vector<uint32_t>& result() const { return writer_->result(); }

 private:
  std::unique_ptr<Namer> namer_;
  std::unique_ptr<Builder> builder_;
  std::unique_ptr<BinaryWriter> writer_;
};

}  // namespace spirv
}  // namespace writer
}  // namespace tint

#endif  // SRC_WRITER_SPIRV_GENERATOR_H_