Preset management

Author: patrickfournier

App.cpp

@@ -13,6 +13,7 @@
 #include "DeviceSelectorObserver.hpp"
 #include "OutputOptionsState.hpp"
 #include "PreferencesView.hpp"
+#include "PresetPanel.hpp"
 #include "PreviewPanel.hpp"
 #include "ScanOptionsPanel.hpp"
 #include "Writers/FileWriter.hpp"
@@ -113,7 +114,7 @@ GtkWidget *ZooScan::App::CreateContent()
     auto deviceSelected = !GetSelectorDeviceName().empty();
 
     auto *paned = gtk_paned_new(GTK_ORIENTATION_HORIZONTAL);
-    gtk_widget_set_margin_bottom(paned, 15);
+    gtk_widget_set_margin_bottom(paned, 0);
     gtk_widget_set_margin_top(paned, 0);
     gtk_widget_set_margin_start(paned, 10);
     gtk_widget_set_margin_end(paned, 10);
@@ -128,31 +129,53 @@ GtkWidget *ZooScan::App::CreateContent()
     gtk_orientable_set_orientation(GTK_ORIENTABLE(clamp), GTK_ORIENTATION_HORIZONTAL);
     gtk_paned_set_start_child(GTK_PANED(paned), clamp);
 
-    m_SettingsBox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 8);
+    m_SettingsBox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
     gtk_widget_set_margin_bottom(m_SettingsBox, 0);
     gtk_widget_set_margin_top(m_SettingsBox, 0);
     gtk_widget_set_margin_start(m_SettingsBox, 0);
     gtk_widget_set_margin_end(m_SettingsBox, 10);
     adw_clamp_set_child(ADW_CLAMP(clamp), m_SettingsBox);
 
+    auto buttonBox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 8);
+    gtk_widget_set_margin_bottom(buttonBox, 20);
+    gtk_widget_set_margin_top(buttonBox, 20);
+    gtk_widget_set_margin_start(buttonBox, 0);
+    gtk_widget_set_margin_end(buttonBox, 0);
+    gtk_box_append(GTK_BOX(m_SettingsBox), buttonBox);
+
     m_PreviewButton = gtk_button_new_with_label(_("Preview"));
     ConnectGtkSignal(this, &App::OnPreviewClicked, m_PreviewButton, "clicked");
     gtk_widget_set_sensitive(m_PreviewButton, deviceSelected);
-    gtk_box_append(GTK_BOX(m_SettingsBox), m_PreviewButton);
+    gtk_box_append(GTK_BOX(buttonBox), m_PreviewButton);
 
     m_ScanButton = gtk_button_new_with_label(_("Scan"));
     ConnectGtkSignal(this, &App::OnScanClicked, m_ScanButton, "clicked");
     gtk_widget_set_sensitive(m_ScanButton, deviceSelected);
-    gtk_box_append(GTK_BOX(m_SettingsBox), m_ScanButton);
+    gtk_box_append(GTK_BOX(buttonBox), m_ScanButton);
 
     m_CancelButton = gtk_button_new_with_label(_("Cancel Scan"));
     ConnectGtkSignal(this, &App::OnCancelClicked, m_CancelButton, "clicked");
     gtk_widget_set_sensitive(m_CancelButton, false);
-    gtk_box_append(GTK_BOX(m_SettingsBox), m_CancelButton);
+    gtk_box_append(GTK_BOX(buttonBox), m_CancelButton);
+
+    auto bottomAlignedSection = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
+    gtk_widget_set_hexpand(bottomAlignedSection, true);
+    gtk_widget_set_vexpand(bottomAlignedSection, true);
+    gtk_widget_set_valign(bottomAlignedSection, GTK_ALIGN_END);
+    gtk_box_append(GTK_BOX(m_SettingsBox), bottomAlignedSection);
+
+    m_PresetPanel = ZooLib::View::Create<PresetPanel>(&m_Dispatcher, this);
+    auto presetsBox = m_PresetPanel->GetRootWidget();
+    gtk_widget_set_margin_bottom(presetsBox, 0);
+    gtk_widget_set_margin_top(presetsBox, 0);
+    gtk_widget_set_margin_start(presetsBox, 0);
+    gtk_widget_set_margin_end(presetsBox, 0);
+    gtk_box_append(GTK_BOX(bottomAlignedSection), presetsBox);
+    gtk_widget_set_hexpand(presetsBox, true);
 
     m_PreviewPanel = ZooLib::View::Create<PreviewPanel>(&m_Dispatcher, this);
     auto previewBox = m_PreviewPanel->GetRootWidget();
