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