]> sigrok.org Git - pulseview.git/blame - contrib/pulseview_cross.nsi.in
manual: install manual conversion result files generated by cmake
[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.
fce541c3 59!define MUI_ICON "@PROJECT_SOURCE_DIR@/icons/pulseview.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
a7171293
UH
138 # This section is gray (can't be disabled) in the component list.
139 SectionIn RO
140
141 # Install the file(s) specified below into the specified directory.
142 SetOutPath "$INSTDIR"
143
f4097c59 144 # License file.
f9cb49cc 145 File "@PROJECT_SOURCE_DIR@/COPYING"
a7171293 146
f4097c59 147 # PulseView (statically linked, includes all libs).
a7171293
UH
148 File "${CROSS}/bin/pulseview.exe"
149
d64796ed 150 # Zadig (used for installing WinUSB drivers).
48898353
UH
151 File "${CROSS}/zadig.exe"
152 File "${CROSS}/zadig_xp.exe"
153
1f763c17 154 # Python
0ebddfac
UH
155 File "${CROSS}/python34.dll"
156 File "${CROSS}/python34.zip"
1f763c17 157
a7e53a4a
DE
158 SetOutPath "$INSTDIR\share"
159
f4097c59 160 # Protocol decoders.
a7e53a4a 161 File /r /x "__pycache__" /x "*.pyc" "${CROSS}/share/libsigrokdecode"
a7171293 162
d8823c8c 163 # Firmware files.
a7e53a4a 164 File /r "${CROSS}/share/sigrok-firmware"
d8823c8c 165
a7171293
UH
166 # Generate the uninstaller executable.
167 WriteUninstaller "$INSTDIR\Uninstall.exe"
168
169 # Create a sub-directory in the start menu.
170 CreateDirectory "$SMPROGRAMS\sigrok"
171 CreateDirectory "$SMPROGRAMS\sigrok\PulseView"
172
173 # Create a shortcut for the PulseView application.
77243b3e 174 SetOutPath "$INSTDIR"
a7171293
UH
175 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\PulseView.lnk" \
176 "$INSTDIR\pulseview.exe" "" "$INSTDIR\pulseview.exe" \
177 0 SW_SHOWNORMAL \
178 "" "Open-source, portable sigrok GUI"
179
a3110cab
SA
180 # Create a shortcut for the PulseView application running in debug mode.
181 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\PulseView (Debug).lnk" \
182 "$INSTDIR\pulseview.exe" "-l 5" "$INSTDIR\pulseview.exe" \
183 0 SW_SHOWNORMAL \
184 "" "Open-source, portable sigrok GUI (debug log level)"
185
a7171293 186 # Create a shortcut for the uninstaller.
b8f93b68 187 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\Uninstall PulseView.lnk" \
a7171293
UH
188 "$INSTDIR\Uninstall.exe" "" "$INSTDIR\Uninstall.exe" 0 \
189 SW_SHOWNORMAL "" "Uninstall PulseView"
190
0518e9c9 191 # Create a shortcut for the Zadig executable.
b8f93b68 192 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\Zadig (PulseView).lnk" \
0518e9c9 193 "$INSTDIR\zadig.exe" "" "$INSTDIR\zadig.exe" 0 \
b8f93b68 194 SW_SHOWNORMAL "" "Zadig (PulseView)"
0518e9c9
UH
195
196 # Create a shortcut for the Zadig executable (for Win XP).
b8f93b68 197 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\Zadig (PulseView, Win XP).lnk" \
0518e9c9 198 "$INSTDIR\zadig_xp.exe" "" "$INSTDIR\zadig_xp.exe" 0 \
b8f93b68 199 SW_SHOWNORMAL "" "Zadig (PulseView, Win XP)"
0518e9c9 200
a7171293
UH
201 # Create registry keys for "Add/remove programs" in the control panel.
202 WriteRegStr HKLM "${REGSTR}" "DisplayName" "PulseView"
203 WriteRegStr HKLM "${REGSTR}" "UninstallString" \
204 "$\"$INSTDIR\Uninstall.exe$\""
205 WriteRegStr HKLM "${REGSTR}" "InstallLocation" "$\"$INSTDIR$\""
206 WriteRegStr HKLM "${REGSTR}" "DisplayIcon" \
fce541c3 207 "$\"$INSTDIR\pulseview.ico$\""
a7171293
UH
208 WriteRegStr HKLM "${REGSTR}" "Publisher" "sigrok"
209 WriteRegStr HKLM "${REGSTR}" "HelpLink" \
210 "http://sigrok.org/wiki/PulseView"
211 WriteRegStr HKLM "${REGSTR}" "URLUpdateInfo" \
212 "http://sigrok.org/wiki/Downloads"
213 WriteRegStr HKLM "${REGSTR}" "URLInfoAbout" "http://sigrok.org"
f9cb49cc 214 WriteRegStr HKLM "${REGSTR}" "DisplayVersion" "@PV_VERSION_STRING@"
a7171293
UH
215 WriteRegStr HKLM "${REGSTR}" "Contact" \
216 "sigrok-devel@lists.sourceforge.org"
217 WriteRegStr HKLM "${REGSTR}" "Comments" \
218 "This is a Qt based sigrok GUI."
219
220 # Display "Remove" instead of "Modify/Remove" in the control panel.
221 WriteRegDWORD HKLM "${REGSTR}" "NoModify" 1
222 WriteRegDWORD HKLM "${REGSTR}" "NoRepair" 1
a7171293
UH
223SectionEnd
224
4bbd53c9
SA
225Section /o "Example data" Section2
226 # Example *.sr files.
227 SetOutPath "$INSTDIR\examples"
228
229 File "${CROSS}/share/sigrok-dumps/arm_trace/stm32f105/trace_example.sr"
230 File "${CROSS}/share/sigrok-dumps/am230x/am2301/am2301_1mhz.sr"
231 File "${CROSS}/share/sigrok-dumps/avr_isp/atmega88/isp_atmega88_erase_chip.sr"
232 File "${CROSS}/share/sigrok-dumps/can/microchip_mcp2515dm-bm/mcp2515dm-bm-125kbits_msg_222_5bytes.sr"
233 File "${CROSS}/share/sigrok-dumps/dcf77/pollin_dcf1_module/dcf77_120s.sr"
234 File "${CROSS}/share/sigrok-dumps/i2c/eeprom_24xx/microchip_24lc02b/hantek_6022be_powerup.sr"
235 File "${CROSS}/share/sigrok-dumps/i2c/eeprom_24xx/microchip_24lc64/sainsmart_dds120_powerup_scl_sda_analog.sr"
236 File "${CROSS}/share/sigrok-dumps/i2c/potentiometer/analog_devices_ad5258/ad5258_read_once_write_continuously_triangle.sr"
237 File "${CROSS}/share/sigrok-dumps/mdio/lan8720a/lan8720a_read_write_read.sr"
238 File "${CROSS}/share/sigrok-dumps/onewire/owfs/ds28ea00.sr"
239 File "${CROSS}/share/sigrok-dumps/sdcard/sd_mode/rcar-h2/cmd23_cmd18.sr"
240 File "${CROSS}/share/sigrok-dumps/spi/mx25l1605d/mx25l1605d_read.sr"
241 File "${CROSS}/share/sigrok-dumps/uart/gps/mtk3339/mtk3339_8n1_9600.sr"
242 File "${CROSS}/share/sigrok-dumps/usb/hid/mouse/olimex_stm32-h103_usb_hid/olimex_stm32-h103_usb_hid.sr"
243 File "${CROSS}/share/sigrok-dumps/z80/kc85/kc85-20mhz.sr"
244
245 # Create a shortcut for the example data folder.
0e206885 246 CreateShortCut "$SMPROGRAMS\sigrok\PulseView\Examples (PulseView).lnk" \
4bbd53c9
SA
247 "$INSTDIR\examples" "" "$INSTDIR\examples" 0 \
248 SW_SHOWNORMAL "" ""
249SectionEnd
250
a7171293 251
a7171293
UH
252# --- Uninstaller section -----------------------------------------------------
253
254Section "Uninstall"
a7171293
UH
255 # Always delete the uninstaller first (yes, this really works).
256 Delete "$INSTDIR\Uninstall.exe"
257
258 # Delete the application, the application data, and related libs.
259 Delete "$INSTDIR\COPYING"
260 Delete "$INSTDIR\pulseview.exe"
48898353
UH
261 Delete "$INSTDIR\zadig.exe"
262 Delete "$INSTDIR\zadig_xp.exe"
0ebddfac
UH
263 Delete "$INSTDIR\python34.dll"
264 Delete "$INSTDIR\python34.zip"
a7171293 265
a7e53a4a 266 # Delete all decoders and everything else in libsigrokdecode/.
a7171293 267 # There could be *.pyc files or __pycache__ subdirs and so on.
a7e53a4a 268 RMDir /r "$INSTDIR\share\libsigrokdecode"
a7171293 269
d8823c8c 270 # Delete the firmware files.
a7e53a4a 271 RMDir /r "$INSTDIR\share\sigrok-firmware"
d8823c8c 272
95052d70
UH
273 # Delete the example *.sr files.
274 RMDir /r "$INSTDIR\examples\*"
275
a7171293 276 # Delete the install directory and its sub-directories.
a7e53a4a 277 RMDir "$INSTDIR\share"
95052d70 278 RMDir "$INSTDIR\examples"
a7171293
UH
279 RMDir "$INSTDIR"
280
281 # Delete the links from the start menu.
282 Delete "$SMPROGRAMS\sigrok\PulseView\PulseView.lnk"
b8f93b68
UH
283 Delete "$SMPROGRAMS\sigrok\PulseView\Uninstall PulseView.lnk"
284 Delete "$SMPROGRAMS\sigrok\PulseView\Zadig (PulseView).lnk"
285 Delete "$SMPROGRAMS\sigrok\PulseView\Zadig (PulseView, Win XP).lnk"
0e206885 286 Delete "$SMPROGRAMS\sigrok\PulseView\Examples (PulseView).lnk"
a7171293
UH
287
288 # Delete the sub-directory in the start menu.
289 RMDir "$SMPROGRAMS\sigrok\PulseView"
290 RMDir "$SMPROGRAMS\sigrok"
291
292 # Delete the registry key(s).
293 DeleteRegKey HKLM "${REGSTR}"
294
63ebd7fe
SA
295 # Unregister any previously registered file extension(s).
296 ${unregisterExtension} ".sr" "sigrok session file"
297
ebe0a196
SA
298 # Force Windows to update the icon cache so that the icon for .sr files is reset.
299 System::Call 'Shell32::SHChangeNotify(i ${SHCNE_ASSOCCHANGED}, i ${SHCNF_IDLIST}, i 0, i 0)'
a7171293
UH
300SectionEnd
301
302
303# --- Component selection section descriptions --------------------------------
304
4bbd53c9
SA
305LangString DESC_Section1 ${LANG_ENGLISH} "This installs the PulseView sigrok GUI, some firmware files, the protocol decoders, and all required libraries."
306LangString DESC_Section2 ${LANG_ENGLISH} "This installs some example files that you can use to try out the features sigrok has to offer."
a7171293
UH
307
308!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
4bbd53c9
SA
309 !insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
310 !insertmacro MUI_DESCRIPTION_TEXT ${Section2} $(DESC_Section2)
a7171293
UH
311!insertmacro MUI_FUNCTION_DESCRIPTION_END
312