dwm-meillo

annotate dwm.h @ 488:0d2559f46b9e

applied sanders jukka patch
author arg@mmvi
date Mon, 25 Sep 2006 20:38:30 +0200
parents be4f90c03582
children 12395ef46d97
rev   line source
garbeam@0 1 /*
garbeam@0 2 * (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
garbeam@0 3 * See LICENSE file for license details.
arg@457 4 *
arg@457 5 * dynamic window manager is designed like any other X client as well. It is
arg@457 6 * driven through handling X events. In contrast to other X clients, a window
arg@468 7 * manager selects for SubstructureRedirectMask on the root window, to receive
arg@468 8 * events about window (dis-)appearance. Only one X connection at a time is
arg@468 9 * allowed to select for this event mask.
arg@457 10 *
arg@468 11 * Calls to fetch an X event from the event queue are blocking. Due reading
arg@469 12 * status text from standard input, a select()-driven main loop has been
arg@468 13 * implemented which selects for reads on the X connection and STDIN_FILENO to
arg@468 14 * handle all data smoothly. The event handlers of dwm are organized in an
arg@468 15 * array which is accessed whenever a new event has been fetched. This allows
arg@468 16 * event dispatching in O(1) time.
arg@457 17 *
arg@460 18 * Each child of the root window is called a client, except windows which have
arg@460 19 * set the override_redirect flag. Clients are organized in a global
arg@460 20 * doubly-linked client list, the focus history is remembered through a global
arg@460 21 * stack list. Each client contains an array of Bools of the same size as the
arg@460 22 * global tags array to indicate the tags of a client. For each client dwm
arg@468 23 * creates a small title window, which is resized whenever the (_NET_)WM_NAME
arg@468 24 * properties are updated or the client is moved/resized.
arg@457 25 *
arg@459 26 * Keys and tagging rules are organized as arrays and defined in the config.h
arg@459 27 * file. These arrays are kept static in event.o and tag.o respectively,
arg@459 28 * because no other part of dwm needs access to them. The current mode is
arg@469 29 * represented by the arrange() function pointer, which wether points to
arg@469 30 * dofloat() or dotile().
arg@457 31 *
arg@468 32 * To understand everything else, start reading main.c:main().
garbeam@0 33 */
garbeam@0 34
arg@166 35 #include "config.h"
garbeam@32 36 #include <X11/Xlib.h>
garbeam@32 37
arg@143 38 /* mask shorthands, used in event.c and client.c */
arg@150 39 #define BUTTONMASK (ButtonPressMask | ButtonReleaseMask)
arg@150 40 #define MOUSEMASK (BUTTONMASK | PointerMotionMask)
arg@157 41 #define PROTODELWIN 1
arg@143 42
arg@452 43 enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */
arg@452 44 enum { WMProtocols, WMDelete, WMLast }; /* default atoms */
arg@452 45 enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */
arg@452 46 enum { ColFG, ColBG, ColLast }; /* color */
arg@452 47
arg@452 48 typedef enum {
arg@452 49 TopLeft, TopRight, BotLeft, BotRight
arg@452 50 } Corner; /* window corners */
arg@452 51
arg@333 52 typedef union {
arg@189 53 const char *cmd;
garbeam@49 54 int i;
arg@452 55 } Arg; /* argument type */
arg@99 56
arg@333 57 typedef struct {
garbeam@32 58 int ascent;
garbeam@32 59 int descent;
garbeam@32 60 int height;
garbeam@84 61 XFontSet set;
garbeam@84 62 XFontStruct *xfont;
arg@333 63 } Fnt;
garbeam@32 64
arg@452 65 typedef struct {
garbeam@32 66 int x, y, w, h;
arg@353 67 unsigned long norm[ColLast];
arg@353 68 unsigned long sel[ColLast];
arg@353 69 unsigned long status[ColLast];
garbeam@84 70 Drawable drawable;
garbeam@84 71 Fnt font;
garbeam@84 72 GC gc;
arg@452 73 } DC; /* draw context */
garbeam@32 74
arg@333 75 typedef struct Client Client;
garbeam@0 76 struct Client {
garbeam@31 77 char name[256];
garbeam@13 78 int proto;
arg@115 79 int x, y, w, h;
arg@480 80 int rx, ry, rw, rh; /* revert geometry */
arg@453 81 int tx, ty, tw, th; /* title window geometry */
garbeam@20 82 int basew, baseh, incw, inch, maxw, maxh, minw, minh;
garbeam@29 83 int grav;
arg@164 84 long flags;
arg@381 85 unsigned int border, weight;
arg@480 86 Bool isfloat, ismax;
arg@178 87 Bool *tags;
garbeam@84 88 Client *next;
arg@127 89 Client *prev;
arg@446 90 Client *snext;
garbeam@0 91 Window win;
arg@342 92 Window twin;
garbeam@0 93 };
garbeam@0 94
arg@452 95 extern const char *tags[]; /* all tags */
arg@452 96 extern char stext[1024]; /* status text */
arg@452 97 extern int bx, by, bw, bh, bmw; /* bar geometry, bar mode label width */
arg@452 98 extern int mw, screen, sx, sy, sw, sh; /* screen geometry, master width */
arg@454 99 extern unsigned int ntags, numlockmask; /* number of tags, dynamic lock mask */
arg@452 100 extern void (*handler[LASTEvent])(XEvent *); /* event handler */
arg@452 101 extern void (*arrange)(Arg *); /* arrange function, indicates mode */
garbeam@84 102 extern Atom wmatom[WMLast], netatom[NetLast];
arg@473 103 extern Bool running, issel, *seltag; /* seltag is array of Bool */
arg@488 104 extern Client *clients, *sel, *stack; /* global client list and stack */
garbeam@84 105 extern Cursor cursor[CurLast];
arg@454 106 extern DC dc; /* global draw context */
garbeam@84 107 extern Display *dpy;
garbeam@84 108 extern Window root, barwin;
garbeam@3 109
garbeam@5 110 /* client.c */
arg@454 111 extern void ban(Client *c); /* ban c from screen */
arg@452 112 extern void focus(Client *c); /* focus c, c may be NULL */
arg@452 113 extern Client *getclient(Window w); /* return client of w */
arg@452 114 extern Client *getctitle(Window w); /* return client of title window */
arg@452 115 extern void gravitate(Client *c, Bool invert); /* gravitate c */
arg@452 116 extern void killclient(Arg *arg); /* kill c nicely */
arg@452 117 extern void manage(Window w, XWindowAttributes *wa); /* manage new client */
arg@452 118 extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/
arg@454 119 extern void updatesize(Client *c); /* update the size structs of c */
arg@454 120 extern void updatetitle(Client *c); /* update the name of c */
arg@452 121 extern void unmanage(Client *c); /* destroy c */
garbeam@13 122
garbeam@33 123 /* draw.c */
arg@487 124 extern void drawall(void); /* draw all visible client titles and the bar */
arg@487 125 extern void drawstatus(void); /* draw the bar */
arg@452 126 extern void drawtitle(Client *c); /* draw title of c */
arg@452 127 extern unsigned long getcolor(const char *colstr); /* return color of colstr */
arg@452 128 extern void setfont(const char *fontstr); /* set the font for DC */
arg@456 129 extern unsigned int textw(const char *text); /* return the width of text in px*/
garbeam@33 130
garbeam@75 131 /* event.c */
arg@487 132 extern void grabkeys(void); /* grab all keys defined in config.h */
arg@487 133 extern void procevent(void); /* process pending X events */
garbeam@18 134
garbeam@43 135 /* main.c */
arg@452 136 extern int getproto(Window w); /* return protocol mask of WMProtocols property of w */
arg@452 137 extern void quit(Arg *arg); /* quit dwm nicely */
arg@452 138 extern void sendevent(Window w, Atom a, long value); /* send synthetic event to w */
arg@452 139 extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
garbeam@43 140
garbeam@75 141 /* tag.c */
arg@487 142 extern void initrregs(void); /* initialize regexps of rules defined in config.h */
arg@452 143 extern Client *getnext(Client *c); /* returns next visible client */
arg@452 144 extern Client *getprev(Client *c); /* returns previous visible client */
arg@454 145 extern void settags(Client *c, Client *trans); /* sets tags of c */
arg@456 146 extern void tag(Arg *arg); /* tags c with arg's index */
arg@456 147 extern void toggletag(Arg *arg); /* toggles c tags with arg's index */
garbeam@73 148
garbeam@32 149 /* util.c */
arg@452 150 extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
arg@456 151 extern void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */
arg@452 152 extern void *erealloc(void *ptr, unsigned int size); /* reallocates memory, exits on error */
arg@456 153 extern void spawn(Arg *arg); /* forks a new subprocess with to arg's cmd */
arg@327 154
arg@327 155 /* view.c */
arg@452 156 extern void detach(Client *c); /* detaches c from global client list */
arg@456 157 extern void dofloat(Arg *arg); /* arranges all windows floating, arg is ignored */
arg@456 158 extern void dotile(Arg *arg); /* arranges all windows, arg is ignored */
arg@452 159 extern void focusnext(Arg *arg); /* focuses next visible client, arg is ignored */
arg@452 160 extern void focusprev(Arg *arg); /* focuses previous visible client, arg is ignored */
arg@452 161 extern Bool isvisible(Client *c); /* returns True if client is visible */
arg@456 162 extern void resizecol(Arg *arg); /* resizes the master width with arg's index value */
arg@487 163 extern void restack(void); /* restores z layers of all clients */
arg@456 164 extern void togglemode(Arg *arg); /* toggles global arrange function (dotile/dofloat) */
arg@456 165 extern void toggleview(Arg *arg); /* toggles the tag with arg's index (in)visible */
arg@456 166 extern void view(Arg *arg); /* views the tag with arg's index */
arg@454 167 extern void viewall(Arg *arg); /* views all tags, arg is ignored */
arg@452 168 extern void zoom(Arg *arg); /* zooms the focused client to master column, arg is ignored */