Basic concept/zh-cn - Revision history

Matrikslee: Created page with "然后它会经历多个阶段，并且可能会在管道中间进行过滤，以阻止所有尚未发生的过程。"

2023-04-19T03:21:29Z

Created page with "然后它会经历多个阶段，并且可能会在管道中间进行过滤，以阻止所有尚未发生的过程。"

← Older revision		Revision as of 03:21, 19 April 2023
Line 49:		Line 49:
	在 Fcitx 内部，Key 事件将被包装为 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1KeyEvent.html KeyEvent对象]，并由 Fcitx 事件管道处理。在发送到管道之前，如果当前要使用的布局与系统布局不同，Fcitx 将应用自己的 XKB 翻译并将翻译后的密钥对象存储在字段 rawKey 中。字段 key() 将相应更新为规范化的 rawKey 形式。		在 Fcitx 内部，Key 事件将被包装为 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1KeyEvent.html KeyEvent对象]，并由 Fcitx 事件管道处理。在发送到管道之前，如果当前要使用的布局与系统布局不同，Fcitx 将应用自己的 XKB 翻译并将翻译后的密钥对象存储在字段 rawKey 中。字段 key() 将相应更新为规范化的 rawKey 形式。

	~~Then it goes through multiple stages and it might be filtered in the middle of the pipeline to prevent any future process.~~		然后它会经历多个阶段，并且可能会在管道中间进行过滤，以阻止所有尚未发生的过程。

Matrikslee: Created page with "== 从 Frontend 到 Fcitx 事件管道和输入法引擎 == 在 Fcitx 内部，Key 事件将被包装为 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1KeyEvent.html KeyEven..."

2023-04-19T03:20:26Z

Created page with "== 从 Frontend 到 Fcitx 事件管道和输入法引擎 == 在 Fcitx 内部，Key 事件将被包装为 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1KeyEvent.html KeyEven..."

← Older revision		Revision as of 03:20, 19 April 2023
Line 46:		Line 46:
	有 zwp_input_method_v1 和 zwp_input_method_v2。在 V1 中，关键事件来自应用程序，并经过与 DBus 相似的代码路径。在 V2 中，Input method 需要创建键盘抓取事件，合成器（Compositor）会将所有键转发给输入法。按键符号转换的关键代码是在 Fcitx 端完成的，会使用来自合成器（Compositor）的键盘映射。		有 zwp_input_method_v1 和 zwp_input_method_v2。在 V1 中，关键事件来自应用程序，并经过与 DBus 相似的代码路径。在 V2 中，Input method 需要创建键盘抓取事件，合成器（Compositor）会将所有键转发给输入法。按键符号转换的关键代码是在 Fcitx 端完成的，会使用来自合成器（Compositor）的键盘映射。

	== ~~From~~ Frontend to Fcitx ~~event pipe line and Input Method Engine~~ ==		== 从 Frontend 到 Fcitx 事件管道和输入法引擎 ==
	~~Inside~~ Fcitx~~, The Key event will be wrapped as a~~ [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1KeyEvent.html ~~KeyEvent~~] ~~object, and be processed by the~~ Fcitx ~~event pipeline. Before sending to the pipeline, if the current layout to be used is not same as the system layout, Fcitx will apply its own~~ XKB ~~translation and store the translated key object in the field~~ rawKey~~. The field~~ key() ~~will be updated accordingly as a normalized~~ rawKey ~~form.~~		在 Fcitx 内部，Key 事件将被包装为 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1KeyEvent.html KeyEvent对象]，并由 Fcitx 事件管道处理。在发送到管道之前，如果当前要使用的布局与系统布局不同，Fcitx 将应用自己的 XKB 翻译并将翻译后的密钥对象存储在字段 rawKey 中。字段 key() 将相应更新为规范化的 rawKey 形式。

	Then it goes through multiple stages and it might be filtered in the middle of the pipeline to prevent any future process.		Then it goes through multiple stages and it might be filtered in the middle of the pipeline to prevent any future process.

