summaryrefslogtreecommitdiff
path: root/doc/xml-xcb.txt
diff options
context:
space:
mode:
authorPeter Harris <pharris@opentext.com>2009-11-11 14:41:16 -0500
committerPeter Harris <pharris@opentext.com>2010-02-08 12:22:50 -0500
commit9d03507afa4354ce402333f94d01f6bcb2cf41e6 (patch)
tree6202c1b858b2e0ed7c2c01273c4d5d4db207fb19 /doc/xml-xcb.txt
parent78e48a24c7df2381269fc6c6accc3b44bc237ab2 (diff)
downloadxcb-proto-9d03507afa4354ce402333f94d01f6bcb2cf41e6.tar.gz
Add description of new protocol elements
These new elements will be used to support XKEYBOARD (and potentially other troublesome extensions in the future). Thanks to Mariusz Ceier <mceier@gmail.com> for starting this work, and to Google's Summer of Code for sponsoring the initial work. Signed-off-by: Peter Harris <pharris@opentext.com>
Diffstat (limited to 'doc/xml-xcb.txt')
-rw-r--r--doc/xml-xcb.txt30
1 files changed, 29 insertions, 1 deletions
diff --git a/doc/xml-xcb.txt b/doc/xml-xcb.txt
index feb9984..3c6a155 100644
--- a/doc/xml-xcb.txt
+++ b/doc/xml-xcb.txt
@@ -225,8 +225,17 @@ enum; the value is restricted to one of the constants named in the enum.
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
+ <switch> instead for new protocol definitions.
+<switch name="identifier"> switch expression
+ <bitcase> bitcase expression, fields </bitcase> </switch>
+
+ This element represents conditional inclusion of fields. It can be viewed
+ as sequence of multiple ifs: if ( switch expression & bitcase expression )
+ is equal to bitcase expression, bitcase fields are included in structure.
+ It can be used only as the last field of structure. New protocol definitions
+ should prefer to use this instead of <valueparam>.
Expressions
-----------
@@ -256,3 +265,22 @@ Expressions
The bit element represents a literal bitmask value in an expression.
The integer must be in the range 0..31, expanding to (1<<n) in C.
+
+<enumref ref="identifier">enum item identifier</enumref>
+
+ This element represents a reference to item of enum.
+
+<unop op="operator">expression</unop>
+
+ 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.
+
+<sumof ref="identifier" />
+
+ This element represents a sumation of the elements of the referenced list.
+
+<popcount>expression</popcount>
+
+ This element represents the number of bits set in the expression.
+