Development/Tutorials/Services/Traders (de)

Development/Tutorials/Services/Traders

Zusammenfassung

Oft ist es notwendig bestimmte Typen von Diensten oder Dienste mit bestimmten Eigenschaften oder Zwecken zu finden. KDE bietet eine einfacher und dennoch mächtige Anfragesprache um diesen Zweck zu erfüllen. Das ist die KTrader Query Sprache.

Die zwei Arten von "Tradern"

Warning

This section needs improvements: Please help us to

cleanup confusing sections and fix sections which contain a todo

Einen Satz in diesem Kapitel konnte ich leider nicht übersetzen.

KDE bietet zwei Klassen an die sich als "Trader" (Händler, sie handeln quasi mit Diensten. Im weiteren Verlauf nennen wir sie aber Trader) verhalten können. Ein Trader nimmt eine Anfrage entgeben und gibt eine Liste von Diensten zurück, die auf den Anforderungen dieser Anfrage genügen. Es gibt einen TRader für Plugins und weitere Add-ons: KServiceTypeTrader. Daneben gibt es noch einen weiteren Trader für MimeTypes KMimetypeTrader. Beide sind sich recht ähnlich: Sie benutzen die gleiche Syntax für Anfragen, offer a singleton pattern accessor, liefern KService::Ptrs als Ergebnis und weitere Gemeinsamkeiten. Während sich diese Anleitung primär auf KServiceTypeTrader konzentriert, ist vieles von dem Inhalt auch auf die MimeType Traders anwendbar.

Dienst Typen

KServiceTypeTrader is used to locate individual components such as application plugins, screensavers, and control panels that are registered with the system. The primary concept used here, is that of the "service type". Each set of services has a unique service type, which makes it very easy to locate the sort of component needed.

This means that, each kind of application plugin is uniquely namespaced within the set of all services. So, it is trivial to locate plugins for a given application, without having to worry about getting another application's plugin in the list.

Examples of service types include:

KParts/ReadWritePart
KTextEditor/Document
ScreenSaver
TerminalEmulator
UserAgentStrings
ThumbCreator
KDevelop/Plugin

There is no limit to the number of service types that a given application may use or register. Of course, service types are not limited to plugins and may be used for any sort of data component.

Creating new service types is covered in the next tutorial of this series: Creating and Loading Plugins Using KService

Benutzung von KServiceTypeTrader

Auf den "service trader" wird immer über self() zugegriffen. Mit der Klasse KServiceTypeTrader können wir dann einen von drei Schritten ausführen:

query:Anfrage einer Liste von Diensten die bestimmten (wenn überhaupt) Kriterien genügen, die der Benutzer vorgibt.
defaultOffers: Fragt alle Dienste unsortiert ab.
preferredService: Ermittelt den bevorzugten Dienst für einen bestimmten Typ.

Der Code dazu ist relativ einfach: KService::List services; KServiceTypeTrader* trader = KServiceTypeTrader::self();

services = trader->query("KParts/ReadWritePart"); foreach (KService::Ptr service, services) {

   kDebug() << "read write part" << service->name();

}
services = trader->defaultOffers("ThumbCreator");
if (services.isEmpty()) {

   kDebug() << "no services found for ThumbCreator!";

}
KService::Ptr service = trader->preferredService("KDevelop/Plugin");
if (!service) {

   kDebug() << "no preferred service found for KDevelop/Plugin";

}

In jedem Fall wird ein oder mehrere Dienste zurückgegeben, mit dem oden denen man verschiedene Operationen wie lokalisieren, beschreiben und laden durchführen kann.

Die KTrader Query Sprache

Die obigen Beispiele sind recht simpel und für die Anforderung vieler Applikationen nicht detailiert genug. Zum Beispiel könnten wir nur eine Liste von Plugins für eine bestimmte Kategorie benötigen, die mit einem bestimmten Mimetype assoziiert ist oder einen bestimmten Namen haben. Hier kommt die Anfragesprache ins Spiel.

Die Anfragesprache selber ist so entworfen worden, dass sie für Menschen lesbar ist und gleichzeitig flexibel. KServiceTypeTrader::query nimmt wahlweise zusätzlich zum Diensttyp eine Anfrage entgegen und benutzt diese, um ein detailiertes Ergebnis zurückzugeben. So können wir das vorige Beispiel so abändern:

KService::List services ; KServiceTypeTrader* trader = KServiceTypeTrader::self();

QString constraint = "'text/plain' in MimeTypes and "

                    "('KOfficePart' in ServiceTypes or "
                    " 'oasis' ~ [X-KDE-ExtraNativeMimeTypes])";

