dwm.h

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