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