Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support string escaping #888

Merged
merged 2 commits into from
Jan 30, 2023
Merged

Support string escaping #888

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d50ac18
#885: Support string escaping
spoenemann Jan 27, 2023
63d607e
Fix terminal regex visitor
msujew Jan 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions examples/domainmodel/src/language-server/domain-model.langium
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ QualifiedName returns string:

hidden terminal WS: /\s+/;
terminal ID: /[_a-zA-Z][\w_]*/;
terminal INT returns number: /[0-9]+/;
terminal STRING: /"[^"]*"|'[^']*'/;

hidden terminal ML_COMMENT: /\/\*[\s\S]*?\*\//;
hidden terminal SL_COMMENT: /\/\/[^\n\r]*/;
24 changes: 0 additions & 24 deletions examples/domainmodel/src/language-server/generated/grammar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,30 +376,6 @@ export const DomainModelGrammar = (): Grammar => loadedDomainModelGrammar ?? (lo
"fragment": false,
"hidden": false
},
{
"$type": "TerminalRule",
"name": "INT",
"type": {
"$type": "ReturnType",
"name": "number"
},
"definition": {
"$type": "RegexToken",
"regex": "[0-9]+"
},
"fragment": false,
"hidden": false
},
{
"$type": "TerminalRule",
"name": "STRING",
"definition": {
"$type": "RegexToken",
"regex": "\\"[^\\"]*\\"|'[^']*'"
},
"fragment": false,
"hidden": false
},
{
"$type": "TerminalRule",
"hidden": true,
Expand Down
10 changes: 0 additions & 10 deletions examples/domainmodel/syntaxes/domain-model.tmLanguage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,6 @@
{
"name": "keyword.control.domain-model",
"match": "\\b(datatype|entity|extends|many|package)\\b"
},
{
"name": "string.quoted.double.domain-model",
"begin": "\"",
"end": "\""
},
{
"name": "string.quoted.single.domain-model",
"begin": "'",
"end": "'"
}
],
"repository": {
Expand Down
2 changes: 0 additions & 2 deletions examples/domainmodel/syntaxes/domainmodel.monarch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ export default {
tokenizer: {
initial: [
{ regex: /[_a-zA-Z][\w_]*/, action: { cases: { '@keywords': {"token":"keyword"}, '@default': {"token":"ID"} }} },
{ regex: /[0-9]+/, action: {"token":"number"} },
{ regex: /"[^"]*"|'[^']*'/, action: {"token":"string"} },
{ include: '@whitespace' },
{ regex: /@symbols/, action: { cases: { '@operators': {"token":"operator"}, '@default': {"token":""} }} },
],
Expand Down
2 changes: 1 addition & 1 deletion examples/requirements/src/language-server/common.langium
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Contact: 'contact' ':' user_name=STRING;
hidden terminal WS: /\s+/;
terminal ID: /[_a-zA-Z][\w_]*/;
terminal INT returns number: /[0-9]+/;
terminal STRING: /"[^"]*"|'[^']*'/;
terminal STRING: /"(\\.|[^"\\])*"|'(\\.|[^'\\])*'/;

