BundleUtilities.cmake 40.5 KB
Newer Older
1 2 3
# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.

4 5 6 7 8 9
#[=======================================================================[.rst:
BundleUtilities
---------------

Functions to help assemble a standalone bundle application.

10
A collection of CMake utility functions useful for dealing with ``.app``
11 12 13 14
bundles on the Mac and bundle-like directories on any OS.

The following functions are provided by this module:

15
.. code-block:: cmake
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

   fixup_bundle
   copy_and_fixup_bundle
   verify_app
   get_bundle_main_executable
   get_dotapp_dir
   get_bundle_and_executable
   get_bundle_all_executables
   get_item_key
   get_item_rpaths
   clear_bundle_keys
   set_bundle_key_values
   get_bundle_keys
   copy_resolved_item_into_bundle
   copy_resolved_framework_into_bundle
   fixup_bundle_item
   verify_bundle_prerequisites
   verify_bundle_symlinks

Requires CMake 2.6 or greater because it uses function, break and
36
``PARENT_SCOPE``.  Also depends on ``GetPrerequisites.cmake``.
37

38 39 40 41
DO NOT USE THESE FUNCTIONS AT CONFIGURE TIME (from ``CMakeLists.txt``)!
Instead, invoke them from an :command:`install(CODE)` or
:command:`install(SCRIPT)` rule.

42
.. code-block:: cmake
43

44
  fixup_bundle(<app> <libs> <dirs>)
45

46
Fix up ``<app>`` bundle in-place and make it standalone, such that it can be
47 48 49
drag-n-drop copied to another machine and run on that machine as long
as all of the system libraries are compatible.

50 51 52 53
If you pass plugins to ``fixup_bundle`` as the libs parameter, you should
install them or copy them into the bundle before calling ``fixup_bundle``.
The ``<libs>`` parameter is a list of libraries that must be fixed up, but
that cannot be determined by ``otool`` output analysis  (i.e. ``plugins``).
54 55 56 57 58

Gather all the keys for all the executables and libraries in a bundle,
and then, for each key, copy each prerequisite into the bundle.  Then
fix each one up according to its own list of prerequisites.

59
Then clear all the keys and call ``verify_app`` on the final bundle to
60 61
ensure that it is truly standalone.

62 63 64
As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
which are then ignored
(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``).
65

66
.. code-block:: cmake
67

68
  copy_and_fixup_bundle(<src> <dst> <libs> <dirs>)
69

70 71
Makes a copy of the bundle ``<src>`` at location ``<dst>`` and then fixes up
the new copied bundle in-place at ``<dst>``.
72

73
.. code-block:: cmake
74

75
  verify_app(<app>)
76

77 78
Verifies that an application ``<app>`` appears valid based on running
analysis tools on it.  Calls :command:`message(FATAL_ERROR)` if the application
79 80
is not verified.

81 82 83
As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
which are then ignored
(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``)
84

85
.. code-block:: cmake
86

87
  get_bundle_main_executable(<bundle> <result_var>)
88 89

The result will be the full path name of the bundle's main executable
90
file or an ``error:`` prefixed string if it could not be determined.
91

92
.. code-block:: cmake
93

94
  get_dotapp_dir(<exe> <dotapp_dir_var>)
95

96
Returns the nearest parent dir whose name ends with ``.app`` given the
97 98 99 100 101
full path to an executable.  If there is no such parent dir, then
simply return the dir containing the executable.

The returned directory may or may not exist.

102
.. code-block:: cmake
103

104
  get_bundle_and_executable(<app> <bundle_var> <executable_var> <valid_var>)
105

106 107 108 109
Takes either a ``.app`` directory name or the name of an executable
nested inside a ``.app`` directory and returns the path to the ``.app``
directory in ``<bundle_var>`` and the path to its main executable in
``<executable_var>``.
110

111
.. code-block:: cmake
112

113
  get_bundle_all_executables(<bundle> <exes_var>)
114

115 116
Scans ``<bundle>`` bundle recursively for all ``<exes_var>`` executable
files and accumulates them into a variable.
117

118
.. code-block:: cmake
119

120
  get_item_key(<item> <key_var>)
121

