Plugin header overhaul (#2087)

* meson: install headers

* Meson/CMake: add pkg-config file for headers

* makefile: install headers and pkgconfig

* CMake: move protocols to cmake

Co-authored-by: Ching Pei Yang <badnam3o.0@gmail.com>

---------

Co-authored-by: Mihai Fufezan <fufexan@protonmail.com>
Co-authored-by: vaxerski <43317083+vaxerski@users.noreply.github.com>

CMakeLists.txt

@@ -10,6 +10,10 @@ project(Hyprland
     VERSION ${VER}
 )
 
+set(HYPRLAND_VERSION ${VER})
+set(PREFIX ${CMAKE_INSTALL_PREFIX})
+configure_file(hyprland.pc.in hyprland.pc @ONLY) 
+
 set(CMAKE_MESSAGE_LOG_LEVEL "STATUS")
 
 message(STATUS "Gathering git info")
@@ -42,6 +46,15 @@ execute_process(
 #
 #
 
+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)
+message(STATUS "Found wayland-protocols at ${WAYLAND_PROTOCOLS_DIR}")
+
 if(CMAKE_BUILD_TYPE MATCHES Debug OR CMAKE_BUILD_TYPE MATCHES DEBUG)
     message(STATUS "Configuring Hyprland in Debug with CMake")
     add_compile_definitions(HYPRLAND_DEBUG)
@@ -54,7 +67,8 @@ include_directories(
   .
   "subprojects/wlroots/include/"
   "subprojects/wlroots/build/include/"
-  "subprojects/udis86/")
+  "subprojects/udis86/"
+  "protocols/")
 set(CMAKE_CXX_STANDARD 23)
 add_compile_definitions(WLR_USE_UNSTABLE)
 add_compile_options(-Wall -Wextra -Wno-unused-parameter -Wno-unused-value -Wno-missing-field-initializers -Wno-narrowing -Wno-pointer-arith)
@@ -130,6 +144,26 @@ include(CPack)
 
 message(STATUS "Setting link libraries")
 
