@words-lang/parser 0.1.0

package/dist/lexer/token.js

@@ -0,0 +1,250 @@
+"use strict";
+/**
+ * token.ts
+ *
+ * Defines every token type the WORDS lexer can produce, the Token interface
+ * that carries a token's value and source location, and a convenience
+ * constructor for creating tokens in tests and the lexer itself.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenType = void 0;
+exports.token = token;
+// ── Token types ───────────────────────────────────────────────────────────────
+/**
+ * Every token type the WORDS lexer can produce.
+ *
+ * Grouped by category:
+ *   - Top-level construct keywords  (system, module, state, ...)
+ *   - Block keywords                (modules, props, uses, returns, ...)
+ *   - Process / transition keywords (when, enter)
+ *   - Control flow keywords         (if, for, as, is, is not)
+ *   - Primitive types               (tstring, tinteger, ...)
+ *   - Literals                      (string_lit, integer_lit, ...)
+ *   - Identifiers                   (pascal_ident, camel_ident)
+ *   - Punctuation                   ((, ), ,, .)
+ *   - Special                       (comment, newline, eof, unknown)
+ *
+ * Enum values are the string representation of each token — useful for
+ * readable error messages and debug output without a separate lookup table.
+ *
+ * Note on naming conventions: method names, callback prop names, and handler
+ * method names (including names like `switch`, `onLoad`, `onSubmit`) are all
+ * plain camelCase identifiers chosen by the designer. None of them are
+ * reserved keywords in the WORDS language.
+ */
+var TokenType;
+(function (TokenType) {
+    // ── Top-level construct keywords ─────────────────────────────────────────
+    // These keywords open a named construct body at the top level of a file
+    // or inside a module definition.
+    /** `system` — opens the system declaration. Appears exactly once per project. */
+    TokenType["System"] = "system";
+    /**
+     * `module` — opens a module definition body, or appears alone on a line
+     * as an ownership declaration at the top of component files.
+     * e.g. `module AuthModule` (ownership) or `module AuthModule "..." (` (definition)
+     */
+    TokenType["Module"] = "module";
+    /** `process` — opens a process definition inside a module body. */
+    TokenType["Process"] = "process";
+    /** `state` — opens a state definition. */
+    TokenType["State"] = "state";
+    /** `context` — opens a context definition. */
+    TokenType["Context"] = "context";
+    /** `screen` — opens a screen definition, or activates a screen inside a `uses` block. */
+    TokenType["Screen"] = "screen";
+    /**
+     * `view` — opens a view definition, or activates a view inside a `uses` block.
+     * e.g. `view LoginFormSection "..." (` or `view UIModule.LoginForm (`
+     */
+    TokenType["View"] = "view";
+    /** `provider` — opens a provider definition, or activates a provider in a `uses` block. */
+    TokenType["Provider"] = "provider";
+    /**
+     * `adapter` — opens an adapter definition, or activates an adapter in a `uses` block.
+     * e.g. `adapter AuthAdapter.login credentials is state.context`
+     */
+    TokenType["Adapter"] = "adapter";
+    /**
+     * `interface` — opens an interface component definition, activates one in a
+     * `uses` block, or introduces an inline interface block inside a module body.
+     */
+    TokenType["Interface"] = "interface";
+    // ── Block keywords ────────────────────────────────────────────────────────
+    // These keywords open named sub-blocks inside a construct body.
+    /** `modules` — opens the module list inside a system body. */
+    TokenType["Modules"] = "modules";
+    /** `props` — opens the props block inside a view, provider, adapter, or interface. */
+    TokenType["Props"] = "props";
+    /** `uses` — opens the uses block inside a state, screen, view, provider, or interface. */
+    TokenType["Uses"] = "uses";
+    /**
+     * `returns` — appears in two roles:
+     * 1. Opens the returns clause inside a state: `returns AccountCredentials`
+     * 2. Declares the return type of a method: `getProducts returns(list(Product))`
+     */
+    TokenType["Returns"] = "returns";
+    /**
+     * `receives` — opens the receives clause on a state definition.
+     * e.g. `state Unauthenticated receives ?AuthError`
+     */
+    TokenType["Receives"] = "receives";
+    /**
+     * `start` — names the initial state of a module.
+     * e.g. `start Unauthenticated`
+     */
+    TokenType["Start"] = "start";
+    /**
+     * `implements` — opens a cross-module handler implementation block
+     * inside a module body.
+     * e.g. `implements RoutingModule.RouteSwitchHandler (`
+     */
+    TokenType["Implements"] = "implements";
+    // ── Process / transition keywords ────────────────────────────────────────
+    /**
+     * `when` — opens a transition rule inside a process body.
+     * e.g. `when Unauthenticated returns AccountCredentials`
+     */
+    TokenType["When"] = "when";
+    /**
+     * `enter` — names the next state to transition to in a `when` rule
+     * or an `implements` branch.
+     * e.g. `enter StartAuthenticating "The user tries to authenticate"`
+     */
+    TokenType["Enter"] = "enter";
+    // ── Control flow keywords ─────────────────────────────────────────────────
+    /**
+     * `if` — opens a conditional block inside a `uses` block or an
+     * `implements` handler body.
+     * e.g. `if state.context is AccountDeauthenticated (`
+     */
+    TokenType["If"] = "if";
+    /**
+     * `for` — opens an iteration block inside a `uses` block.
+     * e.g. `for state.context.notifications as notification (`
+     */
+    TokenType["For"] = "for";
+    /**
+     * `as` — binds the iteration variable(s) in a `for` block.
+     * For lists: `as notification` — one binding.
+     * For maps:  `as category, products` — two bindings.
+     */
+    TokenType["As"] = "as";
+    /**
+     * `is` — the assignment and equality operator.
+     * As assignment: `type is "warning"`, `path is "/home"`
+     * As comparison: `if state.context is AccountDeauthenticated`
+     * Context determines which role it plays.
+     */
+    TokenType["Is"] = "is";
+    /**
+     * `is not` — the inequality operator, normalised from the two-word
+     * sequence `is not` into a single token during lexing.
+     * e.g. `if state.context is not AccountRecovered`
+     */
+    TokenType["IsNot"] = "is_not";
+    // ── Primitive types ───────────────────────────────────────────────────────
+    // These keywords name the built-in scalar and collection types.
+    /** `string` — text value type. Default: `""` */
+    TokenType["TString"] = "tstring";
+    /** `integer` — whole number type. Default: `0` */
+    TokenType["TInteger"] = "tinteger";
+    /** `float` — decimal number type. Default: `0.0` */
+    TokenType["TFloat"] = "tfloat";
+    /** `boolean` — true/false type. Default: `false` */
+    TokenType["TBoolean"] = "tboolean";
+    /**
+     * `context` — opaque context type used only in the system interface
+     * declaration for `getContext` and `setContext`.
+     */
+    TokenType["TContext"] = "tcontext";
+    /** `list` — ordered collection type. Parameterised: `list(Product)`. Default: `[]` */
+    TokenType["TList"] = "tlist";
+    /** `map` — key-value collection type. Parameterised: `map(string, OrderSummary)`. Default: `{}` */
+    TokenType["TMap"] = "tmap";
+    // ── Literals ──────────────────────────────────────────────────────────────
+    /**
+     * A double-quoted string literal.
+     * The token value includes the surrounding quotes.
+     * e.g. `"The user authenticated successfully"`, `"/home"`
+     */
+    TokenType["StringLit"] = "string_lit";
+    /**
+     * A whole number literal.
+     * e.g. `42`, `5000`, `0`
+     */
+    TokenType["IntegerLit"] = "integer_lit";
+    /**
+     * A decimal number literal.
+     * e.g. `0.0`, `3.14`
+     */
+    TokenType["FloatLit"] = "float_lit";
+    /**
+     * A boolean literal — `true` or `false`.
+     * Lexed as keyword-style tokens with value `"true"` or `"false"`.
+     */
+    TokenType["BooleanLit"] = "boolean_lit";
+    // ── Identifiers ───────────────────────────────────────────────────────────
+    /**
+     * A PascalCase identifier — names a construct (state, context, module, etc.)
+     * or a type reference.
+     * e.g. `AuthModule`, `AccountCredentials`, `LoginScreen`, `Product`
+     */
+    TokenType["PascalIdent"] = "pascal_ident";
+    /**
+     * A camelCase identifier — names a prop, method, argument, or iteration variable.
+     * This includes all designer-chosen names: callback prop names, method names,
+     * and handler method names regardless of what they are called.
+     * e.g. `onSubmit`, `credentials`, `fullName`, `notification`, `switch`, `onLoad`
+     */
+    TokenType["CamelIdent"] = "camel_ident";
+    // ── Punctuation ───────────────────────────────────────────────────────────
+    /** `(` — opens a body block or argument list. */
+    TokenType["LParen"] = "(";
+    /** `)` — closes a body block or argument list. */
+    TokenType["RParen"] = ")";
+    /** `,` — separates entries in a list — props, arguments, context names. */
+    TokenType["Comma"] = ",";
+    /** `.` — separates parts of a qualified name or access expression. */
+    TokenType["Dot"] = ".";
+    /**
+     * `?` — marks an optional type or receives clause.
+     * e.g. `?AuthError`, `?Product`
+     * Always immediately precedes a PascalIdent.
+     */
+    TokenType["Question"] = "?";
+    // ── Special ───────────────────────────────────────────────────────────────
+    /**
+     * A `//` line comment. The token value includes the `//` prefix and
+     * everything up to (but not including) the newline.
+     * Comments are included in the token stream so the parser can attach
+     * them to adjacent nodes for hover documentation.
+     */
+    TokenType["Comment"] = "comment";
+    /**
+     * A newline character `\n`.
+     * Newlines are significant in WORDS for distinguishing an ownership
+     * declaration (`module AuthModule` on its own line) from a construct
+     * opening (`module AuthModule "..." (`).
+     */
+    TokenType["Newline"] = "newline";
+    /**
+     * End of file sentinel. Always the last token in the stream.
+     * The parser uses this to detect unexpected end of input.
+     */
+    TokenType["EOF"] = "eof";
+    /**
+     * An unrecognised character. Emitted rather than throwing so the lexer
+     * can continue and collect all errors in a single pass.
+     */
+    TokenType["Unknown"] = "unknown";
+})(TokenType || (exports.TokenType = TokenType = {}));
+// ── Convenience constructor ───────────────────────────────────────────────────
+/**
+ * Creates a Token with the given fields.
+ * Used internally by the lexer and in tests to avoid repetitive object literals.
+ */
+function token(type, value, line, column, offset) {
+    return { type, value, line, column, offset };
+}
+//# sourceMappingURL=token.js.map