122
Given ``<item>`` file name, generate ``<key_var>`` key that should be unique
123 124
considering the set of libraries that need copying or fixing up to
make a bundle standalone.  This is essentially the file name including
125
extension with ``.`` replaced by ``_``
126 127 128 129

This key is used as a prefix for CMake variables so that we can
associate a set of variables with a given item based on its key.

130
.. code-block:: cmake
131

132
  clear_bundle_keys(<keys_var>)
133

134 135
Loop over the ``<keys_var>`` list of keys, clearing all the variables
associated with each key.  After the loop, clear the list of keys itself.
136

137
Caller of ``get_bundle_keys`` should call ``clear_bundle_keys`` when done with
138 139
list of keys.

140
.. code-block:: cmake
141

142
  set_bundle_key_values(<keys_var> <context> <item> <exepath> <dirs>
143 144
                        <copyflag> [<rpaths>])

145 146
Add ``<keys_var>`` key to the list (if necessary) for the given item.
If added, also set all the variables associated with that key.
147

148
.. code-block:: cmake
149

150
  get_bundle_keys(<app> <libs> <dirs> <keys_var>)
151

152 153
Loop over all the executable and library files within ``<app>`` bundle (and
given as extra ``<libs>``) and accumulate a list of keys representing
154 155
them.  Set values associated with each key such that we can loop over
all of them and copy prerequisite libs into the bundle and then do
156
appropriate ``install_name_tool`` fixups.
157

158 159 160
As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
which are then ignored
(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``)
161

162
.. code-block:: cmake
163

164
  copy_resolved_item_into_bundle(<resolved_item> <resolved_embedded_item>)
165

166 167 168
Copy a resolved item into the bundle if necessary.
Copy is not necessary, if the ``<resolved_item>`` is "the same as" the
``<resolved_embedded_item>``.
169

170
.. code-block:: cmake
171

172
  copy_resolved_framework_into_bundle(<resolved_item> <resolved_embedded_item>)
173

174 175 176
Copy a resolved framework into the bundle if necessary.
Copy is not necessary, if the ``<resolved_item>`` is "the same as" the
``<resolved_embedded_item>``.
177

178
By default, ``BU_COPY_FULL_FRAMEWORK_CONTENTS`` is not set.  If you want
179
full frameworks embedded in your bundles, set
180 181 182
``BU_COPY_FULL_FRAMEWORK_CONTENTS`` to ``ON`` before calling fixup_bundle.  By
default, ``COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE`` copies the framework
dylib itself plus the framework ``Resources`` directory.
183

184
.. code-block:: cmake
185

186
  fixup_bundle_item(<resolved_embedded_item> <exepath> <dirs>)
187

188
Get the direct/non-system prerequisites of the ``<resolved_embedded_item>``.
189
For each prerequisite, change the way it is referenced to the value of
190 191
the ``_EMBEDDED_ITEM`` keyed variable for that prerequisite.  (Most likely
changing to an ``@executable_path`` style reference.)
192

193 194
This function requires that the ``<resolved_embedded_item>`` be ``inside``
the bundle already.  In other words, if you pass plugins to ``fixup_bundle``
195
as the libs parameter, you should install them or copy them into the
196
bundle before calling ``fixup_bundle``.  The ``libs`` parameter is a list of
197
libraries that must be fixed up, but that cannot be determined by
198
otool output analysis.  (i.e., ``plugins``)
199 200

Also, change the id of the item being fixed up to its own
201
``_EMBEDDED_ITEM`` value.
202 203

Accumulate changes in a local variable and make *one* call to
204
``install_name_tool`` at the end of the function with all the changes at
205 206
once.

207 208
If the ``BU_CHMOD_BUNDLE_ITEMS`` variable is set then bundle items will be
marked writable before ``install_name_tool`` tries to change them.
209

210
.. code-block:: cmake
211

212
  verify_bundle_prerequisites(<bundle> <result_var> <info_var>)
213 214

Verifies that the sum of all prerequisites of all files inside the
215
bundle are contained within the bundle or are ``system`` libraries,
216 217
presumed to exist everywhere.

218 219 220
As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
which are then ignored
(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``)
221

222
.. code-block:: cmake
223

