tarsec 0.0.11 → 0.0.13

package/dist/combinators/seq.d.ts

@@ -1,2 +1 @@
-import { GeneralParser, MergedResults, MergedCaptures, Parser } from "@/lib/types";
-export declare function seq<const T extends readonly GeneralParser<any, any>[], U>(parsers: T, transform: (results: MergedResults<T>[], captures: MergedCaptures<T>) => U, debugName?: string): Parser<U>;
+export {};

package/dist/combinators/seq.js

@@ -4,120 +4,9 @@
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "@/lib/trace", "@/lib/types", "@/lib/utils"], factory);
+        define(["require", "exports"], factory);
     }
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.seq = void 0;
-    const trace_1 = require("@/lib/trace");
-    const types_1 = require("@/lib/types");
-    const utils_1 = require("@/lib/utils");
-    /*
-    To add backtracking support requires a fairly big change. Here's an example that needs backtracking.
-    
-    ```ts
-      const parser = seq([
-            str("hello "),
-            or([str("world"), str("world!")]),
-            optional("?")
-        ], getResults);
-    ```
-    
-    If we try to parse `"hello world!"`, the first parser in the OR will succeed, but then we'll get stuck at the `optional`. Instead, we need to go back up the tree and try the second parser in the OR. A few things need to happen.
-    
-    1. instead of just processing these parsers sequentially in a for loop, we need to model them as a tree
-    2. the OR parser needs to let us know that there are other branches to try.
-    
-    For #2, there's an optional `nextParser` key on a parser success. The or parser can use this to say "a parser succeeded and here's the result, but there are other parsers that could be tried". `nextParser` is a parser that runs the remaining branches. So in this example, the OR would return a success with `nextParser = or([str("world")])`.
-    
-    Next, we need to model this as a tree. Each node in the tree has a parent and child and the parser for that node.
-    
-    ```ts
-      parent: Node;
-      parser: GeneralParser<any, any> | null;
-      child: Node;
-    ```
-    
-    Hopefully that is self-explanatory. We start at the root of the tree, try the parser there, then use `.child` to go to the next node and so on. We don't model multiple paths as multiple children. To keep the code simple, we do something else.
-    
-    Each node also has a `closed` key. Once we've run the parser for a node, we mark it `closed`. Closed means there are no more branches here. UNLESS, the parser returns a `nextParser`. In that case, we *don't* mark it closed because there are still other options to try. In that case, we also *replace* the parser on that node with nextParser.
-    
-    So, going back to the hello world example, let's say we're stuck at the `optional`:
-    
-    ```ts
-      const parser = seq([
-            str("hello "),
-            or([str("world"), str("world!")]),
-            optional("?")
-        ], getResults);
-    ```
-    
-    We use `.parent` to go back up the tree. We're looking for a node that isn't closed. If we find one, we start again from there. In this case, we'd find an open node at the or with parser `or([str("world")])`. We can restart from there, but there's a bunch of state to reset.
-    
-    1. From the new `or` parser, we need to go to the optional parser. We're doing it all again in the same order. This is one reason why it's easier to model this without multiple children. Otherwise, all the children would have to point to the next level, the next level would have to point to all the children in the previous level, and you'd have multiple parents, which is awful to deal with.
-    
-    2. We have consumed input and added to the results. We need to undo that. At this point, the input is `!`, because we've consumed `hello world`. And the results array is `["hello ", "world"]`. We need to rewind both of those.
-    
-    To do that, I count how many levels up we've gone to find another branch, and just pop that many elements off the results array. So results is now `["hello "]`. The input is trickier. How would I keep track of what the input was when we were at the OR the last time?
-    
-    This is where the final key on a tree node comes in. Nodes also have an optional `input` key.
-    
-    IF a parser succeeds, and
-    IF there's a nextParser,
-    We know we may come back to this node. So we save the current input as `.input` on the node.
-    
-    This approach has some issues. Notably, it doesn't work if you need to backtrack at multiple points in the tree. The test `backtracking-deep.test.ts` shows this.
-    
-    The code is also complex and it would be easy to have bugs in this logic. I wish there was a cleaner solution for rewinding state.
-    */
-    function seq(parsers, transform, debugName = "") {
-        return (0, trace_1.trace)(`seq(${debugName})`, (input) => {
-            const results = [];
-            let rest = input;
-            const captures = {};
-            const rootNode = (0, types_1.createTree)(parsers);
-            let current = rootNode;
-            while (current) {
-                const parser = current.parser;
-                if (!parser) {
-                    console.log({ current, parser, results, captures });
-                    throw new Error("parser is null");
-                }
-                const parsed = parser(rest);
-                current.closed = true;
-                /*       console.log({ parsed }); */
-                if (!parsed.success) {
-                    const [ancestor, count] = (0, utils_1.findAncestorWithNextParser)(current);
-                    if (ancestor) {
-                        current = ancestor;
-                        rest = ancestor.input;
-                        (0, utils_1.popMany)(results, count);
-                        continue;
-                    }
-                    else {
-                        // don't consume input if we're failing
-                        return Object.assign(Object.assign({}, parsed), { rest: input });
-                    }
-                }
-                results.push(parsed.result);
-                if (parsed.nextParser) {
-                    /* console.log("setting next parser", parsed.nextParser); */
-                    current.parser = parsed.nextParser;
-                    current.input = rest;
-                    current.closed = false;
-                }
-                rest = parsed.rest;
-                if ((0, types_1.isCaptureResult)(parsed)) {
-                    for (const key in parsed.captures) {
-                        captures[key] = parsed.captures[key];
-                    }
-                }
-                current = current.child;
-            }
-            const result = transform(results, captures);
-            return (0, types_1.success)(result, rest);
-        });
-    }
-    exports.seq = seq;
 });

