dwm.h

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