224
  verify_bundle_symlinks(<bundle> <result_var> <info_var>)
225

226
Verifies that any symlinks found in the ``<bundle>`` bundle point to other files
227 228 229
that are already also in the bundle...  Anything that points to an
external file causes this function to fail the verification.
#]=======================================================================]
230

231
function(_warn_cmp0080)
232 233
  cmake_policy(GET_WARNING CMP0080 _cmp0080_warning)
  message(AUTHOR_WARNING "${_cmp0080_warning}\n")
234 235
endfunction()

236 237 238 239 240
# 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!")
241 242
  elseif(NOT _BundleUtilities_CMP0080 STREQUAL "OLD" AND NOT _CMP0080_SUPPRESS_WARNING)
    _warn_cmp0080()
243 244 245
  endif()
endif()

246 247 248
cmake_policy(PUSH)
cmake_policy(SET CMP0057 NEW) # if IN_LIST

249 250 251
# The functions defined in this file depend on the get_prerequisites function
# (and possibly others) found in:
#
252
include("${CMAKE_CURRENT_LIST_DIR}/GetPrerequisites.cmake")
253 254 255 256 257 258 259 260 261 262 263 264 265 266


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)
267 268
    string(REPLACE ";" "\\;" info_plist "${info_plist}")
    string(REPLACE "\n" "${eol_char};" info_plist "${info_plist}")
269
    string(REPLACE "\r" "${eol_char};" info_plist "${info_plist}")
270 271 272 273 274 275 276 277

    # 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()
278
      endif()
279

280
      if(line MATCHES "<key>CFBundleExecutable</key>")
281
        set(line_is_main_executable 1)
282 283
      endif()
    endforeach()
284

285
    if(NOT bundle_executable STREQUAL "")
286 287
      if(EXISTS "${bundle}/Contents/MacOS/${bundle_executable}")
        set(result "${bundle}/Contents/MacOS/${bundle_executable}")
288
      else()
289 290 291 292 293 294 295 296 297 298 299 300

        # 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")
301 302 303
      endif()
    endif()
  else()
304 305 306 307 308 309 310
    #
    # 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:
    #
311
  endif()
312 313

  set(${result_var} "${result}" PARENT_SCOPE)
314
endfunction()
315 316 317 318 319


function(get_dotapp_dir exe dotapp_dir_var)
  set(s "${exe}")

320
  if(s MATCHES "/.*\\.app/")
321 322 323 324 325 326 327 328 329
    # 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)
330 331 332 333
      set(s "${sdir}")
      if(sname MATCHES "\\.app$")
        set(done 1)
        set(dotapp_dir "${sdir}/${sname}")
334 335 336
      endif()
    endwhile()
  else()
337 338 339 340 341 342 343
    # 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}")
344
    else()
345
      set(dotapp_dir "${s}")
346 347
    endif()
  endif()
348

349 350

  set(${dotapp_dir_var} "${dotapp_dir}" PARENT_SCOPE)
351
endfunction()
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366


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...")
367
        else()
368
          message(STATUS "warning: *NOT* handled - .app directory case...")
369 370
        endif()
      else()
371
        message(STATUS "warning: *NOT* handled - directory but not .app case...")
372 373
      endif()
    else()
374 375 376 377
      # Is it an executable file?
      is_file_executable("${app}" is_executable)
      if(is_executable)
        get_dotapp_dir("${app}" dotapp_dir)
378
        if(EXISTS "${dotapp_dir}")
379 380 381
          set(${bundle_var} "${dotapp_dir}" PARENT_SCOPE)
          set(${executable_var} "${app}" PARENT_SCOPE)
          set(valid 1)
382 383 384 385 386 387 388 389
          #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()
390
      else()
391
        message(STATUS "warning: *NOT* handled - not .app dir, not executable file...")
392 393 394
      endif()
    endif()
  else()
395
    message(STATUS "warning: *NOT* handled - directory/file does not exist...")
396
  endif()
397 398 399 400

  if(NOT valid)
    set(${bundle_var} "error: not a bundle" PARENT_SCOPE)
    set(${executable_var} "error: not a bundle" PARENT_SCOPE)
401
  endif()
