@spyglassmc/core 0.2.0 → 0.3.0

package/lib/symbol/Symbol.d.ts

@@ -1,4 +1,5 @@
 import type { TextDocument } from 'vscode-languageserver-textdocument';
+import type { DeepReadonly } from '../common/index.js';
 import type { RangeLike } from '../source/index.js';
 import { PositionRange, Range } from '../source/index.js';
 export declare const McdocCategories: readonly ["mcdoc", "mcdoc/dispatcher"];
@@ -39,8 +40,8 @@ export interface SymbolPath {
     path: readonly string[];
 }
 export declare namespace SymbolPath {
-    function fromSymbol(symbol: Symbol): SymbolPath;
-    function fromSymbol(symbol: Symbol | undefined): SymbolPath | undefined;
+    function fromSymbol(symbol: DeepReadonly<Symbol>): SymbolPath;
+    function fromSymbol(symbol: DeepReadonly<Symbol> | undefined): SymbolPath | undefined;
     /**
      * Equivalent {@link SymbolPath}s will always be serialized into the same string value.
      */

package/lib/symbol/SymbolUtil.d.ts

@@ -1,5 +1,5 @@
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import type { ExternalEventEmitter, Externals } from '../common/index.js';
+import type { DeepReadonly, ExternalEventEmitter, Externals } from '../common/index.js';
 import type { AstNode } from '../node/index.js';
 import type { RangeLike } from '../source/index.js';
 import type { AllCategory, Symbol, SymbolLocationBuiltInContributor, SymbolLocationMetadata, SymbolMap, SymbolMetadata, SymbolTable, SymbolUsageType } from './Symbol.js';
@@ -179,27 +179,27 @@ export declare class SymbolUtil implements ExternalEventEmitter {
     /**
      * @returns If the symbol has declarations or definitions.
      */
-    static isDeclared(symbol: Symbol | undefined): boolean;
+    static isDeclared(symbol: DeepReadonly<Symbol> | undefined): boolean;
     /**
      * @returns If the symbol has definitions, or declarations and implementations.
      */
-    static isDefined(symbol: Symbol | undefined): symbol is Symbol;
+    static isDefined(symbol: DeepReadonly<Symbol> | undefined): symbol is Symbol;
     /**
      * @returns If the symbol has implementations or definitions.
      */
-    static isImplemented(symbol: Symbol | undefined): symbol is Symbol;
+    static isImplemented(symbol: DeepReadonly<Symbol> | undefined): symbol is Symbol;
     /**
      * @returns If the symbol has references.
      */
-    static isReferenced(symbol: Symbol | undefined): symbol is Symbol;
+    static isReferenced(symbol: DeepReadonly<Symbol> | undefined): symbol is Symbol;
     /**
      * @returns If the symbol has type definitions.
      */
-    static isTypeDefined(symbol: Symbol | undefined): symbol is Symbol;
+    static isTypeDefined(symbol: DeepReadonly<Symbol> | undefined): symbol is Symbol;
     /**
      * @throws If the symbol does not have any declarations or definitions.
      */
-    static getDeclaredLocation(symbol: Symbol): SymbolLocation;
+    static getDeclaredLocation(symbol: DeepReadonly<Symbol>): SymbolLocation;
     static forEachSymbolInMap(map: SymbolMap, fn: (symbol: Symbol) => unknown): void;
     static forEachSymbol(table: SymbolTable, fn: (symbol: Symbol) => unknown): void;
     static forEachLocationOfSymbol(symbol: Symbol, fn: (data: {
@@ -293,6 +293,7 @@ export declare class SymbolQuery {
         util: SymbolUtil;
     });
     heyGimmeDaSymbol(): Symbol | undefined;
+    getData<T>(predicate: (this: void, value: unknown) => value is T): T | undefined;
     with(fn: QueryMemberCallback): this;
     if(predicate: (this: void, symbol: Symbol | undefined) => symbol is undefined, fn: QueryCallback<undefined>): this;
     if(predicate: (this: void, symbol: Symbol | undefined) => symbol is Symbol, fn: QueryCallback<Symbol>): this;

package/lib/symbol/SymbolUtil.js

@@ -160,6 +160,15 @@ export class SymbolUtil {
         }
     }
     lookup(category, path, node) {
+        while (node) {
+            if (node.locals) {
+                const result = SymbolUtil.lookupTable(node.locals, category, path);
+                if (result.symbol) {
+                    return result;
+                }
+            }
+            node = node.parent;
+        }
         return SymbolUtil.lookupTable(this.global, category, path);
     }
     query(doc, category, ...path) {
@@ -517,6 +526,10 @@ export class SymbolQuery {
     heyGimmeDaSymbol() {
         return this.#symbol;
     }
+    getData(predicate) {
+        const data = this.#symbol?.data;
+        return predicate(data) ? data : undefined;
+    }
     with(fn) {
         fn(this);
         return this;
@@ -594,26 +607,35 @@ export class SymbolQuery {
         return this.else(() => this.resolveAlias());
     }
     _enter(addition) {
+        /**
+         * Get a proper visibility from the addition:
+         * * If the visibility is specified, use it.
+         * * If the visibility is `undefined`, use the visibility of the symbol, or `Public` if unapplicable.
+         */
+        const getAdditionVisibility = (addition) => {
+            return addition.data?.visibility ?? this.symbol?.visibility ?? 2 /* SymbolVisibility.Public */;
+        };
         const getMap = (addition) => {
-            if (this.#map && SymbolUtil.areVisibilitiesCompatible(addition.data?.visibility, this.#symbol?.visibility)) {
+            const additionVisibility = getAdditionVisibility(addition);
+            if (this.#map && SymbolUtil.areVisibilitiesCompatible(additionVisibility, this.#symbol?.visibility)) {
                 return this.#map;
             }
             if (this.path.length > 1) {
                 if (this.#parentSymbol) {
-                    if (!SymbolUtil.areVisibilitiesCompatible(addition.data?.visibility, this.#parentSymbol.visibility)) {
-                        throw new Error(`Cannot enter member “${this.getPath()}” of ${SymbolFormatter.stringifyVisibility(addition.data?.visibility)} visibility to parent of ${SymbolFormatter.stringifyVisibility(this.#parentSymbol.visibility)} visibility`);
+                    if (!SymbolUtil.areVisibilitiesCompatible(additionVisibility, this.#parentSymbol.visibility)) {
+                        throw new Error(`Cannot enter member “${this.getPath()}” of ${SymbolFormatter.stringifyVisibility(additionVisibility)} visibility to parent of ${SymbolFormatter.stringifyVisibility(this.#parentSymbol.visibility)} visibility`);
                     }
                     return this.#parentSymbol.members ??= {};
                 }
             }
             else {
                 let table;
-                if (SymbolUtil.isVisibilityInGlobal(addition.data?.visibility)) {
+                if (SymbolUtil.isVisibilityInGlobal(additionVisibility)) {
                     table = this.util.global;
                 }
-                else if (addition.data?.visibility === 1 /* SymbolVisibility.File */) {
+                else if (additionVisibility === 1 /* SymbolVisibility.File */) {
                     if (!this.#node) {
-                        throw new Error(`Cannot enter “${this.getPath()}” with ${SymbolFormatter.stringifyVisibility(addition.data?.visibility)} visibility as no node is supplied`);
+                        throw new Error(`Cannot enter “${this.getPath()}” with ${SymbolFormatter.stringifyVisibility(additionVisibility)} visibility as no node is supplied`);
                     }
                     let node = this.#node;
                     while (node) {
@@ -624,12 +646,12 @@ export class SymbolQuery {
                         node = node.parent;
                     }
                     if (!table) {
-                        throw new Error(`Cannot enter “${this.getPath()}” with ${SymbolFormatter.stringifyVisibility(addition.data?.visibility)} visibility as no file node is supplied`);
+                        throw new Error(`Cannot enter “${this.getPath()}” with ${SymbolFormatter.stringifyVisibility(additionVisibility)} visibility as no file node is supplied`);
                     }
                 }
                 else {
                     if (!this.#node) {
-                        throw new Error(`Cannot enter “${this.getPath()}” with ${SymbolFormatter.stringifyVisibility(addition.data?.visibility)} visibility as no node is supplied`);
+                        throw new Error(`Cannot enter “${this.getPath()}” with ${SymbolFormatter.stringifyVisibility(additionVisibility)} visibility as no node is supplied`);
                     }
                     let node = this.#node;
                     while (node) {
@@ -640,7 +662,7 @@ export class SymbolQuery {
                         node = node.parent;
                     }
                     if (!table) {
-                        throw new Error(`Cannot enter “${this.getPath()}” with ${SymbolFormatter.stringifyVisibility(addition.data?.visibility)} visibility as no node with locals is supplied`);
+                        throw new Error(`Cannot enter “${this.getPath()}” with ${SymbolFormatter.stringifyVisibility(additionVisibility)} visibility as no node with locals is supplied`);
                     }
                 }
                 // TODO: Move part of symbol from global to table.

package/lib/symbol/index.d.ts

@@ -1,4 +1,3 @@
 export * from './Symbol.js';
 export * from './SymbolUtil.js';
-export * from './UriBinder.js';
 //# sourceMappingURL=index.d.ts.map

package/lib/symbol/index.js

@@ -1,4 +1,3 @@
 export * from './Symbol.js';
 export * from './SymbolUtil.js';
-export * from './UriBinder.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spyglassmc/core",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -23,7 +23,7 @@
     "pako": "^2.0.4",
     "rfdc": "^1.3.0",
     "vscode-languageserver-textdocument": "^1.0.4",
-    "@spyglassmc/locales": "0.2.0"
+    "@spyglassmc/locales": "0.3.0"
   },
   "devDependencies": {
     "@types/decompress": "^4.2.3",

package/lib/service/Operations.d.ts

@@ -1,8 +0,0 @@
-export declare class Operations {
-    private readonly undoOps;
-    private readonly redoOps;
-    set<O extends object, K extends keyof O>(obj: O, key: K, value: O[K]): void;
-    undo(): void;
-    redo(): void;
-}
-//# sourceMappingURL=Operations.d.ts.map

package/lib/service/Operations.js

@@ -1,20 +0,0 @@
-export class Operations {
-    undoOps = [];
-    redoOps = [];
-    set(obj, key, value) {
-        const oldValue = obj[key];
-        const op = () => { obj[key] = value; };
-        this.redoOps.push(op);
-        this.undoOps.push(() => { obj[key] = oldValue; });
-        op();
-    }
-    undo() {
-        for (let i = this.undoOps.length - 1; i >= 0; i--) {
-            this.undoOps[i]();
-        }
-    }
-    redo() {
-        this.redoOps.forEach(f => f());
-    }
-}
-//# sourceMappingURL=Operations.js.map

package/lib/symbol/UriBinder.d.ts

@@ -1,3 +0,0 @@
-import type { UriBinderContext } from '../service/index.js';
-export declare type UriBinder = (uris: readonly string[], ctx: UriBinderContext) => void;
-//# sourceMappingURL=UriBinder.d.ts.map

package/lib/symbol/UriBinder.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=UriBinder.js.map