package/dist/combinators.d.ts

@@ -1,7 +1,25 @@
-export { seq } from "./combinators/seq";
-import { CaptureParser, MergedResults, Parser, Prettify } from "./types";
-export declare function many<T>(parser: Parser<T>): Parser<T[]>;
-export declare function many1<T>(parser: Parser<T>): Parser<T[]>;
+import { CaptureParser, GeneralParser, InferManyReturnType, MergedCaptures, MergedResults, Parser, PickParserType, PlainObject } from "./types";
+/**
+ * Takes a parser and runs it zero or more times, returning the results as an array.
+ * If the parser is a capture parser, it returns the captures as an array in this form:
+ *
+ * ```ts
+ * { captures: <array of captures> }
+ * ```
+ *
+ * Fails on empty strings
+ * @param parser - parser to run
+ * @returns - parser that runs the given parser zero to many times,
+ * and returns the result as an array
+ */
+export declare function many<const T extends GeneralParser<any, any>>(parser: T): InferManyReturnType<T>;
+/**
+ * Same as `many`, but fails if the parser doesn't match at least once.
+ *
+ * @param parser - parser to run
+ * @returns a parser that runs the given parser one to many times,
+ */
+export declare function many1<const T extends GeneralParser<any, any>>(parser: T): InferManyReturnType<T>;
 /**
  * Takes a parser, runs it n times, and returns the results as an array.
  * If it cannot run the parser n times, it fails without consuming input.
@@ -10,15 +28,124 @@ export declare function many1<T>(parser: Parser<T>): Parser<T[]>;
  * @returns - parser that runs the given parser `num` times and returns an array of the results
  */
 export declare function count<T>(num: number, parser: Parser<T>): Parser<T[]>;
-export declare function manyWithJoin(parser: Parser<string>): Parser<string>;
+/**
+ * Same as `many`, but joins the results into a single string.
+ *
+ * @param parser - parser to run. The parser must return a string as its result.
+ * @returns - parser that runs the given parser zero to many times,
+ * and returns the result as a single string
+ */
+export declare function manyWithJoin<const T extends GeneralParser<string, any>>(parser: T): GeneralParser<string, any>;
+/**
+ * Same as `many1`, but joins the results into a single string.
+ *
+ * @param parser - parser to run. The parser must return a string as its result.
+ * @returns - parser that runs the given parser one to many times,
+ * and returns the result as a single string
+ */
 export declare function many1WithJoin(parser: Parser<string>): Parser<string>;
-export declare function or<const T extends readonly Parser<any>[]>(parsers: T, name?: string): Parser<MergedResults<T>>;
+/**
+ * `or` takes an array of parsers and runs them sequentially.
+ * It returns the results of the first parser that succeeds.
+ * You can use `capture` in an `or`:
+ *
+ * ```ts
+ * const parser = or(capture(digit, "num"), capture(word, "name"));
+ * ```
+ *
+ * `or` supports backtracking by returning a `nextParser`:
+ *
+ * ```ts
+ * const parser = or(str("hello"), str("hello!"));
+ *
+ * // this will match the first parser
+ * const result = parser("hello");
+ *
+ * // but or returns the untried parsers as a new parser
+ * result.nextParser("hello!"); // works
+ *
+ * // result.nextParser is the same as or(str("hello!"))
+ * ```
+ *
+ * @param parsers - parsers to try
+ * @returns - a parser that tries each parser in order. Returns the result of the first parser that succeeds.
+ */
+export declare function or<const T extends readonly GeneralParser<any, any>[]>(...parsers: T): PickParserType<T>;
+/**
+ * Takes a parser and runs it. If the parser fails,
+ * optional returns a success with a null result.
+ *
+ * @param parser - parser to run
+ * @returns - a parser that runs the given parser.
+ * If it fails, returns a success with a null result.
+ */
 export declare function optional<T>(parser: Parser<T>): Parser<T | null>;
