added some comments

[dwm.git] / dwm.h

diff --git a/dwm.h b/dwm.h
index c171805..e416a1a 100644 (file)
--- a/dwm.h
+++ b/dwm.h
@@ -3,154 +3,137 @@
  * See LICENSE file for license details.
  */
 
  * See LICENSE file for license details.
  */
 

+#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 MOUSEMASK              (BUTTONMASK | PointerMotionMask)
+#define PROTODELWIN            1

 
 

-#define FONT                           "-*-terminus-medium-*-*-*-13-*-*-*-*-*-iso10646-*"
-#define BGCOLOR                                "#666699"
-#define FGCOLOR                                "#eeeeee"
-#define BORDERCOLOR                    "#9999CC"
-#define MASTERW                                52 /* percent */
-#define WM_PROTOCOL_DELWIN     1
+enum { NetSupported, NetWMName, NetLast };             /* EWMH atoms */
+enum { WMProtocols, WMDelete, WMLast };                        /* default atoms */
+enum { CurNormal, CurResize, CurMove, CurLast };       /* cursor */
+enum { ColFG, ColBG, ColLast };                                /* color */

 
 

-/* tags */
-enum { Tscratch, Tdev, Twww, Twork, TLast };
+typedef enum {
+       TopLeft, TopRight, BotLeft, BotRight
+} Corner; /* window corners */

 
 

-/********** 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];
+       unsigned long status[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 proto;
        int x, y, w, h;

-       int tx, ty, tw, th;
+       int tx, ty, tw, th; /* title */

        int basew, baseh, incw, inch, maxw, maxh, minw, minh;
        int grav;
        int basew, baseh, incw, inch, maxw, maxh, minw, minh;
        int grav;

-       unsigned int border;

        long flags; 
        long flags; 

-       Bool dofloat;
-       Window win;
-       Window title;
+       unsigned int border, weight;
+       Bool isfloat;
+       Bool *tags;

        Client *next;
        Client *next;

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

 };
 
 };
 

+extern const char *tags[];                     /* all tags */
+extern char stext[1024];                       /* status text */
+extern int bx, by, bw, bh, bmw;                        /* bar geometry, bar mode label width */
+extern int mw, screen, sx, sy, sw, sh;         /* screen geometry, master width */
+extern unsigned int ntags, numlockmask;                /* number of tags, and dynamic lock mask */
+extern void (*handler[LASTEvent])(XEvent *);   /* event handler */
+extern void (*arrange)(Arg *);                 /* arrange function, indicates mode  */
+extern Atom wmatom[WMLast], netatom[NetLast];
+extern Bool running, issel, maximized, *seltag;        /* seltag is array of Bool */
+extern Client *clients, *sel, *stack;          /* Client containers */
+extern Cursor cursor[CurLast];
+extern DC dc;                                  /* draw context for everything */

 extern Display *dpy;
 extern Window root, barwin;
 extern Display *dpy;
 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 Key key[];
-
-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;

 
 /* client.c */
 
 /* client.c */

