cstyle.js 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. /* ***** BEGIN LICENSE BLOCK *****
  2. * Distributed under the BSD license:
  3. *
  4. * Copyright (c) 2010, Ajax.org B.V.
  5. * All rights reserved.
  6. *
  7. * Redistribution and use in source and binary forms, with or without
  8. * modification, are permitted provided that the following conditions are met:
  9. * * Redistributions of source code must retain the above copyright
  10. * notice, this list of conditions and the following disclaimer.
  11. * * Redistributions in binary form must reproduce the above copyright
  12. * notice, this list of conditions and the following disclaimer in the
  13. * documentation and/or other materials provided with the distribution.
  14. * * Neither the name of Ajax.org B.V. nor the
  15. * names of its contributors may be used to endorse or promote products
  16. * derived from this software without specific prior written permission.
  17. *
  18. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  19. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21. * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
  22. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28. *
  29. * ***** END LICENSE BLOCK ***** */
  30. define(function(require, exports, module) {
  31. "use strict";
  32. var oop = require("../../lib/oop");
  33. var Range = require("../../range").Range;
  34. var BaseFoldMode = require("./fold_mode").FoldMode;
  35. var FoldMode = exports.FoldMode = function(commentRegex) {
  36. if (commentRegex) {
  37. this.foldingStartMarker = new RegExp(
  38. this.foldingStartMarker.source.replace(/\|[^|]*?$/, "|" + commentRegex.start)
  39. );
  40. this.foldingStopMarker = new RegExp(
  41. this.foldingStopMarker.source.replace(/\|[^|]*?$/, "|" + commentRegex.end)
  42. );
  43. }
  44. };
  45. oop.inherits(FoldMode, BaseFoldMode);
  46. (function() {
  47. this.foldingStartMarker = /(\{|\[)[^\}\]]*$|^\s*(\/\*)/;
  48. this.foldingStopMarker = /^[^\[\{]*(\}|\])|^[\s\*]*(\*\/)/;
  49. this.singleLineBlockCommentRe= /^\s*(\/\*).*\*\/\s*$/;
  50. this.tripleStarBlockCommentRe = /^\s*(\/\*\*\*).*\*\/\s*$/;
  51. this.startRegionRe = /^\s*(\/\*|\/\/)#?region\b/;
  52. //prevent naming conflict with any modes that inherit from cstyle and override this (like csharp)
  53. this._getFoldWidgetBase = this.getFoldWidget;
  54. /**
  55. * Gets fold widget with some non-standard extras:
  56. *
  57. * @example lineCommentRegionStart
  58. * //#region [optional description]
  59. *
  60. * @example blockCommentRegionStart
  61. * /*#region [optional description] *[/]
  62. *
  63. * @example tripleStarFoldingSection
  64. * /*** this folds even though 1 line because it has 3 stars ***[/]
  65. *
  66. * @note the pound symbol for region tags is optional
  67. */
  68. this.getFoldWidget = function(session, foldStyle, row) {
  69. var line = session.getLine(row);
  70. if (this.singleLineBlockCommentRe.test(line)) {
  71. // No widget for single line block comment unless region or triple star
  72. if (!this.startRegionRe.test(line) && !this.tripleStarBlockCommentRe.test(line))
  73. return "";
  74. }
  75. var fw = this._getFoldWidgetBase(session, foldStyle, row);
  76. if (!fw && this.startRegionRe.test(line))
  77. return "start"; // lineCommentRegionStart
  78. return fw;
  79. };
  80. this.getFoldWidgetRange = function(session, foldStyle, row, forceMultiline) {
  81. var line = session.getLine(row);
  82. if (this.startRegionRe.test(line))
  83. return this.getCommentRegionBlock(session, line, row);
  84. var match = line.match(this.foldingStartMarker);
  85. if (match) {
  86. var i = match.index;
  87. if (match[1])
  88. return this.openingBracketBlock(session, match[1], row, i);
  89. var range = session.getCommentFoldRange(row, i + match[0].length, 1);
  90. if (range && !range.isMultiLine()) {
  91. if (forceMultiline) {
  92. range = this.getSectionRange(session, row);
  93. } else if (foldStyle != "all")
  94. range = null;
  95. }
  96. return range;
  97. }
  98. if (foldStyle === "markbegin")
  99. return;
  100. var match = line.match(this.foldingStopMarker);
  101. if (match) {
  102. var i = match.index + match[0].length;
  103. if (match[1])
  104. return this.closingBracketBlock(session, match[1], row, i);
  105. return session.getCommentFoldRange(row, i, -1);
  106. }
  107. };
  108. this.getSectionRange = function(session, row) {
  109. var line = session.getLine(row);
  110. var startIndent = line.search(/\S/);
  111. var startRow = row;
  112. var startColumn = line.length;
  113. row = row + 1;
  114. var endRow = row;
  115. var maxRow = session.getLength();
  116. while (++row < maxRow) {
  117. line = session.getLine(row);
  118. var indent = line.search(/\S/);
  119. if (indent === -1)
  120. continue;
  121. if (startIndent > indent)
  122. break;
  123. var subRange = this.getFoldWidgetRange(session, "all", row);
  124. if (subRange) {
  125. if (subRange.start.row <= startRow) {
  126. break;
  127. } else if (subRange.isMultiLine()) {
  128. row = subRange.end.row;
  129. } else if (startIndent == indent) {
  130. break;
  131. }
  132. }
  133. endRow = row;
  134. }
  135. return new Range(startRow, startColumn, endRow, session.getLine(endRow).length);
  136. };
  137. /**
  138. * gets comment region block with end region assumed to be start of comment in any cstyle mode or SQL mode (--) which inherits from this.
  139. * There may optionally be a pound symbol before the region/endregion statement
  140. */
  141. this.getCommentRegionBlock = function(session, line, row) {
  142. var startColumn = line.search(/\s*$/);
  143. var maxRow = session.getLength();
  144. var startRow = row;
  145. var re = /^\s*(?:\/\*|\/\/|--)#?(end)?region\b/;
  146. var depth = 1;
  147. while (++row < maxRow) {
  148. line = session.getLine(row);
  149. var m = re.exec(line);
  150. if (!m) continue;
  151. if (m[1]) depth--;
  152. else depth++;
  153. if (!depth) break;
  154. }
  155. var endRow = row;
  156. if (endRow > startRow) {
  157. return new Range(startRow, startColumn, endRow, line.length);
  158. }
  159. };
  160. }).call(FoldMode.prototype);
  161. });