Development/Tutorials/KDE4 Porting Guide (de)

Anleitung zur Portierung nach KDE 4

Anleitungsserie	Grundlagen
Voriges Kapitel
Nächstes Kapitel	Einführung in CMake
Weiterführende Texte	"Moving from Qt 3 to Qt 4"
Navigation	Deutsche Startseite

Einführung

Diese Anleitung richtet sich an Entwickler, die ihre Qt3/KDE3 basierten Applikationen nach Qt4/KDE4 portieren wollen. Das muß nämlich kein komplizierter Prozess sein. Es gibt bereits viele Skripte und Dokumentationen, die dabei helfen.

Konventionen

Für die Anweisungen dieser Anleitung gelten folgende Konventionen:

• program bezeichnet ein ausführbares Programm
• path bezeichnet einen Pfad
• file bezeichnet eine Datei
• $SVN ist der vollständige Pfad zu Ihrem KDE subversion depot.

CMake

Anders als KDE3 werden KDE4 Applikationen mit der Hilfe von CMake erstellt. Der einfachste Weg die "autotools"-Dateien nach CMake zu portieren ist, das Script am2cmake zu benutzen, welches im Verzeichnis cmake/scripts des kdesdk Modules zu finden ist. Das erzeugt eine Reihe von CMakeLists.txt Dateien neben den alten autotools-Dateien.

Ist Ihr Code zum Beispiel unter /path/to/src gespeichert, dann:

 % cd /path/to/src
 % $SVN/trunk/KDE/kdesdk/cmake/scripts/am2cmake --kde4

Führen Sie am2cmake --help aus, um zu prüfen, ob Sie das --kde4 Flag benötigen.

Weiterhin gibt es ein Werkzeug, welches in den erzeugten CMakeList.txt Dateien nach möglichen Problemen sucht. Dieses Werkzeug heißt cmakelint.pl und ist unter $SVN/trunk/kde/kdesdk/scripts gespeichert. Benutzen Sie es folgendermaßen:

 % cd /path/to/src
 % $SVN/trunk/KDE/kdesdk/scripts/cmakelint.pl CMakeLists.txt

Oder wenden Sie es auf das gesamte Quellcodeverzeichnis an:

 % cd /path/to/src
 % find . -name CMakeLists.txt | \
   xargs $SVN/trunk/KDE/kdesdk/scripts/cmakelint.pl

Qt4 API

Ein Überblick über den Übergang von Qt3 nach Qt4 wird in der Anleitung "Moving from Qt 3 to Qt 4" von Trolltech gegeben. Dieses Dokument bietet einen sehr guter Überblick über die Änderungen in der Funktionalität, die Qt4 mit sich bringt, und ist daher sehr zu empfehlen.

Die nachfolgende Anleitung "Porting to Qt 4" gibt eine sehr detailierte Beschreibung des Portierungsprozesses, neben einer Liste von Änderungen in den Klassen und Funktionen.

Diese Dokumente beschreiben auch ein Werkzeug, das von Trolltech zur Verfügung gestellt wird und sich qt3to4 nennt. Dieses Programm kann dabei helfen, die Qt-Teile Ihres Codes von Qt3 nach Qt4 zu portieren, indem es spezielle Funktionen zur Kompatibilität benutzt. Rufen Sie qt3to4 folgendermaßen auf:

 % $SVN/trunk/qt-copy/bin/qt3to4 [options] <Infile>, [Infile], ...

Infile kann eine Quellcodedatei oder eine Projektdatei sein. Möchten Sie eine Projektdatei angeben (mit der Endung '.pro' oder '.pri'), wird qt3to4 alle Dateien portieren, die in dieser Datei angegeben sind.

Für mehr Informationen können Sie qt3to4 mit der "--help" Option aufrufen oder unter "qt3to4-The Qt 3 to 4 Porting Tool" nachschlagen.

Weiterhin gibt es ein Programm namens remove-qt3-support.pl im Modul kdesdk, welches nach vielen veralteten Qt3 Strukturen sucht und diese ersetzt. Rufen Sie einfach dieses Programm ohne weitere Optionen im Quellverzeichnis auf.

 % $SVN/trunk/KDE/kdesdk/scripts/qt4/remove-qt3-support.pl

Es kann passieren, daß einige Qt3-Klassen im Code verbleiben, daher sollten in der Datei CMakeLists.txt auf der höchsten Verzeichnisebene die Macros QT3_SUPPORT und QT3_SUPPORT_WARNINGS für die Qt-Header folgendermaßen definiert werden:

 add_definitions (-DQT3_SUPPORT -DQT3_SUPPORT_WARNINGS)

KDE4 API

Ein Großteil der Arbeit beim Portieren besteht einfach aus dem Umbenennen von Klassen und Header-Dateien. Da es ziemlich ermüdend ist, dies von Hand zu machen, gibt es ein nützliches Script im scripts/qt4 Verzeichnis des Modules kdesdk namens adapt-to-kde4-api.pl. Dieses durchsucht alle Ihre Dateien und erzeugt eine diff Ausgabe, die dann benutzt werden kann, um Ihren Code zu patchen.

Wenn diese einfache Codeersetzung erledigt ist, müssen Sie trotzdem noch Ihren zu portierenden Code nachbearbeiten, zum Beispiel wegen der neuen KAction API. Über alle API-Änderungen informiert Sie die Datei KDE4PORTING.html des Modules kdelibs.