+/**
+ * Takes a parser and runs it. If the parser fails,
+ * `not` returns a success with a `null` result.
+ * If the parser succeeds, `not` returns a failure.
+ *
+ * @param parser - parser to run
+ * @returns - a parser that runs the given parser.
+ * If it fails, returns a success with a `null` result.
+ * If it succeeds, returns a failure.
+ */
 export declare function not(parser: Parser<any>): Parser<null>;
+/**
+ * Takes three parsers, `open`, `close`, and `parser`.
+ * `between` matches something that matches `parser`,
+ * surrounded by `open` and `close`. It returns the result of `parser`.
+ * If any of the parsers fail, `between` fails.
+ *
+ * @param open - parser for the opening delimiter
+ * @param close - parser for the closing delimiter
+ * @param parser - parser for the content
+ * @returns a parser that returns the result of `parser`.
+ */
 export declare function between<O, C, P>(open: Parser<O>, close: Parser<C>, parser: Parser<P>): Parser<P>;
 export declare function sepBy<S, P>(separator: Parser<S>, parser: Parser<P>): Parser<P[]>;
 export declare function getResults<R, C>(results: R, captures: C): R;
 export declare function getCaptures<R, C>(results: R, captures: C): C;
 export declare function capture<T, const S extends string>(parser: Parser<T>, name: S): CaptureParser<T, Record<S, T>>;
-export declare function wrap<T, const S extends string>(parser: Parser<T>, name: S): Parser<Prettify<Record<S, T>>>;
-export declare function transform<T, X>(parser: Parser<T>, transformerFunc: (x: T) => X): Parser<X>;
+/**
+ * Returns a parser that consumes input till the given parser succeeds.
+ * @param parser - the stop parser
+ * @returns a parser that consumes the input string until the stop parser succeeds.
+ * Then it returns the consumed input as a string.
+ * The stop parser's match is not included in the result.
+ */
+export declare function manyTill<T>(parser: Parser<T>): Parser<string>;
+export declare function many1Till<T>(parser: Parser<T>): Parser<string>;
+export declare function manyTillStr(str: string): Parser<string>;
+export declare function transform<R, C extends PlainObject, X>(parser: GeneralParser<R, C>, transformerFunc: (x: R) => X): GeneralParser<X, C>;
+export declare function search(parser: Parser<string>): Parser<string[]>;
+/**
+ * seq takes an array of parsers and runs them sequentially.
+ * If any of the parsers fail, seq fails without consuming any input.
+ *
+ * The second argument to seq is a function.
+ * The first argument of that function is an array of results:
+ * one result from each of the parsers you gave to seq.
+ * The second is an object containing any captures.
+ * You can use this second argument, the transformer function,
+ * to transform these however you want and return a result
+ *
+ * Tarsec includes the utility functions `getResults` and `getCaptures`
+ * to just return the results array or captures object respectively for you.
+ *
+ * Finally, you don't need to use seq at all. You can just hand write the logic.
+ * But you'll need to do the error handling
+ * and pass the remaining input to the next parser yourself.
+ * seq also does some backtracking for you that you will need to do yourself.
+ *
+ * Also see `seqR` and `seqC` for convenience functions that return the results or captures respectively.
+ *
+ * @param parsers - parsers to run sequentially
+ * @param transform - function to transform the results and captures. The params are the results and captures
+ * @param debugName - optional name for trace debugging
+ * @returns
+ */
+export declare function seq<const T extends readonly GeneralParser<any, any>[], U>(parsers: T, transform: (results: MergedResults<T>[], captures: MergedCaptures<T>) => U, debugName?: string): Parser<U>;
+export declare function seqR<const T extends readonly GeneralParser<any, any>[]>(...parsers: T): Parser<MergedResults<T>[]>;
+export declare function seqC<const T extends readonly GeneralParser<any, any>[]>(...parsers: T): Parser<MergedCaptures<T>>;
+export declare function match(input: string, parser: GeneralParser<any, any>): boolean;