X-Git-Url: https://jasonwoof.com/gitweb/?p=dwm.git;a=blobdiff_plain;f=dwm.h;h=4a6a30affbb4bcff1484ca753b2460a2c3974d70;hp=22a56d48bff246f5bb3f9526833b442354edbe4e;hb=cb4aa5bc35cf16a06bb2b4e880648e390fa2cc55;hpb=438beeabde5e56f8d85e0dd143721e9372e3eab4 diff --git a/dwm.h b/dwm.h index 22a56d4..4a6a30a 100644 --- a/dwm.h +++ b/dwm.h @@ -1,6 +1,34 @@ -/* - * (C)opyright MMVI Anselm R. Garbe +/* (C)opyright MMVII Anselm R. Garbe * 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" @@ -8,7 +36,8 @@ /* mask shorthands, used in event.c and client.c */ #define BUTTONMASK (ButtonPressMask | ButtonReleaseMask) -#define MOUSEMASK (BUTTONMASK | PointerMotionMask) +/* other stuff used in different places */ +#define BORDERPX 1 #define PROTODELWIN 1 enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */ @@ -48,12 +77,12 @@ struct Client { char name[256]; int proto; int x, y, w, h; + int rx, ry, rw, rh; /* revert geometry */ int tx, ty, tw, th; /* title window geometry */ int basew, baseh, incw, inch, maxw, maxh, minw, minh; - int grav; long flags; - unsigned int border, weight; - Bool isfloat; + unsigned int border; + Bool isfloat, isfixed, ismax; Bool *tags; Client *next; Client *prev; @@ -65,43 +94,44 @@ struct Client { extern const char *tags[]; /* all tags */ extern char stext[1024]; /* status text */ extern int bx, by, bw, bh, bmw; /* bar geometry, bar mode label width */ -extern int mw, screen, sx, sy, sw, sh; /* screen geometry, master width */ -extern unsigned int ntags, numlockmask; /* number of tags, and dynamic lock mask */ +extern int screen, sx, sy, sw, sh; /* screen geometry */ +extern int wax, way, wah, waw; /* windowarea geometry */ +extern unsigned int master, ntags, numlockmask; /* master percent, number of tags, dynamic lock mask */ extern void (*handler[LASTEvent])(XEvent *); /* event handler */ -extern void (*arrange)(Arg *); /* arrange function, indicates mode */ +extern void (*arrange)(void); /* arrange function, indicates mode */ extern Atom wmatom[WMLast], netatom[NetLast]; -extern Bool running, issel, maximized, *seltag; /* seltag is array of Bool */ -extern Client *clients, *sel, *stack; /* Client containers */ +extern Bool running, issel, *seltag; /* seltag is array of Bool */ +extern Client *clients, *sel, *stack; /* global client list and stack */ extern Cursor cursor[CurLast]; -extern DC dc; /* draw context for everything */ +extern DC dc; /* global draw context */ extern Display *dpy; extern Window root, barwin; /* client.c */ -extern void ban(Client *c); /* ban client from screen */ +extern void ban(Client *c); /* ban c from screen */ +extern void configure(Client *c); /* send synthetic configure event */ extern void focus(Client *c); /* focus c, c may be NULL */ extern Client *getclient(Window w); /* return client of w */ extern Client *getctitle(Window w); /* return client of title window */ -extern void gravitate(Client *c, Bool invert); /* gravitate c */ extern void killclient(Arg *arg); /* kill c nicely */ extern void manage(Window w, XWindowAttributes *wa); /* manage new client */ extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/ -extern void setsize(Client *c); /* set the size structs of c */ -extern void settitle(Client *c); /* set the name of c */ -extern void togglemax(Arg *arg); /* (un)maximize c */ +extern void resizetitle(Client *c); /* resizes c->twin correctly */ +extern void updatesizehints(Client *c); /* update the size hint variables of c */ +extern void updatetitle(Client *c); /* update the name of c */ extern void unmanage(Client *c); /* destroy c */ /* draw.c */ -extern void drawall(); /* draw all visible client titles and the bar */ -extern void drawstatus(); /* draw the bar */ +extern void drawall(void); /* draw all visible client titles and the bar */ +extern void drawstatus(void); /* draw the bar */ 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 void procevent(); /* process pending X events */ +extern void grabkeys(void); /* grab all keys defined in config.h */ +extern void procevent(void); /* process pending X events */ /* main.c */ extern int getproto(Window w); /* return protocol mask of WMProtocols property of w */ @@ -110,30 +140,30 @@ extern void sendevent(Window w, Atom a, long value); /* send synthetic event to extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */ /* tag.c */ -extern void initrregs(); /* initialize regexps of rules defined in config.h */ +extern void initrregs(void); /* initialize regexps of rules 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); /* updates 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 settags(Client *c, Client *trans); /* sets tags of c */ +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(void); /* arranges all windows floating */ +extern void dotile(void); /* arranges all windows tiled */ 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 restack(); /* restores z layers of all clients */ -extern void togglemode(Arg *arg); /* toggles global arrange mode (between dotile and dofloat) */ -extern void toggleview(Arg *arg); /* makes the tag accordingly to arg's index (in)visible */ -extern void view(Arg *arg); /* makes the tag accordingly to arg's index visible */ -extern void viewall(Arg *arg); /* makes all tags visible, arg is ignored */ -extern void zoom(Arg *arg); /* zooms the focused client to master column, arg is ignored */ +extern void resizemaster(Arg *arg); /* resizes the master percent with arg's index value */ +extern void restack(void); /* restores z layers of all clients */ +extern void togglefloat(Arg *arg); /* toggles focusesd client between floating/non-floating state */ +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 zoom(Arg *arg); /* zooms the focused client to master area, arg is ignored */