Allow code-folding for selected text in editor

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: 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

@@ -227,7 +227,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);

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

@@ -356,6 +356,8 @@ define(function (require, exports, module) {
                 cm.off("gutterClick", old.onGutterClick);
                 cm.off("change", onChange);
                 cm.off("viewportChange", onViewportChange);
+                cm.off("cursorActivity", onViewportChange);
+
                 cm.off("fold", onFold);
                 cm.off("unfold", onUnFold);
                 cm.off("swapDoc", updateInViewport);
@@ -366,6 +368,7 @@ define(function (require, exports, module) {
                 cm.on("gutterClick", val.onGutterClick);
                 cm.on("change", onChange);
                 cm.on("viewportChange", onViewportChange);
+                cm.on("cursorActivity", onViewportChange);
                 cm.on("fold", onFold);
                 cm.on("unfold", onUnFold);
                 cm.on("swapDoc", updateInViewport);

src/extensions/default/CodeFolding/main.js

@@ -29,7 +29,7 @@
 /*global define, $, brackets*/
 define(function (require, exports, module) {
     "use strict";
-    
+
     var CodeMirror              = brackets.getModule("thirdparty/CodeMirror/lib/codemirror"),
         Strings                 = brackets.getModule("strings"),
         AppInit                 = brackets.getModule("utils/AppInit"),
@@ -56,7 +56,7 @@ define(function (require, exports, module) {
         expandAllKeyMac         = "Cmd-Shift-1";
 
     ExtensionUtils.loadStyleSheet(module, "main.less");
-    
+
     // Load CodeMirror addons
     brackets.getModule(["thirdparty/CodeMirror/addon/fold/brace-fold"]);
     brackets.getModule(["thirdparty/CodeMirror/addon/fold/comment-fold"]);
@@ -67,12 +67,13 @@ define(function (require, exports, module) {
     // e.g. collapsing all children when 'alt' key is pressed
     var foldGutter              = require("foldhelpers/foldgutter"),
         foldCode                = require("foldhelpers/foldcode"),
-        indentFold              = require("foldhelpers/indentFold");
-
-
+        indentFold              = require("foldhelpers/indentFold"),
+        selectionFold           = require("foldhelpers/foldSelected");
+
+
     /** Set to true when init() has run; set back to false after deinit() has run */
     var _isInitialized = false;
-    
+
     /**
       * Restores the linefolds in the editor using values fetched from the preference store
       * Checks the document to ensure that changes have not been made (e.g., in a different editor)
@@ -262,7 +263,7 @@ define(function (require, exports, module) {
         cm.refresh();  // force recomputing gutter width - .folding-enabled class affected linenumbers gutter
         CodeMirror.defineOption("foldGutter", false, null);
     }
-    
+
     /** Add gutter and restore saved expand/collapse state */
     function enableFoldingInEditor(editor) {
         if (editor._codeMirror.getOption("gutters").indexOf(GUTTER_NAME) === -1) {
@@ -300,7 +301,7 @@ define(function (require, exports, module) {
      */
     function deinit() {
         _isInitialized = false;
-        
+
         KeyBindingManager.removeBinding(collapseKey);
         KeyBindingManager.removeBinding(expandKey);
         KeyBindingManager.removeBinding(collapseAllKey);
@@ -314,7 +315,7 @@ define(function (require, exports, module) {
         Menus.getMenu(Menus.AppMenuBar.VIEW_MENU).removeMenuItem(EXPAND);
         Menus.getMenu(Menus.AppMenuBar.VIEW_MENU).removeMenuItem(COLLAPSE_ALL);
         Menus.getMenu(Menus.AppMenuBar.VIEW_MENU).removeMenuItem(EXPAND_ALL);
-        
+
         EditorManager.off(".CodeFolding");
         DocumentManager.off(".CodeFolding");
         ProjectManager.off(".CodeFolding");
@@ -325,19 +326,22 @@ define(function (require, exports, module) {
             removeGutter(editor);
         });
     }
-    
+
     /**
      * Enable code-folding functionality
      */
     function init() {
         _isInitialized = true;
-        
+
         foldCode.init();
         foldGutter.init();
-        
+
         // Many CodeMirror modes specify which fold helper should be used for that language. For a few that
         // don't, we register helpers explicitly here. We also register a global helper for generic indent-based
         // folding, which cuts across all languages if enabled via preference.
+        CodeMirror.registerGlobalHelper("fold", "selectionFold", function (mode, cm) {
+            return prefs.getSetting("makeSelectionsFoldable");
+        }, selectionFold);
         CodeMirror.registerGlobalHelper("fold", "indent", function (mode, cm) {
             return prefs.getSetting("alwaysUseIndentFold");
         }, indentFold);
@@ -358,7 +362,7 @@ define(function (require, exports, module) {
         Menus.getMenu(Menus.AppMenuBar.VIEW_MENU).addMenuItem(EXPAND_ALL);
         Menus.getMenu(Menus.AppMenuBar.VIEW_MENU).addMenuItem(COLLAPSE);
         Menus.getMenu(Menus.AppMenuBar.VIEW_MENU).addMenuItem(EXPAND);
-        
+
         //register keybindings
         KeyBindingManager.addBinding(COLLAPSE_ALL, [ {key: collapseAllKey}, {key: collapseAllKeyMac, platform: "mac"} ]);
         KeyBindingManager.addBinding(EXPAND_ALL, [ {key: expandAllKey}, {key: expandAllKeyMac, platform: "mac"} ]);
@@ -370,7 +374,7 @@ define(function (require, exports, module) {
             enableFoldingInEditor(editor);
         });
     }
-    
+
     /**
       * Register change listener for the preferences file.
       */
@@ -394,7 +398,7 @@ define(function (require, exports, module) {
         CommandManager.register(Strings.EXPAND_ALL, EXPAND_ALL, expandAll);
         CommandManager.register(Strings.COLLAPSE_CURRENT, COLLAPSE, collapseCurrent);
         CommandManager.register(Strings.EXPAND_CURRENT, EXPAND, expandCurrent);
-        
+
         if (prefs.getSetting("enabled")) {
             init();
         }