ObjectFile: update the API to use file paths, add tests

Author: ForNeVeR

Cesium.CodeGen.Tests/CodeGenPInvokeTests.cs

@@ -3,6 +3,7 @@
 // SPDX-License-Identifier: MIT
 
 using Cesium.TestFramework;
+using TruePath;
 
 namespace Cesium.CodeGen.Tests;
 
@@ -12,7 +13,7 @@ public class CodeGenPInvokeTests : CodeGenTestBase
 
     private static async Task DoTest(string source)
     {
-        var processed = await PreprocessorUtil.DoPreprocess(_mainMockedFilePath, source);
+        var processed = await PreprocessorUtil.DoPreprocess(new AbsolutePath(_mainMockedFilePath), source);
         var assembly = GenerateAssembly(default, processed);
 
         var moduleType = assembly.Modules.Single().GetType("<Module>");

Cesium.CodeGen.Tests/CodeGenTestBase.cs

@@ -12,6 +12,7 @@
 using JetBrains.Annotations;
 using Mono.Cecil;
 using Mono.Cecil.Cil;
+using TruePath;
 using Yoakke.Streams;
 using Yoakke.SynKit.C.Syntax;
 
@@ -49,7 +50,12 @@ protected static (AssemblyDefinition, byte[]) GenerateAssembly(
         string globalTypeFqn = "",
         string[]? referencePaths = null)
     {
-        var context = CreateAssembly(runtime, arch, @namespace: @namespace, globalTypeFqn: globalTypeFqn, referencePaths);
+        var context = CreateAssembly(
+            runtime,
+            arch,
+            @namespace: @namespace,
+            globalTypeFqn: globalTypeFqn,
+            referencePaths?.Select(x => new LocalPath(x)).ToArray());
         GenerateCode(context, sources);
         return EmitAssembly(context);
     }
@@ -82,22 +88,22 @@ private static AssemblyContext CreateAssembly(
         TargetArchitectureSet targetArchitectureSet = TargetArchitectureSet.Dynamic,
         string @namespace = "",
         string globalTypeFqn = "",
-        string[]? referencePaths = null)
+        LocalPath[]? referencePaths = null)
     {
-        var allReferences = (referencePaths ?? Array.Empty<string>()).ToList();
-        allReferences.Insert(0, typeof(Console).Assembly.Location);
+        var allReferences = (referencePaths ?? []).ToList();
+        allReferences.Insert(0, new LocalPath(typeof(Console).Assembly.Location));
 
         CompilationOptions compilationOptions = new(
             targetRuntime ?? CSharpCompilationUtil.DefaultRuntime,
             targetArchitectureSet,
             ModuleKind.Console,
-            typeof(Math).Assembly.Location,
-            typeof(RuntimeHelpers).Assembly.Location,
+            new LocalPath(typeof(Math).Assembly.Location),
+            new LocalPath(typeof(RuntimeHelpers).Assembly.Location),
             allReferences,
             @namespace,
             globalTypeFqn,
-            Array.Empty<string>(),
-            Array.Empty<string>(),
+            [],
+            [],
             ProducePreprocessedFile: false,
             ProduceAstFile: false);
         return AssemblyContext.Create(

Cesium.CodeGen/Cesium.CodeGen.csproj

@@ -16,6 +16,7 @@ SPDX-License-Identifier: MIT
       <PackageReference Include="Mono.Cecil" />
       <PackageReference Include="QuikGraph" />
       <PackageReference Include="QuikGraph.Graphviz" />
+      <PackageReference Include="TruePath" />
     </ItemGroup>
 
     <ItemGroup>

Cesium.CodeGen/CompilationOptions.cs

@@ -3,19 +3,20 @@
 // SPDX-License-Identifier: MIT
 
 using Mono.Cecil;
+using TruePath;
 
 namespace Cesium.CodeGen;
 
 public record CompilationOptions(
     TargetRuntimeDescriptor TargetRuntime,
     TargetArchitectureSet TargetArchitectureSet,
     ModuleKind ModuleKind,
-    string CorelibAssembly,
-    string CesiumRuntime,
-    IList<string> ImportAssemblies,
+    LocalPath CorelibAssembly,
+    LocalPath CesiumRuntime,
+    IList<LocalPath> ImportAssemblies,
     string Namespace,
     string GlobalClassFqn,
     IList<string> DefineConstants,
-    IList<string> AdditionalIncludeDirectories,
+    IList<LocalPath> AdditionalIncludeDirectories,
     bool ProducePreprocessedFile,
     bool ProduceAstFile);

Cesium.CodeGen/Contexts/AssemblyContext.cs

@@ -121,9 +121,12 @@ private AssemblyContext(
         Module = module;
         CompilationOptions = compilationOptions;
 
-        MscorlibAssembly = AssemblyDefinition.ReadAssembly(compilationOptions.CorelibAssembly);
-        CesiumRuntimeAssembly = AssemblyDefinition.ReadAssembly(compilationOptions.CesiumRuntime);
-        ImportAssemblies = compilationOptions.ImportAssemblies.Select(AssemblyDefinition.ReadAssembly).Union(new[] { MscorlibAssembly, CesiumRuntimeAssembly }).Distinct().ToArray();
+        MscorlibAssembly = AssemblyDefinition.ReadAssembly(compilationOptions.CorelibAssembly.Value);
+        CesiumRuntimeAssembly = AssemblyDefinition.ReadAssembly(compilationOptions.CesiumRuntime.Value);
+        ImportAssemblies = compilationOptions.ImportAssemblies
+            .Select(x => AssemblyDefinition.ReadAssembly(x.Value))
+            .Union([MscorlibAssembly, CesiumRuntimeAssembly])
+            .Distinct().ToArray();
         _constantPool = new(
             () =>
             {

Cesium.Compiler.Tests/JsonObjectFileTests.cs

@@ -0,0 +1,21 @@
+using TruePath;
+
+namespace Cesium.Compiler.Tests;
+
+public class JsonObjectFileTests
+{
+    [Theory]
+    [InlineData("file.json", false)]
+    [InlineData("file.obj", true)]
+    public void CorrectExtensions(string fileName, bool result) =>
+        Assert.Equal(result, JsonObjectFile.IsCorrectExtension(new LocalPath(fileName)));
+
+    [Fact]
+    public void ObjectFileGetsDumpedCorrectly() => Assert.Fail();
+
+    [Fact]
+    public void ObjectFileGetsReadCorrectly() => Assert.Fail();
+
+    [Fact]
+    public void CompilationSucceedsForObjectFile() => Assert.Fail("Migrate me to the integration tests");
+}

Cesium.Compiler/Arguments.cs

@@ -23,8 +23,8 @@ public class Arguments
     [Value(0)]
     public IList<string> InputFilePaths { get; init; } = null!;
 
-    [Option('c', HelpText = "Compile only into Cessium Object Format (r) (RFC-8259)")]
-    public bool CompileOnly { get; init; } = false;
+    [Option('c', HelpText = "Produce a JSON-based object file imitation.")]
+    public bool ProduceObjectFileImitation { get; init; } = false;
 
     [Option('o', "out")]
     public string OutputFilePath { get; init; } = null!;

Cesium.Compiler/Cesium.Compiler.csproj

@@ -18,6 +18,7 @@ SPDX-License-Identifier: MIT
 
     <ItemGroup>
         <PackageReference Include="CommandLineParser" />
+        <PackageReference Include="TruePath" />
         <PackageReference Include="Yoakke.SynKit.C.Syntax" />
     </ItemGroup>