ast: Have all AST types derive from ast::Node

A common base class is required to move from std::unique_ptr<> to raw pointers for AST types.

Also unifies a bunch of similar APIs.

Bug: tint:322
Change-Id: If829f8c3f22069adf62751365f1f1eeb646aba08
Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/32660
Commit-Queue: Ben Clayton <bclayton@google.com>
Commit-Queue: dan sinclair <dsinclair@chromium.org>
Reviewed-by: dan sinclair <dsinclair@chromium.org>

src/ast/array_decoration.h

@@ -40,9 +40,6 @@ class ArrayDecoration : public Decoration {
   /// @returns the decoration as a stride decoration
   StrideDecoration* AsStride();
 
-  /// @returns the decoration as a string
-  virtual std::string to_str() const = 0;
-
  protected:
   /// Constructor
   /// @param source the source of this decoration

src/ast/binding_decoration.cc

@@ -26,7 +26,8 @@ bool BindingDecoration::IsBinding() const {
   return true;
 }
 
-void BindingDecoration::to_str(std::ostream& out) const {
+void BindingDecoration::to_str(std::ostream& out, size_t indent) const {
+  make_indent(out, indent);
   out << "BindingDecoration{" << value_ << "}" << std::endl;
 }
 

src/ast/binding_decoration.h

@@ -38,8 +38,9 @@ class BindingDecoration : public VariableDecoration {
   uint32_t value() const { return value_; }
 
   /// Outputs the decoration to the given stream
-  /// @param out the stream to output too
+  /// @param out the stream to write to
-  void to_str(std::ostream& out) const override;
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 
  private:
   uint32_t value_;

src/ast/binding_decoration_test.cc

@@ -39,7 +39,7 @@ TEST_F(BindingDecorationTest, Is) {
 TEST_F(BindingDecorationTest, ToStr) {
   BindingDecoration d{2, Source{}};
   std::ostringstream out;
-  d.to_str(out);
+  d.to_str(out, 0);
   EXPECT_EQ(out.str(), R"(BindingDecoration{2}
 )");
 }

src/ast/builtin_decoration.cc

@@ -26,7 +26,8 @@ bool BuiltinDecoration::IsBuiltin() const {
   return true;
 }
 
-void BuiltinDecoration::to_str(std::ostream& out) const {
+void BuiltinDecoration::to_str(std::ostream& out, size_t indent) const {
+  make_indent(out, indent);
   out << "BuiltinDecoration{" << builtin_ << "}" << std::endl;
 }
 

src/ast/builtin_decoration.h

@@ -37,8 +37,9 @@ class BuiltinDecoration : public VariableDecoration {
   Builtin value() const { return builtin_; }
 
   /// Outputs the decoration to the given stream
-  /// @param out the stream to output too
+  /// @param out the stream to write to
-  void to_str(std::ostream& out) const override;
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 
  private:
   Builtin builtin_ = Builtin::kNone;

src/ast/builtin_decoration_test.cc

@@ -39,7 +39,7 @@ TEST_F(BuiltinDecorationTest, Is) {
 TEST_F(BuiltinDecorationTest, ToStr) {
   BuiltinDecoration d{Builtin::kFragDepth, Source{}};
   std::ostringstream out;
-  d.to_str(out);
+  d.to_str(out, 0);
   EXPECT_EQ(out.str(), R"(BuiltinDecoration{frag_depth}
 )");
 }

src/ast/constant_id_decoration.cc

@@ -26,7 +26,8 @@ bool ConstantIdDecoration::IsConstantId() const {
   return true;
 }
 
-void ConstantIdDecoration::to_str(std::ostream& out) const {
+void ConstantIdDecoration::to_str(std::ostream& out, size_t indent) const {
+  make_indent(out, indent);
   out << "ConstantIdDecoration{" << value_ << "}" << std::endl;
 }
 

src/ast/constant_id_decoration.h

@@ -37,8 +37,9 @@ class ConstantIdDecoration : public VariableDecoration {
   uint32_t value() const { return value_; }
 
   /// Outputs the decoration to the given stream
-  /// @param out the stream to output too
+  /// @param out the stream to write to
-  void to_str(std::ostream& out) const override;
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 
  private:
   uint32_t value_ = 0;

src/ast/constant_id_decoration_test.cc

@@ -39,7 +39,7 @@ TEST_F(ConstantIdDecorationTest, Is) {
 TEST_F(ConstantIdDecorationTest, ToStr) {
   ConstantIdDecoration d{1200, Source{}};
   std::ostringstream out;
-  d.to_str(out);
+  d.to_str(out, 0);
   EXPECT_EQ(out.str(), R"(ConstantIdDecoration{1200}
 )");
 }

src/ast/decorated_variable.cc

@@ -86,8 +86,7 @@ void DecoratedVariable::to_str(std::ostream& out, size_t indent) const {
   make_indent(out, indent + 2);
   out << "Decorations{" << std::endl;
   for (const auto& deco : decorations_) {
-    make_indent(out, indent + 4);
+    deco->to_str(out, indent + 4);
-    deco->to_str(out);
   }
 
   make_indent(out, indent + 2);

src/ast/decoration.cc

@@ -35,5 +35,9 @@ std::ostream& operator<<(std::ostream& out, DecorationKind data) {
   return out << "<unknown>";
 }
 
+bool Decoration::IsValid() const {
+  return true;
+}
+
 }  // namespace ast
 }  // namespace tint

src/ast/decoration.h

@@ -19,6 +19,7 @@
 #include <ostream>
 #include <vector>
 
+#include "src/ast/node.h"
 #include "src/source.h"
 
 namespace tint {
@@ -36,9 +37,9 @@ enum class DecorationKind {
 std::ostream& operator<<(std::ostream& out, DecorationKind data);
 
 /// The base class for all decorations
-class Decoration {
+class Decoration : public Node {
  public:
-  virtual ~Decoration();
+  ~Decoration() override;
 
   /// @return the decoration kind
   DecorationKind GetKind() const { return kind_; }
@@ -49,19 +50,18 @@ class Decoration {
     return GetKind() == TO::Kind;
   }
 
-  /// @return the source of this decoration
+  /// @returns true if the node is valid
-  const Source& GetSource() { return source_; }
+  bool IsValid() const override;
 
  protected:
   /// Constructor
   /// @param kind represents the derived type
   /// @param source the source of this decoration
   Decoration(DecorationKind kind, const Source& source)
-      : kind_(kind), source_(source) {}
+      : Node(source), kind_(kind) {}
 
  private:
   DecorationKind const kind_;
-  Source const source_;
 };
 
 /// As dynamically casts |deco| to the target type |TO|.

src/ast/function.cc

@@ -233,8 +233,7 @@ void Function::to_str(std::ostream& out, size_t indent) const {
       << std::endl;
 
   for (const auto& deco : decorations()) {
-    make_indent(out, indent);
+    deco->to_str(out, indent);
-    deco->to_str(out);
   }
 
   make_indent(out, indent);

src/ast/function_decoration.h

@@ -45,10 +45,6 @@ class FunctionDecoration : public Decoration {
   /// @returns the decoration as a workgroup decoration
   const WorkgroupDecoration* AsWorkgroup() const;
 
-  /// Outputs the function decoration to the given stream
-  /// @param out the stream to output too
-  virtual void to_str(std::ostream& out) const = 0;
-
  protected:
   /// Constructor
   /// @param source the source of this decoration

src/ast/literal.cc

@@ -84,5 +84,14 @@ UintLiteral* Literal::AsUint() {
   return static_cast<UintLiteral*>(this);
 }
 
+bool Literal::IsValid() const {
+  return true;
+}
+
+void Literal::to_str(std::ostream& out, size_t indent) const {
+  make_indent(out, indent);
+  out << to_str();
+}
+
 }  // namespace ast
 }  // namespace tint

src/ast/literal.h

@@ -17,6 +17,7 @@
 
 #include <string>
 
+#include "src/ast/node.h"
 #include "src/ast/type/type.h"
 
 namespace tint {
@@ -30,9 +31,9 @@ class IntLiteral;
 class UintLiteral;
 
 /// Base class for a literal value
-class Literal {
+class Literal : public Node {
  public:
-  virtual ~Literal();
+  ~Literal() override;
 
   /// @returns true if this is a bool literal
   virtual bool IsBool() const;
@@ -63,6 +64,14 @@ class Literal {
   /// @returns the type of the literal
   ast::type::Type* type() const { return type_; }
 
+  /// @returns true if the node is valid
+  bool IsValid() const override;
+
+  /// Writes a representation of the node to the output stream
+  /// @param out the stream to write to
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
+
   /// @returns the literal as a string
   virtual std::string to_str() const = 0;
 

src/ast/location_decoration.cc

@@ -26,7 +26,8 @@ bool LocationDecoration::IsLocation() const {
   return true;
 }
 
-void LocationDecoration::to_str(std::ostream& out) const {
+void LocationDecoration::to_str(std::ostream& out, size_t indent) const {
+  make_indent(out, indent);
   out << "LocationDecoration{" << value_ << "}" << std::endl;
 }
 

src/ast/location_decoration.h

@@ -38,8 +38,9 @@ class LocationDecoration : public VariableDecoration {
   uint32_t value() const { return value_; }
 
   /// Outputs the decoration to the given stream
-  /// @param out the stream to output too
+  /// @param out the stream to write to
-  void to_str(std::ostream& out) const override;
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 
  private:
   uint32_t value_;

src/ast/location_decoration_test.cc

@@ -41,7 +41,7 @@ TEST_F(LocationDecorationTest, Is) {
 TEST_F(LocationDecorationTest, ToStr) {
   LocationDecoration d{2, Source{}};
   std::ostringstream out;
-  d.to_str(out);
+  d.to_str(out, 0);
   EXPECT_EQ(out.str(), R"(LocationDecoration{2}
 )");
 }

src/ast/set_decoration.cc

@@ -26,7 +26,8 @@ bool SetDecoration::IsSet() const {
   return true;
 }
 
-void SetDecoration::to_str(std::ostream& out) const {
+void SetDecoration::to_str(std::ostream& out, size_t indent) const {
+  make_indent(out, indent);
   out << "SetDecoration{" << value_ << "}" << std::endl;
 }
 

src/ast/set_decoration.h

@@ -38,8 +38,9 @@ class SetDecoration : public VariableDecoration {
   uint32_t value() const { return value_; }
 
   /// Outputs the decoration to the given stream
-  /// @param out the stream to output too
+  /// @param out the stream to write to
-  void to_str(std::ostream& out) const override;
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 
  private:
   uint32_t value_;

src/ast/set_decoration_test.cc

@@ -39,7 +39,7 @@ TEST_F(SetDecorationTest, Is) {
 TEST_F(SetDecorationTest, ToStr) {
   SetDecoration d{2, Source{}};
   std::ostringstream out;
-  d.to_str(out);
+  d.to_str(out, 0);
   EXPECT_EQ(out.str(), R"(SetDecoration{2}
 )");
 }

src/ast/stage_decoration.cc

@@ -26,7 +26,8 @@ bool StageDecoration::IsStage() const {
   return true;
 }
 
-void StageDecoration::to_str(std::ostream& out) const {
+void StageDecoration::to_str(std::ostream& out, size_t indent) const {
+  make_indent(out, indent);
   out << "StageDecoration{" << stage_ << "}" << std::endl;
 }
 

src/ast/stage_decoration.h

@@ -37,8 +37,9 @@ class StageDecoration : public FunctionDecoration {
   ast::PipelineStage value() const { return stage_; }
 
   /// Outputs the decoration to the given stream
-  /// @param out the stream to output too
+  /// @param out the stream to write to
-  void to_str(std::ostream& out) const override;
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 
  private:
   ast::PipelineStage stage_ = ast::PipelineStage::kNone;

src/ast/stage_decoration_test.cc

@@ -38,7 +38,7 @@ TEST_F(StageDecorationTest, Is) {
 TEST_F(StageDecorationTest, ToStr) {
   StageDecoration d{ast::PipelineStage::kFragment, Source{}};
   std::ostringstream out;
-  d.to_str(out);
+  d.to_str(out, 0);
   EXPECT_EQ(out.str(), R"(StageDecoration{fragment}
 )");
 }

src/ast/stride_decoration.cc

@@ -26,8 +26,9 @@ bool StrideDecoration::IsStride() const {
 
 StrideDecoration::~StrideDecoration() = default;
 
-std::string StrideDecoration::to_str() const {
+void StrideDecoration::to_str(std::ostream& out, size_t indent) const {
-  return "stride " + std::to_string(stride_);
+  make_indent(out, indent);
+  out << "stride " << stride_;
 }
 
 }  // namespace ast

src/ast/stride_decoration.h

@@ -39,8 +39,10 @@ class StrideDecoration : public ArrayDecoration {
   /// @returns the stride value
   uint32_t stride() const { return stride_; }
 
-  /// @returns the decoration as a string
+  /// Outputs the decoration to the given stream
-  std::string to_str() const override;
+  /// @param out the stream to write to
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 
  private:
   uint32_t stride_;

src/ast/stride_decoration_test.cc

@@ -35,10 +35,10 @@ TEST_F(StrideDecorationTest, Is) {
 TEST_F(StrideDecorationTest, Source) {
   StrideDecoration d{
       2, Source{Source::Range{Source::Location{1, 2}, Source::Location{3, 4}}}};
-  EXPECT_EQ(d.GetSource().range.begin.line, 1u);
+  EXPECT_EQ(d.source().range.begin.line, 1u);
-  EXPECT_EQ(d.GetSource().range.begin.column, 2u);
+  EXPECT_EQ(d.source().range.begin.column, 2u);
-  EXPECT_EQ(d.GetSource().range.end.line, 3u);
+  EXPECT_EQ(d.source().range.end.line, 3u);
-  EXPECT_EQ(d.GetSource().range.end.column, 4u);
+  EXPECT_EQ(d.source().range.end.column, 4u);
 }
 
 }  // namespace

src/ast/struct.cc

@@ -73,7 +73,7 @@ void Struct::to_str(std::ostream& out, size_t indent) const {
   for (auto& deco : decorations_) {
     make_indent(out, indent + 2);
     out << "[[";
-    deco->to_str(out);
+    deco->to_str(out, 0);
     out << "]]" << std::endl;
   }
   for (const auto& member : members_) {

src/ast/struct_block_decoration.cc

@@ -26,7 +26,8 @@ bool StructBlockDecoration::IsBlock() const {
   return true;
 }
 
-void StructBlockDecoration::to_str(std::ostream& out) const {
+void StructBlockDecoration::to_str(std::ostream& out, size_t indent) const {
+  make_indent(out, indent);
   out << "block";
 }
 

src/ast/struct_block_decoration.h

@@ -36,8 +36,9 @@ class StructBlockDecoration : public StructDecoration {
   bool IsBlock() const override;
 
   /// Outputs the decoration to the given stream
-  /// @param out the stream to output too
+  /// @param out the stream to write to
-  void to_str(std::ostream& out) const override;
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 };
 
 /// List of struct decorations

src/ast/struct_decoration.h

@@ -35,10 +35,6 @@ class StructDecoration : public Decoration {
   /// @returns true if this is a block struct
   virtual bool IsBlock() const = 0;
 
-  /// Outputs the decoration to the given stream
-  /// @param out the stream to output too
-  virtual void to_str(std::ostream& out) const = 0;
-
  protected:
   /// Constructor
   /// @param source the source of this decoration

src/ast/struct_member.cc

@@ -75,7 +75,7 @@ void StructMember::to_str(std::ostream& out, size_t indent) const {
   if (decorations_.size() > 0) {
     out << "[[ ";
     for (const auto& deco : decorations_)
-      out << deco->to_str() << " ";
+      out << deco->str() << " ";
     out << "]] ";
   }
 

src/ast/struct_member_decoration.h

@@ -40,9 +40,6 @@ class StructMemberDecoration : public Decoration {
   /// @returns the decoration as an offset decoration
   StructMemberOffsetDecoration* AsOffset();
 
-  /// @returns the decoration as a string
-  virtual std::string to_str() const = 0;
-
  protected:
   /// Constructor
   /// @param source the source of this decoration

src/ast/struct_member_offset_decoration.cc

@@ -27,8 +27,10 @@ bool StructMemberOffsetDecoration::IsOffset() const {
 
 StructMemberOffsetDecoration::~StructMemberOffsetDecoration() = default;
 
-std::string StructMemberOffsetDecoration::to_str() const {
+void StructMemberOffsetDecoration::to_str(std::ostream& out,
-  return "offset " + std::to_string(offset_);
+                                          size_t indent) const {
+  make_indent(out, indent);
+  out << "offset " << std::to_string(offset_);
 }
 
 }  // namespace ast

src/ast/struct_member_offset_decoration.h

@@ -39,8 +39,10 @@ class StructMemberOffsetDecoration : public StructMemberDecoration {
   /// @returns the offset value
   uint32_t offset() const { return offset_; }
 
-  /// @returns the decoration as a string
+  /// Outputs the decoration to the given stream
-  std::string to_str() const override;
+  /// @param out the stream to write to
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 
  private:
   uint32_t offset_;

src/ast/variable_decoration.h

@@ -61,10 +61,6 @@ class VariableDecoration : public Decoration {
   /// @returns the decoration as a set decoration
   SetDecoration* AsSet();
 
-  /// Outputs the variable decoration to the given stream
-  /// @param out the stream to output too
-  virtual void to_str(std::ostream& out) const = 0;
-
  protected:
   /// Constructor
   /// @param source the source of this decoration

src/ast/workgroup_decoration.cc

@@ -37,7 +37,8 @@ bool WorkgroupDecoration::IsWorkgroup() const {
   return true;
 }
 
-void WorkgroupDecoration::to_str(std::ostream& out) const {
+void WorkgroupDecoration::to_str(std::ostream& out, size_t indent) const {
+  make_indent(out, indent);
   out << "WorkgroupDecoration{" << x_ << " " << y_ << " " << z_ << "}"
       << std::endl;
 }

src/ast/workgroup_decoration.h

@@ -53,8 +53,9 @@ class WorkgroupDecoration : public FunctionDecoration {
   }
 
   /// Outputs the decoration to the given stream
-  /// @param out the stream to output too
+  /// @param out the stream to write to
-  void to_str(std::ostream& out) const override;
+  /// @param indent number of spaces to indent the node when writing
+  void to_str(std::ostream& out, size_t indent) const override;
 
  private:
   uint32_t x_ = 1;

src/ast/workgroup_decoration_test.cc

@@ -65,7 +65,7 @@ TEST_F(WorkgroupDecorationTest, Is) {
 TEST_F(WorkgroupDecorationTest, ToStr) {
   WorkgroupDecoration d{2, 4, 6, Source{}};
   std::ostringstream out;
-  d.to_str(out);
+  d.to_str(out, 0);
   EXPECT_EQ(out.str(), R"(WorkgroupDecoration{2 4 6}
 )");
 }

src/reader/wgsl/parser_impl.cc

@@ -2844,7 +2844,7 @@ Expect<std::vector<std::unique_ptr<T>>> ParserImpl::cast_decorations(
       std::stringstream msg;
       msg << deco->GetKind() << " decoration type cannot be used for "
           << T::Kind;
-      add_error(deco->GetSource(), msg.str());
+      add_error(deco->source(), msg.str());
       ok = false;
       continue;
     }
@@ -2864,7 +2864,7 @@ bool ParserImpl::expect_decorations_consumed(const ast::DecorationList& in) {
   if (in.empty()) {
     return true;
   }
-  add_error(in[0]->GetSource(), "unexpected decorations");
+  add_error(in[0]->source(), "unexpected decorations");
   return false;
 }
 

src/writer/msl/generator_impl.cc

@@ -1856,7 +1856,7 @@ bool GeneratorImpl::EmitStructType(const ast::type::StructType* str) {
         }
         current_offset = offset;
       } else {
-        error_ = "unsupported member decoration: " + deco->to_str();
+        error_ = "unsupported member decoration: " + deco->str();
         return false;
       }
     }

src/writer/wgsl/generator_impl.cc

@@ -573,7 +573,7 @@ bool GeneratorImpl::EmitStructType(const ast::type::StructType* str) {
   auto* impl = str->impl();
   for (auto& deco : impl->decorations()) {
     out_ << "[[";
-    deco->to_str(out_);
+    deco->to_str(out_, 0);
     out_ << "]]" << std::endl;
   }
   out_ << "struct " << str->name() << " {" << std::endl;