GirFFI 技术文档

1. 安装指南

1.1 安装依赖

在使用 GirFFI 之前，您需要确保系统上安装了以下依赖项：

• Ruby 版本：GirFFI 支持 CRuby 2.7、3.0 和 3.1。
• gobject-introspection：您需要安装带有 introspection 数据的 gobject-introspection。
• glib：建议使用 glib 2.56.0 及以上版本。

在 Debian 和 Ubuntu 系统上，您可以通过以下命令安装所需的依赖项：

sudo apt-get install libgirepository-1.0-1 gir1.2-glib-2.0

1.2 安装 GirFFI

您可以通过 RubyGems 安装 GirFFI：

gem install gir_ffi

1.3 安装其他依赖

如果您需要运行测试或使用某些特定的库，您可能需要安装额外的依赖项。例如：

sudo apt-get install libgirepository1.0-dev gobject-introspection libcairo2-dev gir1.2-gtop-2.0 gir1.2-gtk-3.0 gir1.2-pango-1.0 gir1.2-gtksource-3.0 gir1.2-secret-1 gir1.2-gstreamer-1.0

2. 项目的使用说明

2.1 基本使用

GirFFI 提供了对 GNOME 库的 Ruby 绑定，您可以通过以下步骤开始使用：

1. 首先，加载 gir_ffi 库：

   require 'gir_ffi'
   

2. 设置您希望使用的命名空间，例如 Gio：

   GirFFI.setup :Gio
   

3. 创建一个对象并调用其方法：

   inet_address = Gio::InetAddress.new_from_string "127.0.0.1"
   inet_address.is_loopback    # => true
   inet_address.is_multicast   # => false
   

4. 调用命名空间中的函数：

   Gio.dbus_is_name "foo"   # => false
   

2.2 示例代码

您可以在 examples/ 目录中找到一些简单的示例代码。此外，gir_ffi-gtk 和 gir_ffi-gst 仓库中也提供了更多的示例。

3. 项目API使用文档

3.1 命名空间设置

GirFFI.setup 方法用于设置您希望使用的命名空间。例如：

GirFFI.setup :Gio

3.2 对象创建与方法调用

您可以通过命名空间中的类创建对象，并调用其方法。例如：

inet_address = Gio::InetAddress.new_from_string "127.0.0.1"
inet_address.is_loopback    # => true

3.3 函数调用

您可以直接调用命名空间中的函数。例如：

Gio.dbus_is_name "foo"   # => false

4. 项目安装方式

4.1 通过 RubyGems 安装

最简单的安装方式是通过 RubyGems 安装 GirFFI：

gem install gir_ffi

4.2 手动安装

如果您需要手动安装，可以从 GitHub 仓库克隆代码并运行安装命令：

git clone https://github.com/mvz/gir_ffi.git
cd gir_ffi
rake install

4.3 依赖库的安装

确保您已经安装了所需的依赖库，特别是 gobject-introspection 和 glib。

通过以上步骤，您应该能够顺利安装并使用 GirFFI 项目。