hidden terminal ML_COMMENT: /\/\*[\s\S]*?\*\//;
hidden terminal SL_COMMENT: /\/\/[^\n\r]*/;
4 changes: 2 additions & 2 deletions examples/requirements/src/language-server/generated/grammar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ export const RequirementsGrammar = (): Grammar => loadedRequirementsGrammar ?? (
"name": "STRING",
"definition": {
"$type": "RegexToken",
"regex": "\\"[^\\"]*\\"|'[^']*'"
"regex": "\\"(\\\\\\\\.|[^\\"\\\\\\\\])*\\"|'(\\\\\\\\.|[^'\\\\\\\\])*'"
},
"fragment": false,
"hidden": false
Expand Down Expand Up @@ -590,7 +590,7 @@ export const TestsGrammar = (): Grammar => loadedTestsGrammar ?? (loadedTestsGra
"name": "STRING",
"definition": {
"$type": "RegexToken",
"regex": "\\"[^\\"]*\\"|'[^']*'"
"regex": "\\"(\\\\\\\\.|[^\\"\\\\\\\\])*\\"|'(\\\\\\\\.|[^'\\\\\\\\])*'"
},
"fragment": false,
"hidden": false
Expand Down
20 changes: 17 additions & 3 deletions examples/requirements/syntaxes/requirements.tmLanguage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,22 @@
{
"name": "string.quoted.double.requirements-lang",
"begin": "\"",
"end": "\""
"end": "\"",
"patterns": [
{
"include": "#string-character-escape"
}
]
},
{
"name": "string.quoted.single.requirements-lang",
"begin": "'",
"end": "'"
"end": "'",
"patterns": [
{
"include": "#string-character-escape"
}
]
}
],
"repository": {
Expand Down Expand Up @@ -52,6 +62,10 @@
"name": "comment.line.requirements-lang"
}
]
},
"string-character-escape": {
"name": "constant.character.escape.requirements-lang",
"match": "\\\\(x[0-9A-Fa-f]{2}|u[0-9A-Fa-f]{4}|u\\{[0-9A-Fa-f]+\\}|[0-2][0-7]{0,2}|3[0-6][0-7]?|37[0-7]?|[4-7][0-7]?|.|$)"
}
}
}
}
20 changes: 17 additions & 3 deletions examples/requirements/syntaxes/tests.tmLanguage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,22 @@
{
"name": "string.quoted.double.tests-lang",
"begin": "\"",
"end": "\""
"end": "\"",
"patterns": [
{
"include": "#string-character-escape"
}
]
},
{
"name": "string.quoted.single.tests-lang",
"begin": "'",
"end": "'"
"end": "'",
"patterns": [
{
"include": "#string-character-escape"
}
]
}
],
"repository": {
Expand Down Expand Up @@ -52,6 +62,10 @@
"name": "comment.line.tests-lang"
}
]
},
"string-character-escape": {
"name": "constant.character.escape.tests-lang",
"match": "\\\\(x[0-9A-Fa-f]{2}|u[0-9A-Fa-f]{4}|u\\{[0-9A-Fa-f]+\\}|[0-2][0-7]{0,2}|3[0-6][0-7]?|37[0-7]?|[4-7][0-7]?|.|$)"
}
}
}
}
24 changes: 0 additions & 24 deletions examples/statemachine/src/language-server/generated/grammar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,30 +303,6 @@ export const StatemachineGrammar = (): Grammar => loadedStatemachineGrammar ?? (
"fragment": false,
"hidden": false
},
{
"$type": "TerminalRule",
"name": "INT",
"type": {
"$type": "ReturnType",
"name": "number"
},
"definition": {
"$type": "RegexToken",
"regex": "[0-9]+"
},
"fragment": false,
"hidden": false
},
{
"$type": "TerminalRule",
"name": "STRING",
"definition": {
"$type": "RegexToken",
"regex": "\\"[^\\"]*\\"|'[^']*'"
},
"fragment": false,
"hidden": false
},
{
"$type": "TerminalRule",
"hidden": true,
Expand Down
2 changes: 0 additions & 2 deletions examples/statemachine/src/language-server/statemachine.langium
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ Transition:

hidden terminal WS: /\s+/;
terminal ID: /[_a-zA-Z][\w_]*/;
terminal INT returns number: /[0-9]+/;
terminal STRING: /"[^"]*"|'[^']*'/;

hidden terminal ML_COMMENT: /\/\*[\s\S]*?\*\//;
hidden terminal SL_COMMENT: /\/\/[^\n\r]*/;
2 changes: 0 additions & 2 deletions examples/statemachine/syntaxes/statemachine.monarch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ export default {
tokenizer: {
initial: [
{ regex: /[_a-zA-Z][\w_]*/, action: { cases: { '@keywords': {"token":"keyword"}, '@default': {"token":"ID"} }} },
{ regex: /[0-9]+/, action: {"token":"number"} },
{ regex: /"[^"]*"|'[^']*'/, action: {"token":"string"} },
{ include: '@whitespace' },
{ regex: /@symbols/, action: { cases: { '@operators': {"token":"operator"}, '@default': {"token":""} }} },
],
Expand Down
10 changes: 0 additions & 10 deletions examples/statemachine/syntaxes/statemachine.tmLanguage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,6 @@
{
"name": "keyword.control.statemachine",
"match": "\\b(actions|commands|end|events|initialState|state|statemachine)\\b"
},
{
"name": "string.quoted.double.statemachine",
"begin": "\"",
"end": "\""
},
{
"name": "string.quoted.single.statemachine",
"begin": "'",
"end": "'"
}
],
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion packages/generator-langium/langium-template/src/language-server/language-id.langium
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Greeting:
hidden terminal WS: /\s+/;
terminal ID: /[_a-zA-Z][\w_]*/;
terminal INT returns number: /[0-9]+/;
terminal STRING: /"[^"]*"|'[^']*'/;
terminal STRING: /"(\\.|[^"\\])*"|'(\\.|[^'\\])*'/;

