parser: add doc string opener to nodes

Author: ryangjchandler

schema.json

@@ -1705,6 +1705,24 @@
               "$ref": "#/definitions/ClassishConstant"
             }
           }
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "value"
+          ],
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "TraitUsage"
+              ]
+            },
+            "value": {
+              "$ref": "#/definitions/TraitUsage"
+            }
+          }
         }
       ]
     },
@@ -6101,9 +6119,13 @@
     "HeredocExpression": {
       "type": "object",
       "required": [
+        "label",
         "parts"
       ],
       "properties": {
+        "label": {
+          "$ref": "#/definitions/ByteString"
+        },
         "parts": {
           "type": "array",
           "items": {
@@ -7620,9 +7642,13 @@
     "NowdocExpression": {
       "type": "object",
       "required": [
+        "label",
         "value"
       ],
       "properties": {
+        "label": {
+          "$ref": "#/definitions/ByteString"
+        },
         "value": {
           "$ref": "#/definitions/ByteString"
         }
@@ -10106,6 +10132,24 @@
               "$ref": "#/definitions/ClassishConstant"
             }
           }
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "value"
+          ],
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "TraitUsage"
+              ]
+            },
+            "value": {
+              "$ref": "#/definitions/TraitUsage"
+            }
+          }
         }
       ]
     },

src/parser/ast/mod.rs

@@ -842,6 +842,7 @@ impl Node for InterpolatedStringExpression {
 
 #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, JsonSchema)]
 pub struct HeredocExpression {
+    pub label: ByteString,
     pub parts: Vec<StringPart>,
 }
 
@@ -856,6 +857,7 @@ impl Node for HeredocExpression {
 
 #[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, JsonSchema)]
 pub struct NowdocExpression {
+    pub label: ByteString,
     pub value: ByteString,
 }
 

src/parser/internal/strings.rs

@@ -61,6 +61,7 @@ pub fn shell_exec(state: &mut State) -> ParseResult<Expression> {
 #[inline(always)]
 pub fn heredoc(state: &mut State) -> ParseResult<Expression> {
     let span = state.stream.current().span;
+    let label = state.stream.current().value.clone();
     state.stream.next();
 
     let mut parts = Vec::new();
@@ -140,12 +141,13 @@ pub fn heredoc(state: &mut State) -> ParseResult<Expression> {
         }
     }
 
-    Ok(Expression::Heredoc(HeredocExpression { parts }))
+    Ok(Expression::Heredoc(HeredocExpression { label, parts }))
 }
 
 #[inline(always)]
 pub fn nowdoc(state: &mut State) -> ParseResult<Expression> {
     let span = state.stream.current().span;
+    let label = state.stream.current().value.clone();
 
     state.stream.next();
 
@@ -221,7 +223,7 @@ pub fn nowdoc(state: &mut State) -> ParseResult<Expression> {
         string_part = bytes.into();
     }
 
-    Ok(Expression::Nowdoc(NowdocExpression { value: string_part }))
+    Ok(Expression::Nowdoc(NowdocExpression { label, value: string_part }))
 }
 
 fn part(state: &mut State) -> ParseResult<Option<StringPart>> {

tests/fixtures/0224/ast.txt

@@ -12,6 +12,7 @@
         ExpressionStatement {
             expression: Heredoc(
                 HeredocExpression {
+                    label: "<<<EOF",
                     parts: [
                         Literal(
                             LiteralStringPart {

tests/fixtures/0225/ast.txt

@@ -12,6 +12,7 @@
         ExpressionStatement {
             expression: Heredoc(
                 HeredocExpression {
+                    label: "<<<     TXT",
                     parts: [
                         Literal(
                             LiteralStringPart {

tests/fixtures/0228/ast.txt

@@ -12,6 +12,7 @@
         ExpressionStatement {
             expression: Heredoc(
                 HeredocExpression {
+                    label: "<<<EOF",
                     parts: [
                         Literal(
                             LiteralStringPart {

tests/fixtures/0229/ast.txt

@@ -12,6 +12,7 @@
         ExpressionStatement {
             expression: Heredoc(
                 HeredocExpression {
+                    label: "<<<EOF",
                     parts: [
                         Literal(
                             LiteralStringPart {

tests/fixtures/0230/ast.txt

@@ -12,6 +12,7 @@
         ExpressionStatement {
             expression: Heredoc(
                 HeredocExpression {
+                    label: "<<<EOF",
                     parts: [
                         Literal(
                             LiteralStringPart {

tests/fixtures/0231/ast.txt

@@ -12,6 +12,7 @@
         ExpressionStatement {
             expression: Nowdoc(
                 NowdocExpression {
+                    label: "<<<'EOF'",
                     value: "  Hello, world!\n  Hello, world!",
                 },
             ),

tests/fixtures/0232/ast.txt

@@ -12,6 +12,7 @@
         ExpressionStatement {
             expression: Nowdoc(
                 NowdocExpression {
+                    label: "<<<'EOF'",
                     value: "Hello, world!\nHello, world!",
                 },
             ),

tests/fixtures/0235/ast.txt

@@ -12,6 +12,7 @@
         ExpressionStatement {
             expression: Nowdoc(
                 NowdocExpression {
+                    label: "<<<'EOF'",
                     value: "Hello, {$name}!",
                 },
             ),