@logic-pad/core 0.7.0 → 0.10.0

package/dist/data/solver/backtrack/symbols/focus.js

@@ -0,0 +1,59 @@
+import BTModule, { BTTile, IntArray2D, createOneTileResult, } from '../data.js';
+export default class FocusBTModule extends BTModule {
+    constructor(instr) {
+        super();
+        Object.defineProperty(this, "instr", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "cachedCheckResult", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.instr = instr;
+    }
+    checkGlobal(grid) {
+        const tile = grid.getTile(this.instr.x, this.instr.y);
+        if (tile === BTTile.Empty)
+            return createOneTileResult(grid, { x: this.instr.x, y: this.instr.y });
+        let gray = 0;
+        let same = 0;
+        for (let y = this.instr.y - 1; y <= this.instr.y + 1; y++) {
+            for (let x = this.instr.x - 1; x <= this.instr.x + 1; x++) {
+                if (y !== this.instr.y && x !== this.instr.x)
+                    continue;
+                if (!grid.isInBound(x, y) || (x === this.instr.x && y === this.instr.y))
+                    continue;
+                const checkTile = grid.getTile(x, y);
+                if (checkTile === BTTile.Empty)
+                    gray++;
+                else if (checkTile === tile)
+                    same++;
+            }
+        }
+        if (same > this.instr.number || same + gray < this.instr.number)
+            return false;
+        if (!this.cachedCheckResult)
+            this.cachedCheckResult = this.buildCheckAndRating(grid);
+        return this.cachedCheckResult;
+    }
+    buildCheckAndRating(grid) {
+        const tilesNeedCheck = IntArray2D.create(grid.width, grid.height);
+        const ratings = [];
+        for (let y = this.instr.y - 1; y <= this.instr.y + 1; y++) {
+            for (let x = this.instr.x - 1; x <= this.instr.x + 1; x++) {
+                if (y !== this.instr.y && x !== this.instr.x)
+                    continue;
+                if (!grid.isInBound(x, y) || (x === this.instr.x && y === this.instr.y))
+                    continue;
+                tilesNeedCheck.set(x, y, 1);
+                ratings.push({ pos: { x, y }, score: 1 });
+            }
+        }
+        return { tilesNeedCheck, ratings };
+    }
+}

package/dist/data/solver/cspuz/cspuzSolver.d.ts

@@ -0,0 +1,12 @@
+import EventIteratingSolver from '../eventIteratingSolver.js';
+import GridData from '../../grid.js';
+export default class CspuzSolver extends EventIteratingSolver {
+    private static readonly supportedInstrs;
+    readonly id = "cspuz";
+    readonly author = "semiexp";
+    readonly description = "A blazingly fast WebAssembly solver that supports most rules and symbols (including underclued). No uniqueness check yet.";
+    protected createWorker(): Worker;
+    isGridSupported(grid: GridData): boolean;
+    isInstructionSupported(instructionId: string): boolean;
+    isEnvironmentSupported(): Promise<boolean>;
+}

package/dist/data/solver/cspuz/cspuzSolver.js

@@ -0,0 +1,113 @@
+import { instance as banPatternInstance } from '../../rules/banPatternRule.js';
+import { instance as cellCountInstance } from '../../rules/cellCountRule.js';
+import { instance as regionAreaInstance } from '../../rules/regionAreaRule.js';
+import { instance as sameShapeInstance } from '../../rules/sameShapeRule.js';
+import { instance as symbolsPerRegionInstance } from '../../rules/symbolsPerRegionRule.js';
+import { instance as undercluedInstance } from '../../rules/undercluedRule.js';
+import { instance as uniqueShapeInstance } from '../../rules/uniqueShapeRule.js';
+import { instance as offByXInstance } from '../../rules/offByXRule.js';
+import { instance as areaNumberInstance } from '../../symbols/areaNumberSymbol.js';
+import { instance as dartInstance } from '../../symbols/dartSymbol.js';
+import GalaxySymbol, { instance as galaxyInstance, } from '../../symbols/galaxySymbol.js';
+import { instance as letterInstance } from '../../symbols/letterSymbol.js';
+import LotusSymbol, { instance as lotusInstance, } from '../../symbols/lotusSymbol.js';
+import { instance as minesweeperInstance } from '../../symbols/minesweeperSymbol.js';
+import { instance as viewpointInstance } from '../../symbols/viewpointSymbol.js';
+import { instance as connectAllInstance } from '../../rules/connectAllRule.js';
+import EventIteratingSolver from '../eventIteratingSolver.js';
+import GridData from '../../grid.js';
+import { Color } from '../../primitives.js';
+class CspuzSolver extends EventIteratingSolver {
+    constructor() {
+        super(...arguments);
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'cspuz'
+        });
+        Object.defineProperty(this, "author", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'semiexp'
+        });
+        Object.defineProperty(this, "description", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'A blazingly fast WebAssembly solver that supports most rules and symbols (including underclued). No uniqueness check yet.'
+        });
+    }
+    createWorker() {
+        return new Worker(new URL('./cspuzWorker.js', import.meta.url), {
+            type: 'module',
+        });
+    }
+    isGridSupported(grid) {
+        if (!super.isGridSupported(grid)) {
+            return false;
+        }
+        // special handling for galaxies and lotuses since dual-color symbols are not supported yet
+        for (const [_, symbols] of grid.symbols) {
+            for (const symbol of symbols) {
+                if (symbol instanceof GalaxySymbol || symbol instanceof LotusSymbol) {
+                    if (symbol.x % 1 !== 0 && symbol.y % 1 !== 0) {
+                        return false;
+                    }
+                    else if (symbol.x % 1 !== 0 || symbol.y % 1 !== 0) {
+                        const tile1 = grid.getTile(Math.floor(symbol.x), Math.floor(symbol.y));
+                        const tile2 = grid.getTile(Math.ceil(symbol.x), Math.ceil(symbol.y));
+                        if (!tile1.fixed || !tile2.fixed || tile1.color !== tile2.color) {
+                            return false;
+                        }
+                    }
+                }
+            }
+        }
+        // special handling for fixed gray tiles
+        if (grid.getTileCount(true, true, Color.Gray) > 0) {
+            return false;
+        }
+        return true;
+    }
+    isInstructionSupported(instructionId) {
+        return CspuzSolver.supportedInstrs.includes(instructionId);
+    }
+    async isEnvironmentSupported() {
+        try {
+            const abortController = new AbortController();
+            for await (const _ of this.solve(GridData.create(['.']), abortController.signal)) {
+                abortController.abort();
+            }
+            return true;
+        }
+        catch (ex) {
+            return false;
+        }
+    }
+}
+Object.defineProperty(CspuzSolver, "supportedInstrs", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: [
+        minesweeperInstance.id,
+        areaNumberInstance.id,
+        letterInstance.id,
+        dartInstance.id,
+        viewpointInstance.id,
+        lotusInstance.id,
+        galaxyInstance.id,
+        connectAllInstance.id,
+        banPatternInstance.id,
+        sameShapeInstance.id,
+        uniqueShapeInstance.id,
+        regionAreaInstance.id,
+        cellCountInstance.id,
+        offByXInstance.id,
+        undercluedInstance.id,
+        symbolsPerRegionInstance.id,
+    ]
+});
+export default CspuzSolver;

