[sigrok-cli.git] / contrib / sigrok-cli_cross.nsi.in

##
## This file is part of the sigrok-cli project.
##
## Copyright (C) 2011-2014 Uwe Hermann <uwe@hermann-uwe.de>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, see <http://www.gnu.org/licenses/>.
##

#
# This file is used to create the sigrok-cli Windows installer via NSIS.
# It is meant for use in a cross-compile setup (not for native builds).
# See the 'sigrok-cross-mingw' script in the sigrok-util repo for details.
#
# NSIS documentation:
# http://nsis.sourceforge.net/Docs/
# http://nsis.sourceforge.net/Docs/Modern%20UI%202/Readme.html
#

# Include the "Modern UI" header, which gives us the usual Windows look-n-feel.
!include "MUI2.nsh"


# --- Global stuff ------------------------------------------------------------

# Installer/product name.
Name "@PACKAGE_NAME@"

# Filename of the installer executable.
OutFile "@PACKAGE_NAME@-@SC_PACKAGE_VERSION@-installer.exe"

# Where to install the application.
InstallDir "$PROGRAMFILES\sigrok\@PACKAGE_NAME@"

# Request admin privileges for Windows Vista and Windows 7.
# http://nsis.sourceforge.net/Docs/Chapter4.html
RequestExecutionLevel admin

# Local helper definitions.
!define REGSTR "Software\Microsoft\Windows\CurrentVersion\Uninstall\@PACKAGE_NAME@"


# --- MUI interface configuration ---------------------------------------------

# Use the following icon for the installer EXE file.
!define MUI_ICON "@top_srcdir@/contrib/sigrok-logo-notext.ico"

# Show a nice image at the top of each installer page.
!define MUI_HEADERIMAGE

# Don't automatically go to the Finish page so the user can check the log.
!define MUI_FINISHPAGE_NOAUTOCLOSE

# Upon "cancel", ask the user if he really wants to abort the installer.
!define MUI_ABORTWARNING

# Don't force the user to accept the license, just show it.
# Details: http://trac.videolan.org/vlc/ticket/3124
!define MUI_LICENSEPAGE_BUTTON $(^NextBtn)
!define MUI_LICENSEPAGE_TEXT_BOTTOM "Click Next to continue."

# Path where the cross-compiled sigrok tools and libraries are located.
# Change this to where-ever you installed libsigrok.a and so on.
!define CROSS "@prefix@"


# --- MUI pages ---------------------------------------------------------------

# Show a nice "Welcome to the ... Setup Wizard" page.
!insertmacro MUI_PAGE_WELCOME

# Show the license of the project.
!insertmacro MUI_PAGE_LICENSE "@top_srcdir@/COPYING"

# Show a screen which allows the user to select which components to install.
!insertmacro MUI_PAGE_COMPONENTS

# Allow the user to select a different install directory.
!insertmacro MUI_PAGE_DIRECTORY

# Perform the actual installation, i.e. install the files.
!insertmacro MUI_PAGE_INSTFILES

# Show a final "We're done, click Finish to close this wizard" message.
!insertmacro MUI_PAGE_FINISH

# Pages used for the uninstaller.
!insertmacro MUI_UNPAGE_WELCOME
!insertmacro MUI_UNPAGE_CONFIRM
!insertmacro MUI_UNPAGE_INSTFILES
!insertmacro MUI_UNPAGE_FINISH


# --- MUI language files ------------------------------------------------------

# Select an installer language (required!).
!insertmacro MUI_LANGUAGE "English"


# --- Default section ---------------------------------------------------------

