Formalize Labeled Syntax

This represents labeled statements as an explicit kind of statement and removes the Labeled trait. Any kind of statement is allowed to be labeled in the tree, but we specifically diagnose the syntax elements that aren't allowed to have labels. This homogenizes the way clients deal with statement labels and also makes parser recovery quite a bit easier in the case where we have a label but no actual statement following it.

Author: CodaFi

lib/Parse/ParseStmt.cpp

@@ -534,10 +534,13 @@ ParserResult<Stmt> Parser::parseStmt() {
 
   // If this is a label on a loop/switch statement, consume it and pass it into
   // parsing logic below.
+  SyntaxParsingContext LabelContext(SyntaxContext, SyntaxKind::LabeledStmt);
   if (Tok.is(tok::identifier) && peekToken().is(tok::colon)) {
     LabelInfo.Loc = consumeIdentifier(LabelInfo.Name,
                                       /*diagnoseDollarPrefix=*/true);
     consumeToken(tok::colon);
+  } else {
+    LabelContext.setTransparent();
   }
 
   SourceLoc tryLoc;

utils/gyb_syntax_support/NodeSerializationCodes.py

@@ -268,6 +268,7 @@
     'MissingType': 264,
     'MissingPattern': 265,
     'GarbageNodes' : 266,
+    'LabeledStmt': 267,
 }
 
 

utils/gyb_syntax_support/PatternNodes.py

@@ -73,7 +73,7 @@
 
     # tuple-pattern-element -> identifier? ':' pattern ','?
     Node('TuplePatternElement', kind='Syntax',
-         traits=['WithTrailingComma', 'Labeled'],
+         traits=['WithTrailingComma'],
          children=[
              Child('LabelName', kind='IdentifierToken',
                    is_optional=True),

utils/gyb_syntax_support/StmtNodes.py

@@ -2,6 +2,14 @@
 from .Node import Node  # noqa: I201
 
 STMT_NODES = [
+    # labeled-stmt -> label ':' stmt
+    Node('LabeledStmt', kind='Stmt',
+         children=[
+             Child('LabelName', kind='IdentifierToken'),
+             Child('LabelColon', kind='ColonToken'),
+             Child('Body', kind='Stmt'),
+         ]),
+
     # continue-stmt -> 'continue' label? ';'?
     Node('ContinueStmt', kind='Stmt',
          children=[
@@ -12,12 +20,8 @@
 
     # while-stmt -> label? ':'? 'while' condition-list code-block ';'?
     Node('WhileStmt', kind='Stmt',
-         traits=['WithCodeBlock', 'Labeled'],
+         traits=['WithCodeBlock'],
          children=[
-             Child('LabelName', kind='IdentifierToken',
-                   is_optional=True),
-             Child('LabelColon', kind='ColonToken',
-                   is_optional=True),
              Child('WhileKeyword', kind='WhileToken'),
              Child('Conditions', kind='ConditionElementList',
                    collection_element_name='Condition'),
@@ -46,12 +50,8 @@
 
     # repeat-while-stmt -> label? ':'? 'repeat' code-block 'while' expr ';'?
     Node('RepeatWhileStmt', kind='Stmt',
-         traits=['WithCodeBlock', 'Labeled'],
+         traits=['WithCodeBlock'],
          children=[
-             Child('LabelName', kind='IdentifierToken',
-                   is_optional=True),
-             Child('LabelColon', kind='ColonToken',
-                   is_optional=True),
              Child('RepeatKeyword', kind='RepeatToken'),
              Child('Body', kind='CodeBlock'),
              Child('WhileKeyword', kind='WhileToken'),
@@ -79,12 +79,8 @@
     #   'for' 'try'? 'await'? 'case'? pattern 'in' expr 'where'?
     #   expr code-block ';'?
     Node('ForInStmt', kind='Stmt',
-         traits=['WithCodeBlock', 'Labeled'],
+         traits=['WithCodeBlock'],
          children=[
-             Child('LabelName', kind='IdentifierToken',
-                   is_optional=True),
-             Child('LabelColon', kind='ColonToken',
-                   is_optional=True),
              Child('ForKeyword', kind='ForToken'),
              Child('TryKeyword', kind='TryToken', 
                    is_optional=True),
@@ -106,12 +102,8 @@
     # switch-stmt -> identifier? ':'? 'switch' expr '{'
     #   switch-case-list '}' ';'?
     Node('SwitchStmt', kind='Stmt',
-         traits=['Braced', 'Labeled'],
+         traits=['Braced'],
          children=[
-             Child('LabelName', kind='IdentifierToken',
-                   is_optional=True),
-             Child('LabelColon', kind='ColonToken',
-                   is_optional=True),
              Child('SwitchKeyword', kind='SwitchToken'),
              Child('Expression', kind='Expr'),
              Child('LeftBrace', kind='LeftBraceToken'),
@@ -127,12 +119,8 @@
 
     # do-stmt -> identifier? ':'? 'do' code-block catch-clause-list ';'?
     Node('DoStmt', kind='Stmt',
-         traits=['WithCodeBlock', 'Labeled'],
+         traits=['WithCodeBlock'],
          children=[
-             Child('LabelName', kind='IdentifierToken',
-                   is_optional=True),
-             Child('LabelColon', kind='ColonToken',
-                   is_optional=True),
              Child('DoKeyword', kind='DoToken'),
              Child('Body', kind='CodeBlock'),
              Child('CatchClauses', kind='CatchClauseList',
@@ -272,12 +260,8 @@
     # if-stmt -> identifier? ':'? 'if' condition-list code-block
     #   else-clause ';'?
     Node('IfStmt', kind='Stmt',
-         traits=['WithCodeBlock', 'Labeled'],
+         traits=['WithCodeBlock'],
          children=[
-             Child('LabelName', kind='IdentifierToken',
-                   is_optional=True),
-             Child('LabelColon', kind='ColonToken',
-                   is_optional=True),
              Child('IfKeyword', kind='IfToken'),
              Child('Conditions', kind='ConditionElementList',
                    collection_element_name='Condition'),

utils/gyb_syntax_support/Traits.py

@@ -43,12 +43,6 @@ def __init__(self, trait_name, description=None, children=None):
               Child('TrailingComma', kind='CommaToken', is_optional=True),
           ]),
 
-    Trait('Labeled',
-          children=[
-              Child('LabelName', kind='IdentifierToken', is_optional=True),
-              Child('LabelColon', kind='ColonToken', is_optional=True),
-          ]),
-
     Trait('WithStatements',
           children=[
               Child('Statements', kind='CodeBlockItemList'),