@soundscript/soundscript 0.1.13 → 0.1.15

package/project-transform/src/compiler_generator_runner.js

@@ -0,0 +1,153 @@
+import { assertEquals } from '@std/assert';
+import { compileTempProject, createCompilerTestProject } from './compiler_object_test_helpers.js';
+import { instantiateCompiledModuleInJs, resolveQualifiedExportName, } from './compiler_test_helpers.js';
+async function runGeneratorCompilerCase(testCase) {
+    const tempDirectory = await createCompilerTestProject(testCase.source);
+    const result = compileTempProject(tempDirectory);
+    assertEquals(result.exitCode, 0, testCase.name);
+    assertEquals(result.diagnostics, [], testCase.name);
+    const instance = await instantiateCompiledModuleInJs(tempDirectory);
+    const exportName = await resolveQualifiedExportName(tempDirectory, 'main');
+    const exported = instance.exports[exportName];
+    if (typeof exported !== 'function') {
+        throw new Error(`Expected exported function "${exportName}" for ${testCase.name}.`);
+    }
+    assertEquals(exported(), testCase.expected, testCase.name);
+}
+async function main() {
+    if (Deno.env.get('SOUNDSCRIPT_GENERATOR_LIST_CASES') === '1') {
+        console.log(JSON.stringify(cases.map((testCase) => testCase.name)));
+        return;
+    }
+    const caseFilter = Deno.env.get('SOUNDSCRIPT_GENERATOR_CASE');
+    const caseFiltersValue = Deno.env.get('SOUNDSCRIPT_GENERATOR_CASES');
+    const caseFilters = caseFiltersValue ? new Set(JSON.parse(caseFiltersValue)) : undefined;
+    const selectedCases = cases.filter((testCase) => caseFilter ? testCase.name === caseFilter : caseFilters ? caseFilters.has(testCase.name) : true);
+    for (const testCase of selectedCases) {
+        await runGeneratorCompilerCase(testCase);
+    }
+}
+const cases = [
+    {
+        name: 'compileProject lowers sync generator next calls with resume values',
+        expected: 101237,
+        source: [
+            'function* iterate(): Generator<number, number, number> {',
+            '  const received = yield 10;',
+            '  yield received + 5;',
+            '  return received + 20;',
+            '}',
+            '',
+            'export function main(): number {',
+            '  const iterator = iterate();',
+            '  const first = iterator.next();',
+            '  const second = iterator.next(7);',
+            '  const third = iterator.next();',
+            '  const firstValue = first.done ? 0 : first.value;',
+            '  const secondValue = second.done ? 0 : second.value;',
+            '  const thirdValue = third.done ? third.value : 0;',
+            '  return (first.done ? 1000000 : 0) + (firstValue * 10000) + (second.done ? 1000 : 0)'
+                + ' + (secondValue * 100) + (third.done ? 10 : 0) + thirdValue;',
+            '}',
+            '',
+        ].join('\n'),
+    },
+    {
+        name: 'compileProject lowers sync generator return calls',
+        expected: 42011,
+        source: [
+            'function* iterate(): Generator<number, number, unknown> {',
+            '  yield 4;',
+            '  return 9;',
+            '}',
+            '',
+            'export function main(): number {',
+            '  const iterator = iterate();',
+            '  const first = iterator.next();',
+            '  const second = iterator.return(20);',
+            '  const third = iterator.next();',
+            '  const firstValue = first.done ? 0 : first.value;',
+            '  const secondValue = second.done ? second.value : 0;',
+            '  return (firstValue * 10000)'
+                + ' + (first.done ? 1000 : 0)'
+                + ' + (secondValue * 100)'
+                + ' + (second.done ? 10 : 0)'
+                + ' + (third.done ? 1 : 0);',
+            '}',
+            '',
+        ].join('\n'),
+    },
+    {
+        name: 'compileProject lowers for-of over sync generator results',
+        expected: 357,
+        source: [
+            'function* iterate(): Generator<number, void, unknown> {',
+            '  yield 3;',
+            '  yield 5;',
+            '  yield 7;',
+            '}',
+            '',
+            'export function main(): number {',
+            '  let total = 0;',
+            '  for (const value of iterate()) {',
+            '    total = (total * 10) + value;',
+            '  }',
+            '  return total;',
+            '}',
+            '',
+        ].join('\n'),
+    },
+    {
+        name: 'compileProject lowers sync generator while bodies',
+        expected: 10239,
+        source: [
+            'function* iterate(): Generator<number, number, unknown> {',
+            '  let index = 0;',
+            '  while (index < 3) {',
+            '    index = index + 1;',
+            '    yield index;',
+            '  }',
+            '  return 9;',
+            '}',
+            '',
+            'export function main(): number {',
+            '  const iterator = iterate();',
+            '  const first = iterator.next();',
+            '  const second = iterator.next();',
+            '  const third = iterator.next();',
+            '  const fourth = iterator.next();',
+            '  return (first.done ? 100000 : 0) + ((first.done ? 0 : first.value) * 10000)'
+                + ' + (second.done ? 1000 : 0) + ((second.done ? 0 : second.value) * 100)'
+                + ' + ((third.done ? 0 : third.value) * 10) + (fourth.done ? fourth.value : 0);',
+            '}',
+            '',
+        ].join('\n'),
+    },
+    {
+        name: 'compileProject lowers sync generator for bodies',
+        expected: 4568,
+        source: [
+            'function* iterate(): Generator<number, number, unknown> {',
+            '  let index = 0;',
+            '  for (; index < 3; index = index + 1) {',
+            '    yield index + 4;',
+            '  }',
+            '  return 8;',
+            '}',
+            '',
+            'export function main(): number {',
+            '  const iterator = iterate();',
+            '  const first = iterator.next();',
+            '  const second = iterator.next();',
+            '  const third = iterator.next();',
+            '  const fourth = iterator.next();',
+            '  return ((first.done ? 0 : first.value) * 1000)'
+                + ' + ((second.done ? 0 : second.value) * 100)'
+                + ' + ((third.done ? 0 : third.value) * 10)'
+                + ' + (fourth.done ? fourth.value : 0);',
+            '}',
+            '',
+        ].join('\n'),
+    },
+];
+await main();

