JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
separated layout-specific stuff into separate .h and .c files which are included...
[dwm.git] / dwm.h
diff --git a/dwm.h b/dwm.h
index acfdcbb..c2f1e7e 100644 (file)
--- a/dwm.h
+++ b/dwm.h
-/*
- * (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
- * See LICENSE file for license details.
+/* See LICENSE file for copyright and 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 selects for SubstructureRedirectMask on the root window, to receive
+ * events about window (dis-)appearance.  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 are blocking.  Due reading
+ * 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. 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 of the root window is called a client, 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.  For each client dwm
+ * creates a small title window, which is resized whenever the (_NET_)WM_NAME
+ * properties are updated or the client is moved/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 layout is
+ * represented by the lt pointer.
+ *
+ * To understand everything else, start reading main.c:main().
  */
 
+#include "config.h"
 #include <X11/Xlib.h>
 
-/********** CUSTOMIZE **********/
+/* mask shorthands, used in event.c and client.c */
+#define BUTTONMASK             (ButtonPressMask | ButtonReleaseMask)
 
-#define FONT           "-*-terminus-medium-*-*-*-13-*-*-*-*-*-iso10646-*"
-#define BGCOLOR                "DarkSlateGrey"
-#define FGCOLOR                "LightSteelBlue"
-#define BORDERCOLOR    "SlateGray"
-#define WM_PROTOCOL_DELWIN 1
+enum { BarTop, BarBot, BarOff };                       /* bar position */
+enum { CurNormal, CurResize, CurMove, CurLast };       /* cursor */
+enum { ColBorder, ColFG, ColBG, ColLast };             /* color */
+enum { NetSupported, NetWMName, NetLast };             /* EWMH atoms */
+enum { WMProtocols, WMDelete, WMState, WMLast };       /* default atoms */
 
-/* tags */
-enum { Tscratch, Tdev, Tirc, Twww, Twork, TLast };
-
-/********** CUSTOMIZE **********/
-
-typedef struct DC DC;
 typedef struct Client Client;
-typedef struct Fnt Fnt;
-typedef struct Key Key;
-
-/* atoms */
-enum { WMProtocols, WMDelete, WMLast };
-enum { NetSupported, NetWMName, NetLast };
-
-/* cursor */
-enum { CurNormal, CurResize, CurMove, CurInput, CurLast };
-
-struct Fnt {
-       XFontStruct *xfont;
-       XFontSet set;
-       int ascent;
-       int descent;
-       int height;
-};
-
-struct DC { /* draw context */
-       GC gc;
-       Drawable drawable;
-       int x, y, w, h;
-       Fnt font;
-       unsigned long bg;
-       unsigned long fg;
-       unsigned long border;
-};
-
 struct Client {
        char name[256];
-       char *tags[TLast];
-       int proto;
        int x, y, w, h;
-       int tx, ty, tw, th;
+       int rx, ry, rw, rh; /* revert geometry */
        int basew, baseh, incw, inch, maxw, maxh, minw, minh;
-       int grav;
-       unsigned int border;
+       int minax, maxax, minay, maxay;
+       int unmapped;
        long flags; 
-       Window win;
-       Window trans;
-       Window title;
+       unsigned int border, oldborder;
+       Bool isbanned, isfixed, ismax, isfloating;
+       Bool *tags;
        Client *next;
+       Client *prev;
        Client *snext;
+       Window win;
 };
 
-struct Key {
-       unsigned long mod;
-       KeySym keysym;
-       void (*func)(void *aux);
-       void *aux;
-};
-
-extern Display *dpy;
-extern Window root;
-extern Atom wm_atom[WMLast], net_atom[NetLast];
+typedef struct {
+       int x, y, w, h;
+       unsigned long norm[ColLast];
+       unsigned long sel[ColLast];
+       Drawable drawable;
+       GC gc;
+       struct {
+               int ascent;
+               int descent;
+               int height;
+               XFontSet set;
+               XFontStruct *xfont;
+       } font;
+} DC; /* draw context */
+
+typedef struct {
+       const char *symbol;
+       void (*arrange)(void);
+} Layout;
+
+extern const char *tags[];                     /* all tags */
+extern char stext[256];                                /* status text */
+extern int screen, sx, sy, sw, sh;             /* screen geometry */
+extern int wax, way, wah, waw;                 /* windowarea geometry */
+extern unsigned int bh, blw, bpos;             /* bar height, bar layout label width, bar position */
+extern unsigned int ntags, numlockmask;                /* number of tags, numlock mask */
+extern void (*handler[LASTEvent])(XEvent *);   /* event handler */
+extern Atom wmatom[WMLast], netatom[NetLast];
+extern Bool selscreen, *seltag;                        /* seltag is array of Bool */
+extern Client *clients, *sel, *stack;          /* global client list and stack */
 extern Cursor cursor[CurLast];
