From 710892b2ad5e374252ded6080d5e00cee8c70cfc Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Tue, 14 Jan 2014 23:17:45 -0800 Subject: spec: Make links to data types, requests, events & errors Extracted each set of section ids to file and converted to a perl script: next if m{^\d}; # skip over encoding section body lines next if m{^[adfmnpv] }; # skip over encoding section body lines s{ACCESSCONTEXT}{$&}g; [...] s{XFONTINFO}{$&}g; s{LISTofACCESSCONTEXT}{$&}g; [...] s{LISTofXFONTINFO}{$&}g; s{NoOp}{$&}g; [...] s{CloseFont}{$&}g; s{Request}{$&}g; [...] s{Extensions}{$&}g; s{KeepAlive}{$&}g; [...] s{Extensions}{$&}g; s{<link linkend="[^"]+">(.*?)</link>}{$1}g; s{(.*?)}{$1}g; s{(.*?)}{$2}g; s{(.*?)}{$2}g; if ($_ =~ m{ id=['"]([^"]+)['"]}) { $sectionid = $1; } s{(.*?)}{$1}g; Signed-off-by: Alan Coopersmith --- specs/fsproto.xml | 574 +++++++++++++++++++++++++++--------------------------- 1 file changed, 287 insertions(+), 287 deletions(-) diff --git a/specs/fsproto.xml b/specs/fsproto.xml index 34507ea..28661c9 100644 --- a/specs/fsproto.xml +++ b/specs/fsproto.xml @@ -330,7 +330,7 @@ of the core X Window System protocol Data type names are spelled in upper case with no word separators, -as in: FONTID +as in: FONTID @@ -403,7 +403,7 @@ The following data types are used in the core X Font Server protocol: - ACCESSCONTEXT:ID + ACCESSCONTEXT:ID @@ -426,9 +426,9 @@ users over time (for example, print spoolers). AccessContexts must be created (with -CreateAC) +CreateAC) and switched among (with -SetAuthorization) +SetAuthorization) to represent all of these font users properly. @@ -444,8 +444,8 @@ to represent all of these font users properly. ALTERNATESERVER: - [ name: STRING8, -  subset: BOOL ] + [ name: STRING8, +  subset: BOOL ] @@ -475,8 +475,8 @@ failure. - AUTH:[ name:STRING8, -  data:LISTofBYTE ] + AUTH:[ name:STRING8, +  data:LISTofBYTE ] @@ -541,9 +541,9 @@ request. This structure specifies how glyph images are transmitted in response to -QueryXBitmaps8 +QueryXBitmaps8 and -QueryXBitmaps16 +QueryXBitmaps16 requests. @@ -578,8 +578,8 @@ glyph image. It contains one of the following alternate values: -For a glyph with extents XCHARINFO in a font with header -information XFONTINFO, the IMAGE-RECT +For a glyph with extents XCHARINFO in a font with header +information XFONTINFO, the IMAGE-RECT values have the following meanings: @@ -694,12 +694,12 @@ alternate values: -BITMAPFORMATs are byte-swapped as CARD32s. +BITMAPFORMATs are byte-swapped as CARD32s. All unspecified bits must be zero. -Use of an invalid BITMAPFORMAT causes a -Format error to be returned. +Use of an invalid BITMAPFORMAT causes a +Format error to be returned. @@ -718,7 +718,7 @@ Use of an invalid BITMAPFORMAT causes a -This is a mask of bits representing the fields in a BITMAPFORMAT: +This is a mask of bits representing the fields in a BITMAPFORMAT: @@ -736,7 +736,7 @@ This is a mask of bits representing the fields in a BITMAPFORMAT: Unspecified bits are required to be zero or else a -Format error is returned. +Format error is returned. @@ -868,9 +868,9 @@ bit indicates one or more events, and a bit value of one indicates interest in a corresponding set of events. The following bits are defined for event masks specified for the core protocol (i.e. an EXTENSION-OPCODE of zero in -SetEventMask +SetEventMask and -GetEventMask +GetEventMask requests): @@ -891,12 +891,12 @@ If CatalogueListChangeMask is set, client is interested in receiving -CatalogueListNotify +CatalogueListNotify events. If FontListChangeMask is set, the client is interested in receiving -FontListNotify +FontListNotify events. @@ -906,14 +906,14 @@ the same bit values as the core or other extensions. All unused bits must be set to zero. In -SetEventMask +SetEventMask requests, if any bits are set that are not defined for the extension (or core) for which this EVENTMASK is intended (according to the EXTENSION-OPCODE given in the -SetEventMask +SetEventMask request), an -EventMask +EventMask error is generated. @@ -932,14 +932,14 @@ This value is swapped as a CARD32. - FONTID: ID + FONTID: ID This is specified by the client in the request -OpenBitmapFont +OpenBitmapFont as the identifier to be used when referring to a particular open font. @@ -968,7 +968,7 @@ at least 1 other bit must be set (yielding a range of 1 through It is specified by the client to represent objects in the server. Identifiers are scoped according to their type are private to the client; thus, the same identifier may be used for -both a FONTID and an ACCESSCONTEXT +both a FONTID and an ACCESSCONTEXT as well as by multiple clients. @@ -1034,8 +1034,8 @@ data. PROPINFO: - [ offsets:LISTofPROPOFFSET, -  data:LISTofBYTE ] + [ offsets:LISTofPROPOFFSET, +  data:LISTofBYTE ] @@ -1063,10 +1063,10 @@ This structure is padded to 32-bit alignment. PROPOFFSET: - [ name:OFFSET32, -  value:OFFSET32, + [ name:OFFSET32, +  value:OFFSET32,  type:CARD8, -  zero-pad3:BYTE, BYTE, BYTE ] +  zero-pad3:BYTE, BYTE, BYTE ] @@ -1149,7 +1149,7 @@ This structure is zero-padded to 32-bit alignment. RANGE: - [ min-char, max-char:CHAR2B ] + [ min-char, max-char:CHAR2B ] @@ -1218,7 +1218,7 @@ size, measured in tenths of a point, and must be greater than zero. This is a counted list of 1-byte character codes, typically encoded in ISO 8859-1. A character code c is equivalent to a -CHAR2B structure whose BYTE1 +CHAR2B structure whose BYTE1 is zero and whose BYTE2 is c. @@ -1339,13 +1339,13 @@ pixels and a height of XFONTINFO: [ flags:CARD32,  drawing-direction:{ LeftToRight, RightToLeft } -  char-range:RANGE, -  default-char:CHAR2B, -  min-bounds:XCHARINFO, -  max-bounds:XCHARINFO, +  char-range:RANGE, +  default-char:CHAR2B, +  min-bounds:XCHARINFO, +  max-bounds:XCHARINFO,  font-ascent:INT16,  font-descent:INT16, -  properties:PROPINFO ] +  properties:PROPINFO ] @@ -1521,18 +1521,18 @@ otherwise specified, unused bytes are not required to be zero. If a request packet contains too little or too much data, the server returns -a Length error. If the server runs out of internal +a Length error. If the server runs out of internal resources (such as memory) while processing a request, it returns an -Alloc error. If a server is +Alloc error. If a server is deficient (and therefore non-compliant) and is unable to process a request, it -may return an Implementation error. +may return an Implementation error. If a client uses an extension request without previously having issued a -QueryExtension +QueryExtension request for that extension, the server responds with a -Request +Request error. If the server encounters a request with an unknown MAJOR-OPCODE or MINOR-OPCODE, it responds with a -Request +Request error. At most one error is generated per request. If more than one error condition is encountered in processing a requests, the choice of which error is returned @@ -1623,10 +1623,10 @@ mutually-understood virtual stream: - byte-order:BYTE + byte-order:BYTE client-major-protocol-version:CARD16 client-minor-protocol-version:CARD16 - authorization-protocols:LISTofAUTH + authorization-protocols:LISTofAUTH @@ -1668,9 +1668,9 @@ authorization data. Busy, Denied } server-major-protocol-version:CARD16 server-minor-protocol-version:CARD16 - alternate-servers-hint:LISTofALTERNATESERVER + alternate-servers-hint:LISTofALTERNATESERVER authorization-index:CARD8 - authorization-data:LISTofBYTE + authorization-data:LISTofBYTE @@ -1744,10 +1744,10 @@ setup is not finished, so no requests or events may be sent): ◀ - more-authorization-data:STRING8 + more-authorization-data:STRING8 ▶ status:{ Success, Continue, Busy, Denied } - more-authorization-data:LISTofBYTE + more-authorization-data:LISTofBYTE @@ -1774,7 +1774,7 @@ from the server: remaining-length:CARD32 maximum-request-length:CARD16 release-number:CARD32 - vendor:STRING8 + vendor:STRING8 @@ -1785,7 +1785,7 @@ the remaining data to be transmitted to the client. The MAXIMUM-REQUEST-LENGTH specifies the largest request size in 4-byte units that is accepted by the server and must have a value of at least 4096. Requests with a length field larger -than this value are ignored and a Length +than this value are ignored and a Length error is returned. The VENDOR string specifies the name of the manufacturer of the font server. The RELEASE-NUMBER specifies the particular @@ -1808,14 +1808,14 @@ exchanged, the client may issue any of requests described below: - Errors:Alloc + Errors:Alloc This request does nothing. It is typically used in response to a -KeepAlive +KeepAlive event. @@ -1830,8 +1830,8 @@ event. ▶ - names:LISTofSTRING8 - Errors:Alloc + names:LISTofSTRING8 + Errors:Alloc @@ -1854,9 +1854,9 @@ case-sensitive and are encoded in ISO 8859-1. - name:STRING8 + name:STRING8 ▶ - present:BOOL + present:BOOL major-version:CARD16 minor-version:CARD16 major-opcode:CARD8 @@ -1864,7 +1864,7 @@ case-sensitive and are encoded in ISO 8859-1. number-events:CARD8 first-error:CARD8 number-errors:CARD8 - Errors:Alloc + Errors:Alloc @@ -1894,9 +1894,9 @@ The server is free to return different values to different clients. Therefore, clients must use this request before issuing any of the requests in the named extension package or using the -SetEventMask request to express interest in any of +SetEventMask request to express interest in any of this extension's events. Otherwise, a -Request +Request error is returned. @@ -1911,12 +1911,12 @@ error is returned. - pattern:STRING8 + pattern:STRING8 max-names:CARD32 ▶+ replies-following-hint:CARD32 - names:LISTofSTRING8 - Errors:Alloc + names:LISTofSTRING8 + Errors:Alloc @@ -1967,9 +1967,9 @@ is set to zero. - names:LISTofSTRING8 - Errors:Alloc, -Name + names:LISTofSTRING8 + Errors:Alloc, +Name @@ -1978,10 +1978,10 @@ This request sets the list of catalogues whose fonts should be visible to the client. The union of the fonts provided by each of the named catalogues forms the set of fonts whose names match patterns in -ListFonts, -ListFontsWithXInfo, +ListFonts, +ListFontsWithXInfo, and -OpenBitmapFont +OpenBitmapFont requests. The catalogue names are case-insensitive and are encoded in ISO 8859-1. A zero-length list resets the client's catalogue list to the @@ -1989,7 +1989,7 @@ server-dependent default. If any of the catalogue names are invalid, a -Name +Name error is returned and the request is ignored. @@ -2004,8 +2004,8 @@ error is returned and the request is ignored. ▶ - names:LISTofSTRING8 - Errors:Alloc + names:LISTofSTRING8 + Errors:Alloc @@ -2014,10 +2014,10 @@ This request returns the current list of catalogue names (encoded in ISO 8859-1) associated with the client. These catalogues determine the set of fonts that are visible to -ListFonts, -ListFontsWithXInfo, +ListFonts, +ListFontsWithXInfo, and -OpenBitmapFont. +OpenBitmapFont. A zero-length list indicates the server's default set of fonts. Catalogue names are case-insensitive and may be returned in mixed case. @@ -2034,9 +2034,9 @@ returned in mixed case. extension-opcode:CARD8 - event-mask:EVENTMASK - Errors:EventMask, -Request + event-mask:EVENTMASK + Errors:EventMask, +Request @@ -2058,14 +2058,14 @@ Some events are not maskable and cannot be blocked. If EXTENSION-OPCODE is not a valid extension opcode previously returned by -QueryExtension +QueryExtension or zero, a -Request +Request error is returned. If EVENT-MASK contains any bits that do not correspond to valid events for the specified extension (or core), an -EventMask +EventMask error is returned and the request is ignored. @@ -2082,8 +2082,8 @@ ignored. extension-opcode:CARD8 ▶ - event-mask:EVENTMASK - Errors:Request + event-mask:EVENTMASK + Errors:Request @@ -2096,9 +2096,9 @@ always sent to the client. If EXTENSION-OPCODE is not a valid extension opcode previously returned by -QueryExtension +QueryExtension or zero, a -Request +Request error is returned. @@ -2112,13 +2112,13 @@ error is returned. - ac:ACCESSCONTEXT - authorization-protocols:LISTofAUTH + ac:ACCESSCONTEXT + authorization-protocols:LISTofAUTH ▶ status:{ Success, Continue, Denied } authorization-index:CARD8 - authorization-data:LISTofBYTE - Errors:IDChoice + authorization-data:LISTofBYTE + Errors:IDChoice @@ -2130,7 +2130,7 @@ server containing the specified authorization data. When this AccessContext is selected by the client using the -SetAuthorization +SetAuthorization request, the data may be used by the server to determine whether or not the client should be granted access to particular font information. @@ -2165,10 +2165,10 @@ until STATUS is set to either Success or Denied ◀ - more-authorization-data:STRING8 + more-authorization-data:STRING8 ▶ status:{ Success, Continue, Denied } - more-authorization-data:LISTofBYTE + more-authorization-data:LISTofBYTE @@ -2179,7 +2179,7 @@ the request is complete. If AC is not in the range [1..229-1] or is already associated -with an access context, an IDChoice error is returned. +with an access context, an IDChoice error is returned. @@ -2192,9 +2192,9 @@ with an access context, an IDChoice error is returned. - ac:ACCESSCONTEXT - Errors:AccessContext, -Alloc + ac:ACCESSCONTEXT + Errors:AccessContext, +Alloc @@ -2204,9 +2204,9 @@ be associated with a valid access context. If AC is also the current AccessContext (as set by the -SetAuthorization +SetAuthorization request), an implicit -SetAuthorization +SetAuthorization of None is done to restore the AccessContext @@ -2214,14 +2214,14 @@ established for the initial connection setup. Operations on fonts that were opened under AC are not affected. The client may reuse the value of AC in a subsequent -CreateAC +CreateAC request. If AC isn't associated with any valid authorization previously created by -CreateAC, an -AccessContext +CreateAC, an +AccessContext error is returned. @@ -2235,8 +2235,8 @@ error is returned. - ac:ACCESSCONTEXT - Errors:AccessContext + ac:ACCESSCONTEXT + Errors:AccessContext @@ -2245,18 +2245,18 @@ This request sets the AccessContext to be used for subsequent requests (except for -QueryXInfo, -QueryXExtents8, -QueryXExtents16, -QueryXBitmaps8, -QueryXBitmaps16 +QueryXInfo, +QueryXExtents8, +QueryXExtents16, +QueryXBitmaps8, +QueryXBitmaps16 and -CloseFont +CloseFont which are done under the AccessContext of the corresponding -OpenBitmapFont +OpenBitmapFont ). An AC of None restores the AccessContext @@ -2266,9 +2266,9 @@ established for the initial connection setup. If AC is neither None nor a value associated with a valid AccessContext previously created by -CreateAC, +CreateAC, an -AccessContext +AccessContext error is returned. @@ -2282,9 +2282,9 @@ error is returned. - resolutions:LISTofRESOLUTION - Errors:Resolution, -Alloc + resolutions:LISTofRESOLUTION + Errors:Resolution, +Alloc @@ -2299,14 +2299,14 @@ instance that is used when a partially-specified scalable fontname is opened. -If a zero-length list of RESOLUTIONs is given, the +If a zero-length list of RESOLUTIONs is given, the server-dependent default value is restored. Otherwise, if -elements of all of the specified RESOLUTIONs are non-zero, the +elements of all of the specified RESOLUTIONs are non-zero, the default resolutions for this client are changed. -If a RESOLUTION entry contains a zero, -a Resolution error is +If a RESOLUTION entry contains a zero, +a Resolution error is returned and the default resolutions are not changed. @@ -2321,15 +2321,15 @@ returned and the default resolutions are not changed. ▶ - resolutions:LISTofRESOLUTION - Errors:Alloc + resolutions:LISTofRESOLUTION + Errors:Alloc This request returns the current list of default resolutions. If a client has not performed a -SetResolution, +SetResolution, a server-dependent default value is returned. @@ -2343,12 +2343,12 @@ a server-dependent default value is returned. - pattern:STRING8 + pattern:STRING8 max-names:CARD32 ▶+ replies-following-hint:CARD32 - names:LISTofSTRING8 - Errors:Alloc + names:LISTofSTRING8 + Errors:Alloc @@ -2402,21 +2402,21 @@ is set to zero. - pattern:STRING8 - pattern:STRING8 - pattern:STRING8 + pattern:STRING8 + pattern:STRING8 + pattern:STRING8 max-names:CARD32 ▶+ replies-following-hint:CARD32 - info:XFONTINFO - name:STRING8 - Errors:Alloc + info:XFONTINFO + name:STRING8 + Errors:Alloc This request is similar to -ListFonts +ListFonts except that a separate reply containing the name, header, and property data is generated for each matching font name. Following these @@ -2446,20 +2446,20 @@ client with the server. - fontid:FONTID - pattern:STRING8 - format-mask:BITMAPFORMATMASK - format-hint:BITMAPFORMAT + fontid:FONTID + pattern:STRING8 + format-mask:BITMAPFORMATMASK + format-hint:BITMAPFORMAT ▶ - otherid:FONTID or None - otherid-valid:BOOL - cachable:BOOL + otherid:FONTID or None + otherid-valid:BOOL + cachable:BOOL Errors: -IDChoice, -Name, -Format, -AccessContext, -Alloc +IDChoice, +Name, +Format, +AccessContext, +Alloc @@ -2467,9 +2467,9 @@ client with the server. This request looks for a server-dependent choice of the font names that match the specified PATTERN according to the rules described for -ListFonts. +ListFonts. If no matches are found, a -Name +Name error is returned. Otherwise, the server attempts to open the font associated with the chosen name. @@ -2480,28 +2480,28 @@ may use the client's current AccessContext (as set by the most recent -SetAuthorization +SetAuthorization request or the original connection setup) to determine any client-specific sets of permissions. After the font has been opened, the client is allowed to specify a new AccessContext with -SetAuthorization +SetAuthorization or release the AccessContext using -FreeAC +FreeAC . Subsequent -QueryXInfo, -QueryXExtents8, -QueryXExtents16, -QueryXBitmaps8, -QueryXBitmaps16 +QueryXInfo, +QueryXExtents8, +QueryXExtents16, +QueryXBitmaps8, +QueryXBitmaps16 and -CloseFont -requests on this FONTID are +CloseFont +requests on this FONTID are performed according to permissions granted at the time of the OpenBitmapFont request. @@ -2547,12 +2547,12 @@ client should reopen the font for each The server is permitted to add to or remove from the set of fonts returned by -ListFonts +ListFonts between any two requests, though mechanisms outside the protocol. Therefore, it is possible for this request (which is atomic) to return a different font than would result from separate a -ListFonts +ListFonts followed by an OpenBitmapFont with a non-wildcarded font name. @@ -2561,17 +2561,17 @@ with a non-wildcarded font name. If FONTID is not in the range [1..229-1] or if it is already associated with an open font, an -IDChoice +IDChoice error is returned. If no font is available that matches the specified PATTERN, a -Name +Name error is returned. If the font is present but the client is not permitted access, an -AccessContext +AccessContext error is returned. If FORMAT-MASK has any unspecified bits set or if any of the fields in FORMAT-HINT indicated by FORMAT-MASK are invalid, a -Format +Format error is returned. @@ -2585,11 +2585,11 @@ error is returned. - fontid:FONTID + fontid:FONTID ▶ - info:XFONTINFO - Errors:Font, -Alloc + info:XFONTINFO + Errors:Font, +Alloc @@ -2599,7 +2599,7 @@ for the open font associated with FONTID. If FONTID is not associated with any open fonts, a -Font +Font error is returned. @@ -2614,20 +2614,20 @@ is returned. - fontid:FONTID - range:BOOL - chars:STRING8 + fontid:FONTID + range:BOOL + chars:STRING8 ▶ - extents:LISTofXCHARINFO - Errors:Font, -Range, -Alloc + extents:LISTofXCHARINFO + Errors:Font, +Range, +Alloc This request is equivalent to -QueryXExtents16 +QueryXExtents16 except that it uses 1-byte character codes. @@ -2642,14 +2642,14 @@ uses 1-byte character codes. - fontid:FONTID - range:BOOL - chars:LISTofCHAR2B + fontid:FONTID + range:BOOL + chars:LISTofCHAR2B ▶ - extents:LISTofXCHARINFO - Errors:Font, -Range, -Alloc + extents:LISTofXCHARINFO + Errors:Font, +Range, +Alloc @@ -2667,7 +2667,7 @@ is implicitly appended to the list. If CHARS contains no elements, the list is implicitly replaced with the font's XFONTINFO.CHAR-RANGE. If -any of the resulting character ranges are invalid, a Range +any of the resulting character ranges are invalid, a Range error is returned. Otherwise, the character ranges are concatenated in the order given by CHARS to produce a set of character codes for which extents are returned. @@ -2689,11 +2689,11 @@ with non-zero but equal left and right bearings. If FONTID is not associated with any open fonts, a -Font +Font error is returned. If RANGE is True and CHARS contains any invalid ranges, a -Range +Range error is returned. @@ -2707,24 +2707,24 @@ error is returned. - fontid:FONTID - range:BOOL - chars:STRING8 - format:BITMAPFORMAT + fontid:FONTID + range:BOOL + chars:STRING8 + format:BITMAPFORMAT ▶+ replies-following-hint:CARD32 - offsets:LISTofOFFSET32 - bitmaps:LISTofBYTE - Errors:Font, -Range, -Format, -Alloc + offsets:LISTofOFFSET32 + bitmaps:LISTofBYTE + Errors:Font, +Range, +Format, +Alloc This request is equivalent to -QueryXBitmaps16 +QueryXBitmaps16 except that it uses 1-byte character codes. @@ -2739,18 +2739,18 @@ uses 1-byte character codes. - fontid:FONTID - range:BOOL - chars:LISTofCHAR2B - format:BITMAPFORMAT + fontid:FONTID + range:BOOL + chars:LISTofCHAR2B + format:BITMAPFORMAT ▶+ replies-following-hint:CARD32 - offsets:LISTofOFFSET32 - bitmaps:LISTofBYTE - Errors:Font, - Range, - Format, - Alloc + offsets:LISTofOFFSET32 + bitmaps:LISTofBYTE + Errors:Font, + Range, + Format, + Alloc @@ -2768,7 +2768,7 @@ is implicitly appended to the list. If CHARS contains no elements, the list is implicitly replaced with the font's XFONTINFO.CHAR-RANGE. If -any of the resulting character ranges are invalid, a Range +any of the resulting character ranges are invalid, a Range error is returned. Otherwise, the character ranges are concatenated in the order given by CHARS to produce a set of character codes for which bitmaps are returned. @@ -2780,7 +2780,7 @@ length, then a single reply containing a zero-length list of offsets and bitmaps is returned. -If any of the resulting character ranges are invalid, a Range +If any of the resulting character ranges are invalid, a Range error is returned. Otherwise, the resulting character ranges are concatenated in the order given by CHARS to produce a set of character codes for which bitmaps are returned. @@ -2843,10 +2843,10 @@ reply, which may contain data for zero or more characters, this field is set to zero. -If FONTID is not associated with any open fonts, a Font +If FONTID is not associated with any open fonts, a Font error is returned. If RANGE is True and CHARS contains any invalid -ranges, a Range error is returned. -If FORMAT is invalid, a Format error is returned. +ranges, a Range error is returned. +If FORMAT is invalid, a Format error is returned. @@ -2859,8 +2859,8 @@ If FORMAT is invalid, a Format error is returned. - fontid:FONTID - Errors:Font, Alloc + fontid:FONTID + Errors:Font, Alloc @@ -2870,12 +2870,12 @@ longer be associated with an open font. The server is free to release any client-specific storage or licenses allocated for the font. The client may reuse the value of FONTID in a subsequent -OpenBitmapFont +OpenBitmapFont request. If FONTID is not associated with any open fonts, a -Font +Font error is returned. @@ -2886,7 +2886,7 @@ error is returned. When a connection is closed, a -CloseFont +CloseFont is done on all fonts that are open on the connection. In addition, the server is free to release any storage or licenses allocated on behalf of @@ -2914,7 +2914,7 @@ All errors are at least 16 bytes long and contain the following fields: error-code:CARD8 sequence-number:CARD16 length:CARD32 - timestamp:TIMESTAMP + timestamp:TIMESTAMP major-opcode:CARD8 minor-opcode:CARD8 data-or-unused:CARD16 @@ -2958,7 +2958,7 @@ The following errors are defined for the core protocol: This error is generated by any request that has an unknown combination of major and minor request numbers, or by any extension request that is issued before a -QueryExtension +QueryExtension of that extension. @@ -2974,16 +2974,16 @@ of that extension. data-or-unused:CARD16unused - format:BITMAPFORMATbad format value + format:BITMAPFORMATbad format value -This error is generated by the use of an invalid BITMAPFORMAT +This error is generated by the use of an invalid BITMAPFORMAT in the -OpenBitmapFont, -QueryXBitmaps8, and -QueryXBitmaps16 +OpenBitmapFont, +QueryXBitmaps8, and +QueryXBitmaps16 requests. The value that caused the error is included as extra data. @@ -3000,19 +3000,19 @@ The value that caused the error is included as extra data. data-or-unused:CARD16unused - fontid:FONTIDbad font identifier + fontid:FONTIDbad font identifier -This error is generated by an invalid FONTID in the -QueryXInfo, -QueryXExtents8, -QueryXExtents16, -QueryXBitmaps8, -QueryXBitmaps16 +This error is generated by an invalid FONTID in the +QueryXInfo, +QueryXExtents8, +QueryXExtents16, +QueryXBitmaps8, +QueryXBitmaps16 and -CloseFont +CloseFont requests. The value that caused the error is included as extra data. @@ -3029,17 +3029,17 @@ the error is included as extra data. data-or-unused:CARD16unused - range:RANGEbad range + range:RANGEbad range -This error is generated by an invalid RANGE in the -QueryXExtents8, -QueryXExtents16, -QueryXBitmaps8 +This error is generated by an invalid RANGE in the +QueryXExtents8, +QueryXExtents16, +QueryXBitmaps8 and -QueryXBitmaps16 +QueryXBitmaps16 requests. The value that caused the error is included as extra data. @@ -3056,13 +3056,13 @@ value that caused the error is included as extra data. data-or-unused:CARD16unused - event-mask:EVENTMASKbad event mask + event-mask:EVENTMASKbad event mask -This error is generated by an invalid EVENTMASK in the -SetEventMask +This error is generated by an invalid EVENTMASK in the +SetEventMask request. The value that caused the error is included as extra data. @@ -3079,21 +3079,21 @@ included as extra data. data-or-unused:CARD16unused - ac:ACCESSCONTEXTunaccepted AccessContext + ac:ACCESSCONTEXTunaccepted AccessContext -This error is generated by an invalid ACCESSCONTEXT in the -FreeAC +This error is generated by an invalid ACCESSCONTEXT in the +FreeAC or -SetAuthorization +SetAuthorization request or by an -OpenBitmapFont +OpenBitmapFont request performed without sufficient authorization. In the -first two cases, the ACCESSCONTEXT of the errant request is +first two cases, the ACCESSCONTEXT of the errant request is returned as extra data. In the third case, the current -ACCESSCONTEXT is returned as extra data. +ACCESSCONTEXT is returned as extra data. @@ -3108,17 +3108,17 @@ returned as extra data. In the third case, the current data-or-unused:CARD16unused - id:IDbad identifier + id:IDbad identifier This error is generated by an invalid or already associated -ACCESSCONTEXT identifier in a -CreateAC -request or FONTID identifier +ACCESSCONTEXT identifier in a +CreateAC +request or FONTID identifier in an -OpenBitmapFont +OpenBitmapFont request. The value that caused the error is included as extra data. @@ -3141,9 +3141,9 @@ is included as extra data. This error is generated by a font name pattern that matches no fonts in an -OpenBitmapFont +OpenBitmapFont request or no catalogue names in a -SetCatalogues +SetCatalogues request. @@ -3165,9 +3165,9 @@ request. -This error is generated in response to an invalid RESOLUTION +This error is generated in response to an invalid RESOLUTION structure in a -SetResolution +SetResolution request. The value that caused the error is included in the DATA-OR-UNUSED field and as extra data. @@ -3265,7 +3265,7 @@ is at least 12 bytes long and contains the following fields: event-code:CARD8 sequence-number:CARD16 length:CARD32 - timestamp:TIMESTAMP + timestamp:TIMESTAMP @@ -3277,7 +3277,7 @@ of the event and is in the range 0-127 for core events or the range 128-255 for extensions. The SEQUENCE-NUMBER field specifies the least significant 16 bits of the sequence number of the last request to have been processed by the server. The LENGTH field specifies the number of 4-byte units in this event -packet and must always have a value of at least 3. The TIMESTAMP field +packet and must always have a value of at least 3. The TIMESTAMP field specifies the server time when the event occurred. If LENGTH is greater than three, these fields are followed by (LENGTH - 3) * 4 bytes of additional data. @@ -3320,7 +3320,7 @@ server to verify that the connection has not been broken (for transports that do not provide this information). Clients should acknowledge receipt of this request by sending any request (such as -NoOp +NoOp ). @@ -3334,8 +3334,8 @@ by sending any request (such as - added:BOOL - deleted:BOOL + added:BOOL + deleted:BOOL @@ -3360,8 +3360,8 @@ been removed from the server, otherwise it is False. - added:BOOL - deleted:BOOL + added:BOOL + deleted:BOOL @@ -3445,7 +3445,7 @@ multiple of four: -ACCESSCONTEXT +ACCESSCONTEXT 4 CARD32 access context with at least one of the following bits set: @@ -3456,13 +3456,13 @@ but none of the following bits set: #xe0000000 zero -ALTERNATESERVER +ALTERNATESERVER 1 BOOL subset 1 n length of name n STRING8 name p unused, p=pad(n+2) -AUTH +AUTH 2 n length of name 2 d length of data @@ -3472,7 +3472,7 @@ d STRING8 data q unused, q=pad(d) -BITMAPFORMAT +BITMAPFORMAT 4 CARD32 value, union of the following bits: #x00000001 ByteOrderMSB @@ -3498,7 +3498,7 @@ and the following of which at most one bit may be set: #x0000000c at most one bit can be set -BITMAPFORMATMASK +BITMAPFORMATMASK 4 CARD32 value, mask of the following bits: @@ -3512,13 +3512,13 @@ except for the following bits which must be zero: #xffffffe0 zero -BOOL +BOOL 1 BOOL boolean, one of the following values: 0 False 1 True -BYTE +BYTE 1 BYTE unsigned byte of data CARD8 @@ -3530,11 +3530,11 @@ except for the following bits which must be zero: CARD32 4 CARD32 32-bit unsigned integer -CHAR2B +CHAR2B 1 CARD8 byte1 1 CARD8 byte2 -EVENTMASK +EVENTMASK 4 CARD32 event mask for core events, this is union of the following bits: @@ -3547,7 +3547,7 @@ but none of the following bits set: extensions define their own sets of bits -FONTID +FONTID 4 CARD32 font identifier with at least one of the following bits set: @@ -3567,17 +3567,17 @@ but none of the following bits set: INT32 4 INT32 32-bit signed integer -OFFSET32 +OFFSET32 4 CARD32 position (or integer value) 4 CARD32 length -PROPINFO +PROPINFO 4 n number of PROPOFFSET components 4 m number of bytes of property data 20*n PROPOFFSET property offsets into data block m LISTofBYTE property data block -PROPOFFSET +PROPOFFSET 8 OFFSET32 name in data block 8 OFFSET32 value in data block @@ -3587,11 +3587,11 @@ m LISTofBYTE property data block 2 Signed 3 zero -RANGE +RANGE 2 CHAR2B minimum character code 2 CHAR2B maximum character code -RESOLUTION +RESOLUTION 2 CARD16 x resolution in pixels per inch 2 CARD16 y resolution in pixels per inch 2 CARD16 point size in decipoints @@ -3600,13 +3600,13 @@ STRNAME 1 n length of name n STRING8 name -STRING8 +STRING8 n LISTofBYTE array of 8-bit character values -TIMESTAMP +TIMESTAMP 4 CARD32 milliseconds since server time origin -XCHARINFO +XCHARINFO 2 INT16 left bearing 2 INT16 right bearing 2 INT16 width @@ -3614,7 +3614,7 @@ n LISTofBYTE array of 8-bit character values 2 INT16 descent 2 CARD16 attributes -XFONTINFO +XFONTINFO 4 CARD32 flags, union of the following bits: #x00000001 AllCharactersExist #x00000002 InkInside @@ -4278,7 +4278,7 @@ policies might include, but are not limited to, combinations of the following: anyone may access any fonts. The server neither refuses any connections -nor generates AccessContext errors on any +nor generates AccessContext errors on any fonts. For environments without specially-licensed fonts, this is sufficient. @@ -4310,7 +4310,7 @@ and then look in a list of allowed users. only a certain number of clients may use a given font at any one time. -Additional clients would receive AccessContext +Additional clients would receive AccessContext errors if they attempt to open the font. This is only effective if the initial clients keep the font open for the entire time that it is being used (even if all of the data has been transmitted and is @@ -4326,7 +4326,7 @@ a particular font may only be accessed a limited number of times before its license must be renewed. Each time the font is opened, the server decrements a counter. When the counter reaches zero, all further attempts to open the font -return an AccessContext error. +return an AccessContext error. -- cgit v1.2.3