galacean · GuoLei1990 · Jan 16, 2024 · Sep 20, 2023 · Sep 20, 2023 · Sep 20, 2023
diff --git a/packages/shader-lab/src/Ast2GLSLUtils.ts b/packages/shader-lab/src/Ast2GLSLUtils.ts
@@ -12,7 +12,7 @@ export class Ast2GLSLUtils {
       (fn) => fn.content.name === vertexFnProperty.content.value.content.variable
     );
     if (!vertFnAst) {
-      context.diagnostics.push({
+      context.addDiagnostic({
         severity: DiagnosticSeverity.Error,
         message: `Not found vertex shader definition: ${vertexFnProperty.content.value}`,
         token: vertexFnProperty.position
@@ -39,7 +39,7 @@ export class Ast2GLSLUtils {
       if (type.isCustom) {
         const structAstNode = context.findGlobal(type.text).ast as StructAstNode;
         if (!structAstNode) {
-          context.diagnostics.push({
+          context.addDiagnostic({
             severity: DiagnosticSeverity.Error,
             message: "no attribute struct definition",
             token: arg.position
@@ -86,7 +86,7 @@ export class Ast2GLSLUtils {
       (fn) => fn.content.name === fragmentFnProperty.content.value.content.variable
     );
     if (!fragFnAst) {
-      context.diagnostics.push({
+      context.addDiagnostic({
         severity: DiagnosticSeverity.Error,
         message: `Not found fragment shader definition: ${fragmentFnProperty.content.value}`,
         token: fragmentFnProperty.position

diff --git a/packages/shader-lab/src/AstNodeUtils.ts b/packages/shader-lab/src/AstNodeUtils.ts
@@ -31,8 +31,8 @@ export class AstNodeUtils {
 
   static defaultVisit(this: ICstVisitor<any, AstNode>, ctx: CstChildrenDictionary): ObjectAstNode {
     const content = {} as Record<string, AstNode>;
-    let start: IPosition = { line: Number.MAX_SAFE_INTEGER, character: -1 },
-      end: IPosition = { line: 0, character: -1 };
+    let start: IPosition = { line: Number.MAX_SAFE_INTEGER, character: -1, index: -1 },
+      end: IPosition = { line: 0, character: -1, index: -1 };
 
     for (const k in ctx) {
       if (AstNodeUtils.isCstNode(ctx[k][0])) {
@@ -63,11 +63,13 @@ export class AstNodeUtils {
     return {
       start: {
         line: token.startLine,
-        character: token.startColumn
+        character: token.startColumn,
+        index: token.startOffset
       },
       end: {
         line: token.endLine,
-        character: token.endColumn
+        character: token.endColumn,
+        index: token.endOffset
       }
     };
   }

diff --git a/packages/shader-lab/src/ParsingContext.ts b/packages/shader-lab/src/ParsingContext.ts
@@ -0,0 +1,66 @@
+import { IPosition } from "./ast-node";
+
+export interface IPositionOffset {
+  /** Offset of the first character of the Token. 0-indexed. */
+  index: number;
+  line: number;
+}
+
+export default class ParsingContext {
+  private _parseString: string;
+  get parseString(): string {
+    return this._parseString;
+  }
+
+  private _positionOffsetList: IPositionOffset[] = [];
+  get positionOffsetList() {
+    return this._positionOffsetList;
+  }
+
+  constructor(input: string) {
+    this._parseString = input;
+  }
+
+  balanceGroups(title: string) {
+    let balance = 0;
+    let start = -1;
+    let end = -1;
+    let line = 0;
+    for (let i = 0; i < this._parseString.length; i++) {
+      if (this._parseString.substring(i, i + title.length) === title) {
+        start = i;
+      }
+      if (start < 0) continue;
+
+      if (this._parseString[i] === "{") {
+        balance++;
+      } else if (this._parseString[i] === "}") {
+        if (--balance === 0) {
+          end = i + 1;
+          break;
+        }
+      } else if (this._parseString[i] === "\n") {
+        line++;
+      }
+    }
+    if (start >= 0) return { start, end, line };
+  }
+
+  filterString(title: string) {
+    let range = this.balanceGroups(title);
+    if (range) {
+      this._parseString = this._parseString.slice(0, range.start) + this._parseString.slice(range.end);
+      this._positionOffsetList.push({ index: range.start, line: range.line });
+    }
+  }
+
+  getTextLineOffsetAt(index: number) {
+    let offset = 0;
+    for (const item of this._positionOffsetList) {
+      if (index >= item.index) {
+        offset += item.line;
+      }
+    }
+    return offset;
+  }
+}
diff --git a/packages/shader-lab/src/RuntimeContext.ts b/packages/shader-lab/src/RuntimeContext.ts
@@ -24,6 +24,7 @@ import {
 } from "./ast-node";
 import { AstNodeUtils } from "./AstNodeUtils";
 import { RenderStateDataKey } from "@galacean/engine";
+import ParsingContext from "./ParsingContext";
 
 export interface IDiagnostic {
   severity: DiagnosticSeverity;
@@ -66,7 +67,7 @@ export default class RuntimeContext {
 
   functionAstStack: { fnAst: FnAstNode; localDeclaration: VariableDeclarationAstNode[] }[] = [];
   /** Diagnostic for linting service. */
-  diagnostics: IDiagnostic[] = [];
+  private _diagnostics: IDiagnostic[] = [];
   /** Varying info. */
   varyingTypeAstNode?: ReturnTypeAstNode;
   /** Varying. */
@@ -94,6 +95,11 @@ export default class RuntimeContext {
   private _passGlobalMap: GlobalMap = new Map();
   /** The main function */
   private _currentMainFnAst?: FnAstNode;
+  private _parsingContext: ParsingContext;
+
+  set parsingContext(context: ParsingContext) {
+    this._parsingContext = context;
+  }
 
   /** Current position */
   get serializingAstNode() {
@@ -108,6 +114,15 @@ export default class RuntimeContext {
     return this._currentMainFnAst;
   }
 
+  addDiagnostic(diagnostic: IDiagnostic) {
+    let offset = this._parsingContext.getTextLineOffsetAt(diagnostic.token.start.index);
+    if (offset) {
+      diagnostic.token.start.line += offset;
+      diagnostic.token.end.line += offset;
+    }
+    this._diagnostics.push(diagnostic);
+  }
+
   setSerializingNode(node: AstNode) {
     this._serializingNodeStack.push(node);
   }
@@ -166,7 +181,7 @@ export default class RuntimeContext {
     switch (prop.content.type) {
       case VERT_FN_NAME:
         if (ret.vertexSource) {
-          this.diagnostics.push({
+          this.addDiagnostic({
             severity: DiagnosticSeverity.Error,
             message: "multiple vertex main function found",
             token: prop.position
@@ -178,7 +193,7 @@ export default class RuntimeContext {
         break;
       case FRAG_FN_NAME:
         if (ret.fragmentSource) {
-          this.diagnostics.push({
+          this.addDiagnostic({
             severity: DiagnosticSeverity.Error,
             message: "multiple fragment main function found",
             token: prop.position
@@ -193,7 +208,7 @@ export default class RuntimeContext {
         const variable = prop.content.value;
         const astNode = this.findGlobal(variable.content.variable)?.ast;
         if (!astNode) {
-          this.diagnostics.push({
+          this.addDiagnostic({
             severity: DiagnosticSeverity.Error,
             message: "variable definition not found",
             token: prop.position

diff --git a/packages/shader-lab/src/ShaderLab.ts b/packages/shader-lab/src/ShaderLab.ts
@@ -2,6 +2,7 @@ import { IShaderLab } from "@galacean/engine-design";
 import { ShaderParser } from "./parser/ShaderParser";
 import { ShaderVisitor } from "./ShaderVisitor";
 import RuntimeContext from "./RuntimeContext";
+import ParsingContext from "./ParsingContext";
 
 export class ShaderLab implements IShaderLab {
   /** @internal */
@@ -23,21 +24,26 @@ export class ShaderLab implements IShaderLab {
   }
 
   parseShader(shaderSource: string) {
-    const editorPropertiesRegex = /EditorProperties\s+\{[^}]*?\}/;
+    const parsingContext = new ParsingContext(shaderSource);
+    this._context.parsingContext = parsingContext;
+    parsingContext.filterString("EditorProperties");
+    parsingContext.filterString("EditorMacros");
 
-    const input = shaderSource.replace(editorPropertiesRegex, "");
-
-    this._parser.parse(input);
+    this._parser.parse(parsingContext.parseString);
     const cst = this._parser.ruleShader();
     if (this._parser.errors.length > 0) {
-      console.log(this._parser.errors);
+      for (const err of this._parser.errors) {
+        const offset = parsingContext.getTextLineOffsetAt(err.token.startOffset);
+        if (offset) {
+          err.token.startLine += offset;
+          err.token.endLine += offset;
+        }
+      }
       throw this._parser.errors;
     }
 
     const ast = this._visitor.visit(cst);
-
     const shaderInfo = this._context.parse(ast);
-
     return shaderInfo;
   }
 }
diff --git a/packages/shader-lab/src/ShaderVisitor.ts b/packages/shader-lab/src/ShaderVisitor.ts
@@ -302,8 +302,8 @@ export class ShaderVisitor extends ShaderVisitorConstructor implements Partial<I
   }
 
   _ruleFnBody(ctx: _ruleFnBodyCstChildren) {
-    let start: IPosition = { line: Number.MAX_SAFE_INTEGER, character: -1 },
-      end: IPosition = { line: 0, character: -1 };
+    let start: IPosition = { line: Number.MAX_SAFE_INTEGER, character: -1, index: -1 },
+      end: IPosition = { line: 0, character: -1, index: -1 };
 
     const iterate = (item: CstNode) => {
       const astInfo = this.visit(item);
@@ -749,8 +749,16 @@ export class ShaderVisitor extends ShaderVisitorConstructor implements Partial<I
 
   _ruleBlendStatePropertyDeclaration(children: _ruleBlendStatePropertyDeclarationCstChildren, param?: any) {
     const position: IPositionRange = {
-      start: { line: children.BlendState[0].startLine, character: children.BlendState[0].startOffset },
-      end: { line: children.RCurly[0].endLine, character: children.RCurly[0].endOffset }
+      start: {
+        line: children.BlendState[0].startLine,
+        character: children.BlendState[0].startColumn,
+        index: children.BlendState[0].startOffset
+      },
+      end: {
+        line: children.RCurly[0].endLine,
+        character: children.RCurly[0].endColumn,
+        index: children.RCurly[0].endOffset
+      }
     };
 
     const variable = children.Identifier?.[0].image;
@@ -817,8 +825,16 @@ export class ShaderVisitor extends ShaderVisitorConstructor implements Partial<I
 
   _ruleRasterStatePropertyDeclaration(children: _ruleRasterStatePropertyDeclarationCstChildren, param?: any) {
     const position: IPositionRange = {
-      start: { line: children.RasterState[0].startLine, character: children.RasterState[0].startOffset },
-      end: { line: children.RCurly[0].startLine, character: children.RCurly[0].startOffset }
+      start: {
+        line: children.RasterState[0].startLine,
+        character: children.RasterState[0].startColumn,
+        index: children.RasterState[0].startOffset
+      },
+      end: {
+        line: children.RCurly[0].startLine,
+        character: children.RCurly[0].endColumn,
+        index: children.RasterState[0].endOffset
+      }
     };
 
     const variable = children.Identifier?.[0].image;
@@ -831,8 +847,16 @@ export class ShaderVisitor extends ShaderVisitorConstructor implements Partial<I
 
   _ruleDepthSatePropertyDeclaration(children: _ruleDepthSatePropertyDeclarationCstChildren, param?: any) {
     const position: IPositionRange = {
-      start: { line: children.DepthState[0].startLine, character: children.DepthState[0].startOffset },
-      end: { line: children.RCurly[0].startLine, character: children.RCurly[0].startOffset }
+      start: {
+        line: children.DepthState[0].startLine,
+        character: children.DepthState[0].startOffset,
+        index: children.DepthState[0].startOffset
+      },
+      end: {
+        line: children.RCurly[0].endLine,
+        character: children.RCurly[0].endColumn,
+        index: children.RCurly[0].endOffset
+      }
     };
 
     const variable = children.Identifier?.[0].image;
@@ -887,8 +911,16 @@ export class ShaderVisitor extends ShaderVisitorConstructor implements Partial<I
 
   _ruleStencilStatePropertyDeclaration(children: _ruleStencilStatePropertyDeclarationCstChildren, param?: any) {
     const position: IPositionRange = {
-      start: { line: children.StencilState[0].startLine, character: children.StencilState[0].startOffset },
-      end: { line: children.RCurly[0].startLine, character: children.RCurly[0].startOffset }
+      start: {
+        line: children.StencilState[0].startLine,
+        character: children.StencilState[0].startColumn,
+        index: children.StencilState[0].startOffset
+      },
+      end: {
+        line: children.RCurly[0].endLine,
+        character: children.RCurly[0].endColumn,
+        index: children.RCurly[0].endOffset
+      }
     };
 
     const variable = children.Identifier?.[0].image;

diff --git a/packages/shader-lab/src/ast-node/AstNode.ts b/packages/shader-lab/src/ast-node/AstNode.ts
@@ -78,6 +78,8 @@ import {
 export interface IPosition {
   line: number;
   character: number;
+  // offset from first character
+  index: number;
 }
 
 export interface IPositionRange {
@@ -208,7 +210,7 @@ export class FnAstNode extends AstNode<IFnAstContent> {
       (this.content.returnType.content.text === "void" && this.content.returnStatement) ||
       (this.content.returnType.content.text !== "void" && !this.content.returnStatement)
     ) {
-      context.diagnostics.push({
+      context.addDiagnostic({
         severity: DiagnosticSeverity.Error,
         message: "Mismatched return type",
         token: this.position
@@ -317,7 +319,7 @@ export class FnCallAstNode extends AstNode<IFnCallAstContent> {
   override _doSerialization(context: RuntimeContext): string {
     if (this.content.isCustom) {
       if (!context.referenceGlobal(this.content.function)) {
-        context.diagnostics.push({
+        context.addDiagnostic({
           severity: DiagnosticSeverity.Warning,
           message: `Not found function definition: ${this.content.function}`,
           token: this.position
@@ -497,7 +499,7 @@ export class FnVariableAstNode extends AstNode<IFnVariableAstContent> {
     }
     if (!context.findLocal(objName)) {
       if (!context.referenceGlobal(objName)) {
-        context.diagnostics.push({
+        context.addDiagnostic({
           severity: DiagnosticSeverity.Error,
           message: `Not found variable definition: ${objName}`,
           token: this.position
@@ -571,7 +573,7 @@ export class RenderStateDeclarationAstNode extends AstNode<IRenderStateDeclarati
       }
       const renderStateKey = RenderStateDataKey[_propertyKey];
       if (renderStateKey === undefined) {
-        context?.diagnostics.push({
+        context?.addDiagnostic({
           severity: DiagnosticSeverity.Error,
           message: "invalid render state key",
           token: prop.position
@@ -603,7 +605,7 @@ export class RenderStatePropertyItemAstNode extends AstNode<IRenderStateProperty
     if (isVariable && context) {
       const global = context.findGlobal(this.content.value.content);
       if (!global) {
-        context.diagnostics.push({
+        context.addDiagnostic({
           severity: DiagnosticSeverity.Warning,
           message: "not found variable definition",
           token: this.content.value.position
@@ -645,7 +647,7 @@ export class VariableDeclarationAstNode extends AstNode<IFnVariableDeclarationAs
     }
     if (typeNode.content.isCustom) {
       if (!context.referenceGlobal(typeNode.content.text)) {
-        context.diagnostics.push({
+        context.addDiagnostic({
           severity: DiagnosticSeverity.Error,
           message: `Undefined type ${typeNode.content.text}`,
           token: this.position