Crystal Programming. Введение на основе проекта в создание эффективных, безопасных и читаемых веб-приложений и приложений CLI - Джордж Дитрих
Шрифт:
Интервал:
Закладка:
Все примеры кода, использованные в этой главе, можно найти в папке главы 7 на GitHub: https://github.com/PacktPublishing/Crystal-Programming/tree/main/Chapter07.
Вводим привязки на языке C
Написание привязок C предполагает использование некоторых конкретных ключевых слов и концепций Crystal для определения API библиотеки C, например, какие функции она имеет, каковы аргументы и какой тип возвращаемого значения. Затем Crystal может использовать эти определения, чтобы определить, как их использовать. Конечным результатом является возможность вызывать функции библиотеки C из Crystal без необходимости писать код C самостоятельно. Прежде чем мы углубимся непосредственно в привязку libnotify, давайте начнем с нескольких более простых примеров, чтобы представить концепции и тому подобное. Возьмем, к примеру, этот простой файл C:
#include <stdio.h>
void sayHello(const char *name)
{
printf("Hello %s!n", name);
}
Мы определяем одну функцию, которая принимает указатель char, представляющий имя человека, с которым можно поздороваться. Затем мы можем определить наши привязки:
@[Link(ldflags: "#{ DIR }/hello.o")]
lib LibHello
fun say_hello = sayHello(name : LibC::Char*) : Void
end
LibHello.say_hello "Bob"
Аннотация @[Link] используется для информирования компоновщика, где найти дополнительные внешние библиотеки, которые он должен связать при создании двоичного файла Crystal. В данном случае мы указываем на объектный файл, созданный из нашего кода C — подробнее об этом позже. Далее мы используем ключевое слово lib для создания пространства имен, которое будет содержать все типы и функции привязки. В этом примере у нас есть только одна функция. Функции связываются с помощью ключевого слова fun, за которым следует обычное объявление функции Crystal с одним отличием. В обычном методе Crystal вы можете использовать возвращаемый тип Nil, однако здесь мы используем Void. Семантически они эквивалентны, но при написании привязок C предпочтительнее использовать Void. Наконец, мы можем вызывать методы, определенные в пространстве имен нашей библиотеки, как если бы они были методами класса.
Также обратите внимание, что имя, которое мы используем для вызова этой функции, отличается от имени, определенного в реализации C. Привязки Crystal C позволяют использовать псевдонимы для имен функций C, чтобы лучше соответствовать рекомендациям по стилю кода Crystal. В некоторых случаях псевдонимы могут потребоваться, если имя функции C не является допустимым именем метода Crystal, например, если оно содержит точки. В этом случае имя функции можно заключить в двойные кавычки, например, fun ceil_f32 = "llvm.ceil.f32"(value: Float32) : Float32.
Глядя на код Crystal, вы можете заметить некоторые вещи, которые могут показаться странными. Например, почему тип LibC::Char или строка “Bob” не является указателем? Поскольку Crystal также привязывается к некоторым библиотекам C для реализаций стандартной библиотеки, он предоставляет псевдонимы типам C, которые обрабатывают различия платформ. Например, если бы вы запускали программу на 32-битной машине, длина типа C составляла бы 4 байта, а на 64-битной машине — 8 байт, что соответствовало бы типам Crystal Int32 и Int64 соответственно. Чтобы лучше справиться с этой разницей, вы можете использовать псевдоним LibC::Long, который обрабатывает установку правильного типа Int в зависимости от системы, компилирующей программу.
Crystal также предоставляет некоторые абстракции, которые упрощают работу со связанными функциями. Причина, по которой мы можем передать строку функции, ожидающей указатель, заключается в том, что тип String определяет метод #to_unsafe, который возвращает указатель на содержимое строки. Этот метод определен для различных типов в стандартной библиотеке, но его также можно определить для пользовательских типов. Если этот метод определен, Crystal вызовет его, ожидая, что он вернет правильное значение, которое должно быть передано соответствующей функции C.
Как упоминалось ранее, прежде чем мы сможем запустить нашу программу Crystal, нам необходимо создать объектный файл для кода C. Это можно сделать с помощью различных компиляторов C, но я буду создавать это через GCC, выполнив команду gcc -Wall -O3 -march=native -c hello.c -o hello.o. У нас уже есть аннотация ссылки, ссылающаяся на только что созданный файл hello.o, поэтому все, что осталось сделать, это запустить программу через кристалл hello.cr, который выдает вывод Hello Bob!.
Функций привязки будет недостаточно для использования libnotify; нам также нужен способ представления самого объекта уведомления в форме структуры C. Они также определены в пространстве имен lib, например:
#include <stdio.h>
struct TimeZone {
int minutes_west;
int dst_time;
};
void print_tz(struct TimeZone *tz)
{
printf("DST time is: %dn", tz->dst_time);
}
Здесь мы определяем структуру C под названием TimeZone, которая имеет два свойства int. Затем мы определяем функцию, которая будет печатать свойство времени летнего времени указателя на эту структуру. Соответствующая привязка Crystal будет выглядеть следующим образом:
@[Link(ldflags: "#{__DIR__}/struct.o")]
lib LibStruct
struct TimeZone
minutes_west : Int32
dst time : Int32
end
fun print_tz(tz : TimeZone*) : Void
end
tz = LibStruct::TimeZone.new
tz.minutes_west = 1
tz.dst_time = 14
LibStruct.print_tz pointerof(tz)
Определение этой структуры позволяет создать ее экземпляр, как и любой другой объект, через .new. Однако, в отличие от предыдущего примера, мы не можем передать объект непосредственно в функцию C. Это связано с тем, что структура определена в пространстве имен lib, ожидает указатель на нее и не имеет метода #to_unsafe. В следующем разделе будет рассказано, как лучше всего с этим справиться.
Компиляция объектного файла и запуск программы Crystal, как и раньше, выведет: Время летнего времени: 14.
Еще одна распространенная функция привязки C — поддержка обратных вызовов. Crystal, эквивалентный указателю на функцию C, — это Proc. Лучше всего это показать на примере. Давайте напишем функцию C, которая принимает обратный вызов, принимающий целочисленное значение. Функция C сгенерирует случайное число, а затем вызовет обратный вызов с этим значением. В конечном итоге это может выглядеть примерно так:
#include <stdlib.h>
#include <time.h>
void number_callback(void (*callback)(int))
{
srand(time(0));