package/dist/lexer/token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.js","sourceRoot":"","sources":["../../src/lexer/token.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AA4TH,sBAQC;AAlUD,iFAAiF;AAEjF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,IAAY,SAoQX;AApQD,WAAY,SAAS;IAEnB,4EAA4E;IAC5E,wEAAwE;IACxE,iCAAiC;IAEjC,iFAAiF;IACjF,8BAAiB,CAAA;IAEjB;;;;OAIG;IACH,8BAAiB,CAAA;IAEjB,mEAAmE;IACnE,gCAAmB,CAAA;IAEnB,0CAA0C;IAC1C,4BAAe,CAAA;IAEf,8CAA8C;IAC9C,gCAAmB,CAAA;IAEnB,yFAAyF;IACzF,8BAAiB,CAAA;IAEjB;;;OAGG;IACH,0BAAa,CAAA;IAEb,2FAA2F;IAC3F,kCAAqB,CAAA;IAErB;;;OAGG;IACH,gCAAmB,CAAA;IAEnB;;;OAGG;IACH,oCAAuB,CAAA;IAEvB,6EAA6E;IAC7E,gEAAgE;IAEhE,8DAA8D;IAC9D,gCAAmB,CAAA;IAEnB,sFAAsF;IACtF,4BAAe,CAAA;IAEf,0FAA0F;IAC1F,0BAAa,CAAA;IAEb;;;;OAIG;IACH,gCAAmB,CAAA;IAEnB;;;OAGG;IACH,kCAAqB,CAAA;IAErB;;;OAGG;IACH,4BAAe,CAAA;IAEf;;;;OAIG;IACH,sCAAyB,CAAA;IAEzB,4EAA4E;IAE5E;;;OAGG;IACH,0BAAa,CAAA;IAEb;;;;OAIG;IACH,4BAAe,CAAA;IAEf,6EAA6E;IAE7E;;;;OAIG;IACH,sBAAS,CAAA;IAET;;;OAGG;IACH,wBAAW,CAAA;IAEX;;;;OAIG;IACH,sBAAS,CAAA;IAET;;;;;OAKG;IACH,sBAAS,CAAA;IAET;;;;OAIG;IACH,6BAAgB,CAAA;IAEhB,6EAA6E;IAC7E,gEAAgE;IAEhE,gDAAgD;IAChD,gCAAmB,CAAA;IAEnB,kDAAkD;IAClD,kCAAqB,CAAA;IAErB,oDAAoD;IACpD,8BAAiB,CAAA;IAEjB,oDAAoD;IACpD,kCAAqB,CAAA;IAErB;;;OAGG;IACH,kCAAqB,CAAA;IAErB,sFAAsF;IACtF,4BAAe,CAAA;IAEf,mGAAmG;IACnG,0BAAa,CAAA;IAEb,6EAA6E;IAE7E;;;;OAIG;IACH,qCAAwB,CAAA;IAExB;;;OAGG;IACH,uCAA0B,CAAA;IAE1B;;;OAGG;IACH,mCAAsB,CAAA;IAEtB;;;OAGG;IACH,uCAA0B,CAAA;IAE1B,6EAA6E;IAE7E;;;;OAIG;IACH,yCAA4B,CAAA;IAE5B;;;;;OAKG;IACH,uCAA0B,CAAA;IAE1B,6EAA6E;IAE7E,iDAAiD;IACjD,yBAAY,CAAA;IAEZ,kDAAkD;IAClD,yBAAY,CAAA;IAEZ,2EAA2E;IAC3E,wBAAW,CAAA;IAEX,sEAAsE;IACtE,sBAAS,CAAA;IAET;;;;OAIG;IACH,2BAAc,CAAA;IAEd,6EAA6E;IAE7E;;;;;OAKG;IACH,gCAAmB,CAAA;IAEnB;;;;;OAKG;IACH,gCAAmB,CAAA;IAEnB;;;OAGG;IACH,wBAAW,CAAA;IAEX;;;OAGG;IACH,gCAAmB,CAAA;AACrB,CAAC,EApQW,SAAS,yBAAT,SAAS,QAoQpB;AAwBD,iFAAiF;AAEjF;;;GAGG;AACH,SAAgB,KAAK,CACnB,IAAe,EACf,KAAa,EACb,IAAY,EACZ,MAAc,EACd,MAAc;IAEd,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;AAC9C,CAAC"}