@gmb/bitmark-parser-generator 3.24.0 → 3.25.0

package/dist/esm/generator/bitmark/BitmarkGenerator.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { Ast } from '../../ast/Ast';
+import { StringWriter } from '../../ast/writer/StringWriter';
 import { Breakscape } from '../../breakscaping/Breakscape';
 import { Config } from '../../config/Config';
 import { NodeType } from '../../model/ast/NodeType';
@@ -19,6 +20,7 @@ import { PropertyFormat } from '../../model/enum/PropertyFormat';
 import { PropertyTag } from '../../model/enum/PropertyTag';
 import { ResourceTag } from '../../model/enum/ResourceTag';
 import { TextFormat } from '../../model/enum/TextFormat';
+import { TextLocation } from '../../model/enum/TextLocation';
 import { BooleanUtils } from '../../utils/BooleanUtils';
 import { ObjectUtils } from '../../utils/ObjectUtils';
 import { StringUtils } from '../../utils/StringUtils';
@@ -27,6 +29,8 @@ import { TextGenerator } from '../text/TextGenerator';
 const DEFAULT_OPTIONS = {
     debugGenerationInline: false,
 };
+const DEFAULT_SPACES_AROUND_VALUES = 1;
+const MAX_SPACES_AROUND_VALUES = 10;
 /**
  * Generate bitmark markup from a bitmark AST
  *
@@ -54,6 +58,11 @@ class BitmarkGenerator extends AstWalkerGenerator {
         super();
         this.ast = new Ast();
         // State
+        this.bitType = BitType._error;
+        this.textFormat = TextFormat.bitmarkMinusMinus;
+        this.tagTextFormat = TextFormat.bitmarkMinusMinus;
+        this.isBodyBitmarkText = false;
+        this.isCardAllowed = false;
         this.firstBit = true;
         this.hasCardSet = false;
         this.hasFooter = false;
@@ -84,13 +93,18 @@ class BitmarkGenerator extends AstWalkerGenerator {
         }
         // Calculate the prettify space
         this.prettifySpace = this.options.prettifyJson === true ? 2 : this.options.prettifyJson || undefined;
+        // Calculate the spaces around values
+        this.spacesAroundValues = this.calcSpacesAroundValues();
+        this.spacesAroundValuesStr = ' '.repeat(this.spacesAroundValues);
         // Create the text generator
         this.textGenerator = new TextGenerator(this.bitmarkVersion, {
             writeCallback: this.write,
             bodyBitCallback: this.bodyBitCallback,
             debugGenerationInline: this.debugGenerationInline,
         });
-        this.writer = writer;
+        this.mainWriter = writer;
+        this.partWriter = new StringWriter();
+        this.writer = this.mainWriter;
         this.generateResourceHandlers();
         this.generatePropertyHandlers();
     }
@@ -129,6 +143,11 @@ class BitmarkGenerator extends AstWalkerGenerator {
         this.writer.closeSync();
     }
     resetState() {
+        this.bitType = BitType._error;
+        this.textFormat = TextFormat.bitmarkMinusMinus;
+        this.tagTextFormat = TextFormat.bitmarkMinusMinus;
+        this.isBodyBitmarkText = false;
+        this.isCardAllowed = false;
         this.firstBit = true;
         this.hasCardSet = false;
         this.hasFooter = false;
@@ -150,9 +169,24 @@ class BitmarkGenerator extends AstWalkerGenerator {
     // bitmark
     // bitmarkAst -> bits -> bitsValue
     enter_bitsValue(node, _route) {
+        var _a;
         const bit = node.value;
         const bitConfig = Config.getBitConfig(bit.bitType);
         const bitResourcesConfig = Config.getBitResourcesConfig(bit.bitType, bit.resourceType);
+        // Set state variables
+        this.bitType = bit.bitType;
+        this.textFormat = (_a = bit.textFormat) !== null && _a !== void 0 ? _a : bitConfig.textFormatDefault;
+        this.isBodyBitmarkText =
+            this.textFormat === TextFormat.bitmarkMinusMinus || this.textFormat === TextFormat.bitmarkPlusPlus;
+        this.isCardAllowed = this.calculateIsCardAllowed();
+        // NOTE:
+        // If the bit text format is bitmark++ then the tagTextFormat should be bitmark+, but that is not implemented yet.
+        // It works anyhow, and would require a lot of changes to implement.
+        // Since this may well change in the future, we will keep the code as is for now.
+        this.tagTextFormat =
+            this.textFormat === TextFormat.bitmarkPlusPlus
+                ? TextFormat.bitmarkPlusPlus // NOTE: should be bitmarkPlus
+                : TextFormat.bitmarkMinusMinus;
         this.hasCardSet = this.haveValidCardSet(bit);
         this.hasFooter = this.haveValidFooter(bit);
         // Separate the bits with 3 newlines
@@ -165,12 +199,12 @@ class BitmarkGenerator extends AstWalkerGenerator {
         this.writeOPD(bit.bitLevel);
         if (bit.isCommented)
             this.writeString('|');
-        this.writeBreakscapedTagString(bit.bitType);
+        this.writeTagKey(bit.bitType);
         if (bit.textFormat) {
             const write = this.isWriteTextFormat(bit.textFormat, bitConfig.textFormatDefault);
             if (write) {
                 this.writeColon();
-                this.writeBreakscapedTagString(bit.textFormat);
+                this.writeTagKey(bit.textFormat);
             }
         }
         // Use the bitConfig to see if we need to write the resourceType attachment
@@ -193,7 +227,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         }
         if (resourceType) {
             this.writeAmpersand();
-            this.writeBreakscapedTagString(resourceType);
+            this.writeTagKey(resourceType);
         }
         this.writeCL();
         // this.writeNL();
@@ -367,13 +401,8 @@ class BitmarkGenerator extends AstWalkerGenerator {
         }
         if (hint != null) {
             this.writeOPQ();
-            this.writeBreakscapedTagString(hint);
+            this.writeTextOrValue(hint, TextFormat.text, TextLocation.tag);
             this.writeCL();
-            // this.writeProperty('hint', hint, {
-            //   format: PropertyFormat.trimmedString,
-            //   single: true,
-            //   ignoreEmpty: true,
-            // });
         }
         return false;
     }
@@ -399,7 +428,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             });
         }
         if (avatarImage) {
-            this.writeResource(ResourceTag.image, avatarImage.src);
+            this.writeResource(ResourceTag.image, avatarImage.image.src);
         }
         // Stop traversal of this branch
         return false;
@@ -413,8 +442,6 @@ class BitmarkGenerator extends AstWalkerGenerator {
     // bitmarkAst -> bits -> bitsValue -> cardNode -> flashcards -> flashcardsValue -> alternativeAnswers ->
     // -> alternativeAnswersValue -> text
     enter_text(node, route) {
-        var _a;
-        const textFormat = (_a = this.getTextFormat(route)) !== null && _a !== void 0 ? _a : TextFormat.bitmarkMinusMinus;
         const parent = this.getParentNode(route);
         if (!parent ||
             (parent.key !== NodeType.term &&
@@ -427,7 +454,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         }
         if (node.value) {
             this.writeNL();
-            this.textGenerator.generateSync(node.value, textFormat);
+            this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
         }
         // Stop traversal of this branch
         return false;
@@ -445,11 +472,8 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return true;
         }
         if (StringUtils.isString(node.value)) {
-            const str = node.value;
             this.writeNL();
-            this.write(Breakscape.breakscape(str, {
-                textFormat: TextFormat.text,
-            }));
+            this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
         }
         // Stop traversal of this branch
         return false;
@@ -653,7 +677,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return true; // Will be handled by marginNumber
         this.writeNL_IfNotChain(route);
         this.writeOPC();
-        this.textGenerator.generateSync(item, TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue(item, this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         return true;
     }
@@ -670,10 +694,10 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return true; // Will be handled by marginNumber
         this.writeNL_IfNotChain(route);
         this.writeOPC();
-        this.textGenerator.generateSync((_d = (_c = parent === null || parent === void 0 ? void 0 : parent.value) === null || _c === void 0 ? void 0 : _c.item) !== null && _d !== void 0 ? _d : '', TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue((_d = (_c = parent === null || parent === void 0 ? void 0 : parent.value) === null || _c === void 0 ? void 0 : _c.item) !== null && _d !== void 0 ? _d : '', this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         this.writeOPC();
-        this.textGenerator.generateSync(lead, TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue(lead, this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         return true;
     }
@@ -688,13 +712,13 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return true; // Will be handled by marginNumber
         this.writeNL_IfNotChain(route);
         this.writeOPC();
-        this.textGenerator.generateSync((_c = (_b = parent === null || parent === void 0 ? void 0 : parent.value) === null || _b === void 0 ? void 0 : _b.item) !== null && _c !== void 0 ? _c : '', TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue((_c = (_b = parent === null || parent === void 0 ? void 0 : parent.value) === null || _b === void 0 ? void 0 : _b.item) !== null && _c !== void 0 ? _c : '', this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         this.writeOPC();
-        this.textGenerator.generateSync((_e = (_d = parent === null || parent === void 0 ? void 0 : parent.value) === null || _d === void 0 ? void 0 : _d.lead) !== null && _e !== void 0 ? _e : '', TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue((_e = (_d = parent === null || parent === void 0 ? void 0 : parent.value) === null || _d === void 0 ? void 0 : _d.lead) !== null && _e !== void 0 ? _e : '', this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         this.writeOPC();
-        this.textGenerator.generateSync(pageNumber !== null && pageNumber !== void 0 ? pageNumber : '', TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue(pageNumber !== null && pageNumber !== void 0 ? pageNumber : '', this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         return true;
     }
@@ -707,16 +731,16 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return false; // Ignore empty
         this.writeNL_IfNotChain(route);
         this.writeOPC();
-        this.textGenerator.generateSync((_b = (_a = parent === null || parent === void 0 ? void 0 : parent.value) === null || _a === void 0 ? void 0 : _a.item) !== null && _b !== void 0 ? _b : '', TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue((_b = (_a = parent === null || parent === void 0 ? void 0 : parent.value) === null || _a === void 0 ? void 0 : _a.item) !== null && _b !== void 0 ? _b : '', this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         this.writeOPC();
-        this.textGenerator.generateSync((_d = (_c = parent === null || parent === void 0 ? void 0 : parent.value) === null || _c === void 0 ? void 0 : _c.lead) !== null && _d !== void 0 ? _d : '', TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue((_d = (_c = parent === null || parent === void 0 ? void 0 : parent.value) === null || _c === void 0 ? void 0 : _c.lead) !== null && _d !== void 0 ? _d : '', this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         this.writeOPC();
-        this.textGenerator.generateSync((_f = (_e = parent === null || parent === void 0 ? void 0 : parent.value) === null || _e === void 0 ? void 0 : _e.pageNumber) !== null && _f !== void 0 ? _f : '', TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue((_f = (_e = parent === null || parent === void 0 ? void 0 : parent.value) === null || _e === void 0 ? void 0 : _e.pageNumber) !== null && _f !== void 0 ? _f : '', this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         this.writeOPC();
-        this.textGenerator.generateSync(marginNumber, TextFormat.bitmarkMinusMinus);
+        this.writeTextOrValue(marginNumber, this.tagTextFormat, TextLocation.tag);
         this.writeCL();
         return true;
     }
@@ -730,29 +754,25 @@ class BitmarkGenerator extends AstWalkerGenerator {
         this.inTag = false;
         // Always write a NL before the body content if there is any (see Handle body)
         const body = node.value;
-        const textFormat = this.getTextFormat(route);
-        const isBitmarkText = textFormat === TextFormat.bitmarkPlusPlus || textFormat === TextFormat.bitmarkMinusMinus;
         // Handle body
-        if (textFormat === TextFormat.json) {
+        if (this.textFormat === TextFormat.json) {
             const json = (_a = body.body) !== null && _a !== void 0 ? _a : null;
             if (Array.isArray(json) || ObjectUtils.isObject(json)) {
                 const text = JSON.stringify(json, null, this.prettifySpace);
                 if (text) {
                     this.writePlainTextDivider();
                     this.writeNL();
-                    this.write(Breakscape.breakscape(text, {
-                        textFormat: TextFormat.text,
-                    }));
+                    this.writeTextOrValue(text, TextFormat.text, TextLocation.body);
                 }
             }
         }
-        else if (isBitmarkText) {
+        else if (this.isBodyBitmarkText) {
             // handle bitmark text
             const plainTextDividerAllowed = !(this.hasCardSet || this.hasFooter);
             this.writeNL();
             // The text generator will write to the writer
             const b = (Array.isArray(body.body) ? body.body : []);
-            this.textGenerator.generateSync(b, textFormat, {
+            this.writeTextOrValue(b, this.textFormat, TextLocation.body, {
                 plainTextDividerAllowed,
             });
         }
@@ -761,9 +781,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             this.writePlainTextDivider();
             this.writeNL();
             const s = (StringUtils.isString(body.body) ? body.body : '');
-            this.write(Breakscape.breakscape(`${s}`, {
-                textFormat: TextFormat.text,
-            }));
+            this.writeTextOrValue(`${s}`, TextFormat.text, TextLocation.body);
         }
         // Stop traversal of this branch
         return false;
@@ -790,7 +808,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         else {
             for (const solution of gap.solutions) {
                 this.writeOPU();
-                this.writeBreakscapedTagString(solution);
+                this.writeTextOrValue(solution, TextFormat.text, TextLocation.tag);
                 this.writeCL();
             }
         }
@@ -801,7 +819,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
     enter_mark(node, _route) {
         const mark = node.value;
         this.writeOPE();
-        this.writeBreakscapedTagString(mark.solution);
+        this.writeTextOrValue(mark.solution, TextFormat.text, TextLocation.tag);
         this.writeCL();
         // Continue traversal
         return true;
@@ -822,21 +840,19 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.bitsValue)
             return true;
         const footer = node.value;
-        const textFormat = this.getTextFormat(route);
         // Handle footer
-        if (textFormat === TextFormat.json) {
+        if (this.textFormat === TextFormat.json) {
             // Json footer?!
             // Not valid, ignore
         }
         else if (footer.footer && footer.footer.length > 0) {
-            const isBitmarkText = textFormat === TextFormat.bitmarkPlusPlus || textFormat === TextFormat.bitmarkMinusMinus;
-            if (isBitmarkText) {
+            if (this.isBodyBitmarkText) {
                 // handle bitmark text
                 this.writeNL();
-                this.write('==== footer ====');
+                this.writeTextOrValue('==== footer ====', TextFormat.text, TextLocation.body);
                 this.writeNL();
                 // The text generator will write to the writer
-                this.textGenerator.generateSync(footer.footer, textFormat, {
+                this.writeTextOrValue(footer.footer, this.textFormat, TextLocation.body, {
                     plainTextDividerAllowed: true, // Always allowed for the footer.
                 });
             }
@@ -875,7 +891,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return;
         if (solution) {
             this.writeOPE();
-            this.writeBreakscapedTagString(solution);
+            this.writeTextOrValue(solution, TextFormat.text, TextLocation.tag);
             this.writeCL();
         }
     }
@@ -902,7 +918,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         else {
             this.writeOPM();
         }
-        this.write(selectOption.text);
+        this.writeTextOrValue(selectOption.text, TextFormat.text, TextLocation.tag);
         this.writeCL();
         // Continue traversal
         return true;
@@ -916,29 +932,29 @@ class BitmarkGenerator extends AstWalkerGenerator {
         else {
             this.writeOPM();
         }
-        this.write(highlightText.text);
+        this.writeTextOrValue(highlightText.text, TextFormat.text, TextLocation.tag);
         this.writeCL();
         // Continue traversal
         return true;
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode
-    enter_cardNode(_node, route) {
+    enter_cardNode(_node, _route) {
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return true;
         this.writeCardSetStart();
         // Continue traversal
         return true;
     }
-    between_cardNode(_node, _left, _right, route) {
+    between_cardNode(_node, _left, _right, _route) {
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetCardDivider();
     }
-    exit_cardNode(_node, route) {
+    exit_cardNode(_node, _route) {
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetEnd();
         if (this.options.cardSetVersion === CardSetVersion.v1) {
@@ -957,10 +973,10 @@ class BitmarkGenerator extends AstWalkerGenerator {
         this.writeCardSetCardDivider();
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> flashcards -> flashcardsValue
-    between_flashcardsValue(_node, _left, right, route) {
+    between_flashcardsValue(_node, _left, right, _route) {
         var _a;
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         if (right.key === NodeType.answer) {
             this.writeCardSetSideDivider();
@@ -981,8 +997,8 @@ class BitmarkGenerator extends AstWalkerGenerator {
     enter_statements(_node, _route) {
         //
     }
-    between_statements(_node, _left, _right, route) {
-        const isTrueFalse1 = this.isOfBitType(route, BitType.trueFalse1);
+    between_statements(_node, _left, _right, _route) {
+        const isTrueFalse1 = this.isOfBitType(BitType.trueFalse1);
         if (!isTrueFalse1) {
             this.writeCardSetCardDivider();
         }
@@ -997,7 +1013,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         else {
             this.writeOPM();
         }
-        this.write(statement.statement);
+        this.writeTextOrValue(statement.statement, TextFormat.text, TextLocation.tag);
         this.writeCL();
         // Continue traversal
         return true;
@@ -1014,7 +1030,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         else {
             this.writeOPM();
         }
-        this.write(choice.choice);
+        this.writeTextOrValue(choice.choice, TextFormat.text, TextLocation.tag);
         this.writeCL();
         // Continue traversal
         return true;
@@ -1030,7 +1046,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         else {
             this.writeOPM();
         }
-        this.write(response.response);
+        this.writeTextOrValue(response.response, TextFormat.text, TextLocation.tag);
         this.writeCL();
         // Continue traversal
         return true;
@@ -1056,9 +1072,9 @@ class BitmarkGenerator extends AstWalkerGenerator {
     enter_heading(_node, _route) {
         //
     }
-    between_heading(_node, _left, _right, route) {
+    between_heading(_node, _left, _right, _route) {
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetSideDivider();
     }
@@ -1066,9 +1082,9 @@ class BitmarkGenerator extends AstWalkerGenerator {
     enter_forValues(_node, _route) {
         //
     }
-    between_forValues(_node, _left, _right, route) {
+    between_forValues(_node, _left, _right, _route) {
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetSideDivider();
     }
@@ -1106,15 +1122,15 @@ class BitmarkGenerator extends AstWalkerGenerator {
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> pairs -> pairsValue -> values
     // bitmarkAst -> bits -> bitsValue -> cardNode -> matrix -> matrixValue -> cells -> cellsValue -> values
-    enter_values(_node, route) {
+    enter_values(_node, _route) {
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetSideDivider();
     }
-    between_values(_node, _left, _right, route) {
+    between_values(_node, _left, _right, _route) {
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetVariantDivider();
     }
@@ -1124,7 +1140,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.cardNode)
             return;
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetCardDivider();
     }
@@ -1134,7 +1150,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.cardNode)
             return;
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetCardDivider();
     }
@@ -1154,7 +1170,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if (parentKey !== NodeType.table && parentKey !== NodeType.captionDefinitionList)
             return;
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetSideDivider();
     }
@@ -1163,16 +1179,13 @@ class BitmarkGenerator extends AstWalkerGenerator {
     leaf_columnsValue(node, _route) {
         this.writeNL();
         this.writeOPHASH();
-        if (node.value)
-            this.writeBreakscapedTagString(node.value);
+        this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
         this.writeCL();
     }
     enter_columnsValue(node, _route) {
         this.writeNL();
         this.writeOPHASH();
-        if (node.value) {
-            this.textGenerator.generateSync(node.value, TextFormat.bitmarkMinusMinus);
-        }
+        this.writeTextOrValue(node.value, this.tagTextFormat, TextLocation.tag);
         this.writeCL();
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> table -> data -> dataValue
@@ -1182,7 +1195,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.table && (parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.pronunciationTable)
             return;
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         this.writeCardSetSideDivider();
     }
@@ -1192,16 +1205,14 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.table)
             return;
         this.writeNL();
-        this.write(node.value);
+        this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> table -> data -> dataValue -> dataValueValue
     // bitmarkAst -> bits -> bitsValue -> cardNode -> pronunciationTable -> data -> dataValue -> dataValueValue
     enter_dataValueValue(node, route) {
-        var _a;
         const parent = this.getParentNode(route, 3);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.table && (parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.pronunciationTable)
             return;
-        const textFormat = (_a = this.getTextFormat(route)) !== null && _a !== void 0 ? _a : TextFormat.bitmarkMinusMinus;
         if (node.value) {
             if ((parent === null || parent === void 0 ? void 0 : parent.key) === NodeType.pronunciationTable) {
                 // Pronunciation Table
@@ -1210,16 +1221,16 @@ class BitmarkGenerator extends AstWalkerGenerator {
                     this.writeNL();
                     this.writeOP();
                     this.writeHash();
-                    this.textGenerator.generateSync(cell.title, TextFormat.bitmarkMinusMinus);
+                    this.writeTextOrValue(cell.title, this.tagTextFormat, TextLocation.tag);
                     this.writeCL();
                 }
                 if (cell.audio) {
                     this.writeNL();
-                    this.writeResource(ResourceTag.audio, cell.audio.src);
+                    this.writeResource(ResourceTag.audio, cell.audio.audio.src);
                 }
                 if (cell.body) {
                     this.writeNL();
-                    this.textGenerator.generateSync(cell.body, textFormat);
+                    this.writeTextOrValue(cell.body, this.textFormat, TextLocation.body);
                 }
                 // Stop traversal of this branch
                 return false;
@@ -1227,10 +1238,9 @@ class BitmarkGenerator extends AstWalkerGenerator {
             else {
                 // Table
                 this.writeNL();
-                this.textGenerator.generateSync(node.value, textFormat);
+                this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
             }
         }
-        // this.write(node.value);
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> captionDefinitionList
     between_captionDefinitionList(_node, _left, _right, route) {
@@ -1246,7 +1256,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return true;
         if (node.value) {
             this.writeNL();
-            this.write(node.value);
+            this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
         }
         // Stop traversal of this branch
         return false;
@@ -1258,7 +1268,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return true;
         if (node.value) {
             this.writeNL();
-            this.write(node.value);
+            this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
         }
         // Stop traversal of this branch
         return false;
@@ -1278,7 +1288,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.definitions)
             return;
         // Ignore cards if not allowed
-        if (!this.isCardAllowed(route))
+        if (!this.isCardAllowed)
             return;
         if (right.key === NodeType.definition) {
             this.writeCardSetSideDivider();
@@ -1307,7 +1317,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if (ingredient.title != null) {
             this.writeNL();
             this.writeOPHASH();
-            this.writeBreakscapedTagString(ingredient.title);
+            this.writeTextOrValue(ingredient.title, TextFormat.text, TextLocation.tag);
             this.writeCL();
             // this.writeNL();
         }
@@ -1323,7 +1333,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         // [!43]
         if (ingredient.quantity != null) {
             this.writeOPB();
-            this.writeBreakscapedTagString(`${ingredient.quantity}`);
+            this.writeTextOrValue(`${ingredient.quantity}`, TextFormat.text, TextLocation.tag);
             this.writeCL();
         }
         // [@unit:kilograms]
@@ -1357,7 +1367,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         // item
         if (ingredient.item != null) {
             this.writeNL();
-            this.write(ingredient.item);
+            this.writeTextOrValue(ingredient.item, this.textFormat, TextLocation.body);
         }
         // Stop traversal of this branch
         return false;
@@ -1383,7 +1393,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return;
         this.writeNL();
         this.writeOPB();
-        this.writeBreakscapedTagString(node.value);
+        this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
         this.writeCL();
     }
     // bitmarkAst -> bits -> bitsValue -> cardNode -> botResponses -> botResponsesValue -> reaction
@@ -1403,10 +1413,10 @@ class BitmarkGenerator extends AstWalkerGenerator {
         const parent = this.getParentNode(route);
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.botResponsesValue)
             return;
-        const feeback = node.value;
-        if (feeback) {
+        const feedback = node.value;
+        if (feedback) {
             this.writeNL();
-            this.write(feeback);
+            this.writeTextOrValue(feedback, this.textFormat, TextLocation.body);
         }
     }
     // bitmarkAst -> bits -> bitsValue -> imagePlaceholder
@@ -1481,8 +1491,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if ((parent === null || parent === void 0 ? void 0 : parent.key) !== NodeType.bitsValue)
             return true;
         // Ensure this is a chapter bit
-        const bitType = this.getBitType(route);
-        if (!Config.isOfBitType(bitType, [BitType.chapter]))
+        if (!Config.isOfBitType(this.bitType, [BitType.chapter]))
             return true;
         const level = node.value;
         const bit = parent === null || parent === void 0 ? void 0 : parent.value;
@@ -1513,7 +1522,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             this.writeOP();
             for (let i = 0; i < +level; i++)
                 this.writeHash();
-            this.textGenerator.generateSync(title, TextFormat.bitmarkMinusMinus);
+            this.writeTextOrValue(title, this.tagTextFormat, TextLocation.tag);
             this.writeCL();
         }
         // Stop traversal of this branch
@@ -1533,7 +1542,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             this.writeOP();
             for (let i = 0; i < level; i++)
                 this.writeHash();
-            this.textGenerator.generateSync(subtitle, TextFormat.bitmarkMinusMinus);
+            this.writeTextOrValue(subtitle, this.tagTextFormat, TextLocation.tag);
             this.writeCL();
         }
         // Stop traversal of this branch
@@ -1557,11 +1566,11 @@ class BitmarkGenerator extends AstWalkerGenerator {
             });
             if (book.reference) {
                 this.writeOPRANGLE();
-                this.writeBreakscapedTagString(book.reference);
+                this.writeTextOrValue(book.reference, TextFormat.text, TextLocation.tag);
                 this.writeCL();
                 if (book.referenceEnd) {
                     this.writeOPRANGLE();
-                    this.writeBreakscapedTagString(book.referenceEnd);
+                    this.writeTextOrValue(book.referenceEnd, TextFormat.text, TextLocation.tag);
                     this.writeCL();
                 }
             }
@@ -1582,11 +1591,11 @@ class BitmarkGenerator extends AstWalkerGenerator {
             });
             if (bit.reference) {
                 this.writeOPRANGLE();
-                this.writeBreakscapedTagString(bit.reference);
+                this.writeTextOrValue(bit.reference, TextFormat.text, TextLocation.tag);
                 this.writeCL();
                 if (bit.referenceEnd) {
                     this.writeOPRANGLE();
-                    this.writeBreakscapedTagString(bit.referenceEnd);
+                    this.writeTextOrValue(bit.referenceEnd, TextFormat.text, TextLocation.tag);
                     this.writeCL();
                 }
             }
@@ -1597,7 +1606,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if (node.value) {
             this.writeNL();
             this.writeOPDANGLE();
-            this.writeBreakscapedTagString(node.value);
+            this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
             this.writeCL();
         }
     }
@@ -1610,7 +1619,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             if (!bit.book) {
                 this.writeNL();
                 this.writeOPRANGLE();
-                this.writeBreakscapedTagString(node.value);
+                this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
                 this.writeCL();
             }
         }
@@ -1624,7 +1633,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if (!this.isEmptyText(text)) {
             this.writeNL_IfNotChain(route);
             this.writeOPQ();
-            this.textGenerator.generateSync(text, TextFormat.bitmarkMinusMinus);
+            this.writeTextOrValue(text, this.tagTextFormat, TextLocation.tag);
             this.writeCL();
         }
         // Stop traversal of this branch
@@ -1637,7 +1646,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if (!this.isEmptyText(text)) {
             this.writeNL_IfNotChain(route);
             this.writeOPB();
-            this.textGenerator.generateSync(text, TextFormat.bitmarkMinusMinus);
+            this.writeTextOrValue(text, this.tagTextFormat, TextLocation.tag);
             this.writeCL();
         }
         // Stop traversal of this branch
@@ -1725,18 +1734,18 @@ class BitmarkGenerator extends AstWalkerGenerator {
             this.writeString('example');
             this.writeColon();
             if (example === true) {
-                this.writeString('true');
+                this.writeString(' true ');
             }
             else if (example === false) {
-                this.writeString('false');
+                this.writeString(' false ');
             }
             else if (Array.isArray(example)) {
                 // TextAst
-                this.textGenerator.generateSync(example, TextFormat.bitmarkMinusMinus);
+                this.writeTextOrValue(example, this.tagTextFormat, TextLocation.tag);
             }
             else {
                 // String
-                this.writeBreakscapedTagString(example);
+                this.writeTextOrValue(example, TextFormat.text, TextLocation.tag);
             }
             this.writeCL();
         }
@@ -1751,7 +1760,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
     leaf_elementsValue(node, _route) {
         if (node.value) {
             this.writeNL();
-            this.writeBreakscapedTagString(node.value);
+            this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
         }
     }
     // bitmarkAst -> bits -> bitsValue -> body -> bodyValue -> gap -> solutions -> solution
@@ -1762,7 +1771,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return;
         if (node.value != null) {
             this.writeOPU();
-            this.writeBreakscapedTagString(node.value);
+            this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
             this.writeCL();
         }
     }
@@ -1771,7 +1780,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
     leaf_prefix(node, _route) {
         if (node.value) {
             this.writeOPPRE();
-            this.writeBreakscapedTagString(node.value);
+            this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
             this.writeCL();
         }
     }
@@ -1780,7 +1789,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
     leaf_postfix(node, _route) {
         if (node.value) {
             this.writeOPPOST();
-            this.writeBreakscapedTagString(node.value);
+            this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
             this.writeCL();
         }
     }
@@ -1798,21 +1807,21 @@ class BitmarkGenerator extends AstWalkerGenerator {
     leaf_forKeys(node, _route) {
         this.writeNL();
         this.writeOPHASH();
-        this.writeBreakscapedTagString(node.value);
+        this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
         this.writeCL();
     }
     // bitmarkAst -> bits -> bitsValue -> heading -> forValues
     leaf_forValues(node, _route) {
         this.writeNL();
         this.writeOPHASH();
-        this.writeBreakscapedTagString(node.value);
+        this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
         this.writeCL();
     }
     // bitmarkAst -> bits -> bitsValue -> heading -> forValuesValue
     leaf_forValuesValue(node, _route) {
         this.writeNL();
         this.writeOPHASH();
-        this.writeBreakscapedTagString(node.value);
+        this.writeTextOrValue(node.value, TextFormat.text, TextLocation.tag);
         this.writeCL();
     }
     // bitmarkAst -> bits -> bitsValue -> pairs -> pairsValue -> key
@@ -1820,7 +1829,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
     leaf_key(node, _route) {
         if (node.value) {
             this.writeNL();
-            this.writeBreakscapedTagString(node.value);
+            this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
         }
     }
     // bitmarkAst -> bits -> bitsValue -> pairs -> pairsValue -> values -> valuesValue
@@ -1828,7 +1837,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
     leaf_valuesValue(node, _route) {
         if (node.value) {
             this.writeNL();
-            this.writeBreakscapedTagString(node.value);
+            this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
         }
     }
     // bitmarkAst -> bits -> bitsValue -> questions -> questionsValue -> question
@@ -1840,7 +1849,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return;
         if (node.value) {
             this.writeNL();
-            this.writeBreakscapedTagString(node.value);
+            this.writeTextOrValue(node.value, this.textFormat, TextLocation.body);
         }
     }
     // bitmarkAst -> bits -> bitsValue -> statements -> text
@@ -1897,9 +1906,8 @@ class BitmarkGenerator extends AstWalkerGenerator {
             ignoreEmpty: true,
         });
     }
-    leaf_zoomDisabled(node, route) {
-        const bitType = this.getBitType(route);
-        if (Config.isOfBitType(bitType, [
+    leaf_zoomDisabled(node, _route) {
+        if (Config.isOfBitType(this.bitType, [
             BitType.imageSeparator,
             BitType.pageBanner,
             BitType.imagesLogoGrave,
@@ -2164,8 +2172,7 @@ class BitmarkGenerator extends AstWalkerGenerator {
             return false;
         }
         else if (footer.footer && footer.footer.length > 0) {
-            const isBitmarkText = textFormat === TextFormat.bitmarkPlusPlus || textFormat === TextFormat.bitmarkMinusMinus;
-            if (isBitmarkText) {
+            if (this.isBodyBitmarkText) {
                 // handle bitmark text
                 return true;
             }
@@ -2177,17 +2184,108 @@ class BitmarkGenerator extends AstWalkerGenerator {
         }
         return false;
     }
+    /**
+     * Calculate the number of spaces around values from the options.
+     *
+     * This function should only be called from the constructor.
+     * Otherwise use this.spacesAroundValues.
+     *
+     * @returns
+     */
+    calcSpacesAroundValues() {
+        const val = this.options.spacesAroundValues;
+        let spaces = DEFAULT_SPACES_AROUND_VALUES;
+        if (val != null) {
+            if (val === true) {
+                spaces = DEFAULT_SPACES_AROUND_VALUES;
+            }
+            else if (val === false) {
+                spaces = 0;
+            }
+            else {
+                spaces = val;
+            }
+        }
+        spaces = Math.min(Math.max(spaces, 0), MAX_SPACES_AROUND_VALUES);
+        return spaces;
+    }
     // END UTILITY FUNCTIONS
     //
     // WRITE FUNCTIONS
     //
