Mercurial > aewl
annotate dwm.h @ 459:3c3f429dca99
made introduction comment in dwm.h shorter
author | Anselm R. Garbe <arg@10kloc.org> |
---|---|
date | Tue, 12 Sep 2006 09:46:19 +0200 |
parents | e97ad13f04dc |
children | ab4b08d49d24 |
rev | line source |
---|---|
0 | 1 /* |
2 * (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com> | |
3 * See LICENSE file for license details. | |
457
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
4 * |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
5 * dynamic window manager is designed like any other X client as well. It is |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
6 * driven through handling X events. In contrast to other X clients, a window |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
7 * manager like dwm selects for SubstructureRedirectMask on the root window, to |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
8 * receive events about child window appearance and disappearance. Only one X |
459
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
9 * connection at a time is allowed to select for this event mask. |
457
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
10 * |
459
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
11 * Calls to fetch an X event from the event queue of the X connection are |
457
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
12 * blocking. Due the fact, that dwm reads status text from standard input, a |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
13 * select-driven main loop has been implemented which selects for reads on the |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
14 * X connection and STDIN_FILENO to handle all data smoothly and without |
459
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
15 * busy-loop quirks. The event handlers of dwm are organized in an array which |
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
16 * is accessed whenever a new event has been fetched. This allows event |
457
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
17 * dispatching in O(1) time. |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
18 * |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
19 * Each child window of the root window is called a client in window manager |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
20 * terminology, except windows which have set the override_redirect flag. |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
21 * Clients are organized in a global doubly-linked client list, the focus |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
22 * history is remembered through a global stack list. Each client contains an |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
23 * array of Bools of the same size as the global tags array to indicate the |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
24 * tags of a client. There are no other data structures to organize the clients |
459
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
25 * in tag lists. All clients which have at least one tag enabled of the current |
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
26 * tags viewed, will be visible on the screen, all other clients are banned to |
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
27 * the x-location x + 2 * screen width. This avoids having additional layers |
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
28 * of workspace handling. |
457
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
29 * |
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
30 * For each client dwm creates a small title window which is resized whenever |
459
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
31 * the WM_NAME or _NET_WM_NAME properties are updated or the client is resized. |
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
32 * Keys and tagging rules are organized as arrays and defined in the config.h |
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
33 * file. These arrays are kept static in event.o and tag.o respectively, |
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
34 * because no other part of dwm needs access to them. The current mode is |
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
35 * represented by the arrange function pointer which wether points to dofloat |
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
36 * or dotile. |
457
e97ad13f04dc
added a general comment to dwm.h how dwm is basically organized
Anselm R. Garbe <arg@10kloc.org>
parents:
456
diff
changeset
|
37 * |
459
3c3f429dca99
made introduction comment in dwm.h shorter
Anselm R. Garbe <arg@10kloc.org>
parents:
457
diff
changeset
|
38 * To understand everything else, start with reading main.c:main(). |
0 | 39 */ |
40 | |
166
e0535db04dfe
removed the CONFIG variable from config.mk, renamed config.h into config.default.h, after first clone/extract one needs to copy config.default.h to config.h, that is easier than always heavy typing make CONFIG=blafasel
arg@10ksloc.org
parents:
164
diff
changeset
|
41 #include "config.h" |
32 | 42 #include <X11/Xlib.h> |
43 | |
143 | 44 /* mask shorthands, used in event.c and client.c */ |
150
a26b32ff8911
cleaned config.*h to prevent some confusion
arg@10ksloc.org
parents:
148
diff
changeset
|
45 #define BUTTONMASK (ButtonPressMask | ButtonReleaseMask) |
a26b32ff8911
cleaned config.*h to prevent some confusion
arg@10ksloc.org
parents:
148
diff
changeset
|
46 #define MOUSEMASK (BUTTONMASK | PointerMotionMask) |
157
93012e947eae
renamed WM_PROTOCOL_DELWIN into PROTODELWIN
arg@10ksloc.org
parents:
150
diff
changeset
|
47 #define PROTODELWIN 1 |
143 | 48 |
452 | 49 enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */ |
50 enum { WMProtocols, WMDelete, WMLast }; /* default atoms */ | |
51 enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */ | |
52 enum { ColFG, ColBG, ColLast }; /* color */ | |
53 | |
54 typedef enum { | |
55 TopLeft, TopRight, BotLeft, BotRight | |
56 } Corner; /* window corners */ | |
57 | |
333
827f8f6c9e97
separated setup stuff into main.c:setup() - this makes main() more readable
Anselm R. Garbe <arg@10kloc.org>
parents:
327
diff
changeset
|
58 typedef union { |
189
523df4a3c1c4
using execl now, argv changed, using cmd and const char defs directly in the KEYS struct
arg@10ksloc.org
parents:
178
diff
changeset
|
59 const char *cmd; |
49
466591c2f967
implemented tagging a client
Anselm R. Garbe <garbeam@wmii.de>
parents:
46
diff
changeset
|
60 int i; |
452 | 61 } Arg; /* argument type */ |
99
a19556fe83b5
applied Sanders resize patch, fixed lower bug
arg@10ksloc.org
parents:
95
diff
changeset
|
62 |
333
827f8f6c9e97
separated setup stuff into main.c:setup() - this makes main() more readable
Anselm R. Garbe <arg@10kloc.org>
parents:
327
diff
changeset
|
63 typedef struct { |
32 | 64 int ascent; |
65 int descent; | |
66 int height; | |
84
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
67 XFontSet set; |
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
68 XFontStruct *xfont; |
333
827f8f6c9e97
separated setup stuff into main.c:setup() - this makes main() more readable
Anselm R. Garbe <arg@10kloc.org>
parents:
327
diff
changeset
|
69 } Fnt; |
32 | 70 |
452 | 71 typedef struct { |
32 | 72 int x, y, w, h; |
353
8a06efe5b563
new color stuff/new rendering stuff
Anselm R. Garbe <arg@10kloc.org>
parents:
352
diff
changeset
|
73 unsigned long norm[ColLast]; |
8a06efe5b563
new color stuff/new rendering stuff
Anselm R. Garbe <arg@10kloc.org>
parents:
352
diff
changeset
|
74 unsigned long sel[ColLast]; |
8a06efe5b563
new color stuff/new rendering stuff
Anselm R. Garbe <arg@10kloc.org>
parents:
352
diff
changeset
|
75 unsigned long status[ColLast]; |
84
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
76 Drawable drawable; |
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
77 Fnt font; |
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
78 GC gc; |
452 | 79 } DC; /* draw context */ |
32 | 80 |
333
827f8f6c9e97
separated setup stuff into main.c:setup() - this makes main() more readable
Anselm R. Garbe <arg@10kloc.org>
parents:
327
diff
changeset
|
81 typedef struct Client Client; |
0 | 82 struct Client { |
31 | 83 char name[256]; |
13
5cc5e55a132d
added protocol killing stuff
Anselm R. Garbe <garbeam@wmii.de>
parents:
10
diff
changeset
|
84 int proto; |
115
329fd7dae530
removed c->f{x,y,w,h} and c->t{x,y,w,h} in favor for the new rule handling remembering two kinds of geometries is unnecessary, removed the randomized (x,y) setting on dofloat startup, was kind too random und unpredictable
arg@10ksloc.org
parents:
114
diff
changeset
|
85 int x, y, w, h; |
453 | 86 int tx, ty, tw, th; /* title window geometry */ |
20 | 87 int basew, baseh, incw, inch, maxw, maxh, minw, minh; |
29 | 88 int grav; |
164
21071ae1fe68
made fullscreen apps working fine in floating mode (there is no sane way to make them work in tiled mode, thus I switch to floating mode if I run such kind of app), also fixed the xterm issue reported by Sander
arg@10ksloc.org
parents:
157
diff
changeset
|
89 long flags; |
381
b00cc483d13b
still something wrong with reorder()
Anselm R. Garbe <arg@10kloc.org>
parents:
378
diff
changeset
|
90 unsigned int border, weight; |
80
8125f908c80c
several additions in mouse handling ;)
Anselm R. Garbe <garbeam@wmii.de>
parents:
78
diff
changeset
|
91 Bool isfloat; |
178
e848966a1ac6
removed TLast tag enum, now tags is simple defined as char *[] array, the rest is calculated correctly, rules take an int array for the tags
arg@10ksloc.org
parents:
173
diff
changeset
|
92 Bool *tags; |
84
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
93 Client *next; |
127
1480e19f6377
using double-linked list in order to get correct prev focus handling
arg@10ksloc.org
parents:
125
diff
changeset
|
94 Client *prev; |
446
a2e587651c79
using a global stack for focus recovery on arrange() - seems to work great
Anselm R. Garbe <arg@10kloc.org>
parents:
431
diff
changeset
|
95 Client *snext; |
0 | 96 Window win; |
342 | 97 Window twin; |
0 | 98 }; |
99 | |
452 | 100 extern const char *tags[]; /* all tags */ |
101 extern char stext[1024]; /* status text */ | |
102 extern int bx, by, bw, bh, bmw; /* bar geometry, bar mode label width */ | |
103 extern int mw, screen, sx, sy, sw, sh; /* screen geometry, master width */ | |
454
ffb462fb7903
small change to comments, renamed two set* functions in client.c into update*
Anselm R. Garbe <arg@10kloc.org>
parents:
453
diff
changeset
|
104 extern unsigned int ntags, numlockmask; /* number of tags, dynamic lock mask */ |
452 | 105 extern void (*handler[LASTEvent])(XEvent *); /* event handler */ |
106 extern void (*arrange)(Arg *); /* arrange function, indicates mode */ | |
84
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
107 extern Atom wmatom[WMLast], netatom[NetLast]; |
452 | 108 extern Bool running, issel, maximized, *seltag; /* seltag is array of Bool */ |
454
ffb462fb7903
small change to comments, renamed two set* functions in client.c into update*
Anselm R. Garbe <arg@10kloc.org>
parents:
453
diff
changeset
|
109 extern Client *clients, *sel, *stack; /* global cleint list and stack */ |
84
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
110 extern Cursor cursor[CurLast]; |
454
ffb462fb7903
small change to comments, renamed two set* functions in client.c into update*
Anselm R. Garbe <arg@10kloc.org>
parents:
453
diff
changeset
|
111 extern DC dc; /* global draw context */ |
84
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
112 extern Display *dpy; |
052fe7498930
ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents:
80
diff
changeset
|
113 extern Window root, barwin; |
3
e969f3575b7a
several new changes, made gridmenu working
Anselm R. Garbe <garbeam@wmii.de>
parents:
2
diff
changeset
|
114 |
5 | 115 /* client.c */ |
454
ffb462fb7903
small change to comments, renamed two set* functions in client.c into update*
Anselm R. Garbe <arg@10kloc.org>
parents:
453
diff
changeset
|
116 extern void ban(Client *c); /* ban c from screen */ |
452 | 117 extern void focus(Client *c); /* focus c, c may be NULL */ |
118 extern Client *getclient(Window w); /* return client of w */ | |
119 extern Client *getctitle(Window w); /* return client of title window */ | |
120 extern void gravitate(Client *c, Bool invert); /* gravitate c */ | |
121 extern void killclient(Arg *arg); /* kill c nicely */ | |
122 extern void manage(Window w, XWindowAttributes *wa); /* manage new client */ | |
123 extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/ | |
454
ffb462fb7903
small change to comments, renamed two set* functions in client.c into update*
Anselm R. Garbe <arg@10kloc.org>
parents:
453
diff
changeset
|
124 extern void updatesize(Client *c); /* update the size structs of c */ |
ffb462fb7903
small change to comments, renamed two set* functions in client.c into update*
Anselm R. Garbe <arg@10kloc.org>
parents:
453
diff
changeset
|
125 extern void updatetitle(Client *c); /* update the name of c */ |
452 | 126 extern void togglemax(Arg *arg); /* (un)maximize c */ |
127 extern void unmanage(Client *c); /* destroy c */ | |
13
5cc5e55a132d
added protocol killing stuff
Anselm R. Garbe <garbeam@wmii.de>
parents:
10
diff
changeset
|
128 |
33
e90449e03167
new stuff (some warning elimination)
Anselm R. Garbe <garbeam@wmii.de>
parents:
32
diff
changeset
|
129 /* draw.c */ |
452 | 130 extern void drawall(); /* draw all visible client titles and the bar */ |
131 extern void drawstatus(); /* draw the bar */ | |
132 extern void drawtitle(Client *c); /* draw title of c */ | |
133 extern unsigned long getcolor(const char *colstr); /* return color of colstr */ | |
134 extern void setfont(const char *fontstr); /* set the font for DC */ | |
456
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
135 extern unsigned int textw(const char *text); /* return the width of text in px*/ |
33
e90449e03167
new stuff (some warning elimination)
Anselm R. Garbe <garbeam@wmii.de>
parents:
32
diff
changeset
|
136 |
75 | 137 /* event.c */ |
452 | 138 extern void grabkeys(); /* grab all keys defined in config.h */ |
139 extern void procevent(); /* process pending X events */ | |
18
1efa34c6e1b6
added mouse-based resizals
Anselm R. Garbe <garbeam@wmii.de>
parents:
16
diff
changeset
|
140 |
43 | 141 /* main.c */ |
452 | 142 extern int getproto(Window w); /* return protocol mask of WMProtocols property of w */ |
143 extern void quit(Arg *arg); /* quit dwm nicely */ | |
144 extern void sendevent(Window w, Atom a, long value); /* send synthetic event to w */ | |
145 extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */ | |
43 | 146 |
75 | 147 /* tag.c */ |
452 | 148 extern void initrregs(); /* initialize regexps of rules defined in config.h */ |
149 extern Client *getnext(Client *c); /* returns next visible client */ | |
150 extern Client *getprev(Client *c); /* returns previous visible client */ | |
454
ffb462fb7903
small change to comments, renamed two set* functions in client.c into update*
Anselm R. Garbe <arg@10kloc.org>
parents:
453
diff
changeset
|
151 extern void settags(Client *c, Client *trans); /* sets tags of c */ |
456
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
152 extern void tag(Arg *arg); /* tags c with arg's index */ |
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
153 extern void toggletag(Arg *arg); /* toggles c tags with arg's index */ |
73 | 154 |
32 | 155 /* util.c */ |
452 | 156 extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */ |
456
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
157 extern void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */ |
452 | 158 extern void *erealloc(void *ptr, unsigned int size); /* reallocates memory, exits on error */ |
456
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
159 extern void spawn(Arg *arg); /* forks a new subprocess with to arg's cmd */ |
327
96d09fd98e89
separated several functions into view.c
Anselm R. Garbe <arg@10kloc.org>
parents:
292
diff
changeset
|
160 |
96d09fd98e89
separated several functions into view.c
Anselm R. Garbe <arg@10kloc.org>
parents:
292
diff
changeset
|
161 /* view.c */ |
452 | 162 extern void detach(Client *c); /* detaches c from global client list */ |
456
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
163 extern void dofloat(Arg *arg); /* arranges all windows floating, arg is ignored */ |
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
164 extern void dotile(Arg *arg); /* arranges all windows, arg is ignored */ |
452 | 165 extern void focusnext(Arg *arg); /* focuses next visible client, arg is ignored */ |
166 extern void focusprev(Arg *arg); /* focuses previous visible client, arg is ignored */ | |
167 extern Bool isvisible(Client *c); /* returns True if client is visible */ | |
456
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
168 extern void resizecol(Arg *arg); /* resizes the master width with arg's index value */ |
452 | 169 extern void restack(); /* restores z layers of all clients */ |
456
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
170 extern void togglemode(Arg *arg); /* toggles global arrange function (dotile/dofloat) */ |
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
171 extern void toggleview(Arg *arg); /* toggles the tag with arg's index (in)visible */ |
d11d739ad9df
some other simplifications
Anselm R. Garbe <arg@10kloc.org>
parents:
454
diff
changeset
|
172 extern void view(Arg *arg); /* views the tag with arg's index */ |
454
ffb462fb7903
small change to comments, renamed two set* functions in client.c into update*
Anselm R. Garbe <arg@10kloc.org>
parents:
453
diff
changeset
|
173 extern void viewall(Arg *arg); /* views all tags, arg is ignored */ |
452 | 174 extern void zoom(Arg *arg); /* zooms the focused client to master column, arg is ignored */ |