Matrikslee: Created page with "=== Wayland IM === 有 zwp_input_method_v1 和 zwp_input_method_v2。在 V1 中，关键事件来自应用程序，并经过与 DBus 相似的代码路径。在 V2 中，Input..."

2023-04-19T03:19:39Z

Created page with "=== Wayland IM === 有 zwp_input_method_v1 和 zwp_input_method_v2。在 V1 中，关键事件来自应用程序，并经过与 DBus 相似的代码路径。在 V2 中，Input..."

← Older revision		Revision as of 03:19, 19 April 2023
Line 44:		Line 44:

	=== Wayland IM ===		=== Wayland IM ===
	~~There's~~ zwp_input_method_v1 ~~and zwp_input_method_v2. In~~ V1~~, the key event is from application and goes through a similar code path like~~ DBus~~. In~~ V2~~, Input~~ method ~~will need to create a keyboard grab and Compositor will forward all the key to input methods. The key code to key sym translation is done on the~~ Fcitx ~~side, with the keymap from compositor.~~		有 zwp_input_method_v1 和 zwp_input_method_v2。在 V1 中，关键事件来自应用程序，并经过与 DBus 相似的代码路径。在 V2 中，Input method 需要创建键盘抓取事件，合成器（Compositor）会将所有键转发给输入法。按键符号转换的关键代码是在 Fcitx 端完成的，会使用来自合成器（Compositor）的键盘映射。

	== From Frontend to Fcitx event pipe line and Input Method Engine ==		== From Frontend to Fcitx event pipe line and Input Method Engine ==

Matrikslee: Created page with "=== DBus前端/IBus前端/Fcitx4前端 === 这些前端很相似，只是使用了不同的 dbus 接口。当应用程序从工具包（例如Gtk/Qt/SDL）接收到按键事..."

2023-04-19T03:17:53Z

Created page with "=== DBus前端/IBus前端/Fcitx4前端 === 这些前端很相似，只是使用了不同的 dbus 接口。当应用程序从工具包（例如Gtk/Qt/SDL）接收到按键事..."

← Older revision		Revision as of 03:17, 19 April 2023
Line 40:		Line 40:
	应用程序从 X Server 收到 KeyEvent 后，需要使用 XIM 协议将其转发到 XIM 服务器。按键事件仅包含修饰符状态和按键代码。实际的密钥符号来自 X 服务器密钥映射。		应用程序从 X Server 收到 KeyEvent 后，需要使用 XIM 协议将其转发到 XIM 服务器。按键事件仅包含修饰符状态和按键代码。实际的密钥符号来自 X 服务器密钥映射。

	=== ~~DBusFrontend~~/~~IBusFrontend~~/~~Fcitx4Frontend~~ ===		=== DBus前端/IBus前端/Fcitx4前端 ===
	~~These frontends are similar, but just using different~~ dbus ~~interfaces. When application receives a key event from toolkit (e.g. Gtk~~/Qt/~~SDL), it forward the key event to Fcitx via some dbus interfaces. The key sym comes from the translation inside the application, but key code and modifier state are also available.~~		这些前端很相似，只是使用了不同的 dbus 接口。当应用程序从工具包（例如Gtk/Qt/SDL）接收到按键事件时，它通过一些dbus接口将按键事件转发给Fcitx。密钥符号来自应用程序内部的翻译，但密钥代码和修饰符状态也是可用的。

	=== Wayland IM ===		=== Wayland IM ===

Matrikslee: Created page with "=== XIM === 应用程序从 X Server 收到 KeyEvent 后，需要使用 XIM 协议将其转发到 XIM 服务器。按键事件仅包含修饰符状态和按键代码。实际..."

2023-04-19T03:17:19Z

Created page with "=== XIM === 应用程序从 X Server 收到 KeyEvent 后，需要使用 XIM 协议将其转发到 XIM 服务器。按键事件仅包含修饰符状态和按键代码。实际..."