-    writeBreakscapedTagString(s) {
+    /**
+     * Helper function to write a tag key, breakscaping appropriately.
+     * Use only to write a tag key.
+     *
+     * @param s
+     */
+    writeTagKey(s) {
         if (s != null) {
             this.write(Breakscape.breakscape(`${s}`, {
-                textFormat: TextFormat.tag,
+                textFormat: TextFormat.text,
+                textLocation: TextLocation.tag,
             }));
         }
     }
+    /**
+     * Write text or value, handling the format and location (i.e. conversion to text and breakscaping).
+     *
+     * @param text
+     * @param format
+     * @param location
+     * @param options
+     */
+    writeTextOrValue(text, format, location, options) {
+        const isTagValue = location === TextLocation.tag;
+        const s = StringUtils.isString(text) ? text : undefined;
+        const ast = Array.isArray(text) ? text : undefined;
+        const isBitmarkText = format === TextFormat.bitmarkPlusPlus || format === TextFormat.bitmarkMinusMinus;
+        const isPlainText = !isBitmarkText;
+        const spacesAroundValues = isTagValue ? this.spacesAroundValuesStr : '';
+        if (isPlainText) {
+            // Plain text
+            if (s != null) {
+                this.write(`${spacesAroundValues}${Breakscape.breakscape(`${s}`, {
+                    textFormat: TextFormat.text,
+                    textLocation: location,
+                })}${spacesAroundValues}`);
+            }
+        }
+        else {
+            // Bitmark text (but might not be AST as some values are just strings (and all v2 values are strings))
+            if (s != null) {
+                this.write(`${spacesAroundValues}${Breakscape.breakscape(`${s}`, {
+                    textFormat: format,
+                    textLocation: location,
+                })}${spacesAroundValues}`);
+            }
+            else if (ast != null) {
+                // When writing a tag value, we don't know if it is empty until we write it, so we need to
+                // write it using the part writer, and then check if it is empty before writing to the main writer.
+                // Body values can be written directly to the main writer.
+                if (isTagValue) {
+                    // Change the writer to the part writer
+                    this.writer = this.partWriter;
+                    this.partWriter.openSync();
+                    // Write the text
+                    this.textGenerator.generateSync(ast, format, location, options);
+                    // Get the written text
+                    this.partWriter.closeSync();
+                    const text = this.partWriter.getString();
+                    // Restore the main writer
+                    this.writer = this.mainWriter;
+                    // Write the text to the main writer, adding spaces around it where required
+                    if (text) {
+                        this.write(`${spacesAroundValues}${text.trim()}${spacesAroundValues}`);
+                    }
+                }
+                else {
+                    // Write the text directly to the main writer
+                    this.textGenerator.generateSync(ast, format, location, options);
+                }
+            }
+        }
+    }
     writeString(s) {
         if (s != null)
             this.write(`${s}`);
@@ -2256,8 +2354,14 @@ class BitmarkGenerator extends AstWalkerGenerator {
         this.write('[');
     }
     writeCL() {
-        // HACK to fix breakscaping when string ends with a ^ (must add a space)
-        this.writer.getLastWrite().endsWith('^') ? this.write(' ]') : this.write(']');
+        // HACK to fix breakscaping when string ends with a ^ (must add a space) if
+        // options.spacesAroundValues is 0
+        if (this.spacesAroundValues === 0) {
+            this.writer.getLastWrite().endsWith('^') ? this.write(' ]') : this.write(']');
+        }
+        else {
+            this.write(']');
+        }
     }
     writeAmpersand() {
         this.write('&');
@@ -2271,6 +2375,9 @@ class BitmarkGenerator extends AstWalkerGenerator {
     writeHash() {
         this.write('#');
     }
+    writeSpacesAroundValues() {
+        this.write(this.spacesAroundValuesStr);
+    }
     writePlainTextDivider() {
         this.writeNL();
         this.write('==== text ====');
@@ -2340,9 +2447,9 @@ class BitmarkGenerator extends AstWalkerGenerator {
             const resourceData = resource[resourceTag];
             const src = resourceData ? resourceData.src || resourceData.url || resourceData.body || '' : '';
             this.writeOPA();
-            this.writeBreakscapedTagString(key);
+            this.writeTagKey(key);
             this.writeColon();
-            this.writeBreakscapedTagString(src);
+            this.writeTextOrValue(src, TextFormat.text, TextLocation.tag);
             if (resource.type === ResourceTag.article) {
                 // this.writeNL();
             }
@@ -2354,9 +2461,9 @@ class BitmarkGenerator extends AstWalkerGenerator {
         if (type) {
             // Standard case
             this.writeOPAMP();
-            this.writeBreakscapedTagString(type);
+            this.writeTagKey(type);
             this.writeColon();
-            this.writeBreakscapedTagString(value);
+            this.writeTextOrValue(value, TextFormat.text, TextLocation.tag);
             if (type === ResourceTag.article) {
                 // this.writeNL();
             }
@@ -2373,9 +2480,9 @@ class BitmarkGenerator extends AstWalkerGenerator {
                 if (options.ignoreEmpty && isBitmarkText && this.isEmptyText(values))
                     return;
                 this.writeOPA();
-                this.writeBreakscapedTagString(name);
+                this.writeTagKey(name);
                 this.writeColon();
-                this.textGenerator.generateSync(values, (_a = TextFormat.fromValue(options.format)) !== null && _a !== void 0 ? _a : TextFormat.bitmarkMinusMinus);
+                this.writeTextOrValue(values, (_a = TextFormat.fromValue(options.format)) !== null && _a !== void 0 ? _a : TextFormat.bitmarkMinusMinus, TextLocation.tag);
                 this.writeCL();
             }
             else {
@@ -2398,9 +2505,9 @@ class BitmarkGenerator extends AstWalkerGenerator {
                             if (options.ignoreEmpty && val === '')
                                 continue;
                             this.writeOPA();
-                            this.writeBreakscapedTagString(name);
+                            this.writeTagKey(name);
                             this.writeColon();
-                            this.writeBreakscapedTagString(`${val}`);
+                            this.writeTextOrValue(`${val}`, TextFormat.text, TextLocation.tag);
                             this.writeCL();
                             // propertyIndex++;
                         }
@@ -2437,35 +2544,14 @@ class BitmarkGenerator extends AstWalkerGenerator {
         const writeFormat = !isDefault || this.options.explicitTextFormat;
         return !!writeFormat;
     }
-    getTextFormat(route) {
-        for (const node of route) {
-            if (node.key === NodeType.bitsValue) {
-                const n = node.value;
-                return n === null || n === void 0 ? void 0 : n.textFormat;
-            }
-        }
-        return undefined;
-    }
-    isCardAllowed(route) {
-        const textFormat = this.getTextFormat(route);
-        const isBitmarkText = textFormat === TextFormat.bitmarkMinusMinus || textFormat === TextFormat.bitmarkPlusPlus;
-        return isBitmarkText && !this.isOfBitType1(route);
+    calculateIsCardAllowed() {
+        return this.isBodyBitmarkText && !this.isOfBitType1();
     }
-    isOfBitType1(route) {
-        return this.isOfBitType(route, [BitType.trueFalse1, BitType.multipleChoice1, BitType.multipleResponse1]);
+    isOfBitType1() {
+        return this.isOfBitType([BitType.trueFalse1, BitType.multipleChoice1, BitType.multipleResponse1]);
     }
-    isOfBitType(route, baseBitType) {
-        const bt = this.getBitType(route);
-        return Config.isOfBitType(bt, baseBitType);
-    }
-    getBitType(route) {
-        for (const node of route) {
-            if (node.key === NodeType.bitsValue) {
-                const n = node.value;
-                return n === null || n === void 0 ? void 0 : n.bitType;
-            }
-        }
-        return undefined;
+    isOfBitType(baseBitType) {
+        return Config.isOfBitType(this.bitType, baseBitType);
     }
     //
     // Writer interface