char-class-classranges-merge-transform.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. /**
  2. * The MIT License (MIT)
  3. * Copyright (c) 2017-present Dmitry Soshnikov <dmitry.soshnikov@gmail.com>
  4. */
  5. 'use strict';
  6. /**
  7. * A regexp-tree plugin to merge class ranges.
  8. *
  9. * [a-ec] -> [a-e]
  10. * [a-ec-e] -> [a-e]
  11. * [\w\da-f] -> [\w]
  12. * [abcdef] -> [a-f]
  13. */
  14. module.exports = {
  15. _hasIUFlags: false,
  16. init: function init(ast) {
  17. this._hasIUFlags = ast.flags.includes('i') && ast.flags.includes('u');
  18. },
  19. CharacterClass: function CharacterClass(path) {
  20. var node = path.node;
  21. var expressions = node.expressions;
  22. var metas = [];
  23. // Extract metas
  24. expressions.forEach(function (expression) {
  25. if (isMeta(expression)) {
  26. metas.push(expression.value);
  27. }
  28. });
  29. expressions.sort(sortCharClass);
  30. for (var i = 0; i < expressions.length; i++) {
  31. var expression = expressions[i];
  32. if (fitsInMetas(expression, metas, this._hasIUFlags) || combinesWithPrecedingClassRange(expression, expressions[i - 1]) || combinesWithFollowingClassRange(expression, expressions[i + 1])) {
  33. expressions.splice(i, 1);
  34. i--;
  35. } else {
  36. var nbMergedChars = charCombinesWithPrecedingChars(expression, i, expressions);
  37. expressions.splice(i - nbMergedChars + 1, nbMergedChars);
  38. i -= nbMergedChars;
  39. }
  40. }
  41. }
  42. };
  43. /**
  44. * Sorts expressions in char class in the following order:
  45. * - meta chars, ordered alphabetically by value
  46. * - chars (except `control` kind) and class ranges, ordered alphabetically (`from` char is used for class ranges)
  47. * - if ambiguous, class range comes before char
  48. * - if ambiguous between two class ranges, orders alphabetically by `to` char
  49. * - control chars, ordered alphabetically by value
  50. * @param {Object} a - Left Char or ClassRange node
  51. * @param {Object} b - Right Char or ClassRange node
  52. * @returns {number}
  53. */
  54. function sortCharClass(a, b) {
  55. var aValue = getSortValue(a);
  56. var bValue = getSortValue(b);
  57. if (aValue === bValue) {
  58. // We want ClassRange before Char
  59. // [bb-d] -> [b-db]
  60. if (a.type === 'ClassRange' && b.type !== 'ClassRange') {
  61. return -1;
  62. }
  63. if (b.type === 'ClassRange' && a.type !== 'ClassRange') {
  64. return 1;
  65. }
  66. if (a.type === 'ClassRange' && b.type === 'ClassRange') {
  67. return getSortValue(a.to) - getSortValue(b.to);
  68. }
  69. if (isMeta(a) && isMeta(b) || isControl(a) && isControl(b)) {
  70. return a.value < b.value ? -1 : 1;
  71. }
  72. }
  73. return aValue - bValue;
  74. }
  75. /**
  76. * @param {Object} expression - Char or ClassRange node
  77. * @returns {number}
  78. */
  79. function getSortValue(expression) {
  80. if (expression.type === 'Char') {
  81. if (expression.kind === 'control') {
  82. return Infinity;
  83. }
  84. if (expression.kind === 'meta' && isNaN(expression.codePoint)) {
  85. return -1;
  86. }
  87. return expression.codePoint;
  88. }
  89. // ClassRange
  90. return expression.from.codePoint;
  91. }
  92. /**
  93. * Checks if a node is a meta char from the set \d\w\s\D\W\S
  94. * @param {Object} expression - Char or ClassRange node
  95. * @param {?string} value
  96. * @returns {boolean}
  97. */
  98. function isMeta(expression) {
  99. var value = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
  100. return expression.type === 'Char' && expression.kind === 'meta' && (value ? expression.value === value : /^\\[dws]$/i.test(expression.value));
  101. }
  102. /**
  103. * @param {Object} expression - Char or ClassRange node
  104. * @returns {boolean}
  105. */
  106. function isControl(expression) {
  107. return expression.type === 'Char' && expression.kind === 'control';
  108. }
  109. /**
  110. * @param {Object} expression - Char or ClassRange node
  111. * @param {string[]} metas - Array of meta chars, e.g. ["\\w", "\\s"]
  112. * @param {boolean} hasIUFlags
  113. * @returns {boolean}
  114. */
  115. function fitsInMetas(expression, metas, hasIUFlags) {
  116. for (var i = 0; i < metas.length; i++) {
  117. if (fitsInMeta(expression, metas[i], hasIUFlags)) {
  118. return true;
  119. }
  120. }
  121. return false;
  122. }
  123. /**
  124. * @param {Object} expression - Char or ClassRange node
  125. * @param {string} meta - e.g. "\\w"
  126. * @param {boolean} hasIUFlags
  127. * @returns {boolean}
  128. */
  129. function fitsInMeta(expression, meta, hasIUFlags) {
  130. if (expression.type === 'ClassRange') {
  131. return fitsInMeta(expression.from, meta, hasIUFlags) && fitsInMeta(expression.to, meta, hasIUFlags);
  132. }
  133. // Special cases:
  134. // \S contains \w and \d
  135. if (meta === '\\S' && (isMeta(expression, '\\w') || isMeta(expression, '\\d'))) {
  136. return true;
  137. }
  138. // \D contains \W and \s
  139. if (meta === '\\D' && (isMeta(expression, '\\W') || isMeta(expression, '\\s'))) {
  140. return true;
  141. }
  142. // \w contains \d
  143. if (meta === '\\w' && isMeta(expression, '\\d')) {
  144. return true;
  145. }
  146. // \W contains \s
  147. if (meta === '\\W' && isMeta(expression, '\\s')) {
  148. return true;
  149. }
  150. if (expression.type !== 'Char' || isNaN(expression.codePoint)) {
  151. return false;
  152. }
  153. if (meta === '\\s') {
  154. return fitsInMetaS(expression);
  155. }
  156. if (meta === '\\S') {
  157. return !fitsInMetaS(expression);
  158. }
  159. if (meta === '\\d') {
  160. return fitsInMetaD(expression);
  161. }
  162. if (meta === '\\D') {
  163. return !fitsInMetaD(expression);
  164. }
  165. if (meta === '\\w') {
  166. return fitsInMetaW(expression, hasIUFlags);
  167. }
  168. if (meta === '\\W') {
  169. return !fitsInMetaW(expression, hasIUFlags);
  170. }
  171. return false;
  172. }
  173. /**
  174. * @param {Object} expression - Char node with codePoint
  175. * @returns {boolean}
  176. */
  177. function fitsInMetaS(expression) {
  178. return expression.codePoint === 0x0009 || // \t
  179. expression.codePoint === 0x000a || // \n
  180. expression.codePoint === 0x000b || // \v
  181. expression.codePoint === 0x000c || // \f
  182. expression.codePoint === 0x000d || // \r
  183. expression.codePoint === 0x0020 || // space
  184. expression.codePoint === 0x00a0 || // nbsp
  185. expression.codePoint === 0x1680 || // part of Zs
  186. expression.codePoint >= 0x2000 && expression.codePoint <= 0x200a || // part of Zs
  187. expression.codePoint === 0x2028 || // line separator
  188. expression.codePoint === 0x2029 || // paragraph separator
  189. expression.codePoint === 0x202f || // part of Zs
  190. expression.codePoint === 0x205f || // part of Zs
  191. expression.codePoint === 0x3000 || // part of Zs
  192. expression.codePoint === 0xfeff; // zwnbsp
  193. }
  194. /**
  195. * @param {Object} expression - Char node with codePoint
  196. * @returns {boolean}
  197. */
  198. function fitsInMetaD(expression) {
  199. return expression.codePoint >= 0x30 && expression.codePoint <= 0x39; // 0-9
  200. }
  201. /**
  202. * @param {Object} expression - Char node with codePoint
  203. * @param {boolean} hasIUFlags
  204. * @returns {boolean}
  205. */
  206. function fitsInMetaW(expression, hasIUFlags) {
  207. return fitsInMetaD(expression) || expression.codePoint >= 0x41 && expression.codePoint <= 0x5a || // A-Z
  208. expression.codePoint >= 0x61 && expression.codePoint <= 0x7a || // a-z
  209. expression.value === '_' || hasIUFlags && (expression.codePoint === 0x017f || expression.codePoint === 0x212a);
  210. }
  211. /**
  212. * @param {Object} expression - Char or ClassRange node
  213. * @param {Object} classRange - Char or ClassRange node
  214. * @returns {boolean}
  215. */
  216. function combinesWithPrecedingClassRange(expression, classRange) {
  217. if (classRange && classRange.type === 'ClassRange') {
  218. if (fitsInClassRange(expression, classRange)) {
  219. // [a-gc] -> [a-g]
  220. // [a-gc-e] -> [a-g]
  221. return true;
  222. } else if (
  223. // We only want \w chars or char codes to keep readability
  224. isMetaWCharOrCode(expression) && classRange.to.codePoint === expression.codePoint - 1) {
  225. // [a-de] -> [a-e]
  226. classRange.to = expression;
  227. return true;
  228. } else if (expression.type === 'ClassRange' && expression.from.codePoint <= classRange.to.codePoint + 1 && expression.to.codePoint >= classRange.from.codePoint - 1) {
  229. // [a-db-f] -> [a-f]
  230. // [b-fa-d] -> [a-f]
  231. // [a-cd-f] -> [a-f]
  232. if (expression.from.codePoint < classRange.from.codePoint) {
  233. classRange.from = expression.from;
  234. }
  235. if (expression.to.codePoint > classRange.to.codePoint) {
  236. classRange.to = expression.to;
  237. }
  238. return true;
  239. }
  240. }
  241. return false;
  242. }
  243. /**
  244. * @param {Object} expression - Char or ClassRange node
  245. * @param {Object} classRange - Char or ClassRange node
  246. * @returns {boolean}
  247. */
  248. function combinesWithFollowingClassRange(expression, classRange) {
  249. if (classRange && classRange.type === 'ClassRange') {
  250. // Considering the elements were ordered alphabetically,
  251. // there is only one case to handle
  252. // [ab-e] -> [a-e]
  253. if (
  254. // We only want \w chars or char codes to keep readability
  255. isMetaWCharOrCode(expression) && classRange.from.codePoint === expression.codePoint + 1) {
  256. classRange.from = expression;
  257. return true;
  258. }
  259. }
  260. return false;
  261. }
  262. /**
  263. * @param {Object} expression - Char or ClassRange node
  264. * @param {Object} classRange - ClassRange node
  265. * @returns {boolean}
  266. */
  267. function fitsInClassRange(expression, classRange) {
  268. if (expression.type === 'Char' && isNaN(expression.codePoint)) {
  269. return false;
  270. }
  271. if (expression.type === 'ClassRange') {
  272. return fitsInClassRange(expression.from, classRange) && fitsInClassRange(expression.to, classRange);
  273. }
  274. return expression.codePoint >= classRange.from.codePoint && expression.codePoint <= classRange.to.codePoint;
  275. }
  276. /**
  277. * @param {Object} expression - Char or ClassRange node
  278. * @param {Number} index
  279. * @param {Object[]} expressions - expressions in CharClass
  280. * @returns {number} - Number of characters combined with expression
  281. */
  282. function charCombinesWithPrecedingChars(expression, index, expressions) {
  283. // We only want \w chars or char codes to keep readability
  284. if (!isMetaWCharOrCode(expression)) {
  285. return 0;
  286. }
  287. var nbMergedChars = 0;
  288. while (index > 0) {
  289. var currentExpression = expressions[index];
  290. var precedingExpresion = expressions[index - 1];
  291. if (isMetaWCharOrCode(precedingExpresion) && precedingExpresion.codePoint === currentExpression.codePoint - 1) {
  292. nbMergedChars++;
  293. index--;
  294. } else {
  295. break;
  296. }
  297. }
  298. if (nbMergedChars > 1) {
  299. expressions[index] = {
  300. type: 'ClassRange',
  301. from: expressions[index],
  302. to: expression
  303. };
  304. return nbMergedChars;
  305. }
  306. return 0;
  307. }
  308. function isMetaWCharOrCode(expression) {
  309. return expression && expression.type === 'Char' && !isNaN(expression.codePoint) && (fitsInMetaW(expression, false) || expression.kind === 'unicode' || expression.kind === 'hex' || expression.kind === 'oct' || expression.kind === 'decimal');
  310. }