X-Git-Url: https://git.xinqibao.xyz/dwm.git/blobdiff_plain/080a38d62d18be2ab98f66ed190d3d9e3463fec9..7e476fb86ba254e6fe3a916ed7b5298e432a469c:/dwm.h?ds=sidebyside
diff --git a/dwm.h b/dwm.h
index 0ed778c..6ab6bc3 100644
--- a/dwm.h
+++ b/dwm.h
@@ -1,134 +1,146 @@
-/*
- * (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>
-#include CONFIG
/* mask shorthands, used in event.c and client.c */
#define BUTTONMASK (ButtonPressMask | ButtonReleaseMask)
-#define MOUSEMASK (BUTTONMASK | PointerMotionMask)
-#define PROTODELWIN 1
-typedef union Arg Arg;
-typedef struct Client Client;
-typedef struct DC DC;
-typedef struct Fnt Fnt;
-
-union Arg {
- const char **argv;
- int i;
-};
-
-/* atoms */
-enum { NetSupported, NetWMName, NetLast };
-enum { WMProtocols, WMDelete, WMLast };
-
-/* cursor */
-enum { CurNormal, CurResize, CurMove, CurLast };
-
-/* windowcorners */
-typedef enum { TopLeft, TopRight, BotLeft, BotRight } Corner;
-
-struct Fnt {
- int ascent;
- int descent;
- int height;
- XFontSet set;
- XFontStruct *xfont;
-};
-
-struct DC { /* draw context */
- int x, y, w, h;
- unsigned long bg;
- unsigned long fg;
- unsigned long border;
- Drawable drawable;
- Fnt font;
- GC gc;
-};
+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, WMName, WMState, WMLast };/* default atoms */
+typedef struct Client Client;
struct Client {
char name[256];
- char *tags[TLast];
- int proto;
int x, y, w, h;
- int tx, ty, tw, th; /* title */
+ 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;
long flags;
- Bool isfloat;
- Bool ismax;
+ unsigned int border, oldborder;
+ Bool isbanned, isfixed, ismax, isfloating;
+ Bool *tags;
Client *next;
Client *prev;
+ Client *snext;
Window win;
- Window title;
};
-extern char *tags[TLast], stext[1024];
-extern int tsel, screen, sx, sy, sw, sh, bx, by, bw, bh, mw;
-extern void (*handler[LASTEvent])(XEvent *);
-extern void (*arrange)(Arg *);
+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 */
+
+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 running, issel;
-extern Client *clients, *sel;
+extern Bool selscreen, *seltags; /* seltags is array of Bool */
+extern Client *clients, *sel, *stack; /* global client list and stack */
extern Cursor cursor[CurLast];
-extern DC dc;
+extern DC dc; /* global draw context */
extern Display *dpy;
extern Window root, barwin;
-/* client.c */
-extern void ban(Client *c);
-extern void focus(Client *c);
-extern void focusnext(Arg *arg);
-extern void focusprev(Arg *arg);
-extern Client *getclient(Window w);
-extern Client *getctitle(Window w);
-extern void gravitate(Client *c, Bool invert);
-extern void higher(Client *c);
-extern void killclient(Arg *arg);
-extern void lower(Client *c);
-extern void manage(Window w, XWindowAttributes *wa);
-extern void resize(Client *c, Bool sizehints, Corner sticky);
-extern void setsize(Client *c);
-extern void settitle(Client *c);
-extern void togglemax(Arg *arg);
-extern void unmanage(Client *c);
-extern void zoom(Arg *arg);
+/* bar.c */
+void drawbar(void); /* draw the bar */
+void initbar(void); /* initializes the bar */
+unsigned int textw(const char *text); /* return the width of text in px*/
+void togglebar(const char *arg); /* shows/hides the bar */
+void updatebarpos(void); /* updates the bar position */
-/* draw.c */
-extern void drawall();
-extern void drawstatus();
-extern void drawtitle(Client *c);
-extern unsigned long getcolor(const char *colstr);
-extern void setfont(const char *fontstr);
-extern unsigned int textw(char *text);
+/* client.c */
+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 unban(Client *c); /* unbans c */
+void unmanage(Client *c); /* unmanage c */
+void updatesizehints(Client *c); /* update the size hint variables of c */
+void updatetitle(Client *c); /* update the name of c */
/* event.c */
-extern void grabkeys();
+void grabkeys(void); /* grab all keys defined in config.h */
/* main.c */
-extern int getproto(Window w);
-extern void quit(Arg *arg);
-extern void sendevent(Window w, Atom a, long value);
-extern int xerror(Display *dsply, XErrorEvent *ee);
-
-/* tag.c */
-extern void appendtag(Arg *arg);
-extern void dofloat(Arg *arg);
-extern void dotile(Arg *arg);
-extern Client *getnext(Client *c);
-extern Client *getprev(Client *c);
-extern void replacetag(Arg *arg);
-extern void settags(Client *c);
-extern void togglemode(Arg *arg);
-extern void view(Arg *arg);
-extern void viewnext(Arg *arg);
-extern void viewprev(Arg *arg);
+Bool gettextprop(Window w, Atom atom,
+ char *text, unsigned int size); /* return text property, UTF-8 compliant */
+void quit(const char *arg); /* quit dwm nicely */
+int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
+
+/* screen.c */
+void applyrules(Client *c); /* applies rules to c */
+void arrange(void); /* arranges all windows depending on the layout in use */
+void compileregs(void); /* initialize regexps of rules defined in config.h */
+void focusnext(const char *arg); /* focuses next visible client */
+void focusprev(const char *arg); /* focuses prev visible client */
+const char *getsymbol(void); /* returns symbol of enabled layout */
+void initlayouts(void); /* initialize layout array */
+Bool isarrange(void (*func)()); /* returns True if func is the layout function in use */
+Bool isfloating(void); /* returns True if floating layout is enabled */
+Bool isvisible(Client *c); /* returns True if client is visible */
+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 tag(const char *arg); /* tags sel with arg's index */
+void togglefloating(const char *arg); /* toggles sel between floating/tiled state */
+void togglemax(const char *arg); /* toggles maximization of floating client */
+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 *emallocz(unsigned int size);
-extern void eprint(const char *errstr, ...);
-extern void spawn(Arg *arg);
+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 */