@galacean/engine-shader-compiler 2.0.0-alpha.52 → 2.0.0-alpha.54

package/types/codeGen/VisitorContext.d.ts

@@ -1,17 +1,17 @@
-import { BaseToken } from "../common/BaseToken";
-import { EShaderStage } from "../common/enums/ShaderStage";
-import { SymbolTable } from "../common/SymbolTable";
-import { ASTNode, TreeNode } from "../parser/AST";
-import { ESymbolType, SymbolInfo } from "../parser/symbolTable";
-import { StructProp } from "../parser/types";
-/** Role of a struct type in the shader compiler's IO flattening. */
-export type StructRole = "varying" | "attribute" | "mrt";
+import { BaseToken } from "@galacean/engine-shader-parser/internal";
+import { EShaderStage } from "@galacean/engine-shader-parser/internal";
+import { SymbolTable } from "@galacean/engine-shader-parser/internal";
+import { ASTNode, TreeNode } from "@galacean/engine-shader-parser/internal";
+import { ESymbolType, SymbolInfo, VarSymbol } from "@galacean/engine-shader-parser/internal";
+import { ShaderStructRole, StructProp } from "@galacean/engine-shader-parser/internal";
 /** @internal */
 export declare class VisitorContext {
-    private static _lookupSymbol;
-    private static _singleton;
-    static get context(): VisitorContext;
-    static reset(): void;
+    private readonly _lookupSymbol;
+    private readonly _structRoles;
+    private readonly _vertexUnresolvedVariableRoles;
+    private readonly _fragmentUnresolvedVariableRoles;
+    private readonly _vertexAmbiguousVariableNames;
+    private readonly _fragmentAmbiguousVariableNames;
     attributeStructs: ASTNode.StructSpecifier[];
     attributeList: StructProp[];
     varyingStructs: ASTNode.StructSpecifier[];
@@ -24,26 +24,85 @@ export declare class VisitorContext {
     _referencedVaryingList: Record<string, StructProp[]>;
     _referencedMRTList: Record<string, StructProp[]>;
     _referencedGlobals: Record<string, SymbolInfo[]>;
+    readonly _referencedGlobalSymbols: Set<SymbolInfo>;
+    private _globalSymbolQueries;
     _referencedGlobalMacroASTs: TreeNode[];
+    private readonly _structVariableRoles;
+    _passSymbolTable?: SymbolTable<SymbolInfo>;
+    /** Receives every global use, including uses of declarations already discovered. */
+    onReferenceGlobal?: (symbols: readonly SymbolInfo[]) => void;
+    /** Receives interface uses so generated fields retain their declaration dependencies. */
+    onReferenceStructProps?: (props: readonly StructProp[]) => void;
+    readonly codeCache: Map<TreeNode, string>;
+    private readonly fragmentReturnModes;
+    private readonly terminalInterfaceReturns;
+    constructor();
+    reset(resetAll?: boolean): void;
     /**
-     * Maps variable names (function params, locals, and globals whose type is a
-     * varying/attribute/mrt struct) to their role. Populated during stage setup and
-     * used by macro-value rewriting to recognize `varName.prop` patterns that should
-     * be flattened against the IO lists.
+     * Finds the shared interface role of custom-struct declaration candidates.
+     * @param declarations - Exact parser struct identities resolved at one type occurrence.
+     * @returns Interface role, or `undefined` when the type is not an unambiguous interface struct.
      */
-    _structVarMap: Record<string, StructRole>;
-    _passSymbolTable: SymbolTable<SymbolInfo>;
-    reset(resetAll?: boolean): void;
-    isAttributeStruct(type: string | undefined): boolean;
-    isVaryingStruct(type: string | undefined): boolean;
-    isMRTStruct(type: string | undefined): boolean;
-    /** Return the role of a struct type, or undefined if it isn't one of the IO roles. */
-    getStructRole(typeLexeme: string): StructRole | undefined;
-    /** Register a variable as holding a value of a varying/attribute/mrt struct type. */
-    registerStructVar(varName: string, role: StructRole): void;
-    referenceAttribute(ident: BaseToken): Error | void;
-    referenceVarying(ident: BaseToken): Error | void;
-    referenceMRTProp(ident: BaseToken): Error | void;
+    getStructRole(declarations: readonly ASTNode.StructSpecifier[]): ShaderStructRole | undefined;
+    /**
+     * Tests the exact interface role of one struct declaration.
+     * @param declaration - Parser struct identity.
+     * @param role - Expected interface role.
+     * @returns Whether the declaration owns that role.
+     */
+    hasStructRole(declaration: ASTNode.StructSpecifier, role: ShaderStructRole): boolean;
+    /**
+     * Registers stage-interface struct types for constant-time role lookup.
+     * @param role - Interface role shared by the supplied structs.
+     * @param structs - Struct declarations derived from parser IR.
+     * @internal
+     */
+    registerStructTypes(role: ShaderStructRole, structs: readonly ASTNode.StructSpecifier[]): void;
+    /**
+     * Registers a resolved variable that holds an interface struct.
+     * @param variable - Parser symbol identity for the declaration.
+     * @param role - Struct interface role.
+     * @param stage - Optional stage from whose entry the variable is reachable. Omit when only exact
+     * symbol lookup is required.
+     */
+    registerStructVar(variable: VarSymbol, role: ShaderStructRole, stage?: EShaderStage): void;
+    /**
+     * Finds an interface role for a global macro value that has no lexical symbol identity.
+     * @param variableName - Bare variable name in the macro replacement AST.
+     * @returns A role only when every stage-reachable declaration with that name agrees.
+     */
+    getUnresolvedStructVarRole(variableName: string): ShaderStructRole | undefined;
+    /**
+     * Finds the shared interface role of branch-visible variable candidates.
+     * @param symbols - Exact parser symbols resolved at one reference.
+     * @returns Interface role, or `undefined` when the reference is not an unambiguous interface value.
+     */
+    getStructVarRole(symbols: readonly SymbolInfo[]): ShaderStructRole | undefined;
+    /**
+     * Marks a value-return belonging to a fragment entry for backend lowering.
+     * @param statement - Exact return statement identity.
+     * @param mode - Fragment output contract of the containing entry declaration.
+     */
+    registerFragmentReturn(statement: ASTNode.JumpStatement, mode: FragmentReturnMode): void;
+    /**
+     * Finds the output contract for a fragment-entry return statement.
+     * @param statement - Return statement identity.
+     * @returns Output mode, or `undefined` for ordinary helper/vertex returns.
+     */
+    getFragmentReturnMode(statement: ASTNode.JumpStatement): FragmentReturnMode | undefined;
+    /** Marks a syntactically final interface return whose control-flow exit can be omitted. */
+    registerTerminalInterfaceReturn(statement: ASTNode.JumpStatement): void;
+    /**
+     * Tests whether an interface return is the final syntactic statement in its function.
+     * @param statement - Return statement identity.
+     * @returns Whether backend lowering may omit a trailing `return;`.
+     */
+    isTerminalInterfaceReturn(statement: ASTNode.JumpStatement): boolean;
+    referenceAttribute(ident: BaseToken): void;
+    referenceVarying(ident: BaseToken): void;
+    referenceMRTProp(ident: BaseToken): void;
     referenceGlobal(ident: string, type: ESymbolType): void;
     private _referenceProp;
 }
+/** @internal */
+export type FragmentReturnMode = "color" | "mrt";

package/types/codeGen/types.d.ts

@@ -1,7 +1,7 @@
 import type { IShaderSource } from "@galacean/engine-design";
 export type IRenderState = [
     /** Constant RenderState. */
-    Record<number, boolean | string | number | any>,
+    Record<number, boolean | string | number>,
     /** Variable RenderState. */
     Record<number, string>
 ];

package/types/index.d.ts

@@ -1,3 +1,6 @@
 export { ShaderCompiler } from "./ShaderCompiler";
-export * from "./GSError";
+export { GSError, GSErrorName } from "@galacean/engine-shader-parser/internal";
+/**
+ * Version of the shader compiler package, replaced with the package version during builds.
+ */
 export declare const version = "__buildVersion";

package/types/precompile.d.ts

@@ -0,0 +1 @@
+export { ShaderPrecompiler } from "./ShaderPrecompiler";