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

# File name of the Python installer MSI file.
!define PY_INST "python-3.2.3.msi"

# Standard install path of the Python installer (do not change!).
!define PY_BIN "c:\Python32"

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

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

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

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

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

	# 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


# --- Python installer section ------------------------------------------------

Section "Python" Section2

	# Copy the Python installer MSI file into the temporary directory.
	SetOutPath "$TEMP"
	File "${CROSS}/${PY_INST}"

	# Run the Python installer MSI file from within our installer.
	ExecWait '"msiexec" /i "$TEMP\${PY_INST}" /QB- /passive ALLUSERS=1'

	# Remove Python installer MSI file again.
	Delete "$TEMP\${PY_INST}"

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 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 install directory and its sub-directories.
	RMDir "$INSTDIR\decoders"
	RMDir "$INSTDIR\firmware"
	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, and all required libraries."
LangString DESC_Section2 ${LANG_ENGLISH} "This installs Python 3.2 in its default location of c:\Python32. If you already have Python 3.2 installed, you don't need to re-install it."

!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
!insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
!insertmacro MUI_DESCRIPTION_TEXT ${Section2} $(DESC_Section2)
!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
73	# File name of the Python installer MSI file.
74	!define PY_INST "python-3.2.3.msi"
75
76	# Standard install path of the Python installer (do not change!).
77	!define PY_BIN "c:\Python32"
78
79	# Path where the cross-compiled sigrok tools and libraries are located.
80	# Change this to where-ever you installed libsigrok.a and so on.
e71b3ff7	81	!define CROSS "$%HOME%/sr_mingw"
58b03628 UH	82
	83	# Path where the cross-compiled MXE tools and libraries are located.
	84	# Change this to where-ever you installed MXE (and the files it built).
e71b3ff7	85	!define MXE "$%HOME%/mxe-git/usr/i686-pc-mingw32"
58b03628 UH	86
	87
	88	# --- MUI pages ---------------------------------------------------------------
	89
	90	# Show a nice "Welcome to the ... Setup Wizard" page.
	91	!insertmacro MUI_PAGE_WELCOME
	92
	93	# Show the license of the project.
	94	!insertmacro MUI_PAGE_LICENSE "../COPYING"
	95
	96	# Show a screen which allows the user to select which components to install.
	97	!insertmacro MUI_PAGE_COMPONENTS
	98
	99	# Allow the user to select a different install directory.
	100	!insertmacro MUI_PAGE_DIRECTORY
	101
	102	# Perform the actual installation, i.e. install the files.
	103	!insertmacro MUI_PAGE_INSTFILES
	104
	105	# Show a final "We're done, click Finish to close this wizard" message.
	106	!insertmacro MUI_PAGE_FINISH
	107
	108	# Pages used for the uninstaller.
	109	!insertmacro MUI_UNPAGE_WELCOME
	110	!insertmacro MUI_UNPAGE_CONFIRM
	111	!insertmacro MUI_UNPAGE_INSTFILES
	112	!insertmacro MUI_UNPAGE_FINISH
	113
	114
	115	# --- MUI language files ------------------------------------------------------
	116
	117	# Select an installer language (required!).
	118	!insertmacro MUI_LANGUAGE "English"
	119
	120
	121	# --- Default section ---------------------------------------------------------
	122
	123	Section "@PACKAGE_NAME@ (required)" Section1
	124
	125	# This section is gray (can't be disabled) in the component list.
	126	SectionIn RO
	127
	128	# Install the file(s) specified below into the specified directory.
	129	SetOutPath "$INSTDIR"
	130
01833aec	131	# License file.
58b03628 UH	132	File "../COPYING"
58b03628 UH	133
01833aec	134	# sigrok-cli.
58b03628 UH	135	File "${CROSS}/bin/@PACKAGE_NAME@.exe"
58b03628 UH	136
cc76d423 UH	137	# libusb0.dll (needed for libusb-0.1).
	138	File "${CROSS}/libusb0.dll"
	139
7d8068f8 UH	140	# Zadig (used for installing libusb-win32 and WinUSB drivers).
	141	File "${CROSS}/zadig.exe"
	142	File "${CROSS}/zadig_xp.exe"
	143
58b03628 UH	144	# Install the file(s) specified below into the specified directory.
	145	SetOutPath "$INSTDIR\decoders"
	146
01833aec	147	# Protocol decoders.
58b03628 UH	148	File /r /x "__pycache__" "${CROSS}/share/libsigrokdecode/decoders/*"
58b03628 UH	149
01833aec UH	150	# Install the file(s) specified below into the specified directory.
	151	SetOutPath "$INSTDIR\firmware"
	152
	153	# Firmware files.
	154	File /r "${CROSS}/share/sigrok-firmware/*"
	155
