8bitworkshop/test/unit/testbuildparams.ts

import assert from "assert";
import fs from "fs";
import os from "os";
import path from "path";
import { after, before, describe, it } from "mocha";
import { store, fixParamsWithDefines, applyAsmProjectParams, parseBuildDirectives, applyBuildDirectives } from "../../src/worker/builder";
import { defineArgs, linkSymbolArgs, extraArgsFor, getPlatformToolConfig, TOOL_META } from "../../src/common/toolmeta";
import { compileSourceFile, preload } from "../../src/tools/testlib";

// Backwards-compatibility tests for the source build-directive scanner.
//
// fixParamsWithDefines() reads `//#define`/`;#define` lines out of the main
// source and rewrites the platform build params (cfgfile, libargs, compiler
// flags). These tests pin the behavior that must survive the move to an
// explicit directive grammar (//#symbol, //#arg, //#tooldef) and the
// introduction of a stage-keyed args channel. They also document the parts of
// the current contract that are load-bearing in presets/ today.
//
// The tests operate directly on fixParamsWithDefines()/applyAsmProjectParams()
// rather than through a full compile, so they're fast and don't need WASM.

let seq = 0;
function putSource(code: string, ext = ".c"): string {
  const path = `test_buildparams_${++seq}${ext}`;
  store.putFile(path, code);
  return path;
}

// Mirror of PLATFORM_PARAMS['nes'] -- mapper lives both in libargs (passed to
// ld65 as -D) and in the source as a real preprocessor #define.
function nesParams(): any {
  return {
    arch: "6502",
    cfgfile: "neslib2.cfg",
    libargs: [
      "crt0.o", "nes.lib", "neslib2.lib",
      "-D", "NES_MAPPER=0",
      "-D", "NES_PRG_BANKS=2",
      "-D", "NES_CHR_BANKS=1",
      "-D", "NES_MIRRORING=0",
    ],
    extra_link_files: ["crt0.o", "neslib2.lib", "neslib2.cfg", "nesbanked.cfg"],
    symbolConfigs: { NES_MAPPER: { "4": "nesbanked.cfg" } },
  };
}

function applyDirectives(code: string, params: any) {
  const dir = parseBuildDirectives(code);
  applyBuildDirectives(dir, params);
  return dir;
}

function c64Params(): any {
  return {
    cfgfile: "c64.cfg",
    libargs: ["openroms-compat.o", "c64.lib"],
  };
}

