hyprwm · Jan 6, 2024 · Jan 7, 2024 · Jan 7, 2024 · Jan 7, 2024 · Jan 7, 2024
diff --git a/.github/workflows/nix-build.yaml b/.github/workflows/nix-build.yaml
@@ -8,14 +8,9 @@ jobs:
     steps:
     - name: Clone repository
       uses: actions/checkout@v3
-      with:
-        submodules: recursive
-    - name: Install nix
-      uses: cachix/install-nix-action@v17
-      with:
-        install_url: https://releases.nixos.org/nix/nix-2.10.3/install
-        extra_nix_config: |
-          auto-optimise-store = true
-          experimental-features = nix-command flakes
+
+    - uses: cachix/install-nix-action@v27
+    - uses: DeterminateSystems/magic-nix-cache-action@main
+
     - name: Build xdg-desktop-portal-hyprland
-      run: nix build --print-build-logs
+      run: nix build --print-build-logs --extra-substituters "https://hyprland.cachix.org"
diff --git a/.gitignore b/.gitignore
@@ -51,14 +51,21 @@ Module.symvers
 Mkfile.old
 dkms.conf
 
-# build folder
+# Build folders
 build/
 build-*/
+hyprland-share-picker/build/
 
-.cache
-.vscode/
+# Generated code files
+protocols/*.c*
+protocols/*.h*
 
-hyprland-share-picker/build/
+# Nix build results
+result
+result-man
 
-protocols/*.c
-protocols/*.h
+# Code editors
+.vscode/
+
+# MISCELLANEOUS
+.cache
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,105 +3,148 @@ cmake_minimum_required(VERSION 3.19)
 file(READ ${CMAKE_CURRENT_SOURCE_DIR}/VERSION VER)
 string(STRIP ${VER} VER)
 
-project(xdg-desktop-portal-hyprland
-    DESCRIPTION "An XDG-Destop-Portal backend for Hyprland (and wlroots)"
-    VERSION ${VER}
-)
+project(
+  xdg-desktop-portal-hyprland
+  DESCRIPTION "An XDG-Destop-Portal backend for Hyprland (and wlroots)"
+  VERSION ${VER})
 
 set(CMAKE_MESSAGE_LOG_LEVEL "STATUS")
+set(SYSTEMD_SERVICES
+    ON
+    CACHE BOOL "Install systemd service file")
 
 if(CMAKE_BUILD_TYPE MATCHES Debug OR CMAKE_BUILD_TYPE MATCHES DEBUG)
-    message(STATUS "Configuring XDPH in Debug with CMake")
-    add_compile_definitions(HYPRLAND_DEBUG)
+  message(STATUS "Configuring XDPH in Debug with CMake")
+  add_compile_definitions(HYPRLAND_DEBUG)
 else()
-    add_compile_options(-O3)
-    message(STATUS "Configuring XDPH in Release with CMake")
+  add_compile_options(-O3)
+  message(STATUS "Configuring XDPH in Release with CMake")
 endif()
 
-include_directories(
-  .
-  "protocols/"
-)
+add_compile_definitions(XDPH_VERSION="${VER}")
+
+include_directories(. "protocols/")
 
 # configure
 include(GNUInstallDirs)
 set(LIBEXECDIR ${CMAKE_INSTALL_FULL_LIBEXECDIR})
-configure_file(org.freedesktop.impl.portal.desktop.hyprland.service.in org.freedesktop.impl.portal.desktop.hyprland.service @ONLY)
-configure_file(contrib/systemd/xdg-desktop-portal-hyprland.service.in contrib/systemd/xdg-desktop-portal-hyprland.service @ONLY)
+configure_file(org.freedesktop.impl.portal.desktop.hyprland.service.in
+               org.freedesktop.impl.portal.desktop.hyprland.service @ONLY)
+if(SYSTEMD_SERVICES)
+  configure_file(contrib/systemd/xdg-desktop-portal-hyprland.service.in
+                 contrib/systemd/xdg-desktop-portal-hyprland.service @ONLY)
+endif()
 
 set(CMAKE_CXX_STANDARD 23)
-add_compile_options(-Wall -Wextra -Wno-unused-parameter -Wno-unused-value
-	-Wno-missing-field-initializers -Wno-narrowing -Wno-pointer-arith
-	-fpermissive -Wno-address-of-temporary)
+add_compile_options(
+  -Wall
+  -Wextra
+  -Wno-unused-parameter
+  -Wno-unused-value
+  -Wno-missing-field-initializers
+  -Wno-narrowing
+  -Wno-pointer-arith
+  $<$<COMPILE_LANG_AND_ID:CXX,GNU>:-fpermissive>
+  -Wno-address-of-temporary)
 
 # dependencies
 message(STATUS "Checking deps...")
 add_subdirectory(hyprland-share-picker)
 
 find_package(Threads REQUIRED)
 find_package(PkgConfig REQUIRED)
-pkg_check_modules(deps REQUIRED IMPORTED_TARGET wayland-client wayland-protocols libpipewire-0.3 libspa-0.2 libdrm gbm hyprlang>=0.2.0)
+pkg_check_modules(
+  deps
+  REQUIRED
+  IMPORTED_TARGET
+  wayland-client
+  wayland-protocols
+  libpipewire-0.3>=1.1.82
+  libspa-0.2
+  libdrm
+  gbm
+  hyprlang>=0.2.0
+  hyprutils>=0.2.6
+  hyprwayland-scanner>=0.4.2)
 
 # check whether we can find sdbus-c++ through pkg-config
-pkg_check_modules(SDBUS IMPORTED_TARGET sdbus-c++)
+pkg_check_modules(SDBUS IMPORTED_TARGET sdbus-c++>=2.0.0)
 if(NOT SDBUS_FOUND)
-    include_directories("subprojects/sdbus-cpp/include/")
-    add_subdirectory(subprojects/sdbus-cpp)
-    add_library(PkgConfig::SDBUS ALIAS sdbus-c++)
+  include_directories("subprojects/sdbus-cpp/include/")
+  add_subdirectory(subprojects/sdbus-cpp EXCLUDE_FROM_ALL)
+  add_library(PkgConfig::SDBUS ALIAS sdbus-c++)
 endif()
 
 # same for hyprland-protocols
 pkg_check_modules(HYPRLAND_PROTOS IMPORTED_TARGET hyprland-protocols)
 if(HYPRLAND_PROTOS_FOUND)
-    set(HYPRLAND_PROTOCOLS "${HYPRLAND_PROTOS_PREFIX}/share/hyprland-protocols")
+  set(HYPRLAND_PROTOCOLS "${HYPRLAND_PROTOS_PREFIX}/share/hyprland-protocols")
 else()
-    set(HYPRLAND_PROTOCOLS "subprojects/hyprland-protocols")
+  set(HYPRLAND_PROTOCOLS "${CMAKE_SOURCE_DIR}/subprojects/hyprland-protocols")
 endif()
 
 file(GLOB_RECURSE SRCFILES CONFIGURE_DEPENDS "src/*.cpp")
 add_executable(xdg-desktop-portal-hyprland ${SRCFILES})
-target_link_libraries(xdg-desktop-portal-hyprland PRIVATE rt PkgConfig::SDBUS Threads::Threads PkgConfig::deps)
+target_link_libraries(
+  xdg-desktop-portal-hyprland PRIVATE rt PkgConfig::SDBUS Threads::Threads
+                                      PkgConfig::deps)
 
 # protocols
-find_program(WaylandScanner NAMES wayland-scanner)
-message(STATUS "Found WaylandScanner at ${WaylandScanner}")
-execute_process(
-    COMMAND pkg-config --variable=pkgdatadir wayland-protocols
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-    OUTPUT_VARIABLE WAYLAND_PROTOCOLS_DIR
-    OUTPUT_STRIP_TRAILING_WHITESPACE)
+pkg_get_variable(WAYLAND_PROTOCOLS_DIR wayland-protocols pkgdatadir)
 message(STATUS "Found wayland-protocols at ${WAYLAND_PROTOCOLS_DIR}")
-
-function(protocol protoPath protoName external)
-    if (external)
-        execute_process(
-            COMMAND ${WaylandScanner} client-header ${protoPath} protocols/${protoName}-protocol.h
-            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
-        execute_process(
-            COMMAND ${WaylandScanner} private-code ${protoPath} protocols/${protoName}-protocol.c
-            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
-        target_sources(xdg-desktop-portal-hyprland PRIVATE protocols/${protoName}-protocol.c)
-    else()
-        execute_process(
-            COMMAND ${WaylandScanner} client-header ${WAYLAND_PROTOCOLS_DIR}/${protoPath} protocols/${protoName}-protocol.h
-            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
-        execute_process(
-            COMMAND ${WaylandScanner} private-code ${WAYLAND_PROTOCOLS_DIR}/${protoPath} protocols/${protoName}-protocol.c
-            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
-        target_sources(xdg-desktop-portal-hyprland PRIVATE protocols/${protoName}-protocol.c)
-    endif()
+pkg_get_variable(WAYLAND_SCANNER_DIR wayland-scanner pkgdatadir)
+message(STATUS "Found wayland-scanner at ${WAYLAND_SCANNER_DIR}")
+
+function(protocolnew protoPath protoName external)
+  if(external)
+    set(path ${protoPath})
+  else()
+    set(path ${WAYLAND_PROTOCOLS_DIR}/${protoPath})
+  endif()
+  add_custom_command(
+    OUTPUT ${CMAKE_SOURCE_DIR}/protocols/${protoName}.cpp
+           ${CMAKE_SOURCE_DIR}/protocols/${protoName}.hpp
+    COMMAND hyprwayland-scanner --client ${path}/${protoName}.xml
+            ${CMAKE_SOURCE_DIR}/protocols/
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
+  target_sources(xdg-desktop-portal-hyprland PRIVATE protocols/${protoName}.cpp
+                                                     protocols/${protoName}.hpp)
+endfunction()
+function(protocolWayland)
+  add_custom_command(
+    OUTPUT ${CMAKE_SOURCE_DIR}/protocols/wayland.cpp
+           ${CMAKE_SOURCE_DIR}/protocols/wayland.hpp
+    COMMAND hyprwayland-scanner --wayland-enums --client
+            ${WAYLAND_SCANNER_DIR}/wayland.xml ${CMAKE_SOURCE_DIR}/protocols/
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
+  target_sources(xdg-desktop-portal-hyprland PRIVATE protocols/wayland.cpp
+                                                     protocols/wayland.hpp)
 endfunction()
 
-protocol("protocols/wlr-foreign-toplevel-management-unstable-v1.xml" "wlr-foreign-toplevel-management-unstable-v1" true)
-protocol("protocols/wlr-screencopy-unstable-v1.xml" "wlr-screencopy-unstable-v1" true)
-protocol("${HYPRLAND_PROTOCOLS}/protocols/hyprland-global-shortcuts-v1.xml" "hyprland-global-shortcuts-v1" true)
-protocol("${HYPRLAND_PROTOCOLS}/protocols/hyprland-toplevel-export-v1.xml" "hyprland-toplevel-export-v1" true)
-protocol("unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml" "linux-dmabuf-unstable-v1" false)
+protocolwayland()
+
+protocolnew("${CMAKE_SOURCE_DIR}/protocols"
+            "wlr-foreign-toplevel-management-unstable-v1" true)
+protocolnew("${CMAKE_SOURCE_DIR}/protocols" "wlr-screencopy-unstable-v1" true)
+protocolnew("${HYPRLAND_PROTOCOLS}/protocols" "hyprland-global-shortcuts-v1"
+            true)
+protocolnew("${HYPRLAND_PROTOCOLS}/protocols" "hyprland-toplevel-export-v1"
+            true)
+protocolnew("stable/linux-dmabuf" "linux-dmabuf-v1" false)
 
 # Installation
 install(TARGETS hyprland-share-picker)
-install(TARGETS xdg-desktop-portal-hyprland DESTINATION ${CMAKE_INSTALL_LIBEXECDIR})
-
-install(FILES hyprland.portal DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/xdg-desktop-portal/portals")
-install(FILES ${CMAKE_BINARY_DIR}/org.freedesktop.impl.portal.desktop.hyprland.service DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/dbus-1/services")
-install(FILES ${CMAKE_BINARY_DIR}/contrib/systemd/xdg-desktop-portal-hyprland.service DESTINATION "${CMAKE_INSTALL_LIBDIR}/systemd/user")
+install(TARGETS xdg-desktop-portal-hyprland
+        DESTINATION ${CMAKE_INSTALL_LIBEXECDIR})
+
+install(FILES hyprland.portal
+        DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/xdg-desktop-portal/portals")
+install(
+  FILES ${CMAKE_BINARY_DIR}/org.freedesktop.impl.portal.desktop.hyprland.service
+  DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/dbus-1/services")
+if(SYSTEMD_SERVICES)
+  install(
+    FILES
+      ${CMAKE_BINARY_DIR}/contrib/systemd/xdg-desktop-portal-hyprland.service
+    DESTINATION "lib/systemd/user")
+endif()
diff --git a/README.md b/README.md
@@ -11,6 +11,8 @@ First, make sure to install the required dependencies:
 gbm
 hyprland-protocols
 hyprlang
+hyprutils
+hyprwayland-scanner
 libdrm
 libpipewire-0.3
 libspa-0.2
@@ -24,11 +26,29 @@ Then run the build and install command:
 ```sh
 git clone --recursive https://github.com/hyprwm/xdg-desktop-portal-hyprland
 cd xdg-desktop-portal-hyprland/
-cmake -DCMAKE_INSTALL_LIBEXECDIR=/usr/lib -B build
-cmake --install /usr
+cmake -DCMAKE_INSTALL_LIBEXECDIR=/usr/lib -DCMAKE_INSTALL_PREFIX=/usr -B build
+cmake --build build
+sudo cmake --install build
 ```
 
+## Nix
+
+> [!CAUTION]
+> XDPH should not be used from this flake directly!
+> 
+> Instead, use it from the [Hyprland flake](https://github.com/hyprwm/Hyprland).
+
+There are two reasons for the above:
+
+1. Hyprland depends on XDPH, but XDPH also depends on Hyprland. This results in
+   a cyclic dependency, which is a nightmare. To counter this, we use the
+   Nixpkgs Hyprland package in this flake, so that it can be later consumed by
+   the Hyprland flake while overriding the Hyprland package.
+2. Even if you manually do all the overriding, you may still get it wrong and
+   lose out on the Cachix cache (which has XDPH as exposed by the Hyprland
+   flake).
+
 ## Running, FAQs, etc.
 
 See
-[the Hyprland wiki](https://wiki.hyprland.org/Useful-Utilities/Hyprland-desktop-portal)
+[the Hyprland wiki](https://wiki.hyprland.org/Hypr-Ecosystem/xdg-desktop-portal-hyprland/)
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.3.1
+1.3.9