@bscotch/gml-parser 1.14.2

package/dist/types.checks.js

@@ -0,0 +1,246 @@
+import { arrayWrapped, isArray } from '@bscotch/utility';
+import { Type, TypeStore } from './types.js';
+export function isTypeOfKind(item, kind) {
+    return isTypeInstance(item) && item.kind === kind;
+}
+export function isTypeStoreOfKind(item, kind) {
+    return isTypeStore(item) && item.kind === kind;
+}
+export function isTypeOrStoreOfKind(item, kind) {
+    return isTypeOfKind(item, kind) || isTypeStoreOfKind(item, kind);
+}
+/**
+ * Given some kind of type collection, find the first one matching
+ * a given kind.
+ */
+export function getTypeOfKind(from, kind) {
+    if (!from)
+        return undefined;
+    const types = getTypes(from);
+    const kinds = arrayWrapped(kind);
+    return types.find((t) => kinds.includes(t.kind));
+}
+export function getTypesOfKind(from, kind) {
+    if (!from)
+        return [];
+    const types = getTypes(from);
+    const kinds = arrayWrapped(kind);
+    return types.filter((t) => kinds.includes(t.kind));
+}
+/** Get the typestore of item, if present. Else get the type on item. */
+export function getTypeStoreOrType(item) {
+    if (isArray(item)) {
+        return item;
+    }
+    if (item.$tag === 'Sym') {
+        return item.type;
+    }
+    else if (item.$tag === 'TypeStore') {
+        return item;
+    }
+    return arrayWrapped(item);
+}
+export function getTypes(items) {
+    const types = [];
+    if (!items) {
+        return types;
+    }
+    for (const item of arrayWrapped(items)) {
+        if (item.$tag === 'Sym') {
+            types.push(...item.type.type);
+        }
+        else if (item.$tag === 'TypeStore') {
+            return [...item.type];
+        }
+        else {
+            types.push(item);
+        }
+    }
+    return types;
+}
+export function isTypeInstance(item) {
+    return item && '$tag' in item && item.$tag === 'Type';
+}
+export function isTypeStore(item) {
+    return item && '$tag' in item && item.$tag === 'TypeStore';
+}
+/**
+ * Returns `true` if `narrowed` is a subtype of `type`,
+ * meaning that it is a subset/narrowed/compatible/same type
+ * compared to otherType.
+ *
+ * Identical types also return `true`.
+ */
+export function narrows(narrowType, broadType) {
+    // Convert to type arrays
+    const narrowTypes = getTypes(narrowType);
+    const broadTypes = getTypes(broadType);
+    // All "narrow" types must be a subtype of at least one "broad" type
+    return narrowTypes.every((narrow) => broadTypes.some((broad) => narrowsType(narrow, broad)));
+}
+/**
+ * Returns `true` if `narrowed` is a subtype of `type`,
+ * meaning that it is a subset/narrowed/compatible/same type
+ * compared to otherType.
+ *
+ * Identical types also return `true`.
+ */
+function narrowsType(narrowType, broadType) {
+    if (narrowType === broadType) {
+        return true;
+    }
+    if (['Mixed', 'Any', 'Unknown'].includes(broadType.kind) ||
+        ['Mixed', 'Any'].includes(narrowType.kind)) {
+        // Then everyone is satisfied all of the time
+        return true;
+    }
+    if (broadType.kind !== narrowType.kind) {
+        return false;
+    }
+    // The subtype must have all of the same members, though it could also have others
+    for (const member of broadType.listMembers()) {
+        const matching = narrowType.getMember(member.name);
+        if (!matching) {
+            return false;
+        }
+    }
+    // Similarly, the subtype must have the same params (though it could have others)
+    for (const param of broadType.listParameters()) {
+        const matching = !param || narrowType.getParameter(param.idx);
+        if (!matching) {
+            return false;
+        }
+    }
+    // Check return type
+    if (broadType.returns &&
+        (!narrowType.returns || !narrows(narrowType.returns, broadType.returns))) {
+        return false;
+    }
+    // Check the constructs type
+    if (broadType.isConstructor &&
+        (!narrowType.isConstructor || !narrows(narrowType.self, broadType.self))) {
+        return false;
+    }
+    return true;
+}
+/**
+ * For types inferred from expressions, normalize away utility
+ * types like `InstanceType` and `ObjectType`, and perform any
+ * other type-normalization tasks. Returns a new TypeStore, so
+ * if maintaining reference links is essential this function should
+ * not be used.
+ */
+export function normalizeType(inferred, knownTypes) {
+    const normalized = new TypeStore();
+    type: for (const type of getTypes(inferred)) {
+        if (type.kind === 'EnumMember') {
+            normalized.addType(type.signifier?.parent || type);
+            continue;
+        }
+        else {
+            for (const [utilityKind, defaultItemKind] of [
+                ['InstanceType', 'Id.Instance'],
+                ['ObjectType', 'Asset.GMObject'],
+                ['StaticType', 'Struct'],
+            ]) {
+                if (type.kind !== utilityKind)
+                    continue;
+                if (!type.items?.type.length) {
+                    normalized.addType(knownTypes.get(defaultItemKind) || new Type(defaultItemKind));
+                }
+                for (const itemType of getTypes(type.items || [])) {
+                    // Try to convert the type.
+                    const name = itemType.name
+                        ? `${defaultItemKind}.${itemType.name}`
+                        : defaultItemKind;
+                    let type = knownTypes.get(name) ||
+                        knownTypes.get(defaultItemKind) ||
+                        new Type(defaultItemKind);
+                    if (itemType.isGeneric) {
+                        // Then extend the type to allow having a generic without mutating the original
+                        type = type.derive().genericize().named(itemType.name);
+                    }
+                    if (utilityKind === 'StaticType') {
+                        // TODO: Create a new type consisting of the type's static members
+                        type = Type.Struct;
+                        for (const member of itemType.listMembers()) {
+                            if (member.static) {
+                                type.addMember(member);
+                            }
+                        }
+                    }
+                    normalized.addType(type);
+                }
+                continue type; // so that the fall-through only happens if we didn't find a match
+            }
+        }
+        normalized.addType(type);
+    }
+    return normalized;
+}
+/**
+ * Given an expected type that might include generics, and an inferred
+ * type that should map onto it, update a generics map linking generics
+ * to inferred types by name.
+ */
+export function updateGenericsMap(expected, inferred, knownTypes, 
+/** Map of generics by name to their *inferred type* */
+generics = new Map()) {
+    const expectedTypes = getTypes(expected)
+        .map((t) => normalizeType(t, knownTypes).type)
+        .flat();
+    const inferredTypes = getTypes(inferred)
+        .map((t) => normalizeType(t, knownTypes).type)
+        .flat();
+    // The collection of 1 or more expected types is supposed
+    // to match up with the collection of 1 or more inferred types.
+    // For the overlap of compatible types we need to recurse through
+    // the types and their contained types (stored on the `items` property)
+    // to identify any generics specified in the expected types that we
+    // can resolve with the inferred types.
+    for (const expectedType of expectedTypes) {
+        let generic;
+        if (expectedType.isGeneric) {
+            const genericName = expectedType.name;
+            generic = generics.get(genericName) || new TypeStore();
+            generics.set(genericName, generic);
+        }
+        for (const inferredType of inferredTypes) {
+            if (narrowsType(inferredType, expectedType)) {
+                if (generic) {
+                    // Then we can use this inferred type to resolve the generic
+                    generic.addType(inferredType);
+                }
+                // Repeat on contained types, if there are any
+                if (inferredType.items?.hasTypes && expectedType.items?.hasTypes) {
+                    updateGenericsMap(expectedType.items, inferredType.items, knownTypes, generics);
+                }
+            }
+        }
+    }
+    return generics;
+}
+export function replaceGenerics(startingType, knownTypes, generics) {
+    const startingTypes = getTypes(startingType);
+    // Recurse through the types and, if we find a generic, replace it!
+    // The complication is that we don't want to mutate the starting types, we need to replace them (or their containers!) with a new type. The easiest way to do this is to just create new types from the jump.
+    const replacedTypes = new TypeStore();
+    for (const startingType of startingTypes) {
+        const newTypes = startingType.isGeneric && generics.has(startingType.name)
+            ? generics.get(startingType.name)?.type
+            : [startingType];
+        for (const type of newTypes || []) {
+            const newType = type.derive();
+            if (type.items) {
+                newType.items = replaceGenerics(type.items, knownTypes, generics);
+            }
+            replacedTypes.addType(newType);
+        }
+    }
+    // Remove 'Any' types if there is something more specific
+    if (replacedTypes.type.find((t) => t.kind !== 'Any')) {
+        replacedTypes.type = replacedTypes.type.filter((t) => t.kind !== 'Any');
+    }
+    return replacedTypes;
+}
+//# sourceMappingURL=types.checks.js.map

