JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
c07229a2112dbfa2c259a05366db70112fac8a74
[dwm.git] / dwm.h
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
40 enum { NetSupported, NetWMName, NetLast };              /* EWMH atoms */
41 enum { WMProtocols, WMDelete, WMState, WMLast };        /* default atoms */
42 enum { CurNormal, CurResize, CurMove, CurLast };        /* cursor */
43 enum { ColBorder, ColFG, ColBG, ColLast };              /* color */
44
45 typedef union {
46         const char *cmd;
47         int i;
48 } Arg; /* argument type */
49
50 typedef struct {
51         int ascent;
52         int descent;
53         int height;
54         XFontSet set;
55         XFontStruct *xfont;
56 } Fnt;
57
58 typedef 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
67 typedef struct Client Client;
68 struct 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
84 extern const char *tags[];                      /* all tags */
85 extern char stext[256];                         /* status text */
86 extern int bh, bmw;                             /* bar height, bar mode label width */
87 extern int screen, sx, sy, sw, sh;              /* screen geometry */
88 extern int wax, way, wah, waw;                  /* windowarea geometry */
89 extern unsigned int master, nmaster;            /* master percent, number of master clients */
90 extern unsigned int ntags, numlockmask;         /* number of tags, dynamic lock mask */
91 extern void (*handler[LASTEvent])(XEvent *);    /* event handler */
92 extern void (*arrange)(void);                   /* arrange function, indicates mode  */
93 extern Atom wmatom[WMLast], netatom[NetLast];
94 extern Bool running, selscreen, *seltag;        /* seltag is array of Bool */
95 extern Client *clients, *sel, *stack;           /* global client list and stack */
96 extern Cursor cursor[CurLast];
97 extern DC dc;                                   /* global draw context */
98 extern Display *dpy;
99 extern Window root, barwin;
100
101 /* client.c */
102 extern void configure(Client *c);               /* send synthetic configure event */
103 extern void focus(Client *c);                   /* focus c, c may be NULL */
104 extern Client *getclient(Window w);             /* return client of w */
105 extern Bool isprotodel(Client *c);              /* returns True if c->win supports wmatom[WMDelete] */
106 extern void killclient(Arg *arg);               /* kill c nicely */
107 extern void manage(Window w, XWindowAttributes *wa);    /* manage new client */
108 extern void resize(Client *c, int x, int y,
109                 int w, int h, Bool sizehints);  /* resize c*/
110 extern void updatesizehints(Client *c);         /* update the size hint variables of c */
111 extern void updatetitle(Client *c);             /* update the name of c */
112 extern void unmanage(Client *c);                /* destroy c */
113
114 /* draw.c */
115 extern void drawstatus(void);                   /* draw the bar */
116 extern unsigned long getcolor(const char *colstr);      /* return color of colstr */
117 extern void setfont(const char *fontstr);       /* set the font for DC */
118 extern unsigned int textw(const char *text);    /* return the width of text in px*/
119
120 /* event.c */
121 extern void grabkeys(void);                     /* grab all keys defined in config.h */
122 extern void procevent(void);                    /* process pending X events */
123
124 /* main.c */
125 extern void quit(Arg *arg);                     /* quit dwm nicely */
126 extern void sendevent(Window w, Atom a, long value);    /* send synthetic event to w */
127 extern int xerror(Display *dsply, XErrorEvent *ee);     /* dwm's X error handler */
128
129 /* tag.c */
130 extern void compileregexps(void);               /* initialize regexps of rules defined in config.h */
131 extern void settags(Client *c, Client *trans);  /* sets tags of c */
132 extern void tag(Arg *arg);                      /* tags c with arg's index */
133 extern void toggletag(Arg *arg);                /* toggles c tags with arg's index */
134
135 /* tile.c */
136 extern void dotile(void);                       /* arranges all windows tiled */
137 extern void incnmaster(Arg *arg);               /* increments nmaster with arg's index value */
138 extern void resizemaster(Arg *arg);             /* resizes the master percent with arg's index value */
139 extern void zoom(Arg *arg);                     /* zooms the focused client to master area, arg is ignored */
140
141 /* util.c */
142 extern void *emallocz(unsigned int size);       /* allocates zero-initialized memory, exits on error */
143 extern void eprint(const char *errstr, ...);    /* prints errstr and exits with 1 */
144 extern void spawn(Arg *arg);                    /* forks a new subprocess with to arg's cmd */
145
146 /* view.c */
147 extern void detach(Client *c);                  /* detaches c from global client list */
148 extern void dofloat(void);                      /* arranges all windows floating */
149 extern void focusnext(Arg *arg);                /* focuses next visible client, arg is ignored  */
150 extern void focusprev(Arg *arg);                /* focuses previous visible client, arg is ignored */
151 extern Bool isvisible(Client *c);               /* returns True if client is visible */
152 extern Client *nextmanaged(Client *c);          /* returns managed successor of c */
153 extern void restack(void);                      /* restores z layers of all clients */
154 extern void togglefloat(Arg *arg);              /* toggles focusesd client between floating/non-floating state */
155 extern void togglemode(Arg *arg);               /* toggles global arrange function (dotile/dofloat) */
156 extern void toggleview(Arg *arg);               /* toggles the tag with arg's index (in)visible */
157 extern void view(Arg *arg);                     /* views the tag with arg's index */