JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
other color
[dwm.git] / dwm.h
1 /* See LICENSE file for copyright and license details.
2  *
3  * dynamic window manager is designed like any other X client as well. It is
4  * driven through handling X events. In contrast to other X clients, a window
5  * manager selects for SubstructureRedirectMask on the root window, to receive
6  * events about window (dis-)appearance.  Only one X connection at a time is
7  * allowed to select for this event mask.
8  *
9  * Calls to fetch an X event from the event queue are blocking.  Due reading
10  * status text from standard input, a select()-driven main loop has been
11  * implemented which selects for reads on the X connection and STDIN_FILENO to
12  * handle all data smoothly. The event handlers of dwm are organized in an
13  * array which is accessed whenever a new event has been fetched. This allows
14  * event dispatching in O(1) time.
15  *
16  * Each child of the root window is called a client, except windows which have
17  * set the override_redirect flag.  Clients are organized in a global
18  * doubly-linked client list, the focus history is remembered through a global
19  * stack list. Each client contains an array of Bools of the same size as the
20  * global tags array to indicate the tags of a client.  For each client dwm
21  * creates a small title window, which is resized whenever the (_NET_)WM_NAME
22  * properties are updated or the client is moved/resized.
23  *
24  * Keys and tagging rules are organized as arrays and defined in the config.h
25  * file. These arrays are kept static in event.o and tag.o respectively,
26  * because no other part of dwm needs access to them.  The current layout is
27  * represented by the lt pointer.
28  *
29  * To understand everything else, start reading main.c:main().
30  */
31
32 #include "config.h"
33 #include <X11/Xlib.h>
34
35 /* mask shorthands, used in event.c and client.c */
36 #define BUTTONMASK              (ButtonPressMask | ButtonReleaseMask)
37
38 enum { BarTop, BarBot, BarOff };                        /* bar position */
39 enum { CurNormal, CurResize, CurMove, CurLast };        /* cursor */
40 enum { ColBorder, ColFG, ColBG, ColLast };              /* color */
41 enum { NetSupported, NetWMName, NetLast };              /* EWMH atoms */
42 enum { WMProtocols, WMDelete, WMName, WMState, WMLast };/* default atoms */
43
44 typedef struct Client Client;
45 struct Client {
46         char name[256];
47         int x, y, w, h;
48         int rx, ry, rw, rh; /* revert geometry */
49         int basew, baseh, incw, inch, maxw, maxh, minw, minh;
50         int minax, maxax, minay, maxay;
51         long flags; 
52         unsigned int border, oldborder;
53         Bool isbanned, isfixed, ismax, isfloating;
54         Bool *tags;
55         Client *next;
56         Client *prev;
57         Client *snext;
58         Window win;
59 };
60
61 typedef struct {
62         int x, y, w, h;
63         unsigned long norm[ColLast];
64         unsigned long sel[ColLast];
65         Drawable drawable;
66         GC gc;
67         struct {
68                 int ascent;
69                 int descent;
70                 int height;
71                 XFontSet set;
72                 XFontStruct *xfont;
73         } font;
74 } DC; /* draw context */
75
76 extern const char *tags[];                      /* all tags */
77 extern char stext[256];                         /* status text */
78 extern int screen, sx, sy, sw, sh;              /* screen geometry */
79 extern int wax, way, wah, waw;                  /* windowarea geometry */
80 extern unsigned int bh, blw, bpos;              /* bar height, bar layout label width, bar position */
81 extern unsigned int ntags, numlockmask;         /* number of tags, numlock mask */
82 extern void (*handler[LASTEvent])(XEvent *);    /* event handler */
83 extern Atom wmatom[WMLast], netatom[NetLast];
84 extern Bool selscreen, *seltags;                /* seltags is array of Bool */
85 extern Client *clients, *sel, *stack;           /* global client list and stack */
86 extern Cursor cursor[CurLast];
87 extern DC dc;                                   /* global draw context */
88 extern Display *dpy;
89 extern Window root, barwin;
90
91 /* client.c */
92 void attach(Client *c);                 /* attaches c to global client list */
93 void ban(Client *c);                    /* bans c */
94 void configure(Client *c);              /* send synthetic configure event */
95 void detach(Client *c);                 /* detaches c from global client list */
96 void focus(Client *c);                  /* focus c if visible && !NULL, or focus top visible */
97 void killclient(const char *arg);       /* kill sel  nicely */
98 void manage(Window w, XWindowAttributes *wa);   /* manage new client */
99 void resize(Client *c, int x, int y,
100                 int w, int h, Bool sizehints);  /* resize with given coordinates c*/
101 void unban(Client *c);                  /* unbans c */
102 void unmanage(Client *c);               /* unmanage c */
103 void updatesizehints(Client *c);        /* update the size hint variables of c */
104 void updatetitle(Client *c);            /* update the name of c */
105
106 /* draw.c */
107 void drawstatus(void);                  /* draw the bar */
108 void drawtext(const char *text, unsigned long col[ColLast]);    /* draw text */
109 unsigned int textw(const char *text);   /* return the width of text in px*/
110
111 /* event.c */
112 void grabkeys(void);                    /* grab all keys defined in config.h */
113
114 /* main.c */
115 Bool gettextprop(Window w, Atom atom,
116                 char *text, unsigned int size); /* return text property, UTF-8 compliant */
117 void quit(const char *arg);                     /* quit dwm nicely */
118 int xerror(Display *dsply, XErrorEvent *ee);    /* dwm's X error handler */
119
120 /* screen.c */
121 void applyrules(Client *c);             /* applies rules to c */
122 void arrange(void);                     /* arranges all windows depending on the layout in use */
123 void compileregs(void);                 /* initialize regexps of rules defined in config.h */
124 void focusnext(const char *arg);        /* focuses next visible client */
125 void focusprev(const char *arg);        /* focuses prev visible client */
126 const char *getsymbol(void);            /* returns symbol of enabled layout */
127 void initlayouts(void);                 /* initialize layout array */
128 Bool isarrange(void (*func)());         /* returns True if func is the layout function in use */
129 Bool isfloating(void);                  /* returns True if floating layout is enabled */
130 Bool isvisible(Client *c);              /* returns True if client is visible */
131 Client *nexttiled(Client *c);           /* returns tiled successor of c */
132 void restack(void);                     /* restores z layers of all clients */
133 void setlayout(const char *arg);        /* sets layout, NULL means next layout */
134 void tag(const char *arg);              /* tags sel with arg's index */
135 void togglebar(const char *arg);        /* shows/hides the bar */
136 void togglefloating(const char *arg);   /* toggles sel between floating/tiled state */
137 void togglemax(const char *arg);        /* toggles maximization of floating client */
138 void toggletag(const char *arg);        /* toggles sel tags with arg's index */
139 void toggleview(const char *arg);       /* toggles the tag with arg's index (in)visible */
140 void updatebarpos(void);                /* updates the bar position */
141 void view(const char *arg);             /* views the tag with arg's index */
142
143 /* util.c */
144 void *emallocz(unsigned int size);      /* allocates zero-initialized memory, exits on error */
145 void eprint(const char *errstr, ...);   /* prints errstr and exits with 1 */
146 void spawn(const char *arg);            /* forks a new subprocess with arg's cmd */