desmost 0.2.0 → 0.3.0

package/README.md

@@ -0,0 +1,23 @@
+# Desmost
+
+[**Docs**](https://github.com/Sup2point0/desmost/tree/main/docs)  ·  [**Changelog**](https://github.com/Sup2point0/desmost/blob/main/CHANGELOG.md)  ·  [**Playground**](https://sup2point0.github.io/desmost)
+
+A tiny DSL for compiling LaTeX to Desmos.
+
+<!-- You write this:
+
+```hs
+/viewport{ left: -5, right: 5 }
+% Drag the slider!
+
+A = 1
+y = A \sin(x - t)
+
+/label{ text: "we love Desmos(t)!" } :: (0, 2)
+
+/anim /slider{ min: -1, max: 1 }
+  :: t = 0
+```
+
+And Desmost gives you this: -->
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "desmost",
   "author": "Sup#2.0",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
 
   "description": "A tiny DSL for compiling LaTeX to Desmos",
@@ -23,7 +23,8 @@
     "./src/",
     "./dist/",
     "package.json",
-    "LICENCE"
+    "LICENCE",
+    "README.md"
   ],
   "exports": {
     ".": {

package/src/compiler/evaluate.ts

@@ -69,6 +69,18 @@ export function evaluate_expr(
   if (errors.length > 0) {
     desmos.setExpression({ type: "text", text: errors.join("\n\n") });
   }
+
+  // @ts-expect-error: outdated types
+  if (expr.data.latex != undefined) {
+    // @ts-expect-error: outdated types
+    expr.data.latex = normalise_latex(expr.data.latex);
+
+    if (options.prettify) {
+      // @ts-expect-error: outdated types
+      expr.data.latex = prettify_latex(expr.data.latex);
+    }
+  }
+
   desmos.setExpression(expr.data);
 }
 
@@ -108,6 +120,41 @@ export function evaluate_error(
 }
 
 
+/**
+ * Remove line breaks from `latex` so Desmos can properly consume it.
+ */
+function normalise_latex(latex: string): string
+{
+  return latex.replaceAll("\n", " ");
+}
+
+
+/**
+ * Prettify `latex` to render nicely in Desmos, reflecting how you would type directly into Desmos.
+ * 
+ * This includes:
+ * 
+ * - Replace `()`, `[]`, etc. with `\left(\right)`
+ * - Replace `min()`, `max()`, etc. with `\operatorname{min}()`
+ */
+function prettify_latex(latex: string): string
+{
+  latex = latex.replaceAll(/(?<!\\left)\(/g, "\\left(");
+  latex = latex.replaceAll(/(?<!\\right)\)/g, "\\right)");
+  latex = latex.replaceAll(/(?<!\\left)\[/g, "\\left[");
+  latex = latex.replaceAll(/(?<!\\right)\]/g, "\\right]");
+  latex = latex.replaceAll("\\{", "\\left{");
+  latex = latex.replaceAll("\\}", "\\right}");
+
+  latex = latex.replaceAll(
+    /(?<=[^\w]|^)\\?(mean|median|count|total|repeat|join|sort|shuffle|unique|mod|ceil|floor|round|sign)(?=\(|\\left\()/g,
+    "\\operatorname{$1}"
+  );
+
+  return latex;
+}
+
+
 function format_error(
   e: UnrecoverableError,
   options: Required<DesmostOptions>,

package/src/compiler/options.ts

@@ -47,6 +47,13 @@ export interface DesmostOptions
    */
   ignore_trailing_blanks?: boolean
 
+  /**
+   * Prettify LaTeX output so it renders nicely in the Desmos editor?
+   * 
+   * Defaults to `true`, meaning LaTeX is prettified.
+   */
+  prettify?: boolean
+
   /**
    * Return debug diagnostics? This includes the unevaluated AST, and performance diagnostics.
    * 
@@ -71,6 +78,7 @@ export function set_default_options(options: Partial<DesmostOptions> | undefined
   options.ignore_line_breaks ??= false;
   options.ignore_trailing_blanks ??= false;
 
+  options.prettify ??= true;
   options.debug ??= false;
 
   return options as Required<DesmostOptions>;

package/src/magic/local/index.ts

@@ -3,11 +3,12 @@ import { AnimIncantation } from "./anim";
 
 import { ColourIncantation } from "./colour";
 import { DashedIncantation } from "./dashed";
-import { FillIncantation } from "./fill";
-import { HideIncantation } from "./hide";
-import { LineIncantation } from "./line";
+import { FillIncantation   } from "./fill";
+import { HideIncantation   } from "./hide";
+import { LabelIncantation  } from "./label";
+import { LineIncantation   } from "./line";
 import { NoLineIncantation } from "./no-line";
-import { PointIncantation } from "./point";
+import { PointIncantation  } from "./point";
 import { SecretIncantation } from "./secret";
 import { SliderIncantation } from "./slider";
 
@@ -19,6 +20,7 @@ export const LOCAL_INCANTATIONS: Incantation<LOCAL>[] =
   new DashedIncantation(),
   new FillIncantation(),
   new HideIncantation(),
+  new LabelIncantation(),
   new LineIncantation(),
   new NoLineIncantation(),
   new PointIncantation(),

package/src/magic/local/label.ts

@@ -0,0 +1,58 @@
+import { UnrecoverableError } from "../../errors";
+import { Incantation, ArgIncantation, type LOCAL } from "../incantation";
+
+
+interface LabelOptions
+{
+  text: string;
+  show?: boolean;
+  size?: number | keyof typeof Desmos.LabelSizes;
+  pos?: keyof typeof Desmos.LabelOrientations;
+}
+
+
+export class LabelIncantation extends ArgIncantation<LOCAL>
+{
+  override readonly description
+    = ""
+
+  override readonly identifier   = "label"
+  override readonly requires_arg = true
+  override readonly arg_type     = Incantation.ArgType.OBJECT
+
+  override apply(target: Desmos.ExpressionState, data: LabelOptions)
+  {
+    super.require_expr_type(target.type, "expression");
+    target.label = data.text;
+    if (data.show != undefined) target.showLabel = data.show;
+    // @ts-expect-error: outdated types TODO check
+    if (data.size != undefined) target.labelSize = data.size;
+    if (data.pos  != undefined) target.labelOrientation = data.pos;
+  }
+
+  override evaluate_arg(raw: string): LabelOptions
+  {
+    let out = super.evaluate_arg(raw) as LabelOptions;
+
+    if (!("text" in out)) {
+      throw new UnrecoverableError.InvalidArgument(
+        `/label requires a \`text\` argument, such as: \`/label{ text: "sup world!" }\``
+      );
+    }
+
+    if (typeof out.pos != "undefined") {
+      switch (out.pos.trim().toUpperCase()) {
+        case "ABOVE": out.pos = Desmos.LabelOrientations.ABOVE; break;
+        case "BELOW": out.pos = Desmos.LabelOrientations.BELOW; break;
+        case "LEFT":  out.pos = Desmos.LabelOrientations.LEFT; break;
+        case "RIGHT": out.pos = Desmos.LabelOrientations.RIGHT; break;
+        default:
+          throw new UnrecoverableError.InvalidArgument(
+            `/label: Invalid label position: ${out.pos}`
+          );
+      }
+    }
+
+    return out;
+  }
+}

package/src/parser/desmost-parser.ts

@@ -18,9 +18,9 @@ import type { DesmostOptions } from "../compiler";
  */
 export class DesmostParser extends GenericParser
 {
-  constructor(source: string, options?: DesmostOptions)
+  constructor(source: string, protected options?: DesmostOptions)
   {
-    super(options?.ignore_trailing_blanks ? source : (source + "\n"));
+    super(source + "\n");
   }
 
 
@@ -379,25 +379,13 @@ export class DesmostParser extends GenericParser
 
     /**
      * Pop `ctx` if it is the currently active context, returning `true` if successful.
-     * 
-     * If `{ force: true }`, backtrack the stack and report errors for unterminated contexts.
     */
-    function try_pop(ctx: Ctx, options?: { force: boolean }): boolean
+    function try_pop(ctx: Ctx): boolean
     {
       if (stack.at(-1) === ctx) {
         stack.pop();
         return true;
       }
-      else if (options?.force) {
-        if (stack.includes(ctx)) {
-          /* NOTE: We could report errors for unterminated contexts, but we'll leave that for the actual evaluation - in case we get something wrong ;) */
-          while (stack.at(-1) !== ctx) {
-            stack.pop();
-          }
-
-          return true;
-        }
-      }
 
       return false;
     }
@@ -414,14 +402,13 @@ export class DesmostParser extends GenericParser
       switch (this.current) {
         case Ctx.ESCAPE: stack.push(Ctx.ESCAPE); break;
 
-        /* NOTE: *Currently* `{}` should be ignored in all contexts except `Ctx.BLOCK`. This might change if more contexts are added in future! */
         case Char.L_BRACE:
+          /* NOTE: *Currently* `{}` should be ignored in all contexts except `Ctx.BLOCK`. This might change if more contexts are added in future! */
           if (top !== Ctx.BLOCK) break;
           stack.push(Ctx.BLOCK); break;
 
         case Char.R_BRACE:
-          if (top !== Ctx.BLOCK) break;
-          try_pop(Ctx.BLOCK, { force: true }); break;
+          try_pop(Ctx.BLOCK); break;
       }
 
       if (arg_type === Incantation.ArgType.OBJECT) {