作者: mclasen

桌面应用程序之间用户发起数据传输的传统方法是剪贴板或拖放。GTK+ 从一开始就支持这些方法，但在 GTK3 之前，我们用于这种数据传输的 API 是对相应的 X11 API 的简单伪装：选择、属性和原子。这并不奇怪，因为整个 GDK API 都是以 X11 为模型的。不幸的是，该实现包括诸如增量传输和字符串格式转换之类的弊端。

对于 GTK4，我们正在抛弃这些东西，因为我们正在将 GDK 中的内容移动得更接近 Wayland API。数据传输是迫切需要这种现代化的领域之一。值得庆幸的是，它现在几乎完成了，因此值得看看发生了哪些变化，以及未来事物将如何运作。

概念

如果您的应用程序想要发送的数据不是字符串，它可能是一些对象，例如 GFile、GdkTexture 或 GdkRGBA。接收端的应用程序可能不使用 GTK 或 GLib，因此不会知道这些类型。即使它知道，也没有办法将对象从一个进程完整地传递到另一个进程。

核心上，数据传输的工作原理是，发送应用程序发送一个文件描述符，目标应用程序从该文件描述符读取字节流。剪贴板和 DND 的协议使用诸如 text/uri-list、image/png 或 application/x-color 之类的 MIME 类型来标识字节流的格式。

发送对象涉及协商双方都支持的数据格式，将源端的对象序列化为该格式的字节流，传输数据，并在目标端反序列化对象。

本地情况

在进入具体的 API 之前，值得停下来考虑一下另一种常见的数据传输情况：在单个应用程序内部。使用相同的剪贴板和 DND 机制将数据从应用程序的一侧发送到另一侧是很常见的。由于在这种情况下我们没有跨越进程边界，因此我们可以避免字节流以及相关的序列化和反序列化开销，而只需传递对该对象的引用即可传输数据。

API

我们在上一节中提到的对象由 GType（例如 G_TYPE_FILE 或 GDK_TYPE_TEXTURE）描述，而正如所提到的，Wayland 和 X11 协议中的数据交换格式由 MIME 类型描述。

我们引入的第一个用于处理这些类型的 API 是 GdkContentFormats 对象。它可以包含格式列表，这些格式可以是 GType 或 MIME 类型。我们使用 GdkContentFormats 对象来描述应用程序可以提供数据采用的格式，以及应用程序可以接收数据的格式。

您可能想知道为什么我们在同一个对象中混合使用 GType 和 MIME 类型。答案是我们希望使用相同的 API 来处理跨进程和本地情况。虽然我们需要为跨进程情况匹配 MIME 类型，但我们需要本地情况的 GType。

转换

我们仍然需要一种方法来关联 GType 和 MIME 类型，以便我们可以相互转换。这由 GdkContentSerializer 和 GdkContentDeserializer API 处理。这些本质上是转换函数的注册表：GdkContentSerializer 知道如何将 GType 转换为 MIME 类型，而 GdkContentDeserializer 处理相反的方向。

GDK 具有用于常见类型的预定义转换，但该系统可以通过使用 gdk_content_register_serializer 和 gdk_content_register_deserializer 来扩展。

内容

现在我们知道如何描述格式以及在它们之间进行转换，但为了将所有这些整合在一起，我们仍然需要一个方便的 API，该 API 在一侧接收对象，并在另一侧提供字节流。为此，我们添加了 GdkContentProvider API。

GdkContentProvider 允许您将对象与输入端的格式描述结合使用，并在输出端提供异步写入器 API，该 API 可以连接到我们想要在其上发送数据的文件描述符。

典型的内容提供程序是这样创建的

gdk_content_provider_new_for_value (gvalue)
gdk_content_provider_new_for_bytes (gbytes, mimetype)

它接收的 GValue 包含对象及其类型的信息，因此如果我们提供对象作为 GBytes（本质上只是一段内存），则不需要额外的类型信息，我们需要单独提供类型信息。

剪贴板

GTK3 有一个 GtkClipboard 对象，它为复制/粘贴操作提供实现。在 GTK 中拥有此对象并不理想，因为它需要在 GTK 支持的平台上进行不同的实现。因此，GTK4 将该对象移动到 GDK，并因此将其重命名为 GdkClipboard。它也已被移植到上面描述的新数据传输 API。要在 GTK4 中将数据放入剪贴板，请使用“set” API 之一

