@rpgm-tools/neo-angband-core 0.10.0

package/dist/expression.js

@@ -0,0 +1,333 @@
+/**
+ * Simple math expressions, ported from reference/src/z-expression.c/h
+ * (Angband 4.2.6).
+ *
+ * An expression is a base value function plus a list of (operator, operand)
+ * operations applied to an accumulator strictly left to right; there is NO
+ * operator precedence. The string form is prefix/space-delimited and must
+ * start with an operator: "+ 1 2 3" means ((base + 1) + 2) + 3 and
+ * "+ 2 * 3" means (base + 2) * 3. An operator with multiple following
+ * operands is applied once per operand; negation ("n" or "N") is unary and
+ * takes no operand.
+ *
+ * Number tokens are parsed with C strtol(str, &end, 0) semantics: base is
+ * auto-detected, so "0x1A" is hex and "017" is OCTAL (15). Any token where
+ * strtol consumes at least one character is treated as a value, even with
+ * trailing junk ("5abc" is the value 5). Operands must fit in int16
+ * (-32768..32767). Arithmetic is C int32: wrap on add/sub/mul, truncation
+ * toward zero on division.
+ *
+ * Parsing appends at most EXPRESSION_MAX_OPERATIONS (50) operations per
+ * call and silently drops the rest, as upstream. On a parse error nothing
+ * is appended and the (negative) error code is returned.
+ */
+export const EXPRESSION_ERR_GENERIC = -1;
+export const EXPRESSION_ERR_INVALID_OPERATOR = -2;
+export const EXPRESSION_ERR_EXPECTED_OPERATOR = -3;
+export const EXPRESSION_ERR_EXPECTED_OPERAND = -4;
+export const EXPRESSION_ERR_DIVIDE_BY_ZERO = -5;
+export const EXPRESSION_ERR_OPERAND_OUT_OF_BOUNDS = -6;
+/** Operator types (expression_operator_t). */
+const OPERATOR_NONE = 0;
+const OPERATOR_ADD = 1;
+const OPERATOR_SUB = 2;
+const OPERATOR_MUL = 3;
+const OPERATOR_DIV = 4;
+const OPERATOR_NEG = 5;
+/** Parser states (expression_state_t). */
+const STATE_START = 0;
+const STATE_OPERATOR = 1;
+const STATE_OPERAND = 2;
+/** Parser input types (expression_input_t). */
+const INPUT_INVALID = 0;
+const INPUT_NEEDS_OPERANDS = 1;
+const INPUT_UNARY_OPERATOR = 2;
+const INPUT_VALUE = 3;
+/** Allocation block size for the operations array (bookkeeping only). */
+const EXPRESSION_ALLOC_SIZE = 5;
+/** Maximum number of operations added by one parse call. */
+export const EXPRESSION_MAX_OPERATIONS = 50;
+/**
+ * The parser state table, transcribed from z-expression.c. Cells hold the
+ * next state, or a negative expression error code.
+ */
+const STATE_TABLE = [
+    // STATE_START
+    [
+        EXPRESSION_ERR_INVALID_OPERATOR,
+        STATE_OPERATOR,
+        STATE_START,
+        EXPRESSION_ERR_EXPECTED_OPERATOR,
+    ],
+    // STATE_OPERATOR (found operator)
+    [
+        EXPRESSION_ERR_INVALID_OPERATOR,
+        EXPRESSION_ERR_EXPECTED_OPERAND,
+        EXPRESSION_ERR_EXPECTED_OPERAND,
+        STATE_OPERAND,
+    ],
+    // STATE_OPERAND (found one operand)
+    [
+        EXPRESSION_ERR_INVALID_OPERATOR,
+        STATE_OPERATOR,
+        STATE_START,
+        STATE_OPERAND,
+    ],
+];
+const C_SPACE = " \t\n\v\f\r";
+function digitValue(ch, base) {
+    let v;
+    if (ch >= "0" && ch <= "9")
+        v = ch.charCodeAt(0) - 0x30;
+    else if (ch >= "a" && ch <= "z")
+        v = ch.charCodeAt(0) - 0x61 + 10;
+    else if (ch >= "A" && ch <= "Z")
+        v = ch.charCodeAt(0) - 0x41 + 10;
+    else
+        return -1;
+    return v < base ? v : -1;
+}
+/**
+ * C strtol(nptr, &endptr, 0) replica used by the expression and dice
+ * parsers: optional whitespace, optional sign, then auto-detected base
+ * ("0x"/"0X" prefix is hex, leading "0" is octal, otherwise decimal).
+ * Returns the parsed value and the number of characters consumed; consumed
+ * is 0 when no digits were found (endptr == nptr upstream). Long-overflow
+ * saturation is not replicated (tokens here are at most 16 chars).
+ */
+export function strtolBase0(s) {
+    let i = 0;
+    while (i < s.length && C_SPACE.includes(s[i]))
+        i++;
+    let sign = 1;
+    if (s[i] === "+" || s[i] === "-") {
+        if (s[i] === "-")
+            sign = -1;
+        i++;
+    }
+    let base = 10;
+    if (s[i] === "0") {
+        if ((s[i + 1] === "x" || s[i + 1] === "X") &&
+            i + 2 < s.length &&
+            digitValue(s[i + 2], 16) >= 0) {
+            base = 16;
+            i += 2;
+        }
+        else {
+            base = 8;
+        }
+    }
+    let value = 0;
+    let any = false;
+    while (i < s.length) {
+        const d = digitValue(s[i], base);
+        if (d < 0)
+            break;
+        value = value * base + d;
+        any = true;
+        i++;
+    }
+    if (!any)
+        return { value: 0, consumed: 0 };
+    return { value: sign * value, consumed: i };
+}
+/** expression_operator_from_token. */
+function operatorFromToken(token) {
+    let result;
+    switch (token[0]) {
+        case "+":
+            result = OPERATOR_ADD;
+            break;
+        case "-":
+            result = OPERATOR_SUB;
+            break;
+        case "*":
+            result = OPERATOR_MUL;
+            break;
+        case "/":
+            result = OPERATOR_DIV;
+            break;
+        case "n":
+        case "N":
+            result = OPERATOR_NEG;
+            break;
+        default:
+            return OPERATOR_NONE;
+    }
+    /* Reject if there is additional junk in the token after the operator. */
+    return token.length > 1 ? OPERATOR_NONE : result;
+}
+/** expression_input_for_operator. */
+function inputForOperator(operator) {
+    switch (operator) {
+        case OPERATOR_ADD:
+        case OPERATOR_SUB:
+        case OPERATOR_MUL:
+        case OPERATOR_DIV:
+            return INPUT_NEEDS_OPERANDS;
+        case OPERATOR_NEG:
+            return INPUT_UNARY_OPERATOR;
+        default:
+            return INPUT_INVALID;
+    }
+}
+/**
+ * expression_t. Construction is expression_new; there is no expression_free
+ * (garbage collected). operationsSize mirrors the upstream capacity
+ * bookkeeping so expressionTestCopy can compare it faithfully.
+ */
+export class Expression {
+    baseValue = null;
+    operations = [];
+    operationsSize = EXPRESSION_ALLOC_SIZE;
+    /** expression_copy: a deep copy sharing the base value function. */
+    copy() {
+        const copy = new Expression();
+        copy.baseValue = this.baseValue;
+        copy.operationsSize = this.operationsSize;
+        copy.operations = this.operations.map((op) => ({ ...op }));
+        return copy;
+    }
+    /** expression_set_base_value. */
+    setBaseValue(fn) {
+        this.baseValue = fn;
+    }
+    /**
+     * expression_evaluate: applies the operations left to right with C int32
+     * semantics. With no base value function, evaluation starts from zero.
+     */
+    evaluate() {
+        let value = 0;
+        if (this.baseValue !== null)
+            value = this.baseValue() | 0;
+        for (const op of this.operations) {
+            switch (op.operator) {
+                case OPERATOR_ADD:
+                    value = (value + op.operand) | 0;
+                    break;
+                case OPERATOR_SUB:
+                    value = (value - op.operand) | 0;
+                    break;
+                case OPERATOR_MUL:
+                    value = Math.imul(value, op.operand);
+                    break;
+                case OPERATOR_DIV:
+                    value = Math.trunc(value / op.operand) | 0;
+                    break;
+                case OPERATOR_NEG:
+                    value = -value | 0;
+                    break;
+                default:
+                    break;
+            }
+        }
+        return value;
+    }
+    /** expression_add_operation, including the capacity bookkeeping. */
+    addOperation(operation) {
+        if (this.operations.length >= this.operationsSize) {
+            this.operationsSize += EXPRESSION_ALLOC_SIZE;
+        }
+        this.operations.push(operation);
+    }
+    /**
+     * expression_add_operations_string: parses a prefix-notation string and
+     * appends its operations. Returns the number of operations added, or a
+     * negative expression error code (in which case nothing is appended).
+     * The upstream NULL string case maps to null/undefined.
+     */
+    addOperationsString(str) {
+        if (str === null || str === undefined)
+            return EXPRESSION_ERR_GENERIC;
+        /* Empty string is an identity operation. */
+        if (str === "")
+            return 0;
+        const pending = [];
+        let count = 0;
+        let parsedOperator = OPERATOR_NONE;
+        let currentOperator = OPERATOR_NONE;
+        let state = STATE_START;
+        /* strtok with a single-space delimiter set. */
+        const tokens = str.split(" ").filter((t) => t.length > 0);
+        for (const token of tokens) {
+            const { value, consumed } = strtolBase0(token);
+            if (consumed === 0) {
+                parsedOperator = operatorFromToken(token);
+                const input = inputForOperator(parsedOperator);
+                state = STATE_TABLE[state][input];
+            }
+            else {
+                state = STATE_TABLE[state][INPUT_VALUE];
+            }
+            /* Perform actions based on the new state. */
+            if (state < STATE_START) {
+                /* An error occurred, according to the state table. */
+                return state;
+            }
+            else if (state === STATE_START) {
+                /* Flush the operation for a unary operator. */
+                pending.push({ operator: parsedOperator, operand: 0 });
+                count++;
+            }
+            else if (state === STATE_OPERATOR) {
+                /* Remember the operator, since it needs operands. */
+                currentOperator = parsedOperator;
+            }
+            else if (state === STATE_OPERAND) {
+                if (value < -32768 || value > 32767) {
+                    return EXPRESSION_ERR_OPERAND_OUT_OF_BOUNDS;
+                }
+                /* Try to catch divide by zero. */
+                if (currentOperator === OPERATOR_DIV && value === 0) {
+                    return EXPRESSION_ERR_DIVIDE_BY_ZERO;
+                }
+                /* Flush the operator and operand pair. */
+                pending.push({ operator: currentOperator, operand: value });
+                count++;
+            }
+            /* Limit the number of operations, saving what we have. */
+            if (count >= EXPRESSION_MAX_OPERATIONS)
+                break;
+        }
+        for (const op of pending)
+            this.addOperation(op);
+        return count;
+    }
+    /** Internal snapshot for expressionTestCopy. */
+    snapshot() {
+        return {
+            baseValue: this.baseValue,
+            operations: this.operations,
+            operationsSize: this.operationsSize,
+        };
+    }
+    /**
+     * expression_test_copy: checks that b is a value-equal deep copy of a
+     * (distinct objects, same base value function, same operations).
+     */
+    static testCopy(a, b) {
+        if (a === null || b === null)
+            return false;
+        const sa = a.snapshot();
+        const sb = b.snapshot();
+        let success = a !== b;
+        success &&= sa.baseValue === sb.baseValue;
+        success &&= sa.operations.length === sb.operations.length;
+        success &&= sa.operationsSize === sb.operationsSize;
+        success &&= sa.operations !== sb.operations;
+        if (sa.operations.length !== sb.operations.length)
+            return false;
+        for (let i = 0; i < sa.operations.length; i++) {
+            const opA = sa.operations[i];
+            const opB = sb.operations[i];
+            success &&= opA.operand === opB.operand;
+            success &&= opA.operator === opB.operator;
+        }
+        return success;
+    }
+}
+/** Function-style alias for upstream expression_test_copy. */
+export function expressionTestCopy(a, b) {
+    return Expression.testCopy(a, b);
+}
+//# sourceMappingURL=expression.js.map

