xref: /minix/external/mit/xorg/lib/libxcb/files/xc_misc.h (revision ebfedea0)
1 /*
2  * This file generated automatically from xc_misc.xml by c_client.py.
3  * Edit at your peril.
4  */
5 
6 /**
7  * @defgroup XCB_XCMisc_API XCB XCMisc API
8  * @brief XCMisc XCB Protocol Implementation.
9  * @{
10  **/
11 
12 #ifndef __XC_MISC_H
13 #define __XC_MISC_H
14 
15 #include "xcb.h"
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 #define XCB_XCMISC_MAJOR_VERSION 1
22 #define XCB_XCMISC_MINOR_VERSION 1
23 
24 extern xcb_extension_t xcb_xc_misc_id;
25 
26 /**
27  * @brief xcb_xc_misc_get_version_cookie_t
28  **/
29 typedef struct xcb_xc_misc_get_version_cookie_t {
30     unsigned int sequence; /**<  */
31 } xcb_xc_misc_get_version_cookie_t;
32 
33 /** Opcode for xcb_xc_misc_get_version. */
34 #define XCB_XC_MISC_GET_VERSION 0
35 
36 /**
37  * @brief xcb_xc_misc_get_version_request_t
38  **/
39 typedef struct xcb_xc_misc_get_version_request_t {
40     uint8_t  major_opcode; /**<  */
41     uint8_t  minor_opcode; /**<  */
42     uint16_t length; /**<  */
43     uint16_t client_major_version; /**<  */
44     uint16_t client_minor_version; /**<  */
45 } xcb_xc_misc_get_version_request_t;
46 
47 /**
48  * @brief xcb_xc_misc_get_version_reply_t
49  **/
50 typedef struct xcb_xc_misc_get_version_reply_t {
51     uint8_t  response_type; /**<  */
52     uint8_t  pad0; /**<  */
53     uint16_t sequence; /**<  */
54     uint32_t length; /**<  */
55     uint16_t server_major_version; /**<  */
56     uint16_t server_minor_version; /**<  */
57 } xcb_xc_misc_get_version_reply_t;
58 
59 /**
60  * @brief xcb_xc_misc_get_xid_range_cookie_t
61  **/
62 typedef struct xcb_xc_misc_get_xid_range_cookie_t {
63     unsigned int sequence; /**<  */
64 } xcb_xc_misc_get_xid_range_cookie_t;
65 
66 /** Opcode for xcb_xc_misc_get_xid_range. */
67 #define XCB_XC_MISC_GET_XID_RANGE 1
68 
69 /**
70  * @brief xcb_xc_misc_get_xid_range_request_t
71  **/
72 typedef struct xcb_xc_misc_get_xid_range_request_t {
73     uint8_t  major_opcode; /**<  */
74     uint8_t  minor_opcode; /**<  */
75     uint16_t length; /**<  */
76 } xcb_xc_misc_get_xid_range_request_t;
77 
78 /**
79  * @brief xcb_xc_misc_get_xid_range_reply_t
80  **/
81 typedef struct xcb_xc_misc_get_xid_range_reply_t {
82     uint8_t  response_type; /**<  */
83     uint8_t  pad0; /**<  */
84     uint16_t sequence; /**<  */
85     uint32_t length; /**<  */
86     uint32_t start_id; /**<  */
87     uint32_t count; /**<  */
88 } xcb_xc_misc_get_xid_range_reply_t;
89 
90 /**
91  * @brief xcb_xc_misc_get_xid_list_cookie_t
92  **/
93 typedef struct xcb_xc_misc_get_xid_list_cookie_t {
94     unsigned int sequence; /**<  */
95 } xcb_xc_misc_get_xid_list_cookie_t;
96 
97 /** Opcode for xcb_xc_misc_get_xid_list. */
98 #define XCB_XC_MISC_GET_XID_LIST 2
99 
100 /**
101  * @brief xcb_xc_misc_get_xid_list_request_t
102  **/
103 typedef struct xcb_xc_misc_get_xid_list_request_t {
104     uint8_t  major_opcode; /**<  */
105     uint8_t  minor_opcode; /**<  */
106     uint16_t length; /**<  */
107     uint32_t count; /**<  */
108 } xcb_xc_misc_get_xid_list_request_t;
109 
110 /**
111  * @brief xcb_xc_misc_get_xid_list_reply_t
112  **/
113 typedef struct xcb_xc_misc_get_xid_list_reply_t {
114     uint8_t  response_type; /**<  */
115     uint8_t  pad0; /**<  */
116     uint16_t sequence; /**<  */
117     uint32_t length; /**<  */
118     uint32_t ids_len; /**<  */
119     uint8_t  pad1[20]; /**<  */
120 } xcb_xc_misc_get_xid_list_reply_t;
121 
122 /**
123  *
124  * @param c The connection
125  * @return A cookie
126  *
127  * Delivers a request to the X server.
128  *
129  */
130 
131 /*****************************************************************************
132  **
133  ** xcb_xc_misc_get_version_cookie_t xcb_xc_misc_get_version
134  **
135  ** @param xcb_connection_t *c
136  ** @param uint16_t          client_major_version
137  ** @param uint16_t          client_minor_version
138  ** @returns xcb_xc_misc_get_version_cookie_t
139  **
140  *****************************************************************************/
141 
142 xcb_xc_misc_get_version_cookie_t
143 xcb_xc_misc_get_version (xcb_connection_t *c  /**< */,
144                          uint16_t          client_major_version  /**< */,
145                          uint16_t          client_minor_version  /**< */);
146 
147 /**
148  *
149  * @param c The connection
150  * @return A cookie
151  *
152  * Delivers a request to the X server.
153  *
154  * This form can be used only if the request will cause
155  * a reply to be generated. Any returned error will be
156  * placed in the event queue.
157  */
158 
159 /*****************************************************************************
160  **
161  ** xcb_xc_misc_get_version_cookie_t xcb_xc_misc_get_version_unchecked
162  **
163  ** @param xcb_connection_t *c
164  ** @param uint16_t          client_major_version
165  ** @param uint16_t          client_minor_version
166  ** @returns xcb_xc_misc_get_version_cookie_t
167  **
168  *****************************************************************************/
169 
170 xcb_xc_misc_get_version_cookie_t
171 xcb_xc_misc_get_version_unchecked (xcb_connection_t *c  /**< */,
172                                    uint16_t          client_major_version  /**< */,
173                                    uint16_t          client_minor_version  /**< */);
174 
175 /**
176  * Return the reply
177  * @param c      The connection
178  * @param cookie The cookie
179  * @param e      The xcb_generic_error_t supplied
180  *
181  * Returns the reply of the request asked by
182  *
183  * The parameter @p e supplied to this function must be NULL if
184  * xcb_xc_misc_get_version_unchecked(). is used.
185  * Otherwise, it stores the error if any.
186  *
187  * The returned value must be freed by the caller using free().
188  */
189 
190 /*****************************************************************************
191  **
192  ** xcb_xc_misc_get_version_reply_t * xcb_xc_misc_get_version_reply
193  **
194  ** @param xcb_connection_t                  *c
195  ** @param xcb_xc_misc_get_version_cookie_t   cookie
196  ** @param xcb_generic_error_t              **e
197  ** @returns xcb_xc_misc_get_version_reply_t *
198  **
199  *****************************************************************************/
200 
201 xcb_xc_misc_get_version_reply_t *
202 xcb_xc_misc_get_version_reply (xcb_connection_t                  *c  /**< */,
203                                xcb_xc_misc_get_version_cookie_t   cookie  /**< */,
204                                xcb_generic_error_t              **e  /**< */);
205 
206 /**
207  *
208  * @param c The connection
209  * @return A cookie
210  *
211  * Delivers a request to the X server.
212  *
213  */
214 
215 /*****************************************************************************
216  **
217  ** xcb_xc_misc_get_xid_range_cookie_t xcb_xc_misc_get_xid_range
218  **
219  ** @param xcb_connection_t *c
220  ** @returns xcb_xc_misc_get_xid_range_cookie_t
221  **
222  *****************************************************************************/
223 
224 xcb_xc_misc_get_xid_range_cookie_t
225 xcb_xc_misc_get_xid_range (xcb_connection_t *c  /**< */);
226 
227 /**
228  *
229  * @param c The connection
230  * @return A cookie
231  *
232  * Delivers a request to the X server.
233  *
234  * This form can be used only if the request will cause
235  * a reply to be generated. Any returned error will be
236  * placed in the event queue.
237  */
238 
239 /*****************************************************************************
240  **
241  ** xcb_xc_misc_get_xid_range_cookie_t xcb_xc_misc_get_xid_range_unchecked
242  **
243  ** @param xcb_connection_t *c
244  ** @returns xcb_xc_misc_get_xid_range_cookie_t
245  **
246  *****************************************************************************/
247 
248 xcb_xc_misc_get_xid_range_cookie_t
249 xcb_xc_misc_get_xid_range_unchecked (xcb_connection_t *c  /**< */);
250 
251 /**
252  * Return the reply
253  * @param c      The connection
254  * @param cookie The cookie
255  * @param e      The xcb_generic_error_t supplied
256  *
257  * Returns the reply of the request asked by
258  *
259  * The parameter @p e supplied to this function must be NULL if
260  * xcb_xc_misc_get_xid_range_unchecked(). is used.
261  * Otherwise, it stores the error if any.
262  *
263  * The returned value must be freed by the caller using free().
264  */
265 
266 /*****************************************************************************
267  **
268  ** xcb_xc_misc_get_xid_range_reply_t * xcb_xc_misc_get_xid_range_reply
269  **
270  ** @param xcb_connection_t                    *c
271  ** @param xcb_xc_misc_get_xid_range_cookie_t   cookie
272  ** @param xcb_generic_error_t                **e
273  ** @returns xcb_xc_misc_get_xid_range_reply_t *
274  **
275  *****************************************************************************/
276 
277 xcb_xc_misc_get_xid_range_reply_t *
278 xcb_xc_misc_get_xid_range_reply (xcb_connection_t                    *c  /**< */,
279                                  xcb_xc_misc_get_xid_range_cookie_t   cookie  /**< */,
280                                  xcb_generic_error_t                **e  /**< */);
281 
282 int
283 xcb_xc_misc_get_xid_list_sizeof (const void  *_buffer  /**< */);
284 
285 /**
286  *
287  * @param c The connection
288  * @return A cookie
289  *
290  * Delivers a request to the X server.
291  *
292  */
293 
294 /*****************************************************************************
295  **
296  ** xcb_xc_misc_get_xid_list_cookie_t xcb_xc_misc_get_xid_list
297  **
298  ** @param xcb_connection_t *c
299  ** @param uint32_t          count
300  ** @returns xcb_xc_misc_get_xid_list_cookie_t
301  **
302  *****************************************************************************/
303 
304 xcb_xc_misc_get_xid_list_cookie_t
305 xcb_xc_misc_get_xid_list (xcb_connection_t *c  /**< */,
306                           uint32_t          count  /**< */);
307 
308 /**
309  *
310  * @param c The connection
311  * @return A cookie
312  *
313  * Delivers a request to the X server.
314  *
315  * This form can be used only if the request will cause
316  * a reply to be generated. Any returned error will be
317  * placed in the event queue.
318  */
319 
320 /*****************************************************************************
321  **
322  ** xcb_xc_misc_get_xid_list_cookie_t xcb_xc_misc_get_xid_list_unchecked
323  **
324  ** @param xcb_connection_t *c
325  ** @param uint32_t          count
326  ** @returns xcb_xc_misc_get_xid_list_cookie_t
327  **
328  *****************************************************************************/
329 
330 xcb_xc_misc_get_xid_list_cookie_t
331 xcb_xc_misc_get_xid_list_unchecked (xcb_connection_t *c  /**< */,
332                                     uint32_t          count  /**< */);
333 
334 
335 /*****************************************************************************
336  **
337  ** uint32_t * xcb_xc_misc_get_xid_list_ids
338  **
339  ** @param const xcb_xc_misc_get_xid_list_reply_t *R
340  ** @returns uint32_t *
341  **
342  *****************************************************************************/
343 
344 uint32_t *
345 xcb_xc_misc_get_xid_list_ids (const xcb_xc_misc_get_xid_list_reply_t *R  /**< */);
346 
347 
348 /*****************************************************************************
349  **
350  ** int xcb_xc_misc_get_xid_list_ids_length
351  **
352  ** @param const xcb_xc_misc_get_xid_list_reply_t *R
353  ** @returns int
354  **
355  *****************************************************************************/
356 
357 int
358 xcb_xc_misc_get_xid_list_ids_length (const xcb_xc_misc_get_xid_list_reply_t *R  /**< */);
359 
360 
361 /*****************************************************************************
362  **
363  ** xcb_generic_iterator_t xcb_xc_misc_get_xid_list_ids_end
364  **
365  ** @param const xcb_xc_misc_get_xid_list_reply_t *R
366  ** @returns xcb_generic_iterator_t
367  **
368  *****************************************************************************/
369 
370 xcb_generic_iterator_t
371 xcb_xc_misc_get_xid_list_ids_end (const xcb_xc_misc_get_xid_list_reply_t *R  /**< */);
372 
373 /**
374  * Return the reply
375  * @param c      The connection
376  * @param cookie The cookie
377  * @param e      The xcb_generic_error_t supplied
378  *
379  * Returns the reply of the request asked by
380  *
381  * The parameter @p e supplied to this function must be NULL if
382  * xcb_xc_misc_get_xid_list_unchecked(). is used.
383  * Otherwise, it stores the error if any.
384  *
385  * The returned value must be freed by the caller using free().
386  */
387 
388 /*****************************************************************************
389  **
390  ** xcb_xc_misc_get_xid_list_reply_t * xcb_xc_misc_get_xid_list_reply
391  **
392  ** @param xcb_connection_t                   *c
393  ** @param xcb_xc_misc_get_xid_list_cookie_t   cookie
394  ** @param xcb_generic_error_t               **e
395  ** @returns xcb_xc_misc_get_xid_list_reply_t *
396  **
397  *****************************************************************************/
398 
399 xcb_xc_misc_get_xid_list_reply_t *
400 xcb_xc_misc_get_xid_list_reply (xcb_connection_t                   *c  /**< */,
401                                 xcb_xc_misc_get_xid_list_cookie_t   cookie  /**< */,
402                                 xcb_generic_error_t               **e  /**< */);
403 
404 
405 #ifdef __cplusplus
406 }
407 #endif
408 
409 #endif
410 
411 /**
412  * @}
413  */
414