Avoid generated version headers

Use a fixed libwpe-version.h header which contains #defines for the
version numbers only, which is the location where the canonical version
is read by the build systems, and also used by then get used by both
version.h and version-deprecated.h

This avoids needing to use relative #include paths, which continued being
a pitfall even after the recent improvements due to the mixup of headers
with the same name (and relative path!) in the preprocessor search path
e.g. wpe/version.h from WPEBackend-fdo.

Author: aperezdc

CMakeLists.txt

@@ -4,7 +4,8 @@ cmake_policy(VERSION 3.0)
 set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 include(VersioningUtils)
 
-SET_PROJECT_VERSION(1 9 1)
+READ_VERSION_HEADER("" "WPE_[A-Z]+_VERSION" "${CMAKE_SOURCE_DIR}/include/wpe/libwpe-version.h")
+SET_PROJECT_VERSION(${WPE_MAJOR_VERSION} ${WPE_MINOR_VERSION} ${WPE_MICRO_VERSION})
 set(WPE_API_VERSION "1.0")
 
 # Before making a release, the LT_VERSION string should be modified.
@@ -41,19 +42,16 @@ foreach (cflag -Wall)
     endif ()
 endforeach ()
 
-set(DERIVED_SOURCES_DIR "${CMAKE_BINARY_DIR}/DerivedSources/wpe")
-configure_file(include/wpe/version.h.cmake ${DERIVED_SOURCES_DIR}/version.h @ONLY)
-configure_file(include/wpe/version-deprecated.h.cmake ${DERIVED_SOURCES_DIR}/version-deprecated.h @ONLY)
-
 include(DistTargets)
 include(GNUInstallDirs)
 
 find_package(EGL REQUIRED)
 find_package(Libxkbcommon REQUIRED)
 
 set(WPE_PUBLIC_HEADERS
-  ${DERIVED_SOURCES_DIR}/version.h
-  ${DERIVED_SOURCES_DIR}/version-deprecated.h
+  include/wpe/libwpe-version.h
+  include/wpe/version.h
+  include/wpe/version-deprecated.h
   include/wpe/export.h
   include/wpe/input.h
   include/wpe/keysyms.h
@@ -81,7 +79,6 @@ add_library(wpe SHARED
 target_include_directories(wpe PRIVATE
     "include"
     "src"
-    ${DERIVED_SOURCES_DIR}/..
     $<TARGET_PROPERTY:GL::egl,INTERFACE_INCLUDE_DIRECTORIES>
 )
 target_compile_definitions(wpe PRIVATE
@@ -145,10 +142,8 @@ IF(BUILD_DOCS)
       --sitemap=${CMAKE_SOURCE_DIR}/docs/sitemap.txt
       --output=${CMAKE_CURRENT_BINARY_DIR}/Documentation/
       --c-sources "${CMAKE_SOURCE_DIR}/include/wpe/*.h"
-                  "${DERIVED_SOURCES_DIR}/version.h"
-                  "${DERIVED_SOURCES_DIR}/version-deprecated.h"
       --extra-c-flags=-DWPE_COMPILATION=1
-      --c-include-directories ${CMAKE_SOURCE_DIR}/include ${DERIVED_SOURCES_DIR}
+      --c-include-directories ${CMAKE_SOURCE_DIR}/include
       --c-smart-index
     )
   ELSE()

cmake/VersioningUtils.cmake

@@ -1,3 +1,12 @@
+function(READ_VERSION_HEADER var_prefix def_regex file_path)
+    file(STRINGS "${file_path}" lines)
+    foreach (line ${lines})
+        if (line MATCHES "^#define[ \t]+(${def_regex})[ \t]+([0-9]+)$")
+            set("${var_prefix}${CMAKE_MATCH_1}" "${CMAKE_MATCH_2}" PARENT_SCOPE)
+        endif()
+    endforeach()
+endfunction()
+
 macro(SET_PROJECT_VERSION major minor micro)
     set(PROJECT_VERSION_MAJOR "${major}")
     set(PROJECT_VERSION_MINOR "${minor}")

include/wpe/libwpe-version.h

@@ -0,0 +1,15 @@
+/*
+ * libwpe-version.h
+ * Copyright (C) 2021 Adrian Perez de Castro <[email protected]>
+ *
+ * Distributed under terms of the MIT license.
+ */
+
+#ifndef LIBWPE_VERSION_H
+#define LIBWPE_VERSION_H
+
+#define WPE_MAJOR_VERSION 1
+#define WPE_MINOR_VERSION 9
+#define WPE_MICRO_VERSION 1
+
+#endif /* !LIBWPE_VERSION_H */

include/wpe/meson.build

@@ -2,27 +2,17 @@ api_headers = [
 	'export.h',
 	'input.h',
 	'keysyms.h',
+	'libwpe-version.h',
 	'loader.h',
 	'pasteboard.h',
 	'renderer-backend-egl.h',
 	'renderer-host.h',
+	'version.h',
+	'version-deprecated.h',
 	'view-backend.h',
 	'wpe-egl.h',
 	'wpe.h',
-
-	# Generated API headers.
-	configure_file(
-		input: 'version.h.cmake',
-		output: 'version.h',
-		configuration: version_info,
-	),
-	configure_file(
-		input: 'version-deprecated.h.cmake',
-		output: 'version-deprecated.h',
-		configuration: version_info,
-	),
 ]
 install_headers(api_headers,
 	subdir: join_paths('wpe-' + api_version, 'wpe'),
 )
-

include/wpe/version-deprecated.h.cmake include/wpe/version-deprecated.hinclude/wpe/version-deprecated.h.cmake renamed to include/wpe/version-deprecated.h

@@ -32,16 +32,18 @@
 #define wpe_version_deprecated_h
 
 #if defined(WPE_COMPILATION)
-#include "wpe/export.h"
+#include "export.h"
 #endif
 
+#include "libwpe-version.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#define WPE_BACKEND_MAJOR_VERSION (@PROJECT_VERSION_MAJOR@)
-#define WPE_BACKEND_MINOR_VERSION (@PROJECT_VERSION_MINOR@)
-#define WPE_BACKEND_MICRO_VERSION (@PROJECT_VERSION_PATCH@)
+#define WPE_BACKEND_MAJOR_VERSION WPE_MAJOR_VERSION
+#define WPE_BACKEND_MINOR_VERSION WPE_MINOR_VERSION
+#define WPE_BACKEND_MICRO_VERSION WPE_MICRO_VERSION
 
 #define WPE_BACKEND_CHECK_VERSION(major, minor, micro) \
     (WPE_BACKEND_MAJOR_VERSION > (major) || \

include/wpe/version.h.cmake include/wpe/version.hinclude/wpe/version.h.cmake renamed to include/wpe/version.h

@@ -42,17 +42,15 @@
  */
 
 #if defined(WPE_COMPILATION)
-#include "wpe/export.h"
+#include "export.h"
 #endif
 
+#include "libwpe-version.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#define WPE_MAJOR_VERSION (@PROJECT_VERSION_MAJOR@)
-#define WPE_MINOR_VERSION (@PROJECT_VERSION_MINOR@)
-#define WPE_MICRO_VERSION (@PROJECT_VERSION_PATCH@)
-
 #define WPE_CHECK_VERSION(major, minor, micro) \
     (WPE_MAJOR_VERSION > (major) || \
     (WPE_MAJOR_VERSION == (major) && WPE_MINOR_VERSION > (minor)) || \

include/wpe/wpe.h

@@ -41,15 +41,9 @@
 #include "pasteboard.h"
 #include "renderer-host.h"
 #include "view-backend.h"
-
-/*
- * The wpe/ prefix is needed for autogenerated headers to avoid
- * breaking building libwpe as a Meson subproject, because headers
- * in that case are uninstalled and will be picked from the directory
- * where they are generated (instead of where they are installed.)
- */
-#include "wpe/version.h"
-#include "wpe/version-deprecated.h"
+#include "libwpe-version.h"
+#include "version.h"
+#include "version-deprecated.h"
 
 #undef __WPE_H_INSIDE__
 

meson.build

@@ -7,7 +7,7 @@ project('libwpe', 'cpp', 'c',
 		'cpp_std=c++11',
 	],
 	license: 'BSD-2-Clause',
-	version: '1.9.1',
+	version: run_command(join_paths('scripts', 'version.py')).stdout().strip(),
 )
 
 # This refers to the API level provided. This is modified only with major,

scripts/version.py

@@ -0,0 +1,23 @@
+#! /usr/bin/env python3
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+#
+# Copyright © 2021 Igalia S.L.
+#
+# Distributed under terms of the MIT license.
+
+from os import environ, path
+import re
+
+version = {}
+version_re = re.compile(r"^#define\s+WPE_([A-Z]+)_VERSION\s+(\d+)$")
+version_file = path.join(environ["MESON_SOURCE_ROOT"],
+                         "include", "wpe", "libwpe-version.h")
+
+with open(version_file, "r") as f:
+    for line in f.readlines():
+        m = version_re.match(line)
+        if m:
+            version[m[1]] = m[2]
+
+print("{}.{}.{}".format(version["MAJOR"], version["MINOR"], version["MICRO"]))

src/version.c

@@ -24,8 +24,8 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#include "wpe/version.h"
-#include "wpe/version-deprecated.h"
+#include "../include/wpe/version.h"
+#include "../include/wpe/version-deprecated.h"
 
 unsigned
 wpe_get_major_version(void)