[folding] should not fold whitespace after function. Fixes microsoft#3353

aeschli · aeschli · commit de68414a9a63 · 2017-09-20T11:09:42.000+02:00
diff --git a/extensions/clojure/language-configuration.json b/extensions/clojure/language-configuration.json
@@ -18,5 +18,10 @@
 		["[", "]"],
 		["(", ")"],
 		["\"", "\""]
-	]
+	],
+	"folding": {
+		"indendationBasedFolding": {
+			"offSide": true
+		}
+	}
 }
diff --git a/extensions/coffeescript/language-configuration.json b/extensions/coffeescript/language-configuration.json
@@ -21,5 +21,10 @@
 		["(", ")"],
 		["\"", "\""],
 		["'", "'"]
-	]
+	],
+	"folding": {
+		"indendationBasedFolding": {
+			"offSide": true
+		}
+	}
 }
diff --git a/extensions/fsharp/language-configuration.json b/extensions/fsharp/language-configuration.json
@@ -20,5 +20,10 @@
 		["(", ")"],
 		["\"", "\""],
 		["'", "'"]
-	]
+	],
+	"folding": {
+		"indendationBasedFolding": {
+			"offSide": true
+		}
+	}
 }
diff --git a/extensions/markdown/language-configuration.json b/extensions/markdown/language-configuration.json
@@ -37,5 +37,10 @@
 		["(", ")"],
 		["[", "]"],
 		["`", "`"]
-	]
+	],
+	"folding": {
+		"indendationBasedFolding": {
+			"offSide": true
+		}
+	}
 }
diff --git a/extensions/pug/language-configuration.json b/extensions/pug/language-configuration.json
@@ -20,5 +20,10 @@
 		["(", ")"],
 		["'", "'"],
 		["\"", "\""]
-	]
+	],
+	"folding": {
+		"indendationBasedFolding": {
+			"offSide": true
+		}
+	}
 }
diff --git a/extensions/python/language-configuration.json b/extensions/python/language-configuration.json
@@ -21,6 +21,10 @@
 		["(", ")"],
 		["\"", "\""],
 		["'", "'"]
-	]
-	// enhancedBrackets: [ { open: /.*:\s*$/,  closeComplete: 'else:' } ],
+	],
+	"folding": {
+		"indendationBasedFolding": {
+			"offSide": true
+		}
+	}
 }
diff --git a/extensions/yaml/language-configuration.json b/extensions/yaml/language-configuration.json
@@ -20,5 +20,10 @@
 		["(", ")"],
 		["\"", "\""],
 		["'", "'"]
-	]
+	],
+	"folding": {
+		"indendationBasedFolding": {
+			"offSide": true
+		}
+	}
 }
