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