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

manual folding ranges: memento does not store all sources #156273

Merged
merged 2 commits into from Jul 27, 2022
Merged

manual folding ranges: memento does not store all sources #156273

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
d52d008
use source: fix memento does not store all sources
aeschli Jul 26, 2022
0263578
Merge branch 'main' into aeschli/fixfoldingmemento
aeschli Jul 27, 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
5 changes: 2 additions & 3 deletions src/vs/editor/contrib/folding/browser/folding.ts
View file
Open in desktop
Expand Up @@ -32,7 +32,7 @@ import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegis
import { editorSelectionBackground, iconForeground, registerColor, transparent } from 'vs/platform/theme/common/colorRegistry';
import { registerThemingParticipant, ThemeIcon } from 'vs/platform/theme/common/themeService';
import { foldingCollapsedIcon, FoldingDecorationProvider, foldingExpandedIcon, foldingManualCollapsedIcon, foldingManualExpandedIcon } from './foldingDecorations';
import { FoldingRegion, FoldingRegions, FoldRange, ILineRange } from './foldingRanges';
import { FoldingRegion, FoldingRegions, FoldRange, FoldSource, ILineRange } from './foldingRanges';
import { SyntaxRangeProvider } from './syntaxRangeProvider';
import { INotificationService } from 'vs/platform/notification/common/notification';
import Severity from 'vs/base/common/severity';
Expand Down Expand Up @@ -1097,8 +1097,7 @@ class FoldRangeFromSelectionAction extends FoldingAction<void> {
endLineNumber: endLineNumber,
type: undefined,
isCollapsed: true,
isUserDefined: true,
isRecovered: false
source: FoldSource.userDefined
});
editor.setSelection({
startLineNumber: selection.startLineNumber,
Expand Down
24 changes: 10 additions & 14 deletions src/vs/editor/contrib/folding/browser/foldingModel.ts
View file
Open in desktop
Expand Up @@ -5,7 +5,7 @@

import { Emitter, Event } from 'vs/base/common/event';
import { IModelDecorationOptions, IModelDecorationsChangeAccessor, IModelDeltaDecoration, ITextModel } from 'vs/editor/common/model';
import { FoldingRegion, FoldingRegions, ILineRange, FoldRange } from './foldingRanges';
import { FoldingRegion, FoldingRegions, ILineRange, FoldRange, FoldSource } from './foldingRanges';
import { hash } from 'vs/base/common/hash';

export interface IDecorationProvider {
Expand All @@ -22,7 +22,7 @@ export interface FoldingModelChangeEvent {
interface ILineMemento extends ILineRange {
checksum?: number;
isCollapsed?: boolean;
isUserDefined?: boolean;
source?: FoldSource;
}

export type CollapseMemento = ILineMemento[];
Expand Down Expand Up @@ -64,7 +64,7 @@ export class FoldingModel {
const endLineNumber = this._regions.getEndLineNumber(k);
const isCollapsed = this._regions.isCollapsed(k);
if (endLineNumber <= dirtyRegionEndLine) {
const isManual = this.regions.isUserDefined(k) || this.regions.isRecovered(k);
const isManual = this.regions.getSource(k) !== FoldSource.provider;
accessor.changeDecorationOptions(this._editorDecorationIds[k], this._decorationProvider.getDecorationOption(isCollapsed, endLineNumber <= lastHiddenLine, isManual));
}
if (isCollapsed && endLineNumber > lastHiddenLine) {
Expand Down Expand Up @@ -104,7 +104,7 @@ export class FoldingModel {
};
for (let i = 0; i < this._regions.length; i++) {
const foldRange = this._regions.toFoldRange(i);
if (!foldRange.isUserDefined && !foldRange.isRecovered || !intersects(foldRange)) {
if (foldRange.source === FoldSource.provider || !intersects(foldRange)) {
newFoldingRanges.push(foldRange);
}
}
Expand All @@ -124,7 +124,7 @@ export class FoldingModel {
const startLineNumber = newRegions.getStartLineNumber(index);
const endLineNumber = newRegions.getEndLineNumber(index);
const isCollapsed = newRegions.isCollapsed(index);
const isManual = newRegions.isUserDefined(index) || newRegions.isRecovered(index);
const isManual = newRegions.getSource(index) !== FoldSource.provider;
const decorationRange = {
startLineNumber: startLineNumber,
startColumn: this._textModel.getLineMaxColumn(startLineNumber),
Expand Down Expand Up @@ -155,9 +155,8 @@ export class FoldingModel {
const foldedRanges: FoldRange[] = [];
for (let i = 0, limit = this._regions.length; i < limit; i++) {
let isCollapsed = this.regions.isCollapsed(i);
const isUserDefined = this.regions.isUserDefined(i);
const isRecovered = this.regions.isRecovered(i);
if (isCollapsed || isUserDefined || isRecovered) {
const source = this.regions.getSource(i);
if (isCollapsed || source !== FoldSource.provider) {
const foldRange = this._regions.toFoldRange(i);
const decRange = this._textModel.getDecorationRange(this._editorDecorationIds[i]);
if (decRange) {
Expand All @@ -169,8 +168,7 @@ export class FoldingModel {
endLineNumber: decRange.endLineNumber,
type: foldRange.type,
isCollapsed,
isUserDefined,
isRecovered
source
});
}
}
Expand All @@ -192,7 +190,7 @@ export class FoldingModel {
startLineNumber: range.startLineNumber,
endLineNumber: range.endLineNumber,
isCollapsed: range.isCollapsed,
isUserDefined: range.isRecovered,
source: range.source,
checksum: checksum
});
}
Expand All @@ -214,14 +212,12 @@ export class FoldingModel {
}
const checksum = this._getLinesChecksum(range.startLineNumber + 1, range.endLineNumber);
if (!range.checksum || checksum === range.checksum) {
const isUserDefined = range.isUserDefined === true;
rangesToRestore.push({
startLineNumber: range.startLineNumber,
endLineNumber: range.endLineNumber,
type: undefined,
isCollapsed: range.isCollapsed ?? true,
isUserDefined,
isRecovered: !isUserDefined
source: range.source ?? FoldSource.provider
});
}
}
Expand Down
69 changes: 47 additions & 22 deletions src/vs/editor/contrib/folding/browser/foldingRanges.ts
View file
Open in desktop
Expand Up @@ -8,13 +8,18 @@ export interface ILineRange {
endLineNumber: number;
}

export const enum FoldSource {
provider = 0,
userDefined = 1,
recovered = 2
}

export interface FoldRange {
startLineNumber: number;
endLineNumber: number;
type: string | undefined;
isCollapsed: boolean;
isUserDefined: boolean;
isRecovered: boolean;
source: FoldSource;
}

export const MAX_FOLDING_REGIONS = 0xFFFF;
Expand Down Expand Up @@ -123,22 +128,44 @@ export class FoldingRegions {
this._collapseStates.set(index, newState);
}

public isUserDefined(index: number): boolean {
private isUserDefined(index: number): boolean {
return this._userDefinedStates.get(index);
}

public setUserDefined(index: number, newState: boolean) {
private setUserDefined(index: number, newState: boolean) {
return this._userDefinedStates.set(index, newState);
}

public isRecovered(index: number): boolean {
private isRecovered(index: number): boolean {
return this._recoveredStates.get(index);
}

public setRecovered(index: number, newState: boolean) {
private setRecovered(index: number, newState: boolean) {
return this._recoveredStates.set(index, newState);
}

public getSource(index: number): FoldSource {
if (this.isUserDefined(index)) {
return FoldSource.userDefined;
} else if (this.isRecovered(index)) {
return FoldSource.recovered;
}
return FoldSource.provider;
}

public setSource(index: number, source: FoldSource): void {
if (source === FoldSource.userDefined) {
this.setUserDefined(index, true);
this.setRecovered(index, false);
} else if (source === FoldSource.recovered) {
this.setUserDefined(index, false);
this.setRecovered(index, true);
} else {
this.setUserDefined(index, false);
this.setRecovered(index, false);
}
}

public setCollapsedAllOfType(type: string, newState: boolean) {
let hasChanged = false;
if (this._types) {
Expand Down Expand Up @@ -203,10 +230,16 @@ export class FoldingRegions {
return -1;
}

private readonly sourceAbbr = {
[FoldSource.provider]: ' ',
[FoldSource.userDefined]: 'u',
[FoldSource.recovered]: 'r',
};

public toString() {
const res: string[] = [];
for (let i = 0; i < this.length; i++) {
res[i] = `[${this.isUserDefined(i) ? '*' : ' '}${this.isRecovered(i) ? 'r' : ' '}${this.isCollapsed(i) ? '+' : '-'}] ${this.getStartLineNumber(i)}/${this.getEndLineNumber(i)}`;
res[i] = `[${this.sourceAbbr[this.getSource(i)]}${this.isCollapsed(i) ? '+' : '-'}] ${this.getStartLineNumber(i)}/${this.getEndLineNumber(i)}`;
}
return res.join(', ');
}
Expand All @@ -217,8 +250,7 @@ export class FoldingRegions {
endLineNumber: this._endIndexes[index] & MAX_LINE_NUMBER,
type: this._types ? this._types[index] : undefined,
isCollapsed: this.isCollapsed(index),
isUserDefined: this.isUserDefined(index),
isRecovered: this.isRecovered(index)
source: this.getSource(index)
};
}

Expand All @@ -245,12 +277,7 @@ export class FoldingRegions {
if (ranges[i].isCollapsed) {
regions.setCollapsed(i, true);
}
if (ranges[i].isUserDefined) {
regions.setUserDefined(i, true);
}
if (ranges[i].isRecovered) {
regions.setRecovered(i, true);
}
regions.setSource(i, ranges[i].source);
}
return regions;
}
Expand Down Expand Up @@ -296,23 +323,21 @@ export class FoldingRegions {
let useRange: FoldRange | undefined = undefined;
if (nextB && (!nextA || nextA.startLineNumber >= nextB.startLineNumber)) {
if (nextA && nextA.startLineNumber === nextB.startLineNumber) {
if (nextB.isUserDefined) {
if (nextB.source === FoldSource.userDefined) {
// a user defined range (possibly unfolded)
useRange = nextB;
} else {
// a previously folded range or a (possibly unfolded) recovered range
useRange = nextA;
useRange.isCollapsed = nextB.isCollapsed && nextA.endLineNumber === nextB.endLineNumber;
useRange.isUserDefined = false;
useRange.isRecovered = false;
useRange.source = FoldSource.provider;
}
nextA = getA(++indexA); // not necessary, just for speed
} else {
useRange = nextB;
if (nextB.isCollapsed && !nextB.isUserDefined && !nextB.isRecovered) {
if (nextB.isCollapsed && nextB.source === FoldSource.provider) {
// a previously collapsed range
useRange.isRecovered = true;
useRange.isUserDefined = false;
useRange.source = FoldSource.recovered;
}
}
nextB = getB(++indexB);
Expand All @@ -326,7 +351,7 @@ export class FoldingRegions {
useRange = nextA;
break; // no conflict, use this nextA
}
if (prescanB.isUserDefined && prescanB.endLineNumber > nextA!.endLineNumber) {
if (prescanB.source === FoldSource.userDefined && prescanB.endLineNumber > nextA!.endLineNumber) {
// we found a user folded range, it wins
break; // without setting nextResult, so this nextA gets skipped
}
Expand Down