X-Git-Url: http://git.demorecorder.com/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Fxml-xcb.txt;h=cf6d14e4647b814bbd7cfa70a982d7621efdab87;hb=e6a246e50e62cbcba33d0e1d2371e69e6e089383;hp=5d34754425fb1aa73606655f54d806675130f0dc;hpb=505dd632bbbd9a55c2bd334d0c06abc175445327;p=free-sw%2Fxcb%2Fproto
diff --git a/doc/xml-xcb.txt b/doc/xml-xcb.txt
index 5d34754..cf6d14e 100644
--- a/doc/xml-xcb.txt
+++ b/doc/xml-xcb.txt
@@ -178,6 +178,12 @@ separated by a single colon. For example, to refer to the PIXMAP type defined
in glx rather than the one defined in xproto, use type="glx:PIXMAP" rather
than type="PIXMAP".
+Note: Most of the below may optionally contain an enum, altenum, or mask
+attribute, which follows the above rules for "type". "enum" is an exhaustive
+enum; the value is restricted to one of the constants named in the enum.
+"altenum" may be one of the values contained in the enum, but it need not be.
+"mask" refers to an enum to be used as a bitmask.
+
This element declares some padding in a data structure. The bytes
@@ -219,8 +225,22 @@ than type="PIXMAP".
defining the set of values included, and a list containing these values.
value-mask-type gives the type of the bitmask; this must be CARD16 or
CARD32. value-mask-name gives the field name of the bitmask, and
- value-list-name gives the field name of the list of values.
+ value-list-name gives the field name of the list of values. Please use
+ instead for new protocol definitions.
+
+ switch expression
+ bitcase expression(s), fields
+
+ This element represents conditional inclusion of fields. It can be viewed
+ as sequence of multiple ifs: if ( switch expression & bitcase expression )
+ is non-zero, bitcase fields are included in structure. It can be used only
+ as the last field of a structure.
+
+ When a bitcase includes multiple clauses, the contents of the
+ bitcase are only present once regardless of the number of bitcase expressions
+ that match.
+ New protocol definitions should prefer to use this instead of .
Expressions
-----------
@@ -250,3 +270,57 @@ Expressions
The bit element represents a literal bitmask value in an expression.
The integer must be in the range 0..31, expanding to (1<enum item identifier
+
+ This element represents a reference to item of enum.
+
+expression
+
+ This element represents a unary operator, with the op attribute specifying
+ which operator. The only supported operation so far is ~, and its semantic
+ is identical to the corresponding operator in C.
+
+
+
+ This element represents a sumation of the elements of the referenced list.
+
+expression
+
+ This element represents the number of bits set in the expression.
+
+Documentation
+-------------
+
+ Documentation for each request, reply or event is stored in the appropriate
+ element using a element. The element can contain the following
+ elements:
+
+brief description
+
+ A short description of the request, reply or event. For example "makes a
+ window visible" for MapWindow. This will end up in the manpage NAME section
+ and in the doxygen @brief description.
+
+
+
+ The full description. Use `` to highlight words, such as "Draws
+ `points_len`-1 lines between each pair of pointsâ¦"
+
+
+
+ Example C code illustrating the usage of the particular request, reply or
+ event.
+
+field description
+
+ The full description for the specified field. Depending on the context, this
+ is either a request parameter or a reply/event datastructure field.
+
+error description
+
+ The full description for an error which can occur due to this request.
+
+
+
+ A reference to another relevant program, function, request or event.