package/dist/expression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expression.js","sourceRoot":"","sources":["../src/expression.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,CAAC;AACzC,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,CAAC;AAClD,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,CAAC;AACnD,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,CAAC;AAClD,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,CAAC;AAChD,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,CAAC;AAUvD,8CAA8C;AAC9C,MAAM,aAAa,GAAG,CAAC,CAAC;AACxB,MAAM,YAAY,GAAG,CAAC,CAAC;AACvB,MAAM,YAAY,GAAG,CAAC,CAAC;AACvB,MAAM,YAAY,GAAG,CAAC,CAAC;AACvB,MAAM,YAAY,GAAG,CAAC,CAAC;AACvB,MAAM,YAAY,GAAG,CAAC,CAAC;AAEvB,0CAA0C;AAC1C,MAAM,WAAW,GAAG,CAAC,CAAC;AACtB,MAAM,cAAc,GAAG,CAAC,CAAC;AACzB,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB,+CAA+C;AAC/C,MAAM,aAAa,GAAG,CAAC,CAAC;AACxB,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B,MAAM,WAAW,GAAG,CAAC,CAAC;AAEtB,yEAAyE;AACzE,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAEhC,4DAA4D;AAC5D,MAAM,CAAC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,GAAmC;IAClD,cAAc;IACd;QACE,+BAA+B;QAC/B,cAAc;QACd,WAAW;QACX,gCAAgC;KACjC;IACD,kCAAkC;IAClC;QACE,+BAA+B;QAC/B,+BAA+B;QAC/B,+BAA+B;QAC/B,aAAa;KACd;IACD,oCAAoC;IACpC;QACE,+BAA+B;QAC/B,cAAc;QACd,WAAW;QACX,aAAa;KACd;CACF,CAAC;AAEF,MAAM,OAAO,GAAG,aAAa,CAAC;AAE9B,SAAS,UAAU,CAAC,EAAU,EAAE,IAAY;IAC1C,IAAI,CAAS,CAAC;IACd,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG;QAAE,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;SACnD,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG;QAAE,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC;SAC7D,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG;QAAE,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC;;QAC7D,OAAO,CAAC,CAAC,CAAC;IACf,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,CAAS;IACnC,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC;QAAE,CAAC,EAAE,CAAC;IAC7D,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACjC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG;YAAE,IAAI,GAAG,CAAC,CAAC,CAAC;QAC5B,CAAC,EAAE,CAAC;IACN,CAAC;IACD,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACjB,IACE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC;YACtC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM;YAChB,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAW,EAAE,EAAE,CAAC,IAAI,CAAC,EACvC,CAAC;YACD,IAAI,GAAG,EAAE,CAAC;YACV,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAW,EAAE,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,GAAG,CAAC;YAAE,MAAM;QACjB,KAAK,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC;QACzB,GAAG,GAAG,IAAI,CAAC;QACX,CAAC,EAAE,CAAC;IACN,CAAC;IACD,IAAI,CAAC,GAAG;QAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAC3C,OAAO,EAAE,KAAK,EAAE,IAAI,GAAG,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;AAC9C,CAAC;AAED,sCAAsC;AACtC,SAAS,iBAAiB,CAAC,KAAa;IACtC,IAAI,MAAc,CAAC;IACnB,QAAQ,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACjB,KAAK,GAAG;YACN,MAAM,GAAG,YAAY,CAAC;YACtB,MAAM;QACR,KAAK,GAAG;YACN,MAAM,GAAG,YAAY,CAAC;YACtB,MAAM;QACR,KAAK,GAAG;YACN,MAAM,GAAG,YAAY,CAAC;YACtB,MAAM;QACR,KAAK,GAAG;YACN,MAAM,GAAG,YAAY,CAAC;YACtB,MAAM;QACR,KAAK,GAAG,CAAC;QACT,KAAK,GAAG;YACN,MAAM,GAAG,YAAY,CAAC;YACtB,MAAM;QACR;YACE,OAAO,aAAa,CAAC;IACzB,CAAC;IACD,yEAAyE;IACzE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC;AACnD,CAAC;AAED,qCAAqC;AACrC,SAAS,gBAAgB,CAAC,QAAgB;IACxC,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,YAAY,CAAC;QAClB,KAAK,YAAY,CAAC;QAClB,KAAK,YAAY,CAAC;QAClB,KAAK,YAAY;YACf,OAAO,oBAAoB,CAAC;QAC9B,KAAK,YAAY;YACf,OAAO,oBAAoB,CAAC;QAC9B;YACE,OAAO,aAAa,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,UAAU;IACb,SAAS,GAA+B,IAAI,CAAC;IAC7C,UAAU,GAA0B,EAAE,CAAC;IACvC,cAAc,GAAG,qBAAqB,CAAC;IAE/C,oEAAoE;IACpE,IAAI;QACF,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iCAAiC;IACjC,YAAY,CAAC,EAAuB;QAClC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAC1D,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACjC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;gBACpB,KAAK,YAAY;oBACf,KAAK,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;oBACjC,MAAM;gBACR,KAAK,YAAY;oBACf,KAAK,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;oBACjC,MAAM;gBACR,KAAK,YAAY;oBACf,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;oBACrC,MAAM;gBACR,KAAK,YAAY;oBACf,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;oBAC3C,MAAM;gBACR,KAAK,YAAY;oBACf,KAAK,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC;oBACnB,MAAM;gBACR;oBACE,MAAM;YACV,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,oEAAoE;IAC5D,YAAY,CAAC,SAA8B;QACjD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAClD,IAAI,CAAC,cAAc,IAAI,qBAAqB,CAAC;QAC/C,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,GAA8B;QAChD,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS;YAAE,OAAO,sBAAsB,CAAC;QAErE,4CAA4C;QAC5C,IAAI,GAAG,KAAK,EAAE;YAAE,OAAO,CAAC,CAAC;QAEzB,MAAM,OAAO,GAA0B,EAAE,CAAC;QAC1C,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,cAAc,GAAG,aAAa,CAAC;QACnC,IAAI,eAAe,GAAG,aAAa,CAAC;QACpC,IAAI,KAAK,GAAG,WAAW,CAAC;QAExB,+CAA+C;QAC/C,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE1D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;YAE/C,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;gBACnB,cAAc,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;gBAC1C,MAAM,KAAK,GAAG,gBAAgB,CAAC,cAAc,CAAC,CAAC;gBAC/C,KAAK,GAAI,WAAW,CAAC,KAAK,CAAuB,CAAC,KAAK,CAAW,CAAC;YACrE,CAAC;iBAAM,CAAC;gBACN,KAAK,GAAI,WAAW,CAAC,KAAK,CAAuB,CAC/C,WAAW,CACF,CAAC;YACd,CAAC;YAED,6CAA6C;YAC7C,IAAI,KAAK,GAAG,WAAW,EAAE,CAAC;gBACxB,sDAAsD;gBACtD,OAAO,KAAK,CAAC;YACf,CAAC;iBAAM,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;gBACjC,+CAA+C;gBAC/C,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;gBACvD,KAAK,EAAE,CAAC;YACV,CAAC;iBAAM,IAAI,KAAK,KAAK,cAAc,EAAE,CAAC;gBACpC,qDAAqD;gBACrD,eAAe,GAAG,cAAc,CAAC;YACnC,CAAC;iBAAM,IAAI,KAAK,KAAK,aAAa,EAAE,CAAC;gBACnC,IAAI,KAAK,GAAG,CAAC,KAAK,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC;oBACpC,OAAO,oCAAoC,CAAC;gBAC9C,CAAC;gBACD,kCAAkC;gBAClC,IAAI,eAAe,KAAK,YAAY,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBACpD,OAAO,6BAA6B,CAAC;gBACvC,CAAC;gBACD,0CAA0C;gBAC1C,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC5D,KAAK,EAAE,CAAC;YACV,CAAC;YAED,0DAA0D;YAC1D,IAAI,KAAK,IAAI,yBAAyB;gBAAE,MAAM;QAChD,CAAC;QAED,KAAK,MAAM,EAAE,IAAI,OAAO;YAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gDAAgD;IACxC,QAAQ;QAKd,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAoB,EAAE,CAAoB;QACxD,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAC3C,MAAM,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;QACxB,MAAM,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;QACxB,IAAI,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC;QACtB,OAAO,KAAK,EAAE,CAAC,SAAS,KAAK,EAAE,CAAC,SAAS,CAAC;QAC1C,OAAO,KAAK,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1D,OAAO,KAAK,EAAE,CAAC,cAAc,KAAK,EAAE,CAAC,cAAc,CAAC;QACpD,OAAO,KAAK,EAAE,CAAC,UAAU,KAAK,EAAE,CAAC,UAAU,CAAC;QAC5C,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,EAAE,CAAC,UAAU,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAChE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9C,MAAM,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAwB,CAAC;YACpD,MAAM,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAwB,CAAC;YACpD,OAAO,KAAK,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,CAAC;YACxC,OAAO,KAAK,GAAG,CAAC,QAAQ,KAAK,GAAG,CAAC,QAAQ,CAAC;QAC5C,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAED,8DAA8D;AAC9D,MAAM,UAAU,kBAAkB,CAChC,CAAoB,EACpB,CAAoB;IAEpB,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACnC,CAAC"}

