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