[dlgs] Move the native FileDialog stuff to laf-dlgs library

Author: dacap

CMakeLists.txt

@@ -65,6 +65,7 @@ endif()
 add_subdirectory(third_party)
 add_subdirectory(base)
 add_subdirectory(gfx)
+add_subdirectory(dlgs)
 if(FREETYPE_LIBRARIES AND HARFBUZZ_LIBRARIES)
   add_subdirectory(ft)
 endif()

dlgs/CMakeLists.txt

@@ -0,0 +1,13 @@
+# laf-dlgs
+# Copyright (C) 2024  Igara Studio S.A.
+
+add_library(laf-dlgs file_dialog.cpp)
+target_link_libraries(laf-dlgs laf-base)
+
+if(WIN32)
+  target_sources(laf-dlgs PRIVATE file_dialog_win.cpp)
+elseif(APPLE)
+  target_sources(laf-dlgs PRIVATE file_dialog_osx.mm)
+else()
+  target_sources(laf-dlgs PRIVATE file_dialog_x11.cpp)
+endif()

dlgs/file_dialog.cpp

@@ -0,0 +1,53 @@
+// laf-dlgs
+// Copyright (C) 2020-2024  Igara Studio S.A.
+// Copyright (C) 2017  David Capello
+//
+// This file is released under the terms of the MIT license.
+// Read LICENSE.txt for more information.
+
+#ifdef HAVE_CONFIG_H
+  #include "config.h"
+#endif
+
+#include "dlgs/file_dialog.h"
+
+namespace dlgs {
+
+void FileDialog::setType(const Type type)
+{
+  m_type = type;
+}
+
+void FileDialog::setTitle(const std::string& title)
+{
+  m_title = title;
+}
+
+void FileDialog::setDefaultExtension(const std::string& extension)
+{
+  m_defExtension = extension;
+}
+
+void FileDialog::addFilter(const std::string& extension,
+                           const std::string& description)
+{
+  if (m_defExtension.empty())
+    m_defExtension = extension;
+
+  m_filters.push_back(std::make_pair(extension, description));
+}
+
+FileDialogRef FileDialog::make(const Spec& spec)
+{
+#if LAF_WINDOWS
+  return FileDialog::makeWin(spec);
+#elif LAF_MACOS
+  return FileDialog::makeOSX(spec);
+#elif LAF_LINUX
+  return FileDialog::makeX11(spec);
+#else
+  return nullptr;
+#endif
+}
+
+}  // namespace dlgs

dlgs/file_dialog.h

@@ -0,0 +1,92 @@
+// laf-dlgs
+// Copyright (c) 2020-2024  Igara Studio S.A.
+// Copyright (c) 2015-2018  David Capello
+//
+// This file is released under the terms of the MIT license.
+// Read LICENSE.txt for more information.
+
+#ifndef DLGS_FILE_DIALOG_H_INCLUDED
+#define DLGS_FILE_DIALOG_H_INCLUDED
+#pragma once
+
+#include "base/paths.h"
+#include "base/ref.h"
+
+#include <string>
+#include <utility>
+#include <vector>
+
+namespace dlgs {
+class FileDialog;
+using FileDialogRef = base::Ref<FileDialog>;
+
+class FileDialog : public base::RefCount {
+public:
+  enum class Type {
+    OpenFile,
+    OpenFiles,
+    OpenFolder,
+    SaveFile,
+  };
+
+  enum class Result {
+    Error = -1,  // This happens when we cannot open the native dialog
+    Cancel = 0,  // The user canceled the dialog
+    OK = 1,      // The user selected some file(s)
+  };
+
+  struct Spec {
+#if LAF_MACOS
+    // Indicates which is the "Edit" menu (NSMenuItem*) with
+    // Undo/Redo/Cut/Copy/Paste/etc. commands. Used by the
+    // FileDialogOSX impl to completely replace the "Edit" menu with a
+    // standard one to make these
+    // Undo/Redo/Cut/Copy/Paste/etc. keyboard shortcuts work.
+    //
+    // The specific details are not beautiful or important, but you
+    // can search for "OSXEditMenuHack" to know why this is needed.
+    void* editNSMenuItem = nullptr;
+#endif
+
+#if LAF_LINUX
+    // Connection to the X11 server (the Display* pointer returned by
+    // XOpenDisplay()).
+    void* x11display = nullptr;
+#endif
+  };
+
+  static FileDialogRef make(const Spec& spec);
+#if LAF_WINDOWS
+  static FileDialogRef makeWin(const Spec& spec);
+#elif LAF_MACOS
+  static FileDialogRef makeOSX(const Spec& spec);
+#elif LAF_LINUX
+  static FileDialogRef makeX11(const Spec& spec);
+#endif
+
+  virtual ~FileDialog() { }
+
+  void setType(const Type type);
+  void setTitle(const std::string& title);
+  void setDefaultExtension(const std::string& extension);
+  void addFilter(const std::string& extension,
+                 const std::string& description);
+
+  virtual std::string fileName() = 0;
+  virtual void getMultipleFileNames(base::paths& output) = 0;
+  virtual void setFileName(const std::string& filename) = 0;
+
+  // The native window handle is an HWND on Windows, a NSWindow* on
+  // macOS, or an X11 Window on Linux.
+  virtual Result show(void* windowNative) = 0;
+
+protected:
+  Type m_type = Type::OpenFile;
+  std::string m_title;
+  std::string m_defExtension;
+  std::vector<std::pair<std::string, std::string>> m_filters;
+};
+
+}  // namespace dlgs
+
+#endif

