i3
xcb.c
Go to the documentation of this file.
1 #undef I3__FILE__
2 #define I3__FILE__ "xcb.c"
3 /*
4  * vim:ts=4:sw=4:expandtab
5  *
6  * i3 - an improved dynamic tiling window manager
7  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
8  *
9  * xcb.c: Helper functions for easier usage of XCB
10  *
11  */
12 #include "all.h"
13 
14 unsigned int xcb_numlock_mask;
15 
16 /*
17  * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
18  * for errors.
19  *
20  */
21 xcb_window_t create_window(xcb_connection_t *conn, Rect dims,
22  uint16_t depth, xcb_visualid_t visual, uint16_t window_class,
23  enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values) {
24  xcb_window_t result = xcb_generate_id(conn);
25 
26  /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, we copy depth and
27  * visual id from the parent window. */
28  if (window_class == XCB_WINDOW_CLASS_INPUT_ONLY) {
29  depth = XCB_COPY_FROM_PARENT;
30  visual = XCB_COPY_FROM_PARENT;
31  }
32 
33  xcb_create_window(conn,
34  depth,
35  result, /* the window id */
36  root, /* parent == root */
37  dims.x, dims.y, dims.width, dims.height, /* dimensions */
38  0, /* border = 0, we draw our own */
39  window_class,
40  visual,
41  mask,
42  values);
43 
44  /* Set the cursor */
45  if (xcursor_supported) {
46  mask = XCB_CW_CURSOR;
47  values[0] = xcursor_get_cursor(cursor);
48  xcb_change_window_attributes(conn, result, mask, values);
49  } else {
50  xcb_cursor_t cursor_id = xcb_generate_id(conn);
51  i3Font cursor_font = load_font("cursor", false);
52  int xcb_cursor = xcursor_get_xcb_cursor(cursor);
53  xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
54  cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
55  65535, 65535, 65535);
56  xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
57  xcb_free_cursor(conn, cursor_id);
58  }
59 
60  /* Map the window (= make it visible) */
61  if (map)
62  xcb_map_window(conn, result);
63 
64  return result;
65 }
66 
67 /*
68  * Draws a line from x,y to to_x,to_y using the given color
69  *
70  */
71 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
72  uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
73  xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]) {colorpixel});
74  xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2,
75  (xcb_point_t[]) {{x, y}, {to_x, to_y}});
76 }
77 
78 /*
79  * Draws a rectangle from x,y with width,height using the given color
80  *
81  */
82 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
83  uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
84  xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]) {colorpixel});
85  xcb_rectangle_t rect = {x, y, width, height};
86  xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
87 }
88 
89 /*
90  * Generates a configure_notify_event with absolute coordinates (relative to the X root
91  * window, not to the client’s frame) for the given client.
92  *
93  */
95  xcb_rectangle_t absolute;
96  if (con->window == NULL)
97  return;
98 
99  absolute.x = con->rect.x + con->window_rect.x;
100  absolute.y = con->rect.y + con->window_rect.y;
101  absolute.width = con->window_rect.width;
102  absolute.height = con->window_rect.height;
103 
104  DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
105 
106  fake_configure_notify(conn, absolute, con->window->id, con->border_width);
107 }
108 
109 /*
110  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
111  *
112  */
113 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp) {
114  /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
115  * In order to properly initialize these bytes, we allocate 32 bytes even
116  * though we only need less for an xcb_configure_notify_event_t */
117  void *event = scalloc(32);
118  xcb_client_message_event_t *ev = event;
119 
120  ev->response_type = XCB_CLIENT_MESSAGE;
121  ev->window = window;
122  ev->type = A_WM_PROTOCOLS;
123  ev->format = 32;
124  ev->data.data32[0] = A_WM_TAKE_FOCUS;
125  ev->data.data32[1] = timestamp;
126 
127  DLOG("Sending WM_TAKE_FOCUS to the client\n");
128  xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char *)ev);
129  free(event);
130 }
131 
132 /*
133  * Raises the given window (typically client->frame) above all other windows
134  *
135  */
136 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
137  uint32_t values[] = {XCB_STACK_MODE_ABOVE};
138  xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
139 }
140 
141 /*
142  * Configures the given window to have the size/position specified by given rect
143  *
144  */
145 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
146  xcb_void_cookie_t cookie;
147  cookie = xcb_configure_window(conn, window,
148  XCB_CONFIG_WINDOW_X |
149  XCB_CONFIG_WINDOW_Y |
150  XCB_CONFIG_WINDOW_WIDTH |
151  XCB_CONFIG_WINDOW_HEIGHT,
152  &(r.x));
153  /* ignore events which are generated because we configured a window */
154  add_ignore_event(cookie.sequence, -1);
155 }
156 
157 /*
158  * Returns true if the given reply contains the given atom.
159  *
160  */
161 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
162  if (prop == NULL || xcb_get_property_value_length(prop) == 0)
163  return false;
164 
165  xcb_atom_t *atoms;
166  if ((atoms = xcb_get_property_value(prop)) == NULL)
167  return false;
168 
169  for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
170  if (atoms[i] == atom)
171  return true;
172 
173  return false;
174 }
175 
180 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect) {
181  int mid_x = rect->x + (rect->width / 2);
182  int mid_y = rect->y + (rect->height / 2);
183 
184  LOG("warp pointer to: %d %d\n", mid_x, mid_y);
185  xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0, mid_x, mid_y);
186 }
187 
188 /*
189  * Set the cursor of the root window to the given cursor id.
190  * This function should only be used if xcursor_supported == false.
191  * Otherwise, use xcursor_set_root_cursor().
192  *
193  */
194 void xcb_set_root_cursor(int cursor) {
195  xcb_cursor_t cursor_id = xcb_generate_id(conn);
196  i3Font cursor_font = load_font("cursor", false);
197  int xcb_cursor = xcursor_get_xcb_cursor(cursor);
198  xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
199  cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
200  65535, 65535, 65535);
201  xcb_change_window_attributes(conn, root, XCB_CW_CURSOR, &cursor_id);
202  xcb_free_cursor(conn, cursor_id);
203  xcb_flush(conn);
204 }
205 
206 /*
207  * Get depth of visual specified by visualid
208  *
209  */
210 uint16_t get_visual_depth(xcb_visualid_t visual_id) {
211  xcb_depth_iterator_t depth_iter;
212 
213  depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
214  for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
215  xcb_visualtype_iterator_t visual_iter;
216 
217  visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
218  for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
219  if (visual_id == visual_iter.data->visual_id) {
220  return depth_iter.data->depth;
221  }
222  }
223  }
224  return 0;
225 }
226 
227 /*
228  * Get visualid with specified depth
229  *
230  */
231 xcb_visualid_t get_visualid_by_depth(uint16_t depth) {
232  xcb_depth_iterator_t depth_iter;
233 
234  depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
235  for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
236  if (depth_iter.data->depth != depth)
237  continue;
238 
239  xcb_visualtype_iterator_t visual_iter;
240 
241  visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
242  if (!visual_iter.rem)
243  continue;
244  return visual_iter.data->visual_id;
245  }
246  return 0;
247 }
int xcursor_get_xcb_cursor(enum xcursor_cursor_t c)
Definition: xcursor.c:67
Con * con
The con for which this state is.
Definition: x.c:41
uint32_t y
Definition: data.h:124
uint32_t height
Definition: data.h:33
xcb_connection_t * conn
Definition: main.c:47
xcb_visualid_t visual_id
Definition: main.c:66
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:122
#define LOG(fmt,...)
Definition: libi3.h:76
xcursor_cursor_t
Definition: xcursor.h:14
struct Rect window_rect
Definition: data.h:515
struct Rect rect
Definition: data.h:514
bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom)
Definition: xcb.c:161
xcb_screen_t * root_screen
Definition: main.c:59
Data structure for cached font information:
Definition: libi3.h:38
struct Window * window
Definition: data.h:547
void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height)
Draws a rectangle from x,y with width,height using the given color.
Definition: xcb.c:82
uint32_t width
Definition: data.h:32
int border_width
Definition: data.h:540
void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp)
Sends the WM_TAKE_FOCUS ClientMessage to the given window.
Definition: xcb.c:113
bool xcursor_supported
Definition: main.c:96
void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y)
Draws a line from x,y to to_x,to_y using the given color.
Definition: xcb.c:71
#define DLOG(fmt,...)
Definition: libi3.h:86
union Font::@22 specific
Rect rect
Definition: x.c:49
void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window)
Raises the given window (typically client-&gt;frame) above all other windows.
Definition: xcb.c:136
uint32_t height
Definition: data.h:126
void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r)
Configures the given window to have the size/position specified by given rect.
Definition: xcb.c:145
xcb_cursor_t xcursor_get_cursor(enum xcursor_cursor_t c)
Definition: xcursor.c:62
void add_ignore_event(const int sequence, const int response_type)
Adds the given sequence to the list of events which are ignored.
void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect)
Moves the mouse pointer into the middle of rect.
Definition: xcb.c:180
xcb_visualid_t get_visualid_by_depth(uint16_t depth)
Get visualid with specified depth.
Definition: xcb.c:231
xcb_window_t create_window(xcb_connection_t *conn, Rect dims, uint16_t depth, xcb_visualid_t visual, uint16_t window_class, enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values)
Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking...
Definition: xcb.c:21
unsigned int xcb_numlock_mask
Definition: xcb.c:14
A &#39;Con&#39; represents everything from the X11 root window down to a single X11 window.
Definition: data.h:479
uint32_t x
Definition: data.h:123
void xcb_set_root_cursor(int cursor)
Set the cursor of the root window to the given cursor id.
Definition: xcb.c:194
void * scalloc(size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
void fake_configure_notify(xcb_connection_t *conn, xcb_rectangle_t r, xcb_window_t window, int border_width)
Generates a configure_notify event and sends it to the given window Applications need this to think t...
void fake_absolute_configure_notify(Con *con)
Generates a configure_notify_event with absolute coordinates (relative to the X root window...
Definition: xcb.c:94
xcb_window_t root
Definition: main.c:60
struct Font::@22::@23 xcb
uint32_t y
Definition: data.h:31
uint16_t get_visual_depth(xcb_visualid_t visual_id)
Get depth of visual specified by visualid.
Definition: xcb.c:210
xcb_window_t id
Definition: data.h:333
uint32_t x
Definition: data.h:30
i3Font load_font(const char *pattern, const bool fallback)
Loads a font for usage, also getting its height.
uint32_t width
Definition: data.h:125