packaging/wix/windeployqt-to-wix.ps1

   1 # windeployqt-to-wix
   2 #
   3 # Windeployqt-to-wix - Convert the output of windeployqt to an equivalent set of
   4 # Wix file and component statements.
   5 #
   6 # Copyright 2016 Michael Mann
   7 #
   8 # Wireshark - Network traffic analyzer
   9 # By Gerald Combs <gerald@wireshark.org>
  10 # Copyright 1998 Gerald Combs
  11 #
  12 # SPDX-License-Identifier: GPL-2.0-or-later
  13
  14 #requires -version 2
  15
  16 <#
  17 .SYNOPSIS
  18 Creates Wix components required for Qt packaging.
  19
  20 .DESCRIPTION
  21 This script creates n Wix-compatible include file based on the output of
  22 windeployqt. If Qt is present, version 5.3 or later is required.
  23 Otherwise a dummy file will be created.
  24
  25 If building with Qt, QMake must be in your PATH.
  26
  27 .PARAMETER Executable
  28 The path to a Qt application. It will be examined for dependent DLLs.
  29
  30 .PARAMETER FilePath
  31 Output filename.
  32
  33 .INPUTS
  34 -Executable Path to the Qt application.
  35 -FilePath Output Wix include file.
  36
  37 .OUTPUTS
  38 Wix file required to package supporting DLLs.
  39
  40 .EXAMPLE
  41 C:\PS> .\windeployqt-to-wix.ps1 windeployqt.exe ..\..\staging\wireshark.exe qt-dll-manifest.wxs
  42 #>
  43
  44 Param(
  45     [Parameter(Mandatory=$true, Position=0)]
  46     [String] $Executable,
  47
  48     [Parameter(Position=1)]
  49     [String] $FilePath = "qt-dll-manifest.wxs"
  50 )
  51
  52
  53 try {
  54     $qtVersion = [version](qmake -query QT_VERSION)
  55     $wixComponents = "<Wix xmlns=`"http://schemas.microsoft.com/wix/2006/wi`">
  56 <?include InputPaths.wxi ?>
  57 "
  58     $wixComponents += @("<!-- Qt version " + $qtVersion ; "-->
  59 ")
  60
  61     if ($qtVersion -lt "5.3") {
  62         Throw "Qt " + $qtVersion + " found. 5.3 or later is required."
  63     }
  64
  65     # windeployqt lists translation files that it don't exist (e.g.
  66     # qtbase_ar.qm), so we handle those by hand.
  67     # https://bugreports.qt.io/browse/QTBUG-65974
  68     $wdqtList = windeployqt `
  69         --release `
  70         --no-compiler-runtime `
  71         --no-translations `
  72         --list relative `
  73         $Executable
  74
  75     $dllPath = Split-Path -Parent $Executable
  76
  77     $dllList = "   <Fragment>
  78      <DirectoryRef Id=`"INSTALLFOLDER`">
  79 "
  80     $dirList = ""
  81     $currentDir = ""
  82     $startDirList = "   <Fragment>
  83      <DirectoryRef Id=`"INSTALLFOLDER`">
  84 "
  85     $endDirList = "       </Directory>
  86      </DirectoryRef>
  87    </Fragment>
  88 "
  89     $currentDirList = $startDirList
  90
  91     $componentGroup = "   <Fragment>
  92       <ComponentGroup Id=`"CG.QtDependencies`">
  93 "
  94     foreach ($entry in $wdqtList) {
  95         $dir = Split-Path -Parent $entry
  96         $wix_name = $entry -ireplace "[^a-z0-9]", "_"
  97
  98         if ($dir) {
  99             if ($dir -ne $currentDir) {
 100                 if ($currentDir -ne "") { # for everything but first directory found
 101                     $currentDirList += $endDirList
 102
 103                     # Previous directory complete, add to list
 104                     $dirList += $currentDirList
 105                 }
 106
 107                 $currentDirList = $startDirList + "       <Directory Id=`"dir$dir`" Name=`"$dir`">
 108     "
 109
 110                 $currentDir = $dir
 111             }
 112
 113             $currentDirList += "           <Component Id=`"cmp$wix_name`" Guid=`"*`">
 114               <File Id=`"fil$wix_name`" KeyPath=`"yes`" Source=`"`$(var.Staging.Dir)\$entry`" />
 115            </Component>
 116 "
 117             $componentGroup += "         <ComponentRef Id=`"cmp$wix_name`" />
 118 "
 119         } else {
 120             $dllList += "       <Component Id=`"cmp$wix_name`" Guid=`"*`">
 121           <File Id=`"fil$wix_name`" KeyPath=`"yes`" Source=`"`$(var.Staging.Dir)\$entry`" />
 122        </Component>
 123 "
 124             $componentGroup += "         <ComponentRef Id=`"cmp$wix_name`" />
 125 "
 126         }
 127     }
 128
 129     #finish up the last directory
 130     $currentDirList += $endDirList
 131     $dirList += $currentDirList
 132
 133     $dllList += "     </DirectoryRef>
 134    </Fragment>
 135 "
 136     $componentGroup += "      </ComponentGroup>
 137    </Fragment>
 138 "
 139
 140     $wixComponents += $dllList + $dirList + $componentGroup
 141
 142     $wixComponents += @"
 143 </Wix>
 144 "@
 145
 146 }
 147
 148 catch {
 149
 150     $wixComponents = "<?xml version=`"1.0`" encoding=`"utf-8`"?>
 151 <Include>
 152 <!--- Qt not configured -->
 153 </Include>
 154 "
 155
 156 }
 157
 158 Set-Content $FilePath @"
 159 <?xml version=`"1.0`" encoding=`"utf-8`"?>
 160 <!--
 161    Automatically generated by $($MyInvocation.MyCommand.Name)
 162 -->
 163 "@
 164
 165 Add-Content $FilePath $wixComponents