]> git.sur5r.net Git - i3/i3/blobdiff - include/xcb.h
Merge pull request #1665 from Airblader/feature-1658
[i3/i3] / include / xcb.h
index 7f89caaf144881f8abc1226560bcd87a78ff768f..7dab5d100c8a39014dcc5d9f11db6588d853d3ab 100644 (file)
 /*
- * vim:ts=8:expandtab
+ * vim:ts=4:sw=4:expandtab
  *
  * i3 - an improved dynamic tiling window manager
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
  *
- * (c) 2009 Michael Stapelberg and contributors
- *
- * See file LICENSE for license information.
+ * xcb.c: Helper functions for easier usage of XCB
  *
  */
-#ifndef _XCB_H
-#define _XCB_H
+#pragma once
 
 #include "data.h"
+#include "xcursor.h"
 
-#define _NET_WM_STATE_REMOVE    0
-#define _NET_WM_STATE_ADD       1
-#define _NET_WM_STATE_TOGGLE    2
+#define _NET_WM_STATE_REMOVE 0
+#define _NET_WM_STATE_ADD 1
+#define _NET_WM_STATE_TOGGLE 2
 
-/* This is the equivalent of XC_left_ptr. I’m not sure why xcb doesn’t have a constant for that. */
-#define XCB_CURSOR_LEFT_PTR     68
+/** This is the equivalent of XC_left_ptr. I’m not sure why xcb doesn’t have a
+ * constant for that. */
+#define XCB_CURSOR_LEFT_PTR 68
 #define XCB_CURSOR_SB_H_DOUBLE_ARROW 108
 #define XCB_CURSOR_SB_V_DOUBLE_ARROW 116
+#define XCB_CURSOR_WATCH 150
 
 /* from X11/keysymdef.h */
-#define XCB_NUM_LOCK                    0xff7f
+#define XCB_NUM_LOCK 0xff7f
 
-/* The event masks are defined here because we don’t only set them once but we need to set slight
-   variations of them (without XCB_EVENT_MASK_ENTER_WINDOW while rendering the layout) */
-/* The XCB_CW_EVENT_MASK for the child (= real window) */
-#define CHILD_EVENT_MASK (XCB_EVENT_MASK_PROPERTY_CHANGE | \
+/* The event masks are defined here because we don’t only set them once but we
+   need to set slight variations of them (without XCB_EVENT_MASK_ENTER_WINDOW
+   while rendering the layout) */
+/** The XCB_CW_EVENT_MASK for the child (= real window) */
+#define CHILD_EVENT_MASK (XCB_EVENT_MASK_PROPERTY_CHANGE |  \
                           XCB_EVENT_MASK_STRUCTURE_NOTIFY | \
-                          XCB_EVENT_MASK_ENTER_WINDOW)
-
-/* The XCB_CW_EVENT_MASK for its frame */
-#define FRAME_EVENT_MASK (XCB_EVENT_MASK_BUTTON_PRESS |          /* …mouse is pressed/released */ \
-                          XCB_EVENT_MASK_BUTTON_RELEASE | \
-                          XCB_EVENT_MASK_EXPOSURE |              /* …our window needs to be redrawn */ \
-                          XCB_EVENT_MASK_STRUCTURE_NOTIFY |      /* …the frame gets destroyed */ \
+                          XCB_EVENT_MASK_FOCUS_CHANGE)
+
+/** The XCB_CW_EVENT_MASK for its frame */
+#define FRAME_EVENT_MASK (XCB_EVENT_MASK_BUTTON_PRESS | /* …mouse is pressed/released */                       \
+                          XCB_EVENT_MASK_BUTTON_RELEASE |                                                        \
+                          XCB_EVENT_MASK_POINTER_MOTION |        /* …mouse is moved */                         \
+                          XCB_EVENT_MASK_EXPOSURE |              /* …our window needs to be redrawn */         \
+                          XCB_EVENT_MASK_STRUCTURE_NOTIFY |      /* …the frame gets destroyed */               \
                           XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | /* …the application tries to resize itself */ \
-                          XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY |   /* …subwindows get notifies */ \
+                          XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY |   /* …subwindows get notifies */                \
                           XCB_EVENT_MASK_ENTER_WINDOW)           /* …user moves cursor inside our window */
 
