warscript 0.0.1-dev.9c98c3a → 0.0.1-dev.9d07b64

package/operation.d.ts

@@ -16,9 +16,11 @@ export { OperationContinue };
 export declare abstract class Operation<T> {
     protected constructor();
     private started;
+    private settled;
+    private canceled;
     protected progress: number;
     protected maximum: number;
-    isCanceled: boolean;
+    get isCanceled(): boolean;
     get isStarted(): boolean;
     execute(): OperationMonitor<T>;
     protected abstract estimate(): number | Promise<number>;
@@ -30,6 +32,11 @@ export declare abstract class Operation<T> {
         ...result: [success: true, result: T] | [success: false, reason?: any]
     ]>;
     get onProgress(): Event<[operation: Operation<T>]>;
+    /**
+     * Invoked with `isCanceled` already set. Should unblock any pending `estimate`/`work` promise
+     * (e.g. by rejecting it) and return whether cancellation is possible; on `false` the canceled
+     * state is reverted.
+     */
     protected abstract doCancel(): boolean;
     cancel(): boolean;
 }

package/operation.lua

@@ -22,10 +22,7 @@ OperationMonitor.name = "OperationMonitor"
 __TS__ClassExtends(OperationMonitor, __TS__Promise)
 function OperationMonitor.prototype.____constructor(self, operation, ...)
     local args = {...}
-    __TS__Promise.prototype.____constructor(
-        self,
-        table.unpack(args)
-    )
+    __TS__Promise.prototype.____constructor(self, ...)
     self.o = operation
 end
 function OperationMonitor.prototype.cancel(self)
@@ -38,9 +35,10 @@ local Operation = ____exports.Operation
 Operation.name = "Operation"
 function Operation.prototype.____constructor(self)
     self.started = false
+    self.settled = false
+    self.canceled = false
     self.progress = 0
     self.maximum = 0
-    self.isCanceled = false
 end
 function Operation.prototype.execute(self)
     if self.started then
@@ -58,6 +56,12 @@ function Operation.prototype.execute(self)
                 local result
                 local progress = self.progress
                 local ____try = __TS__AsyncAwaiter(function()
+                    if self.canceled then
+                        error(
+                            __TS__New(CancellationException),
+                            0
+                        )
+                    end
                     local maximum = __TS__Await(self:estimate())
                     self.maximum = maximum
                     if maximum ~= 0 then
@@ -68,20 +72,19 @@ function Operation.prototype.execute(self)
                     end
                     repeat
                         do
-                            if self.isCanceled then
-                                local reason = __TS__New(CancellationException)
-                                reject(nil, reason)
-                                local onFailure = ____rawget(self, "onFailure")
-                                if onFailure ~= nil then
-                                    Event.invoke(onFailure, self, reason)
-                                end
-                                local onComplete = ____rawget(self, "onComplete")
-                                if onComplete ~= nil then
-                                    Event.invoke(onComplete, self, false, reason)
-                                end
-                                return ____awaiter_resolve(nil)
+                            if self.canceled then
+                                error(
+                                    __TS__New(CancellationException),
+                                    0
+                                )
                             end
                             result = __TS__Await(self:work())
+                            if self.canceled then
+                                error(
+                                    __TS__New(CancellationException),
+                                    0
+                                )
+                            end
                             if self.progress ~= progress or self.maximum ~= maximum then
                                 progress = self.progress
                                 maximum = self.maximum
@@ -96,6 +99,7 @@ function Operation.prototype.execute(self)
                 __TS__Await(____try.catch(
                     ____try,
                     function(____, reason)
+                        self.settled = true
                         reject(nil, reason)
                         local onFailure = ____rawget(self, "onFailure")
                         if onFailure ~= nil then
@@ -108,6 +112,7 @@ function Operation.prototype.execute(self)
                         return ____awaiter_resolve(nil)
                     end
                 ))
+                self.settled = true
                 resolve(nil, result)
                 local onSuccess = ____rawget(self, "onSuccess")
                 if onSuccess ~= nil then
@@ -122,12 +127,27 @@ function Operation.prototype.execute(self)
     )
 end
 function Operation.prototype.cancel(self)