package/dist/data/solver/cspuz/cspuzWorker.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/data/solver/cspuz/cspuzWorker.js

@@ -0,0 +1,44 @@
+import { solveLogicPad } from 'logic-pad-solver-core';
+import { Serializer } from '../../serializer/allSerializers.js';
+import { gridToJson } from './jsonify.js';
+import { instance as undercluedInstance } from '../../rules/undercluedRule.js';
+import { Color } from '../../primitives.js';
+function stringToColor(str) {
+    if (str === 'dark') {
+        return Color.Dark;
+    }
+    else if (str === 'light') {
+        return Color.Light;
+    }
+    else {
+        return Color.Gray;
+    }
+}
+onmessage = e => {
+    const grid = Serializer.parseGrid(e.data);
+    const puzzleData = gridToJson(grid);
+    const solverResult = solveLogicPad(puzzleData, !!grid.findRule(r => r.id === undercluedInstance.id));
+    if (solverResult === null) {
+        postMessage(null);
+    }
+    else if ('error' in solverResult) {
+        throw new Error(solverResult.error);
+    }
+    else {
+        const solution = grid.withTiles(tiles => {
+            for (const [y, row] of solverResult.entries()) {
+                for (const [x, color] of row.entries()) {
+                    tiles[y][x] = tiles[y][x].withColor(stringToColor(color));
+                }
+            }
+            return tiles;
+        });
+        if (solution.resetTiles().colorEquals(solution)) {
+            postMessage(null);
+        }
+        else {
+            postMessage(Serializer.stringifyGrid(solution));
+        }
+    }
+    postMessage(undefined);
+};

