Add support for the “turn around” command

Amphiluke · Jan 3, 2024 · 2769d6e · 2769d6e
1 parent 25696d2
commit 2769d6e
Show file tree

Hide file tree

Showing 14 changed files with 99 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -35,6 +35,21 @@ If you rather prefer using ES modules in a browser, just choose the “esm” bu
 </script>
 ```
 
+## Supported commands
+
+The following turtle commands are currently supported by lindsvg:
+
+| Command             | Description                                           |
+| ------------------- | ----------------------------------------------------- |
+| `F`                 | Move forward one step with drawing a line             |
+| `B`                 | Move forward one step without drawing a line          |
+| `+`                 | Turn left by turning angle (theta)                    |
+| `-`                 | Turn right by turning angle (theta)                   |
+| `\|`                | Reverse direction (turn by 180 degrees)               |
+| `[`                 | 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                          |
+
 ## API &amp; examples
 
 The module exports two pairs of methods.

diff --git a/dist/lindsvg.cjs b/dist/lindsvg.cjs
@@ -1,13 +1,13 @@
 /*!
-lindsvg v1.3.3
+lindsvg v1.4.0
 https://amphiluke.github.io/lindsvg/
-(c) 2023 Amphiluke
+(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;
 }
@@ -117,6 +117,7 @@ let ctrlRules = {
     B: "",
     "+": "+",
     "-": "-",
+    "|": "|",
     "[": "[",
     "]": "]",
 };
@@ -136,7 +137,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!)
@@ -169,7 +170,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 {
@@ -195,6 +196,10 @@ class Turtle {
         this.alpha += factor * this.theta;
     }
 
+    reverse(repeatCount = 1) {
+        this.alpha += (repeatCount % 2) * Math.PI;
+    }
+
     pushStack(repeatCount = 1) {
         for (; repeatCount > 0; repeatCount--) {
             this.stack.push({x: this.x, y: this.y, alpha: this.alpha});
@@ -263,6 +268,9 @@ function getPathData(tokens, turtle) {
             case "-":
                 turtle.rotate(-tokenLength);
                 break;
+            case "|":
+                turtle.reverse(tokenLength);
+                break;
             case "[":
                 turtle.pushStack(tokenLength);
                 break;
@@ -312,6 +320,9 @@ function getMultiPathData(tokens, turtle) {
             case "-":
                 turtle.rotate(-tokenLength);
                 break;
+            case "|":
+                turtle.reverse(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.3.3
+lindsvg v1.4.0
 https://amphiluke.github.io/lindsvg/
-(c) 2023 Amphiluke
+(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;
 }
@@ -115,6 +115,7 @@ let ctrlRules = {
     B: "",
     "+": "+",
     "-": "-",
+    "|": "|",
     "[": "[",
     "]": "]",
 };
@@ -134,7 +135,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!)
@@ -167,7 +168,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 {
@@ -193,6 +194,10 @@ class Turtle {
         this.alpha += factor * this.theta;
     }
 
+    reverse(repeatCount = 1) {
+        this.alpha += (repeatCount % 2) * Math.PI;
+    }
+
     pushStack(repeatCount = 1) {
         for (; repeatCount > 0; repeatCount--) {
             this.stack.push({x: this.x, y: this.y, alpha: this.alpha});
@@ -261,6 +266,9 @@ function getPathData(tokens, turtle) {
             case "-":
                 turtle.rotate(-tokenLength);
                 break;
+            case "|":
+                turtle.reverse(tokenLength);
+                break;
             case "[":
                 turtle.pushStack(tokenLength);
                 break;
@@ -310,6 +318,9 @@ function getMultiPathData(tokens, turtle) {
             case "-":
                 turtle.rotate(-tokenLength);
                 break;
+            case "|":
+                turtle.reverse(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,7 +1,7 @@
 /*!
-lindsvg v1.3.3
+lindsvg v1.4.0
 https://amphiluke.github.io/lindsvg/
-(c) 2023 Amphiluke
+(c) 2024 Amphiluke
 */
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
@@ -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;
     }
@@ -121,6 +121,7 @@ https://amphiluke.github.io/lindsvg/
         B: "",
         "+": "+",
         "-": "-",
+        "|": "|",
         "[": "[",
         "]": "]",
     };
@@ -140,7 +141,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!)
@@ -173,7 +174,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 {
@@ -199,6 +200,10 @@ https://amphiluke.github.io/lindsvg/
             this.alpha += factor * this.theta;
         }
 
+        reverse(repeatCount = 1) {
+            this.alpha += (repeatCount % 2) * Math.PI;
+        }
+
         pushStack(repeatCount = 1) {
             for (; repeatCount > 0; repeatCount--) {
                 this.stack.push({x: this.x, y: this.y, alpha: this.alpha});
@@ -267,6 +272,9 @@ https://amphiluke.github.io/lindsvg/
                 case "-":
                     turtle.rotate(-tokenLength);
                     break;
+                case "|":
+                    turtle.reverse(tokenLength);
+                    break;
                 case "[":
                     turtle.pushStack(tokenLength);
                     break;
@@ -316,6 +324,9 @@ https://amphiluke.github.io/lindsvg/
                 case "-":
                     turtle.rotate(-tokenLength);
                     break;
+                case "|":
+                    turtle.reverse(tokenLength);
+                    break;
                 case "[":
                     branchLevel += tokenLength;
                     turtle.pushStack(tokenLength);