+    if self.canceled then
+        return true
+    end
+    if self.settled then
+        return false
+    end
+    self.canceled = true
     if self:doCancel() then
-        self.isCanceled = true
         return true
     end
+    self.canceled = false
     return false
 end
+__TS__SetDescriptor(
+    Operation.prototype,
+    "isCanceled",
+    {get = function(self)
+        return self.canceled
+    end},
+    true
+)
 __TS__SetDescriptor(
     Operation.prototype,
     "isStarted",

package/package.json

@@ -1,7 +1,7 @@
 {
     "$schema": "https://json.schemastore.org/package",
     "name": "warscript",
-    "version": "0.0.1-dev.9c98c3a",
+    "version": "0.0.1-dev.9d07b64",
     "description": "A typescript library for Warcraft III using Warpack.",
     "keywords": [
         "warcraft",
@@ -13,31 +13,11 @@
         "type": "git",
         "url": "git+https://github.com/rhazarian/warscript.git"
     },
-    "scripts": {
-        "clean": "rimraf dist",
-        "prebuild": "npm run clean",
-        "build": "tstl && copyfiles -u 1 \"src/**/*.d.ts\" \"src/**/*.lua\" dist && copyfiles LICENSE package.json dist",
-        "prepublishOnly": "echo You should run 'npm run publish' instead. && exit 1",
-        "publish": "npm run build && npm publish ./dist --ignore-scripts"
-    },
     "peerDependencies": {
         "@warscript/language-extensions": "^0.0.1",
-        "@warscript/tstl-plugin": "^0.0.4",
+        "@warscript/tstl-plugin": "^0.0.6",
         "lua-types": "^2.13.1",
-        "warpack": "0.0.1-dev.251db08"
-    },
-    "devDependencies": {
-        "@typescript-eslint/eslint-plugin": "^8.13.0",
-        "@typescript-eslint/parser": "^8.13.0",
-        "async": "^3.2.6",
-        "copyfiles": "^2.4.1",
-        "eslint": "^9.14.0",
-        "eslint-config-prettier": "^9.1.0",
-        "eslint-plugin-prettier": "^5.2.1",
-        "prettier": "^3.3.3",
-        "rimraf": "^6.0.1",
-        "ts-node": "^10.9.2",
-        "tsc-watch": "^6.2.0"
+        "warpack": "0.0.1-dev.eb3e92a"
     },
     "publishConfig": {
         "access": "public",

package/patch-lua.lua

@@ -1,5 +1,9 @@
+local error = _G.error
 local getmetatable = _G.getmetatable
 local ipairs = _G.ipairs
+local select = _G.select
+local tostring = _G.tostring
+local tableconcat = table.concat
 
 _G.ipairs = function(t)
     local metatable = getmetatable(t)
@@ -8,3 +12,14 @@ _G.ipairs = function(t)
     end
     return ipairs(t)
 end
+
+_G.assert = function(v, ...)
+    if not v then
+        local args = {}
+        for i = 1, select("#", ...) do
+            args[i] = tostring(select(i, ...))
+        end
+        error(tableconcat(args, " "))
+    end
+    return v, ...
+end

package/utility/arrays.d.ts

@@ -1,6 +1,11 @@
 /** @noSelfInFile */
-import { TupleOf } from "./types";
+import { NonEmptyArray, ReadonlyNonEmptyArray, TupleOf } from "./types";
 export declare const emptyArray: <T>() => readonly T[];
+/** Checks for any element with `next` instead of computing the length. */
+export declare const isNonEmptyArray: {
+    <T>(array: T[]): array is NonEmptyArray<T>;
+    <T>(array: readonly T[]): array is ReadonlyNonEmptyArray<T>;
+};
 export declare const joinToString: <T>(array: readonly T[], separator: string, transform?: (element: T) => string) => string;
 export declare const arrayOfNotNull: <T>(...elements: readonly (T | undefined | null)[]) => T[];
 export declare const array: <T, N extends number>(length: N, initialize: (index: number) => T) => TupleOf<T, N>;
@@ -42,6 +47,7 @@ export declare const associateByIndexed: <K extends AnyNotNil, V>(array: readonl
 export declare const associateWith: <K extends AnyNotNil, V>(array: readonly K[], valueSelector: (value: K) => V) => LuaMap<K, V>;
 export declare const associateWithIndexed: <K extends AnyNotNil, V>(array: readonly K[], valueSelector: (index: number, value: K) => V) => LuaMap<K, V>;
 export declare const filter: <T>(array: readonly T[], predicate: (value: T) => boolean) => T[];
+export declare const filterNot: <T>(array: readonly T[], predicate: (value: T) => boolean) => T[];
 export declare const average: (array: readonly number[]) => number;
 export declare const sum: (array: readonly number[]) => number;
 export declare const product: (array: readonly number[]) => number;

package/utility/arrays.lua

@@ -7,6 +7,7 @@ local ____functions = require("utility.functions")
 local identity = ____functions.identity
 local mathMax = math.max
 local mathMin = math.min
+local next = _G.next
 local select = _G.select
 local tableConcat = table.concat
 local tableSort = table.sort
@@ -14,6 +15,10 @@ local EMPTY_ARRAY = {}
 ____exports.emptyArray = function()
     return EMPTY_ARRAY
 end
+--- Checks for any element with `next` instead of computing the length.
+____exports.isNonEmptyArray = function(array)
+    return (next(array)) ~= nil
+end
 ____exports.joinToString = function(array, separator, transform)
     if transform == nil then
         transform = tostring
@@ -238,6 +243,18 @@ ____exports.filter = function(array, predicate)
     end
     return result
 end
+____exports.filterNot = function(array, predicate)
+    local result = {}
+    local j = 1
+    for i = 1, #array do
+        local value = array[i]
+        if not predicate(value) then
+            result[j] = value
+            j = j + 1
+        end
+    end
+    return result
+end
 ____exports.average = function(array)
     local sum = 0
     local count = #array

package/utility/linked-map.d.ts

@@ -0,0 +1,35 @@
+/** @noSelfInFile */
+import { ReadonlyLinkedSet } from "./linked-set";
+type IteratorState<K extends AnyNotNil, V> = {
+    n?: K;
+    t: LuaMap<K, K>;
+    v: LuaMap<K, V>;
+};
+type OneSidedTypeGuard = {
+    readonly __oneSidedTypeGuard: unique symbol;
+};
+export interface ReadonlyLinkedMap<K extends AnyNotNil, V> extends LuaPairsIterable<K, V> {
+    readonly keys: ReadonlyLinkedSet<K>;
+    get(key: K): V | undefined;
+    contains(key: AnyNotNil): key is K & OneSidedTypeGuard;
+    readonly size: number;
+}
+export interface LinkedMap<K extends AnyNotNil, V> extends LuaPairsIterable<K, V> {
+    readonly __linkedMap: unique symbol;
+}
+export declare class LinkedMap<K extends AnyNotNil, V> implements ReadonlyLinkedMap<K, V> {
+    private k;
+    private v;
+    get keys(): ReadonlyLinkedSet<K>;
+    get(key: K): V | undefined;
+    getOrPut(key: K, defaultValue: (this: void) => V): V;
+    put(key: K, value: V): void;
+    remove(key: K): boolean;
+    contains(key: AnyNotNil): key is K & OneSidedTypeGuard;
+    get size(): number;
+    protected __len(): number;
+    protected __pairs(this: LinkedMap<K, V>): LuaIterator<LuaMultiReturn<[K | undefined, V | undefined]>, IteratorState<K, V>>;
+}
+export declare const emptyLinkedMap: <K extends AnyNotNil, V>() => ReadonlyLinkedMap<K, V>;
+export declare const mutableLinkedMap: <K extends AnyNotNil, V>() => LinkedMap<K, V>;
+export {};

package/utility/linked-map.lua

@@ -0,0 +1,107 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__New = ____lualib.__TS__New
+local __TS__SetDescriptor = ____lualib.__TS__SetDescriptor
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local ____exports = {}
+local ____linked_2Dset = require("utility.linked-set")
+local LinkedSet = ____linked_2Dset.LinkedSet
+local ____exception = require("exception")
+local UnsupportedOperationException = ____exception.UnsupportedOperationException
+local function linkedMapNext(state)
+    local n = state.n
+    state.n = state.t[n]
+    return n, state.v[n]
+end
+____exports.LinkedMap = __TS__Class()
+local LinkedMap = ____exports.LinkedMap
+LinkedMap.name = "LinkedMap"
+function LinkedMap.prototype.____constructor(self)
+    self.k = __TS__New(LinkedSet)
+    self.v = {}
+end
+function LinkedMap.prototype.get(self, key)
+    return self.v[key]
+end
+function LinkedMap.prototype.getOrPut(self, key, defaultValue)
+    local value = self.v[key]
+    if value ~= nil then
+        return value
+    end
+    value = defaultValue()
+    self.k:add(key)
+    self.v[key] = value
+    return value
+end
+function LinkedMap.prototype.put(self, key, value)
+    self.k:add(key)
+    self.v[key] = value
+end
+function LinkedMap.prototype.remove(self, key)
+    if self.k:remove(key) then
+        self.v[key] = nil
+        return true
+    end
+    return false
+end
+function LinkedMap.prototype.contains(self, key)
+    return self.keys:contains(key)
+end
+function LinkedMap.prototype.__len(self)
+    return self.keys.size
+end
+function LinkedMap.prototype.__pairs(self)
+    return linkedMapNext, {n = self.k.f, t = self.k.n, v = self.v}, nil
+end
+__TS__SetDescriptor(
+    LinkedMap.prototype,
+    "keys",
+    {get = function(self)
+        return self.k
+    end},
+    true
+)
+__TS__SetDescriptor(
+    LinkedMap.prototype,
+    "size",
+    {get = function(self)
+        return self.keys.size
+    end},
+    true
+)
+local emptyIteratorState = {t = {}, v = {}}
+local EmptyLinkedMap = __TS__Class()
+EmptyLinkedMap.name = "EmptyLinkedMap"
+__TS__ClassExtends(EmptyLinkedMap, ____exports.LinkedMap)
+function EmptyLinkedMap.prototype.getOrPut(self)
+    error(
+        __TS__New(UnsupportedOperationException),
+        0
+    )
+end
+function EmptyLinkedMap.prototype.put(self)
+    error(
+        __TS__New(UnsupportedOperationException),
+        0
+    )
+end
+function EmptyLinkedMap.prototype.remove(self)
+    error(
+        __TS__New(UnsupportedOperationException),
+        0
+    )
+end
+function EmptyLinkedMap.prototype.__len(self)
+    return 0
+end
+function EmptyLinkedMap.prototype.__pairs(self)
+    return linkedMapNext, emptyIteratorState, nil
+end
+local EMPTY_LINKED_MAP = __TS__New(EmptyLinkedMap)
+____exports.emptyLinkedMap = function()
+    return EMPTY_LINKED_MAP
+end
+____exports.mutableLinkedMap = function()
+    return __TS__New(____exports.LinkedMap)
+end
+return ____exports

package/utility/linked-set.d.ts

@@ -14,7 +14,7 @@ export interface ReadonlyLinkedSet<T extends AnyNotNil> extends LuaPairsKeyItera
     next(key: T): T | undefined;
     previous(key: T): T | undefined;
     contains(key: AnyNotNil): key is T & OneSidedTypeGuard;
-    size: number;
+    readonly size: number;
     forEach<Args extends any[]>(action: (value: T, ...args: Args) => void, ...args: Args): void;
     toArray(): T[];
     sumOf(selector: ((value: T) => number) | KeysOfType<T, number>): number;
@@ -40,6 +40,7 @@ export declare class LinkedSet<T extends AnyNotNil> implements ReadonlyLinkedSet
     next(key: T): T | undefined;
     previous(key: T): T | undefined;
     add(key: T): boolean;
+    protected addBefore(value: T, key: T): boolean;
     remove(key: T): boolean;
     contains(key: AnyNotNil): key is T & OneSidedTypeGuard;
     clear(): void;
@@ -48,6 +49,7 @@ export declare class LinkedSet<T extends AnyNotNil> implements ReadonlyLinkedSet
     toArray(): T[];
     sumOf(selector: ((value: T) => number) | KeysOfType<T, number>): number;
     sortBy<R>(selector: ((value: T) => R) | KeysOfType<T, R>): void;
+    protected __len(): number;
     protected __pairs(this: LinkedSet<T>): LuaIterator<T | undefined, IteratorState<T>>;
 }
 export declare const emptyLinkedSet: <T extends AnyNotNil>() => ReadonlyLinkedSet<T>;

package/utility/linked-set.lua

@@ -85,6 +85,23 @@ function LinkedSet.prototype.add(self, key)
     end
     return true
 end
+function LinkedSet.prototype.addBefore(self, value, key)
+    local n = self.n
+    local p = self.p
+    local previous = p[value]
+    if previous ~= nil then
+        n[previous] = key
+        p[key] = previous
+    elseif value == self.f then
+        self.f = key
+    else
+        return false
+    end
+    n[key] = value
+    p[value] = key
+    self.s = self.s + 1
+    return true
+end
 function LinkedSet.prototype.remove(self, key)
     local n = self.n
     local next = n[key]
@@ -171,6 +188,9 @@ function LinkedSet.prototype.sortBy(self, selector)
     self.f = array[1]
     self.l = array[s]
 end
+function LinkedSet.prototype.__len(self)
+    return self.s
+end
 function LinkedSet.prototype.__pairs(self)
     return linkedSetNext, {t = self.n, n = self.f}, nil
 end
@@ -182,6 +202,7 @@ __TS__SetDescriptor(
     end},
     true
 )
+local emptyIteratorState = {t = {}}
 local EmptyLinkedSet = __TS__Class()
 EmptyLinkedSet.name = "EmptyLinkedSet"
 __TS__ClassExtends(EmptyLinkedSet, ____exports.LinkedSet)
@@ -191,6 +212,12 @@ function EmptyLinkedSet.prototype.add(self)
         0
     )
 end
+function EmptyLinkedSet.prototype.__len(self)
+    return 0
+end
+function EmptyLinkedSet.prototype.__pairs(self)
+    return linkedSetNext, emptyIteratorState, nil
+end
 local EMPTY_LINKED_SET = __TS__New(EmptyLinkedSet)
 ____exports.emptyLinkedSet = function()
     return EMPTY_LINKED_SET

package/utility/random.d.ts

@@ -0,0 +1,102 @@
+/** @noSelfInFile */
+import { ReadonlyNonEmptyArray } from "./types";
+/**
+ * A client-local pseudorandom generator that is safe to advance inside a local block.
+ *
+ * Instances are independent of each other and of the game's synchronous randomness.
+ */
+export declare class AsyncRandom {
+    private a;
+    private b;
+    private c;
+    private d;
+    /**
+     * Creates a generator seeded with the given `seed`,
+     * or with client-local entropy if no seed is given.
+     */
+    constructor(seed?: number);
+    /** Resets the generator to the state defined by the given `seed`. */
+    setSeed(seed: number): void;
+    /**
+     * Folds freshly gathered client-local entropy, optionally together with the given `value`,
+     * into the current state.
+     *
+     * Useful to make streams of different clients diverge even further, e.g. by mixing in values
+     * that are local by definition, such as the local player's id or the local mouse position.
+     */
+    addEntropy(value?: number | string): void;
+    /** Advances the state and returns the next 32-bit word. */
+    private next;
+    /** Returns a uniformly distributed value in `[0, bound)`, where `bound` is in `[1, 2^32]`. */
+    private nextBounded;
+    /** Returns the given amount (`0` to `32`) of random bits as a non-negative integer. */
+    nextBits(bitCount: number): number;
+    /**
+     * Returns a uniformly distributed integer, both bounds being inclusive:
+     * in `[0, upperBound]` when called with a single bound, in `[lowerBound, upperBound]` otherwise.
+     */
+    nextInteger(upperBound?: number): number;
+    nextInteger(lowerBound: number, upperBound: number): number;
+    /**
+     * Returns a uniformly distributed float with 53 bits of precision, the upper bound being
+     * exclusive: in `[0, upperBound)` when called with a single bound,
+     * in `[lowerBound, upperBound)` otherwise.
+     */
+    nextFloat(upperBound?: number): number;
+    nextFloat(lowerBound: number, upperBound: number): number;
+    /** Returns `true` with the given `probability`, or with a probability of one half by default. */
+    nextBoolean(probability?: number): boolean;
+    /** Returns a uniformly distributed angle in degrees, in `[0, 360)`. */
+    nextAngle(): number;
+    /** Returns a uniformly distributed point within `range` of the given center. */
+    nextXY(centerX: number, centerY: number, range: number): LuaMultiReturn<[x: number, y: number]>;
+    /** Returns a uniformly distributed element of the given `array`. */
+    nextElement<T>(array: ReadonlyNonEmptyArray<T>): T;
+    nextElement<T>(array: ReadonlyArray<T>): T | undefined;
+    /** Returns a uniformly distributed one of the given `elements`. */
+    nextOf<T>(element: T, ...elements: T[]): T;
+    nextOf<T>(...elements: T[]): T | undefined;
+    /** Shuffles the given `array` in place, each permutation being equally likely. */
+    shuffle(array: unknown[]): void;
+}
+/**
+ * Folds freshly gathered client-local entropy, optionally together with the given `value`,
+ * into the state of the generator backing the `asyncRandom*` functions.
+ */
+export declare const addAsyncRandomEntropy: (value?: number | string) => void;
+/** Returns the given amount (`0` to `32`) of random bits as a non-negative integer. */
+export declare const asyncRandomBits: (bitCount: number) => number;
+/**
+ * Returns a uniformly distributed integer, both bounds being inclusive:
+ * in `[0, upperBound]` when called with a single bound, in `[lowerBound, upperBound]` otherwise.
+ */
+export declare const asyncRandomInteger: {
+    (upperBound?: number): number;
+    (lowerBound: number, upperBound: number): number;
+};
+/**
+ * Returns a uniformly distributed float with 53 bits of precision, the upper bound being exclusive:
+ * in `[0, upperBound)` when called with a single bound, in `[lowerBound, upperBound)` otherwise.
+ */
+export declare const asyncRandomFloat: {
+    (upperBound?: number): number;
+    (lowerBound: number, upperBound: number): number;
+};
+/** Returns `true` with the given `probability`, or with a probability of one half by default. */
+export declare const asyncRandomBoolean: (probability?: number) => boolean;
+/** Returns a uniformly distributed angle in degrees, in `[0, 360)`. */
+export declare const asyncRandomAngle: () => number;
+/** Returns a uniformly distributed point within `range` of the given center. */
+export declare const asyncRandomXY: (centerX: number, centerY: number, range: number) => LuaMultiReturn<[x: number, y: number]>;
+/** Returns a uniformly distributed element of the given `array`. */
+export declare const asyncRandomElement: {
+    <T>(array: ReadonlyNonEmptyArray<T>): T;
+    <T>(array: ReadonlyArray<T>): T | undefined;
+};
+/** Returns a uniformly distributed one of the given `elements`. */
+export declare const asyncRandom: {
+    <T>(element: T, ...elements: T[]): T;
+    <T>(...elements: T[]): T | undefined;
+};
+/** Shuffles the given `array` in place, each permutation being equally likely. */
+export declare const asyncShuffle: (array: unknown[]) => void;