replaced togglelayout with setlayout

[dwm.git] / dwm.h

diff --git a/dwm.h b/dwm.h
index 1f8283c..d4cc1fa 100644 (file)
--- a/dwm.h
+++ b/dwm.h
@@ -1,161 +1,150 @@
-/*
- * (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
+/* (C)opyright MMVI-MMVII Anselm R. Garbe <garbeam at gmail dot com>

  * See LICENSE file for license details.
  * See LICENSE file for 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>
 
 #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                                "#666699"
-#define FGCOLOR                                "#ffffff"
-#define BORDERCOLOR                    "#9999CC"
-#define MASTERW                                52 /* percent */
-#define WM_PROTOCOL_DELWIN     1
+enum { NetSupported, NetWMName, NetLast };             /* EWMH atoms */
+enum { WMProtocols, WMDelete, WMState, WMLast };       /* default atoms */
+enum { CurNormal, CurResize, CurMove, CurLast };       /* cursor */
+enum { ColBorder, ColFG, ColBG, ColLast };             /* color */

 
 

-/* tags */
-enum { Tscratch, Tdev, Tirc, Twww, Twork, TLast };
-
-/********** CUSTOMIZE **********/
-
-typedef union Arg Arg;
-typedef struct DC DC;
-typedef struct Client Client;
-typedef struct Fnt Fnt;
-typedef struct Key Key;
-typedef struct Rule Rule;
-
-union Arg {
-       const char **argv;
+typedef union {
+       const char *cmd;

        int i;
        int i;

-};
+} Arg; /* argument type */

 
 

-/* atoms */
-enum { WMProtocols, WMDelete, WMLast };
-enum { NetSupported, NetWMName, NetLast };
-
-/* cursor */
-enum { CurNormal, CurResize, CurMove, CurInput, CurLast };
-
-struct Fnt {
-       XFontStruct *xfont;
-       XFontSet set;
+typedef struct {

        int ascent;
        int descent;
        int height;
        int ascent;
        int descent;
        int height;

-};
+       XFontSet set;
+       XFontStruct *xfont;
+} Fnt;

 
 

-struct DC { /* draw context */
-       GC gc;
-       Drawable drawable;
+typedef struct {

        int x, y, w, h;
        int x, y, w, h;

+       unsigned long norm[ColLast];
+       unsigned long sel[ColLast];
+       Drawable drawable;

        Fnt font;
        Fnt font;

-       unsigned long bg;
-       unsigned long fg;
-       unsigned long border;
-};
+       GC gc;
+} DC; /* draw context */

 
 

+typedef struct Client Client;

 struct Client {
        char name[256];
 struct Client {
        char name[256];

-       char *tags[TLast];
-       int proto;

        int x, y, w, h;
        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 basew, baseh, incw, inch, maxw, maxh, minw, minh;

-       int grav;
-       unsigned int border;
+       int minax, minay, maxax, maxay;

        long flags; 
        long flags; 

-       Bool floating;
-       Window win;
-       Window title;
+       unsigned int border;
+       Bool isbanned, isfixed, ismax, isversatile;
+       Bool *tags;

        Client *next;
        Client *next;

-       Client *revert;
-};
-
-struct Rule {
-       const char *class;
-       const char *instance;
-       char *tags[TLast];
-       Bool floating;
-};
-
-struct Key {
-       unsigned long mod;
-       KeySym keysym;
-       void (*func)(Arg *arg);
-       Arg arg;
+       Client *prev;
+       Client *snext;
+       Window win;

 };
 
 };
 

+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;                   /* bar height, bar layout label width */
+extern unsigned int master, nmaster;           /* master percent, number of master clients */
+extern unsigned int ntags, numlockmask;                /* number of tags, dynamic lock mask */
+extern void (*handler[LASTEvent])(XEvent *);   /* event handler */
+extern Atom wmatom[WMLast], netatom[NetLast];
+extern Bool running, selscreen, *seltag;       /* seltag is array of Bool */
+extern Client *clients, *sel, *stack;          /* global client list and stack */
+extern Cursor cursor[CurLast];
+extern DC dc;                                  /* global draw context */

 extern Display *dpy;
 extern Display *dpy;

+extern Layout *lt;

 extern Window root, barwin;
 extern Window root, barwin;

