// 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_WRITER_H_
#define SRC_WRITER_WRITER_H_

#include <string>

#include "src/ast/module.h"
#include "src/ast/pipeline_stage.h"
#include "src/context.h"

namespace tint {
namespace writer {

/// Base class for the output writers
class Writer {
 public:
  virtual ~Writer();

  /// @returns the writer error string
  const std::string& error() const { return error_; }

  /// Resets the generator
  //! @cond Doxygen_Suppress
  virtual void Reset() = 0;
  //! @endcond

  /// Converts the module into the desired format
  /// @returns true on success; false on failure
  virtual bool Generate() = 0;

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

 protected:
  /// Constructor
  /// DEPRECATED
  /// @param module the tint module to convert
  explicit Writer(ast::Module module);

  /// Constructor
  /// @param ctx the context object, must be non-null
  /// @param module the tint module to convert
  Writer(Context* ctx, ast::Module module);

  /// Sets the error string
  /// @param msg the error message
  void set_error(const std::string& msg) { error_ = msg; }

  /// An error message, if an error was encountered
  std::string error_;
  /// The context
  Context* ctx_ = nullptr;
  /// Tracks if we own the context
  bool context_is_owned_ = false;
  /// The module being converted
  ast::Module module_;
};

}  // namespace writer
}  // namespace tint

#endif  // SRC_WRITER_WRITER_H_