2. Poradnik: Podstawy

2.3.1 Atrybuty instalatora

Atrybuty instalatora określają zachowanie i wygląd instalatora. Używając tych atrybutów możesz zmieniać teksty, które pokazywane będą podczas instalacji, liczbę typów instalacji itp. Większość z tych poleceń mogą być tylko ustawione i nie mogą być zmieniane podczas wykonania.

Innymi podstawowymi instrukcjami są Name oraz InstallDir.

Więcej informacji o atrybutach instalatora znajdziesz tutaj: Atrybuty instalatora.

2.3.2 Strony

Instalatory okienkowe są zbiorem stron kreatora, pozwalających użytkownikowi skonfigurować instalatora. Możesz zdecydować, które ze stron wyświetlić używając polecenia Page (lub PageEx w przypadku zaawansowanych ustawień). Typowy zbiór stron wygląda jak poniżej:

Page license
Page components
Page directory
Page instfiles
UninstPage uninstConfirm
UninstPage instfiles

W instalatorze, ten typowy zbiór stron wyświetli postanowienia licencji, wybór komponentów do zainstalowania, wybór katalogu docelowego instalacji oraz na końcu instalowanie wybranych komponentów na stronie instalacji plików. Dla deinstalatora, wyświetlona zostanie strona potwierdzająca deinstalację oraz strona postępu deinstalacji.

2.3.3 Sekcje

Instalatory zazwyczaj zawierają kilka komponentów, które użytkownik może zainstalować. Dla przykładu, w instalatorze dystrybucji NSIS możesz wybrać instalację dodatkowych narzędzi, wtyczek, przykładów i więcej. Każdy z tych komponentów odzwierciedlany jest przez część kodu. Jeśli użytkownik zaznaczy instalację tego komponentu, instalator wykona ten fragment kodu. W skrypcie, ten kod definiowany jest w sekcjach. Każda sekcja odpowiada jednemu komponentowi na stronie komponentów. Nazwy sekcji wyświetlane są jako nazwy wybranych komponentów, a kod sekcji zostanie wykonany tylko wtedy gdy dany komponent zostanie wybrany. Możliwym jest zbudowanie instalatora z tylko jedną sekcją, lecz jeśli chcesz wykorzystać stronę komponentów i dać możliwość wyboru użytkownikowi co chce zainstalować, będziesz musiał użyć więcej niż jednej sekcji.

Deinstalatory również mogą mieć wiele sekcji. Nazwy sekcji deinstalatora są poprzedzane przez 'un.'. Na przykład:

Section "Sekcja instalatora"
SectionEnd

Section "un.Sekcja deinstalatora"
SectionEnd

Instrukcje, które mogą być użyte w sekcjach różnią się od instrukcji atrybutów instalatora, wykonywane są one na komputerze użytkownika podczas wykonania. Instrukcje te mogą wyodrębniać pliki, czytać i zapisywać dane rejestru, plików INI lub normalnych plików, tworzyć katalogi, tworzyć skróty i wiele więcej. Więcej możesz dowiedzieć się tutaj: Instrukcje.

Najbardziej podstawowymi instrukcjami są instrukcja SetOutPath, która informuje instalator, gdzie ma wyodrębnić pliki oraz instrukcja File, która wyodrębnia pliki.

Przykład:

Section "Mój program"
  SetOutPath $INSTDIR
  File "Mój program.exe"
  File "CzytajMnie.txt"
SectionEnd

Więcej informacji o sekcjach znajdziesz tutaj: Sekcje.

2.3.4 Funkcje

Funkcje mogą zawierać kod skryptu, tak samo jak sekcje. Różnica pomiędzy sekcjami oraz funkcjami polega na sposobie ich wywoływania. Istnieją dwa rodzaje funkcji, funkcje użytkownika oraz funkcje zwrotne.

Funkcje użytkownika wywoływane są przez użytkownika z sekcji lub innych funkcji przy użyciu instrukcji Call. Funkcje użytkownika nie zostaną wykonane dopóki ich nie wywołasz. Po wykonaniu kodu funkcji instalator będzie kontynuował wykonywanie instrukcji znajdujących się po instrukcji Call, chyba że przerwiesz instalację wewnątrz funkcji. Funkcje użytkownika są bardzo użyteczne, jeśli masz wiele instrukcji, które muszą być wykonane w różnych miejscach instalatora. Jeśli wstawisz kod do funkcji oszczędzisz czas na kopiowaniu tego kodu oraz uczynisz go bardziej czytelnym.

Funkcje zwrotne są wywoływane przez instalator podczas zdefiniowanych zdarzeń instalatora, takich jak uruchomienie instalatora. Funkcje zwrotne są opcjonalne. Jeśli, na przykład, chcesz powitać użytkownika swojego instalatora możesz zdefiniować funkcję .onInit. Kompilator NSIS rozpozna tę funkcję jako funkcję zwrotną po nazwie i wywoła ją podczas uruchamiania instalatora.

Function .onInit
  MessageBox MB_YESNO "Ten program zainstaluje Mój program. Czy chcesz kontynuować?" IDYES gogogo
    Abort
  gogogo:
FunctionEnd

Funkcja Abort ma specjalne znaczenie w funkcjach zwrotnych. Każda funkcja zwrotna ma swoją własną interpretację tej funkcji, więcej informacji znajdziesz tutaj: Funkcje zwrotne. W powyższym przykładzie instrukcja Abort instruuje instalatora, by zatrzymał inicjalizację instalatora i zakończył natychmiast działanie.

Więcej informacji o funkcjach znajdziesz tutaj: Funkcje.

2.3.5 Praca ze skryptami

StrCmp $0 'jakaś wartość' 0 +3
  MessageBox MB_OK '$$0 jest jakąś wartością'
  Goto done
StrCmp $0 'jakaś inna wartość' 0 +3
  MessageBox MB_OK '$$0 jest jakąś inną wartością'
  Goto done
# else
  MessageBox MB_OK '$$0 jest "$0"'
done:

${If} $0 == 'jakaś wartość'
  MessageBox MB_OK '$$0 jest jakąś wartością'
${ElseIf} $0 == 'jakaś inna wartość'
  MessageBox MB_OK '$$0 jest jakąś inną wartością'
${Else}
  MessageBox MB_OK '$$0 jest "$0"'
${EndIf}

${Switch} $0
   ${Case} 'jakaś wartość'
      MessageBox MB_OK '$$0 jest jakąś wartością'
    ${Break}
   ${Case} 'jakaś inna wartość'
      MessageBox MB_OK '$$0 jest jakąś inną wartością'
    ${Break}
   ${Default}
      MessageBox MB_OK '$$0 jest "$0"'
    ${Break}
${EndSwitch}

${If} $0 == ''
${AndIf} $1 == ''
  MessageBox MB_OK|MB_ICONSTOP 'Obydwa są puste!'
${EndIf}

StrCpy $R1 0
${While} $R1 < 5
  IntOp $R1 $R1 + 1
  DetailPrint $R1
${EndWhile}

${For} $R1 1 5
  DetailPrint $R1
${Next}

StrCpy $R1 0
${Do}
  IntOp $R1 $R1 + 1
  DetailPrint $R1
${LoopUntil} $R1 >= 5

!include LogicLib.nsh

Var BLA ; Deklaracja zmiennej

Section bla

  StrCpy $BLA "123" ; Teraz możesz użyć zmiennej $BLA (do której przypisano wartość "123")

SectionEnd

Function bla

  Push $R0
  Push $R1

    ...kod...

  Pop $R1
  Pop $R0

FunctionEnd

2.3.6 Wykonywanie skryptu

Gdy użytkownik uruchomi instalatora lub deinstalatora, strony wyświetlane są w takiej kolejności w jakiej zostały zdefiniowane w skrypcie. Na stronie wyświetlającej postęp instalacji plików (instfiles), sekcje odpowiadające wybranym komponentom, są wykonywane w kolejności ich definicji w skrypcie. Jeśli strona z komponentami nie jest wyświetlana, wykonywane są wszystkie, także te, które nie zostały odznaczone lub w jakiś sposób wyłączone przez skrypt.

Poza kodem w sekcjach, istnieje jeszcze kod w funkcjach zwrotnych. Jeśli są zdefiniowane, mogą zostać wykonane przed kodem sekcji. Na przykład, funkcja zwrotna .onInit jest wykonywana przed wszystkim innym w kodzie skryptu. Istnieją również funkcje wywołań zwrotnych stron, które są wykonywane w określonych momentach procesu wyświetlania strony.

2.3.7 Polecenia kompilatora

Polecenia kompilatora wykonywane są w czasie kompilacji na Twoim komputerze. Mogą one być używane do kompilacji warunkowej, do załączania plików nagłówkowych, do uruchamiania aplikacji, do zmiany katalogu roboczego i innych. Najbardziej powszechnym jest używanie definicji. Definicje są stałymi w czasie kompilacji. Możesz zdefiniować numer wersji swojego produktu i użyć go w skrypcie. Na przykład:

!define VERSION "1.0.3"
Name "Mój Program ${VERSION}"
OutFile "Instalator Mojego programu - ${VERSION}.exe"

Więcej informacji o definicjach znajdziesz tutaj: Kompilacja warunkowa.

Innym powszechnym sposobem użycia są makra. Makra używane są do wstawiania kodu w czasie kompilacji, w zależności od definicji oraz wartości tych definicji. Polecenia makr wstawiane są w czasie kompilacji. Pozwala to na zapisanie kodu ogólnego tyko raz i użycie go wiele razy, ale z pewnymi zmianami. Na przykład:

!macro MojaFunkcja UN
Function ${UN}MojaFunkcja
  Call ${UN}DoRegStuff
  ReadRegStr $0 HKLM 'Software\Mój Program' Klucz
  DetailPrint $0
FunctionEnd
!macroend

!insertmacro MojaFunkcja ""
!insertmacro MojaFunkcja "un."

Makro to pomaga uniknąć sytuacji pisania tego samego kodu zarówno dla instalatora jak i deinstalatora. Dwa polecenia !insertmacro wstawiają dwie funkcje, jedną dla instalatora, o nazwie MojaFunkcja oraz drugą dla deinstalatora, o nazwie un.MojaFunkcja. Obie robią dokładnie to samo.

Więcej informacji znajdziesz tutaj: Polecenia przy kompilacji.