]> sigrok.org Git - sigrok-cli.git/blame - contrib/sigrok-cli_cross.nsi.in
nsis: Fix for installing 64bit Windows programs into 'Program Files'
[sigrok-cli.git] / contrib / sigrok-cli_cross.nsi.in
CommitLineData
58b03628
UH
1##
2## This file is part of the sigrok-cli project.
3##
cccdd2b9 4## Copyright (C) 2011-2020 Uwe Hermann <uwe@hermann-uwe.de>
58b03628
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
04044d1b 17## along with this program; if not, see <http://www.gnu.org/licenses/>.
58b03628
UH
18##
19
20#
21# This file is used to create the sigrok-cli 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
33
34# --- Global stuff ------------------------------------------------------------
35
36# Installer/product name.
37Name "@PACKAGE_NAME@"
38
39# Filename of the installer executable.
9d642270 40OutFile "@PACKAGE_NAME@-@SC_PACKAGE_VERSION@-installer.exe"
58b03628
UH
41
42# Where to install the application.
a23df119 43!ifdef PE64
44 InstallDir "$PROGRAMFILES64\sigrok\@PACKAGE_NAME@"
45!else
46 InstallDir "$PROGRAMFILES\sigrok\@PACKAGE_NAME@"
47!endif
58b03628
UH
48
49# Request admin privileges for Windows Vista and Windows 7.
50# http://nsis.sourceforge.net/Docs/Chapter4.html
51RequestExecutionLevel admin
52
53# Local helper definitions.
54!define REGSTR "Software\Microsoft\Windows\CurrentVersion\Uninstall\@PACKAGE_NAME@"
55
56
57# --- MUI interface configuration ---------------------------------------------
58
59# Use the following icon for the installer EXE file.
4c6bfc08 60!define MUI_ICON "@top_srcdir@/contrib/sigrok-logo-notext.ico"
58b03628
UH
61
62# Show a nice image at the top of each installer page.
63!define MUI_HEADERIMAGE
64
65# Don't automatically go to the Finish page so the user can check the log.
66!define MUI_FINISHPAGE_NOAUTOCLOSE
67
68# Upon "cancel", ask the user if he really wants to abort the installer.
69!define MUI_ABORTWARNING
70
71# Don't force the user to accept the license, just show it.
72# Details: http://trac.videolan.org/vlc/ticket/3124
73!define MUI_LICENSEPAGE_BUTTON $(^NextBtn)
74!define MUI_LICENSEPAGE_TEXT_BOTTOM "Click Next to continue."
75
58b03628
UH
76# Path where the cross-compiled sigrok tools and libraries are located.
77# Change this to where-ever you installed libsigrok.a and so on.
4c6bfc08 78!define CROSS "@prefix@"
58b03628
UH
79
80
81# --- MUI pages ---------------------------------------------------------------
82
83# Show a nice "Welcome to the ... Setup Wizard" page.
84!insertmacro MUI_PAGE_WELCOME
85
86# Show the license of the project.
4c6bfc08 87!insertmacro MUI_PAGE_LICENSE "@top_srcdir@/COPYING"
58b03628
UH
88
89# Show a screen which allows the user to select which components to install.
90!insertmacro MUI_PAGE_COMPONENTS
91
92# Allow the user to select a different install directory.
93!insertmacro MUI_PAGE_DIRECTORY
94
95# Perform the actual installation, i.e. install the files.
96!insertmacro MUI_PAGE_INSTFILES
97
98# Show a final "We're done, click Finish to close this wizard" message.
99!insertmacro MUI_PAGE_FINISH
100
101# Pages used for the uninstaller.
102!insertmacro MUI_UNPAGE_WELCOME
103!insertmacro MUI_UNPAGE_CONFIRM
104!insertmacro MUI_UNPAGE_INSTFILES
105!insertmacro MUI_UNPAGE_FINISH
106
107
108# --- MUI language files ------------------------------------------------------
109
110# Select an installer language (required!).
111!insertmacro MUI_LANGUAGE "English"
112
113
114# --- Default section ---------------------------------------------------------
115
116Section "@PACKAGE_NAME@ (required)" Section1
58b03628
UH
117 # This section is gray (can't be disabled) in the component list.
118 SectionIn RO
119
120 # Install the file(s) specified below into the specified directory.
121 SetOutPath "$INSTDIR"
122
01833aec 123 # License file.
4c6bfc08 124 File "@top_srcdir@/COPYING"
58b03628 125
0b34fecd 126 # sigrok-cli.exe.
58b03628
UH
127 File "${CROSS}/bin/@PACKAGE_NAME@.exe"
128
5b1a6c2a 129 # Zadig (used for installing WinUSB drivers).
7d8068f8
UH
130 File "${CROSS}/zadig.exe"
131 File "${CROSS}/zadig_xp.exe"
132
0b34fecd 133 # Python
f4c490a7
UH
134 File "${CROSS}/python34.dll"
135 File "${CROSS}/python34.zip"
cccdd2b9 136 File "${CROSS}/*.pyd"
0b34fecd 137
a5396d7b
DE
138 SetOutPath "$INSTDIR\share"
139
01833aec 140 # Protocol decoders.
a5396d7b 141 File /r /x "__pycache__" /x "*.pyc" "${CROSS}/share/libsigrokdecode"
58b03628 142
01833aec 143 # Firmware files.
a5396d7b 144 File /r "${CROSS}/share/sigrok-firmware"
01833aec 145
58b03628
UH
146 # Generate the uninstaller executable.
147 WriteUninstaller "$INSTDIR\Uninstall.exe"
148
149 # Create a sub-directory in the start menu.
150 CreateDirectory "$SMPROGRAMS\sigrok"
151 CreateDirectory "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
152
153 # Create a shortcut for sigrok-cli (this merely opens a "DOS box").
154 # Set the working directory (where the user will be placed into when
1afa97c5
UH
155 # the DOS box starts) to the installation directory.
156 SetOutPath "$INSTDIR"
58b03628
UH
157 CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk" \
158 "$SYSDIR\cmd.exe" \
159 "/K echo For instructions run @PACKAGE_NAME@ --help." \
160 "$SYSDIR\cmd.exe" 0 \
161 SW_SHOWNORMAL "" "Run @PACKAGE_NAME@"
162
163 # Create a shortcut for the uninstaller.
d8f647c4 164 CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall @PACKAGE_NAME@.lnk" \
58b03628
UH
165 "$INSTDIR\Uninstall.exe" "" "$INSTDIR\Uninstall.exe" 0 \
166 SW_SHOWNORMAL "" "Uninstall @PACKAGE_NAME@"
167
6ffb6577 168 # Create a shortcut for the Zadig executable.
d8f647c4 169 CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (@PACKAGE_NAME@).lnk" \
6ffb6577
UH
170 "$INSTDIR\zadig.exe" "" "$INSTDIR\zadig.exe" 0 \
171 SW_SHOWNORMAL "" "Zadig"
172
173 # Create a shortcut for the Zadig executable (for Win XP).
d8f647c4 174 CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (@PACKAGE_NAME@, Win XP).lnk" \
6ffb6577
UH
175 "$INSTDIR\zadig_xp.exe" "" "$INSTDIR\zadig_xp.exe" 0 \
176 SW_SHOWNORMAL "" "Zadig (Win XP)"
177
58b03628
UH
178 # Create registry keys for "Add/remove programs" in the control panel.
179 WriteRegStr HKLM "${REGSTR}" "DisplayName" "@PACKAGE_STRING@"
180 WriteRegStr HKLM "${REGSTR}" "UninstallString" \
181 "$\"$INSTDIR\Uninstall.exe$\""
182 WriteRegStr HKLM "${REGSTR}" "InstallLocation" "$\"$INSTDIR$\""
183 WriteRegStr HKLM "${REGSTR}" "DisplayIcon" \
184 "$\"$INSTDIR\sigrok-logo-notext.ico$\""
185 WriteRegStr HKLM "${REGSTR}" "Publisher" "sigrok"
186 WriteRegStr HKLM "${REGSTR}" "HelpLink" \
187 "http://sigrok.org/wiki/Sigrok-cli"
188 WriteRegStr HKLM "${REGSTR}" "URLUpdateInfo" \
189 "http://sigrok.org/wiki/Downloads"
190 WriteRegStr HKLM "${REGSTR}" "URLInfoAbout" "http://sigrok.org"
9d642270 191 WriteRegStr HKLM "${REGSTR}" "DisplayVersion" "@SC_PACKAGE_VERSION@"
58b03628
UH
192 WriteRegStr HKLM "${REGSTR}" "Contact" \
193 "sigrok-devel@lists.sourceforge.org"
194 WriteRegStr HKLM "${REGSTR}" "Comments" \
195 "This is the sigrok command-line application."
196
197 # Display "Remove" instead of "Modify/Remove" in the control panel.
198 WriteRegDWORD HKLM "${REGSTR}" "NoModify" 1
199 WriteRegDWORD HKLM "${REGSTR}" "NoRepair" 1
200
201 # TODO: Add sigrok-cli directory to the PATH env. variable.
58b03628
UH
202SectionEnd
203
a663411b
SA
204Section /o "Example data" Section2
205 # Example *.sr files.
206 SetOutPath "$INSTDIR\examples"
207
208 File "${CROSS}/share/sigrok-dumps/arm_trace/stm32f105/trace_example.sr"
209 File "${CROSS}/share/sigrok-dumps/am230x/am2301/am2301_1mhz.sr"
210 File "${CROSS}/share/sigrok-dumps/avr_isp/atmega88/isp_atmega88_erase_chip.sr"
211 File "${CROSS}/share/sigrok-dumps/can/microchip_mcp2515dm-bm/mcp2515dm-bm-125kbits_msg_222_5bytes.sr"
212 File "${CROSS}/share/sigrok-dumps/dcf77/pollin_dcf1_module/dcf77_120s.sr"
213 File "${CROSS}/share/sigrok-dumps/i2c/eeprom_24xx/microchip_24lc02b/hantek_6022be_powerup.sr"
214 File "${CROSS}/share/sigrok-dumps/i2c/eeprom_24xx/microchip_24lc64/sainsmart_dds120_powerup_scl_sda_analog.sr"
215 File "${CROSS}/share/sigrok-dumps/i2c/potentiometer/analog_devices_ad5258/ad5258_read_once_write_continuously_triangle.sr"
216 File "${CROSS}/share/sigrok-dumps/mdio/lan8720a/lan8720a_read_write_read.sr"
217 File "${CROSS}/share/sigrok-dumps/onewire/owfs/ds28ea00.sr"
218 File "${CROSS}/share/sigrok-dumps/sdcard/sd_mode/rcar-h2/cmd23_cmd18.sr"
219 File "${CROSS}/share/sigrok-dumps/spi/mx25l1605d/mx25l1605d_read.sr"
220 File "${CROSS}/share/sigrok-dumps/uart/gps/mtk3339/mtk3339_8n1_9600.sr"
221 File "${CROSS}/share/sigrok-dumps/usb/hid/mouse/olimex_stm32-h103_usb_hid/olimex_stm32-h103_usb_hid.sr"
222 File "${CROSS}/share/sigrok-dumps/z80/kc85/kc85-20mhz.sr"
223
224 # Create a shortcut for the example data folder.
d8f647c4 225 CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Examples (@PACKAGE_NAME@).lnk" \
a663411b
SA
226 "$INSTDIR\examples" "" "$INSTDIR\examples" 0 \
227 SW_SHOWNORMAL "" ""
228SectionEnd
229
58b03628 230
58b03628
UH
231# --- Uninstaller section -----------------------------------------------------
232
233Section "Uninstall"
58b03628
UH
234 # Always delete the uninstaller first (yes, this really works).
235 Delete "$INSTDIR\Uninstall.exe"
236
237 # Delete the application, the application data, and related libs.
238 Delete "$INSTDIR\COPYING"
239 Delete "$INSTDIR\@PACKAGE_NAME@.exe"
7d8068f8
UH
240 Delete "$INSTDIR\zadig.exe"
241 Delete "$INSTDIR\zadig_xp.exe"
f4c490a7
UH
242 Delete "$INSTDIR\python34.dll"
243 Delete "$INSTDIR\python34.zip"
cccdd2b9 244 Delete "$INSTDIR\*.pyd"
58b03628 245
a5396d7b 246 # Delete all decoders and everything else in libsigrokdecode/.
58b03628 247 # There could be *.pyc files or __pycache__ subdirs and so on.
a5396d7b 248 RMDir /r "$INSTDIR\share\libsigrokdecode"
58b03628 249
01833aec 250 # Delete the firmware files.
a5396d7b 251 RMDir /r "$INSTDIR\share\sigrok-firmware"
01833aec 252
72db8c56
UH
253 # Delete the example *.sr files.
254 RMDir /r "$INSTDIR\examples\*"
255
58b03628 256 # Delete the install directory and its sub-directories.
a5396d7b 257 RMDir "$INSTDIR\share"
72db8c56 258 RMDir "$INSTDIR\examples"
58b03628
UH
259 RMDir "$INSTDIR"
260
261 # Delete the links from the start menu.
262 Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk"
d8f647c4
SA
263 Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall @PACKAGE_NAME@.lnk"
264 Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (@PACKAGE_NAME@).lnk"
265 Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (@PACKAGE_NAME@, Win XP).lnk"
266 Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Examples (@PACKAGE_NAME@).lnk"
58b03628
UH
267
268 # Delete the sub-directory in the start menu.
269 RMDir "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
270 RMDir "$SMPROGRAMS\sigrok"
271
272 # Delete the registry key(s).
273 DeleteRegKey HKLM "${REGSTR}"
58b03628
UH
274SectionEnd
275
276
277# --- Component selection section descriptions --------------------------------
278
a663411b
SA
279LangString DESC_Section1 ${LANG_ENGLISH} "This installs the sigrok command-line tool, some firmware files, the protocol decoders, and all required libraries."
280LangString DESC_Section2 ${LANG_ENGLISH} "This installs some example files that you can use to try out the features sigrok has to offer."
58b03628
UH
281
282!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
a663411b
SA
283 !insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
284 !insertmacro MUI_DESCRIPTION_TEXT ${Section2} $(DESC_Section2)
58b03628
UH
285!insertmacro MUI_FUNCTION_DESCRIPTION_END
286