diff --git a/src/vs/editor/browser/viewParts/indentGuides/indentGuides.ts b/src/vs/editor/browser/viewParts/indentGuides/indentGuides.ts
@@ -77,6 +77,9 @@ export class IndentGuidesOverlay extends DynamicViewOverlay {
 	public onZonesChanged(e: viewEvents.ViewZonesChangedEvent): boolean {
 		return true;
 	}
+	public onLanguageConfigurationChanged(e: viewEvents.ViewLanguageConfigurationEvent): boolean {
+		return true;
+	}
 
 	// --- end event handlers
 
diff --git a/src/vs/editor/common/model/indentRanges.ts b/src/vs/editor/common/model/indentRanges.ts
@@ -6,6 +6,7 @@
 'use strict';
 
 import { ITokenizedModel } from 'vs/editor/common/editorCommon';
+import { LanguageConfigurationRegistry } from 'vs/editor/common/modes/languageConfigurationRegistry';
 
 export class IndentRange {
 	_indentRangeBrand: void;
@@ -32,17 +33,23 @@ export class IndentRange {
 export function computeRanges(model: ITokenizedModel, minimumRangeSize: number = 1): IndentRange[] {
 
 	let result: IndentRange[] = [];
+	let foldingRules = LanguageConfigurationRegistry.getFoldingRules(model.getLanguageIdentifier().id);
+	let offSide = foldingRules && foldingRules.indendationBasedFolding && foldingRules.indendationBasedFolding.offSide;
 
 	let previousRegions: { indent: number, line: number }[] = [];
 	previousRegions.push({ indent: -1, line: model.getLineCount() + 1 }); // sentinel, to make sure there's at least one entry
 
 	for (let line = model.getLineCount(); line > 0; line--) {
 		let indent = model.getIndentLevel(line);
+		let previous = previousRegions[previousRegions.length - 1];
 		if (indent === -1) {
+			if (offSide) {
+				// for offSide languages, empty lines are associated to the next block
+				previous.line = line;
+			}
 			continue; // only whitespace
 		}
 
-		let previous = previousRegions[previousRegions.length - 1];
 
 		if (previous.indent > indent) {
 			// discard all regions with larger indent
diff --git a/src/vs/editor/common/modes/languageConfiguration.ts b/src/vs/editor/common/modes/languageConfiguration.ts
@@ -61,6 +61,12 @@ export interface LanguageConfiguration {
 	 * settings will be used.
 	 */
 	surroundingPairs?: IAutoClosingPair[];
+
+	/**
+	 * The language's folding rules.
+	 */
+	folding?: FoldingRules;
+
 	/**
 	 * **Deprecated** Do not use.
 	 *
@@ -89,8 +95,25 @@ export interface IndentationRule {
 	 * If a line matches this pattern, then its indentation should not be changed and it should not be evaluated against the other rules.
 	 */
 	unIndentedLinePattern?: RegExp;
+
 }
 
+/**
+ * Describes folding rules for a language.
+ */
+export interface FoldingRules {
+	indendationBasedFolding?: {
+		/**
+		 * Used by the indentation based strategy to decide wheter empty lines belong to the previous or the next block.
+		 * A language adheres to the off-side rule if blocks in that language are expressed by their indentation.
+		 * See [wikipedia](https://en.wikipedia.org/wiki/Off-side_rule) for more information.
+		 * If not set, `false` is used and empty lines belong to the previous block.
+		 */
+		offSide: boolean;
+	};
+}
+
+
 /**
  * Describes a rule to be evaluated when pressing Enter.
  */
diff --git a/src/vs/editor/common/modes/languageConfigurationRegistry.ts b/src/vs/editor/common/modes/languageConfigurationRegistry.ts
@@ -18,7 +18,7 @@ import { DEFAULT_WORD_REGEXP, ensureValidWordDefinition } from 'vs/editor/common
 import { createScopedLineTokens } from 'vs/editor/common/modes/supports';
 import { LineTokens } from 'vs/editor/common/core/lineTokens';
 import { Range } from 'vs/editor/common/core/range';
-import { IndentAction, EnterAction, IAutoClosingPair, LanguageConfiguration, IndentationRule } from 'vs/editor/common/modes/languageConfiguration';
+import { IndentAction, EnterAction, IAutoClosingPair, LanguageConfiguration, IndentationRule, FoldingRules } from 'vs/editor/common/modes/languageConfiguration';
 import { LanguageIdentifier, LanguageId } from 'vs/editor/common/modes';
 
 /**
@@ -55,6 +55,7 @@ export class RichEditSupport {
 	public readonly indentRulesSupport: IndentRulesSupport;
 	public readonly brackets: RichEditBrackets;
 	public readonly indentationRules: IndentationRule;
+	public readonly foldingRules: FoldingRules;
 
 	constructor(languageIdentifier: LanguageIdentifier, previous: RichEditSupport, rawConf: LanguageConfiguration) {
 
@@ -82,6 +83,8 @@ export class RichEditSupport {
 		if (this._conf.indentationRules) {
 			this.indentRulesSupport = new IndentRulesSupport(this._conf.indentationRules);
 		}
+
+		this.foldingRules = this._conf.folding || {};
 	}
 
 	private static _mergeConf(prev: LanguageConfiguration, current: LanguageConfiguration): LanguageConfiguration {
@@ -93,6 +96,7 @@ export class RichEditSupport {
 			onEnterRules: (prev ? current.onEnterRules || prev.onEnterRules : current.onEnterRules),
 			autoClosingPairs: (prev ? current.autoClosingPairs || prev.autoClosingPairs : current.autoClosingPairs),
 			surroundingPairs: (prev ? current.surroundingPairs || prev.surroundingPairs : current.surroundingPairs),
+			folding: (prev ? current.folding || prev.folding : current.folding),
 			__electricCharacterSupport: (prev ? current.__electricCharacterSupport || prev.__electricCharacterSupport : current.__electricCharacterSupport),
 		};
 	}
@@ -272,9 +276,15 @@ export class LanguageConfigurationRegistryImpl {
 		return ensureValidWordDefinition(value.wordDefinition || null);
 	}
 
+	public getFoldingRules(languageId: LanguageId): FoldingRules {
+		let value = this._getRichEditSupport(languageId);
+		if (!value) {
+			return {};
+		}
+		return value.foldingRules;
+	}
 
-
-	// beigin Indent Rules
+	// begin Indent Rules
 
 	public getIndentRulesSupport(languageId: LanguageId): IndentRulesSupport {
 		let value = this._getRichEditSupport(languageId);
diff --git a/src/vs/editor/contrib/folding/browser/folding.ts b/src/vs/editor/contrib/folding/browser/folding.ts
@@ -237,6 +237,9 @@ export class FoldingController implements IFoldingController {
 		this.localToDispose.push(this.contentChangedScheduler);
 		this.localToDispose.push(this.cursorChangedScheduler);
 
+		this.localToDispose.push(model.onDidChangeLanguageConfiguration(e => {
+			this.contentChangedScheduler.schedule();
+		}));
 		this.localToDispose.push(this.editor.onDidChangeModelContent(e => this.contentChangedScheduler.schedule()));
 		this.localToDispose.push(this.editor.onDidChangeCursorPosition((e) => {
 
diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -4310,6 +4310,10 @@ declare module monaco.languages {
 		 * settings will be used.
 		 */
 		surroundingPairs?: IAutoClosingPair[];
+		/**
+		 * The language's folding rules.
+		 */
+		folding?: FoldingRules;
 		/**
 		 * **Deprecated** Do not use.
 		 *
@@ -4340,6 +4344,21 @@ declare module monaco.languages {
 		unIndentedLinePattern?: RegExp;
 	}
 
+	/**
+	 * Describes folding rules for a language.
+	 */
+	export interface FoldingRules {
+		indendationBasedFolding?: {
+			/**
+			 * Used by the indentation based strategy to decide wheter empty lines belong to the previous or the next block.
+			 * A language adheres to the off-side rule if blocks in that language are expressed by their indentation.
+			 * See [wikipedia](https://en.wikipedia.org/wiki/Off-side_rule) for more information.
+			 * If not set, `false` is used and empty lines belong to the previous block.
+			 */
+			offSide: boolean;
+		};
+	}
+
 	/**
 	 * Describes a rule to be evaluated when pressing Enter.
 	 */
diff --git a/src/vs/workbench/parts/codeEditor/electron-browser/languageConfiguration/languageConfigurationExtensionPoint.ts b/src/vs/workbench/parts/codeEditor/electron-browser/languageConfiguration/languageConfigurationExtensionPoint.ts
@@ -7,7 +7,7 @@
 import * as nls from 'vs/nls';
 import { parse, ParseError } from 'vs/base/common/json';
 import { readFile } from 'vs/base/node/pfs';
-import { CharacterPair, LanguageConfiguration, IAutoClosingPair, IAutoClosingPairConditional, IndentationRule, CommentRule } from 'vs/editor/common/modes/languageConfiguration';
+import { CharacterPair, LanguageConfiguration, IAutoClosingPair, IAutoClosingPairConditional, IndentationRule, CommentRule, FoldingRules } from 'vs/editor/common/modes/languageConfiguration';
 import { IModeService } from 'vs/editor/common/services/modeService';
 import { LanguageConfigurationRegistry } from 'vs/editor/common/modes/languageConfigurationRegistry';
 import { Extensions, IJSONContributionRegistry } from 'vs/platform/jsonschemas/common/jsonContributionRegistry';
@@ -35,6 +35,7 @@ interface ILanguageConfiguration {
 	surroundingPairs?: (CharacterPair | IAutoClosingPair)[];
 	wordPattern?: string | IRegExp;
 	indentationRules?: IIndentationRules;
+	folding?: FoldingRules;
 }
 
 export class LanguageConfigurationFileHandler {
@@ -117,6 +118,10 @@ export class LanguageConfigurationFileHandler {
 			}
 		}
 
+		if (configuration.folding) {
+			richEditConfig.folding = configuration.folding;
+		}
+
 		LanguageConfigurationRegistry.register(languageIdentifier, richEditConfig);
 	}
 
@@ -377,7 +382,24 @@ const schema: IJSONSchema = {
 					}
 				}
 			}
+		},
+		folding: {
+			type: 'object',
+			description: nls.localize('schema.folding', 'The language\'s folding settings.'),
+			properties: {
+				indendationBasedFolding: {
+					type: 'object',
+					description: nls.localize('schema.folding.indendationBasedFolding', 'Settings for indentation based folding.'),
+					properties: {
+						offSide: {
+							type: 'boolean',
+							description: nls.localize('schema.folding.indendationBasedFolding.offSide', 'A language adheres to the off-side rule if blocks in that language are expressed by their indentation. If set, empty lines belong to the subsequent block.'),
+						}
+					}
+				}
+			}
 		}
+
 	}
 };
 let schemaRegistry = <IJSONContributionRegistry>Registry.as(Extensions.JSONContribution);

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,9 @@ export class IndentGuidesOverlay extends DynamicViewOverlay {`
`77`	`77`	`public onZonesChanged(e: viewEvents.ViewZonesChangedEvent): boolean {`
`78`	`78`	`return true;`
`79`	`79`	`}`
	`80`	`+ public onLanguageConfigurationChanged(e: viewEvents.ViewLanguageConfigurationEvent): boolean {`
	`81`	`+ return true;`
	`82`	`+ }`
`80`	`83`
`81`	`84`	`// --- end event handlers`
`82`	`85`