dwm/dwm.h

175 lines
7.6 KiB
C
Raw Normal View History

2006-07-10 14:38:18 +00:00
/*
* (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 like dwm selects for SubstructureRedirectMask on the root window, to
* receive events about child window appearance and disappearance. 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 of the X connection are
* blocking. Due the fact, that dwm reads 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 and without
* busy-loop quirks. 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 window of the root window is called a client in window manager
* terminology, 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. There are no other data structures to organize the clients
* in tag lists. All clients which have at least one tag enabled of the current
* tags viewed, will be visible on the screen, all other clients are banned to
* the x-location x + 2 * screen width. This avoids having additional layers
* of workspace handling.
*
* For each client dwm creates a small title window which is resized whenever
* the WM_NAME or _NET_WM_NAME properties are updated or the client is 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 with reading main.c:main().
2006-07-10 14:38:18 +00:00
*/
#include "config.h"
#include <X11/Xlib.h>
2006-07-12 23:30:55 +00:00
2006-08-01 10:32:33 +00:00
/* mask shorthands, used in event.c and client.c */
#define BUTTONMASK (ButtonPressMask | ButtonReleaseMask)
#define MOUSEMASK (BUTTONMASK | PointerMotionMask)
#define PROTODELWIN 1
2006-08-01 10:32:33 +00:00
2006-09-11 05:40:41 +00:00
enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */
enum { WMProtocols, WMDelete, WMLast }; /* default atoms */
enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */
enum { ColFG, ColBG, ColLast }; /* color */
typedef enum {
TopLeft, TopRight, BotLeft, BotRight
} Corner; /* window corners */
typedef union {
const char *cmd;
2006-07-13 15:09:35 +00:00
int i;
2006-09-11 05:40:41 +00:00
} Arg; /* argument type */
typedef struct {
2006-07-12 23:30:55 +00:00
int ascent;
int descent;
int height;
XFontSet set;
XFontStruct *xfont;
} Fnt;
2006-07-12 23:30:55 +00:00
2006-09-11 05:40:41 +00:00
typedef struct {
2006-07-12 23:30:55 +00:00
int x, y, w, h;
2006-08-25 10:59:45 +00:00
unsigned long norm[ColLast];
unsigned long sel[ColLast];
unsigned long status[ColLast];
Drawable drawable;
Fnt font;
GC gc;
2006-09-11 05:40:41 +00:00
} DC; /* draw context */
2006-07-12 23:30:55 +00:00
typedef struct Client Client;
2006-07-10 14:38:18 +00:00
struct Client {
2006-07-12 23:04:38 +00:00
char name[256];
2006-07-11 14:14:22 +00:00
int proto;
int x, y, w, h;
2006-09-11 06:58:58 +00:00
int tx, ty, tw, th; /* title window geometry */
2006-07-11 20:49:09 +00:00
int basew, baseh, incw, inch, maxw, maxh, minw, minh;
2006-07-12 15:17:15 +00:00
int grav;
2006-07-11 20:49:09 +00:00
long flags;
2006-08-29 11:40:09 +00:00
unsigned int border, weight;
2006-07-15 22:47:40 +00:00
Bool isfloat;
Bool *tags;
2006-07-10 14:38:18 +00:00
Client *next;
Client *prev;
Client *snext;
Window win;
2006-08-23 16:50:46 +00:00
Window twin;
2006-07-10 14:38:18 +00:00
};
2006-09-11 05:40:41 +00:00
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, dynamic lock mask */
2006-09-11 05:40:41 +00:00
extern void (*handler[LASTEvent])(XEvent *); /* event handler */
extern void (*arrange)(Arg *); /* arrange function, indicates mode */
extern Atom wmatom[WMLast], netatom[NetLast];
2006-09-11 05:40:41 +00:00
extern Bool running, issel, maximized, *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 Display *dpy;
extern Window root, barwin;
2006-07-10 20:16:48 +00:00
/* client.c */
extern void ban(Client *c); /* ban c from screen */
2006-09-11 05:40:41 +00:00
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 updatesize(Client *c); /* update the size structs of c */
extern void updatetitle(Client *c); /* update the name of c */
2006-09-11 05:40:41 +00:00
extern void togglemax(Arg *arg); /* (un)maximize c */
extern void unmanage(Client *c); /* destroy c */
2006-07-11 14:14:22 +00:00
2006-07-12 23:55:54 +00:00
/* draw.c */
2006-09-11 05:40:41 +00:00
extern void drawall(); /* draw all visible client titles and the bar */
extern void drawstatus(); /* 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 */
2006-09-11 15:31:21 +00:00
extern unsigned int textw(const char *text); /* return the width of text in px*/
2006-07-12 23:55:54 +00:00
2006-07-15 14:30:50 +00:00
/* event.c */
2006-09-11 05:40:41 +00:00
extern void grabkeys(); /* grab all keys defined in config.h */
extern void procevent(); /* process pending X events */
2006-07-11 19:24:10 +00:00
2006-07-13 09:43:05 +00:00
/* main.c */
2006-09-11 05:40:41 +00:00
extern int getproto(Window w); /* return protocol mask of WMProtocols property of w */
extern void quit(Arg *arg); /* quit dwm nicely */
extern void sendevent(Window w, Atom a, long value); /* send synthetic event to w */
extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
2006-07-13 09:43:05 +00:00
2006-07-15 14:30:50 +00:00
/* tag.c */
2006-09-11 05:40:41 +00:00
extern void initrregs(); /* 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); /* sets tags of c */
2006-09-11 15:31:21 +00:00
extern void tag(Arg *arg); /* tags c with arg's index */
extern void toggletag(Arg *arg); /* toggles c tags with arg's index */
2006-07-14 20:33:38 +00:00
2006-07-12 23:30:55 +00:00
/* util.c */
2006-09-11 05:40:41 +00:00
extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
2006-09-11 15:31:21 +00:00
extern void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */
2006-09-11 05:40:41 +00:00
extern void *erealloc(void *ptr, unsigned int size); /* reallocates memory, exits on error */
2006-09-11 15:31:21 +00:00
extern void spawn(Arg *arg); /* forks a new subprocess with to arg's cmd */
/* view.c */
2006-09-11 05:40:41 +00:00
extern void detach(Client *c); /* detaches c from global client list */
2006-09-11 15:31:21 +00:00
extern void dofloat(Arg *arg); /* arranges all windows floating, arg is ignored */
extern void dotile(Arg *arg); /* arranges all windows, arg is ignored */
2006-09-11 05:40:41 +00:00
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 */
2006-09-11 15:31:21 +00:00
extern void resizecol(Arg *arg); /* resizes the master width with arg's index value */
2006-09-11 05:40:41 +00:00
extern void restack(); /* restores z layers of all clients */
2006-09-11 15:31:21 +00:00
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 */
2006-09-11 05:40:41 +00:00
extern void zoom(Arg *arg); /* zooms the focused client to master column, arg is ignored */