dwm.h (view raw)
1/*
2 * (C)opyright MMVI Anselm R. Garbe <garbeam 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 mode is
29 * represented by the arrange() function pointer, which wether points to
30 * dofloat() or dotile().
31 *
32 * To understand everything else, start reading main.c:main().
33 */
34
35#include "config.h"
36#include <X11/Xlib.h>
37
38/* mask shorthands, used in event.c and client.c */
39#define BUTTONMASK (ButtonPressMask | ButtonReleaseMask)
40#define MOUSEMASK (BUTTONMASK | PointerMotionMask)
41/* other stuff used in different places */
42#define BORDERPX 1
43#define MINW 100
44#define PROTODELWIN 1
45
46enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */
47enum { WMProtocols, WMDelete, WMLast }; /* default atoms */
48enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */
49enum { ColFG, ColBG, ColLast }; /* color */
50
51typedef enum {
52 StackLeft, StackBottom, StackRight
53} StackPos; /* stack position*/
54
55typedef enum {
56 TopLeft, TopRight, BotLeft, BotRight
57} Corner; /* window corners */
58
59typedef union {
60 const char *cmd;
61 int i;
62} Arg; /* argument type */
63
64typedef struct {
65 int ascent;
66 int descent;
67 int height;
68 XFontSet set;
69 XFontStruct *xfont;
70} Fnt;
71
72typedef struct {
73 int x, y, w, h;
74 unsigned long norm[ColLast];
75 unsigned long sel[ColLast];
76 unsigned long status[ColLast];
77 Drawable drawable;
78 Fnt font;
79 GC gc;
80} DC; /* draw context */
81
82typedef struct Client Client;
83struct Client {
84 char name[256];
85 int proto;
86 int x, y, w, h;
87 int rx, ry, rw, rh; /* revert geometry */
88 int tx, ty, tw, th; /* title window geometry */
89 int basew, baseh, incw, inch, maxw, maxh, minw, minh;
90 int grav;
91 long flags;
92 unsigned int border, weight;
93 Bool isfloat, ismax;
94 Bool *tags;
95 Client *next;
96 Client *prev;
97 Client *snext;
98 Window win;
99 Window twin;
100};
101
102extern const char *tags[]; /* all tags */
103extern char stext[1024]; /* status text */
104extern int bx, by, bw, bh, bmw; /* bar geometry, bar mode label width */
105extern int master, screen, sx, sy, sw, sh; /* screen geometry, master dimension*/
106extern unsigned int ntags, numlockmask; /* number of tags, dynamic lock mask */
107extern void (*handler[LASTEvent])(XEvent *); /* event handler */
108extern void (*arrange)(Arg *); /* arrange function, indicates mode */
109extern Atom wmatom[WMLast], netatom[NetLast];
110extern Bool running, issel, *seltag; /* seltag is array of Bool */
111extern Bool isvertical; /* stack direction */
112extern Client *clients, *sel, *stack; /* global client list and stack */
113extern Cursor cursor[CurLast];
114extern DC dc; /* global draw context */
115extern Display *dpy;
116extern StackPos stackpos;
117extern Window root, barwin;
118
119/* client.c */
120extern void ban(Client *c); /* ban c from screen */
121extern void configure(Client *c); /* send synthetic configure event */
122extern void focus(Client *c); /* focus c, c may be NULL */
123extern Client *getclient(Window w); /* return client of w */
124extern Client *getctitle(Window w); /* return client of title window */
125extern void gravitate(Client *c, Bool invert); /* gravitate c */
126extern void killclient(Arg *arg); /* kill c nicely */
127extern void manage(Window w, XWindowAttributes *wa); /* manage new client */
128extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/
129extern void resizetitle(Client *c); /* resizes c->twin correctly */
130extern void updatesize(Client *c); /* update the size structs of c */
131extern void updatetitle(Client *c); /* update the name of c */
132extern void unmanage(Client *c); /* destroy c */
133
134/* draw.c */
135extern void drawall(void); /* draw all visible client titles and the bar */
136extern void drawstatus(void); /* draw the bar */
137extern void drawtitle(Client *c); /* draw title of c */
138extern unsigned long getcolor(const char *colstr); /* return color of colstr */
139extern void setfont(const char *fontstr); /* set the font for DC */
140extern unsigned int textw(const char *text); /* return the width of text in px*/
141
142/* event.c */
143extern void grabkeys(void); /* grab all keys defined in config.h */
144extern void procevent(void); /* process pending X events */
145
146/* main.c */
147extern int getproto(Window w); /* return protocol mask of WMProtocols property of w */
148extern void quit(Arg *arg); /* quit dwm nicely */
149extern void sendevent(Window w, Atom a, long value); /* send synthetic event to w */
150extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
151
152/* tag.c */
153extern void initrregs(void); /* initialize regexps of rules defined in config.h */
154extern Client *getnext(Client *c); /* returns next visible client */
155extern Client *getprev(Client *c); /* returns previous visible client */
156extern void settags(Client *c, Client *trans); /* sets tags of c */
157extern void tag(Arg *arg); /* tags c with arg's index */
158extern void toggletag(Arg *arg); /* toggles c tags with arg's index */
159
160/* util.c */
161extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
162extern void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */
163extern void *erealloc(void *ptr, unsigned int size); /* reallocates memory, exits on error */
164extern void spawn(Arg *arg); /* forks a new subprocess with to arg's cmd */
165
166/* view.c */
167extern void detach(Client *c); /* detaches c from global client list */
168extern void dofloat(Arg *arg); /* arranges all windows floating, arg is ignored */
169extern void dotile(Arg *arg); /* arranges all windows, arg is ignored */
170extern void focusnext(Arg *arg); /* focuses next visible client, arg is ignored */
171extern void focusprev(Arg *arg); /* focuses previous visible client, arg is ignored */
172extern Bool isvisible(Client *c); /* returns True if client is visible */
173extern void resizecol(Arg *arg); /* resizes the master dimension with arg's index value */
174extern void restack(void); /* restores z layers of all clients */
175extern void togglestackdir(Arg *arg); /* toggles stack direction */
176extern void togglestackpos(Arg *arg); /* toggles stack position */
177extern void togglemode(Arg *arg); /* toggles global arrange function (dotile/dofloat) */
178extern void toggleview(Arg *arg); /* toggles the tag with arg's index (in)visible */
179extern void updatemaster(void); /* updates master dimension */
180extern void view(Arg *arg); /* views the tag with arg's index */
181extern void viewall(Arg *arg); /* views all tags, arg is ignored */
182extern void zoom(Arg *arg); /* zooms the focused client to master area, arg is ignored */