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 mode is
28 * represented by the arrange() function pointer, which wether points to
29 * dofloat() or dotile().
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/* other stuff used in different places */
40#define PROTODELWIN 1
41
42enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */
43enum { WMProtocols, WMDelete, WMLast }; /* default atoms */
44enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */
45enum { ColBorder, ColFG, ColBG, ColLast }; /* color */
46
47typedef enum {
48 TopLeft, TopRight, BotLeft, BotRight
49} Corner; /* window corners */
50
51typedef union {
52 const char *cmd;
53 int i;
54} Arg; /* argument type */
55
56typedef struct {
57 int ascent;
58 int descent;
59 int height;
60 XFontSet set;
61 XFontStruct *xfont;
62} Fnt;
63
64typedef struct {
65 int x, y, w, h;
66 unsigned long norm[ColLast];
67 unsigned long sel[ColLast];
68 Drawable drawable;
69 Fnt font;
70 GC gc;
71} DC; /* draw context */
72
73typedef struct Client Client;
74struct Client {
75 char name[256];
76 int proto;
77 int x, y, w, h;
78 int rx, ry, rw, rh; /* revert geometry */
79 int basew, baseh, incw, inch, maxw, maxh, minw, minh;
80 long flags;
81 unsigned int border;
82 Bool isfloat, isfixed, ismax;
83 Bool *tags;
84 Client *next;
85 Client *prev;
86 Client *snext;
87 Window win;
88};
89
90extern const char *tags[]; /* all tags */
91extern char stext[256]; /* status text */
92extern int bh, bmw; /* bar height, bar mode label width */
93extern int screen, sx, sy, sw, sh; /* screen geometry */
94extern int wax, way, wah, waw; /* windowarea geometry */
95extern unsigned int master, nmaster; /* master percent, number of master clients */
96extern unsigned int ntags, numlockmask; /* number of tags, dynamic lock mask */
97extern void (*handler[LASTEvent])(XEvent *); /* event handler */
98extern void (*arrange)(void); /* arrange function, indicates mode */
99extern Atom wmatom[WMLast], netatom[NetLast];
100extern Bool running, issel, *seltag; /* seltag is array of Bool */
101extern Client *clients, *sel, *stack; /* global client list and stack */
102extern Cursor cursor[CurLast];
103extern DC dc; /* global draw context */
104extern Display *dpy;
105extern Window root, barwin;
106
107/* client.c */
108extern void configure(Client *c); /* send synthetic configure event */
109extern void focus(Client *c); /* focus c, c may be NULL */
110extern Client *getclient(Window w); /* return client of w */
111extern void killclient(Arg *arg); /* kill c nicely */
112extern void manage(Window w, XWindowAttributes *wa); /* manage new client */
113extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/
114extern void updatesizehints(Client *c); /* update the size hint variables of c */
115extern void updatetitle(Client *c); /* update the name of c */
116extern void unmanage(Client *c); /* destroy c */
117
118/* draw.c */
119extern void drawstatus(void); /* draw the bar */
120extern unsigned long getcolor(const char *colstr); /* return color of colstr */
121extern void setfont(const char *fontstr); /* set the font for DC */
122extern unsigned int textw(const char *text); /* return the width of text in px*/
123
124/* event.c */
125extern void grabkeys(void); /* grab all keys defined in config.h */
126extern void procevent(void); /* process pending X events */
127
128/* main.c */
129extern int getproto(Window w); /* return protocol mask of WMProtocols property of w */
130extern void quit(Arg *arg); /* quit dwm nicely */
131extern void sendevent(Window w, Atom a, long value); /* send synthetic event to w */
132extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
133
134/* tag.c */
135extern void initrregs(void); /* initialize regexps of rules defined in config.h */
136extern Client *getnext(Client *c); /* returns next visible client */
137extern Client *getprev(Client *c); /* returns previous visible client */
138extern void settags(Client *c, Client *trans); /* sets tags of c */
139extern void tag(Arg *arg); /* tags c with arg's index */
140extern void toggletag(Arg *arg); /* toggles c tags with arg's index */
141
142/* util.c */
143extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
144extern void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */
145extern void spawn(Arg *arg); /* forks a new subprocess with to arg's cmd */
146
147/* view.c */
148extern void detach(Client *c); /* detaches c from global client list */
149extern void dofloat(void); /* arranges all windows floating */
150extern void dotile(void); /* arranges all windows tiled */
151extern void focusnext(Arg *arg); /* focuses next visible client, arg is ignored */
152extern void focusprev(Arg *arg); /* focuses previous visible client, arg is ignored */
153extern void incnmaster(Arg *arg); /* increments nmaster with arg's index value */
154extern Bool isvisible(Client *c); /* returns True if client is visible */
155extern void resizemaster(Arg *arg); /* resizes the master percent with arg's index value */
156extern void restack(void); /* restores z layers of all clients */
157extern void togglefloat(Arg *arg); /* toggles focusesd client between floating/non-floating state */
158extern void togglemode(Arg *arg); /* toggles global arrange function (dotile/dofloat) */
159extern void toggleview(Arg *arg); /* toggles the tag with arg's index (in)visible */
160extern void view(Arg *arg); /* views the tag with arg's index */
161extern void zoom(Arg *arg); /* zooms the focused client to master area, arg is ignored */