os/osx/native_dialogs.mm renamed to dlgs/file_dialog_osx.mm

@@ -1,5 +1,5 @@
-// LAF OS Library
-// Copyright (C) 2020-2022  Igara Studio S.A.
+// laf-dlgs
+// Copyright (C) 2020-2024  Igara Studio S.A.
 // Copyright (C) 2012-2018  David Capello
 //
 // This file is released under the terms of the MIT license.
@@ -8,12 +8,9 @@
 #include <Cocoa/Cocoa.h>
 #include <vector>
 
+#include "dlgs/file_dialog.h"
+
 #include "base/fs.h"
-#include "os/common/file_dialog.h"
-#include "os/keys.h"
-#include "os/native_cursor.h"
-#include "os/osx/native_dialogs.h"
-#include "os/window.h"
 
 #include <map>
 
@@ -26,22 +23,23 @@
 // etc.
 //
 // So what we have to do if the main menu doesn't provide the standard
-// Edit selectors? (which is our case with our MenuItemOSX and MenuOSX
-// implementations):
+// "Edit" selectors? Which can be our case with laf-os MenuItemOSX and
+// MenuOSX implementations:
 //
-// 1. Before we open the NSSavePanel, find the Edit menu that was
-//    specified by the user with os::MenuItem::setAsStandardEditMenuItem()
-// 2. Replace the Edit menu with a custom made one with the
-//    standard Edit menu prepared especially with selectors
-//    (undo:, redo:, cut:, etc.)
+// 1. Before we open the NSSavePanel, this class receives the current
+//    "Edit" menu that was specified by the user from
+//    FileDialog::Spec::editNSMenuItem.
+// 2. Replaces the "Edit" menu with a custom made one with the
+//    standard Edit menu prepared especially with selectors (undo:,
+//    redo:, cut:, etc.)
 // 3. Each menu item that contains a standard keyboard shortcut
 //    (Command+C, Command+V, etc.) must be modified, because those
 //    shortcuts are now used by this new Edit menu. So we remove the
 //    keyEquivalent of each one. This is necessary only when one of
 //    those items are outside the replaced Edit menu (e.g. if we have
 //    Command+A to select all in other menu like Select > All, instead
 //    of Edit > Select All)
