@galacean/engine-shaderlab 1.6.0-alpha.2 → 1.6.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-shaderlab",
-  "version": "1.6.0-alpha.2",
+  "version": "1.6.0-beta.1",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -26,11 +26,11 @@
     "verbose/package.json"
   ],
   "devDependencies": {
-    "@galacean/engine": "1.6.0-alpha.2",
-    "@galacean/engine-design": "1.6.0-alpha.2"
+    "@galacean/engine": "1.6.0-beta.1",
+    "@galacean/engine-design": "1.6.0-beta.1"
   },
   "peerDependencies": {
-    "@galacean/engine": "1.6.0-alpha.2"
+    "@galacean/engine": "1.6.0-beta.1"
   },
   "scripts": {
     "b:types": "tsc"

package/types/GSError.d.ts

@@ -11,5 +11,6 @@ export declare class GSError extends Error {
 export declare enum GSErrorName {
     PreprocessorError = "PreprocessorError",
     CompilationError = "CompilationError",
-    ScannerError = "ScannerError"
+    ScannerError = "ScannerError",
+    CompilationWarn = "CompilationWarning"
 }

package/types/ParserUtils.d.ts

@@ -1,6 +1,6 @@
-import { NoneTerminal, GrammarSymbol } from "./parser/GrammarSymbol";
 import { GalaceanDataType } from "./common";
 import { TreeNode } from "./parser/AST";
+import { GrammarSymbol, NoneTerminal } from "./parser/GrammarSymbol";
 export declare class ParserUtils {
     static unwrapNodeByType<T = TreeNode>(node: TreeNode, type: NoneTerminal): T | undefined;
     /**

package/types/Preprocessor.d.ts

@@ -0,0 +1,31 @@
+export declare enum MacroValueType {
+    Number = 0,// 1, 1.1
+    Symbol = 1,// variable name
+    FunctionCall = 2,// function call, e.g. clamp(a, 0.0, 1.0)
+    Other = 3
+}
+export interface MacroDefineInfo {
+    isFunction: boolean;
+    name: string;
+    value: string;
+    valueType: MacroValueType;
+    params: string[];
+    functionCallName: string;
+}
+export interface MacroDefineList {
+    [macroName: string]: MacroDefineInfo[];
+}
+export declare class Preprocessor {
+    private static readonly _includeReg;
+    private static readonly _macroRegex;
+    private static readonly _symbolReg;
+    private static readonly _funcCallReg;
+    private static readonly _macroDefineIncludeMap;
+    static parse(source: string, basePathForIncludeKey: string, outMacroDefineList: MacroDefineList, parseMacro?: boolean): string;
+    static getReferenceSymbolNames(macroDefineList: MacroDefineList, macroName: string, out: string[]): void;
+    private static _isNumber;
+    private static _isExist;
+    private static _parseMacroDefines;
+    private static _mergeMacroDefineLists;
+    private static _replace;
+}

package/types/ShaderLab.d.ts

@@ -1 +1,15 @@
-export {};
+import { ShaderMacro, ShaderLanguage } from "@galacean/engine";
+import { IShaderLab, IShaderSource } from "@galacean/engine-design";
+import { IShaderProgramSource } from "@galacean/engine-design/types/shader-lab/IShaderProgramSource";
+import { ShaderPosition, ShaderRange } from "./common";
+export declare class ShaderLab implements IShaderLab {
+    private static _parser;
+    private static _shaderPositionPool;
+    private static _shaderRangePool;
+    static _processingPassText?: string;
+    static createPosition(index: number, line?: number, column?: number): ShaderPosition;
+    static createRange(start: ShaderPosition, end: ShaderPosition): ShaderRange;
+    _parseShaderSource(sourceCode: string): IShaderSource;
+    _parseShaderPass(source: string, vertexEntry: string, fragmentEntry: string, backend: ShaderLanguage, basePathForIncludeKey: string): IShaderProgramSource | undefined;
+    _parseMacros(content: string, macros: ShaderMacro[]): string;
+}

package/types/codeGen/CodeGenVisitor.d.ts

@@ -1,2 +1 @@
-export declare const V3_GL_FragColor = "GS_glFragColor";
-export declare const V3_GL_FragData = "GS_glFragData";
+export {};

package/types/codeGen/GLES100.d.ts

@@ -1,16 +1,12 @@
 import { ASTNode } from "../parser/AST";
+import { StructProp } from "../parser/types";
 import { GLESVisitor } from "./GLESVisitor";
-import { ICodeSegment } from "./types";
 export declare class GLES100Visitor extends GLESVisitor {
-    _versionText: string;
-    _extensions: string;
     private static _singleton;
     static getVisitor(): GLES100Visitor;
-    getFragDataCodeGen(index: string | number): string;
-    getReferencedMRTPropText(index: string | number, ident: string): string;
-    getAttributeDeclare(out: ICodeSegment[]): void;
-    getVaryingDeclare(out: ICodeSegment[]): void;
-    getMRTDeclare(out: ICodeSegment[]): void;
+    getAttributeProp(prop: StructProp): string;
+    getVaryingProp(prop: StructProp): string;
+    getMRTProp(): string;
     visitPostfixExpression(node: ASTNode.PostfixExpression): string;
     visitJumpStatement(node: ASTNode.JumpStatement): string;
 }

package/types/codeGen/GLES300.d.ts

@@ -1,15 +1,18 @@
 import { ASTNode } from "../parser/AST";
+import { ShaderData } from "../parser/ShaderInfo";
+import { StructProp } from "../parser/types";
 import { GLESVisitor } from "./GLESVisitor";
 import { ICodeSegment } from "./types";
 export declare class GLES300Visitor extends GLESVisitor {
-    _versionText: string;
     private static _singleton;
     static getVisitor(): GLES300Visitor;
-    getFragDataCodeGen(index: string | number): string;
-    getReferencedMRTPropText(index: string | number, ident: string): string;
-    getAttributeDeclare(out: ICodeSegment[]): void;
-    getVaryingDeclare(out: ICodeSegment[]): void;
-    getMRTDeclare(out: ICodeSegment[]): void;
+    private _otherCodeArray;
+    private _fragColorVariableRegistered;
+    reset(): void;
+    getOtherGlobal(data: ShaderData, out: ICodeSegment[]): void;
+    getAttributeProp(prop: StructProp): string;
+    getVaryingProp(prop: StructProp): string;
+    getMRTProp(prop: StructProp): string;
     visitFunctionIdentifier(node: ASTNode.FunctionIdentifier): string;
     visitVariableIdentifier(node: ASTNode.VariableIdentifier): string;
     visitJumpStatement(node: ASTNode.JumpStatement): string;

package/types/codeGen/types.d.ts

@@ -1,11 +1,11 @@
-import { IShaderContent } from "@galacean/engine-design";
+import { IShaderSource } from "@galacean/engine-design";
 export type IRenderState = [
     /** Constant RenderState. */
     Record<number, boolean | string | number | any>,
     /** Variable RenderState. */
     Record<number, string>
 ];
-export type ITag = IShaderContent["subShaders"][number]["tags"];
+export type ITag = IShaderSource["subShaders"][number]["tags"];
 export type ICodeSegment = {
     text: string;
     index: number;

package/types/common/BaseLexer.d.ts

@@ -0,0 +1,2 @@
+import { BaseToken } from "./BaseToken";
+export type OnToken = (token: BaseToken, scanner: BaseLexer) => void;

package/types/common/IBaseSymbol.d.ts

@@ -0,0 +1,5 @@
+export interface IBaseSymbol {
+    isInMacroBranch: boolean;
+    readonly ident: string;
+    equal(other: IBaseSymbol): boolean;
+}

package/types/common/SymbolTable.d.ts

@@ -0,0 +1,7 @@
+import { IBaseSymbol } from "./IBaseSymbol";
+export declare class SymbolTable<T extends IBaseSymbol> {
+    private _table;
+    insert(symbol: T, isInMacroBranch?: boolean): void;
+    getSymbol(symbol: T, includeMacro?: boolean): T | undefined;
+    getSymbols(symbol: T, includeMacro: boolean, out: T[]): T[];
+}

package/types/common/SymbolTableStack.d.ts

@@ -0,0 +1,13 @@
+import { IBaseSymbol } from "./IBaseSymbol";
+import { SymbolTable } from "./SymbolTable";
+export declare class SymbolTableStack<S extends IBaseSymbol, T extends SymbolTable<S>> {
+    stack: T[];
+    get scope(): T;
+    get isInMacroBranch(): boolean;
+    pushScope(scope: T): void;
+    clear(): void;
+    popScope(): T | undefined;
+    insert(symbol: S): void;
+    lookup(symbol: S, includeMacro?: boolean): S | undefined;
+    lookupAll(symbol: S, includeMacro: boolean, out: S[]): S[];
+}

package/types/common/enums/Keyword.d.ts

@@ -0,0 +1,108 @@
+export declare enum Keyword {
+    CONST = 0,
+    BOOL = 1,
+    FLOAT = 2,
+    DOUBLE = 3,
+    INT = 4,
+    UINT = 5,
+    BREAK = 6,
+    CONTINUE = 7,
+    DO = 8,
+    ELSE = 9,
+    FOR = 10,
+    IF = 11,
+    WHILE = 12,
+    DISCARD = 13,
+    RETURN = 14,
+    BVEC2 = 15,
+    BVEC3 = 16,
+    BVEC4 = 17,
+    IVEC2 = 18,
+    IVEC3 = 19,
+    IVEC4 = 20,
+    UVEC2 = 21,
+    UVEC3 = 22,
+    UVEC4 = 23,
+    VEC2 = 24,
+    VEC3 = 25,
+    VEC4 = 26,
+    VEC4_ARRAY = 27,
+    MAT2 = 28,
+    MAT3 = 29,
+    MAT4 = 30,
+    MAT2X3 = 31,
+    MAT2X4 = 32,
+    MAT3X2 = 33,
+    MAT3X4 = 34,
+    MAT4X2 = 35,
+    MAT4X3 = 36,
+    IN = 37,
+    OUT = 38,
+    INOUT = 39,
+    CENTROID = 40,
+    SAMPLER2D = 41,
+    SAMPLER3D = 42,
+    SAMPLER_CUBE = 43,
+    SAMPLER2D_SHADOW = 44,
+    SAMPLER_CUBE_SHADOW = 45,
+    SAMPLER2D_ARRAY = 46,
+    SAMPLER2D_ARRAY_SHADOW = 47,
+    I_SAMPLER2D = 48,
+    I_SAMPLER3D = 49,
+    I_SAMPLER_CUBE = 50,
+    I_SAMPLER2D_ARRAY = 51,
+    U_SAMPLER2D = 52,
+    U_SAMPLER3D = 53,
+    U_SAMPLER_CUBE = 54,
+    U_SAMPLER2D_ARRAY = 55,
+    STRUCT = 56,
+    LAYOUT = 57,
+    LOCATION = 58,
+    VOID = 59,
+    PRECISION = 60,
+    PRECISE = 61,
+    HIGHP = 62,
+    MEDIUMP = 63,
+    LOWP = 64,
+    INVARIANT = 65,
+    SMOOTH = 66,
+    FLAT = 67,
+    NOPERSPECTIVE = 68,
+    True = 69,
+    False = 70,
+    LeftBrace = 71,
+    RightBrace = 72,
+    Equal = 73,
+    GSRenderQueueType = 74,
+    GSBlendState = 75,
+    GSDepthState = 76,
+    GSStencilState = 77,
+    GSRasterState = 78,
+    GSEditorProperties = 79,
+    GSEditorMacros = 80,
+    GSEditor = 81,
+    GSTags = 82,
+    GSVertexShader = 83,
+    GSFragmentShader = 84,
+    GSSubShader = 85,
+    GSPass = 86,
+    GSBlendFactor = 87,
+    GSBlendOperation = 88,
+    GSBool = 89,
+    GSNumber = 90,
+    GSColor = 91,
+    GSCompareFunction = 92,
+    GSStencilOperation = 93,
+    GSCullMode = 94,
+    GSUsePass = 95,
+    MACRO_IF = 96,
+    MACRO_IFDEF = 97,
+    MACRO_IFNDEF = 98,
+    MACRO_ELSE = 99,
+    MACRO_ELIF = 100,
+    MACRO_ENDIF = 101,
+    MACRO_UNDEF = 102,
+    MACRO_DEFINE_EXPRESSION = 103,
+    MACRO_CONDITIONAL_EXPRESSION = 104,
+    MACRO_CALL = 105
+}

package/types/common/index.d.ts

@@ -2,4 +2,4 @@ import { ShaderRange } from "./ShaderRange";
 import { ShaderPosition } from "./ShaderPosition";
 export { ShaderRange, ShaderPosition };
 export * from "./types";
-export * from "./Keywords";
+export * from "./enums/Keyword";

package/types/common/types.d.ts

@@ -1,5 +1,4 @@
-import { EKeyword } from "./Keywords";
-export declare const KeywordTable: Map<string, EKeyword>;
+import { Keyword } from "./enums/Keyword";
 export declare enum ETokenType {
     ID = 1000,
     FLOAT_CONSTANT = 1001,
@@ -92,11 +91,11 @@ export declare enum ETokenType {
     AMPERSAND = 1047,
     /** ? */
     QUESTION = 1048,
-    NOT_WORD = 1049,
+    NotWord = 1049,
     /** ε */
     EPSILON = 1998,
     EOF = 1999
 }
 export declare const TypeAny = 3000;
-export type GalaceanDataType = EKeyword.VOID | EKeyword.FLOAT | EKeyword.BOOL | EKeyword.INT | EKeyword.UINT | EKeyword.VEC2 | EKeyword.VEC3 | EKeyword.VEC4 | EKeyword.BVEC2 | EKeyword.BVEC3 | EKeyword.BVEC4 | EKeyword.IVEC2 | EKeyword.IVEC3 | EKeyword.IVEC4 | EKeyword.UVEC2 | EKeyword.UVEC3 | EKeyword.UVEC4 | EKeyword.MAT2 | EKeyword.MAT3 | EKeyword.MAT4 | EKeyword.MAT2X3 | EKeyword.MAT2X4 | EKeyword.MAT3X2 | EKeyword.MAT3X4 | EKeyword.MAT4X2 | EKeyword.MAT4X3 | EKeyword.SAMPLER2D | EKeyword.SAMPLER3D | EKeyword.SAMPLER_CUBE | EKeyword.SAMPLER2D_SHADOW | EKeyword.SAMPLER_CUBE_SHADOW | EKeyword.SAMPLER2D_ARRAY | EKeyword.SAMPLER2D_ARRAY_SHADOW | EKeyword.I_SAMPLER2D | EKeyword.I_SAMPLER3D | EKeyword.I_SAMPLER_CUBE | EKeyword.I_SAMPLER2D_ARRAY | EKeyword.U_SAMPLER2D | EKeyword.U_SAMPLER3D | EKeyword.U_SAMPLER_CUBE | EKeyword.U_SAMPLER2D_ARRAY | EKeyword.VEC4_ARRAY | typeof TypeAny | string;
-export type TokenType = ETokenType | EKeyword;
+export type GalaceanDataType = Keyword.VOID | Keyword.FLOAT | Keyword.BOOL | Keyword.INT | Keyword.UINT | Keyword.VEC2 | Keyword.VEC3 | Keyword.VEC4 | Keyword.BVEC2 | Keyword.BVEC3 | Keyword.BVEC4 | Keyword.IVEC2 | Keyword.IVEC3 | Keyword.IVEC4 | Keyword.UVEC2 | Keyword.UVEC3 | Keyword.UVEC4 | Keyword.MAT2 | Keyword.MAT3 | Keyword.MAT4 | Keyword.MAT2X3 | Keyword.MAT2X4 | Keyword.MAT3X2 | Keyword.MAT3X4 | Keyword.MAT4X2 | Keyword.MAT4X3 | Keyword.SAMPLER2D | Keyword.SAMPLER3D | Keyword.SAMPLER_CUBE | Keyword.SAMPLER2D_SHADOW | Keyword.SAMPLER_CUBE_SHADOW | Keyword.SAMPLER2D_ARRAY | Keyword.SAMPLER2D_ARRAY_SHADOW | Keyword.I_SAMPLER2D | Keyword.I_SAMPLER3D | Keyword.I_SAMPLER_CUBE | Keyword.I_SAMPLER2D_ARRAY | Keyword.U_SAMPLER2D | Keyword.U_SAMPLER3D | Keyword.U_SAMPLER_CUBE | Keyword.U_SAMPLER2D_ARRAY | Keyword.VEC4_ARRAY | typeof TypeAny | string;
+export type TokenType = ETokenType | Keyword;

package/types/index.d.ts

@@ -1,4 +1,3 @@
 export { ShaderLab } from "./ShaderLab";
-export { Preprocessor } from "./preprocessor";
 export * from "./GSError";
 export declare const version = "__buildVersion";

package/types/lalr/CFG.d.ts

@@ -2,4 +2,4 @@ import { Grammar } from "../parser/Grammar";
 import SemanticAnalyzer from "../parser/SemanticAnalyzer";
 declare const createGrammar: () => Grammar;
 declare const addTranslationRule: (sa: SemanticAnalyzer) => void;
-export { createGrammar, addTranslationRule };
+export { addTranslationRule, createGrammar };

package/types/lexer/Lexer.d.ts

@@ -1,16 +1,21 @@
+import { BaseLexer } from "../common/BaseLexer";
 import { BaseToken } from "../common/BaseToken";
-import BaseScanner from "../common/BaseScanner";
+import { MacroDefineList } from "../Preprocessor";
 /**
  * The Lexer of ShaderLab Compiler
  */
-export declare class Lexer extends BaseScanner {
-    reset(source: string): void;
+export declare class Lexer extends BaseLexer {
+    macroDefineList: MacroDefineList;
+    private static _lexemeTable;
+    private _needScanMacroConditionExpression;
     tokenize(): Generator<BaseToken<number>, BaseToken<number>, unknown>;
-    skipSpace(): void;
+    constructor(source: string, macroDefineList: MacroDefineList);
     scanToken(): BaseToken;
     private _scanStringConst;
     private _scanNumAfterDot;
-    private _getPosition;
+    private _scanUtilBreakLine;
+    private _scanDirectives;
+    private _scanMacroConditionExpression;
     private _scanWord;
     private _scanNum;
     private _scanFloatSuffix;

package/types/{preprocessor → macroProcessor}/MacroDefine.d.ts

@@ -1,12 +1,12 @@
-import { BaseToken } from "../common/BaseToken";
 import { ShaderRange } from "../common";
+import { BaseToken } from "../common/BaseToken";
 export declare class MacroDefine {
     readonly macro: BaseToken;
     readonly body?: BaseToken;
     readonly location?: ShaderRange;
     readonly args?: BaseToken[];
     private _replaceRegex?;
-    private readonly _argsLexemes;
+    private readonly _argsLexemes?;
     get isFunction(): boolean;
     constructor(macro: BaseToken, body?: BaseToken, location?: ShaderRange, args?: BaseToken[]);
     expandFunctionBody(args: string[]): string;

package/types/macroProcessor/MacroParserLexer.d.ts

@@ -0,0 +1,32 @@
+import { ShaderPosition, ShaderRange } from "../common";
+import PpSourceMap from "./sourceMap";
+import { BaseLexer } from "../common/BaseLexer";
+import { BaseToken } from "../common/BaseToken";
+import { MacroParserToken } from "./constants";
+export type OnToken = (token: BaseToken, scanner: MacroParserLexer) => void;
+export default class MacroParserLexer extends BaseLexer {
+    private static _isPpCharacters;
+    private static _lexemeTable;
+    private macroLvl;
+    readonly sourceMap: PpSourceMap;
+    readonly file: string;
+    readonly blockRange?: ShaderRange;
+    constructor(source: string, file?: string, blockRange?: ShaderRange);
+    scanWordsUntilTerminator(terminatorChar: string): BaseToken[];
+    scanWord(): BaseToken;
+    scanToken(): BaseToken | undefined;
+    scanQuotedString(): BaseToken<MacroParserToken.string_const>;
+    scanToChar(char: string): void;
+    scanMacroBranchBody(): {
+        body: BaseToken<MacroParserToken.chunk>;
+        nextDirective: BaseToken;
+    };
+    scanPairedBlock(lc: string, rc: string): void;
+    /**
+     * @returns end ShaderPosition
+     */
+    scanRemainMacro(): ShaderPosition;
+    peekNonSpace(): string;
+    scanInteger(): BaseToken<number>;
+    scanMacroBody(): BaseToken<MacroParserToken.line_remain>;
+}

package/types/macroProcessor/Utils.d.ts

@@ -0,0 +1,5 @@
+import { ExpandSegment } from "./MacroParser";
+import PpSourceMap from "./sourceMap";
+export declare class PpUtils {
+    static expand(segments: ExpandSegment[], source: string, sourceMap?: PpSourceMap): string;
+}

package/types/{preprocessor → macroProcessor}/constants.d.ts

@@ -1,4 +1,4 @@
-export declare enum EPpToken {
+export declare enum MacroParserToken {
     id = 0,
     line_remain = 1,
     chunk = 2,
@@ -40,7 +40,7 @@ export declare enum EPpToken {
     percent = 22,
     EOF = 100
 }
-export declare enum EPpKeyword {
+export declare enum MacroParserKeyword {
     define = 101,
     undef = 102,
     if = 103,
@@ -49,8 +49,6 @@ export declare enum EPpKeyword {
     else = 106,
     elif = 107,
     endif = 108,
-    include = 109,
-    defined = 110
+    defined = 109
 }
-export declare const PpKeyword: Map<string, EPpKeyword>;
-export type PpConstant = boolean | number;
+export type MacroParserConstant = boolean | number;

package/types/macroProcessor/index.d.ts

@@ -0,0 +1 @@
+export * from "./MacroParser";