describe("build directive scanner (backwards compatibility)", function () {

  it("CFGFILE selects a linker config", function () {
    const p = putSource("#define CFGFILE c64-sid.cfg\nint main(void){return 0;}\n");
    const params = c64Params();
    fixParamsWithDefines(p, params);
    assert.strictEqual(params.cfgfile, "c64-sid.cfg");
  });

  it("does NOT read //#define (two slashes) -- commenting out disables it", function () {
    // The pattern is /^[;/]?#define/ -- a single optional ; or /. A C line
    // comment '//#define' has two slashes, so it is ignored. This is the only
    // form that reliably disables a directive in C source today.
    const p = putSource("//#define CFGFILE c64-sid.cfg\n");
    const params = c64Params();
    fixParamsWithDefines(p, params);
    assert.strictEqual(params.cfgfile, "c64.cfg");
  });

  it("reads the single-slash /#define form", function () {
    // Quirk of the pattern: '/#define' (one slash) is treated as a directive.
    const p = putSource("/#define CFGFILE c64-sid.cfg\n");
    const params = c64Params();
    fixParamsWithDefines(p, params);
    assert.strictEqual(params.cfgfile, "c64-sid.cfg");
  });

  it("reads the asm-comment ;#define form", function () {
    const p = putSource(";#define CFGFILE c64-sid.cfg\n", ".s");
    const params = c64Params();
    fixParamsWithDefines(p, params);
    assert.strictEqual(params.cfgfile, "c64-sid.cfg");
  });

  it("LIBARGS replaces the linker argument list", function () {
    const p = putSource("#define LIBARGS a.lib,b.lib\n");
    const params = c64Params();
    fixParamsWithDefines(p, params);
    assert.deepStrictEqual(params.libargs, ["a.lib", "b.lib"]);
  });

  it("CC65_FLAGS replaces the compiler argument list", function () {
    const p = putSource("#define CC65_FLAGS -O3,-T\n");
    const params: any = { libargs: ["crt0.o"] };
    fixParamsWithDefines(p, params);
    assert.deepStrictEqual(params.extra_compiler_args, ["-O3", "-T"]);
  });

  it("overrides a matching IDENT=VALUE entry in libargs", function () {
    const p = putSource("#define NES_PRG_BANKS 4\n");
    const params = nesParams();
    fixParamsWithDefines(p, params);
    assert.ok(params.libargs.includes("NES_PRG_BANKS=4"), "expected NES_PRG_BANKS=4");
    assert.ok(!params.libargs.includes("NES_PRG_BANKS=2"), "stale NES_PRG_BANKS=2 remained");
  });

  it("NES_MAPPER=4 switches to the banked config and updates the linker define", function () {
    const p = putSource("#define NES_MAPPER 4\t\t// Mapper 4 (MMC3)\n");
    const params = nesParams();
    fixParamsWithDefines(p, params);
    assert.strictEqual(params.cfgfile, "nesbanked.cfg");
    assert.ok(params.libargs.includes("NES_MAPPER=4"));
  });

  it("NES_MAPPER=2 keeps the default config", function () {
    const p = putSource("#define NES_MAPPER 2\t// mapper 2 (UxROM mapper)\n");
    const params = nesParams();
    fixParamsWithDefines(p, params);
    assert.strictEqual(params.cfgfile, "neslib2.cfg");
    assert.ok(params.libargs.includes("NES_MAPPER=2"));
  });

  it("honors commented-out directives -- presets/nes/skeleton.ca65 relies on it", function () {
    // ';#define LIBARGS ,' is a ca65 comment, but the scanner reads the ';'
    // form on purpose to clear libargs for the hand-written asm skeleton.
    const p = putSource(";#define LIBARGS ,\n", ".s");
    const params = nesParams();
    fixParamsWithDefines(p, params);
    assert.deepStrictEqual(params.libargs, []);
  });

  it("ignores defines that are not build configuration", function () {
    const p = putSource("#define FOO 1\n#define BAR baz\n");
    const params = nesParams();
    fixParamsWithDefines(p, params);
    assert.strictEqual(params.cfgfile, "neslib2.cfg");
    assert.deepStrictEqual(params.libargs, nesParams().libargs);
    assert.strictEqual(params.extra_compiler_args, undefined);
  });

  it("is a no-op without a source path", function () {
    const params = nesParams();
    const before = JSON.stringify(params);
    fixParamsWithDefines(null, params);
    fixParamsWithDefines("", params);
    fixParamsWithDefines("does_not_exist_xyz.c", params);
    assert.strictEqual(JSON.stringify(params), before);
  });

  it("is a no-op when the platform has no libargs (current coupling)", function () {
    // Known wart: the whole scanner body is gated on params.libargs, so
    // CFGFILE/CC65_FLAGS are silently ignored on libargs-less platforms.
    const p = putSource("#define CFGFILE foo.cfg\n");
    const params: any = { cfgfile: "orig.cfg" };
    fixParamsWithDefines(p, params);
    assert.strictEqual(params.cfgfile, "orig.cfg");
  });

});

