Merge pull request #1 from GalaxyShad/feat-linear-complexity

Many features and refactor

.github/workflows/dotnet-desktop.yml

@@ -0,0 +1,115 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# This workflow will build, test, sign and package a WPF or Windows Forms desktop application
+# built on .NET Core.
+# To learn how to migrate your existing application to .NET Core,
+# refer to https://docs.microsoft.com/en-us/dotnet/desktop-wpf/migration/convert-project-from-net-framework
+#
+# To configure this workflow:
+#
+# 1. Configure environment variables
+# GitHub sets default environment variables for every workflow run.
+# Replace the variables relative to your project in the "env" section below.
+#
+# 2. Signing
+# Generate a signing certificate in the Windows Application
+# Packaging Project or add an existing signing certificate to the project.
+# Next, use PowerShell to encode the .pfx file using Base64 encoding
+# by running the following Powershell script to generate the output string:
+#
+# $pfx_cert = Get-Content '.\SigningCertificate.pfx' -Encoding Byte
+# [System.Convert]::ToBase64String($pfx_cert) | Out-File 'SigningCertificate_Encoded.txt'
+#
+# Open the output file, SigningCertificate_Encoded.txt, and copy the
+# string inside. Then, add the string to the repo as a GitHub secret
+# and name it "Base64_Encoded_Pfx."
+# For more information on how to configure your signing certificate for
+# this workflow, refer to https://github.com/microsoft/github-actions-for-desktop-apps#signing
+#
+# Finally, add the signing certificate password to the repo as a secret and name it "Pfx_Key".
+# See "Build the Windows Application Packaging project" below to see how the secret is used.
+#
+# For more information on GitHub Actions, refer to https://github.com/features/actions
+# For a complete CI/CD sample to get started with GitHub Action workflows for Desktop Applications,
+# refer to https://github.com/microsoft/github-actions-for-desktop-apps
+
+name: .NET Core Desktop
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+
+  build:
+
+    strategy:
+      matrix:
+        configuration: [Debug, Release]
+
+    runs-on: windows-latest  # For a list of available runner types, refer to
+                             # https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on
+
+    env:
+      Solution_Name: your-solution-name                         # Replace with your solution name, i.e. MyWpfApp.sln.
+      Test_Project_Path: your-test-project-path                 # Replace with the path to your test project, i.e. MyWpfApp.Tests\MyWpfApp.Tests.csproj.
+      Wap_Project_Directory: your-wap-project-directory-name    # Replace with the Wap project directory relative to the solution, i.e. MyWpfApp.Package.
+      Wap_Project_Path: your-wap-project-path                   # Replace with the path to your Wap project, i.e. MyWpf.App.Package\MyWpfApp.Package.wapproj.
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    # Install the .NET Core workload
+    - name: Install .NET Core
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 6.0.x
+
+    # Add  MSBuild to the PATH: https://github.com/microsoft/setup-msbuild
+    - name: Setup MSBuild.exe
+      uses: microsoft/[email protected]
+
+    # Execute all unit tests in the solution
+    - name: Execute unit tests
+      run: dotnet test
+
+    # Restore the application to populate the obj folder with RuntimeIdentifiers
+    - name: Restore the application
+      run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration
+      env:
+        Configuration: ${{ matrix.configuration }}
+
+    # Decode the base 64 encoded pfx and save the Signing_Certificate
+    - name: Decode the pfx
+      run: |
+        $pfx_cert_byte = [System.Convert]::FromBase64String("${{ secrets.Base64_Encoded_Pfx }}")
+        $certificatePath = Join-Path -Path $env:Wap_Project_Directory -ChildPath GitHubActionsWorkflow.pfx
+        [IO.File]::WriteAllBytes("$certificatePath", $pfx_cert_byte)
+
+    # Create the app package by building and packaging the Windows Application Packaging project
+    - name: Create the app package
+      run: msbuild $env:Wap_Project_Path /p:Configuration=$env:Configuration /p:UapAppxPackageBuildMode=$env:Appx_Package_Build_Mode /p:AppxBundle=$env:Appx_Bundle /p:PackageCertificateKeyFile=GitHubActionsWorkflow.pfx /p:PackageCertificatePassword=${{ secrets.Pfx_Key }}
+      env:
+        Appx_Bundle: Always
+        Appx_Bundle_Platforms: x86|x64
+        Appx_Package_Build_Mode: StoreUpload
+        Configuration: ${{ matrix.configuration }}
+
+    # Remove the pfx
+    - name: Remove the pfx
+      run: Remove-Item -path $env:Wap_Project_Directory\GitHubActionsWorkflow.pfx
+
+    # Upload the MSIX package: https://github.com/marketplace/actions/upload-a-build-artifact
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: MSIX Package
+        path: ${{ env.Wap_Project_Directory }}\AppPackages

