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