402 403

  set(${valid_var} ${valid} PARENT_SCOPE)
404
endfunction()
405 406 407 408 409


function(get_bundle_all_executables bundle exes_var)
  set(exes "")

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
  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()

429 430 431 432
  foreach(f ${file_list})
    is_file_executable("${f}" is_executable)
    if(is_executable)
      set(exes ${exes} "${f}")
433 434
    endif()
  endforeach()
435 436

  set(${exes_var} "${exes}" PARENT_SCOPE)
437
endfunction()
438 439


440 441 442 443 444 445 446 447 448 449
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
450 451
      RESULT_VARIABLE otool_rv
      ERROR_VARIABLE otool_ev
452
      )
453 454 455
    if(NOT otool_rv STREQUAL "0")
      message(FATAL_ERROR "otool -l failed: ${otool_rv}\n${otool_ev}")
    endif()
456 457 458 459
    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)
460 461 462
      foreach(rpath ${load_cmds_ov})
        gp_append_unique(${rpaths_var} "${rpath}")
      endforeach()
463 464 465
    endif()
  endif()

466 467 468 469 470 471 472 473 474 475
  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()

476 477 478 479
  set(${rpaths_var} ${${rpaths_var}} PARENT_SCOPE)
endfunction()


480 481
function(get_item_key item key_var)
  get_filename_component(item_name "${item}" NAME)
482 483 484
  if(WIN32)
    string(TOLOWER "${item_name}" item_name)
  endif()
485
  string(REPLACE "." "_" ${key_var} "${item_name}")
486
  set(${key_var} ${${key_var}} PARENT_SCOPE)
487
endfunction()
488 489 490 491 492 493 494 495 496 497


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)
498
    set(${key}_RPATHS PARENT_SCOPE)
499
  endforeach()
500
  set(${keys_var} PARENT_SCOPE)
501
endfunction()
502 503 504


function(set_bundle_key_values keys_var context item exepath dirs copyflag)
505 506 507 508 509
  if(ARGC GREATER 6)
    set(rpaths "${ARGV6}")
  else()
    set(rpaths "")
  endif()
510 511 512 513 514 515 516 517 518
  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)
519
    gp_resolve_item("${context}" "${item}" "${exepath}" "${dirs}" resolved_item "${rpaths}")
520 521 522

    gp_item_default_embedded_path("${item}" default_embedded_path)

523 524
    get_item_rpaths("${resolved_item}" item_rpaths)

525
    if((NOT item MATCHES "\\.dylib$") AND (item MATCHES "[^/]+\\.framework/"))
526 527 528
      # For frameworks, construct the name under the embedded path from the
      # opening "${item_name}.framework/" to the closing "/${item_name}":
      #
529
      string(REGEX REPLACE "^.*(${item_name}.framework/.*/?${item_name}).*$" "${default_embedded_path}/\\1" embedded_item "${item}")
530
    else()
531 532 533 534
      # For other items, just use the same name as the original, but in the
      # embedded path:
      #
      set(embedded_item "${default_embedded_path}/${item_name}")
535
    endif()
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550

    # 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}")
551
    endif()
552 553 554 555 556 557 558 559

    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)
560 561
    set(${key}_RPATHS "${item_rpaths}" PARENT_SCOPE)
    set(${key}_RDEP_RPATHS "${rpaths}" PARENT_SCOPE)
562
  else()
563
    #message("warning: item key '${key}' already in the list, subsequent references assumed identical to first")
564 565
  endif()
endfunction()
566 567 568 569 570


function(get_bundle_keys app libs dirs keys_var)
  set(${keys_var} PARENT_SCOPE)

571 572 573 574 575
  set(options)
  set(oneValueArgs)
  set(multiValueArgs IGNORE_ITEM)
  cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )

576 577 578 579 580 581 582 583 584 585 586
  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)

587 588 589 590 591 592 593 594 595
    # 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}")

596 597 598 599 600 601
    # 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})
602
      set_bundle_key_values(${keys_var} "${lib}" "${lib}" "${exepath}" "${dirs}" 0 "${main_rpaths}")
603 604

      set(prereqs "")
605 606
      get_filename_component(prereq_filename ${lib} NAME)