package/dist/game/cave-cmd.d.ts

@@ -0,0 +1,195 @@
+/**
+ * Cave commands, ported from reference/src/cmd-cave.c (Angband 4.2.6):
+ * opening and closing doors, tunneling (with the calc_digging_chances
+ * player math and rubble / gold-vein payouts onto the live floor piles),
+ * chest open/disarm branches (do_cmd_open / do_cmd_disarm, gap #49), the
+ * alter dispatcher, and the stair commands with their terrain checks.
+ *
+ * Door LOCKS are traps upstream (the "door lock" trap kind holds the
+ * power), so locked-door handling rides on the isLockedDoor / pickLock
+ * seams until trap.c lands (#21) - shipped levels place plain closed
+ * doors, which open exactly as upstream. square_isknown gating is
+ * knowledge (#24): everything is known here, matching the current FOV
+ * front end.
+ *
+ * Chests (game/chest.ts) plug in via the optional `chestDeps`; open gains
+ * a chest branch (chest_check(CHEST_OPENABLE) before the door test), and a
+ * new "disarm" action is registered that tries chest_check(CHEST_TRAPPED)
+ * first and falls through to whatever "disarm" action was already
+ * registered (the sibling floor-trap disarm, trap.ts #21) otherwise -
+ * merging rather than double-registering, since a stub or the real
+ * trap-disarm action is always present by the time this installs.
+ *
+ * NOW PORTED (was deferred): the swap-digger machinery (player_best_digger,
+ * player/best-digger.ts, temporarily wields the pack's best digger and
+ * recomputes DIGGING via state.bestDiggerDigging - RNG-free, input-only to the
+ * dig roll) feeds tunnelAux; and do_cmd_lock_door (the door-lock branch of
+ * do_cmd_disarm plus a dedicated "lock" action) with the exact m_bonus /
+ * randint0(100) / randint1(i) RNG order, riding the trap.c door-lock seams
+ * (state.setDoorLock / env.isLockedDoor).
+ *
+ * count_feats direction inference is NOW PORTED (countFeats below, consumed by
+ * the shell's open / close / disarm commands): it is unconditional in 4.2.6 --
+ * the old easy_open option no longer exists -- so deferring it as "UI" changed
+ * the keystrokes ordinary play requires on every door and trap.
+ *
+ * DEFERRED (ledgered in game-cave-cmd.yaml): do_cmd_steal (shapechange #22) and
+ * command repetition. Running and travel / explore (player-path #24) are ported
+ * in game/player-path.ts.
+ */
+import type { Loc } from "../loc.js";
+import type { MakeDeps } from "../obj/make.js";
+import type { ChestCmdDeps } from "./chest.js";
+import type { GameState } from "./context.js";
+import type { ActionRegistry } from "./player-turn.js";
+import { type TrapDeps } from "./trap.js";
+/** Hooks for messages and unported subsystems; all optional. */
+export interface CaveCmdEnv {
+    msg?: (text: string) => void;
+    /** square_islockeddoor: door locks are traps (#21). Default false. */
+    isLockedDoor?: (grid: Loc) => boolean;
+    /**
+     * The unlock attempt for a locked door (calc_unlocking_chance +
+     * square_open_door's lock removal, #21). Returns whether it opened.
+     */
+    pickLock?: (grid: Loc) => boolean;
+    /**
+     * player_is_trapsafe (player-util.c:1073-1077): skip disarm-on-walk when
+     * true (cmd-cave.c:1311-1312). Default: trap.ts playerIsTrapsafe (timed +
+     * derived/equipment OF_TRAP_IMMUNE). Override only for tests.
+     */
+    isTrapsafe?: (state: GameState) => boolean;
+    /**
+     * get_check: do_cmd_go_down's force_descend quest warning
+     * (cmd-cave.c:126). Default yes - an unprompted terminal auto-accepts, the
+     * same convention as effect-general.ts's confirm seam.
+     */
+    confirm?: (prompt: string) => boolean;
+    /**
+     * tunnel_aux's `with_clause` (cmd-cave.c:541, :552): "with your hands" with
+     * no weapon, "with your weapon" wielding one, "with your swap digger" when
+     * player_best_digger swapped a better tool in for the roll. Pairs with
+     * state.bestDiggerDigging, which supplies that roll; default "with your
+     * hands" only matters in the worldless harness.
+     */
+    digWithClause?: () => string;
+}
+/** What the cave commands need beyond the state. */
+export interface CaveCmdDeps {
+    /** Object generation deps for rubble finds / gold veins; optional. */
+    makeDeps?: MakeDeps;
+    env?: CaveCmdEnv;
+    /**
+     * Chest deps (gap #49); absent, the open/disarm chest branches are
+     * skipped entirely (doors and floor traps behave exactly as before).
+     */
+    chestDeps?: ChestCmdDeps;
+    /**
+     * Live trap deps for disarm-on-walk (cmd-cave.c:1079-1083). Absent, the
+     * walk wrapper never auto-disarms (step triggers as before).
+     */
+    trapDeps?: TrapDeps;
+}
+/**
+ * display_feeling (cmd-cave.c L1729) via do_cmd_feeling (L1777): re-emit the
+ * current level feeling. `objOnly` reproduces display_feeling(true), the
+ * object-only line shown the moment the object feeling is first discovered;
+ * do_cmd_feeling (^F) calls it with objOnly = false. Cold-hearted characters
+ * (birth_feelings off) get nothing; the town gets the fixed line; a level not
+ * yet explored to feeling_need grids gets only the monster feeling, otherwise
+ * the joined "<mon>, and/yet <obj>" line with the exact conjunction rule.
+ * feelingNeed defaults to the shipped constants.txt world:feeling-need (10),
+ * matching the display-model default (display.ts).
+ */
+export declare function displayFeeling(state: GameState, opts?: {
+    objOnly?: boolean;
+    feelingNeed?: number;
+}): void;
+/**
+ * count_feats (cave.c L644-679): how many of the nine grids around (and
+ * optionally under) the player match `test`, plus the last one matched.
+ *
+ * Two details of the C matter and are easy to get wrong. It requires
+ * `square_isknown` and then tests **the player's memory**, `player->cave`, not
+ * the live map -- so terrain the player has not seen never counts, and
+ * misremembered terrain counts as remembered. And `ddgrid_ddd[8]` is the
+ * player's own grid, which only participates when `under` is set.
+ *
+ * Draws no RNG. The C uses this to auto-select a direction for open, close and
+ * disarm when exactly one adjacent candidate exists (cmd-cave.c L250-260, L409,
+ * L874-876), which is unconditional in 4.2.6 -- the old `easy_open` option no
+ * longer exists.
+ */
+export declare function countFeats(state: GameState, test: (state: GameState, grid: Loc) => boolean, under: boolean): {
+    count: number;
+    grid: Loc | null;
+};
+/**
+ * square_isunlockeddoor (cave-square.c L791-794): a closed door whose lock
+ * power is zero. Locks are traps upstream, so without live trap deps every
+ * closed door reads as unlocked -- which matches shipped levels, where plain
+ * closed doors are what generation places.
+ */
+export declare function squareIsUnlockedDoor(state: GameState, grid: Loc, trapDeps?: TrapDeps): boolean;
+/** square_isopendoor: a door that can be closed (TF CLOSABLE). */
+export declare function squareIsOpenDoor(state: GameState, grid: Loc): boolean;
+/** square_isbrokendoor: passable door that cannot be closed. */
+export declare function squareIsBrokenDoor(state: GameState, grid: Loc): boolean;
+/** square_issecretdoor: a door still disguised as rock. */
+export declare function squareIsSecretDoor(state: GameState, grid: Loc): boolean;
+/** square_isdiggable: mineral, secret door or rubble. */
+export declare function squareIsDiggable(state: GameState, grid: Loc): boolean;
+/** enum digging (player.h): the digging-difficulty classes. */
+export declare const DIGGING: {
+    readonly RUBBLE: 0;
+    readonly MAGMA: 1;
+    readonly QUARTZ: 2;
+    readonly GRANITE: 3;
+    readonly DOORS: 4;
+    readonly MAX: 5;
+};
+/** calc_digging_chances: success chances (out of 1600) by difficulty. */
+export declare function calcDiggingChances(diggingSkill: number): number[];
+/** square_digging: the feature's 1..5 digging class (0 = not diggable). */
+export declare function squareDigging(state: GameState, grid: Loc): number;
+/**
+ * do_cmd_tunnel_aux: one digging attempt. player_best_digger temporarily wields
+ * the pack's best digger and recomputes DIGGING (via state.bestDiggerDigging,
+ * RNG-free) to feed the roll; absent that hook the wielded DIGGING decides.
+ * Returns "may repeat" (a failed dig with hope).
+ *
+ * Exported because a mod handling the walkBlockedByDiggable hook has to be able
+ * to make a REAL dig attempt - the same roll and payouts the tunnel command
+ * makes - rather than reimplement the roll and drift from it. It draws RNG, so a
+ * hook must only call it on a path where it has committed to handling the walk.
+ */
+export declare function tunnelAux(state: GameState, grid: Loc, deps: CaveCmdDeps): boolean;
+/**
+ * do_cmd_movement_tunnel_test (neostryder's Angband fork): a grid the player should tunnel into
+ * when they try to WALK into it - known, not permanent rock, impassable,
+ * diggable, and diggable with a positive success chance given the current
+ * weapon / best pack digger. RNG-free (input only).
+ */
+export declare function movementTunnelTest(state: GameState, grid: Loc): boolean;
+/**
+ * The walk-into-a-wall seam, installed as state.autoDigStep by the session and
+ * consulted by walkAction (game/player-turn.ts) when a walk is blocked.
+ *
+ * Faithful 4.2.6 bumps the wall and spends nothing, so with no mod loaded this
+ * returns 0 having drawn NO RNG - the walk falls through to the normal bump and
+ * core is byte-identical. A mod may take the walk over through the
+ * walkBlockedByDiggable hook (mod/hooks.ts); the digging itself is the mod's,
+ * and everything it needs is already public here (movementTunnelTest to decide
+ * whether the grid is a legal target, tunnelAux to make one attempt with the
+ * real dig roll and payouts).
+ *
+ * Core deliberately does not check what KIND of mod is asking or which flag it
+ * consulted - a hook is present or it is not.
+ */
+export declare function movementAutoDig(state: GameState, grid: Loc, deps: CaveCmdDeps): number | null;
+/**
+ * Register open / close / lock / tunnel / alter and the stair-checked descend /
+ * ascend on the action registry.
+ */
+export declare function installCaveCommands(registry: ActionRegistry, deps?: CaveCmdDeps): void;
+//# sourceMappingURL=cave-cmd.d.ts.map