package/dist/data/solver/cspuz/jsonify.d.ts

@@ -0,0 +1,3 @@
+import { PuzzleData } from 'logic-pad-solver-core';
+import GridData from '../../grid.js';
+export declare function gridToJson(grid: GridData): PuzzleData;

package/dist/data/solver/cspuz/jsonify.js

@@ -0,0 +1,211 @@
+import { Color, Comparison } from '../../primitives.js';
+import BanPatternRule from '../../rules/banPatternRule.js';
+import CellCountRule from '../../rules/cellCountRule.js';
+import ConnectAllRule from '../../rules/connectAllRule.js';
+import OffByXRule from '../../rules/offByXRule.js';
+import RegionAreaRule from '../../rules/regionAreaRule.js';
+import SameShapeRule from '../../rules/sameShapeRule.js';
+import SymbolsPerRegionRule from '../../rules/symbolsPerRegionRule.js';
+import UndercluedRule from '../../rules/undercluedRule.js';
+import UniqueShapeRule from '../../rules/uniqueShapeRule.js';
+import { instance as areaNumberInstance, } from '../../symbols/areaNumberSymbol.js';
+import { instance as dartInstance, } from '../../symbols/dartSymbol.js';
+import { instance as galaxyInstance, } from '../../symbols/galaxySymbol.js';
+import { instance as letterInstance, } from '../../symbols/letterSymbol.js';
+import { instance as lotusInstance, } from '../../symbols/lotusSymbol.js';
+import { instance as minesweeperInstance, } from '../../symbols/minesweeperSymbol.js';
+import { instance as viewpointInstance, } from '../../symbols/viewpointSymbol.js';
+import TileData from '../../tile.js';
+function canonizeTiles(tileData) {
+    const ret = [];
+    for (const row of tileData) {
+        const newRow = [];
+        for (const tile of row) {
+            if (tile.exists) {
+                newRow.push(tile);
+            }
+            else {
+                newRow.push(new TileData(true, false, Color.Gray));
+            }
+        }
+        ret.push(newRow);
+    }
+    return ret;
+}
+export function gridToJson(grid) {
+    const rules = [];
+    for (const rule of grid.rules) {
+        if (rule instanceof ConnectAllRule) {
+            rules.push({
+                type: 'connectAll',
+                color: rule.color,
+            });
+        }
+        else if (rule instanceof BanPatternRule) {
+            rules.push({
+                type: 'forbiddenPattern',
+                pattern: canonizeTiles(rule.pattern.tiles),
+            });
+        }
+        else if (rule instanceof SameShapeRule) {
+            rules.push({
+                type: 'sameShape',
+                color: rule.color,
+            });
+        }
+        else if (rule instanceof UniqueShapeRule) {
+            rules.push({
+                type: 'uniqueShape',
+                color: rule.color,
+            });
+        }
+        else if (rule instanceof RegionAreaRule) {
+            rules.push({
+                type: 'regionArea',
+                color: rule.color,
+                size: rule.size,
+            });
+        }
+        else if (rule instanceof CellCountRule) {
+            rules.push({
+                type: 'cellCount',
+                color: rule.color,
+                count: rule.count,
+            });
+        }
+        else if (rule instanceof OffByXRule) {
+            rules.push({
+                type: 'offByX',
+                number: rule.number,
+            });
+        }
+        else if (rule instanceof UndercluedRule) {
+            continue;
+        }
+        else if (rule instanceof SymbolsPerRegionRule) {
+            let kind;
+            if (rule.comparison === Comparison.Equal) {
+                kind = 'exactly';
+            }
+            else if (rule.comparison === Comparison.AtLeast) {
+                kind = 'atLeast';
+            }
+            else if (rule.comparison === Comparison.AtMost) {
+                kind = 'atMost';
+            }
+            else {
+                throw new Error(`Unknown comparison (${rule.comparison})`);
+            }
+            rules.push({
+                type: 'symbolCount',
+                number: rule.count,
+                kind,
+                color: rule.color,
+            });
+        }
+        else if (rule.necessaryForCompletion) {
+            throw new Error(`Unknown rule type (${rule.explanation})`);
+        }
+    }
+    for (const [rule, symbols] of grid.symbols) {
+        if (rule === minesweeperInstance.id) {
+            rules.push({
+                type: 'minesweeper',
+                tiles: symbols.map(s => ({
+                    x: Math.floor(s.x),
+                    y: Math.floor(s.y),
+                    number: s.number,
+                })),
+            });
+        }
+        else if (rule === areaNumberInstance.id) {
+            rules.push({
+                type: 'number',
+                tiles: symbols.map(s => ({
+                    x: Math.floor(s.x),
+                    y: Math.floor(s.y),
+                    number: s.number,
+                })),
+            });
+        }
+        else if (rule === letterInstance.id) {
+            rules.push({
+                type: 'letter',
+                tiles: symbols.map(s => ({
+                    x: Math.floor(s.x),
+                    y: Math.floor(s.y),
+                    letter: s.letter,
+                })),
+            });
+        }
+        else if (rule === dartInstance.id) {
+            rules.push({
+                type: 'dart',
+                tiles: symbols.map(s => ({
+                    x: Math.floor(s.x),
+                    y: Math.floor(s.y),
+                    orientation: s.orientation,
+                    number: s.number,
+                })),
+            });
+        }
+        else if (rule === viewpointInstance.id) {
+            rules.push({
+                type: 'viewpoint',
+                tiles: symbols.map(s => ({
+                    x: Math.floor(s.x),
+                    y: Math.floor(s.y),
+                    number: s.number,
+                })),
+            });
+        }
+        else if (rule === lotusInstance.id) {
+            const tiles = symbols.map(s => ({
+                x: Math.round(s.x * 2),
+                y: Math.round(s.y * 2),
+                orientation: s.orientation,
+            }));
+            rules.push({
+                type: 'lotus',
+                tiles,
+            });
+        }
+        else if (rule === galaxyInstance.id) {
+            const tiles = symbols.map(s => ({
+                x: Math.round(s.x * 2),
+                y: Math.round(s.y * 2),
+            }));
+            rules.push({
+                type: 'galaxy',
+                tiles,
+            });
+        }
+        else if (symbols.some(s => s.necessaryForCompletion)) {
+            throw new Error(`Unknown symbol type: ${rule}`);
+        }
+    }
+    const connections = grid.connections.edges.map(edge => {
+        return {
+            x1: edge.x1,
+            y1: edge.y1,
+            x2: edge.x2,
+            y2: edge.y2,
+        };
+    });
+    const tiles = grid.tiles.map(row => {
+        return row.map(tile => {
+            return {
+                exists: tile.exists,
+                fixed: tile.fixed,
+                color: tile.color,
+            };
+        });
+    });
+    return {
+        width: grid.width,
+        height: grid.height,
+        connections,
+        tiles,
+        rules,
+    };
+}