-extern Atom wm_atom[WMLast], net_atom[NetLast];
-extern Cursor cursor[CurLast];
-extern Bool running, issel;
-extern void (*handler[LASTEvent])(XEvent *);
-extern void (*arrange)(Arg *);
-
-extern int tsel, screen, sx, sy, sw, sh, bx, by, bw, bh, mw;
-extern char *tags[TLast], stext[1024];
-
-extern DC dc;
-extern Client *clients, *sel;
-
-/* bar.c */
-extern void draw_bar();

 
 /* client.c */
 
 /* 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, Bool inc);
-extern void update_size(Client *c);
-extern Client *gettitle(Window w);
-extern void craise(Client *c);
-extern void lower(Client *c);
-extern void ckill(Arg *arg);
-extern void nextc(Arg *arg);
-extern void prevc(Arg *arg);
-extern void max(Arg *arg);
-extern void floating(Arg *arg);
-extern void tiling(Arg *arg);
-extern void ttrunc(Arg *arg);
-extern void tappend(Arg *arg);
-extern void view(Arg *arg);
-extern void zoom(Arg *arg);
-extern void gravitate(Client *c, Bool invert);
-
-/* draw.c */
-extern void drawtext(const char *text, Bool border);
-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);
+extern void configure(Client *c);              /* send synthetic configure event */
+extern void focus(Client *c);                  /* focus c, c may be NULL */
+extern void focusnext(Arg *arg);               /* focuses next visible client, arg is ignored  */
+extern void focusprev(Arg *arg);               /* focuses previous visible client, arg is ignored */
+extern void killclient(Arg *arg);              /* kill c nicely */
+extern void manage(Window w, XWindowAttributes *wa);   /* manage new client */
+extern Client *nexttiled(Client *c);           /* returns tiled successor of c */
+extern void resize(Client *c, int x, int y,
+               int w, int h, Bool sizehints);  /* resize with given coordinates c*/
+extern void updatesizehints(Client *c);                /* update the size hint variables of c */
+extern void updatetitle(Client *c);            /* update the name of c */
+extern void unmanage(Client *c);               /* destroy c */
+extern void zoom(Arg *arg);                    /* zooms the focused client to master area, arg is ignored */

 
 /* event.c */
 
 /* event.c */

-extern void discard_events(long even_mask);
-
-/* dev.c */
-extern void update_keys(void);
-extern void keypress(XEvent *e);
-extern void mresize(Client *c);
-extern void mmove(Client *c);
+extern void grabkeys(void);                    /* grab all keys defined in config.h */

 
 /* main.c */
 
 /* 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(Arg *arg);
+extern void drawstatus(void);                  /* draw the bar */
+extern unsigned int textw(const char *text);   /* return the width of text in px*/
+extern void quit(Arg *arg);                    /* quit dwm nicely */
+extern void sendevent(Window w, Atom a, long value);   /* send synthetic event to w */
+extern int xerror(Display *dsply, XErrorEvent *ee);    /* dwm's X error handler */
+
+/* screen.c */
+extern void compileregs(void);                 /* initialize regexps of rules defined in config.h */
+extern void incnmaster(Arg *arg);              /* increments nmaster with arg's index value */
+extern void initlayouts(void);                 /* initialize layout array */
+extern Bool isvisible(Client *c);              /* returns True if client is visible */
+extern void resizemaster(Arg *arg);            /* resizes the master percent with arg's index value */
+extern void restack(void);                     /* restores z layers of all clients */
+extern void setlayout(Arg *arg);               /* sets layout, -1 toggles */
+extern void settags(Client *c, Client *trans); /* sets tags of c */
+extern void tag(Arg *arg);                     /* tags c with arg's index */
+extern void toggleversatile(Arg *arg);         /* toggles focusesd client between versatile/and non-versatile state */
+extern void toggletag(Arg *arg);               /* toggles c tags with arg's index */
+extern void toggleview(Arg *arg);              /* toggles the tag with arg's index (in)visible */
+extern void versatile(void);                   /* arranges all windows versatile */
+extern void view(Arg *arg);                    /* views the tag with arg's index */

 
 /* util.c */
 
 /* 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(Arg *arg);
-extern void swap(void **p1, void **p2);
+extern void *emallocz(unsigned int size);      /* allocates zero-initialized memory, exits on error */
+extern void eprint(const char *errstr, ...);   /* prints errstr and exits with 1 */
+extern void spawn(Arg *arg);                   /* forks a new subprocess with to arg's cmd */
+