kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Modules/DeployQt4.cmake

333 lines
13 KiB
CMake
Raw Normal View History

Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
#.rst:
# DeployQt4
# ---------
#
# Functions to help assemble a standalone Qt4 executable.
#
# A collection of CMake utility functions useful for deploying Qt4
# executables.
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#
# The following functions are provided by this module:
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
#
# ::
#
# write_qt4_conf
# resolve_qt4_paths
# fixup_qt4_executable
# install_qt4_plugin_path
# install_qt4_plugin
# install_qt4_executable
#
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
# Requires CMake 2.6 or greater because it uses function and
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# PARENT_SCOPE. Also depends on BundleUtilities.cmake.
#
# ::
#
# WRITE_QT4_CONF(<qt_conf_dir> <qt_conf_contents>)
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#
# Writes a qt.conf file with the <qt_conf_contents> into <qt_conf_dir>.
#
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# ::
#
# RESOLVE_QT4_PATHS(<paths_var> [<executable_path>])
#
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
# Loop through <paths_var> list and if any don't exist resolve them
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# relative to the <executable_path> (if supplied) or the
# CMAKE_INSTALL_PREFIX.
#
# ::
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# FIXUP_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>])
#
# Copies Qt plugins, writes a Qt configuration file (if needed) and
# fixes up a Qt4 executable using BundleUtilities so it is standalone
# and can be drag-and-drop copied to another machine as long as all of
# the system libraries are compatible.
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#
# <executable> should point to the executable to be fixed-up.
#
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# <qtplugins> should contain a list of the names or paths of any Qt
# plugins to be installed.
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# <libs> will be passed to BundleUtilities and should be a list of any
# already installed plugins, libraries or executables to also be
# fixed-up.
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# <dirs> will be passed to BundleUtilities and should contain and
# directories to be searched to find library dependencies.
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#
# <plugins_dir> allows an custom plugins directory to be used.
#
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# <request_qt_conf> will force a qt.conf file to be written even if not
# needed.
#
# ::
#
# INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var <plugins_dir> <component> <configurations>)
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#
# Install (or copy) a resolved <plugin> to the default plugins directory
# (or <plugins_dir>) relative to <executable> and store the result in
# <installed_plugin_path_var>.
#
# If <copy> is set to TRUE then the plugins will be copied rather than
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# installed. This is to allow this module to be used at CMake time
# rather than install time.
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#
# If <component> is set then anything installed will use this COMPONENT.
#
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# ::
#
# INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var <plugins_dir> <component>)
#
# Install (or copy) an unresolved <plugin> to the default plugins
# directory (or <plugins_dir>) relative to <executable> and store the
# result in <installed_plugin_path_var>. See documentation of
# INSTALL_QT4_PLUGIN_PATH.
#
# ::
#
# INSTALL_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>])
#
# Installs Qt plugins, writes a Qt configuration file (if needed) and
# fixes up a Qt4 executable using BundleUtilities so it is standalone
# and can be drag-and-drop copied to another machine as long as all of
# the system libraries are compatible. The executable will be fixed-up
# at install time. <component> is the COMPONENT used for bundle fixup
# and plugin installation. See documentation of FIXUP_QT4_BUNDLE.
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
#=============================================================================
# Copyright 2011 Mike McQuaid <mike@mikemcquaid.com>
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
# License text for the above reference.)
# The functions defined in this file depend on the fixup_bundle function
# (and others) found in BundleUtilities.cmake
Find* (and some other): use ${CMAKE_CURRENT_LIST_DIR} in include() This solves a lots of warnings, e.g. in the FindModulesExecuteAll test. If the installed version on the system is rather old this may even lead to bugs, e.g. https://bugs.gentoo.org/show_bug.cgi?id=436540
2012-11-04 00:35:44 +04:00
include("${CMAKE_CURRENT_LIST_DIR}/BundleUtilities.cmake")
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
set(DeployQt4_cmake_dir "${CMAKE_CURRENT_LIST_DIR}")
Fix bad plugin paths.
2012-01-11 19:39:12 +04:00
set(DeployQt4_apple_plugins_dir "PlugIns")
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
function(write_qt4_conf qt_conf_dir qt_conf_contents)
set(qt_conf_path "${qt_conf_dir}/qt.conf")
message(STATUS "Writing ${qt_conf_path}")
file(WRITE "${qt_conf_path}" "${qt_conf_contents}")
endfunction()
function(resolve_qt4_paths paths_var)
set(executable_path ${ARGV1})
set(paths_resolved)
foreach(path ${${paths_var}})
if(EXISTS "${path}")
list(APPEND paths_resolved "${path}")
else()
if(${executable_path})
list(APPEND paths_resolved "${executable_path}/${path}")
else()
DeployQt4: Include DESTDIR for some cpack generators.
2012-08-16 05:36:50 +04:00
list(APPEND paths_resolved "\$ENV{DESTDIR}\${CMAKE_INSTALL_PREFIX}/${path}")
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
endif()
endif()
endforeach()
set(${paths_var} ${paths_resolved} PARENT_SCOPE)
endfunction()
Match fixup_qt4_executable with documentation.
2011-10-28 20:31:30 +04:00
function(fixup_qt4_executable executable)
set(qtplugins ${ARGV1})
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
set(libs ${ARGV2})
set(dirs ${ARGV3})
set(plugins_dir ${ARGV4})
set(request_qt_conf ${ARGV5})
message(STATUS "fixup_qt4_executable")
message(STATUS " executable='${executable}'")
message(STATUS " qtplugins='${qtplugins}'")
message(STATUS " libs='${libs}'")
message(STATUS " dirs='${dirs}'")
message(STATUS " plugins_dir='${plugins_dir}'")
message(STATUS " request_qt_conf='${request_qt_conf}'")
if(QT_LIBRARY_DIR)
list(APPEND dirs "${QT_LIBRARY_DIR}")
endif()
DeployQt4: Add path to Qt dlls on Windows.
2012-03-07 22:03:36 +04:00
if(QT_BINARY_DIR)
list(APPEND dirs "${QT_BINARY_DIR}")
endif()
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
if(APPLE)
set(qt_conf_dir "${executable}/Contents/Resources")
set(executable_path "${executable}")
set(write_qt_conf TRUE)
Fix bad plugin paths.
2012-01-11 19:39:12 +04:00
if(NOT plugins_dir)
set(plugins_dir "${DeployQt4_apple_plugins_dir}")
endif()
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
else()
get_filename_component(executable_path "${executable}" PATH)
if(NOT executable_path)
set(executable_path ".")
endif()
set(qt_conf_dir "${executable_path}")
set(write_qt_conf ${request_qt_conf})
endif()
foreach(plugin ${qtplugins})
set(installed_plugin_path "")
Fix mismatched arguments.
2012-01-17 00:15:38 +04:00
install_qt4_plugin("${plugin}" "${executable}" 1 installed_plugin_path)
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
list(APPEND libs ${installed_plugin_path})
endforeach()
foreach(lib ${libs})
if(NOT EXISTS "${lib}")
message(FATAL_ERROR "Library does not exist: ${lib}")
endif()
endforeach()
resolve_qt4_paths(libs "${executable_path}")
if(write_qt_conf)
set(qt_conf_contents "[Paths]\nPlugins = ${plugins_dir}")
write_qt4_conf("${qt_conf_dir}" "${qt_conf_contents}")
endif()
fixup_bundle("${executable}" "${libs}" "${dirs}")
endfunction()
function(install_qt4_plugin_path plugin executable copy installed_plugin_path_var)
set(plugins_dir ${ARGV4})
set(component ${ARGV5})
set(configurations ${ARGV6})
if(EXISTS "${plugin}")
if(APPLE)
Fix bad plugin paths.
2012-01-11 19:39:12 +04:00
if(NOT plugins_dir)
set(plugins_dir "${DeployQt4_apple_plugins_dir}")
endif()
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
set(plugins_path "${executable}/Contents/${plugins_dir}")
else()
Fix bad plugin paths.
2012-01-11 19:39:12 +04:00
get_filename_component(plugins_path "${executable}" PATH)
if(NOT plugins_path)
set(plugins_path ".")
endif()
if(plugins_dir)
set(plugins_path "${plugins_path}/${plugins_dir}")
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
endif()
endif()
set(plugin_group "")
get_filename_component(plugin_path "${plugin}" PATH)
get_filename_component(plugin_parent_path "${plugin_path}" PATH)
get_filename_component(plugin_parent_dir_name "${plugin_parent_path}" NAME)
get_filename_component(plugin_name "${plugin}" NAME)
string(TOLOWER "${plugin_parent_dir_name}" plugin_parent_dir_name)
if("${plugin_parent_dir_name}" STREQUAL "plugins")
get_filename_component(plugin_group "${plugin_path}" NAME)
set(${plugin_group_var} "${plugin_group}")
endif()
set(plugins_path "${plugins_path}/${plugin_group}")
if(${copy})
file(MAKE_DIRECTORY "${plugins_path}")
file(COPY "${plugin}" DESTINATION "${plugins_path}")
else()
if(configurations AND (CMAKE_CONFIGURATION_TYPES OR CMAKE_BUILD_TYPE))
set(configurations CONFIGURATIONS ${configurations})
Unset configurations variable when no build type.
2011-12-13 20:24:39 +04:00
else()
unset(configurations)
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
endif()
install(FILES "${plugin}" DESTINATION "${plugins_path}" ${configurations} ${component})
endif()
Ensure libs are passed to BundleUtilities.
2012-02-21 21:10:39 +04:00
set(${installed_plugin_path_var} "${plugins_path}/${plugin_name}" PARENT_SCOPE)
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
endif()
endfunction()
function(install_qt4_plugin plugin executable copy installed_plugin_path_var)
set(plugins_dir ${ARGV4})
set(component ${ARGV5})
if(EXISTS "${plugin}")
install_qt4_plugin_path("${plugin}" "${executable}" "${copy}" "${installed_plugin_path_var}" "${plugins_dir}" "${component}")
else()
Fix plugin installation issues.
2012-02-21 21:11:28 +04:00
string(TOUPPER "QT_${plugin}_PLUGIN" plugin_var)
Check plugin variables are defined before warning.
2011-10-28 20:33:21 +04:00
set(plugin_release_var "${plugin_var}_RELEASE")
set(plugin_debug_var "${plugin_var}_DEBUG")
set(plugin_release "${${plugin_release_var}}")
set(plugin_debug "${${plugin_debug_var}}")
if(DEFINED "${plugin_release_var}" AND DEFINED "${plugin_debug_var}" AND NOT EXISTS "${plugin_release}" AND NOT EXISTS "${plugin_debug}")
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
message(WARNING "Qt plugin \"${plugin}\" not recognized or found.")
endif()
Fix plugin installation issues.
2012-02-21 21:11:28 +04:00
if(NOT EXISTS "${${plugin_debug_var}}")
set(plugin_debug "${plugin_release}")
endif()
if(CMAKE_CONFIGURATION_TYPES OR CMAKE_BUILD_TYPE)
install_qt4_plugin_path("${plugin_release}" "${executable}" "${copy}" "${installed_plugin_path_var}_release" "${plugins_dir}" "${component}" "Release|RelWithDebInfo|MinSizeRel")
install_qt4_plugin_path("${plugin_debug}" "${executable}" "${copy}" "${installed_plugin_path_var}_debug" "${plugins_dir}" "${component}" "Debug")
if(CMAKE_BUILD_TYPE MATCHES "^Debug$")
set(${installed_plugin_path_var} ${${installed_plugin_path_var}_debug})
else()
set(${installed_plugin_path_var} ${${installed_plugin_path_var}_release})
endif()
else()
install_qt4_plugin_path("${plugin_release}" "${executable}" "${copy}" "${installed_plugin_path_var}" "${plugins_dir}" "${component}")
endif()
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
endif()
Fix plugin installation issues.
2012-02-21 21:11:28 +04:00
set(${installed_plugin_path_var} ${${installed_plugin_path_var}} PARENT_SCOPE)
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
endfunction()
function(install_qt4_executable executable)
set(qtplugins ${ARGV1})
set(libs ${ARGV2})
set(dirs ${ARGV3})
set(plugins_dir ${ARGV4})
set(request_qt_conf ${ARGV5})
Improve component support and output indentation.
2011-12-16 20:41:19 +04:00
set(component ${ARGV6})
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
if(QT_LIBRARY_DIR)
list(APPEND dirs "${QT_LIBRARY_DIR}")
endif()
DeployQt4: Add path to Qt dlls on Windows.
2012-03-07 22:03:36 +04:00
if(QT_BINARY_DIR)
list(APPEND dirs "${QT_BINARY_DIR}")
endif()
Improve component support and output indentation.
2011-12-16 20:41:19 +04:00
if(component)
set(component COMPONENT ${component})
else()
unset(component)
endif()
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
get_filename_component(executable_absolute "${executable}" ABSOLUTE)
Check QtCore without warning. When debug and release versions of QtCore were available it printed a warning. This has been fixed.
2011-11-14 20:34:10 +04:00
if(EXISTS "${QT_QTCORE_LIBRARY_RELEASE}")
gp_file_type("${executable_absolute}" "${QT_QTCORE_LIBRARY_RELEASE}" qtcore_type)
elseif(EXISTS "${QT_QTCORE_LIBRARY_DEBUG}")
gp_file_type("${executable_absolute}" "${QT_QTCORE_LIBRARY_DEBUG}" qtcore_type)
endif()
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
if(qtcore_type STREQUAL "system")
set(qt_plugins_dir "")
endif()
Fix plugin installation issues.
2012-02-21 21:11:28 +04:00
if(QT_IS_STATIC)
message(WARNING "Qt built statically: not installing plugins.")
else()
foreach(plugin ${qtplugins})
set(installed_plugin_paths "")
install_qt4_plugin("${plugin}" "${executable}" 0 installed_plugin_paths "${plugins_dir}" "${component}")
list(APPEND libs ${installed_plugin_paths})
endforeach()
endif()
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
DeployQt4: workaround bug 13258 where ARGV1 is leaked into a sub function.
2012-07-09 20:18:45 +04:00
resolve_qt4_paths(libs "")
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
install(CODE
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
"include(\"${DeployQt4_cmake_dir}/DeployQt4.cmake\")
set(BU_CHMOD_BUNDLE_ITEMS TRUE)
DeployQt4: Include DESTDIR for some cpack generators.
2012-08-16 05:36:50 +04:00
FIXUP_QT4_EXECUTABLE(\"\$ENV{DESTDIR}\${CMAKE_INSTALL_PREFIX}/${executable}\" \"\" \"${libs}\" \"${dirs}\" \"${plugins_dir}\" \"${request_qt_conf}\")"
Improve component support and output indentation.
2011-12-16 20:41:19 +04:00
${component}
Add DeployQt4 module. Add a module that gives better support to BundleUtilities to handle Qt plugins and deploy Qt applications.
2011-09-30 16:40:49 +04:00
)
endfunction()