Home | History | Annotate | Download | only in xcb 
      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  * Delivers a request to the X server
    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  * Delivers a request to the X server
    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  * Delivers a request to the X server
    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  * Delivers a request to the X server
    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 /**
    283  * Delivers a request to the X server
    284  * @param c The connection
    285  * @return A cookie
    286  *
    287  * Delivers a request to the X server.
    288  *
    289  */
    290 
    291 /*****************************************************************************
    292  **
    293  ** xcb_xc_misc_get_xid_list_cookie_t xcb_xc_misc_get_xid_list
    294  **
    295  ** @param xcb_connection_t *c
    296  ** @param uint32_t          count
    297  ** @returns xcb_xc_misc_get_xid_list_cookie_t
    298  **
    299  *****************************************************************************/
    300 
    301 xcb_xc_misc_get_xid_list_cookie_t
    302 xcb_xc_misc_get_xid_list (xcb_connection_t *c  /**< */,
    303                           uint32_t          count  /**< */);
    304 
    305 /**
    306  * Delivers a request to the X server
    307  * @param c The connection
    308  * @return A cookie
    309  *
    310  * Delivers a request to the X server.
    311  *
    312  * This form can be used only if the request will cause
    313  * a reply to be generated. Any returned error will be
    314  * placed in the event queue.
    315  */
    316 
    317 /*****************************************************************************
    318  **
    319  ** xcb_xc_misc_get_xid_list_cookie_t xcb_xc_misc_get_xid_list_unchecked
    320  **
    321  ** @param xcb_connection_t *c
    322  ** @param uint32_t          count
    323  ** @returns xcb_xc_misc_get_xid_list_cookie_t
    324  **
    325  *****************************************************************************/
    326 
    327 xcb_xc_misc_get_xid_list_cookie_t
    328 xcb_xc_misc_get_xid_list_unchecked (xcb_connection_t *c  /**< */,
    329                                     uint32_t          count  /**< */);
    330 
    331 
    332 /*****************************************************************************
    333  **
    334  ** uint32_t * xcb_xc_misc_get_xid_list_ids
    335  **
    336  ** @param const xcb_xc_misc_get_xid_list_reply_t *R
    337  ** @returns uint32_t *
    338  **
    339  *****************************************************************************/
    340 
    341 uint32_t *
    342 xcb_xc_misc_get_xid_list_ids (const xcb_xc_misc_get_xid_list_reply_t *R  /**< */);
    343 
    344 
    345 /*****************************************************************************
    346  **
    347  ** int xcb_xc_misc_get_xid_list_ids_length
    348  **
    349  ** @param const xcb_xc_misc_get_xid_list_reply_t *R
    350  ** @returns int
    351  **
    352  *****************************************************************************/
    353 
    354 int
    355 xcb_xc_misc_get_xid_list_ids_length (const xcb_xc_misc_get_xid_list_reply_t *R  /**< */);
    356 
    357 
    358 /*****************************************************************************
    359  **
    360  ** xcb_generic_iterator_t xcb_xc_misc_get_xid_list_ids_end
    361  **
    362  ** @param const xcb_xc_misc_get_xid_list_reply_t *R
    363  ** @returns xcb_generic_iterator_t
    364  **
    365  *****************************************************************************/
    366 
    367 xcb_generic_iterator_t
    368 xcb_xc_misc_get_xid_list_ids_end (const xcb_xc_misc_get_xid_list_reply_t *R  /**< */);
    369 
    370 /**
    371  * Return the reply
    372  * @param c      The connection
    373  * @param cookie The cookie
    374  * @param e      The xcb_generic_error_t supplied
    375  *
    376  * Returns the reply of the request asked by
    377  *
    378  * The parameter @p e supplied to this function must be NULL if
    379  * xcb_xc_misc_get_xid_list_unchecked(). is used.
    380  * Otherwise, it stores the error if any.
    381  *
    382  * The returned value must be freed by the caller using free().
    383  */
    384 
    385 /*****************************************************************************
    386  **
    387  ** xcb_xc_misc_get_xid_list_reply_t * xcb_xc_misc_get_xid_list_reply
    388  **
    389  ** @param xcb_connection_t                   *c
    390  ** @param xcb_xc_misc_get_xid_list_cookie_t   cookie
    391  ** @param xcb_generic_error_t               **e
    392  ** @returns xcb_xc_misc_get_xid_list_reply_t *
    393  **
    394  *****************************************************************************/
    395 
    396 xcb_xc_misc_get_xid_list_reply_t *
    397 xcb_xc_misc_get_xid_list_reply (xcb_connection_t                   *c  /**< */,
    398                                 xcb_xc_misc_get_xid_list_cookie_t   cookie  /**< */,
    399                                 xcb_generic_error_t               **e  /**< */);
    400 
    401 
    402 #ifdef __cplusplus
    403 }
    404 #endif
    405 
    406 #endif
    407 
    408 /**
    409  * @}
    410  */
    411