Changed Assembler interfacing to use AssemblyResult

Author: Avid29

src/Apps/Mipser.ViewModels/Services/Build/BuildService.cs

@@ -90,23 +90,23 @@ public async Task AssembleFilesAsync(BindableFile[] files)
             }
 
             // Assemble the file
-            var assembler = await AssembleFileAsync(file, null, saveFile);
+            var result = await AssembleFileAsync(file, null, saveFile);
 
             // Restore the original language
             CultureInfo.CurrentUICulture = restore;
 
             // Check the assembler result
-            if (assembler is null)
+            if (result is null)
                 continue; // TODO: Handle file loading errors
 
             // Update the status and log
-            var assemblerFailed = assembler?.Failed ?? false;
-            failed = failed || (assembler?.Failed ?? false);
+            var assemblerFailed = result?.Failed ?? false;
+            failed = failed || (result?.Failed ?? false);
             Status = failed ? BuildStatus.Failing : BuildStatus.Assembling;
-            if (assembler?.Logs is not null)
-                logs.AddRange(assembler.Logs);
+            if (result?.Logs is not null)
+                logs.AddRange(result.Logs);
 
-            _messenger.Send(new FileAssembledMessage(file.Path, saveFile?.Path, assemblerFailed, assembler?.Logs));
+            _messenger.Send(new FileAssembledMessage(file.Path, saveFile?.Path, assemblerFailed, result?.Logs));
         }
 
         // Send a message with the build results.
@@ -117,7 +117,7 @@ public async Task AssembleFilesAsync(BindableFile[] files)
         await WaitAndClearStatus();
     }
 
-    private static async Task<Assembler?> AssembleFileAsync(BindableFile file, AssemblerConfig? config, BindableFile? saveLocation = null)
+    private static async Task<AssemblyResult?> AssembleFileAsync(BindableFile file, RasmConfig? config, BindableFile? saveLocation = null)
     {
         config ??= new RasmConfig();
 
@@ -126,21 +126,15 @@ public async Task AssembleFilesAsync(BindableFile[] files)
         if (stream is null)
             return null;
 
-        // Assemble the file
-        var assembler = await Assembler.AssembleAsync(stream, file.Path, config);
-
-        // Return if no save file is provided
-        if (saveLocation is null)
-            return assembler;
-
-        // Open save file for 
-        stream = await saveLocation.GetWriteStreamAsync();
-        if (stream is null)
-            return null;
+        // Open save location stream
+        Stream? saveStream = null;
+        if (saveLocation is not null)
+        {
+            saveStream = await saveLocation.GetWriteStreamAsync();
+        }
 
-        // TODO: Support other module formats
-        assembler.CompleteModule<RasmModule>(stream);
-        return assembler;
+        // Assemble the file
+        return await Assembler.AssembleAsync<RasmModule, RasmConfig>(stream, file.Path, config, saveStream);
     }
 
     private bool PreBuildChecks()

src/Apps/Mipser/Program.cs

@@ -54,17 +54,12 @@ private static async Task Run(string filePath)
 
         var inFile = File.Open(filePath, FileMode.Open);
         var outFile = File.Open(resultFile, FileMode.Create);
-        var assembler = await Assembler.AssembleAsync(inFile, filePath, new RasmConfig());
+        var assembler = await Assembler.AssembleAsync<RasmModule, RasmConfig>(inFile, filePath, new RasmConfig(), outFile);
 
         Console.WriteLine(!assembler.Failed
             ? $"Assembled with {assembler.Logs.Count} messages."
             : $"Failed to assemble with {assembler.Logs.Count} messages.");
 
-        if (!assembler.Failed)
-        {
-            assembler.CompleteModule<RasmModule>(outFile);
-        }
-
         Console.WriteLine();
 
         if (assembler.Logs.Count > 0)

src/Formats/ELF.Modules/ElfModule.cs

@@ -13,7 +13,7 @@ namespace ELF.Modules;
 /// <summary>
 /// A fully assembled object module in ELF format
 /// </summary>
