Differential D2854 Diff 8639 modules/ECMAddQCH.cmake

Changeset View

Standalone View

View Options

modules/ECMAddQCH.cmake

  • This file was added.
1​#.rst:
2​# ECMAddQCH
3​# ------------------
4​#
5​# This module provides the ``ecm_add_qch`` function for generating API
6​# documentation files in the QCH format, and the ``ecm_install_qch_export``
7​# function for generating and installing exported CMake targets for such
8​# generated QCH files to enable builds of other software with generation of
9​# QCH files to create links into the given QCH files.
10​#
11​# ::
12​#
13​# ecm_add_qch(<name>
14​# OUTPUT_BASENAME <basename>
15​# VERSION <version>
16​# QCH_INSTALL_DESTINATION <qchfile_install_path>
17​# TAGFILE_INSTALL_DESTINATION <tagsfile_install_path>
18​# [SOURCE_DIRS <dir> [<dir2> [...]]]
19​# [SOURCES <file> [<file2> [...]]]
20​# |MD_MAINPAGE <md_file>]
21​# [IMAGE_DIRS <idir> [<idir2> [...]]]
22​# [EXAMPLE_DIRS <edir> [<edir2> [...]]]
23​# [ORG_DOMAIN <domain>]
24​# [NAMESPACE <namespace>]
25​# [LINK_QCHS <qch> [<qch2> [...]]]
26​# [LINK_QCHS_VERSIONED <qchv> [<qchv2> [...]]]
27​# [BLANK_MACROS <macro> [<macro2> [...]]]
28​# [CONFIG_TEMPLATE <configtemplate_file>]
29​# [VERBOSE]
30​# )
31​#
32​# This macro adds a target called <name> for the creation of an API
33​# documentation manual named ``<basename>.qch``in the QCH format from the
34​# given sources.
35​# It currently uses doxygen, future versions might optionally also allow other
36​# tools.
37​# Next to the QCH file the target will generate a corresponding doxygen tag
38​# file name ``<basename>.tags``, which enables creating links from other
39​# documentation into the generated QCH file.
40​#
41​# If the required tools are not found, the macro will skip creation of the
42​# target and only emit a warning, so the use of the macro can be introduced
43​# without requiring anyone to also have the needed tools present at that time.
44​# This behaviour might change in future versions to result in a fail instead.
45​# It is recommended to make the use of this macro optional, by depending
46​# the call to ``ecm_add_qch()`` on a CMake option being set, with a name like
47​# ``BUILD_QCH`` and being TRUE by default. This will allow the developers to
48​# saves resources on normal source development build cycles by setting this
49​# option to FALSE.
50​#
51​# The macro will set the target properties DOXYGEN_TAGFILE, QHP_NAMESPACE,
52​# QHP_NAMESPACE_VERSIONED and QHP_VIRTUALFOLDER to the respective values, to
53​# allow other code access to them, e.g. the macro ecm_install_qch_export().
54​# To enable the use of the target <name> as item for LINK_QCHS or
55​# LINK_QCHS_VERSIONED in further ``ecm_add_qch()`` calls in the current build,
56​# additionally a target property DOXYGEN_TAGFILE_BUILD is set, with the path
57​# of the created doxygen tag file in the build dir.
58​# If existing, ``ecm_add_qch()`` will use this property instead of
59​# DOXYGEN_TAGFILE for access to the tags file.
60​#
61​# OUTPUT_BASENAME specifies the base name for the generated documentation and
62​# the files.
63​#
64​# VERSION specifies the version of the library for which the documentation is
65​# created.
66​#
67​# SOURCE_DIRS specifies the dirs (incl. subdirs) with the source files for
68​# which the API documentation should be generated. Dirs can be relative to
69​# the current source dir. Dependencies to the files in the dirs are not
70​# tracked currently, other than with the SOURCES argument. So do not use for
71​# sources generated during the build.
72​# Needs to be used when SOURCES or CONFIG_TEMPLATE are not used.
73​#
74​# SOURCES specifies the source files for which the API documentation should be
75​# generated.
76​# Needs to be used when SOURCE_DIRS or CONFIG_TEMPLATE are not used.
77​#
78​# MD_MAINPAGE specifies a file in Markdown format that should be used as main
79​# page. This page will overrule any ``\mainpage`` command in the included
80​# sources.
81​#
82​# IMAGE_DIRS specifies the dirs which contain images that are included in the
83​# documentation. Dirs can be relative to the current source dir.
84​#
85​# EXAMPLE_DIRS specifies the dirs which contain examples that are included in
86​# the documentation. Dirs can be relative to the current source dir.
87​#
88​# QCH_INSTALL_DESTINATION specifies where the generated QCH file will be
89​# installed.
90​#
91​# TAGFILE_INSTALL_DESTINATION specifies where the generated tag file will be
92​# installed.
93​#
94​# NAMESPACE can be used to set a custom namespace <namespace> of the generated
95​# QCH file. The namepspace is used as the unique id by QHelpEngine (cmp.
96​# http://doc.qt.io/qt-5/qthelpproject.html#namespace).
97​# The default namespace is ``<domain>.<basename>``.
98​# Needs to be used when ORG_DOMAIN is not used.
99​#
100​# ORG_DOMAIN can be used to define the organization domain prefix for the
101​# default namespace of the generated QCH file.
102​# Needs to be used when NAMESPACE is not used.
103​#
104​# LINK_QCHS specifies a list of other QCH targets which should be used for
105​# creating references to API documenation of code in external libraries.
106​# For each target <qch> in the list these target properties are expected to be
107​# defined: DOXYGEN_TAGFILE, QHP_NAMESPACE and QHP_VIRTUALFOLDER.
108​# If any of these is not existing, <qch> will be ignored.
109​# Use the macro ecm_install_qch_export for exporting a target with these
110​# properties with the CMake config of a library.
111​# Any target <qch> can also be one created before in the same buildsystem by
112​# another call of ``ecm_add_qch()``.
113​#
114​# LINK_QCHS_VERSIONED does basically the same as LINK_QCHS, but binds the links
115​# to a certain version.
116​# For each <qchv> in the list these target properties are expected to be
117​# defined: DOXYGEN_TAGFILE, QHP_NAMESPACE_VERSIONED and QHP_VIRTUALFOLDER.
118​# If any of these is not existing, <qchv> will be ignored.
119​# Use the macro ecm_install_qch_export for exporting a target with these
120​# properties with the CMake config of a library.
121​# Any <qchv> can also be one created before in the same buildsystem by another
122​# call of ``ecm_add_qch()``.
123​#
124​# BLANK_MACROS specifies a list of C/C++ macro names which should be ignored by
125​# the API dox generation tool and handled as if they resolve to empty strings.
126​# Examples are export macros only defined in generated files, so whose
127​# definition might be not available to the tool.
128​#
129​# CONFIG_TEMPLATE specifies a custom cmake template file for the config file
130​# that is created to control the execution of the API dox generation tool.
131​# The following CMake variables need to be used:
132​# ECM_DOXYGENQCH_PERL_EXECUTABLE, ECM_DOXYGENQCH_QHELPGENERATOR_EXECUTABLE,
133​# ECM_DOXYGENQCH_FILEPATH, ECM_DOXYGENQCH_TAGFILE.
134​# The following CMake variables can be used:
135​# ECM_DOXYGENQCH_PROJECTNAME, ECM_DOXYGENQCH_PROJECTVERSION,
136​# ECM_DOXYGENQCH_VIRTUALFOLDER, ECM_DOXYGENQCH_FULLNAMESPACE,
137​# ECM_DOXYGENQCH_TAGFILES,
138​# ECM_DOXYGENQCH_WARN_LOGFILE, ECM_DOXYGENQCH_QUIET.
139​# There is no guarantue that the other CMake variables currently used in the
140​# default config file template will also be present with the same semantics
141​# in future versions of this macro.
142​#
143​# VERBOSE tells the API dox generation tool to be more verbose about its
144​# activity.
145​#
146​# Example usage:
147​#
148​# .. code-block:: cmake
149​#
150​# ecm_add_qch(
151​# MyLib_QCH
152​# OUTPUT_BASENAME MyLib
153​# VERSION "0.42.0"
154​# ORG_DOMAIN org.myorg
155​# SOURCE_DIRS
156​# src
157​# LINK_QCHS
158​# Qt5Core_QCH
159​# Qt5Xml_QCH
160​# Qt5Gui_QCH
161​# Qt5Widgets_QCH
162​# BLANK_MACROS
163​# MyLib_EXPORT
164​# MyLib_DEPRECATED
165​# TAGFILE_INSTALL_DESTINATION ${CMAKE_INSTALL_PREFIX}/share/docs/tags
166​# QCH_INSTALL_DESTINATION ${CMAKE_INSTALL_PREFIX}/share/docs/qch
167​# )
168​#
169​# Example usage (with two QCH files, second linking first):
170​#
171​# .. code-block:: cmake
172​#
173​# ecm_add_qch(
174​# MyLib_QCH
175​# OUTPUT_BASENAME MyLib
176​# VERSION ${MyLib_VERSION}
177​# ORG_DOMAIN org.myorg
178​# SOURCES ${MyLib_PUBLIC_HEADERS}
179​# MD_MAINPAGE src/mylib/README.md
180​# LINK_QCHS Qt5Core_QCH
181​# TAGFILE_INSTALL_DESTINATION ${CMAKE_INSTALL_PREFIX}/share/docs/tags
182​# QCH_INSTALL_DESTINATION ${CMAKE_INSTALL_PREFIX}/share/docs/qch
183​# )
184​# ecm_add_qch(
185​# MyOtherLib_QCH
186​# OUTPUT_BASENAME MyOtherLib
187​# VERSION ${MyOtherLib_VERSION}
188​# ORG_DOMAIN org.myorg
189​# SOURCES ${MyOtherLib_PUBLIC_HEADERS}
190​# MD_MAINPAGE src/myotherlib/README.md
191​# LINK_QCHS Qt5Core_QCH MyLib_QCH
192​# TAGFILE_INSTALL_DESTINATION ${CMAKE_INSTALL_PREFIX}/share/docs/tags
193​# QCH_INSTALL_DESTINATION ${CMAKE_INSTALL_PREFIX}/share/docs/qch
194​# )
195​#
196​# ::
197​#
198​# ecm_install_qch_export(
199​# TARGETS [<name> [<name2> [...]]]
200​# FILE <file>
201​# DESTINATION <dest>
202​# [COMPONENT <component>}]
203​# )
204​#
205​# This macro creates and installs a CMake file <file> which exports the given
206​# QCH targets <name> etc., so they can be picked up by CMake-based builds of
207​# other software that also generate QCH files (using ``ecm_add_qch()``) and
208​# which should include links to the QCH files created by the given targets.
209​# The installed CMake file <file> is expected to be included by the CMake
210​# config file created for the software the related QCH files are documenting.
211​#
212​# TARGETS specifies the QCH targets which should be exported. If a target does
213​# not exist or does not have all needed properties, a warning will be
214​# generated and the target skipped.
215​# This behaviour might change in future versions to result in a fail instead.
216​#
217​# FILE specifies the name of the created CMake file, typically with a .cmake
218​# extension.
219​#
220​# DESTINATION specifies the directory on disk to which the file will be
221​# installed. It usually is the same as the one where the CMake config files
222​# for this software are installed.
223​#
224​# COMPONENT specifies the the installation component name with which the
225​# install rule is associated.
226​#
227​# Example usage:
228​#
229​# .. code-block:: cmake
230​#
231​# ecm_install_qch_export(
232​# TARGETS MyLib_QCH
233​# FILE MyLibQCHTargets.cmake
234​# DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/cmake/MyLib"
235​# COMPONENT Devel
236​# )
237​#
238​# Since 5.29.0.
239​
240​#=============================================================================
241​# Copyright 2016 Friedrich W. H. Kossebau <kossebau@kde.org>
242​#
243​# Redistribution and use in source and binary forms, with or without
244​# modification, are permitted provided that the following conditions
245​# are met:
246​#
247​# 1. Redistributions of source code must retain the copyright
248​# notice, this list of conditions and the following disclaimer.
249​# 2. Redistributions in binary form must reproduce the copyright
250​# notice, this list of conditions and the following disclaimer in the
251​# documentation and/or other materials provided with the distribution.
252​# 3. The name of the author may not be used to endorse or promote products
253​# derived from this software without specific prior written permission.
254​#
255​# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
256​# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
257​# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
258​# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
259​# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
260​# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
261​# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
262​# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
263​# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
264​# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
265​
266​include(CMakeParseArguments)
267​include(ECMQueryQmake)
268​
269​function(ecm_add_qch target_name)
270​ # Parse arguments
271​ set(options VERBOSE)
272​ set(oneValueArgs OUTPUT_BASENAME QCH_INSTALL_DESTINATION TAGFILE_INSTALL_DESTINATION VERSION NAMESPACE MD_MAINPAGE ORG_DOMAIN CONFIG_TEMPLATE)
273​ set(multiValueArgs SOURCE_DIRS SOURCES IMAGE_DIRS EXAMPLE_DIRS BLANK_MACROS LINK_QCHS LINK_QCHS_VERSIONED)
274​ cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
275​
276​ # check required args
277​ foreach(_arg_name OUTPUT_BASENAME QCH_INSTALL_DESTINATION TAGFILE_INSTALL_DESTINATION VERSION)
278​ if(NOT DEFINED ARGS_${_arg_name})
279​ message(FATAL_ERROR "${_arg_name} needs to be defined when calling ecm_add_qch")
280​ endif()
281​ endforeach()
282​ if(NOT DEFINED ARGS_SOURCE_DIRS AND NOT DEFINED ARGS_SOURCES AND NOT DEFINED ARGS_CONFIG_TEMPLATE)
283​ message(FATAL_ERROR "SOURCE_DIRS or SOURCES needs to be defined when calling ecm_add_qch")
284​ endif()
285​ if(DEFINED ARGS_SOURCE_DIRS AND DEFINED ARGS_SOURCES)
286​ message(FATAL_ERROR "Either SOURCE_DIRS or SOURCES, not both, needs to be defined when calling ecm_add_qch")
287​ endif()
288​ if(NOT DEFINED ARGS_ORG_DOMAIN AND NOT DEFINED ARGS_NAMESPACE)
289​ message(FATAL_ERROR "ORG_DOMAIN or NAMESPACE needs to be defined when calling ecm_add_qch")
290​ endif()
291​
292​ # create QCH targets for Qt
293​ # Ideally one day Qt CMake Config files provide these
294​ if(NOT TARGET Qt5Core_QCH)
295​ # get Qt version, if any
296​ find_package(Qt5Core CONFIG QUIET)
297​ # lookup tag files
298​ query_qmake(qt_docs_dir QT_INSTALL_DOCS)
299​ find_path(_qtcoreTagsPath qtcore/qtcore.tags
300​ PATHS
301​ ${qt_docs_dir}
302​ )
303​
304​ if(Qt5Core_FOUND AND _qtcoreTagsPath)
305​ string(REPLACE "." "" _version ${Qt5Core_VERSION})
306​ # TODO: properly find each tag file
307​ # TODO: complete list of Qt modules
308​ foreach(_module
309​ Bluetooth Concurrent Core DBus Gui Location Multimedia MultimediaWidgets
310​ Network Positioning PrintSupport Qml Quick Sensors SerialPort Sql Svg
311​ WebEngine WebView Widgets Xml XmlPatterns
312​ )
313​ string(TOLOWER ${_module} _lowermodule)
314​
315​ add_custom_target(Qt5${_module}_QCH)
316​ set_target_properties(Qt5${_module}_QCH PROPERTIES
317​ DOXYGEN_TAGFILE "${_qtcoreTagsPath}/qt${_lowermodule}/qt${_lowermodule}.tags"
318​ QHP_NAMESPACE "org.qt-project.qt${_lowermodule}"
319​ QHP_NAMESPACE_VERSIONED "org.qt-project.qt${_lowermodule}.${_version}"
320​ QHP_VIRTUALFOLDER "qt${_lowermodule}"
321​ IMPORTED TRUE
322​ )
323​ endforeach()
324​ endif()
325​ endif()
326​
327​ # find required tools
328​ find_package(Perl)
329​ set_package_properties(Perl PROPERTIES
330​ TYPE OPTIONAL
331​ )
332​ find_package(Doxygen)
333​ set_package_properties(Doxygen PROPERTIES
334​ TYPE OPTIONAL
335​ DESCRIPTION "Tool for API Documentation generation"
336​ URL "http://www.doxygen.org/"
337​ )
338​ if (DOXYGEN_FOUND AND DOXYGEN_VERSION VERSION_LESS 1.8.13 AND NOT ECM_DOXYGEN_PATCHED_JSFILESADDED)
339​ message(WARNING "Make sure Doxygen is patched with https://github.com/doxygen/doxygen/commit/bf9415698e53d79b, then pass -DECM_DOXYGEN_PATCHED_JSFILESADDED=ON to cmake")
340​ set(DOXYGEN_FOUND FALSE)
341​ endif()
342​ # TODO: use Qt5::qhelpgenerator for Qt >= 5.7.1
343​ find_program(ECM_DOXYGENQCH_QHELPGENERATOR_EXECUTABLE NAMES qhelpgenerator-qt5 qhelpgenerator)
344​
345​ # prepare base dirs, working file names and other vars
346​ set(_qch_file_basename "${ARGS_OUTPUT_BASENAME}.qch")
347​ set(_tags_file_basename "${ARGS_OUTPUT_BASENAME}.tags")
348​ set(_qch_buildpath "${CMAKE_CURRENT_BINARY_DIR}/${_qch_file_basename}")
349​ set(_tags_buildpath "${CMAKE_CURRENT_BINARY_DIR}/${_tags_file_basename}")
350​ set(_apidox_builddir "${CMAKE_CURRENT_BINARY_DIR}/${ARGS_OUTPUT_BASENAME}_ECMDoxygenQCH")
351​ if (DEFINED ARGS_NAMESPACE)
352​ set(_namespace "${ARGS_NAMESPACE}")
353​ else()
354​ set(_namespace "${ARGS_ORG_DOMAIN}.${ARGS_OUTPUT_BASENAME}")
355​ endif()
356​ string(REPLACE "." "_" _dotLessVersion ${ARGS_VERSION})
357​ set(_versioned_namespace "${_namespace}.${_dotLessVersion}")
358​ set(_sources)
359​ set(_dep_tagfiles)
360​ set(_dep_qch_targets)
361​
362​ ### Create doxygen config file
363​ set(_doxygenconfig_file "${CMAKE_CURRENT_BINARY_DIR}/${ARGS_OUTPUT_BASENAME}_ECMDoxygenQCH.config")
364​ if (DEFINED ARGS_CONFIG_TEMPLATE)
365​ set(_doxygenconfig_template_file "${ARGS_CONFIG_TEMPLATE}")
366​ else()
367​ set(_doxygenconfig_template_file "${ECM_MODULE_DIR}/ECMDoxygenQCH.config.in")
368​ endif()
369​ # Setup variables used in config file template, ECM_DOXYGENQCH_*
370​ set(ECM_DOXYGENQCH_OUTPUTDIR "\"${_apidox_builddir}\"")
371​ set(ECM_DOXYGENQCH_TAGFILE "\"${_tags_buildpath}\"")
372​ set(ECM_DOXYGENQCH_LAYOUTFILE "\"${ECM_MODULE_DIR}/ECMDoxygenQCHLayout.xml\"")
373​ set(ECM_DOXYGENQCH_IMAGEDIRS)
374​ foreach(_image_DIR IN LISTS ARGS_IMAGE_DIRS)
375​ if (NOT IS_ABSOLUTE ${_image_DIR})
376​ set(_image_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${_image_DIR}")
377​ endif()
378​ # concat dirs separated by a break, it is no issue that first has also a leading break
379​ set(ECM_DOXYGENQCH_IMAGEDIRS "${ECM_DOXYGENQCH_IMAGEDIRS} \\\n\"${_image_DIR}\"")
380​ endforeach()
381​ set(ECM_DOXYGENQCH_EXAMPLEDIRS)
382​ foreach(_example_DIR IN LISTS ARGS_EXAMPLE_DIRS)
383​ if (NOT IS_ABSOLUTE ${_example_DIR})
384​ set(_example_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${_example_DIR}")
385​ endif()
386​ # concat dirs separated by a break, it is no issue that first has also a leading break
387​ set(ECM_DOXYGENQCH_EXAMPLEDIRS "${ECM_DOXYGENQCH_EXAMPLEDIRS} \\\n\"${_example_DIR}\"")
388​ endforeach()
389​ if (ARGS_MD_MAINPAGE)
390​ if (NOT IS_ABSOLUTE ${ARGS_MD_MAINPAGE})
391​ set(ARGS_MD_MAINPAGE "${CMAKE_CURRENT_SOURCE_DIR}/${ARGS_MD_MAINPAGE}")
392​ endif()
393​ set(ECM_DOXYGENQCH_MAINPAGE_MDFILE "\"${ARGS_MD_MAINPAGE}\"")
394​ else()
395​ set(ECM_DOXYGENQCH_MAINPAGE_MDFILE)
396​ endif()
397​ set(ECM_DOXYGENQCH_INPUT)
398​ if (ARGS_SOURCE_DIRS)
399​ foreach(_source_DIR IN LISTS ARGS_SOURCE_DIRS)
400​ if (NOT IS_ABSOLUTE ${_source_DIR})
401​ set(_source_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${_source_DIR}")
402​ endif()
403​ # concat dirs separated by a break, it is no issue that first has also a leading break
404​ set(ECM_DOXYGENQCH_INPUT "${ECM_DOXYGENQCH_INPUT} \\\n\"${_source_DIR}\"")
405​ endforeach()
406​ if (ARGS_MD_MAINPAGE)
407​ set(ECM_DOXYGENQCH_INPUT "${ECM_DOXYGENQCH_INPUT} \\\n\"${ARGS_MD_MAINPAGE}\"")
408​ endif()
409​ set(ECM_DOXYGENQCH_FILE_PATTERNS "*.h *.cpp *.hpp *.hh *.cc *.h++ *.c++ *.hxx *.cxx *.dox *.md")
410​ else()
411​ foreach(_source IN LISTS ARGS_SOURCES)
412​ if (NOT IS_ABSOLUTE ${_source})
413​ set(_source "${CMAKE_CURRENT_SOURCE_DIR}/${_source}")
414​ endif()
415​ list(APPEND _sources "${_source}")
416​ endforeach()
417​ if (ARGS_MD_MAINPAGE)
418​ list(FIND _sources ${ARGS_MD_MAINPAGE} _mainpage_index)
419​ if (_mainpage_index STREQUAL -1)
420​ list(APPEND _sources "${ARGS_MD_MAINPAGE}")
421​ endif()
422​ endif()
423​ foreach(_source IN LISTS _sources)
424​ # concat sources separated by a break, it is no issue that first has also a leading break
425​ set(ECM_DOXYGENQCH_INPUT "${ECM_DOXYGENQCH_INPUT} \\\n\"${_source}\"")
426​ endforeach()
427​ set(ECM_DOXYGENQCH_FILE_PATTERNS "")
428​ endif()
429​
430​ set(ECM_DOXYGENQCH_PROJECTNAME ${ARGS_OUTPUT_BASENAME})
431​ file(RELATIVE_PATH _builddirrelative_filepath "${_apidox_builddir}/html" ${_qch_buildpath})
432​ set(ECM_DOXYGENQCH_FILEPATH "\"${_builddirrelative_filepath}\"")
433​ set(ECM_DOXYGENQCH_PROJECTVERSION ${ARGS_VERSION})
434​ set(ECM_DOXYGENQCH_VIRTUALFOLDER "${ARGS_OUTPUT_BASENAME}")
435​ set(ECM_DOXYGENQCH_FULLNAMESPACE ${_versioned_namespace})
436​ set(ECM_DOXYGENQCH_BLANK_MACROS)
437​ foreach(_macro IN LISTS ARGS_BLANK_MACROS)
438​ # concat dirs separated by a break, it is no issue that first has also a leading break
439​ set(ECM_DOXYGENQCH_BLANK_MACROS "${ECM_DOXYGENQCH_BLANK_MACROS} \\\n${_macro}=\"\"")
440​ endforeach()
441​ set(ECM_DOXYGENQCH_TAGFILES)
442​ foreach(_versioned_postfix "" "_VERSIONED")
443​ foreach(_link_qch IN LISTS ARGS_LINK_QCHS${_versioned_postfix})
444​ set(_target_usable TRUE)
445​ if (NOT TARGET ${_link_qch})
446​ message(STATUS "No such target ${_link_qch} defined when calling ecm_add_qch().")
447​ set(_target_usable FALSE)
448​ elseif()
449​ foreach(_propertyname
450​ DOXYGEN_TAGFILE
451​ QHP_NAMESPACE${_versioned_postfix}
452​ QHP_VIRTUALFOLDER
453​ )
454​ if(NOT "${_property}")
455​ message(STATUS "No property ${_propertyname} set on ${_link_qch} when calling ecm_add_qch().")
456​ set(_target_usable FALSE)
457​ endif()
458​ endforeach()
459​ endif()
460​ if(_target_usable)
461​ list(APPEND _dep_qch_targets ${_link_qch})
462​ get_target_property(_link_qch_tagfile ${_link_qch} DOXYGEN_TAGFILE)
463​ get_target_property(_link_qch_tagfile_build ${_link_qch} DOXYGEN_TAGFILE_BUILD)
464​ get_target_property(_link_qch_namespace ${_link_qch} QHP_NAMESPACE${_versioned_postfix})
465​ get_target_property(_link_qch_virtualfolder ${_link_qch} QHP_VIRTUALFOLDER)
466​ # if same build, then prefer build version over any installed one
467​ if (${_link_qch_tagfile_build})
468​ set(_link_qch_tagfile ${_link_qch_tagfile_build})
469​ list(APPEND _dep_tagfiles "${_link_qch_tagfile}")
470​ endif()
471​ set(_tagfile_entry "\"${_link_qch_tagfile}=qthelp://${_link_qch_namespace}/${_link_qch_virtualfolder}/\"")
472​ # concat dirs separated by a break, it is no issue that first has also a leading break
473​ set(ECM_DOXYGENQCH_TAGFILES "${ECM_DOXYGENQCH_TAGFILES} \\\n${_tagfile_entry}")
474​ else()
475​ message(WARNING "No linking to API dox of ${_link_qch}.")
476​ endif()
477​ endforeach()
478​ endforeach()
479​
480​ set(ECM_DOXYGENQCH_WARN_LOGFILE "\"${_doxygenconfig_file}.log\"")
481​ if(ARGS_VERBOSE)
482​ set(ECM_DOXYGENQCH_QUIET "NO")
483​ else()
484​ set(ECM_DOXYGENQCH_QUIET "YES")
485​ endif()
486​ set(ECM_DOXYGENQCH_PERL_EXECUTABLE "${PERL_EXECUTABLE}")
487​
488​ if (NOT DOXYGEN_FOUND)
489​ message(WARNING "Unable to find the doxygen utility - API dox QCH file will not be generated!")
490​ elseif(NOT ECM_DOXYGENQCH_QHELPGENERATOR_EXECUTABLE)
491​ message(WARNING "Unable to find the qhelpgenerator utility - API dox QCH file will not be generated!")
492​ elseif(NOT PERL_FOUND)
493​ message(WARNING "Unable to find the perl utility - API dox QCH file will not be generated!")
494​ else()
495​ configure_file(
496​ "${_doxygenconfig_template_file}"
497​ "${_doxygenconfig_file}"
498​ @ONLY
499​ )
500​
501​ set(_qch_INSTALLPATH ${ARGS_QCH_INSTALL_DESTINATION})
502​ set(_tags_INSTALLPATH ${ARGS_TAGFILE_INSTALL_DESTINATION})
503​ file(RELATIVE_PATH _relative_qch_file ${CMAKE_BINARY_DIR} ${_qch_buildpath})
504​ file(RELATIVE_PATH _relative_tags_file ${CMAKE_BINARY_DIR} ${_tags_buildpath})
505​ add_custom_command(
506​ OUTPUT ${_qch_buildpath} ${_tags_buildpath}
507​ COMMENT "Generating ${_relative_qch_file}, ${_relative_tags_file}"
508​ COMMAND cmake -E remove_directory "${ECM_DOXYGENQCH_OUTPUTDIR}"
509​ COMMAND cmake -E make_directory "${ECM_DOXYGENQCH_OUTPUTDIR}"
510​ COMMAND ${DOXYGEN_EXECUTABLE} "${_doxygenconfig_file}"
511​ DEPENDS ${_doxygenconfig_file} ${_sources} ${_dep_tagfiles} ${_dep_qch_targets}
512​ )
513​ add_custom_target(${target_name} ALL DEPENDS ${_qch_buildpath} ${_tags_buildpath})
514​ set_target_properties(${target_name} PROPERTIES
515​ DOXYGEN_TAGFILE "${_qch_INSTALLPATH}/${_tags_file_basename}"
516​ DOXYGEN_TAGFILE_BUILD "${_tags_buildpath}"
517​ QHP_NAMESPACE "${_namespace}"
518​ QHP_NAMESPACE_VERSIONED "${_versioned_namespace}"
519​ QHP_VIRTUALFOLDER "${ECM_DOXYGENQCH_VIRTUALFOLDER}"
520​ )
521​
522​ install(FILES
523​ ${_qch_buildpath}
524​ DESTINATION ${_qch_INSTALLPATH}
525​ COMPONENT Devel
526​ )
527​
528​ install(FILES
529​ ${_tags_buildpath}
530​ DESTINATION ${_tags_INSTALLPATH}
531​ COMPONENT Devel
532​ )
533​ endif()
534​
535​endfunction()
536​
537​
538​function(ecm_install_qch_export)
539​ set(options )
540​ set(oneValueArgs FILE DESTINATION COMPONENT)
541​ set(multiValueArgs TARGETS)
542​
543​ cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
544​
545​ if(NOT DEFINED ARGS_FILE)
546​ message(FATAL_ERROR "FILE needs to be defined when calling ecm_install_qch_export().")
547​ endif()
548​
549​ if(NOT DEFINED ARGS_DESTINATION)
550​ message(FATAL_ERROR "DESTINATION needs to be defined when calling ecm_install_qch_export().")
551​ endif()
552​
553​ # TARGETS may be empty (and ARGS_TARGETS will not be defined then by cmake_parse_arguments)
554​
555​ set(_content
556​"# Generated by ecm_install_qch_export()
557​# Any changes to this file will be overwritten by the next CMake run.
558​"
559​ )
560​
561​ foreach(_target IN LISTS ARGS_TARGETS)
562​ set(_target_usable TRUE)
563​
564​ if (NOT TARGET ${_target})
565​ message(STATUS "No such target ${_target} when calling ecm_install_qch_export().")
566​ set(_target_usable FALSE)
567​ else()
568​ foreach(_propertyname
569​ DOXYGEN_TAGFILE
570​ QHP_NAMESPACE
571​ QHP_NAMESPACE_VERSIONED
572​ QHP_VIRTUALFOLDER
573​ )
574​ get_target_property(_property ${_target} ${_propertyname})
575​ if(NOT _property)
576​ message(STATUS "No property ${_propertyname} set on ${_target} when calling ecm_install_qch_export(). <${_property}>")
577​ set(_target_usable FALSE)
578​ endif()
579​ endforeach()
580​ endif()
581​ if(_target_usable)
582​ get_target_property(_tagfile ${_target} DOXYGEN_TAGFILE)
583​ get_target_property(_namespace ${_target} QHP_NAMESPACE)
584​ get_target_property(_namespace_versioned ${_target} QHP_NAMESPACE_VERSIONED)
585​ get_target_property(_virtualfolder ${_target} QHP_VIRTUALFOLDER)
586​ set(_content "${_content}
587​if (NOT TARGET ${_target})
588​
589​add_custom_target(${_target})
590​set_target_properties(${_target} PROPERTIES
591​ DOXYGEN_TAGFILE \"${_tagfile}\"
592​ QHP_NAMESPACE \"${_namespace}\"
593​ QHP_NAMESPACE_VERSIONED \"${_namespace_versioned}\"
594​ QHP_VIRTUALFOLDER \"${_virtualfolder}\"
595​ IMPORTED TRUE
596​)
597​
598​endif()
599​"
600​ )
601​ else()
602​ message(STATUS "No target exported for ${_target}.")
603​ endif()
604​ endforeach()
605​
606​ if (NOT IS_ABSOLUTE ${ARGS_FILE})
607​ set(ARGS_FILE "${CMAKE_CURRENT_BINARY_DIR}/${ARGS_FILE}")
608​ endif()
609​
610​ file(GENERATE
611​ OUTPUT "${ARGS_FILE}"
612​ CONTENT "${_content}"
613​ )
614​
615​ if (DEFINED ARGS_COMPONENT)
616​ set(_component COMPONENT ${ARGS_COMPONENT})
617​ endif()
618​ install(
619​ FILES "${ARGS_FILE}"
620​ DESTINATION "${ARGS_DESTINATION}"
621​ ${_component}
622​ )
623​
624​endfunction()