dwm.h (view raw)
1/* (C)opyright MMVI-MMVII Anselm R. Garbe <garbeam at gmail dot com>
2 * See LICENSE file for license details.
3 *
4 * dynamic window manager is designed like any other X client as well. It is
5 * driven through handling X events. In contrast to other X clients, a window
6 * manager selects for SubstructureRedirectMask on the root window, to receive
7 * events about window (dis-)appearance. Only one X connection at a time is
8 * allowed to select for this event mask.
9 *
10 * Calls to fetch an X event from the event queue are blocking. Due reading
11 * status text from standard input, a select()-driven main loop has been
12 * implemented which selects for reads on the X connection and STDIN_FILENO to
13 * handle all data smoothly. The event handlers of dwm are organized in an
14 * array which is accessed whenever a new event has been fetched. This allows
15 * event dispatching in O(1) time.
16 *
17 * Each child of the root window is called a client, except windows which have
18 * set the override_redirect flag. Clients are organized in a global
19 * doubly-linked client list, the focus history is remembered through a global
20 * stack list. Each client contains an array of Bools of the same size as the
21 * global tags array to indicate the tags of a client. For each client dwm
22 * creates a small title window, which is resized whenever the (_NET_)WM_NAME
23 * properties are updated or the client is moved/resized.
24 *
25 * Keys and tagging rules are organized as arrays and defined in the config.h
26 * file. These arrays are kept static in event.o and tag.o respectively,
27 * because no other part of dwm needs access to them. The current layout is
28 * represented by the lt pointer.
29 *
30 * To understand everything else, start reading main.c:main().
31 */
32
33#include "config.h"
34#include <X11/Xlib.h>
35
36/* mask shorthands, used in event.c and client.c */
37#define BUTTONMASK (ButtonPressMask | ButtonReleaseMask)
38
39enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */
40enum { WMProtocols, WMDelete, WMState, WMLast }; /* default atoms */
41enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */
42enum { ColBorder, ColFG, ColBG, ColLast }; /* color */
43
44typedef struct {
45 int x, y, w, h;
46 unsigned long norm[ColLast];
47 unsigned long sel[ColLast];
48 Drawable drawable;
49 GC gc;
50 struct Fnt {
51 int ascent;
52 int descent;
53 int height;
54 XFontSet set;
55 XFontStruct *xfont;
56 } font;
57} DC; /* draw context */
58
59typedef struct Client Client;
60struct Client {
61 char name[256];
62 int x, y, w, h;
63 int rx, ry, rw, rh; /* revert geometry */
64 int basew, baseh, incw, inch, maxw, maxh, minw, minh;
65 int minax, minay, maxax, maxay;
66 long flags;
67 unsigned int border;
68 Bool isbanned, isfixed, ismax, isuntiled;
69 Bool *tags;
70 Client *next;
71 Client *prev;
72 Client *snext;
73 Window win;
74};
75
76typedef struct {
77 const char *symbol;
78 void (*arrange)(void);
79} Layout;
80
81extern const char *tags[]; /* all tags */
82extern char stext[256]; /* status text */
83extern int screen, sx, sy, sw, sh; /* screen geometry */
84extern int wax, way, wah, waw; /* windowarea geometry */
85extern unsigned int bh, blw; /* bar height, bar layout label width */
86extern unsigned int ntags, numlockmask; /* number of tags, dynamic lock mask */
87extern void (*handler[LASTEvent])(XEvent *); /* event handler */
88extern Atom wmatom[WMLast], netatom[NetLast];
89extern Bool selscreen, *seltag; /* seltag is array of Bool */
90extern Client *clients, *sel, *stack; /* global client list and stack */
91extern Cursor cursor[CurLast];
92extern DC dc; /* global draw context */
93extern Display *dpy;
94extern Layout *lt;
95extern Window root, barwin;
96
97/* client.c */
98extern void attach(Client *c); /* attaches c to global client list */
99extern void configure(Client *c); /* send synthetic configure event */
100extern void detach(Client *c); /* detaches c from global client list */
101extern void focus(Client *c); /* focus c, c may be NULL */
102extern void killclient(const char *arg); /* kill c nicely */
103extern void manage(Window w, XWindowAttributes *wa); /* manage new client */
104extern void resize(Client *c, int x, int y,
105 int w, int h, Bool sizehints); /* resize with given coordinates c*/
106extern void toggletiled(const char *arg); /* toggles focused client between tiled/untiled state */
107extern void updatesizehints(Client *c); /* update the size hint variables of c */
108extern void updatetitle(Client *c); /* update the name of c */
109extern void unmanage(Client *c); /* destroy c */
110
111/* draw.c */
112extern void drawstatus(void); /* draw the bar */
113extern void drawtext(const char *text, unsigned long col[ColLast]); /* draw text */
114extern unsigned int textw(const char *text); /* return the width of text in px*/
115
116/* event.c */
117extern void grabkeys(void); /* grab all keys defined in config.h */
118
119/* layout.c */
120extern void focusclient(const char *arg); /* focuses next(1)/previous(-1) visible client */
121extern void incmasterw(const char *arg); /* increments the master width with arg's index value */
122extern void incnmaster(const char *arg); /* increments nmaster with arg's index value */
123extern void initlayouts(void); /* initialize layout array */
124extern Client *nexttiled(Client *c); /* returns tiled successor of c */
125extern void restack(void); /* restores z layers of all clients */
126extern void setlayout(const char *arg); /* sets layout, -1 toggles */
127extern void togglemax(const char *arg); /* toggles maximization of untiled client */
128extern void untile(void); /* arranges all windows untiled */
129extern void zoom(const char *arg); /* zooms the focused client to master area, arg is ignored */
130
131/* main.c */
132extern void quit(const char *arg); /* quit dwm nicely */
133extern void sendevent(Window w, Atom a, long value); /* send synthetic event to w */
134extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
135
136/* tag.c */
137extern void compileregs(void); /* initialize regexps of rules defined in config.h */
138extern Bool isvisible(Client *c); /* returns True if client is visible */
139extern void settags(Client *c, Client *trans); /* sets tags of c */
140extern void tag(const char *arg); /* tags c with arg's index */
141extern void toggletag(const char *arg); /* toggles c tags with arg's index */
142extern void toggleview(const char *arg); /* toggles the tag with arg's index (in)visible */
143extern void view(const char *arg); /* views the tag with arg's index */
144
145/* util.c */
146extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
147extern void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */
148extern void spawn(const char *arg); /* forks a new subprocess with arg's cmd */
149