CMakeVerifyManifest.cmake 3.88 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 10 11 12 13 14 15 16 17 18 19 20
#[=======================================================================[.rst:
CMakeVerifyManifest
-------------------



CMakeVerifyManifest.cmake

This script is used to verify that embedded manifests and side by side
manifests for a project match.  To run this script, cd to a directory
and run the script with cmake -P.  On the command line you can pass in
versions that are OK even if not found in the .manifest files.  For
example, cmake -Dallow_versions=8.0.50608.0
-PCmakeVerifyManifest.cmake could be used to allow an embedded manifest
of 8.0.50608.0 to be used in a project even if that version was not
found in the .manifest file.
#]=======================================================================]
21 22 23

# This script first recursively globs *.manifest files from
# the current directory.  Then globs *.exe and *.dll.  Each
24
# .exe and .dll is scanned for embedded manifests and the versions
25 26 27
# of CRT are compared to those found in the .manifest files
# from the first glob.

28
# crt_version:
29 30 31 32 33
# function to extract the CRT version from a file
# this can be passed a .exe, .dll, or a .manifest file
# it will put the list of versions found into the variable
# specified by list_var
function(crt_version file list_var)
34
  file(STRINGS "${file}" strings REGEX "Microsoft.VC...CRT" NEWLINE_CONSUME)
35 36 37
  foreach(s ${strings})
    set(has_match 1)
    string(REGEX
38
      REPLACE ".*<assembly.*\"Microsoft.VC...CRT\".*version=\"([^\"]*)\".*</assembly>.*$" "\\1"
39 40 41 42 43 44
      version "${s}")
    if(NOT "${version}" STREQUAL "")
      list(APPEND version_list ${version})
    else()
      message(FATAL_ERROR "Parse error could not find version in [${s}]")
    endif()
45
  endforeach()
46
  if(NOT DEFINED has_match)
47
    message("Information: no embedded manifest in: ${file}")
48 49 50 51 52 53 54
    return()
  endif()
  list(APPEND version_list ${${list_var}})
  list(REMOVE_DUPLICATES version_list)
  if(version_list)
    set(${list_var} ${version_list} PARENT_SCOPE)
  endif()
55
endfunction()
56
set(fatal_error FALSE)
57 58

# check_version:
59
#
60 61 62 63 64 65
# test a file against the shipped manifest versions
# for a directory
function(check_version file manifest_versions)
  set(manifest_versions ${manifest_versions} ${allow_versions})
  # collect versions for a given file
  crt_version(${file} file_versions)
66
  # see if the versions
67 68 69
  foreach(ver ${file_versions})
    list(FIND manifest_versions "${ver}" found_version)
    if("${found_version}" EQUAL -1)
70
      message("ERROR: ${file} uses ${ver} not found in shipped manifests:[${manifest_versions}].")
71 72
      set(fatal_error TRUE PARENT_SCOPE)
    endif()
73
  endforeach()
74 75 76 77 78 79 80 81 82 83 84 85
  list(LENGTH file_versions len)
  if(${len} GREATER 1)
    message("WARNING: found more than one version of MICROSOFT.VC80.CRT referenced in ${file}: [${file_versions}]")
  endif()
endfunction()

# collect up the versions of CRT that are shipped
# in .manifest files
set(manifest_version_list )
file(GLOB_RECURSE manifest_files "*.manifest")
foreach(f ${manifest_files})
  crt_version("${f}" manifest_version_list)
86
endforeach()
87 88 89 90
list(LENGTH manifest_version_list LEN)
if(LEN EQUAL 0)
  message(FATAL_ERROR "No .manifest files found, no version check can be done.")
endif()
91
message("Versions found in ${manifest_files}: ${manifest_version_list}")
Bill Hoffman's avatar
Bill Hoffman committed
92 93 94
if(DEFINED allow_versions)
  message("Extra versions allowed: ${allow_versions}")
endif()
95 96 97 98 99 100 101

# now find all .exe and .dll files
# and call check_version on each of them
file(GLOB_RECURSE exe_files "*.exe")
file(GLOB_RECURSE dll_files "*.dll")
set(exe_files ${exe_files} ${dll_files})
foreach(f ${exe_files})
102
  check_version(${f} "${manifest_version_list}")
103 104 105 106 107
endforeach()

# report a fatal error if there were any so that cmake will return
# a non zero value
if(fatal_error)
108 109
  message(FATAL_ERROR "This distribution embeds dll "
    " versions that it does not ship, and may not work on other machines.")
110
endif()