renamed floating into swimming (this does not clash with C naming conventions and...
[dwm.git] / dwm.h
1 /* (C)opyright MMVI-MMVII 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 layout is
28  * represented by the lt pointer.
29  *
30  * To understand everything else, start reading main.c:main().
31  */
32
33 #include "config.h"
34 #include <X11/Xlib.h>
35
36 /* mask shorthands, used in event.c and client.c */
37 #define BUTTONMASK              (ButtonPressMask | ButtonReleaseMask)
38
39 enum { NetSupported, NetWMName, NetLast };              /* EWMH atoms */
40 enum { WMProtocols, WMDelete, WMState, WMLast };        /* default atoms */
41 enum { CurNormal, CurResize, CurMove, CurLast };        /* cursor */
42 enum { ColBorder, ColFG, ColBG, ColLast };              /* color */
43
44 typedef union {
45         const char *cmd;
46         int i;
47 } Arg; /* argument type */
48
49 typedef struct {
50         int ascent;
51         int descent;
52         int height;
53         XFontSet set;
54         XFontStruct *xfont;
55 } Fnt;
56
57 typedef struct {
58         int x, y, w, h;
59         unsigned long norm[ColLast];
60         unsigned long sel[ColLast];
61         Drawable drawable;
62         Fnt font;
63         GC gc;
64 } DC; /* draw context */
65
66 typedef struct Client Client;
67 struct Client {
68         char name[256];
69         int x, y, w, h;
70         int rx, ry, rw, rh; /* revert geometry */
71         int basew, baseh, incw, inch, maxw, maxh, minw, minh;
72         int minax, minay, maxax, maxay;
73         long flags; 
74         unsigned int border;
75         Bool isbanned, isfixed, ismax, swimming;
76         Bool *tags;
77         Client *next;
78         Client *prev;
79         Client *snext;
80         Window win;
81 };
82
83 typedef struct {
84         const char *symbol;
85         void (*arrange)(void);
86 } Layout;
87
88 extern const char *tags[];                      /* all tags */
89 extern char stext[256];                         /* status text */
90 extern int screen, sx, sy, sw, sh;              /* screen geometry */
91 extern int wax, way, wah, waw;                  /* windowarea geometry */
92 extern unsigned int bh, blw;                    /* bar height, bar layout label width */
93 extern unsigned int master, nmaster;            /* master percent, number of master clients */
94 extern unsigned int ntags, numlockmask;         /* number of tags, dynamic lock mask */
95 extern void (*handler[LASTEvent])(XEvent *);    /* event handler */
96 extern Atom wmatom[WMLast], netatom[NetLast];
97 extern Bool running, selscreen, *seltag;        /* seltag is array of Bool */
98 extern Client *clients, *sel, *stack;           /* global client list and stack */
99 extern Cursor cursor[CurLast];
100 extern DC dc;                                   /* global draw context */
101 extern Display *dpy;
102 extern Layout *lt;
103 extern Window root, barwin;
104
105 /* client.c */
106 extern void configure(Client *c);               /* send synthetic configure event */
107 extern void focus(Client *c);                   /* focus c, c may be NULL */
108 extern void focusnext(Arg *arg);                /* focuses next visible client, arg is ignored  */
109 extern void focusprev(Arg *arg);                /* focuses previous visible client, arg is ignored */
110 extern void killclient(Arg *arg);               /* kill c nicely */
111 extern void manage(Window w, XWindowAttributes *wa);    /* manage new client */
112 extern Client *nexttiled(Client *c);            /* returns tiled successor of c */
113 extern void resize(Client *c, int x, int y,
114                 int w, int h, Bool sizehints);  /* resize with given coordinates c*/
115 extern void updatesizehints(Client *c);         /* update the size hint variables of c */
116 extern void updatetitle(Client *c);             /* update the name of c */
117 extern void unmanage(Client *c);                /* destroy c */
118 extern void zoom(Arg *arg);                     /* zooms the focused client to master area, arg is ignored */
119
120 /* event.c */
121 extern void grabkeys(void);                     /* grab all keys defined in config.h */
122
123 /* main.c */
124 extern void drawstatus(void);                   /* draw the bar */
125 extern unsigned int textw(const char *text);    /* return the width of text in px*/
126 extern void quit(Arg *arg);                     /* quit dwm nicely */
127 extern void sendevent(Window w, Atom a, long value);    /* send synthetic event to w */
128 extern int xerror(Display *dsply, XErrorEvent *ee);     /* dwm's X error handler */
129
130 /* screen.c */
131 extern void compileregs(void);                  /* initialize regexps of rules defined in config.h */
132 extern void incnmaster(Arg *arg);               /* increments nmaster with arg's index value */
133 extern void initlayouts(void);                  /* initialize layout array */
134 extern Bool isvisible(Client *c);               /* returns True if client is visible */
135 extern void resizemaster(Arg *arg);             /* resizes the master percent with arg's index value */
136 extern void restack(void);                      /* restores z layers of all clients */
137 extern void settags(Client *c, Client *trans);  /* sets tags of c */
138 extern void swim(void);                         /* arranges all windows swimming */
139 extern void tag(Arg *arg);                      /* tags c with arg's index */
140 extern void toggleswimming(Arg *arg);           /* toggles focusesd client between swimming/and non-swimming state */
141 extern void togglelayout(Arg *arg);             /* toggles layout */
142 extern void toggletag(Arg *arg);                /* toggles c tags with arg's index */
143 extern void toggleview(Arg *arg);               /* toggles the tag with arg's index (in)visible */
144 extern void view(Arg *arg);                     /* views the tag with arg's index */
145
146 /* util.c */
147 extern void *emallocz(unsigned int size);       /* allocates zero-initialized memory, exits on error */
148 extern void eprint(const char *errstr, ...);    /* prints errstr and exits with 1 */
149 extern void spawn(Arg *arg);                    /* forks a new subprocess with to arg's cmd */
150