Add ECMGenerateExportHeader, for improved handling of deprecated API

Summary:
Generates additional macros in the export header which can be used for
fine-grained disabling of warnings & visibility as well as excluding from
the build.

Reviewers: #frameworks, #build_system

Subscribers: chehrlic, dfaure, cgiboudeaux, kde-frameworks-devel, kde-buildsystem

Tags: #frameworks, #build_system

Differential Revision: https://phabricator.kde.org/D23789

1 files changed, 50 insertions, 0 deletions

diff --git a/tests/ECMGenerateExportHeaderTest/consumer/testAPI_NO_DEPRECATED.cmake b/tests/ECMGenerateExportHeaderTest/consumer/testAPI_NO_DEPRECATED.cmake
new file mode 100644
index 00000000..190ccecc
--- /dev/null
+++ b/tests/ECMGenerateExportHeaderTest/consumer/testAPI_NO_DEPRECATED.cmake
@@ -0,0 +1,50 @@
+if(GROUP_MODE STREQUAL "GROUP_USE_GROUP")
+    set(_deprecation_macros_base_name "LIBGROUP")
+else()
+    set(_deprecation_macros_base_name "LIBRARY")
+endif()
+
+function(testAPI code_var_name)
+    set(options BUILD_TIME_ONLY_DISABLABLE NO_WARNING)
+    set(oneValueArgs DEPRECATED_AT)
+    set(multiValueArgs)
+    cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+    if((NOT ARGS_DEPRECATED_AT) OR
+       (ARGS_BUILD_TIME_ONLY_DISABLABLE AND ARGS_DEPRECATED_AT VERSION_GREATER DEPRECATED_EXCLUDED_BEFORE_AND_AT))
+       set(_build_result_expected TRUE)
+    else()
+       set(_build_result_expected FALSE)
+    endif()
+
+    set(CMAKE_REQUIRED_LIBRARIES library)
+    set(CMAKE_REQUIRED_DEFINITIONS "-D${_deprecation_macros_base_name}_NO_DEPRECATED")
+
+    set(_code "
+#include <library.hpp>
+int main(int, char**)
+{
+    ${${code_var_name}}
+}
+")
+
+    unset(_result CACHE) # clear out as check_cxx_source_compiles caches the result
+    check_cxx_source_compiles("${_code}" _result)
+
+    assert_var_bool_value(_result ${_build_result_expected})
+
+    # check warning
+    if(_build_result_expected)
+        if(ARGS_BUILD_TIME_ONLY_DISABLABLE AND NOT ARGS_NO_WARNING)
+            set(_dep_warning_result_expected FALSE)
+        else()
+            set(_dep_warning_result_expected TRUE)
+        endif()
+
+        set(CMAKE_REQUIRED_FLAGS "-Werror=deprecated-declarations")
+        set(CMAKE_REQUIRED_DEFINITIONS) # unset LIBRARY_DISABLE_DEPRECATED_BEFORE_AND_AT, as LIBRARY_DEPRECATED_WARNINGS_SINCE defaults to it
+        unset(_dep_warning_result CACHE) # clear out as check_cxx_source_compiles caches the result
+        check_cxx_source_compiles("${_code}" _dep_warning_result)
+        assert_var_bool_value(_dep_warning_result ${_dep_warning_result_expected})
+    endif()
+endfunction()