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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/*
 * Copyright (C) 2013 James Miller <james@aatch.net>
 * Copyright (c) 2016
 *         Remi Thebault <remi.thebault@gmail.com>
 *         Thomas Bracht Laumann Jespersen <laumann.thomas@gmail.com>
 *
 * 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 OR COPYRIGHT HOLDERS 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.
 */

#![allow(dead_code)]
#![allow(unused_imports)]
#![allow(non_snake_case)]

//! Rust bindings to the XCB library.
//!
//! The X protocol C-language Binding (XCB - https://xcb.freedesktop.org/) is a
//! replacement for Xlib featuring a small footprint, latency hiding,
//! direct access to the protocol, improved threading support, and extensibility.
//!
//! The communication is established with the X server by the creation of a
//! `Connection` object.
//!
//! A client communicates with the server by sending requests. There are 2 types
//! of requests:
//!
//!   - void requests: requests that do not expect an answer (e.g. `ChangeProperty`)
//!   - non-void requests: requests that need a `Reply` (e.g. `GetProperty`)
//!
//! Void requests are normally unchecked. They are issued by the client, that
//! will normally not do anything else about it. For each such request, it exists
//! a variant with `_checked` suffix (e.g. `change_property` and `change_property_checked`)
//! that allows to receive a confirmation reply from the server via
//! `Connection::request_check`.
//!
//! Conversely, non-void requests are normally checked. When the client retrieves
//! the `Reply`, it can check for an `Error`. For each such request, it exists a variant
//! with `_unchecked` suffix (e.g. `get_property` and `get_property_unchecked`).
//! If this variant is used, the `Reply` is retrieved assuming that there was no error.
//!
//! The server can also communicate with clients by sending `Event`s.
//! The client listens to events with calls such as `Connection::wait_for_event`
//! (blocking) or `Connection::poll_for_event` (non-blocking).
//!
//! API documentation is detailed in modules `base` and `xproto`.
//!
//!  - `base`: contains `Connection` and a few utils
//!  - `xproto`: X protocol requests and events
//!
//! X protocol extensions are activated with cargo features

extern crate libc;
#[cfg(feature="xlib_xcb")]
extern crate x11;

#[macro_use]
extern crate log;

pub mod base;
pub mod xproto;
pub mod big_requests;
pub mod xc_misc;

pub use base::*;
pub use xproto::*;

#[cfg(feature = "composite")]
pub mod composite;

#[cfg(feature = "damage")]
pub mod damage;

#[cfg(feature = "dpms")]
pub mod dpms;

#[cfg(feature = "dri2")]
pub mod dri2;

#[cfg(feature = "dri3")]
pub mod dri3;

#[cfg(feature = "ge")]
pub mod genericevent;

#[cfg(feature = "glx")]
pub mod glx;

#[cfg(feature = "xinput")]
pub mod input;

#[cfg(feature = "present")]
pub mod present;

#[cfg(feature = "randr")]
pub mod randr;

#[cfg(feature = "record")]
pub mod record;

#[cfg(feature = "render")]
pub mod render;

#[cfg(feature = "res")]
pub mod res;

#[cfg(feature = "screensaver")]
pub mod screensaver;

#[cfg(feature = "xselinux")]
pub mod selinux;

#[cfg(feature = "shape")]
pub mod shape;

#[cfg(feature = "shm")]
pub mod shm;

#[cfg(feature = "sync")]
pub mod sync;

#[cfg(feature = "xtest")]
pub mod test;

#[cfg(feature = "xprint")]
pub mod x_print;

#[cfg(feature = "xevie")]
pub mod xevie;

#[cfg(feature = "xf86dri")]
pub mod xf86dri;

#[cfg(feature = "xf86vidmode")]
pub mod xf86vidmode;

#[cfg(feature = "xfixes")]
pub mod xfixes;

#[cfg(feature = "xinerama")]
pub mod xinerama;

#[cfg(feature = "xkb")]
pub mod xkb;

#[cfg(feature = "xvmc")]
pub mod xvmc;

#[cfg(feature = "xv")]
pub mod xv;


pub mod ffi
{
    #![allow(non_camel_case_types)]

    pub mod base;
    pub mod xproto;
    pub mod big_requests;
    pub mod xc_misc;

    pub use ffi::base::*;
    pub use ffi::xproto::*;


    #[cfg(feature = "xlib_xcb")]
    pub mod xlib_xcb;

    #[cfg(feature = "composite")]
    pub mod composite;

    #[cfg(feature = "damage")]
    pub mod damage;

    #[cfg(feature = "dpms")]
    pub mod dpms;

    #[cfg(feature = "dri2")]
    pub mod dri2;

    #[cfg(feature = "dri3")]
    pub mod dri3;

    #[cfg(feature = "ge")]
    pub mod genericevent;

    #[cfg(feature = "glx")]
    pub mod glx;

    #[cfg(feature = "xinput")]
    pub mod input;

    #[cfg(feature = "present")]
    pub mod present;

    #[cfg(feature = "randr")]
    pub mod randr;

    #[cfg(feature = "record")]
    pub mod record;

    #[cfg(feature = "render")]
    pub mod render;

    #[cfg(feature = "res")]
    pub mod res;

    #[cfg(feature = "screensaver")]
    pub mod screensaver;

    #[cfg(feature = "xselinux")]
    pub mod selinux;

    #[cfg(feature = "shape")]
    pub mod shape;

    #[cfg(feature = "shm")]
    pub mod shm;

    #[cfg(feature = "sync")]
    pub mod sync;

    #[cfg(feature = "xtest")]
    pub mod test;

    #[cfg(feature = "xprint")]
    pub mod x_print;

    #[cfg(feature = "xevie")]
    pub mod xevie;

    #[cfg(feature = "xf86dri")]
    pub mod xf86dri;

    #[cfg(feature = "xf86vidmode")]
    pub mod xf86vidmode;

    #[cfg(feature = "xfixes")]
    pub mod xfixes;

    #[cfg(feature = "xinerama")]
    pub mod xinerama;

    #[cfg(feature = "xkb")]
    pub mod xkb;

    #[cfg(feature = "xvmc")]
    pub mod xvmc;

    #[cfg(feature = "xv")]
    pub mod xv;
}