58b03628 UH	156	# Generate the uninstaller executable.
	157	WriteUninstaller "$INSTDIR\Uninstall.exe"
	158
	159	# Create a sub-directory in the start menu.
	160	CreateDirectory "$SMPROGRAMS\sigrok"
	161	CreateDirectory "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
	162
	163	# Create a shortcut for sigrok-cli (this merely opens a "DOS box").
	164	# Set the working directory (where the user will be placed into when
1afa97c5 UH	165	# the DOS box starts) to the installation directory.
1afa97c5 UH	166	SetOutPath "$INSTDIR"
58b03628 UH	167	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk" \
	168	"$SYSDIR\cmd.exe" \
	169	"/K echo For instructions run @PACKAGE_NAME@ --help." \
	170	"$SYSDIR\cmd.exe" 0 \
	171	SW_SHOWNORMAL "" "Run @PACKAGE_NAME@"
	172
	173	# Create a shortcut for the uninstaller.
	174	CreateShortCut "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall.lnk" \
	175	"$INSTDIR\Uninstall.exe" "" "$INSTDIR\Uninstall.exe" 0 \
	176	SW_SHOWNORMAL "" "Uninstall @PACKAGE_NAME@"
	177
	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"
	191	WriteRegStr HKLM "${REGSTR}" "DisplayVersion" "@PACKAGE_VERSION@"
	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
	206	# --- Python installer section ------------------------------------------------
	207
	208	Section "Python" Section2
	209
	210	# Copy the Python installer MSI file into the temporary directory.
	211	SetOutPath "$TEMP"
	212	File "${CROSS}/${PY_INST}"
	213
	214	# Run the Python installer MSI file from within our installer.
	215	ExecWait '"msiexec" /i "$TEMP\${PY_INST}" /QB- /passive ALLUSERS=1'
	216
	217	# Remove Python installer MSI file again.
	218	Delete "$TEMP\${PY_INST}"
	219
	220	SectionEnd
	221
	222
	223	# --- Uninstaller section -----------------------------------------------------
	224
	225	Section "Uninstall"
	226
	227	# Always delete the uninstaller first (yes, this really works).
	228	Delete "$INSTDIR\Uninstall.exe"
	229
	230	# Delete the application, the application data, and related libs.
231	Delete "$INSTDIR\COPYING"
232	Delete "$INSTDIR\@PACKAGE_NAME@.exe"
cc76d423	233	Delete "$INSTDIR\libusb0.dll"
7d8068f8 UH	234	Delete "$INSTDIR\zadig.exe"
7d8068f8 UH	235	Delete "$INSTDIR\zadig_xp.exe"
58b03628 UH	236
	237	# Delete all decoders and everything else in decoders/.
	238	# There could be *.pyc files or __pycache__ subdirs and so on.
	239	RMDir /r "$INSTDIR\decoders\*"
	240
01833aec	241	# Delete the firmware files.
c7f154fc	242	RMDir /r "$INSTDIR\firmware\*"
01833aec	243
58b03628 UH	244	# Delete the install directory and its sub-directories.
58b03628 UH	245	RMDir "$INSTDIR\decoders"
01833aec	246	RMDir "$INSTDIR\firmware"
58b03628 UH	247	RMDir "$INSTDIR"
	248
	249	# Delete the links from the start menu.
	250	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\sigrok command-line tool.lnk"
	251	Delete "$SMPROGRAMS\sigrok\@PACKAGE_NAME@\Uninstall.lnk"
	252
	253	# Delete the sub-directory in the start menu.
	254	RMDir "$SMPROGRAMS\sigrok\@PACKAGE_NAME@"
	255	RMDir "$SMPROGRAMS\sigrok"
	256
	257	# Delete the registry key(s).
	258	DeleteRegKey HKLM "${REGSTR}"
	259
	260	SectionEnd
	261
	262
	263	# --- Component selection section descriptions --------------------------------
	264
bb26e3fc	265	LangString DESC_Section1 ${LANG_ENGLISH} "This installs the sigrok command-line tool, some firmware files, the protocol decoders, and all required libraries."
58b03628 UH	266	LangString DESC_Section2 ${LANG_ENGLISH} "This installs Python 3.2 in its default location of c:\Python32. If you already have Python 3.2 installed, you don't need to re-install it."
	267
	268	!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
	269	!insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
	270	!insertmacro MUI_DESCRIPTION_TEXT ${Section2} $(DESC_Section2)
	271	!insertmacro MUI_FUNCTION_DESCRIPTION_END
	272