607
      if(NOT prereq_filename IN_LIST CFG_IGNORE_ITEM)
608 609 610 611 612 613 614
        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()
615
    endforeach()
616 617 618 619 620 621

    # 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})
622
      # Main executable is scanned first above:
623
      #
624
      if(NOT exe STREQUAL executable)
625 626 627 628 629 630 631 632 633 634 635
        # 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()
636 637 638 639

      # Add each prerequisite to the keys:
      #
      set(prereqs "")
640 641
      get_filename_component(prereq_filename ${exe} NAME)

642
      if(NOT prereq_filename IN_LIST CFG_IGNORE_ITEM)
643 644 645 646 647 648 649
        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()
650
    endforeach()
651

652 653
    # preserve library symlink structure
    foreach(key ${${keys_var}})
654
      if("${${key}_COPYFLAG}" STREQUAL "1")
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
        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)

671
          if(NOT resolved_item_compare STREQUAL resolved_embedded_item_compare)
672 673 674 675 676 677 678
            set(${key}_COPYFLAG "2")
            set(${key}_RESOLVED_ITEM "${${targetkey}_RESOLVED_EMBEDDED_ITEM}")
          endif()

        endif()
      endif()
    endforeach()
679 680 681 682 683 684 685 686 687 688
    # 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)
689 690
      set(${key}_RPATHS "${${key}_RPATHS}" PARENT_SCOPE)
      set(${key}_RDEP_RPATHS "${${key}_RDEP_RPATHS}" PARENT_SCOPE)
691 692 693
    endforeach()
  endif()
endfunction()
694

695 696 697 698 699 700 701 702 703 704
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()

705
  if(resolved_item_compare STREQUAL resolved_embedded_item_compare)
706 707 708 709
    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}")
710 711 712
    if (NOT EXISTS "${target_dir}")
      file(MAKE_DIRECTORY "${target_dir}")
    endif()
713 714 715
    execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink "${symlink_target}" "${resolved_embedded_item}")
  endif()
endfunction()
716 717

function(copy_resolved_item_into_bundle resolved_item resolved_embedded_item)
718 719 720 721 722 723 724 725 726
  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()

727
  if(resolved_item_compare STREQUAL resolved_embedded_item_compare)
728
    message(STATUS "warning: resolved_item == resolved_embedded_item - not copying...")
729 730
  else()
    #message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy ${resolved_item} ${resolved_embedded_item}")
731
    execute_process(COMMAND ${CMAKE_COMMAND} -E copy "${resolved_item}" "${resolved_embedded_item}")
732 733
    if(UNIX AND NOT APPLE)
      file(RPATH_REMOVE FILE "${resolved_embedded_item}")
734
    endif()
735
  endif()
736

737
endfunction()
738 739


740 741 742 743 744 745 746 747 748 749
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()

750
  if(resolved_item_compare STREQUAL resolved_embedded_item_compare)
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
    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:
767 768
      string(REGEX REPLACE "^(.*)/[^/]+$" "\\1/Resources" resolved_resources "${resolved_item}")
      string(REGEX REPLACE "^(.*)/[^/]+$" "\\1/Resources" resolved_embedded_resources "${resolved_embedded_item}")
769 770 771
      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}")
772 773 774 775 776 777
      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):
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
        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()
795 796 797 798 799 800 801 802 803 804
        # 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()
805 806
      endif()
    endif()
807 808
    if(UNIX AND NOT APPLE)
      file(RPATH_REMOVE FILE "${resolved_embedded_item}")
809
    endif()
810 811
  endif()

812
endfunction()
813 814


815 816 817 818 819
function(fixup_bundle_item resolved_embedded_item exepath dirs)
  # This item's key is "ikey":
  #
  get_item_key("${resolved_embedded_item}" ikey)

820 821 822 823 824 825 826
  # 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)
827 828 829
  string(LENGTH "${resolved_embedded_item}" resolved_embedded_item_length)
  set(path_too_short 0)
  set(is_embedded 0)
830
  if(resolved_embedded_item_length LESS exe_dotapp_dir_length)
