i3
xcb.h
Go to the documentation of this file.
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 #pragma once
11 
12 #include "data.h"
13 #include "xcursor.h"
14 
15 #define _NET_WM_STATE_REMOVE 0
16 #define _NET_WM_STATE_ADD 1
17 #define _NET_WM_STATE_TOGGLE 2
18 
21 #define XCB_CURSOR_LEFT_PTR 68
22 #define XCB_CURSOR_SB_H_DOUBLE_ARROW 108
23 #define XCB_CURSOR_SB_V_DOUBLE_ARROW 116
24 #define XCB_CURSOR_WATCH 150
25 
26 /* from X11/keysymdef.h */
27 #define XCB_NUM_LOCK 0xff7f
28 
29 /* The event masks are defined here because we don’t only set them once but we
30  need to set slight variations of them (without XCB_EVENT_MASK_ENTER_WINDOW
31  while rendering the layout) */
33 #define CHILD_EVENT_MASK (XCB_EVENT_MASK_PROPERTY_CHANGE | \
34  XCB_EVENT_MASK_STRUCTURE_NOTIFY | \
35  XCB_EVENT_MASK_FOCUS_CHANGE)
36 
38 #define FRAME_EVENT_MASK (XCB_EVENT_MASK_BUTTON_PRESS | /* …mouse is pressed/released */ \
39  XCB_EVENT_MASK_BUTTON_RELEASE | \
40  XCB_EVENT_MASK_POINTER_MOTION | /* …mouse is moved */ \
41  XCB_EVENT_MASK_EXPOSURE | /* …our window needs to be redrawn */ \
42  XCB_EVENT_MASK_STRUCTURE_NOTIFY | /* …the frame gets destroyed */ \
43  XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | /* …the application tries to resize itself */ \
44  XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY | /* …subwindows get notifies */ \
45  XCB_EVENT_MASK_ENTER_WINDOW) /* …user moves cursor inside our window */
46 
47 #define ROOT_EVENT_MASK (XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | \
48  XCB_EVENT_MASK_BUTTON_PRESS | \
49  XCB_EVENT_MASK_STRUCTURE_NOTIFY | /* when the user adds a screen (e.g. video \
50  projector), the root window gets a \
51  ConfigureNotify */ \
52  XCB_EVENT_MASK_POINTER_MOTION | \
53  XCB_EVENT_MASK_PROPERTY_CHANGE | \
54  XCB_EVENT_MASK_ENTER_WINDOW)
55 
56 #define xmacro(atom) xcb_atom_t A_##atom;
57 #include "atoms.xmacro"
58 #undef xmacro
59 
60 extern unsigned int xcb_numlock_mask;
61 
67 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t depth, xcb_visualid_t visual,
68  uint16_t window_class, enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values);
69 
74 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable,
75  xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
76  uint32_t y, uint32_t to_x, uint32_t to_y);
77 
82 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable,
83  xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
84  uint32_t y, uint32_t width, uint32_t height);
85 
92 
97 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp);
98 
103 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
104 
109 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
110 
115 xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply);
116 
121 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
122 
127 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect);
128 
135 void xcb_set_root_cursor(int cursor);
136 
141 uint16_t get_visual_depth(xcb_visualid_t visual_id);
142 
147 xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id);
148 
153 xcb_visualid_t get_visualid_by_depth(uint16_t depth);
154 
160 void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
161 
168 void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
169 
174 void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, bool bind_scrollwheel);
uint32_t width
Definition: data.h:122
bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom)
Returns true if the given reply contains the given data.
Definition: xcb.c:191
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
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
void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, bool bind_scrollwheel)
Grab the specified buttons on a window when managing it.
Definition: xcb.c:349
unsigned int xcb_numlock_mask
Definition: xcb.c:14
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:43
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
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
xcursor_cursor_t
Definition: xcursor.h:14
uint32_t x
Definition: data.h:120
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:141
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
void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom)
Add an atom to a list of atoms the given property defines.
Definition: xcb.c:305
uint32_t y
Definition: data.h:121
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition: data.h:544
void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect)
Moves the mouse pointer into the middle of rect.
Definition: xcb.c:210
uint32_t height
Definition: data.h:123
xcb_visualid_t visual_id
void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window)
Raises the given window (typically client->frame) above all other windows.
Definition: xcb.c:136
uint16_t get_visual_depth(xcb_visualid_t visual_id)
Get depth of visual specified by visualid.
Definition: xcb.c:240
void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom)
Remove an atom from a list of atoms the given property defines without removing any other potentially...
Definition: xcb.c:315
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_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply)
Returns the first supported _NET_WM_WINDOW_TYPE atom.
Definition: xcb.c:161
xcb_visualid_t get_visualid_by_depth(uint16_t depth)
Get visualid with specified depth.
Definition: xcb.c:282
void xcb_set_root_cursor(int cursor)
Set the cursor of the root window to the given cursor id.
Definition: xcb.c:224
xcb_visualtype_t * get_visualtype_by_id(xcb_visualid_t visual_id)
Get visual type specified by visualid.
Definition: xcb.c:261