diff options
Diffstat (limited to 'modules/ECMConfiguredInstall.cmake')
| -rw-r--r-- | modules/ECMConfiguredInstall.cmake | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/modules/ECMConfiguredInstall.cmake b/modules/ECMConfiguredInstall.cmake new file mode 100644 index 00000000..cbf51f5b --- /dev/null +++ b/modules/ECMConfiguredInstall.cmake @@ -0,0 +1,100 @@ +#.rst: +# ECMConfiguredInstall +# -------------------- +# +# Takes a list of files, runs configure_file on each and installs the resultant configured files in the given location. +# +# Any suffix of ".in" in the passed file names wil be stripped from the file name at the installed location. +# +# :: +# +# ecm_install_configured_files( +# INPUT <file> [<file2> [...]] +# DESTINATION <INSTALL_DIRECTORY> +# [COPYONLY] +# [ESCAPE_QUOTES] +# [@ONLY] +# [COMPONENT <component>]) +# +# Example usage: +# +# .. code-block:: cmake +# +# ecm_install_configured_files(INPUT foo.txt.in DESTINATION ${KDE_INSTALL_DATADIR} @ONLY) +# +# This wil install the file as foo.txt with any cmake variable replacements made into the data directory. +# +# Since 5.73.0. + +# Copyright 2020 David Edmundson <davidedmundson@kde.org> +# +# 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. + +function(ecm_install_configured_files) + set(options COPYONLY ESCAPE_QUOTES @ONLY) + set(oneValueArgs DESTINATION COMPONENT) + set(multiValueArgs INPUT) + + cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" + "${multiValueArgs}" ${ARGN}) + + + if(ARGS_UNPARSED_ARGUMENTS) + message(FATAL_ERROR "Unknown arguments given to ecm_install_configured_file(): \"${ARGS_UNPARSED_ARGUMENTS}\"") + endif() + + if (NOT ARGS_DESTINATION) + message(FATAL_ERROR "missing DESTINATION argument to ECMConfiguredInstall") + endif() + + foreach(_input ${ARGS_INPUT}) + # convert absolute paths + get_filename_component(_name ${_input} NAME) + + string(REGEX REPLACE "\\.in$" "" _name ${_name}) + + set(_out_file ${CMAKE_CURRENT_BINARY_DIR}/${_name}) + + set(_configure_args) + if (ARGS_COPY_ONLY) + list(APPEND _configure_args COPY_ONLY) + endif() + if (ARGS_ESCAPE_QUOTES) + list(APPEND _configure_args ESCAPE_QUOTES) + endif() + if (ARGS_@ONLY) + list(APPEND _configure_args @ONLY) + endif() + + configure_file(${_input} ${_out_file} ${_configure_args}) + + if (DEFINED ARGS_COMPONENT) + set(_component COMPONENT ${ARGS_COMPONENT}) + else() + set(_component) + endif() + + install(FILES ${_out_file} DESTINATION ${ARGS_DESTINATION} ${_component}) + endforeach() +endfunction() |