@gmb/bitmark-parser-generator 1.4.8 → 1.4.9

package/dist/cjs/breakscaping/Breakscape.js

@@ -0,0 +1,240 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Breakscape = void 0;
+const StringUtils_1 = require("../utils/StringUtils");
+/**
+ * Utility class for breakscaping strings.
+ *
+ * Breakscaping is the process of escaping certain character sequences in a string so that they are not interpreted as
+ * special sequences by the parser.
+ *
+ * This is different from escaping in that when escaping, single characters tend to be escaped, rather than sequences
+ * being broken (split) by a special charater.
+ *
+ * The special character is ^
+ * To include the special character in a text, use ^^ (once), ^^^ (twice), etc.
+ *
+ * The following sequences can be breakscaped:
+ *  - inline:                                ==         ==>   =^=
+ *  - comment:                               ||         ==>   |^|
+ *  - remark:                                ::         ==>   :^:
+ *  - title block:                   (SOL)[##]#(space)  ==>   (SOL)[##]#^(space)
+ *  - new block:                     (SOL)|(WS EOL)     ==>   (SOL)|^(WS EOL)
+ *  - code block:                    (SOL)|code(:type)  ==>   (SOL)|^code(:type)
+ *  - image block:                   (SOL)|image:(url)  ==>   (SOL)|^image:(url)
+ *  - bullet list:                   (SOL)•(space)      ==>   (SOL)•^(space)
+ *  - ordered list:                  (SOL)•1(space)     ==>   (SOL)•^1(space)
+ *  - tag list +:                    (SOL)•+(space)     ==>   (SOL)•^+(space)
+ *  - tag list -:                    (SOL)•-(space)     ==>   (SOL)•^-(space)
+ *  - bold:                                  **         ==>   *^*
+ *  - light:                                 ``         ==>   `^`
+ *  - italic:                                __         ==>   _^_
+ *  - highlight:                             !!         ==>   !^!
+ *  - start of bit:                          [.         ==>   [^.
+ *  - start of property:                     [@         ==>   [^@
+ *  - start of title:                        [#         ==>   [^#
+ *  - start of anchor:                       [▼         ==>   [^▼
+ *  - start of reference:                    [►         ==>   [^►
+ *  - start of item/lead:                    [%         ==>   [^%
+ *  - start of instruction:                  [!         ==>   [^!
+ *  - start of hint:                         [?         ==>   [^?
+ *  - start of true statement:               [+         ==>   [^+
+ *  - start of false statement:              [-         ==>   [^-
+ *  - start of sample solution:              [$         ==>   [^$
+ *  - start of gap:                          [_         ==>   [^_
+ *  - start of mark:                         [=         ==>   [^=
+ *  - start of resource:                     [&         ==>   [^&
+ *  - end of tag:                            ]          ==>   ^]
+ *
+ *
+ * The following are breakscaped with ^ in between. Just add more ^s to increase the number of ^ string:
+ *  - inline:                                =^=         ==>   =^^=
+ *  - comment:                               |^|         ==>   |^^|
+ *  - remark:                                :^:         ==>   :^^:
+ *  - title block:                   (SOL)[##]#^(space)  ==>   (SOL)[##]#^^(space)
+ *  - new block:                     (SOL)|^(WS EOL)     ==>   (SOL)|^^(WS EOL)
+ *  - code block:                    (SOL)|^code(:type)  ==>   (SOL)|^^code(:type)
+ *  - image block:                   (SOL)|^image:(url)  ==>   (SOL)|^^image:(url)
+ *  - bullet list:                   (SOL)•^(space)      ==>   (SOL)•^^(space)
+ *  - ordered list:                  (SOL)•^1(space)     ==>   (SOL)•^^1(space)
+ *  - tag list +:                    (SOL)•^+(space)     ==>   (SOL)•^^+(space)
+ *  - tag list -:                    (SOL)•^-(space)     ==>   (SOL)•^^-(space)
+ *  - bold:                                  *^*         ==>   *^^*
+ *  - light:                                 `^`         ==>   `^^`
+ *  - italic:                                _^_         ==>   _^^_
+ *  - highlight:                             !^!         ==>   !^^!
+ *  - start of bit:                          [^.         ==>   [^^.
+ *  - start of property:                     [^@         ==>   [^^@
+ *  - start of title:                        [^#         ==>   [^^#
+ *  - start of anchor:                       [^▼         ==>   [^^▼
+ *  - start of reference:                    [^►         ==>   [^^►
+ *  - start of item/lead:                    [^%         ==>   [^^%
+ *  - start of instruction:                  [^!         ==>   [^^!
+ *  - start of hint:                         [^?         ==>   [^^?
+ *  - start of true statement:               [^+         ==>   [^^+
+ *  - start of false statement:              [^-         ==>   [^^-
+ *  - start of sample solution:              [^$         ==>   [^^$
+ *  - start of gap:                          [^_         ==>   [^^_
+ *  - start of mark:                         [^=         ==>   [^^=
+ *  - start of resource:                     [^&         ==>   [^^&
+ *  - end of tag:                            ^]          ==>   ^^]
+ */
+//
+// Breakscaping
+//
+const REGEX_MARKS = /([*`_!|:=])([\^]*)\1/;
+const REGEX_BLOCKS = /^(\|)([\^]*)(code[\s]*|code:|image:|[\s]*$)/;
+const REGEX_TITLE_BLOCKS = /^([#]{1,3})([\^]*)([^\S\r\n]+)/;
+const REGEX_LIST_BLOCKS = /^(•)([\^]*)(1|\+|-|)([^\S\r\n]+)/;
+const REGEX_START_OF_TAG = /(\[)([\^]*)([.@#▼►%!?+\-$_=&])/;
+const REGEX_END_OF_TAG = /([\^]*)(])/;
+const BREAKSCAPE_REGEX_SOURCE = `${REGEX_MARKS.source}|${REGEX_BLOCKS.source}|${REGEX_TITLE_BLOCKS.source}|${REGEX_LIST_BLOCKS.source}|${REGEX_START_OF_TAG.source}|${REGEX_END_OF_TAG.source}`;
+const UNBREAKSCAPE_REGEX_SOURCE = BREAKSCAPE_REGEX_SOURCE.replace(/(\(\[\\\^\]\*\))/g, '\\^$1'); // Add ^ into the regex
+// Regex groups in BODY (bitmark++):
+// 1: start of MARK
+// 2: ^ in MARK
+// 3: start of BLOCK
+// 4: ^ in BLOCK
+// 5: end of BLOCK
+// 6: start of TITLE_BLOCK
+// 7: ^ in TITLE_BLOCK
+// 8: end of TITLE_BLOCK
+// 9: start of LIST_BLOCK
+// 10: ^ in LIST_BLOCK
+// 11: end of LIST_BLOCK part 1
+// 12: end of LIST_BLOCK part 2
+// 13: start of START_OF_TAG block
+// 14: ^ in START_OF_TAG block
+// 15: end of START_OF_TAG block
+// 16: ^ in END_OF_TAG block
+// 17: end of END_OF_TAG block
+const BREAKSCAPE_REGEX = new RegExp(BREAKSCAPE_REGEX_SOURCE, 'gm');
+const BREAKSCAPE_REGEX_REPLACER = '$1$3$6$9$13^$2$1$4$5$7$8$10$11$12$14$15$16$17';
+const UNBREAKSCAPE_REGEX = new RegExp(UNBREAKSCAPE_REGEX_SOURCE, 'gm');
+const UNBREAKSCAPE_REGEX_REPLACER = BREAKSCAPE_REGEX_REPLACER.replace(/\^/g, ''); // Remove ^ from the regex replacer
+// Regex explanation:
+// - match a single | or • or # character at the start of a line and capture in group 1
+// This will capture all new block characters within the code text.
+// Replace with group 1, ^
+const BREAKSCAPE_CODE_REGEX = new RegExp('^(\\||•|#)', 'gm');
+const BREAKSCAPE_CODE_REGEX_REPLACER = '$1^';
+class Breakscape {
+    constructor() {
+        this.EMPTY_STRING = '';
+    }
+    /**
+     * Breakscape a string or an array of strings.
+     * If the input is an array, a new array will be returned.
+     *
+     * @param val input value
+     * @param options options for breakscaping
+     * @param modifyArray
+     * @returns the input value with any strings breakscaped.
+     */
+    breakscape(val, options) {
+        if (val == null)
+            return val;
+        const opts = Object.assign({}, options);
+        const breakscapeStr = (str) => {
+            if (!str)
+                return str;
+            str = str.replace(BREAKSCAPE_REGEX, BREAKSCAPE_REGEX_REPLACER);
+            return str;
+        };
+        if (Array.isArray(val)) {
+            const newVal = opts.modifyArray ? val : [val.length];
+            for (let i = 0, len = val.length; i < len; i++) {
+                const v = val[i];
+                if (StringUtils_1.StringUtils.isString(v)) {
+                    newVal[i] = breakscapeStr(v);
+                }
+            }
+            val = newVal;
+        }
+        else if (StringUtils_1.StringUtils.isString(val)) {
+            val = breakscapeStr(val);
+        }
+        return val;
+    }
+    /**
+     * Unbreakscape a string or an array of strings.
+     * If the input is an array, a new array will be returned.
+     *
+     * @param val input value
+     * @param modifyArray if true, the original array will be modified rather than a copy being made
+     * @returns the input value with any strings unbreakscaped.
+     */
+    unbreakscape(val, options) {
+        if (val == null)
+            return val;
+        const opts = Object.assign({}, options);
+        const unbreakscapeStr = (str) => {
+            if (!str)
+                return str;
+            str = str.replace(UNBREAKSCAPE_REGEX, UNBREAKSCAPE_REGEX_REPLACER);
+            return str;
+        };
+        if (Array.isArray(val)) {
+            const newVal = opts.modifyArray ? val : [];
+            for (let i = 0, len = val.length; i < len; i++) {
+                const v = val[i];
+                if (StringUtils_1.StringUtils.isString(v)) {
+                    newVal[i] = unbreakscapeStr(v);
+                }
+                else {
+                    newVal[i] = v;
+                }
+            }
+            val = newVal;
+        }
+        else if (StringUtils_1.StringUtils.isString(val)) {
+            val = unbreakscapeStr(val);
+        }
+        return val;
+    }
+    /**
+     * Breakscape a code string or an array of code strings.
+     * If the input is an array, a new array will be returned.
+     *
+     * @param val input value
+     * @param modifyArray if true, the original array will be modified rather than a copy being made
+     * @returns the input value with any strings breakscaped
+     */
+    breakscapeCode(val, options) {
+        if (val == null)
+            return val;
+        const opts = Object.assign({}, options);
+        const breakscapeStr = (str) => {
+            if (!str)
+                return str;
+            return str.replace(BREAKSCAPE_CODE_REGEX, BREAKSCAPE_CODE_REGEX_REPLACER);
+        };
+        if (Array.isArray(val)) {
+            const newVal = opts.modifyArray ? val : [val.length];
+            for (let i = 0, len = val.length; i < len; i++) {
+                const v = val[i];
+                if (StringUtils_1.StringUtils.isString(v)) {
+                    val[i] = breakscapeStr(v);
+                }
+            }
+            val = newVal;
+        }
+        else if (StringUtils_1.StringUtils.isString(val)) {
+            val = breakscapeStr(val);
+        }
+        return val;
+    }
+    /**
+     * Concatenate two breakscaped strings.
+     *
+     * @param s1 first string
+     * @param s2 second string
+     * @returns the concatenated string
+     */
+    concatenate(s1, s2) {
+        return (s1 + s2);
+    }
+}
+const instance = new Breakscape();
+exports.Breakscape = instance;
+//# sourceMappingURL=Breakscape.js.map

package/dist/cjs/breakscaping/Breakscape.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Breakscape.js","sourceRoot":"","sources":["../../../src/breakscaping/Breakscape.ts"],"names":[],"mappings":";;;AACA,sDAAmD;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AAEH,EAAE;AACF,eAAe;AACf,EAAE;AAEF,MAAM,WAAW,GAAG,sBAAsB,CAAC;AAC3C,MAAM,YAAY,GAAG,6CAA6C,CAAC;AACnE,MAAM,kBAAkB,GAAG,gCAAgC,CAAC;AAC5D,MAAM,iBAAiB,GAAG,kCAAkC,CAAC;AAC7D,MAAM,kBAAkB,GAAG,gCAAgC,CAAC;AAC5D,MAAM,gBAAgB,GAAG,YAAY,CAAC;AAEtC,MAAM,uBAAuB,GAAG,GAAG,WAAW,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,IAAI,kBAAkB,CAAC,MAAM,IAAI,iBAAiB,CAAC,MAAM,IAAI,kBAAkB,CAAC,MAAM,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;AAChM,MAAM,yBAAyB,GAAG,uBAAuB,CAAC,OAAO,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,CAAC,uBAAuB;AAExH,oCAAoC;AACpC,mBAAmB;AACnB,eAAe;AACf,oBAAoB;AACpB,gBAAgB;AAChB,kBAAkB;AAClB,0BAA0B;AAC1B,sBAAsB;AACtB,wBAAwB;AACxB,yBAAyB;AACzB,sBAAsB;AACtB,+BAA+B;AAC/B,+BAA+B;AAC/B,kCAAkC;AAClC,8BAA8B;AAC9B,gCAAgC;AAChC,4BAA4B;AAC5B,8BAA8B;AAE9B,MAAM,gBAAgB,GAAG,IAAI,MAAM,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAC;AACnE,MAAM,yBAAyB,GAAG,+CAA+C,CAAC;AAElF,MAAM,kBAAkB,GAAG,IAAI,MAAM,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;AACvE,MAAM,2BAA2B,GAAG,yBAAyB,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,mCAAmC;AAErH,qBAAqB;AACrB,uFAAuF;AACvF,mEAAmE;AACnE,0BAA0B;AAC1B,MAAM,qBAAqB,GAAG,IAAI,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;AAC7D,MAAM,8BAA8B,GAAG,KAAK,CAAC;AAa7C,MAAM,UAAU;IAAhB;QACkB,iBAAY,GAAG,EAAuB,CAAC;IAwIzD,CAAC;IAtIC;;;;;;;;OAQG;IACI,UAAU,CACf,GAAM,EACN,OAA2B;QAI3B,IAAI,GAAG,IAAI,IAAI;YAAE,OAAO,GAAmB,CAAC;QAE5C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAExC,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE;YACpC,IAAI,CAAC,GAAG;gBAAE,OAAO,GAAG,CAAC;YACrB,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,yBAAyB,CAAC,CAAC;YAE/D,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QAEF,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,MAAM,GAAc,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAChE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBACjB,IAAI,yBAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;oBAC3B,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;iBAC9B;aACF;YACD,GAAG,GAAG,MAAW,CAAC;SACnB;aAAM,IAAI,yBAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACpC,GAAG,GAAG,aAAa,CAAC,GAAa,CAAM,CAAC;SACzC;QAED,OAAO,GAAmB,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACI,YAAY,CACjB,GAAM,EACN,OAA2B;QAI3B,IAAI,GAAG,IAAI,IAAI;YAAE,OAAO,GAAmB,CAAC;QAE5C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAExC,MAAM,eAAe,GAAG,CAAC,GAAW,EAAE,EAAE;YACtC,IAAI,CAAC,GAAG;gBAAE,OAAO,GAAG,CAAC;YACrB,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,EAAE,2BAA2B,CAAC,CAAC;YAEnE,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QAEF,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,MAAM,GAAc,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBACjB,IAAI,yBAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;oBAC3B,MAAM,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;iBAChC;qBAAM;oBACL,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;iBACf;aACF;YACD,GAAG,GAAG,MAAW,CAAC;SACnB;aAAM,IAAI,yBAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACpC,GAAG,GAAG,eAAe,CAAC,GAAa,CAAM,CAAC;SAC3C;QAED,OAAO,GAAmB,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACI,cAAc,CACnB,GAAM,EACN,OAA2B;QAI3B,IAAI,GAAG,IAAI,IAAI;YAAE,OAAO,GAAmB,CAAC;QAE5C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAExC,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE;YACpC,IAAI,CAAC,GAAG;gBAAE,OAAO,GAAG,CAAC;YACrB,OAAO,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,8BAA8B,CAAC,CAAC;QAC5E,CAAC,CAAC;QAEF,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,MAAM,GAAc,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAChE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBACjB,IAAI,yBAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;oBAC3B,GAAG,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;iBAC3B;aACF;YACD,GAAG,GAAG,MAAW,CAAC;SACnB;aAAM,IAAI,yBAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACpC,GAAG,GAAG,aAAa,CAAC,GAAa,CAAM,CAAC;SACzC;QAED,OAAO,GAAmB,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,EAAqB,EAAE,EAAqB;QAC7D,OAAO,CAAC,EAAE,GAAG,EAAE,CAAsB,CAAC;IACxC,CAAC;CACF;AAED,MAAM,QAAQ,GAAG,IAAI,UAAU,EAAE,CAAC;AAEb,8BAAU"}

package/dist/cjs/generated/build-info.js

@@ -5,7 +5,7 @@ exports.buildInfo = void 0;
 /* eslint-disable */
 exports.buildInfo = {
     "name": "@gmb/bitmark-parser-generator",
-    "version": "1.4.8",
+    "version": "1.4.9",
     "author": "Get More Brain Ltd",
     "license": "ISC",
     "description": "A bitmark parser and generator using Peggy.js"