/*
* (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
* See LICENSE file for license details.
+ *
+ * dynamic window manager is designed like any other X client as well. It is
+ * driven through handling X events. In contrast to other X clients, a window
+ * manager selects for SubstructureRedirectMask on the root window, to receive
+ * events about window (dis-)appearance. Only one X connection at a time is
+ * allowed to select for this event mask.
+ *
+ * Calls to fetch an X event from the event queue are blocking. Due reading
+ * status text from standard input, a select()-driven main loop has been
+ * implemented which selects for reads on the X connection and STDIN_FILENO to
+ * handle all data smoothly. The event handlers of dwm are organized in an
+ * array which is accessed whenever a new event has been fetched. This allows
+ * event dispatching in O(1) time.
+ *
+ * Each child of the root window is called a client, except windows which have
+ * set the override_redirect flag. Clients are organized in a global
+ * doubly-linked client list, the focus history is remembered through a global
+ * stack list. Each client contains an array of Bools of the same size as the
+ * global tags array to indicate the tags of a client. For each client dwm
+ * creates a small title window, which is resized whenever the (_NET_)WM_NAME
+ * properties are updated or the client is moved/resized.
+ *
+ * Keys and tagging rules are organized as arrays and defined in the config.h
+ * file. These arrays are kept static in event.o and tag.o respectively,
+ * because no other part of dwm needs access to them. The current mode is
+ * represented by the arrange() function pointer, which wether points to
+ * dofloat() or dotile().
+ *
+ * To understand everything else, start reading main.c:main().
*/
#include "config.h"
extern void (*handler[LASTEvent])(XEvent *); /* event handler */
extern void (*arrange)(Arg *); /* arrange function, indicates mode */
extern Atom wmatom[WMLast], netatom[NetLast];
-extern Bool running, issel, maximized, *seltag; /* seltag is array of Bool */
+extern Bool running, issel, *seltag; /* seltag is array of Bool */
extern Client *clients, *sel, *stack; /* global cleint list and stack */
extern Cursor cursor[CurLast];
extern DC dc; /* global draw context */
extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/
extern void updatesize(Client *c); /* update the size structs of c */
extern void updatetitle(Client *c); /* update the name of c */
-extern void togglemax(Arg *arg); /* (un)maximize c */
extern void unmanage(Client *c); /* destroy c */
/* draw.c */
extern void drawtitle(Client *c); /* draw title of c */
extern unsigned long getcolor(const char *colstr); /* return color of colstr */
extern void setfont(const char *fontstr); /* set the font for DC */
-extern unsigned int textw(const char *text); /* return the text width of text */
+extern unsigned int textw(const char *text); /* return the width of text in px*/
/* event.c */
extern void grabkeys(); /* grab all keys defined in config.h */
extern Client *getnext(Client *c); /* returns next visible client */
extern Client *getprev(Client *c); /* returns previous visible client */
extern void settags(Client *c, Client *trans); /* sets tags of c */
-extern void tag(Arg *arg); /* tags c accordingly to arg's index */
-extern void toggletag(Arg *arg); /* toggles c tags accordingly to arg's index */
+extern void tag(Arg *arg); /* tags c with arg's index */
+extern void toggletag(Arg *arg); /* toggles c tags with arg's index */
/* util.c */
extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
-extern void eprint(const char *errstr, ...); /* prints error string and exits with return code 1 */
+extern void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */
extern void *erealloc(void *ptr, unsigned int size); /* reallocates memory, exits on error */
-extern void spawn(Arg *arg); /* forks a new subprocess accordingly to arg's cmd */
+extern void spawn(Arg *arg); /* forks a new subprocess with to arg's cmd */
/* view.c */
extern void detach(Client *c); /* detaches c from global client list */
-extern void dofloat(Arg *arg); /* arranges all windows in a floating way, arg is ignored */
-extern void dotile(Arg *arg); /* arranges all windows in a tiled way, arg is ignored */
+extern void dofloat(Arg *arg); /* arranges all windows floating, arg is ignored */
+extern void dotile(Arg *arg); /* arranges all windows, arg is ignored */
extern void focusnext(Arg *arg); /* focuses next visible client, arg is ignored */
extern void focusprev(Arg *arg); /* focuses previous visible client, arg is ignored */
extern Bool isvisible(Client *c); /* returns True if client is visible */
-extern void resizecol(Arg *arg); /* resizes the master width accordingly to arg's index value */
+extern void resizecol(Arg *arg); /* resizes the master width with arg's index value */
extern void restack(); /* restores z layers of all clients */
-extern void togglemode(Arg *arg); /* toggles global arrange function (between dotile and dofloat) */
-extern void toggleview(Arg *arg); /* toggles the tag accordingly to arg's index (in)visible */
-extern void view(Arg *arg); /* views the tag accordingly to arg's index */
+extern void togglemode(Arg *arg); /* toggles global arrange function (dotile/dofloat) */
+extern void toggleview(Arg *arg); /* toggles the tag with arg's index (in)visible */
+extern void view(Arg *arg); /* views the tag with arg's index */
extern void viewall(Arg *arg); /* views all tags, arg is ignored */
extern void zoom(Arg *arg); /* zooms the focused client to master column, arg is ignored */
Got questions, comments, patches, etc.? Contact Jason Woofenden