[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, write to the Free Software
## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
##

#
# 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@-@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 "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 "$%HOME%/sr_mingw"

# Path where the cross-compiled MXE tools and libraries are located.
# Change this to where-ever you installed MXE (and the files it built).
!define MXE "$%HOME%/mxe-git/usr/i686-pc-mingw32"


# --- 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 "../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 "../COPYING"

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

	# libusb0.dll (needed for libusb-0.1).
	File "${CROSS}/libusb0.dll"

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

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

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

	# Firmware files.
	SetOutPath "$INSTDIR\firmware"
	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 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" "@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\libusb0.dll"
	Delete "$INSTDIR\zadig.exe"
	Delete "$INSTDIR\zadig_xp.exe"
	Delete "$INSTDIR\python32.dll"
	Delete "$INSTDIR\python32.zip"

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

	# Delete the firmware files.
	RMDir /r "$INSTDIR\firmware\*"

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

	# Delete the install directory and its sub-directories.
	RMDir "$INSTDIR\decoders"
	RMDir "$INSTDIR\firmware"
	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 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
	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
	19	##
	20
	21	#
	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.
	25	#
	26	# NSIS documentation:
	27	# http://nsis.sourceforge.net/Docs/
	28	# http://nsis.sourceforge.net/Docs/Modern%20UI%202/Readme.html
	29	#
	30
	31	# Include the "Modern UI" header, which gives us the usual Windows look-n-feel.
	32	!include "MUI2.nsh"
	33
	34
	35	# --- Global stuff ------------------------------------------------------------
	36
	37	# Installer/product name.
	38	Name "@PACKAGE_NAME@"
	39
	40	# Filename of the installer executable.
	41	OutFile "@PACKAGE_NAME@-@PACKAGE_VERSION@-installer.exe"
	42
	43	# Where to install the application.
	44	InstallDir "$PROGRAMFILES\sigrok\@PACKAGE_NAME@"
	45
	46	# Request admin privileges for Windows Vista and Windows 7.
	47	# http://nsis.sourceforge.net/Docs/Chapter4.html
	48	RequestExecutionLevel admin
	49
	50	# Local helper definitions.
	51	!define REGSTR "Software\Microsoft\Windows\CurrentVersion\Uninstall\@PACKAGE_NAME@"
	52
	53
	54	# --- MUI interface configuration ---------------------------------------------
	55
	56	# Use the following icon for the installer EXE file.
	57	!define MUI_ICON "sigrok-logo-notext.ico"
	58
	59	# Show a nice image at the top of each installer page.
	60	!define MUI_HEADERIMAGE
	61
	62	# Don't automatically go to the Finish page so the user can check the log.
	63	!define MUI_FINISHPAGE_NOAUTOCLOSE
	64
	65	# Upon "cancel", ask the user if he really wants to abort the installer.
	66	!define MUI_ABORTWARNING
	67
	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."
72
58b03628 UH	73	# Path where the cross-compiled sigrok tools and libraries are located.
58b03628 UH	74	# Change this to where-ever you installed libsigrok.a and so on.
e71b3ff7	75	!define CROSS "$%HOME%/sr_mingw"
58b03628 UH	76
	77	# Path where the cross-compiled MXE tools and libraries are located.
	78	# Change this to where-ever you installed MXE (and the files it built).
e71b3ff7	79	!define MXE "$%HOME%/mxe-git/usr/i686-pc-mingw32"
58b03628 UH	80
	81
	82	# --- MUI pages ---------------------------------------------------------------
	83
	84	# Show a nice "Welcome to the ... Setup Wizard" page.
	85	!insertmacro MUI_PAGE_WELCOME
	86
	87	# Show the license of the project.
	88	!insertmacro MUI_PAGE_LICENSE "../COPYING"
	89
	90	# Show a screen which allows the user to select which components to install.
	91	!insertmacro MUI_PAGE_COMPONENTS
	92
	93	# Allow the user to select a different install directory.
	94	!insertmacro MUI_PAGE_DIRECTORY
	95
	96	# Perform the actual installation, i.e. install the files.
	97	!insertmacro MUI_PAGE_INSTFILES
	98
	99	# Show a final "We're done, click Finish to close this wizard" message.
	100	!insertmacro MUI_PAGE_FINISH
	101
	102	# Pages used for the uninstaller.
	103	!insertmacro MUI_UNPAGE_WELCOME
	104	!insertmacro MUI_UNPAGE_CONFIRM
	105	!insertmacro MUI_UNPAGE_INSTFILES
	106	!insertmacro MUI_UNPAGE_FINISH
	107
	108
	109	# --- MUI language files ------------------------------------------------------
	110
	111	# Select an installer language (required!).
	112	!insertmacro MUI_LANGUAGE "English"
	113
	114
	115	# --- Default section ---------------------------------------------------------
	116
	117	Section "@PACKAGE_NAME@ (required)" Section1
	118
	119	# This section is gray (can't be disabled) in the component list.
	120	SectionIn RO
	121
	122	# Install the file(s) specified below into the specified directory.
	123	SetOutPath "$INSTDIR"
	124
01833aec	125	# License file.
58b03628 UH	126	File "../COPYING"
58b03628 UH	127
0b34fecd	128	# sigrok-cli.exe.
58b03628 UH	129	File "${CROSS}/bin/@PACKAGE_NAME@.exe"
58b03628 UH	130
cc76d423 UH	131	# libusb0.dll (needed for libusb-0.1).
	132	File "${CROSS}/libusb0.dll"
	133
7d8068f8 UH	134	# Zadig (used for installing libusb-win32 and WinUSB drivers).
	135	File "${CROSS}/zadig.exe"
	136	File "${CROSS}/zadig_xp.exe"
	137
0b34fecd UH	138	# Python
	139	File "${CROSS}/python32.dll"
	140	File "${CROSS}/python32.zip"
	141
01833aec	142	# Protocol decoders.
72db8c56	143	SetOutPath "$INSTDIR\decoders"
58b03628 UH	144	File /r /x "__pycache__" "${CROSS}/share/libsigrokdecode/decoders/*"
58b03628 UH	145
01833aec	146	# Firmware files.
72db8c56	147	SetOutPath "$INSTDIR\firmware"
01833aec UH	148	File /r "${CROSS}/share/sigrok-firmware/*"
01833aec UH	149
72db8c56 UH	150	# Example *.sr files.
	151	SetOutPath "$INSTDIR\examples"
	152	File /r "${CROSS}/share/sigrok-dumps/*"
	153
58b03628 UH	154	# Generate the uninstaller executable.
	155	WriteUninstaller "$INSTDIR\Uninstall.exe"
	156
	157	# Create a sub-directory in the start menu.
	158	CreateDirectory "$SMPROGRAMS\sigrok"
	159	CreateDirectory "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
	160
	161	# Create a shortcut for sigrok-cli (this merely opens a "DOS box").
	162	# Set the working directory (where the user will be placed into when
1afa97c5 UH	163	# the DOS box starts) to the installation directory.
1afa97c5 UH	164	SetOutPath "$INSTDIR"
58b03628 UH	165	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk" \
	166	"$SYSDIR\cmd.exe" \
	167	"/K echo For instructions run @PACKAGE_NAME@ --help." \
	168	"$SYSDIR\cmd.exe" 0 \
	169	SW_SHOWNORMAL "" "Run @PACKAGE_NAME@"
	170
	171	# Create a shortcut for the uninstaller.
	172	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall.lnk" \
	173	"$INSTDIR\Uninstall.exe" "" "$INSTDIR\Uninstall.exe" 0 \
	174	SW_SHOWNORMAL "" "Uninstall @PACKAGE_NAME@"
	175
	176	# Create registry keys for "Add/remove programs" in the control panel.
	177	WriteRegStr HKLM "${REGSTR}" "DisplayName" "@PACKAGE_STRING@"
	178	WriteRegStr HKLM "${REGSTR}" "UninstallString" \
	179	"$\"$INSTDIR\Uninstall.exe$\""
	180	WriteRegStr HKLM "${REGSTR}" "InstallLocation" "$\"$INSTDIR$\""
	181	WriteRegStr HKLM "${REGSTR}" "DisplayIcon" \
	182	"$\"$INSTDIR\sigrok-logo-notext.ico$\""
	183	WriteRegStr HKLM "${REGSTR}" "Publisher" "sigrok"
	184	WriteRegStr HKLM "${REGSTR}" "HelpLink" \
	185	"http://sigrok.org/wiki/Sigrok-cli"
	186	WriteRegStr HKLM "${REGSTR}" "URLUpdateInfo" \
	187	"http://sigrok.org/wiki/Downloads"
	188	WriteRegStr HKLM "${REGSTR}" "URLInfoAbout" "http://sigrok.org"
	189	WriteRegStr HKLM "${REGSTR}" "DisplayVersion" "@PACKAGE_VERSION@"
	190	WriteRegStr HKLM "${REGSTR}" "Contact" \
	191	"sigrok-devel@lists.sourceforge.org"
	192	WriteRegStr HKLM "${REGSTR}" "Comments" \
	193	"This is the sigrok command-line application."
	194
	195	# Display "Remove" instead of "Modify/Remove" in the control panel.
	196	WriteRegDWORD HKLM "${REGSTR}" "NoModify" 1
	197	WriteRegDWORD HKLM "${REGSTR}" "NoRepair" 1
	198
	199	# TODO: Add sigrok-cli directory to the PATH env. variable.
	200
	201	SectionEnd
	202
	203
58b03628 UH	204	# --- Uninstaller section -----------------------------------------------------
	205
	206	Section "Uninstall"
	207
	208	# Always delete the uninstaller first (yes, this really works).
	209	Delete "$INSTDIR\Uninstall.exe"
	210
	211	# Delete the application, the application data, and related libs.
	212	Delete "$INSTDIR\COPYING"
	213	Delete "$INSTDIR\@PACKAGE_NAME@.exe"
cc76d423	214	Delete "$INSTDIR\libusb0.dll"
7d8068f8 UH	215	Delete "$INSTDIR\zadig.exe"
7d8068f8 UH	216	Delete "$INSTDIR\zadig_xp.exe"
0b34fecd UH	217	Delete "$INSTDIR\python32.dll"
0b34fecd UH	218	Delete "$INSTDIR\python32.zip"
58b03628 UH	219
	220	# Delete all decoders and everything else in decoders/.
	221	# There could be *.pyc files or __pycache__ subdirs and so on.
	222	RMDir /r "$INSTDIR\decoders\*"
	223
01833aec	224	# Delete the firmware files.
c7f154fc	225	RMDir /r "$INSTDIR\firmware\*"
01833aec	226
72db8c56 UH	227	# Delete the example *.sr files.
	228	RMDir /r "$INSTDIR\examples\*"
	229
58b03628 UH	230	# Delete the install directory and its sub-directories.
58b03628 UH	231	RMDir "$INSTDIR\decoders"
01833aec	232	RMDir "$INSTDIR\firmware"
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"
	239
	240	# Delete the sub-directory in the start menu.
	241	RMDir "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
	242	RMDir "$SMPROGRAMS\sigrok"
	243
	244	# Delete the registry key(s).
	245	DeleteRegKey HKLM "${REGSTR}"
	246
	247	SectionEnd
	248
	249
	250	# --- Component selection section descriptions --------------------------------
	251
72db8c56	252	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	253
	254	!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
	255	!insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
58b03628 UH	256	!insertmacro MUI_FUNCTION_DESCRIPTION_END
58b03628 UH	257