gdk_clipboard_set_content()
gdk_clipboard_set_value()
gdk_clipboard_set_text()

最终，所有这些函数都会将 GdkContentProvider 与剪贴板关联起来。

要在 GTK4 中从剪贴板读取数据，请使用异步“read”API 之一

gdk_clipboard_read_async()
gdk_clipboard_read_value_async()
gdk_clipboard_read_text_async()

拖放

GTK3 拖放 API 涉及侦听 GtkWidget 上的多个信号，并为拖动源和目标调用一些特殊的设置函数。它很灵活，但通常被认为是令人困惑的，我们在这里不会详细描述它。

在 GTK4 中，拖放 API 已围绕内容提供程序和事件控制器的概念进行重组。要启动拖放操作，您可以创建一个 GtkDragSource 事件控制器来响应拖动手势（您也可以通过仅调用 gdk_drag_begin 来启动“一次性”拖放操作），并为要传输的数据提供一个 GdkContentProvider。要接收拖放操作，您可以创建一个 GtkDropTarget 事件控制器，并在它发出 ::drop-done 信号时调用异步读取方法

gdk_drop_read_value_async()
gdk_drop_read_text_async()

最近在 GTK master 中完成的较大重构之一是重新设计条目层次结构。 这篇文章总结了已更改的内容，以及我们为什么认为这种方式更好。

GTK 3 中的条目

让我们首先看看 GTK 3 中的情况。

GtkEntry 是这里的基础类。 它实现了 GtkEditable 接口。 GtkSpinButton 是 GtkEntry 的子类。 多年来，添加了更多内容。 GtkEntry 获得了对条目完成、嵌入图标和显示进度的支持。 我们添加了另一个子类 GtkSearchEntry。

这种方法的一些问题立即显现出来。 gtkentry.c 的代码超过 11100 行。 不仅很难在此大型代码库中添加更多功能，而且也很难对其进行子类化——这是创建您自己的条目的唯一方法，因为所有单行文本编辑功能都在 GtkEntry 中。

GtkEditable 接口非常旧——它在 GTK 2 之前就存在了。 不幸的是，它作为一个接口并没有真正成功——GtkEntry 是唯一的实现，并且它以一种令人困惑的方式在内部使用接口函数。

GTK 4 中的条目

现在让我们看看 GTK master 中的情况。

我们做的第一件事是将 GtkEntry 的核心文本编辑功能移到一个名为 GtkText 的新部件中。这基本上是一个没有所有额外功能的输入框，比如图标、补全和进度。

我们通过向 GtkEditable 接口添加一些更常用的功能（如 width-chars 和 max-width-chars）使其更有用，并使 GtkText 实现它。我们还添加了辅助 API，以便轻松地将 GtkEditable 实现委托给另一个对象。

“复杂”的输入框部件（GtkEntry、GtkSpinButton、GtkSearchEntry）现在都是组合部件，它们包含一个 GtkText 子部件，并将其 GtkEditable 实现委托给这个子部件。

最后，我们添加了一个新的 GtkPasswordEntry 部件，它接管了 GtkEntry 过去拥有的相应功能，例如显示大写锁定警告

或者允许用户查看内容。

为什么这样更好？

这次重构的主要目标之一是使在 GTK 之外创建自定义输入框部件更容易。

过去，这需要子类化 GtkEntry，并浏览一个复杂的 vfunc 迷宫来覆盖。现在，您只需添加一个 GtkText 部件，将其 GtkEditable 实现委托给它，就可以轻松获得一个功能齐全的输入框部件。

而且您可以灵活地在 GtkText 组件周围添加各种花哨的东西。例如，我们在 gtk4-demo 中添加了一个带标签的输入框，现在可以很容易地在 GTK 之外实现。

从 GTK 3 移植时，这会影响您吗？

在将代码移植到这种新的输入框样式时，有几个需要注意的潜在陷阱。

GtkSearchEntry 和 GtkSpinButton 不再派生自 GtkEntry。如果您看到有关将这些类之一强制转换为 GtkEntry 的运行时警告，您很可能需要切换到使用 GtkEditable API。