← Older revision		Revision as of 03:17, 19 April 2023
Line 38:		Line 38:

	=== XIM ===		=== XIM ===
	~~Upon application receives a KeyEvent from~~ X Server~~, it need to use~~ XIM ~~protocol to forward it to the~~ XIM ~~server. The key event contains only modifier state and key code. The actual key sym is derived from the~~ X ~~Server key map.~~		应用程序从 X Server 收到 KeyEvent 后，需要使用 XIM 协议将其转发到 XIM 服务器。按键事件仅包含修饰符状态和按键代码。实际的密钥符号来自 X 服务器密钥映射。

	=== DBusFrontend/IBusFrontend/Fcitx4Frontend ===		=== DBusFrontend/IBusFrontend/Fcitx4Frontend ===

Matrikslee: Created page with "Fcitx 前端是 Fcitx 从应用程序和显示服务器接收按键事件的地方。"

2023-04-19T03:17:02Z

Created page with "Fcitx 前端是 Fcitx 从应用程序和显示服务器接收按键事件的地方。"

← Older revision		Revision as of 03:17, 19 April 2023
Line 35:		Line 35:
	根据 Fcitx 和应用程序之间的协议，可以使用几种不同的路径。		根据 Fcitx 和应用程序之间的协议，可以使用几种不同的路径。

	Fcitx ~~frontend is where~~ Fcitx ~~receives the key event from application and display server.~~		Fcitx 前端是 Fcitx 从应用程序和显示服务器接收按键事件的地方。

	=== XIM ===		=== XIM ===

Matrikslee: Created page with "== 到达 Fcitx 前端 == 根据 Fcitx 和应用程序之间的协议，可以使用几种不同的路径。"

2023-04-19T03:16:46Z

Created page with "== 到达 Fcitx 前端 == 根据 Fcitx 和应用程序之间的协议，可以使用几种不同的路径。"

← Older revision		Revision as of 03:16, 19 April 2023
Line 32:		Line 32:
	从实际的物理键盘按下到 Fcitx 接收到按键事件可能会经过以下步骤。		从实际的物理键盘按下到 Fcitx 接收到按键事件可能会经过以下步骤。

	== ~~Reaching~~ Fcitx ~~Frontend~~ ==		== 到达 Fcitx 前端 ==
	~~Depending on the protocol between~~ Fcitx ~~and application, there are several different path that might be exercised.~~		根据 Fcitx 和应用程序之间的协议，可以使用几种不同的路径。

	Fcitx frontend is where Fcitx receives the key event from application and display server.		Fcitx frontend is where Fcitx receives the key event from application and display server.

Matrikslee: Created page with "= 关键事件的生命周期 = 从实际的物理键盘按下到 Fcitx 接收到按键事件可能会经过以下步骤。"

2023-04-19T03:16:34Z

Created page with "= 关键事件的生命周期 = 从实际的物理键盘按下到 Fcitx 接收到按键事件可能会经过以下步骤。"

← Older revision		Revision as of 03:16, 19 April 2023
Line 29:		Line 29:
	至于事件类型，有输入上下文特定事件和全局事件。输入上下文特定事件总是与输入上下文相关联。		至于事件类型，有输入上下文特定事件和全局事件。输入上下文特定事件总是与输入上下文相关联。

	= ~~Life of a Key Event~~ =		= 关键事件的生命周期 =
	~~From an actual physical keyboard press to the key event that receives by~~ Fcitx ~~may go through following steps.~~		从实际的物理键盘按下到 Fcitx 接收到按键事件可能会经过以下步骤。

	== Reaching Fcitx Frontend ==		== Reaching Fcitx Frontend ==

Matrikslee: Created page with "至于事件类型，有输入上下文特定事件和全局事件。输入上下文特定事件总是与输入上下文相关联。"

2023-04-19T03:16:22Z

Created page with "至于事件类型，有输入上下文特定事件和全局事件。输入上下文特定事件总是与输入上下文相关联。"

