xcb-schema: add listelement-ref
[free-sw/xcb/proto] / src / xcb.xsd
index 23dc352..2f11f64 100644 (file)
@@ -30,28 +30,76 @@ authorization from the authors.
   <xsd:element name="xcb">
     <xsd:complexType>
       <xsd:group ref="macro" minOccurs="0" maxOccurs="unbounded" />
-      <xsd:attribute name="header" type="xsd:string" />
+      <xsd:attribute name="header" type="xsd:string" use="required" />
       <xsd:attribute name="extension-xname" type="xsd:string" use="optional" />
       <xsd:attribute name="extension-name"  type="xsd:string" use="optional" />
+      <xsd:attribute name="extension-multiword" type="xsd:boolean" use="optional" default="false" />
+      <xsd:attribute name="major-version"   type="xsd:integer" use="optional" />
+      <xsd:attribute name="minor-version"   type="xsd:integer" use="optional" />
     </xsd:complexType>
   </xsd:element>
 
   <!-- Padding -->
   <xsd:element name="pad">
     <xsd:complexType>
-      <xsd:attribute name="bytes" type="xsd:integer" />
+      <xsd:attribute name="bytes" type="xsd:integer" use="optional" />
+      <xsd:attribute name="align" type="xsd:integer" use="optional" />
     </xsd:complexType>
   </xsd:element>
 
   <!-- Type for fields or parameters with attributes "name" and "type" -->
   <xsd:complexType name="var">
-    <xsd:attribute name="name" type="xsd:string" />
-    <xsd:attribute name="type" type="xsd:string" />
+    <xsd:attribute name="name" type="xsd:string" use="required" />
+    <xsd:attribute name="type" type="xsd:string" use="required" />
+    <xsd:attribute name="enum" type="xsd:string" use="optional" />
+    <xsd:attribute name="altenum" type="xsd:string" use="optional" />
+    <xsd:attribute name="mask" type="xsd:string" use="optional" />
+    <xsd:attribute name="altmask" type="xsd:string" use="optional" />
   </xsd:complexType>
 
+  <!-- case expression -->
+  <xsd:complexType name="caseexpr">
+    <xsd:sequence>
+      <!-- case expression: -->
+      <xsd:group ref="expression" minOccurs="1" maxOccurs="unbounded" />
+      <!-- match -->
+      <xsd:group ref="fields" minOccurs="1" maxOccurs="unbounded" />
+      <xsd:choice>
+        <xsd:element ref="switch" minOccurs="0" maxOccurs="unbounded" />
+      </xsd:choice>
+    </xsd:sequence>
+    <xsd:attribute name="name" type="xsd:string" use="optional" />
+  </xsd:complexType>
+
+  <!-- switch expression -->
+  <xsd:complexType name="switchexpr">
+    <xsd:sequence>
+      <!-- switch(expression) -->
+      <xsd:group ref="expression" minOccurs="1" maxOccurs="1" />
+      <xsd:choice>
+        <!-- bitcase expression - bit test -->
+        <xsd:element name="bitcase" type="caseexpr" minOccurs="0" maxOccurs="unbounded" />
+        <!-- case expression - value test -->
+        <xsd:element name="case" type="caseexpr" minOccurs="0" maxOccurs="unbounded" />
+      </xsd:choice>
+      <!-- default: -->
+      <xsd:group ref="fields" minOccurs="0" maxOccurs="1" />
+    </xsd:sequence>
+    <xsd:attribute name="name" type="xsd:string" use="required" />
+  </xsd:complexType>
+
+  <xsd:element name="switch" type="switchexpr" />
+
   <!-- field replaces FIELD, PARAM, and REPLY. -->
   <xsd:element name="field" type="var" />
 
+  <!-- fd passing parameter -->
+  <xsd:element name="fd">
+    <xsd:complexType>
+      <xsd:attribute name="name" type="xsd:string" use="required" />
+    </xsd:complexType>
+  </xsd:element>
+
   <!-- list replaces ARRAYFIELD, LISTPARAM, and ARRAYREPLY.  The name and type
        are specified as attributes.  The content is an expression giving the
        length. -->
@@ -65,9 +113,6 @@ authorization from the authors.
     </xsd:complexType>
   </xsd:element>
 