-extern Bool running, issel;
-extern void (*handler[LASTEvent]) (XEvent *);
-
-extern int tsel, screen, sx, sy, sw, sh, th;
-extern char stext[1024], *tags[TLast];
-
-extern DC dc;
-extern Client *clients, *stack;
+extern DC dc;                                  /* global draw context */
+extern Display *dpy;
+extern Layout *lt;
+extern Window root, barwin;
 
 /* client.c */
-extern void manage(Window w, XWindowAttributes *wa);
-extern void unmanage(Client *c);
-extern Client *getclient(Window w);
-extern void focus(Client *c);
-extern void update_name(Client *c);
-extern void draw_client(Client *c);
-extern void resize(Client *c);
-extern void update_size(Client *c);
-extern Client *gettitle(Window w);
-extern void craise(Client *c);
-extern void lower(Client *c);
-extern void ckill(void *aux);
-extern void sel(void *aux);
-extern void max(void *aux);
-extern void toggle(void *aux);
-extern void gravitate(Client *c, Bool invert);
+void attach(Client *c);                        /* attaches c to global client list */
+void ban(Client *c);                   /* bans c */
+void configure(Client *c);             /* send synthetic configure event */
+void detach(Client *c);                        /* detaches c from global client list */
+void focus(Client *c);                 /* focus c if visible && !NULL, or focus top visible */
+void killclient(const char *arg);      /* kill sel  nicely */
+void manage(Window w, XWindowAttributes *wa);  /* manage new client */
+void resize(Client *c, int x, int y,
+               int w, int h, Bool sizehints);  /* resize with given coordinates c*/
+void togglefloating(const char *arg);  /* toggles sel between floating/tiled state */
+void unban(Client *c);                 /* unbans c */
+void unmanage(Client *c);              /* destroy c */
+void updatesizehints(Client *c);       /* update the size hint variables of c */
+void updatetitle(Client *c);           /* update the name of c */
 
 /* draw.c */
-extern void draw(Bool border, const char *text);
-extern unsigned long initcolor(const char *colstr);
-extern void initfont(const char *fontstr);
-extern unsigned int textnw(char *text, unsigned int len);
-extern unsigned int textw(char *text);
-extern unsigned int texth(void);
+void drawstatus(void);                 /* draw the bar */
+void drawtext(const char *text, unsigned long col[ColLast]);   /* draw text */
+unsigned int textw(const char *text);  /* return the width of text in px*/
 
 /* event.c */
-extern void discard_events(long even_mask);
+void grabkeys(void);                   /* grab all keys defined in config.h */
 
-/* dev.c */
-extern void update_keys(void);
-extern void keypress(XEvent *e);
-extern void mresize(Client *c);
-extern void mmove(Client *c);
+/* layout.c */
+void focusclient(const char *arg);     /* focuses next(1)/previous(-1) visible client */
+void initlayouts(void);                        /* initialize layout array */
+Client *nexttiled(Client *c);          /* returns tiled successor of c */
+void restack(void);                    /* restores z layers of all clients */
+void setlayout(const char *arg);       /* sets layout, NULL means next layout */
+void togglebar(const char *arg);       /* shows/hides the bar */
 
 /* main.c */
-extern int error_handler(Display *dsply, XErrorEvent *e);
-extern void send_message(Window w, Atom a, long value);
-extern int win_proto(Window w);
-extern void quit(void *aux);
+void updatebarpos(void);               /* updates the bar position */
+void quit(const char *arg);            /* quit dwm nicely */
+int xerror(Display *dsply, XErrorEvent *ee);   /* dwm's X error handler */
+
+/* tag.c */
+void compileregs(void);                        /* initialize regexps of rules defined in config.h */
+Bool isvisible(Client *c);             /* returns True if client is visible */
+void settags(Client *c, Client *trans);        /* sets tags of c */
+void tag(const char *arg);             /* tags sel with arg's index */
+void toggletag(const char *arg);       /* toggles sel tags with arg's index */
+void toggleview(const char *arg);      /* toggles the tag with arg's index (in)visible */
+void view(const char *arg);            /* views the tag with arg's index */
 
 /* util.c */
-extern void error(const char *errstr, ...);
-extern void *emallocz(unsigned int size);
-extern void *emalloc(unsigned int size);
-extern void *erealloc(void *ptr, unsigned int size);
-extern char *estrdup(const char *str);
-extern void spawn(char *argv[]);
-extern void swap(void **p1, void **p2);
+void *emallocz(unsigned int size);     /* allocates zero-initialized memory, exits on error */
+void eprint(const char *errstr, ...);  /* prints errstr and exits with 1 */
+void spawn(const char *arg);           /* forks a new subprocess with arg's cmd */