-// 4. After the NSSavePanel is closed, we restore all keyEquivalent
+// 4. After the NSSavePanel is closed, it restores all keyEquivalent
 //    shortcuts and the old Edit menu.
 //
 class OSXEditMenuHack {
@@ -121,20 +119,16 @@ void disableMenuItemsWithKeyEquivalent(NSMenu* menu,
 
 } // anonymous namespace
 
-namespace os {
-extern NSMenuItem* g_standardEditMenuItem;
-}
-
 @interface OpenSaveHelper : NSObject {
 @private
   NSSavePanel* panel;
-  os::Window* window;
+  NSWindow* window;
   int result;
   std::function<void()> fileTypeChangeObserver;
 }
 - (id)init;
 - (void)setPanel:(NSSavePanel*)panel;
-- (void)setWindow:(os::Window*)window;
+- (void)setWindow:(NSWindow*)window;
 - (void)runModal;
 - (int)result;
 - (void)fileTypeChange;
@@ -146,6 +140,8 @@ @implementation OpenSaveHelper
 - (id)init
 {
   if (self = [super init]) {
+    panel = nil;
+    window = nil;
     result = NSFileHandlingPanelCancelButton;
   }
   return self;
@@ -156,18 +152,14 @@ - (void)setPanel:(NSSavePanel*)newPanel
   panel = newPanel;
 }
 
-- (void)setWindow:(os::Window*)newWindow
+- (void)setWindow:(NSWindow*)newWindow
 {
   window = newWindow;
 }
 
 // This is executed in the main thread.
 - (void)runModal
 {
-  os::NativeCursor oldCursor = window->nativeCursor();
-  window->setCursor(os::NativeCursor::Arrow);
-
-  OSXEditMenuHack hack(os::g_standardEditMenuItem);
   [[[NSApplication sharedApplication] mainMenu] setAutoenablesItems:NO];
 
 #ifndef __MAC_10_6              // runModalForTypes is deprecated in 10.6
@@ -184,10 +176,11 @@ - (void)runModal
     result = [panel runModal];
   }
 
-  window->setCursor(oldCursor);
-  NSWindow* nsWindow = (__bridge NSWindow *)window->nativeHandle();
-  [nsWindow makeKeyAndOrderFront:nil];
   [[[NSApplication sharedApplication] mainMenu] setAutoenablesItems:YES];
+
+  // Re-active the parent key window.
+  if (window)
+    [window makeKeyAndOrderFront:nil];
 }
 
 - (int)result
@@ -208,11 +201,13 @@ - (void)setFileTypeChangeObserver:(std::function<void()>)observer
 
 @end
 
-namespace os {
+namespace dlgs {
 
-class FileDialogOSX : public CommonFileDialog {
+class FileDialogOSX : public FileDialog {
 public:
-  FileDialogOSX() {
+  FileDialogOSX(const Spec& spec) {
+    if (spec.editNSMenuItem)
+      m_editMenuItem = (__bridge NSMenuItem*)spec.editNSMenuItem;
   }
 
   std::string fileName() override {
@@ -227,7 +222,7 @@ void setFileName(const std::string& filename) override {
     m_filename = filename;
   }
 
-  Result show(Window* window) override {
+  Result show(void* window) override {
     Result retValue = Result::Cancel;
     @autoreleasepool {
       NSSavePanel* panel = nil;
@@ -282,7 +277,8 @@ Result show(Window* window) override {
 
       OpenSaveHelper* helper = [OpenSaveHelper new];
       [helper setPanel:panel];
-      [helper setWindow:window];
+      if (window)
+        [helper setWindow:(__bridge NSWindow*)window];
 
       // Configure the file type popup/combobox.
       if (m_popup) {
@@ -323,7 +319,10 @@ Result show(Window* window) override {
         }];
       }
 
-      [helper performSelectorOnMainThread:@selector(runModal) withObject:nil waitUntilDone:YES];
+      {
+        OSXEditMenuHack hack(m_editMenuItem);
+        [helper performSelectorOnMainThread:@selector(runModal) withObject:nil waitUntilDone:YES];
+      }
 
       if ([helper result] == NSFileHandlingPanelOKButton) {
         if (m_type == Type::OpenFiles) {
@@ -385,15 +384,14 @@ Result show(Window* window) override {
   // easily (configuring its target/action properties + accessing its
   // selected item).
   NSPopUpButton* m_popup = nullptr;
-};
 
-NativeDialogsOSX::NativeDialogsOSX()
-{
-}
+  // Pointer to the "Edit" menu used with OSXEditMenuHack.
+  NSMenuItem* m_editMenuItem = nullptr;
+};
 
-FileDialogRef NativeDialogsOSX::makeFileDialog()
+FileDialogRef FileDialog::makeOSX(const Spec& spec)
 {
-  return make_ref<FileDialogOSX>();
+  return base::make_ref<FileDialogOSX>(spec);
 }
 
-} // namespace os
+} // namespace dlgs