xcb.h

Go to the documentation of this file.

/*
 * Copyright (C) 2001-2006 Bart Massey, Jamey Sharp, and Josh Triplett.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * Except as contained in this notice, the names of the authors or their
 * institutions shall not be used in advertising or otherwise to promote the
 * sale, use or other dealings in this Software without prior written
 * authorization from the authors.
 */

#ifndef __XCB_H__
#define __XCB_H__
#include <sys/types.h>

#if defined(__solaris__)
#include <inttypes.h>
#else
#include <stdint.h>
#endif

#ifndef _WIN32
#include <sys/uio.h>
#else
#include "xcb_windefs.h"
#endif
#include <pthread.h>


#ifdef __cplusplus
extern "C" {
#endif

#define XCB_PACKED __attribute__((__packed__))

/* Pre-defined constants */

#define X_PROTOCOL 11

#define X_PROTOCOL_REVISION 0

#define X_TCP_PORT 6000

#define XCB_CONN_ERROR 1

#define XCB_CONN_CLOSED_EXT_NOTSUPPORTED 2

#define XCB_CONN_CLOSED_MEM_INSUFFICIENT 3

#define XCB_CONN_CLOSED_REQ_LEN_EXCEED 4

#define XCB_CONN_CLOSED_PARSE_ERR 5

#define XCB_CONN_CLOSED_INVALID_SCREEN 6

#define XCB_CONN_CLOSED_FDPASSING_FAILED 7

#define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))

/* Opaque structures */

typedef struct xcb_connection_t xcb_connection_t;  
/* Other types */

typedef struct {
    void *data;   
    int rem;    
    int index;  
} xcb_generic_iterator_t;

typedef struct {
    uint8_t   response_type;  
    uint8_t  pad0;           
    uint16_t sequence;       
    uint32_t length;         
} xcb_generic_reply_t;

typedef struct {
    uint8_t   response_type;  
    uint8_t  pad0;           
    uint16_t sequence;       
    uint32_t pad[7];         
    uint32_t full_sequence;  
} xcb_generic_event_t;

typedef struct {
    uint8_t  response_type;  
    uint8_t  pad0;           
    uint16_t sequence;       
    uint32_t length;
    uint16_t event_type;
    uint16_t pad1;
    uint32_t pad[5];         
    uint32_t full_sequence;  
} xcb_ge_event_t;

typedef struct {
    uint8_t   response_type;  
    uint8_t   error_code;     
    uint16_t sequence;       
    uint32_t resource_id;     
    uint16_t minor_code;      
    uint8_t major_code;       
    uint8_t pad0;
    uint32_t pad[5];         
    uint32_t full_sequence;  
} xcb_generic_error_t;

typedef struct {
    unsigned int sequence;  
} xcb_void_cookie_t;


/* Include the generated xproto header. */
#include "xproto.h"


#define XCB_NONE 0L

#define XCB_COPY_FROM_PARENT 0L

#define XCB_CURRENT_TIME 0L

#define XCB_NO_SYMBOL 0L


/* xcb_auth.c */

typedef struct xcb_auth_info_t {
    int   namelen;  
    char *name;     
    int   datalen;  
    char *data;   
} xcb_auth_info_t;


/* xcb_out.c */

int xcb_flush(xcb_connection_t *c);

uint32_t xcb_get_maximum_request_length(xcb_connection_t *c);

void xcb_prefetch_maximum_request_length(xcb_connection_t *c);


/* xcb_in.c */

xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c);

xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c);

xcb_generic_event_t *xcb_poll_for_queued_event(xcb_connection_t *c);

typedef struct xcb_special_event xcb_special_event_t;

xcb_generic_event_t *xcb_poll_for_special_event(xcb_connection_t *c,
                                                xcb_special_event_t *se);

xcb_generic_event_t *xcb_wait_for_special_event(xcb_connection_t *c,
                                                xcb_special_event_t *se);
typedef struct xcb_extension_t xcb_extension_t;  
xcb_special_event_t *xcb_register_for_special_xge(xcb_connection_t *c,
                                                  xcb_extension_t *ext,
                                                  uint32_t eid,
                                                  uint32_t *stamp);

void xcb_unregister_for_special_event(xcb_connection_t *c,
                                      xcb_special_event_t *se);

xcb_generic_error_t *xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie);

void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence);

void xcb_discard_reply64(xcb_connection_t *c, uint64_t sequence);

/* xcb_ext.c */

const struct xcb_query_extension_reply_t *xcb_get_extension_data(xcb_connection_t *c, xcb_extension_t *ext);

void xcb_prefetch_extension_data(xcb_connection_t *c, xcb_extension_t *ext);


/* xcb_conn.c */

const struct xcb_setup_t *xcb_get_setup(xcb_connection_t *c);

int xcb_get_file_descriptor(xcb_connection_t *c);

int xcb_connection_has_error(xcb_connection_t *c);

xcb_connection_t *xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info);

void xcb_disconnect(xcb_connection_t *c);


/* xcb_util.c */

int xcb_parse_display(const char *name, char **host, int *display, int *screen);

xcb_connection_t *xcb_connect(const char *displayname, int *screenp);

xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen);


/* xcb_xid.c */

uint32_t xcb_generate_id(xcb_connection_t *c);


#ifdef __cplusplus
}
#endif


#endif /* __XCB_H__ */