Port UI to Avalonia

.github/workflows/build.yml

@@ -4,17 +4,18 @@ on: [workflow_call]
 
 jobs:
   build:
-    runs-on: windows-latest
+    runs-on: ubuntu-latest
     strategy:
       matrix:
+        target-runtime: [linux-x64, win-x64]
         configuration: [Debug, Release]
 
-    name: Z64Utils-${{ matrix.configuration }}
+    name: Z64Utils-${{ matrix.target-runtime }}-${{ matrix.configuration }}
     env:
       DOTNET_CLI_TELEMETRY_OPTOUT: true
-      restore_args: ''
+      restore_args: --runtime ${{ matrix.target-runtime }}
       build_args: --no-self-contained --configuration ${{ matrix.configuration }} --version-suffix ${{ github.sha }} --property:IncludeSourceRevisionInInformationalVersion=false
-      archive_name: Z64Utils-${{ matrix.configuration }}-${{ github.sha }}
+      archive_name: Z64Utils-${{ matrix.target-runtime }}-${{ matrix.configuration }}-${{ github.sha }}
     steps:
       - uses: actions/checkout@v4
         with:
@@ -28,17 +29,17 @@ jobs:
       - name: dotnet restore
         shell: bash
         run: |
-          dotnet restore ${{ env.restore_args }}
+          dotnet restore Z64Utils/Z64Utils.csproj ${{ env.restore_args }}
 
       - name: dotnet build
         shell: bash
         run: |
-          dotnet build ${{ env.restore_args }} ${{ env.build_args }}
+          dotnet build Z64Utils/Z64Utils.csproj ${{ env.restore_args }} ${{ env.build_args }}
 
       - name: dotnet publish
         shell: bash
         run: |
-          dotnet publish --output publish_out/ ${{ env.restore_args }} ${{ env.build_args }}
+          dotnet publish Z64Utils/Z64Utils.csproj --output publish_out/ ${{ env.restore_args }} ${{ env.build_args }}
 
       - uses: actions/checkout@v4
         with:

README.md

@@ -39,20 +39,15 @@ You can find these configuration files as well as some additional information ab
 
 Currently, the only requirement is `.NET 6` (Not to be confused with `.NET Core` or `.NET Framework`).
 
