git.sur5r.net Git - i3/i3/blob - src/xcb.c

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * xcb.c: Helper functions for easier usage of XCB
   8  *
   9  */
  10 #include "all.h"
  11
  12 unsigned int xcb_numlock_mask;
  13
  14 /*
  15  * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
  16  * for errors.
  17  *
  18  */
  19 xcb_window_t create_window(xcb_connection_t *conn, Rect dims,
  20                            uint16_t depth, xcb_visualid_t visual, uint16_t window_class,
  21                            enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values) {
  22     xcb_window_t result = xcb_generate_id(conn);
  23
  24     /* If the window class is XCB_WINDOW_CLASS_INPUT_ONLY, we copy depth and
  25      * visual id from the parent window. */
  26     if (window_class == XCB_WINDOW_CLASS_INPUT_ONLY) {
  27         depth = XCB_COPY_FROM_PARENT;
  28         visual = XCB_COPY_FROM_PARENT;
  29     }
  30
  31     xcb_create_window(conn,
  32                       depth,
  33                       result,                                  /* the window id */
  34                       root,                                    /* parent == root */
  35                       dims.x, dims.y, dims.width, dims.height, /* dimensions */
  36                       0,                                       /* border = 0, we draw our own */
  37                       window_class,
  38                       visual,
  39                       mask,
  40                       values);
  41
  42     /* Set the cursor */
  43     if (xcursor_supported) {
  44         mask = XCB_CW_CURSOR;
  45         values[0] = xcursor_get_cursor(cursor);
  46         xcb_change_window_attributes(conn, result, mask, values);
  47     } else {
  48         xcb_cursor_t cursor_id = xcb_generate_id(conn);
  49         i3Font cursor_font = load_font("cursor", false);
  50         int xcb_cursor = xcursor_get_xcb_cursor(cursor);
  51         xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
  52                                 cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
  53                                 65535, 65535, 65535);
  54         xcb_change_window_attributes(conn, result, XCB_CW_CURSOR, &cursor_id);
  55         xcb_free_cursor(conn, cursor_id);
  56     }
  57
  58     /* Map the window (= make it visible) */
  59     if (map)
  60         xcb_map_window(conn, result);
  61
  62     return result;
  63 }
  64
  65 /*
  66  * Draws a line from x,y to to_x,to_y using the given color
  67  *
  68  */
  69 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
  70                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y) {
  71     xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]){colorpixel});
  72     xcb_poly_line(conn, XCB_COORD_MODE_ORIGIN, drawable, gc, 2,
  73                   (xcb_point_t[]){{x, y}, {to_x, to_y}});
  74 }
  75
  76 /*
  77  * Draws a rectangle from x,y with width,height using the given color
  78  *
  79  */
  80 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
  81                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height) {
  82     xcb_change_gc(conn, gc, XCB_GC_FOREGROUND, (uint32_t[]){colorpixel});
  83     xcb_rectangle_t rect = {x, y, width, height};
  84     xcb_poly_fill_rectangle(conn, drawable, gc, 1, &rect);
  85 }
  86
  87 /*
  88  * Generates a configure_notify_event with absolute coordinates (relative to the X root
  89  * window, not to the client’s frame) for the given client.
  90  *
  91  */
  92 void fake_absolute_configure_notify(Con *con) {
  93     xcb_rectangle_t absolute;
  94     if (con->window == NULL)
  95         return;
  96
  97     absolute.x = con->rect.x + con->window_rect.x;
  98     absolute.y = con->rect.y + con->window_rect.y;
  99     absolute.width = con->window_rect.width;
 100     absolute.height = con->window_rect.height;
 101
 102     DLOG("fake rect = (%d, %d, %d, %d)\n", absolute.x, absolute.y, absolute.width, absolute.height);
 103
 104     fake_configure_notify(conn, absolute, con->window->id, con->border_width);
 105 }
 106
 107 /*
 108  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
 109  *
 110  */
 111 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp) {
 112     /* Every X11 event is 32 bytes long. Therefore, XCB will copy 32 bytes.
 113      * In order to properly initialize these bytes, we allocate 32 bytes even
 114      * though we only need less for an xcb_configure_notify_event_t */
 115     void *event = scalloc(32, 1);
 116     xcb_client_message_event_t *ev = event;
 117
 118     ev->response_type = XCB_CLIENT_MESSAGE;
 119     ev->window = window;
 120     ev->type = A_WM_PROTOCOLS;
 121     ev->format = 32;
 122     ev->data.data32[0] = A_WM_TAKE_FOCUS;
 123     ev->data.data32[1] = timestamp;
 124
 125     DLOG("Sending WM_TAKE_FOCUS to the client\n");
 126     xcb_send_event(conn, false, window, XCB_EVENT_MASK_NO_EVENT, (char *)ev);
 127     free(event);
 128 }
 129
 130 /*
 131  * Raises the given window (typically client->frame) above all other windows
 132  *
 133  */
 134 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window) {
 135     uint32_t values[] = {XCB_STACK_MODE_ABOVE};
 136     xcb_configure_window(conn, window, XCB_CONFIG_WINDOW_STACK_MODE, values);
 137 }
 138
 139 /*
 140  * Configures the given window to have the size/position specified by given rect
 141  *
 142  */
 143 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r) {
 144     xcb_void_cookie_t cookie;
 145     cookie = xcb_configure_window(conn, window,
 146                                   XCB_CONFIG_WINDOW_X |
 147                                       XCB_CONFIG_WINDOW_Y |
 148                                       XCB_CONFIG_WINDOW_WIDTH |
 149                                       XCB_CONFIG_WINDOW_HEIGHT,
 150                                   &(r.x));
 151     /* ignore events which are generated because we configured a window */
 152     add_ignore_event(cookie.sequence, -1);
 153 }
 154
 155 /*
 156  * Returns the first supported _NET_WM_WINDOW_TYPE atom.
 157  *
 158  */
 159 xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply) {
 160     if (reply == NULL || xcb_get_property_value_length(reply) == 0)
 161         return XCB_NONE;
 162
 163     xcb_atom_t *atoms;
 164     if ((atoms = xcb_get_property_value(reply)) == NULL)
 165         return XCB_NONE;
 166
 167     for (int i = 0; i < xcb_get_property_value_length(reply) / (reply->format / 8); i++) {
 168         if (atoms[i] == A__NET_WM_WINDOW_TYPE_NORMAL ||
 169             atoms[i] == A__NET_WM_WINDOW_TYPE_DIALOG ||
 170             atoms[i] == A__NET_WM_WINDOW_TYPE_UTILITY ||
 171             atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLBAR ||
 172             atoms[i] == A__NET_WM_WINDOW_TYPE_SPLASH ||
 173             atoms[i] == A__NET_WM_WINDOW_TYPE_MENU ||
 174             atoms[i] == A__NET_WM_WINDOW_TYPE_DROPDOWN_MENU ||
 175             atoms[i] == A__NET_WM_WINDOW_TYPE_POPUP_MENU ||
 176             atoms[i] == A__NET_WM_WINDOW_TYPE_TOOLTIP ||
 177             atoms[i] == A__NET_WM_WINDOW_TYPE_NOTIFICATION) {
 178             return atoms[i];
 179         }
 180     }
 181
 182     return XCB_NONE;
 183 }
 184
 185 /*
 186  * Returns true if the given reply contains the given atom.
 187  *
 188  */
 189 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom) {
 190     if (prop == NULL || xcb_get_property_value_length(prop) == 0)
 191         return false;
 192
 193     xcb_atom_t *atoms;
 194     if ((atoms = xcb_get_property_value(prop)) == NULL)
 195         return false;
 196
 197     for (int i = 0; i < xcb_get_property_value_length(prop) / (prop->format / 8); i++)
 198         if (atoms[i] == atom)
 199             return true;
 200
 201     return false;
 202 }
 203
 204 /**
 205  * Moves the mouse pointer into the middle of rect.
 206  *
 207  */
 208 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect) {
 209     int mid_x = rect->x + (rect->width / 2);
 210     int mid_y = rect->y + (rect->height / 2);
 211
 212     LOG("warp pointer to: %d %d\n", mid_x, mid_y);
 213     xcb_warp_pointer(conn, XCB_NONE, root, 0, 0, 0, 0, mid_x, mid_y);
 214 }
 215
 216 /*
 217  * Set the cursor of the root window to the given cursor id.
 218  * This function should only be used if xcursor_supported == false.
 219  * Otherwise, use xcursor_set_root_cursor().
 220  *
 221  */
 222 void xcb_set_root_cursor(int cursor) {
 223     xcb_cursor_t cursor_id = xcb_generate_id(conn);
 224     i3Font cursor_font = load_font("cursor", false);
 225     int xcb_cursor = xcursor_get_xcb_cursor(cursor);
 226     xcb_create_glyph_cursor(conn, cursor_id, cursor_font.specific.xcb.id,
 227                             cursor_font.specific.xcb.id, xcb_cursor, xcb_cursor + 1, 0, 0, 0,
 228                             65535, 65535, 65535);
 229     xcb_change_window_attributes(conn, root, XCB_CW_CURSOR, &cursor_id);
 230     xcb_free_cursor(conn, cursor_id);
 231     xcb_flush(conn);
 232 }
 233
 234 /*
 235  * Get depth of visual specified by visualid
 236  *
 237  */
 238 uint16_t get_visual_depth(xcb_visualid_t visual_id) {
 239     xcb_depth_iterator_t depth_iter;
 240
 241     depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
 242     for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
 243         xcb_visualtype_iterator_t visual_iter;
 244
 245         visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
 246         for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
 247             if (visual_id == visual_iter.data->visual_id) {
 248                 return depth_iter.data->depth;
 249             }
 250         }
 251     }
 252     return 0;
 253 }
 254
 255 /*
 256  * Get visual type specified by visualid
 257  *
 258  */
 259 xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id) {
 260     xcb_depth_iterator_t depth_iter;
 261
 262     depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
 263     for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
 264         xcb_visualtype_iterator_t visual_iter;
 265
 266         visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
 267         for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
 268             if (visual_id == visual_iter.data->visual_id) {
 269                 return visual_iter.data;
 270             }
 271         }
 272     }
 273     return 0;
 274 }
 275
 276 /*
 277  * Get visualid with specified depth
 278  *
 279  */
 280 xcb_visualid_t get_visualid_by_depth(uint16_t depth) {
 281     xcb_depth_iterator_t depth_iter;
 282
 283     depth_iter = xcb_screen_allowed_depths_iterator(root_screen);
 284     for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
 285         if (depth_iter.data->depth != depth)
 286             continue;
 287
 288         xcb_visualtype_iterator_t visual_iter;
 289
 290         visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
 291         if (!visual_iter.rem)
 292             continue;
 293         return visual_iter.data->visual_id;
 294     }
 295     return 0;
 296 }
 297
 298 /*
 299  * Add an atom to a list of atoms the given property defines.
 300  * This is useful, for example, for manipulating _NET_WM_STATE.
 301  *
 302  */
 303 void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
 304     xcb_change_property(conn, XCB_PROP_MODE_APPEND, window, property, XCB_ATOM_ATOM, 32, 1, (uint32_t[]){atom});
 305 }
 306
 307 /*
 308  * Remove an atom from a list of atoms the given property defines without
 309  * removing any other potentially set atoms.  This is useful, for example, for
 310  * manipulating _NET_WM_STATE.
 311  *
 312  */
 313 void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom) {
 314     xcb_grab_server(conn);
 315
 316     xcb_get_property_reply_t *reply =
 317         xcb_get_property_reply(conn,
 318                                xcb_get_property(conn, false, window, property, XCB_GET_PROPERTY_TYPE_ANY, 0, 4096), NULL);
 319     if (reply == NULL || xcb_get_property_value_length(reply) == 0)
 320         goto release_grab;
 321     xcb_atom_t *atoms = xcb_get_property_value(reply);
 322     if (atoms == NULL) {
 323         goto release_grab;
 324     }
 325
 326     {
 327         int num = 0;
 328         const int current_size = xcb_get_property_value_length(reply) / (reply->format / 8);
 329         xcb_atom_t values[current_size];
 330         for (int i = 0; i < current_size; i++) {
 331             if (atoms[i] != atom)
 332                 values[num++] = atoms[i];
 333         }
 334
 335         xcb_change_property(conn, XCB_PROP_MODE_REPLACE, window, property, XCB_ATOM_ATOM, 32, num, values);
 336     }
 337
 338 release_grab:
 339     FREE(reply);
 340     xcb_ungrab_server(conn);
 341 }
 342
 343 /*
 344  * Grab the specified buttons on a window when managing it.
 345  *
 346  */
 347 void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons) {
 348     int i = 0;
 349     while (buttons[i] > 0) {
 350         xcb_grab_button(conn, false, window, XCB_EVENT_MASK_BUTTON_PRESS, XCB_GRAB_MODE_SYNC,
 351                         XCB_GRAB_MODE_ASYNC, root, XCB_NONE, buttons[i], XCB_BUTTON_MASK_ANY);
 352
 353         i++;
 354     }
 355 }