all repos — dwm @ c9cc2b385aade3ce7db1404f4b5f8cd6e41e6bae

fork of suckless dynamic window manager

dwm.h (view raw)

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