-    gtk_widget_set_margin_bottom(previewBox, 0);
+    gtk_widget_set_margin_bottom(previewBox, 10);
     gtk_widget_set_margin_top(previewBox, 0);
     gtk_widget_set_margin_start(previewBox, 10);
     gtk_widget_set_margin_end(previewBox, 0);
@@ -268,7 +291,7 @@ void ZooScan::App::Update(const std::vector<uint64_t> &lastSeenVersions)
         }
 
         gtk_box_remove(GTK_BOX(m_SettingsBox), m_ScanOptionsPanel->GetRootWidget());
-        // m_DeviceOptionsPanel is automatically deleted when its root widget is destroyed.
+        // m_ScanOptionsPanel is automatically deleted when its root widget is destroyed.
         m_ScanOptionsPanel = nullptr;
         m_Dispatcher.UnregisterHandler<SetScanAreaCommand>();
     }
@@ -315,18 +338,26 @@ void ZooScan::App::Update(const std::vector<uint64_t> &lastSeenVersions)
     }
 }
 
-const ZooScan::DeviceOptionsState *ZooScan::App::GetDeviceOptions() const
+ZooScan::DeviceOptionsState *ZooScan::App::GetDeviceOptions() const
 {
     if (m_ScanOptionsPanel == nullptr)
         return nullptr;
 
     return m_ScanOptionsPanel->GetDeviceOptionsState();
 }
 
-void ZooScan::App::RestoreScanOptions() const
+ZooScan::OutputOptionsState *ZooScan::App::GetOutputOptions()
+{
+    if (m_ScanOptionsPanel == nullptr)
+        return nullptr;
+
+    return m_ScanOptionsPanel->GetOutputOptionsState();
+}
+
+void ZooScan::App::RestoreScanOptions()
 {
     auto device = GetDevice();
-    const auto options = GetDeviceOptions();
+    auto options = GetDeviceOptions();
     if (device == nullptr || options == nullptr)
     {
         return;

App.hpp

@@ -12,6 +12,7 @@
 
 namespace ZooScan
 {
+    class PresetPanel;
     class FileWriter;
     class DeviceOptionsObserver;
     class ScanOptionsPanel;
@@ -33,6 +34,7 @@ namespace ZooScan
 
         ScanOptionsPanel *m_ScanOptionsPanel{};
         PreviewPanel *m_PreviewPanel{};
+        PresetPanel *m_PresetPanel{};
 
         GtkWidget *m_SettingsBox{};
 
@@ -74,7 +76,7 @@ namespace ZooScan
             {
                 return nullptr;
             }
-            return m_DeviceSelectorState->GetDeviceByName(m_AppState->GetOptionPanelDeviceName());
+            return m_DeviceSelectorState->GetDeviceByName(m_AppState->GetCurrentDeviceName());
         }
 
         [[nodiscard]] int GetScanHeight() const;
@@ -83,7 +85,7 @@ namespace ZooScan
 
         void OnPreviewClicked(GtkWidget *widget);
         void UpdatePreview();
-        void RestoreScanOptions() const;
+        void RestoreScanOptions();
         void StopPreview();
 
         bool CheckFileOutputOptions(const OutputOptionsState *scanOptions);
@@ -114,9 +116,9 @@ namespace ZooScan
             return m_AppState;
         }
 
-        [[nodiscard]] AppState *GetAppState()
+        [[nodiscard]] const DeviceSelectorState *GetDeviceSelectorState() const
         {
-            return m_AppState;
+            return m_DeviceSelectorState;
         }
 
         void Update(const std::vector<uint64_t> &lastSeenVersions);
@@ -131,6 +133,7 @@ namespace ZooScan
             return m_DeviceSelectorState->GetDeviceByName(deviceName);
         }
 
-        [[nodiscard]] const DeviceOptionsState *GetDeviceOptions() const;
+        [[nodiscard]] DeviceOptionsState *GetDeviceOptions() const;
+        [[nodiscard]] OutputOptionsState *GetOutputOptions();
     };
 }

AppState.hpp

@@ -16,7 +16,7 @@ namespace ZooScan
     private:
         const bool m_DevMode;
 
-        std::string m_OptionPanelDeviceName{};
+        std::string m_CurrentDeviceName{};
         AppMode m_AppMode{};
 
         bool m_IsScanning{};
@@ -29,13 +29,11 @@ namespace ZooScan
         {
         }
 
-        ~AppState() override
-        {
-        }
+        ~AppState() override = default;
 