Section "@PACKAGE_NAME@ (required)" Section1

	# This section is gray (can't be disabled) in the component list.
	SectionIn RO

	# Install the file(s) specified below into the specified directory.
	SetOutPath "$INSTDIR"

	# License file.
	File "@top_srcdir@/COPYING"

	# sigrok-cli.exe.
	File "${CROSS}/bin/@PACKAGE_NAME@.exe"

	# Zadig (used for installing WinUSB drivers).
	File "${CROSS}/zadig.exe"
	File "${CROSS}/zadig_xp.exe"

	# Python
	File "${CROSS}/python34.dll"
	File "${CROSS}/python34.zip"

	SetOutPath "$INSTDIR\share"

	# Protocol decoders.
	File /r /x "__pycache__" /x "*.pyc" "${CROSS}/share/libsigrokdecode"

	# Firmware files.
	File /r "${CROSS}/share/sigrok-firmware"

	# Example *.sr files.
	SetOutPath "$INSTDIR\examples"
	File /r "${CROSS}/share/sigrok-dumps/*"

	# Generate the uninstaller executable.
	WriteUninstaller "$INSTDIR\Uninstall.exe"

	# Create a sub-directory in the start menu.
	CreateDirectory "$SMPROGRAMS\sigrok"
	CreateDirectory "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"

	# Create a shortcut for sigrok-cli (this merely opens a "DOS box").
	# Set the working directory (where the user will be placed into when
	# the DOS box starts) to the installation directory.
	SetOutPath "$INSTDIR"
	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk" \
		"$SYSDIR\cmd.exe" \
		"/K echo For instructions run @PACKAGE_NAME@ --help." \
		"$SYSDIR\cmd.exe" 0 \
		SW_SHOWNORMAL "" "Run @PACKAGE_NAME@"

	# Create a shortcut for the uninstaller.
	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall.lnk" \
		"$INSTDIR\Uninstall.exe" "" "$INSTDIR\Uninstall.exe" 0 \
		SW_SHOWNORMAL "" "Uninstall @PACKAGE_NAME@"

	# Create a shortcut for the Zadig executable.
	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig.lnk" \
		"$INSTDIR\zadig.exe" "" "$INSTDIR\zadig.exe" 0 \
		SW_SHOWNORMAL "" "Zadig"

	# Create a shortcut for the Zadig executable (for Win XP).
	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (Win XP).lnk" \
		"$INSTDIR\zadig_xp.exe" "" "$INSTDIR\zadig_xp.exe" 0 \
		SW_SHOWNORMAL "" "Zadig (Win XP)"

	# Create registry keys for "Add/remove programs" in the control panel.
	WriteRegStr HKLM "${REGSTR}" "DisplayName" "@PACKAGE_STRING@"
	WriteRegStr HKLM "${REGSTR}" "UninstallString" \
		"$\"$INSTDIR\Uninstall.exe$\""
	WriteRegStr HKLM "${REGSTR}" "InstallLocation" "$\"$INSTDIR$\""
	WriteRegStr HKLM "${REGSTR}" "DisplayIcon" \
		"$\"$INSTDIR\sigrok-logo-notext.ico$\""
	WriteRegStr HKLM "${REGSTR}" "Publisher" "sigrok"
	WriteRegStr HKLM "${REGSTR}" "HelpLink" \
		"http://sigrok.org/wiki/Sigrok-cli"
	WriteRegStr HKLM "${REGSTR}" "URLUpdateInfo" \
		"http://sigrok.org/wiki/Downloads"
	WriteRegStr HKLM "${REGSTR}" "URLInfoAbout" "http://sigrok.org"
	WriteRegStr HKLM "${REGSTR}" "DisplayVersion" "@SC_PACKAGE_VERSION@"
	WriteRegStr HKLM "${REGSTR}" "Contact" \
		"sigrok-devel@lists.sourceforge.org"
	WriteRegStr HKLM "${REGSTR}" "Comments" \
		"This is the sigrok command-line application."

	# Display "Remove" instead of "Modify/Remove" in the control panel.
	WriteRegDWORD HKLM "${REGSTR}" "NoModify" 1
	WriteRegDWORD HKLM "${REGSTR}" "NoRepair" 1

	# TODO: Add sigrok-cli directory to the PATH env. variable.

SectionEnd


# --- Uninstaller section -----------------------------------------------------

Section "Uninstall"

	# Always delete the uninstaller first (yes, this really works).
	Delete "$INSTDIR\Uninstall.exe"

	# Delete the application, the application data, and related libs.
	Delete "$INSTDIR\COPYING"
	Delete "$INSTDIR\@PACKAGE_NAME@.exe"
	Delete "$INSTDIR\zadig.exe"
	Delete "$INSTDIR\zadig_xp.exe"
	Delete "$INSTDIR\python34.dll"
	Delete "$INSTDIR\python34.zip"

	# Delete all decoders and everything else in libsigrokdecode/.
	# There could be *.pyc files or __pycache__ subdirs and so on.
	RMDir /r "$INSTDIR\share\libsigrokdecode"

	# Delete the firmware files.
	RMDir /r "$INSTDIR\share\sigrok-firmware"

	# Delete the example *.sr files.
	RMDir /r "$INSTDIR\examples\*"

	# Delete the install directory and its sub-directories.
	RMDir "$INSTDIR\share"
	RMDir "$INSTDIR\examples"
	RMDir "$INSTDIR"

	# Delete the links from the start menu.
	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk"
	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall.lnk"
	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig.lnk"
	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (Win XP).lnk"

	# Delete the sub-directory in the start menu.
	RMDir "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
	RMDir "$SMPROGRAMS\sigrok"

	# Delete the registry key(s).
	DeleteRegKey HKLM "${REGSTR}"

