summaryrefslogtreecommitdiff
path: root/src/xcb.h
blob: 18785abbc45164371a1a2459aab7aa49d2243f95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/*
 * Copyright (C) 2001-2004 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>

/* TODO: check for stdint in config? (HAVE_STDINT) fallback? */
#include <stdint.h>

typedef uint8_t  BYTE;
typedef uint8_t  BOOL;
typedef uint8_t  CARD8;
typedef uint16_t CARD16;
typedef uint32_t CARD32;
typedef int8_t   INT8;
typedef int16_t  INT16;
typedef int32_t  INT32;

#include <X11/X.h>
#include <sys/uio.h>
#include <pthread.h>

#ifdef __cplusplus
extern "C" {
#endif

#if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
#define deprecated __attribute__((__deprecated__))
#else
#define deprecated
#endif

/* Pre-defined constants */

/* current protocol version */
#define X_PROTOCOL 11

/* current minor version */
#define X_PROTOCOL_REVISION 0

/* X_TCP_PORT + display number = server port for TCP transport */
#define X_TCP_PORT 6000

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


/* Opaque structures */

typedef struct XCBConnection XCBConnection;


/* Other types */

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

typedef struct {
    BYTE response_type;
    CARD8 pad0;
    CARD16 sequence;
    CARD32 length;
} XCBGenericRep;

typedef struct {
    BYTE response_type;
    CARD8 pad0;
    CARD16 sequence;
    CARD32 pad[7];
    CARD32 full_sequence;
} XCBGenericEvent;

typedef struct {
    BYTE response_type;
    BYTE error_code;
    CARD16 sequence;
    CARD32 pad[7];
    CARD32 full_sequence;
} XCBGenericError;

typedef struct {
    unsigned int sequence;
} XCBVoidCookie;


/* Include the generated xproto and xcb_types headers. */
#include "xcb_types.h"
#include "xproto.h"


/* xcb_auth.c */

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

int XCBGetAuthInfo(int fd, XCBAuthInfo *info) deprecated;


/* xcb_out.c */

int XCBFlush(XCBConnection *c);
CARD32 XCBGetMaximumRequestLength(XCBConnection *c);


/* xcb_in.c */

XCBGenericEvent *XCBWaitEvent(XCBConnection *c) deprecated;
XCBGenericEvent *XCBWaitForEvent(XCBConnection *c);
XCBGenericEvent *XCBPollForEvent(XCBConnection *c, int *error);
unsigned int XCBGetRequestRead(XCBConnection *c);


/* xcb_ext.c */

typedef struct XCBExtension XCBExtension;

/* Do not free the returned XCBQueryExtensionRep - on return, it's aliased
 * from the cache. */
const XCBQueryExtensionRep *XCBGetExtensionData(XCBConnection *c, XCBExtension *ext);

void XCBPrefetchExtensionData(XCBConnection *c, XCBExtension *ext);


/* xcb_conn.c */

XCBConnSetupSuccessRep *XCBGetSetup(XCBConnection *c);
int XCBGetFileDescriptor(XCBConnection *c);

XCBConnection *XCBConnectToFD(int fd, XCBAuthInfo *auth_info);
void XCBDisconnect(XCBConnection *c);


/* xcb_util.c */

int XCBParseDisplay(const char *name, char **host, int *display, int *screen);
int XCBOpen(const char *host, int display) deprecated;
int XCBOpenTCP(const char *host, unsigned short port) deprecated;
int XCBOpenUnix(const char *file) deprecated;

XCBConnection *XCBConnectBasic(void) deprecated;
XCBConnection *XCBConnect(const char *displayname, int *screenp);
XCBConnection *XCBConnectToDisplayWithAuthInfo(const char *display, XCBAuthInfo *auth, int *screen);

int XCBSync(XCBConnection *c, XCBGenericError **e);


#ifdef __cplusplus
}
#endif

#endif