Найпростішим способом встановлення нових визначень структур є використання вбудованої підтримки KNewStuff у Okteta. Щоб встановити існуючу структуру, відкрийте діалогове вікно інструменту «Структури». Перейдіть на вкладку Керування структурами і натисніть кнопку Отримати нові структури.... За допомогою діалогового вікна, яке буде відкрито, ви зможете встановити або вилучити встановлені визначення структур.

Інструмент «Структури» шукає описи структур у підкаталозі okteta/structures/ каталогу даних програм користувача (визначити адресу цього каталогу можна за допомогою команди qtpaths --paths GenericDataLocation). Якщо ще не встановлено жодного визначення структури, можливо, вам доведеться створити відповідний підкаталог.

Дані кожного визначення структури має бути розподілено між двома файлами: один з файлів міститиме дані самого визначення, а інший файл, .desktop, зберігатиме метадані (дані щодо автора, версії тощо).

У цьому каталозі має бути підкаталог для кожного з визначень структури, у якому мають зберігатися обидва файла визначення: файл .desktop і файл .osd або main.js.

Наприклад, якщо каталогом даних програм є qtpaths --paths GenericDataLocation, а визначення структури має назву ExampleStructure, має бути каталог okteta/structures/ExampleStructure, що міститиме файли ExampleStructure.desktop і ExampleStructure.osd.

Якщо ви встановили нове визначення структури створенням такого каталогу або редагуванням файлів у ньому, вам слід перезапустити Okteta, а потім відкрити діалогове вікно параметрів інструменту «Структури». Там слід перейти на вкладку Керування записами структур і переконатися, що відповідний пункт визначення структури позначено. Після цього перейдіть на вкладку Структури і переконайтеся, що бажаний пункт є у списку, розташованому у правій частині вікна.

Наш файл метаданих буде таким:

        [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
        

Призначення полів має бути очевидним, окрім поля X-KDE-PluginInfo-Name. Значення у цьому полі має збігатися з назвою каталогу, у якому зберігається файл, а також назвою файла .desktop. Під час створення структури XML назва файла .osd також має збігатися з вказаною назвою.

У нашому прикладі ми маємо каталог з назвою simplestruct, у якому зберігаються файл simplestruct.desktop. Якщо структура визначається у форматі XML, у каталозі також має зберігатися файл з назвою simplestruct.osd. Якщо використано підхід з визначенням JavaScript, матимемо файл з назвою main.js.

Для початку ми створимо визначення дуже простої структури, що міститиме лише прості типи даних (один символ і одне 32-бітове ціле число (int)). Цю структуру можна записати мовою C/C++ так:

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

Першим кроком буде створення файла .osd, який ми назвемо 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>
          

Цей файл дуже подібний до визначення структури у C/C++.

Тепер створимо підкаталог simplestruct у каталозі встановлення структури (див. встановлення визначення структури вручну) і скопіюємо два файли до цього каталогу. Тепер можна перезапустити Okteta і спробувати скористатися новою структурою.

Щоб реалізувати наведену вище структуру мовою JavaScript, створіть файл з назвою main.js замість simplestruct.osd, і замініть X-KDE-PluginInfo-Category=structure на X-KDE-PluginInfo-Category=structure/js. У файлі мають міститися такі рядки:

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

Структура, показана у вікні Okteta, це завжди значення, яке повертає функція init.

Для створення типу елемента може бути викликано такі функції:

Функція bitfield отримує два параметри. Першим є рядок bool, signed або unsigned. Другим параметром є ціле число, яке встановлює розмір типу у бітах.

Тепер ми створимо визначення складнішої структури, яке назвемо «complex» і збережемо у файлі з назвою complex.osd. Ця структура міститиме два масиви (один фіксованої довжини і один, у якому довжина визначатиметься під час роботи програми), а також вкладену структуру і об’єднання (union).

          <?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>
          

Така структура формально визначається у C/C++ так:

struct complex {
            uint8_t size;
            union aUnion {
              int8_t fourBytes[4];
            };
            struct nested {
              char string[size] //не відповідає стандартам C++, посилається на значення розмірності uint8
            };
          };
          

Далі, ми створимо файл complex.desktop, як і у попередньому прикладі (переконайтеся, що значення X-KDE-PluginInfo-Name змінено відповідним чином), та повторимо дії зі встановлення визначення структури.

Декілька прикладів визначень структур можна знайти тут. Серед цих прикладів є файл заголовка для файлів PNG і заголовка файла ELF. Схема XML, яка описує структуру файла .osd, зберігається тут. Якщо вам потрібні якісь додаткові відомості, зверніться до автора за адресою (arichardson.kde gmail.com)