describe("explicit build directives (//#symbol, //#flag, //#tooldef)", function () {

  it("#flag collects raw args per phase", function () {
    const params: any = {};
    applyDirectives("//#flag compiler -O3 -g\n//#flag ld -Wl,--large\n//#flag as -g\n", params);
    assert.deepStrictEqual(params.buildArgs.compiler, ["-O3", "-g"]);
    assert.deepStrictEqual(params.buildArgs.linker, ["-Wl,--large"]);
    assert.deepStrictEqual(params.buildArgs.assembler, ["-g"]);
  });

  it("#flag honors quoted arguments", function () {
    const params: any = {};
    applyDirectives('//#flag c "-DFOO=bar baz"\n', params);
    assert.deepStrictEqual(params.buildArgs.compiler, ["-DFOO=bar baz"]);
  });

  it("#symbol defaults to the compiler (preprocessor) phase", function () {
    const params: any = {};
    applyDirectives("//#symbol FOO=bar\n", params);
    assert.deepStrictEqual(params.symbols.compiler, ["FOO=bar"]);
    assert.deepStrictEqual(params.symbols.assembler, []);
    assert.deepStrictEqual(params.symbols.linker, []);
  });

  it("#symbol phases are independent", function () {
    const params: any = {};
    applyDirectives("//#symbol c COUNTER=1\n//#symbol as COUNTER=2\n", params);
    assert.deepStrictEqual(params.symbols.compiler, ["COUNTER=1"]);
    assert.deepStrictEqual(params.symbols.assembler, ["COUNTER=2"]);
  });

  it("#symbol merges by name (last definition wins, no duplicates)", function () {
    const params: any = {};
    applyDirectives("//#symbol c X=1\n//#symbol c Y=2\n//#symbol c X=9\n", params);
    assert.deepStrictEqual(params.symbols.compiler, ["Y=2", "X=9"]);
  });

  it("#symbol ld replaces the matching libargs entry and selects the config", function () {
    const params = nesParams();
    applyDirectives("//#symbol ld NES_MAPPER=4\n", params);
    assert.ok(params.libargs.includes("NES_MAPPER=4"));
    assert.ok(!params.libargs.includes("NES_MAPPER=0"));
    assert.strictEqual(params.cfgfile, "nesbanked.cfg");
    // merged into libargs, not queued again -> no redefinition on the link line
    assert.deepStrictEqual(params.symbols.linker, []);
  });

  it("#symbol ld replaces a matching -g entry in extra_link_args (sdldz80)", function () {
    const params: any = { extra_link_args: ['-l', 'gb', '-g', 'GB_MAPPER=0x0', '-g', 'GB_RAM_SIZE=0x0'] };
    applyDirectives("//#symbol ld GB_MAPPER=0x03\n//#symbol ld GB_RAM_SIZE=0x02\n", params);
    assert.deepStrictEqual(params.extra_link_args, ['-l', 'gb', '-g', 'GB_MAPPER=0x03', '-g', 'GB_RAM_SIZE=0x02']);
    // merged into extra_link_args, not queued again -> no duplicate -g on the link line
    assert.deepStrictEqual(params.symbols.linker, []);
  });

  it("#symbol ld queues a symbol that is not a platform libarg", function () {
    const params = nesParams();
    applyDirectives("//#symbol ld NEWSYM=0x10\n", params);
    assert.deepStrictEqual(params.symbols.linker, ["NEWSYM=0x10"]);
  });

  it("#symbol ld rejects a string value (would fail ld65 -D)", function () {
    const params = nesParams();
    const dir = applyDirectives('//#symbol ld BAD="str"\n', params);
    assert.strictEqual(dir.errors.length, 1);
    assert.deepStrictEqual(params.symbols.linker, []);
    assert.ok(params.libargs.includes("NES_MAPPER=0"));
  });

  it("#tooldef sets a typed linker knob", function () {
    const params = c64Params();
    applyDirectives("//#tooldef ld cfgfile=foo.cfg\n", params);
    assert.strictEqual(params.cfgfile, "foo.cfg");
  });

  it("#tooldef libargs replaces the linker argument list", function () {
    const params = c64Params();
    applyDirectives("//#tooldef ld libargs=a.lib,b.lib\n", params);
    assert.deepStrictEqual(params.libargs, ["a.lib", "b.lib"]);
  });

  it("#tooldef c sdcc picks the SDCC version", function () {
    const params: any = {};
    applyDirectives("//#tooldef c sdcc=3\n", params);
    assert.strictEqual(params.sdcc_version, 3);
    const dir = applyDirectives("//#tooldef c sdcc=5\n", params);
    assert.strictEqual(dir.errors.length, 1);
    assert.strictEqual(params.sdcc_version, 3);
  });

  it("#tooldef ld code_start and data_start take addresses", function () {
    const params: any = {};
    applyDirectives("//#tooldef ld code_start=0x4000\n//#tooldef ld data_start=36864\n", params);
    assert.strictEqual(params.code_start, 0x4000);
    assert.strictEqual(params.data_start, 0x9000);
    const dir = applyDirectives("//#tooldef ld code_start=nowhere\n//#tooldef ld data_start=0x10000\n", params);
    assert.strictEqual(dir.errors.length, 2);
    assert.strictEqual(params.code_start, 0x4000);
  });

  it("#tooldef rejects unknown knobs", function () {
    const params = c64Params();
    const dir = applyDirectives("//#tooldef ld nonsense=1\n", params);
    assert.strictEqual(dir.errors.length, 1);
  });

  it("ignores directives that are commented out at the marker", function () {
    const params: any = {};
    applyDirectives("////#flag c -O3\n;;#symbol X=1\n;//#flag ld -x\n", params);
    assert.deepStrictEqual(params.buildArgs.compiler, []);
    assert.deepStrictEqual(params.symbols.compiler, []);
    assert.deepStrictEqual(params.buildArgs.linker, []);
  });

  it("accepts both the // and ; comment markers", function () {
    const params: any = {};
    applyDirectives("//#flag c -O3\n;#flag ld -x\n", params);
    assert.deepStrictEqual(params.buildArgs.compiler, ["-O3"]);
    assert.deepStrictEqual(params.buildArgs.linker, ["-x"]);
  });

  it("fixParamsWithDefines applies explicit directives too", function () {
    const p = putSource("//#flag c -O3\n//#symbol c HELLO=world\n");
    const params = c64Params();
    fixParamsWithDefines(p, params);
    assert.deepStrictEqual(params.buildArgs.compiler, ["-O3"]);
    assert.deepStrictEqual(params.symbols.compiler, ["HELLO=world"]);
  });

  it("fixParamsWithDefines throws on a malformed directive", function () {
    const p = putSource('//#symbol ld BAD="str"\n');
    const params = nesParams();
    assert.throws(() => fixParamsWithDefines(p, params), /build directive error/);
  });

  it("applies each source file's directives only once", function () {
    const p = putSource("//#flag c -O3\n");
    const params = c64Params();
    fixParamsWithDefines(p, params);
    fixParamsWithDefines(p, params);
    assert.deepStrictEqual(params.buildArgs.compiler, ["-O3"]);
  });

});

