feat: add text block support in parser

Author: clementdessoude

packages/java-parser/api.d.ts

@@ -671,6 +671,7 @@ export type LiteralCtx = {
   floatingPointLiteral?: FloatingPointLiteralCstNode[];
   booleanLiteral?: BooleanLiteralCstNode[];
   CharLiteral?: IToken[];
+  TextBlock?: IToken[];
   StringLiteral?: IToken[];
   Null?: IToken[];
 };

packages/java-parser/src/productions/lexical-structure.js

@@ -7,6 +7,7 @@ function defineRules($, t) {
       { ALT: () => $.SUBRULE($.floatingPointLiteral) },
       { ALT: () => $.SUBRULE($.booleanLiteral) },
       { ALT: () => $.CONSUME(t.CharLiteral) },
+      { ALT: () => $.CONSUME(t.TextBlock) },
       { ALT: () => $.CONSUME(t.StringLiteral) },
       { ALT: () => $.CONSUME(t.Null) }
     ]);

packages/java-parser/src/tokens.js

@@ -224,6 +224,12 @@ createToken({
     "'(?:[^\\\\']|(?:(?:{{EscapeSequence}})|{{UnicodeInputCharacter}}))'"
   )
 });
+
+createToken({
+  name: "TextBlock",
+  pattern: /"""\s*\n(\\"|\s|.)*?"""/
+});
+
 createToken({
   name: "StringLiteral",
   pattern: MAKE_PATTERN('"(?:[^\\\\"]|{{StringCharacter}})*"')

packages/java-parser/test/test-block-spec.js

@@ -0,0 +1,113 @@
+"use strict";
+
+const { expect } = require("chai");
+
+const javaParser = require("../src/index");
+
+describe("The Java Parser should parse TextBlocks", () => {
+  it("should not parse a one word 'TextBlock'", () => {
+    const input = `"""word"""`;
+
+    expect(() => javaParser.parse(input, "literal")).to.throw();
+  });
+
+  it("should not parse a one word 'TextBlock' with starting spaces", () => {
+    const input = `"""   word"""`;
+
+    expect(() => javaParser.parse(input, "literal")).to.throw();
+  });
+
+  it("should parse a one word 'TextBlock' starting with new line", () => {
+    const input = `"""
+    one"""`;
+
+    expect(() => javaParser.parse(input, "literal")).to.not.throw();
+  });
+
+  it("should parse a one word 'TextBlock' starting with spaces and new line", () => {
+    const input = `"""${"    "}
+    one"""`;
+
+    expect(() => javaParser.parse(input, "literal")).to.not.throw();
+  });
+
+  it("should parse a one line 'TextBlock' starting with new line", () => {
+    const input = `"""
+    one sentence"""`;
+
+    expect(() => javaParser.parse(input, "literal")).to.not.throw();
+  });
+
+  it("should parse a one line 'TextBlock' starting with spaces and new line", () => {
+    const input = `"""${"    "}
+    one sentence"""`;
+
+    expect(() => javaParser.parse(input, "literal")).to.not.throw();
+  });
+
+  it("should parse a multiline 'TextBlock'", () => {
+    const input = `"""
+    one word
+
+    sentence
+
+    """`;
+
+    expect(() => javaParser.parse(input, "literal")).to.not.throw();
+  });
+
+  it("should not parse a multiline 'TextBlock' which do not start with new line", () => {
+    const input = `"""one word
+
+    sentence
+
+    """`;
+
+    expect(() => javaParser.parse(input, "literal")).to.throw();
+  });
+
+  it("should parse a multiline 'TextBlock' with ", () => {
+    const input = `"""
+    one word
+
+    "sentence"
+
+    """`;
+
+    expect(() => javaParser.parse(input, "literal")).to.not.throw();
+  });
+
+  it("should not parse a 'TextBlock' ending with 4x\"", () => {
+    const input = `"""
+    one word
+
+    "sentence"
+
+    """"`;
+
+    expect(() => javaParser.parse(input, "literal")).to.throw();
+  });
+
+  it("should not parse a 'TextBlock' ending with 4x\"", () => {
+    const input = `"""
+    one word
+
+    "sentence"""
+
+    ""`;
+
+    expect(() => javaParser.parse(input, "literal")).to.throw();
+  });
+
+  it("should not parse a 'TextBlock' ending with 4x\"", () => {
+    const input = `"""
+    my text
+
+
+    sentence\\"""
+
+    """
+    `;
+    expect(() => javaParser.parse(input, "literal")).to.not.throw();
+  });
+});