From 998f64c6c986feee7a745a5169152025b229c6d8 Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Sat, 4 Dec 2010 15:31:21 -0800 Subject: spec: Make event names in text hyperlinks to event definition sections Started by taking list of event names and generating a list of perl commands such as: s{^\KeyPress\}{KeyPress}g; and running that with perl -i -p /tmp/e.pl *.xml Many of those changes were then manually reverted to avoid having the same link appear multiple times in a paragraph or to avoid having the definition sections link to themselves. Signed-off-by: Alan Coopersmith --- specs/encoding.xml | 66 ++++++++--------- specs/sect1-9.xml | 204 ++++++++++++++++++++++++++--------------------------- 2 files changed, 135 insertions(+), 135 deletions(-) diff --git a/specs/encoding.xml b/specs/encoding.xml index c703d2f..8161dc7 100644 --- a/specs/encoding.xml +++ b/specs/encoding.xml @@ -2793,7 +2793,7 @@ VISUALTYPE Events -KeyPress +KeyPress 1 2 code 1 KEYCODE detail 2 CARD16 sequence number @@ -2810,7 +2810,7 @@ VISUALTYPE 1 BOOL same-screen 1 unused -KeyRelease +KeyRelease 1 3 code 1 KEYCODE detail 2 CARD16 sequence number @@ -2827,7 +2827,7 @@ VISUALTYPE 1 BOOL same-screen 1 unused -ButtonPress +ButtonPress 1 4 code 1 BUTTON detail 2 CARD16 sequence number @@ -2844,7 +2844,7 @@ VISUALTYPE 1 BOOL same-screen 1 unused -ButtonRelease +ButtonRelease 1 5 code 1 BUTTON detail 2 CARD16 sequence number @@ -2861,7 +2861,7 @@ VISUALTYPE 1 BOOL same-screen 1 unused -MotionNotify +MotionNotify 1 6 code 1 detail 0 Normal @@ -2880,7 +2880,7 @@ VISUALTYPE 1 BOOL same-screen 1 unused -EnterNotify +EnterNotify 1 7 code 1 detail 0 Ancestor @@ -2908,7 +2908,7 @@ VISUALTYPE #x02 same-screen (1 is True, 0 is False) #xFC unused -LeaveNotify +LeaveNotify 1 8 code 1 detail 0 Ancestor @@ -2936,7 +2936,7 @@ VISUALTYPE #x02 same-screen (1 is True, 0 is False) #xFC unused -FocusIn +FocusIn 1 9 code 1 detail 0 Ancestor @@ -2956,7 +2956,7 @@ VISUALTYPE 3 WhileGrabbed 23 unused -FocusOut +FocusOut 1 10 code 1 detail 0 Ancestor @@ -2976,12 +2976,12 @@ VISUALTYPE 3 WhileGrabbed 23 unused -KeymapNotify +KeymapNotify 1 11 code 31 LISTofCARD8 keys (byte for keycodes 0-7 is omitted) -Expose +Expose 1 12 code 1 unused 2 CARD16 sequence number @@ -2993,7 +2993,7 @@ VISUALTYPE 2 CARD16 count 14 unused -GraphicsExposure +GraphicsExposure 1 13 code 1 unused 2 CARD16 sequence number @@ -3007,7 +3007,7 @@ VISUALTYPE 1 CARD8 major-opcode 11 unused -NoExposure +NoExposure 1 14 code 1 unused 2 CARD16 sequence number @@ -3016,7 +3016,7 @@ VISUALTYPE 1 CARD8 major-opcode 21 unused -VisibilityNotify +VisibilityNotify 1 15 code 1 unused 2 CARD16 sequence number @@ -3027,7 +3027,7 @@ VISUALTYPE 2 FullyObscured 23 unused -CreateNotify +CreateNotify 1 16 code 1 unused 2 CARD16 sequence number @@ -3041,7 +3041,7 @@ VISUALTYPE 1 BOOL override-redirect 9 unused -DestroyNotify +DestroyNotify 1 17 code 1 unused 2 CARD16 sequence number @@ -3049,7 +3049,7 @@ VISUALTYPE 4 WINDOW window 20 unused -UnmapNotify +UnmapNotify 1 18 code 1 unused 2 CARD16 sequence number @@ -3058,7 +3058,7 @@ VISUALTYPE 1 BOOL from-configure 19 unused -MapNotify +MapNotify 1 19 code 1 unused 2 CARD16 sequence number @@ -3067,7 +3067,7 @@ VISUALTYPE 1 BOOL override-redirect 19 unused -MapRequest +MapRequest 1 20 code 1 unused 2 CARD16 sequence number @@ -3075,7 +3075,7 @@ VISUALTYPE 4 WINDOW window 20 unused -ReparentNotify +ReparentNotify 1 21 code 1 unused 2 CARD16 sequence number @@ -3087,7 +3087,7 @@ VISUALTYPE 1 BOOL override-redirect 11 unused -ConfigureNotify +ConfigureNotify 1 22 code 1 unused 2 CARD16 sequence number @@ -3103,7 +3103,7 @@ VISUALTYPE 1 BOOL override-redirect 5 unused -ConfigureRequest +ConfigureRequest 1 23 code 1 stack-mode 0 Above @@ -3131,7 +3131,7 @@ VISUALTYPE #x0040 stack-mode 4 unused -GravityNotify +GravityNotify 1 24 code 1 unused 2 CARD16 sequence number @@ -3141,7 +3141,7 @@ VISUALTYPE 2 INT16 y 16 unused -ResizeRequest +ResizeRequest 1 25 code 1 unused 2 CARD16 sequence number @@ -3150,7 +3150,7 @@ VISUALTYPE 2 CARD16 height 20 unused -CirculateNotify +CirculateNotify 1 26 code 1 unused 2 CARD16 sequence number @@ -3162,7 +3162,7 @@ VISUALTYPE 1 Bottom 15 unused -CirculateRequest +CirculateRequest 1 27 code 1 unused 2 CARD16 sequence number @@ -3174,7 +3174,7 @@ VISUALTYPE 1 Bottom 15 unused -PropertyNotify +PropertyNotify 1 28 code 1 unused 2 CARD16 sequence number @@ -3186,7 +3186,7 @@ VISUALTYPE 1 Deleted 15 unused -SelectionClear +SelectionClear 1 29 code 1 unused 2 CARD16 sequence number @@ -3195,7 +3195,7 @@ VISUALTYPE 4 ATOM selection 16 unused -SelectionRequest +SelectionRequest 1 30 code 1 unused 2 CARD16 sequence number @@ -3209,7 +3209,7 @@ VISUALTYPE 0 None 4 unused -SelectionNotify +SelectionNotify 1 31 code 1 unused 2 CARD16 sequence number @@ -3222,7 +3222,7 @@ VISUALTYPE 0 None 8 unused -ColormapNotify +ColormapNotify 1 32 code 1 unused 2 CARD16 sequence number @@ -3235,7 +3235,7 @@ VISUALTYPE 1 Installed 18 unused -ClientMessage +ClientMessage 1 33 code 1 CARD8 format 2 CARD16 sequence number @@ -3243,7 +3243,7 @@ VISUALTYPE 4 ATOM type 20 data -MappingNotify +MappingNotify 1 34 code 1 unused 2 CARD16 sequence number diff --git a/specs/sect1-9.xml b/specs/sect1-9.xml index e7267d9..134f131 100644 --- a/specs/sect1-9.xml +++ b/specs/sect1-9.xml @@ -173,7 +173,7 @@ protocol does not define a mechanism for selecting interest in such events. Eventextension Extensionevent Every core event (with the exception of -KeymapNotify) +KeymapNotify) also contains the least significant 16 bits of the sequence number of the last request issued by the client that was (or is currently being) processed by the server. @@ -893,7 +893,7 @@ of "K". The standard rules for obtaining a KEYSYM from a -KeyPress +KeyPress KeyPress event make use of only the Group 1 and Group 2 KEYSYMs; no interpretation of other KEYSYMs in the list is defined. The modifier state determines which @@ -1542,7 +1542,7 @@ No geometry is defined among screens. The server may retain the recent history of pointer motion and do so to a finer granularity than is reported by -MotionNotify +MotionNotify events. The GetMotionEvents @@ -1858,7 +1858,7 @@ The server essentially acts as if InputOnly windows do not exist for the purposes of graphics requests, exposure processing, and -VisibilityNotify +VisibilityNotify events. An InputOnly @@ -2319,7 +2319,7 @@ in the displayed cursor. This request generates a -CreateNotify +CreateNotify event. @@ -2422,7 +2422,7 @@ However, only one client at a time can select for only one client at a time can select for ResizeRedirect, and only one client at a time can select for -ButtonPress. +ButtonPress. An attempt to violate these restrictions results in an Access error. @@ -2434,7 +2434,7 @@ client. Changing the colormap of a window (by defining a new map, not by changing the contents of the existing map) generates a -ColormapNotify +ColormapNotify event. Changing the colormap of a visible window might have no immediate effect on the screen (see @@ -2610,7 +2610,7 @@ an UnmapWindow request is performed automatically. The window and all inferiors are then destroyed, and a -DestroyNotify +DestroyNotify event is generated for each window. The ordering of the DestroyNotify @@ -2761,7 +2761,7 @@ window. The window is placed on top in the stacking order with respect to siblings. A -ReparentNotify +ReparentNotify event is then generated. The override-redirect attribute of the window is passed on in this event; a value of @@ -2831,11 +2831,11 @@ If the override-redirect attribute of the window is and some other client has selected SubstructureRedirect on the parent, then a -MapRequest +MapRequest event is generated, but the window remains unmapped. Otherwise, the window is mapped, and a -MapNotify +MapNotify event is generated. @@ -2917,7 +2917,7 @@ Errors: If the window is already unmapped, this request has no effect. Otherwise, the window is unmapped, and an -UnmapNotify +UnmapNotify event is generated. Normal exposure processing on formerly obscured windows is performed. @@ -3075,7 +3075,7 @@ If the override-redirect attribute of the window is and some other client has selected SubstructureRedirect on the parent, a -ConfigureRequest +ConfigureRequest event is generated, and no further processing is performed. Otherwise, the following is performed: @@ -3084,7 +3084,7 @@ If some other client has selected ResizeRedirect on the window and the inside width or height of the window is being changed, a -ResizeRequest +ResizeRequest event is generated, and the current inside width and height are used instead. Note that the override-redirect attribute of the window has no effect on @@ -3098,7 +3098,7 @@ on the window. The geometry of the window is changed as specified, the window is restacked among siblings, and a -ConfigureNotify +ConfigureNotify event is generated if the state of the window actually changes. If the inside width or height of the window has actually changed, then children of the window are affected, @@ -3198,11 +3198,11 @@ When a window with one of these win-gravities has its parent window resized, the corresponding pair defines the change in position of the window within the parent. This repositioning generates a -GravityNotify +GravityNotify event. GravityNotify events are generated after the -ConfigureNotify +ConfigureNotify event is generated. @@ -3243,11 +3243,11 @@ is like NorthWest, but the child is also unmapped when the parent is resized, and an -UnmapNotify +UnmapNotify event is generated. UnmapNotify events are generated after the -ConfigureNotify +ConfigureNotify event is generated. @@ -3427,10 +3427,10 @@ Errors: If some other client has selected SubstructureRedirect on the window, then a -CirculateRequest +CirculateRequest event is generated, and no further processing is performed. Otherwise, the following is performed, and then a -CirculateNotify +CirculateNotify event is generated if the window is actually restacked. @@ -3761,7 +3761,7 @@ it is tacked on to the end of the existing data. This request generates a -PropertyNotify +PropertyNotify event on the window. @@ -3810,7 +3810,7 @@ Errors: This request deletes the property from the specified window if the property exists and generates a -PropertyNotify +PropertyNotify event on the window unless the property does not exist. @@ -3936,7 +3936,7 @@ If delete is and the bytes-after is zero, the property is also deleted from the window, and a -PropertyNotify +PropertyNotify event is generated on the window. @@ -3991,7 +3991,7 @@ of property names (right for positive delta, left for negative delta). If delta mod N is nonzero, a -PropertyNotify +PropertyNotify event is generated for each property in the order listed. @@ -4114,7 +4114,7 @@ is not the same as the current owner and the current owner is not None, then the current owner is sent a -SelectionClear +SelectionClear event. @@ -4130,9 +4130,9 @@ The selection atom is uninterpreted by the server. The owner window is returned by the GetSelectionOwner request and is reported in -SelectionRequest +SelectionRequest and -SelectionClear +SelectionClear events. @@ -4237,11 +4237,11 @@ Errors: If the specified selection has an owner, the server sends a -SelectionRequest +SelectionRequest event to that owner. If no owner for the specified selection exists, the server generates a -SelectionNotify +SelectionNotify event to the requestor with property None. The arguments are passed on unchanged in either of the events. @@ -4499,9 +4499,9 @@ keep it contained in the window. This request generates -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events. @@ -4558,9 +4558,9 @@ the last-pointer-grab time or is later than the current server time. This request generates -EnterNotify +EnterNotify and -LeaveNotify +LeaveNotify events. @@ -4653,7 +4653,7 @@ the pointer is actively grabbed as described in GrabPointer, the last-pointer-grab time is set to the time at which the button was pressed (as transmitted in the -ButtonPress +ButtonPress event), and the ButtonPress event is reported if all of the following conditions are true: @@ -4894,9 +4894,9 @@ and if a generated key event would normally be reported to this client, it is reported normally. Otherwise, the event is reported with respect to the grab-window. Both -KeyPress +KeyPress and -KeyRelease +KeyRelease events are always reported, independent of any event selection made by the client. @@ -4932,9 +4932,9 @@ They are simply queued for later processing. This request generates -FocusIn +FocusIn and -FocusOut +FocusOut events. @@ -4989,9 +4989,9 @@ last-keyboard-grab time or is later than the current server time. This request generates -FocusIn +FocusIn and -FocusOut +FocusOut events. @@ -5063,7 +5063,7 @@ the keyboard is actively grabbed as described in GrabKeyboard, the last-keyboard-grab time is set to the time at which the key was pressed (as transmitted in the -KeyPress +KeyPress event), and the KeyPress event is reported if all of the following conditions are true: @@ -5245,9 +5245,9 @@ For SyncPointer, if the pointer is frozen and actively grabbed by the client, pointer event processing continues normally until the next -ButtonPress +ButtonPress or -ButtonRelease +ButtonRelease event is reported to the client, at which time the pointer again appears to freeze. However, if the reported event causes the pointer grab to be released, @@ -5292,9 +5292,9 @@ For SyncKeyboard, if the keyboard is frozen and actively grabbed by the client, keyboard event processing continues normally until the next -KeyPress +KeyPress or -KeyRelease +KeyRelease event is reported to the client, at which time the keyboard again appears to freeze. However, if the reported event causes the keyboard grab to be released, @@ -5327,11 +5327,11 @@ For SyncBoth, if both pointer and keyboard are frozen by the client, event processing (for both devices) continues normally until the next -ButtonPress, -ButtonRelease, -KeyPress, +ButtonPress, +ButtonRelease, +KeyPress, or -KeyRelease +KeyRelease event is reported to the client for a grabbed device (button event for the pointer, key event for the keyboard), at which time the devices again appear to freeze. @@ -5792,9 +5792,9 @@ the revert-to argument is ignored. This request generates -FocusIn +FocusIn and -FocusOut +FocusOut events. @@ -5814,9 +5814,9 @@ or None, the focus reverts to that value. When the focus reverts, -FocusIn +FocusIn and -FocusOut +FocusOut events are generated, but the last-focus-change time is not affected. @@ -7505,7 +7505,7 @@ request. The graphics-exposures flag controls -GraphicsExposure +GraphicsExposure event generation for CopyArea and @@ -8151,7 +8151,7 @@ Regardless of tiling and whether the destination is a window or a pixmap, if graphics-exposures in gc is True, then -GraphicsExposure +GraphicsExposure events for all corresponding destination regions are generated. @@ -8161,7 +8161,7 @@ but no GraphicsExposure events are generated, then a -NoExposure +NoExposure event is generated. @@ -9713,7 +9713,7 @@ or the colormap for the window is changed to None, and a -ColormapNotify +ColormapNotify event is generated. The protocol does not define the colors displayed for a window with a colormap of None. @@ -9821,7 +9821,7 @@ except that the required list must remain installed. If cmap is not already an installed map, a -ColormapNotify +ColormapNotify event is generated on every window having cmap as an attribute. In addition, for every other colormap that is installed or uninstalled as a result @@ -9893,7 +9893,7 @@ except that the required list must remain installed. If cmap becomes uninstalled, a -ColormapNotify +ColormapNotify event is generated on every window having cmap as an attribute. In addition, for every other colormap that is installed or uninstalled as a result of @@ -11159,7 +11159,7 @@ and none of the modifiers is changed. This request generates a -MappingNotify +MappingNotify event on a Success status. @@ -11297,7 +11297,7 @@ to appear in nontrailing positions of the effective list for a keycode. This request generates a -MappingNotify +MappingNotify event. @@ -11546,9 +11546,9 @@ When the global mode is Off, no keys should auto-repeat. An auto-repeating key generates alternating -KeyPress +KeyPress and -KeyRelease +KeyRelease events. When a key is used as a modifier, it is desirable for the key not to auto-repeat, @@ -11747,7 +11747,7 @@ and the mapping is not changed. This request generates a -MappingNotify +MappingNotify event on a Success status. @@ -12802,7 +12802,7 @@ in a different window than before, and LeaveNotify events are generated instead of a -MotionNotify +MotionNotify event. Only clients selecting EnterWindow @@ -12856,20 +12856,20 @@ and LeaveNotify events caused by a hierarchy change are generated after any hierarchy event caused by that change (that is, -UnmapNotify, -MapNotify, -ConfigureNotify, -GravityNotify, -CirculateNotify), +UnmapNotify, +MapNotify, +ConfigureNotify, +GravityNotify, +CirculateNotify), but the ordering of EnterNotify and LeaveNotify events with respect to -FocusOut, -VisibilityNotify, +FocusOut, +VisibilityNotify, and -Expose +Expose events is not constrained. @@ -13026,7 +13026,7 @@ is generated on B. When a pointer grab activates (but after any initial warp into a confine-to window and before generating any actual -ButtonPress +ButtonPress event that activates the grab), G is the grab-window for the grab, and P is the window the pointer is in: @@ -13052,7 +13052,7 @@ and final positions for the events. When a pointer grab deactivates (but after generating any actual -ButtonRelease +ButtonRelease event that deactivates the grab), G is the grab-window for the grab, and P is the window the pointer is in: @@ -13157,15 +13157,15 @@ and events generated when a keyboard grab deactivates have mode All FocusOut events caused by a window unmap are generated after any -UnmapNotify +UnmapNotify event, but the ordering of FocusOut with respect to generated -EnterNotify, -LeaveNotify, -VisibilityNotify, +EnterNotify, +LeaveNotify, +VisibilityNotify, and -Expose +Expose events is not constrained. @@ -13621,9 +13621,9 @@ The value is a bit vector as described in This event is reported to clients selecting KeymapState on a window and is generated immediately after every -EnterNotify +EnterNotify and -FocusIn. +FocusIn. @@ -13708,15 +13708,15 @@ All Expose events caused by a hierarchy change are generated after any hierarchy event caused by that change (for example, -UnmapNotify, -MapNotify, -ConfigureNotify, -GravityNotify, -CirculateNotify). +UnmapNotify, +MapNotify, +ConfigureNotify, +GravityNotify, +CirculateNotify). All Expose events on a given window are generated after any -VisibilityNotify +VisibilityNotify event on that window, but it is not required that all Expose @@ -13726,10 +13726,10 @@ events on all windows. The ordering of Expose events with respect to -FocusOut, -EnterNotify, +FocusOut, +EnterNotify, and -LeaveNotify +LeaveNotify events is not constrained. @@ -13848,7 +13848,7 @@ This event is reported to a client using a graphics context with graphics-exposures selected and is generated when a graphics request that might produce -GraphicsExposure +GraphicsExposure events does not produce any. The drawable specifies the destination used for the graphics request. @@ -13930,15 +13930,15 @@ All VisibilityNotify events caused by a hierarchy change are generated after any hierarchy event caused by that change (for example, -UnmapNotify, -MapNotify, -ConfigureNotify, -GravityNotify, -CirculateNotify). +UnmapNotify, +MapNotify, +ConfigureNotify, +GravityNotify, +CirculateNotify). Any VisibilityNotify event on a given window is generated before any -Expose +Expose events on that window, but it is not required that all VisibilityNotify @@ -13948,10 +13948,10 @@ events on all windows. The ordering of VisibilityNotify events with respect to -FocusOut, -EnterNotify, +FocusOut, +EnterNotify, and -LeaveNotify +LeaveNotify events is not constrained. -- cgit v1.2.3