gollum 2.4.4 → 2.4.5

data/lib/gollum/frontend/public/gollum/livepreview/js/ace/lib/ace/selection.js

@@ -1,38 +1,30 @@
 /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ * Distributed under the BSD license:
  *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is Ajax.org Code Editor (ACE).
- *
- * The Initial Developer of the Original Code is
- * Ajax.org B.V.
- * Portions created by the Initial Developer are Copyright (C) 2010
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- *      Fabian Jakobs <fabian AT ajax DOT org>
- *      Julian Viereck <julian.viereck@gmail.com>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 2 or later (the "GPL"), or
- * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
+ * Copyright (c) 2010, Ajax.org B.V.
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Ajax.org B.V. nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  * ***** END LICENSE BLOCK ***** */
 
@@ -45,20 +37,36 @@ var EventEmitter = require("./lib/event_emitter").EventEmitter;
 var Range = require("./range").Range;
 
 /**
- * class Selection
- *
+ * 
  * Contains the cursor position and the text selection of an edit session.
  *
  * The row/columns used in the selection are in document coordinates representing ths coordinates as thez appear in the document before applying soft wrap and folding.
+ * @class Selection
  **/
 
+
 /**
- * new Selection(session)
- * - session (EditSession): The session to use
+ * Emitted when the cursor position changes.
+ * @event changeCursor
  *
- * Creates a new `Selection` object.
+ * 
  *
 **/
