dwm/dwm.h

147 lines
6.4 KiB
C
Raw Normal View History

2007-05-30 06:19:28 -04:00
/* See LICENSE file for copyright and license details.
*
* dynamic window manager is designed like any other X client as well. It is
* driven through handling X events. In contrast to other X clients, a window
2006-09-19 10:13:44 -04:00
* manager selects for SubstructureRedirectMask on the root window, to receive
* events about window (dis-)appearance. Only one X connection at a time is
* allowed to select for this event mask.
*
2006-09-19 10:13:44 -04:00
* Calls to fetch an X event from the event queue are blocking. Due reading
* status text from standard input, a select()-driven main loop has been
2006-09-19 10:13:44 -04:00
* implemented which selects for reads on the X connection and STDIN_FILENO to
* handle all data smoothly. The event handlers of dwm are organized in an
* array which is accessed whenever a new event has been fetched. This allows
* event dispatching in O(1) time.
*
* Each child of the root window is called a client, except windows which have
* set the override_redirect flag. Clients are organized in a global
* doubly-linked client list, the focus history is remembered through a global
* stack list. Each client contains an array of Bools of the same size as the
* global tags array to indicate the tags of a client. For each client dwm
2006-09-19 10:13:44 -04:00
* creates a small title window, which is resized whenever the (_NET_)WM_NAME
* properties are updated or the client is moved/resized.
*
* Keys and tagging rules are organized as arrays and defined in the config.h
* file. These arrays are kept static in event.o and tag.o respectively,
2007-02-19 10:40:36 -05:00
* because no other part of dwm needs access to them. The current layout is
* represented by the lt pointer.
*
2006-09-19 10:13:44 -04:00
* To understand everything else, start reading main.c:main().
2006-07-10 10:38:18 -04:00
*/
#include "config.h"
#include <X11/Xlib.h>
2006-07-12 19:30:55 -04:00
2006-08-01 06:32:33 -04:00
/* mask shorthands, used in event.c and client.c */
#define BUTTONMASK (ButtonPressMask | ButtonReleaseMask)
2006-08-01 06:32:33 -04:00
2007-05-15 06:09:18 -04:00
enum { BarTop, BarBot, BarOff }; /* bar position */
2006-09-11 01:40:41 -04:00
enum { CurNormal, CurResize, CurMove, CurLast }; /* cursor */
enum { ColBorder, ColFG, ColBG, ColLast }; /* color */
2007-05-15 06:09:18 -04:00
enum { NetSupported, NetWMName, NetLast }; /* EWMH atoms */
enum { WMProtocols, WMDelete, WMName, WMState, WMLast };/* default atoms */
2006-09-11 01:40:41 -04:00
typedef struct Client Client;
2006-07-10 10:38:18 -04:00
struct Client {
2006-07-12 19:04:38 -04:00
char name[256];
int x, y, w, h;
int rx, ry, rw, rh; /* revert geometry */
2006-07-11 16:49:09 -04:00
int basew, baseh, incw, inch, maxw, maxh, minw, minh;
int minax, maxax, minay, maxay;
2006-07-11 16:49:09 -04:00
long flags;
unsigned int border, oldborder;
Bool isbanned, isfixed, ismax, isfloating;
Bool *tags;
2006-07-10 10:38:18 -04:00
Client *next;
Client *prev;
Client *snext;
Window win;
2006-07-10 10:38:18 -04:00
};
2007-02-22 12:17:07 -05:00
typedef struct {
int x, y, w, h;
unsigned long norm[ColLast];
unsigned long sel[ColLast];
Drawable drawable;
GC gc;
struct {
int ascent;
int descent;
int height;
XFontSet set;
XFontStruct *xfont;
} font;
} DC; /* draw context */
extern const char *tags[]; /* all tags */
extern char stext[256]; /* status text */
extern int screen, sx, sy, sw, sh; /* screen geometry */
extern int wax, way, wah, waw; /* windowarea geometry */
extern unsigned int bh, blw, bpos; /* bar height, bar layout label width, bar position */
extern unsigned int ntags, numlockmask; /* number of tags, numlock mask */
extern void (*handler[LASTEvent])(XEvent *); /* event handler */
extern Atom wmatom[WMLast], netatom[NetLast];
2007-08-17 15:12:55 -04:00
extern Bool selscreen, *seltags; /* seltags is array of Bool */
extern Client *clients, *sel, *stack; /* global client list and stack */
extern Cursor cursor[CurLast];
extern DC dc; /* global draw context */
extern Display *dpy;
extern Window root, barwin;
2006-07-10 16:16:48 -04:00
/* client.c */
void attach(Client *c); /* attaches c to global client list */
2007-06-04 05:50:48 -04:00
void ban(Client *c); /* bans c */
void configure(Client *c); /* send synthetic configure event */
void detach(Client *c); /* detaches c from global client list */
void focus(Client *c); /* focus c if visible && !NULL, or focus top visible */
2007-05-15 06:09:18 -04:00
void killclient(const char *arg); /* kill sel nicely */
void manage(Window w, XWindowAttributes *wa); /* manage new client */
void resize(Client *c, int x, int y,
int w, int h, Bool sizehints); /* resize with given coordinates c*/
2007-06-04 05:50:48 -04:00
void unban(Client *c); /* unbans c */
void unmanage(Client *c); /* unmanage c */
2007-05-15 06:09:18 -04:00
void updatesizehints(Client *c); /* update the size hint variables of c */
void updatetitle(Client *c); /* update the name of c */
2006-07-11 10:14:22 -04:00
/* draw.c */
2007-09-15 06:36:42 -04:00
void drawbar(void); /* draw the bar */
void drawtext(const char *text, unsigned long col[ColLast]); /* draw text */
unsigned int textw(const char *text); /* return the width of text in px*/
2006-07-15 10:30:50 -04:00
/* event.c */
void grabkeys(void); /* grab all keys defined in config.h */
2006-07-11 15:24:10 -04:00
2006-07-13 05:43:05 -04:00
/* main.c */
Bool gettextprop(Window w, Atom atom,
char *text, unsigned int size); /* return text property, UTF-8 compliant */
2007-08-19 05:00:47 -04:00
void quit(const char *arg); /* quit dwm nicely */
int xerror(Display *dsply, XErrorEvent *ee); /* dwm's X error handler */
2006-07-13 05:43:05 -04:00
/* screen.c */
2007-08-18 07:48:05 -04:00
void applyrules(Client *c); /* applies rules to c */
void arrange(void); /* arranges all windows depending on the layout in use */
void compileregs(void); /* initialize regexps of rules defined in config.h */
void focusnext(const char *arg); /* focuses next visible client */
void focusprev(const char *arg); /* focuses prev visible client */
const char *getsymbol(void); /* returns symbol of enabled layout */
void initlayouts(void); /* initialize layout array */
Bool isarrange(void (*func)()); /* returns True if func is the layout function in use */
Bool isfloating(void); /* returns True if floating layout is enabled */
Bool isvisible(Client *c); /* returns True if client is visible */
Client *nexttiled(Client *c); /* returns tiled successor of c */
void restack(void); /* restores z layers of all clients */
void setlayout(const char *arg); /* sets layout, NULL means next layout */
void tag(const char *arg); /* tags sel with arg's index */
void togglebar(const char *arg); /* shows/hides the bar */
2007-08-15 13:27:32 -04:00
void togglefloating(const char *arg); /* toggles sel between floating/tiled state */
void togglemax(const char *arg); /* toggles maximization of floating client */
2007-05-15 06:09:18 -04:00
void toggletag(const char *arg); /* toggles sel tags with arg's index */
void toggleview(const char *arg); /* toggles the tag with arg's index (in)visible */
2007-08-19 05:00:47 -04:00
void updatebarpos(void); /* updates the bar position */
void view(const char *arg); /* views the tag with arg's index */
/* util.c */
void *emallocz(unsigned int size); /* allocates zero-initialized memory, exits on error */
void eprint(const char *errstr, ...); /* prints errstr and exits with 1 */
void spawn(const char *arg); /* forks a new subprocess with arg's cmd */