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.

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

Resolve transitive imports in grammar #1113

Merged
merged 2 commits into from
Jul 7, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
28 changes: 24 additions & 4 deletions packages/langium/src/grammar/references/grammar-scope.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,23 @@ import type { LangiumServices } from '../../services';
import type { AstNode, AstNodeDescription, ReferenceInfo } from '../../syntax-tree';
import type { Stream } from '../../utils/stream';
import type { AstNodeLocator } from '../../workspace/ast-node-locator';
import type { DocumentSegment, LangiumDocument, PrecomputedScopes } from '../../workspace/documents';
import type { DocumentSegment, LangiumDocument, LangiumDocuments, PrecomputedScopes } from '../../workspace/documents';
import type { Grammar } from '../generated/ast';
import { DefaultScopeComputation } from '../../references/scope-computation';
import { DefaultScopeProvider, EMPTY_SCOPE, StreamScope } from '../../references/scope-provider';
import { findRootNode, getContainerOfType, getDocument, streamAllContents } from '../../utils/ast-util';
import { toDocumentSegment } from '../../utils/cst-util';
import { stream } from '../../utils/stream';
import { equalURI } from '../../utils/uri-util';
import { AbstractType, Interface, isAction, isGrammar, isParserRule, isReturnType, Type } from '../generated/ast';
import { getActionType, resolveImportUri } from '../internal-grammar-util';

export class LangiumGrammarScopeProvider extends DefaultScopeProvider {

protected readonly langiumDocuments: LangiumDocuments;

constructor(services: LangiumServices) {
super(services);
this.langiumDocuments = services.shared.workspace.LangiumDocuments;
}

override getScope(context: ReferenceInfo): Scope {
Expand Down Expand Up @@ -58,15 +61,32 @@ export class LangiumGrammarScopeProvider extends DefaultScopeProvider {
if (!grammar) {
return EMPTY_SCOPE;
}
const importedUris = stream(grammar.imports).map(resolveImportUri).nonNullable();
const importedUris = new Set<string>();
this.gatherImports(grammar, importedUris);
let importedElements = this.indexManager.allElements(referenceType)
.filter(des => importedUris.some(importedUri => equalURI(des.documentUri, importedUri)));
.filter(des => importedUris.has(des.documentUri.toString()));
if (referenceType === AbstractType) {
importedElements = importedElements.filter(des => des.type === Interface || des.type === Type);
}
return new StreamScope(importedElements);
}

private gatherImports(grammar: Grammar, importedUris: Set<string>): void {
for (const imp0rt of grammar.imports) {
const uri = resolveImportUri(imp0rt);
if (uri && !importedUris.has(uri.toString())) {
importedUris.add(uri.toString());
if (this.langiumDocuments.hasDocument(uri)) {
const importedDocument = this.langiumDocuments.getOrCreateDocument(uri);
const rootNode = importedDocument.parseResult.value;
if (isGrammar(rootNode)) {
this.gatherImports(rootNode, importedUris);
}
}
}
}
}

}

export class LangiumGrammarScopeComputation extends DefaultScopeComputation {
Expand Down
29 changes: 29 additions & 0 deletions packages/langium/test/grammar/references/grammar-scope.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,33 @@ describe('Type Linking', () => {
expect(reference?.type.ref).toBe(declaredType);
});

test('Linking declared in transitively imported file', async () => {
const grammar1 = await parse(`
interface A {
a: string
}
`);
const grammar2 = await parse(`
import './${Utils.basename(grammar1.uri)}'
A returns A:
'A' a=ID;
terminal ID: /[_a-zA-Z][\\w_]*/;
`);
const grammar3 = await parse(`
grammar Debug
import './${Utils.basename(grammar2.uri)}'
interface B {
b: @A
}
entry Model:
(b+=B | a+=A)*;
B returns B:
'B' b=[A:ID];
`);
await services.shared.workspace.DocumentBuilder.build([grammar3, grammar2, grammar1]);
const reference = locator.getAstNode<CrossReference>(grammar3.parseResult.value, 'rules@1/definition/elements@1/terminal');
const declaredType = locator.getAstNode<Interface>(grammar1.parseResult.value, 'interfaces@0');
expect(reference?.type.ref).toBe(declaredType);
});

});