annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/xcb/xc_misc.h @ 69:33d812a61356

planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 /*
jpayne@69 2 * This file generated automatically from xc_misc.xml by c_client.py.
jpayne@69 3 * Edit at your peril.
jpayne@69 4 */
jpayne@69 5
jpayne@69 6 /**
jpayne@69 7 * @defgroup XCB_XCMisc_API XCB XCMisc API
jpayne@69 8 * @brief XCMisc XCB Protocol Implementation.
jpayne@69 9 * @{
jpayne@69 10 **/
jpayne@69 11
jpayne@69 12 #ifndef __XC_MISC_H
jpayne@69 13 #define __XC_MISC_H
jpayne@69 14
jpayne@69 15 #include "xcb.h"
jpayne@69 16
jpayne@69 17 #ifdef __cplusplus
jpayne@69 18 extern "C" {
jpayne@69 19 #endif
jpayne@69 20
jpayne@69 21 #define XCB_XCMISC_MAJOR_VERSION 1
jpayne@69 22 #define XCB_XCMISC_MINOR_VERSION 1
jpayne@69 23
jpayne@69 24 extern xcb_extension_t xcb_xc_misc_id;
jpayne@69 25
jpayne@69 26 /**
jpayne@69 27 * @brief xcb_xc_misc_get_version_cookie_t
jpayne@69 28 **/
jpayne@69 29 typedef struct xcb_xc_misc_get_version_cookie_t {
jpayne@69 30 unsigned int sequence;
jpayne@69 31 } xcb_xc_misc_get_version_cookie_t;
jpayne@69 32
jpayne@69 33 /** Opcode for xcb_xc_misc_get_version. */
jpayne@69 34 #define XCB_XC_MISC_GET_VERSION 0
jpayne@69 35
jpayne@69 36 /**
jpayne@69 37 * @brief xcb_xc_misc_get_version_request_t
jpayne@69 38 **/
jpayne@69 39 typedef struct xcb_xc_misc_get_version_request_t {
jpayne@69 40 uint8_t major_opcode;
jpayne@69 41 uint8_t minor_opcode;
jpayne@69 42 uint16_t length;
jpayne@69 43 uint16_t client_major_version;
jpayne@69 44 uint16_t client_minor_version;
jpayne@69 45 } xcb_xc_misc_get_version_request_t;
jpayne@69 46
jpayne@69 47 /**
jpayne@69 48 * @brief xcb_xc_misc_get_version_reply_t
jpayne@69 49 **/
jpayne@69 50 typedef struct xcb_xc_misc_get_version_reply_t {
jpayne@69 51 uint8_t response_type;
jpayne@69 52 uint8_t pad0;
jpayne@69 53 uint16_t sequence;
jpayne@69 54 uint32_t length;
jpayne@69 55 uint16_t server_major_version;
jpayne@69 56 uint16_t server_minor_version;
jpayne@69 57 } xcb_xc_misc_get_version_reply_t;
jpayne@69 58
jpayne@69 59 /**
jpayne@69 60 * @brief xcb_xc_misc_get_xid_range_cookie_t
jpayne@69 61 **/
jpayne@69 62 typedef struct xcb_xc_misc_get_xid_range_cookie_t {
jpayne@69 63 unsigned int sequence;
jpayne@69 64 } xcb_xc_misc_get_xid_range_cookie_t;
jpayne@69 65
jpayne@69 66 /** Opcode for xcb_xc_misc_get_xid_range. */
jpayne@69 67 #define XCB_XC_MISC_GET_XID_RANGE 1
jpayne@69 68
jpayne@69 69 /**
jpayne@69 70 * @brief xcb_xc_misc_get_xid_range_request_t
jpayne@69 71 **/
jpayne@69 72 typedef struct xcb_xc_misc_get_xid_range_request_t {
jpayne@69 73 uint8_t major_opcode;
jpayne@69 74 uint8_t minor_opcode;
jpayne@69 75 uint16_t length;
jpayne@69 76 } xcb_xc_misc_get_xid_range_request_t;
jpayne@69 77
jpayne@69 78 /**
jpayne@69 79 * @brief xcb_xc_misc_get_xid_range_reply_t
jpayne@69 80 **/
jpayne@69 81 typedef struct xcb_xc_misc_get_xid_range_reply_t {
jpayne@69 82 uint8_t response_type;
jpayne@69 83 uint8_t pad0;
jpayne@69 84 uint16_t sequence;
jpayne@69 85 uint32_t length;
jpayne@69 86 uint32_t start_id;
jpayne@69 87 uint32_t count;
jpayne@69 88 } xcb_xc_misc_get_xid_range_reply_t;
jpayne@69 89
jpayne@69 90 /**
jpayne@69 91 * @brief xcb_xc_misc_get_xid_list_cookie_t
jpayne@69 92 **/
jpayne@69 93 typedef struct xcb_xc_misc_get_xid_list_cookie_t {
jpayne@69 94 unsigned int sequence;
jpayne@69 95 } xcb_xc_misc_get_xid_list_cookie_t;
jpayne@69 96
jpayne@69 97 /** Opcode for xcb_xc_misc_get_xid_list. */
jpayne@69 98 #define XCB_XC_MISC_GET_XID_LIST 2
jpayne@69 99
jpayne@69 100 /**
jpayne@69 101 * @brief xcb_xc_misc_get_xid_list_request_t
jpayne@69 102 **/
jpayne@69 103 typedef struct xcb_xc_misc_get_xid_list_request_t {
jpayne@69 104 uint8_t major_opcode;
jpayne@69 105 uint8_t minor_opcode;
jpayne@69 106 uint16_t length;
jpayne@69 107 uint32_t count;
jpayne@69 108 } xcb_xc_misc_get_xid_list_request_t;
jpayne@69 109
jpayne@69 110 /**
jpayne@69 111 * @brief xcb_xc_misc_get_xid_list_reply_t
jpayne@69 112 **/
jpayne@69 113 typedef struct xcb_xc_misc_get_xid_list_reply_t {
jpayne@69 114 uint8_t response_type;
jpayne@69 115 uint8_t pad0;
jpayne@69 116 uint16_t sequence;
jpayne@69 117 uint32_t length;
jpayne@69 118 uint32_t ids_len;
jpayne@69 119 uint8_t pad1[20];
jpayne@69 120 } xcb_xc_misc_get_xid_list_reply_t;
jpayne@69 121
jpayne@69 122 /**
jpayne@69 123 *
jpayne@69 124 * @param c The connection
jpayne@69 125 * @return A cookie
jpayne@69 126 *
jpayne@69 127 * Delivers a request to the X server.
jpayne@69 128 *
jpayne@69 129 */
jpayne@69 130 xcb_xc_misc_get_version_cookie_t
jpayne@69 131 xcb_xc_misc_get_version (xcb_connection_t *c,
jpayne@69 132 uint16_t client_major_version,
jpayne@69 133 uint16_t client_minor_version);
jpayne@69 134
jpayne@69 135 /**
jpayne@69 136 *
jpayne@69 137 * @param c The connection
jpayne@69 138 * @return A cookie
jpayne@69 139 *
jpayne@69 140 * Delivers a request to the X server.
jpayne@69 141 *
jpayne@69 142 * This form can be used only if the request will cause
jpayne@69 143 * a reply to be generated. Any returned error will be
jpayne@69 144 * placed in the event queue.
jpayne@69 145 */
jpayne@69 146 xcb_xc_misc_get_version_cookie_t
jpayne@69 147 xcb_xc_misc_get_version_unchecked (xcb_connection_t *c,
jpayne@69 148 uint16_t client_major_version,
jpayne@69 149 uint16_t client_minor_version);
jpayne@69 150
jpayne@69 151 /**
jpayne@69 152 * Return the reply
jpayne@69 153 * @param c The connection
jpayne@69 154 * @param cookie The cookie
jpayne@69 155 * @param e The xcb_generic_error_t supplied
jpayne@69 156 *
jpayne@69 157 * Returns the reply of the request asked by
jpayne@69 158 *
jpayne@69 159 * The parameter @p e supplied to this function must be NULL if
jpayne@69 160 * xcb_xc_misc_get_version_unchecked(). is used.
jpayne@69 161 * Otherwise, it stores the error if any.
jpayne@69 162 *
jpayne@69 163 * The returned value must be freed by the caller using free().
jpayne@69 164 */
jpayne@69 165 xcb_xc_misc_get_version_reply_t *
jpayne@69 166 xcb_xc_misc_get_version_reply (xcb_connection_t *c,
jpayne@69 167 xcb_xc_misc_get_version_cookie_t cookie /**< */,
jpayne@69 168 xcb_generic_error_t **e);
jpayne@69 169
jpayne@69 170 /**
jpayne@69 171 *
jpayne@69 172 * @param c The connection
jpayne@69 173 * @return A cookie
jpayne@69 174 *
jpayne@69 175 * Delivers a request to the X server.
jpayne@69 176 *
jpayne@69 177 */
jpayne@69 178 xcb_xc_misc_get_xid_range_cookie_t
jpayne@69 179 xcb_xc_misc_get_xid_range (xcb_connection_t *c);
jpayne@69 180
jpayne@69 181 /**
jpayne@69 182 *
jpayne@69 183 * @param c The connection
jpayne@69 184 * @return A cookie
jpayne@69 185 *
jpayne@69 186 * Delivers a request to the X server.
jpayne@69 187 *
jpayne@69 188 * This form can be used only if the request will cause
jpayne@69 189 * a reply to be generated. Any returned error will be
jpayne@69 190 * placed in the event queue.
jpayne@69 191 */
jpayne@69 192 xcb_xc_misc_get_xid_range_cookie_t
jpayne@69 193 xcb_xc_misc_get_xid_range_unchecked (xcb_connection_t *c);
jpayne@69 194
jpayne@69 195 /**
jpayne@69 196 * Return the reply
jpayne@69 197 * @param c The connection
jpayne@69 198 * @param cookie The cookie
jpayne@69 199 * @param e The xcb_generic_error_t supplied
jpayne@69 200 *
jpayne@69 201 * Returns the reply of the request asked by
jpayne@69 202 *
jpayne@69 203 * The parameter @p e supplied to this function must be NULL if
jpayne@69 204 * xcb_xc_misc_get_xid_range_unchecked(). is used.
jpayne@69 205 * Otherwise, it stores the error if any.
jpayne@69 206 *
jpayne@69 207 * The returned value must be freed by the caller using free().
jpayne@69 208 */
jpayne@69 209 xcb_xc_misc_get_xid_range_reply_t *
jpayne@69 210 xcb_xc_misc_get_xid_range_reply (xcb_connection_t *c,
jpayne@69 211 xcb_xc_misc_get_xid_range_cookie_t cookie /**< */,
jpayne@69 212 xcb_generic_error_t **e);
jpayne@69 213
jpayne@69 214 int
jpayne@69 215 xcb_xc_misc_get_xid_list_sizeof (const void *_buffer);
jpayne@69 216
jpayne@69 217 /**
jpayne@69 218 *
jpayne@69 219 * @param c The connection
jpayne@69 220 * @return A cookie
jpayne@69 221 *
jpayne@69 222 * Delivers a request to the X server.
jpayne@69 223 *
jpayne@69 224 */
jpayne@69 225 xcb_xc_misc_get_xid_list_cookie_t
jpayne@69 226 xcb_xc_misc_get_xid_list (xcb_connection_t *c,
jpayne@69 227 uint32_t count);
jpayne@69 228
jpayne@69 229 /**
jpayne@69 230 *
jpayne@69 231 * @param c The connection
jpayne@69 232 * @return A cookie
jpayne@69 233 *
jpayne@69 234 * Delivers a request to the X server.
jpayne@69 235 *
jpayne@69 236 * This form can be used only if the request will cause
jpayne@69 237 * a reply to be generated. Any returned error will be
jpayne@69 238 * placed in the event queue.
jpayne@69 239 */
jpayne@69 240 xcb_xc_misc_get_xid_list_cookie_t
jpayne@69 241 xcb_xc_misc_get_xid_list_unchecked (xcb_connection_t *c,
jpayne@69 242 uint32_t count);
jpayne@69 243
jpayne@69 244 uint32_t *
jpayne@69 245 xcb_xc_misc_get_xid_list_ids (const xcb_xc_misc_get_xid_list_reply_t *R);
jpayne@69 246
jpayne@69 247 int
jpayne@69 248 xcb_xc_misc_get_xid_list_ids_length (const xcb_xc_misc_get_xid_list_reply_t *R);
jpayne@69 249
jpayne@69 250 xcb_generic_iterator_t
jpayne@69 251 xcb_xc_misc_get_xid_list_ids_end (const xcb_xc_misc_get_xid_list_reply_t *R);
jpayne@69 252
jpayne@69 253 /**
jpayne@69 254 * Return the reply
jpayne@69 255 * @param c The connection
jpayne@69 256 * @param cookie The cookie
jpayne@69 257 * @param e The xcb_generic_error_t supplied
jpayne@69 258 *
jpayne@69 259 * Returns the reply of the request asked by
jpayne@69 260 *
jpayne@69 261 * The parameter @p e supplied to this function must be NULL if
jpayne@69 262 * xcb_xc_misc_get_xid_list_unchecked(). is used.
jpayne@69 263 * Otherwise, it stores the error if any.
jpayne@69 264 *
jpayne@69 265 * The returned value must be freed by the caller using free().
jpayne@69 266 */
jpayne@69 267 xcb_xc_misc_get_xid_list_reply_t *
jpayne@69 268 xcb_xc_misc_get_xid_list_reply (xcb_connection_t *c,
jpayne@69 269 xcb_xc_misc_get_xid_list_cookie_t cookie /**< */,
jpayne@69 270 xcb_generic_error_t **e);
jpayne@69 271
jpayne@69 272
jpayne@69 273 #ifdef __cplusplus
jpayne@69 274 }
jpayne@69 275 #endif
jpayne@69 276
jpayne@69 277 #endif
jpayne@69 278
jpayne@69 279 /**
jpayne@69 280 * @}
jpayne@69 281 */