-The general purpose download link for `.NET` is [this](https://dotnet.microsoft.com/download), and the direct download is [here](https://builds.dotnet.microsoft.com/dotnet/WindowsDesktop/6.0.36/windowsdesktop-runtime-6.0.36-win-x64.exe).
-
-## Wine / Linux
+## Windows
 
-Z64Utils v2.0.1 is wine-compatible (this may change in the future).
+The general purpose download link for `.NET` is [this](https://dotnet.microsoft.com/download), and the direct download is [here](https://builds.dotnet.microsoft.com/dotnet/WindowsDesktop/6.0.36/windowsdesktop-runtime-6.0.36-win-x64.exe).
 
-To run it, first you need to install `.NET 6` using the installer (see [Dependencies](#dependencies) for the download link).
+## Linux
 
-Please keep in mind you need to use `wine64` instead of `wine` because this is a 64bits-only app.
+On Ubuntu, you can install `.NET 6` with `sudo apt install dotnet-runtime-6.0`.
 
-```bash
-wine64 windowsdesktop-runtime-6.0.36-win-x64.exe
-wine64 Z64Utils.exe
-```
+For other Linux distributions, additional details or other installation methods, see (Microsoft's documentation)[https://learn.microsoft.com/en-us/dotnet/core/install/linux].
 
 # Contributing
 

Z64Utils/App.axaml

@@ -0,0 +1,34 @@
+<Application xmlns="https://github.com/avaloniaui"
+    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+    xmlns:c="using:Z64Utils.Controls"
+    x:Class="Z64Utils.App"
+    RequestedThemeVariant="Default">
+    <!-- "Default" ThemeVariant follows system theme variant. "Dark" or "Light" are other available
+    options. -->
+
+    <Application.Styles>
+        <FluentTheme />
+        <StyleInclude Source="avares://Avalonia.Controls.DataGrid/Themes/Fluent.xaml" />
+        <StyleInclude Source="avares://Avalonia.Controls.ColorPicker/Themes/Fluent/Fluent.xaml" />
+    </Application.Styles>
+    <Application.Resources>
+        <ResourceDictionary>
+            <ResourceDictionary.MergedDictionaries>
+                <ResourceInclude Source="/Controls/HexTextBox/Themes/Fluent.xaml" />
+            </ResourceDictionary.MergedDictionaries>
+        </ResourceDictionary>
+        <FontFamily x:Key="MonospacedFont">avares://Z64Utils/Assets/Fonts#Hack</FontFamily>
+
+        <c:EnumUINameMap x:Key="SegmentTypeEnumUINameMap">
+            <c:EnumUINameMapEntry Enum="EMPTY" UI="Empty" />
+            <c:EnumUINameMapEntry Enum="ADDRESS" UI="Address" />
+            <c:EnumUINameMapEntry Enum="ROM_FILESYSTEM" UI="ROM FS" />
+            <c:EnumUINameMapEntry Enum="FILE" UI="File" />
+            <c:EnumUINameMapEntry Enum="IDENTITY_MATRICES" UI="Identity Matrices" />
+            <c:EnumUINameMapEntry Enum="PRIM_COLOR_DLIST" UI="Prim Color" />
+            <c:EnumUINameMapEntry Enum="ENV_COLOR_DLIST" UI="Env Color" />
+            <c:EnumUINameMapEntry Enum="NULL_BYTES" UI="Null Bytes" />
+            <c:EnumUINameMapEntry Enum="EMPTY_DLIST" UI="Empty DList" />
+        </c:EnumUINameMap>
+    </Application.Resources>
+</Application>

Z64Utils/App.axaml.cs

@@ -0,0 +1,125 @@
+using System;
+using System.Linq;
+using Avalonia;
+using Avalonia.Controls.ApplicationLifetimes;
+using Avalonia.Markup.Xaml;
+using Z64Utils.ViewModels;
+using Z64Utils.Views;
+
+namespace Z64Utils;
+
+public partial class App : Application
+{
+    private static readonly NLog.Logger Logger = NLog.LogManager.GetCurrentClassLogger();
+
+    public override void Initialize()
+    {
+        AvaloniaXamlLoader.Load(this);
+    }
+
+    public override void OnFrameworkInitializationCompleted()
+    {
+        if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop)
+        {
+            var winVM = new MainWindowViewModel();
+            var win = new MainWindow() { DataContext = winVM };
+            desktop.MainWindow = win;
+
+            win.Opened += (sender, ev) =>
+            {
+                string? romPath = Program.ParsedArgs?.RomFile?.FullName;
+                Logger.Debug("romPath={romPath}", romPath);
+                if (romPath != null)
+                {
+                    winVM.OpenROMImpl(romPath);
+                    var objectAnalyzerFileNames = Program.ParsedArgs?.ObjectAnalyzerFileNames;
+                    if (objectAnalyzerFileNames != null)
+                    {
+                        Logger.Debug(
+                            "objectAnalyzerFileNames={objectAnalyzerFileNames}",
+                            objectAnalyzerFileNames
+                        );
+                        foreach (var name in objectAnalyzerFileNames)
+                        {
+                            // TODO un-hardcode segment 6
+                            var oavm = winVM.OpenObjectAnalyzerByFileName(name, 6);
+
+                            if (oavm == null)
+                            {
+                                // TODO maybe show error window
+                                Logger.Error(
+                                    "Could not find an object with name {objectName}",
+                                    name
+                                );
+                                continue;
+                            }
+
+                            // TODO put find and analyze behind more command line args
+                            // TODO don't use the Command funcs themselves?
+                            oavm.FindDListsCommand();
+                            oavm.AnalyzeDListsCommand();
+
+                            var dListViewerOHEName = Program.ParsedArgs?.DListViewerOHEName;
+                            if (dListViewerOHEName != null)
+                            {
+                                ObjectAnalyzerWindowViewModel.ObjectHolderEntry? ohe;
+                                try
+                                {
+                                    ohe = oavm.ObjectHolderEntries.First(ohe =>
+                                        ohe.ObjectHolder.Name == dListViewerOHEName
+                                    );
+                                }
+                                catch (InvalidOperationException)
+                                {
+                                    ohe = null;
+                                }
+                                if (ohe != null)
+                                {
+                                    oavm.OpenDListViewerObjectHolderEntryCommand.Execute(ohe);
+                                }
+                                else
+                                {
+                                    // TODO maybe show error window
+                                    Logger.Error(
+                                        "Could not find an entry with name {0}",
+                                        dListViewerOHEName
+                                    );
+                                }
+                            }
+
+                            var skeletonViewerOHEName = Program.ParsedArgs?.SkeletonViewerOHEName;
+                            if (skeletonViewerOHEName != null)
+                            {
+                                ObjectAnalyzerWindowViewModel.ObjectHolderEntry? ohe;
+                                try
+                                {
+                                    ohe = oavm.ObjectHolderEntries.First(ohe =>
+                                        ohe.ObjectHolder.Name == skeletonViewerOHEName
+                                    );
+                                }
+                                catch (InvalidOperationException)
+                                {
+                                    ohe = null;
+                                }
+                                if (ohe != null)
+                                {
+                                    oavm.OpenSkeletonViewerObjectHolderEntryCommand.Execute(ohe);
+                                }
+                                else
+                                {
+                                    // TODO maybe show error window
+                                    Logger.Error(
+                                        "Could not find an entry with name {0}",
+                                        skeletonViewerOHEName
+                                    );
+                                }
+                            }
+                        }
+                    }
+                }
+            };
+        }
+
+        base.OnFrameworkInitializationCompleted();
+    }
+}

Z64Utils/Assets/Fonts/Hack-LICENSE.md

@@ -0,0 +1,45 @@
+The work in the Hack project is Copyright 2018 Source Foundry Authors and licensed under the MIT License
+
+The work in the DejaVu project was committed to the public domain.
+
+Bitstream Vera Sans Mono Copyright 2003 Bitstream Inc. and licensed under the Bitstream Vera License with Reserved Font Names "Bitstream" and "Vera"
+
+### MIT License
+
+Copyright (c) 2018 Source Foundry Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+### BITSTREAM VERA LICENSE
+
+Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is a trademark of Bitstream, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of the fonts accompanying this license ("Fonts") and associated documentation files (the "Font Software"), to reproduce and distribute the Font Software, including without limitation the rights to use, copy, merge, publish, distribute, and/or sell copies of the Font Software, and to permit persons to whom the Font Software is furnished to do so, subject to the following conditions:
+
+The above copyright and trademark notices and this permission notice shall be included in all copies of one or more of the Font Software typefaces.
+
+The Font Software may be modified, altered, or added to, and in particular the designs of glyphs or characters in the Fonts may be modified and additional glyphs or characters may be added to the Fonts, only if the fonts are renamed to names not containing either the words "Bitstream" or the word "Vera".
+
+This License becomes null and void to the extent applicable to Fonts or Font Software that has been modified and is distributed under the "Bitstream Vera" names.
+
+The Font Software may be sold as part of a larger software package but no copy of one or more of the Font Software typefaces may be sold by itself.
+
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL BITSTREAM OR THE GNOME FOUNDATION BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.
+
+Except as contained in this notice, the names of Gnome, the Gnome Foundation, and Bitstream Inc., shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Font Software without prior written authorization from the Gnome Foundation or Bitstream Inc., respectively. For further information, contact: fonts at gnome dot org.

Z64Utils/Common/UpdateChecker.cs

@@ -7,6 +7,7 @@
 using System.Text;
 using System.Text.Json;
 using System.Text.Json.Serialization;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace Common
@@ -171,21 +172,26 @@ public static class UpdateChecker
     {
         public const string ReleaseURL =
             @"https://api.github.com/repos/zeldaret/Z64Utils/releases/latest";
-        public static readonly string CurrentTag = "v" + Z64.Program.Version;
+        public static readonly string CurrentTag = "v" + Z64Utils.Program.Version;
+        private static HttpClient GithubApiHttpClient = new()
+        {
+            BaseAddress = new("https://api.github.com"),
+        };
+
+        static UpdateChecker()
+        {
+            GithubApiHttpClient.DefaultRequestHeaders.UserAgent.ParseAdd("Z64Utils Updater");
+        }
 
-        public static GithubRelease? GetLatestRelease()
+        public static async Task<GithubRelease> GetLatestRelease()
         {
-            HttpClient client = new();
-            var request = new HttpRequestMessage(HttpMethod.Get, ReleaseURL);
-            request.Headers.UserAgent.ParseAdd("Z64Utils Updater");
-            var resp = client.Send(request);
-
-            using (var stream = resp.Content.ReadAsStream())
-            {
-                StreamReader sr = new StreamReader(stream);
-                string json = sr.ReadToEnd();
-                return JsonSerializer.Deserialize<GithubRelease>(json);
-            }
+            CancellationTokenSource timeoutTokenSource = new();
+            timeoutTokenSource.CancelAfter(TimeSpan.FromSeconds(10));
+            var resp = await GithubApiHttpClient.GetAsync(ReleaseURL, timeoutTokenSource.Token);
+            string json = await resp.Content.ReadAsStringAsync();
+            var r = JsonSerializer.Deserialize<GithubRelease>(json);
+            Utils.Assert(r != null);
+            return r;
         }
     }
 }

Z64Utils/Common/Utils.cs

@@ -141,6 +141,8 @@ public static void Assert([DoesNotReturnIf(false)] bool condition)
         {
             if (!condition)
             {
+                if (Debugger.IsAttached)
+                    Debugger.Break();
                 throw new AssertFailedException();
             }
         }