SectionEnd


# --- Component selection section descriptions --------------------------------

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."

!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
!insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
!insertmacro MUI_FUNCTION_DESCRIPTION_END
Commit	Line	Data
58b03628 UH	1	##
	2	## This file is part of the sigrok-cli project.
	3	##
01833aec	4	## Copyright (C) 2011-2014 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.
	37	Name "@PACKAGE_NAME@"
	38
	39	# Filename of the installer executable.
9d642270	40	OutFile "@PACKAGE_NAME@-@SC_PACKAGE_VERSION@-installer.exe"
58b03628 UH	41
	42	# Where to install the application.
	43	InstallDir "$PROGRAMFILES\sigrok\@PACKAGE_NAME@"
	44
	45	# Request admin privileges for Windows Vista and Windows 7.
	46	# http://nsis.sourceforge.net/Docs/Chapter4.html
	47	RequestExecutionLevel admin
	48
	49	# Local helper definitions.
	50	!define REGSTR "Software\Microsoft\Windows\CurrentVersion\Uninstall\@PACKAGE_NAME@"
	51
	52
	53	# --- MUI interface configuration ---------------------------------------------
	54
	55	# Use the following icon for the installer EXE file.
4c6bfc08	56	!define MUI_ICON "@top_srcdir@/contrib/sigrok-logo-notext.ico"
58b03628 UH	57
	58	# Show a nice image at the top of each installer page.
	59	!define MUI_HEADERIMAGE
	60
	61	# Don't automatically go to the Finish page so the user can check the log.
	62	!define MUI_FINISHPAGE_NOAUTOCLOSE
	63
	64	# Upon "cancel", ask the user if he really wants to abort the installer.
	65	!define MUI_ABORTWARNING
	66
	67	# Don't force the user to accept the license, just show it.
	68	# Details: http://trac.videolan.org/vlc/ticket/3124
	69	!define MUI_LICENSEPAGE_BUTTON $(^NextBtn)
	70	!define MUI_LICENSEPAGE_TEXT_BOTTOM "Click Next to continue."
	71
58b03628 UH	72	# Path where the cross-compiled sigrok tools and libraries are located.
58b03628 UH	73	# Change this to where-ever you installed libsigrok.a and so on.
4c6bfc08	74	!define CROSS "@prefix@"
58b03628 UH	75
	76
	77	# --- MUI pages ---------------------------------------------------------------
	78
	79	# Show a nice "Welcome to the ... Setup Wizard" page.
	80	!insertmacro MUI_PAGE_WELCOME
	81
	82	# Show the license of the project.
4c6bfc08	83	!insertmacro MUI_PAGE_LICENSE "@top_srcdir@/COPYING"
58b03628 UH	84
	85	# Show a screen which allows the user to select which components to install.
	86	!insertmacro MUI_PAGE_COMPONENTS
	87
	88	# Allow the user to select a different install directory.
	89	!insertmacro MUI_PAGE_DIRECTORY
	90
	91	# Perform the actual installation, i.e. install the files.
	92	!insertmacro MUI_PAGE_INSTFILES
	93
	94	# Show a final "We're done, click Finish to close this wizard" message.
	95	!insertmacro MUI_PAGE_FINISH
	96
	97	# Pages used for the uninstaller.
	98	!insertmacro MUI_UNPAGE_WELCOME
	99	!insertmacro MUI_UNPAGE_CONFIRM
	100	!insertmacro MUI_UNPAGE_INSTFILES
	101	!insertmacro MUI_UNPAGE_FINISH
	102
	103
	104	# --- MUI language files ------------------------------------------------------
	105
	106	# Select an installer language (required!).
	107	!insertmacro MUI_LANGUAGE "English"
	108
	109
	110	# --- Default section ---------------------------------------------------------
	111
	112	Section "@PACKAGE_NAME@ (required)" Section1
	113
	114	# This section is gray (can't be disabled) in the component list.
	115	SectionIn RO
	116
	117	# Install the file(s) specified below into the specified directory.
	118	SetOutPath "$INSTDIR"
	119
