Am einfachsten lassen sich neue Strukturen mit der Funktion „Neue Erweiterungen“ herunterladen in Okteta installieren. Dazu öffnen Sie den Einrichtungsdialog des Strukturwerkzeugs. Gehen Sie zur Seite Strukturen-Verwaltung und drücken den Knopf Neue Strukturen holen. Im Dialog, der dann geöffnet wird, können Strukturen installiert und deinstalliert werden.

Das Werkzeug Strukturen sucht die Definitionen der Strukturen im Unterordner okteta/structures/ im Datenordner für Programme im Persönlichen Ordner des Benutzers. Diesen Ordner finden Sie mit der Eingabe von qtpaths --paths GenericDataLocation auf der Konsole. Wenn noch keine Strukturdefinitionen installiert wurden, muss dieser Ordner angelegt werden.

Für jede Strukturdefinition gibt es zwei Dateien: Eine Datei mit der tatsächlichen Definition und eine .desktop-Datei mit den Metadaten (Autor, Version usw.).

In diesem Ordner gibt es für jede Strukturdefinition einen eigenen Unterordner, der sowohl die .desktop-Datei und auch die .osd-Datei oder die main.js-Datei mit der Strukturdefinition.

Ist zum Beispiel der Datenordner der Programme qtpaths --paths GenericDataLocation, dann finden Sie eine Strukturdefinition namens BeispielStruktur im Unterordner okteta/structures/BeispielStruktur, darin dann die Dateien BeispielStruktur.desktop und BeispielStruktur.osd.

Wenn Sie eine neue Strukturdefinition installiert haben, müssen Sie Okteta neu starten, um sie benutzen zu können. Nach den Neustart von Okteta den Einrichtungsdialog der Strukturen öffnen. Wählen Sie dort die Seite Strukturen-Verwaltung und überprüfen Sie, ob die neue Strukturdefinition ausgewählt ist. Wechseln Sie dann zur Seite Strukturen und überprüfen Sie, ob das gewünschte Element in der rechten Liste enthalten ist.

Die Metadatendatei hat diesen Inhalt:

        [Desktop Entry]
        Icon=arrow-up❶
        Type=Service
        ServiceTypes=KPluginInfo

        Name=Simple test structure
        Comment=A very simple test structure containing only two items

        X-KDE-PluginInfo-Author=Alex Richardson
        X-KDE-PluginInfo-Email=foo.bar@email.org
        X-KDE-PluginInfo-Name=simplestruct
        X-KDE-PluginInfo-Version=1.0
        X-KDE-PluginInfo-Website=https://www.plugin.org/
        X-KDE-PluginInfo-Category=structure
        X-KDE-PluginInfo-License=LGPL
        X-KDE-PluginInfo-EnabledByDefault=false
        

Die Bedeutung der Felder erschließt sich leicht aus Ihrem Namen, ausgenommen für das Feld X-KDE-PluginInfo-Name. Der Wert dieses Felds muss mit dem Namen des Ordners, in dem diese Datei enthalten ist, und auch dem Namen der.desktop-Datei übereinstimmen. Bei XML-Strukturdefinitionen muss der Wert dieses Feldes außerdem den gleichen Namen wie die .osd-Datei haben.

In diesem Beispiel befindet sich die Datei simplestruct.desktop im Ordner simplestruct. Bei XML-Strukturdefinitionen enthält der Ordner auch noch eine Datei namens simplestruct.osd. Wird JavaScript verwendet, gibt es stattdessen die Datei main.js.

Zuerst wird die Definition einer einfachen Teststruktur erstellt, die nur ganzzahlige Datentypen wie ein „char“, einen vorzeichenbehafteten 32-bit Integerwert und ein Bitfeld enthält. In C/C++ wird das so geschrieben:

          struct simple {
            char aChar;
            int anInt;
            bool bitFlag :1;
            unsigned padding :7;
          };
          

Als erstes wird die .osd-Datei mit dem im vorherigen Abschnitt definierten Dateiformat geschrieben. Diese erhält den Namen simplestruct.osd:

          <?xml version="1.0" encoding="UTF-8"?>
          <data>
            <struct name="simple">
              <primitive name="aChar" type="Char"/>
              <primitive name="anInt" type="Int32"/>
              <bitfield name="bitFlag" type="bool" width="1"/>
              <bitfield name="padding" type="unsigned" width="7"/>
            </struct>
          </data>
          

Dies ist ähnlich wie die C/C++ Definition.

Erstellen Sie nun einen Ordner simplestruct im Strukturinstallationsordner wie im Abschnitt manuelle Installation beschrieben. Kopieren Sie diese beiden Dateien in diesen Ordner. Starten Sie Okteta neu und benutzen Sie die neue Struktur.

Um die oben gezeigte Struktur in JavaScript zu schreiben, erstellen Sie eine Daten namens main.js anstelle der Datei simplestruct.osd und ändern Sie X-KDE-PluginInfo-Category=structure zu X-KDE-PluginInfo-Category=structure/js. Die Datei sollten folgenden Inhalt haben:

        function init() {
          var structure = struct({
            aChar : char(),
            anInt : int32(),
            bitFlag : bitfield("bool", 1),
            padding : bitfield("unsigned", 7),
          })
          return structure;
        }
        

Die in Okteta angezeigte Struktur ist immer der Rückgabewert der Funktion init.

Die folgenden Funktionen können benutzt werden, um einen primitiven Typ zu erzeugen:

Die Funktion „bitfield“ benötigt zwei Parameter, als erstes einen String wie bool, signed oder unsigned. Der zweite Parameter ist ein Integer-Wert, der die Breite in Bits angibt.

Als nächstes wird eine komplexere Struktur definiert. Sie wird "complex" genannt und in der Datei complex.osd gespeichert. Diese Struktur enthält zwei Felder, eines mit fester Länge und ein anderes, dessen Länge erst zur Laufzeit bestimmt wird, außerdem noch eine verschachtelte Struktur und einen Verbund.

          <?xml version="1.0" encoding="UTF-8"?>
          <data>
            <struct name="complex">
              <primitive name="size" type="UInt8" />
              <union name="aUnion">
                <array name="fourBytes" length="4">
                  <primitive type="Int8" />
                </array>
              </union>
              <struct name="nested">
                <array name="string" length="size"> <!-- references the field size above -->
                  <primitive type="Char" />
                </array>
              </struct>
            </struct>
          </data>
          

Dies entspricht folgendem Pseudocode in C/C++

struct complex {
            uint8_t size;
            union aUnion {
              int8_t fourBytes[4];
            };
            struct nested {
              char string[size] //not valid C++, references value of the uint8 size
            };
          };
          

Als nächstes wird die Datei complex.desktop wie im vorher gezeigten Beispiel erstellt. Benutzen Sie für X-KDE-PluginInfo-Name den richtigen Namen und installieren Sie beide Dateien.

Einige Beispiele von Strukturdefinitionen finden Sie im Git-Archiv. Dort ist zum Beispiel der Vorspann für PNG- und ELF-Dateien enthalten. Ein XML-Schema, das die Struktur von .osd-Dateien beschreibt, finden Sie hier. Brauchen Sie weitere Informationen, kontaktieren Sie (arichardson.kde gmail.com).