package/project-transform/src/compiler_generator_runner.ts

@@ -0,0 +1,171 @@
+import { assertEquals } from '@std/assert';
+
+import { compileTempProject, createCompilerTestProject } from './compiler_object_test_helpers.ts';
+import {
+  instantiateCompiledModuleInJs,
+  resolveQualifiedExportName,
+} from './compiler_test_helpers.ts';
+
+type GeneratorCompilerCase = {
+  name: string;
+  source: string;
+  expected: number;
+};
+
+async function runGeneratorCompilerCase(testCase: GeneratorCompilerCase): Promise<void> {
+  const tempDirectory = await createCompilerTestProject(testCase.source);
+  const result = compileTempProject(tempDirectory);
+
+  assertEquals(result.exitCode, 0, testCase.name);
+  assertEquals(result.diagnostics, [], testCase.name);
+  const instance = await instantiateCompiledModuleInJs(tempDirectory);
+  const exportName = await resolveQualifiedExportName(tempDirectory, 'main');
+  const exported = instance.exports[exportName];
+  if (typeof exported !== 'function') {
+    throw new Error(`Expected exported function "${exportName}" for ${testCase.name}.`);
+  }
+  assertEquals(exported(), testCase.expected, testCase.name);
+}
+
+async function main(): Promise<void> {
+  if (Deno.env.get('SOUNDSCRIPT_GENERATOR_LIST_CASES') === '1') {
+    console.log(JSON.stringify(cases.map((testCase) => testCase.name)));
+    return;
+  }
+
+  const caseFilter = Deno.env.get('SOUNDSCRIPT_GENERATOR_CASE');
+  const caseFiltersValue = Deno.env.get('SOUNDSCRIPT_GENERATOR_CASES');
+  const caseFilters = caseFiltersValue ? new Set(JSON.parse(caseFiltersValue) as string[]) : undefined;
+  const selectedCases = cases.filter((testCase) =>
+    caseFilter ? testCase.name === caseFilter : caseFilters ? caseFilters.has(testCase.name) : true
+  );
+  for (const testCase of selectedCases) {
+    await runGeneratorCompilerCase(testCase);
+  }
+}
+
+const cases: GeneratorCompilerCase[] = [
+  {
+    name: 'compileProject lowers sync generator next calls with resume values',
+    expected: 101237,
+    source: [
+      'function* iterate(): Generator<number, number, number> {',
+      '  const received = yield 10;',
+      '  yield received + 5;',
+      '  return received + 20;',
+      '}',
+      '',
+      'export function main(): number {',
+      '  const iterator = iterate();',
+      '  const first = iterator.next();',
+      '  const second = iterator.next(7);',
+      '  const third = iterator.next();',
+      '  const firstValue = first.done ? 0 : first.value;',
+      '  const secondValue = second.done ? 0 : second.value;',
+      '  const thirdValue = third.done ? third.value : 0;',
+      '  return (first.done ? 1000000 : 0) + (firstValue * 10000) + (second.done ? 1000 : 0)'
+        + ' + (secondValue * 100) + (third.done ? 10 : 0) + thirdValue;',
+      '}',
+      '',
+    ].join('\n'),
+  },
+  {
+    name: 'compileProject lowers sync generator return calls',
+    expected: 42011,
+    source: [
+      'function* iterate(): Generator<number, number, unknown> {',
+      '  yield 4;',
+      '  return 9;',
+      '}',
+      '',
+      'export function main(): number {',
+      '  const iterator = iterate();',
+      '  const first = iterator.next();',
+      '  const second = iterator.return(20);',
+      '  const third = iterator.next();',
+      '  const firstValue = first.done ? 0 : first.value;',
+      '  const secondValue = second.done ? second.value : 0;',
+      '  return (firstValue * 10000)'
+        + ' + (first.done ? 1000 : 0)'
+        + ' + (secondValue * 100)'
+        + ' + (second.done ? 10 : 0)'
+        + ' + (third.done ? 1 : 0);',
+      '}',
+      '',
+    ].join('\n'),
+  },
+  {
+    name: 'compileProject lowers for-of over sync generator results',
+    expected: 357,
+    source: [
+      'function* iterate(): Generator<number, void, unknown> {',
+      '  yield 3;',
+      '  yield 5;',
+      '  yield 7;',
+      '}',
+      '',
+      'export function main(): number {',
+      '  let total = 0;',
+      '  for (const value of iterate()) {',
+      '    total = (total * 10) + value;',
+      '  }',
+      '  return total;',
+      '}',
+      '',
+    ].join('\n'),
+  },
+  {
+    name: 'compileProject lowers sync generator while bodies',
+    expected: 10239,
+    source: [
+      'function* iterate(): Generator<number, number, unknown> {',
+      '  let index = 0;',
+      '  while (index < 3) {',
+      '    index = index + 1;',
+      '    yield index;',
+      '  }',
+      '  return 9;',
+      '}',
+      '',
+      'export function main(): number {',
+      '  const iterator = iterate();',
+      '  const first = iterator.next();',
+      '  const second = iterator.next();',
+      '  const third = iterator.next();',
+      '  const fourth = iterator.next();',
+      '  return (first.done ? 100000 : 0) + ((first.done ? 0 : first.value) * 10000)'
+        + ' + (second.done ? 1000 : 0) + ((second.done ? 0 : second.value) * 100)'
+        + ' + ((third.done ? 0 : third.value) * 10) + (fourth.done ? fourth.value : 0);',
+      '}',
+      '',
+    ].join('\n'),
+  },
+  {
+    name: 'compileProject lowers sync generator for bodies',
+    expected: 4568,
+    source: [
+      'function* iterate(): Generator<number, number, unknown> {',
+      '  let index = 0;',
+      '  for (; index < 3; index = index + 1) {',
+      '    yield index + 4;',
+      '  }',
+      '  return 8;',
+      '}',
+      '',
+      'export function main(): number {',
+      '  const iterator = iterate();',
+      '  const first = iterator.next();',
+      '  const second = iterator.next();',
+      '  const third = iterator.next();',
+      '  const fourth = iterator.next();',
+      '  return ((first.done ? 0 : first.value) * 1000)'
+        + ' + ((second.done ? 0 : second.value) * 100)'
+        + ' + ((third.done ? 0 : third.value) * 10)'
+        + ' + (fourth.done ? fourth.value : 0);',
+      '}',
+      '',
+    ].join('\n'),
+  },
+];
+
+await main();