-        [[nodiscard]] const std::string &GetOptionPanelDeviceName() const
+        [[nodiscard]] const std::string &GetCurrentDeviceName() const
         {
-            return m_OptionPanelDeviceName;
+            return m_CurrentDeviceName;
         }
 
         [[nodiscard]] AppMode GetAppMode() const
@@ -66,9 +64,13 @@ namespace ZooScan
             {
             }
 
-            void UpdateOptionPanelDeviceName(const std::string &deviceName) const
+            void LoadFromJson(const nlohmann::json &json) override
+            {
+            }
+
+            void SetCurrentDevice(const std::string &deviceName) const
             {
-                m_StateComponent->m_OptionPanelDeviceName = deviceName;
+                m_StateComponent->m_CurrentDeviceName = deviceName;
             }
 
             void SetAppMode(AppMode scanMode) const

CMakeLists.txt

@@ -59,25 +59,35 @@ set(SOURCE_FILES
         DeviceOptionsState.cpp
         DeviceSelectorState.cpp
         OptionRewriter.cpp
+        PresetCreateDialog.cpp
+        PresetPanel.cpp
+        PresetPanelState.cpp
         PreviewPanel.cpp
         ScanOptionsPanel.cpp
 
         Writers/FileWriter.cpp
         Writers/JpegWriter.cpp
         Writers/PngWriter.cpp
         Writers/TiffWriter.cpp
+        PresetRenameDialog.cpp
+        PresetViewDialog.cpp
 )
 
 set(GETTEXT_SOURCE_FILES
         ${SOURCE_FILES}
 
+        Commands/ApplyPresetCommand.hpp
         Commands/ChangeOptionCommand.hpp
+        Commands/CreatePresetCommand.hpp
+        Commands/DeletePresetCommand.hpp
         Commands/DeviceSelectorCommands.hpp
         Commands/DevMode/SetDumpSaneOptions.hpp
+        Commands/RenamePresetCommand.hpp
         Commands/SelectDeviceCommand.hpp
         Commands/SetCreateMissingDirectoriesCommand.hpp
         Commands/SetFileExistsActionCommand.hpp
         Commands/SetJpegQuality.hpp
+        Commands/SetPresetExpanded.hpp
         Commands/SetOutputDestinationCommand.hpp
         Commands/SetOutputDirectoryCommand.hpp
         Commands/SetOutputFileNameCommand.hpp
@@ -106,16 +116,20 @@ set(GETTEXT_SOURCE_FILES
         ZooLib/CommandDispatcher.hpp
         ZooLib/ErrorDialog.hpp
         ZooLib/Gettext.hpp
+        ZooLib/GtkUtils.hpp
         ZooLib/Observer.hpp
         ZooLib/ObserverManager.hpp
         ZooLib/SignalSupport.hpp
         ZooLib/State.hpp
         ZooLib/StateComponent.hpp
+        ZooLib/StringUtils.hpp
         ZooLib/View.hpp
 
         App.hpp
         AppState.hpp
+        CurrentDeviceObserver.hpp
         DeviceOptionsObserver.hpp
+        DeviceOptionsState.hpp
         DeviceOptionValueBase.hpp
         DeviceOptionValue.hpp
         DeviceSelector.hpp
@@ -125,6 +139,9 @@ set(GETTEXT_SOURCE_FILES
         OutputOptionsState.hpp
         Point.hpp
         PreferencesView.hpp
+        PresetPanel.hpp
+        PresetPanelDialogs.hpp
+        PresetPanelState.hpp
         PreviewPanel.hpp
         PreviewState.hpp
         Rect.hpp
@@ -136,6 +153,21 @@ set(GETTEXT_SOURCE_FILES
 
 if (GETTEXT_XGETTEXT_EXECUTABLE)
 
+    # Check that the GETTEXT_SOURCE_FILES are up to date with the files in the project.
+    file(GLOB_RECURSE GETTEXT_SOURCE_FILES_FROM_GLOB RELATIVE ${CMAKE_SOURCE_DIR} *.cpp *.hpp)
+    file(GLOB_RECURSE GETTEXT_EXCLUDED_SOURCE_FILES_FROM_GLOB RELATIVE ${CMAKE_SOURCE_DIR} Tests/* ZooLib/json/* cmake-*/*)
+    list(REMOVE_ITEM GETTEXT_SOURCE_FILES_FROM_GLOB ${GETTEXT_EXCLUDED_SOURCE_FILES_FROM_GLOB})
+
+    list(APPEND GETTEXT_SOURCE_FILES_DIFF ${GETTEXT_SOURCE_FILES_FROM_GLOB})
+    list(REMOVE_ITEM GETTEXT_SOURCE_FILES_DIFF ${GETTEXT_SOURCE_FILES})
+    list(LENGTH GETTEXT_SOURCE_FILES_DIFF GETTEXT_SOURCE_FILES_DIFF_LENGTH)
+    if (GETTEXT_SOURCE_FILES_DIFF_LENGTH GREATER 0)
+        message(STATUS "These files are missing from the GETTEXT_SOURCE_FILES:")
+        foreach (item IN LISTS GETTEXT_SOURCE_FILES_DIFF)
+            message(STATUS " ${item}")
+        endforeach()
+    endif()
+
     # Extract strings from JSON files: title, description and string_list. Make a list of them and remove empty strings.
     set(JQ_FILTER '[.options[].title,.options[].description,.options[].string_list[]] | map(select((. | length) > 0))')
 
@@ -199,7 +231,6 @@ if (GETTEXT_MSGMERGE_EXECUTABLE)
     message(TRACE " PO_FILES: ${PO_FILES}")
 
     foreach(PO_FILE IN ITEMS ${PO_FILES})
-        message(STATUS " Adding msgmerge for: ${PO_FILE}")
         add_custom_command(
                 TARGET pot-merge
                 PRE_BUILD
@@ -227,7 +258,6 @@ if (GETTEXT_MSGFMT_EXECUTABLE)
 
     foreach(PO_LANG IN ITEMS ${PO_LANGS})
         if(IS_DIRECTORY ${PO_LANG})
-            message(STATUS " Adding msgfmt for: ${PO_LANG}")
             add_custom_command(
                     TARGET po-compile
                     PRE_BUILD

Commands/ApplyPresetCommand.hpp

@@ -0,0 +1,51 @@
+#pragma once
+#include <string>
+
+
+#include "DeviceOptionsState.hpp"
+
+#include "OutputOptionsState.hpp"
+#include "PresetPanelState.hpp"
+#include "ZooLib/Command.hpp"
+
+namespace ZooScan
+{
+    class ApplyPresetCommand : public ZooLib::Command
+    {
+        const nlohmann::json *m_Preset;
+
+    public:
+        explicit ApplyPresetCommand(const nlohmann::json *preset)
+            : m_Preset(preset)
+        {
+        }
+
+        static void
+        Execute(const ApplyPresetCommand &command, DeviceOptionsState *deviceOptions, OutputOptionsState *outputOptions)
+        {
+            if (command.m_Preset == nullptr)
+            {
+                return;
+            }
+
+            if (command.m_Preset->contains(PresetPanelState::s_PresetSectionScannerSettings))
+            {
+                auto scannerSettings = command.m_Preset->at(PresetPanelState::s_PresetSectionScannerSettings);
+                auto deviceOptionsUpdater = DeviceOptionsState::Updater(deviceOptions);
+                deviceOptionsUpdater.ApplySettings(scannerSettings);
+            }
+            if (command.m_Preset->contains(PresetPanelState::s_PresetSectionScanArea))
+            {
+                auto scanAreaSettings = command.m_Preset->at(PresetPanelState::s_PresetSectionScanArea);
+                auto deviceOptionsUpdater = DeviceOptionsState::Updater(deviceOptions);
+                deviceOptionsUpdater.ApplyScanArea(scanAreaSettings);
+            }
+            if (command.m_Preset->contains(PresetPanelState::s_PresetSectionOutputSettings))
+            {
+                auto outputSettings = command.m_Preset->at(PresetPanelState::s_PresetSectionOutputSettings);
+                auto outputOptionsUpdater = OutputOptionsState::Updater(outputOptions);
+                // outputOptionsUpdater.ApplySettings(outputSettings);
+            }
+        }
+    };
+}

Commands/CreatePresetCommand.hpp

@@ -0,0 +1,26 @@
+#pragma once
+#include "PresetPanelState.hpp"
+#include "ZooLib/Command.hpp"
+#include "ZooLib/json/single_include/nlohmann/json.hpp"
+
+namespace ZooScan
+{
+
+    class CreatePresetCommand : public ZooLib::Command
+    {
+        nlohmann::json m_Preset{};
+
+    public:
+        explicit CreatePresetCommand(const nlohmann::json &j)
+            : m_Preset(j)
+        {
+        }
+
+        static void Execute(const CreatePresetCommand &command, PresetPanelState *state)
+        {
+            auto updater = PresetPanelState::Updater(state);
+            updater.AddPreset(command.m_Preset);
+        }
+    };
+
+}