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

Alias Completions Fixes #1188

Merged
merged 2 commits into from
May 15, 2024
Merged

Alias Completions Fixes #1188

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
c606c0e
Adds alias completions
markwpearce May 15, 2024
d38738d
Merge branch 'release-1.0.0' into alias_fixes
markwpearce May 15, 2024
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
71 changes: 71 additions & 0 deletions src/bscPlugin/completions/CompletionsProcessor.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2259,4 +2259,75 @@ describe('CompletionsProcessor', () => {
}]);
});
});

describe('alias', () => {
it('includes aliases', () => {
program.setFile('source/main.bs', `
alias APerson = Person
alias APi = Pi

namespace alpha
sub test()
print
end sub

sub pi()
print "Magnum"
end sub

enum Person
tall
short
end enum
end namespace

function Person()
return "John Doe"
end function

const PI = 3.14
`);
program.validate();
// print |
let completions = program.getCompletions('source/main.bs', util.createPosition(6, 31));
expectCompletionsIncludes(completions, [{
label: 'APi',
kind: CompletionItemKind.Constant
}, {
label: 'APerson',
kind: CompletionItemKind.Function
}]);
});


it('includes runtime and typetime symbols on RHS', () => {
program.setFile('source/main.bs', `
alias myAlias = a

function getPersonName()
return "John Doe"
end function

const PI = 3.14

interface SomeInterface
name as string
end interface
`);
program.validate();
// alias myAlias = a|
let completions = program.getCompletions('source/main.bs', util.createPosition(1, 33));
expectCompletionsIncludes(completions, [{
label: 'getPersonName',
kind: CompletionItemKind.Function
}, {
label: 'PI',
kind: CompletionItemKind.Constant
}, {
label: 'SomeInterface',
kind: CompletionItemKind.Interface
}]);
});

});
});
55 changes: 40 additions & 15 deletions src/bscPlugin/completions/CompletionsProcessor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { isBrsFile, isCallableType, isClassStatement, isClassType, isComponentType, isConstStatement, isEnumMemberType, isEnumType, isFunctionExpression, isInterfaceType, isMethodStatement, isNamespaceStatement, isNamespaceType, isNativeType, isTypedFunctionType, isXmlFile, isXmlScope } from '../../astUtils/reflection';
import type { FileReference, ProvideCompletionsEvent } from '../../interfaces';
import { isAliasStatement, isBrsFile, isCallableType, isClassStatement, isClassType, isComponentType, isConstStatement, isEnumMemberType, isEnumType, isFunctionExpression, isInterfaceType, isMethodStatement, isNamespaceStatement, isNamespaceType, isNativeType, isTypedFunctionType, isXmlFile, isXmlScope } from '../../astUtils/reflection';
import type { ExtraSymbolData, FileReference, ProvideCompletionsEvent } from '../../interfaces';
import type { BscFile } from '../../files/BscFile';
import { AllowedTriviaTokens, DeclarableTypes, Keywords, TokenKind } from '../../lexer/TokenKind';
import type { XmlScope } from '../../XmlScope';
Expand All @@ -18,7 +18,7 @@ import { BooleanType } from '../../types/BooleanType';
import { InvalidType } from '../../types/InvalidType';
import type { BscType } from '../../types/BscType';
import type { AstNode } from '../../parser/AstNode';
import type { ClassStatement, FunctionStatement, NamespaceStatement } from '../../parser/Statement';
import type { ClassStatement, FunctionStatement, NamespaceStatement, AliasStatement } from '../../parser/Statement';
import type { Token } from '../../lexer/Token';
import { createIdentifier } from '../../astUtils/creators';
import type { FunctionExpression } from '../../parser/Expression';
Expand Down Expand Up @@ -168,24 +168,29 @@ export class CompletionsProcessor {
return this.getLabelCompletion(functionScope);
}