package/dist/types.checks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.checks.js","sourceRoot":"","sources":["../src/types.checks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAGzD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAG7C,MAAM,UAAU,YAAY,CAC1B,IAAS,EACT,IAAO;IAEP,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,IAAS,EACT,IAAO;IAEP,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC;AACjD,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,IAAS,EACT,IAAO;IAEP,OAAO,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACnE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAqE,EACrE,IAA0B;IAE1B,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAQ,CAAC;IACxC,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAW,CAAC,CAEzC,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,IAAqE,EACrE,IAA0B;IAE1B,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAQ,CAAC;IACxC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAW,CAAC,CAAQ,CAAC;AACnE,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,kBAAkB,CAChC,IAA2C;IAE3C,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAKD,MAAM,UAAU,QAAQ,CAAC,KAA2B;IAClD,MAAM,KAAK,GAAW,EAAE,CAAC;IACzB,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YACxB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAS;IACtC,OAAO,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAS;IACnC,OAAO,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CACrB,UAAqC,EACrC,SAAoC;IAEpC,yBAAyB;IACzB,MAAM,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IACvC,oEAAoE;IACpE,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAClC,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CACvD,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,UAAgB,EAAE,SAAe;IACpD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IACE,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC;QACpD,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,EAC1C,CAAC;QACD,6CAA6C;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,SAAS,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kFAAkF;IAClF,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC;QAC7C,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,iFAAiF;IACjF,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,cAAc,EAAE,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG,CAAC,KAAK,IAAI,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,GAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,oBAAoB;IACpB,IACE,SAAS,CAAC,OAAO;QACjB,CAAC,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,EACxE,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,4BAA4B;IAC5B,IACE,SAAS,CAAC,aAAa;QACvB,CAAC,CAAC,UAAU,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAK,EAAE,SAAS,CAAC,IAAK,CAAC,CAAC,EAC1E,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,QAAkB,EAClB,UAAyB;IAEzB,MAAM,UAAU,GAAG,IAAI,SAAS,EAAE,CAAC;IACnC,IAAI,EAAE,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YAC/B,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC;YACnD,SAAS;QACX,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,IAAI;gBAC3C,CAAC,cAAc,EAAE,aAAa,CAAC;gBAC/B,CAAC,YAAY,EAAE,gBAAgB,CAAC;gBAChC,CAAC,YAAY,EAAE,QAAQ,CAAC;aAChB,EAAE,CAAC;gBACX,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW;oBAAE,SAAS;gBACxC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;oBAC7B,UAAU,CAAC,OAAO,CAChB,UAAU,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,CAAC,CAC7D,CAAC;gBACJ,CAAC;gBACD,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;oBAClD,2BAA2B;oBAC3B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI;wBACxB,CAAC,CAAC,GAAG,eAAe,IAAI,QAAQ,CAAC,IAAI,EAAE;wBACvC,CAAC,CAAC,eAAe,CAAC;oBACpB,IAAI,IAAI,GACN,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;wBACpB,UAAU,CAAC,GAAG,CAAC,eAAe,CAAC;wBAC/B,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC;oBAC5B,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;wBACvB,+EAA+E;wBAC/E,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBACzD,CAAC;oBACD,IAAI,WAAW,KAAK,YAAY,EAAE,CAAC;wBACjC,kEAAkE;wBAClE,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;wBACnB,KAAK,MAAM,MAAM,IAAI,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;4BAC5C,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gCAClB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;4BACzB,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC3B,CAAC;gBACD,SAAS,IAAI,CAAC,CAAC,kEAAkE;YACnF,CAAC;QACH,CAAC;QACD,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAAkB,EAClB,QAAkB,EAClB,UAAyB;AACzB,uDAAuD;AACvD,WAAmC,IAAI,GAAG,EAAE;IAE5C,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC;SACrC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC;SAC7C,IAAI,EAAE,CAAC;IACV,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC;SACrC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC;SAC7C,IAAI,EAAE,CAAC;IAEV,yDAAyD;IACzD,+DAA+D;IAC/D,iEAAiE;IACjE,uEAAuE;IACvE,mEAAmE;IACnE,uCAAuC;IACvC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACzC,IAAI,OAA8B,CAAC;QACnC,IAAI,YAAY,CAAC,SAAS,EAAE,CAAC;YAC3B,MAAM,WAAW,GAAG,YAAY,CAAC,IAAK,CAAC;YACvC,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,SAAS,EAAE,CAAC;YACvD,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACrC,CAAC;QACD,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,WAAW,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC;gBAC5C,IAAI,OAAO,EAAE,CAAC;oBACZ,4DAA4D;oBAC5D,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBAChC,CAAC;gBACD,8CAA8C;gBAC9C,IAAI,YAAY,CAAC,KAAK,EAAE,QAAQ,IAAI,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC;oBACjE,iBAAiB,CACf,YAAY,CAAC,KAAK,EAClB,YAAY,CAAC,KAAK,EAClB,UAAU,EACV,QAAQ,CACT,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,YAAsB,EACtB,UAAyB,EACzB,QAAgC;IAEhC,MAAM,aAAa,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;IAC7C,mEAAmE;IACnE,6MAA6M;IAC7M,MAAM,aAAa,GAAG,IAAI,SAAS,EAAE,CAAC;IACtC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACzC,MAAM,QAAQ,GACZ,YAAY,CAAC,SAAS,IAAI,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,IAAK,CAAC;YACxD,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,IAAK,CAAC,EAAE,IAAI;YACxC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QACrB,KAAK,MAAM,IAAI,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;YAClC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC9B,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YACpE,CAAC;YACD,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IACD,yDAAyD;IACzD,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QACrD,aAAa,CAAC,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,152 @@
+import { Flags } from './signifiers.flags.js';
+import { Signifier } from './signifiers.js';
+import { type KnownOrGenerics, type KnownTypesMap } from './types.feather.js';
+import { PrimitiveName, withableTypes } from './types.primitives.js';
+export type AnyType = Type<'Any'>;
+export type ArrayType = Type<'Array'>;
+export type BoolType = Type<'Bool'>;
+export type EnumType = Type<'Enum'>;
+export type FunctionType = Type<'Function'>;
+export type PointerType = Type<'Pointer'>;
+export type RealType = Type<'Real'>;
+export type StringType = Type<'String'>;
+export type StructType = Type<'Struct'>;
+export type UndefinedType = Type<'Undefined'>;
+export type UnknownType = Type<'Unknown'>;
+export type WithableType = Type<(typeof withableTypes)[number]>;
+/**
+ * A stable entity that represents a type. It should be used
+ * as the referenced container for any type information, so
+ * that the types can be changed within the container without
+ * breaking references.
+ */
+export declare class TypeStore<T extends PrimitiveName = PrimitiveName> extends Flags {
+    readonly $tag = "TypeStore";
+    protected _types: Type<T>[];
+    constructor();
+    /** If this store has only one type, its kind. Else throws. */
+    get kind(): "Array" | "Bool" | "Enum" | "Function" | "Pointer" | "Real" | "String" | "Struct" | "Undefined" | "ArgumentIdentity" | "Any" | "Asset.GMAnimCurve" | "Asset.GMAudioGroup" | "Asset.GMFont" | "Asset.GMObject" | "Asset.GMParticleSystem" | "Asset.GMPath" | "Asset.GMRoom" | "Asset.GMScript" | "Asset.GMSequence" | "Asset.GMShader" | "Asset.GMSound" | "Asset.GMSprite" | "Asset.GMTileSet" | "Asset.GMTimeline" | "Asset.Script" | "Id.AudioEmitter" | "Id.AudioListener" | "Id.AudioSyncGroup" | "Id.BackgroundElement" | "Id.BinaryFile" | "Id.Buffer" | "Id.Camera" | "Id.DsGrid" | "Id.DsList" | "Id.DsMap" | "Id.DsPriority" | "Id.DsQueue" | "Id.DsStack" | "Id.ExternalCall" | "Id.Gif" | "Id.Instance" | "Id.Layer" | "Id.MpGrid" | "Id.ParticleEmitter" | "Id.ParticleSystem" | "Id.ParticleType" | "Id.PhysicsIndex" | "Id.PhysicsParticleGroup" | "Id.Sampler" | "Id.SequenceElement" | "Id.Socket" | "Id.Sound" | "Id.SpriteElement" | "Id.Surface" | "Id.TextFile" | "Id.Texture" | "Id.TileElementId" | "Id.TileMapElement" | "Id.TimeSource" | "Id.Uniform" | "Id.VertexBuffer" | "Id.VertexFormat" | "Mixed" | "EnumMember" | "Unknown" | "Never" | "InstanceType" | "ObjectType" | "StaticType";
+    get type(): Type<T>[];
+    set type(types: Type<T> | Type<T>[] | undefined);
+    get hasTypes(): boolean;
+    get constructs(): StructType[];
+    get items(): TypeStore[];
+    get returns(): TypeStore[];
+    /**
+     * Should be used sparingly, since it means we're adding types in multiple steps instead of all at once.
+     */
+    addType(type: Type<T> | Type<T>[]): this;
+    narrows(other: TypeStore | Type | Type[]): boolean;
+    toFeatherString(): string;
+}
+export declare class Type<T extends PrimitiveName = PrimitiveName> {
+    protected _kind: T;
+    readonly $tag = "Type";
+    name: string | undefined;
+    description: string | undefined;
+    /** Signifiers associated with this type. */
+    _signifier: Signifier | undefined;
+    /**
+     * If set, then this Type is treated as a subset of the parent.
+     * It will only "match" another type if that type is in its
+     * parent somewhere. Useful for struct/constructor inheritence, as well
+     * as for e.g. representing a subset of Real constants in a type. */
+    protected _extends: Type | undefined;
+    protected _derived: Set<Type> | undefined;
+    protected flags: number;
+    /** Named members of Structs and Enums */
+    protected _members: Map<string, Signifier> | undefined;
+    /** Types of the items found in arrays and various ds types, or the fallback type found in Structs */
+    items: TypeStore | undefined;
+    /**
+     * For functions, the local variables declared within the function.
+     * A subset of these will be parameters, which are also signifiers.
+     */
+    local: Type<'Struct'> | undefined;
+    /**
+     * If this is a constructor function, then this is the
+     * type of the struct that it constructs.
+     * Otherwise it's the self-context of the function */
+    self: WithableType | undefined;
+    returns: TypeStore | undefined;
+    constructor(_kind: T);
+    protected setFlag(flag: number, value: boolean): void;
+    protected getFlag(flag: number): boolean;
+    /**
+     * Native and primitive types are typically read-only once
+     * they've been defined. This property should be set once a type
+     * is intended to be immutable.
+     */
+    get isReadonly(): boolean;
+    set isReadonly(value: boolean);
+    /**
+     * If this is a type used as a generic, then this will be true
+     */
+    get isGeneric(): boolean;
+    set isGeneric(value: boolean);
+    get isConstructor(): boolean;
+    set isConstructor(value: boolean);
+    get kind(): PrimitiveName;
+    set kind(newKind: PrimitiveName);
+    get signifier(): Signifier | undefined;
+    set signifier(signifier: Signifier);
+    get extends(): Type | undefined;
+    set extends(type: Type | undefined);
+    listDerived(recursive?: boolean): Type[];
+    get canBeSelf(): boolean;
+    /** If this type narrows `other` type, returns `true` */
+    narrows(other: Type | Type[] | TypeStore): boolean;
+    /** Get this type as a Feather-compatible string */
+    toFeatherString(): string;
+    get code(): string;
+    get details(): string;
+    get isFunction(): boolean;
+    setReturnType(type: Type | TypeStore | (Type | TypeStore)[]): this;
+    /** Prefer `setReturnType` where possible */
+    addReturnType(type: Type | Type[]): this;
+    listParameters(): (Signifier | undefined)[];
+    getParameter(name: string): Signifier | undefined;
+    getParameter(idx: number): Signifier | undefined;
+    /** A parameter is a special type of local variable. */
+    addParameter(idx: number, nameOrParam: string | Signifier, options?: {
+        type?: Type | Type[];
+        optional?: boolean;
+    }): Signifier;
+    truncateParameters(count: number): void;
+    totalMembers(excludeParents?: boolean): number;
+    listMembers(excludeParents?: boolean): Signifier[];
+    getMember(name: string, excludeParents?: boolean): Signifier | undefined;
+    /** For container types that have named members, like Structs and Enums */
+    addMember(newMember: Signifier | string, options?: {
+        type?: Type | Type[];
+        writable?: boolean;
+        override?: boolean;
+    }): Signifier | undefined;
+    protected replaceMemberInChildren(member: Signifier): void;
+    removeMember(name: string): void;
+    /**
+     * For container types that have non-named members, like arrays and DsTypes.
+     * Can also be used for default Struct values. */
+    addItemType(type: Type): this;
+    /**
+     * For container types that have non-named members, like arrays and DsTypes.
+     * Can also be used for default Struct values. */
+    setItemType(type: Type): this;
+    /**
+     * Create a derived type: of the same kind, pointing to
+     * this type as its parent. */
+    derive(): Type<T>;
+    named(name: string | undefined): this;
+    describe(description: string | undefined): this;
+    genericize(): this;
+    /** Given a Feather-compatible type string, get a fully parsed type. */
+    static fromFeatherString(typeString: string, knownTypes: KnownTypesMap | KnownOrGenerics[], addMissing: boolean): Type[];
+    static get Any(): Type<"Any">;
+    static get Real(): Type<"Real">;
+    static get String(): Type<"String">;
+    static get Bool(): Type<"Bool">;
+    static get Undefined(): Type<"Undefined">;
+    static get Struct(): Type<"Struct">;
+    static get Function(): Type<"Function">;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,aAAa,EACnB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAGrE,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;AAClC,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;AACtC,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;AACpC,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;AACpC,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;AAC5C,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;AAC1C,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;AACpC,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;AACxC,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;AACxC,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;AAC9C,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;AAC1C,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAEhE;;;;;GAKG;AACH,qBAAa,SAAS,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,KAAK;IAC3E,QAAQ,CAAC,IAAI,eAAe;IAC5B,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAM;;IAMjC,8DAA8D;IAC9D,IAAI,IAAI,ypCAOP;IAED,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAEpB;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAE9C;IAED,IAAI,QAAQ,YAEX;IAED,IAAI,UAAU,IAAI,UAAU,EAAE,CAI7B;IAED,IAAI,KAAK,IAAI,SAAS,EAAE,CAEvB;IAED,IAAI,OAAO,IAAI,SAAS,EAAE,CAEzB;IAED;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAKxC,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI,EAAE,GAAG,OAAO;IAIlD,eAAe,IAAI,MAAM;CAM1B;AAQD,qBAAa,IAAI,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa;IAwC3C,SAAS,CAAC,KAAK,EAAE,CAAC;IAvC9B,QAAQ,CAAC,IAAI,UAAU;IAKvB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAa;IACrC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAa;IAC5C,4CAA4C;IAC5C,UAAU,EAAE,SAAS,GAAG,SAAS,CAAa;IAE9C;;;;wEAIoE;IACpE,SAAS,CAAC,QAAQ,EAAE,IAAI,GAAG,SAAS,CAAa;IACjD,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,CAAa;IAEtD,SAAS,CAAC,KAAK,SAAK;IAEpB,yCAAyC;IACzC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,SAAS,CAAa;IAEnE,qGAAqG;IACrG,KAAK,EAAE,SAAS,GAAG,SAAS,CAAa;IAGzC;;;OAGG;IACH,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAa;IAC9C;;;yDAGqD;IACrD,IAAI,EAAE,YAAY,GAAG,SAAS,CAAa;IAC3C,OAAO,EAAE,SAAS,GAAG,SAAS,CAAa;gBAErB,KAAK,EAAE,CAAC;IAE9B,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;IAO9C,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM;IAI9B;;;;OAIG;IACH,IAAI,UAAU,IAGQ,OAAO,CAD5B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,OAAO,EAE5B;IACD;;OAEG;IACH,IAAI,SAAS,IAGQ,OAAO,CAD3B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,EAE3B;IACD,IAAI,aAAa,IAGQ,OAAO,CAD/B;IACD,IAAI,aAAa,CAAC,KAAK,EAAE,OAAO,EAE/B;IAED,IAAI,IAAI,IAGU,aAAa,CAD9B;IACD,IAAI,IAAI,CAAC,OAAO,EAAE,aAAa,EAM9B;IAED,IAAI,SAAS,IAAI,SAAS,GAAG,SAAS,CAErC;IACD,IAAI,SAAS,CAAC,SAAS,EAAE,SAAS,EAGjC;IAED,IAAI,OAAO,IAGO,IAAI,GAAG,SAAS,CADjC;IACD,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,EAQjC;IACD,WAAW,CAAC,SAAS,UAAQ,GAAG,IAAI,EAAE;IAatC,IAAI,SAAS,YAEZ;IAED,wDAAwD;IACxD,OAAO,CAAC,KAAK,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,SAAS,GAAG,OAAO;IAIlD,mDAAmD;IACnD,eAAe,IAAI,MAAM;IAIzB,IAAI,IAAI,WAEP;IAED,IAAI,OAAO,WAEV;IAED,IAAI,UAAU,YAEb;IAED,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,GAAG,CAAC,IAAI,GAAG,SAAS,CAAC,EAAE;IAO3D,4CAA4C;IAC5C,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE;IAOjC,cAAc,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,EAAE;IAgB3C,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IACjD,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAShD,uDAAuD;IACvD,YAAY,CACV,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC;QACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,GACA,SAAS;IAgCZ,kBAAkB,CAAC,KAAK,EAAE,MAAM;IAQhC,YAAY,CAAC,cAAc,UAAQ,GAAG,MAAM;IAY5C,WAAW,CAAC,cAAc,UAAQ,GAAG,SAAS,EAAE;IAYhD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,cAAc,UAAQ,GAAG,SAAS,GAAG,SAAS;IAWtE,0EAA0E;IAC1E,SAAS,CACP,SAAS,EAAE,SAAS,GAAG,MAAM,EAC7B,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC;QACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,GACA,SAAS,GAAG,SAAS;IAiExB,SAAS,CAAC,uBAAuB,CAAC,MAAM,EAAE,SAAS;IAuBnD,YAAY,CAAC,IAAI,EAAE,MAAM;IAYzB;;qDAEiD;IACjD,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAM7B;;qDAEiD;IACjD,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAM7B;;kCAE8B;IAC9B,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC;IAOjB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAKrC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAK/C,UAAU,IAAI,IAAI;IAKlB,uEAAuE;IACvE,MAAM,CAAC,iBAAiB,CACtB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,aAAa,GAAG,eAAe,EAAE,EAC7C,UAAU,EAAE,OAAO,GAClB,IAAI,EAAE;IAIT,MAAM,KAAK,GAAG,gBAEb;IAED,MAAM,KAAK,IAAI,iBAEd;IAED,MAAM,KAAK,MAAM,mBAEhB;IAED,MAAM,KAAK,IAAI,iBAEd;IAED,MAAM,KAAK,SAAS,sBAEnB;IAED,MAAM,KAAK,MAAM,mBAEhB;IAED,MAAM,KAAK,QAAQ,qBAElB;CACF"}

package/dist/types.feather.d.ts

@@ -0,0 +1,21 @@
+import { type FeatherType, type FeatherTypeUnion } from './jsdoc.feather.js';
+import type { JsdocSummary } from './jsdoc.js';
+import { Type } from './types.js';
+export type KnownTypesMap = Map<string, Type>;
+export type GenericsMap = Record<string, Type[]>;
+export type KnownOrGenerics = KnownTypesMap | GenericsMap;
+export declare function typeFromFeatherString(typeString: string, knownTypes: KnownTypesMap | KnownOrGenerics[], addMissing: boolean): Type[];
+/**
+ * Given a type identifier, get a parsed Type instance. Useful for
+ * the "leaves" of a type tree, e.g. "String" or "Struct.Mystruct".
+ * Only creates primitive types, e.g. "Struct.MyStruct" will return
+ * a plain `Type<"Struct">` instance.
+ *
+ * When knownTypes are provided, will return a known type by exact
+ * identifier match if it exists. Otherwise a new type instance will
+ * be created *and added to the knownTypes map*.
+ */
+export declare function typeFromIdentifier(identifier: string, knownTypes: KnownTypesMap | KnownOrGenerics[], addMissing: boolean, __isRootRequest?: boolean): Type;
+export declare function typeFromParsedJsdocs(jsdoc: JsdocSummary, knownTypes: Map<string, Type>, addMissing: boolean): Type[];
+export declare function typeFromParsedFeatherString(node: FeatherTypeUnion | FeatherType, knownTypes: KnownTypesMap | KnownOrGenerics[], addMissing: boolean): Type[];
+//# sourceMappingURL=types.feather.d.ts.map

package/dist/types.feather.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.feather.d.ts","sourceRoot":"","sources":["../src/types.feather.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAIlC,MAAM,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC9C,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AACjD,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,WAAW,CAAC;AAqB1D,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,aAAa,GAAG,eAAe,EAAE,EAC7C,UAAU,EAAE,OAAO,GAClB,IAAI,EAAE,CAGR;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,aAAa,GAAG,eAAe,EAAE,EAC7C,UAAU,EAAE,OAAO,EACnB,eAAe,UAAO,GACrB,IAAI,CA4CN;AAED,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,YAAY,EACnB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAC7B,UAAU,EAAE,OAAO,GAClB,IAAI,EAAE,CA2ER;AACD,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,gBAAgB,GAAG,WAAW,EACpC,UAAU,EAAE,aAAa,GAAG,eAAe,EAAE,EAC7C,UAAU,EAAE,OAAO,GAClB,IAAI,EAAE,CAyCR"}

package/dist/types.feather.js

@@ -0,0 +1,156 @@
+import { arrayWrapped } from '@bscotch/utility';
+import { parseFeatherTypeString, } from './jsdoc.feather.js';
+import { Type } from './types.js';
+import { primitiveNames } from './types.primitives.js';
+import { ok } from './util.js';
+function findInKnownOrGenerics(identifier, knownTypes) {
+    const collections = arrayWrapped(knownTypes);
+    for (const collection of collections) {
+        let found;
+        if (collection instanceof Map) {
+            found = collection.get(identifier);
+        }
+        else {
+            found = collection[identifier];
+        }
+        if (found) {
+            return arrayWrapped(found);
+        }
+    }
+    return;
+}
+export function typeFromFeatherString(typeString, knownTypes, addMissing) {
+    const parsed = parseFeatherTypeString(typeString);
+    return typeFromParsedFeatherString(parsed, knownTypes, addMissing);
+}
+/**
+ * Given a type identifier, get a parsed Type instance. Useful for
+ * the "leaves" of a type tree, e.g. "String" or "Struct.Mystruct".
+ * Only creates primitive types, e.g. "Struct.MyStruct" will return
+ * a plain `Type<"Struct">` instance.
+ *
+ * When knownTypes are provided, will return a known type by exact
+ * identifier match if it exists. Otherwise a new type instance will
+ * be created *and added to the knownTypes map*.
+ */
+export function typeFromIdentifier(identifier, knownTypes, addMissing, __isRootRequest = true) {
+    ok(identifier.match(/^[A-Z][A-Z0-9._]*$/i), `Invalid type name ${identifier}`);
+    const normalizedName = identifier?.toLocaleLowerCase?.();
+    const isObjectType = ['asset.gmobject', 'id.instance'].includes(normalizedName);
+    const knownType = findInKnownOrGenerics(identifier, knownTypes)?.[0];
+    if (knownType && isObjectType) {
+        // Need a derived type to prevent mutation of the parent!
+        return knownType.derive();
+    }
+    else if (knownType) {
+        return knownType;
+    }
+    const primitiveType = primitiveNames.find((n) => n?.toLocaleLowerCase?.() === normalizedName);
+    if (primitiveType) {
+        return new Type(primitiveType);
+    }
+    if (identifier.match(/\./)) {
+        // Then we might still be able to get a base type.
+        const [baseType, ...nameParts] = identifier.split('.');
+        const type = typeFromIdentifier(baseType, knownTypes, addMissing, false);
+        if (__isRootRequest && type) {
+            // Then add to the known types map
+            const derivedTyped = type.derive().named(nameParts.join('.'));
+            // Types should only be auto-added when loading the native spec
+            if (addMissing) {
+                const map = arrayWrapped(knownTypes).find((collection) => collection instanceof Map);
+                map?.set(identifier, derivedTyped);
+            }
+            return derivedTyped;
+        }
+        return type;
+    }
+    return new Type('Undefined');
+}
+export function typeFromParsedJsdocs(jsdoc, knownTypes, addMissing) {
+    if (jsdoc.kind === 'description') {
+        // Then we have no type info.
+        return [];
+    }
+    else if (['type', 'instancevar', 'globalvar', 'localvar'].includes(jsdoc.kind)) {
+        // Then this was purely a type annotation. Create the type and
+        // add any metadata.
+        return typeFromFeatherString(jsdoc.type?.content || 'Any', knownTypes, addMissing);
+    }
+    else if (jsdoc.kind === 'self') {
+        // The self-type could be a function, in which case
+        // we want to use its "self" as the type instead of
+        // the function itself.
+        const matchingType = typeFromFeatherString(jsdoc.self?.content || 'Any', knownTypes, addMissing)
+            .map((t) => (t.kind === 'Function' ? t.self : t))
+            .filter((x) => !!x);
+        return matchingType;
+    }
+    else if (jsdoc.kind === 'function') {
+        const type = new Type('Function').describe(jsdoc.description);
+        let i = 0;
+        const generics = {};
+        for (const generic of jsdoc.templates || []) {
+            generics[generic.name.content] = typeFromFeatherString(generic.type?.content || 'Any', knownTypes, addMissing);
+            // Flag them all as generic, named after the generic name
+            for (const genericType of generics[generic.name.content]) {
+                genericType.isGeneric = true;
+                genericType.named(generic.name.content);
+            }
+        }
+        if (jsdoc.self) {
+            type.self = typeFromFeatherString(jsdoc.self.content, knownTypes, addMissing)[0];
+        }
+        if (jsdoc.returns && jsdoc.returns.type) {
+            const returnType = typeFromFeatherString(jsdoc.returns.type.content, [knownTypes, generics], addMissing);
+            type.addReturnType(returnType);
+        }
+        for (const param of jsdoc.params || []) {
+            const member = type.addParameter(i, param.name.content);
+            if (param.type) {
+                member.setType(typeFromFeatherString(param.type.content, [knownTypes, generics], addMissing));
+            }
+            i++;
+            member.optional = !!param.optional;
+            member.describe(param.description);
+        }
+        return [type];
+    }
+    return [];
+}
+export function typeFromParsedFeatherString(node, knownTypes, addMissing) {
+    if (node.kind === 'type') {
+        const identifier = node.name;
+        let type = typeFromIdentifier(identifier.content, knownTypes, addMissing);
+        if (node.of) {
+            const subtypes = typeFromParsedFeatherString(node.of, knownTypes, addMissing);
+            // Then we need to create a new type instead of mutating
+            // the one we found.
+            type = type.derive();
+            // While only some types are "containers", we can
+            // go ahead and add any contained types and worry
+            // about the consequences later. That way we don't
+            // need to keep updating this as we add more container
+            // types.
+            for (const subtype of subtypes) {
+                type.addItemType(subtype);
+            }
+            // TODO: Else create a diagnostic?
+        }
+        return [type];
+    }
+    else if (node.kind === 'union') {
+        const unionOf = node.types;
+        if (unionOf.length === 1) {
+            return typeFromParsedFeatherString(unionOf[0], knownTypes, addMissing);
+        }
+        const types = [];
+        for (const child of unionOf) {
+            const subtype = typeFromParsedFeatherString(child, knownTypes, addMissing);
+            types.push(...subtype);
+        }
+        return types;
+    }
+    throw new Error(`Unknown node type ${node['name']}`);
+}
+//# sourceMappingURL=types.feather.js.map

package/dist/types.feather.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.feather.js","sourceRoot":"","sources":["../src/types.feather.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EACL,sBAAsB,GAGvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AAM/B,SAAS,qBAAqB,CAC5B,UAAkB,EAClB,UAA6C;IAE7C,MAAM,WAAW,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;IAC7C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,IAAI,KAAgC,CAAC;QACrC,IAAI,UAAU,YAAY,GAAG,EAAE,CAAC;YAC9B,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;QACjC,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,OAAO;AACT,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,UAAkB,EAClB,UAA6C,EAC7C,UAAmB;IAEnB,MAAM,MAAM,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAClD,OAAO,2BAA2B,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAChC,UAAkB,EAClB,UAA6C,EAC7C,UAAmB,EACnB,eAAe,GAAG,IAAI;IAEtB,EAAE,CACA,UAAU,CAAC,KAAK,CAAC,qBAAqB,CAAC,EACvC,qBAAqB,UAAU,EAAE,CAClC,CAAC;IACF,MAAM,cAAc,GAAG,UAAU,EAAE,iBAAiB,EAAE,EAAE,CAAC;IACzD,MAAM,YAAY,GAAG,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC,QAAQ,CAC7D,cAAqB,CACtB,CAAC;IAEF,MAAM,SAAS,GAAG,qBAAqB,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACrE,IAAI,SAAS,IAAI,YAAY,EAAE,CAAC;QAC9B,yDAAyD;QACzD,OAAO,SAAS,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;SAAM,IAAI,SAAS,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,iBAAiB,EAAE,EAAE,KAAK,cAAc,CACnD,CAAC;IACF,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,kDAAkD;QAClD,MAAM,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,kBAAkB,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QACzE,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;YAC5B,kCAAkC;YAClC,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9D,+DAA+D;YAC/D,IAAI,UAAU,EAAE,CAAC;gBACf,MAAM,GAAG,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,IAAI,CACvC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,YAAY,GAAG,CACb,CAAC;gBAC/B,GAAG,EAAE,GAAG,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YACrC,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,KAAmB,EACnB,UAA6B,EAC7B,UAAmB;IAEnB,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACjC,6BAA6B;QAC7B,OAAO,EAAE,CAAC;IACZ,CAAC;SAAM,IACL,CAAC,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EACrE,CAAC;QACD,8DAA8D;QAC9D,oBAAoB;QACpB,OAAO,qBAAqB,CAC1B,KAAK,CAAC,IAAI,EAAE,OAAO,IAAI,KAAK,EAC5B,UAAU,EACV,UAAU,CACX,CAAC;IACJ,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACjC,mDAAmD;QACnD,mDAAmD;QACnD,uBAAuB;QACvB,MAAM,YAAY,GAAG,qBAAqB,CACxC,KAAK,CAAC,IAAI,EAAE,OAAO,IAAI,KAAK,EAC5B,UAAU,EACV,UAAU,CACX;aACE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAChD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC;QAChC,OAAO,YAAY,CAAC;IACtB,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,MAAM,QAAQ,GAA2B,EAAE,CAAC;QAC5C,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;YAC5C,QAAQ,CAAC,OAAO,CAAC,IAAK,CAAC,OAAO,CAAC,GAAG,qBAAqB,CACrD,OAAO,CAAC,IAAI,EAAE,OAAO,IAAI,KAAK,EAC9B,UAAU,EACV,UAAU,CACX,CAAC;YACF,yDAAyD;YACzD,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC1D,WAAW,CAAC,SAAS,GAAG,IAAI,CAAC;gBAC7B,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,IAAK,CAAC,OAAO,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAC/B,KAAK,CAAC,IAAK,CAAC,OAAO,EACnB,UAAU,EACV,UAAU,CACX,CAAC,CAAC,CAAc,CAAC;QACpB,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACxC,MAAM,UAAU,GAAG,qBAAqB,CACtC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAC1B,CAAC,UAAU,EAAE,QAAQ,CAAC,EACtB,UAAU,CACX,CAAC;YACF,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACjC,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,IAAK,CAAC,OAAO,CAAC,CAAC;YACzD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACf,MAAM,CAAC,OAAO,CACZ,qBAAqB,CACnB,KAAK,CAAC,IAAI,CAAC,OAAO,EAClB,CAAC,UAAU,EAAE,QAAQ,CAAC,EACtB,UAAU,CACX,CACF,CAAC;YACJ,CAAC;YACD,CAAC,EAAE,CAAC;YACJ,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;YACnC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AACD,MAAM,UAAU,2BAA2B,CACzC,IAAoC,EACpC,UAA6C,EAC7C,UAAmB;IAEnB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC;QAC7B,IAAI,IAAI,GAAG,kBAAkB,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAC1E,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,QAAQ,GAAG,2BAA2B,CAC1C,IAAI,CAAC,EAAE,EACP,UAAU,EACV,UAAU,CACX,CAAC;YACF,wDAAwD;YACxD,oBAAoB;YACpB,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACrB,iDAAiD;YACjD,iDAAiD;YACjD,kDAAkD;YAClD,sDAAsD;YACtD,SAAS;YACT,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YAC5B,CAAC;YACD,kCAAkC;QACpC,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QACzE,CAAC;QACD,MAAM,KAAK,GAAW,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,2BAA2B,CACzC,KAAK,EACL,UAAU,EACV,UAAU,CACX,CAAC;YACF,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;QACzB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,qBAAqB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AACvD,CAAC"}

package/dist/types.hover.d.ts

@@ -0,0 +1,4 @@
+import type { Type } from './types.js';
+export declare function typeToHoverDetails(type: Type): string;
+export declare function typeToHoverText(type: Type): string;
+//# sourceMappingURL=types.hover.d.ts.map

package/dist/types.hover.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.hover.d.ts","sourceRoot":"","sources":["../src/types.hover.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAYvC,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,IAAI,UA0D5C;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,UA4BzC"}