Differential D7094 Diff 17911 modules/ECMQMLModules.cmake

Changeset View

Standalone View

View Options

modules/ECMQMLModules.cmake

  • This file was added.
1​#.rst:
2​# FindQMLModule
3​# -------
4​#
5​# Find QML import modules through a find_qmlmodule() call.
6​# It uses the qmlplugindump application to find the plugins and sets them up as
7​# runtime dependencies.
8​#
9​# This is useful so that when we configure a project we are noified when some
10​# QML imports are not present in the system, thus having the application compilable
11​# but fail at runtime.
12​#
13​# ::
14​# ecm_find_qmlmodule(<module_name> <version>...)
15​#
sitterUnsubmitted
Done

If I read the code correctly it takes vargs equal to find_package, may be worth mentioning.

sitter: If I read the code correctly it takes vargs equal to `find_package`, may be worth mentioning.
16​# Any further arguments passed will be forwarded into a find_package() call. See
17​# find_package() documentation for more information.
18​#
19​# Usage example:
20​#
21​# .. code-block:: cmake
22​#
23​# ecm_find_qmlmodule(org.kde.kirigami 2.1)
24​#
25​#=============================================================================
26​# Copyright 2015 Aleix Pol Gonzalez <aleixpol@blue-systems.com>
27​#
28​# Redistribution and use in source and binary forms, with or without
29​# modification, are permitted provided that the following conditions
30​# are met:
31​#
32​# 1. Redistributions of source code must retain the copyright
33​# notice, this list of conditions and the following disclaimer.
34​# 2. Redistributions in binary form must reproduce the copyright
35​# notice, this list of conditions and the following disclaimer in the
36​# documentation and/or other materials provided with the distribution.
37​# 3. The name of the author may not be used to endorse or promote products
38​# derived from this software without specific prior written permission.
39​#
40​# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
41​# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42​# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
43​# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
44​# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45​# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
46​# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
47​# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
48​# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
49​# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
50​#=============================================================================
51​
52​set(MODULES_DIR ${CMAKE_CURRENT_LIST_DIR})
53​
54​function(ecm_find_qmlmodule MODULE_NAME VERSION)
55​ set(GENMODULE "${MODULE_NAME}-QMLModule")
56​
57​ configure_file("${MODULES_DIR}/ECMFindQMLModule.cmake.in" "Find${GENMODULE}.cmake" @ONLY)
58​
59​ set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_BINARY_DIR}" ${CMAKE_MODULE_PATH})
60​ find_package(${GENMODULE} ${ARGN})
61​
sitterUnsubmitted
Done

Description should probably mention that this is a qml module.

"QML module ${MODULE_NAME} is a runtime dependency" or something like that.

sitter: Description should probably mention that this is a qml module. "QML module ${MODULE_NAME} is a…
62​ if(COMMAND set_package_properties)
63​ set_package_properties(${GENMODULE} PROPERTIES
64​ DESCRIPTION "QML module '${MODULE_NAME}' is a runtime dependency."
65​ TYPE RUNTIME)
66​ endif()
67​endfunction()