describe("platform tool config resolution", function () {

  it("resolves per-platform, root-base, and default configs", function () {
    assert.strictEqual(getPlatformToolConfig('cc65', 'nes').wasiFSZip, 'cc65-fs-nes.zip');
    assert.strictEqual(getPlatformToolConfig('cc65', 'atari8-800').wasiFSZip, 'cc65-fs-atari8.zip');
    assert.strictEqual(getPlatformToolConfig('sdcc').wasiFSZip, 'sdcc-fs.zip');
    assert.strictEqual(getPlatformToolConfig('sdcc', 'sms-sms-libcv').preloadFS, 'sdcc'); // root base 'sms'
    assert.strictEqual(getPlatformToolConfig('dasm', 'nes'), undefined);
  });

  it("routes oscar64 to the target machine for each platform", function () {
    // oscar64 defaults to the C64; atari8 needs -tm=atari (and emits a XEX)
    assert.deepStrictEqual(extraArgsFor('oscar64', getPlatformToolConfig('oscar64', 'atari8-800').buildArgs), ['-tm=atari']);
    assert.deepStrictEqual(extraArgsFor('oscar64', getPlatformToolConfig('oscar64', 'atari8').buildArgs), ['-tm=atari']);
    assert.deepStrictEqual(extraArgsFor('oscar64', getPlatformToolConfig('oscar64', 'nes').buildArgs), ['-tm=nes']);
    assert.deepStrictEqual(extraArgsFor('oscar64', getPlatformToolConfig('oscar64', 'c64').buildArgs), []);
    assert.deepStrictEqual(defineArgs('oscar64', ['FOO=1']), ['-dFOO=1']);
  });

});

describe("tool define/symbol formatting", function () {

  it("formats preprocessor defines per tool", function () {
    assert.deepStrictEqual(defineArgs("cc65", ["FOO=1"]), ["-DFOO=1"]);
    assert.deepStrictEqual(defineArgs("sdcc", ["FOO=1"]), ["-DFOO=1"]);
    assert.deepStrictEqual(defineArgs("ca65", ["FOO=1"]), ["-D", "FOO=1"]);
    assert.deepStrictEqual(defineArgs("sdasz80", ["FOO=1"]), []);
    assert.deepStrictEqual(defineArgs("cc65", []), []);
  });

  it("formats link symbols per tool", function () {
    assert.deepStrictEqual(linkSymbolArgs("ld65", ["A=1"]), ["-D", "A=1"]);
    assert.deepStrictEqual(linkSymbolArgs("sdldz80", ["A=1"]), ["-g", "A=1"]);
    assert.deepStrictEqual(linkSymbolArgs("cc65", ["A=1"]), []);
  });

  it("selects raw args by tool kind", function () {
    const args = { compiler: ["-O3"], assembler: ["-as"], linker: ["-x"] };
    assert.deepStrictEqual(extraArgsFor("cc65", args), ["-O3"]);
    assert.deepStrictEqual(extraArgsFor("ca65", args), ["-as"]);
    assert.deepStrictEqual(extraArgsFor("ld65", args), ["-x"]);
    assert.deepStrictEqual(extraArgsFor("sdldz80", args), ["-x"]);
  });

});

