2 ## This file is part of the sigrok-cli project.
4 ## Copyright (C) 2011-2014 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, write to the Free Software
18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 # This file is used to create the sigrok-cli Windows installer via NSIS.
23 # It is meant for use in a cross-compile setup (not for native builds).
24 # See the 'sigrok-cross-mingw' script in the sigrok-util repo for details.
27 # http://nsis.sourceforge.net/Docs/
28 # http://nsis.sourceforge.net/Docs/Modern%20UI%202/Readme.html
31 # Include the "Modern UI" header, which gives us the usual Windows look-n-feel.
35 # --- Global stuff ------------------------------------------------------------
37 # Installer/product name.
40 # Filename of the installer executable.
41 OutFile "@PACKAGE_NAME@-@SC_PACKAGE_VERSION@-installer.exe"
43 # Where to install the application.
44 InstallDir "$PROGRAMFILES\sigrok\@PACKAGE_NAME@"
46 # Request admin privileges for Windows Vista and Windows 7.
47 # http://nsis.sourceforge.net/Docs/Chapter4.html
48 RequestExecutionLevel admin
50 # Local helper definitions.
51 !define REGSTR "Software\Microsoft\Windows\CurrentVersion\Uninstall\@PACKAGE_NAME@"
54 # --- MUI interface configuration ---------------------------------------------
56 # Use the following icon for the installer EXE file.
57 !define MUI_ICON "@top_srcdir@/contrib/sigrok-logo-notext.ico"
59 # Show a nice image at the top of each installer page.
60 !define MUI_HEADERIMAGE
62 # Don't automatically go to the Finish page so the user can check the log.
63 !define MUI_FINISHPAGE_NOAUTOCLOSE
65 # Upon "cancel", ask the user if he really wants to abort the installer.
66 !define MUI_ABORTWARNING
68 # Don't force the user to accept the license, just show it.
69 # Details: http://trac.videolan.org/vlc/ticket/3124
70 !define MUI_LICENSEPAGE_BUTTON $(^NextBtn)
71 !define MUI_LICENSEPAGE_TEXT_BOTTOM "Click Next to continue."
73 # Path where the cross-compiled sigrok tools and libraries are located.
74 # Change this to where-ever you installed libsigrok.a and so on.
75 !define CROSS "@prefix@"
78 # --- MUI pages ---------------------------------------------------------------
80 # Show a nice "Welcome to the ... Setup Wizard" page.
81 !insertmacro MUI_PAGE_WELCOME
83 # Show the license of the project.
84 !insertmacro MUI_PAGE_LICENSE "@top_srcdir@/COPYING"
86 # Show a screen which allows the user to select which components to install.
87 !insertmacro MUI_PAGE_COMPONENTS
89 # Allow the user to select a different install directory.
90 !insertmacro MUI_PAGE_DIRECTORY
92 # Perform the actual installation, i.e. install the files.
93 !insertmacro MUI_PAGE_INSTFILES
95 # Show a final "We're done, click Finish to close this wizard" message.
96 !insertmacro MUI_PAGE_FINISH
98 # Pages used for the uninstaller.
99 !insertmacro MUI_UNPAGE_WELCOME
100 !insertmacro MUI_UNPAGE_CONFIRM
101 !insertmacro MUI_UNPAGE_INSTFILES
102 !insertmacro MUI_UNPAGE_FINISH
105 # --- MUI language files ------------------------------------------------------
107 # Select an installer language (required!).
108 !insertmacro MUI_LANGUAGE "English"
111 # --- Default section ---------------------------------------------------------
113 Section "@PACKAGE_NAME@ (required)" Section1
115 # This section is gray (can't be disabled) in the component list.
118 # Install the file(s) specified below into the specified directory.
119 SetOutPath "$INSTDIR"
122 File "@top_srcdir@/COPYING"
125 File "${CROSS}/bin/@PACKAGE_NAME@.exe"
127 # Zadig (used for installing WinUSB drivers).
128 File "${CROSS}/zadig.exe"
129 File "${CROSS}/zadig_xp.exe"
132 File "${CROSS}/python32.dll"
133 File "${CROSS}/python32.zip"
135 SetOutPath "$INSTDIR\share"
138 File /r /x "__pycache__" /x "*.pyc" "${CROSS}/share/libsigrokdecode"
141 File /r "${CROSS}/share/sigrok-firmware"
143 # Example *.sr files.
144 SetOutPath "$INSTDIR\examples"
145 File /r "${CROSS}/share/sigrok-dumps/*"
147 # Generate the uninstaller executable.
148 WriteUninstaller "$INSTDIR\Uninstall.exe"
150 # Create a sub-directory in the start menu.
151 CreateDirectory "$SMPROGRAMS\sigrok"
152 CreateDirectory "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
154 # Create a shortcut for sigrok-cli (this merely opens a "DOS box").
155 # Set the working directory (where the user will be placed into when
156 # the DOS box starts) to the installation directory.
157 SetOutPath "$INSTDIR"
158 CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk" \
160 "/K echo For instructions run @PACKAGE_NAME@ --help." \
161 "$SYSDIR\cmd.exe" 0 \
162 SW_SHOWNORMAL "" "Run @PACKAGE_NAME@"
164 # Create a shortcut for the uninstaller.
165 CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall.lnk" \
166 "$INSTDIR\Uninstall.exe" "" "$INSTDIR\Uninstall.exe" 0 \
167 SW_SHOWNORMAL "" "Uninstall @PACKAGE_NAME@"
169 # Create a shortcut for the Zadig executable.
170 CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig.lnk" \
171 "$INSTDIR\zadig.exe" "" "$INSTDIR\zadig.exe" 0 \
172 SW_SHOWNORMAL "" "Zadig"
174 # Create a shortcut for the Zadig executable (for Win XP).
175 CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (Win XP).lnk" \
176 "$INSTDIR\zadig_xp.exe" "" "$INSTDIR\zadig_xp.exe" 0 \
177 SW_SHOWNORMAL "" "Zadig (Win XP)"
179 # Create registry keys for "Add/remove programs" in the control panel.
180 WriteRegStr HKLM "${REGSTR}" "DisplayName" "@PACKAGE_STRING@"
181 WriteRegStr HKLM "${REGSTR}" "UninstallString" \
182 "$\"$INSTDIR\Uninstall.exe$\""
183 WriteRegStr HKLM "${REGSTR}" "InstallLocation" "$\"$INSTDIR$\""
184 WriteRegStr HKLM "${REGSTR}" "DisplayIcon" \
185 "$\"$INSTDIR\sigrok-logo-notext.ico$\""
186 WriteRegStr HKLM "${REGSTR}" "Publisher" "sigrok"
187 WriteRegStr HKLM "${REGSTR}" "HelpLink" \
188 "http://sigrok.org/wiki/Sigrok-cli"
189 WriteRegStr HKLM "${REGSTR}" "URLUpdateInfo" \
190 "http://sigrok.org/wiki/Downloads"
191 WriteRegStr HKLM "${REGSTR}" "URLInfoAbout" "http://sigrok.org"
192 WriteRegStr HKLM "${REGSTR}" "DisplayVersion" "@SC_PACKAGE_VERSION@"
193 WriteRegStr HKLM "${REGSTR}" "Contact" \
194 "sigrok-devel@lists.sourceforge.org"
195 WriteRegStr HKLM "${REGSTR}" "Comments" \
196 "This is the sigrok command-line application."
198 # Display "Remove" instead of "Modify/Remove" in the control panel.
199 WriteRegDWORD HKLM "${REGSTR}" "NoModify" 1
200 WriteRegDWORD HKLM "${REGSTR}" "NoRepair" 1
202 # TODO: Add sigrok-cli directory to the PATH env. variable.
207 # --- Uninstaller section -----------------------------------------------------
211 # Always delete the uninstaller first (yes, this really works).
212 Delete "$INSTDIR\Uninstall.exe"
214 # Delete the application, the application data, and related libs.
215 Delete "$INSTDIR\COPYING"
216 Delete "$INSTDIR\@PACKAGE_NAME@.exe"
217 Delete "$INSTDIR\zadig.exe"
218 Delete "$INSTDIR\zadig_xp.exe"
219 Delete "$INSTDIR\python32.dll"
220 Delete "$INSTDIR\python32.zip"
222 # Delete all decoders and everything else in libsigrokdecode/.
223 # There could be *.pyc files or __pycache__ subdirs and so on.
224 RMDir /r "$INSTDIR\share\libsigrokdecode"
226 # Delete the firmware files.
227 RMDir /r "$INSTDIR\share\sigrok-firmware"
229 # Delete the example *.sr files.
230 RMDir /r "$INSTDIR\examples\*"
232 # Delete the install directory and its sub-directories.
233 RMDir "$INSTDIR\share"
234 RMDir "$INSTDIR\examples"
237 # Delete the links from the start menu.
238 Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk"
239 Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall.lnk"
240 Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig.lnk"
241 Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (Win XP).lnk"
243 # Delete the sub-directory in the start menu.
244 RMDir "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
245 RMDir "$SMPROGRAMS\sigrok"
247 # Delete the registry key(s).
248 DeleteRegKey HKLM "${REGSTR}"
253 # --- Component selection section descriptions --------------------------------
255 LangString DESC_Section1 ${LANG_ENGLISH} "This installs the sigrok command-line tool, some firmware files, the protocol decoders, some example files, and all required libraries."
257 !insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
258 !insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
259 !insertmacro MUI_FUNCTION_DESCRIPTION_END