Re-implement console --progress

#83

NAPS2.Lib.Gtk/EntryPoints/GtkEntryPoint.cs

@@ -1,4 +1,6 @@
-using NAPS2.Modules;
+using NAPS2.EtoForms;
+using NAPS2.EtoForms.Gtk;
+using NAPS2.Modules;
 
 namespace NAPS2.EntryPoints;
 
@@ -10,6 +12,7 @@ public static class GtkEntryPoint
     public static int Run(string[] args)
     {
         GLib.ExceptionManager.UnhandledException += UnhandledGtkException;
+        EtoPlatform.Current = new GtkEtoPlatform();
 
         if (args.Length > 0 && args[0] is "cli" or "console")
         {

NAPS2.Lib.Gtk/Modules/GtkModule.cs

@@ -17,7 +17,5 @@ protected override void Load(ContainerBuilder builder)
 
         builder.RegisterType<GtkDesktopForm>().As<DesktopForm>();
         builder.RegisterType<GtkPreviewForm>().As<PreviewForm>();
-
-        EtoPlatform.Current = new GtkEtoPlatform();
     }
 }

NAPS2.Lib.Mac/EntryPoints/MacEntryPoint.cs

@@ -1,4 +1,6 @@
-using NAPS2.Modules;
+using NAPS2.EtoForms;
+using NAPS2.EtoForms.Mac;
+using NAPS2.Modules;
 
 namespace NAPS2.EntryPoints;
 
@@ -19,6 +21,8 @@ public static int Run(string[] args)
             Log.Error($"Marshalling ObjC exception: {eventArgs.Exception.Description}");
         };
 
+        EtoPlatform.Current = new MacEtoPlatform();
+
         if (args.Length > 0 && args[0] is "cli" or "console")
         {
             return ConsoleEntryPoint.Run(args.Skip(1).ToArray(), new MacImagesModule());

NAPS2.Lib.Mac/Modules/MacModule.cs

@@ -20,7 +20,5 @@ protected override void Load(ContainerBuilder builder)
 
         builder.RegisterType<MacDesktopForm>().As<DesktopForm>();
         builder.RegisterType<MacPreviewForm>().As<PreviewForm>();
-
-        EtoPlatform.Current = new MacEtoPlatform();
     }
 }

NAPS2.Lib.WinForms/EntryPoints/WinFormsEntryPoint.cs

@@ -1,4 +1,6 @@
-using NAPS2.Modules;
+using NAPS2.EtoForms;
+using NAPS2.EtoForms.WinForms;
+using NAPS2.Modules;
 
 namespace NAPS2.EntryPoints;
 
@@ -9,6 +11,8 @@ public static class WinFormsEntryPoint
 {
     public static int Run(string[] args)
     {
+        EtoPlatform.Current = new WinFormsEtoPlatform();
+
         if (args.Length > 0 && args[0] == "worker")
         {
             return WindowsWorkerEntryPoint.Run(args.Skip(1).ToArray());

NAPS2.Lib.WinForms/EntryPoints/WindowsConsoleEntryPoint.cs

@@ -1,4 +1,6 @@
-using NAPS2.Modules;
+using NAPS2.EtoForms;
+using NAPS2.EtoForms.WinForms;
+using NAPS2.Modules;
 
 namespace NAPS2.EntryPoints;
 
@@ -9,6 +11,7 @@ public static class WindowsConsoleEntryPoint
 {
     public static int Run(string[] args)
     {
+        EtoPlatform.Current = new WinFormsEtoPlatform();
         return ConsoleEntryPoint.Run(args, new GdiModule());
     }
 }

NAPS2.Lib.WinForms/Modules/WinFormsModule.cs

@@ -19,7 +19,6 @@ protected override void Load(ContainerBuilder builder)
 
         builder.RegisterType<WinFormsDesktopForm>().As<DesktopForm>();
 
-        EtoPlatform.Current = new WinFormsEtoPlatform();
         // TODO: Can we add a test for this?
         builder.RegisterBuildCallback(ctx =>
             Log.EventLogger = ctx.Resolve<WindowsEventLogger>());

NAPS2.Lib/EntryPoints/ConsoleEntryPoint.cs

@@ -1,6 +1,7 @@
 using Autofac;
 using CommandLine;
 using NAPS2.Automation;
+using NAPS2.EtoForms;
 using NAPS2.Modules;
 using NAPS2.Remoting.Worker;
 using NAPS2.Scan;
@@ -35,7 +36,22 @@ public static int Run(string[] args, Module imageModule)
 
         // Run the scan automation logic
         var scanning = container.Resolve<AutomatedScanning>();
-        scanning.Execute().Wait();
+
+        if (options.Progress)
+        {
+            // We need to set up an Eto application in order to be able to display a progress GUI
+            EtoPlatform.Current.InitializePlatform();
+            container.Resolve<CultureHelper>().SetCulturesFromConfig();
+
+            var application = EtoPlatform.Current.CreateApplication();
+            application.UnhandledException += UnhandledException;
+            application.Initialized += (_, _) => scanning.Execute().ContinueWith(_ => application.Quit());
+            EtoPlatform.Current.RunApplication(application);
+        }
+        else
+        {
+            scanning.Execute().Wait();
+        }
 
         return ((ConsoleErrorOutput) container.Resolve<ErrorOutput>()).HasError ? 1 : 0;
     }
@@ -45,4 +61,10 @@ private static void UnhandledTaskException(object? sender, UnobservedTaskExcepti
         Log.FatalException("An error occurred that caused the task to terminate.", e.Exception);
         e.SetObserved();
     }
+
+    private static void UnhandledException(object? sender, Eto.UnhandledExceptionEventArgs e)
+    {
+        Log.FatalException("An error occurred that caused the application to close.",
+            e.ExceptionObject as Exception ?? new Exception());
+    }
 }

NAPS2.Lib/EtoForms/EtoInvoker.cs

@@ -0,0 +1,30 @@
+using Eto.Forms;
+
+namespace NAPS2.EtoForms;
+
+public class EtoInvoker : IInvoker
+{
+    private readonly Application _application;
+
+    public EtoInvoker(Application application)
+    {
+        _application = application;
+    }
+
+    public void Invoke(Action action)
+    {
+        _application.Invoke(action);
+    }
+
+    public void InvokeDispatch(Action action)
+    {
+        _application.AsyncInvoke(action);
+    }
+
+    public T InvokeGet<T>(Func<T> func)
+    {
+        T value = default!;
+        _application.Invoke(() => value = func());
+        return value;
+    }
+}

NAPS2.Lib/EtoForms/EtoPlatform.cs

@@ -41,6 +41,13 @@ public virtual void RunApplication(Application application, Form mainForm)
         application.Run(mainForm);
     }
 