GtkEntry 和其他复杂的输入框部件不再可聚焦 – 焦点会转移到包含的 GtkText。但 gtk_widget_grab_focus() 仍然有效，并将焦点移动到正确的位置。您不太可能受到此影响。

大写锁定警告功能已从 GtkEntry 中删除。如果您将 GtkEntry 的 visibility==FALSE 用于密码，则只需切换到 GtkPasswordEntry。

如果您将 GtkEntry 用于基本的编辑功能，并且不需要任何额外的输入框功能，则应考虑使用 GtkText。

GTK 对可加载模块的支持可以追溯到很久以前，这就是为什么 GTK 有很多代码来处理 GTypeModules 和搜索路径等。 后来，Alex 为 GVfs 重新审视了该主题，并提出了扩展点和 GIO 模块的概念，它们实现了这些扩展点。这是一个更好的框架，GTK 4 是我们切换到使用它的绝佳机会。

GTK+ 4 中的更改

因此，我最近花了一些时间在 GTK 中的模块支持上。这里的主要变化如下

• 我们不再支持通用可加载模块。此功能的少数剩余用户之一是 libcanberra，我们将考虑直接在 GTK+ 中实现“事件声音”功能，而不是依赖于模块来实现。如果您依赖于加载 GTK+ 模块，请来和我们讨论其他实现您正在做的事情的方法。
• 打印后端现在使用名为“gtk-print-backend”的扩展点定义，该扩展点需要 GtkPrintBackend 类型。现有的打印后端已转换为实现此扩展点的 GIO 模块。由于我们从未支持过树外打印后端，因此这不应影响其他任何人。
• 输入法也使用扩展点定义，名为“gtk-im-module”，它需要 GtkIMContext 类型。 我们已经放弃了所有非平台 IM 模块，并将平台 IM 模块移到了 GTK+ 本身中，同时也实现了扩展点。

适配现有的输入法

由于我们仍然支持树外 IM 模块，我想用这篇文章的其余部分来简要介绍一下 GTK+ 4 的树外 IM 模块必须是什么样子。

将传统的基于 GTypeModule 的 IM 模块转换为新的扩展点需要几个步骤。下面的示例代码取自 Broadway 输入法。

使用 G_DEFINE_DYNAMIC_TYPE

我们将从模块加载类型，并且 G_DEFINE_DYNAMIC_TYPE 是定义此类类型的正确方法

G_DEFINE_DYNAMIC_TYPE (GtkIMContextBroadway,
                       gtk_im_context_broadway,
                       GTK_TYPE_IM_CONTEXT)

请注意，此宏定义了一个 gtk_im_context_broadway_register_type() 函数，我们将在下一步中使用它。

请注意，除了更常见的 class_init 之外，动态类型还需要一个 class_finalize 函数，它可以是微不足道的

static void
gtk_im_context_broadway_class_finalize
               (GtkIMContextBroadwayClass *class)
{
}

实现 GIO 模块 API

为了用作 GIOModule，模块必须实现三个函数：g_io_module_load()、g_io_module_unload() 和 g_io_module_query()（严格来说，最后一个是可选的，但我们无论如何都要在这里实现它）。

void
g_io_module_load (GIOModule *module)
{
  g_type_module_use (G_TYPE_MODULE (module));
  gtk_im_context_broadway_register_type  
                        (G_TYPE_MODULE (module));
  g_io_extension_point_implement
             (GTK_IM_MODULE_EXTENSION_POINT_NAME,
              GTK_TYPE_IM_CONTEXT_BROADWAY,
              "broadway",
              10);
 }

void
g_io_module_unload (GIOModule *module)
{
}

char **
g_io_module_query (void)
{
  char *eps[] = {
    GTK_IM_MODULE_EXTENSION_POINT_NAME,
    NULL
  };
  return g_strdupv (eps);
}

正确安装您的模块

GTK+ 仍将在 $LIBDIR/gtk-4.0/immodules/ 中查找要加载的输入法，但 GIO 仅查看名称以“lib”开头的共享对象，因此请确保您遵循该约定。

调试

就是这样！

现在 GTK+ 4 应该加载您的输入法，如果您使用 GTK_DEBUG=modules 运行 GTK+ 4 应用程序，您应该在调试输出中看到您的模块。