2 * Copyright (C) 2009 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
14 * * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * @param {number} startLine
34 * @param {number} startColumn
35 * @param {number} endLine
36 * @param {number} endColumn
38 WebInspector.TextRange = function(startLine, startColumn, endLine, endColumn)
40 this.startLine = startLine;
41 this.startColumn = startColumn;
42 this.endLine = endLine;
43 this.endColumn = endColumn;
46 WebInspector.TextRange.createFromLocation = function(line, column)
48 return new WebInspector.TextRange(line, column, line, column);
52 * @param {Object} serializedTextRange
53 * @return {WebInspector.TextRange}
55 WebInspector.TextRange.fromObject = function (serializedTextRange)
57 return new WebInspector.TextRange(serializedTextRange.startLine, serializedTextRange.startColumn, serializedTextRange.endLine, serializedTextRange.endColumn);
60 WebInspector.TextRange.prototype = {
66 return this.startLine === this.endLine && this.startColumn === this.endColumn;
74 return this.endLine - this.startLine;
77 collapseToEnd: function()
79 return new WebInspector.TextRange(this.endLine, this.endColumn, this.endLine, this.endColumn);
83 * @return {WebInspector.TextRange}
87 if (this.startLine > this.endLine || (this.startLine === this.endLine && this.startColumn > this.endColumn))
88 return new WebInspector.TextRange(this.endLine, this.endColumn, this.startLine, this.startColumn);
94 * @return {WebInspector.TextRange}
98 return new WebInspector.TextRange(this.startLine, this.startColumn, this.endLine, this.endColumn);
104 serializeToObject: function()
106 var serializedTextRange = {};
107 serializedTextRange.startLine = this.startLine;
108 serializedTextRange.startColumn = this.startColumn;
109 serializedTextRange.endLine = this.endLine;
110 serializedTextRange.endColumn = this.endColumn;
111 return serializedTextRange;
115 * @param {WebInspector.TextRange} other
118 compareTo: function(other)
120 if (this.startLine > other.startLine)
122 if (this.startLine < other.startLine)
124 if (this.startColumn > other.startColumn)
126 if (this.startColumn < other.startColumn)
132 * @param {number} lineOffset
133 * @return {WebInspector.TextRange}
135 shift: function(lineOffset)
137 return new WebInspector.TextRange(this.startLine + lineOffset, this.startColumn, this.endLine + lineOffset, this.endColumn);
142 return JSON.stringify(this);
148 * @param {WebInspector.TextRange} newRange
149 * @param {string} originalText
151 WebInspector.TextEditorCommand = function(newRange, originalText)
153 this.newRange = newRange;
154 this.originalText = originalText;
159 * @extends {WebInspector.Object}
161 WebInspector.TextEditorModel = function()
164 this._attributes = [];
165 /** @type {Array.<WebInspector.TextEditorCommand>} */
166 this._undoStack = [];
167 this._noPunctuationRegex = /[^ !%&()*+,-.:;<=>?\[\]\^{|}~]+/;
168 this._lineBreak = "\n";
171 WebInspector.TextEditorModel.Indent = {
178 WebInspector.TextEditorModel.Events = {
179 TextChanged: "TextChanged"
182 WebInspector.TextEditorModel.endsWithBracketRegex = /[{(\[]\s*$/;
184 WebInspector.TextEditorModel.prototype = {
190 return this._lines.length;
198 return this._lines.join(this._lineBreak);
202 * @return {WebInspector.TextRange}
206 return new WebInspector.TextRange(0, 0, this._lines.length - 1, this._lines[this._lines.length - 1].length);
214 return this._lineBreak;
218 * @param {number} lineNumber
221 line: function(lineNumber)
223 if (lineNumber >= this._lines.length)
224 throw "Out of bounds:" + lineNumber;
225 return this._lines[lineNumber];
229 * @param {number} lineNumber
232 lineLength: function(lineNumber)
234 return this._lines[lineNumber].length;
238 * @param {string} text
240 setText: function(text)
242 this._resetUndoStack();
244 var range = this.range();
245 this._lineBreak = /\r\n/.test(text) ? "\r\n" : "\n";
246 var newRange = this._innerSetText(range, text);
247 this.dispatchEventToListeners(WebInspector.TextEditorModel.Events.TextChanged, { oldRange: range, newRange: newRange});
251 * @param {WebInspector.TextRange} range
252 * @param {string} text
253 * @return {WebInspector.TextRange}
255 editRange: function(range, text)
257 if (this._lastEditedRange && (!text || text.indexOf("\n") !== -1 || this._lastEditedRange.endLine !== range.startLine || this._lastEditedRange.endColumn !== range.startColumn))
258 this._markUndoableState();
259 return this._innerEditRange(range, text);
263 * @param {WebInspector.TextRange} range
264 * @param {string} text
265 * @return {WebInspector.TextRange}
267 _innerEditRange: function(range, text)
269 var originalText = this.copyRange(range);
270 this._lastEditedRange = range;
271 var newRange = range;
272 if (text !== originalText) {
273 newRange = this._innerSetText(range, text);
274 this._pushUndoableCommand(newRange, originalText);
277 this.dispatchEventToListeners(WebInspector.TextEditorModel.Events.TextChanged, { oldRange: range, newRange: newRange, editRange: true });
282 * @param {WebInspector.TextRange} range
283 * @param {string} text
284 * @return {WebInspector.TextRange}
286 _innerSetText: function(range, text)
288 this._eraseRange(range);
290 return new WebInspector.TextRange(range.startLine, range.startColumn, range.startLine, range.startColumn);
292 var newLines = text.split(/\r?\n/);
294 var prefix = this._lines[range.startLine].substring(0, range.startColumn);
295 var suffix = this._lines[range.startLine].substring(range.startColumn);
297 var postCaret = prefix.length;
299 if (newLines.length === 1) {
300 this._setLine(range.startLine, prefix + newLines[0] + suffix);
301 postCaret += newLines[0].length;
303 this._setLine(range.startLine, prefix + newLines[0]);
304 this._insertLines(range, newLines);
305 this._setLine(range.startLine + newLines.length - 1, newLines[newLines.length - 1] + suffix);
306 postCaret = newLines[newLines.length - 1].length;
309 return new WebInspector.TextRange(range.startLine, range.startColumn,
310 range.startLine + newLines.length - 1, postCaret);
314 * @param {WebInspector.TextRange} range
315 * @param {Array.<string>} newLines
317 _insertLines: function(range, newLines)
319 var lines = new Array(this._lines.length + newLines.length - 1);
320 for (var i = 0; i <= range.startLine; ++i)
321 lines[i] = this._lines[i];
322 // Line at [0] is already set via setLine.
323 for (var i = 1; i < newLines.length; ++i)
324 lines[range.startLine + i] = newLines[i];
325 for (var i = range.startLine + newLines.length; i < lines.length; ++i)
326 lines[i] = this._lines[i - newLines.length + 1];
329 // Adjust attributes, attributes move with the first character of line.
330 var attributes = new Array(lines.length);
331 var insertionIndex = range.startColumn ? range.startLine + 1 : range.startLine;
332 for (var i = 0; i < insertionIndex; ++i)
333 attributes[i] = this._attributes[i];
334 for (var i = insertionIndex + newLines.length - 1; i < attributes.length; ++i)
335 attributes[i] = this._attributes[i - newLines.length + 1];
336 this._attributes = attributes;
340 * @param {WebInspector.TextRange} range
342 _eraseRange: function(range)
347 var prefix = this._lines[range.startLine].substring(0, range.startColumn);
348 var suffix = this._lines[range.endLine].substring(range.endColumn);
350 if (range.endLine > range.startLine) {
351 this._lines.splice(range.startLine + 1, range.endLine - range.startLine);
352 // Adjust attributes, attributes move with the first character of line.
353 this._attributes.splice(range.startColumn ? range.startLine + 1 : range.startLine, range.endLine - range.startLine);
355 this._setLine(range.startLine, prefix + suffix);
359 * @param {number} lineNumber
360 * @param {string} text
362 _setLine: function(lineNumber, text)
364 this._lines[lineNumber] = text;
368 * @param {number} lineNumber
369 * @param {number} column
370 * @return {WebInspector.TextRange}
372 wordRange: function(lineNumber, column)
374 return new WebInspector.TextRange(lineNumber, this.wordStart(lineNumber, column, true), lineNumber, this.wordEnd(lineNumber, column, true));
378 * @param {number} lineNumber
379 * @param {number} column
380 * @param {boolean} gapless
383 wordStart: function(lineNumber, column, gapless)
385 var line = this._lines[lineNumber];
386 var prefix = line.substring(0, column).split("").reverse().join("");
387 var prefixMatch = this._noPunctuationRegex.exec(prefix);
388 return prefixMatch && (!gapless || prefixMatch.index === 0) ? column - prefixMatch.index - prefixMatch[0].length : column;
392 * @param {number} lineNumber
393 * @param {number} column
394 * @param {boolean} gapless
397 wordEnd: function(lineNumber, column, gapless)
399 var line = this._lines[lineNumber];
400 var suffix = line.substring(column);
401 var suffixMatch = this._noPunctuationRegex.exec(suffix);
402 return suffixMatch && (!gapless || suffixMatch.index === 0) ? column + suffixMatch.index + suffixMatch[0].length : column;
406 * @param {WebInspector.TextRange} range
409 copyRange: function(range)
412 range = this.range();
415 if (range.startLine === range.endLine) {
416 clip.push(this._lines[range.startLine].substring(range.startColumn, range.endColumn));
417 return clip.join(this._lineBreak);
419 clip.push(this._lines[range.startLine].substring(range.startColumn));
420 for (var i = range.startLine + 1; i < range.endLine; ++i)
421 clip.push(this._lines[i]);
422 clip.push(this._lines[range.endLine].substring(0, range.endColumn));
423 return clip.join(this._lineBreak);
427 * @param {number} line
428 * @param {string} name
429 * @param {Object?} value
431 setAttribute: function(line, name, value)
433 var attrs = this._attributes[line];
436 this._attributes[line] = attrs;
442 * @param {number} line
443 * @param {string} name
444 * @return {Object|null} value
446 getAttribute: function(line, name)
448 var attrs = this._attributes[line];
449 return attrs ? attrs[name] : null;
453 * @param {number} line
454 * @param {string} name
456 removeAttribute: function(line, name)
458 var attrs = this._attributes[line];
464 * @param {WebInspector.TextRange} newRange
465 * @param {string} originalText
466 * @return {WebInspector.TextEditorCommand}
468 _pushUndoableCommand: function(newRange, originalText)
470 var command = new WebInspector.TextEditorCommand(newRange.clone(), originalText);
472 this._redoStack.push(command);
475 this._redoStack = [];
476 this._undoStack.push(command);
482 * @return {?WebInspector.TextRange}
486 if (!this._undoStack.length)
489 this._markRedoableState();
492 var range = this._doUndo(this._undoStack);
499 * @return {WebInspector.TextRange}
503 if (!this._redoStack || !this._redoStack.length)
505 this._markUndoableState();
508 var range = this._doUndo(this._redoStack);
515 * @param {Array.<WebInspector.TextEditorCommand>} stack
516 * @return {WebInspector.TextRange}
518 _doUndo: function(stack)
521 for (var i = stack.length - 1; i >= 0; --i) {
522 var command = stack[i];
524 range = this._innerEditRange(command.newRange, command.originalText);
525 if (i > 0 && stack[i - 1].explicit)
531 _markUndoableState: function()
533 if (this._undoStack.length)
534 this._undoStack[this._undoStack.length - 1].explicit = true;
537 _markRedoableState: function()
539 if (this._redoStack.length)
540 this._redoStack[this._redoStack.length - 1].explicit = true;
543 _resetUndoStack: function()
545 this._undoStack = [];
549 * @param {WebInspector.TextRange} range
550 * @return {WebInspector.TextRange}
552 indentLines: function(range)
554 this._markUndoableState();
556 var indent = WebInspector.settings.textEditorIndent.get();
557 var newRange = range.clone();
558 // Do not change a selection start position when it is at the beginning of a line
559 if (range.startColumn)
560 newRange.startColumn += indent.length;
562 var indentEndLine = range.endLine;
564 newRange.endColumn += indent.length;
568 for (var lineNumber = range.startLine; lineNumber <= indentEndLine; lineNumber++)
569 this._innerEditRange(WebInspector.TextRange.createFromLocation(lineNumber, 0), indent);
575 * @param {WebInspector.TextRange} range
576 * @return {WebInspector.TextRange}
578 unindentLines: function(range)
580 this._markUndoableState();
582 var indent = WebInspector.settings.textEditorIndent.get();
583 var indentLength = indent === WebInspector.TextEditorModel.Indent.TabCharacter ? 4 : indent.length;
584 var lineIndentRegex = new RegExp("^ {1," + indentLength + "}");
585 var newRange = range.clone();
587 var indentEndLine = range.endLine;
588 if (!range.endColumn)
591 for (var lineNumber = range.startLine; lineNumber <= indentEndLine; lineNumber++) {
592 var line = this.line(lineNumber);
593 var firstCharacter = line.charAt(0);
594 var lineIndentLength;
596 if (firstCharacter === " ")
597 lineIndentLength = line.match(lineIndentRegex)[0].length;
598 else if (firstCharacter === "\t")
599 lineIndentLength = 1;
603 this._innerEditRange(new WebInspector.TextRange(lineNumber, 0, lineNumber, lineIndentLength), "");
605 if (lineNumber === range.startLine)
606 newRange.startColumn = Math.max(0, newRange.startColumn - lineIndentLength);
607 if (lineNumber === range.endLine)
608 newRange.endColumn = Math.max(0, newRange.endColumn - lineIndentLength);
615 * @param {number=} from
616 * @param {number=} to
617 * @return {WebInspector.TextEditorModel}
619 slice: function(from, to)
621 var textModel = new WebInspector.TextEditorModel();
622 textModel._lines = this._lines.slice(from, to);
623 textModel._lineBreak = this._lineBreak;
628 * @param {WebInspector.TextRange} range
629 * @return {WebInspector.TextRange}
631 growRangeLeft: function(range)
633 var result = range.clone();
634 if (result.startColumn)
635 --result.startColumn;
636 else if (result.startLine)
637 result.startColumn = this.lineLength(--result.startLine);
642 * @param {WebInspector.TextRange} range
643 * @return {WebInspector.TextRange}
645 growRangeRight: function(range)
647 var result = range.clone();
648 if (result.endColumn < this.lineLength(result.endLine))
650 else if (result.endLine < this.linesCount) {
651 result.endColumn = 0;
657 __proto__: WebInspector.Object.prototype
662 * @param {WebInspector.TextEditorModel} textModel
664 WebInspector.TextEditorModel.BraceMatcher = function(textModel)
666 this._textModel = textModel;
669 WebInspector.TextEditorModel.BraceMatcher.prototype = {
671 * @param {number} lineNumber
672 * @return {Array.<{startColumn: number, endColumn: number, token: string}>}
674 _braceRanges: function(lineNumber)
676 if (lineNumber >= this._textModel.linesCount || lineNumber < 0)
679 var attribute = this._textModel.getAttribute(lineNumber, "highlight");
683 return attribute.braces;
687 * @param {string} braceTokenLeft
688 * @param {string} braceTokenRight
691 _matches: function(braceTokenLeft, braceTokenRight)
693 return ((braceTokenLeft === "brace-start" && braceTokenRight === "brace-end") || (braceTokenLeft === "block-start" && braceTokenRight === "block-end"));
697 * @param {number} lineNumber
698 * @param {number} column
699 * @param {number=} maxBraceIteration
700 * @return {?{lineNumber: number, column: number, token: string}}
702 findLeftCandidate: function(lineNumber, column, maxBraceIteration)
704 var braces = this._braceRanges(lineNumber);
708 var braceIndex = braces.length - 1;
709 while (braceIndex >= 0 && braces[braceIndex].startColumn > column)
712 var brace = braceIndex >= 0 ? braces[braceIndex] : null;
713 if (brace && brace.startColumn === column && (brace.token === "block-end" || brace.token === "brace-end"))
717 maxBraceIteration = maxBraceIteration || Number.MAX_VALUE;
718 while (--maxBraceIteration) {
719 if (braceIndex < 0) {
720 while ((braces = this._braceRanges(--lineNumber)) && !braces.length) {};
723 braceIndex = braces.length - 1;
725 brace = braces[braceIndex];
726 if (brace.token === "block-end" || brace.token === "brace-end")
727 stack.push(brace.token);
728 else if (stack.length === 0)
730 lineNumber: lineNumber,
731 column: brace.startColumn,
734 else if (!this._matches(brace.token, stack.pop()))
743 * @param {number} lineNumber
744 * @param {number} column
745 * @param {number=} maxBraceIteration
746 * @return {?{lineNumber: number, column: number, token: string}}
748 findRightCandidate: function(lineNumber, column, maxBraceIteration)
750 var braces = this._braceRanges(lineNumber);
755 while (braceIndex < braces.length && braces[braceIndex].startColumn < column)
758 var brace = braceIndex < braces.length ? braces[braceIndex] : null;
759 if (brace && brace.startColumn === column && (brace.token === "block-start" || brace.token === "brace-start"))
763 maxBraceIteration = maxBraceIteration || Number.MAX_VALUE;
764 while (--maxBraceIteration) {
765 if (braceIndex >= braces.length) {
766 while ((braces = this._braceRanges(++lineNumber)) && !braces.length) {};
771 brace = braces[braceIndex];
772 if (brace.token === "block-start" || brace.token === "brace-start")
773 stack.push(brace.token);
774 else if (stack.length === 0)
776 lineNumber: lineNumber,
777 column: brace.startColumn,
780 else if (!this._matches(stack.pop(), brace.token))
788 * @param {number} lineNumber
789 * @param {number} column
790 * @param {number=} maxBraceIteration
791 * @return {?{leftBrace: {lineNumber: number, column: number, token: string}, rightBrace: {lineNumber: number, column: number, token: string}}}
793 enclosingBraces: function(lineNumber, column, maxBraceIteration)
795 var leftBraceLocation = this.findLeftCandidate(lineNumber, column, maxBraceIteration);
796 if (!leftBraceLocation)
799 var rightBraceLocation = this.findRightCandidate(lineNumber, column, maxBraceIteration);
800 if (!rightBraceLocation)
803 if (!this._matches(leftBraceLocation.token, rightBraceLocation.token))
807 leftBrace: leftBraceLocation,
808 rightBrace: rightBraceLocation