@aethervtt/shard-shader 0.0.1 → 0.2.0

package/dist/library.d.ts

@@ -1,5 +1,7 @@
+import { ShardError } from '@aethervtt/shard-core';
 import type { GpuContext } from '@aethervtt/shard-gpu';
 import type { Platform } from '@aethervtt/shard-platform';
+import type { RetargetedBinding } from './baseline/rewrite.js';
 export interface LinkRequest {
     /** Module with the entry points, e.g. `shard::pbr::main` or `project::water`. */
     root: string;
@@ -20,6 +22,8 @@ export interface LinkedShader {
     code: string;
     /** Maps a character offset in `code` back to the module that produced it. */
     locate(offset: number): SourceLocation | undefined;
+    /** Baseline variants (0064): the bindings the rewrite retargeted, for the engine's layouts. */
+    bindings?: readonly RetargetedBinding[];
 }
 /** One linked variant, for `ShaderLibrary.preload`. */
 export interface BakedShader {
@@ -39,13 +43,18 @@ export interface ShaderBake {
  * under `shard::`, plugins under their own package, a project's `shaders/` folder under `project::`.
  */
 export declare class ShaderLibrary {
+    /** Module sources as they link: `@data` marks stripped (0064). */
     private readonly sources;
+    /** Each module's `@data` declarations, for baseline variants. */
+    private readonly data;
     /** Where each module came from, for error messages (a file path, or the module path). */
     private readonly origins;
     private readonly linkCache;
     private readonly variants;
     private readonly listeners;
     private version;
+    /** Bumps whenever a module is registered or changes: what renderers compare to retry failures. */
+    get revision(): number;
     private readonly preloaded;
     /** Every variant linked or served from the bake, for `bake()`. */
     private readonly used;
@@ -92,6 +101,12 @@ export declare class ShaderLibrary {
      */
     module(gpu: GpuContext, request: LinkRequest): GPUShaderModule | undefined;
     private rebuild;
+    /**
+     * Why a variant has no module to give: its code failed to link or compile, and no earlier version
+     * compiled either. Undefined while it compiles, once it has a module, and for unknown variants.
+     * Renderers draw with a fallback then instead of skipping the draw forever (0061).
+     */
+    failure(request: LinkRequest, gpu?: GpuContext): ShardError | undefined;
     /** Waits until every variant requested through `module()` has finished compiling. */
     whenIdle(): Promise<void>;
     /** Module graph and hooks, for agents. */
@@ -105,7 +120,12 @@ export declare class ShaderLibrary {
         };
         defines: string[];
     };
-    /** Of the source of every module a variant links: its root's imports, and the overrides'. */
+    /** Every module a variant links: its root's imports, and the overrides'. */
+    private closureOf;
+    /**
+     * Of the source of every module a variant links. A baseline variant's also covers its `@data`
+     * declarations and the rewrite's version, which change its code and not its modules' text.
+     */
     private hashOf;
     private doLink;
 }

package/dist/library.js

@@ -1,4 +1,5 @@
 import { ShardError } from "@aethervtt/shard-core";
+import { BASELINE_REWRITE_VERSION, collectData } from "./data-marks.js";
 import { applyHooks, findHooks } from "./hooks.js";
 let wesl;
 const loadWesl = () => {
@@ -22,13 +23,20 @@ function lineColumn(text, offset) {
   return { line, column: offset - lineStart + 1 };
 }
 class ShaderLibrary {
+  /** Module sources as they link: `@data` marks stripped (0064). */
   sources = /* @__PURE__ */ new Map();
+  /** Each module's `@data` declarations, for baseline variants. */
+  data = /* @__PURE__ */ new Map();
   /** Where each module came from, for error messages (a file path, or the module path). */
   origins = /* @__PURE__ */ new Map();
   linkCache = /* @__PURE__ */ new Map();
   variants = /* @__PURE__ */ new Map();
   listeners = /* @__PURE__ */ new Set();
   version = 0;
+  /** Bumps whenever a module is registered or changes: what renderers compare to retry failures. */
+  get revision() {
+    return this.version;
+  }
   preloaded = /* @__PURE__ */ new Map();
   /** Every variant linked or served from the bake, for `bake()`. */
   used = /* @__PURE__ */ new Map();
@@ -62,8 +70,11 @@ class ShaderLibrary {
         hint: "Use lowercase `package::dir::name`, e.g. `project::water`."
       });
     }
-    if (this.sources.get(path) === source) return;
-    this.sources.set(path, source);
+    const { code, data } = collectData(source, path);
+    if (this.sources.get(path) === code && sameData(this.data.get(path), data)) return;
+    this.sources.set(path, code);
+    if (data.length > 0) this.data.set(path, data);
+    else this.data.delete(path);
     this.origins.set(path, origin ?? path);
     this.version++;
     this.linkCache.clear();
@@ -156,10 +167,13 @@ class ShaderLibrary {
    * the error is reported through the GPU context and the old module stays in use.
    */
   module(gpu, request) {
+    if (gpu.tier === "baseline" && !request.defines?.BASELINE) {
+      request = { ...request, defines: { ...request.defines, BASELINE: true } };
+    }
     const key = variantKey(request);
     let state = this.variants.get(key);
     if (!state) {
-      state = { good: void 0, pending: void 0, version: -1, gpu, request };
+      state = { good: void 0, pending: void 0, version: -1, gpu, request, failed: void 0 };
       this.variants.set(key, state);
     }
     const s = state;
@@ -178,28 +192,43 @@ class ShaderLibrary {
         if (s.good?.code !== linked.code) {
           s.pending = linked.code;
           const error = await compile(gpu, linked);
-          if (error) gpu.reportError(labelled(error, request.label));
-          else
+          if (error) {
+            s.failed = labelled(error, request.label);
+            gpu.reportError(s.failed);
+          } else {
+            s.failed = void 0;
             s.good = {
               code: linked.code,
               module: moduleFor(gpu, linked),
               linked,
               generation: gpu.generation
             };
-        }
+          }
+        } else s.failed = void 0;
         s.pending = void 0;
       },
       (err) => {
-        gpu.reportError(
-          labelled(
-            err instanceof ShardError ? err : new ShardError("shader/link", String(err)),
-            request.label
-          )
+        s.failed = labelled(
+          err instanceof ShardError ? err : new ShardError("shader/link", String(err)),
+          request.label
         );
+        gpu.reportError(s.failed);
         s.pending = void 0;
       }
     );
   }
+  /**
+   * Why a variant has no module to give: its code failed to link or compile, and no earlier version
+   * compiled either. Undefined while it compiles, once it has a module, and for unknown variants.
+   * Renderers draw with a fallback then instead of skipping the draw forever (0061).
+   */
+  failure(request, gpu) {
+    if (gpu?.tier === "baseline" && !request.defines?.BASELINE) {
+      request = { ...request, defines: { ...request.defines, BASELINE: true } };
+    }
+    const s = this.variants.get(variantKey(request));
+    return s && !s.good && s.pending === void 0 ? s.failed : void 0;
+  }
   /** Waits until every variant requested through `module()` has finished compiling. */
   async whenIdle() {
     for (let i = 0; i < 200; i++) {
@@ -221,18 +250,28 @@ class ShaderLibrary {
       defines: [...new Set(reachable.flatMap((m) => definesOf(this.sources.get(m) ?? "")))].sort()
     };
   }
-  /** Of the source of every module a variant links: its root's imports, and the overrides'. */
-  hashOf(request) {
-    const imports = (p) => importsOf(this.sources.get(p) ?? "");
+  /** Every module a variant links: its root's imports, and the overrides'. */
+  closureOf(request) {
+    const imports = (p) => importsOf(this.sources.get(p) ?? "", request.defines ?? {});
     const paths = /* @__PURE__ */ new Set();
     for (const root of [request.root, ...request.overrides ?? []])
       for (const p of closure(root, imports)) paths.add(p);
+    return [...paths].sort();
+  }
+  /**
+   * Of the source of every module a variant links. A baseline variant's also covers its `@data`
+   * declarations and the rewrite's version, which change its code and not its modules' text.
+   */
+  hashOf(request) {
+    const paths = this.closureOf(request);
     let a = 2166136261;
     let b = 2538058380;
-    for (const path of [...paths].sort()) {
-      const text = `${path}
+    const baseline = request.defines?.BASELINE ? `baseline ${BASELINE_REWRITE_VERSION} ${JSON.stringify(paths.map((p) => this.data.get(p) ?? []))}
+` : "";
+    for (const path of [...paths, ...baseline ? [""] : []]) {
+      const text = path ? `${path}
 ${this.sources.get(path) ?? ""}
-`;
+` : baseline;
       for (let i = 0; i < text.length; i++) {
         const c = text.charCodeAt(i);
         a = Math.imul(a ^ c, 16777619);
@@ -254,7 +293,11 @@ ${this.sources.get(path) ?? ""}
         );
       }
     }
-    for (const path of closure(request.root, (p) => importsOf(this.sources.get(p) ?? ""))) {
+    const defines = request.defines ?? {};
+    for (const path of closure(
+      request.root,
+      (p) => importsOf(this.sources.get(p) ?? "", defines)
+    )) {
       if (!this.sources.has(path)) {
         const importer = [...this.sources].find(([, src]) => importsOf(src).includes(path))?.[0];
         throw new ShardError("shader/link-unknown-module", `Unknown shader module "${path}"`, {
@@ -302,27 +345,39 @@ ${this.sources.get(path) ?? ""}
         this.origins.get(request.root)
       );
     }
-    const code = linked.dest;
-    this.used.set(key, { key, hash, code });
     const origins = this.origins;
+    const locate = (offset) => {
+      try {
+        const pos = linked.sourceMap.destToSrc(offset);
+        const srcPath = pos.src.path ?? "";
+        const match = /^\.\/([a-z_][a-z0-9_]*)\/(.*)$/.exec(srcPath);
+        const module = fileToModule.get(`${root.pkg}|${srcPath}`) ?? (match ? fileToModule.get(`${match[1]}|./${match[2]}`) : void 0) ?? srcPath;
+        const { line, column } = lineColumn(pos.src.text, pos.position);
+        return { module: origins.get(module) ?? module, line, column };
+      } catch {
+        return void 0;
+      }
+    };
+    if (!request.defines?.BASELINE) {
+      const code = linked.dest;
+      this.used.set(key, { key, hash, code });
+      return { key, code, locate };
+    }
+    const { rewriteForBaseline } = await import("./baseline/rewrite.js");
+    const data = this.closureOf(request).flatMap((p) => this.data.get(p) ?? []);
+    const rewritten = rewriteForBaseline(linked.dest, data, locate, request.label);
+    this.used.set(key, { key, hash, code: rewritten.code });
     return {
       key,
-      code,
-      locate(offset) {
-        try {
-          const pos = linked.sourceMap.destToSrc(offset);
-          const srcPath = pos.src.path ?? "";
-          const match = /^\.\/([a-z_][a-z0-9_]*)\/(.*)$/.exec(srcPath);
-          const module = fileToModule.get(`${root.pkg}|${srcPath}`) ?? (match ? fileToModule.get(`${match[1]}|./${match[2]}`) : void 0) ?? srcPath;
-          const { line, column } = lineColumn(pos.src.text, pos.position);
-          return { module: origins.get(module) ?? module, line, column };
-        } catch {
-          return void 0;
-        }
-      }
+      code: rewritten.code,
+      locate: (offset) => locate(rewritten.toLinked(offset)),
+      bindings: rewritten.bindings
     };
   }
 }
+function sameData(a, b) {
+  return JSON.stringify(a ?? []) === JSON.stringify(b);
+}
 const moduleCache = /* @__PURE__ */ new WeakMap();
 function moduleFor(gpu, linked) {
   let cache = moduleCache.get(gpu);
@@ -372,10 +427,13 @@ function variantKey(request) {
   const defines = Object.entries(request.defines ?? {}).filter(([, on]) => on).map(([name]) => name).sort();
   return `${request.root}|${defines.join(",")}|${(request.overrides ?? []).join(",")}`;
 }
-function importsOf(source) {
+function importsOf(source, defines) {
   const out = [];
-  for (const m of source.matchAll(/^\s*import\s+([^;]+);/gm)) {
-    const spec = m[1].replace(/\s+/g, "");
+  for (const m of source.matchAll(
+    /^\s*((?:@\w+\s*\((?:[^()]|\([^()]*\))*\)\s*)*)import\s+([^;]+);/gm
+  )) {
+    if (defines && m[1] && !attributesHold(m[1], defines)) continue;
+    const spec = m[2].replace(/\s+/g, "");
     const braced = /^(.*?)::\{(.*)\}$/.exec(spec);
     if (braced) {
       for (const item of braced[2].split(",")) {
@@ -389,6 +447,44 @@ function importsOf(source) {
   }
   return [...new Set(out.filter((p) => p.includes("::") && !p.startsWith("constants")))];
 }
+function attributesHold(attributes, defines) {
+  for (const m of attributes.matchAll(/@if\s*\(((?:[^()]|\([^()]*\))*)\)/g))
+    if (!evaluateCondition(m[1], defines)) return false;
+  return true;
+}
+function evaluateCondition(expression, defines) {
+  const tokens = expression.match(/[A-Za-z_]\w*|&&|\|\||[!()]/g) ?? [];
+  let i = 0;
+  const or = () => {
+    let v = and();
+    while (tokens[i] === "||") {
+      i++;
+      v = and() || v;
+    }
+    return v;
+  };
+  const and = () => {
+    let v = unary();
+    while (tokens[i] === "&&") {
+      i++;
+      v = unary() && v;
+    }
+    return v;
+  };
+  const unary = () => {
+    const t = tokens[i++];
+    if (t === "!") return !unary();
+    if (t === "(") {
+      const v = or();
+      i++;
+      return v;
+    }
+    if (t === "true") return true;
+    if (t === "false" || t === void 0) return false;
+    return defines[t] === true;
+  };
+  return or();
+}
 function definesOf(source) {
   const out = [];
   for (const m of source.matchAll(/@(?:if|elif)\s*\(([^)]*)\)/g)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aethervtt/shard-shader",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
@@ -8,6 +8,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./fragment-kernel": {
+      "types": "./dist/baseline/fragment-kernel.d.ts",
+      "default": "./dist/baseline/fragment-kernel.js"
     }
   },
   "files": [
@@ -16,9 +20,9 @@
     "README.md"
   ],
   "dependencies": {
-    "@aethervtt/shard-core": "0.0.1",
-    "@aethervtt/shard-gpu": "0.0.1",
-    "@aethervtt/shard-platform": "0.0.1",
+    "@aethervtt/shard-core": "0.2.0",
+    "@aethervtt/shard-gpu": "0.2.0",
+    "@aethervtt/shard-platform": "0.2.0",
     "wesl": "0.7.31"
   },
   "repository": {
@@ -31,6 +35,6 @@
     "provenance": true
   },
   "shard": {
-    "buildSha": "d6c5c6aef4675575c878b02cf2c8f738b4190229"
+    "buildSha": "32c22a3944ed23f5d1baa90bf7cc9fae724f5fd8"
   }
 }