Evaluating expanded macros in conditional expressions

package.json

@@ -10,8 +10,8 @@
     "prepare": "npm run build && ./prepublish.sh",
     "postpublish": "./postbuild.sh",
     "build": "./build.sh",
-    "watch-test": "jest --watch",
-    "test": "jest --colors"
+    "watch-test": "vitest --watch",
+    "test": "vitest --colors"
   },
   "files": [
     "ast",
@@ -42,13 +42,12 @@
     "@babel/preset-typescript": "^7.15.0",
     "@swc/core": "^1.4.11",
     "@swc/jest": "^0.2.36",
-    "@types/jest": "^27.0.2",
-    "@types/node": "^16.10.2",
-    "jest": "^29.7.0",
+    "@types/node": "^24.3.0",
     "peggy": "^1.2.0",
     "prettier": "^2.1.2",
     "ts-jest": "^29.1.2",
     "ts-jest-resolver": "^2.0.1",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.3",
+    "vitest": "^3.2.4"
   }
 }

src/ast/ast.test.ts

@@ -1,3 +1,5 @@
+import { expect, test } from 'vitest';
+
 import {
   AstNode,
   BinaryNode,

src/parser/parse.test.ts

@@ -1,9 +1,11 @@
+import { expect, test, beforeAll, vi } from 'vitest';
+
 import { FunctionCallNode, visit } from '../ast/index.js';
 import { GlslSyntaxError } from '../error.js';
 import { buildParser } from './test-helpers.js';
 
-let c!: ReturnType<typeof buildParser>;
-beforeAll(() => (c = buildParser()));
+let c!: Awaited<ReturnType<typeof buildParser>>;
+beforeAll(async () => (c = await buildParser()));
 
 test('parse error', () => {
   let error: GlslSyntaxError | undefined;
@@ -354,7 +356,7 @@ test('Locations with location disabled', () => {
 });
 
 test('built-in function names should be identified as keywords', () => {
-  console.warn = jest.fn();
+  console.warn = vi.fn();
 
   const src = `
 void main() {
@@ -442,7 +444,7 @@ test('exotic precision statements', () => {
 });
 
 test('warns when grammar stage is unknown', () => {
-  const consoleWarnMock = jest
+  const consoleWarnMock = vi
     .spyOn(console, 'warn')
     .mockImplementation(() => {});
 
@@ -458,7 +460,7 @@ test('warns when grammar stage is unknown', () => {
 });
 
 test('does not warn on built in stage variable', () => {
-  const consoleWarnMock = jest
+  const consoleWarnMock = vi
     .spyOn(console, 'warn')
     .mockImplementation(() => {});
 
@@ -476,7 +478,7 @@ test('does not warn on built in stage variable', () => {
 });
 
 test('does not warn on built in either stage variable', () => {
-  const consoleWarnMock = jest
+  const consoleWarnMock = vi
     .spyOn(console, 'warn')
     .mockImplementation(() => {});
 
@@ -495,7 +497,7 @@ test('does not warn on built in either stage variable', () => {
 });
 
 test('warn on variable from wrong stage', () => {
-  const consoleWarnMock = jest
+  const consoleWarnMock = vi
     .spyOn(console, 'warn')
     .mockImplementation(() => {});
 

src/parser/scope.test.ts

@@ -1,3 +1,5 @@
+import { expect, test, beforeAll } from 'vitest';
+
 import generate from './generator.js';
 import { renameBindings, renameFunctions, renameTypes } from './utils.js';
 import { UNKNOWN_TYPE } from './grammar.js';
@@ -7,7 +9,7 @@
 beforeAll(() => (c = buildParser()));
 
 test('scope bindings and type names', () => {
   const ast = c.parseSrc(`
 float selfref, b = 1.0, c = selfref;
 vec2 texcoord1, texcoord2;
 vec3 position;
@@ -47,7 +49,7 @@
 });
 
 test('scope references', () => {
   const ast = c.parseSrc(
     `
 float selfref, b = 1.0, c = selfref;
 mat2x2 myMat = mat2( vec2( 1.0, 0.0 ), vec2( 0.0, 1.0 ) );
@@ -124,7 +126,7 @@
 });
 
 test('scope binding declarations', () => {
   const ast = c.parseSrc(
     `
 float selfref, b = 1.0, c = selfref;
 void main() {
@@ -144,7 +146,7 @@
 });
 
 test('struct constructor identified in scope', () => {
   const ast = c.parseSrc(`
 struct light {
   float intensity;
   vec3 position;
@@ -155,7 +157,7 @@
 });
 
 test('function overloaded scope', () => {
   const ast = c.parseSrc(`
 vec4 overloaded(vec4 x) {
   return x;
 }
@@ -167,7 +169,7 @@
 
 test('overriding glsl builtin function', () => {
   // "noise" is a built-in GLSL function that should be identified and renamed
   const ast = c.parseSrc(`
 float noise() {}
 float fn() {
     vec2 uv;
@@ -190,7 +192,7 @@
 });
 
 test('rename bindings and functions', () => {
   const ast = c.parseSrc(
     `
 float selfref, b = 1.0, c = selfref;
 mat2x2 myMat = mat2( vec2( 1.0, 0.0 ), vec2( 0.0, 1.0 ) );
@@ -290,7 +292,7 @@
 });
 
 test('detecting struct scope and usage', () => {
   const ast = c.parseSrc(`
 struct StructName {
   vec3 color;
 };
@@ -362,7 +364,7 @@
 });
 
 test('fn args shadowing global scope identified as separate bindings', () => {
   const ast = c.parseSrc(`
 attribute vec3 position;
 vec3 func(vec3 position) {
   return position;
@@ -379,7 +381,7 @@
 });
 
 test('I do not yet know what to do with layout()', () => {
   const ast = c.parseSrc(`
 layout(std140,column_major) uniform;
 float a;
 uniform Material

src/parser/test-helpers.ts

@@ -1,16 +1,16 @@
+import { expect, vi } from 'vitest';
 import { execSync } from 'child_process';
 import { GrammarError } from 'peggy';
 import util from 'util';
 import generate from './generator.js';
 import { AstNode, FunctionNode, Program } from '../ast/index.js';
 import { Parse, ParserOptions } from './parser.js';
-import { FunctionScopeIndex, Scope, ScopeIndex } from './scope.js';
 
 export const inspect = (arg: any) =>
   console.log(util.inspect(arg, false, null, true));
 
 export const nextWarn = () => {
-  console.warn = jest.fn();
+  console.warn = vi.fn();
   let i = 0;
   // @ts-ignore
   const mock = console.warn.mock;
@@ -22,11 +22,11 @@ type Context = {
   parseSrc: ParseSrc;
 };
 
-export const buildParser = () => {
+export const buildParser = async () => {
   execSync(
     'npx peggy --cache --format es -o src/parser/parser.js src/parser/glsl-grammar.pegjs'
   );
-  const parser = require('./parser');
+  const parser = await import('./parser.js');
   const parse = parser.parse as Parse;
   const ps = parseSrc(parse);
   const ctx: Context = {
@@ -45,11 +45,11 @@ export const buildParser = () => {
   };
 };
 
-export const buildPreprocessorParser = () => {
+export const buildPreprocessorParser = async () => {
   execSync(
     'npx peggy --cache --format es -o src/preprocessor/preprocessor-parser.js src/preprocessor/preprocessor-grammar.pegjs'
   );
-  const { parse, parser } = require('../preprocessor');
+  const { parse, parser } = await import('../preprocessor/index.js');
   return {
     parse,
     parser,

src/preprocessor/generator.ts

@@ -1,4 +1,4 @@
-import { makeGenerator, NodeGenerators } from '../ast/index.js';
+import { makeGenerator } from '../ast/index.js';
 import { PreprocessorProgram } from './preprocessor.js';
 import { PreprocessorAstNode } from './preprocessor-node.js';
 
@@ -91,6 +91,7 @@ const generators: NodePreprocessorGenerators = {
     generate(node.rp) +
     generate(node.body) +
     generate(node.wsEnd),
+  replacement_list: (node) => generate(node.list) + generate(node.wsEnd),
 
   conditional: (node) =>
     generate(node.wsStart) +

src/preprocessor/preprocessor-grammar.pegjs

@@ -129,6 +129,28 @@ text_or_control_lines =
     return node('segment', { blocks });
   }
 
+punctuator = wsStart:_? punctuator:$(
+  "[" / "]" / "(" / ")" / "{" / "}" / "." / "->"
+  "++" / "--" / "&" / "*" / "+" / "-" / "~" / "!"
+  "/" / "%" / "<<" / ">>" / "<" / ">" / "<=" / "==" / "!=" / "^" / "|" / "&&" / "||"
+  "?" / ":" / ";" / "..."
+  "=" / "*=" / "/=" / "%=" / "+=" / "-=" / "<<=" / ">>=" / "&=" / "^=" / "|="
+  "," / "###"
+  "<:" / ":>" / "%<" / "%>" / "%:" / "%:%:"
+) _:_? {
+  return node('literal', { literal: punctuator, wsEnd: _ });
+}
+
+replacement_list "replacement list"
+  = list:(
+      IDENTIFIER
+    / integer_constant
+    / punctuator
+    / token_string
+  )+ {
+    return node('replacement_list', { list: list });
+  }
+
 // Any preprocessor or directive line
 control_line "control line"
   = conditional
@@ -146,7 +168,7 @@ control_line "control line"
       body:token_string? {
         return node('define_arguments', { define, identifier, lp, args: args || [], rp, body } )
       }
-      / define:DEFINE identifier:IDENTIFIER body:token_string? {
+      / define:DEFINE identifier:IDENTIFIER body:replacement_list? {
         return node('define', { define, identifier, body } )
       }
       / line:LINE value:$digit+ {

src/preprocessor/preprocessor-node.ts

@@ -42,6 +42,12 @@ export interface PreprocessorDefineNode extends IPreprocessorNode {
   body: string;
 }
 
+export interface PreprocessorReplacementListNode extends IPreprocessorNode {
+  type: 'replacement_list';
+  list: PreprocessorAstNode[];
+  wsEnd: string;
+}
+
 export interface PreprocessorElseNode extends IPreprocessorNode {
   type: 'else';
   token: string;
@@ -172,6 +178,7 @@ export type PreprocessorAstNode =
   | PreprocessorConditionalNode
   | PreprocessorDefineArgumentsNode
   | PreprocessorDefineNode
+  | PreprocessorReplacementListNode
   | PreprocessorElseNode
   | PreprocessorElseIfNode
   | PreprocessorErrorNode

src/preprocessor/preprocessor.test.ts

@@ -1,3 +1,5 @@
+import { expect, test, beforeAll } from 'vitest';
+
 import util from 'util';
 import {
   preprocessComments,
@@ -10,10 +12,10 @@ import { GlslSyntaxError } from '../error.js';
 
 import { buildPreprocessorParser } from '../parser/test-helpers.js';
 
-let c!: ReturnType<typeof buildPreprocessorParser>;
+let c!: Awaited<ReturnType<typeof buildPreprocessorParser>>;
 let parse: (src: string, options?: PreprocessorOptions) => PreprocessorProgram;
-beforeAll(() => {
-  c = buildPreprocessorParser();
+beforeAll(async () => {
+  c = await buildPreprocessorParser();
   parse = c.parse;
 });
 
@@ -40,6 +42,36 @@ const expectParsedProgram = (
 // test('pre test file', () => {
 //   expectParsedProgram(fileContents('./preprocess-test-grammar.glsl'));
 // });
+test('evaluates binary expression with simple macro', () => {
+  const program = `
+#define A 1
+#if A + 1 == 2
+true
+#endif
+`;
+
+  const ast = parse(program);
+  preprocessAst(ast);
+  expect(generate(ast)).toBe(`
+true
+`);
+});
+
+test('evaluates binary expression with nested macro', () => {
+  const program = `
+#define A 1
+#define B A + 1
+#if B == 2
+true
+#endif
+`;
+
+  const ast = parse(program);
+  preprocessAst(ast);
+  expect(generate(ast)).toBe(`
+true
+`);
+});
 
 test('#preprocessComments', () => {
   // Should strip comments and replace single-line comments with a single space
@@ -130,6 +162,37 @@ true
 `);
 });
 
+test('evaluates binary expression with simple macro', () => {
+  const program = `
+#define A 1
+#if A + 1 == 2
+true
+#endif
+`;
+
+  const ast = parse(program);
+  preprocessAst(ast);
+  expect(generate(ast)).toBe(`
+true
+`);
+});
+
+test('evaluates binary expression with nested macro', () => {
+  const program = `
+#define A 1
+#define B A + 1
+#if B == 2
+true
+#endif
+`;
+
+  const ast = parse(program);
+  preprocessAst(ast);
+  expect(generate(ast)).toBe(`
+true
+`);
+});
+
 test('define inside if/else is properly expanded when the if branch is chosen', () => {
   const program = `
 #define MACRO
@@ -489,17 +552,17 @@ bar()`);
 // for now. The current preprocessor results in bar(bar(1.0)). To achieve the
 // correct result here I likely need to redo the expansion system to use "blue
 // painting" https://en.wikipedia.org/wiki/Painted_blue
-xtest('nested function macros that reference each other', () => {
-  const program = `
-#define foo(x) bar(x)
-#define bar(x) foo(x)
-bar(foo(1.0))`;
-
-  const ast = parse(program);
-  preprocessAst(ast);
-  expect(generate(ast)).toBe(`
-bar(foo(1.0))`);
-});
+// xtest('nested function macros that reference each other', () => {
+//   const program = `
+// #define foo(x) bar(x)
+// #define bar(x) foo(x)
+// bar(foo(1.0))`;
+
+//   const ast = parse(program);
+//   preprocessAst(ast);
+//   expect(generate(ast)).toBe(`
+// bar(foo(1.0))`);
+// });
 
 test('multi-pass cross-referencing object macros', () => {
   const program = `

src/preprocessor/preprocessor.ts

@@ -7,6 +7,7 @@ import {
   PreprocessorLiteralNode,
   PreprocessorSegmentNode,
 } from './preprocessor-node.js';
+import generate from './generator.js';
 
 export type PreprocessorProgram = {
   type: string;
@@ -581,7 +582,7 @@ const preprocessAst = (
           args,
         } = path.node;
 
-        macros[identifier] = { args, body };
+        macros[identifier] = { args, body: generate(body) };
         !preserveNode(path) && path.remove();
       },
     },
@@ -593,7 +594,7 @@ const preprocessAst = (
           body,
         } = path.node;
 
-        macros[identifier] = { body };
+        macros[identifier] = { body: generate(body) };
         !preserveNode(path) && path.remove();
       },
     },

vite.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  server: {
+    watch: {
+      ignored: ['**/*.js'],
+    },
+  },
+});