package/dist/game/cave-cmd.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cave-cmd.d.ts","sourceRoot":"","sources":["../../src/game/cave-cmd.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAQrC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAI/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAiB,MAAM,cAAc,CAAC;AAkB7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAQL,KAAK,QAAQ,EACd,MAAM,WAAW,CAAC;AAEnB,gEAAgE;AAChE,MAAM,WAAW,UAAU;IACzB,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,sEAAsE;IACtE,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC;IACtC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC;IAClC;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,OAAO,CAAC;IAC3C;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IACtC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,MAAM,CAAC;CAC9B;AAED,oDAAoD;AACpD,MAAM,WAAW,WAAW;IAC1B,sEAAsE;IACtE,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAmCD;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,SAAS,EAChB,IAAI,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAO,GACrD,IAAI,CAyCN;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,EAC9C,KAAK,EAAE,OAAO,GACb;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,GAAG,GAAG,IAAI,CAAA;CAAE,CAarC;AAMD;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,GAAG,EACT,QAAQ,CAAC,EAAE,QAAQ,GAClB,OAAO,CAGT;AAED,kEAAkE;AAClE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAErE;AAED,gEAAgE;AAChE,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAGvE;AAED,2DAA2D;AAC3D,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAGvE;AAED,yDAAyD;AACzD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAMrE;AAMD,+DAA+D;AAC/D,eAAO,MAAM,OAAO;;;;;;;CAOV,CAAC;AAEX,yEAAyE;AACzE,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,CAYjE;AAED,2EAA2E;AAC3E,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,MAAM,CAKjE;AAwLD;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,GAAG,EACT,IAAI,EAAE,WAAW,GAChB,OAAO,CAiFT;AA6BD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAMvE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,SAAS,EAChB,IAAI,EAAE,GAAG,EACT,IAAI,EAAE,WAAW,GAChB,MAAM,GAAG,IAAI,CAQf;AAwGD;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,cAAc,EACxB,IAAI,GAAE,WAAgB,GACrB,IAAI,CA6VN"}