-  <!-- Parameters in requests that are not sent with the request. -->
-  <xsd:element name="localfield" type="var" />
-  
   <!-- Expressions -->
   <xsd:group name="expression">
     <xsd:choice>
@@ -77,7 +122,7 @@ authorization from the authors.
             <xsd:group ref="expression" />
             <xsd:group ref="expression" />
           </xsd:sequence>
-          <xsd:attribute name="op">
+          <xsd:attribute name="op" use="required">
             <xsd:simpleType>
               <xsd:restriction base="xsd:string">
                 <xsd:pattern value="\+|-|\*|/|&amp;|&lt;&lt;" />
@@ -86,8 +131,46 @@ authorization from the authors.
           </xsd:attribute>
         </xsd:complexType>
       </xsd:element>
+      <xsd:element name="unop">
+         <xsd:complexType>
+            <xsd:sequence>
+              <xsd:group ref="expression" />
+            </xsd:sequence>
+            <xsd:attribute name="op" use="required">
+              <xsd:simpleType>
+                <xsd:restriction base="xsd:string">
+                  <xsd:pattern value="~" />
+                </xsd:restriction>
+              </xsd:simpleType>
+            </xsd:attribute>
+         </xsd:complexType>
+      </xsd:element>
       <xsd:element name="fieldref" type="xsd:string" />
-      <xsd:element name="value" type="dec-or-hex-integer" />
+      <xsd:element name="enumref">
+        <xsd:complexType>
+          <xsd:simpleContent>
+            <xsd:extension base="xsd:string">
+              <xsd:attribute name="ref" use="required" type="xsd:string" />
+            </xsd:extension>
+          </xsd:simpleContent>
+        </xsd:complexType>
+      </xsd:element>
+      <xsd:element name="popcount">
+        <xsd:complexType>
+          <xsd:group ref="expression" />
+        </xsd:complexType>
+      </xsd:element>
+      <xsd:element name="sumof">
+        <xsd:complexType>
+          <xsd:sequence>
+            <xsd:group ref="expression" minOccurs="0" maxOccurs="1"/>
+          </xsd:sequence>
+          <xsd:attribute name="ref" use="required" type="xsd:string" />
+        </xsd:complexType>
+      </xsd:element>
+      <xsd:element name="listelement-ref" />
+      <xsd:element name="value" type="xsd:integer" />
+      <xsd:element name="bit" type="bitType" />
     </xsd:choice>
   </xsd:group>
   
@@ -106,9 +189,9 @@ authorization from the authors.
   <!-- BITMASK/LISTofVALUE parameter pairs. -->
   <xsd:element name="valueparam">
     <xsd:complexType>
-      <xsd:attribute name="value-mask-type" type="xsd:string" />
-      <xsd:attribute name="value-mask-name" type="xsd:string" />
-      <xsd:attribute name="value-list-name" type="xsd:string" />
+      <xsd:attribute name="value-mask-type" type="xsd:string" use="required" />
+      <xsd:attribute name="value-mask-name" type="xsd:string" use="required" />
+      <xsd:attribute name="value-list-name" type="xsd:string" use="required" />
     </xsd:complexType>
   </xsd:element>
 
@@ -117,40 +200,97 @@ authorization from the authors.
       <xsd:element ref="pad" />
       <xsd:element ref="field" />
       <xsd:element ref="list" />
+      <xsd:element ref="fd" />
     </xsd:choice>
   </xsd:group>
 
   <!-- Type for a structure -->
   <xsd:complexType name="struct">
-    <xsd:group ref="fields" minOccurs="1" maxOccurs="unbounded" />
-    <xsd:attribute name="name" type="xsd:string" />
+    <xsd:sequence>
+      <xsd:group ref="fields" minOccurs="1" maxOccurs="unbounded" />
+      <xsd:choice minOccurs="0" maxOccurs="1">
+        <xsd:element ref="switch" />
+      </xsd:choice>
+    </xsd:sequence>
+    <xsd:attribute name="name" type="xsd:string" use="required" />
   </xsd:complexType>
 
   <!-- Type for a packet structure -->
   <xsd:complexType name="packet-struct">