+#define ROOT_EVENT_MASK (XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT |                                       \
+                         XCB_EVENT_MASK_BUTTON_PRESS |                                                \
+                         XCB_EVENT_MASK_STRUCTURE_NOTIFY | /* when the user adds a screen (e.g. video \
+                                                                  projector), the root window gets a  \
+                                                                  ConfigureNotify */                  \
+                         XCB_EVENT_MASK_POINTER_MOTION |                                              \
+                         XCB_EVENT_MASK_PROPERTY_CHANGE |                                             \
+                         XCB_EVENT_MASK_ENTER_WINDOW)
 
-enum { _NET_SUPPORTED = 0,
-        _NET_SUPPORTING_WM_CHECK,
-        _NET_WM_NAME,
-        _NET_WM_STATE_FULLSCREEN,
-        _NET_WM_STATE,
-        _NET_WM_WINDOW_TYPE,
-        _NET_WM_WINDOW_TYPE_DOCK,
-        _NET_WM_WINDOW_TYPE_DIALOG,
-        _NET_WM_DESKTOP,
-        _NET_WM_STRUT_PARTIAL,
-        WM_PROTOCOLS,
-        WM_DELETE_WINDOW,
-        UTF8_STRING,
-        WM_STATE
-};
+#define xmacro(atom) xcb_atom_t A_##atom;
+#include "atoms.xmacro"
+#undef xmacro
 
 extern unsigned int xcb_numlock_mask;
 
 /**
- * Loads a font for usage, getting its height. This function is used very often, so it
- * maintains a cache.
+ * Convenience wrapper around xcb_create_window which takes care of depth,
+ * generating an ID and checking for errors.
  *
  */
-i3Font *load_font(xcb_connection_t *conn, const char *pattern);
+xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t depth, xcb_visualid_t visual,
+                           uint16_t window_class, enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values);
 
 /**
- * Returns the colorpixel to use for the given hex color (think of HTML).
+ * Draws a line from x,y to to_x,to_y using the given color
  *
- * The hex_color has to start with #, for example #FF00FF.
+ */
+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 rectangle from x,y with width,height using the given color
  *
- * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
- * This has to be done by the caller.
+ */
+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);
+
+/**
+ * Generates a configure_notify_event with absolute coordinates (relative to
+ * the X root window, not to the client’s frame) for the given client.
  *
  */
-uint32_t get_colorpixel(xcb_connection_t *conn, char *hex);
+void fake_absolute_configure_notify(Con *con);
 
 /**
- * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
- * for errors.
+ * Sends the WM_TAKE_FOCUS ClientMessage to the given window
  *
  */
-xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t window_class, int cursor,
-                           uint32_t mask, uint32_t *values);
+void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp);
 
 /**
- * Changes a single value in the graphic context (so one doesn’t have to define an array of values)
+ * Raises the given window (typically client->frame) above all other windows
  *
  */
-void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value);
+void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
 
 /**
- * Draws a line from x,y to to_x,to_y using the given color
+ * Configures the given window to have the size/position specified by given rect
  *
  */
-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);
+void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
 
 /**
- * Draws a rectangle from x,y with width,height using the given color
+ * Returns the first supported _NET_WM_WINDOW_TYPE atom.
  *
  */
-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);
+xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply);
 
 /**
- * Generates a configure_notify event and sends it to the given window
- * Applications need this to think they’ve configured themselves correctly.
- * The truth is, however, that we will manage them.
+ * Returns true if the given reply contains the given data.
  *
  */
-void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window);
+bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
 
 /**
- * Generates a configure_notify_event with absolute coordinates (relative to the X root
- * window, not to the client’s frame) for the given client.
+ * Moves the mouse pointer into the middle of rect.
  *
  */
-void fake_absolute_configure_notify(xcb_connection_t *conn, Client *client);
+void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect);
 
 /**
- * Finds out which modifier mask is the one for numlock, as the user may change this.
+ * Set the cursor of the root window to the given cursor id.
+ * This function should only be used if xcursor_supported == false.
+ * Otherwise, use xcursor_set_root_cursor().
  *
  */
-void xcb_get_numlock_mask(xcb_connection_t *conn);
+void xcb_set_root_cursor(int cursor);
 
 /**
- * Raises the given window (typically client->frame) above all other windows
+ * Get depth of visual specified by visualid
  *
  */
-void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
+uint16_t get_visual_depth(xcb_visualid_t visual_id);
 
-#endif
+/**
+ * Get visualid with specified depth
+ *
+ */
+xcb_visualid_t get_visualid_by_depth(uint16_t depth);