re2js 1.3.2 → 1.4.0

package/build/index.umd.js

@@ -2,7 +2,7 @@
  * re2js
  * RE2JS is the JavaScript port of RE2, a regular expression engine that provides linear time matching
  *
- * @version v1.3.2
+ * @version v1.4.0
  * @author Alexey Vasiliev
  * @homepage https://github.com/le0pard/re2js#readme
  * @repository github:le0pard/re2js
@@ -1130,16 +1130,31 @@
      * {@link #appendReplacement} as a literal replacement of {@code s}.
      *
      * @param {string} str the string to be quoted
+     * @param {boolean} [javaMode=false] whether the replacement will be used in javaMode
      * @returns {string} the quoted string
      */
-    static quoteReplacement(str) {
-      if (str.indexOf('\\') < 0 && str.indexOf('$') < 0) {
+    static quoteReplacement(str, javaMode = false) {
+      if (javaMode) {
+        // Java mode escape '\' and '$' with a backslash
+        if (str.indexOf('\\') < 0 && str.indexOf('$') < 0) {
+          return str;
+        }
+        return str.split('').map(s => {
+          const c = s.codePointAt(0);
+          if (c === Codepoint.CODES.get('\\') || c === Codepoint.CODES.get('$')) {
+            return `\\${s}`;
+          }
+          return s;
+        }).join('');
+      }
+
+      // In JS mode, '\' is not a special character, but '$' must be escaped as '$$'
+      if (str.indexOf('$') < 0) {
         return str;
       }
       return str.split('').map(s => {
-        const c = s.codePointAt(0);
-        if (c === Codepoint.CODES['\\'] || c === Codepoint.CODES['$']) {
-          return `\\${s}`;
+        if (s.codePointAt(0) === Codepoint.CODES.get('$')) {
+          return '$$';
         }
         return s;
       }).join('');
@@ -1429,13 +1444,13 @@
      * earlier, escape the first digit that should not be used.
      *
      * @param {string} replacement the replacement string
-     * @param {boolean} [perlMode=false] activate perl/js mode (different behaviour for capture groups and special characters)
+     * @param {boolean} [javaMode=false] activate java mode (different behaviour for capture groups and special characters)
      * @returns {string}
      * @throws IllegalStateException if there was no most recent match
      * @throws IndexOutOfBoundsException if replacement refers to an invalid group
      * @private
      */
-    appendReplacement(replacement, perlMode = false) {
+    appendReplacement(replacement, javaMode = false) {
       let res = '';
       const s = this.start();
       const e = this.end();
@@ -1443,7 +1458,7 @@
         res += this.substring(this.appendPos, s);
       }
       this.appendPos = e;
-      res += perlMode ? this.appendReplacementInternalPerl(replacement) : this.appendReplacementInternal(replacement);
+      res += javaMode ? this.appendReplacementInternalJava(replacement) : this.appendReplacementInternalJs(replacement);
       return res;
     }
 
@@ -1452,7 +1467,7 @@
      * @returns {string}
      * @private
      */
-    appendReplacementInternal(replacement) {
+    appendReplacementInternalJava(replacement) {
       let res = '';
       let last = 0;
       const m = replacement.length;
@@ -1518,7 +1533,7 @@
      * @returns {string}
      * @private
      */
-    appendReplacementInternalPerl(replacement) {
+    appendReplacementInternalJs(replacement) {
       let res = '';
       let last = 0;
       const m = replacement.length;
@@ -1615,12 +1630,12 @@
      * {@code appendReplacement}.
      *
      * @param {string} replacement - the replacement string
-     * @param {boolean} [perlMode=false] - activate perl/js mode (different behaviour for capture groups and special characters)
+     * @param {boolean} [javaMode=false] - activate java mode (different behaviour for capture groups and special characters)
      * @returns {string} the input string with the matches replaced
-     * @throws IndexOutOfBoundsException if replacement refers to an invalid group and perlMode is false
+     * @throws IndexOutOfBoundsException if replacement refers to an invalid group and javaMode is true
      */
-    replaceAll(replacement, perlMode = false) {
-      return this.replace(replacement, true, perlMode);
+    replaceAll(replacement, javaMode = false) {
+      return this.replace(replacement, true, javaMode);
     }
 
     /**
@@ -1628,27 +1643,27 @@
      * {@code appendReplacement}.
      *
      * @param {string} replacement - the replacement string
-     * @param {boolean} [perlMode=false] - activate perl/js mode (different behaviour for capture groups and special characters)
+     * @param {boolean} [javaMode=false] - activate java mode (different behaviour for capture groups and special characters)
      * @returns {string} the input string with the first match replaced
-     * @throws IndexOutOfBoundsException if replacement refers to an invalid group and perlMode is false
+     * @throws IndexOutOfBoundsException if replacement refers to an invalid group and javaMode is true
      */
-    replaceFirst(replacement, perlMode = false) {
-      return this.replace(replacement, false, perlMode);
+    replaceFirst(replacement, javaMode = false) {
+      return this.replace(replacement, false, javaMode);
     }
 
     /**
      * Helper: replaceAll/replaceFirst hybrid.
      * @param {string} replacement - the replacement string
      * @param {boolean} [all=true] - replace all matches
-     * @param {boolean} [perlMode=false] - activate perl/js mode (different behaviour for capture groups and special characters)
+     * @param {boolean} [javaMode=false] - activate java mode (different behaviour for capture groups and special characters)
      * @returns {string}
      * @private
      */
-    replace(replacement, all = true, perlMode = false) {
+    replace(replacement, all = true, javaMode = false) {
       let res = '';
       this.reset();
       while (this.find()) {
-        res += this.appendReplacement(replacement, perlMode);
+        res += this.appendReplacement(replacement, javaMode);
         if (!all) {
           break;
         }
@@ -6205,6 +6220,20 @@
       return Utils.quoteMeta(str);
     }
 
+    /**
+     * Quotes '\' and '$' in {@code str}, so that the returned string could be used in
+     * replacement methods as a literal replacement of {@code str}.
+     *
+     * This is a convenience delegation to {@link Matcher.quoteReplacement}.
+     *
+     * @param {string} str the string to be quoted
+     * @param {boolean} [javaMode=false] whether the replacement will be used in javaMode
+     * @returns {string} the quoted string
+     */
+    static quoteReplacement(str, javaMode = false) {
+      return Matcher.quoteReplacement(str, javaMode);
+    }
+
     /**
      * Translates a given regular expression string to ensure compatibility with RE2JS.
      *