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

Tests written for Sticky Scroll #158266

Merged
merged 8 commits into from
Aug 19, 2022
Merged

Tests written for Sticky Scroll #158266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bd3e16b
Initial skeleton of sticky scroll test
Aug 12, 2022
b595675
work in progress
Aug 12, 2022
22c1836
Merge branch 'main' into aiday/stickyScrollTesting
Aug 12, 2022
930de55
Work in progress
Aug 16, 2022
af08b4f
Tests committed
Aug 16, 2022
fc4e65a
Merge branch 'main' into aiday/stickyScrollTesting
Aug 16, 2022
447f054
Formatting the stickyScroll.ts file
Aug 16, 2022
b6f53f1
Merge branch 'main' into aiday/stickyScrollTesting
Aug 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
84 changes: 47 additions & 37 deletions src/vs/editor/contrib/stickyScroll/browser/stickyScrollController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,53 +12,62 @@ import { StickyScrollWidget, StickyScrollWidgetState } from './stickyScrollWidge
import { StickyLineCandidateProvider, StickyRange } from './stickyScrollProvider';
import { IModelTokensChangedEvent } from 'vs/editor/common/textModelEvents';


export class StickyScrollController extends Disposable implements IEditorContribution {

static readonly ID = 'store.contrib.stickyScrollController';
private readonly editor: ICodeEditor;
private readonly stickyScrollWidget: StickyScrollWidget;
private readonly stickyLineCandidateProvider: StickyLineCandidateProvider;
private readonly sessionStore: DisposableStore = new DisposableStore();
private readonly _editor: ICodeEditor;
private readonly _stickyScrollWidget: StickyScrollWidget;
private readonly _stickyLineCandidateProvider: StickyLineCandidateProvider;
private readonly _sessionStore: DisposableStore = new DisposableStore();
private _widgetState: StickyScrollWidgetState;

constructor(
editor: ICodeEditor,
_editor: ICodeEditor,
@ILanguageFeaturesService _languageFeaturesService: ILanguageFeaturesService,
) {
super();
this.editor = editor;
this.stickyScrollWidget = new StickyScrollWidget(this.editor);
this.stickyLineCandidateProvider = new StickyLineCandidateProvider(this.editor, _languageFeaturesService);
this._editor = _editor;
this._stickyScrollWidget = new StickyScrollWidget(this._editor);
this._stickyLineCandidateProvider = new StickyLineCandidateProvider(this._editor, _languageFeaturesService);
this._widgetState = new StickyScrollWidgetState([], 0);

this._register(this.editor.onDidChangeConfiguration(e => {
this._register(this._editor.onDidChangeConfiguration(e => {
if (e.hasChanged(EditorOption.experimental)) {
this.readConfiguration();
}
}));
this.readConfiguration();
}

public get stickyScrollCandidateProvider() {
return this._stickyLineCandidateProvider;
}

public get stickyScrollWidgetState() {
return this._widgetState;
}

private readConfiguration() {
const options = this.editor.getOption(EditorOption.experimental);
const options = this._editor.getOption(EditorOption.experimental);
if (options.stickyScroll.enabled === false) {
this.editor.removeOverlayWidget(this.stickyScrollWidget);
this.sessionStore.clear();
this._editor.removeOverlayWidget(this._stickyScrollWidget);
this._sessionStore.clear();
return;
} else {
this.editor.addOverlayWidget(this.stickyScrollWidget);
this.sessionStore.add(this.editor.onDidScrollChange(() => this.renderStickyScroll()));
this.sessionStore.add(this.editor.onDidLayoutChange(() => this.onDidResize()));
this.sessionStore.add(this.editor.onDidChangeModelTokens((e) => this.onTokensChange(e)));
this.sessionStore.add(this.stickyLineCandidateProvider.onStickyScrollChange(() => this.renderStickyScroll()));
const lineNumberOption = this.editor.getOption(EditorOption.lineNumbers);
this._editor.addOverlayWidget(this._stickyScrollWidget);
this._sessionStore.add(this._editor.onDidScrollChange(() => this.renderStickyScroll()));
this._sessionStore.add(this._editor.onDidLayoutChange(() => this.onDidResize()));
this._sessionStore.add(this._editor.onDidChangeModelTokens((e) => this.onTokensChange(e)));
this._sessionStore.add(this._stickyLineCandidateProvider.onStickyScrollChange(() => this.renderStickyScroll()));
const lineNumberOption = this._editor.getOption(EditorOption.lineNumbers);
if (lineNumberOption.renderType === RenderLineNumbersType.Relative) {
this.sessionStore.add(this.editor.onDidChangeCursorPosition(() => this.renderStickyScroll()));
this._sessionStore.add(this._editor.onDidChangeCursorPosition(() => this.renderStickyScroll()));
}
}
}

private needsUpdate(event: IModelTokensChangedEvent) {
const stickyLineNumbers = this.stickyScrollWidget.getCurrentLines();
const stickyLineNumbers = this._stickyScrollWidget.getCurrentLines();
for (const stickyLineNumber of stickyLineNumbers) {
for (const range of event.ranges) {
if (stickyLineNumber >= range.fromLineNumber && stickyLineNumber <= range.toLineNumber) {
Expand All @@ -76,32 +85,33 @@ export class StickyScrollController extends Disposable implements IEditorContrib
}

private onDidResize() {
const width = this.editor.getLayoutInfo().width - this.editor.getLayoutInfo().minimap.minimapCanvasOuterWidth - this.editor.getLayoutInfo().verticalScrollbarWidth;
this.stickyScrollWidget.getDomNode().style.width = `${width}px`;
const width = this._editor.getLayoutInfo().width - this._editor.getLayoutInfo().minimap.minimapCanvasOuterWidth - this._editor.getLayoutInfo().verticalScrollbarWidth;
this._stickyScrollWidget.getDomNode().style.width = `${width}px`;
}

private renderStickyScroll() {
if (!(this.editor.hasModel())) {
if (!(this._editor.hasModel())) {
return;
}
const model = this.editor.getModel();
if (this.stickyLineCandidateProvider.getVersionId() !== model.getVersionId()) {
const model = this._editor.getModel();
if (this._stickyLineCandidateProvider.getVersionId() !== model.getVersionId()) {
// Old _ranges not updated yet
return;
}
this.stickyScrollWidget.setState(this.getScrollWidgetState());
this._widgetState = this.getScrollWidgetState();
this._stickyScrollWidget.setState(this._widgetState);
}

private getScrollWidgetState(): StickyScrollWidgetState {
const lineHeight: number = this.editor.getOption(EditorOption.lineHeight);
const maxNumberStickyLines = this.editor.getOption(EditorOption.experimental).stickyScroll.maxLineCount;
const scrollTop: number = this.editor.getScrollTop();
public getScrollWidgetState(): StickyScrollWidgetState {
const lineHeight: number = this._editor.getOption(EditorOption.lineHeight);
const maxNumberStickyLines = this._editor.getOption(EditorOption.experimental).stickyScroll.maxLineCount;
const scrollTop: number = this._editor.getScrollTop();
let lastLineRelativePosition: number = 0;
const lineNumbers: number[] = [];
const arrayVisibleRanges = this.editor.getVisibleRanges();
const arrayVisibleRanges = this._editor.getVisibleRanges();
if (arrayVisibleRanges.length !== 0) {
const fullVisibleRange = new StickyRange(arrayVisibleRanges[0].startLineNumber, arrayVisibleRanges[arrayVisibleRanges.length - 1].endLineNumber);
const candidateRanges = this.stickyLineCandidateProvider.getCandidateStickyLinesIntersecting(fullVisibleRange);
const candidateRanges = this._stickyLineCandidateProvider.getCandidateStickyLinesIntersecting(fullVisibleRange);
for (const range of candidateRanges) {
const start = range.startLineNumber;
const end = range.endLineNumber;
Expand All @@ -110,9 +120,9 @@ export class StickyScrollController extends Disposable implements IEditorContrib
const topOfElementAtDepth = (depth - 1) * lineHeight;
const bottomOfElementAtDepth = depth * lineHeight;

const bottomOfBeginningLine = this.editor.getBottomForLineNumber(start) - scrollTop;
const topOfEndLine = this.editor.getTopForLineNumber(end) - scrollTop;
const bottomOfEndLine = this.editor.getBottomForLineNumber(end) - scrollTop;
const bottomOfBeginningLine = this._editor.getBottomForLineNumber(start) - scrollTop;
const topOfEndLine = this._editor.getTopForLineNumber(end) - scrollTop;
const bottomOfEndLine = this._editor.getBottomForLineNumber(end) - scrollTop;

if (topOfElementAtDepth > topOfEndLine && topOfElementAtDepth <= bottomOfEndLine) {
lineNumbers.push(start);
Expand All @@ -133,6 +143,6 @@ export class StickyScrollController extends Disposable implements IEditorContrib

override dispose(): void {
super.dispose();
this.sessionStore.dispose();
this._sessionStore.dispose();
}
}
62 changes: 31 additions & 31 deletions src/vs/editor/contrib/stickyScroll/browser/stickyScrollProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,24 @@ export class StickyLineCandidateProvider extends Disposable {
public readonly onStickyScrollChange = this.onStickyScrollChangeEmitter.event;

static readonly ID = 'store.contrib.stickyScrollController';
private readonly editor: ICodeEditor;
private readonly languageFeaturesService: ILanguageFeaturesService;
private readonly updateSoon: RunOnceScheduler;
private readonly _editor: ICodeEditor;
private readonly _languageFeaturesService: ILanguageFeaturesService;
private readonly _updateSoon: RunOnceScheduler;

private cts: CancellationTokenSource | undefined;
private outlineModel: StickyOutlineElement | undefined;
private readonly sessionStore: DisposableStore = new DisposableStore();
private modelVersionId: number = 0;
private _cts: CancellationTokenSource | undefined;
private _outlineModel: StickyOutlineElement | undefined;
private readonly _sessionStore: DisposableStore = new DisposableStore();
private _modelVersionId: number = 0;

constructor(
editor: ICodeEditor,
@ILanguageFeaturesService _languageFeaturesService: ILanguageFeaturesService,
@ILanguageFeaturesService languageFeaturesService: ILanguageFeaturesService,
) {
super();
this.editor = editor;
this.languageFeaturesService = _languageFeaturesService;
this.updateSoon = this._register(new RunOnceScheduler(() => this.update(), 50));
this._register(this.editor.onDidChangeConfiguration(e => {
this._editor = editor;
this._languageFeaturesService = languageFeaturesService;
this._updateSoon = this._register(new RunOnceScheduler(() => this.update(), 50));
this._register(this._editor.onDidChangeConfiguration(e => {
if (e.hasChanged(EditorOption.experimental)) {
this.readConfiguration();
}
Expand All @@ -59,40 +59,40 @@ export class StickyLineCandidateProvider extends Disposable {
}

private readConfiguration() {
const options = this.editor.getOption(EditorOption.experimental);
const options = this._editor.getOption(EditorOption.experimental);
if (options.stickyScroll.enabled === false) {
this.sessionStore.clear();
this._sessionStore.clear();
return;
} else {
this.sessionStore.add(this.editor.onDidChangeModel(() => 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._editor.onDidChangeModel(() => 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.update();
}
}

public getVersionId() {
return this.modelVersionId;
return this._modelVersionId;
}

private async update(): Promise<void> {
this.cts?.dispose(true);
this.cts = new CancellationTokenSource();
await this.updateOutlineModel(this.cts.token);
public async update(): Promise<void> {
this._cts?.dispose(true);
this._cts = new CancellationTokenSource();
await this.updateOutlineModel(this._cts.token);
this.onStickyScrollChangeEmitter.fire();
}

private async updateOutlineModel(token: CancellationToken) {
if (this.editor.hasModel()) {
const model = this.editor.getModel();
if (this._editor.hasModel()) {
const model = this._editor.getModel();
const modelVersionId = model.getVersionId();
const outlineModel = await OutlineModel.create(this.languageFeaturesService.documentSymbolProvider, model, token) as OutlineModel;
const outlineModel = await OutlineModel.create(this._languageFeaturesService.documentSymbolProvider, model, token) as OutlineModel;
if (token.isCancellationRequested) {
return;
}
this.outlineModel = StickyOutlineElement.fromOutlineModel(outlineModel);
this.modelVersionId = modelVersionId;
this._outlineModel = StickyOutlineElement.fromOutlineModel(outlineModel);
this._modelVersionId = modelVersionId;
}
}

Expand All @@ -115,8 +115,8 @@ export class StickyLineCandidateProvider extends Disposable {

public getCandidateStickyLinesIntersecting(range: StickyRange): StickyLineCandidate[] {
let stickyLineCandidates: StickyLineCandidate[] = [];
this.getCandidateStickyLinesIntersectingFromOutline(range, this.outlineModel as StickyOutlineElement, stickyLineCandidates, 0, -1);
const hiddenRanges: Range[] | undefined = this.editor._getViewModel()?.getHiddenAreas();
this.getCandidateStickyLinesIntersectingFromOutline(range, this._outlineModel as StickyOutlineElement, stickyLineCandidates, 0, -1);
const hiddenRanges: Range[] | undefined = this._editor._getViewModel()?.getHiddenAreas();
if (hiddenRanges) {
for (const hiddenRange of hiddenRanges) {
stickyLineCandidates = stickyLineCandidates.filter(stickyLine => !(stickyLine.startLineNumber >= hiddenRange.startLineNumber && stickyLine.endLineNumber <= hiddenRange.endLineNumber + 1));
Expand All @@ -127,7 +127,7 @@ export class StickyLineCandidateProvider extends Disposable {

override dispose(): void {
super.dispose();
this.sessionStore.dispose();
this._sessionStore.dispose();
}
}

Expand Down