dwm.h

   1 /* © 2006-2007 Anselm R. Garbe <garbeam at gmail dot com>
   2  * © 2006-2007 Sander van Dijk <a dot h dot vandijk 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 layout is
  29  * represented by the lt pointer.
  30  *
  31  * To understand everything else, start reading main.c:main().
  32  */
  33
  34 #include "config.h"
  35 #include <X11/Xlib.h>
  36
  37 /* mask shorthands, used in event.c and client.c */
  38 #define BUTTONMASK              (ButtonPressMask | ButtonReleaseMask)
  39
  40 enum { NetSupported, NetWMName, NetLast };              /* EWMH atoms */
  41 enum { WMProtocols, WMDelete, WMState, WMLast };        /* default atoms */
  42 enum { CurNormal, CurResize, CurMove, CurLast };        /* cursor */
  43 enum { ColBorder, ColFG, ColBG, ColLast };              /* color */
  44
  45 typedef struct Client Client;
  46 struct Client {
  47         char name[256];
  48         int x, y, w, h;
  49         int rx, ry, rw, rh; /* revert geometry */
  50         int basew, baseh, incw, inch, maxw, maxh, minw, minh;
  51         int minax, maxax, minay, maxay;
  52         long flags;
  53         unsigned int border, oldborder;
  54         Bool isbanned, isfixed, ismax, isfloating;
  55         Bool *tags;
  56         Client *next;
  57         Client *prev;
  58         Client *snext;
  59         Window win;
  60 };
  61
  62 typedef struct {
  63         int x, y, w, h;
  64         unsigned long norm[ColLast];
  65         unsigned long sel[ColLast];
  66         Drawable drawable;
  67         GC gc;
  68         struct {
  69                 int ascent;
  70                 int descent;
  71                 int height;
  72                 XFontSet set;
  73                 XFontStruct *xfont;
  74         } font;
  75 } DC; /* draw context */
  76
  77 typedef struct {
  78         const char *symbol;
  79         void (*arrange)(void);
  80 } Layout;
  81
  82 extern const char *tags[];              /* all tags */
  83 char stext[256];                        /* status text */
  84 int screen, sx, sy, sw, sh;             /* screen geometry */
  85 int wax, way, wah, waw;                 /* windowarea geometry */
  86 unsigned int bh, blw;                   /* bar height, bar layout label width */
  87 unsigned int ntags, numlockmask;        /* number of tags, dynamic lock mask */
  88 void (*handler[LASTEvent])(XEvent *);   /* event handler */
  89 Atom wmatom[WMLast], netatom[NetLast];
  90 Bool selscreen, *seltag;                /* seltag is array of Bool */
  91 Client *clients, *sel, *stack;          /* global client list and stack */
  92 Cursor cursor[CurLast];
  93 DC dc;                                  /* global draw context */
  94 Display *dpy;
  95 Layout *lt;
  96 Window root, barwin;
  97
  98 /* client.c */
  99 void attach(Client *c);                 /* attaches c to global client list */
 100 void configure(Client *c);              /* send synthetic configure event */
 101 void detach(Client *c);                 /* detaches c from global client list */
 102 void focus(Client *c);                  /* focus c, c may be NULL */
 103 void killclient(const char *arg);               /* kill c nicely */
 104 void manage(Window w, XWindowAttributes *wa);   /* manage new client */
 105 void resize(Client *c, int x, int y,
 106                 int w, int h, Bool sizehints);  /* resize with given coordinates c*/
 107 void togglefloating(const char *arg);   /* toggles focused client between floating/tiled state */
 108 void updatesizehints(Client *c);                /* update the size hint variables of c */
 109 void updatetitle(Client *c);            /* update the name of c */
 110 void unmanage(Client *c);               /* destroy c */
 111
 112 /* draw.c */
 113 void drawstatus(void);                  /* draw the bar */
 114 void drawtext(const char *text, unsigned long col[ColLast]);    /* draw text */
 115 unsigned int textw(const char *text);   /* return the width of text in px*/
 116
 117 /* event.c */
 118 void grabkeys(void);                    /* grab all keys defined in config.h */
 119
 120 /* layout.c */
 121 void floating(void);                    /* arranges all windows floating */
 122 void focusclient(const char *arg);      /* focuses next(1)/previous(-1) visible client */
 123 void incmasterw(const char *arg);       /* increments the master width with arg's index value */
 124 void incnmaster(const char *arg);       /* increments nmaster with arg's index value */
 125 void initlayouts(void);                 /* initialize layout array */
 126 Client *nexttiled(Client *c);           /* returns tiled successor of c */
 127 void restack(void);                     /* restores z layers of all clients */
 128 void setlayout(const char *arg);                /* sets layout, -1 toggles */
 129 void togglemax(const char *arg);                /* toggles maximization of floating client */
 130 void zoom(const char *arg);             /* zooms the focused client to master area, arg is ignored */
 131
 132 /* main.c */
 133 void quit(const char *arg);             /* quit dwm nicely */
 134 int xerror(Display *dsply, XErrorEvent *ee);    /* dwm's X error handler */
 135
 136 /* tag.c */
 137 void compileregs(void);                 /* initialize regexps of rules defined in config.h */
 138 Bool isvisible(Client *c);              /* returns True if client is visible */
 139 void settags(Client *c, Client *trans); /* sets tags of c */
 140 void tag(const char *arg);              /* tags c with arg's index */
 141 void toggletag(const char *arg);                /* toggles c tags with arg's index */
 142 void toggleview(const char *arg);       /* toggles the tag with arg's index (in)visible */
 143 void view(const char *arg);             /* views the tag with arg's index */
 144
 145 /* util.c */
 146 void *emallocz(unsigned int size);      /* allocates zero-initialized memory, exits on error */
 147 void eprint(const char *errstr, ...);   /* prints errstr and exits with 1 */
 148 void spawn(const char *arg);            /* forks a new subprocess with arg's cmd */