831 832 833 834
    set(path_too_short 1)
  endif()
  if(NOT path_too_short)
    string(SUBSTRING "${resolved_embedded_item}" 0 ${exe_dotapp_dir_length} item_substring)
835
    if("${exe_dotapp_dir}/" STREQUAL item_substring)
836 837 838 839
      set(is_embedded 1)
    endif()
  endif()
  if(NOT is_embedded)
840 841 842 843
    message("  exe_dotapp_dir/='${exe_dotapp_dir}/'")
    message("  item_substring='${item_substring}'")
    message("  resolved_embedded_item='${resolved_embedded_item}'")
    message("")
844 845
    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?")
846 847 848 849
    message("")
    message(FATAL_ERROR "cannot fixup an item that is not in the bundle...")
  endif()

850 851
  set(rpaths "${${ikey}_RPATHS}" "${${ikey}_RDEP_RPATHS}")

852
  set(prereqs "")
853
  get_prerequisites("${resolved_embedded_item}" prereqs 1 0 "${exepath}" "${dirs}" "${rpaths}")
854 855 856 857 858 859 860 861 862 863

  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}")
864
    else()
865
      message("warning: unexpected reference to '${pr}'")
866 867
    endif()
  endforeach()
868

869 870 871 872
  if(BU_CHMOD_BUNDLE_ITEMS)
    execute_process(COMMAND chmod u+w "${resolved_embedded_item}")
  endif()

873 874 875 876
  # 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})

877 878
  # Only if install_name_tool supports -delete_rpath:
  #
879
  execute_process(COMMAND ${CMAKE_INSTALL_NAME_TOOL}
880 881 882 883 884 885 886 887 888 889 890 891 892
    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()

893 894 895
  # Change this item's id and all of its references in one call
  # to install_name_tool:
  #
896
  if(changes)
897
    set(cmd ${CMAKE_INSTALL_NAME_TOOL} ${changes} "${resolved_embedded_item}")
898 899 900 901 902
    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()
903
  endif()
904
endfunction()
905 906 907 908 909 910 911 912


function(fixup_bundle app libs dirs)
  message(STATUS "fixup_bundle")
  message(STATUS "  app='${app}'")
  message(STATUS "  libs='${libs}'")
  message(STATUS "  dirs='${dirs}'")

913 914 915 916 917 918 919
  set(options)
  set(oneValueArgs)
  set(multiValueArgs IGNORE_ITEM)
  cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )

  message(STATUS "  ignoreItems='${CFG_IGNORE_ITEM}'")

920 921 922 923 924
  get_bundle_and_executable("${app}" bundle executable valid)
  if(valid)
    get_filename_component(exepath "${executable}" PATH)

    message(STATUS "fixup_bundle: preparing...")
925
    get_bundle_keys("${app}" "${libs}" "${dirs}" keys IGNORE_ITEM "${CFG_IGNORE_ITEM}")
926 927 928 929 930 931 932 933

    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)
934 935 936
      if("${${key}_COPYFLAG}" STREQUAL "2")
        message(STATUS "${i}/${n}: linking '${${key}_RESOLVED_ITEM}' -> '${${key}_RESOLVED_EMBEDDED_ITEM}'")
      elseif(${${key}_COPYFLAG})
937
        message(STATUS "${i}/${n}: copying '${${key}_RESOLVED_ITEM}'")
938
      else()
939
        message(STATUS "${i}/${n}: *NOT* copying '${${key}_RESOLVED_ITEM}'")
940
      endif()
941 942 943 944 945 946 947 948 949 950 951

      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 "")
952
      endif()
953

954 955 956 957
      if("${${key}_COPYFLAG}" STREQUAL "2")
        link_resolved_item_into_bundle("${${key}_RESOLVED_ITEM}"
          "${${key}_RESOLVED_EMBEDDED_ITEM}")
      elseif(${${key}_COPYFLAG})
958 959 960 961 962 963 964 965
        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()
966 967
      endif()
    endforeach()
968 969 970 971

    message(STATUS "fixup_bundle: fixing...")
    foreach(key ${keys})
      math(EXPR i ${i}+1)
972 973
      if(APPLE)
        message(STATUS "${i}/${n}: fixing up '${${key}_RESOLVED_EMBEDDED_ITEM}'")
