@spyglassmc/core 0.1.0

package/lib/symbol/Symbol.js

@@ -0,0 +1,324 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _SymbolPathCollector_set;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SymbolTable = exports.SymbolLocation = exports.Symbol = exports.SymbolUsageType = exports.SymbolUsageTypes = exports.SymbolPathCollector = exports.SymbolPath = exports.ResourceLocationCategory = exports.ResourceLocationCategories = exports.AllCategories = exports.DatapackCategories = exports.MiscCategories = exports.FileCategories = exports.TagFileCategories = exports.TaggableResourceLocationCategories = exports.WorldgenFileCategories = exports.RegistryCategories = exports.NbtdocCategories = void 0;
+const rfdc_1 = __importDefault(require("rfdc"));
+const common_1 = require("../common");
+const source_1 = require("../source");
+//#region NBTDoc Categories
+exports.NbtdocCategories = Object.freeze([
+    'nbtdoc',
+    'nbtdoc/description',
+]);
+//#endregion
+//#region Registry Categories
+// Data in `java-edition/src/binder/index.ts` may need to be updated when this section is changed.
+exports.RegistryCategories = Object.freeze([
+    'activity',
+    'attribute',
+    'block',
+    'block_entity_type',
+    'block_predicate_type',
+    'chunk_status',
+    'custom_stat',
+    'enchantment',
+    'entity_type',
+    'float_provider_type',
+    'fluid',
+    'game_event',
+    'height_provider_type',
+    'int_provider_type',
+    'item',
+    'loot_condition_type',
+    'loot_function_type',
+    'loot_nbt_provider_type',
+    'loot_number_provider_type',
+    'loot_pool_entry_type',
+    'loot_score_provider_type',
+    'memory_module_type',
+    'menu',
+    'mob_effect',
+    'motive',
+    'particle_type',
+    'point_of_interest_type',
+    'pos_rule_test',
+    'position_source_type',
+    'potion',
+    'recipe_serializer',
+    'recipe_type',
+    'rule_test',
+    'schedule',
+    'sensor_type',
+    'sound_event',
+    'stat_type',
+    'villager_profession',
+    'villager_type',
+    'worldgen/biome_source',
+    'worldgen/block_placer_type',
+    'worldgen/block_state_provider_type',
+    'worldgen/carver',
+    'worldgen/chunk_generator',
+    'worldgen/decorator',
+    'worldgen/feature',
+    'worldgen/feature_size_type',
+    'worldgen/foliage_placer_type',
+    'worldgen/material_condition',
+    'worldgen/material_rule',
+    'worldgen/placement_modifier_type',
+    'worldgen/structure_feature',
+    'worldgen/structure_piece',
+    'worldgen/structure_pool_element',
+    'worldgen/structure_processor',
+    'worldgen/surface_builder',
+    'worldgen/tree_decorator_type',
+    'worldgen/trunk_placer_type',
+]);
+//#endregion
+//#region Data Pack Categories
+exports.WorldgenFileCategories = Object.freeze([
+    'worldgen/biome',
+    'worldgen/configured_carver',
+    'worldgen/configured_feature',
+    'worldgen/configured_structure_feature',
+    'worldgen/configured_surface_builder',
+    'worldgen/noise',
+    'worldgen/noise_settings',
+    'worldgen/placed_feature',
+    'worldgen/processor_list',
+    'worldgen/template_pool',
+]);
+exports.TaggableResourceLocationCategories = Object.freeze([
+    'function',
+    ...exports.RegistryCategories,
+    ...exports.WorldgenFileCategories,
+]);
+exports.TagFileCategories = Object.freeze(exports.TaggableResourceLocationCategories.map(key => `tag/${key}`));
+exports.FileCategories = Object.freeze([
+    'advancement',
+    'dimension',
+    'dimension_type',
+    'function',
+    'item_modifier',
+    'loot_table',
+    'predicate',
+    'recipe',
+    'structure',
+    ...exports.TagFileCategories,
+    ...exports.WorldgenFileCategories,
+]);
+exports.MiscCategories = Object.freeze([
+    'attribute_modifier_uuid',
+    'bossbar',
+    'objective',
+    'score_holder',
+    'storage',
+    'tag',
+    'team',
+]);
+exports.DatapackCategories = Object.freeze([
+    ...exports.FileCategories,
+    ...exports.MiscCategories,
+]);
+//#endregion
+exports.AllCategories = Object.freeze([
+    ...exports.DatapackCategories,
+    ...exports.NbtdocCategories,
+    ...exports.RegistryCategories,
+]);
+exports.ResourceLocationCategories = Object.freeze([
+    'bossbar',
+    'storage',
+    ...exports.FileCategories,
+    ...exports.RegistryCategories,
+]);
+var ResourceLocationCategory;
+(function (ResourceLocationCategory) {
+    function is(category) {
+        return exports.ResourceLocationCategories.includes(category);
+    }
+    ResourceLocationCategory.is = is;
+})(ResourceLocationCategory = exports.ResourceLocationCategory || (exports.ResourceLocationCategory = {}));
+var SymbolPath;
+(function (SymbolPath) {
+    function fromSymbol(symbol) {
+        return symbol
+            ? { category: symbol.category, path: symbol.path }
+            : undefined;
+    }
+    SymbolPath.fromSymbol = fromSymbol;
+    /**
+     * Equivalent {@link SymbolPath}s will always be serialized into the same string value.
+     */
+    function toString(path) {
+        return JSON.stringify({ category: path.category, path: path.path });
+    }
+    SymbolPath.toString = toString;
+    function fromString(value) {
+        return JSON.parse(value);
+    }
+    SymbolPath.fromString = fromString;
+})(SymbolPath = exports.SymbolPath || (exports.SymbolPath = {}));
+class SymbolPathCollector {
+    constructor() {
+        _SymbolPathCollector_set.set(this, new Set());
+    }
+    add(path) {
+        if (!path) {
+            return;
+        }
+        __classPrivateFieldGet(this, _SymbolPathCollector_set, "f").add(SymbolPath.toString(path));
+    }
+    has(path) {
+        return __classPrivateFieldGet(this, _SymbolPathCollector_set, "f").has(SymbolPath.toString(path));
+    }
+    collect() {
+        return [...__classPrivateFieldGet(this, _SymbolPathCollector_set, "f")].map(SymbolPath.fromString);
+    }
+}
+exports.SymbolPathCollector = SymbolPathCollector;
+_SymbolPathCollector_set = new WeakMap();
+exports.SymbolUsageTypes = Object.freeze(['definition', 'declaration', 'implementation', 'reference', 'typeDefinition']);
+var SymbolUsageType;
+(function (SymbolUsageType) {
+    function is(value) {
+        return exports.SymbolUsageTypes.includes(value);
+    }
+    SymbolUsageType.is = is;
+})(SymbolUsageType = exports.SymbolUsageType || (exports.SymbolUsageType = {}));
+var Symbol;
+(function (Symbol) {
+    function get(table, category, ...path) {
+        if ((0, common_1.isIterable)(table)) {
+            for (const t of table) {
+                const result = get(t, category, ...path);
+                if (result) {
+                    return result;
+                }
+            }
+            return undefined;
+        }
+        const map = table[category];
+        for (const p of path) {
+        }
+        return undefined;
+    }
+    Symbol.get = get;
+})(Symbol = exports.Symbol || (exports.Symbol = {}));
+var SymbolLocation;
+(function (SymbolLocation) {
+    /* istanbul ignore next */
+    function create(doc, range, fullRange, contributor, additional) {
+        return {
+            ...source_1.Location.create(doc, range),
+            ...fullRange ? { fullRange: source_1.Range.get(fullRange), fullPosRange: source_1.PositionRange.from(fullRange, doc) } : {},
+            ...contributor ? { contributor } : {},
+            ...additional ? additional : {},
+        };
+    }
+    SymbolLocation.create = create;
+})(SymbolLocation = exports.SymbolLocation || (exports.SymbolLocation = {}));
+var SymbolTable;
+(function (SymbolTable) {
+    /**
+     * The passed-in parameter `table` won't be mutated.
+     *
+     * @returns An identical symbol table where each Symbol's `parentMap` and `parentSymbol` properties
+     * are set properly.
+     */
+    function link(table) {
+        const linkSymbol = (symbol, parentMap, parentSymbol, category, path) => {
+            symbol.category = category;
+            symbol.identifier = path[path.length - 1];
+            symbol.path = path;
+            symbol.parentMap = parentMap;
+            if (parentSymbol) {
+                symbol.parentSymbol = parentSymbol;
+            }
+            if (symbol.members) {
+                linkSymbolMap(symbol.members, symbol, category, path);
+            }
+        };
+        const linkSymbolMap = (map, parentSymbol, category, path) => {
+            for (const [identifier, childSymbol] of Object.entries(map)) {
+                linkSymbol(childSymbol, map, parentSymbol, category, [...path, identifier]);
+            }
+        };
+        const ans = (0, rfdc_1.default)()(table);
+        for (const [category, map] of Object.entries(ans)) {
+            linkSymbolMap(map, undefined, category, []);
+        }
+        return ans;
+    }
+    SymbolTable.link = link;
+    /**
+     * The passed-in parameter `table` won't be mutated.
+     *
+     * @returns An identical symbol table where each Symbol's `parentMap` and `parentSymbol` properties
+     * are deleted.
+     */
+    function unlink(table) {
+        const unlinkSymbol = (symbol) => {
+            delete symbol.category;
+            delete symbol.identifier;
+            delete symbol.parentMap;
+            delete symbol.parentSymbol;
+            delete symbol.path;
+            if (symbol.members) {
+                unlinkSymbolMap(symbol.members);
+            }
+        };
+        const unlinkSymbolMap = (map) => {
+            for (const childSymbol of Object.values(map)) {
+                unlinkSymbol(childSymbol);
+            }
+        };
+        const ans = (0, rfdc_1.default)({ circles: true })(table);
+        for (const map of Object.values(ans)) {
+            unlinkSymbolMap(map);
+        }
+        return ans;
+    }
+    SymbolTable.unlink = unlink;
+    /**
+     * @returns A serialized string representation of this symbol table. It can be turned back into
+     * a symbol table through the {@link deserialize} method.
+     */
+    function serialize(table) {
+        return JSON.stringify(unlink(table));
+    }
+    SymbolTable.serialize = serialize;
+    /**
+     * @returns The symbol table represented by the string returned by the {@link serialize} method.
+     */
+    function deserialize(json) {
+        return link(JSON.parse(json));
+    }
+    SymbolTable.deserialize = deserialize;
+})(SymbolTable = exports.SymbolTable || (exports.SymbolTable = {}));
+// interface SymbolEvent {
+// 	symbol: Symbol,
+// }
+// interface SymbolLocationEvent extends SymbolEvent {
+// 	type: SymbolUsageType,
+// 	location: SymbolLocation,
+// }
+// export class CachedSymbolTable extends TypedEmitter<{
+// 	symbolCreated: (e: SymbolEvent) => unknown,
+// 	symbolAmended: (e: SymbolEvent) => unknown,
+// 	symbolRemoved: (e: SymbolEvent) => unknown,
+// 	symbolLocationCreated: (e: SymbolLocationEvent) => unknown,
+// 	symbolLocationRemoved: (e: SymbolLocationEvent) => unknown,
+// }> {
+// 	constructor(public readonly table: SymbolTable) {
+// 		super()
+// 	}
+// }
+//# sourceMappingURL=Symbol.js.map