Skip to content

Commit

Permalink
Merge pull request #159305 from microsoft/aiday/issue159136
Browse files Browse the repository at this point in the history 
Sticky Scroll : when several outline models are available, choose the one spanning the biggest total range
  • Loading branch information
Aiday Marlen Kyzy authored Aug 30, 2022
2 parents 3965d65 + d3a964d commit 9332731
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 19 deletions.
1 change: 1 addition & 0 deletions src/vs/editor/contrib/documentSymbols/browser/outlineModel.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ export class OutlineModel extends TreeElement {
const id = TreeElement.findId(`provider_${index}`, result);
const group = new OutlineGroup(id, result, provider.displayName ?? 'Unknown Outline Provider', index);


return Promise.resolve(provider.provideDocumentSymbols(textModel, cts.token)).then(result => {
for (const info of result || []) {
OutlineModel._makeOutlineElement(info, group);
Expand Down
88 changes: 69 additions & 19 deletions src/vs/editor/contrib/stickyScroll/browser/stickyScrollProvider.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { RunOnceScheduler } from 'vs/base/common/async';
import { Range } from 'vs/editor/common/core/range';
import { Emitter } from 'vs/base/common/event';
import { binarySearch } from 'vs/base/common/arrays';
import { Iterable } from 'vs/base/common/iterator';
import { FoldingController } from 'vs/editor/contrib/folding/browser/folding';
import { FoldingModel } from 'vs/editor/contrib/folding/browser/foldingModel';

Expand Down Expand Up @@ -44,6 +45,7 @@ export class StickyLineCandidateProvider extends Disposable {
private _outlineModel: StickyOutlineElement | undefined;
private readonly _sessionStore: DisposableStore = new DisposableStore();
private _modelVersionId: number = 0;
private _providerID: string | undefined = undefined;

constructor(
editor: ICodeEditor,
Expand All @@ -67,10 +69,16 @@ export class StickyLineCandidateProvider extends Disposable {
this._sessionStore.clear();
return;
} else {
this._sessionStore.add(this._editor.onDidChangeModel(() => this.update()));
this._sessionStore.add(this._editor.onDidChangeModel(() => {
this._providerID = undefined;
this.update();
}));
this._sessionStore.add(this._editor.onDidChangeHiddenAreas(() => this.update()));
this._sessionStore.add(this._editor.onDidChangeModelContent(() => this._updateSoon.schedule()));
this._sessionStore.add(this._languageFeaturesService.documentSymbolProvider.onDidChange(() => this.update()));
this._sessionStore.add(this._languageFeaturesService.documentSymbolProvider.onDidChange(() => {
this._providerID = undefined;
this.update();
}));
this.update();
}
}
Expand All @@ -95,7 +103,9 @@ export class StickyLineCandidateProvider extends Disposable {
return;
}
if (outlineModel.children.size !== 0) {
this._outlineModel = StickyOutlineElement.fromOutlineModel(outlineModel, -1);
const { stickyOutlineElement, providerID } = StickyOutlineElement.fromOutlineModel(outlineModel, this._providerID);
this._outlineModel = stickyOutlineElement;
this._providerID = providerID;
} else {
const foldingController = FoldingController.get(this._editor);
const foldingModel = await foldingController?.getFoldingModel();
Expand Down Expand Up @@ -177,18 +187,16 @@ export class StickyLineCandidateProvider extends Disposable {
}

class StickyOutlineElement {
public static fromOutlineModel(outlineModel: OutlineModel | OutlineElement | OutlineGroup, previousStartLine: number): StickyOutlineElement {

public static fromOutlineElement(outlineElement: OutlineElement, previousStartLine: number): StickyOutlineElement {
const children: StickyOutlineElement[] = [];
for (const child of outlineModel.children.values()) {
if (child instanceof OutlineGroup || child instanceof OutlineModel) {
children.push(StickyOutlineElement.fromOutlineModel(child, previousStartLine));
} else if (child instanceof OutlineElement && child.symbol.selectionRange.startLineNumber !== child.symbol.range.endLineNumber) {
for (const child of outlineElement.children.values()) {
if (child.symbol.selectionRange.startLineNumber !== child.symbol.range.endLineNumber) {
if (child.symbol.selectionRange.startLineNumber !== previousStartLine) {
children.push(StickyOutlineElement.fromOutlineModel(child, child.symbol.selectionRange.startLineNumber));
children.push(StickyOutlineElement.fromOutlineElement(child, child.symbol.selectionRange.startLineNumber));
} else {
for (const subchild of child.children.values()) {
children.push(StickyOutlineElement.fromOutlineModel(subchild, child.symbol.selectionRange.startLineNumber));
children.push(StickyOutlineElement.fromOutlineElement(subchild, child.symbol.selectionRange.startLineNumber));
}
}
}
Expand All @@ -202,17 +210,59 @@ class StickyOutlineElement {
return child2.range.endLineNumber - child1.range.endLineNumber;
}
});
let range: StickyRange | undefined;
if (outlineModel instanceof OutlineElement) {
range = new StickyRange(outlineModel.symbol.selectionRange.startLineNumber, outlineModel.symbol.range.endLineNumber);
const range = new StickyRange(outlineElement.symbol.selectionRange.startLineNumber, outlineElement.symbol.range.endLineNumber);
return new StickyOutlineElement(range, children, undefined);
}

public static fromOutlineModel(outlineModel: OutlineModel, providerID: string | undefined): { stickyOutlineElement: StickyOutlineElement; providerID: string | undefined } {

let ID: string | undefined = providerID;
let outlineElements: Map<string, OutlineElement>;
// When several possible outline providers
if (Iterable.first(outlineModel.children.values()) instanceof OutlineGroup) {
const provider = Iterable.find(outlineModel.children.values(), outlineGroupOfModel => outlineGroupOfModel.id === providerID);
if (provider) {
outlineElements = provider.children;
} else {
let tempID = '';
let maxTotalSumOfRanges = 0;
let optimalOutlineGroup = undefined;
for (const [_key, outlineGroup] of outlineModel.children.entries()) {
const totalSumRanges = StickyOutlineElement.findSumOfRangesOfGroup(outlineGroup);
if (totalSumRanges > maxTotalSumOfRanges) {
optimalOutlineGroup = outlineGroup;
maxTotalSumOfRanges = totalSumRanges;
tempID = outlineGroup.id;
}
}
ID = tempID;
outlineElements = optimalOutlineGroup!.children;
}
} else {
range = undefined;
outlineElements = outlineModel.children as Map<string, OutlineElement>;
}
const stickyChildren: StickyOutlineElement[] = [];
for (const outlineElement of outlineElements.values()) {
stickyChildren.push(StickyOutlineElement.fromOutlineElement(outlineElement, outlineElement.symbol.selectionRange.startLineNumber));
}
const stickyOutlineElement = new StickyOutlineElement(undefined, stickyChildren, undefined);

return {
stickyOutlineElement: stickyOutlineElement,
providerID: ID
};
}

private static findSumOfRangesOfGroup(outline: OutlineGroup | OutlineElement): number {
let res = 0;
for (const child of outline.children.values()) {
res += this.findSumOfRangesOfGroup(child);
}
if (outline instanceof OutlineElement) {
return res + outline.symbol.range.endLineNumber - outline.symbol.selectionRange.startLineNumber;
} else {
return res;
}
return new StickyOutlineElement(
range,
children,
undefined
);
}

public static fromFoldingModel(foldingModel: FoldingModel): StickyOutlineElement {
Expand Down
1 change: 1 addition & 0 deletions src/vs/editor/contrib/stickyScroll/test/browser/stickyScroll.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ suite('Sticky Scroll Tests', () => {
await withAsyncTestCodeEditor(model, { serviceCollection }, async (editor, _viewModel, instantiationService) => {

const stickyScrollController: StickyScrollController = editor.registerAndInstantiateContribution(StickyScrollController.ID, StickyScrollController);
await stickyScrollController.stickyScrollCandidateProvider.update();
const lineHeight = editor.getOption(EditorOption.lineHeight);

const languageService = instantiationService.get(ILanguageFeaturesService);
Expand Down

0 comments on commit 9332731

Please sign in to comment.