+    public virtual void RunApplication(Application application)
+    {
+        // TODO: Can we use EtoInvoker more generally and get rid of some of the platform-specific stuff?
+        Invoker.Current = new EtoInvoker(application);
+        application.Run();
+    }
+
     public virtual void SetContainerSize(Window window, Control container, Size size, int padding)
     {
     }

NAPS2.Lib/EtoForms/Notifications/StubNotify.cs

@@ -0,0 +1,26 @@
+using NAPS2.Update;
+
+namespace NAPS2.EtoForms.Notifications;
+
+public class StubNotify : INotify
+{
+    public void PdfSaved(string path)
+    {
+    }
+
+    public void ImagesSaved(int imageCount, string path)
+    {
+    }
+
+    public void DonatePrompt()
+    {
+    }
+
+    public void OperationProgress(OperationProgress progress, IOperation op)
+    {
+    }
+
+    public void UpdateAvailable(IUpdateChecker updateChecker, UpdateInfo update)
+    {
+    }
+}

NAPS2.Lib/Modules/AutoFacHelper.cs

@@ -6,13 +6,16 @@ namespace NAPS2.Modules;
 
 public class AutoFacHelper
 {
-    public static IContainer FromModules(params IModule[] modules)
+    public static IContainer FromModules(params IModule?[] modules)
     {
         var builder = new ContainerBuilder();
         builder.RegisterSource<AnyConcreteTypeNotAlreadyRegisteredSource>();
         foreach (var module in modules)
         {
-            builder.RegisterModule(module);
+            if (module != null)
+            {
+                builder.RegisterModule(module);
+            }
         }
         return builder.Build();
     }

NAPS2.Lib/Modules/ConsoleModule.cs

@@ -24,7 +24,15 @@ protected override void Load(ContainerBuilder builder)
         builder.RegisterType<ConsolePdfPasswordProvider>().As<IPdfPasswordProvider>();
         builder.RegisterType<ConsoleErrorOutput>().As<ErrorOutput>().SingleInstance();
         builder.RegisterType<ConsoleOverwritePrompt>().As<IOverwritePrompt>();
-        builder.RegisterType<ConsoleOperationProgress>().As<OperationProgress>();
+        if (_options.Progress)
+        {
+            builder.RegisterType<EtoOperationProgress>().As<OperationProgress>();
+        }
+        else
+        {
+            builder.RegisterType<ConsoleOperationProgress>().As<OperationProgress>();
+        }
+        builder.RegisterType<StubNotify>().As<INotify>();
         // TODO: We might want an eto-based dialog helper, or at least handle dialogs in a more user-friendly way than just silently doing nothing
         builder.RegisterType<StubDialogHelper>().As<DialogHelper>();
         builder.RegisterType<ConsoleOutput>().AsSelf().WithParameter("writer", Console.Out);