01833aec	120	# License file.
4c6bfc08	121	File "@top_srcdir@/COPYING"
58b03628	122
0b34fecd	123	# sigrok-cli.exe.
58b03628 UH	124	File "${CROSS}/bin/@PACKAGE_NAME@.exe"
58b03628 UH	125
5b1a6c2a	126	# Zadig (used for installing WinUSB drivers).
7d8068f8 UH	127	File "${CROSS}/zadig.exe"
	128	File "${CROSS}/zadig_xp.exe"
	129
0b34fecd	130	# Python
f4c490a7 UH	131	File "${CROSS}/python34.dll"
f4c490a7 UH	132	File "${CROSS}/python34.zip"
0b34fecd	133
a5396d7b DE	134	SetOutPath "$INSTDIR\share"
a5396d7b DE	135
01833aec	136	# Protocol decoders.
a5396d7b	137	File /r /x "__pycache__" /x "*.pyc" "${CROSS}/share/libsigrokdecode"
58b03628	138
01833aec	139	# Firmware files.
a5396d7b	140	File /r "${CROSS}/share/sigrok-firmware"
01833aec	141
72db8c56 UH	142	# Example *.sr files.
	143	SetOutPath "$INSTDIR\examples"
	144	File /r "${CROSS}/share/sigrok-dumps/*"
	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.
1afa97c5 UH	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.
	164	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall.lnk" \
	165	"$INSTDIR\Uninstall.exe" "" "$INSTDIR\Uninstall.exe" 0 \
	166	SW_SHOWNORMAL "" "Uninstall @PACKAGE_NAME@"
	167
6ffb6577 UH	168	# Create a shortcut for the Zadig executable.
	169	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig.lnk" \
	170	"$INSTDIR\zadig.exe" "" "$INSTDIR\zadig.exe" 0 \
	171	SW_SHOWNORMAL "" "Zadig"
	172
	173	# Create a shortcut for the Zadig executable (for Win XP).
	174	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (Win XP).lnk" \
	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.
	202
	203	SectionEnd
	204
	205
58b03628 UH	206	# --- Uninstaller section -----------------------------------------------------
	207
	208	Section "Uninstall"
	209
	210	# Always delete the uninstaller first (yes, this really works).
	211	Delete "$INSTDIR\Uninstall.exe"
	212
	213	# Delete the application, the application data, and related libs.
	214	Delete "$INSTDIR\COPYING"
	215	Delete "$INSTDIR\@PACKAGE_NAME@.exe"
7d8068f8 UH	216	Delete "$INSTDIR\zadig.exe"
7d8068f8 UH	217	Delete "$INSTDIR\zadig_xp.exe"
f4c490a7 UH	218	Delete "$INSTDIR\python34.dll"
f4c490a7 UH	219	Delete "$INSTDIR\python34.zip"
58b03628	220
a5396d7b	221	# Delete all decoders and everything else in libsigrokdecode/.
58b03628	222	# There could be *.pyc files or __pycache__ subdirs and so on.
a5396d7b	223	RMDir /r "$INSTDIR\share\libsigrokdecode"
58b03628	224
01833aec	225	# Delete the firmware files.
a5396d7b	226	RMDir /r "$INSTDIR\share\sigrok-firmware"
01833aec	227
72db8c56 UH	228	# Delete the example *.sr files.
	229	RMDir /r "$INSTDIR\examples\*"
	230
58b03628	231	# Delete the install directory and its sub-directories.
a5396d7b	232	RMDir "$INSTDIR\share"
72db8c56	233	RMDir "$INSTDIR\examples"
58b03628 UH	234	RMDir "$INSTDIR"
	235
	236	# Delete the links from the start menu.
	237	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk"
	238	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall.lnk"
6ffb6577 UH	239	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig.lnk"
6ffb6577 UH	240	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Zadig (Win XP).lnk"
58b03628 UH	241
	242	# Delete the sub-directory in the start menu.
	243	RMDir "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
	244	RMDir "$SMPROGRAMS\sigrok"
	245
	246	# Delete the registry key(s).
	247	DeleteRegKey HKLM "${REGSTR}"
	248
	249	SectionEnd
	250
	251
	252	# --- Component selection section descriptions --------------------------------
	253
72db8c56	254	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."
58b03628 UH	255
	256	!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
	257	!insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
58b03628 UH	258	!insertmacro MUI_FUNCTION_DESCRIPTION_END
58b03628 UH	259