package/project-transform/src/compiler_object_test_helpers.js

@@ -0,0 +1,69 @@
+import { assertEquals, assertMatch, assertStringIncludes } from '@std/assert';
+import { compileProject } from './compiler/compile_project.js';
+import { createTempProject } from './compiler_test_helpers.js';
+export function assertWatDeclaresFallbackObjectType(watOutput) {
+    assertStringIncludes(watOutput, '(type $object_fallback');
+}
+export function assertWatCallsFallbackObjectGeneralize(watOutput) {
+    assertStringIncludes(watOutput, 'call $generalize_object_to_fallback');
+}
+export function assertWatCallsFallbackObjectGet(watOutput) {
+    assertStringIncludes(watOutput, 'call $get_fallback_object_property');
+}
+export function assertWatCallsFallbackObjectSet(watOutput) {
+    assertStringIncludes(watOutput, 'call $set_fallback_object_property');
+}
+export function assertWatCallsSpecializedObjectKeysListing(watOutput, propertyKeys) {
+    assertStringIncludes(watOutput, 'call $list_specialized_object_keys__');
+    assertStringIncludes(watOutput, `Object.keys own-property order: ${propertyKeys.join(', ')}`);
+}
+export function assertWatUsesDistinctSpecializedObjectKeysHelperSymbols(watOutput) {
+    const helperNames = [...watOutput.matchAll(/\$([A-Za-z0-9_]*list_specialized_object_keys__[A-Za-z0-9_]+)/g)]
+        .map((match) => match[1]);
+    assertEquals(new Set(helperNames).size, 2);
+}
+export function assertWatCallsFallbackOrderedObjectKeysListing(watOutput) {
+    assertStringIncludes(watOutput, 'call $list_fallback_object_keys_in_js_own_property_order');
+    assertStringIncludes(watOutput, 'Object.keys own-property order contract: integer-index-like keys ascend numerically, then string keys keep insertion order.');
+}
+export function assertWatCallsFallbackObjectHas(watOutput) {
+    assertStringIncludes(watOutput, 'call $has_fallback_object_property');
+}
+export function assertWatAvoidsFallbackObjectMembership(watOutput) {
+    assertEquals(watOutput.includes('call $generalize_object_to_fallback'), false);
+    assertEquals(watOutput.includes('call $has_fallback_object_property'), false);
+}
+export function assertWatContainsWeightedHundredsTensOnesResult(watOutput) {
+    assertMatch(watOutput, /f64\.const 100[\s\S]*f64\.mul[\s\S]*f64\.const 10[\s\S]*f64\.mul[\s\S]*f64\.add[\s\S]*f64\.add/s);
+}
+export function assertWatStaysOnSpecializedObjectLowering(watOutput) {
+    assertStringIncludes(watOutput, 'struct.new $object_shape_left_required_f64_right_required_f64');
+    assertStringIncludes(watOutput, 'struct.get $object_shape_left_required_f64_right_required_f64 1');
+    assertStringIncludes(watOutput, 'struct.get $object_shape_left_required_f64_right_required_f64 0');
+}
+export async function createCompilerTestProject(indexSource) {
+    return await createTempProject([
+        {
+            path: 'tsconfig.json',
+            contents: JSON.stringify({
+                compilerOptions: {
+                    strict: true,
+                    noEmit: true,
+                    target: 'ES2022',
+                    module: 'ESNext',
+                },
+                include: ['src/**/*.ts'],
+            }, null, 2),
+        },
+        {
+            path: 'src/index.ts',
+            contents: indexSource,
+        },
+    ]);
+}
+export function compileTempProject(tempDirectory) {
+    return compileProject({
+        projectPath: `${tempDirectory}/tsconfig.json`,
+        workingDirectory: tempDirectory,
+    });
+}

