From c36ee1a4db4e7876526190b8ab6b0da5867f76f7 Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Wed, 9 Jul 2014 23:26:37 -0700 Subject: [PATCH] specs/XKB: Manual fixup of symbol name markup Handles typos that caused the scripts to miss matches, misnamed masks, etc. Signed-off-by: Alan Coopersmith --- specs/XKB/ch01.xml | 2 +- specs/XKB/ch02.xml | 2 +- specs/XKB/ch06.xml | 2 +- specs/XKB/ch08.xml | 14 ++++----- specs/XKB/ch09.xml | 6 ++-- specs/XKB/ch10.xml | 14 ++++----- specs/XKB/ch11.xml | 6 ++-- specs/XKB/ch13.xml | 2 +- specs/XKB/ch14.xml | 2 +- specs/XKB/ch15.xml | 4 +-- specs/XKB/ch16.xml | 50 ++++++++++++++--------------- specs/XKB/ch17.xml | 2 +- specs/XKB/ch18.xml | 4 +-- specs/XKB/ch19.xml | 10 +++--- specs/XKB/ch21.xml | 78 +++++++++++++++++++++++++--------------------- 15 files changed, 102 insertions(+), 96 deletions(-) diff --git a/specs/XKB/ch01.xml b/specs/XKB/ch01.xml index 8a47f07c..262a9f97 100644 --- a/specs/XKB/ch01.xml +++ b/specs/XKB/ch01.xml @@ -379,7 +379,7 @@ generated. pointer to a structure - NULL + NULL Bool diff --git a/specs/XKB/ch02.xml b/specs/XKB/ch02.xml index 2a8defb6..2d71a46a 100644 --- a/specs/XKB/ch02.xml +++ b/specs/XKB/ch02.xml @@ -782,7 +782,7 @@ involve both a server connection (Display * The device identifier can specify any X input extension device with a -KeyClass +KeyClass component, or it can specify the constant, XkbUseCoreKbd. The use of diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml index d7cb06b0..f731a477 100644 --- a/specs/XKB/ch06.xml +++ b/specs/XKB/ch06.xml @@ -57,7 +57,7 @@ The may yield unpredictable results. The device_spec field specifies the device identifier of the keyboard input device, or -XkbUseCoreKeyboard, +XkbUseCoreKbd, which specifies the core keyboard device. The min_key_code and diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml index e6315bb4..8600af20 100644 --- a/specs/XKB/ch08.xml +++ b/specs/XKB/ch08.xml @@ -1028,9 +1028,9 @@ Xkb also allows applications to refer to indicators by name. Use to get the indicator names (see ). Using names eliminates the need for hard-coding bitmask values for particular keyboards. For example, instead of using vendor-specific constants such as -WSKBLed_ScrollLock +WSKBLed_ScrollLock mask on Digital workstations or -XLED_SCROLL_LOCK +XLED_SCROLL_LOCK on Sun workstations, you can instead use XkbGetNamedIndicator to look up information on the indicator named "Scroll Lock." @@ -1764,8 +1764,8 @@ To receive events for only specific indicators, use XkbSelectEventDetails. Set the event_type - parameter -to XkbIndicatorStateNotify + parameter to +XkbIndicatorStateNotify or XkbIndicatorMapNotify, and set both the @@ -1802,9 +1802,9 @@ typedef struct _XkbIndicatorNotify { or XkbIndicatorMapNotify, depending on whether the event is a -kbIndicatorStateNotify +XkbIndicatorStateNotify event or -kbIndicatorMapNotify +XkbIndicatorMapNotify, event. @@ -1823,7 +1823,7 @@ have changed. If the event is of type is a mask that specifies the current state of all indicators, whether they have changed or not, for both XkbIndicatorStateNotify - and IndicatorMapNotify events. + and XkbIndicatorMapNotify events. diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml index f0b60dbd..3dede6fe 100644 --- a/specs/XKB/ch09.xml +++ b/specs/XKB/ch09.xml @@ -252,9 +252,9 @@ feedback and keyboard feedback. Some of the functions in this section have parameters; set them as follows: Set bell_class to -BellFeedbackClass +BellFeedbackClass or -KbdFeedbackClass. +KbdFeedbackClass. A device can have more than one feedback of each type; set bell_id to the particular bell feedback of @@ -1088,7 +1088,7 @@ can call as the event_type and specifying -XkbAllBellNotifyMask +XkbAllBellEventsMask in bits_to_change and diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index d3e98f94..619d3ff1 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -2113,7 +2113,7 @@ To receive events under all possible conditions, use XkbSelectEvents (see section 4.3) and pass -XkbAccesXNotifyMask +XkbAccessXNotifyMask in both bits_to_change and @@ -4215,7 +4215,7 @@ operate; the The -XkbAX_AnyFeeback +XkbAX_AnyFeedback macro accepts a pointer to an XkbControlsRec structure and tells whether the @@ -4559,7 +4559,7 @@ the corresponding values are still updated in the X server. For example, the control is enabled (that is, the X server’s equivalent of xkb->ctrls has -XkbRepeatKeyMask +XkbRepeatKeysMask set in enabled_ctrls ). It is permissible to modify the attributes of a control in one call to @@ -4822,8 +4822,8 @@ and the is set to the type of event that caused the change (one of KeyPress, KeyRelease, -DeviceKeyPress, -DeviceKeyRelease, +DeviceKeyPress, +DeviceKeyRelease, ButtonPress or ButtonRelease @@ -4836,9 +4836,9 @@ and the is KeyPress, KeyRelease, -DeviceKeyPress, +DeviceKeyPress, or -DeviceKeyRelease, +DeviceKeyRelease, the keycode field is set to the key that caused the change. If diff --git a/specs/XKB/ch11.xml b/specs/XKB/ch11.xml index 3042aeb4..ef73b838 100644 --- a/specs/XKB/ch11.xml +++ b/specs/XKB/ch11.xml @@ -325,7 +325,7 @@ name is “ComposeFail”. When Xkb is initialized, it implicitly forces requests for -NewKeyboardNotify +NewKeyboardNotify events. These events may be used by the Xkb library extension internally; they are normally translated into core protocol MappingNotify @@ -333,7 +333,7 @@ are normally translated into core protocol client is appropriate in most cases, it is not appropriate for some clients that maintain per-key data structures. This is because once the server has sent a -NewKeyboardNotify +NewKeyboardNotify event, it is free to send the client events for all keys in the new range and that range may be outside of the per-key data structures the client is maintaining. @@ -344,7 +344,7 @@ maintaining. The IgnoreNewKeyboards control, if enabled, prevents Xkb from mapping -NewKeyboardNotify +NewKeyboardNotify events to core MappingNotify events and passing them to the client. The control is initially disabled. diff --git a/specs/XKB/ch13.xml b/specs/XKB/ch13.xml index 3e9dc9ba..89084e3d 100644 --- a/specs/XKB/ch13.xml +++ b/specs/XKB/ch13.xml @@ -93,7 +93,7 @@ as follows: The top-level keyboard geometry description includes a list of up to -MaxColors +XkbGeomMaxColors (32) color names. A color name is a string whose interpretation is not specified by Xkb. The diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml index 0c7cabe7..f43d6671 100644 --- a/specs/XKB/ch14.xml +++ b/specs/XKB/ch14.xml @@ -853,7 +853,7 @@ server and are always updated by the server whenever it returns the data for an - XkbVirtuawModsMask + XkbVirtualModsMask vmods server->vmods[*] diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index 65ce32d0..e885e757 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -2299,9 +2299,9 @@ The is four and groups only has -Group1Mask +XkbGroup1Mask and -Group3Mask +XkbGroup3Mask set, new_types_in looks like this: diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml index 26698bc8..ad1ddb59 100644 --- a/specs/XKB/ch16.xml +++ b/specs/XKB/ch16.xml @@ -553,7 +553,7 @@ have an associated data structure. -XKbSA_PtrBtn +XkbSA_PtrBtn XkbSA_LockPtrBtn XkbPtrBtnActionbtn @@ -601,7 +601,7 @@ have an associated data structure. XkbSA_DeviceBtn -XKbSA_LockDeviceBtn +XkbSA_LockDeviceBtn XkbDeviceBtnAction devbtn @@ -630,7 +630,7 @@ Actions associated with the typedef struct _XkbModAction { - unsigned char type; /* XkbSA_{Set|Latch|Lock}Mods */ + unsigned char type; /* XkbSA_{Set|Latch|Lock}Mods */ unsigned char flags; /* with type , controls the effect on modifiers */ unsigned char mask; /* same as mask field of a modifier description */ unsigned char real_mods; /* same as real_mods field of a modifier description */ @@ -1006,7 +1006,7 @@ Actions associated with the typedef struct _XkbGroupAction { - unsigned char type; /* XkbSA_{Set|Latch|Lock}Group */ + unsigned char type; /* XkbSA_{Set|Latch|Lock}Group */ unsigned char flags; /* with type , controls the effect on groups */ char group_XXX; /* represents a group index or delta */ } XkbGroupAction; @@ -1178,7 +1178,7 @@ the server sets the locked keyboard group to XkbSA_LatchToLock If set, and the action type is -SA_LatchGroup, +XkbSA_LatchGroup, the server locks the action group if it is already latched. @@ -1595,7 +1595,7 @@ pressed and released: typedef struct _XkbPtrBtnAction { - unsigned char type; /*XkbSA_PtrBtn, XkbSA_LockPtrBtn */ + unsigned char type; /* XkbSA_PtrBtn, XkbSA_LockPtrBtn */ unsigned char flags; /* with type , controls the effect on pointer buttons*/ unsigned char count; /* controls number of ButtonPress and ButtonRelease events */ unsigned char button; /* pointer button to simulate */ @@ -2119,7 +2119,7 @@ A key press sets the base group as specified by the bit of the flags field (see section Note). If no other actions are transformed by the -XkbISO_Lock +XkbSA_ISOLock action, a key release locks the group. Otherwise, a key release clears group set by the key press. @@ -2144,7 +2144,7 @@ If not set, any actions that occur simultaneously with the XkbSA_ISOLock action are treated as -XkbSA_LockMod +XkbSA_LockMods actions instead. @@ -2231,7 +2231,7 @@ the and vmods2 fields (see section 16.1.3). If no other actions are transformed by the -XkbISO_Lock +XkbSA_ISOLock action, a key release locks the action modifiers. Otherwise, a key release clears the base modifiers set by the key press. @@ -2269,7 +2269,7 @@ If not set, any actions that occur simultaneously with the XkbSA_ISOLock action are treated as -XkbSA_LockMod +XkbSA_LockMods actions instead. @@ -2371,7 +2371,7 @@ The - XkbSA_ISODNoAffectMods + XkbSA_ISONoAffectMods If XkbSA_ISONoAffectMods @@ -3003,7 +3003,7 @@ The as the event_type and specifying -XkbAllActionMessageMask +XkbAllActionMessagesMask in bits_to_change and @@ -3176,7 +3176,7 @@ The XkbSA_RedirectKey action normally redirects to another key on the same device as the key that caused the event, unless that device does not belong to the input extension -KeyClass, +KeyClass, in which case this action causes an event on the core keyboard device. (The input extension categorizes devices by breaking them into classes. Keyboards, and other input devices with keys, are classified as KeyClass devices by the @@ -3368,9 +3368,9 @@ provides the following convenience macros: Actions associated with XkbDeviceBtnAction structures generate -DeviceButtonPress +DeviceButtonPress and -DeviceButtonRelease +DeviceButtonRelease events instead of normal KeyPress and @@ -3380,7 +3380,7 @@ Actions associated with typedef struct _XkbDeviceBtnAction { - unsigned char type; /* XkbSA_DeviceBtn, XkbSA_LockDeviceBtn */ + unsigned char type; /* XkbSA_DeviceBtn, XkbSA_LockDeviceBtn */ unsigned char flags; /* with type , specifies locking or unlocking */ unsigned char count; /* controls number of DeviceButtonPress and Release events */ unsigned char button; /* index of button on device */ @@ -3426,13 +3426,13 @@ Otherwise, key presses cause one or more input extension device events instead of the usual key press event. If the count field is zero, a key press generates a single -DeviceButtonPress +DeviceButtonPress event. If count is greater than zero, a key press event generates count pairs of -DeviceButtonPress +DeviceButtonPress and -DeviceButtonRelease +DeviceButtonRelease events. @@ -3441,11 +3441,11 @@ of the usual key press event. If the If count is zero, a key release generates an input extension -DeviceButtonRelease +DeviceButtonRelease event that matches the event generated by the corresponding key press. If count is nonzero, a key release does not cause a -DeviceButtonRelease +DeviceButtonRelease event. Key releases never cause KeyRelease events. @@ -3471,7 +3471,7 @@ Otherwise, if the specified button is not locked and the bit is not set in the flags field, a key press generates an input extension -DeviceButtonPress +DeviceButtonPress event instead of a KeyPress event and locks the button. If the button is already locked or if @@ -3488,7 +3488,7 @@ If the corresponding key press was ignored, and if the bit is not set in the flags field, a key release generates an input extension -DeviceButtonRelease +DeviceButtonRelease event instead of a KeyRelease event and unlocks the button. If the corresponding key press locked a button, @@ -4003,7 +4003,7 @@ currently defined is: -#define XkbRG_AllowNone 0x80 +#define XkbKB_RGAllowNone 0x80 @@ -4086,7 +4086,7 @@ that is logically down and then processes the new key press event normally. If the key itself is logically down when pressed, the key press event is ignored, but the processing of the corresponding key release depends on the value of the -Xkb_RGAllowNone +XkbKB_RGAllowNone bit in flags. If it is set, the key release is processed normally; otherwise, the key diff --git a/specs/XKB/ch17.xml b/specs/XKB/ch17.xml index eba9d80c..388da5e8 100644 --- a/specs/XKB/ch17.xml +++ b/specs/XKB/ch17.xml @@ -438,7 +438,7 @@ structure specifies a symbol interpretation: typedef struct { KeySym sym; /* keysym of interest or NULL */ - unsigned char flags; /* XkbSI_AutoRepeat, XkbSI_LockingKey */ + unsigned char flags; /* XkbSI_AutoRepeat, XkbSI_LockingKey */ unsigned char match; /* specifies how mods is interpreted */ unsigned char mods; /* modifier bits, correspond to eight real modifiers */ unsigned char virtual_mod; /* 1 modifier to add to key virtual mod map */ diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml index 8a490166..0d67f107 100644 --- a/specs/XKB/ch18.xml +++ b/specs/XKB/ch18.xml @@ -915,8 +915,8 @@ fields in this event are interpreted as the like-named fields in an -When your application receives a X -kbNamesNotify +When your application receives a +XkbNamesNotify event, you can note the changed names in a changes structure using XkbNoteNameChanges. diff --git a/specs/XKB/ch19.xml b/specs/XKB/ch19.xml index 84a42638..37a2d62c 100644 --- a/specs/XKB/ch19.xml +++ b/specs/XKB/ch19.xml @@ -19,9 +19,9 @@ XChangeKeyboardDevice input extension request allows a client to designate an input extension keyboard device as the X keyboard, in which case the old X keyboard device becomes inaccessible except via the input device extension. In this case, core protocol -XMappingNotify +MappingNotify and input extension -XChangeDeviceNotify +XChangeDeviceNotify events are generated to notify all clients that a new keyboard with a new keymap has been designated. @@ -233,12 +233,12 @@ and Notification of geometry changes wanted - XkbNKN_DeviceIDMask + XkbNKN_DeviceIDMask (1L<<2) Notification of device ID changes wanted - XkbNKN_AllChangesMask + XkbAllNewKeyboardEventsMask (0x7) Includes all of the above masks @@ -290,7 +290,7 @@ If the keyboard change is the result of an X Input Extension contains the input extension major opcode, and req_minor contains the input extension request number for -X_ChangeKeyboardDevice. +X_ChangeKeyboardDevice. In this case, device and diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml index b26fe246..0fb48620 100644 --- a/specs/XKB/ch21.xml +++ b/specs/XKB/ch21.xml @@ -10,7 +10,7 @@ input extension. Other types of devices supported by the input extension include, but are not limited to: mice, tablets, touchscreens, barcode readers, button boxes, trackballs, identifier devices, data gloves, and eye trackers. Xkb provides additional control over all X input extension devices, whether -they are KeyClass +they are KeyClass devices or not, as well as the core keyboard and pointer. @@ -59,14 +59,14 @@ the following additional access is provided: If allowed, Xkb functionality for additional -KeyClass +KeyClass devices supported by the input extension is accessed via those same functions. If allowed, Xkb functionality for non- -KeyClass +KeyClass devices supported by the input extension is also accessed via the XkbGetDeviceInfo and XkbSetDeviceInfo functions described in this chapter. @@ -77,9 +77,9 @@ XkbGetDeviceInfo and XkbSetDeviceInfo functions described in this chapter. Each device has an X Input Extension device ID. Each device may have several classes of feedback. For example, there are two types of feedbacks that can generate bells: bell feedback and keyboard feedback ( -BellFeedbackClass +BellFeedbackClass and -KbdFeedbackClass +KbdFeedbackClass ). A device can have more than one feedback of each type; the feedback ID identifies the particular feedback within its class. @@ -124,7 +124,7 @@ If the input extension is present and the server allows interaction between the input extension and Xkb, then the core keyboard, the core keyboard indicators, and the core keyboard bells may each be addressed using an appropriate device spec, class, and ID. The constant -XkbXIDfltID +XkbDfltXIId may be used as the device ID to specify the core keyboard indicators for the core indicator feedback. The particular device ID corresponding to the core keyboard feedback and the core indicator feedback may be obtained by calling @@ -142,11 +142,11 @@ keyboard feedback and the core indicator feedback may be obtained by calling If the server does not allow Xkb access to input extension -KeyClass +KeyClass devices, attempts to use Xkb requests with those devices fail with a BadKeyboard error. Attempts to access non- -KeyClass +KeyClass input extension devices via XkbGetDeviceInfo and XkbSetDeviceInfo fail silently if Xkb access to those devices is not supported by the X server. @@ -201,7 +201,7 @@ The type field is a registered symbolic name for a class of devices (for example, "TABLET"). If a device is a keyboard (that is, is a member of -KeyClass +KeyClass ), it has its own state, and has_own_state is @@ -246,7 +246,7 @@ functions described subsequently in this section. (1L << 0) Clients can use all Xkb requests and events with -KeyClass +KeyClass devices supported by the input device extension. @@ -259,7 +259,7 @@ devices supported by the input device extension. (1L <<1) Clients can assign key actions to buttons on non- -KeyClass +KeyClass input extension devices. @@ -269,7 +269,7 @@ input extension devices. (1L <<2) Clients can assign names to indicators on non- -KeyClass +KeyClass input extension devices. @@ -279,7 +279,7 @@ Clients can assign names to indicators on non- (1L <<3) Clients can assign indicator maps to indicators on non- -KeyClass +KeyClass input extension devices. @@ -289,7 +289,7 @@ Clients can assign indicator maps to indicators on non- (1L <<4) Clients can request the status of indicators on non- -KeyClass +KeyClass input extension devices. @@ -302,9 +302,9 @@ Clients can request the status of indicators on non- (0x1c) -XkbXI_IndicatorNames­Mask | -XkbXI_IndicatorMaps­Mask | -XkbXI_IndicatorState­Mask +XkbXI_IndicatorNames­Mask | +XkbXI_IndicatorMaps­Mask | +XkbXI_IndicatorState­Mask @@ -318,8 +318,8 @@ Clients can request the status of indicators on non- Those selected by Value column masks (0x1e) -XkbXI_Indicators­Mask | -XkbSI_ButtonActions­Mask +XkbXI_Indicators­Mask | +XkbXI_ButtonActions­Mask @@ -327,8 +327,8 @@ Clients can request the status of indicators on non- Those selected by Value column masks (0x1f) -XkbSI_AllDevice­FeaturesMask | -XkbSI_Keyboards­Mask +XkbXI_AllDevice­FeaturesMask | +XkbXI_Keyboards­Mask @@ -336,8 +336,8 @@ Clients can request the status of indicators on non- Those selected by Value column masks (0x801f) -XkbXI_AllFeatures­Mask | -XkbXI_Unsupported­FeaturesMask +XkbXI_AllFeatures­Mask | +XkbXI_Unsupported­FeaturesMask @@ -367,7 +367,7 @@ them. To determine whether the X server allows Xkb access to particular capabilities of input devices other than the core X keyboard, or to determine the status of indicator maps, indicator names or button actions on a non- -KeyClass +KeyClass extension device, use XkbGetDeviceInfo. @@ -496,7 +496,7 @@ the server implementation, and a client may modify the associated behavior. If the -XkbButtonActionsMask +XkbXI_ButtonActionsMask bit is set in which, the @@ -510,10 +510,12 @@ the If which - includes one of the bits in XkbXI_IndicatorsMask, the feedback class of the + includes one of the bits in XkbXI_IndicatorsMask, +the feedback class of the indicators must be specified in ind_class, and the feedback ID of the indicators must be specified in ind_id. If the request does not include any of -the bits in XkbXI_IndicatorsMask, the ind_class and ind_id parameters are +the bits in XkbXI_IndicatorsMask, +the ind_class and ind_id parameters are ignored. The class and ID can be obtained via the input device extension XListInputDevices request. @@ -1321,7 +1323,8 @@ the value of which determines which subcomponents are freed. which is an inclusive OR of one or more of the values from Table 21.1. If which -contains XkbXI_ButtonActionsMask, all button actions associated with +contains XkbXI_ButtonActionsMask, + all button actions associated with device_info are freed, device_info @@ -1333,7 +1336,8 @@ and device_info -> num_btns - is set to zero. If which contains all bits in XkbXI_IndicatorsMask, all + is set to zero. If which contains all bits in +XkbXI_IndicatorsMask, all XkbDeviceLedInfoRec structures associated with device_info @@ -1351,14 +1355,16 @@ and device_info -> num_leds - are set to zero. If which contains XkbXI_IndicatorMapsMask, all indicator maps -associated with + are set to zero. If which contains XkbXI_IndicatorMapsMask, + all indicator maps associated with device_info are cleared, but the number of LEDs and the leds structures themselves are -preserved. If which contains XkbXI_IndicatorNamesMask, all indicator names +preserved. If which contains XkbXI_IndicatorNamesMask, +all indicator names associated with device_info are cleared, but the number of LEDs and the leds structures themselves are preserved. If which contains -XkbXI_IndicatorStateMask, the indicator state associated with the +XkbXI_IndicatorStateMask, +the indicator state associated with the device_info leds are set to zeros but the number of LEDs and the leds structures themselves are preserved. @@ -1548,7 +1554,7 @@ If the number of buttons requested to be updated is not valid for the device, If the -XkbXI_IndicatorMaps +XkbXI_IndicatorMapsMask and / or XkbXI_IndicatorNamesMask bit is set in the supported mask returned by XkbGetDeviceInfo, the Xkb @@ -1788,7 +1794,7 @@ The as the event_type and specifying -XkbAllExtensionDeviceMask +XkbAllExtensionDeviceEventsMask in bits_to_change and @@ -1844,7 +1850,7 @@ state or configuration. Changes to an Xkb extension device may be tracked by listening to -XkbDeviceExtensionNotify +XkbExtensionDeviceNotify events and accumulating the changes in an XkbDeviceChangesRec structure. The changes noted in the structure may then be used in subsequent