[libSyntax] Add validate method to all syntax nodes

For syntax nodes that previously didn’t have a `validate` method, the newly added `validate` method is a no-op. This will make validation easier in upcoming generic code.

Author: ahoppen

include/swift/Syntax/SyntaxCollection.h

@@ -68,11 +68,15 @@ class SyntaxCollection : public Syntax {
   }
 
 public:
-  SyntaxCollection(const RC<const SyntaxData> &Data) : Syntax(Data) {}
+  SyntaxCollection(const RC<const SyntaxData> &Data) : Syntax(Data) {
+    validate();
+  }
 
   SyntaxCollection(std::initializer_list<Element> list):
     SyntaxCollection(SyntaxCollection::makeData(list)) {}
 
+  void validate() {}
+
   /// Returns true if the collection is empty.
   bool empty() const {
     return size() == 0;

include/swift/Syntax/SyntaxNodes.h.gyb

@@ -56,9 +56,7 @@ class ${node.name} ${qualifier} : public ${node.base_type} {
 %     if node.is_buildable():
       friend class ${node.name}Builder;
 %     end
-%     if node.requires_validation():
   void validate() const;
-%     end
 
 public:
 %     if node.children:
@@ -70,10 +68,8 @@ public:
 %     end
 
   ${node.name}(const RC<const SyntaxData> &Data) : ${node.base_type}(Data) {
-%     if node.requires_validation():
-      this->validate();
-%     end
-    }
+    this->validate();
+  }
 
 %     for child in node.children:
 %       for line in dedented_lines(child.description):

include/swift/Syntax/TokenSyntax.h

@@ -33,7 +33,9 @@ class TokenSyntax final : public Syntax {
     assert(getRaw()->isToken());
   }
 public:
-  TokenSyntax(const RC<const SyntaxData> &Data) : Syntax(Data) {}
+  TokenSyntax(const RC<const SyntaxData> &Data) : Syntax(Data) {
+    validate();
+  }
 
   static TokenSyntax missingToken(const tok Kind, StringRef Text,
                                   const RC<SyntaxArena> &Arena) {

lib/Syntax/SyntaxNodes.cpp.gyb

@@ -25,32 +25,39 @@ using namespace swift;
 using namespace swift::syntax;
 
 % for node in SYNTAX_NODES:
-%   if node.requires_validation():
-void ${node.name}::validate() const {
+%   if not node.is_syntax_collection():
+void ${node.name}Ref::validate() const {
+%     if node.requires_validation():
 #ifndef NDEBUG
-  auto raw = getData()->getRaw();
+  auto raw = getDataRef()->getRaw();
   if (isMissing()) return;
   assert(raw->getLayout().size() == ${len(node.children)});
-%     for child in node.children:
-%       if child.token_choices:
-%         choices = ", ".join("tok::" + choice.kind
-%                             for choice in child.token_choices)
+%       for child in node.children:
+%         if child.token_choices:
+%           choices = ", ".join("tok::" + choice.kind
+%                               for choice in child.token_choices)
   syntax_assert_child_token(raw, ${child.name}, ${choices});
-%       end
-%       if child.main_token() and child.text_choices:
-%         token_kind = child.main_token().kind
-%         choices = ", ".join("\"%s\"" % choice
-%                             for choice in child.text_choices)
+%         end
+%         if child.main_token() and child.text_choices:
+%           token_kind = child.main_token().kind
+%           choices = ", ".join("\"%s\"" % choice
+%                               for choice in child.text_choices)
   syntax_assert_child_token_text(raw, ${child.name},
                                  tok::${token_kind}, ${choices});
-%       end
-%       if child.node_choices:
+%         end
+%         if child.node_choices:
   if (auto __Child = raw->getChild(Cursor::${child.name}))
     assert(${check_child_condition_raw(child)}(__Child));
+%         end
 %       end
-%     end
 #endif
+%     end
 }
+
+void ${node.name}::validate() const {
+  ${node.name}Ref(*this).validate();
+}
+
 %   end
 
 %   for child in node.children: