Skip to content

Latest commit

 

History

History
280 lines (164 loc) · 7.38 KB

README.rst

File metadata and controls

280 lines (164 loc) · 7.38 KB
Raw

Libraries

Um die AusweisApp2 zu bauen ist eine Toolchain erforderlich, die die Abhängigkeiten und die Compilertools beinhaltet.

Unterstützte C++17 Compiler:

  • MinGW / GCC >= 7.3
  • Clang >= 5.0
  • MSVC >= 2017

Notwendige Bibliotheken:

Notwendige Tools:

Build

Die Abhängigkeiten lassen sich mittels der CMakeLists.txt in diesem Ordner automatisch aufbauen. Das Skript kann die abhängigen Bibliotheken als Quellcode selbständig herunterladen, entpacken und bauen.

Lokale Pakete können mittels -DPACKAGES_DIR=C:/packages verwendet werden. Wichtig: Bei PACKAGES_DIR muss ein absoluter Pfad angegeben werden!

Der Build umfasst unter anderem das Qt-Framework, daher kann (je nach Rechenleistung) der Build einige Stunden dauern.

Wichtig bei der Angabe in CMake ist der Verweis auf den Ordner "libs". Ein Verweis direkt auf "AusweisApp2" würde den Build für die "AusweisApp2" konfigurieren.

Nach dem Aufruf "make" bzw. "mingw32-make" werden nun alle Bibliotheken gebaut und in dem Ordner ./dist installiert. Dieser Ordner kann beim Build von der AusweisApp2 mittels -DCMAKE_PREFIX_PATH als Toolchain angegeben werden. Zusätzlich kann mit dem make Target "compress" der Inhalt der dist-Ordner bereinigt und ein Tarball aus den gebauten Bibliotheken erzeugt werden.

Proxy

Sofern beim Download der Pakete ein Proxy notwendig ist, müssen vorm Aufruf von "make" folgende Umgebungsvariablen gesetzt werden. (Ein erneutes Ausführen von CMake ist nicht notwendig.)

http_proxy=host:port
https_proxy=host:port
ftp_proxy=host:port

macOS

Unter MacOS ist die Einrichtung relativ einfach und bedarf nur der oben genannten Voreinstellungen. Es wird der von Apple ausgelieferte clang compiler verwendet.

Beispiel: Innerhalb von /Users/governikus/AusweisApp2 befindet sich der Quellcode.

$ cd /Users/governikus
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=release -DPACKAGES_DIR=/Users/governikus/packages ../AusweisApp2/libs
$ make

Windows MinGW

Unter Windows ist es derzeit empfohlen einen Teil der Toolchain mittels MSYS2 zu bauen. Perl muss dafür in MSYS2 nachinstalliert werden. Außerdem ist das Windows SDK notwendig.

MinGW

MSYS2

Windows SDK

Python

Vorbereitung

  1. Download und Entpacken des MinGW Paketes.
  2. Eintragen des Ordners "bin" von der MinGW-Installation in %PATH%.
  3. Entpacken von MSYS2.
  4. Start von "msys2_shell.cmd -use-full-path".
  5. System aktualisieren mittels "pacman -Syu" (danach MSYS2 neustarten).
  6. Perl nachinstallieren mittels "pacman -S perl".
  7. Installation des Windows SDK und setzen einer Systemvariable:
Für das Windows SDK 10.0.15063.0 und neuer:
    WindowsSdkVerBinPath = C:\Program Files (x86)\Windows Kits\10\bin\%VERSION%
Für alle älteren Versionen:
    WindowsSdkDir = C:\Program Files (x86)\Windows Kits\10

Durch einige Probleme mit Unix-Shell-Skripten ist es derzeit leider notwendig die Toolchain in zwei Schritten zu bauen. Hierzu muss OpenSSL und Qt separat gebaut werden.

  1. Download und Start der Installation von Python.
  2. Sicherstellen, dass die python.exe während der Installation zum PATH hinzugefügt wird.

Eventuell muss für MinGW folgende Option gesetzt werden (QTBUG-16443):

  1. Windows --> gpedit.msc --> Enter (als Administrator)
  2. Richtlinien für Lokaler Computer
  3. Computerkonfiguration
  4. Administrative Vorlagen
  5. System
  6. Dateisystem
  7. Lange Win32-Pfade aktivieren

openssl / Qt

Da Qt mittels Batchskript gebaut werden muss, ist es leider nicht möglich dies innerhalb von MSYS2 zu bauen [2]. Daher wird OpenSSL und Qt mittels Windows-CLI konfiguriert. Dabei wird Qt über Windows-CLI und OpenSSL unter MSYS2 gebaut.

  1. cmd.exe von Windows starten
  2. mkdir c:msys64homeuserqt ("user" ist der Benutzer, der unter MSYS2 verwendet wird)
  3. cd c:msys64homeuserqt
  4. cmake -DCMAKE_BUILD_TYPE=release -DPACKAGES_DIR=C:/packages C:/AusweisApp2/libs -G "MinGW Makefiles"
  5. MSYS2 Shell starten ("msys2_shell.cmd -use-full-path")
  6. cd qt
  7. mingw32-make openssl
  8. MSYS2 Shell verlassen
  9. In der cmd.exe: c:msys64homeuserqt
  10. mingw32-make qt

[2] https://sourceforge.net/p/mingw/bugs/1902/

iOS

Die Toolchain für iOS kann nur auf MacOS gebaut werden. Dabei müssen XCode und die Command Line Tools (siehe "xcode-select -p" bzw. "xcode-select --install") auf dem Mac vorhanden sein. Die folgende Anleitung wurde unter macOS 10.12 getestet.

Ebenfalls muss für den Build-Vorgang von Qt ein iOS Developer-Zertifikat mit Wildcard (*) im Keystore von MacOS hinterlegt sein.

Beispiel: Innerhalb von /Users/governikus/AusweisApp2 befindet sich der Quellcode.

$ cd /Users/governikus
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=release -DPACKAGES_DIR=/Users/governikus/packages -DCMAKE_TOOLCHAIN_FILE=../AusweisApp2/cmake/iOS.toolchain.cmake ../AusweisApp2/libs
$ make

Android

Die Toolchain für Android wird derzeit nur unter Linux unterstützt. Dabei müssen folgende Komponenten vorhanden sein:

Beispiel: Innerhalb von /home/governikus/AusweisApp2 befindet sich der Quellcode.

$ cd /home/governikus
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=release -DPACKAGES_DIR=/home/governikus/packages -DCMAKE_TOOLCHAIN_FILE=../AusweisApp2/cmake/android.toolchain.cmake ../AusweisApp2/libs
$ make

Standardmäßig wird die Architektur "armeabi-v7a" gewählt. Um zum Beispiel die Toolchain für x86-Architektur zu bauen, ist beim Aufruf von CMake der Parameter "-DCMAKE_ANDROID_ARCH_ABI=x86" mitzugeben.