package/project-transform/src/compiler_object_test_helpers.ts

@@ -0,0 +1,96 @@
+import { assertEquals, assertMatch, assertStringIncludes } from '@std/assert';
+
+import { compileProject } from './compiler/compile_project.ts';
+import { createTempProject } from './compiler_test_helpers.ts';
+
+export function assertWatDeclaresFallbackObjectType(watOutput: string): void {
+  assertStringIncludes(watOutput, '(type $object_fallback');
+}
+
+export function assertWatCallsFallbackObjectGeneralize(watOutput: string): void {
+  assertStringIncludes(watOutput, 'call $generalize_object_to_fallback');
+}
+
+export function assertWatCallsFallbackObjectGet(watOutput: string): void {
+  assertStringIncludes(watOutput, 'call $get_fallback_object_property');
+}
+
+export function assertWatCallsFallbackObjectSet(watOutput: string): void {
+  assertStringIncludes(watOutput, 'call $set_fallback_object_property');
+}
+
+export function assertWatCallsSpecializedObjectKeysListing(
+  watOutput: string,
+  propertyKeys: readonly string[],
+): void {
+  assertStringIncludes(watOutput, 'call $list_specialized_object_keys__');
+  assertStringIncludes(watOutput, `Object.keys own-property order: ${propertyKeys.join(', ')}`);
+}
+
+export function assertWatUsesDistinctSpecializedObjectKeysHelperSymbols(watOutput: string): void {
+  const helperNames = [...watOutput.matchAll(/\$([A-Za-z0-9_]*list_specialized_object_keys__[A-Za-z0-9_]+)/g)]
+    .map((match) => match[1]);
+  assertEquals(new Set(helperNames).size, 2);
+}
+
+export function assertWatCallsFallbackOrderedObjectKeysListing(watOutput: string): void {
+  assertStringIncludes(watOutput, 'call $list_fallback_object_keys_in_js_own_property_order');
+  assertStringIncludes(
+    watOutput,
+    'Object.keys own-property order contract: integer-index-like keys ascend numerically, then string keys keep insertion order.',
+  );
+}
+
+export function assertWatCallsFallbackObjectHas(watOutput: string): void {
+  assertStringIncludes(watOutput, 'call $has_fallback_object_property');
+}
+
+export function assertWatAvoidsFallbackObjectMembership(watOutput: string): void {
+  assertEquals(watOutput.includes('call $generalize_object_to_fallback'), false);
+  assertEquals(watOutput.includes('call $has_fallback_object_property'), false);
+}
+
+export function assertWatContainsWeightedHundredsTensOnesResult(watOutput: string): void {
+  assertMatch(
+    watOutput,
+    /f64\.const 100[\s\S]*f64\.mul[\s\S]*f64\.const 10[\s\S]*f64\.mul[\s\S]*f64\.add[\s\S]*f64\.add/s,
+  );
+}
+
+export function assertWatStaysOnSpecializedObjectLowering(watOutput: string): void {
+  assertStringIncludes(watOutput, 'struct.new $object_shape_left_required_f64_right_required_f64');
+  assertStringIncludes(watOutput, 'struct.get $object_shape_left_required_f64_right_required_f64 1');
+  assertStringIncludes(watOutput, 'struct.get $object_shape_left_required_f64_right_required_f64 0');
+}
+
+export async function createCompilerTestProject(indexSource: string): Promise<string> {
+  return await createTempProject([
+    {
+      path: 'tsconfig.json',
+      contents: JSON.stringify(
+        {
+          compilerOptions: {
+            strict: true,
+            noEmit: true,
+            target: 'ES2022',
+            module: 'ESNext',
+          },
+          include: ['src/**/*.ts'],
+        },
+        null,
+        2,
+      ),
+    },
+    {
+      path: 'src/index.ts',
+      contents: indexSource,
+    },
+  ]);
+}
+
+export function compileTempProject(tempDirectory: string) {
+  return compileProject({
+    projectPath: `${tempDirectory}/tsconfig.json`,
+    workingDirectory: tempDirectory,
+  });
+}