New feature: Accept native parent window handle (#136)

This is necessary for platforms to present the dialog properly, e.g. ensuring that the dialog never goes behind the parent window.

Author: btzy

.github/workflows/cmake.yml

@@ -29,7 +29,7 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v2
-    - name: Installing Dependencies
+    - name: Install Dependencies
       run: sudo apt-get update && sudo apt-get install dos2unix
     - name: Convert to Unix line endings
       run: dos2unix */*
@@ -72,7 +72,7 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v2
-    - name: Installing Dependencies
+    - name: Install Dependencies
       run: sudo apt-get update && sudo apt-get install ${{ matrix.portal.dep }}
     - name: Configure
       run: mkdir build && mkdir install && cd build && cmake -DCMAKE_INSTALL_PREFIX="../install" -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=${{ matrix.compiler.c }} -DCMAKE_CXX_COMPILER=${{ matrix.compiler.cpp }} -DCMAKE_CXX_STANDARD=${{ matrix.cppstd }} -DCMAKE_C_FLAGS="-Wall -Wextra -Werror -pedantic" -DCMAKE_CXX_FLAGS="-Wall -Wextra -Werror -pedantic" -DNFD_PORTAL=${{ matrix.portal.flag }} -DNFD_APPEND_EXTENSION=${{ matrix.autoappend.flag }} -DBUILD_SHARED_LIBS=${{ matrix.shared_lib.flag }} -DNFD_BUILD_TESTS=ON ..
@@ -189,3 +189,75 @@ jobs:
         path: |
           build/src/*
           build/test/*
+
+  build-ubuntu-sdl2:
+
+    name: Ubuntu latest - GCC, ${{ matrix.portal.name }}, Static, SDL2
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        portal: [ {flag: OFF, dep: libgtk-3-dev, name: GTK}, {flag: ON, dep: libdbus-1-dev, name: Portal} ] # The NFD_PORTAL setting defaults to OFF (i.e. uses GTK)
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install Dependencies
+      run: sudo apt-get update && sudo apt-get install ${{ matrix.portal.dep }} libsdl2-dev libsdl2-ttf-dev
+    - name: Configure
+      run: mkdir build && mkdir install && cd build && cmake -DCMAKE_INSTALL_PREFIX="../install" -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS="-Wall -Wextra -Werror -pedantic" -DCMAKE_CXX_FLAGS="-Wall -Wextra -Werror -pedantic" -DNFD_PORTAL=${{ matrix.portal.flag }} -DNFD_APPEND_EXTENSION=OFF -DNFD_BUILD_TESTS=OFF -DNFD_BUILD_SDL2_TESTS=ON ..
+    - name: Build
+      run: cmake --build build --target install
+    - name: Upload test binaries
+      uses: actions/upload-artifact@v2
+      with:
+        name: Ubuntu latest - GCC, ${{ matrix.portal.name }}, Static, SDL2
+        path: |
+          build/src/*
+          build/test/*
+
+  build-macos-sdl2:
+
+    name: MacOS latest - Clang, Static, SDL2
+    runs-on: macos-latest
+    
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install Dependencies
+      run: brew install sdl2 sdl2_ttf
+    - name: Configure
+      run: mkdir build && mkdir install && cd build && cmake -DCMAKE_INSTALL_PREFIX="../install" -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS="-Wall -Wextra -Werror -pedantic" -DCMAKE_CXX_FLAGS="-Wall -Wextra -Werror -pedantic" -DNFD_BUILD_TESTS=OFF -DNFD_BUILD_SDL2_TESTS=ON ..
+    - name: Build
+      run: cmake --build build --target install
+    - name: Upload test binaries
+      uses: actions/upload-artifact@v2
+      with:
+        name: MacOS latest - Clang, Static, SDL2
+        path: |
+          build/src/*
+          build/test/*
+
+  build-windows-sdl2:
+
+    name: Windows latest - MSVC, Static, SDL2
+    runs-on: windows-latest
+    
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install pkgconfiglite
+      run: choco install pkgconfiglite
+    - name: Install Dependencies
+      run: vcpkg integrate install && vcpkg install sdl2 sdl2-ttf --triplet=x64-windows-release
+    - name: Configure
+      run: mkdir build && mkdir install && cd build && cmake -DCMAKE_INSTALL_PREFIX="../install" -DCMAKE_TOOLCHAIN_FILE="C:/vcpkg/scripts/buildsystems/vcpkg.cmake" -DVCPKG_TARGET_TRIPLET="x64-windows-release" -DNFD_BUILD_TESTS=OFF -DNFD_BUILD_SDL2_TESTS=ON ..
+    - name: Build
+      run: cmake --build build --target install --config Release
+    - name: Upload test binaries
+      uses: actions/upload-artifact@v2
+      with:
+        name: Windows latest - MSVC, Static, SDL2
+        path: |
+          build/src/Release/*
+          build/test/Release/*

CMakeLists.txt

@@ -8,6 +8,7 @@ endif ()
 
 option(BUILD_SHARED_LIBS "Build a shared library instead of static" OFF)
 option(NFD_BUILD_TESTS "Build tests for nfd" ${nfd_ROOT_PROJECT})
+option(NFD_BUILD_SDL2_TESTS "Build SDL2 tests for nfd" OFF)
 option(NFD_INSTALL "Generate install target for nfd" ${nfd_ROOT_PROJECT})
 
 set(nfd_PLATFORM Undefined)
@@ -48,6 +49,6 @@ endif()
 
 add_subdirectory(src)
 
-if(${NFD_BUILD_TESTS})
+if(${NFD_BUILD_TESTS} OR ${NFD_BUILD_SDL2_TESTS})
   add_subdirectory(test)
 endif()

src/CMakeLists.txt

@@ -2,7 +2,9 @@ set(TARGET_NAME nfd)
 
 set(PUBLIC_HEADER_FILES
   include/nfd.h
-  include/nfd.hpp)
+  include/nfd.hpp
+  include/nfd_sdl2.h
+  include/nfd_glfw3.h)
 
 set(SOURCE_FILES ${PUBLIC_HEADER_FILES})
 

src/include/nfd.h

@@ -96,19 +96,39 @@ typedef struct {
 typedef nfdu8filteritem_t nfdnfilteritem_t;
 #endif  // _WIN32
 
+// The native window handle type.
+enum {
+    NFD_WINDOW_HANDLE_TYPE_UNSET = 0,
+    // Windows: handle is HWND (the Windows API typedefs this to void*)
+    NFD_WINDOW_HANDLE_TYPE_WINDOWS = 1,
+    // Cocoa: handle is NSWindow*
+    NFD_WINDOW_HANDLE_TYPE_COCOA = 2,
+    // X11: handle is Window
+    NFD_WINDOW_HANDLE_TYPE_X11 = 3,
+    // Wayland support will be implemented separately in the future
+};
+// The native window handle.  If using a platform abstraction framework (e.g. SDL2), this should be
+// obtained using the corresponding NFD glue header (e.g. nfd_sdl2.h).
+typedef struct {
+    size_t type;  // this is one of the values of the enum above
+    void* handle;
+} nfdwindowhandle_t;
+
 typedef size_t nfdversion_t;
 
 typedef struct {
     const nfdu8filteritem_t* filterList;
     nfdfiltersize_t filterCount;
     const nfdu8char_t* defaultPath;
+    nfdwindowhandle_t parentWindow;
 } nfdopendialogu8args_t;
 
 #ifdef _WIN32
 typedef struct {
     const nfdnfilteritem_t* filterList;
     nfdfiltersize_t filterCount;
     const nfdnchar_t* defaultPath;
+    nfdwindowhandle_t parentWindow;
 } nfdopendialognargs_t;
 #else
 typedef nfdopendialogu8args_t nfdopendialognargs_t;
@@ -119,6 +139,7 @@ typedef struct {
     nfdfiltersize_t filterCount;
     const nfdu8char_t* defaultPath;
     const nfdu8char_t* defaultName;
+    nfdwindowhandle_t parentWindow;
 } nfdsavedialogu8args_t;
 
 #ifdef _WIN32
@@ -127,18 +148,21 @@ typedef struct {
     nfdfiltersize_t filterCount;
     const nfdnchar_t* defaultPath;
     const nfdnchar_t* defaultName;
+    nfdwindowhandle_t parentWindow;
 } nfdsavedialognargs_t;
 #else
 typedef nfdsavedialogu8args_t nfdsavedialognargs_t;
 #endif  // _WIN32
 
 typedef struct {
     const nfdu8char_t* defaultPath;
+    nfdwindowhandle_t parentWindow;
 } nfdpickfolderu8args_t;
 
 #ifdef _WIN32
 typedef struct {
     const nfdnchar_t* defaultPath;
+    nfdwindowhandle_t parentWindow;
 } nfdpickfoldernargs_t;
 #else
 typedef nfdpickfolderu8args_t nfdpickfoldernargs_t;