annotate dwm.h @ 453:f30f937f9e52

small fix
author Anselm R. Garbe <arg@10kloc.org>
date Mon, 11 Sep 2006 08:58:58 +0200
parents 026aba558fdf
children ffb462fb7903
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
1 /*
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
2 * (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
3 * See LICENSE file for license details.
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
4 */
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
5
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
6 #include "config.h"
32
082c75b937b5 removed unnecessary crap
Anselm R. Garbe <garbeam@wmii.de>
parents: 31
diff changeset
7 #include <X11/Xlib.h>
082c75b937b5 removed unnecessary crap
Anselm R. Garbe <garbeam@wmii.de>
parents: 31
diff changeset
8
143
36cabfe408cd applied Sanders patches
arg@10ksloc.org
parents: 142
diff changeset
9 /* 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
10 #define BUTTONMASK (ButtonPressMask | ButtonReleaseMask)
a26b32ff8911 cleaned config.*h to prevent some confusion
arg@10ksloc.org
parents: 148
diff changeset
11 #define MOUSEMASK (BUTTONMASK | PointerMotionMask)
157
93012e947eae renamed WM_PROTOCOL_DELWIN into PROTODELWIN
arg@10ksloc.org
parents: 150
diff changeset
12 #define PROTODELWIN 1
143
36cabfe408cd applied Sanders patches
arg@10ksloc.org
parents: 142
diff changeset
13
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
14 enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
15 enum { WMProtocols, WMDelete, WMLast }; /* default atoms */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
16 enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
17 enum { ColFG, ColBG, ColLast }; /* color */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
18
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
19 typedef enum {
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
20 TopLeft, TopRight, BotLeft, BotRight
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
21 } Corner; /* window corners */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
22
333
827f8f6c9e97 separated setup stuff into main.c:setup() - this makes main() more readable
Anselm R. Garbe <arg@10kloc.org>
parents: 327
diff changeset
23 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
24 const char *cmd;
49
466591c2f967 implemented tagging a client
Anselm R. Garbe <garbeam@wmii.de>
parents: 46
diff changeset
25 int i;
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
26 } Arg; /* argument type */
99
a19556fe83b5 applied Sanders resize patch, fixed lower bug
arg@10ksloc.org
parents: 95
diff changeset
27
333
827f8f6c9e97 separated setup stuff into main.c:setup() - this makes main() more readable
Anselm R. Garbe <arg@10kloc.org>
parents: 327
diff changeset
28 typedef struct {
32
082c75b937b5 removed unnecessary crap
Anselm R. Garbe <garbeam@wmii.de>
parents: 31
diff changeset
29 int ascent;
082c75b937b5 removed unnecessary crap
Anselm R. Garbe <garbeam@wmii.de>
parents: 31
diff changeset
30 int descent;
082c75b937b5 removed unnecessary crap
Anselm R. Garbe <garbeam@wmii.de>
parents: 31
diff changeset
31 int height;
84
052fe7498930 ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
32 XFontSet set;
052fe7498930 ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
33 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
34 } Fnt;
32
082c75b937b5 removed unnecessary crap
Anselm R. Garbe <garbeam@wmii.de>
parents: 31
diff changeset
35
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
36 typedef struct {
32
082c75b937b5 removed unnecessary crap
Anselm R. Garbe <garbeam@wmii.de>
parents: 31
diff changeset
37 int x, y, w, h;
353
8a06efe5b563 new color stuff/new rendering stuff
Anselm R. Garbe <arg@10kloc.org>
parents: 352
diff changeset
38 unsigned long norm[ColLast];
8a06efe5b563 new color stuff/new rendering stuff
Anselm R. Garbe <arg@10kloc.org>
parents: 352
diff changeset
39 unsigned long sel[ColLast];
8a06efe5b563 new color stuff/new rendering stuff
Anselm R. Garbe <arg@10kloc.org>
parents: 352
diff changeset
40 unsigned long status[ColLast];
84
052fe7498930 ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
41 Drawable drawable;
052fe7498930 ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
42 Fnt font;
052fe7498930 ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
43 GC gc;
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
44 } DC; /* draw context */
32
082c75b937b5 removed unnecessary crap
Anselm R. Garbe <garbeam@wmii.de>
parents: 31
diff changeset
45
333
827f8f6c9e97 separated setup stuff into main.c:setup() - this makes main() more readable
Anselm R. Garbe <arg@10kloc.org>
parents: 327
diff changeset
46 typedef struct Client Client;
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
47 struct Client {
31
386649deb651 before leaning things up
Anselm R. Garbe <garbeam@wmii.de>
parents: 29
diff changeset
48 char name[256];
13
5cc5e55a132d added protocol killing stuff
Anselm R. Garbe <garbeam@wmii.de>
parents: 10
diff changeset
49 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
50 int x, y, w, h;
453
f30f937f9e52 small fix
Anselm R. Garbe <arg@10kloc.org>
parents: 452
diff changeset
51 int tx, ty, tw, th; /* title window geometry */
20
4560e0882c1d made code more readable
Anselm R. Garbe <garbeam@wmii.de>
parents: 19
diff changeset
52 int basew, baseh, incw, inch, maxw, maxh, minw, minh;
29
8ad86d0a6a53 added gravity stuff
Anselm R. Garbe <garbeam@wmii.de>
parents: 28
diff changeset
53 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
54 long flags;
381
b00cc483d13b still something wrong with reorder()
Anselm R. Garbe <arg@10kloc.org>
parents: 378
diff changeset
55 unsigned int border, weight;
80
8125f908c80c several additions in mouse handling ;)
Anselm R. Garbe <garbeam@wmii.de>
parents: 78
diff changeset
56 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
57 Bool *tags;
84
052fe7498930 ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
58 Client *next;
127
1480e19f6377 using double-linked list in order to get correct prev focus handling
arg@10ksloc.org
parents: 125
diff changeset
59 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
60 Client *snext;
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
61 Window win;
342
a1901753deef updated man page
Anselm R. Garbe <arg@10kloc.org>
parents: 333
diff changeset
62 Window twin;
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
63 };
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
64
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
65 extern const char *tags[]; /* all tags */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
66 extern char stext[1024]; /* status text */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
67 extern int bx, by, bw, bh, bmw; /* bar geometry, bar mode label width */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
68 extern int mw, screen, sx, sy, sw, sh; /* screen geometry, master width */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
69 extern unsigned int ntags, numlockmask; /* number of tags, and dynamic lock mask */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
70 extern void (*handler[LASTEvent])(XEvent *); /* event handler */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
71 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
72 extern Atom wmatom[WMLast], netatom[NetLast];
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
73 extern Bool running, issel, maximized, *seltag; /* seltag is array of Bool */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
74 extern Client *clients, *sel, *stack; /* Client containers */
84
052fe7498930 ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
75 extern Cursor cursor[CurLast];
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
76 extern DC dc; /* draw context for everything */
84
052fe7498930 ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
77 extern Display *dpy;
052fe7498930 ordered variables in structs and source files alphabetically
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
78 extern Window root, barwin;
3
e969f3575b7a several new changes, made gridmenu working
Anselm R. Garbe <garbeam@wmii.de>
parents: 2
diff changeset
79
5
e5018cae273f added several other stuff
Anselm R. Garbe <garbeam@wmii.de>
parents: 3
diff changeset
80 /* client.c */
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
81 extern void ban(Client *c); /* ban client from screen */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
82 extern void focus(Client *c); /* focus c, c may be NULL */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
83 extern Client *getclient(Window w); /* return client of w */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
84 extern Client *getctitle(Window w); /* return client of title window */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
85 extern void gravitate(Client *c, Bool invert); /* gravitate c */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
86 extern void killclient(Arg *arg); /* kill c nicely */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
87 extern void manage(Window w, XWindowAttributes *wa); /* manage new client */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
88 extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
89 extern void setsize(Client *c); /* set the size structs of c */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
90 extern void settitle(Client *c); /* set the name of c */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
91 extern void togglemax(Arg *arg); /* (un)maximize c */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
92 extern void unmanage(Client *c); /* destroy c */
13
5cc5e55a132d added protocol killing stuff
Anselm R. Garbe <garbeam@wmii.de>
parents: 10
diff changeset
93
33
e90449e03167 new stuff (some warning elimination)
Anselm R. Garbe <garbeam@wmii.de>
parents: 32
diff changeset
94 /* draw.c */
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
95 extern void drawall(); /* draw all visible client titles and the bar */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
96 extern void drawstatus(); /* draw the bar */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
97 extern void drawtitle(Client *c); /* draw title of c */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
98 extern unsigned long getcolor(const char *colstr); /* return color of colstr */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
99 extern void setfont(const char *fontstr); /* set the font for DC */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
100 extern unsigned int textw(const char *text); /* return the text width of text */
33
e90449e03167 new stuff (some warning elimination)
Anselm R. Garbe <garbeam@wmii.de>
parents: 32
diff changeset
101
75
f08271b7cb20 rearranged several stuff
Anselm R. Garbe <garbeam@wmii.de>
parents: 74
diff changeset
102 /* event.c */
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
103 extern void grabkeys(); /* grab all keys defined in config.h */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
104 extern void procevent(); /* process pending X events */
18
1efa34c6e1b6 added mouse-based resizals
Anselm R. Garbe <garbeam@wmii.de>
parents: 16
diff changeset
105
43
989178822938 changed default colors
Anselm R. Garbe <garbeam@wmii.de>
parents: 42
diff changeset
106 /* main.c */
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
107 extern int getproto(Window w); /* return protocol mask of WMProtocols property of w */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
108 extern void quit(Arg *arg); /* quit dwm nicely */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
109 extern void sendevent(Window w, Atom a, long value); /* send synthetic event to w */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
110 extern int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
43
989178822938 changed default colors
Anselm R. Garbe <garbeam@wmii.de>
parents: 42
diff changeset
111
75
f08271b7cb20 rearranged several stuff
Anselm R. Garbe <garbeam@wmii.de>
parents: 74
diff changeset
112 /* tag.c */
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
113 extern void initrregs(); /* initialize regexps of rules defined in config.h */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
114 extern Client *getnext(Client *c); /* returns next visible client */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
115 extern Client *getprev(Client *c); /* returns previous visible client */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
116 extern void settags(Client *c, Client *trans); /* updates tags of c */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
117 extern void tag(Arg *arg); /* tags c accordingly to arg's index */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
118 extern void toggletag(Arg *arg); /* toggles c tags accordingly to arg's index */
73
c2ddb9dbbd10 rearranged
Anselm R. Garbe <garbeam@wmii.de>
parents: 66
diff changeset
119
32
082c75b937b5 removed unnecessary crap
Anselm R. Garbe <garbeam@wmii.de>
parents: 31
diff changeset
120 /* util.c */
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
121 extern void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
122 extern void eprint(const char *errstr, ...); /* prints error string and exits with return code 1 */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
123 extern void *erealloc(void *ptr, unsigned int size); /* reallocates memory, exits on error */
453
f30f937f9e52 small fix
Anselm R. Garbe <arg@10kloc.org>
parents: 452
diff changeset
124 extern void spawn(Arg *arg); /* forks a new subprocess accordingly to arg's cmd */
327
96d09fd98e89 separated several functions into view.c
Anselm R. Garbe <arg@10kloc.org>
parents: 292
diff changeset
125
96d09fd98e89 separated several functions into view.c
Anselm R. Garbe <arg@10kloc.org>
parents: 292
diff changeset
126 /* view.c */
452
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
127 extern void detach(Client *c); /* detaches c from global client list */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
128 extern void dofloat(Arg *arg); /* arranges all windows in a floating way, arg is ignored */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
129 extern void dotile(Arg *arg); /* arranges all windows in a tiled way, arg is ignored */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
130 extern void focusnext(Arg *arg); /* focuses next visible client, arg is ignored */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
131 extern void focusprev(Arg *arg); /* focuses previous visible client, arg is ignored */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
132 extern Bool isvisible(Client *c); /* returns True if client is visible */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
133 extern void resizecol(Arg *arg); /* resizes the master width accordingly to arg's index value */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
134 extern void restack(); /* restores z layers of all clients */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
135 extern void togglemode(Arg *arg); /* toggles global arrange mode (between dotile and dofloat) */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
136 extern void toggleview(Arg *arg); /* makes the tag accordingly to arg's index (in)visible */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
137 extern void view(Arg *arg); /* makes the tag accordingly to arg's index visible */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
138 extern void viewall(Arg *arg); /* makes all tags visible, arg is ignored */
026aba558fdf added some comments
Anselm R. Garbe <arg@10kloc.org>
parents: 446
diff changeset
139 extern void zoom(Arg *arg); /* zooms the focused client to master column, arg is ignored */