From e36be07141300b3300ce7347e9ee089c1a050da7 Mon Sep 17 00:00:00 2001 From: Kristóf Marussy Date: Wed, 3 Nov 2021 01:55:19 +0100 Subject: fix(web): fix autocomplete prefix behavior Always try to complete the current token if it is a terminal (e.g., true, false, unknown, and error after a : or an = sign). Autocomplete still only starts without being explicitly invoked if there is a QualifiedName to complete. Discard completions with a shorter prefix than the current token, because they would be filtered out by CodeMirror anyways. --- .../src/main/js/xtext/ContentAssistService.ts | 105 +++++++++++++++------ 1 file changed, 77 insertions(+), 28 deletions(-) (limited to 'language-web') diff --git a/language-web/src/main/js/xtext/ContentAssistService.ts b/language-web/src/main/js/xtext/ContentAssistService.ts index f085c5b1..65381b21 100644 --- a/language-web/src/main/js/xtext/ContentAssistService.ts +++ b/language-web/src/main/js/xtext/ContentAssistService.ts @@ -3,6 +3,7 @@ import type { CompletionContext, CompletionResult, } from '@codemirror/autocomplete'; +import { syntaxTree } from '@codemirror/language'; import type { Transaction } from '@codemirror/state'; import escapeStringRegexp from 'escape-string-regexp'; @@ -10,16 +11,69 @@ import type { UpdateService } from './UpdateService'; import { getLogger } from '../utils/logger'; import type { IContentAssistEntry } from './xtextServiceResults'; +const IMPLICIT_COMPLETION_TOKENS = [ + 'QualifiedName', + 'true', + 'false', + 'unknown', + 'error', +]; + const PROPOSALS_LIMIT = 1000; const IDENTIFIER_REGEXP_STR = '[a-zA-Z0-9_]*'; -const HIGH_PRIORITY_KEYWORDS = ['<->']; - -const QUALIFIED_NAME_SEPARATOR_REGEXP = /::/g; +const HIGH_PRIORITY_KEYWORDS = ['<->', '~>']; const log = getLogger('xtext.ContentAssistService'); +interface IFoundToken { + from: number; + + to: number; + + name: string; + + text: string; +} + +function findToken({ pos, state }: CompletionContext): IFoundToken | null { + const token = syntaxTree(state).resolveInner(pos, -1); + if (token === null) { + return null; + } + if (token.firstChild !== null) { + // We only autocomplete terminal nodes. If the current node is nonterminal, + // returning `null` makes us autocomplete with the empty prefix instead. + return null; + } + return { + from: token.from, + to: token.to, + name: token.name, + text: state.sliceDoc(token.from, token.to), + }; +} + +function shouldCompleteImplicitly(token: IFoundToken | null, context: CompletionContext): boolean { + return token !== null + && IMPLICIT_COMPLETION_TOKENS.includes(token.name) + && context.pos - token.from >= 2; +} + +function computeSpan(prefix: string, entryCount: number): RegExp { + const escapedPrefix = escapeStringRegexp(prefix); + if (entryCount < PROPOSALS_LIMIT) { + // Proposals with the current prefix fit the proposals limit. + // We can filter client side as long as the current prefix is preserved. + return new RegExp(`^${escapedPrefix}${IDENTIFIER_REGEXP_STR}$`); + } + // The current prefix overflows the proposals limits, + // so we have to fetch the completions again on the next keypress. + // Hopefully, it'll return a shorter list and we'll be able to filter client side. + return new RegExp(`^${escapedPrefix}$`); +} + function createCompletion(entry: IContentAssistEntry): Completion { let boost; switch (entry.kind) { @@ -33,7 +87,7 @@ function createCompletion(entry: IContentAssistEntry): Completion { break; default: { // Penalize qualified names (vs available unqualified names). - const extraSegments = entry.proposal.match(QUALIFIED_NAME_SEPARATOR_REGEXP)?.length || 0; + const extraSegments = entry.proposal.match(/::/g)?.length || 0; boost = Math.max(-5 * extraSegments, -50); } break; @@ -47,19 +101,6 @@ function createCompletion(entry: IContentAssistEntry): Completion { }; } -function computeSpan(prefix: string, entryCount: number) { - const escapedPrefix = escapeStringRegexp(prefix); - if (entryCount < PROPOSALS_LIMIT) { - // Proposals with the current prefix fit the proposals limit. - // We can filter client side as long as the current prefix is preserved. - return new RegExp(`^${escapedPrefix}${IDENTIFIER_REGEXP_STR}$`); - } - // The current prefix overflows the proposals limits, - // so we have to fetch the completions again on the next keypress. - // Hopefully, it'll return a shorter list and we'll be able to filter client side. - return new RegExp(`^${escapedPrefix}$`); -} - export class ContentAssistService { private readonly updateService: UpdateService; @@ -76,16 +117,16 @@ export class ContentAssistService { } async contentAssist(context: CompletionContext): Promise { - const tokenBefore = context.tokenBefore(['QualifiedName']); + const tokenBefore = findToken(context); + if (!context.explicit && !shouldCompleteImplicitly(tokenBefore, context)) { + return { + from: context.pos, + options: [], + }; + } let range: { from: number, to: number }; let prefix = ''; if (tokenBefore === null) { - if (!context.explicit) { - return { - from: context.pos, - options: [], - }; - } range = { from: context.pos, to: context.pos, @@ -124,7 +165,12 @@ export class ContentAssistService { } const options: Completion[] = []; entries.forEach((entry) => { - options.push(createCompletion(entry)); + if (prefix === entry.prefix) { + // Xtext will generate completions that do not complete the current token, + // e.g., `(` after trying to complete an indetifier, + // but we ignore those, since CodeMirror won't filter for them anyways. + options.push(createCompletion(entry)); + } }); log.debug('Fetched', options.length, 'completions from server'); this.lastCompletion = { @@ -137,7 +183,7 @@ export class ContentAssistService { private shouldReturnCachedCompletion( token: { from: number, to: number, text: string } | null, - ) { + ): boolean { if (token === null || this.lastCompletion === null) { return false; } @@ -147,10 +193,13 @@ export class ContentAssistService { return true; } const [transformedFrom, transformedTo] = this.mapRangeInclusive(lastFrom, lastTo); - return from >= transformedFrom && to <= transformedTo && span && span.exec(text); + return from >= transformedFrom + && to <= transformedTo + && typeof span !== 'undefined' + && span.exec(text) !== null; } - private shouldInvalidateCachedCompletion(transaction: Transaction) { + private shouldInvalidateCachedCompletion(transaction: Transaction): boolean { if (!transaction.docChanged || this.lastCompletion === null) { return false; } -- cgit v1.2.3-70-g09d2 From 6a03842b14b9e4ea1a29a7745acfab15875ffeeb Mon Sep 17 00:00:00 2001 From: Kristóf Marussy Date: Thu, 4 Nov 2021 20:17:45 +0100 Subject: fix(web): fix fold gutter styling We can't seem to be able to style the fold gutter in the current line to set its background color, so we set the background of the whole gutter instead. --- language-web/src/main/js/editor/EditorParent.ts | 9 +++++++-- language-web/src/main/js/editor/EditorStore.ts | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) (limited to 'language-web') diff --git a/language-web/src/main/js/editor/EditorParent.ts b/language-web/src/main/js/editor/EditorParent.ts index ee1323f6..2d74b863 100644 --- a/language-web/src/main/js/editor/EditorParent.ts +++ b/language-web/src/main/js/editor/EditorParent.ts @@ -34,6 +34,9 @@ export const EditorParent = styled('div')(({ theme }) => { '&, .cm-editor': { height: '100%', }, + '.cm-content': { + padding: 0, + }, '.cm-scroller, .cm-tooltip-autocomplete, .cm-completionLabel, .cm-completionDetail': { fontSize: 16, fontFamily: '"JetBrains MonoVariable", "JetBrains Mono", monospace', @@ -46,7 +49,7 @@ export const EditorParent = styled('div')(({ theme }) => { color: theme.palette.text.secondary, }, '.cm-gutters': { - background: theme.palette.background.default, + background: 'rgba(255, 255, 255, 0.1)', color: theme.palette.text.disabled, border: 'none', }, @@ -57,7 +60,9 @@ export const EditorParent = styled('div')(({ theme }) => { background: 'rgba(0, 0, 0, 0.3)', }, '.cm-activeLineGutter': { - background: 'rgba(0, 0, 0, 0.3)', + background: 'transparent', + }, + '.cm-lineNumbers .cm-activeLineGutter': { color: theme.palette.text.primary, }, '.cm-cursor, .cm-cursor-primary': { diff --git a/language-web/src/main/js/editor/EditorStore.ts b/language-web/src/main/js/editor/EditorStore.ts index ba31efcb..059233f4 100644 --- a/language-web/src/main/js/editor/EditorStore.ts +++ b/language-web/src/main/js/editor/EditorStore.ts @@ -112,8 +112,8 @@ export class EditorStore { }), semanticHighlighting, // We add the gutters to `extensions` in the order we want them to appear. - foldGutter(), lineNumbers(), + foldGutter(), keymap.of([ ...closeBracketsKeymap, ...commentKeymap, -- cgit v1.2.3-70-g09d2 From c5a6471251fd8728089d22dc1b0f0615af92c396 Mon Sep 17 00:00:00 2001 From: Kristóf Marussy Date: Fri, 5 Nov 2021 18:47:40 +0100 Subject: fix(lang): make default and scope non-contextual Contextual keywords make Xtext parsing more complicated and degrade content assist. --- language-web/src/main/js/language/problem.grammar | 4 ++-- language/src/main/java/tools/refinery/language/Problem.xtext | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'language-web') diff --git a/language-web/src/main/js/language/problem.grammar b/language-web/src/main/js/language/problem.grammar index c242a4ba..86cc7722 100644 --- a/language-web/src/main/js/language/problem.grammar +++ b/language-web/src/main/js/language/problem.grammar @@ -24,7 +24,7 @@ statement { RuleBody { ":" sep "~>" sep "." } } | Assertion { - ckw<"default">? (NotOp | UnknownOp)? RelationName + kw<"default">? (NotOp | UnknownOp)? RelationName ParameterList (":" LogicValue)? "." } | NodeValueAssertion { @@ -34,7 +34,7 @@ statement { ckw<"unique"> sep<",", UniqueNodeName> "." } | ScopeDeclaration { - ckw<"scope"> sep<",", ScopeElement> "." + kw<"scope"> sep<",", ScopeElement> "." } } diff --git a/language/src/main/java/tools/refinery/language/Problem.xtext b/language/src/main/java/tools/refinery/language/Problem.xtext index 6f6a8588..0fa47d63 100644 --- a/language/src/main/java/tools/refinery/language/Problem.xtext +++ b/language/src/main/java/tools/refinery/language/Problem.xtext @@ -154,7 +154,7 @@ ScopeDeclaration: "scope" typeScopes+=TypeScope ("," typeScopes+=TypeScope)* "."; TypeScope: - targetType=[ClassDeclaration] + targetType=[ClassDeclaration|QualifiedName] (increment?="+=" | "=") multiplicity=DefiniteMultiplicity; @@ -183,8 +183,8 @@ QualifiedName hidden(): Identifier ("::" Identifier)*; Identifier: - ID | "true" | "false" | "unknown" | "error" | "class" | "abstract" | "extends" | "enum" | "pred" | "scope" | - "unique" | "default" | "problem" | "new" | "delete"; + ID | "true" | "false" | "unknown" | "error" | "class" | "abstract" | "extends" | "enum" | "pred" | + "unique" | "problem" | "new" | "delete"; Integer returns ecore::EInt hidden(): "-"? INT; -- cgit v1.2.3-70-g09d2 From 10df138d6084000659626aaf50afb16e6b674b25 Mon Sep 17 00:00:00 2001 From: Kristóf Marussy Date: Fri, 5 Nov 2021 19:17:30 +0100 Subject: chore(web): implicit completion info in grammar Move information about which tokens should support implicit completions into the Lezer grammar. --- language-web/package.json | 1 + language-web/src/main/js/language/problem.grammar | 10 +++++++--- language-web/src/main/js/language/props.ts | 7 +++++++ language-web/src/main/js/xtext/ContentAssistService.ts | 15 ++++----------- language-web/yarn.lock | 2 +- 5 files changed, 20 insertions(+), 15 deletions(-) create mode 100644 language-web/src/main/js/language/props.ts (limited to 'language-web') diff --git a/language-web/package.json b/language-web/package.json index cb860c5f..3362a47a 100644 --- a/language-web/package.json +++ b/language-web/package.json @@ -85,6 +85,7 @@ "escape-string-regexp": "^5.0.0", "@fontsource/jetbrains-mono": "^4.5.0", "@fontsource/roboto": "^4.5.1", + "@lezer/common": "^0.15.7", "@lezer/lr": "^0.15.4", "loglevel": "^1.7.1", "loglevel-plugin-prefix": "^0.8.4", diff --git a/language-web/src/main/js/language/problem.grammar b/language-web/src/main/js/language/problem.grammar index 86cc7722..8e39243f 100644 --- a/language-web/src/main/js/language/problem.grammar +++ b/language-web/src/main/js/language/problem.grammar @@ -1,3 +1,7 @@ +@detectDelim + +@external prop implicitCompletion from '../../../../src/main/js/language/props.ts' + @top Problem { statement* } statement { @@ -89,11 +93,11 @@ VariableName { QualifiedName } NodeName { QualifiedName } -QualifiedName { identifier ("::" identifier)* } +QualifiedName[implicitCompletion=true] { identifier ("::" identifier)* } -kw { @specialize[@name={term}] } +kw { @specialize[@name={term},implicitCompletion=true] } -ckw { @extend[@name={term}] } +ckw { @extend[@name={term},implicitCompletion=true] } ParameterList { "(" sep<",", content> ")" } diff --git a/language-web/src/main/js/language/props.ts b/language-web/src/main/js/language/props.ts new file mode 100644 index 00000000..8e488bf5 --- /dev/null +++ b/language-web/src/main/js/language/props.ts @@ -0,0 +1,7 @@ +import { NodeProp } from '@lezer/common'; + +export const implicitCompletion = new NodeProp({ + deserialize(s: string) { + return s === 'true'; + }, +}); diff --git a/language-web/src/main/js/xtext/ContentAssistService.ts b/language-web/src/main/js/xtext/ContentAssistService.ts index 65381b21..aa9a80b0 100644 --- a/language-web/src/main/js/xtext/ContentAssistService.ts +++ b/language-web/src/main/js/xtext/ContentAssistService.ts @@ -7,18 +7,11 @@ import { syntaxTree } from '@codemirror/language'; import type { Transaction } from '@codemirror/state'; import escapeStringRegexp from 'escape-string-regexp'; +import { implicitCompletion } from '../language/props'; import type { UpdateService } from './UpdateService'; import { getLogger } from '../utils/logger'; import type { IContentAssistEntry } from './xtextServiceResults'; -const IMPLICIT_COMPLETION_TOKENS = [ - 'QualifiedName', - 'true', - 'false', - 'unknown', - 'error', -]; - const PROPOSALS_LIMIT = 1000; const IDENTIFIER_REGEXP_STR = '[a-zA-Z0-9_]*'; @@ -32,7 +25,7 @@ interface IFoundToken { to: number; - name: string; + implicitCompletion: boolean; text: string; } @@ -50,14 +43,14 @@ function findToken({ pos, state }: CompletionContext): IFoundToken | null { return { from: token.from, to: token.to, - name: token.name, + implicitCompletion: token.type.prop(implicitCompletion) || false, text: state.sliceDoc(token.from, token.to), }; } function shouldCompleteImplicitly(token: IFoundToken | null, context: CompletionContext): boolean { return token !== null - && IMPLICIT_COMPLETION_TOKENS.includes(token.name) + && token.implicitCompletion && context.pos - token.from >= 2; } diff --git a/language-web/yarn.lock b/language-web/yarn.lock index e05f4fa6..06b30508 100644 --- a/language-web/yarn.lock +++ b/language-web/yarn.lock @@ -1476,7 +1476,7 @@ resolved "https://registry.yarnpkg.com/@humanwhocodes/object-schema/-/object-schema-1.2.0.tgz#87de7af9c231826fdd68ac7258f77c429e0e5fcf" integrity sha512-wdppn25U8z/2yiaT6YGquE6X8sSv7hNMWSXYSSU1jGv/yd6XqjXgTDJ8KP4NgjTXfJ3GbRjeeb8RTV7a/VpM+w== -"@lezer/common@^0.15.0", "@lezer/common@^0.15.5": +"@lezer/common@^0.15.0", "@lezer/common@^0.15.5", "@lezer/common@^0.15.7": version "0.15.7" resolved "https://registry.yarnpkg.com/@lezer/common/-/common-0.15.7.tgz#8b445dae9777f689783132cf490770ece3c03d7b" integrity sha512-Rw8TDJnBzZnkyzIXs1Tmmd241FrBLJBj8gkdy3y0joGFb8Z4I/joKEsR+gv1pb13o1TMsZxm3fmP+d/wPt2CTQ== -- cgit v1.2.3-70-g09d2