mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-01 11:22:21 -06:00
1d52a6867a
- Added intro code block showing how to include this module. - Used word "commands" instead of "functions". - Updated and synced commands descriptions. - Added a very basic examples section for consistency.
1401 lines
48 KiB
CMake
1401 lines
48 KiB
CMake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
# file LICENSE.rst or https://cmake.org/licensing for details.
|
|
|
|
#[=======================================================================[.rst:
|
|
BundleUtilities
|
|
---------------
|
|
|
|
This module provides utility commands for assembling standalone,
|
|
bundle-style applications with CMake, such as macOS ``.app`` bundles or
|
|
similar directory-based application bundles on other operating systems.
|
|
|
|
Load this module in CMake installation with:
|
|
|
|
.. code-block:: cmake
|
|
|
|
include(BundleUtilities)
|
|
|
|
.. note::
|
|
|
|
Do not use this module at configure time (from ``CMakeLists.txt``).
|
|
Instead, include it and invoke its commands from an :command:`install(CODE)`
|
|
or :command:`install(SCRIPT)`.
|
|
|
|
Commands
|
|
^^^^^^^^
|
|
|
|
This module provides the following commands:
|
|
|
|
* :command:`fixup_bundle`
|
|
* :command:`copy_and_fixup_bundle`
|
|
* :command:`verify_app`
|
|
* :command:`get_bundle_main_executable`
|
|
* :command:`get_dotapp_dir`
|
|
* :command:`get_bundle_and_executable`
|
|
* :command:`get_bundle_all_executables`
|
|
* :command:`get_item_key`
|
|
* :command:`get_item_rpaths`
|
|
* :command:`clear_bundle_keys`
|
|
* :command:`set_bundle_key_values`
|
|
* :command:`get_bundle_keys`
|
|
* :command:`copy_resolved_item_into_bundle`
|
|
* :command:`copy_resolved_framework_into_bundle`
|
|
* :command:`fixup_bundle_item`
|
|
* :command:`verify_bundle_prerequisites`
|
|
* :command:`verify_bundle_symlinks`
|
|
|
|
.. command:: fixup_bundle
|
|
|
|
Prepares a bundle for distribution by fixing up its internal dependencies:
|
|
|
|
.. code-block:: cmake
|
|
|
|
fixup_bundle(<app> <libs> <dirs> [IGNORE_ITEM <files>...])
|
|
|
|
This command modifies the ``<app>`` bundle in-place to make it
|
|
self-contained and portable, so that it can be drag-n-drop copied to
|
|
another machine and run there, assuming all of the system libraries are
|
|
compatible.
|
|
|
|
This command collects all dependencies (keys) for the executables and
|
|
libraries in the bundle. For each dependency, it copies the required
|
|
files into the bundle and adjusts them according to their own
|
|
prerequisites. Once complete, it clears the collected keys and invokes
|
|
the :command:`verify_app` command to ensure the final bundle is truly
|
|
standalone.
|
|
|
|
The arguments are:
|
|
|
|
``<app>``
|
|
The path to the bundle to fix. This can be an ``.app`` directory or
|
|
direct path to an executable.
|
|
|
|
``<libs>``
|
|
A list of libraries that must be fixed up, but that cannot be
|
|
automatically determined by the ``otool`` output analysis (i.e.
|
|
``plugins``). If plugins are passed to this command as this parameter,
|
|
they should be installed or copied into the bundle before calling this
|
|
command.
|
|
|
|
``<dirs>``
|
|
A list of paths where libraries might be found. These paths are searched
|
|
first when a target without any path info is given. Then standard system
|
|
locations are also searched: ``PATH``, Framework locations, ``/usr/lib``,
|
|
etc.
|
|
|
|
``IGNORE_ITEM <files>...``
|
|
.. versionadded:: 3.6
|
|
|
|
Optional list of file names to ignore
|
|
(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``).
|
|
|
|
.. command:: copy_and_fixup_bundle
|
|
|
|
Copies the bundle and fixes up the new copied bundle in-place:
|
|
|
|
.. code-block:: cmake
|
|
|
|
copy_and_fixup_bundle(<src> <dst> <libs> <dirs>)
|
|
|
|
This command makes a copy of the bundle ``<src>`` at location ``<dst>``
|
|
and then fixes up the new copied bundle in-place at ``<dst>``.
|
|
|
|
The arguments are:
|
|
|
|
``<src>``
|
|
The directory of the bundle being copied.
|
|
|
|
``<dst>``
|
|
The destination directory of the bundle copy.
|
|
|
|
``<libs>``
|
|
A list of libraries that must be fixed up, but that cannot be
|
|
automatically determined by the ``otool`` output analysis (i.e.
|
|
``plugins``). If plugins are passed to this command as this parameter,
|
|
they should be installed or copied into the bundle before calling this
|
|
command.
|
|
|
|
``<dirs>``
|
|
A list of paths where libraries might be found. These paths are searched
|
|
first when a target without any path info is given. Then standard system
|
|
locations are also searched: ``PATH``, Framework locations, ``/usr/lib``,
|
|
etc.
|
|
|
|
.. command:: verify_app
|
|
|
|
Verifies that an application bundle appears valid based on running analysis
|
|
tools on it:
|
|
|
|
.. code-block:: cmake
|
|
|
|
verify_app(<app> [IGNORE_ITEM <files>...])
|
|
|
|
If the application fails verification, a :command:`message(FATAL_ERROR)`
|
|
is issued, halting the installation process.
|
|
|
|
The arguments are:
|
|
|
|
``<app>``
|
|
The path to the application to verify. This can be a ``.app`` directory
|
|
or a standalone executable.
|
|
|
|
``IGNORE_ITEM <files>...``
|
|
.. versionadded:: 3.6
|
|
|
|
Optional list of file names to ignore
|
|
(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``).
|
|
|
|
.. command:: get_bundle_main_executable
|
|
|
|
Retrieves the main executable within a given application bundle:
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_bundle_main_executable(<bundle> <result-var>)
|
|
|
|
The result is stored in a ``<result-var>`` variable and will contain a
|
|
full path name of the bundle's main executable file, or an ``error:``
|
|
prefixed string if it could not be determined.
|
|
|
|
.. command:: get_dotapp_dir
|
|
|
|
Locates the enclosing ``.app`` directory for the given executable:
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_dotapp_dir(<exe> <dotapp-dir-var>)
|
|
|
|
This command retrieves the nearest parent dir whose name ends with ``.app``
|
|
given the full path to an executable and stores it to the
|
|
``<dotapp-dir-var>`` variable. If there is no such parent dir, then it
|
|
simply retrieves the directory containing the executable.
|
|
|
|
The retrieved directory may or may not exist.
|
|
|
|
.. command:: get_bundle_and_executable
|
|
|
|
Takes either a ``.app`` directory name or the name of an executable
|
|
nested inside a ``.app`` directory and retrieves the path to the ``.app``
|
|
directory and the path to its main executable:
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_bundle_and_executable(<app> <bundle-var> <executable-var> <valid-var>)
|
|
|
|
The arguments are:
|
|
|
|
``<app>``
|
|
The name of the application being processed.
|
|
|
|
``<bundle-var>``
|
|
Variable name in which to store the resulting path to the ``.app``
|
|
directory. In case of any error, this variable will contain an error
|
|
message prefixed with string ``error:``.
|
|
|
|
``<executable-var>``
|
|
Variable name in which to store the resulting main executable. In case
|
|
of any error, this variable will contain an error message prefixed with
|
|
string ``error:``.
|
|
|
|
``<valid-var>``
|
|
Variable name in which the boolean result is stored whether this command
|
|
was successful or not.
|
|
|
|
.. command:: get_bundle_all_executables
|
|
|
|
Gets all executables of a given bundle:
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_bundle_all_executables(<bundle> <exes-var>)
|
|
|
|
This command scans ``<bundle>`` bundle recursively for all executable
|
|
files and stores them into a variable ``<exes-var>``.
|
|
|
|
.. command:: get_item_key
|
|
|
|
Generates a unique key for the given item:
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_item_key(<item> <key-var>)
|
|
|
|
Given ``<item>`` file name, this command generates ``<key-var>`` key that
|
|
should be unique considering the set of libraries that need copying or
|
|
fixing up to make a bundle standalone. This is essentially the file name
|
|
including extension with ``.`` replaced by ``_``.
|
|
|
|
This key is used as a prefix for CMake variables so that a set of
|
|
variables can be associated with a given item based on its key.
|
|
|
|
.. command:: get_item_rpaths
|
|
|
|
Gets RPATHS (run-time search paths) for the given item:
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_item_rpaths(<item> <rpaths-var>)
|
|
|
|
This command gets RPATHS of the ``<item>`` file name and stores them to
|
|
the variable with provided name ``<rpaths-var>``.
|
|
|
|
.. command:: clear_bundle_keys
|
|
|
|
Clears all variables associated with keys:
|
|
|
|
.. code-block:: cmake
|
|
|
|
clear_bundle_keys(<keys-var>)
|
|
|
|
This command loops over the ``<keys-var>`` list of keys, clearing all the
|
|
variables associated with each key. After the loop, it clears the list of
|
|
keys itself. This command should be called after the
|
|
:command:`get_bundle_keys` command, when done working with a list of keys.
|
|
|
|
.. command:: set_bundle_key_values
|
|
|
|
Adds a key to the list of keys:
|
|
|
|
.. code-block:: cmake
|
|
|
|
set_bundle_key_values(
|
|
<keys-var>
|
|
<context>
|
|
<item>
|
|
<exepath>
|
|
<dirs>
|
|
<copyflag>
|
|
[<rpaths>]
|
|
)
|
|
|
|
This command adds the ``<keys-var>`` key to the list (if necessary) for
|
|
the given item. If added, also set all the variables associated with
|
|
that key.
|
|
|
|
The arguments are:
|
|
|
|
``<keys-var>``
|
|
Variable name holding the name of the key to be added to the list for
|
|
the given item.
|
|
|
|
``<context>``
|
|
The path to the top level loading path used for ``@loader_path``
|
|
replacement on Apple operating systems. When resolving item,
|
|
``@loader_path`` references will be resolved relative to the directory
|
|
of the given context value (presumably another library).
|
|
|
|
``<item>``
|
|
The item for which to add the key.
|
|
|
|
``<exepath>``
|
|
The path to the top level executable used for ``@executable_path``
|
|
replacement on Apple operating systems.
|
|
|
|
``<dirs>``
|
|
A list of paths where libraries might be found. These paths are searched
|
|
first when a target without any path info is given. Then standard system
|
|
locations are also searched: ``PATH``, Framework locations, ``/usr/lib``,
|
|
etc.
|
|
|
|
``<copyflag>``
|
|
If set to ``1`` library symlink structure will be preserved.
|
|
|
|
``<rpaths>``
|
|
Optional run-time search paths for an executable file or library to help
|
|
find files.
|
|
|
|
.. command:: get_bundle_keys
|
|
|
|
Gets bundle keys:
|
|
|
|
.. code-block:: cmake
|
|
|
|
get_bundle_keys(<app> <libs> <dirs> <keys-var> [IGNORE_ITEM <files>...])
|
|
|
|
This command loops over all the executable and library files within
|
|
``<app>`` bundle (and given as extra ``<libs>``) and accumulate a list of
|
|
keys representing them. It sets values associated with each key such
|
|
that they can be looped over all of them and copies prerequisite libs into
|
|
the bundle and then does appropriate ``install_name_tool`` fixups.
|
|
|
|
The arguments are:
|
|
|
|
``<app>``
|
|
The path to the bundle to fix. This can be an ``.app`` directory or
|
|
direct path to an executable.
|
|
|
|
``<libs>``
|
|
A list of libraries that must be fixed up, but that cannot be
|
|
automatically determined by the ``otool`` output analysis (i.e.
|
|
``plugins``). If plugins are passed to this command as this parameter,
|
|
they should be installed or copied into the bundle before calling this
|
|
command.
|
|
|
|
``<dirs>``
|
|
A list of paths where libraries might be found. These paths are searched
|
|
first when a target without any path info is given. Then standard system
|
|
locations are also searched: ``PATH``, Framework locations, ``/usr/lib``,
|
|
etc.
|
|
|
|
``<keys-var>``
|
|
Variable name holding a list of keys that represent all executable and
|
|
library files within the bundle.
|
|
|
|
``IGNORE_ITEM <files>...``
|
|
.. versionadded:: 3.6
|
|
|
|
Optional list of file names to ignore
|
|
(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``).
|
|
|
|
.. command:: copy_resolved_item_into_bundle
|
|
|
|
Copies a resolved item into the bundle if necessary:
|
|
|
|
.. code-block:: cmake
|
|
|
|
copy_resolved_item_into_bundle(<resolved-item> <resolved-embedded-item>)
|
|
|
|
Copy is not necessary, if the ``<resolved-item>`` is "the same as" the
|
|
``<resolved-embedded-item>``.
|
|
|
|
.. command:: copy_resolved_framework_into_bundle
|
|
|
|
Copies a resolved framework into the bundle if necessary:
|
|
|
|
.. code-block:: cmake
|
|
|
|
copy_resolved_framework_into_bundle(<resolved-item> <resolved-embedded-item>)
|
|
|
|
Copy is not necessary, if the ``<resolved-item>`` is "the same as" the
|
|
``<resolved-embedded-item>``.
|
|
|
|
The following variables can be set before invoking this command:
|
|
|
|
``BU_COPY_FULL_FRAMEWORK_CONTENTS``
|
|
By default, this variable is not set. If full frameworks should be
|
|
embedded in the bundles, set this variable to boolean true before calling
|
|
the :command:`fixup_bundle` command. By default, this command copies
|
|
the framework dylib itself plus the framework ``Resources`` directory.
|
|
|
|
.. command:: fixup_bundle_item
|
|
|
|
Fixes up bundle item:
|
|
|
|
.. code-block:: cmake
|
|
|
|
fixup_bundle_item(<resolved-embedded-item> <exepath> <dirs>)
|
|
|
|
This command gets the direct/non-system prerequisites of the
|
|
``<resolved-embedded-item>`` and for each prerequisite, it changes the
|
|
way it is referenced to the value of the ``_EMBEDDED_ITEM`` keyed variable
|
|
for that prerequisite. Most likely changing to an ``@executable_path``
|
|
style reference.
|
|
|
|
This command requires that the ``<resolved-embedded-item>`` be ``inside``
|
|
the bundle already. In other words, if plugins are passed to
|
|
:command:`fixup_bundle` command as its ``<libs>`` parameter, they should
|
|
be installed or copied into the bundle before calling the
|
|
:command:`fixup_bundle` command.
|
|
|
|
Also, it changes the id of the item being fixed up to its own
|
|
``_EMBEDDED_ITEM`` value.
|
|
|
|
Changes are accumulated in a local variable and *one* call is made to
|
|
``install_name_tool`` command-line tool at the end of this command with
|
|
all the changes at once.
|
|
|
|
The arguments are:
|
|
|
|
``<resolved-embedded-item>``
|
|
The bundle item to be fixed up.
|
|
|
|
``<exepath>``
|
|
The path to the top level executable used for ``@executable_path``
|
|
replacement on Apple operating systems.
|
|
|
|
``<dirs>``
|
|
A list of paths where libraries might be found. These paths are searched
|
|
first when a target without any path info is given. Then standard system
|
|
locations are also searched: ``PATH``, Framework locations, ``/usr/lib``,
|
|
etc.
|
|
|
|
The following variables can be set before invoking this command:
|
|
|
|
``BU_CHMOD_BUNDLE_ITEMS``
|
|
If this variable is set to boolean true value then bundle items will be
|
|
marked writable before ``install_name_tool`` tool tries to change them.
|
|
|
|
.. command:: verify_bundle_prerequisites
|
|
|
|
Verifies that the sum of all prerequisites of all files inside the
|
|
bundle are contained within the bundle or are ``system`` libraries,
|
|
presumed to exist everywhere:
|
|
|
|
.. code-block:: cmake
|
|
|
|
verify_bundle_prerequisites(
|
|
<bundle>
|
|
<result-var>
|
|
<info-var>
|
|
[IGNORE_ITEM <files>...]
|
|
)
|
|
|
|
The arguments are:
|
|
|
|
``<bundle>``
|
|
Name of the bundle being verified.
|
|
|
|
``<result-var>``
|
|
Name of the variable in which to store a boolean result of whether a
|
|
verification was successful.
|
|
|
|
``<info-var>``
|
|
Name of the variable holding any informational messages produced by the
|
|
verification.
|
|
|
|
``IGNORE_ITEM <files>...``
|
|
.. versionadded:: 3.6
|
|
|
|
Optional list of file names to ignore
|
|
(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``).
|
|
|
|
.. command:: verify_bundle_symlinks
|
|
|
|
Verifies that any symlinks found in the specified bundle point to other
|
|
files that are already also in the bundle:
|
|
|
|
.. code-block:: cmake
|
|
|
|
verify_bundle_symlinks(<bundle> <result-var> <info-var>)
|
|
|
|
Anything that points to an external file causes this command to fail the
|
|
verification.
|
|
|
|
The arguments are:
|
|
|
|
``<bundle>``
|
|
Name of the bundle being verified.
|
|
|
|
``<result-var>``
|
|
Name of the variable in which to store a boolean result of whether a
|
|
verification was successful.
|
|
|
|
``<info-var>``
|
|
Name of the variable holding any informational messages produced by the
|
|
verification.
|
|
|
|
Examples
|
|
^^^^^^^^
|
|
|
|
Using this module inside the installation code that is executed at the
|
|
installation phase:
|
|
|
|
.. code-block:: cmake
|
|
:caption: ``CMakeLists.txt``
|
|
|
|
# ...
|
|
|
|
install(CODE "
|
|
include(BundleUtilities)
|
|
set(BU_CHMOD_BUNDLE_ITEMS TRUE)
|
|
fixup_bundle(
|
|
\"${fixup_exe}\"
|
|
\"${plugins}\"
|
|
\"${bin_dir};${library_dir};${binary_dir}\"
|
|
)
|
|
")
|
|
#]=======================================================================]
|
|
|
|
function(_warn_cmp0080)
|
|
cmake_policy(GET_WARNING CMP0080 _cmp0080_warning)
|
|
message(AUTHOR_WARNING "${_cmp0080_warning}\n")
|
|
endfunction()
|
|
|
|
# Do not include this module at configure time!
|
|
if(DEFINED CMAKE_GENERATOR)
|
|
cmake_policy(GET CMP0080 _BundleUtilities_CMP0080)
|
|
if(_BundleUtilities_CMP0080 STREQUAL "NEW")
|
|
message(FATAL_ERROR "BundleUtilities cannot be included at configure time!")
|
|
elseif(NOT _BundleUtilities_CMP0080 STREQUAL "OLD" AND NOT _CMP0080_SUPPRESS_WARNING)
|
|
_warn_cmp0080()
|
|
endif()
|
|
endif()
|
|
|
|
# The functions defined in this file depend on the get_prerequisites function
|
|
# (and possibly others) found in:
|
|
#
|
|
include("${CMAKE_CURRENT_LIST_DIR}/GetPrerequisites.cmake")
|
|
|
|
|
|
function(get_bundle_main_executable bundle result_var)
|
|
set(result "error: '${bundle}/Contents/Info.plist' file does not exist")
|
|
|
|
if(EXISTS "${bundle}/Contents/Info.plist")
|
|
set(result "error: no CFBundleExecutable in '${bundle}/Contents/Info.plist' file")
|
|
set(line_is_main_executable 0)
|
|
set(bundle_executable "")
|
|
|
|
# Read Info.plist as a list of lines:
|
|
#
|
|
set(eol_char "E")
|
|
file(READ "${bundle}/Contents/Info.plist" info_plist)
|
|
string(REPLACE ";" "\\;" info_plist "${info_plist}")
|
|
string(REPLACE "\n" "${eol_char};" info_plist "${info_plist}")
|
|
string(REPLACE "\r" "${eol_char};" info_plist "${info_plist}")
|
|
|
|
# Scan the lines for "<key>CFBundleExecutable</key>" - the line after that
|
|
# is the name of the main executable.
|
|
#
|
|
foreach(line ${info_plist})
|
|
if(line_is_main_executable)
|
|
string(REGEX REPLACE "^.*<string>(.*)</string>.*$" "\\1" bundle_executable "${line}")
|
|
break()
|
|
endif()
|
|
|
|
if(line MATCHES "<key>CFBundleExecutable</key>")
|
|
set(line_is_main_executable 1)
|
|
endif()
|
|
endforeach()
|
|
|
|
if(NOT bundle_executable STREQUAL "")
|
|
if(EXISTS "${bundle}/Contents/MacOS/${bundle_executable}")
|
|
set(result "${bundle}/Contents/MacOS/${bundle_executable}")
|
|
else()
|
|
|
|
# Ultimate goal:
|
|
# If not in "Contents/MacOS" then scan the bundle for matching files. If
|
|
# there is only one executable file that matches, then use it, otherwise
|
|
# it's an error...
|
|
#
|
|
#file(GLOB_RECURSE file_list "${bundle}/${bundle_executable}")
|
|
|
|
# But for now, pragmatically, it's an error. Expect the main executable
|
|
# for the bundle to be in Contents/MacOS, it's an error if it's not:
|
|
#
|
|
set(result "error: '${bundle}/Contents/MacOS/${bundle_executable}' does not exist")
|
|
endif()
|
|
endif()
|
|
else()
|
|
#
|
|
# More inclusive technique... (This one would work on Windows and Linux
|
|
# too, if a developer followed the typical Mac bundle naming convention...)
|
|
#
|
|
# If there is no Info.plist file, try to find an executable with the same
|
|
# base name as the .app directory:
|
|
#
|
|
endif()
|
|
|
|
set(${result_var} "${result}" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
|
|
function(get_dotapp_dir exe dotapp_dir_var)
|
|
set(s "${exe}")
|
|
|
|
if(s MATCHES "/.*\\.app/")
|
|
# If there is a ".app" parent directory,
|
|
# ascend until we hit it:
|
|
# (typical of a Mac bundle executable)
|
|
#
|
|
set(done 0)
|
|
while(NOT ${done})
|
|
get_filename_component(snamewe "${s}" NAME_WE)
|
|
get_filename_component(sname "${s}" NAME)
|
|
get_filename_component(sdir "${s}" PATH)
|
|
set(s "${sdir}")
|
|
if(sname MATCHES "\\.app$")
|
|
set(done 1)
|
|
set(dotapp_dir "${sdir}/${sname}")
|
|
endif()
|
|
endwhile()
|
|
else()
|
|
# Otherwise use a directory containing the exe
|
|
# (typical of a non-bundle executable on Mac, Windows or Linux)
|
|
#
|
|
is_file_executable("${s}" is_executable)
|
|
if(is_executable)
|
|
get_filename_component(sdir "${s}" PATH)
|
|
set(dotapp_dir "${sdir}")
|
|
else()
|
|
set(dotapp_dir "${s}")
|
|
endif()
|
|
endif()
|
|
|
|
|
|
set(${dotapp_dir_var} "${dotapp_dir}" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
|
|
function(get_bundle_and_executable app bundle_var executable_var valid_var)
|
|
set(valid 0)
|
|
|
|
if(EXISTS "${app}")
|
|
# Is it a directory ending in .app?
|
|
if(IS_DIRECTORY "${app}")
|
|
if(app MATCHES "\\.app$")
|
|
get_bundle_main_executable("${app}" executable)
|
|
if(EXISTS "${app}" AND EXISTS "${executable}")
|
|
set(${bundle_var} "${app}" PARENT_SCOPE)
|
|
set(${executable_var} "${executable}" PARENT_SCOPE)
|
|
set(valid 1)
|
|
#message(STATUS "info: handled .app directory case...")
|
|
else()
|
|
message(STATUS "warning: *NOT* handled - .app directory case...")
|
|
endif()
|
|
else()
|
|
message(STATUS "warning: *NOT* handled - directory but not .app case...")
|
|
endif()
|
|
else()
|
|
# Is it an executable file?
|
|
is_file_executable("${app}" is_executable)
|
|
if(is_executable)
|
|
get_dotapp_dir("${app}" dotapp_dir)
|
|
if(EXISTS "${dotapp_dir}")
|
|
set(${bundle_var} "${dotapp_dir}" PARENT_SCOPE)
|
|
set(${executable_var} "${app}" PARENT_SCOPE)
|
|
set(valid 1)
|
|
#message(STATUS "info: handled executable file in .app dir case...")
|
|
else()
|
|
get_filename_component(app_dir "${app}" PATH)
|
|
set(${bundle_var} "${app_dir}" PARENT_SCOPE)
|
|
set(${executable_var} "${app}" PARENT_SCOPE)
|
|
set(valid 1)
|
|
#message(STATUS "info: handled executable file in any dir case...")
|
|
endif()
|
|
else()
|
|
message(STATUS "warning: *NOT* handled - not .app dir, not executable file...")
|
|
endif()
|
|
endif()
|
|
else()
|
|
message(STATUS "warning: *NOT* handled - directory/file does not exist...")
|
|
endif()
|
|
|
|
if(NOT valid)
|
|
set(${bundle_var} "error: not a bundle" PARENT_SCOPE)
|
|
set(${executable_var} "error: not a bundle" PARENT_SCOPE)
|
|
endif()
|
|
|
|
set(${valid_var} ${valid} PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
|
|
function(get_bundle_all_executables bundle exes_var)
|
|
set(exes "")
|
|
|
|
if(UNIX)
|
|
find_program(find_cmd "find")
|
|
mark_as_advanced(find_cmd)
|
|
endif()
|
|
|
|
# find command is much quicker than checking every file one by one on Unix
|
|
# which can take long time for large bundles, and since anyway we expect
|
|
# executable to have execute flag set we can narrow the list much quicker.
|
|
if(find_cmd)
|
|
execute_process(COMMAND "${find_cmd}" "${bundle}"
|
|
-type f \( -perm -0100 -o -perm -0010 -o -perm -0001 \)
|
|
OUTPUT_VARIABLE file_list
|
|
OUTPUT_STRIP_TRAILING_WHITESPACE
|
|
)
|
|
string(REPLACE "\n" ";" file_list "${file_list}")
|
|
else()
|
|
file(GLOB_RECURSE file_list "${bundle}/*")
|
|
endif()
|
|
|
|
foreach(f ${file_list})
|
|
is_file_executable("${f}" is_executable)
|
|
if(is_executable)
|
|
set(exes ${exes} "${f}")
|
|
endif()
|
|
endforeach()
|
|
|
|
set(${exes_var} "${exes}" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
|
|
function(get_item_rpaths item rpaths_var)
|
|
if(APPLE)
|
|
find_program(otool_cmd "otool")
|
|
mark_as_advanced(otool_cmd)
|
|
endif()
|
|
|
|
if(otool_cmd)
|
|
execute_process(
|
|
COMMAND "${otool_cmd}" -l "${item}"
|
|
OUTPUT_VARIABLE load_cmds_ov
|
|
RESULT_VARIABLE otool_rv
|
|
ERROR_VARIABLE otool_ev
|
|
)
|
|
if(NOT otool_rv STREQUAL "0")
|
|
message(FATAL_ERROR "otool -l failed: ${otool_rv}\n${otool_ev}")
|
|
endif()
|
|
string(REGEX REPLACE "[^\n]+cmd LC_RPATH\n[^\n]+\n[^\n]+path ([^\n]+) \\(offset[^\n]+\n" "rpath \\1\n" load_cmds_ov "${load_cmds_ov}")
|
|
string(REGEX MATCHALL "rpath [^\n]+" load_cmds_ov "${load_cmds_ov}")
|
|
string(REGEX REPLACE "rpath " "" load_cmds_ov "${load_cmds_ov}")
|
|
if(load_cmds_ov)
|
|
foreach(rpath ${load_cmds_ov})
|
|
gp_append_unique(${rpaths_var} "${rpath}")
|
|
endforeach()
|
|
endif()
|
|
endif()
|
|
|
|
if(UNIX AND NOT APPLE)
|
|
file(READ_ELF ${item} RPATH rpath_var RUNPATH runpath_var CAPTURE_ERROR error_var)
|
|
get_filename_component(item_dir ${item} DIRECTORY)
|
|
foreach(rpath ${rpath_var} ${runpath_var})
|
|
# Substitute $ORIGIN with the exepath and add to the found rpaths
|
|
string(REPLACE "$ORIGIN" "${item_dir}" rpath "${rpath}")
|
|
gp_append_unique(${rpaths_var} "${rpath}")
|
|
endforeach()
|
|
endif()
|
|
|
|
set(${rpaths_var} ${${rpaths_var}} PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
|
|
function(get_item_key item key_var)
|
|
get_filename_component(item_name "${item}" NAME)
|
|
if(WIN32)
|
|
string(TOLOWER "${item_name}" item_name)
|
|
endif()
|
|
string(REPLACE "." "_" ${key_var} "${item_name}")
|
|
set(${key_var} ${${key_var}} PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
|
|
function(clear_bundle_keys keys_var)
|
|
foreach(key ${${keys_var}})
|
|
set(${key}_ITEM PARENT_SCOPE)
|
|
set(${key}_RESOLVED_ITEM PARENT_SCOPE)
|
|
set(${key}_DEFAULT_EMBEDDED_PATH PARENT_SCOPE)
|
|
set(${key}_EMBEDDED_ITEM PARENT_SCOPE)
|
|
set(${key}_RESOLVED_EMBEDDED_ITEM PARENT_SCOPE)
|
|
set(${key}_COPYFLAG PARENT_SCOPE)
|
|
set(${key}_RPATHS PARENT_SCOPE)
|
|
endforeach()
|
|
set(${keys_var} PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
|
|
function(set_bundle_key_values keys_var context item exepath dirs copyflag)
|
|
if(ARGC GREATER 6)
|
|
set(rpaths "${ARGV6}")
|
|
else()
|
|
set(rpaths "")
|
|
endif()
|
|
get_filename_component(item_name "${item}" NAME)
|
|
|
|
get_item_key("${item}" key)
|
|
|
|
list(LENGTH ${keys_var} length_before)
|
|
gp_append_unique(${keys_var} "${key}")
|
|
list(LENGTH ${keys_var} length_after)
|
|
|
|
if(NOT length_before EQUAL length_after)
|
|
gp_resolve_item("${context}" "${item}" "${exepath}" "${dirs}" resolved_item "${rpaths}")
|
|
|
|
gp_item_default_embedded_path("${item}" default_embedded_path)
|
|
|
|
get_item_rpaths("${resolved_item}" item_rpaths)
|
|
|
|
if((NOT item MATCHES "\\.dylib$") AND (item MATCHES "[^/]+\\.framework/"))
|
|
# For frameworks, construct the name under the embedded path from the
|
|
# opening "${item_name}.framework/" to the closing "/${item_name}":
|
|
#
|
|
string(REGEX REPLACE "^.*(${item_name}.framework/.*/?${item_name}).*$" "${default_embedded_path}/\\1" embedded_item "${item}")
|
|
else()
|
|
# For other items, just use the same name as the original, but in the
|
|
# embedded path:
|
|
#
|
|
set(embedded_item "${default_embedded_path}/${item_name}")
|
|
endif()
|
|
|
|
# Replace @executable_path and resolve ".." references:
|
|
#
|
|
string(REPLACE "@executable_path" "${exepath}" resolved_embedded_item "${embedded_item}")
|
|
get_filename_component(resolved_embedded_item "${resolved_embedded_item}" ABSOLUTE)
|
|
|
|
# *But* -- if we are not copying, then force resolved_embedded_item to be
|
|
# the same as resolved_item. In the case of multiple executables in the
|
|
# original bundle, using the default_embedded_path results in looking for
|
|
# the resolved executable next to the main bundle executable. This is here
|
|
# so that exes in the other sibling directories (like "bin") get fixed up
|
|
# properly...
|
|
#
|
|
if(NOT copyflag)
|
|
set(resolved_embedded_item "${resolved_item}")
|
|
endif()
|
|
|
|
set(${keys_var} ${${keys_var}} PARENT_SCOPE)
|
|
set(${key}_ITEM "${item}" PARENT_SCOPE)
|
|
set(${key}_RESOLVED_ITEM "${resolved_item}" PARENT_SCOPE)
|
|
set(${key}_DEFAULT_EMBEDDED_PATH "${default_embedded_path}" PARENT_SCOPE)
|
|
set(${key}_EMBEDDED_ITEM "${embedded_item}" PARENT_SCOPE)
|
|
set(${key}_RESOLVED_EMBEDDED_ITEM "${resolved_embedded_item}" PARENT_SCOPE)
|
|
set(${key}_COPYFLAG "${copyflag}" PARENT_SCOPE)
|
|
set(${key}_RPATHS "${item_rpaths}" PARENT_SCOPE)
|
|
set(${key}_RDEP_RPATHS "${rpaths}" PARENT_SCOPE)
|
|
else()
|
|
#message("warning: item key '${key}' already in the list, subsequent references assumed identical to first")
|
|
endif()
|
|
endfunction()
|
|
|
|
|
|
function(get_bundle_keys app libs dirs keys_var)
|
|
set(${keys_var} PARENT_SCOPE)
|
|
|
|
set(options)
|
|
set(oneValueArgs)
|
|
set(multiValueArgs IGNORE_ITEM)
|
|
cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
|
|
|
|
get_bundle_and_executable("${app}" bundle executable valid)
|
|
if(valid)
|
|
# Always use the exepath of the main bundle executable for @executable_path
|
|
# replacements:
|
|
#
|
|
get_filename_component(exepath "${executable}" PATH)
|
|
|
|
# But do fixups on all executables in the bundle:
|
|
#
|
|
get_bundle_all_executables("${bundle}" exes)
|
|
|
|
# Set keys for main executable first:
|
|
#
|
|
set_bundle_key_values(${keys_var} "${executable}" "${executable}" "${exepath}" "${dirs}" 0)
|
|
|
|
# Get rpaths specified by main executable:
|
|
#
|
|
get_item_key("${executable}" executable_key)
|
|
set(main_rpaths "${${executable_key}_RPATHS}")
|
|
|
|
# For each extra lib, accumulate a key as well and then also accumulate
|
|
# any of its prerequisites. (Extra libs are typically dynamically loaded
|
|
# plugins: libraries that are prerequisites for full runtime functionality
|
|
# but that do not show up in otool -L output...)
|
|
#
|
|
foreach(lib ${libs})
|
|
set_bundle_key_values(${keys_var} "${lib}" "${lib}" "${exepath}" "${dirs}" 0 "${main_rpaths}")
|
|
|
|
set(prereqs "")
|
|
get_filename_component(prereq_filename ${lib} NAME)
|
|
|
|
if(NOT prereq_filename IN_LIST CFG_IGNORE_ITEM)
|
|
get_prerequisites("${lib}" prereqs 1 1 "${exepath}" "${dirs}" "${main_rpaths}")
|
|
foreach(pr ${prereqs})
|
|
set_bundle_key_values(${keys_var} "${lib}" "${pr}" "${exepath}" "${dirs}" 1 "${main_rpaths}")
|
|
endforeach()
|
|
else()
|
|
message(STATUS "Ignoring file: ${prereq_filename}")
|
|
endif()
|
|
endforeach()
|
|
|
|
# For each executable found in the bundle, accumulate keys as we go.
|
|
# The list of keys should be complete when all prerequisites of all
|
|
# binaries in the bundle have been analyzed.
|
|
#
|
|
foreach(exe ${exes})
|
|
# Main executable is scanned first above:
|
|
#
|
|
if(NOT exe STREQUAL executable)
|
|
# Add the exe itself to the keys:
|
|
#
|
|
set_bundle_key_values(${keys_var} "${exe}" "${exe}" "${exepath}" "${dirs}" 0 "${main_rpaths}")
|
|
|
|
# Get rpaths specified by executable:
|
|
#
|
|
get_item_key("${exe}" exe_key)
|
|
set(exe_rpaths "${main_rpaths}" "${${exe_key}_RPATHS}")
|
|
else()
|
|
set(exe_rpaths "${main_rpaths}")
|
|
endif()
|
|
|
|
# Add each prerequisite to the keys:
|
|
#
|
|
set(prereqs "")
|
|
get_filename_component(prereq_filename ${exe} NAME)
|
|
|
|
if(NOT prereq_filename IN_LIST CFG_IGNORE_ITEM)
|
|
get_prerequisites("${exe}" prereqs 1 1 "${exepath}" "${dirs}" "${exe_rpaths}")
|
|
foreach(pr ${prereqs})
|
|
set_bundle_key_values(${keys_var} "${exe}" "${pr}" "${exepath}" "${dirs}" 1 "${exe_rpaths}")
|
|
endforeach()
|
|
else()
|
|
message(STATUS "Ignoring file: ${prereq_filename}")
|
|
endif()
|
|
endforeach()
|
|
|
|
# preserve library symlink structure
|
|
foreach(key ${${keys_var}})
|
|
if("${${key}_COPYFLAG}" STREQUAL "1")
|
|
if(IS_SYMLINK "${${key}_RESOLVED_ITEM}")
|
|
get_filename_component(target "${${key}_RESOLVED_ITEM}" REALPATH)
|
|
set_bundle_key_values(${keys_var} "${exe}" "${target}" "${exepath}" "${dirs}" 1 "${exe_rpaths}")
|
|
get_item_key("${target}" targetkey)
|
|
|
|
if(WIN32)
|
|
# ignore case on Windows
|
|
string(TOLOWER "${${key}_RESOLVED_ITEM}" resolved_item_compare)
|
|
string(TOLOWER "${${targetkey}_RESOLVED_EMBEDDED_ITEM}" resolved_embedded_item_compare)
|
|
else()
|
|
set(resolved_item_compare "${${key}_RESOLVED_ITEM}")
|
|
set(resolved_embedded_item_compare "${${targetkey}_RESOLVED_EMBEDDED_ITEM}")
|
|
endif()
|
|
get_filename_component(resolved_item_compare "${resolved_item_compare}" NAME)
|
|
get_filename_component(resolved_embedded_item_compare "${resolved_embedded_item_compare}" NAME)
|
|
|
|
if(NOT resolved_item_compare STREQUAL resolved_embedded_item_compare)
|
|
set(${key}_COPYFLAG "2")
|
|
set(${key}_RESOLVED_ITEM "${${targetkey}_RESOLVED_EMBEDDED_ITEM}")
|
|
endif()
|
|
|
|
endif()
|
|
endif()
|
|
endforeach()
|
|
# Propagate values to caller's scope:
|
|
#
|
|
set(${keys_var} ${${keys_var}} PARENT_SCOPE)
|
|
foreach(key ${${keys_var}})
|
|
set(${key}_ITEM "${${key}_ITEM}" PARENT_SCOPE)
|
|
set(${key}_RESOLVED_ITEM "${${key}_RESOLVED_ITEM}" PARENT_SCOPE)
|
|
set(${key}_DEFAULT_EMBEDDED_PATH "${${key}_DEFAULT_EMBEDDED_PATH}" PARENT_SCOPE)
|
|
set(${key}_EMBEDDED_ITEM "${${key}_EMBEDDED_ITEM}" PARENT_SCOPE)
|
|
set(${key}_RESOLVED_EMBEDDED_ITEM "${${key}_RESOLVED_EMBEDDED_ITEM}" PARENT_SCOPE)
|
|
set(${key}_COPYFLAG "${${key}_COPYFLAG}" PARENT_SCOPE)
|
|
set(${key}_RPATHS "${${key}_RPATHS}" PARENT_SCOPE)
|
|
set(${key}_RDEP_RPATHS "${${key}_RDEP_RPATHS}" PARENT_SCOPE)
|
|
endforeach()
|
|
endif()
|
|
endfunction()
|
|
|
|
function(link_resolved_item_into_bundle resolved_item resolved_embedded_item)
|
|
if(WIN32)
|
|
# ignore case on Windows
|
|
string(TOLOWER "${resolved_item}" resolved_item_compare)
|
|
string(TOLOWER "${resolved_embedded_item}" resolved_embedded_item_compare)
|
|
else()
|
|
set(resolved_item_compare "${resolved_item}")
|
|
set(resolved_embedded_item_compare "${resolved_embedded_item}")
|
|
endif()
|
|
|
|
if(resolved_item_compare STREQUAL resolved_embedded_item_compare)
|
|
message(STATUS "warning: resolved_item == resolved_embedded_item - not linking...")
|
|
else()
|
|
get_filename_component(target_dir "${resolved_embedded_item}" DIRECTORY)
|
|
file(RELATIVE_PATH symlink_target "${target_dir}" "${resolved_item}")
|
|
if (NOT EXISTS "${target_dir}")
|
|
file(MAKE_DIRECTORY "${target_dir}")
|
|
endif()
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink "${symlink_target}" "${resolved_embedded_item}")
|
|
endif()
|
|
endfunction()
|
|
|
|
function(copy_resolved_item_into_bundle resolved_item resolved_embedded_item)
|
|
if(WIN32)
|
|
# ignore case on Windows
|
|
string(TOLOWER "${resolved_item}" resolved_item_compare)
|
|
string(TOLOWER "${resolved_embedded_item}" resolved_embedded_item_compare)
|
|
else()
|
|
set(resolved_item_compare "${resolved_item}")
|
|
set(resolved_embedded_item_compare "${resolved_embedded_item}")
|
|
endif()
|
|
|
|
if(resolved_item_compare STREQUAL resolved_embedded_item_compare)
|
|
message(STATUS "warning: resolved_item == resolved_embedded_item - not copying...")
|
|
else()
|
|
#message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy ${resolved_item} ${resolved_embedded_item}")
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E copy "${resolved_item}" "${resolved_embedded_item}")
|
|
if(UNIX AND NOT APPLE)
|
|
file(RPATH_REMOVE FILE "${resolved_embedded_item}")
|
|
endif()
|
|
endif()
|
|
|
|
endfunction()
|
|
|
|
|
|
function(copy_resolved_framework_into_bundle resolved_item resolved_embedded_item)
|
|
if(WIN32)
|
|
# ignore case on Windows
|
|
string(TOLOWER "${resolved_item}" resolved_item_compare)
|
|
string(TOLOWER "${resolved_embedded_item}" resolved_embedded_item_compare)
|
|
else()
|
|
set(resolved_item_compare "${resolved_item}")
|
|
set(resolved_embedded_item_compare "${resolved_embedded_item}")
|
|
endif()
|
|
|
|
if(resolved_item_compare STREQUAL resolved_embedded_item_compare)
|
|
message(STATUS "warning: resolved_item == resolved_embedded_item - not copying...")
|
|
else()
|
|
if(BU_COPY_FULL_FRAMEWORK_CONTENTS)
|
|
# Full Framework (everything):
|
|
get_filename_component(resolved_dir "${resolved_item}" PATH)
|
|
get_filename_component(resolved_dir "${resolved_dir}/../.." ABSOLUTE)
|
|
get_filename_component(resolved_embedded_dir "${resolved_embedded_item}" PATH)
|
|
get_filename_component(resolved_embedded_dir "${resolved_embedded_dir}/../.." ABSOLUTE)
|
|
#message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy_directory '${resolved_dir}' '${resolved_embedded_dir}'")
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E copy_directory "${resolved_dir}" "${resolved_embedded_dir}")
|
|
else()
|
|
# Framework lib itself:
|
|
#message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy ${resolved_item} ${resolved_embedded_item}")
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E copy "${resolved_item}" "${resolved_embedded_item}")
|
|
|
|
# Plus Resources, if they exist:
|
|
string(REGEX REPLACE "^(.*)/[^/]+$" "\\1/Resources" resolved_resources "${resolved_item}")
|
|
string(REGEX REPLACE "^(.*)/[^/]+$" "\\1/Resources" resolved_embedded_resources "${resolved_embedded_item}")
|
|
if(EXISTS "${resolved_resources}")
|
|
#message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy_directory '${resolved_resources}' '${resolved_embedded_resources}'")
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E copy_directory "${resolved_resources}" "${resolved_embedded_resources}")
|
|
endif()
|
|
|
|
# Some frameworks e.g. Qt put Info.plist in wrong place, so when it is
|
|
# missing in resources, copy it from other well known incorrect locations:
|
|
if(NOT EXISTS "${resolved_resources}/Info.plist")
|
|
# Check for Contents/Info.plist in framework root (older Qt SDK):
|
|
string(REGEX REPLACE "^(.*)/[^/]+/[^/]+/[^/]+$" "\\1/Contents/Info.plist" resolved_info_plist "${resolved_item}")
|
|
string(REGEX REPLACE "^(.*)/[^/]+$" "\\1/Resources/Info.plist" resolved_embedded_info_plist "${resolved_embedded_item}")
|
|
if(EXISTS "${resolved_info_plist}")
|
|
#message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy_directory '${resolved_info_plist}' '${resolved_embedded_info_plist}'")
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E copy "${resolved_info_plist}" "${resolved_embedded_info_plist}")
|
|
endif()
|
|
endif()
|
|
|
|
# Check if framework is versioned and fix it layout
|
|
string(REGEX REPLACE "^.*/([^/]+)/[^/]+$" "\\1" resolved_embedded_version "${resolved_embedded_item}")
|
|
string(REGEX REPLACE "^(.*)/[^/]+/[^/]+$" "\\1" resolved_embedded_versions "${resolved_embedded_item}")
|
|
string(REGEX REPLACE "^.*/([^/]+)/[^/]+/[^/]+$" "\\1" resolved_embedded_versions_basename "${resolved_embedded_item}")
|
|
if(resolved_embedded_versions_basename STREQUAL "Versions")
|
|
# Ensure Current symlink points to the framework version
|
|
if(NOT EXISTS "${resolved_embedded_versions}/Current")
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink "${resolved_embedded_version}" "${resolved_embedded_versions}/Current")
|
|
endif()
|
|
# Restore symlinks in framework root pointing to current framework
|
|
# binary and resources:
|
|
string(REGEX REPLACE "^(.*)/[^/]+/[^/]+/[^/]+$" "\\1" resolved_embedded_root "${resolved_embedded_item}")
|
|
string(REGEX REPLACE "^.*/([^/]+)$" "\\1" resolved_embedded_item_basename "${resolved_embedded_item}")
|
|
if(NOT EXISTS "${resolved_embedded_root}/${resolved_embedded_item_basename}")
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink "Versions/Current/${resolved_embedded_item_basename}" "${resolved_embedded_root}/${resolved_embedded_item_basename}")
|
|
endif()
|
|
if(NOT EXISTS "${resolved_embedded_root}/Resources")
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink "Versions/Current/Resources" "${resolved_embedded_root}/Resources")
|
|
endif()
|
|
endif()
|
|
endif()
|
|
if(UNIX AND NOT APPLE)
|
|
file(RPATH_REMOVE FILE "${resolved_embedded_item}")
|
|
endif()
|
|
endif()
|
|
|
|
endfunction()
|
|
|
|
|
|
function(fixup_bundle_item resolved_embedded_item exepath dirs)
|
|
# This item's key is "ikey":
|
|
#
|
|
get_item_key("${resolved_embedded_item}" ikey)
|
|
|
|
# Ensure the item is "inside the .app bundle" -- it should not be fixed up if
|
|
# it is not in the .app bundle... Otherwise, we'll modify files in the build
|
|
# tree, or in other varied locations around the file system, with our call to
|
|
# install_name_tool. Make sure that doesn't happen here:
|
|
#
|
|
get_dotapp_dir("${exepath}" exe_dotapp_dir)
|
|
string(LENGTH "${exe_dotapp_dir}/" exe_dotapp_dir_length)
|
|
string(LENGTH "${resolved_embedded_item}" resolved_embedded_item_length)
|
|
set(path_too_short 0)
|
|
set(is_embedded 0)
|
|
if(resolved_embedded_item_length LESS exe_dotapp_dir_length)
|
|
set(path_too_short 1)
|
|
endif()
|
|
if(NOT path_too_short)
|
|
string(SUBSTRING "${resolved_embedded_item}" 0 ${exe_dotapp_dir_length} item_substring)
|
|
if("${exe_dotapp_dir}/" STREQUAL item_substring)
|
|
set(is_embedded 1)
|
|
endif()
|
|
endif()
|
|
if(NOT is_embedded)
|
|
message(" exe_dotapp_dir/='${exe_dotapp_dir}/'")
|
|
message(" item_substring='${item_substring}'")
|
|
message(" resolved_embedded_item='${resolved_embedded_item}'")
|
|
message("")
|
|
message("Install or copy the item into the bundle before calling fixup_bundle.")
|
|
message("Or maybe there's a typo or incorrect path in one of the args to fixup_bundle?")
|
|
message("")
|
|
message(FATAL_ERROR "cannot fixup an item that is not in the bundle...")
|
|
endif()
|
|
|
|
set(rpaths "${${ikey}_RPATHS}" "${${ikey}_RDEP_RPATHS}")
|
|
|
|
set(prereqs "")
|
|
get_prerequisites("${resolved_embedded_item}" prereqs 1 0 "${exepath}" "${dirs}" "${rpaths}")
|
|
|
|
set(changes "")
|
|
|
|
foreach(pr ${prereqs})
|
|
# Each referenced item's key is "rkey" in the loop:
|
|
#
|
|
get_item_key("${pr}" rkey)
|
|
|
|
if(NOT "${${rkey}_EMBEDDED_ITEM}" STREQUAL "")
|
|
set(changes ${changes} "-change" "${pr}" "${${rkey}_EMBEDDED_ITEM}")
|
|
else()
|
|
message("warning: unexpected reference to '${pr}'")
|
|
endif()
|
|
endforeach()
|
|
|
|
# CMAKE_INSTALL_NAME_TOOL may not be set if executed in script mode
|
|
# Duplicated from CMakeFindBinUtils.cmake
|
|
find_program(CMAKE_INSTALL_NAME_TOOL NAMES install_name_tool HINTS ${_CMAKE_TOOLCHAIN_LOCATION})
|
|
|
|
# Only if install_name_tool supports -delete_rpath:
|
|
#
|
|
execute_process(COMMAND ${CMAKE_INSTALL_NAME_TOOL}
|
|
OUTPUT_VARIABLE install_name_tool_usage
|
|
ERROR_VARIABLE install_name_tool_usage
|
|
)
|
|
if(install_name_tool_usage MATCHES ".*-delete_rpath.*")
|
|
foreach(rpath ${${ikey}_RPATHS})
|
|
set(changes ${changes} -delete_rpath "${rpath}")
|
|
endforeach()
|
|
endif()
|
|
|
|
if(${ikey}_EMBEDDED_ITEM)
|
|
set(changes ${changes} -id "${${ikey}_EMBEDDED_ITEM}")
|
|
endif()
|
|
|
|
# Change this item's id and all of its references in one call
|
|
# to install_name_tool:
|
|
#
|
|
if(changes)
|
|
# Check for a script by extension (.bat,.sh,...) or if the file starts with "#!" (shebang)
|
|
file(READ ${resolved_embedded_item} file_contents LIMIT 5)
|
|
if(NOT "${resolved_embedded_item}" MATCHES "\\.(bat|c?sh|bash|ksh|cmd)$" AND
|
|
NOT file_contents MATCHES "^#!")
|
|
set(cmd ${CMAKE_INSTALL_NAME_TOOL} ${changes} "${resolved_embedded_item}")
|
|
if(BU_CHMOD_BUNDLE_ITEMS)
|
|
execute_process(COMMAND chmod u+w "${resolved_embedded_item}")
|
|
endif()
|
|
execute_process(COMMAND ${cmd} RESULT_VARIABLE install_name_tool_result)
|
|
if(NOT install_name_tool_result EQUAL 0)
|
|
string(REPLACE ";" "' '" msg "'${cmd}'")
|
|
message(FATAL_ERROR "Command failed:\n ${msg}")
|
|
endif()
|
|
endif()
|
|
endif()
|
|
endfunction()
|
|
|
|
|
|
function(fixup_bundle app libs dirs)
|
|
message(STATUS "fixup_bundle")
|
|
message(STATUS " app='${app}'")
|
|
message(STATUS " libs='${libs}'")
|
|
message(STATUS " dirs='${dirs}'")
|
|
|
|
set(options)
|
|
set(oneValueArgs)
|
|
set(multiValueArgs IGNORE_ITEM)
|
|
cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
|
|
|
|
message(STATUS " ignoreItems='${CFG_IGNORE_ITEM}'")
|
|
|
|
get_bundle_and_executable("${app}" bundle executable valid)
|
|
if(valid)
|
|
get_filename_component(exepath "${executable}" PATH)
|
|
|
|
message(STATUS "fixup_bundle: preparing...")
|
|
get_bundle_keys("${app}" "${libs}" "${dirs}" keys IGNORE_ITEM "${CFG_IGNORE_ITEM}")
|
|
|
|
message(STATUS "fixup_bundle: copying...")
|
|
list(LENGTH keys n)
|
|
math(EXPR n ${n}*2)
|
|
|
|
set(i 0)
|
|
foreach(key ${keys})
|
|
math(EXPR i ${i}+1)
|
|
if("${${key}_COPYFLAG}" STREQUAL "2")
|
|
message(STATUS "${i}/${n}: linking '${${key}_RESOLVED_ITEM}' -> '${${key}_RESOLVED_EMBEDDED_ITEM}'")
|
|
elseif(${${key}_COPYFLAG})
|
|
message(STATUS "${i}/${n}: copying '${${key}_RESOLVED_ITEM}'")
|
|
else()
|
|
message(STATUS "${i}/${n}: *NOT* copying '${${key}_RESOLVED_ITEM}'")
|
|
endif()
|
|
|
|
set(show_status 0)
|
|
if(show_status)
|
|
message(STATUS "key='${key}'")
|
|
message(STATUS "item='${${key}_ITEM}'")
|
|
message(STATUS "resolved_item='${${key}_RESOLVED_ITEM}'")
|
|
message(STATUS "default_embedded_path='${${key}_DEFAULT_EMBEDDED_PATH}'")
|
|
message(STATUS "embedded_item='${${key}_EMBEDDED_ITEM}'")
|
|
message(STATUS "resolved_embedded_item='${${key}_RESOLVED_EMBEDDED_ITEM}'")
|
|
message(STATUS "copyflag='${${key}_COPYFLAG}'")
|
|
message(STATUS "")
|
|
endif()
|
|
|
|
if("${${key}_COPYFLAG}" STREQUAL "2")
|
|
link_resolved_item_into_bundle("${${key}_RESOLVED_ITEM}"
|
|
"${${key}_RESOLVED_EMBEDDED_ITEM}")
|
|
elseif(${${key}_COPYFLAG})
|
|
set(item "${${key}_ITEM}")
|
|
if(item MATCHES "[^/]+\\.framework/")
|
|
copy_resolved_framework_into_bundle("${${key}_RESOLVED_ITEM}"
|
|
"${${key}_RESOLVED_EMBEDDED_ITEM}")
|
|
else()
|
|
copy_resolved_item_into_bundle("${${key}_RESOLVED_ITEM}"
|
|
"${${key}_RESOLVED_EMBEDDED_ITEM}")
|
|
endif()
|
|
endif()
|
|
endforeach()
|
|
|
|
message(STATUS "fixup_bundle: fixing...")
|
|
foreach(key ${keys})
|
|
math(EXPR i ${i}+1)
|
|
if(APPLE)
|
|
message(STATUS "${i}/${n}: fixing up '${${key}_RESOLVED_EMBEDDED_ITEM}'")
|
|
if(NOT "${${key}_COPYFLAG}" STREQUAL "2")
|
|
fixup_bundle_item("${${key}_RESOLVED_EMBEDDED_ITEM}" "${exepath}" "${dirs}")
|
|
endif()
|
|
else()
|
|
message(STATUS "${i}/${n}: fix-up not required on this platform '${${key}_RESOLVED_EMBEDDED_ITEM}'")
|
|
endif()
|
|
endforeach()
|
|
|
|
message(STATUS "fixup_bundle: cleaning up...")
|
|
clear_bundle_keys(keys)
|
|
|
|
message(STATUS "fixup_bundle: verifying...")
|
|
verify_app("${app}" IGNORE_ITEM "${CFG_IGNORE_ITEM}")
|
|
else()
|
|
message(SEND_ERROR "error: fixup_bundle: not a valid bundle")
|
|
endif()
|
|
|
|
message(STATUS "fixup_bundle: done")
|
|
endfunction()
|
|
|
|
|
|
function(copy_and_fixup_bundle src dst libs dirs)
|
|
execute_process(COMMAND ${CMAKE_COMMAND} -E copy_directory "${src}" "${dst}")
|
|
fixup_bundle("${dst}" "${libs}" "${dirs}")
|
|
endfunction()
|
|
|
|
|
|
function(verify_bundle_prerequisites bundle result_var info_var)
|
|
set(result 1)
|
|
set(info "")
|
|
set(count 0)
|
|
|
|
set(options)
|
|
set(oneValueArgs)
|
|
set(multiValueArgs IGNORE_ITEM)
|
|
cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
|
|
|
|
get_bundle_main_executable("${bundle}" main_bundle_exe)
|
|
|
|
get_bundle_all_executables("${bundle}" file_list)
|
|
foreach(f ${file_list})
|
|
get_filename_component(exepath "${f}" PATH)
|
|
math(EXPR count "${count} + 1")
|
|
|
|
message(STATUS "executable file ${count}: ${f}")
|
|
|
|
set(prereqs "")
|
|
get_filename_component(prereq_filename ${f} NAME)
|
|
|
|
if(NOT prereq_filename IN_LIST CFG_IGNORE_ITEM)
|
|
get_item_rpaths(${f} _main_exe_rpaths)
|
|
get_prerequisites("${f}" prereqs 1 1 "${exepath}" "${_main_exe_rpaths}")
|
|
|
|
# On the Mac,
|
|
# "embedded" and "system" prerequisites are fine... anything else means
|
|
# the bundle's prerequisites are not verified (i.e., the bundle is not
|
|
# really "standalone")
|
|
#
|
|
# On Windows (and others? Linux/Unix/...?)
|
|
# "local" and "system" prereqs are fine...
|
|
#
|
|
|
|
set(external_prereqs "")
|
|
|
|
foreach(p ${prereqs})
|
|
set(p_type "")
|
|
gp_file_type("${f}" "${p}" p_type)
|
|
|
|
if(APPLE)
|
|
if(NOT p_type STREQUAL "embedded" AND NOT p_type STREQUAL "system")
|
|
set(external_prereqs ${external_prereqs} "${p}")
|
|
endif()
|
|
else()
|
|
if(NOT p_type STREQUAL "local" AND NOT p_type STREQUAL "system")
|
|
set(external_prereqs ${external_prereqs} "${p}")
|
|
endif()
|
|
endif()
|
|
endforeach()
|
|
|
|
if(external_prereqs)
|
|
# Found non-system/somehow-unacceptable prerequisites:
|
|
set(result 0)
|
|
set(info ${info} "external prerequisites found:\nf='${f}'\nexternal_prereqs='${external_prereqs}'\n")
|
|
endif()
|
|
else()
|
|
message(STATUS "Ignoring file: ${prereq_filename}")
|
|
endif()
|
|
endforeach()
|
|
|
|
if(result)
|
|
set(info "Verified ${count} executable files in '${bundle}'")
|
|
endif()
|
|
|
|
set(${result_var} "${result}" PARENT_SCOPE)
|
|
set(${info_var} "${info}" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
|
|
function(verify_bundle_symlinks bundle result_var info_var)
|
|
set(result 1)
|
|
set(info "")
|
|
set(count 0)
|
|
|
|
# TODO: implement this function for real...
|
|
# Right now, it is just a stub that verifies unconditionally...
|
|
|
|
set(${result_var} "${result}" PARENT_SCOPE)
|
|
set(${info_var} "${info}" PARENT_SCOPE)
|
|
endfunction()
|
|
|
|
|
|
function(verify_app app)
|
|
set(verified 0)
|
|
set(info "")
|
|
|
|
set(options)
|
|
set(oneValueArgs)
|
|
set(multiValueArgs IGNORE_ITEM)
|
|
cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
|
|
|
|
get_bundle_and_executable("${app}" bundle executable valid)
|
|
|
|
message(STATUS "===========================================================================")
|
|
message(STATUS "Analyzing app='${app}'")
|
|
message(STATUS "bundle='${bundle}'")
|
|
message(STATUS "executable='${executable}'")
|
|
message(STATUS "valid='${valid}'")
|
|
|
|
# Verify that the bundle does not have any "external" prerequisites:
|
|
#
|
|
verify_bundle_prerequisites("${bundle}" verified info IGNORE_ITEM "${CFG_IGNORE_ITEM}")
|
|
message(STATUS "verified='${verified}'")
|
|
message(STATUS "info='${info}'")
|
|
message(STATUS "")
|
|
|
|
if(verified)
|
|
# Verify that the bundle does not have any symlinks to external files:
|
|
#
|
|
verify_bundle_symlinks("${bundle}" verified info)
|
|
message(STATUS "verified='${verified}'")
|
|
message(STATUS "info='${info}'")
|
|
message(STATUS "")
|
|
endif()
|
|
|
|
if(NOT verified)
|
|
message(FATAL_ERROR "error: verify_app failed")
|
|
endif()
|
|
endfunction()
|