if (file.getPreviousToken(currentToken)?.kind === TokenKind.Dot || file.isTokenNextToTokenKind(currentToken, TokenKind.Dot)) {
const dotToken = currentToken.kind === TokenKind.Dot ? currentToken : file.getTokenBefore(currentToken, TokenKind.Dot);
if (this.isTokenAdjacentTo(file, currentToken, TokenKind.Dot)) {
const dotToken = this.getAdjacentToken(file, currentToken, TokenKind.Dot);
beforeDotToken = file.getTokenBefore(dotToken);
expression = file.getClosestExpression(beforeDotToken?.range.end);
shouldLookForMembers = true;
} else if (file.getPreviousToken(currentToken)?.kind === TokenKind.Callfunc || file.isTokenNextToTokenKind(currentToken, TokenKind.Callfunc)) {
const dotToken = currentToken.kind === TokenKind.Callfunc ? currentToken : file.getTokenBefore(currentToken, TokenKind.Callfunc);
} else if (this.isTokenAdjacentTo(file, currentToken, TokenKind.Callfunc)) {
const dotToken = this.getAdjacentToken(file, currentToken, TokenKind.Callfunc);
beforeDotToken = file.getTokenBefore(dotToken);
expression = file.getClosestExpression(beforeDotToken?.range.end);
shouldLookForCallFuncMembers = true;
} else if (file.getPreviousToken(currentToken)?.kind === TokenKind.As || file.isTokenNextToTokenKind(currentToken, TokenKind.As)) {

} else if (this.isTokenAdjacentTo(file, currentToken, TokenKind.As)) {
if (file.parseMode === ParseMode.BrightScript) {
return NativeTypeCompletions;
}
expression = file.getClosestExpression(this.event.position);
symbolTableLookupFlag = SymbolTypeFlag.typetime;
} else if (this.isTokenAdjacentTo(file, currentToken, TokenKind.Equal)) {
expression = file.getClosestExpression(this.event.position);
if (expression.findAncestor<AliasStatement>(isAliasStatement)) {
// allow runtime and typetime lookups in alias statements
// eslint-disable-next-line no-bitwise
symbolTableLookupFlag = SymbolTypeFlag.runtime | SymbolTypeFlag.typetime;
}
} else {
expression = file.getClosestExpression(this.event.position);
}
Expand Down Expand Up @@ -326,10 +331,12 @@ export class CompletionsProcessor {
private getScopeSymbolCompletions(file: BrsFile, scope: Scope, symbolTableLookupFlag: SymbolTypeFlag) {
// get all scope available symbols

let scopeSymbols = file.parseMode === ParseMode.BrighterScript
const scopeSymbols = file.parseMode === ParseMode.BrighterScript
? [...scope.symbolTable.getOwnSymbols(symbolTableLookupFlag), ...scope.allNamespaceTypeTable.getOwnSymbols(symbolTableLookupFlag)]
: scope.symbolTable.getOwnSymbols(symbolTableLookupFlag);

const fileSymbols = file.ast.getSymbolTable().getOwnSymbols(symbolTableLookupFlag);
scopeSymbols.push(...fileSymbols);

const scopeAvailableSymbols = scopeSymbols.filter(sym => {
if (file.parseMode === ParseMode.BrighterScript) {
Expand Down Expand Up @@ -372,10 +379,20 @@ export class CompletionsProcessor {


private getCompletionKindFromSymbol(symbol: BscSymbol, areMembers = false) {
const type = symbol?.type;
let type = symbol?.type;
const extraData = symbol?.data;
const isInstance = extraData?.isInstance;
if (isConstStatement(extraData?.definingNode)) {
let definingNode = extraData?.definingNode;
let isAlias = extraData?.isAlias;
let isInstance = extraData?.isInstance;

if (isAliasStatement(extraData?.definingNode)) {
isAlias = true;
const aliasExtraData: ExtraSymbolData = {};
type = extraData.definingNode.value.getType({ flags: symbol.flags, data: aliasExtraData });
definingNode = aliasExtraData?.definingNode;
}

if (isConstStatement(definingNode)) {
return CompletionItemKind.Constant;
} else if (isClassType(type) && !isInstance) {
return CompletionItemKind.Class;
Expand All @@ -388,7 +405,7 @@ export class CompletionsProcessor {
nameMatchesType = true;
}
}
if (nameMatchesType) {
if (nameMatchesType || isAlias) {
return areMembers ? CompletionItemKind.Method : CompletionItemKind.Function;
}
} else if (isInterfaceType(type) && !isInstance) {
Expand Down Expand Up @@ -609,6 +626,14 @@ export class CompletionsProcessor {
}
return false;
}

private isTokenAdjacentTo(file: BrsFile, currentToken: Token, targetKind: TokenKind) {
return file.getPreviousToken(currentToken)?.kind === targetKind || file.isTokenNextToTokenKind(currentToken, targetKind);
}

private getAdjacentToken(file: BrsFile, currentToken: Token, targetKind: TokenKind) {
return currentToken.kind === targetKind ? currentToken : file.getTokenBefore(currentToken, targetKind);
}
}

/**
Expand Down