diff --git a/specs/XKB/ch02.xml b/specs/XKB/ch02.xml index e1e43ab5..6a17924b 100644 --- a/specs/XKB/ch02.xml +++ b/specs/XKB/ch02.xml @@ -407,7 +407,7 @@ the X keyboard extension. In all cases, upon return and minor_in_out are not -NULL, +NULL, XkbOpenDisplay first calls XkbLibraryVersion @@ -424,7 +424,7 @@ If the library is incompatible, minor_in_out with the major and minor extension versions of the library being used and returns -NULL. +NULL. If the library is compatible, XkbOpenDisplay next calls @@ -432,7 +432,7 @@ next calls with the display_name. If this fails, the function returns -NULL. +NULL. If successful, XkbOpenDisplay calls @@ -446,7 +446,7 @@ If the server extension version is not compatible with the library extension version or if the server extension is not present, XkbOpenDisplay closes the display and returns -NULL. +NULL. When successful, the function returns the display connection. @@ -749,11 +749,11 @@ Where a connection to the server is passed as an argument (Display*) and an field of the XkbDescRec must be -NULL. +NULL. If they don’t match or the dpy field is not -NULL, +NULL, a BadMatch error is returned (either in the return value or a backfilled diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml index f1494292..f2dd66cc 100644 --- a/specs/XKB/ch06.xml +++ b/specs/XKB/ch06.xml @@ -258,7 +258,7 @@ server for those components specified in the and copies the results to the XkbDescRec it allocated. The remaining fields in the keyboard description are set to -NULL. +NULL. The valid masks for which are those listed in Table 6.2. @@ -320,7 +320,7 @@ or If XkbAllocKeyboard fails to allocate the keyboard description, it returns -NULL. +NULL. Otherwise, it returns a pointer to an empty keyboard description structure. The device_spec @@ -392,14 +392,14 @@ To destroy either an entire an specified by which and sets the corresponding values to -NULL. +NULL. If free_all is True, XkbFreeKeyboard frees every non- -NULL +NULL component of xkb and then frees the diff --git a/specs/XKB/ch07.xml b/specs/XKB/ch07.xml index 26449c27..ae0166f9 100644 --- a/specs/XKB/ch07.xml +++ b/specs/XKB/ch07.xml @@ -305,7 +305,7 @@ The bit (0 relative) of the mask represents the i-th virtual modifier. If mask_rtrn is non- -NULL, +NULL, XkbVirtualModsToReal backfills it with the resulting real modifier mask. If the keyboard description in diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml index d0f19488..a28ef4fd 100644 --- a/specs/XKB/ch08.xml +++ b/specs/XKB/ch08.xml @@ -994,7 +994,7 @@ If the field of the desc parameter is -NULL, +NULL, XkbGetIndicatorMap allocates and initializes it. @@ -1183,7 +1183,7 @@ indicator is mapped to a physical LED, the Each of the " _rtrn " arguments is optional; you can pass -NULL +NULL for any unneeded " _rtrn " arguments. @@ -1547,7 +1547,7 @@ If and the optional parameter, state, is not -NULL, +NULL, XkbSetNamedIndicator tells the server to change the state of the named indicator to the value specified by @@ -1574,7 +1574,7 @@ the name specified by If the optional parameter, map, is not -NULL, +NULL, XkbSetNamedIndicator tells the server to change the indicator’s map to the values specified in map. @@ -1989,7 +1989,7 @@ If the field of xkb is -NULL, +NULL, XkbGetIndicatorChanges allocates and initializes it. To free the indicators @@ -2103,7 +2103,7 @@ To free memory used by the If the indicators member of the keyboard description record pointed to by xkb -is not NULL, +is not NULL, XkbFreeIndicatorMaps frees the memory associated with the indicators diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml index 247ff2ba..df10b3cc 100644 --- a/specs/XKB/ch09.xml +++ b/specs/XKB/ch09.xml @@ -429,7 +429,7 @@ To ring the bell on an X input extension device or the default keyboard, use - a name for the bell, or NULL + a name for the bell, or NULL @@ -538,7 +538,7 @@ default keyboard: - a bell name, or NULL + a bell name, or NULL @@ -701,7 +701,7 @@ without ringing the corresponding bell, use - a bell name, or NULL + a bell name, or NULL @@ -796,7 +796,7 @@ the keyboard without ringing the bell: - a bell name, or NULL + a bell name, or NULL @@ -1033,7 +1033,7 @@ and = None, and name = -NULL, +NULL, and returns what XkbForceDeviceBell returns. diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index 4bd6c560..a37a4642 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -990,7 +990,7 @@ use and waits for a reply. If supported_rtrn is not -NULL, +NULL, it backfills supported_rtrn with True if the server supports @@ -1086,7 +1086,7 @@ and off it ; it then waits for a reply. If supported_rtrn is not -NULL, +NULL, XkbSetDetectableAutorepeat backfills supported_rtrn @@ -4381,7 +4381,7 @@ If -> ctrls is -NULL, +NULL, XkbGetControls allocates and initializes it before obtaining the values specified by which. @@ -4390,7 +4390,7 @@ If -> ctrls is not -NULL, +NULL, XkbGetControls modifies only those portions of xkb @@ -4412,7 +4412,7 @@ If if xkb is -NULL +NULL or which is empty, or @@ -4533,7 +4533,7 @@ If -> ctrls is -NULL, +NULL, the server does not support a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbSetControls @@ -4993,7 +4993,7 @@ results into the field of xkb is -NULL, +NULL, XkbGetControlsChanges allocates and initializes it. To free the ctrls @@ -5079,14 +5079,14 @@ allocate one by calling If the ctrls field is not -NULL, +NULL, XkbAllocControls simply returns Success. If xkb is -NULL, +NULL, XkbAllocControls reports a BadMatch @@ -5173,7 +5173,7 @@ structure, use field in the xkb keyboard description and sets the corresponding structure component values to -NULL +NULL or zero. The @@ -5192,7 +5192,7 @@ If True, XkbFreeControls frees every non- -NULL +NULL structure component in the controls, frees the XkbControlsRec structure referenced by the @@ -5202,7 +5202,7 @@ If and sets ctrls to -NULL. +NULL. diff --git a/specs/XKB/ch12.xml b/specs/XKB/ch12.xml index c459ec23..4b8e0be8 100644 --- a/specs/XKB/ch12.xml +++ b/specs/XKB/ch12.xml @@ -588,7 +588,7 @@ being held down. state. buf is -NULL +NULL terminated unless there’s an overflow. If the string returned is larger than nbytes, a count of bytes that does not fit into the buffer is returned in extra_rtrn. diff --git a/specs/XKB/ch13.xml b/specs/XKB/ch13.xml index ce160608..32434b2a 100644 --- a/specs/XKB/ch13.xml +++ b/specs/XKB/ch13.xml @@ -277,7 +277,7 @@ A list of one or more outlines (described below). Optional pointers to a primary and an approximation outline (described below). If either of these pointers is -NULL, +NULL, the default primary/approximation outline is the first one in the list of outlines for the shape. @@ -339,7 +339,7 @@ shape’s list of outlines. If the field of the XkbShapeRec structure is not -NULL, +NULL, it points to the primary outline. A rectangular approximation must be included for nonrectangular keys as one of the outlines associated @@ -846,7 +846,7 @@ If and/or primary is -NULL, +NULL, the default value is used. The default primary outline is the first element in the outlines array, as is the default approximating outline. @@ -1289,11 +1289,11 @@ shape. The top surface is defined to be the approximating outline if the field of shape is not -NULL. +NULL. If approx is -NULL, +NULL, the top surface is defined as the last outline in the shape ’s array of outlines. @@ -1303,7 +1303,7 @@ the top surface is defined as the last outline in the if shape is -NULL +NULL or if there are no outlines for the shape; otherwise, it returns True. @@ -1360,7 +1360,7 @@ those outlines. if shape is -NULL +NULL or if there are no outlines for the shape; otherwise, it returns True. @@ -1428,7 +1428,7 @@ and updates the bounding box of the row if necessary. returns False if any of the arguments is -NULL +NULL ; otherwise, it returns True. @@ -1485,7 +1485,7 @@ that section. To update the bounding box of a section, use returns False if any of the arguments is -NULL +NULL ; otherwise, it returns True. @@ -1644,7 +1644,7 @@ To add one property to an existing keyboard geometry description, use to the keyboard geometry specified by geom. XkbAddGeomProperty returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space for the property. To allocate space for an arbitrary number of properties, use the XkbAllocGeomProps function. @@ -1710,7 +1710,7 @@ To add one key alias to an existing keyboard geometry description, use it with the key whose real name is real. XkbAddGeomKeyAlias returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space for the alias. To allocate space for an arbitrary number of aliases, use the XkbAllocGeomKeyAliases function. @@ -1791,7 +1791,7 @@ A color using their indices in this global list or pointers to colors in this list. XkbAddGeomColor returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space for the color. To allocate space for an arbitrary number of colors to a geometry, use the @@ -1850,7 +1850,7 @@ An outline consists of an arbitrary number of points. points for it. The new outline is allocated and zeroed. XkbAddGeomOutline returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space. To allocate space for an arbitrary number of outlines to a shape, use XkbAllocGeomOutlines. @@ -1924,7 +1924,7 @@ an arbitrary number of outlines. already exists in the geometry, a pointer to the existing shape is returned. XkbAddGeomShape returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space. To allocate space for an arbitrary number of geometry shapes, use XkbAllocGeomShapes. @@ -1969,7 +1969,7 @@ Keys are grouped into rows. The key is allocated and zeroed. XkbAddGeomKey returns -NULL +NULL if row is empty or if it was not able to allocate space for the key. To allocate @@ -2074,7 +2074,7 @@ If a section with name returned. XkbAddGeomSection returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space for the section. To allocate space for an arbitrary number of sections to a geometry, use XkbAllocGeomSections. @@ -2134,7 +2134,7 @@ The newly created row contains space for the number of keys specified in They are allocated and zeroed, but otherwise uninitialized. XkbAddGeomRow returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space for the row. To allocate space for an arbitrary number of rows to a section, use the XkbAllocGeomRows function. @@ -2205,25 +2205,25 @@ section. adds a doodad with name specified by name to the geometry geom if section is -NULL +NULL or to the section of the geometry specified by section if section is not -NULL. +NULL. XkbAddGeomDoodad returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space for the doodad. If there is already a doodad with the name name in the doodad array for the geometry (if section is -NULL +NULL ) or the section (if section is non- -NULL +NULL ), a pointer to that doodad is returned. To allocate space for an arbitrary number of doodads to a section, use the XkbAllocGeomSectionDoodads function. To allocate space for an arbitrary number of doodads to a keyboard geometry, use @@ -2296,7 +2296,7 @@ overlay with name returned. XkbAddGeomOverlay returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space for the overlay. To allocate space for an arbitrary number of overlays to a section, use the XkbAllocGeomOverlay function. @@ -2368,11 +2368,11 @@ The new row contains space for specifies a row that doesn’t exist on the underlying section, XkbAddGeomOverlayRow returns -NULL +NULL and doesn’t change the overlay. XkbAddGeomOverlayRow returns -NULL +NULL if any of the parameters is empty or if it was not able to allocate space for the overlay. @@ -2442,7 +2442,7 @@ If there is no key named in the row of the underlying section, XkbAddGeomOverlayKey returns -NULL. +NULL. diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml index 3117b338..33a65104 100644 --- a/specs/XKB/ch14.xml +++ b/specs/XKB/ch14.xml @@ -328,7 +328,7 @@ reply, and then returns. If successful, structure it allocated. If unsuccessful, XkbGetMap returns -NULL. +NULL. When unsuccessful, one of the following protocol errors is also generated: BadAlloc (unable to allocate the @@ -1264,7 +1264,7 @@ of entries necessary for If the client map of the keyboard description is not -NULL, +NULL, and any fields are already allocated in the client map, XkbAllocClientMap does not overwrite the existing values; it simply ignores that part of the @@ -1365,7 +1365,7 @@ To free memory used by the client map member of an structure specified by the xkb parameter and sets the corresponding structure component values to -NULL. +NULL. The which parameter specifies a combination of the client map masks shown in @@ -1382,7 +1382,7 @@ If is ignored; XkbFreeClientMap frees every non- -NULL +NULL structure component in the client map, frees the XkbClientMapRec structure referenced by the @@ -1392,7 +1392,7 @@ If parameter, and sets the map member to -NULL. +NULL. @@ -1554,7 +1554,7 @@ field of the server map. If the server map of the keyboard description is not -NULL +NULL and any fields are already allocated in the server map, XkbAllocServerMap does not overwrite the existing values. The only exception is with the @@ -1652,7 +1652,7 @@ The structure specified by the xkb parameter and sets the corresponding structure component values to -NULL. +NULL. The which parameter specifies a combination of the server map masks and is a bitwise @@ -1665,7 +1665,7 @@ inclusive OR of the masks listed in is ignored and XkbFreeServerMap frees every non- -NULL +NULL structure component in the server map, frees the XkbServerMapRec structure referenced by the @@ -1675,7 +1675,7 @@ inclusive OR of the masks listed in parameter, and sets the server member to -NULL. +NULL. diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index 6077c327..ba963eb1 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -83,7 +83,7 @@ typedef struct { /* Key Type */ modify directly */ unsigned char map_count; /* # entries in map, preserve - (if non- NULL) */ + (if non-NULL) */ XkbKTMapEntryPtr map; /* vector of modifiers for each shift level */ XkbModsPtr preserve; /* mods to preserve for corresponding @@ -207,7 +207,7 @@ an optional field. If a preserve member of a key type is not -NULL, +NULL, it represents a list of modifiers where each entry corresponds directly to one of the key type’s map. @@ -364,7 +364,7 @@ Because the modifier is to be preserved for further event processing, the preserve list is not -NULL +NULL and parallels the map list. All @@ -955,7 +955,7 @@ can be zero or greater. If and preserve entries for the type if they exist and sets them to -NULL. +NULL. @@ -979,7 +979,7 @@ the the preserve field is freed if necessary and set to -NULL. +NULL. @@ -2242,7 +2242,7 @@ initializes any new symbols or actions to as appropriate. If the p_changes parameter is not -NULL, +NULL, XkbChangeTypesOfKey adds the XkbKeySymsMask @@ -2360,7 +2360,7 @@ If the Xkb extension has not been properly initialized, If the xkb parameter it not valid (that is, it is -NULL +NULL or it does not contain a valid client map), XkbChangeTypesOfKey returns @@ -2501,7 +2501,7 @@ If any allocation errors occur while resizing the number of symbols bound to the key, XkbResizeKeySyms returns -NULL. +NULL. A change to the number of symbols bound to a key should be diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml index eaa6887c..0ec44ca0 100644 --- a/specs/XKB/ch16.xml +++ b/specs/XKB/ch16.xml @@ -3086,9 +3086,9 @@ keyboard focus. However, the The message field is set to the message specified in the action and is guaranteed to be -NULL +NULL -terminated; the Xkb extension forces a -NULL +NULL into message [ @@ -3940,7 +3940,7 @@ If any allocation errors occur while resizing the number of actions bound to the key, XkbResizeKeyActions returns -NULL. +NULL. A change to the number of actions bound to a key should be diff --git a/specs/XKB/ch17.xml b/specs/XKB/ch17.xml index 284a724e..3e774892 100644 --- a/specs/XKB/ch17.xml +++ b/specs/XKB/ch17.xml @@ -437,7 +437,7 @@ structure specifies a symbol interpretation: typedef struct { - KeySym sym; /* keysym of interest or NULL */ + KeySym sym; /* keysym of interest or NULL */ 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 */ @@ -450,7 +450,7 @@ typedef struct { If sym is not -NULL, +NULL, it limits the symbol interpretation to keys on which that particular keysym is selected by the modifiers matching the criteria specified by mods @@ -459,7 +459,7 @@ is selected by the modifiers matching the criteria specified by If sym is -NULL, +NULL, the interpretation may be applied to any symbol selected on a key when the modifiers match the criteria specified by mods @@ -890,7 +890,7 @@ work space, field of the xkb argument is non- -NULL +NULL and does not match the display argument, and @@ -1162,7 +1162,7 @@ for groups 1 and 2 using the rules specified by the Xkb protocol and places them in xkb_syms_rtrn, which will be non- -NULL. +NULL. @@ -1492,7 +1492,7 @@ If it (re)applies the compatibility map to all of the keys on the keyboard. If changes is non- -NULL, +NULL, it reports the parts of the keyboard that were affected (unless updateMap is @@ -1500,7 +1500,7 @@ it reports the parts of the keyboard that were affected (unless not much changes). XkbAddSymInterpret returns a pointer to the actual new symbol interpretation in the list or -NULL +NULL if it failed. @@ -1740,7 +1740,7 @@ added, use if xkb is -NULL, +NULL, or BadAlloc if errors are encountered when attempting to allocate storage. @@ -1821,7 +1821,7 @@ in section True, which is ignored, all non- -NULL +NULL compatibility map components are freed, and the compat field in the @@ -1829,7 +1829,7 @@ in section referenced by xkb is set to -NULL. +NULL. diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml index 56f7b125..2687c06b 100644 --- a/specs/XKB/ch18.xml +++ b/specs/XKB/ch18.xml @@ -431,7 +431,7 @@ If the field of the keyboard description xkb is -NULL, +NULL, XkbGetNames allocates and initializes the names @@ -442,7 +442,7 @@ If the field of xkb is not -NULL, +NULL, XkbGetNames obtains the values specified by which @@ -457,7 +457,7 @@ If the component of the xkb parameter is -NULL, +NULL, XkbGetNames does not retrieve type or shift level names, even if XkbKeyTypeNamesMask diff --git a/specs/XKB/ch20.xml b/specs/XKB/ch20.xml index fa892d86..75e95d09 100644 --- a/specs/XKB/ch20.xml +++ b/specs/XKB/ch20.xml @@ -256,7 +256,7 @@ composed of characters from the ISO * ’, and characters permitted in a component class or member name (see section 20.1). A pattern may be -NULL, +NULL, in which case no components for that type is returned. Pattern matches with component names are case sensitive. The ‘ ? @@ -786,7 +786,7 @@ independent of any actual device. The server parses all non- -NULL +NULL fields in names and uses them to build a keyboard description. However, before parsing the @@ -807,7 +807,7 @@ possible bits in If a required component has not been specified in the names structure (the corresponding field is -NULL +NULL ), the server substitutes the expression " % ", resulting in the component values being taken from @@ -821,7 +821,7 @@ the server modifies if necessary (again using a " % " entry) to ensure all of the following fields are non- -NULL +NULL : types, keycodes, @@ -1092,7 +1092,7 @@ There is no way to determine which components specified in XkbGetKeyboardByName is synchronous; it sends the request to the server to build a new keyboard description and waits for the reply. If successful, the return value is -non-NULL. +non-NULL. XkbGetKeyboardByName generates a BadMatch protocol error if errors are encountered when building the keyboard @@ -1170,7 +1170,7 @@ keyboard device. It calls ( dpy, device_spec, -NULL, +NULL, which, which, False diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml index 28d87ae1..fe22ce46 100644 --- a/specs/XKB/ch21.xml +++ b/specs/XKB/ch21.xml @@ -1183,7 +1183,7 @@ if are inappropriate, XkbAddDeviceLedInfo returns -NULL. +NULL. @@ -1244,7 +1244,7 @@ To allocate additional space for button actions in an -> btn_acts is set to -NULL. +NULL. If device_info is invalid or new_total is greater than 255, BadValue is returned. If a memory allocation failure occurs, a @@ -1328,7 +1328,7 @@ contains XkbXI_ButtonActionsMask, all button actions associated with -> btn_acts is set to -NULL, +NULL, and device_info -> @@ -1342,7 +1342,7 @@ and -> leds is set to -NULL, +NULL, and device_info ->