dwm-meillo
view dwm.h @ 514:3dd1631824a6
documented the new behavior in man page
| author | Anselm R. Garbe <arg@10kloc.org> |
|---|---|
| date | Fri, 29 Sep 2006 17:20:05 +0200 |
| parents | ede48935f2b3 |
| children | d6d1d0033e3c |
line source
1 /*
2 * (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
3 * See LICENSE file for license details.
4 *
5 * dynamic window manager is designed like any other X client as well. It is
6 * driven through handling X events. In contrast to other X clients, a window
7 * manager selects for SubstructureRedirectMask on the root window, to receive
8 * events about window (dis-)appearance. Only one X connection at a time is
9 * allowed to select for this event mask.
10 *
11 * Calls to fetch an X event from the event queue are blocking. Due reading
12 * status text from standard input, a select()-driven main loop has been
13 * implemented which selects for reads on the X connection and STDIN_FILENO to
14 * handle all data smoothly. The event handlers of dwm are organized in an
15 * array which is accessed whenever a new event has been fetched. This allows
16 * event dispatching in O(1) time.
17 *
18 * Each child of the root window is called a client, except windows which have
19 * set the override_redirect flag. Clients are organized in a global
20 * doubly-linked client list, the focus history is remembered through a global
21 * stack list. Each client contains an array of Bools of the same size as the
22 * global tags array to indicate the tags of a client. For each client dwm
23 * creates a small title window, which is resized whenever the (_NET_)WM_NAME
24 * properties are updated or the client is moved/resized.
25 *
26 * Keys and tagging rules are organized as arrays and defined in the config.h
27 * file. These arrays are kept static in event.o and tag.o respectively,
28 * because no other part of dwm needs access to them. The current mode is
29 * represented by the arrange() function pointer, which wether points to
30 * dofloat() or dotile().
31 *
32 * To understand everything else, start reading main.c:main().
33 */
35 #include "config.h"
36 #include <X11/Xlib.h>
38 /* mask shorthands, used in event.c and client.c */
39 #define BUTTONMASK (ButtonPressMask | ButtonReleaseMask)
40 #define MOUSEMASK (BUTTONMASK | PointerMotionMask)
41 /* other stuff used in different places */
42 #define BORDERPX 1
43 #define MINW 100
44 #define PROTODELWIN 1
46 enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */
47 enum { WMProtocols, WMDelete, WMLast }; /* default atoms */
48 enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */
49 enum { ColFG, ColBG, ColLast }; /* color */
51 typedef enum {
52 StackLeft, StackBottom, StackRight
53 } StackPos; /* stack position*/
55 typedef enum {
56 TopLeft, TopRight, BotLeft, BotRight
57 } Corner; /* window corners */
59 typedef union {
60 const char *cmd;
61 int i;
62 } Arg; /* argument type */
64 typedef struct {
65 int ascent;
66 int descent;
67 int height;
68 XFontSet set;
69 XFontStruct *xfont;
70 } Fnt;
72 typedef struct {
73 int x, y, w, h;
74 unsigned long norm[ColLast];
75 unsigned long sel[ColLast];
76 unsigned long status[ColLast];
77 Drawable drawable;
78 Fnt font;
79 GC gc;
80 } DC; /* draw context */
82 typedef struct Client Client;
83 struct Client {
84 char name[256];
85 int proto;
86 int x, y, w, h;
87 int rx, ry, rw, rh; /* revert geometry */
88 int tx, ty, tw, th; /* title window geometry */
89 int basew, baseh, incw, inch, maxw, maxh, minw, minh;
90 int grav;
91 long flags;
92 unsigned int border, weight;
93 Bool isfloat, ismax;
94 Bool *tags;
95 Client *next;
96 Client *prev;
97 Client *snext;
98 Window win;
99 Window twin;
100 };
102 extern const char *tags[]; /* all tags */
103 extern char stext[1024]; /* status text */
104 extern int bx, by, bw, bh, bmw; /* bar geometry, bar mode label width */
105 extern int master, screen, sx, sy, sw, sh; /* screen geometry, master dimension*/
106 extern unsigned int ntags, numlockmask; /* number of tags, dynamic lock mask */
107 extern void (*handler[LASTEvent])(XEvent *); /* event handler */
108 extern void (*arrange)(Arg *); /* arrange function, indicates mode */
109 extern Atom wmatom[WMLast], netatom[NetLast];
110 extern Bool running, issel, *seltag; /* seltag is array of Bool */
111 extern Client *clients, *sel, *stack; /* global client list and stack */
112 extern Cursor cursor[CurLast];
113 extern DC dc; /* global draw context */
114 extern Display *dpy;
115 extern StackPos stackpos;
116 extern Window root, barwin;
118 /* client.c */
119 extern void ban(Client *c); /* ban c from screen */
120 extern void configure(Client *c); /* send synthetic configure event */
121 extern void focus(Client *c); /* focus c, c may be NULL */
122 extern Client *getclient(Window w); /* return client of w */
123 extern Client *getctitle(Window w); /* return client of title window */
124 extern void gravitate(Client *c, Bool invert); /* gravitate c */
125 extern void killclient(Arg *arg); /* kill c nicely */
126 extern void manage(Window w, XWindowAttributes *wa); /* manage new client */
127 extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/
128 extern void resizetitle(Client *c); /* resizes c->twin correctly */
129 extern void updatesize(Client *c); /* update the size structs of c */
130 extern void updatetitle(Client *c); /* update the name of c */
131 extern void unmanage(Client *c); /* destroy c */
133 /* draw.c */
134 extern void drawall(void); /* draw all visible client titles and the bar */
135 extern void drawstatus(void); /* draw the bar */
136 extern void drawtitle(Client *c); /* draw title of c */
137 extern unsigned long getcolor(const char *colstr); /* return color of colstr */
138 extern void setfont(const char *fontstr); /* set the font for DC */
139 extern unsigned int textw(const char *text); /* return the width of text in px*/
141 /* event.c */
142 extern void grabkeys(void); /* grab all keys defined in config.h */
143 extern void procevent(void); /* process pending X events */
145 /* main.c */
146 extern int getproto(Window w); /* return protocol mask of WMProtocols property of w */
147 extern void quit(Arg *arg); /* quit dwm nicely */
148 extern void sendevent(Window w, Atom a, long value); /* send synthetic event to w */
149 extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
151 /* tag.c */
152 extern void initrregs(void); /* initialize regexps of rules defined in config.h */
153 extern Client *getnext(Client *c); /* returns next visible client */
154 extern Client *getprev(Client *c); /* returns previous visible client */
155 extern void settags(Client *c, Client *trans); /* sets tags of c */
156 extern void tag(Arg *arg); /* tags c with arg's index */
157 extern void toggletag(Arg *arg); /* toggles c tags with arg's index */
159 /* util.c */
160 extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
161 extern void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */
162 extern void *erealloc(void *ptr, unsigned int size); /* reallocates memory, exits on error */
163 extern void spawn(Arg *arg); /* forks a new subprocess with to arg's cmd */
165 /* view.c */
166 extern void detach(Client *c); /* detaches c from global client list */
167 extern void dofloat(Arg *arg); /* arranges all windows floating, arg is ignored */
168 extern void dotile(Arg *arg); /* arranges all windows, arg is ignored */
169 extern void focusnext(Arg *arg); /* focuses next visible client, arg is ignored */
170 extern void focusprev(Arg *arg); /* focuses previous visible client, arg is ignored */
171 extern Bool isvisible(Client *c); /* returns True if client is visible */
172 extern void resizecol(Arg *arg); /* resizes the master dimension with arg's index value */
173 extern void restack(void); /* restores z layers of all clients */
174 extern void togglestackpos(Arg *arg); /* toggles stack position */
175 extern void togglemode(Arg *arg); /* toggles global arrange function (dotile/dofloat) */
176 extern void toggleview(Arg *arg); /* toggles the tag with arg's index (in)visible */
177 extern void updatemaster(void); /* updates master dimension */
178 extern void view(Arg *arg); /* views the tag with arg's index */
179 extern void viewall(Arg *arg); /* views all tags, arg is ignored */
180 extern void zoom(Arg *arg); /* zooms the focused client to master area, arg is ignored */