Merge pull request #10850 from thehogfather/issue10846

Addresses issue #10846

Author: abose

src/extensions/default/CodeFolding/Prefs.js

@@ -8,27 +8,35 @@
 /*global define, brackets*/
 define(function (require, exports, module) {
     "use strict";
-    var PreferencesManager      = brackets.getModule("preferences/PreferencesManager"),
-        prefs                   = PreferencesManager.getExtensionPrefs("code-folding"),
-        strings                 = brackets.getModule("strings"),
-        store                   = {},
-        foldsKey                = "folds";
+    var PreferencesManager          = brackets.getModule("preferences/PreferencesManager"),
+        prefs                       = PreferencesManager.getExtensionPrefs("code-folding"),
+        foldsKey                    = "code-folding.folds",
+        // preference key strings are here for now since they are not used in any UI
+        ENABLE_CODE_FOLDING         = "Enable code folding",
+        MIN_FOLD_SIZE               = "Minimum fold size",
+        MIN_FOLD_SIZE_HELP          = "Minimum number of lines to allow in a foldable range",
+        SAVE_FOLD_STATES            = "Save fold states",
+        SAVE_FOLD_STATES_HELP       = "Save fold states to disk when editor is closed and restore the folds when reopened",
+        ALWAYS_USE_INDENT_FOLD      = "Always use indent fold",
+        ALWAYS_USE_INDENT_FOLD_HELP = "Fall back to using level of indentation as a folding guideline if no range finder is found for the current mode.",
+        FADE_FOLD_BUTTONS           = "Fade fold buttons",
+        FADE_FOLD_BUTTONS_HELP      = "Hides the fold buttons unless the mouse is over the gutter",
+        MAX_FOLD_LEVEL              = "Max fold level",
+        MAX_FOLD_LEVEL_HELP         = "Used to limit the number of nested folds to find and collapse when View -> Collapse All is called or Alt is held down when collapsing. Should improve performance for large files.";
 
     //default preference values
     prefs.definePreference("enabled", "boolean", true,
-                           {name: strings.ENABLE_CODE_FOLDING, description: strings.ENABLE_CODE_FOLDING});
+                           {name: ENABLE_CODE_FOLDING, description: ENABLE_CODE_FOLDING});
     prefs.definePreference("minFoldSize", "number", 2,
-                           {name: strings.MIN_FOLD_SIZE, description: strings.MIN_FOLD_SIZE_HELP});
+                           {name: MIN_FOLD_SIZE, description: MIN_FOLD_SIZE_HELP});
     prefs.definePreference("saveFoldStates", "boolean", true,
-                           {name: strings.SAVE_FOLD_STATES, description: strings.SAVE_FOLD_STATES_HELP});
-    prefs.definePreference("alwaysUseIndentFold", "boolean", true,
-                           {name: strings.ALWAYS_USE_INDENT_FOLD, description: strings.ALWAYS_USE_INDENT_FOLD_HELP});
-    prefs.definePreference("enableRegionFolding", "boolean", true,
-                           {name: strings.ENABLE_REGION_FOLDING, description: strings.ENABLE_REGION_FOLDING});
+                           {name: SAVE_FOLD_STATES, description: SAVE_FOLD_STATES_HELP});
+    prefs.definePreference("alwaysUseIndentFold", "boolean", false,
+                           {name: ALWAYS_USE_INDENT_FOLD, description: ALWAYS_USE_INDENT_FOLD_HELP});
     prefs.definePreference("fadeFoldButtons", "boolean", false,
-                           {name: strings.FADE_FOLD_BUTTONS, description: strings.FADE_FOLD_BUTTONS_HELP});
+                           {name: FADE_FOLD_BUTTONS, description: FADE_FOLD_BUTTONS_HELP});
     prefs.definePreference("maxFoldLevel", "number", 2,
-                           {name: strings.MAX_FOLD_LEVEL, description: strings.MAX_FOLD_LEVEL_HELP});
+                           {name: MAX_FOLD_LEVEL, description: MAX_FOLD_LEVEL_HELP});
     prefs.definePreference("folds", "object", {});
 
     /**
@@ -75,8 +83,8 @@ define(function (require, exports, module) {
       * @return {Object} the line folds for the document at the specified path
       */
     function getFolds(path) {
-        store = (prefs.get(foldsKey) || {});
-        return inflate(store[path]);
+        var folds = (PreferencesManager.getViewState(foldsKey) || {});
+        return inflate(folds[path]);
     }
 
     /**
@@ -85,8 +93,9 @@ define(function (require, exports, module) {
       * @param {Object} folds the fold ranges to save for the current document
       */
     function setFolds(path, folds) {
-        store[path] = simplify(folds);
-        prefs.set(foldsKey, store);
+        var allFolds = PreferencesManager.getViewState(foldsKey);
+        allFolds[path] = simplify(folds);
+        PreferencesManager.setViewState(foldsKey, allFolds);
     }
 
     /**
@@ -102,7 +111,7 @@ define(function (require, exports, module) {
       * Clears all the saved line folds for all documents.
       */
     function clearAllFolds() {
-        prefs.set(foldsKey, {});
+        PreferencesManager.setViewState(foldsKey, {});
     }
 
     module.exports.getFolds = getFolds;