-    <xsd:group ref="fields" minOccurs="0" maxOccurs="unbounded" />
-    <xsd:attribute name="name" type="xsd:string" />
-    <xsd:attribute name="number" type="xsd:integer" />
+    <xsd:sequence>
+      <xsd:group ref="fields" minOccurs="0" maxOccurs="unbounded" />
+    </xsd:sequence>
+    <xsd:attribute name="name" type="xsd:string" use="required" />
+    <xsd:attribute name="number" type="xsd:integer" use="required" />
   </xsd:complexType>
 
   <!-- Type for a packet structure copy -->
   <xsd:complexType name="packet-struct-copy">
-    <xsd:attribute name="name" type="xsd:string" />
-    <xsd:attribute name="number" type="xsd:integer" />
-    <xsd:attribute name="ref" type="xsd:string" />
+    <xsd:attribute name="name" type="xsd:string" use="required" />
+    <xsd:attribute name="number" type="xsd:integer" use="required" />
+    <xsd:attribute name="ref" type="xsd:string" use="required" />
   </xsd:complexType>
 
-  <!-- Type for hex integers -->
-  <xsd:simpleType name="hex-integer">
-    <xsd:restriction base="xsd:string">
-      <xsd:pattern value="0x[0-9a-fA-F]+" />
+  <!-- Type for bit values -->
+  <xsd:simpleType name="bitType">
+    <xsd:restriction base="xsd:integer">
+      <xsd:minInclusive value="0" />
+      <xsd:maxExclusive value="32" />
     </xsd:restriction>
   </xsd:simpleType>
 
-  <!-- Type for integers in either decimal or hex -->
-  <xsd:simpleType name="dec-or-hex-integer">
-    <xsd:union memberTypes="xsd:integer hex-integer" />
-  </xsd:simpleType>
+  <!-- Type for documentation -->
+  <xsd:group name="doc-fields">
+    <xsd:sequence>
+      <xsd:element name="field">
+        <xsd:complexType>
+          <xsd:simpleContent>
+            <xsd:extension base="xsd:string">
+              <xsd:attribute name="name" type="xsd:string" />
+            </xsd:extension>
+          </xsd:simpleContent>
+        </xsd:complexType>
+      </xsd:element>
+    </xsd:sequence>
+  </xsd:group>
+
+  <xsd:group name="error-fields">
+    <xsd:sequence>
+      <xsd:element name="error">
+        <xsd:complexType>
+          <xsd:simpleContent>
+            <xsd:extension base="xsd:string">
+              <xsd:attribute name="type" type="xsd:string" />
+            </xsd:extension>
+          </xsd:simpleContent>
+        </xsd:complexType>
+      </xsd:element>
+    </xsd:sequence>
+  </xsd:group>
+
+  <xsd:group name="see-fields">
+    <xsd:sequence>
+      <xsd:element name="see">
+        <xsd:complexType>
+          <xsd:attribute name="name" type="xsd:string" />
+          <xsd:attribute name="type" type="xsd:string" />
+        </xsd:complexType>
+      </xsd:element>
+    </xsd:sequence>
+  </xsd:group>
+
+  <xsd:element name="doc">
+    <xsd:complexType mixed="true">
+      <xsd:sequence>
+        <xsd:element name="brief" type="xsd:string" minOccurs="0" maxOccurs="1" />
+        <xsd:element name="description" type="xsd:string" minOccurs="0" maxOccurs="1" />
+        <xsd:element name="example" type="xsd:string" minOccurs="0" maxOccurs="1" />
+        <xsd:group ref="doc-fields" minOccurs="0" maxOccurs="unbounded" />
+        <xsd:group ref="error-fields" minOccurs="0" maxOccurs="unbounded" />
+        <xsd:group ref="see-fields" minOccurs="0" maxOccurs="unbounded" />
+      </xsd:sequence>
+    </xsd:complexType>
+  </xsd:element>
 
   <xsd:group name="macro">
     <xsd:choice>
@@ -159,29 +299,45 @@ authorization from the authors.
           <xsd:sequence>
             <xsd:choice minOccurs="0" maxOccurs="unbounded">
               <xsd:group ref="fields" />
-              <xsd:element ref="localfield" />
               <xsd:element ref="exprfield" />
               <xsd:element ref="valueparam" />
             </xsd:choice>
+            <xsd:choice minOccurs="0" maxOccurs="1">
+              <xsd:element ref="switch" />
+            </xsd:choice>
             <xsd:element name="reply" minOccurs="0" maxOccurs="1">
               <xsd:complexType>
