From e5301edf1daf06aa862eb5ccae5ede72d7717fe0 Mon Sep 17 00:00:00 2001
From: Aleix Pol <aleixpol@kde.org>
Date: Thu, 3 Aug 2017 16:06:47 +0200
Subject: Include a module for finding qml imports as runtime dependencies

Summary:
Allows to check if a module is available on the system and sets it as a
runtime dependency.
This is useful for projects so that they can specify their qml dependencies
easily and packagers and developers get to see what's missing by looking
at the cmake output.

Reviewers: #build_system, #frameworks, sitter

Reviewed By: sitter

Subscribers: dfaure, aacid

Tags: #frameworks, #build_system

Differential Revision: https://phabricator.kde.org/D7094
---
 modules/ECMQMLModules.cmake | 67 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 modules/ECMQMLModules.cmake

(limited to 'modules/ECMQMLModules.cmake')

diff --git a/modules/ECMQMLModules.cmake b/modules/ECMQMLModules.cmake
new file mode 100644
index 00000000..faf9968f
--- /dev/null
+++ b/modules/ECMQMLModules.cmake
@@ -0,0 +1,67 @@
+#.rst:
+# FindQMLModule
+# -------
+#
+# Find QML import modules through a find_qmlmodule() call.
+# It uses the qmlplugindump application to find the plugins and sets them up as
+# runtime dependencies.
+#
+# This is useful so that when we configure a project we are noified when some
+# QML imports are not present in the system, thus having the application compilable
+# but fail at runtime.
+#
+# ::
+#   ecm_find_qmlmodule(<module_name> <version>...)
+#
+# Any further arguments passed will be forwarded into a find_package() call. See
+# find_package() documentation for more information.
+#
+# Usage example:
+#
+# .. code-block:: cmake
+#
+#   ecm_find_qmlmodule(org.kde.kirigami 2.1)
+#
+#=============================================================================
+# Copyright 2015 Aleix Pol Gonzalez <aleixpol@blue-systems.com>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+# 3. The name of the author may not be used to endorse or promote products
+#    derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#=============================================================================
+
+set(MODULES_DIR ${CMAKE_CURRENT_LIST_DIR})
+
+function(ecm_find_qmlmodule MODULE_NAME VERSION)
+    set(GENMODULE "${MODULE_NAME}-QMLModule")
+
+    configure_file("${MODULES_DIR}/ECMFindQMLModule.cmake.in" "Find${GENMODULE}.cmake" @ONLY)
+
+    set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_BINARY_DIR}" ${CMAKE_MODULE_PATH})
+    find_package(${GENMODULE} ${ARGN})
+
+    if(COMMAND set_package_properties)
+        set_package_properties(${GENMODULE} PROPERTIES
+            DESCRIPTION "QML module '${MODULE_NAME}' is a runtime dependency."
+            TYPE RUNTIME)
+    endif()
+endfunction()
-- 
cgit v1.2.1