← Older revision		Revision as of 03:16, 19 April 2023
Line 27:		Line 27:
	一个事件有5个事件处理阶段，只有3个阶段暴露给用户，分别是Default、PreInputMethod和PostInputMethod。还有 Fcitx 内部使用的 ReservedFirst 和 ReservedLast。这些阶段的顺序是 ReservedFirst、PreInputMethod、Default、PostInputMethod、ReservedLast。活动输入法引擎收到事件后的默认阶段。PreInputMethod 是实现子输入法最常用的方法之一。例如，插件可以定义触发键。当用户按下触发键时，它会设置一个标志并处理 PreInputMethod 阶段中的所有未来键事件，直到它结束其输入模式。		一个事件有5个事件处理阶段，只有3个阶段暴露给用户，分别是Default、PreInputMethod和PostInputMethod。还有 Fcitx 内部使用的 ReservedFirst 和 ReservedLast。这些阶段的顺序是 ReservedFirst、PreInputMethod、Default、PostInputMethod、ReservedLast。活动输入法引擎收到事件后的默认阶段。PreInputMethod 是实现子输入法最常用的方法之一。例如，插件可以定义触发键。当用户按下触发键时，它会设置一个标志并处理 PreInputMethod 阶段中的所有未来键事件，直到它结束其输入模式。

	~~As for the event type, there are input context specific events and global events. The input context specific events always associate with an input context.~~		至于事件类型，有输入上下文特定事件和全局事件。输入上下文特定事件总是与输入上下文相关联。

	= Life of a Key Event =		= Life of a Key Event =

Matrikslee: Created page with "= 事件处理 = 一个事件有5个事件处理阶段，只有3个阶段暴露给用户，分别是Default、PreInputMethod和PostInputMethod。还有 Fcitx 内部使用的 R..."

2023-04-19T03:16:10Z

Created page with "= 事件处理 = 一个事件有5个事件处理阶段，只有3个阶段暴露给用户，分别是Default、PreInputMethod和PostInputMethod。还有 Fcitx 内部使用的 R..."

← Older revision		Revision as of 03:16, 19 April 2023
Line 24:		Line 24:
	基于不同的显示服务器，输入上下文可能属于不同的焦点组。每个焦点组都映射到一个显示连接，例如 X11、Wayland。每个焦点小组都包含一组输入上下文，并且最多其中一个将在小组中获得焦点。输入上下文也可能没有焦点小组。		基于不同的显示服务器，输入上下文可能属于不同的焦点组。每个焦点组都映射到一个显示连接，例如 X11、Wayland。每个焦点小组都包含一组输入上下文，并且最多其中一个将在小组中获得焦点。输入上下文也可能没有焦点小组。

	= ~~Event handling~~ =		= 事件处理 =
	There are 5 stage of event handling for one event, only 3 of the stages are exposed to user, which are Default, PreInputMethod, and PostInputMethod. There are also ReservedFirst and ReservedLast used by Fcitx ~~internally. The order of different stages is~~ ReservedFirst, PreInputMethod, Default, PostInputMethod, ReservedLast. The Default stage just after the active input method engine receives event. PreInputMethod is one of the most commonly used one to implement sub input method. For example, an addon may define a trigger key. When the trigger key is pressed by user, it sets a flag and handle all the future key event in the PreInputMethod ~~stage until it ends its input mode.~~		一个事件有5个事件处理阶段，只有3个阶段暴露给用户，分别是Default、PreInputMethod和PostInputMethod。还有 Fcitx 内部使用的 ReservedFirst 和 ReservedLast。这些阶段的顺序是 ReservedFirst、PreInputMethod、Default、PostInputMethod、ReservedLast。活动输入法引擎收到事件后的默认阶段。PreInputMethod 是实现子输入法最常用的方法之一。例如，插件可以定义触发键。当用户按下触发键时，它会设置一个标志并处理 PreInputMethod 阶段中的所有未来键事件，直到它结束其输入模式。

	As for the event type, there are input context specific events and global events. The input context specific events always associate with an input context.		As for the event type, there are input context specific events and global events. The input context specific events always associate with an input context.