SomeAsmTranslator.sln

@@ -3,7 +3,9 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.3.32922.545
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SomeAsmTranslator", "SomeAsmTranslator\SomeAsmTranslator.csproj", "{318AD031-0521-4D9E-8D8A-2FB77EEC7793}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SomeAsmTranslator", "SomeAsmTranslator\SomeAsmTranslator.csproj", "{318AD031-0521-4D9E-8D8A-2FB77EEC7793}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SomeAsmTranslatorTests", "SomeAsmTranslatorTests\SomeAsmTranslatorTests.csproj", "{26C7B11A-592E-47E8-B059-4BF8C21E2028}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -15,6 +17,10 @@ Global
 		{318AD031-0521-4D9E-8D8A-2FB77EEC7793}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{318AD031-0521-4D9E-8D8A-2FB77EEC7793}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{318AD031-0521-4D9E-8D8A-2FB77EEC7793}.Release|Any CPU.Build.0 = Release|Any CPU
+		{26C7B11A-592E-47E8-B059-4BF8C21E2028}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{26C7B11A-592E-47E8-B059-4BF8C21E2028}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{26C7B11A-592E-47E8-B059-4BF8C21E2028}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{26C7B11A-592E-47E8-B059-4BF8C21E2028}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

SomeAsmTranslator/Program.cs

@@ -9,7 +9,6 @@ namespace I8080Translator;
 
 partial class Program
 {
-    static private readonly Assembler _assembler = new();
     static private readonly ListingGenerator _listingGenerator = new();
 
     static void Main(string[] args)
@@ -21,41 +20,48 @@ static void Main(string[] args)
               .WithNotParsed(HandleParseError);
     }
 
