rregex 1.0.0 → 1.0.1

package/lib/browser.js

@@ -46,6 +46,73 @@ function addHeapObject(obj) {
     return idx;
 }
 
+let WASM_VECTOR_LEN = 0;
+
+let cachedTextEncoder = new TextEncoder('utf-8');
+
+const encodeString = (typeof cachedTextEncoder.encodeInto === 'function'
+    ? function (arg, view) {
+    return cachedTextEncoder.encodeInto(arg, view);
+}
+    : function (arg, view) {
+    const buf = cachedTextEncoder.encode(arg);
+    view.set(buf);
+    return {
+        read: arg.length,
+        written: buf.length
+    };
+});
+
+function passStringToWasm0(arg, malloc, realloc) {
+
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length);
+        getUint8Memory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len);
+
+    const mem = getUint8Memory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3);
+        const view = getUint8Memory0().subarray(ptr + offset, ptr + len);
+        const ret = encodeString(arg, view);
+
+        offset += ret.written;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+let cachegetInt32Memory0 = null;
+function getInt32Memory0() {
+    if (cachegetInt32Memory0 === null || cachegetInt32Memory0.buffer !== wasm.memory.buffer) {
+        cachegetInt32Memory0 = new Int32Array(wasm.memory.buffer);
+    }
+    return cachegetInt32Memory0;
+}
+
 function debugString(val) {
     // primitive types
     const type = typeof val;
@@ -110,69 +177,25 @@ function debugString(val) {
     // TODO we could test for more things here, like `Set`s and `Map`s.
     return className;
 }
-
-let WASM_VECTOR_LEN = 0;
-
-let cachedTextEncoder = new TextEncoder('utf-8');
-
-const encodeString = (typeof cachedTextEncoder.encodeInto === 'function'
-    ? function (arg, view) {
-    return cachedTextEncoder.encodeInto(arg, view);
-}
-    : function (arg, view) {
-    const buf = cachedTextEncoder.encode(arg);
-    view.set(buf);
-    return {
-        read: arg.length,
-        written: buf.length
-    };
-});
-
-function passStringToWasm0(arg, malloc, realloc) {
-
-    if (realloc === undefined) {
-        const buf = cachedTextEncoder.encode(arg);
-        const ptr = malloc(buf.length);
-        getUint8Memory0().subarray(ptr, ptr + buf.length).set(buf);
-        WASM_VECTOR_LEN = buf.length;
-        return ptr;
-    }
-
-    let len = arg.length;
-    let ptr = malloc(len);
-
-    const mem = getUint8Memory0();
-
-    let offset = 0;
-
-    for (; offset < len; offset++) {
-        const code = arg.charCodeAt(offset);
-        if (code > 0x7F) break;
-        mem[ptr + offset] = code;
-    }
-
-    if (offset !== len) {
-        if (offset !== 0) {
-            arg = arg.slice(offset);
-        }
-        ptr = realloc(ptr, len, len = offset + arg.length * 3);
-        const view = getUint8Memory0().subarray(ptr + offset, ptr + len);
-        const ret = encodeString(arg, view);
-
-        offset += ret.written;
+/**
+* @param {string} text
+* @returns {string}
+*/
+export function escape(text) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len0 = WASM_VECTOR_LEN;
+        wasm.escape(retptr, ptr0, len0);
+        var r0 = getInt32Memory0()[retptr / 4 + 0];
+        var r1 = getInt32Memory0()[retptr / 4 + 1];
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_free(r0, r1);
     }
-
-    WASM_VECTOR_LEN = offset;
-    return ptr;
 }
 
-let cachegetInt32Memory0 = null;
-function getInt32Memory0() {
-    if (cachegetInt32Memory0 === null || cachegetInt32Memory0.buffer !== wasm.memory.buffer) {
-        cachegetInt32Memory0 = new Int32Array(wasm.memory.buffer);
-    }
-    return cachegetInt32Memory0;
-}
 /**
 * @returns {any}
 */
@@ -181,6 +204,14 @@ export function get_metadata() {
     return takeObject(ret);
 }
 
+let stack_pointer = 32;
+
+function addBorrowedObject(obj) {
+    if (stack_pointer == 1) throw new Error('out of js stack');
+    heap[--stack_pointer] = obj;
+    return stack_pointer;
+}
+
 function handleError(f, args) {
     try {
         return f.apply(this, args);
@@ -189,11 +220,13 @@ function handleError(f, args) {
     }
 }
 /**
+* A compiled regular expression for matching Unicode strings.
+* @see https://docs.rs/regex/latest/regex/
 */
-export class RRegExp {
+export class RRegex {
 
     static __wrap(ptr) {
-        const obj = Object.create(RRegExp.prototype);
+        const obj = Object.create(RRegex.prototype);
         obj.ptr = ptr;
 
         return obj;
@@ -208,70 +241,90 @@ export class RRegExp {
 
     free() {
         const ptr = this.__destroy_into_raw();
-        wasm.__wbg_rregexp_free(ptr);
+        wasm.__wbg_rregex_free(ptr);
     }
     /**
+    * Compiles a regular expression. Once compiled, it can be used repeatedly to search, split or replace text in a string.
+    * If an invalid expression is given, then an error is returned.
     * @param {string} re
     */
     constructor(re) {
         var ptr0 = passStringToWasm0(re, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         var len0 = WASM_VECTOR_LEN;
-        var ret = wasm.rregexp_new(ptr0, len0);
-        return RRegExp.__wrap(ret);
+        var ret = wasm.rregex_new(ptr0, len0);
+        return RRegex.__wrap(ret);
     }
     /**
+    * Returns true if and only if there is a match for the regex in the string given.
+    * It is recommended to use this method if all you need to do is test a match, since the underlying matching engine may be able to do less work.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match
     * @param {string} text
     * @returns {boolean}
     */
-    is_match(text) {
+    isMatch(text) {
         var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         var len0 = WASM_VECTOR_LEN;
-        var ret = wasm.rregexp_is_match(this.ptr, ptr0, len0);
+        var ret = wasm.rregex_isMatch(this.ptr, ptr0, len0);
         return ret !== 0;
     }
     /**
+    * Returns the same as is_match, but starts the search at the given offset.
+    * The significance of the starting point is that it takes the surrounding context into consideration. For example, the `\A` anchor can only match when `start == 0`.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.is_match_at
     * @param {string} text
     * @param {number} start
     * @returns {boolean}
     */
-    is_match_at(text, start) {
+    isMatchAt(text, start) {
         var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         var len0 = WASM_VECTOR_LEN;
-        var ret = wasm.rregexp_is_match_at(this.ptr, ptr0, len0, start);
+        var ret = wasm.rregex_isMatchAt(this.ptr, ptr0, len0, start);
         return ret !== 0;
     }
     /**
+    * Returns the start and end byte range of the leftmost-first match in `text`. If no match exists, then `undefined` is returned.
+    * Note that this should only be used if you want to discover the position of the match. Testing the existence of a match is faster if you use `is_match`.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find
     * @param {string} text
     * @returns {any}
     */
     find(text) {
         var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         var len0 = WASM_VECTOR_LEN;
-        var ret = wasm.rregexp_find(this.ptr, ptr0, len0);
+        var ret = wasm.rregex_find(this.ptr, ptr0, len0);
         return takeObject(ret);
     }
     /**
+    * Returns the same as find, but starts the search at the given offset.
+    * The significance of the starting point is that it takes the surrounding context into consideration. For example, the \A anchor can only match when `start == 0`.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_at
     * @param {string} text
     * @param {number} start
     * @returns {any}
     */
-    find_at(text, start) {
+    findAt(text, start) {
         var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         var len0 = WASM_VECTOR_LEN;
-        var ret = wasm.rregexp_find_at(this.ptr, ptr0, len0, start);
+        var ret = wasm.rregex_findAt(this.ptr, ptr0, len0, start);
         return takeObject(ret);
     }
     /**
+    * Returns an array for each successive non-overlapping match in text, returning the start and end byte indices with respect to text.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.find_iter
     * @param {string} text
     * @returns {any}
     */
-    find_all(text) {
+    findAll(text) {
         var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         var len0 = WASM_VECTOR_LEN;
-        var ret = wasm.rregexp_find_all(this.ptr, ptr0, len0);
+        var ret = wasm.rregex_findAll(this.ptr, ptr0, len0);
         return takeObject(ret);
     }
     /**
+    * Replaces the leftmost-first match with the replacement provided.
+    * The replacement can be a regular string (where `$N` and `$name` are expanded to match capture groups) or a function that takes the matches’ `Captures` and returns the replaced string.
+    * If no match is found, then a copy of the string is returned unchanged.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace
     * @param {string} text
     * @param {string} rep
     * @returns {string}
@@ -283,7 +336,7 @@ export class RRegExp {
             var len0 = WASM_VECTOR_LEN;
             var ptr1 = passStringToWasm0(rep, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
             var len1 = WASM_VECTOR_LEN;
-            wasm.rregexp_replace(retptr, this.ptr, ptr0, len0, ptr1, len1);
+            wasm.rregex_replace(retptr, this.ptr, ptr0, len0, ptr1, len1);
             var r0 = getInt32Memory0()[retptr / 4 + 0];
             var r1 = getInt32Memory0()[retptr / 4 + 1];
             return getStringFromWasm0(r0, r1);
@@ -293,6 +346,9 @@ export class RRegExp {
         }
     }
     /**
+    * Replaces at most `limit` non-overlapping matches in `text` with the replacement provided. If `limit` is 0, then all non-overlapping matches are replaced.
+    * See the documentation for `replace` for details on how to access capturing group matches in the replacement string.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.replacen
     * @param {string} text
     * @param {number} limit
     * @param {string} rep
@@ -305,7 +361,7 @@ export class RRegExp {
             var len0 = WASM_VECTOR_LEN;
             var ptr1 = passStringToWasm0(rep, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
             var len1 = WASM_VECTOR_LEN;
-            wasm.rregexp_replacen(retptr, this.ptr, ptr0, len0, limit, ptr1, len1);
+            wasm.rregex_replacen(retptr, this.ptr, ptr0, len0, limit, ptr1, len1);
             var r0 = getInt32Memory0()[retptr / 4 + 0];
             var r1 = getInt32Memory0()[retptr / 4 + 1];
             return getStringFromWasm0(r0, r1);
@@ -315,18 +371,21 @@ export class RRegExp {
         }
     }
     /**
+    * Replaces all non-overlapping matches in `text` with the replacement provided. This is the same as calling `replacen` with `limit` set to `0`.
+    * See the documentation for `replace` for details on how to access capturing group matches in the replacement string.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace_all
     * @param {string} text
     * @param {string} rep
     * @returns {string}
     */
-    replace_all(text, rep) {
+    replaceAll(text, rep) {
         try {
             const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
             var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
             var len0 = WASM_VECTOR_LEN;
             var ptr1 = passStringToWasm0(rep, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
             var len1 = WASM_VECTOR_LEN;
-            wasm.rregexp_replace_all(retptr, this.ptr, ptr0, len0, ptr1, len1);
+            wasm.rregex_replaceAll(retptr, this.ptr, ptr0, len0, ptr1, len1);
             var r0 = getInt32Memory0()[retptr / 4 + 0];
             var r1 = getInt32Memory0()[retptr / 4 + 1];
             return getStringFromWasm0(r0, r1);
@@ -336,16 +395,22 @@ export class RRegExp {
         }
     }
     /**
+    * Returns an iterator of substrings of `text` delimited by a match of the regular expression. Namely, each element of the iterator corresponds to text that isn’t matched by the regular expression.
+    * This method will not copy the text given.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.split
     * @param {string} text
     * @returns {any}
     */
     split(text) {
         var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         var len0 = WASM_VECTOR_LEN;
-        var ret = wasm.rregexp_split(this.ptr, ptr0, len0);
+        var ret = wasm.rregex_split(this.ptr, ptr0, len0);
         return takeObject(ret);
     }
     /**
+    * Returns an iterator of at most `limit` substrings of `text` delimited by a match of the regular expression. (A limit of 0 will return no substrings.) Namely, each element of the iterator corresponds to text that isn’t matched by the regular expression. The remainder of the string that is not split will be the last element in the iterator.
+    * This method will not copy the text given.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.splitn
     * @param {string} text
     * @param {number} limit
     * @returns {any}
@@ -353,14 +418,136 @@ export class RRegExp {
     splitn(text, limit) {
         var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         var len0 = WASM_VECTOR_LEN;
-        var ret = wasm.rregexp_splitn(this.ptr, ptr0, len0, limit);
+        var ret = wasm.rregex_splitn(this.ptr, ptr0, len0, limit);
         return takeObject(ret);
     }
     /**
+    * Returns the end location of a match in the text given.
+    * This method may have the same performance characteristics as `is_match`, except it provides an end location for a match. In particular, the location returned may be shorter than the proper end of the leftmost-first match.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.shortest_match
+    * @param {string} text
+    * @returns {number | undefined}
+    */
+    shortestMatch(text) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            var len0 = WASM_VECTOR_LEN;
+            wasm.rregex_shortestMatch(retptr, this.ptr, ptr0, len0);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            return r0 === 0 ? undefined : r1 >>> 0;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+    * Returns the same as shortest_match, but starts the search at the given offset.
+    * The significance of the starting point is that it takes the surrounding context into consideration. For example, the \A anchor can only match when `start == 0`.
+    * @see https://docs.rs/regex/latest/regex/struct.Regex.html#method.shortest_match_at
+    * @param {string} text
+    * @param {number} limit
+    * @returns {number | undefined}
+    */
+    shortestMatchAt(text, limit) {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            var len0 = WASM_VECTOR_LEN;
+            wasm.rregex_shortestMatchAt(retptr, this.ptr, ptr0, len0, limit);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            return r0 === 0 ? undefined : r1 >>> 0;
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+        }
+    }
+    /**
+    * Return the Regex syntax object
     * @returns {any}
     */
     syntax() {
-        var ret = wasm.rregexp_syntax(this.ptr);
+        var ret = wasm.rregex_syntax(this.ptr);
+        return takeObject(ret);
+    }
+    /**
+    * Returns a string representing the regular expression
+    * @returns {string}
+    */
+    toString() {
+        try {
+            const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+            wasm.rregex_toString(retptr, this.ptr);
+            var r0 = getInt32Memory0()[retptr / 4 + 0];
+            var r1 = getInt32Memory0()[retptr / 4 + 1];
+            return getStringFromWasm0(r0, r1);
+        } finally {
+            wasm.__wbindgen_add_to_stack_pointer(16);
+            wasm.__wbindgen_free(r0, r1);
+        }
+    }
+}
+/**
+* Match multiple (possibly overlapping) regular expressions in a single scan.
+* A regex set corresponds to the union of two or more regular expressions. That is, a regex set will match text where at least one of its constituent regular expressions matches. A regex set as its formulated here provides a touch more power: it will also report which regular expressions in the set match. Indeed, this is the key difference between regex sets and a single `Regex` with many alternates, since only one alternate can match at a time.
+* @see https://docs.rs/regex/latest/regex/struct.RegexSet.html#method.empty
+*/
+export class RRegexSet {
+
+    static __wrap(ptr) {
+        const obj = Object.create(RRegexSet.prototype);
+        obj.ptr = ptr;
+
+        return obj;
+    }
+
+    __destroy_into_raw() {
+        const ptr = this.ptr;
+        this.ptr = 0;
+
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_rregexset_free(ptr);
+    }
+    /**
+    * Create a new regex set with the given regular expressions.
+    * @param {Array<any>} list
+    */
+    constructor(list) {
+        try {
+            var ret = wasm.rregexset_new(addBorrowedObject(list));
+            return RRegexSet.__wrap(ret);
+        } finally {
+            heap[stack_pointer++] = undefined;
+        }
+    }
+    /**
+    * Returns true if and only if one of the regexes in this set matches the text given.
+    * This method should be preferred if you only need to test whether any of the regexes in the set should match, but don’t care about which regexes matched. This is because the underlying matching engine will quit immediately after seeing the first match instead of continuing to find all matches.
+    * @see https://docs.rs/regex/latest/regex/struct.RegexSet.html#method.is_match
+    * @param {string} text
+    * @returns {boolean}
+    */
+    isMatch(text) {
+        var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len0 = WASM_VECTOR_LEN;
+        var ret = wasm.rregexset_isMatch(this.ptr, ptr0, len0);
+        return ret !== 0;
+    }
+    /**
+    * Returns the set of regular expressions that match in the given text.
+    * The set returned contains the index of each regular expression that matches in the given text. The index is in correspondence with the order of regular expressions given to RegexSet’s constructor.
+    * the set can also be used to iterate over the matched indices.
+    * @param {string} text
+    * @returns {any}
+    */
+    matches(text) {
+        var ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len0 = WASM_VECTOR_LEN;
+        var ret = wasm.rregexset_matches(this.ptr, ptr0, len0);
         return takeObject(ret);
     }
 }
@@ -398,7 +585,7 @@ async function load(module, imports) {
 
 async function init(input) {
     if (typeof input === 'undefined') {
-        input = new URL('browser_bg.wasm', import.meta.url);
+        input = new URL('rregex.wasm', import.meta.url);
     }
     const imports = {};
     imports.wbg = {};
@@ -413,6 +600,26 @@ async function init(input) {
         var ret = arg0;
         return addHeapObject(ret);
     };
+    imports.wbg.__wbindgen_is_string = function(arg0) {
+        var ret = typeof(getObject(arg0)) === 'string';
+        return ret;
+    };
+    imports.wbg.__wbindgen_string_get = function(arg0, arg1) {
+        const obj = getObject(arg1);
+        var ret = typeof(obj) === 'string' ? obj : undefined;
+        var ptr0 = isLikeNone(ret) ? 0 : passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len0 = WASM_VECTOR_LEN;
+        getInt32Memory0()[arg0 / 4 + 1] = len0;
+        getInt32Memory0()[arg0 / 4 + 0] = ptr0;
+    };
+    imports.wbg.__wbg_get_67189fe0b323d288 = function(arg0, arg1) {
+        var ret = getObject(arg0)[arg1 >>> 0];
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_length_42e02f5a04d67464 = function(arg0) {
+        var ret = getObject(arg0).length;
+        return ret;
+    };
     imports.wbg.__wbg_new_949bbc1147195c4e = function() {
         var ret = new Array();
         return addHeapObject(ret);