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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-shader-compiler",
-  "version": "2.0.0-alpha.54",
+  "version": "2.0.0-alpha.56",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -56,10 +56,10 @@
   ],
   "dependencies": {
     "@rollup/pluginutils": "^5.0.0",
-    "@galacean/engine-math": "2.0.0-alpha.54",
-    "@galacean/engine-core": "2.0.0-alpha.54",
-    "@galacean/engine-shader-parser": "2.0.0-alpha.54",
-    "@galacean/engine-design": "2.0.0-alpha.54"
+    "@galacean/engine-core": "2.0.0-alpha.56",
+    "@galacean/engine-design": "2.0.0-alpha.56",
+    "@galacean/engine-shader-parser": "2.0.0-alpha.56",
+    "@galacean/engine-math": "2.0.0-alpha.56"
   },
   "typesVersions": {
     "*": {

package/types/codeGen/CodeGenVisitor.d.ts

@@ -1,3 +1,4 @@
+import { BaseToken } from "@galacean/engine-shader-parser/internal";
 import { ASTNode, TreeNode } from "@galacean/engine-shader-parser/internal";
 import { FnSymbol } from "@galacean/engine-shader-parser/internal";
 import { NodeChild, StructProp } from "@galacean/engine-shader-parser/internal";
@@ -18,6 +19,13 @@ export declare abstract class CodeGenVisitor implements ICodeGenVisitor {
     cache(node: TreeNode, code: string): string;
     getCachedCode(node: TreeNode): string | undefined;
     defaultCodeGen(children: NodeChild[]): string;
+    /**
+     * Spells a source token in the generated code.
+     * @param token - Source token
+     * @returns Generated text for the token
+     */
+    protected tokenLexeme(token: BaseToken): string;
+    protected interfaceMemberName(name: string): string;
     visitPostfixExpression(node: ASTNode.PostfixExpression): string;
     visitVariableIdentifier(node: ASTNode.VariableIdentifier): string;
     protected referenceFunction(symbol: FnSymbol, referenceIndex: number, branch: BranchSignature): void;
@@ -26,8 +34,7 @@ export declare abstract class CodeGenVisitor implements ICodeGenVisitor {
     visitStatementList(node: ASTNode.StatementList): string;
     /**
      * Code-generate a `#define` macro parsed as expression AST. Produces a `#define`
-     * directive whose value is the AST-rewritten string — so varying flattening
-     * happens naturally via `visitPostfixExpression` inside the AST walk.
+     * directive whose value retains ordinary expression and member-access semantics.
      */
     visitMacroDefine(node: ASTNode.MacroDefine): string;
     visitSingleDeclaration(node: ASTNode.SingleDeclaration): string;

package/types/codeGen/GLES100.d.ts

@@ -1,10 +1,10 @@
-import { ASTNode } from "@galacean/engine-shader-parser/internal";
 import { StructProp } from "@galacean/engine-shader-parser/internal";
 import { GLESVisitor } from "./GLESVisitor";
 export declare class GLES100Visitor extends GLESVisitor {
+    protected readonly supportsArrayStructReturn = false;
     getAttributeProp(prop: StructProp): string;
     getVaryingProp(prop: StructProp): string;
     getMRTProp(): string;
-    visitPostfixExpression(node: ASTNode.PostfixExpression): string;
-    visitJumpStatement(node: ASTNode.JumpStatement): string;
+    protected fragmentColorOutput(): string;
+    protected mrtOutput(prop: StructProp): string;
 }

package/types/codeGen/GLES300.d.ts

@@ -17,7 +17,10 @@ export declare class GLES300Visitor extends GLESVisitor {
     visitFunctionIdentifier(node: ASTNode.FunctionIdentifier): string;
     visitVariableIdentifier(node: ASTNode.VariableIdentifier): string;
     visitPostfixExpression(node: ASTNode.PostfixExpression): string;
-    visitJumpStatement(node: ASTNode.JumpStatement): string;
+    protected fragmentColorOutput(): string;
+    protected mrtOutput(prop: StructProp): string;
+    private _fragmentColorName;
+    private _fragmentDataName;
     private _registerFragColorVariable;
     private _registerOutput;
     protected prepareFragment(entryInfo: ShaderEntryPointInfo, outerGlobalMacroStatements: readonly ASTNode.GlobalDeclaration[]): void;

package/types/codeGen/GLESVisitor.d.ts

@@ -1,9 +1,12 @@
 import type { IShaderInfo } from "@galacean/engine-design";
 import type { IPoolElement } from "@galacean/engine-core";
+import { BaseToken } from "@galacean/engine-shader-parser/internal";
 import { ASTNode } from "@galacean/engine-shader-parser/internal";
+import { NodeChild } from "@galacean/engine-shader-parser/internal";
 import { ShaderData } from "@galacean/engine-shader-parser/internal";
 import { FnSymbol } from "@galacean/engine-shader-parser/internal";
-import type { BranchSignature, ShaderClueIR, ShaderCoreInfo, ShaderEntryPointInfo, DeferredDeclarationOwnership } from "@galacean/engine-shader-parser/internal";
+import { ShaderStructRole } from "@galacean/engine-shader-parser/internal";
+import type { BranchSignature, StructProp, ShaderClueIR, ShaderCoreInfo, ShaderEntryPointInfo, DeferredDeclarationOwnership } from "@galacean/engine-shader-parser/internal";
 import { CodeGenVisitor } from "./CodeGenVisitor";
 import { ICodeSegment } from "./types";
 import type { ShaderBackend } from "../ShaderBackend";
@@ -11,6 +14,16 @@ import type { ShaderBackend } from "../ShaderBackend";
  * @internal
  */
 export declare abstract class GLESVisitor extends CodeGenVisitor implements ShaderBackend, IPoolElement {
+    protected readonly supportsArrayStructReturn: boolean;
+    /** Names of pass-scope declarations, which stage-interface globals must not redeclare. */
+    private readonly _globalNames;
+    /** Interface type and variable tokens whose source names GLSL ES rejects. */
+    private readonly _escapedDeclarations;
+    private _vertexOutputNames?;
+    private readonly _fragmentVaryingProps;
+    private readonly _globalInputs;
+    private readonly _inputHelperBodies;
+    private readonly _inputHelperGroups;
     private _globalCodeArray;
     private readonly _forwardFunctionDeclarations;
     private readonly _forwardStructIndices;
@@ -47,6 +60,37 @@ export declare abstract class GLESVisitor extends CodeGenVisitor implements Shad
     generate(ir: ShaderClueIR, coreInfo: ShaderCoreInfo): IShaderInfo;
     private _vertexMain;
     private _fragmentMain;
+    private _referenceInterfaceDependencies;
+    /**
+     * Resolves an interface member's global name, shared by both stages for varyings.
+     * @param prop - Interface member
+     * @param role - Stage-interface role of the member's structure
+     * @returns Generated global identifier
+     */
+    protected interfaceName(prop: StructProp, role: ShaderStructRole): string;
+    protected interfaceMemberName(name: string): string;
+    private _interfaceTypeName;
+    /**
+     * Escapes interface-typed variables whose names GLSL ES reserves.
+     * @param name - Source name
+     * @param structs - Struct declarations of the variable type
+     * @returns The escaped name, or the source name when no escape is necessary
+     */
+    private _interfaceVariableName;
+    private _collectEscapedDeclarations;
+    protected tokenLexeme(token: BaseToken): string;
+    private _escapedReference;
+    protected abstract fragmentColorOutput(): string;
+    protected abstract mrtOutput(prop: StructProp): string;
+    private _transferName;
+    visitStructSpecifier(node: ASTNode.StructSpecifier): string;
+    private _containsArray;
+    defaultCodeGen(children: NodeChild[]): string;
+    private _observeWholeStruct;
+    visitFunctionHeader(node: ASTNode.FunctionHeader): string;
+    visitFunctionIdentifier(node: ASTNode.FunctionIdentifier): string;
+    visitFunctionDefinition(fnNode: ASTNode.FunctionDefinition): string;
+    private _initializeGlobalInputs;
     protected prepareFragment(entryInfo: ShaderEntryPointInfo, outerGlobalMacroStatements: readonly ASTNode.GlobalDeclaration[]): void;
     /**
      * Pre-walk `#define` values in global macro declarations and register any
@@ -56,7 +100,6 @@ export declare abstract class GLESVisitor extends CodeGenVisitor implements Shad
      */
     private _preRegisterGlobalMacroRefs;
     private _walkMacroDefineTokens;
-    private _registerFragmentReturns;
     private _getGlobalSymbol;
     protected referenceFunction(symbol: FnSymbol, referenceIndex: number, branch: BranchSignature): void;
     private _getForwardSignature;

package/types/codeGen/NameAllocator.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Tests whether GLSL ES rejects an identifier that ShaderLab accepts.
+ * @param name - Source identifier
+ * @returns Whether the identifier uses a reserved word or namespace
+ * @internal
+ */
+export declare function isUnsafeGLSLIdentifier(name: string): boolean;
+/**
+ * Allocates generated identifiers that avoid source identifiers and each other.
+ * @internal
+ */
+export declare class NameAllocator {
+    private readonly _used;
+    private readonly _names;
+    /**
+     * Reserves a source identifier so that generated names never shadow it.
+     * @param name - Source identifier
+     */
+    reserve(name: string): void;
+    /**
+     * Keeps a source identifier when GLSL accepts it, otherwise assigns a legal name to its identity.
+     * @param key - Source declaration or namespace identity
+     * @param name - Source identifier
+     * @returns Identifier used by the declaration and its references
+     */
+    sourceName(key: unknown, name: string): string;
+    /**
+     * Returns the same identifier for every request with the same key.
+     * @param key - Identity of the generated declaration, independent of its spelling
+     * @param preferred - Readable base name. Repeated underscores collapse to one, because WebGL rejects `__`
+     * @returns An identifier that differs from every reserved and previously allocated name
+     */
+    allocate(key: unknown, preferred: string): string;
+    /** Releases all reservations and allocations between compilation requests. */
+    reset(): void;
+}

package/types/codeGen/VisitorContext.d.ts

@@ -4,8 +4,10 @@ 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";
+import { NameAllocator } from "./NameAllocator";
 /** @internal */
 export declare class VisitorContext {
+    readonly names: NameAllocator;
     private readonly _lookupSymbol;
     private readonly _structRoles;
     private readonly _vertexUnresolvedVariableRoles;
@@ -34,8 +36,6 @@ export declare class VisitorContext {
     /** 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;
     /**
@@ -78,31 +78,9 @@ export declare class VisitorContext {
      * @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";