-public class ElfModule : IBuildModule<ElfModule>
+public class ElfModule : IBuildModule<ElfModule, ElfConfig>
 {
     /// <summary>
     /// Initializes a new instance of the <see cref="ElfModule"/> class.
@@ -27,28 +27,21 @@ public ElfModule(string name)
     public string? Name { get; }
 
     /// <inheritdoc/>
-    public unsafe static ElfModule? Create(ModuleConstructor constructor, AssemblerConfig config, Stream? stream = null)
+    public unsafe static ElfModule? Create(ModuleConstructor constructor, ElfConfig config, Stream? stream = null)
     {
         stream ??= new MemoryStream();
 
-        // Verify 
-        if (config is not ElfConfig elfConfig)
-        {
-            ThrowHelper.ThrowArgumentException(nameof(config), $"{config} must be an {nameof(ElfConfig)}.");
-            return null;
-        }
-
         // Ensure 32-bit class
         // TODO: Support creating 64-bit elf.
-        if (elfConfig.ElfIdentity.Class is not Class.Bit32)
+        if (config.ElfIdentity.Class is not Class.Bit32)
         {
-            ThrowHelper.ThrowArgumentException(nameof(elfConfig.ElfIdentity.Class), $"Configuration class must be 32bit for MIPS.");
+            ThrowHelper.ThrowArgumentException(nameof(config.ElfIdentity.Class), $"Configuration class must be 32bit for MIPS.");
         }
 
         // Allocate space for header
         var header = new Header<uint>()
         {
-            Identity = elfConfig.ElfIdentity,
+            Identity = config.ElfIdentity,
             HeaderSize = (ushort)sizeof(Header<uint>),
         };
         header.TryWrite(stream);
@@ -67,7 +60,7 @@ public ElfModule(string name)
 
         throw new NotImplementedException();
     }
-    
+
     /// <inheritdoc/>
     public static ElfModule? Load(string name, Stream stream)
     {

src/Formats/ObjectFiles/ElfModule.cs

@@ -13,7 +13,7 @@ namespace ObjectFiles;
 /// <summary>
 /// An object module in ELF format.
 /// </summary>
-public class ElfModule : IBuildModule<ElfModule>, IExecutableModule
+public class ElfModule : IBuildModule<ElfModule, AssemblerConfig>, IExecutableModule
 {
     private readonly ElfFile _elfFile;
 

src/Formats/RASM.Modules/RasmModule.cs

@@ -19,7 +19,7 @@ namespace RASM.Modules;
 /// <summary>
 /// A fully assembled object module in RASM format.
 /// </summary>
-public class RasmModule : IBuildModule<RasmModule>, IExecutableModule
+public class RasmModule : IBuildModule<RasmModule, RasmConfig>, IExecutableModule
 {
     private const int SECTION_COUNT = 6;
 
@@ -50,16 +50,10 @@ public RasmModule(string? name, Header header, Stream source)
     public string? Name { get; }
 
     /// <inheritdoc/>
-    public static RasmModule? Create(ModuleConstructor constructor, AssemblerConfig config, Stream? stream = null)
+    public static RasmModule? Create(ModuleConstructor constructor, RasmConfig config, Stream? stream = null)
     {
         stream ??= new MemoryStream();
 
-        if (config is not RasmConfig rasmConfig)
-        {
-            ThrowHelper.ThrowArgumentException(nameof(config), $"{config} must be a {nameof(RasmConfig)}.");
-            return null;
-        }
-
         // TODO: Flags and entry point properly
         // TODO: Construct string list.
 
@@ -75,7 +69,7 @@ public RasmModule(string? name, Header header, Stream source)
             0, 0, 0, 0
         };
 
-        var header = new Header(rasmConfig.MagicNumber, rasmConfig.VersionNumber, 0, 0, sizes);
+        var header = new Header(config.MagicNumber, config.VersionNumber, 0, 0, sizes);
         header.TryWrite(stream);
 
         // Append segments to stream

src/Formats/Raw.Modules/RawModule.cs

@@ -10,7 +10,7 @@ namespace Raw.Modules;
 /// <summary>
 /// A raw wrapper format for a module that contains the raw binary data of the assembled program.
 /// </summary>
-public class RawModule : IBuildModule<RawModule>, IExecutableModule
+public class RawModule : IBuildModule<RawModule, AssemblerConfig>, IExecutableModule
 {
     private readonly Stream _source;
 

src/MIPS.Assembler/Assembler.Public.cs

@@ -0,0 +1,57 @@
+// Avishai Dernis 2025
+
+using MIPS.Assembler.Models;
+using MIPS.Assembler.Models.Modules.Interfaces;
+using System.IO;
+using System.Threading.Tasks;
+
+namespace MIPS.Assembler;
+
+public partial class Assembler
+{
+    /// <summary>
+    /// Assembles a string.
+    /// </summary>
+    public static async Task<AssemblyResult> AssembleAsync(string str, string? filename, AssemblerConfig config)
+    {
+        using var reader = new StringReader(str);
+        var assembler = await AssembleAsync(reader, filename, config);
+        return new AssemblyResult(assembler.Failed, assembler.Logs);
+    }
+    
+    /// <summary>
+    /// Assembles a string.
+    /// </summary>
+    public static async Task<AssemblyResult<T>> AssembleAsync<T, TConfig>(string str, string? filename, TConfig config, Stream? outStream = null)
+        where T : IBuildModule<T, TConfig>
+        where TConfig : AssemblerConfig
+    {
+        using var reader = new StringReader(str);
+        var assembler = await AssembleAsync(reader, filename, config);
+        var obj = T.Create(assembler._module, config, outStream);
+        return new AssemblyResult<T>(obj, assembler.Failed, assembler.Logs);
+    }
+
+    /// <summary>
+    /// Assembles a stream.
+    /// </summary>
+    public static async Task<AssemblyResult> AssembleAsync(Stream stream, string? filename, AssemblerConfig config)
+    {
+        using var reader = new StreamReader(stream);
+        var assembler = await AssembleAsync(reader, filename, config);
+        return new AssemblyResult(assembler.Failed, assembler.Logs);
+    }
+
+    /// <summary>
+    /// Assembles a stream.
+    /// </summary>
+    public static async Task<AssemblyResult<T>> AssembleAsync<T, TConfig>(Stream stream, string? filename, TConfig config, Stream? outStream = null)
+        where T : IBuildModule<T, TConfig>
+        where TConfig : AssemblerConfig
+    {
+        using var reader = new StreamReader(stream);
+        var assembler = await AssembleAsync(reader, filename, config);
+        var obj = T.Create(assembler._module, config, outStream);
+        return new AssemblyResult<T>(obj, assembler.Failed, assembler.Logs);
+    }
+}

src/MIPS.Assembler/Assembler.cs

@@ -11,6 +11,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Net.Http.Headers;
 using System.Threading.Tasks;
 
 namespace MIPS.Assembler;
@@ -59,12 +60,12 @@ private Assembler(AssemblerConfig config)
     /// <summary>
     /// Gets the assembler context for this assembler instance.
     /// </summary>
-    public AssemblerContext Context { get; }
+    internal AssemblerContext Context { get; }
 
     /// <summary>
     /// Gets the assembler's configuration.
     /// </summary>
-    public AssemblerConfig Config { get; }
+    internal AssemblerConfig Config { get; }
 
     /// <summary>
     /// Gets the current address.
@@ -89,29 +90,11 @@ internal Address CurrentAddress
     /// Gets whether or not the assembler failed to assemble a valid module.
     /// </summary>
     public bool Failed => _logger.Failed;
-    
-    /// <summary>
-    /// Assembles an object module from a stream of assembly.
-    /// </summary>
-    public static async Task<Assembler> AssembleAsync(string str, string? filename, AssemblerConfig config)
-    {
-        using var reader = new StringReader(str);
-        return await AssembleAsync(reader, filename, config);
-    }
-    
-    /// <summary>
-    /// Assembles an object module from a stream of assembly.
-    /// </summary>
-    public static async Task<Assembler> AssembleAsync(Stream stream, string? filename, AssemblerConfig config)
-    {
-        using var reader = new StreamReader(stream);
-        return await AssembleAsync(reader, filename, config);
-    }
 
     /// <summary>
     /// Assembles an object module from a stream of assembly.
     /// </summary>
-    public static async Task<Assembler> AssembleAsync(TextReader reader, string? filename, AssemblerConfig config)
+    private static async Task<Assembler> AssembleAsync(TextReader reader, string? filename, AssemblerConfig config)
     {
         var assembler = new Assembler(config);
         var tokens = await Tokenizer.TokenizeAsync(reader, filename);
@@ -130,13 +113,4 @@ public static async Task<Assembler> AssembleAsync(TextReader reader, string? fil
 
         return assembler;
     }
-
-    /// <summary>
-    /// Writes the assembled module to a module stream of the provided format.
-    /// </summary>
-    /// <typeparam name="T">The format of module to write.</typeparam>
-    /// <param name="stream">The stream to write the module to.</param>
-    /// <returns>The module object.</returns>
-    public T? CompleteModule<T>(Stream stream)
-        where T : IBuildModule<T> => T.Create(_module, Config, stream);
 }

src/MIPS.Assembler/Models/AssemblyResult.cs

@@ -0,0 +1,28 @@
+// Avishai Dernis 2025
+
+using MIPS.Assembler.Logging;
+using System.Collections.Generic;
+
+namespace MIPS.Assembler.Models;
+
+/// <summary>
+/// A class containing the results of an assembler run.
+/// </summary>
+public class AssemblyResult
+{
+    internal AssemblyResult(bool failed, IReadOnlyList<AssemblerLog> logs)
+    {
+        Failed = failed;
+        Logs = logs;
+    }
+
+    /// <summary>
+    /// Gets whether or not the assembly failed.
+    /// </summary>
+    public bool Failed { get; }
+
+    /// <summary>
+    /// Gets the assmembly log.
+    /// </summary>
+    public IReadOnlyList<AssemblerLog> Logs { get; }
+}

src/MIPS.Assembler/Models/AssemblyResult{TObject}.cs

@@ -0,0 +1,31 @@
+// Avishai Dernis 2025
+
+using MIPS.Assembler.Logging;
+using MIPS.Assembler.Models.Modules.Interfaces;
+using System.Collections.Generic;
+
+namespace MIPS.Assembler.Models;
+
+/// <summary>
+/// A <see cref="AssemblyResult"/> including the constructed object module.
+/// </summary>
+/// <typeparam name="TObject">The object module type.</typeparam>
+public class AssemblyResult<TObject> : AssemblyResult
+    where TObject : IBuildModule
+{
+    internal AssemblyResult(TObject? objectModule, bool failed, IReadOnlyList<AssemblerLog> logs)
+        : base(failed, logs)
+    {
+        ObjectModule = objectModule;
+    }
+
+    internal AssemblyResult(TObject? objectModule, AssemblyResult childResult)
+        : this(objectModule, childResult.Failed, childResult.Logs)
+    {
+    }
+
+    /// <summary>
+    /// Gets the object module result of the assembly.
+    /// </summary>
+    public TObject? ObjectModule { get; }
+}