desmost 0.10.0 → 0.11.0

package/src/parser/ast.ts

@@ -3,15 +3,17 @@ import { Incantation, ArgIncantation } from "../magic";
 
 export namespace Ast
 {
-	/** What kind of AST node this is. */
-	export enum Kind
-	{
+	/**
+	 * What kind of AST node this is.
+	 */
+	export enum Kind {
 		EXPRESSION             = "Expression",
 		INCANTATION_INVOCATION = "Incantation-Invocation",
 	}
-
 	
-	/** A Desmos expression to add to the calculator. */
+	/**
+	 * A Desmos expression to add to the calculator.
+	 */
 	export interface Expression
 	{
 		kind: Kind.EXPRESSION
@@ -19,8 +21,9 @@ export namespace Ast
 		incantations: IncantationInvocation<Incantation.Effect.LOCAL>[]
 	}
 
-
-	/** A pending incantation invocation that requires applying its argument (if any), then applying its effect. */
+	/**
+	 * A pending incantation invocation that requires applying its argument (if any), then applying its effect.
+	 */
 	export type IncantationInvocation<Effect extends Incantation.Effect = Incantation.Effect> =
 		| {
 			kind: Kind.INCANTATION_INVOCATION

package/src/parser/desmost-parser.ts

@@ -1,9 +1,10 @@
 import { GenericParser } from "./generic-parser";
 import { Ast } from "./ast";
+import { NO_MATCH, INVALID_PARSE } from "./errors";
+import type { NoMatch, InvalidParse } from "./errors";
 
 import type { DesmostOptions } from "../options";
-import { NO_MATCH, DesmostError } from "../errors";
-import type { NoMatch, Fallible } from "../errors";
+import { DesmostError, type Fallible } from "../errors";
 import * as utils from "../utils";
 
 import {
@@ -49,7 +50,7 @@ export class DesmostParser extends GenericParser
 	{
 		this.errors = [];
 
-		this.consume_spaces();
+		this.eat_whitespace();
 
 		if (this.out_of_bounds()) {
 			return undefined;
@@ -97,7 +98,7 @@ export class DesmostParser extends GenericParser
 			blocks.push(this.parse_post_sep());
 		}
 
-		this.consume_end_of_block();
+		this.eat_end_of_block();
 
 		return { blocks, errors: this.errors };
 	}
@@ -116,10 +117,10 @@ export class DesmostParser extends GenericParser
 	{
 		// 1 global incantation
 		try {
-			let r = this.try_parse_incantation(GLOBAL_INCANTATIONS);
+			let r = this.try_parse_incantation(Object.values(GLOBAL_INCANTATIONS));
 
 			if (r !== NO_MATCH) {
-				this.consume_spaces();
+				this.eat_whitespace();
 				return { global: r };
 			}
 		}
@@ -133,7 +134,7 @@ export class DesmostParser extends GenericParser
 
 		while (this.current === "/") {
 			try {
-				var invocation = this.try_parse_incantation(LOCAL_INCANTATIONS);
+				var invocation = this.try_parse_incantation(Object.values(LOCAL_INCANTATIONS));
 			}
 			catch (e) {
 				this.errors.push(e as Error);
@@ -142,7 +143,7 @@ export class DesmostParser extends GenericParser
 
 			if (invocation === NO_MATCH) break;
 			incantations.push(invocation);
-			this.consume_whitespace();
+			this.eat_newlines();
 		}
 
 		return { locals: incantations };
@@ -153,10 +154,10 @@ export class DesmostParser extends GenericParser
 	 */
 	parse_sep(): Fallible<void>
 	{
-		this.consume_whitespace();
+		this.eat_newlines();
 		
 		try {
-			this.consume("::", {
+			this.eat("::", {
 				msg:  `Expected \`::\` separator between local incantations and expression, but found: \`${this.preview()}\``,
 				hint: `Use \`/incantation :: ${this.preview()}\``,
 			});
@@ -181,10 +182,10 @@ export class DesmostParser extends GenericParser
 				}
 			}));
 
-			this.consume("::");
+			this.eat("::");
 		}
 
-		this.consume_whitespace();
+		this.eat_newlines();
 	}
 
 	/**
@@ -195,7 +196,7 @@ export class DesmostParser extends GenericParser
 	 */
 	parse_post_sep(): Fallible<Ast.Expression>
 	{
-		this.consume_spaces();
+		this.eat_whitespace();
 
 		switch (this.current) {
 			// empty block
@@ -260,9 +261,9 @@ export class DesmostParser extends GenericParser
 	{
 		let init = this.i;
 
-		if (this.try_consume("/") === NO_MATCH) return NO_MATCH;
+		if (this.try_eat("/") === NO_MATCH) return NO_MATCH;
 
-		let ident = this.try_consume_identifier();
+		let ident = this.try_eat_identifier();
 		if (ident === NO_MATCH) {
 			this.i = init;
 			return NO_MATCH;
@@ -302,22 +303,25 @@ export class DesmostParser extends GenericParser
 	{
 		let init = this.i;
 
-		if (this.try_consume("/") === NO_MATCH) return NO_MATCH;
+		if (this.try_eat("/") === NO_MATCH) return NO_MATCH;
 
-		let ident = this.try_consume_identifier();
+		let ident = this.try_eat_identifier();
 		if (ident === NO_MATCH) {
 			this.i = init;
 			return NO_MATCH;
 		}
 
-		let incantation = EXPR_INCANTATIONS.find(inc => inc.identifier === ident || inc.alias === ident);
+		let incantation =	
+			Object.values(EXPR_INCANTATIONS)
+			.find(inc => inc.identifier === ident || inc.alias === ident);
+		
 		if (incantation == undefined) {
 			this.i = init;
 			return NO_MATCH;
 		}
 
 		/* NOTE: All expression incantations currently require arguments, and all for the foreseeable future will too */
-		let arg_raw = this.parse_incantation_arg((incantation as ArgIncantation<EXPR>).arg_type);
+		let arg_raw = this.parse_incantation_arg(incantation.arg_type);
 
 		let data = {};
 		incantation.apply(data, arg_raw);
@@ -398,7 +402,7 @@ export class DesmostParser extends GenericParser
 	{
 		let init = this.i;
 
-		this.consume("{", {
+		this.eat("{", {
 			msg: `Expected \`{\` to start incantation argument, but found: \`${this.preview()}\``
 		});
 
@@ -431,7 +435,7 @@ export class DesmostParser extends GenericParser
 					stack.push(Ctx.ENUM);
 					indices_to_insert_quotes.push(this.i);
 				}
-				else if (top === Ctx.ENUM && this.current?.match(/[^a-zA-Z]/)) {
+				else if (top === Ctx.ENUM && this.current?.match(/[^a-zA-Z-_]/)) {
 					stack.pop();
 					indices_to_insert_quotes.push(this.i);
 

package/src/parser/errors.ts

@@ -0,0 +1,10 @@
+/** The parser failed to parse something (usually during speculative parsing), which only results in internal backtracking. */
+export const NO_MATCH = Symbol("no-match");
+
+/** The compiler encountered a non-fatal recoverable failure (usually during speculative parsing), which only results in internal backtracking. */
+export type NoMatch = typeof NO_MATCH & { readonly __brand?: unique symbol };
+
+
+export const INVALID_PARSE = Symbol("invalid-parse");
+
+export type InvalidParse = typeof INVALID_PARSE & { readonly __brand?: unique symbol };

package/src/parser/generic-parser.ts

@@ -1,5 +1,7 @@
-import { NO_MATCH, DesmostError } from "../errors";
-import type { NoMatch, Fallible } from "../errors";
+import { NO_MATCH, INVALID_PARSE } from "./errors";
+import type { NoMatch, InvalidParse } from "./errors";
+
+import { DesmostError, type Fallible } from "../errors";
 
 
 const IGNORED_CHARACTERS = new Set([
@@ -111,15 +113,15 @@ export class GenericParser
 		this.i++;
 
 		// @ts-expect-error: `this.current == undefined` is a true negative
-		if (IGNORED_CHARACTERS.has(this.current)) {
-			this.advance();
+		while (IGNORED_CHARACTERS.has(this.current)) {
+			this.i++;
 		}
 	}
 
 	/**
 	 * Consume `raw`, erroring if `raw` was not found.
 	 */
-	protected consume(raw: string, error_data?: DesmostError.Data): Fallible<void>
+	protected eat(raw: string, error_data?: DesmostError.Data): Fallible<void>
 	{
 		if (this.out_of_bounds()) {
 			throw new DesmostError.UnexpectedEnd({
@@ -154,7 +156,7 @@ export class GenericParser
 	/**
 	 * Attempt to consume `raw`, backtracking if `raw` was not found.
 	 */
-	protected try_consume(raw: string): void | NoMatch
+	protected try_eat(raw: string): void | NoMatch
 	{
 		let init = this.i;
 		let ii = 0;
@@ -172,7 +174,7 @@ export class GenericParser
 		return NO_MATCH;
 	}
 
-	protected try_consume_identifier(): string | NoMatch
+	protected try_eat_identifier(): string | NoMatch
 	{
 		let init = this.i;
 
@@ -189,44 +191,40 @@ export class GenericParser
 	}
 
 	/**
-	 * Consume 0 or more space characters.
+	 * Consume 0 or more space or tab characters (but not newlines).
+	 * 
+	 * This is always safe to call, and will match 0 characters if the parser is out of bounds.
 	 */
-	protected consume_spaces(): void
+	protected eat_whitespace(): void
 	{
-		/* NOTE: Callers should be able to assume this is safe to call even when at end of input, since it should just match 0 characters */
-		if (this.out_of_bounds()) return;
-
-		while (this.current === " ") {
+		while (this.current === ' ' || this.current === '\t') {
 			this.advance();
 		}
 	}
 
 	/**
-	 * Consume 0 or more whitespace characters.
+	 * Consume 0 or more whitespace characters (including newlines).
 	 * 
-	 * Same as `.consume_spaces()`, but allows tabs and newlines.
+	 * This is always safe to call, and will match 0 characters if the parser is out of bounds.
 	 */
-	protected consume_whitespace(): void
+	protected eat_newlines(): void
 	{
-		/* NOTE: Callers should be able to assume this is safe to call even when at end of input, since it should just match 0 characters */
-		if (this.i >= this.length) return;
-
 		while (
-			this.current === " "
-			|| this.current === "\n"
-			|| this.current === "\t"
+			this.current === ' '
+			|| this.current === '\n'
+			|| this.current === '\t'
 		) {
 			this.advance();
 		}
 	}
 
-	protected consume_end_of_block(error_data?: DesmostError.Data): Fallible<void>
+	protected eat_end_of_block(error_data?: DesmostError.Data): Fallible<void>
 	{
 		if (this.i >= this.length) return;
 
-		this.consume_spaces();
+		this.eat_whitespace();
 
-		this.consume("\n", {
+		this.eat("\n", {
 			msg: `Expected a newline at the end of a block, but found: \`${this.preview()}\``,
 			...error_data
 		});

package/src/utils.ts

@@ -67,7 +67,7 @@ export class Range
 	}
 
 	get length(): number {
-		return this.stop - this.start + 1;
+		return this.stop - this.start;
 	}
 
 	*map<T>(callback: (n: number) => T): Generator<T>

package/svelte/desmost.svelte

@@ -12,11 +12,11 @@ When this component is unmounted, it calls `.destroy()` on each calculator insta
 
 ```svelte
 <script>
-    import Content from "./content.md";
+	import Content from "./content.md";
 </script>
 
 <Desmost>
-    <Content />
+	<Content />
 </Desmost>
 ```
 
@@ -24,7 +24,7 @@ With compile options:
 
 ```svelte
 <Desmost options={{ errors: "crash" }}>
-    <Content />
+	<Content />
 </Desmost>
 ```
 
@@ -32,7 +32,7 @@ With styling:
 
 ```svelte
 <Desmost width="100%" height="50vh">
-    <Content />
+	<Content />
 </Desmost>
 ```
 -->
@@ -47,72 +47,72 @@ import { onMount, type Snippet } from "svelte";
 
 interface Props
 {
-  children: Snippet;
-
-  /** Compile options to pass to Desmost.*/
-  options?: DesmostOptions;
-
-  /**
-   * Default settings to apply to all Desmos calculator instances.
-   * 
-   * These are applied *before* compilation, so individual Desmost blocks can override them with `/desmos`.
-   */
-  settings?: Desmos.GraphConfiguration & Desmos.GraphSettings;
-
-  /**
-   * Should compilation be lazy using `IntersectionObserver`?
-   * 
-   * ## Example
-   * 
-   * ```svelte
-   * <Desmost lazy />
-   * ```
-   */
-  lazy?: true;
-
-  /**
-   * CSS styles to apply to each Desmos calculator's containing element.
-   * 
-   * ## Example
-   * 
-   * ```svelte
-   * <Desmost style="margin: 1rem; border: 1px solid red" />
-   * ```
-   */
-  style?: string;
-
-  /**
-   * Width of each Desmos calculator's containing element.
-   * 
-   * ## Example
-   * 
-   * ```svelte
-   * <Desmost width="500px" />
-   * <Desmost width="40rem" />
-   * <Desmost width="80vw" />
-   * ```
-   */
-  width?: string;
-  
-  /**
-   * Height of each Desmos calculator's containing element.
-   * 
-   * ## Example
-   * 
-   * ```svelte
-   * <Desmost height="500px" />
-   * <Desmost height="40rem" />
-   * <Desmost height="80vw" />
-   * ```
-   */
-  height?: string;
+	children: Snippet;
+
+	/** Compile options to pass to Desmost.*/
+	options?: DesmostOptions;
+
+	/**
+	 * Default settings to apply to all Desmos calculator instances.
+	 * 
+	 * These are applied *before* compilation, so individual Desmost blocks can override them with `/desmos`.
+	 */
+	settings?: Desmos.GraphConfiguration & Desmos.GraphSettings;
+
+	/**
+	 * Should compilation be lazy using `IntersectionObserver`?
+	 * 
+	 * ## Example
+	 * 
+	 * ```svelte
+	 * <Desmost lazy />
+	 * ```
+	 */
+	lazy?: true;
+
+	/**
+	 * CSS styles to apply to each Desmos calculator's containing element.
+	 * 
+	 * ## Example
+	 * 
+	 * ```svelte
+	 * <Desmost style="margin: 1rem; border: 1px solid red" />
+	 * ```
+	 */
+	style?: string;
+
+	/**
+	 * Width of each Desmos calculator's containing element.
+	 * 
+	 * ## Example
+	 * 
+	 * ```svelte
+	 * <Desmost width="500px" />
+	 * <Desmost width="40rem" />
+	 * <Desmost width="80vw" />
+	 * ```
+	 */
+	width?: string;
+	
+	/**
+	 * Height of each Desmos calculator's containing element.
+	 * 
+	 * ## Example
+	 * 
+	 * ```svelte
+	 * <Desmost height="500px" />
+	 * <Desmost height="40rem" />
+	 * <Desmost height="80vw" />
+	 * ```
+	 */
+	height?: string;
 }
 
 let {
-  children,
-  options, settings,
-  lazy,
-  style, width, height,
+	children,
+	options, settings,
+	lazy,
+	style, width, height,
 }: Props = $props();
 
 
@@ -123,56 +123,56 @@ let lazy_observers: IntersectionObserver[] = [];
 
 onMount(() =>
 {
-  let sources = root.querySelectorAll("pre[lang='desmos'], pre.language-desmos");
-
-  for (let source of sources.values()) {
-    source.style.display = "none";
-
-    let el_desmos = source.parentNode!.insertBefore(
-      document.createElement("div"),
-      source.nextSibling,
-    );
-    
-    if (width  != undefined) el_desmos.style.width = width;
-    if (height != undefined) el_desmos.style.height = height;
-    if (style  != undefined) el_desmos.style.cssText += style;
-
-    if (!lazy) {
-      inject(el_desmos, source.textContent);
-    }
-    else {
-      let observer = new IntersectionObserver(([entry]) => {
-        if (entry.isIntersecting) {
-          inject(el_desmos, source.textContent);
-          observer.disconnect();
-        }
-      });
-      observer.observe(el_desmos);
-      lazy_observers.push(observer);
-    }
-  }
-
-  return () => {
-    desmos_instances.forEach(d => d.destroy());
-    lazy_observers.forEach(o => o.disconnect());
-  };
+	let sources = root.querySelectorAll("pre[lang='desmos'], pre.language-desmos");
+
+	for (let source of sources.values()) {
+		source.style.display = "none";
+
+		let el_desmos = source.parentNode!.insertBefore(
+			document.createElement("div"),
+			source.nextSibling,
+		);
+		
+		if (width  != undefined) el_desmos.style.width = width;
+		if (height != undefined) el_desmos.style.height = height;
+		if (style  != undefined) el_desmos.style.cssText += style;
+
+		if (!lazy) {
+			inject(el_desmos, source.textContent);
+		}
+		else {
+			let observer = new IntersectionObserver(([entry]) => {
+				if (entry.isIntersecting) {
+					inject(el_desmos, source.textContent);
+					observer.disconnect();
+				}
+			});
+			observer.observe(el_desmos);
+			lazy_observers.push(observer);
+		}
+	}
+
+	return () => {
+		desmos_instances.forEach(d => d.destroy());
+		lazy_observers.forEach(o => o.disconnect());
+	};
 });
 
 function inject(el_desmos: HTMLElement, source: string)
 {
-  let desmos = Desmos.GraphingCalculator(el_desmos);
+	let desmos = Desmos.GraphingCalculator(el_desmos);
 
-  if (settings != undefined) {
-    desmos.updateSettings(settings);
-  }
+	if (settings != undefined) {
+		desmos.updateSettings(settings);
+	}
 
-  desmos_instances.push(desmos);
-  compile(desmos, source, options);
+	desmos_instances.push(desmos);
+	compile(desmos, source, options);
 }
 
 </script>
 
 
 <div bind:this={root} style:display="contents">
-  {@render children?.()}
+	{@render children?.()}
 </div>

package/dist/magic/expr/index.d.ts

@@ -1,3 +0,0 @@
-import { ArgIncantation, type EXPR } from "../incantation.js";
-export declare const EXPR_INCANTATIONS: ArgIncantation<EXPR>[];
-//# sourceMappingURL=index.d.ts.map

package/dist/magic/expr/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/magic/expr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAM3D,eAAO,MAAM,iBAAiB,EAAE,cAAc,CAAC,IAAI,CAAC,EAInD,CAAC"}

package/dist/magic/global/dark-mode.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dark-mode.d.ts","sourceRoot":"","sources":["../../../src/magic/global/dark-mode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAG1D,qBAAa,mBAAoB,SAAQ,WAAW,CAAC,MAAM,CAAC;IAE3D,SAAkB,WAAW,qEACuC;IAEpE,SAAkB,UAAU,UAAS;IAErC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU;CAI/B"}

package/dist/magic/global/dark-mode.js

@@ -1,9 +0,0 @@
-import { Incantation } from "../incantation.js";
-export class DarkModeIncantation extends Incantation {
-    description = "Enable dark mode for the calculator, which inverts all colours.";
-    identifier = "dark";
-    apply(target) {
-        target.updateSettings({ invertedColors: true });
-    }
-}
-//# sourceMappingURL=dark-mode.js.map

package/dist/magic/global/dark-mode.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"dark-mode.js","sourceRoot":"","sources":["../../../src/magic/global/dark-mode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,MAAM,gBAAgB,CAAC;AAG1D,MAAM,OAAO,mBAAoB,SAAQ,WAAmB;IAEzC,WAAW,GAC1B,iEAAiE,CAAA;IAElD,UAAU,GAAG,MAAM,CAAA;IAErC,KAAK,CAAC,MAAyB;QAE9B,MAAM,CAAC,cAAc,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;CACD"}

package/src/magic/global/dark-mode.ts

@@ -1,15 +0,0 @@
-import { Incantation, type GLOBAL } from "../incantation";
-
-
-export class DarkModeIncantation extends Incantation<GLOBAL>
-{
-	override readonly description
-		= "Enable dark mode for the calculator, which inverts all colours."
-	
-	override readonly identifier = "dark"
-
-	apply(target: Desmos.Calculator)
-	{
-		target.updateSettings({ invertedColors: true });
-	}
-}