-    static void RunOptions(ArgumentsOptions opts)
+    static void ProccessProgram(ArgumentsOptions opts)
     {
-        try
-        {
-            string sourceCode = ReadSourceCodeFromFile(opts.InputFilePath);
+        _listingGenerator.IsMachineCodeLineSeperation = !opts.IsKeepAllInstructionBytesOnSameLine;
 
-            _listingGenerator.IsMachineCodeLineSeperation = !opts.IsKeepAllInstructionBytesOnSameLine;
+        var assemblerLines = Assemble(opts.InputFilePath);
+        var listing = _listingGenerator.Generate(assemblerLines);
 
-            var assemblerLines = Assemble(sourceCode);
-            var listing = _listingGenerator.Generate(assemblerLines);
+        var listingWriterFactory = new AssemblerListingWriterFactory(listing, assemblerLines);
+        var listingWritersList = listingWriterFactory.Get(opts);
 
-            var listingWriterFactory = new AssemblerListingWriterFactory(listing, assemblerLines);
-            var listingWritersList = listingWriterFactory.Get(opts);
+        var inFilePath = Path.GetFullPath(opts.InputFilePath);
+        var inputFileWihoutExt = GetDirectoryPathWithoutExtension(inFilePath);
+        var outFilePath = $"{inputFileWihoutExt}.i8080asm";
 
-            var inFilePath = Path.GetFullPath(opts.InputFilePath);
-            var inputFileWihoutExt = GetDirectoryPathWithoutExtension(inFilePath);
-            var outFilePath = $"{inputFileWihoutExt}.i8080asm";
-
-            foreach (IAssemblerFileWriter listingWriter in listingWritersList)
+        foreach (IAssemblerFileWriter listingWriter in listingWritersList)
+        {
+            if (listingWriter is AssemblerListingWriterText consoleWriter)
             {
-                if (listingWriter is AssemblerListingWriterText consoleWriter)
-                {
-                    if (consoleWriter.FileExtension == AssemblerListingWriterText.Extension.Txt)
-                        consoleWriter.WriteToConsole();
-                }
-
-                listingWriter.WriteToFile(outFilePath);
+                if (consoleWriter.FileExtension == AssemblerListingWriterText.Extension.Txt)
+                    consoleWriter.WriteToConsole();
             }
 
-            Console.WriteLine($"\nSuccessfull");
+            listingWriter.WriteToFile(outFilePath);
+        }
+
+        Console.WriteLine($"\nSuccessfull");
+    }
+
+    static void RunOptions(ArgumentsOptions opts)
+    {
+#if DEBUG
+        ProccessProgram(opts);
+#else
+        try
+        {
+            ProccessProgram(opts);
         }
         catch (Exception ex)
         {
             Console.WriteLine(ex.Message);
         }
+#endif
     }
     static void HandleParseError(IEnumerable<Error> errs)
     {
@@ -67,35 +73,52 @@ static string GetDirectoryPathWithoutExtension(string path) =>
         $"{Path.DirectorySeparatorChar}" +
         $"{Path.GetFileNameWithoutExtension(path)}";
 
-    static private IEnumerable<AssemblyLine> Assemble(string sourceCode)
+    static private IList<AssemblyLine> AssembleFile(string filepath)
+    {
+        using var streamReader = new StreamReader(filepath);
+        var asm = new Assembler(streamReader);
+        return asm.AssembleAll().ToList();
+    }
+
+    static private IEnumerable<AssemblyLine> Assemble(string filepath)
     {
+#if DEBUG
+        return AssembleFile(filepath);
+#else
         try
         {
-            return _assembler.AssembleAll(sourceCode);
+            return AssembleFile(filepath);
         }
         catch (TranslatorLexerException ex)
         {
             throw new Exception(
-                $"[ERR] [LEXER] {ex.GetType()}\n" +
-                $"Error at line {ex.ErrorLine}\n" +
-                $"      {ex.Message}"
+                $"[ERR] [LEXER] {filepath}\n" +
+                $"[Line {ex.ErrorLine}] {ex.Message}\n"
             );
         }
         catch (TranslatorParserException ex)
         {
             throw new Exception(
-                $"[ERR] [PARSER] {ex.GetType()}\n" +
-                $"Error at line {ex.ErrorLine}\n" +
-                $"      {ex.Message}"
+                $"[ERR] [PARSER] {filepath}\n" +
+                $"[Line {ex.ErrorLine}] {ex.Message}\n"
+            );
+        }
+        catch (TranslatorAssemblerException ex)
+        {
+            throw new Exception(
+                $"[ERR] [ASSEMBLER] {filepath}\n" +
+                $"[Line {ex.ErrorLine}] {ex.Message}\n"
             );
         }
         catch (Exception ex)
         {
             throw new Exception(
-                $"[ERR] [Unexpected error] [{ex.GetType()}] Send a bug report to the developer.\n" +
+                $"[ERR] [Unexpected error] {filepath}\n" +
+                $"[{ex.GetType()}] Send a bug report to the developer.\n" +
                 $"{ex.Message}\n"
             );
         }
+#endif
     }
 
     static private string ReadSourceCodeFromFile(string filepath)

SomeAsmTranslator/Properties/launchSettings.json

@@ -3,6 +3,10 @@
     "SomeAsmTranslator": {
       "commandName": "Project",
       "commandLineArgs": "$(MSBuildProjectDirectory)/TestData/1.asm --csv --word --samelinebyte --bin --md"
+    },
+    "Monitor": {
+      "commandName": "Project",
+      "commandLineArgs": "$(MSBuildProjectDirectory)/TestData/monitor.asm --csv --word --bin --md"
     }
   }
 }