Merge pull request #11538 from thehogfather/fold-selected

Allow code-folding for selected text in editor

Author: abose

src/extensions/default/CodeFolding/Prefs.js

@@ -8,7 +8,7 @@
 /*global define, brackets*/
 define(function (require, exports, module) {
     "use strict";
-    
+
     var ProjectManager              = brackets.getModule("project/ProjectManager"),
         PreferencesManager          = brackets.getModule("preferences/PreferencesManager"),
         Strings                     = brackets.getModule("strings"),
@@ -20,7 +20,8 @@ define(function (require, exports, module) {
         SAVE_FOLD_STATES            = "Save fold states",
         ALWAYS_USE_INDENT_FOLD      = "Always use indent fold",
         HIDE_FOLD_BUTTONS           = "Hide fold triangles",
-        MAX_FOLD_LEVEL              = "Max fold level";
+        MAX_FOLD_LEVEL              = "Max fold level",
+        MAKE_SELECTIONS_FOLDABLE     = "Makes selections foldable";
 
     //default preference values
     prefs.definePreference("enabled", "boolean", true,
@@ -35,7 +36,9 @@ define(function (require, exports, module) {
                            {name: HIDE_FOLD_BUTTONS, description: Strings.DESCRIPTION_CODE_FOLDING_HIDE_UNTIL_MOUSEOVER});
     prefs.definePreference("maxFoldLevel", "number", 2,
                            {name: MAX_FOLD_LEVEL, description: Strings.DESCRIPTION_CODE_FOLDING_MAX_FOLD_LEVEL});
-    
+    prefs.definePreference("makeSelectionsFoldable", "boolean", true,
+                           {name: MAKE_SELECTIONS_FOLDABLE, description: Strings.DESCRIPTION_CODE_FOLDING_MAKE_SELECTIONS_FOLDABLE});
+
     PreferencesManager.stateManager.definePreference(FOLDS_PREF_KEY, "object", {});
 
     /**
@@ -75,7 +78,7 @@ define(function (require, exports, module) {
 
         return ranges;
     }
-    
+
     /**
      * Returns a 'context' object for getting/setting project-specific view state preferences.
      * Similar to code in MultiRangeInlineEditor._getPrefsContext()...

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

@@ -0,0 +1,30 @@
+/**
+ * Selection range helper for code folding.
+ * @author Patrick Oladimeji
+ * @date 31/07/2015 00:11:53
+ */
+/*global define*/
+define(function (require, exports, module) {
+    "use strict";
+
+    /**
+     * This helper returns the start and end range represeting the current selection in the editor.
+     * @param   {Object} cm    The Codemirror instance
+     * @param   {Object} start A Codemirror.Pos object {line, ch} representing the current line we are
+     *                          checking for fold ranges
+     * @returns {Object} The fold range, {from, to} representing the current selection.
+     */
+    function SelectionFold(cm, start) {
+        if (!cm.somethingSelected()) {
+            return;
+        }
+
+        var from = cm.getCursor("from"),
+            to  = cm.getCursor("to");
+        if (from.line === start.line) {
+            return {from: from, to: to};
+        }
+    }
+
+    module.exports = SelectionFold;
+});

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

@@ -137,7 +137,6 @@ define(function (require, exports, module) {
                         cachedRange = folds[lineNumber];
                         if (range && cachedRange && range.from.line === cachedRange.from.line &&
                                 range.to.line === cachedRange.to.line) {
-                            cm.foldCode(lineNumber, {range: folds[lineNumber]}, "fold");
                             result[lineNumber] = folds[lineNumber];
                         }
                     }
@@ -227,7 +226,9 @@ define(function (require, exports, module) {
         };
 
         /**
-          * Helper to combine an array of fold range finders into one
+          * Helper to combine an array of fold range finders into one. This goes through the
+          * list of fold helpers in the parameter arguments and returns the first non-null
+          * range found from calling the fold helpers in order.
           */
         CodeMirror.registerHelper("fold", "combine", function () {
             var funcs = Array.prototype.slice.call(arguments, 0);
@@ -249,16 +250,16 @@ define(function (require, exports, module) {
           * @param {number} start the current position in the document
           */
         CodeMirror.registerHelper("fold", "auto", function (cm, start) {
-            var helpers = cm.getHelpers(start, "fold"), i, cur;
+            var helpers = cm.getHelpers(start, "fold"), i, range;
             //ensure mode helper is loaded if there is one
             var mode = cm.getMode().name;
             var modeHelper = CodeMirror.fold[mode];
             if (modeHelper && helpers.indexOf(modeHelper) < 0) {
                 helpers.push(modeHelper);
             }
             for (i = 0; i < helpers.length; i++) {
-                cur = helpers[i](cm, start);
-                if (cur) { return cur; }
+                range = helpers[i](cm, start);
+                if (range && range.to.line - range.from.line >= prefs.getSetting("minFoldSize")) { return range; }
             }
         });
     }

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

@@ -156,6 +156,19 @@ define(function (require, exports, module) {
         });
     }
 
+    /**
+     * Helper function to return the fold text marker on a line in an editor
+     * @param   {CodeMirror} cm   The CodeMirror instance for the active editor
+     * @param   {Number}     line The line number representing the position of the fold marker
+     * @returns {TextMarker} A CodeMirror TextMarker object
+     */
+    function getFoldOnLine(cm, line) {
+        var pos = CodeMirror.Pos(line);
+        var folds = cm.findMarksAt(pos) || [];
+        folds = folds.filter(isFold);
+        return folds.length ? folds[0] : undefined;
+    }
+
     /**
      * Synchronises the code folding states in the CM doc to cm._lineFolds cache.
      * When an undo operation is done, if folded code fragments are restored, then
@@ -166,19 +179,15 @@ define(function (require, exports, module) {
      */
     function syncDocToFoldsCache(cm, from, lineAdded) {
         var minFoldSize = prefs.getSetting("minFoldSize") || 2;
-        var opts = cm.state.foldGutter.options || {};
-        var rf = opts.rangeFinder || CodeMirror.fold.auto;
-        var i, pos, folds, fold, range;
+        var i, fold, range;
         if (lineAdded <= 0) {
             return;
         }
 
         for (i = from; i <= from + lineAdded; i = i + 1) {
-            pos = CodeMirror.Pos(i);
-            folds = cm.doc.findMarksAt(pos).filter(isFold);
-            fold = folds.length ? fold = folds[0] : undefined;
+            fold = getFoldOnLine(cm, i);
             if (fold) {
-                range = rf(cm, CodeMirror.Pos(i));
+                range = fold.find();
                 if (range && range.to.line - range.from.line >= minFoldSize) {
                     cm._lineFolds[i] = range;
                     i = range.to.line;
@@ -187,18 +196,27 @@ define(function (require, exports, module) {
                 }
             }
         }
+    }
 
+    /**
+     * Helper function to move a fold range object by the specified number of lines
+     * @param {Object} range    An object specifying the fold range to move. It contains {from, to} which are CodeMirror.Pos objects.
+     * @param {Number} numLines A positive or negative number representing the numbe of lines to move the range by
+     */
+    function moveRange(range, numLines) {
+        return {from: CodeMirror.Pos(range.from.line + numLines, range.from.ch),
+                to: CodeMirror.Pos(range.to.line + numLines, range.to.ch)};
     }
 
     /**
       * Updates the line folds cache usually when the document changes.
       * The following cases are accounted for:
       * 1.  When the change does not add a new line to the document we check if the line being modified
       *     is folded. If that is the case, changes to this line might affect the range stored in the cache
-      *     so we update the range.
+      *     so we update the range using the range finder function.
       * 2.  If lines have been added, we need to update the records for all lines in the folds cache
       *     which are greater than the line position at which we are adding the new line(s). When existing
-      *     folds exist above the addition we keep the original position in the cache.
+      *     folds are above the addition we keep the original position in the cache.
       * 3.  If lines are being removed, we need to update the records for all lines in the folds cache which are
       *     greater than the line position at which we are removing the new lines, while making sure to
       *     not include any folded lines in the cache that are part of the removed chunk.
@@ -208,7 +226,7 @@ define(function (require, exports, module) {
       *                                This value is negative for deletions and positive for additions.
       */
     function updateFoldsCache(cm, from, linesDiff) {
-        var range;
+        var oldRange, newRange;
         var minFoldSize = prefs.getSetting("minFoldSize") || 2;
         var foldedLines = Object.keys(cm._lineFolds).map(function (d) {
             return +d;
@@ -218,31 +236,31 @@ define(function (require, exports, module) {
 
         if (linesDiff === 0) {
             if (foldedLines.indexOf(from) >= 0) {
-                range = rf(cm, CodeMirror.Pos(from));
-                if (range && range.to.line - range.from.line >= minFoldSize) {
-                    cm._lineFolds[from] = range;
+                newRange = rf(cm, CodeMirror.Pos(from));
+                if (newRange && newRange.to.line - newRange.from.line >= minFoldSize) {
+                    cm._lineFolds[from] = newRange;
                 } else {
                     delete cm._lineFolds[from];
                 }
             }
         } else if (foldedLines.length) {
             var newFolds = {};
             foldedLines.forEach(function (line) {
-                range = cm._lineFolds[line];
+                oldRange = cm._lineFolds[line];
+                //update range with lines-diff
+                newRange = moveRange(oldRange, linesDiff);
                 // for removed lines we want to check lines that lie outside the deleted range
                 if (linesDiff < 0) {
                     if (line < from) {
-                        newFolds[line] = range;
+                        newFolds[line] = oldRange;
                     } else if (line >= from + Math.abs(linesDiff)) {
-                        range = rf(cm, CodeMirror.Pos(line + linesDiff));
-                        newFolds[line + linesDiff] = range;
+                        newFolds[line + linesDiff] = newRange;
                     }
                 } else {
                     if (line < from) {
-                        newFolds[line] = range;
-                    } else {
-                        range = rf(cm, CodeMirror.Pos(line + linesDiff));
-                        newFolds[line + linesDiff] = range;
+                        newFolds[line] = oldRange;
+                    } else if (line >= from) {
+                        newFolds[line + linesDiff] = newRange;
                     }
                 }
             });
@@ -317,17 +335,29 @@ define(function (require, exports, module) {
         }, 400);
     }
 
+    /**
+     * Triggered when the cursor moves in the editor and used to detect text selection changes
+     * in the editor.
+     * @param {!CodeMirror} cm the CodeMirror instance for the active editor
+     */
+    function onCursorActivity(cm) {
+        var state = cm.state.foldGutter;
+        var vp = cm.getViewport();
+        window.clearTimeout(state.changeUpdate);
+        state.changeUpdate = window.setTimeout(function () {
+            //need to render the entire visible viewport to remove fold marks rendered from previous selections if any
+            updateInViewport(cm, vp.from, vp.to);
+        }, 400);
+    }
+
     /**
       * Triggered when a code segment is folded.
       * @param {!CodeMirror} cm the CodeMirror instance for the active editor
       * @param {!Object} from  the ch and line position that designates the start of the region
       * @param {!Object} to the ch and line position that designates the end of the region
       */
     function onFold(cm, from, to) {
-        var state = cm.state.foldGutter, line = from.line;
-        if (line >= state.from && line < state.to) {
-            updateFoldInfo(cm, line, line + 1);
-        }
+        updateFoldInfo(cm, from.line, from.line + 1);
     }
 
     /**
@@ -337,11 +367,7 @@ define(function (require, exports, module) {
       * @param {!{line:number, ch:number}} to the ch and line position that designates the end of the region
       */
     function onUnFold(cm, from, to) {
-        var state = cm.state.foldGutter, line = from.line;
-        var vp = cm.getViewport();
-        if (line >= state.from && line < state.to) {
-            updateFoldInfo(cm, line, Math.min(vp.to, to.line));
-        }
+        updateFoldInfo(cm, from.line, from.line + 1);
     }
 
     /**
@@ -356,6 +382,8 @@ define(function (require, exports, module) {
                 cm.off("gutterClick", old.onGutterClick);
                 cm.off("change", onChange);
                 cm.off("viewportChange", onViewportChange);
+                cm.off("cursorActivity", onCursorActivity);
+
                 cm.off("fold", onFold);
                 cm.off("unfold", onUnFold);
                 cm.off("swapDoc", updateInViewport);
@@ -366,6 +394,7 @@ define(function (require, exports, module) {
                 cm.on("gutterClick", val.onGutterClick);
                 cm.on("change", onChange);
                 cm.on("viewportChange", onViewportChange);
+                cm.on("cursorActivity", onCursorActivity);
                 cm.on("fold", onFold);
                 cm.on("unfold", onUnFold);
                 cm.on("swapDoc", updateInViewport);