-extern void ban(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 settitle(Client *c);
-extern void resize(Client *c, Bool inc);
-extern void setsize(Client *c);
-extern Client *getctitle(Window w);
-extern void higher(Client *c);
-extern void lower(Client *c);
-extern void gravitate(Client *c, Bool invert);
-extern void zoom(Arg *arg);
-extern void maximize(Arg *arg);
-extern void focusprev(Arg *arg);
-extern void focusnext(Arg *arg);
-extern void killclient(Arg *arg);
+extern void ban(Client *c);                    /* ban client from screen */
+extern void focus(Client *c);                  /* focus c, c may be NULL */
+extern Client *getclient(Window w);            /* return client of w */
+extern Client *getctitle(Window w);            /* return client of title window */
+extern void gravitate(Client *c, Bool invert); /* gravitate c */
+extern void killclient(Arg *arg);              /* kill c nicely */
+extern void manage(Window w, XWindowAttributes *wa);   /* manage new client */
+extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/
+extern void setsize(Client *c);                        /* set the size structs of c */
+extern void settitle(Client *c);               /* set the name of c */
+extern void togglemax(Arg *arg);               /* (un)maximize c */
+extern void unmanage(Client *c);               /* destroy c */

 
 /* draw.c */
 
 /* draw.c */

-extern void drawall();
-extern void drawstatus();
-extern void drawtitle(Client *c);
-extern void drawtext(const char *text, Bool invert, Bool border);
-extern unsigned long getcolor(const char *colstr);
-extern void setfont(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 drawall();                         /* draw all visible client titles and the bar */
+extern void drawstatus();                      /* draw the bar */
+extern void drawtitle(Client *c);              /* draw title of c */
+extern unsigned long getcolor(const char *colstr);     /* return color of colstr */
+extern void setfont(const char *fontstr);      /* set the font for DC */
+extern unsigned int textw(const char *text);   /* return the text width of text */

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

-extern void grabkeys();
+extern void grabkeys();                                /* grab all keys defined in config.h */
+extern void procevent();                       /* process pending X events */

 
 /* main.c */
 
 /* main.c */

-extern void quit(Arg *arg);
-extern int xerror(Display *dsply, XErrorEvent *ee);
-extern void sendevent(Window w, Atom a, long value);
-extern int getproto(Window w);
+extern int getproto(Window w);                 /* return protocol mask of WMProtocols property of w */
+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 */

 
 /* tag.c */
 
 /* tag.c */

-extern Client *getnext(Client *c);
-extern void settags(Client *c);
-extern void dofloat(Arg *arg);
-extern void dotile(Arg *arg);
-extern void view(Arg *arg);
-extern void appendtag(Arg *arg);
-extern void replacetag(Arg *arg);
+extern void initrregs();                       /* initialize regexps of rules defined in config.h */
+extern Client *getnext(Client *c);             /* returns next visible client */
+extern Client *getprev(Client *c);             /* returns previous visible client */
+extern void settags(Client *c, Client *trans); /* updates tags of c */
+extern void tag(Arg *arg);                     /* tags c accordingly to arg's index */
+extern void toggletag(Arg *arg);               /* toggles c tags accordingly to arg's index */

 
 /* util.c */
 
 /* util.c */

-extern void eprint(const char *errstr, ...);
-extern void *emallocz(unsigned int size);
-extern void spawn(Arg *arg);
+extern void *emallocz(unsigned int size);      /* allocates zero-initialized memory, exits on error */
+extern void eprint(const char *errstr, ...);   /* prints error string and exits with return code 1 */
+extern void *erealloc(void *ptr, unsigned int size);   /* reallocates memory, exits on error */
+extern void spawn(Arg *arg)                    /* forks a new subprocess accordingly to arg's cmd */
+
+/* view.c */
+extern void detach(Client *c);                 /* detaches c from global client list */
+extern void dofloat(Arg *arg);                 /* arranges all windows in a floating way, arg is ignored */
+extern void dotile(Arg *arg);                  /* arranges all windows in a tiled way, arg is ignored */
+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 Bool isvisible(Client *c);              /* returns True if client is visible */
+extern void resizecol(Arg *arg);               /* resizes the master width accordingly to arg's index value */
+extern void restack();                         /* restores z layers of all clients */
+extern void togglemode(Arg *arg);              /* toggles global arrange mode (between dotile and dofloat) */
+extern void toggleview(Arg *arg);              /* makes the tag accordingly to arg's index (in)visible */
+extern void view(Arg *arg);                    /* makes the tag accordingly to arg's index visible */
+extern void viewall(Arg *arg);                 /* makes all tags visible, arg is ignored */
+extern void zoom(Arg *arg);                    /* zooms the focused client to master column, arg is ignored */