Qt Designer UI-Dateien

Die ".ui"-Dateien, die vom Qt Designer unter Qt3 produziert wurden müssen in das neue Qt4-Format konvertiert werden. Dazu kann man das Programm uic3 benutze, welches in Ihrer Qt4-Installation zur Verfügung gestellt wird.

 % $SVN/trunk/qt-copy/bin/uic3 -convert file.ui > foo.ui
 % mv foo.ui file.ui

Oder, wenn Sie ein graphisches Werkzeug vorziehen, können Sie auch das Designer-Programm von Qt4 benutzen

 % $SVN/trunk/qt-copy/bin/designer file.ui
 (you can save file.ui over top itself, or save to a new file)

noframe

Beachten Sie, dass durch den Konvertierungsprozess einige selbstdefinierten Slots, Tabellen Spalten, etc verloren gehen können. Es kann also sein, dass Sie diese Dinge dann von Hand wiederherstellen müssen.

Warnung

Sie sollten auch das Programm fixuifiles aus dem Modul kdesdk ausführen, welches einige Säuberungen und Plausibilitätsprüfungen durchführt.

 % $SVN/trunk/KDE/kdesdk/scripts/fixuifiles

D-Bus

Statt DCOP, wie es in KDE3 benutzt wird, kommt in KDE4 nun D-Bus für die Kommunikation zwischen Prozessen (interprocess communication) zum Einsatz. Die Portierung von DCOP nach D-BUS ist ein großes Thema, welches im Detail in der Anleitung Porting to D-Bus (in englisch) beschrieben wird.

Für mehr Informationen sehen Sie bitte auch D-Bus tutorials.

Icons

KDE4 richtet sich nach dem Namensschema für Icons, welches unter freedesktop.org icon naming specification (englisch) spezifiziert wird. Das bedeutet, dass sowohl Icons die mit KDE4 (Oxygen) ausgeliefert werden, als auch Komponenten in kdelibs, die Icons benutzen diesem Schema folgen.

Um Ihre Applikation von den Iconnamen, die in KDE3 benutzt wurden, in diejenigen, die jetzt in KDE4 benutzt werden zu konvertieren, rufen Sie einfach das adapt-to-icon-spec.py Skript aus dem Wurzelverzeichnis Ihres Projekts auf und folgen Sie den Anweisungen auf dem Bildschirm.

Das Skript konvertiert automatisch alle Icons, die sicher eine überprüfbare Entsprechung haben (z.B. die Benutzung von KIcon oder KIconLoader), überspringt diejenigen die überprüfbar keine Entsprechung haben und fragt bei den fraglich positiven Fällen nach. Letzteres geschieht mit zusätzlichen Kontextinformationen (wenn das gewünscht ist) und so muß man nur 'y' oder 'n' drücken, um die möglichen Treffer zu bestätigen oder abzulehenen und den Portierungsvorgang abzuschließen.

Internationalization

Um Ihre ".pot" Datei zu erzeugen, kopieren Sie die Befehle aus der "messages"-Regel der Makefile.am Datei Ihres Projektes in ein Shell-Skript namens Messages.sh. Sie dürfen hier die gleichen Variablen ($PREPARETIPS, $XGETTEXT, $podir, etc.) als existent voraussetzen, doch beachten Sie, dass Makefiles und Shell-Skripten eine unterschiedliche Syntax haben.

Seien Sie auch vorsichtig, wenn Sie den "-k"-Parameter mit $XGETTTEXT benutzen. Dann müssen Sie explizit alle Varianten auflisten, die Sie benutzen.

So wird zum Beispiel aus der "messages"-Erzeugungsregel:

 messages: rc.cpp
        rm -f tips.cpp
        $(PREPARETIPS) > tips.cpp
        $(XGETTEXT) -ktranslate *.cpp *.h -o $(podir)/kmail.pot
        rm -f tips.cpp

folgendes Messages.sh Skript:

 #! /usr/bin/env bash
 $PREPARETIPS > tips.cpp
 $XGETTEXT -ktranslate:1,1t -ktranslate:1c,2,2t *.cpp *.h -o $podir/kmail.pot
 rm -f tips.cpp

Do's und Don'ts

• Benutzen Sie nicht die alten Socket-Klassen
• Benutzen Sie nicht QPtrList, und allgemein, setAutoDelete()
• Benutzen Sie keine Rasteroperationen.
• Kodieren Sie keine Darstellungsaufgaben außerhalb des paint events.
• Vermeiden Sie die Benutzung von QHBox, QVBox, QGrid. Bevorzugen Sie lieber Layouts.
• Spielen Sie nicht mit Rahmen von Groupboxes, Labels oder Lineedits um ein anderes Widget zu imitieren. Benutzen Sie lieber das passende Widget. Anstatt ein Label so zu ändern, dass es einen eingesunkenen Lineedit-Rand hat, lieber ein nur-lesen KLineEdit benutzen. Und statt KLineEdit ohne Rahmen für Widgets mit Kopierfunktion lieber KActiveLabel benutzen.
• Benutzen Sie keine Groupbox ohne Rahmen um Widgets zu gruppieren. Statt dessen einfach ein Layout benutzen.

Mehr Informationen

Dokumentation

• Qt4.3 Reference
• KDE4 API Reference
• CMake Cross Platform Make
• KDE4PORTING.html

Weitere Hilfe

• #kde4-devel on irc.freenode.net