hidden terminal ML_COMMENT: /\/\*[\s\S]*?\*\//;
hidden terminal SL_COMMENT: /\/\/[^\n\r]*/;
31 changes: 24 additions & 7 deletions packages/langium-cli/src/generator/highlighting/textmate-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Copyright 2021-2022 TypeFox GmbH
* This program and the accompanying materials are made available under the
* terms of the MIT License, which is available in the project root.
******************************************************************************/
******************************************************************************/

import {
escapeRegExp, getCaseInsensitivePattern, getTerminalParts, Grammar, GrammarAST, isCommentTerminal, stream
Expand All @@ -11,6 +11,8 @@ import { terminalRegex } from 'langium/lib/grammar/internal-grammar-util';
import { LangiumLanguageConfig } from '../../package';
import { collectKeywords } from '../util';

/* eslint-disable dot-notation */

export interface TextMateGrammar {
repository: Repository;
readonly scopeName: string;
Expand Down Expand Up @@ -71,7 +73,9 @@ function getPatterns(grammar: Grammar, config: LangiumLanguageConfig): Pattern[]
}

function getRepository(grammar: Grammar, config: LangiumLanguageConfig): Repository {
const repository: Repository = {};
const commentPatterns: Pattern[] = [];
let stringEscapePattern: Pattern | undefined;
for (const rule of grammar.rules) {
if (GrammarAST.isTerminalRule(rule) && isCommentTerminal(rule)) {
const parts = getTerminalParts(terminalRegex(rule));
Expand Down Expand Up @@ -105,14 +109,22 @@ function getRepository(grammar: Grammar, config: LangiumLanguageConfig): Reposit
});
}
}
} else if (GrammarAST.isTerminalRule(rule) && rule.name.toLowerCase() === 'string') {
stringEscapePattern = {
'name': `constant.character.escape.${config.id}`,
'match': '\\\\(x[0-9A-Fa-f]{2}|u[0-9A-Fa-f]{4}|u\\{[0-9A-Fa-f]+\\}|[0-2][0-7]{0,2}|3[0-6][0-7]?|37[0-7]?|[4-7][0-7]?|.|$)'
};
}
}
const repository: Repository = {
'comments': {
'patterns': commentPatterns
}
};

if (commentPatterns.length > 0) {
repository['comments'] = {
'patterns': commentPatterns
};
}
if (stringEscapePattern) {
repository['string-character-escape'] = stringEscapePattern;
}
return repository;
}

Expand Down Expand Up @@ -170,7 +182,12 @@ function getStringPatterns(grammar: Grammar, pack: LangiumLanguageConfig): Patte
stringPatterns.push({
'name': `string.quoted.${delimiterName(part.start)}.${pack.id}`,
'begin': part.start,
'end': part.end
'end': part.end,
'patterns': [
{
'include': '#string-character-escape'
}
]
});
}
}
Expand Down
26 changes: 20 additions & 6 deletions packages/langium-vscode/data/langium.tmLanguage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,22 @@
{
"name": "string.quoted.double.langium",
"begin": "\"",
"end": "\""
"end": "\"",
"patterns": [
{
"include": "#string-character-escape"
}
]
},
{
"name": "string.quoted.single.langium",
"begin": "'",
"end": "'"
"end": "'",
"patterns": [
{
"include": "#string-character-escape"
}
]
}
],
"repository": {
Expand Down Expand Up @@ -64,23 +74,27 @@
}
]
},
"string-character-escape": {
"name": "constant.character.escape.langium",
"match": "\\\\(x[0-9A-Fa-f]{2}|u[0-9A-Fa-f]{4}|u\\{[0-9A-Fa-f]+\\}|[0-2][0-7]{0,2}|3[0-6][0-7]?|37[0-7]?|[4-7][0-7]?|.|$)"
},
"regex": {
"patterns": [
{
"name": "string.regex.ts",
"name": "string.regex.langium",
"begin": "/(?![/*])(?=(?:[^/\\\\\\[]|\\\\.|\\[([^\\]\\\\]|\\\\.)+\\])+/(?![/*]))",
"beginCaptures": {
"0": {
"name": "punctuation.definition.string.begin.ts"
"name": "punctuation.definition.string.begin.langium"
}
},
"end": "/",
"endCaptures": {
"1": {
"name": "punctuation.definition.string.end.ts"
"name": "punctuation.definition.string.end.langium"
},
"2": {
"name": "keyword.other.ts"
"name": "keyword.other.langium"
}
},
"patterns": [
Expand Down
Loading