From c7d49c240737afe938c59a9c7a75dbe1c754c82a Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Tue, 14 Jan 2014 00:16:15 -0800 Subject: spec: markup enumerated constant names with Signed-off-by: Alan Coopersmith --- specs/fsproto.xml | 190 +++++++++++++++++++++++++++--------------------------- 1 file changed, 95 insertions(+), 95 deletions(-) (limited to 'specs') diff --git a/specs/fsproto.xml b/specs/fsproto.xml index 5e802d9..34507ea 100644 --- a/specs/fsproto.xml +++ b/specs/fsproto.xml @@ -632,7 +632,7 @@ bottom: XCHARINFO.DESCENT This refers to all scanlines, from the maximum ascent (or the font ascent, whichever is greater) to the maximum descent (or the font descent, whichever is greater), -padded to the same horizontal extents as MaxWidth. +padded to the same horizontal extents as MaxWidth. All glyph images have the same sized bitmap and share a common origin. This is the least compact representation, but may be the easiest or most efficient (particularly for @@ -1664,8 +1664,8 @@ authorization data. ▶ - status:{ Success, Continue, - Busy, Denied } + status:{ Success, Continue, + Busy, Denied } server-major-protocol-version:CARD16 server-minor-protocol-version:CARD16 alternate-servers-hint:LISTofALTERNATESERVER @@ -1713,8 +1713,8 @@ It has one of the following alternate values: -If STATUS is Denied, the server has rejected the client's -authorization information. If STATUS is Busy, the server has +If STATUS is Denied, the server has rejected the client's +authorization information. If STATUS is Busy, the server has simply decided that it cannot provide fonts to this client at this time (it may be able to at a later time). In both cases, AUTHORIZATION-INDEX is set to zero, no authorization-data is @@ -1733,8 +1733,8 @@ etc.). -If STATUS is Success, the following section of protocol is -omitted. Otherwise, if STATUS is Continue, the server expects +If STATUS is Success, the following section of protocol +is omitted. Otherwise, if STATUS is Continue, the server expects more authorization data from the client (i.e. the connection setup is not finished, so no requests or events may be sent): @@ -1746,7 +1746,7 @@ setup is not finished, so no requests or events may be sent): ◀ more-authorization-data:STRING8 ▶ - status:{ Success, Continue, Busy, Denied } + status:{ Success, Continue, Busy, Denied } more-authorization-data:LISTofBYTE @@ -1755,12 +1755,12 @@ setup is not finished, so no requests or events may be sent): The values in STATUS have the same meanings as described above. This section of protocol is repeated until the server -either accepts (sets STATUS to Success) or rejects (sets -STATUS to Denied or Busy) the connection. +either accepts (sets STATUS to Success) or rejects (sets +STATUS to Denied or Busy) the connection. -Once the connection has been accepted and STATUS is Success, +Once the connection has been accepted and STATUS is Success, an implicit AccessContext is created for the authorization data and the protocol continues with the following data sent from the server: @@ -1873,7 +1873,7 @@ This request determines whether or not the extension package specified by NAME (encoded in ISO 8859-1) is supported by the server and that there is sufficient number of major opcode, event, and error codes available. If so, then PRESENT is set -to True, MAJOR-VERSION and MINOR-VERSION are set to the +to True, MAJOR-VERSION and MINOR-VERSION are set to the respective major and minor version numbers of the protocol that the server would prefer; MAJOR-OPCODE is set to the value to use in extension requests; FIRST-EVENT is set to the value @@ -1886,7 +1886,7 @@ NUMBER-ERRORS is set to the number of new errors the extension defines. -Otherwise, PRESENT is set to False and the remaining fields are +Otherwise, PRESENT is set to False and the remaining fields are set to zero. @@ -2115,7 +2115,7 @@ error is returned. ac:ACCESSCONTEXT authorization-protocols:LISTofAUTH ▶ - status:{ Success, Continue, Denied } + status:{ Success, Continue, Denied } authorization-index:CARD8 authorization-data:LISTofBYTE Errors:IDChoice @@ -2136,7 +2136,7 @@ to determine whether or not the client should be granted access to particular font information. -If STATUS is Denied, the server rejects the client's +If STATUS is Denied, the server rejects the client's authorization information and does not associate AC with any valid AccessContext. @@ -2153,10 +2153,10 @@ back authorization protocol-dependent data to the client (such as a challenge, authentication of the server, etc.). -If STATUS is Continue, the client is expected to continue +If STATUS is Continue, the client is expected to continue the request by sending the following protocol and receiving the indicated response from the server. This continues -until STATUS is set to either Success or Denied. +until STATUS is set to either Success or Denied. @@ -2167,13 +2167,13 @@ until STATUS is set to either Success or Denied. ◀ more-authorization-data:STRING8 ▶ - status:{ Success, Continue, Denied } + status:{ Success, Continue, Denied } more-authorization-data:LISTofBYTE -Once the connection has been accepted and STATUS is Success, +Once the connection has been accepted and STATUS is Success, the request is complete. @@ -2207,7 +2207,7 @@ current SetAuthorization request), an implicit SetAuthorization -of None is done to +of None is done to restore the AccessContext established for the initial @@ -2258,12 +2258,12 @@ of the corresponding OpenBitmapFont ). -An AC of None restores the +An AC of None restores the AccessContext established for the initial connection setup. -If AC is neither None nor a value associated with a valid +If AC is neither None nor a value associated with a valid AccessContext previously created by CreateAC, @@ -2451,7 +2451,7 @@ client with the server. format-mask:BITMAPFORMATMASK format-hint:BITMAPFORMAT ▶ - otherid:FONTID or None + otherid:FONTID or None otherid-valid:BOOL cachable:BOOL Errors: @@ -2512,16 +2512,16 @@ has already opened the font successfully (possibly under a different name), the OTHERID field may be set to one of the identifiers previously used to open the font. The OTHERID-VALID field indicates whether or not OTHERID is -still associated with an open font: if it is True, the +still associated with an open font: if it is True, the client may use OTHERID as an alternative to FONTID. -Otherwise, if OTHERID-VALID is False, OTHERID is no longer +Otherwise, if OTHERID-VALID is False, OTHERID is no longer open but has not been reused by a subsequent OpenBitmapFont request. -If OTHERID is set to None, then OTHERID-VALID should be set -to False. +If OTHERID is set to None, then OTHERID-VALID should be set +to False. The FORMAT-MASK indicates which fields in FORMAT-HINT @@ -2533,14 +2533,14 @@ requests. Servers may wish to use this information to precompute certain values. -If CACHABLE is set to True, the client may cache the font +If CACHABLE is set to True, the client may cache the font (so that redundant opens of the same font may be avoided) and use it with all AccessContexts during the life of the client without violating the font's licensing policy. This flag is typically set whenever a font is unlicensed or is -licensed on a per-display basis. If CACHABLE is False, the +licensed on a per-display basis. If CACHABLE is False, the client should reopen the font for each AccessContext. @@ -2659,7 +2659,7 @@ font associated with FONTID for the series of characters specified by RANGE and CHARS. -If RANGE is True, each succeeding pair of elements in CHARS is +If RANGE is True, each succeeding pair of elements in CHARS is treated as a range of characters for which extents should be returned. If CHARS contains an odd number of elements, the font's XFONTINFO.CHAR-RANGE.MAX-CHAR @@ -2673,7 +2673,7 @@ concatenated in the order given by CHARS to produce a set of character codes for which extents are returned. -If RANGE is False, then CHARS specifies the set of character +If RANGE is False, then CHARS specifies the set of character codes for which extents are returned. If CHARS is of zero length, then a zero-length list of extents is returned. @@ -2691,7 +2691,7 @@ with non-zero but equal left and right bearings. If FONTID is not associated with any open fonts, a Font error is -returned. If RANGE is True and CHARS contains any invalid +returned. If RANGE is True and CHARS contains any invalid ranges, a Range error is returned. @@ -2760,7 +2760,7 @@ font associated with FONTID for the series of characters specified by RANGE and CHARS. -If RANGE is True, each succeeding pair of elements in CHARS is +If RANGE is True, each succeeding pair of elements in CHARS is treated as a range of characters for which bitmaps should be returned. If CHARS contains an odd number of elements, the font's XFONTINFO.CHAR-RANGE.MAX-CHAR @@ -2774,7 +2774,7 @@ concatenated in the order given by CHARS to produce a set of character codes for which bitmaps are returned. -If RANGE is False, then CHARS specifies the set of character +If RANGE is False, then CHARS specifies the set of character codes for which bitmaps are returned. If CHARS is of zero length, then a single reply containing a zero-length list of offsets and bitmaps is returned. @@ -2844,7 +2844,7 @@ this field is set to zero. If FONTID is not associated with any open fonts, a Font -error is returned. If RANGE is True and CHARS contains any invalid +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. @@ -3341,13 +3341,13 @@ by sending any request (such as This event is sent to clients that have included -CatalogueListChangeMask +CatalogueListChangeMask in their core event mask whenever the list of catalogues that are available has -changed. The ADDED field is True if new catalogues have -been added to the server, otherwise it is False. The -DELETED field is True if any existing catalogues have -been removed from the server, otherwise it is False. +changed. The ADDED field is True if new catalogues have +been added to the server, otherwise it is False. The +DELETED field is True if any existing catalogues have +been removed from the server, otherwise it is False. @@ -3367,15 +3367,15 @@ been removed from the server, otherwise it is False. This event is sent to clients that have included -FontListChangeMask +FontListChangeMask in their event mask whenever the list of fonts that are provided by the currently selected -catalogues has changed. The ADDED field is True if new +catalogues has changed. The ADDED field is True if new fonts have been added to any of the catalogues currently -used by the client, otherwise it is False. The DELETED -field is True if any existing fonts have been removed +used by the client, otherwise it is False. The DELETED +field is True if any existing fonts have been removed from any of catalogues used by the client, otherwise it -is False. +is False.
@@ -3477,17 +3477,17 @@ q unused, q=pad(d) 4 CARD32 value, union of the following bits: #x00000001 ByteOrderMSB #x00000002 BitOrderMSB - #x00000000 ImageRectMin - #x00000004 ImageRectMaxWidth - #x00000008 ImageRectMax - #x00000000 ScanlinePad8 - #x00000100 ScanlinePad16 - #x00000200 ScanlinePad32 - #x00000300 ScanlinePad64 - #x00000000 ScanlineUnit8 - #x00001000 ScanlineUnit16 - #x00002000 ScanlineUnit32 - #x00003000 ScanlineUnit64 + #x00000000 ImageRectMin + #x00000004 ImageRectMaxWidth + #x00000008 ImageRectMax + #x00000000 ScanlinePad8 + #x00000100 ScanlinePad16 + #x00000200 ScanlinePad32 + #x00000300 ScanlinePad64 + #x00000000 ScanlineUnit8 + #x00001000 ScanlineUnit16 + #x00002000 ScanlineUnit32 + #x00003000 ScanlineUnit64 except for the following bits which must be zero: @@ -3502,11 +3502,11 @@ and the following of which at most one bit may be set: 4 CARD32 value, mask of the following bits: - #x00000001 ByteOrderMask - #x00000002 BitOrderMask - #x00000004 ImageRectMask - #x00000008 ScanlinePadMask - #x00000010 ScanlineUnitMask + #x00000001 ByteOrderMask + #x00000002 BitOrderMask + #x00000004 ImageRectMask + #x00000008 ScanlinePadMask + #x00000010 ScanlineUnitMask except for the following bits which must be zero: @@ -3515,8 +3515,8 @@ except for the following bits which must be zero: BOOL 1 BOOL boolean, one of the following values: -0 False -1 True +0 False +1 True BYTE 1 BYTE unsigned byte of data @@ -3538,8 +3538,8 @@ except for the following bits which must be zero: 4 CARD32 event mask for core events, this is union of the following bits: - #00000001 CatalogueListChangeMask - #00000002 FontListChangeMask + #00000001 CatalogueListChangeMask + #00000002 FontListChangeMask but none of the following bits set: @@ -3582,9 +3582,9 @@ m LISTofBYTE property data block 8 OFFSET32 value in data block 1 CARD8 type, one of the following values: -0 String -1 Unsigned -2 Signed +0 String +1 Unsigned +2 Signed 3 zero RANGE @@ -3616,17 +3616,17 @@ n LISTofBYTE array of 8-bit character values XFONTINFO 4 CARD32 flags, union of the following bits: - #x00000001 AllCharactersExist - #x00000002 InkInside - #x00000004 HorizontalOverlap + #x00000001 AllCharactersExist + #x00000002 InkInside + #x00000004 HorizontalOverlap but none of the following bits set: #xfffffff8 zero 4 RANGE range of characters in font 1 CARD8 drawing direction - 0 LeftToRight - 1 RightToLeft + 0 LeftToRight + 1 RightToLeft 1 unused 2 CHAR2B default character 12 XCHARINFO minimum bounds @@ -3651,10 +3651,10 @@ n PROPINFO property data a LISTofAUTH auth-data ▶ 2 CARD16 status -0 Success -1 Continue -2 Busy -3 Denied +0 Success +1 Continue +2 Busy +3 Denied 2 2 major version 2 0 version 1 CARD8 numberof alternate-servers-hint @@ -3667,11 +3667,11 @@ q unused, q=pad(d) -If STATUS is Busy or Denied, the protocol stops and the connection is -closed. If STATUS is Continue, the client is expected to respond with +If STATUS is Busy or Denied, the protocol stops and the connection is +closed. If STATUS is Continue, the client is expected to respond with additional data, to which the server responds with a new status value and more data. This dialog continues until the status -is set to Success, or until the server sets STATUS to Busy or Denied +is set to Success, or until the server sets STATUS to Busy or Denied and closes the connection: @@ -3683,16 +3683,16 @@ q unused, q=pad(d) ▶ 4 2+(d+q)/4 length 2 CARD16 status - 0 Success - 1 Continue - 2 Busy - 3 Denied + 0 Success + 1 Continue + 2 Busy + 3 Denied 2 unused d LISTofBYTE more-authorization-data q unused, q=pad(d) -When STATUS is Success, the protocol resumes with the following +When STATUS is Success, the protocol resumes with the following sent by the server: @@ -3814,21 +3814,21 @@ a LISTofAUTH authorization-protocols 2 CARD16 sequence-number 4 3+(d+q)/4 length 2 CARD16 status - 0 Success - 1 Continue - 2 Busy - 3 Denied + 0 Success + 1 Continue + 2 Busy + 3 Denied 2 unused d LISTofBYTE authorization-data q unused, q=pad(d) -If STATUS is Continue, the client is expected to respond with additional +If STATUS is Continue, the client is expected to respond with additional data, to which the server responds with a new status value and more data. This dialog continues until the status is set to -Success, Busy, or Denied at which point the request is finished. +Success, Busy, or Denied at which point the request is finished. @@ -3839,10 +3839,10 @@ q unused, q=pad(d) ▶ 4 2+(d+q)/4 length 2 CARD16 status - 0 Success - 1 Continue - 2 Busy - 3 Denied + 0 Success + 1 Continue + 2 Busy + 3 Denied 2 unused d LISTofBYTE authorization-data q unused, q=pad(d) -- cgit v1.2.3