-                <xsd:choice minOccurs="1" maxOccurs="unbounded">
-                  <xsd:group ref="fields" />
-                  <xsd:element ref="valueparam" />
-                </xsd:choice>
+                <xsd:sequence>
+                  <xsd:choice minOccurs="1" maxOccurs="unbounded">
+                    <xsd:group ref="fields" />
+                    <xsd:element ref="valueparam" />
+                  </xsd:choice>
+                  <xsd:choice minOccurs="0" maxOccurs="1">
+                    <xsd:element ref="switch" />
+                  </xsd:choice>
+                  <xsd:element ref="doc" minOccurs="0" maxOccurs="1" />
+                </xsd:sequence>
               </xsd:complexType>
             </xsd:element>
+            <xsd:element ref="doc" minOccurs="0" maxOccurs="1" />
           </xsd:sequence>
-          <xsd:attribute name="name" type="xsd:string" />
-          <xsd:attribute name="opcode" type="xsd:integer" />
-          <xsd:attribute name="combine-adjacent" type="xsd:boolean" />
+          <xsd:attribute name="name" type="xsd:string" use="required" />
+          <xsd:attribute name="opcode" type="xsd:integer" use="required" />
+          <xsd:attribute name="combine-adjacent" type="xsd:boolean"
+                         use="optional" default="false" />
         </xsd:complexType>
       </xsd:element>
       <xsd:element name="event">
         <xsd:complexType>
           <xsd:complexContent>
             <xsd:extension base="packet-struct">
-              <xsd:attribute name="no-sequence-number" type="xsd:boolean" />
+              <xsd:sequence>
+                <xsd:element ref="doc" minOccurs="0" maxOccurs="1" />
+              </xsd:sequence>
+              <xsd:attribute name="no-sequence-number" type="xsd:boolean"
+                             use="optional" default="false" />
+              <xsd:attribute name="xge" type="xsd:boolean"
+                             use="optional" default="false" />
             </xsd:extension>
           </xsd:complexContent>
         </xsd:complexType>
@@ -193,7 +349,16 @@ authorization from the authors.
       <xsd:element name="union" type="struct" />
       <xsd:element name="xidtype">
         <xsd:complexType>
-          <xsd:attribute name="name" type="xsd:string" />
+          <xsd:attribute name="name" type="xsd:string" use="required" />
+        </xsd:complexType>
+      </xsd:element>
+      <xsd:element name="xidunion">
+        <xsd:complexType>
+          <xsd:sequence>
+            <xsd:element name="type" type="xsd:string"
+                         minOccurs="1" maxOccurs="unbounded" />
+          </xsd:sequence>
+          <xsd:attribute name="name" type="xsd:string" use="required" />
         </xsd:complexType>
       </xsd:element>
       <xsd:element name="enum">
@@ -201,18 +366,22 @@ authorization from the authors.
           <xsd:sequence minOccurs="1" maxOccurs="unbounded">
             <xsd:element name="item">
               <xsd:complexType>
-                <xsd:group ref="expression" minOccurs="0" maxOccurs="1" />
-                <xsd:attribute name="name" type="xsd:string" />
+                <xsd:choice minOccurs="1" maxOccurs="1">
+                  <xsd:element name="value" type="xsd:unsignedInt" />
+                  <xsd:element name="bit" type="bitType" />
+                </xsd:choice>
+                <xsd:attribute name="name" type="xsd:string" use="required" />
               </xsd:complexType>
             </xsd:element>
+            <xsd:element ref="doc" minOccurs="0" maxOccurs="1" />
           </xsd:sequence>
-          <xsd:attribute name="name" type="xsd:string" />
+          <xsd:attribute name="name" type="xsd:string" use="required" />
         </xsd:complexType>
       </xsd:element>
       <xsd:element name="typedef">
         <xsd:complexType>
-          <xsd:attribute name="oldname" type="xsd:string" />
-          <xsd:attribute name="newname" type="xsd:string" />
+          <xsd:attribute name="oldname" type="xsd:string" use="required" />
+          <xsd:attribute name="newname" type="xsd:string" use="required" />
         </xsd:complexType>
       </xsd:element>
       <!-- The import element allows a protocol description to reference the