services = trader->query("KParts/ReadWritePart", constraint);
foreach (KService::Ptr service, services) {

   kDebug() << "read write part" << service->name();

}

Dieser Codeschnipsel sucht nach einem KPart welches sowohl einfache Textdateien lesen und schreiben kann und gleichzeitig eine KOffice-Komponente ist oder einfach ODF Dokumente lesen kann.

Fehler in Anfragen werden über die Debug-Ausgabe in der Konsole zur Laufzeit angezeigt.

Reihenfolge der Operatoren

Die Anfragezeichenkette wird von links nach rechts ausgewertet, ein Abschitt nach dem anderen. Abschnitte werden durch boolsche Operatoren (siehe unten) oder Klammern unterteilt.

Basistypen

Drei Basistypen werden von der KTrader Query Sprache unterstützt:

strings: Zeichenketten, die einfachen Anführungsstrichen (') umschlossen sein müssen
booleans: Boolsche Werte (TRUE oder FALSE)
signed integers: vorzeichenbehaftete Ganzzahlen
signed floating point numbers: vorzeichenbehaftete Gleitkommazahlen

Bezeichner

Bezeichner in einer Anfragezeichenkette werden auf Einträge abgebildet, welche in der zum Dienst gehörenden .desktop Datei stehen. So ist zum Beispiel "Name" der Name des Dienstes und "ServiceTypes" ist eine Liste von Dienstarten, die dieser Dienst unterstützt.

Bezeichner dürfen nur alphanumerische Zeichen und das '-' Zeichen enthalten. Bezeichner, die nicht mit einem alphabetischen Zeichen oder welches nicht alphanumerische Zeichen enthält muss in eckigen Klammern eingeschlossen werden, z.B. [X-KDE-Init].

Es gibt auch drei spezielle Bezeichner:

DesktopEntryName bezeichnet den Dateinamen der Dienst Desktop-Datei ohne dessen Erweiterung. Das kann nützlich sein, um bestimmte Dienste auszuschließen.
DesktopEntryPath bezeichnet den relativen oder vollen Pfad zur .desktop-Datei. Siehe auch KService::desktopEntryPath.
Library: ist ein Synonym für [X-KDE-Library] in der .desktop Datei.

Ob ein Bezeichner existiert oder nicht kann mit dem exist Operator abgefragt werden, z.B. "exist [X-KDE-Library]". Das kann insbesondere dann nützlich sein, wenn man prüft, ob der Wert eines Bezeichners mit einem Vorgabewert gesetzt ist. Wenn zum Beispiel MyProp eine Eigenschaft mit einem boolschen Typ ist, kann man "not exist MyProp or MyProp" schreiben, um den Vorgabewert "true" zu erhalten.

Vergleichsoperatoren

Die folgenden Vergleichoperatoren können benutzt werden, um Werte von allen unterstützten Daten miteinander zu vergleichen:

==: gleichheit
!=: ungleichheit
<: kleiner als
<=: kleiner oder gleich
>: größer als
>=: größer oder gleich

Mathematische Operatoren

Folgende mathematische Operatoren können auf Zahlentypen angewandt werden

+
-
*
/

Boolsche Operatoren

Folgende boolsche Operatoren werden unterstützt:

and: logisches und
or: logisches oder
not: logisches nicht

Operatoren für Zeichenketten

Die Operatoren, die auf Gleichheit von Zeichenketten prüfen, geben einen boolschen Wert zurück, der anzeigt, ob erfolgreich oder nicht.

Zeichenkettenvergleiche werden mit folgenden Operatoren erledigt:

==: Gleichheit, Groß- und Kleinschreibung wird beachtet
=~: Gleichheit, Groß- und Kleinschreibung wird nicht beachtet
!=: Ungleichheit, Groß- und Kleinschreibung wird beachtet
!~: Ungleichheit, Groß- und Kleinschreibung wird nicht beachtet

Teilzeichenketten können in Zeichenketten durch folgende Operatoren gesucht werden:

~: enthält, z.B. "'Bar' ~ 'FooBarBaz'" ist wahr
~~: enthält und Groß und Kleinschreibung wird ignoriert, z.B. "'Bar' ~~ 'FoobarBaz'" ist wahr

Einige Eigenschaftem wie MimeTypes oder ServiceTypes sind Listen von Zeichenketten. Diese Listen können mit den folgenden zwei Operatoren durchsucht werden:

in: Die Liste enthält die Zeichenkette, z.B. "'MyApp/Plugin' in ServiceTypes'"
~in: Die Liste enthält die Zeichenkette und Groß- und Kleinschreibung wird ignoriert.