Skip to content

Add a new findReferences API that buckets results with the definition th... #2446

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

Merged
merged 3 commits into from
Mar 24, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
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
13 changes: 11 additions & 2 deletions src/compiler/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ module ts {

/* @internal */ export let checkTime = 0;

/* @internal */
export function getSymbolId(symbol: Symbol): number {
if (!symbol.id) {
symbol.id = nextSymbolId++;
}

return symbol.id;
}

export function createTypeChecker(host: TypeCheckerHost, produceDiagnostics: boolean): TypeChecker {
let Symbol = objectAllocator.getSymbolConstructor();
let Type = objectAllocator.getTypeConstructor();
Expand Down Expand Up @@ -250,8 +259,8 @@ module ts {

function getSymbolLinks(symbol: Symbol): SymbolLinks {
if (symbol.flags & SymbolFlags.Transient) return <TransientSymbol>symbol;
if (!symbol.id) symbol.id = nextSymbolId++;
return symbolLinks[symbol.id] || (symbolLinks[symbol.id] = {});
var id = getSymbolId(symbol);
return symbolLinks[id] || (symbolLinks[id] = {});
}

function getNodeLinks(node: Node): NodeLinks {
Expand Down
3 changes: 3 additions & 0 deletions src/harness/harnessLanguageService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,9 @@ module Harness.LanguageService {
getReferencesAtPosition(fileName: string, position: number): ts.ReferenceEntry[] {
return unwrapJSONCallResult(this.shim.getReferencesAtPosition(fileName, position));
}
findReferences(fileName: string, position: number): ts.ReferencedSymbol[] {
return unwrapJSONCallResult(this.shim.findReferences(fileName, position));
}
getOccurrencesAtPosition(fileName: string, position: number): ts.ReferenceEntry[] {
return unwrapJSONCallResult(this.shim.getOccurrencesAtPosition(fileName, position));
}
Expand Down
5 changes: 5 additions & 0 deletions src/server/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,11 @@ module ts.server {
});
}

findReferences(fileName: string, position: number): ReferencedSymbol[]{
// Not yet implemented.
return [];
}

getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[] {
var lineOffset = this.positionToOneBasedLineOffset(fileName, position);
var args: protocol.FileLocationRequestArgs = {
Expand Down
268 changes: 185 additions & 83 deletions src/services/services.ts

Large diffs are not rendered by default.

19 changes: 14 additions & 5 deletions src/services/shims.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,12 @@ module ts {
* { fileName: string; textSpan: { start: number; length: number}; isWriteAccess: boolean }[]
*/
getReferencesAtPosition(fileName: string, position: number): string;

/**
* Returns a JSON-encoded value of the type:
* { definition: <encoded>; references: <encoded>[] }[]
*/
findReferences(fileName: string, position: number): string;

/**
* Returns a JSON-encoded value of the type:
Expand Down Expand Up @@ -555,11 +561,6 @@ module ts {

/// GET REFERENCES

/**
* Return references to a symbol at the requested position.
* References are separated by "\n".
* Each reference is a "fileindex min lim" sub-string.
*/
public getReferencesAtPosition(fileName: string, position: number): string {
return this.forwardJSONCall(
"getReferencesAtPosition('" + fileName + "', " + position + ")",
Expand All @@ -568,6 +569,14 @@ module ts {
});
}

public findReferences(fileName: string, position: number): string {
return this.forwardJSONCall(
"findReferences('" + fileName + "', " + position + ")",
() => {
return this.languageService.findReferences(fileName, position);
});
}

public getOccurrencesAtPosition(fileName: string, position: number): string {
return this.forwardJSONCall(
"getOccurrencesAtPosition('" + fileName + "', " + position + ")",
Expand Down
5 changes: 5 additions & 0 deletions tests/baselines/reference/APISample_compile.js
Original file line number Diff line number Diff line change
Expand Up @@ -1589,6 +1589,7 @@ declare module "typescript" {
getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[];
getOccurrencesAtPosition(fileName: string, position: number): ReferenceEntry[];
findReferences(fileName: string, position: number): ReferencedSymbol[];
getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
getNavigationBarItems(fileName: string): NavigationBarItem[];
getOutliningSpans(fileName: string): OutliningSpan[];
Expand Down Expand Up @@ -1675,6 +1676,10 @@ declare module "typescript" {
containerKind: string;
containerName: string;
}
interface ReferencedSymbol {
definition: DefinitionInfo;
references: ReferenceEntry[];
}
enum SymbolDisplayPartKind {
aliasName = 0,
className = 1,
Expand Down
17 changes: 17 additions & 0 deletions tests/baselines/reference/APISample_compile.types
Original file line number Diff line number Diff line change
Expand Up @@ -5154,6 +5154,12 @@ declare module "typescript" {
>position : number
>ReferenceEntry : ReferenceEntry

findReferences(fileName: string, position: number): ReferencedSymbol[];
>findReferences : (fileName: string, position: number) => ReferencedSymbol[]
>fileName : string
>position : number
>ReferencedSymbol : ReferencedSymbol

getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
>getNavigateToItems : (searchValue: string, maxResultCount?: number) => NavigateToItem[]
>searchValue : string
Expand Down Expand Up @@ -5424,6 +5430,17 @@ declare module "typescript" {

containerName: string;
>containerName : string
}
interface ReferencedSymbol {
>ReferencedSymbol : ReferencedSymbol

definition: DefinitionInfo;
>definition : DefinitionInfo
>DefinitionInfo : DefinitionInfo

references: ReferenceEntry[];
>references : ReferenceEntry[]
>ReferenceEntry : ReferenceEntry
}
enum SymbolDisplayPartKind {
>SymbolDisplayPartKind : SymbolDisplayPartKind
Expand Down
5 changes: 5 additions & 0 deletions tests/baselines/reference/APISample_linter.js
Original file line number Diff line number Diff line change
Expand Up @@ -1620,6 +1620,7 @@ declare module "typescript" {
getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[];
getOccurrencesAtPosition(fileName: string, position: number): ReferenceEntry[];
findReferences(fileName: string, position: number): ReferencedSymbol[];
getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
getNavigationBarItems(fileName: string): NavigationBarItem[];
getOutliningSpans(fileName: string): OutliningSpan[];
Expand Down Expand Up @@ -1706,6 +1707,10 @@ declare module "typescript" {
containerKind: string;
containerName: string;
}
interface ReferencedSymbol {
definition: DefinitionInfo;
references: ReferenceEntry[];
}
enum SymbolDisplayPartKind {
aliasName = 0,
className = 1,
Expand Down
17 changes: 17 additions & 0 deletions tests/baselines/reference/APISample_linter.types
Original file line number Diff line number Diff line change
Expand Up @@ -5300,6 +5300,12 @@ declare module "typescript" {
>position : number
>ReferenceEntry : ReferenceEntry

findReferences(fileName: string, position: number): ReferencedSymbol[];
>findReferences : (fileName: string, position: number) => ReferencedSymbol[]
>fileName : string
>position : number
>ReferencedSymbol : ReferencedSymbol

getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
>getNavigateToItems : (searchValue: string, maxResultCount?: number) => NavigateToItem[]
>searchValue : string
Expand Down Expand Up @@ -5570,6 +5576,17 @@ declare module "typescript" {

containerName: string;
>containerName : string
}
interface ReferencedSymbol {
>ReferencedSymbol : ReferencedSymbol

definition: DefinitionInfo;
>definition : DefinitionInfo
>DefinitionInfo : DefinitionInfo

references: ReferenceEntry[];
>references : ReferenceEntry[]
>ReferenceEntry : ReferenceEntry
}
enum SymbolDisplayPartKind {
>SymbolDisplayPartKind : SymbolDisplayPartKind
Expand Down
5 changes: 5 additions & 0 deletions tests/baselines/reference/APISample_transform.js
Original file line number Diff line number Diff line change
Expand Up @@ -1621,6 +1621,7 @@ declare module "typescript" {
getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[];
getOccurrencesAtPosition(fileName: string, position: number): ReferenceEntry[];
findReferences(fileName: string, position: number): ReferencedSymbol[];
getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
getNavigationBarItems(fileName: string): NavigationBarItem[];
getOutliningSpans(fileName: string): OutliningSpan[];
Expand Down Expand Up @@ -1707,6 +1708,10 @@ declare module "typescript" {
containerKind: string;
containerName: string;
}
interface ReferencedSymbol {
definition: DefinitionInfo;
references: ReferenceEntry[];
}
enum SymbolDisplayPartKind {
aliasName = 0,
className = 1,
Expand Down
17 changes: 17 additions & 0 deletions tests/baselines/reference/APISample_transform.types
Original file line number Diff line number Diff line change
Expand Up @@ -5250,6 +5250,12 @@ declare module "typescript" {
>position : number
>ReferenceEntry : ReferenceEntry

findReferences(fileName: string, position: number): ReferencedSymbol[];
>findReferences : (fileName: string, position: number) => ReferencedSymbol[]
>fileName : string
>position : number
>ReferencedSymbol : ReferencedSymbol

getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
>getNavigateToItems : (searchValue: string, maxResultCount?: number) => NavigateToItem[]
>searchValue : string
Expand Down Expand Up @@ -5520,6 +5526,17 @@ declare module "typescript" {

containerName: string;
>containerName : string
}
interface ReferencedSymbol {
>ReferencedSymbol : ReferencedSymbol

definition: DefinitionInfo;
>definition : DefinitionInfo
>DefinitionInfo : DefinitionInfo

references: ReferenceEntry[];
>references : ReferenceEntry[]
>ReferenceEntry : ReferenceEntry
}
enum SymbolDisplayPartKind {
>SymbolDisplayPartKind : SymbolDisplayPartKind
Expand Down
5 changes: 5 additions & 0 deletions tests/baselines/reference/APISample_watcher.js
Original file line number Diff line number Diff line change
Expand Up @@ -1658,6 +1658,7 @@ declare module "typescript" {
getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[];
getOccurrencesAtPosition(fileName: string, position: number): ReferenceEntry[];
findReferences(fileName: string, position: number): ReferencedSymbol[];
getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
getNavigationBarItems(fileName: string): NavigationBarItem[];
getOutliningSpans(fileName: string): OutliningSpan[];
Expand Down Expand Up @@ -1744,6 +1745,10 @@ declare module "typescript" {
containerKind: string;
containerName: string;
}
interface ReferencedSymbol {
definition: DefinitionInfo;
references: ReferenceEntry[];
}
enum SymbolDisplayPartKind {
aliasName = 0,
className = 1,
Expand Down
17 changes: 17 additions & 0 deletions tests/baselines/reference/APISample_watcher.types
Original file line number Diff line number Diff line change
Expand Up @@ -5423,6 +5423,12 @@ declare module "typescript" {
>position : number
>ReferenceEntry : ReferenceEntry

findReferences(fileName: string, position: number): ReferencedSymbol[];
>findReferences : (fileName: string, position: number) => ReferencedSymbol[]
>fileName : string
>position : number
>ReferencedSymbol : ReferencedSymbol

getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[];
>getNavigateToItems : (searchValue: string, maxResultCount?: number) => NavigateToItem[]
>searchValue : string
Expand Down Expand Up @@ -5693,6 +5699,17 @@ declare module "typescript" {

containerName: string;
>containerName : string
}
interface ReferencedSymbol {
>ReferencedSymbol : ReferencedSymbol

definition: DefinitionInfo;
>definition : DefinitionInfo
>DefinitionInfo : DefinitionInfo

references: ReferenceEntry[];
>references : ReferenceEntry[]
>ReferenceEntry : ReferenceEntry
}
enum SymbolDisplayPartKind {
>SymbolDisplayPartKind : SymbolDisplayPartKind
Expand Down
2 changes: 1 addition & 1 deletion tests/cases/fourslash/findAllRefsInsideWithBlock.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ goTo.marker('1');
verify.referencesCountIs(3);

goTo.marker('2');
verify.referencesCountIs(1);
verify.referencesCountIs(0);
2 changes: 1 addition & 1 deletion tests/cases/fourslash/getOccurrencesOfUndefinedSymbol.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@

// "any" should not be highlighted
goTo.marker();
verify.occurrencesAtPositionCount(1);
verify.occurrencesAtPositionCount(0);
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ for (var i = 1; i <= test.markers().length; i++) {
verify.occurrencesAtPositionCount(8);
break;
case 4:
case 5:
case 8:
verify.occurrencesAtPositionCount(1);
break;
case 6:
case 7:
case 9:
verify.occurrencesAtPositionCount(8);
break;
case 5:
case 8:
case 10:
case 11:
case 12:
Expand Down
2 changes: 1 addition & 1 deletion tests/cases/fourslash/getOccurrencesThisNegatives2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -143,5 +143,5 @@

test.markers().forEach(m => {
goTo.position(m.position, m.fileName)
verify.occurrencesAtPositionCount(1);
verify.occurrencesAtPositionCount(0);
});
2 changes: 2 additions & 0 deletions tests/cases/fourslash/getOccurrencesTryCatchFinallyBroken.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ for (var i = 1; i <= test.markers().length; i++) {

switch (i) {
case 1:
verify.occurrencesAtPositionCount(0);
break;
case 2:
case 3:
verify.occurrencesAtPositionCount(1);
Expand Down
2 changes: 1 addition & 1 deletion tests/cases/fourslash/localGetReferences.ts
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ verify.referencesCountIs(7);

// References to unresolved symbol.
goTo.marker("12");
verify.referencesCountIs(1);
verify.referencesCountIs(0);

// References to no context.
goTo.marker("13");
Expand Down
4 changes: 2 additions & 2 deletions tests/cases/fourslash/referencesForIllegalAssignment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
////ba/*4*/r = b/*5*/ar + 1;

goTo.marker("1");
verify.referencesCountIs(1);
verify.referencesCountIs(0);

goTo.marker("2");
verify.referencesCountIs(1);
verify.referencesCountIs(0);

goTo.marker("3");
verify.referencesCountIs(3);
Expand Down
2 changes: 1 addition & 1 deletion tests/cases/fourslash/referencesForIndexProperty2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
////a[/*1*/"blah"];

goTo.marker("1");
verify.referencesCountIs(1);
verify.referencesCountIs(0);
2 changes: 1 addition & 1 deletion tests/cases/fourslash/referencesForLabel2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
////}

goTo.marker("1");
verify.referencesCountIs(1);
verify.referencesCountIs(0);