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