libxkbcommon  1.8.1
Library implementing the XKB specification for parsing keyboard descriptions and handling keyboard state
Data Structures | Functions
Rules

Data Structures

struct  xkb_rule_names
 
struct  xkb_component_names
 

Functions

XKB_EXPORT bool xkb_component_names::xkb_components_names_from_rules (struct xkb_context *context, const struct xkb_rule_names *rmlvo_in, struct xkb_rule_names *rmlvo_out, struct xkb_component_names *components_out)
 

Detailed Description

Utility functions related to rules, whose purpose is introduced in: XKB the keyboard keymap configuration.

Function Documentation

◆ xkb_components_names_from_rules()

XKB_EXPORT bool xkb_components_names_from_rules ( struct xkb_context context,
const struct xkb_rule_names rmlvo_in,
struct xkb_rule_names rmlvo_out,
struct xkb_component_names components_out 
)

Resolve RMLVO names to KcCGST components.

This function is used primarily for debugging. See xkb_keymap::xkb_keymap_new_from_names() for creating keymaps from RMLVO names.

Parameters
[in]contextThe context in which to resolve the names.
[in]rmlvo_inThe RMLVO names to use.
[out]rmlvo_outThe RMLVO names actually used after resolving missing values.
[out]components_outThe KcCGST components resulting of the RMLVO resolution.

rmlvo_out and components can be omitted by using NULL, but not both.

If components is not NULL, it is filled with dynamically-allocated strings that should be freed by the caller.

Returns
true if the RMLVO names could be resolved, false otherwise.
See also
Introduction to RMLVO
Introduction to KcCGST
xkb_rule_names
xkb_component_names
xkb_keymap::xkb_keymap_new_from_names()
Since
1.9.0