@@ -113,4 +122,6 @@ define(function (require, exports, module) {
 
     module.exports.clearAllFolds = clearAllFolds;
 
+    module.exports.prefBase = prefs;
+
 });

src/extensions/default/CodeFolding/foldhelpers/foldcode.js

@@ -1,3 +1,5 @@
+// CodeMirror, copyright (c) by Marijn Haverbeke and others
+// Distributed under an MIT license: http://codemirror.net/LICENSE
 /**
  * Based on http://codemirror.net/addon/fold/foldcode.js
  * @author Patrick Oladimeji
@@ -22,15 +24,15 @@ define(function (require, exports, module) {
         if (typeof pos === "number") {
             pos = CodeMirror.Pos(pos, 0);
         }
+
         var finder = options.rangeFinder || CodeMirror.fold.auto,
-            minSize = options.minFoldSize || prefs.getSetting("minFoldSize"),
             range,
             widget,
             textRange;
 
         function getRange(allowFolded) {
             var range = options.range || finder(cm, pos);
-            if (!range || range.to.line - range.from.line < minSize) {
+            if (!range || range.to.line - range.from.line < prefs.getSetting("minFoldSize")) {
                 return null;
             }
             var marks = cm.findMarksAt(range.from),
@@ -74,7 +76,7 @@ define(function (require, exports, module) {
                 range = getRange(false);
             }
         }
-        if (!range || range.cleared || force === "unfold" || range.to.line - range.from.line < minSize) {
+        if (!range || range.cleared || force === "unfold" || range.to.line - range.from.line < prefs.getSetting("minFoldSize")) {
             if (range) { range.cleared = false; }
             return;
         }
@@ -119,7 +121,7 @@ define(function (require, exports, module) {
         });
 
         CodeMirror.defineExtension("isFolded", function (line) {
-            return this._lineFolds[line];
+            return this._lineFolds && this._lineFolds[line];
         });
 
         /**
@@ -203,7 +205,7 @@ define(function (require, exports, module) {
           * @param {?number} end the line number for the end of the region to fold
           */
         CodeMirror.commands.foldToLevel = function (cm, start, end) {
-            var rf = CodeMirror.fold.auto, level = prefs.getSetting("maxFoldLevel");
+            var rf = CodeMirror.fold.auto;
             function foldLevel(n, from, to) {
                 if (n > 0) {
                     var i = from, range;
@@ -223,7 +225,7 @@ define(function (require, exports, module) {
             cm.operation(function () {
                 start = start === undefined ? cm.firstLine() : start;
                 end = end || cm.lastLine();
-                foldLevel(level, start, end);
+                foldLevel(prefs.getSetting("maxFoldLevel"), start, end);
             });
         };
 

src/extensions/default/CodeFolding/foldhelpers/foldgutter.js

@@ -1,3 +1,5 @@
+// CodeMirror, copyright (c) by Marijn Haverbeke and others
+// Distributed under an MIT license: http://codemirror.net/LICENSE
 /**
  * Based on http://codemirror.net/addon/fold/foldgutter.js
  * @author Patrick Oladimeji
@@ -220,7 +222,7 @@ define(function (require, exports, module) {
             window.clearTimeout(state.changeUpdate);
             state.changeUpdate = window.setTimeout(function () {
                 updateInViewport(cm);
-            }, prefs.getSetting("foldOnChangeTimeSpan") || 600);
+            }, 600);
         }
     }
 
@@ -251,7 +253,7 @@ define(function (require, exports, module) {
                     }
                 });
             }
-        }, prefs.getSetting("updateViewportTimeSpan") || 400);
+        }, 400);
     }
 
     /**
@@ -310,7 +312,6 @@ define(function (require, exports, module) {
         });
     }
 
-
     exports.init = init;
     exports.clearGutter = clearGutter;
     exports.updateInViewport = updateInViewport;