974 975 976
        if(NOT "${${key}_COPYFLAG}" STREQUAL "2")
          fixup_bundle_item("${${key}_RESOLVED_EMBEDDED_ITEM}" "${exepath}" "${dirs}")
        endif()
977
      else()
978
        message(STATUS "${i}/${n}: fix-up not required on this platform '${${key}_RESOLVED_EMBEDDED_ITEM}'")
979 980
      endif()
    endforeach()
981 982 983 984 985

    message(STATUS "fixup_bundle: cleaning up...")
    clear_bundle_keys(keys)

    message(STATUS "fixup_bundle: verifying...")
986
    verify_app("${app}" IGNORE_ITEM "${CFG_IGNORE_ITEM}")
987
  else()
988
    message(SEND_ERROR "error: fixup_bundle: not a valid bundle")
989
  endif()
990 991

  message(STATUS "fixup_bundle: done")
992
endfunction()
993 994 995 996 997


function(copy_and_fixup_bundle src dst libs dirs)
  execute_process(COMMAND ${CMAKE_COMMAND} -E copy_directory "${src}" "${dst}")
  fixup_bundle("${dst}" "${libs}" "${dirs}")
998
endfunction()
999 1000 1001 1002 1003 1004 1005


function(verify_bundle_prerequisites bundle result_var info_var)
  set(result 1)
  set(info "")
  set(count 0)

1006 1007 1008 1009 1010
  set(options)
  set(oneValueArgs)
  set(multiValueArgs IGNORE_ITEM)
  cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )

1011 1012
  get_bundle_main_executable("${bundle}" main_bundle_exe)

1013
  get_bundle_all_executables("${bundle}" file_list)
1014 1015 1016 1017
  foreach(f ${file_list})
      get_filename_component(exepath "${f}" PATH)
      math(EXPR count "${count} + 1")

1018 1019
      message(STATUS "executable file ${count}: ${f}")

1020
      set(prereqs "")
1021 1022
      get_filename_component(prereq_filename ${f} NAME)

1023
      if(NOT prereq_filename IN_LIST CFG_IGNORE_ITEM)
1024 1025
        get_item_rpaths(${f} _main_exe_rpaths)
        get_prerequisites("${f}" prereqs 1 1 "${exepath}" "${_main_exe_rpaths}")
1026

1027 1028 1029 1030 1031 1032 1033 1034
        # 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...
        #
1035

1036 1037 1038 1039 1040 1041 1042
        set(external_prereqs "")

        foreach(p ${prereqs})
          set(p_type "")
          gp_file_type("${f}" "${p}" p_type)

          if(APPLE)
1043
            if(NOT p_type STREQUAL "embedded" AND NOT p_type STREQUAL "system")
1044 1045 1046
              set(external_prereqs ${external_prereqs} "${p}")
            endif()
          else()
1047
            if(NOT p_type STREQUAL "local" AND NOT p_type STREQUAL "system")
1048 1049
              set(external_prereqs ${external_prereqs} "${p}")
            endif()
1050
          endif()
1051
        endforeach()
1052

1053 1054 1055 1056 1057 1058 1059
        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}")
1060 1061
      endif()
  endforeach()
1062 1063 1064

  if(result)
    set(info "Verified ${count} executable files in '${bundle}'")
1065
  endif()
1066 1067 1068

  set(${result_var} "${result}" PARENT_SCOPE)
  set(${info_var} "${info}" PARENT_SCOPE)
1069
endfunction()
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081


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)
1082
endfunction()
1083 1084 1085 1086 1087 1088


function(verify_app app)
  set(verified 0)
  set(info "")

1089 1090 1091 1092 1093
  set(options)
  set(oneValueArgs)
  set(multiValueArgs IGNORE_ITEM)
  cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
  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:
  #
1104
  verify_bundle_prerequisites("${bundle}" verified info IGNORE_ITEM "${CFG_IGNORE_ITEM}")
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
  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 "")
1116
  endif()
1117 1118 1119

  if(NOT verified)
    message(FATAL_ERROR "error: verify_app failed")
1120 1121
  endif()
endfunction()
1122 1123

cmake_policy(POP)