Add support for the “swap sign” command

Amphiluke · Jan 4, 2024 · 35f711b · 35f711b
1 parent 2769d6e
commit 35f711b
Show file tree

Hide file tree

Showing 15 changed files with 81 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -46,6 +46,7 @@ The following turtle commands are currently supported by lindsvg:
 | `+`                 | Turn left by turning angle (theta)                    |
 | `-`                 | Turn right by turning angle (theta)                   |
 | `\|`                | Reverse direction (turn by 180 degrees)               |
+| `!`                 | Reverse the meaning of `+` and `-`                    |
 | `[`                 | Push current state of the turtle onto the stack       |
 | `]`                 | Pop a state from the stack and apply it to the turtle |
 | `A`,`C`–`E`,`G`–`Z` | Auxiliary user-defined rules                          |

diff --git a/dist/lindsvg.cjs b/dist/lindsvg.cjs
@@ -1,13 +1,13 @@
 /*!
-lindsvg v1.4.0
+lindsvg v1.5.0
 https://amphiluke.github.io/lindsvg/
 (c) 2024 Amphiluke
 */
 'use strict';
 
 let messages = {
-    AXIOM: "Axiom may only contain the following characters: A..Z,+,-,|,[,]",
-    RULE: "Production rules may only contain the following characters: A..Z,+,-,|,[,]",
+    AXIOM: "Axiom may only contain the following characters: A..Z,+,-,|,!,[,]",
+    RULE: "Production rules may only contain the following characters: A..Z,+,-,|,!,[,]",
     LETTER: "Allowed alphabet letters are: A..Z",
     ALPHA: "The “alpha” parameter must be a finite number",
     THETA: "The “theta” parameter must be a finite number",
@@ -21,7 +21,7 @@ function checkLetter(letter, msg = messages.LETTER) {
     return letterRE.test(letter) || msg;
 }
 
-let ruleRE = /^[A-Z+\-[\]|]*$/;
+let ruleRE = /^[A-Z+\-|![\]]*$/;
 function checkRule(rule, msg = messages.RULE) {
     return ruleRE.test(rule) || msg;
 }
@@ -118,6 +118,7 @@ let ctrlRules = {
     "+": "+",
     "-": "-",
     "|": "|",
+    "!": "!",
     "[": "[",
     "]": "]",
 };
@@ -137,7 +138,7 @@ let defaults = {
  */
 function cleanCodeword(codeword) {
     // Remove auxiliary drawing-indifferent letters
-    let cleanCodeword = codeword.replace(/[^FB[\]+-|]/g, "");
+    let cleanCodeword = codeword.replace(/[^FB[\]+-|!]/g, "");
     do {
         codeword = cleanCodeword;
         // Remove useless brackets that don’t contain F commands or other brackets (preserving bracket balance!)
@@ -170,7 +171,7 @@ function generateCodeword(lsParams) {
  * @return {String[]}
  */
 function tokenizeCodeword(codeword) {
-    return codeword.match(/([FB[\]+-|])\1*/g); // tokenize
+    return codeword.match(/([FB[\]+-|!])\1*/g); // tokenize
 }
 
 class Turtle {
@@ -200,6 +201,10 @@ class Turtle {
         this.alpha += (repeatCount % 2) * Math.PI;
     }
 
+    swapSigns(repeatCount = 1) {
+        this.theta *= (-1) ** repeatCount;
+    }
+
     pushStack(repeatCount = 1) {
         for (; repeatCount > 0; repeatCount--) {
             this.stack.push({x: this.x, y: this.y, alpha: this.alpha});
@@ -271,6 +276,9 @@ function getPathData(tokens, turtle) {
             case "|":
                 turtle.reverse(tokenLength);
                 break;
+            case "!":
+                turtle.swapSigns(tokenLength);
+                break;
             case "[":
                 turtle.pushStack(tokenLength);
                 break;
@@ -323,6 +331,9 @@ function getMultiPathData(tokens, turtle) {
             case "|":
                 turtle.reverse(tokenLength);
                 break;
+            case "!":
+                turtle.swapSigns(tokenLength);
+                break;
             case "[":
                 branchLevel += tokenLength;
                 turtle.pushStack(tokenLength);

diff --git a/dist/lindsvg.esm.js b/dist/lindsvg.esm.js
@@ -1,11 +1,11 @@
 /*!
-lindsvg v1.4.0
+lindsvg v1.5.0
 https://amphiluke.github.io/lindsvg/
 (c) 2024 Amphiluke
 */
 let messages = {
-    AXIOM: "Axiom may only contain the following characters: A..Z,+,-,|,[,]",
-    RULE: "Production rules may only contain the following characters: A..Z,+,-,|,[,]",
+    AXIOM: "Axiom may only contain the following characters: A..Z,+,-,|,!,[,]",
+    RULE: "Production rules may only contain the following characters: A..Z,+,-,|,!,[,]",
     LETTER: "Allowed alphabet letters are: A..Z",
     ALPHA: "The “alpha” parameter must be a finite number",
     THETA: "The “theta” parameter must be a finite number",
@@ -19,7 +19,7 @@ function checkLetter(letter, msg = messages.LETTER) {
     return letterRE.test(letter) || msg;
 }
 
-let ruleRE = /^[A-Z+\-[\]|]*$/;
+let ruleRE = /^[A-Z+\-|![\]]*$/;
 function checkRule(rule, msg = messages.RULE) {
     return ruleRE.test(rule) || msg;
 }
@@ -116,6 +116,7 @@ let ctrlRules = {
     "+": "+",
     "-": "-",
     "|": "|",
+    "!": "!",
     "[": "[",
     "]": "]",
 };
@@ -135,7 +136,7 @@ let defaults = {
  */
 function cleanCodeword(codeword) {
     // Remove auxiliary drawing-indifferent letters
-    let cleanCodeword = codeword.replace(/[^FB[\]+-|]/g, "");
+    let cleanCodeword = codeword.replace(/[^FB[\]+-|!]/g, "");
     do {
         codeword = cleanCodeword;
         // Remove useless brackets that don’t contain F commands or other brackets (preserving bracket balance!)
@@ -168,7 +169,7 @@ function generateCodeword(lsParams) {
  * @return {String[]}
  */
 function tokenizeCodeword(codeword) {
-    return codeword.match(/([FB[\]+-|])\1*/g); // tokenize
+    return codeword.match(/([FB[\]+-|!])\1*/g); // tokenize
 }
 
 class Turtle {
@@ -198,6 +199,10 @@ class Turtle {
         this.alpha += (repeatCount % 2) * Math.PI;
     }
 
+    swapSigns(repeatCount = 1) {
+        this.theta *= (-1) ** repeatCount;
+    }
+
     pushStack(repeatCount = 1) {
         for (; repeatCount > 0; repeatCount--) {
             this.stack.push({x: this.x, y: this.y, alpha: this.alpha});
@@ -269,6 +274,9 @@ function getPathData(tokens, turtle) {
             case "|":
                 turtle.reverse(tokenLength);
                 break;
+            case "!":
+                turtle.swapSigns(tokenLength);
+                break;
             case "[":
                 turtle.pushStack(tokenLength);
                 break;
@@ -321,6 +329,9 @@ function getMultiPathData(tokens, turtle) {
             case "|":
                 turtle.reverse(tokenLength);
                 break;
+            case "!":
+                turtle.swapSigns(tokenLength);
+                break;
             case "[":
                 branchLevel += tokenLength;
                 turtle.pushStack(tokenLength);

diff --git a/dist/lindsvg.esm.min.js b/dist/lindsvg.esm.min.js
diff --git a/dist/lindsvg.js b/dist/lindsvg.js
@@ -1,5 +1,5 @@
 /*!
-lindsvg v1.4.0
+lindsvg v1.5.0
 https://amphiluke.github.io/lindsvg/
 (c) 2024 Amphiluke
 */
@@ -10,8 +10,8 @@ https://amphiluke.github.io/lindsvg/
 })(this, (function (exports) { 'use strict';
 
     let messages = {
-        AXIOM: "Axiom may only contain the following characters: A..Z,+,-,|,[,]",
-        RULE: "Production rules may only contain the following characters: A..Z,+,-,|,[,]",
+        AXIOM: "Axiom may only contain the following characters: A..Z,+,-,|,!,[,]",
+        RULE: "Production rules may only contain the following characters: A..Z,+,-,|,!,[,]",
         LETTER: "Allowed alphabet letters are: A..Z",
         ALPHA: "The “alpha” parameter must be a finite number",
         THETA: "The “theta” parameter must be a finite number",
@@ -25,7 +25,7 @@ https://amphiluke.github.io/lindsvg/
         return letterRE.test(letter) || msg;
     }
 
-    let ruleRE = /^[A-Z+\-[\]|]*$/;
+    let ruleRE = /^[A-Z+\-|![\]]*$/;
     function checkRule(rule, msg = messages.RULE) {
         return ruleRE.test(rule) || msg;
     }
@@ -122,6 +122,7 @@ https://amphiluke.github.io/lindsvg/
         "+": "+",
         "-": "-",
         "|": "|",
+        "!": "!",
         "[": "[",
         "]": "]",
     };
@@ -141,7 +142,7 @@ https://amphiluke.github.io/lindsvg/
      */
     function cleanCodeword(codeword) {
         // Remove auxiliary drawing-indifferent letters
-        let cleanCodeword = codeword.replace(/[^FB[\]+-|]/g, "");
+        let cleanCodeword = codeword.replace(/[^FB[\]+-|!]/g, "");
         do {
             codeword = cleanCodeword;
             // Remove useless brackets that don’t contain F commands or other brackets (preserving bracket balance!)
@@ -174,7 +175,7 @@ https://amphiluke.github.io/lindsvg/
      * @return {String[]}
      */
     function tokenizeCodeword(codeword) {
-        return codeword.match(/([FB[\]+-|])\1*/g); // tokenize
+        return codeword.match(/([FB[\]+-|!])\1*/g); // tokenize
     }
 
     class Turtle {
@@ -204,6 +205,10 @@ https://amphiluke.github.io/lindsvg/
             this.alpha += (repeatCount % 2) * Math.PI;
         }
 
+        swapSigns(repeatCount = 1) {
+            this.theta *= (-1) ** repeatCount;
+        }
+
         pushStack(repeatCount = 1) {
             for (; repeatCount > 0; repeatCount--) {
                 this.stack.push({x: this.x, y: this.y, alpha: this.alpha});
@@ -275,6 +280,9 @@ https://amphiluke.github.io/lindsvg/
                 case "|":
                     turtle.reverse(tokenLength);
                     break;
+                case "!":
+                    turtle.swapSigns(tokenLength);
+                    break;
                 case "[":
                     turtle.pushStack(tokenLength);
                     break;
@@ -327,6 +335,9 @@ https://amphiluke.github.io/lindsvg/
                 case "|":
                     turtle.reverse(tokenLength);
                     break;
+                case "!":
+                    turtle.swapSigns(tokenLength);
+                    break;
                 case "[":
                     branchLevel += tokenLength;
                     turtle.pushStack(tokenLength);