describe("applyAsmProjectParams (backwards compatibility)", function () {

  it("copies asm_* keys over their base keys", function () {
    const params: any = {
      cfgfile: "neslib2.cfg",
      libargs: ["crt0.o"],
      asm_cfgfile: "nes-asm.cfg",
      asm_libargs: ["none.o"],
      asm_extra_link_files: ["nes-asm.cfg"],
    };
    applyAsmProjectParams(params);
    assert.strictEqual(params.cfgfile, "nes-asm.cfg");
    assert.deepStrictEqual(params.libargs, ["none.o"]);
    assert.deepStrictEqual(params.extra_link_files, ["nes-asm.cfg"]);
  });

  it("leaves non-asm keys untouched", function () {
    const params: any = { cfgfile: "base.cfg", extra_compiler_args: ["-O3"] };
    applyAsmProjectParams(params);
    assert.strictEqual(params.cfgfile, "base.cfg");
    assert.deepStrictEqual(params.extra_compiler_args, ["-O3"]);
  });

  it("source CFGFILE still overrides asm_ project params", function () {
    // applyAsmProjectParams() runs first, then the source scan -- so a source
    // directive has the last word over the asm_* copies.
    const p = putSource("#define CFGFILE custom.cfg\n");
    const params: any = {
      cfgfile: "base.cfg",
      libargs: ["base.o"],
      asm_cfgfile: "asm.cfg",
      asm_libargs: ["asm.o"],
    };
    applyAsmProjectParams(params);
    fixParamsWithDefines(p, params);
    assert.strictEqual(params.cfgfile, "custom.cfg");
  });

});

describe("build directive wiring (integration)", function () {
  this.timeout(120000);
  let tmpdir: string;
  before(function () { tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), "buildparams-")); });
  after(function () { fs.rmSync(tmpdir, { recursive: true, force: true }); });

  function writeSource(name: string, code: string): string {
    const p = path.join(tmpdir, name);
    fs.writeFileSync(p, code);
    return p;
  }

  const guard = "#ifndef MYFLAG\n#error MYFLAG missing\n#endif\nint main(void){return 0;}\n";

  it("control: undefined MYFLAG fails to compile", async function () {
    await preload('cc65', 'c64');
    const result: any = await compileSourceFile('cc65', 'c64', writeSource('ctrl.c', guard));
    assert.ok((result.errors || []).length > 0, "expected #error from missing MYFLAG");
  });

  it("//#symbol c reaches the preprocessor", async function () {
    await preload('cc65', 'c64');
    const code = "//#symbol c MYFLAG=1\n" + guard;
    const result: any = await compileSourceFile('cc65', 'c64', writeSource('sym.c', code));
    assert.deepStrictEqual(result.errors || [], []);
  });

  it("//#flag c reaches the compiler", async function () {
    await preload('cc65', 'c64');
    const code = "//#flag c -DMYFLAG=1\n" + guard;
    const result: any = await compileSourceFile('cc65', 'c64', writeSource('flag.c', code));
    assert.deepStrictEqual(result.errors || [], []);
  });

  it("step symbol overrides reach the compiler (CLI/project path)", async function () {
    await preload('cc65', 'c64');
    const result: any = await compileSourceFile('cc65', 'c64', writeSource('ovr1.c', guard), undefined,
      { symbols: { compiler: ['MYFLAG=1'] } });
    assert.deepStrictEqual(result.errors || [], []);
  });

  it("step raw-arg overrides reach the compiler", async function () {
    await preload('cc65', 'c64');
    const result: any = await compileSourceFile('cc65', 'c64', writeSource('ovr2.c', guard), undefined,
      { buildArgs: { compiler: ['-DMYFLAG=1'] } });
    assert.deepStrictEqual(result.errors || [], []);
  });

  it("rejects a text link symbol from step overrides", async function () {
    await preload('cc65', 'c64');
    const result: any = await compileSourceFile('cc65', 'c64', writeSource('ovr3.c', guard), undefined,
      { symbols: { linker: ['BAD=xyz'] } });
    assert.ok((result.errors || []).length > 0, "expected a link symbol error");
  });

  it("platform ToolMeta buildArgs reach the tool", async function () {
    await preload('cc65', 'c64');
    const meta = TOOL_META['cc65'];
    const saved = meta.platforms['c64'];
    try {
      meta.platforms['c64'] = { ...saved, buildArgs: { compiler: ['-DMYFLAG=1'] } };
      const result: any = await compileSourceFile('cc65', 'c64', writeSource('plat.c', guard));
      assert.deepStrictEqual(result.errors || [], []);
    } finally {
      meta.platforms['c64'] = saved;
    }
  });

});