package/dist/data/solver/eventIteratingSolver.d.ts

@@ -1,6 +1,7 @@
 import GridData from '../grid.js';
-import Solver, { CancelRef } from './solver.js';
+import Solver from './solver.js';
 export default abstract class EventIteratingSolver extends Solver {
+    readonly supportsCancellation = true;
     protected abstract createWorker(): Worker;
-    solve(grid: GridData, cancelRef: CancelRef): AsyncGenerator<GridData | null>;
+    solve(grid: GridData, abortSignal?: AbortSignal): AsyncGenerator<GridData | null>;
 }

package/dist/data/solver/eventIteratingSolver.js

@@ -2,9 +2,19 @@ import { Serializer } from '../serializer/allSerializers.js';
 import Solver from './solver.js';
 import { EventIterator } from 'event-iterator';
 export default class EventIteratingSolver extends Solver {
-    async *solve(grid, cancelRef) {
+    constructor() {
+        super(...arguments);
+        Object.defineProperty(this, "supportsCancellation", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+    }
+    async *solve(grid, abortSignal) {
         const worker = this.createWorker();
-        cancelRef.cancel = () => worker.terminate();
+        const terminateHandler = () => worker.terminate();
+        abortSignal?.addEventListener('abort', terminateHandler);
         try {
             const iterator = new EventIterator(({ push, stop, fail }) => {
                 worker.postMessage(Serializer.stringifyGrid(grid.resetTiles()));
@@ -12,6 +22,10 @@ export default class EventIteratingSolver extends Solver {
                     if (e.data) {
                         push(Serializer.parseGrid(e.data));
                     }
+                    else if (e.data === null) {
+                        push(null);
+                        stop(); // Stop after the first signal for out of solutions
+                    }
                     else {
                         stop();
                     }
@@ -24,10 +38,10 @@ export default class EventIteratingSolver extends Solver {
             for await (const solution of iterator) {
                 yield solution;
             }
-            yield null;
         }
         finally {
             worker.terminate();
+            abortSignal?.removeEventListener('abort', terminateHandler);
         }
     }
 }

package/dist/data/solver/solver.d.ts

@@ -1,7 +1,4 @@
 import GridData from '../grid.js';
-export interface CancelRef {
-    cancel?: () => void;
-}
 /**
  * Base class that all solvers must extend.
  */
@@ -12,10 +9,18 @@ export default abstract class Solver {
      * This is also displayed to the user when selecting a solver.
      */
     abstract get id(): string;
+    /**
+     * The author(s) of the solver.
+     */
+    abstract get author(): string;
     /**
      * A short paragraph describing when the user should use this solver.
      */
     abstract get description(): string;
+    /**
+     * Whether the solver supports cancellation. If `true`, the solver must respond to the abort signal if it is provided.
+     */
+    abstract get supportsCancellation(): boolean;
     /**
      * Solve the given grid. The implementation should delegate long-running tasks to a worker thread and yield solutions
      * asynchronously.
@@ -31,10 +36,10 @@ export default abstract class Solver {
      *
      * @param grid The grid to solve. The provided grid is guaranteed to be supported by the solver. Some tiles in the
      * grid may already be filled by the user. It is up to the solver to decide whether to respect these tiles or not.
-     * @param cancelRef A reference to a function that can be called to cancel the solver. If cancellation is supported,
-     * the solver can assign a function to `cancelRef.cancel` that will stop the solver when called.
+     * @param abortSignal An optional signal that the solver should subscribe to in order to cancel the operation. If the
+     * solver does not support cancellation, it should ignore this parameter.
      */
-    abstract solve(grid: GridData, cancelRef: CancelRef): AsyncGenerator<GridData | null>;
+    abstract solve(grid: GridData, abortSignal?: AbortSignal): AsyncGenerator<GridData | null>;
     /**
      * Check if the solver supports the current browser environment. This method is called once when the user first clicks
      * the "Solve" button, and the result is cached for the duration of the editor session.

package/dist/data/solver/universal/universalSolver.d.ts

@@ -1,6 +1,7 @@
 import EventIteratingSolver from '../eventIteratingSolver.js';
 export default class UniversalSolver extends EventIteratingSolver {
     readonly id = "universal";
+    readonly author = "romain22222, Lysine";
     readonly description = "A backtracking solver that supports all rules and symbols (including underclued) but is less optimized.";
     protected createWorker(): Worker;
     isInstructionSupported(instructionId: string): boolean;

package/dist/data/solver/universal/universalSolver.js

@@ -9,6 +9,12 @@ export default class UniversalSolver extends EventIteratingSolver {
             writable: true,
             value: 'universal'
         });
+        Object.defineProperty(this, "author", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'romain22222, Lysine'
+        });
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,

package/dist/data/solver/universal/universalWorker.js

@@ -115,6 +115,11 @@ onmessage = e => {
     const grid = Serializer.parseGrid(e.data);
     let count = 0;
     solve(grid, solution => {
+        if (solution) {
+            if (solution.resetTiles().colorEquals(solution)) {
+                solution = null;
+            }
+        }
         postMessage(solution ? Serializer.stringifyGrid(solution) : null);
         count += 1;
         return count < 2;

package/dist/data/solver/z3/z3Solver.d.ts

@@ -2,7 +2,9 @@ import GridData from '../../grid.js';
 import Solver from '../solver.js';
 export default class Z3Solver extends Solver {
     readonly id = "z3";
-    readonly description = "Good for confirming that a solution is unique, especially for larger puzzles. It is otherwise slower than most solvers in small to medium-sized puzzles.";
+    readonly author = "Lysine";
+    readonly description = "(Obsolete) A WebAssembly solver that supports a limited set of rules and symbols.";
+    readonly supportsCancellation = false;
     isEnvironmentSupported(): Promise<boolean>;
     solve(grid: GridData): AsyncGenerator<GridData | null>;
     isInstructionSupported(instructionId: string): boolean;

package/dist/data/solver/z3/z3Solver.js

@@ -14,11 +14,23 @@ export default class Z3Solver extends Solver {
             writable: true,
             value: 'z3'
         });
+        Object.defineProperty(this, "author", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'Lysine'
+        });
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: 'Good for confirming that a solution is unique, especially for larger puzzles. It is otherwise slower than most solvers in small to medium-sized puzzles.'
+            value: '(Obsolete) A WebAssembly solver that supports a limited set of rules and symbols.'
+        });
+        Object.defineProperty(this, "supportsCancellation", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
         });
     }
     async isEnvironmentSupported() {