+function(protocol protoPath protoName external)
+    if (external)
+        execute_process(
+            COMMAND ${WaylandScanner} server-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(Hyprland PRIVATE protocols/${protoName}-protocol.c)
+    else()
+        execute_process(
+            COMMAND ${WaylandScanner} server-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(Hyprland PRIVATE protocols/${protoName}-protocol.c)
+    endif()
+endfunction()
+
 target_link_libraries(Hyprland PkgConfig::deps)
 
 target_link_libraries(Hyprland
@@ -139,12 +173,20 @@ target_link_libraries(Hyprland
         GLESv2
         pthread
         ${CMAKE_THREAD_LIBS_INIT}
-        ${CMAKE_SOURCE_DIR}/ext-workspace-unstable-v1-protocol.o
-        ${CMAKE_SOURCE_DIR}/wlr-foreign-toplevel-management-unstable-v1-protocol.o
-        ${CMAKE_SOURCE_DIR}/hyprland-toplevel-export-v1-protocol.o
-        ${CMAKE_SOURCE_DIR}/hyprland-global-shortcuts-v1-protocol.o
-        ${CMAKE_SOURCE_DIR}/fractional-scale-v1-protocol.o
-        ${CMAKE_SOURCE_DIR}/text-input-unstable-v1-protocol.o
-        ${CMAKE_SOURCE_DIR}/wlr-screencopy-unstable-v1-protocol.o
         ${CMAKE_SOURCE_DIR}/subprojects/udis86/build/libudis86/liblibudis86.a
 )
+
+protocol("protocols/ext-workspace-unstable-v1.xml" "ext-workspace-unstable-v1" true)
+protocol("protocols/idle.xml" "idle" true)
+protocol("protocols/pointer-constraints-unstable-v1.xml" "pointer-constraints-unstable-v1" true)
+protocol("protocols/tablet-unstable-v2.xml" "tablet-unstable-v2" true)
+protocol("protocols/wlr-foreign-toplevel-management-unstable-v1.xml" "wlr-foreign-toplevel-management-unstable-v1" true)
+protocol("protocols/wlr-layer-shell-unstable-v1.xml" "wlr-layer-shell-unstable-v1" true)
+protocol("protocols/wlr-output-power-management-unstable-v1.xml" "wlr-output-power-management-unstable-v1" true)
+protocol("protocols/wlr-screencopy-unstable-v1.xml" "wlr-screencopy-unstable-v1" true)
+protocol("subprojects/hyprland-protocols/protocols/hyprland-global-shortcuts-v1.xml" "hyprland-global-shortcuts-v1" true)
+protocol("subprojects/hyprland-protocols/protocols/hyprland-toplevel-export-v1.xml" "hyprland-toplevel-export-v1" true)
+protocol("stable/xdg-shell/xdg-shell.xml" "xdg-shell" false)
+protocol("unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml" "linux-dmabuf-unstable-v1" false)
+protocol("staging/fractional-scale/fractional-scale-v1.xml" "fractional-scale-v1" false)
+protocol("unstable/text-input/text-input-unstable-v1.xml" "text-input-unstable-v1" false)

Makefile

@@ -1,155 +1,4 @@
-include config.mk
+PREFIX = /usr/local
-
-CFLAGS += -I. -DWLR_USE_UNSTABLE -std=c99
-
-WAYLAND_PROTOCOLS=$(shell pkg-config --variable=pkgdatadir wayland-protocols)
-WAYLAND_SCANNER=$(shell pkg-config --variable=wayland_scanner wayland-scanner)
-
-PKGS = wlroots wayland-server xcb xkbcommon libinput
-CFLAGS += $(foreach p,$(PKGS),$(shell pkg-config --cflags $(p)))
-LDLIBS += $(foreach p,$(PKGS),$(shell pkg-config --libs $(p)))
-
-DATE=$(shell date "+%d %b %Y")
-
-xdg-shell-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		$(WAYLAND_PROTOCOLS)/stable/xdg-shell/xdg-shell.xml $@
-
-xdg-shell-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		$(WAYLAND_PROTOCOLS)/stable/xdg-shell/xdg-shell.xml $@
-
-xdg-shell-protocol.o: xdg-shell-protocol.h
-
-wlr-layer-shell-unstable-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		protocols/wlr-layer-shell-unstable-v1.xml $@
-
-wlr-layer-shell-unstable-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		protocols/wlr-layer-shell-unstable-v1.xml $@
-
-wlr-layer-shell-unstable-v1-protocol.o: wlr-layer-shell-unstable-v1-protocol.h
-
-wlr-screencopy-unstable-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		protocols/wlr-screencopy-unstable-v1.xml $@
-
-wlr-screencopy-unstable-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		protocols/wlr-screencopy-unstable-v1.xml $@
-
-wlr-screencopy-unstable-v1-protocol.o: wlr-screencopy-unstable-v1-protocol.h
-
-ext-workspace-unstable-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		protocols/ext-workspace-unstable-v1.xml $@
-
-ext-workspace-unstable-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		protocols/ext-workspace-unstable-v1.xml $@
-
-ext-workspace-unstable-v1-protocol.o: ext-workspace-unstable-v1-protocol.h
-
-pointer-constraints-unstable-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		protocols/pointer-constraints-unstable-v1.xml $@
-
-pointer-constraints-unstable-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		protocols/pointer-constraints-unstable-v1.xml $@
-
-pointer-constraints-unstable-v1-protocol.o: pointer-constraints-unstable-v1-protocol.h
-
-tablet-unstable-v2-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		protocols/tablet-unstable-v2.xml $@
-
-tablet-unstable-v2-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		protocols/tablet-unstable-v2.xml $@
-
-tablet-unstable-v2-protocol.o: tablet-unstable-v2-protocol.h
-
-idle-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		protocols/idle.xml $@
-
-idle-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		protocols/idle.xml $@
-
-idle-protocol.o: idle-protocol.h
-
-wlr-output-power-management-unstable-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		protocols/wlr-output-power-management-unstable-v1.xml $@
-
-wlr-output-power-management-unstable-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		protocols/wlr-output-power-management-unstable-v1.xml $@
-
-wlr-output-power-management-unstable-v1-protocol.o: wlr-output-power-management-unstable-v1-protocol.h
-
-hyprland-toplevel-export-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		subprojects/hyprland-protocols/protocols/hyprland-toplevel-export-v1.xml $@
-
-hyprland-toplevel-export-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		subprojects/hyprland-protocols/protocols/hyprland-toplevel-export-v1.xml $@
-
-hyprland-toplevel-export-v1-protocol.o: hyprland-toplevel-export-v1-protocol.h
-
-hyprland-global-shortcuts-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		subprojects/hyprland-protocols/protocols/hyprland-global-shortcuts-v1.xml $@
-
-hyprland-global-shortcuts-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		subprojects/hyprland-protocols/protocols/hyprland-global-shortcuts-v1.xml $@
-
-hyprland-global-shortcuts-v1-protocol.o: hyprland-global-shortcuts-v1-protocol.h
-
-linux-dmabuf-unstable-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		$(WAYLAND_PROTOCOLS)/unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml $@
-
-linux-dmabuf-unstable-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		$(WAYLAND_PROTOCOLS)/unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml $@
-
-linux-dmabuf-unstable-v1-protocol.o: linux-dmabuf-unstable-v1-protocol.h
-
-wlr-foreign-toplevel-management-unstable-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		protocols/wlr-foreign-toplevel-management-unstable-v1.xml $@
-
-wlr-foreign-toplevel-management-unstable-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		protocols/wlr-foreign-toplevel-management-unstable-v1.xml $@
-
-wlr-foreign-toplevel-management-unstable-v1-protocol.o: wlr-foreign-toplevel-management-unstable-v1-protocol.h
-
-fractional-scale-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		$(WAYLAND_PROTOCOLS)/staging/fractional-scale/fractional-scale-v1.xml $@
-
-fractional-scale-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		$(WAYLAND_PROTOCOLS)/staging/fractional-scale/fractional-scale-v1.xml $@
-
-fractional-scale-v1-protocol.o: fractional-scale-v1-protocol.h
-
-text-input-unstable-v1-protocol.h:
-	$(WAYLAND_SCANNER) server-header \
-		$(WAYLAND_PROTOCOLS)/unstable/text-input/text-input-unstable-v1.xml $@
-
-text-input-unstable-v1-protocol.c:
-	$(WAYLAND_SCANNER) private-code \
-		$(WAYLAND_PROTOCOLS)/unstable/text-input/text-input-unstable-v1.xml $@
-
-text-input-unstable-v1-protocol.o: text-input-unstable-v1-protocol.h
 
 legacyrenderer:
 	cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -DLEGACY_RENDERER:BOOL=true -S . -B ./build -G Ninja
@@ -169,7 +18,7 @@ debug:
 
 clear:
 	rm -rf build
-	rm -f *.o *-protocol.h *-protocol.c
+	rm -f ./protocols/*-protocol.h ./protocols/*-protocol.c
 	rm -f ./hyprctl/hyprctl
 	rm -rf ./subprojects/wlroots/build
 
@@ -178,7 +27,6 @@ all:
 	make fixwlr
 	cd ./subprojects/wlroots && meson setup build/ --buildtype=release && ninja -C build/ && cp ./build/libwlroots.so.12032 ${PREFIX}/lib/ || echo "Could not install libwlroots to ${PREFIX}/lib/libwlroots.so.12032"
 	cd subprojects/udis86 && cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -S . -B./build -G Ninja && cmake --build ./build --config Release --target all -j$(shell nproc)
-	make protocols
 	make release
 	make -C hyprctl all
 
@@ -187,7 +35,6 @@ install:
 	make fixwlr
 	cd ./subprojects/wlroots && meson setup build/ --buildtype=release && ninja -C build/ && cp ./build/libwlroots.so.12032 ${PREFIX}/lib/ || echo "Could not install libwlroots to ${PREFIX}/lib/libwlroots.so.12032"
 	cd subprojects/udis86 && cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -S . -B./build -G Ninja && cmake --build ./build --config Release --target all -j$(shell nproc) && cd ../..
-	make protocols
 	make release
 	make -C hyprctl all
 
@@ -202,6 +49,13 @@ install:
 	cp ./assets/wall_8K.png ${PREFIX}/share/hyprland
 
 	install -Dm644 -t ${PREFIX}/share/man/man1 ./docs/*.1
+	mkdir -p ${PREFIX}/include/hyprland
+
+	mkdir -p ${PREFIX}/include/hyprland/protocols
+	mkdir -p ${PREFIX}/share/pkgconfig
+	find src -name '*.h*' -exec cp --parents '{}' ${PREFIX}/include/hyprland ';'
+	cp ./protocols/*-protocol.h ${PREFIX}/include/hyprland/protocols
+	cp ./build/hyprland.pc ${PREFIX}/share/pkgconfig
 
 cleaninstall:
 	echo -en "make cleaninstall has been DEPRECATED, you should avoid using it in the future.\nRunning make install instead...\n"
@@ -216,16 +70,12 @@ uninstall:
 	rm -f ${PREFIX}/share/man/man1/Hyprland.1
 	rm -f ${PREFIX}/share/man/man1/hyprctl.1
 
-protocols: xdg-shell-protocol.o wlr-layer-shell-unstable-v1-protocol.o wlr-screencopy-unstable-v1-protocol.o idle-protocol.o ext-workspace-unstable-v1-protocol.o pointer-constraints-unstable-v1-protocol.o tablet-unstable-v2-protocol.o wlr-output-power-management-unstable-v1-protocol.o linux-dmabuf-unstable-v1-protocol.o hyprland-toplevel-export-v1-protocol.o wlr-foreign-toplevel-management-unstable-v1-protocol.o fractional-scale-v1-protocol.o text-input-unstable-v1-protocol.o hyprland-global-shortcuts-v1-protocol.o
-
 fixwlr:
 	sed -i -E 's/(soversion = 12)([^032]|$$)/soversion = 12032/g' subprojects/wlroots/meson.build
 
 	rm -rf ./subprojects/wlroots/build
 
 config:
-	make protocols
-
 	make fixwlr
 
 	meson setup subprojects/wlroots/build subprojects/wlroots --prefix=${PREFIX} --buildtype=release -Dwerror=false -Dexamples=false
@@ -236,8 +86,6 @@ config:
 	cd subprojects/udis86 && cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -S . -B ./build -G Ninja && cmake --build ./build --config Release --target all -j$(shell nproc)
 
 pluginenv:
-	make protocols
-
 	cd subprojects/udis86 && cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -S . -B ./build -G Ninja && cmake --build ./build --config Release --target all -j$(shell nproc)
 
 	make fixwlr
@@ -246,8 +94,6 @@ pluginenv:
 	ninja -C subprojects/wlroots/build/
 
 configdebug:
-	make protocols
-
 	make fixwlr
 
 	meson setup subprojects/wlroots/build subprojects/wlroots --prefix=${PREFIX} --buildtype=debug -Dwerror=false -Dexamples=false -Db_sanitize=address

config.mk

@@ -1,4 +0,0 @@
-PREFIX = /usr/local
-CFLAGS ?= -g -Wall -Wextra -Werror -Wno-unused-parameter -Wno-sign-compare -Wno-unused-function -Wno-unused-variable -Wno-unused-result -Wdeclaration-after-statement
-CFLAGS += -DXWAYLAND
-

hyprland.pc.in

@@ -0,0 +1,8 @@
+prefix="@PREFIX@"
+includedir="${prefix}/include"
+
+Name: Hyprland
+URL: https://github.com/hyprwm/Hyprland
+Description: Hyprland header files
+Version: @HYPRLAND_VERSION@
+Cflags: -I"${includedir}/hyprland"

meson.build

@@ -75,9 +75,25 @@ if get_option('buildtype') == 'debug'
   add_project_arguments('-DHYPRLAND_DEBUG', language: 'cpp')
 endif
 
+globber = run_command('find', 'src', '-name', '*.h*', check: true)
+headers = globber.stdout().strip().split('\n')
+foreach file : headers
+  install_headers(file, subdir: 'hyprland', preserve_path: true)
+endforeach
+
 subdir('protocols')
 subdir('src')
 subdir('hyprctl')
 subdir('assets')
 subdir('example')
 subdir('docs')
+
+pkg_install_dir = join_paths(get_option('datadir'), 'pkgconfig')
+
+import('pkgconfig').generate(
+  name: 'Hyprland',
+  filebase: 'hyprland',
+  url: 'https://github.com/hyprwm/Hyprland',
+  description: 'Hyprland header files',
+  install_dir: pkg_install_dir,
+)

nix/default.nix

@@ -61,6 +61,7 @@ in
       outputs = [
         "out"
         "man"
+        "dev"
       ];
 
       buildInputs =

protocols/meson.build

@@ -47,6 +47,8 @@ foreach p : protocols
 	wl_protos_headers += custom_target(
 		xml.underscorify() + '_server_h',
 		input: xml,
+		install: true,
+		install_dir: join_paths(get_option('includedir'), 'hyprland/protocols'),
 		output: '@BASENAME@-protocol.h',
 		command: [wayland_scanner, 'server-header', '@INPUT@', '@OUTPUT@'],
 	)