Mercurial > repos > rliterman > csp2

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 xevie.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_Xevie_API XCB Xevie API
jpayne@69 8 * @brief Xevie XCB Protocol Implementation.
jpayne@69 9 * @{
jpayne@69 10 **/
jpayne@69 11
jpayne@69 12 #ifndef __XEVIE_H
jpayne@69 13 #define __XEVIE_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_XEVIE_MAJOR_VERSION 1
jpayne@69 22 #define XCB_XEVIE_MINOR_VERSION 0
jpayne@69 23
jpayne@69 24 extern xcb_extension_t xcb_xevie_id;
jpayne@69 25
jpayne@69 26 /**
jpayne@69 27 * @brief xcb_xevie_query_version_cookie_t
jpayne@69 28 **/
jpayne@69 29 typedef struct xcb_xevie_query_version_cookie_t {
jpayne@69 30 unsigned int sequence;
jpayne@69 31 } xcb_xevie_query_version_cookie_t;
jpayne@69 32
jpayne@69 33 /** Opcode for xcb_xevie_query_version. */
jpayne@69 34 #define XCB_XEVIE_QUERY_VERSION 0
jpayne@69 35
jpayne@69 36 /**
jpayne@69 37 * @brief xcb_xevie_query_version_request_t
jpayne@69 38 **/
jpayne@69 39 typedef struct xcb_xevie_query_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_xevie_query_version_request_t;
jpayne@69 46
jpayne@69 47 /**
jpayne@69 48 * @brief xcb_xevie_query_version_reply_t
jpayne@69 49 **/
jpayne@69 50 typedef struct xcb_xevie_query_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 uint8_t pad1[20];
jpayne@69 58 } xcb_xevie_query_version_reply_t;
jpayne@69 59
jpayne@69 60 /**
jpayne@69 61 * @brief xcb_xevie_start_cookie_t
jpayne@69 62 **/
jpayne@69 63 typedef struct xcb_xevie_start_cookie_t {
jpayne@69 64 unsigned int sequence;
jpayne@69 65 } xcb_xevie_start_cookie_t;
jpayne@69 66
jpayne@69 67 /** Opcode for xcb_xevie_start. */
jpayne@69 68 #define XCB_XEVIE_START 1
jpayne@69 69
jpayne@69 70 /**
jpayne@69 71 * @brief xcb_xevie_start_request_t
jpayne@69 72 **/
jpayne@69 73 typedef struct xcb_xevie_start_request_t {
jpayne@69 74 uint8_t major_opcode;
jpayne@69 75 uint8_t minor_opcode;
jpayne@69 76 uint16_t length;
jpayne@69 77 uint32_t screen;
jpayne@69 78 } xcb_xevie_start_request_t;
jpayne@69 79
jpayne@69 80 /**
jpayne@69 81 * @brief xcb_xevie_start_reply_t
jpayne@69 82 **/
jpayne@69 83 typedef struct xcb_xevie_start_reply_t {
jpayne@69 84 uint8_t response_type;
jpayne@69 85 uint8_t pad0;
jpayne@69 86 uint16_t sequence;
jpayne@69 87 uint32_t length;
jpayne@69 88 uint8_t pad1[24];
jpayne@69 89 } xcb_xevie_start_reply_t;
jpayne@69 90
jpayne@69 91 /**
jpayne@69 92 * @brief xcb_xevie_end_cookie_t
jpayne@69 93 **/
jpayne@69 94 typedef struct xcb_xevie_end_cookie_t {
jpayne@69 95 unsigned int sequence;
jpayne@69 96 } xcb_xevie_end_cookie_t;
jpayne@69 97
jpayne@69 98 /** Opcode for xcb_xevie_end. */
jpayne@69 99 #define XCB_XEVIE_END 2
jpayne@69 100
jpayne@69 101 /**
jpayne@69 102 * @brief xcb_xevie_end_request_t
jpayne@69 103 **/
jpayne@69 104 typedef struct xcb_xevie_end_request_t {
jpayne@69 105 uint8_t major_opcode;
jpayne@69 106 uint8_t minor_opcode;
jpayne@69 107 uint16_t length;
jpayne@69 108 uint32_t cmap;
jpayne@69 109 } xcb_xevie_end_request_t;
jpayne@69 110
jpayne@69 111 /**
jpayne@69 112 * @brief xcb_xevie_end_reply_t
jpayne@69 113 **/
jpayne@69 114 typedef struct xcb_xevie_end_reply_t {
jpayne@69 115 uint8_t response_type;
jpayne@69 116 uint8_t pad0;
jpayne@69 117 uint16_t sequence;
jpayne@69 118 uint32_t length;
jpayne@69 119 uint8_t pad1[24];
jpayne@69 120 } xcb_xevie_end_reply_t;
jpayne@69 121
jpayne@69 122 typedef enum xcb_xevie_datatype_t {
jpayne@69 123 XCB_XEVIE_DATATYPE_UNMODIFIED = 0,
jpayne@69 124 XCB_XEVIE_DATATYPE_MODIFIED = 1
jpayne@69 125 } xcb_xevie_datatype_t;
jpayne@69 126
jpayne@69 127 /**
jpayne@69 128 * @brief xcb_xevie_event_t
jpayne@69 129 **/
jpayne@69 130 typedef struct xcb_xevie_event_t {
jpayne@69 131 uint8_t pad0[32];
jpayne@69 132 } xcb_xevie_event_t;
jpayne@69 133
jpayne@69 134 /**
jpayne@69 135 * @brief xcb_xevie_event_iterator_t
jpayne@69 136 **/
jpayne@69 137 typedef struct xcb_xevie_event_iterator_t {
jpayne@69 138 xcb_xevie_event_t *data;
jpayne@69 139 int rem;
jpayne@69 140 int index;
jpayne@69 141 } xcb_xevie_event_iterator_t;
jpayne@69 142
jpayne@69 143 /**
jpayne@69 144 * @brief xcb_xevie_send_cookie_t
jpayne@69 145 **/
jpayne@69 146 typedef struct xcb_xevie_send_cookie_t {
jpayne@69 147 unsigned int sequence;
jpayne@69 148 } xcb_xevie_send_cookie_t;
jpayne@69 149
jpayne@69 150 /** Opcode for xcb_xevie_send. */
jpayne@69 151 #define XCB_XEVIE_SEND 3
jpayne@69 152
jpayne@69 153 /**
jpayne@69 154 * @brief xcb_xevie_send_request_t
jpayne@69 155 **/
jpayne@69 156 typedef struct xcb_xevie_send_request_t {
jpayne@69 157 uint8_t major_opcode;
jpayne@69 158 uint8_t minor_opcode;
jpayne@69 159 uint16_t length;
jpayne@69 160 xcb_xevie_event_t event;
jpayne@69 161 uint32_t data_type;
jpayne@69 162 uint8_t pad0[64];
jpayne@69 163 } xcb_xevie_send_request_t;
jpayne@69 164
jpayne@69 165 /**
jpayne@69 166 * @brief xcb_xevie_send_reply_t
jpayne@69 167 **/
jpayne@69 168 typedef struct xcb_xevie_send_reply_t {
jpayne@69 169 uint8_t response_type;
jpayne@69 170 uint8_t pad0;
jpayne@69 171 uint16_t sequence;
jpayne@69 172 uint32_t length;
jpayne@69 173 uint8_t pad1[24];
jpayne@69 174 } xcb_xevie_send_reply_t;
jpayne@69 175
jpayne@69 176 /**
jpayne@69 177 * @brief xcb_xevie_select_input_cookie_t
jpayne@69 178 **/
jpayne@69 179 typedef struct xcb_xevie_select_input_cookie_t {
jpayne@69 180 unsigned int sequence;
jpayne@69 181 } xcb_xevie_select_input_cookie_t;
jpayne@69 182
jpayne@69 183 /** Opcode for xcb_xevie_select_input. */
jpayne@69 184 #define XCB_XEVIE_SELECT_INPUT 4
jpayne@69 185
jpayne@69 186 /**
jpayne@69 187 * @brief xcb_xevie_select_input_request_t
jpayne@69 188 **/
jpayne@69 189 typedef struct xcb_xevie_select_input_request_t {
jpayne@69 190 uint8_t major_opcode;
jpayne@69 191 uint8_t minor_opcode;
jpayne@69 192 uint16_t length;
jpayne@69 193 uint32_t event_mask;
jpayne@69 194 } xcb_xevie_select_input_request_t;
jpayne@69 195
jpayne@69 196 /**
jpayne@69 197 * @brief xcb_xevie_select_input_reply_t
jpayne@69 198 **/
jpayne@69 199 typedef struct xcb_xevie_select_input_reply_t {
jpayne@69 200 uint8_t response_type;
jpayne@69 201 uint8_t pad0;
jpayne@69 202 uint16_t sequence;
jpayne@69 203 uint32_t length;
jpayne@69 204 uint8_t pad1[24];
jpayne@69 205 } xcb_xevie_select_input_reply_t;
jpayne@69 206
jpayne@69 207 /**
jpayne@69 208 *
jpayne@69 209 * @param c The connection
jpayne@69 210 * @return A cookie
jpayne@69 211 *
jpayne@69 212 * Delivers a request to the X server.
jpayne@69 213 *
jpayne@69 214 */
jpayne@69 215 xcb_xevie_query_version_cookie_t
jpayne@69 216 xcb_xevie_query_version (xcb_connection_t *c,
jpayne@69 217 uint16_t client_major_version,
jpayne@69 218 uint16_t client_minor_version);
jpayne@69 219
jpayne@69 220 /**
jpayne@69 221 *
jpayne@69 222 * @param c The connection
jpayne@69 223 * @return A cookie
jpayne@69 224 *
jpayne@69 225 * Delivers a request to the X server.
jpayne@69 226 *
jpayne@69 227 * This form can be used only if the request will cause
jpayne@69 228 * a reply to be generated. Any returned error will be
jpayne@69 229 * placed in the event queue.
jpayne@69 230 */
jpayne@69 231 xcb_xevie_query_version_cookie_t
jpayne@69 232 xcb_xevie_query_version_unchecked (xcb_connection_t *c,
jpayne@69 233 uint16_t client_major_version,
jpayne@69 234 uint16_t client_minor_version);
jpayne@69 235
jpayne@69 236 /**
jpayne@69 237 * Return the reply
jpayne@69 238 * @param c The connection
jpayne@69 239 * @param cookie The cookie
jpayne@69 240 * @param e The xcb_generic_error_t supplied
jpayne@69 241 *
jpayne@69 242 * Returns the reply of the request asked by
jpayne@69 243 *
jpayne@69 244 * The parameter @p e supplied to this function must be NULL if
jpayne@69 245 * xcb_xevie_query_version_unchecked(). is used.
jpayne@69 246 * Otherwise, it stores the error if any.
jpayne@69 247 *
jpayne@69 248 * The returned value must be freed by the caller using free().
jpayne@69 249 */
jpayne@69 250 xcb_xevie_query_version_reply_t *
jpayne@69 251 xcb_xevie_query_version_reply (xcb_connection_t *c,
jpayne@69 252 xcb_xevie_query_version_cookie_t cookie /**< */,
jpayne@69 253 xcb_generic_error_t **e);
jpayne@69 254
jpayne@69 255 /**
jpayne@69 256 *
jpayne@69 257 * @param c The connection
jpayne@69 258 * @return A cookie
jpayne@69 259 *
jpayne@69 260 * Delivers a request to the X server.
jpayne@69 261 *
jpayne@69 262 */
jpayne@69 263 xcb_xevie_start_cookie_t
jpayne@69 264 xcb_xevie_start (xcb_connection_t *c,
jpayne@69 265 uint32_t screen);
jpayne@69 266
jpayne@69 267 /**
jpayne@69 268 *
jpayne@69 269 * @param c The connection
jpayne@69 270 * @return A cookie
jpayne@69 271 *
jpayne@69 272 * Delivers a request to the X server.
jpayne@69 273 *
jpayne@69 274 * This form can be used only if the request will cause
jpayne@69 275 * a reply to be generated. Any returned error will be
jpayne@69 276 * placed in the event queue.
jpayne@69 277 */
jpayne@69 278 xcb_xevie_start_cookie_t
jpayne@69 279 xcb_xevie_start_unchecked (xcb_connection_t *c,
jpayne@69 280 uint32_t screen);
jpayne@69 281
jpayne@69 282 /**
jpayne@69 283 * Return the reply
jpayne@69 284 * @param c The connection
jpayne@69 285 * @param cookie The cookie
jpayne@69 286 * @param e The xcb_generic_error_t supplied
jpayne@69 287 *
jpayne@69 288 * Returns the reply of the request asked by
jpayne@69 289 *
jpayne@69 290 * The parameter @p e supplied to this function must be NULL if
jpayne@69 291 * xcb_xevie_start_unchecked(). is used.
jpayne@69 292 * Otherwise, it stores the error if any.
jpayne@69 293 *
jpayne@69 294 * The returned value must be freed by the caller using free().
jpayne@69 295 */
jpayne@69 296 xcb_xevie_start_reply_t *
jpayne@69 297 xcb_xevie_start_reply (xcb_connection_t *c,
jpayne@69 298 xcb_xevie_start_cookie_t cookie /**< */,
jpayne@69 299 xcb_generic_error_t **e);
jpayne@69 300
jpayne@69 301 /**
jpayne@69 302 *
jpayne@69 303 * @param c The connection
jpayne@69 304 * @return A cookie
jpayne@69 305 *
jpayne@69 306 * Delivers a request to the X server.
jpayne@69 307 *
jpayne@69 308 */
jpayne@69 309 xcb_xevie_end_cookie_t
jpayne@69 310 xcb_xevie_end (xcb_connection_t *c,
jpayne@69 311 uint32_t cmap);
jpayne@69 312
jpayne@69 313 /**
jpayne@69 314 *
jpayne@69 315 * @param c The connection
jpayne@69 316 * @return A cookie
jpayne@69 317 *
jpayne@69 318 * Delivers a request to the X server.
jpayne@69 319 *
jpayne@69 320 * This form can be used only if the request will cause
jpayne@69 321 * a reply to be generated. Any returned error will be
jpayne@69 322 * placed in the event queue.
jpayne@69 323 */
jpayne@69 324 xcb_xevie_end_cookie_t
jpayne@69 325 xcb_xevie_end_unchecked (xcb_connection_t *c,
jpayne@69 326 uint32_t cmap);
jpayne@69 327
jpayne@69 328 /**
jpayne@69 329 * Return the reply
jpayne@69 330 * @param c The connection
jpayne@69 331 * @param cookie The cookie
jpayne@69 332 * @param e The xcb_generic_error_t supplied
jpayne@69 333 *
jpayne@69 334 * Returns the reply of the request asked by
jpayne@69 335 *
jpayne@69 336 * The parameter @p e supplied to this function must be NULL if
jpayne@69 337 * xcb_xevie_end_unchecked(). is used.
jpayne@69 338 * Otherwise, it stores the error if any.
jpayne@69 339 *
jpayne@69 340 * The returned value must be freed by the caller using free().
jpayne@69 341 */
jpayne@69 342 xcb_xevie_end_reply_t *
jpayne@69 343 xcb_xevie_end_reply (xcb_connection_t *c,
jpayne@69 344 xcb_xevie_end_cookie_t cookie /**< */,
jpayne@69 345 xcb_generic_error_t **e);
jpayne@69 346
jpayne@69 347 /**
jpayne@69 348 * Get the next element of the iterator
jpayne@69 349 * @param i Pointer to a xcb_xevie_event_iterator_t
jpayne@69 350 *
jpayne@69 351 * Get the next element in the iterator. The member rem is
jpayne@69 352 * decreased by one. The member data points to the next
jpayne@69 353 * element. The member index is increased by sizeof(xcb_xevie_event_t)
jpayne@69 354 */
jpayne@69 355 void
jpayne@69 356 xcb_xevie_event_next (xcb_xevie_event_iterator_t *i);
jpayne@69 357
jpayne@69 358 /**
jpayne@69 359 * Return the iterator pointing to the last element
jpayne@69 360 * @param i An xcb_xevie_event_iterator_t
jpayne@69 361 * @return The iterator pointing to the last element
jpayne@69 362 *
jpayne@69 363 * Set the current element in the iterator to the last element.
jpayne@69 364 * The member rem is set to 0. The member data points to the
jpayne@69 365 * last element.
jpayne@69 366 */
jpayne@69 367 xcb_generic_iterator_t
jpayne@69 368 xcb_xevie_event_end (xcb_xevie_event_iterator_t i);
jpayne@69 369
jpayne@69 370 /**
jpayne@69 371 *
jpayne@69 372 * @param c The connection
jpayne@69 373 * @return A cookie
jpayne@69 374 *
jpayne@69 375 * Delivers a request to the X server.
jpayne@69 376 *
jpayne@69 377 */
jpayne@69 378 xcb_xevie_send_cookie_t
jpayne@69 379 xcb_xevie_send (xcb_connection_t *c,
jpayne@69 380 xcb_xevie_event_t event,
jpayne@69 381 uint32_t data_type);
jpayne@69 382
jpayne@69 383 /**
jpayne@69 384 *
jpayne@69 385 * @param c The connection
jpayne@69 386 * @return A cookie
jpayne@69 387 *
jpayne@69 388 * Delivers a request to the X server.
jpayne@69 389 *
jpayne@69 390 * This form can be used only if the request will cause
jpayne@69 391 * a reply to be generated. Any returned error will be
jpayne@69 392 * placed in the event queue.
jpayne@69 393 */
jpayne@69 394 xcb_xevie_send_cookie_t
jpayne@69 395 xcb_xevie_send_unchecked (xcb_connection_t *c,
jpayne@69 396 xcb_xevie_event_t event,
jpayne@69 397 uint32_t data_type);
jpayne@69 398
jpayne@69 399 /**
jpayne@69 400 * Return the reply
jpayne@69 401 * @param c The connection
jpayne@69 402 * @param cookie The cookie
jpayne@69 403 * @param e The xcb_generic_error_t supplied
jpayne@69 404 *
jpayne@69 405 * Returns the reply of the request asked by
jpayne@69 406 *
jpayne@69 407 * The parameter @p e supplied to this function must be NULL if
jpayne@69 408 * xcb_xevie_send_unchecked(). is used.
jpayne@69 409 * Otherwise, it stores the error if any.
jpayne@69 410 *
jpayne@69 411 * The returned value must be freed by the caller using free().
jpayne@69 412 */
jpayne@69 413 xcb_xevie_send_reply_t *
jpayne@69 414 xcb_xevie_send_reply (xcb_connection_t *c,
jpayne@69 415 xcb_xevie_send_cookie_t cookie /**< */,
jpayne@69 416 xcb_generic_error_t **e);
jpayne@69 417
jpayne@69 418 /**
jpayne@69 419 *
jpayne@69 420 * @param c The connection
jpayne@69 421 * @return A cookie
jpayne@69 422 *
jpayne@69 423 * Delivers a request to the X server.
jpayne@69 424 *
jpayne@69 425 */
jpayne@69 426 xcb_xevie_select_input_cookie_t
jpayne@69 427 xcb_xevie_select_input (xcb_connection_t *c,
jpayne@69 428 uint32_t event_mask);
jpayne@69 429
jpayne@69 430 /**
jpayne@69 431 *
jpayne@69 432 * @param c The connection
jpayne@69 433 * @return A cookie
jpayne@69 434 *
jpayne@69 435 * Delivers a request to the X server.
jpayne@69 436 *
jpayne@69 437 * This form can be used only if the request will cause
jpayne@69 438 * a reply to be generated. Any returned error will be
jpayne@69 439 * placed in the event queue.
jpayne@69 440 */
jpayne@69 441 xcb_xevie_select_input_cookie_t
jpayne@69 442 xcb_xevie_select_input_unchecked (xcb_connection_t *c,
jpayne@69 443 uint32_t event_mask);
jpayne@69 444
jpayne@69 445 /**
jpayne@69 446 * Return the reply
jpayne@69 447 * @param c The connection
jpayne@69 448 * @param cookie The cookie
jpayne@69 449 * @param e The xcb_generic_error_t supplied
jpayne@69 450 *
jpayne@69 451 * Returns the reply of the request asked by
jpayne@69 452 *
jpayne@69 453 * The parameter @p e supplied to this function must be NULL if
jpayne@69 454 * xcb_xevie_select_input_unchecked(). is used.
jpayne@69 455 * Otherwise, it stores the error if any.
jpayne@69 456 *
jpayne@69 457 * The returned value must be freed by the caller using free().
jpayne@69 458 */
jpayne@69 459 xcb_xevie_select_input_reply_t *
jpayne@69 460 xcb_xevie_select_input_reply (xcb_connection_t *c,
jpayne@69 461 xcb_xevie_select_input_cookie_t cookie /**< */,
jpayne@69 462 xcb_generic_error_t **e);
jpayne@69 463
jpayne@69 464
jpayne@69 465 #ifdef __cplusplus
jpayne@69 466 }
jpayne@69 467 #endif
jpayne@69 468
jpayne@69 469 #endif
jpayne@69 470
jpayne@69 471 /**
jpayne@69 472 * @}
jpayne@69 473 */