]> sigrok.org Git - pulseview.git/blame - contrib/pulseview_cross.nsi.in
Installer: Update icon cache also after uninstallation
[pulseview.git] / contrib / pulseview_cross.nsi.in
CommitLineData
a7171293
UH
1##
2## This file is part of the PulseView project.
3##
f4097c59 4## Copyright (C) 2013-2014 Uwe Hermann <uwe@hermann-uwe.de>
a7171293
UH
5##
6## This program is free software; you can redistribute it and/or modify
7## it under the terms of the GNU General Public License as published by
8## the Free Software Foundation; either version 2 of the License, or
9## (at your option) any later version.
10##
11## This program is distributed in the hope that it will be useful,
12## but WITHOUT ANY WARRANTY; without even the implied warranty of
13## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14## GNU General Public License for more details.
15##
16## You should have received a copy of the GNU General Public License
efdec55a 17## along with this program; if not, see <http://www.gnu.org/licenses/>.
a7171293
UH
18##
19
20#
21# This file is used to create the PulseView Windows installer via NSIS.
22# It is meant for use in a cross-compile setup (not for native builds).
23# See the 'sigrok-cross-mingw' script in the sigrok-util repo for details.
24#
25# NSIS documentation:
26# http://nsis.sourceforge.net/Docs/
27# http://nsis.sourceforge.net/Docs/Modern%20UI%202/Readme.html
28#
29
30# Include the "Modern UI" header, which gives us the usual Windows look-n-feel.
31!include "MUI2.nsh"
32
63ebd7fe
SA
33# Include the file association header so that we can register file extensions.
34!include "FileAssociation.nsh"
35
a7171293
UH
36
37# --- Global stuff ------------------------------------------------------------
38
39# Installer/product name.
40Name "PulseView"
41
42# Filename of the installer executable.
f9cb49cc 43OutFile "pulseview-@PV_VERSION_STRING@-installer.exe"
a7171293
UH
44
45# Where to install the application.
46InstallDir "$PROGRAMFILES\sigrok\PulseView"
47
48# Request admin privileges for Windows Vista and Windows 7.
49# http://nsis.sourceforge.net/Docs/Chapter4.html
50RequestExecutionLevel admin
51
52# Local helper definitions.
53!define REGSTR "Software\Microsoft\Windows\CurrentVersion\Uninstall\PulseView"
54
55
56# --- MUI interface configuration ---------------------------------------------
57
58# Use the following icon for the installer EXE file.
f9cb49cc 59!define MUI_ICON "@PROJECT_SOURCE_DIR@/icons/sigrok-logo-notext.ico"
a7171293
UH
60
61# Show a nice image at the top of each installer page.
62!define MUI_HEADERIMAGE
63
64# Don't automatically go to the Finish page so the user can check the log.
65!define MUI_FINISHPAGE_NOAUTOCLOSE
66
67# Upon "cancel", ask the user if he really wants to abort the installer.
68!define MUI_ABORTWARNING
69
70# Don't force the user to accept the license, just show it.
71# Details: http://trac.videolan.org/vlc/ticket/3124
72!define MUI_LICENSEPAGE_BUTTON $(^NextBtn)
73!define MUI_LICENSEPAGE_TEXT_BOTTOM "Click Next to continue."
74
a7171293
UH
75# Path where the cross-compiled sigrok tools and libraries are located.
76# Change this to where-ever you installed libsigrok.a and so on.
f9cb49cc 77!define CROSS "@CMAKE_INSTALL_PREFIX@"
a7171293 78
bf627f70
SA
79# Defines for WinAPI SHChangeNotify call.
80!define SHCNE_ASSOCCHANGED 0x8000000
81!define SHCNF_IDLIST 0
82
a7171293 83
63ebd7fe
SA
84# --- Functions ---------------------------------------------------------------
85
86Function register_sr_files
bf627f70
SA
87 ${registerExtension} "$INSTDIR\pulseview.exe" ".sr" "sigrok session file"
88
89 # Force Windows to update the icon cache so that the icon for .sr files shows up.
90 System::Call 'Shell32::SHChangeNotify(i ${SHCNE_ASSOCCHANGED}, i ${SHCNF_IDLIST}, i 0, i 0)'
63ebd7fe
SA
91FunctionEnd
92
93
a7171293
UH
94# --- MUI pages ---------------------------------------------------------------
95
96# Show a nice "Welcome to the ... Setup Wizard" page.
97!insertmacro MUI_PAGE_WELCOME
98
99# Show the license of the project.
f9cb49cc 100!insertmacro MUI_PAGE_LICENSE "@PROJECT_SOURCE_DIR@/COPYING"
a7171293
UH
101
102# Show a screen which allows the user to select which components to install.
103!insertmacro MUI_PAGE_COMPONENTS
104
105# Allow the user to select a different install directory.
106!insertmacro MUI_PAGE_DIRECTORY
107
108# Perform the actual installation, i.e. install the files.
109!insertmacro MUI_PAGE_INSTFILES
110
63ebd7fe
SA
111# Insert the "Show Readme" button in the finish dialog. We repurpose it for
112# registering the .sr file extension. This way, we don't need to add in-depth
113# modifications to the finish page.
114!define MUI_FINISHPAGE_SHOWREADME ""
115!define MUI_FINISHPAGE_SHOWREADME_CHECKED
116!define MUI_FINISHPAGE_SHOWREADME_TEXT "Register .sr files with PulseView"
117!define MUI_FINISHPAGE_SHOWREADME_FUNCTION register_sr_files
118
a7171293
UH
119# Show a final "We're done, click Finish to close this wizard" message.
120!insertmacro MUI_PAGE_FINISH
121
122# Pages used for the uninstaller.
123!insertmacro MUI_UNPAGE_WELCOME
124!insertmacro MUI_UNPAGE_CONFIRM
125!insertmacro MUI_UNPAGE_INSTFILES
126!insertmacro MUI_UNPAGE_FINISH
127
128
129# --- MUI language files ------------------------------------------------------
130
131# Select an installer language (required!).
132!insertmacro MUI_LANGUAGE "English"
133
134
135# --- Default section ---------------------------------------------------------
136
137Section "PulseView (required)" Section1
138
139 # This section is gray (can't be disabled) in the component list.
140 SectionIn RO
141
142 # Install the file(s) specified below into the specified directory.
143 SetOutPath "$INSTDIR"
144
f4097c59 145 # License file.
f9cb49cc 146 File "@PROJECT_SOURCE_DIR@/COPYING"
a7171293 147
f4097c59 148 # PulseView (statically linked, includes all libs).
a7171293
UH
149 File "${CROSS}/bin/pulseview.exe"
150
d64796ed 151 # Zadig (used for installing WinUSB drivers).
48898353
UH
152 File "${CROSS}/zadig.exe"
153 File "${CROSS}/zadig_xp.exe"
154
1f763c17 155 # Python
0ebddfac
UH
156 File "${CROSS}/python34.dll"
157 File "${CROSS}/python34.zip"
1f763c17 158
a7e53a4a
DE
159 SetOutPath "$INSTDIR\share"
160
f4097c59 161 # Protocol decoders.
a7e53a4a 162 File /r /x "__pycache__" /x "*.pyc" "${CROSS}/share/libsigrokdecode"
a7171293 163
d8823c8c 164 # Firmware files.
a7e53a4a 165 File /r "${CROSS}/share/sigrok-firmware"
d8823c8c 166
95052d70
UH
167 # Example *.sr files.
168 SetOutPath "$INSTDIR\examples"
169 File /r "${CROSS}/share/sigrok-dumps/*"
170
a7171293
UH
171 # Generate the uninstaller executable.
172 WriteUninstaller "$INSTDIR\Uninstall.exe"
173
174 # Create a sub-directory in the start menu.
175 CreateDirectory "$SMPROGRAMS\sigrok"
176 CreateDirectory "$SMPROGRAMS\sigrok\PulseView"
177
178 # Create a shortcut for the PulseView application.
77243b3e 179 SetOutPath "$INSTDIR"
a7171293
UH
180 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\PulseView.lnk" \
181 "$INSTDIR\pulseview.exe" "" "$INSTDIR\pulseview.exe" \
182 0 SW_SHOWNORMAL \
183 "" "Open-source, portable sigrok GUI"
184
185 # Create a shortcut for the uninstaller.
186 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\Uninstall.lnk" \
187 "$INSTDIR\Uninstall.exe" "" "$INSTDIR\Uninstall.exe" 0 \
188 SW_SHOWNORMAL "" "Uninstall PulseView"
189
0518e9c9
UH
190 # Create a shortcut for the Zadig executable.
191 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\Zadig.lnk" \
192 "$INSTDIR\zadig.exe" "" "$INSTDIR\zadig.exe" 0 \
193 SW_SHOWNORMAL "" "Zadig"
194
195 # Create a shortcut for the Zadig executable (for Win XP).
196 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\Zadig (Win XP).lnk" \
197 "$INSTDIR\zadig_xp.exe" "" "$INSTDIR\zadig_xp.exe" 0 \
198 SW_SHOWNORMAL "" "Zadig (Win XP)"
199
a7171293
UH
200 # Create registry keys for "Add/remove programs" in the control panel.
201 WriteRegStr HKLM "${REGSTR}" "DisplayName" "PulseView"
202 WriteRegStr HKLM "${REGSTR}" "UninstallString" \
203 "$\"$INSTDIR\Uninstall.exe$\""
204 WriteRegStr HKLM "${REGSTR}" "InstallLocation" "$\"$INSTDIR$\""
205 WriteRegStr HKLM "${REGSTR}" "DisplayIcon" \
206 "$\"$INSTDIR\sigrok-logo-notext.ico$\""
207 WriteRegStr HKLM "${REGSTR}" "Publisher" "sigrok"
208 WriteRegStr HKLM "${REGSTR}" "HelpLink" \
209 "http://sigrok.org/wiki/PulseView"
210 WriteRegStr HKLM "${REGSTR}" "URLUpdateInfo" \
211 "http://sigrok.org/wiki/Downloads"
212 WriteRegStr HKLM "${REGSTR}" "URLInfoAbout" "http://sigrok.org"
f9cb49cc 213 WriteRegStr HKLM "${REGSTR}" "DisplayVersion" "@PV_VERSION_STRING@"
a7171293
UH
214 WriteRegStr HKLM "${REGSTR}" "Contact" \
215 "sigrok-devel@lists.sourceforge.org"
216 WriteRegStr HKLM "${REGSTR}" "Comments" \
217 "This is a Qt based sigrok GUI."
218
219 # Display "Remove" instead of "Modify/Remove" in the control panel.
220 WriteRegDWORD HKLM "${REGSTR}" "NoModify" 1
221 WriteRegDWORD HKLM "${REGSTR}" "NoRepair" 1
222
223SectionEnd
224
225
a7171293
UH
226# --- Uninstaller section -----------------------------------------------------
227
228Section "Uninstall"
229
230 # Always delete the uninstaller first (yes, this really works).
231 Delete "$INSTDIR\Uninstall.exe"
232
233 # Delete the application, the application data, and related libs.
234 Delete "$INSTDIR\COPYING"
235 Delete "$INSTDIR\pulseview.exe"
48898353
UH
236 Delete "$INSTDIR\zadig.exe"
237 Delete "$INSTDIR\zadig_xp.exe"
0ebddfac
UH
238 Delete "$INSTDIR\python34.dll"
239 Delete "$INSTDIR\python34.zip"
a7171293 240
a7e53a4a 241 # Delete all decoders and everything else in libsigrokdecode/.
a7171293 242 # There could be *.pyc files or __pycache__ subdirs and so on.
a7e53a4a 243 RMDir /r "$INSTDIR\share\libsigrokdecode"
a7171293 244
d8823c8c 245 # Delete the firmware files.
a7e53a4a 246 RMDir /r "$INSTDIR\share\sigrok-firmware"
d8823c8c 247
95052d70
UH
248 # Delete the example *.sr files.
249 RMDir /r "$INSTDIR\examples\*"
250
a7171293 251 # Delete the install directory and its sub-directories.
a7e53a4a 252 RMDir "$INSTDIR\share"
95052d70 253 RMDir "$INSTDIR\examples"
a7171293
UH
254 RMDir "$INSTDIR"
255
256 # Delete the links from the start menu.
257 Delete "$SMPROGRAMS\sigrok\PulseView\PulseView.lnk"
258 Delete "$SMPROGRAMS\sigrok\PulseView\Uninstall.lnk"
0518e9c9
UH
259 Delete "$SMPROGRAMS\sigrok\PulseView\Zadig.lnk"
260 Delete "$SMPROGRAMS\sigrok\PulseView\Zadig (Win XP).lnk"
a7171293
UH
261
262 # Delete the sub-directory in the start menu.
263 RMDir "$SMPROGRAMS\sigrok\PulseView"
264 RMDir "$SMPROGRAMS\sigrok"
265
266 # Delete the registry key(s).
267 DeleteRegKey HKLM "${REGSTR}"
268
63ebd7fe
SA
269 # Unregister any previously registered file extension(s).
270 ${unregisterExtension} ".sr" "sigrok session file"
271
ebe0a196
SA
272 # Force Windows to update the icon cache so that the icon for .sr files is reset.
273 System::Call 'Shell32::SHChangeNotify(i ${SHCNE_ASSOCCHANGED}, i ${SHCNF_IDLIST}, i 0, i 0)'
a7171293
UH
274SectionEnd
275
276
277# --- Component selection section descriptions --------------------------------
278
95052d70 279LangString DESC_Section1 ${LANG_ENGLISH} "This installs the PulseView sigrok GUI, some firmware files, the protocol decoders, some example files, and all required libraries."
a7171293
UH
280
281!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
282!insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
a7171293
UH
283!insertmacro MUI_FUNCTION_DESCRIPTION_END
284