Программирование с использованием gtkmm 3. Создание с помощью утилиты gmmproc оберток для разработанных с использованием языка программирования C библиотек

Приложение G. Создание с помощью утилиты gmmproc оберток для разработанных с использованием языка программирования C библиотек

Для генерации большей части кода gtkmm используется утилита gmmproc, которая обрабатывает файлы с расширением .defs, описывающие API библиотек на основе системы типов GObject. Таким образом, создание аналогичных gtkmm оберток для других библиотек на основе glib/GObject является достаточно простой задачей.

Процесс создания оберток для библиотек связан с использованием множества инструментов, некоторые из которых являются достаточно сложными, но, по крайней мере, они работают и успешно используются несколькими проектами.

G.1. Структура директорий для сборки

Генерация исходного кода для API в стиле gtkmm связана с использованием таких инструментов, как gmmproc и generate_wrap_init.pl. Теоретически вы могли бы разработать свои собственные файлы сборки для последующего использования, но гораздо более удачным вариантом является использование инфраструктуры сборки, предоставляемой модулем mm-common. В начале работы очень полезно выбрать существующий модуль, который сможет использоваться в будущем в качестве наглядного примера.

Например, представим, что мы создаем обертку для разработанной с использованием языка программирования C библиотеки под названием libsomething. Она предоставляет API на основе системы типов GObject с такими названиями типов, как, к примеру, SomeWidget и SomeStuff.

G.1.1. Копирование прототипа проекта

  $ git clone git://git.gnome.org/mm-common
  $ cp -a mm-common/skeletonmm libsomethingmm

$ for f in $(find libsomethingmm -depth -name '*skeleton*'); do \
    d="${f%/*}"; b="${f##*/}"; mv "$f" "$d/${b//skeleton/libsomething}"; \
  done

Файлы прототипа проекта в будущем должны быть заполнены специфичными для проекта данными.

Учтите, что файлы с заканчивающимися на .in именами будут использоваться для генерации файлов с такими же именами, но без суффиксов .in путем замены некоторых переменных на реальные значения в процессе конфигурации.

G.1.2. Модификация файлов сборки

Теперь мы должны модифицировать файлы сборки для их адаптации к нашим потребностям. Для выполнения этой задачи вы можете предпочесть использовать утилиту, выполняющую поиск и замену данных во множестве файлов, такую, как regexxer. Учтите, что практически все эти файлы из дерева исходного кода прототипа проекта содержат текст для заполнения. Следовательно, должны осуществляться глобальные подстановки, не ограничивающиеся файлами Automake и Autoconf.

Все упоминания о названии прототипа проекта должны заменяться на корректное название созданной с использованием языка программирования C библиотеки, для которой создается обертка, такое, как "something" или "libsomething" и, таким же образом, все слова "SKELETON" должны быть заменены на "SOMETHING" или "LIBSOMETHING", а все слова "Skeleton - на "Something".

Аналогичным образом следует заменить все сочетания "Joe Hacker" на имя владельца авторских прав, которым, скорее всего, являетесь вы. То же самое нужно сделать и с адресом электронной почты "joe@example.com".

G.1.2.1. Файл configure.ac

G.1.2.2. Файлы Makefile.am

G.1.2.3. Создание файлов .hg и .cgg

Теперь мы должны создать первые файлы с расширениями .hg и .ccg с целью формирования обертки для одного из объектов созданной с использованием языка программирования C библиотеки. Одна пара примеров файлов исходного кода уже существует: skeleton.ccg и skeleton.hg. Создавайте копии этих файлов по мере необходимости.

Мы должны указать имена всех наших файлов с расширениями .hg и .cgg в файле skeleton/src/filelist.am обычно в качестве значения переменной files_hg.

Любые дополнительные не сгенерированные файлы исходного кода с расширениями .h и .cc могут быть размещены в директории skeleton/skeletonmm/ и описаны в файле skeleton/skeletonmm/filelist.am обычно с помощью значений переменных files_extra_h и files_extra_cc.

В разделе "Файлы с расширениями .hg и .ccg" вы можете узнать о синтаксисе, используемом в этих файлах.

G.2. Генерация файлов с расширением .defs

Сценарий skeleton/codegen/generate_defs_and_docs.sh генерирует все файлы с расширением .defs и файл *_docs.xml, описанный в разделе "Документация".

G.2.1. Генерация файла с расширением .defs для хранения описаний методов

$ ./h2def.py /usr/include/gtk-3.0/gtk/*.h > gtk_methods.defs

G.2.2. Генерация файла с расширением .defs для хранения описаний перечислений

$ ./enum.pl /usr/include/gtk-3.0/gtk/*.h > gtk_enums.defs

G.2.3. Генерация файла с расширением .defs для хранения описаний сигналов и свойств

$ cd tools/extra_defs_gen
$ ./generate_extra_defs > gtk_signals.defs

Вы должны отредактировать исходный код вашей утилиты generate_extra_defs с целью генерации файлов с расширением .defs для объявленных на уровне языка программирования C типов GObject, для которых вы желаете создать обертки. В дереве исходного кода прототипа проекта имя файла исходного кода утилиты codegen/extradefs/generate_extra_defs_skeleton.cc. Если вы еще не переименовали этот файл, сделайте это, заменив "skeleton" на основное название вашей новой обертки. В файле codegen/Makefile.am также должно использоваться новое имя файла исходного кода.

#include <libsomething.h>

int main(int, char**)
{
  something_init();

  std::cout << get_defs(SOME_TYPE_WIDGET)
            << get_defs(SOME_TYPE_STUFF);
  return 0;
}

G.2.4. Создание файла с расширением .defs для хранения описаний виртуальных функций

Файл с расширением .defs данного типа описывает виртуальные функции (vfuncs). Он должен создаваться вручную. Существует прототип данного файла с именем skeleton/src/skeleton_vfunc.defs, с редактирования которого можно начать работу. Также вы можете рассмотреть файл gtk/src/gtk_vfuncs.defs из дерева исходного кода gtkmm.

Следующий раздел : Приложение G.3. Файлы с расширениями .hg и .ccg.