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 union {
45 const char *cmd;
46 int i;
47} Arg; /* argument type */
48
49typedef struct {
50 int ascent;
51 int descent;
52 int height;
53 XFontSet set;
54 XFontStruct *xfont;
55} Fnt;
56
57typedef struct {
58 int x, y, w, h;
59 unsigned long norm[ColLast];
60 unsigned long sel[ColLast];
61 Drawable drawable;
62 Fnt font;
63 GC gc;
64} DC; /* draw context */
65
66typedef struct Client Client;
67struct Client {
68 char name[256];
69 int x, y, w, h;
70 int rx, ry, rw, rh; /* revert geometry */
71 int basew, baseh, incw, inch, maxw, maxh, minw, minh;
72 int minax, minay, maxax, maxay;
73 long flags;
74 unsigned int border;
75 Bool isbanned, isfixed, ismax, isversatile;
76 Bool *tags;
77 Client *next;
78 Client *prev;
79 Client *snext;
80 Window win;
81};
82
83typedef struct {
84 const char *symbol;
85 void (*arrange)(void);
86} Layout;
87
88extern const char *tags[]; /* all tags */
89extern char stext[256]; /* status text */
90extern int screen, sx, sy, sw, sh; /* screen geometry */
91extern int wax, way, wah, waw; /* windowarea geometry */
92extern unsigned int bh, blw; /* bar height, bar layout label width */
93extern unsigned int ntags, numlockmask; /* number of tags, dynamic lock mask */
94extern void (*handler[LASTEvent])(XEvent *); /* event handler */
95extern Atom wmatom[WMLast], netatom[NetLast];
96extern Bool selscreen, *seltag; /* seltag is array of Bool */
97extern Client *clients, *sel, *stack; /* global client list and stack */
98extern Cursor cursor[CurLast];
99extern DC dc; /* global draw context */
100extern Display *dpy;
101extern Layout *lt;
102extern Window root, barwin;
103
104/* client.c */
105extern void attach(Client *c); /* attaches c to global client list */
106extern void configure(Client *c); /* send synthetic configure event */
107extern void detach(Client *c); /* detaches c from global client list */
108extern void focus(Client *c); /* focus c, c may be NULL */
109extern void killclient(Arg arg); /* kill c nicely */
110extern void manage(Window w, XWindowAttributes *wa); /* manage new client */
111extern void resize(Client *c, int x, int y,
112 int w, int h, Bool sizehints); /* resize with given coordinates c*/
113extern void toggleversatile(Arg arg); /* toggles focused client between versatile/and non-versatile state */
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 void drawtext(const char *text,
121 unsigned long col[ColLast]); /* draw text */
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 */
126
127/* layout.c */
128extern void focusnext(Arg arg); /* focuses next visible client, arg is ignored */
129extern void focusprev(Arg arg); /* focuses previous visible client, arg is ignored */
130extern void incmasterw(Arg arg); /* increments the master width with arg's index value */
131extern void incnmaster(Arg arg); /* increments nmaster with arg's index value */
132extern void initlayouts(void); /* initialize layout array */
133extern Client *nexttiled(Client *c); /* returns tiled successor of c */
134extern void restack(void); /* restores z layers of all clients */
135extern void setlayout(Arg arg); /* sets layout, -1 toggles */
136extern void togglemax(Arg arg); /* toggles maximization of versatile client */
137extern void versatile(void); /* arranges all windows versatile */
138
139/* main.c */
140extern void quit(Arg arg); /* quit dwm nicely */
141extern void sendevent(Window w, Atom a, long value); /* send synthetic event to w */
142extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
143
144/* tag.c */
145extern void compileregs(void); /* initialize regexps of rules defined in config.h */
146extern Bool isvisible(Client *c); /* returns True if client is visible */
147extern void settags(Client *c, Client *trans); /* sets tags of c */
148extern void tag(Arg arg); /* tags c with arg's index */
149extern void toggletag(Arg arg); /* toggles c tags with arg's index */
150extern void toggleview(Arg arg); /* toggles the tag with arg's index (in)visible */
151extern void view(Arg arg); /* views the tag with arg's index */
152extern void zoom(Arg arg); /* zooms the focused client to master area, arg is ignored */
153
154/* util.c */
155extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
156extern void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */
157extern void spawn(Arg arg); /* forks a new subprocess with arg's cmd */
158