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  * © 2007 Premysl Hruby <dfenze at gmail dot com>
   4  * © 2007 Szabolcs Nagy <nszabolcs at gmail dot com>
   5  * See LICENSE file for license details.
   6  *
   7  * dynamic window manager is designed like any other X client as well. It is
   8  * driven through handling X events. In contrast to other X clients, a window
   9  * manager selects for SubstructureRedirectMask on the root window, to receive
  10  * events about window (dis-)appearance.  Only one X connection at a time is
  11  * allowed to select for this event mask.
  12  *
  13  * Calls to fetch an X event from the event queue are blocking.  Due reading
  14  * status text from standard input, a select()-driven main loop has been
  15  * implemented which selects for reads on the X connection and STDIN_FILENO to
  16  * handle all data smoothly. The event handlers of dwm are organized in an
  17  * array which is accessed whenever a new event has been fetched. This allows
  18  * event dispatching in O(1) time.
  19  *
  20  * Each child of the root window is called a client, except windows which have
  21  * set the override_redirect flag.  Clients are organized in a global
  22  * doubly-linked client list, the focus history is remembered through a global
  23  * stack list. Each client contains an array of Bools of the same size as the
  24  * global tags array to indicate the tags of a client.  For each client dwm
  25  * creates a small title window, which is resized whenever the (_NET_)WM_NAME
  26  * properties are updated or the client is moved/resized.
  27  *
  28  * Keys and tagging rules are organized as arrays and defined in the config.h
  29  * file. These arrays are kept static in event.o and tag.o respectively,
  30  * because no other part of dwm needs access to them.  The current layout is
  31  * represented by the lt pointer.
  32  *
  33  * To understand everything else, start reading main.c:main().
  34  */
  35
  36 #include "config.h"
  37 #include <X11/Xlib.h>
  38
  39 /* mask shorthands, used in event.c and client.c */
  40 #define BUTTONMASK              (ButtonPressMask | ButtonReleaseMask)
  41
  42 enum { BarTop, BarBot, BarOff };                        /* bar position */
  43 enum { CurNormal, CurResize, CurMove, CurLast };        /* cursor */
  44 enum { ColBorder, ColFG, ColBG, ColLast };              /* color */
  45 enum { NetSupported, NetWMName, NetLast };              /* EWMH atoms */
  46 enum { WMProtocols, WMDelete, WMState, WMLast };        /* default atoms */
  47
  48 typedef struct Client Client;
  49 struct Client {
  50         char name[256];
  51         int x, y, w, h;
  52         int rx, ry, rw, rh; /* revert geometry */
  53         int basew, baseh, incw, inch, maxw, maxh, minw, minh;
  54         int minax, maxax, minay, maxay;
  55         long flags;
  56         unsigned int border, oldborder;
  57         Bool isbanned, isfixed, ismax, isfloating;
  58         Bool *tags;
  59         Client *next;
  60         Client *prev;
  61         Client *snext;
  62         Window win;
  63 };
  64
  65 typedef struct {
  66         int x, y, w, h;
  67         unsigned long norm[ColLast];
  68         unsigned long sel[ColLast];
  69         Drawable drawable;
  70         GC gc;
  71         struct {
  72                 int ascent;
  73                 int descent;
  74                 int height;
  75                 XFontSet set;
  76                 XFontStruct *xfont;
  77         } font;
  78 } DC; /* draw context */
  79
  80 typedef struct {
  81         const char *symbol;
  82         void (*arrange)(void);
  83 } Layout;
  84
  85 extern const char *tags[];              /* all tags */
  86 char stext[256];                        /* status text */
  87 int screen, sx, sy, sw, sh;             /* screen geometry */
  88 int wax, way, wah, waw;                 /* windowarea geometry */
  89 unsigned int bh, blw, bpos;             /* bar height, bar layout label width, bar position */
  90 unsigned int ntags, numlockmask;        /* number of tags, dynamic lock mask */
  91 void (*handler[LASTEvent])(XEvent *);   /* event handler */
  92 Atom wmatom[WMLast], netatom[NetLast];
  93 Bool selscreen, *seltag;                /* seltag is array of Bool */
  94 Client *clients, *sel, *stack;          /* global client list and stack */
  95 Cursor cursor[CurLast];
  96 DC dc;                                  /* global draw context */
  97 Display *dpy;
  98 Layout *lt;
  99 Window root, barwin;
 100
 101 /* client.c */
 102 void attach(Client *c);                 /* attaches c to global client list */
 103 void configure(Client *c);              /* send synthetic configure event */
 104 void detach(Client *c);                 /* detaches c from global client list */
 105 void focus(Client *c);                  /* focus c if visible && !NULL, or focus top visible */
 106 void killclient(const char *arg);       /* kill sel  nicely */
 107 void manage(Window w, XWindowAttributes *wa);   /* manage new client */
 108 void resize(Client *c, int x, int y,
 109                 int w, int h, Bool sizehints);  /* resize with given coordinates c*/
 110 void togglefloating(const char *arg);   /* toggles sel between floating/tiled state */
 111 void updatesizehints(Client *c);        /* update the size hint variables of c */
 112 void updatetitle(Client *c);            /* update the name of c */
 113 void unmanage(Client *c);               /* destroy c */
 114
 115 /* draw.c */
 116 void drawstatus(void);                  /* draw the bar */
 117 void drawtext(const char *text, unsigned long col[ColLast]);    /* draw text */
 118 unsigned int textw(const char *text);   /* return the width of text in px*/
 119
 120 /* event.c */
 121 void grabkeys(void);                    /* grab all keys defined in config.h */
 122
 123 /* layout.c */
 124 void floating(void);                    /* arranges all windows floating */
 125 void focusclient(const char *arg);      /* focuses next(1)/previous(-1) visible client */
 126 void incmasterw(const char *arg);       /* increments the master width with arg's index value */
 127 void incnmaster(const char *arg);       /* increments nmaster with arg's index value */
 128 void initlayouts(void);                 /* initialize layout array */
 129 Client *nexttiled(Client *c);           /* returns tiled successor of c */
 130 void restack(void);                     /* restores z layers of all clients */
 131 void setlayout(const char *arg);        /* sets layout, NULL means next layout */
 132 void togglebar(const char *arg);        /* shows/hides the bar */
 133 void togglemax(const char *arg);        /* toggles maximization of floating client */
 134 void zoom(const char *arg);             /* zooms the focused client to master area, arg is ignored */
 135
 136 /* main.c */
 137 void updatebarpos(void);                /* updates the bar position */
 138 void quit(const char *arg);             /* quit dwm nicely */
 139 int xerror(Display *dsply, XErrorEvent *ee);    /* dwm's X error handler */
 140
 141 /* tag.c */
 142 void compileregs(void);                 /* initialize regexps of rules defined in config.h */
 143 Bool isvisible(Client *c);              /* returns True if client is visible */
 144 void settags(Client *c, Client *trans); /* sets tags of c */
 145 void tag(const char *arg);              /* tags sel with arg's index */
 146 void toggletag(const char *arg);        /* toggles sel tags with arg's index */
 147 void toggleview(const char *arg);       /* toggles the tag with arg's index (in)visible */
 148 void view(const char *arg);             /* views the tag with arg's index */
 149
 150 /* util.c */
 151 void *emallocz(unsigned int size);      /* allocates zero-initialized memory, exits on error */
 152 void eprint(const char *errstr, ...);   /* prints errstr and exits with 1 */
 153 void spawn(const char *arg);            /* forks a new subprocess with arg's cmd */