+/**
+ * Emitted when the cursor selection changes.
+ *  @event changeSelection
+ *
+ * 
+ *
+**/
+/**
+ * Creates a new `Selection` object.
+ * @param {EditSession} session The session to use
+ *
+ * 
+ * 
+ * @constructor
+ **/
 var Selection = function(session) {
     this.session = session;
     this.doc = session.getDocument();
@@ -87,9 +95,9 @@ var Selection = function(session) {
     oop.implement(this, EventEmitter);
 
     /**
-    * Selection.isEmpty() -> Boolean
-    *
+    * 
     * Returns `true` if the selection is empty.
+    * @returns {Boolean}
     **/
     this.isEmpty = function() {
         return (this.$isEmpty || (
@@ -98,10 +106,9 @@ var Selection = function(session) {
         ));
     };
 
-    /**
-    * Selection.isMultiLine() -> Boolean
-    *
+    /** 
     * Returns `true` if the selection is a multi-line.
+    * @returns {Boolean}
     **/
     this.isMultiLine = function() {
         if (this.isEmpty()) {
@@ -111,21 +118,20 @@ var Selection = function(session) {
         return this.getRange().isMultiLine();
     };
 
-    /**
-    * Selection.getCursor() -> Number
-    *
+    /** 
     * Gets the current position of the cursor.
+    * @returns {Number}
     **/
     this.getCursor = function() {
         return this.lead.getPosition();
     };
 
     /**
-    * Selection.setSelectionAnchor(row, column)
-    * - row (Number): The new row
-    * - column (Number): The new column
-    *
     * Sets the row and column position of the anchor. This function also emits the `'changeSelection'` event.
+    * @param {Number} row The new row
+    * @param {Number} column The new column
+    *
+    * 
     **/
     this.setSelectionAnchor = function(row, column) {
         this.anchor.setPosition(row, column);
@@ -136,11 +142,9 @@ var Selection = function(session) {
         }
     };
 
-    /** related to: Anchor.getPosition
-    * Selection.getSelectionAnchor() -> Object
-    *
+    /**
     * Returns an object containing the `row` and `column` of the calling selection anchor.
-    *
+    * @related Anchor.getPosition
     **/
     this.getSelectionAnchor = function() {
         if (this.$isEmpty)
@@ -150,19 +154,19 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.getSelectionLead() -> Object
-    *
+    * 
     * Returns an object containing the `row` and `column` of the calling selection lead.
+    * @returns {Object}
     **/
     this.getSelectionLead = function() {
         return this.lead.getPosition();
     };
 
     /**
-    * Selection.shiftSelection(columns)
-    * - columns (Number): The number of columns to shift by
-    *
     * Shifts the selection up (or down, if [[Selection.isBackwards `isBackwards()`]] is true) the given number of columns.
+    * @param {Number} columns The number of columns to shift by
+    *
+    * 
     *
     **/
     this.shiftSelection = function(columns) {
@@ -187,9 +191,8 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.isBackwards() -> Boolean
-    *
     * Returns `true` if the selection is going backwards in the document.
+    * @returns {Boolean}
     **/
     this.isBackwards = function() {
         var anchor = this.anchor;
@@ -198,9 +201,8 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.getRange() -> Range
-    *
-    * [Returns the [[Range `Range`]] for the selected text.]{: #Selection.getRange}
+    * [Returns the [[Range]] for the selected text.]{: #Selection.getRange}
+    * @returns {Range}
     **/
     this.getRange = function() {
         var anchor = this.anchor;
@@ -218,8 +220,6 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.clearSelection()
-    *
     * [Empties the selection (by de-selecting it). This function also emits the `'changeSelection'` event.]{: #Selection.clearSelection}
     **/
     this.clearSelection = function() {
@@ -230,8 +230,6 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectAll()
-    *
     * Selects all the text in the document.
     **/
     this.selectAll = function() {
@@ -241,12 +239,12 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.setSelectionRange(range, reverse)
-    * - range (Range): The range of text to select
-    * - reverse (Boolean): Indicates if the range should go backwards (`true`) or not
-    *
     * Sets the selection to the provided range.
+    * @param {Range} range The range of text to select
+    * @param {Boolean} reverse Indicates if the range should go backwards (`true`) or not
     *
+    * 
+    * @method setSelectionRange
     **/
     this.setRange =
     this.setSelectionRange = function(range, reverse) {
@@ -269,11 +267,11 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectTo(row, column)
-    * - row (Number): The row to select to
-    * - column (Number): The column to select to
-    *
     * Moves the selection cursor to the indicated row and column.
+    * @param {Number} row The row to select to
+    * @param {Number} column The column to select to
+    *
+    * 
     *
     **/
     this.selectTo = function(row, column) {
@@ -283,10 +281,10 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectToPosition(pos)
-    * - pos (Object): An object containing the row and column
-    *
     * Moves the selection cursor to the row and column indicated by `pos`.
+    * @param {Object} pos An object containing the row and column
+    *
+    * 
     *
     **/
     this.selectToPosition = function(pos) {
@@ -296,8 +294,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectUp()
-    *
+    * 
     * Moves the selection up one row.
     **/
     this.selectUp = function() {
@@ -305,8 +302,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectDown()
-    *
+    * 
     * Moves the selection down one row.
     **/
     this.selectDown = function() {
@@ -314,7 +310,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectRight()
+    * 
     *
     * Moves the selection right one column.
     **/
@@ -323,8 +319,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectLeft()
-    *
+    * 
     * Moves the selection left one column.
     **/
     this.selectLeft = function() {
@@ -332,8 +327,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectLineStart()
-    *
+    * 
     * Moves the selection to the beginning of the current line.
     **/
     this.selectLineStart = function() {
@@ -341,8 +335,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectLineEnd()
-    *
+    * 
     * Moves the selection to the end of the current line.
     **/
     this.selectLineEnd = function() {
@@ -350,8 +343,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectFileEnd()
-    *
+    * 
     * Moves the selection to the end of the file.
     **/
     this.selectFileEnd = function() {
@@ -359,8 +351,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectFileStart()
-    *
+    * 
     * Moves the selection to the start of the file.
     **/
     this.selectFileStart = function() {
@@ -368,8 +359,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectWordRight()
-    *
+    * 
     * Moves the selection to the first word on the right.
     **/
     this.selectWordRight = function() {
@@ -377,18 +367,16 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectWordLeft()
-    *
+    * 
     * Moves the selection to the first word on the left.
     **/
     this.selectWordLeft = function() {
         this.$moveSelection(this.moveCursorWordLeft);
     };
 
-    /** related to: EditSession.getWordRange
-    * Selection.selectWord()
-    *
+    /** 
     * Moves the selection to highlight the entire word.
+    * @related EditSession.getWordRange
     **/
     this.getWordRange = function(row, column) {
         if (typeof column == "undefined") {
@@ -398,15 +386,18 @@ var Selection = function(session) {
         }
         return this.session.getWordRange(row, column);
     };
-
+    
+    /**
+    * 
+    * Selects an entire word boundary.
+    **/
     this.selectWord = function() {
         this.setSelectionRange(this.getWordRange());
     };
 
-    /** related to: EditSession.getAWordRange
-    * Selection.selectAWord()
-    *
+    /** 
     * Selects a word, including its right whitespace.
+    * @related EditSession.getAWordRange
     **/
     this.selectAWord = function() {
         var cursor = this.getCursor();
@@ -432,8 +423,6 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.selectLine()
-    *
     * Selects the entire line.
     **/
     this.selectLine = function() {
@@ -441,8 +430,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorUp()
-    *
+    * 
     * Moves the cursor up one row.
     **/
     this.moveCursorUp = function() {
@@ -450,8 +438,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorDown()
-    *
+    * 
     * Moves the cursor down one row.
     **/
     this.moveCursorDown = function() {
@@ -459,8 +446,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorLeft()
-    *
+    * 
     * Moves the cursor left one column.
     **/
     this.moveCursorLeft = function() {
@@ -485,8 +471,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorRight()
-    *
+    * 
     * Moves the cursor right one column.
     **/
     this.moveCursorRight = function() {
@@ -511,8 +496,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorLineStart()
-    *
+    * 
     * Moves the cursor to the start of the line.
     **/
     this.moveCursorLineStart = function() {
@@ -525,8 +509,8 @@ var Selection = function(session) {
 
         // Determ the line
         var beforeCursor = this.session.getDisplayLine(
-            row, null,
-            firstColumnPosition.row, firstColumnPosition.column
+            row, null, firstColumnPosition.row,
+            firstColumnPosition.column
         );
 
         var leadingSpace = beforeCursor.match(/^\s*/);
@@ -544,23 +528,26 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorLineEnd()
-    *
+    * 
     * Moves the cursor to the end of the line.
     **/
     this.moveCursorLineEnd = function() {
         var lead = this.lead;
-        var lastRowColumnPosition =
-            this.session.getDocumentLastRowColumnPosition(lead.row, lead.column);
-        this.moveCursorTo(
-            lastRowColumnPosition.row,
-            lastRowColumnPosition.column
-        );
+        var lineEnd = this.session.getDocumentLastRowColumnPosition(lead.row, lead.column);
+        if (this.lead.column == lineEnd.column) {
+            var line = this.session.getLine(lineEnd.row);
+            if (lineEnd.column == line.length) {
+                var textEnd = line.search(/\s+$/);
+                if (textEnd > 0)
+                    lineEnd.column = textEnd;
+            }
+        }
+
+        this.moveCursorTo(lineEnd.row, lineEnd.column);
     };
 
     /**
-    * Selection.moveCursorFileEnd()
-    *
+    * 
     * Moves the cursor to the end of the file.
     **/
     this.moveCursorFileEnd = function() {
@@ -570,8 +557,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorFileStart()
-    *
+    * 
     * Moves the cursor to the start of the file.
     **/
     this.moveCursorFileStart = function() {
@@ -579,8 +565,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorLongWordRight()
-    *
+    * 
     * Moves the cursor to the word on the right.
     **/
     this.moveCursorLongWordRight = function() {
@@ -626,8 +611,7 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorLongWordLeft()
-    *
+    * 
     * Moves the cursor to the word on the left.
     **/
     this.moveCursorLongWordLeft = function() {
@@ -779,12 +763,13 @@ var Selection = function(session) {
             this.moveCursorShortWordLeft();
     };
 
-    /** related to: EditSession.documentToScreenPosition
-    * Selection.moveCursorBy(rows, chars)
-    * - rows (Number): The number of rows to move by
-    * - chars (Number): The number of characters to move by
+    /**
+    * Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document. 
+    * @param {Number} rows The number of rows to move by
+    * @param {Number} chars The number of characters to move by
     *
-    * Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.
+    * 
+    * @related EditSession.documentToScreenPosition
     **/
     this.moveCursorBy = function(rows, chars) {
         var screenPos = this.session.documentToScreenPosition(
@@ -806,22 +791,22 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorToPosition(position)
-    * - position (Object): The position to move to
-    *
     * Moves the selection to the position indicated by its `row` and `column`.
+    * @param {Object} position The position to move to
+    *
+    * 
     **/
     this.moveCursorToPosition = function(position) {
         this.moveCursorTo(position.row, position.column);
     };
 
     /**
-    * Selection.moveCursorTo(row, column, keepDesiredColumn)
-    * - row (Number): The row to move to
-    * - column (Number): The column to move to
-    * - keepDesiredColumn (Boolean): [If `true`, the cursor move does not respect the previous column]{: #preventUpdateBool}
-    *
     * Moves the cursor to the row and column provided. [If `preventUpdateDesiredColumn` is `true`, then the cursor stays in the same column position as its original point.]{: #preventUpdateBoolDesc}
+    * @param {Number} row The row to move to
+    * @param {Number} column The column to move to
+    * @param {Boolean} keepDesiredColumn [If `true`, the cursor move does not respect the previous column]{: #preventUpdateBool}
+    *
+    * 
     **/
     this.moveCursorTo = function(row, column, keepDesiredColumn) {
         // Ensure the row/column is not inside of a fold.
@@ -840,12 +825,12 @@ var Selection = function(session) {
     };
 
     /**
-    * Selection.moveCursorToScreen(row, column, keepDesiredColumn)
-    * - row (Number): The row to move to
-    * - column (Number): The column to move to
-    * - keepDesiredColumn (Boolean): {:preventUpdateBool}
-    *
     * Moves the cursor to the screen position indicated by row and column. {:preventUpdateBoolDesc}
+    * @param {Number} row The row to move to
+    * @param {Number} column The column to move to
+    * @param {Boolean} keepDesiredColumn {:preventUpdateBool}
+    *
+    * 
     **/
     this.moveCursorToScreen = function(row, column, keepDesiredColumn) {
         var pos = this.session.screenToDocumentPosition(row, column);