about summary refs log blame commit diff stats
path: root/dwm.h
blob: da105b7afa7e51f2849106c510f774a4057fd731 (plain) (tree)
1
2
3
4
5
6
7
8
9
                                                              
                                        


                                                                             


                                                                              
  
                                                                            
                                                                        



                                                                              
  




                                                                              

                                                                             
  


                                                                             

                                                                        
  
                                                              

   
                   
                     
 
                                                   

                                                                     

                                          
                                 
 








                                                                           
               
                        
              
                          
 
                


                    

                           
      
 
                
                       


                                      


                          
                        
 
                             
               
                       
                  
                       
                                                 
                                                       
                                                             
                 
                    
                                    
                            
                   
                     
                     
                      
                   
                    

  


                                                                                        

                                                                                                       
                                                                   
                                                                                       
                                             
                                                                             
                                                                                  
                              
                                                                         
                    
                           
 
              
                                                                       
                                                                                    






                                                                                   
                                                                               

                                                                                          
                                                               
 
            

                                                                                                


                                                                                    
                                                                                   
 
             

                                                                                       
 
            



                                                                                                       
 
           
                                                                                                     

                                                                                     
                                                                    

                                                                                     
 
            
                                                                                                       
                                                                                    
                                                                                                
                                                                                              

            
                                                                                        

                                                                                   


                                                                                                     
                                                                                                       
                                                                                      


                                                                                                      
                                                                                    
                                                                                                             
/* (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
 * See LICENSE file for 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
 * 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.
 *
 * 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
 * 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
 * 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,
 * because no other part of dwm needs access to them.  The current mode is
 * represented by the arrange() function pointer, which wether points to
 * dofloat() or dotile(). 
 *
 * To understand everything else, start reading main.c:main().
 */

#include "config.h"
#include <X11/Xlib.h>

/* mask shorthands, used in event.c and client.c */
#define BUTTONMASK		(ButtonPressMask | ButtonReleaseMask)
#define MOUSEMASK		(BUTTONMASK | PointerMotionMask)
/* other stuff used in different places */
#define BORDERPX		1
#define PROTODELWIN		1

enum { NetSupported, NetWMName, NetLast };		/* EWMH atoms */
enum { WMProtocols, WMDelete, WMLast };			/* default atoms */
enum { CurNormal, CurResize, CurMove, CurLast };	/* cursor */
enum { ColFG, ColBG, ColLast };				/* color */

typedef enum {
	TopLeft, TopRight, BotLeft, BotRight
} Corner; /* window corners */

typedef union {
	const char *cmd;
	int i;
} Arg; /* argument type */

typedef struct {
	int ascent;
	int descent;
	int height;
	XFontSet set;
	XFontStruct *xfont;
} Fnt;

typedef struct {
	int x, y, w, h;
	unsigned long norm[ColLast];
	unsigned long sel[ColLast];
	unsigned long status[ColLast];
	Drawable drawable;
	Fnt font;
	GC gc;
} DC; /* draw context */

typedef struct Client Client;
struct Client {
	char name[256];
	int proto;
	int x, y, w, h;
	int rx, ry, rw, rh; /* revert geometry */
	int tx, ty, tw, th; /* title window geometry */
	int basew, baseh, incw, inch, maxw, maxh, minw, minh;
	int grav;
	long flags; 
	unsigned int border, weight;
	Bool isfloat, ismax;
	Bool *tags;
	Client *next;
	Client *prev;
	Client *snext;
	Window win;
	Window twin;
};

extern const char *tags[];			/* all tags */
extern char stext[1024];			/* status text */
extern int bx, by, bw, bh, bmw;			/* bar geometry, bar mode label width */
extern int screen, sx, sy, sw, sh;		/* screen geometry */
extern unsigned int master, ntags, numlockmask;	/* master percent, number of tags, dynamic lock mask */
extern void (*handler[LASTEvent])(XEvent *);	/* event handler */
extern void (*arrange)(void);			/* arrange function, indicates mode  */
extern Atom wmatom[WMLast], netatom[NetLast];
extern Bool running, issel, *seltag;		/* seltag 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;

/* client.c */
extern void ban(Client *c);			/* ban c from screen */
extern void configure(Client *c);		/* send synthetic configure event */
extern void focus(Client *c);			/* focus c, c may be NULL */
extern Client *getclient(Window w);		/* return client of w */
extern Client *getctitle(Window w);		/* return client of title window */
extern void gravitate(Client *c, Bool invert);	/* gravitate c */
extern void killclient(Arg *arg);		/* kill c nicely */
extern void manage(Window w, XWindowAttributes *wa);	/* manage new client */
extern void resize(Client *c, Bool sizehints, Corner sticky); /* resize c*/
extern void resizetitle(Client *c);		/* resizes c->twin correctly */
extern void updatesize(Client *c);			/* update the size structs of c */
extern void updatetitle(Client *c);		/* update the name of c */
extern void unmanage(Client *c);		/* destroy c */

/* draw.c */
extern void drawall(void);			/* draw all visible client titles and the bar */
extern void drawstatus(void);			/* draw the bar */
extern void drawtitle(Client *c);		/* draw title of c */
extern unsigned long getcolor(const char *colstr);	/* return color of colstr */
extern void setfont(const char *fontstr);	/* set the font for DC */
extern unsigned int textw(const char *text);	/* return the width of text in px*/

/* event.c */
extern void grabkeys(void);			/* grab all keys defined in config.h */
extern void procevent(void);			/* process pending X events */

/* main.c */
extern int getproto(Window w);			/* return protocol mask of WMProtocols property of w */
extern void quit(Arg *arg);			/* quit dwm nicely */
extern void sendevent(Window w, Atom a, long value);	/* send synthetic event to w */
extern int xerror(Display *dsply, XErrorEvent *ee);	/* dwm's X error handler */

/* tag.c */
extern void initrregs(void);			/* initialize regexps of rules defined in config.h */
extern Client *getnext(Client *c);		/* returns next visible client */
extern Client *getprev(Client *c);		/* returns previous visible client */
extern void settags(Client *c, Client *trans);	/* sets tags of c */
extern void tag(Arg *arg);			/* tags c with arg's index */
extern void toggletag(Arg *arg);		/* toggles c tags with arg's index */

/* util.c */
extern void *emallocz(unsigned int size);	/* allocates zero-initialized memory, exits on error */
extern void eprint(const char *errstr, ...);	/* prints errstr and exits with 1 */
extern void *erealloc(void *ptr, unsigned int size);	/* reallocates memory, exits on error */
extern void spawn(Arg *arg);			/* forks a new subprocess with to arg's cmd */

/* view.c */
extern void detach(Client *c);			/* detaches c from global client list */
extern void dofloat(void);			/* arranges all windows floating */
extern void dotile(void);			/* arranges all windows tiled */
extern void focusnext(Arg *arg);		/* focuses next visible client, arg is ignored  */
extern void focusprev(Arg *arg);		/* focuses previous visible client, arg is ignored */
extern Bool isvisible(Client *c);		/* returns True if client is visible */
extern void resizecol(Arg *arg);		/* resizes the master percent with arg's index value */
extern void restack(void);			/* restores z layers of all clients */
extern void togglemode(Arg *arg);		/* toggles global arrange function (dotile/dofloat) */
extern void toggleview(Arg *arg);		/* toggles the tag with arg's index (in)visible */
extern void view(Arg *arg);			/* views the tag with arg's index */
extern void viewall(Arg *arg);			/* views all tags, arg is ignored */
extern void zoom(Arg *arg);			/* zooms the focused client to master area, arg is ignored */
main [ # prepare default-space address 10:num/alloc-id, 11:num <- copy 0, 1000 # prepare default-space payload 1000:num <- copy 0 # alloc id of payload 1001:num <- copy 5 # length # prepare payload outside the local scope 2000:num/alloc-id, 2001:num <- copy 0, 34 # actual start of this recipe default-space:space <- copy 10:&:@:location # a local address 2:num, 3:num <- copy 0, 2000 20:num/raw <- copy *2:&:num ] +mem: storing 2000 in location 1005 +mem: storing 34 in location 20 //: precondition: disable name conversion for 'default-space' :(scenarios transform) :(scenario convert_names_passes_default_space) % Hide_errors = true; def main [ default-space:num <- copy 0 x:num <- copy 1 ] +name: assign x 2 -name: assign default-space 1 -name: assign default-space 2 :(scenarios run) :(before "End is_disqualified Special-cases") if (x.name == "default-space") x.initialized = true; :(before "End is_special_name Special-cases") if (s == "default-space") return true; //: core implementation :(before "End call Fields") int default_space; :(before "End call Constructor") default_space = 0; :(before "Begin canonize(x) Lookups") absolutize(x); :(code) void absolutize(reagent& x) { if (is_raw(x) || is_dummy(x)) return; if (x.name == "default-space") return; if (!x.initialized) raise << to_original_string(current_instruction()) << ": reagent not initialized: '" << x.original_string << "'\n" << end(); x.set_value(address(x.value, space_base(x))); x.properties.push_back(pair<string, string_tree*>("raw", NULL)); assert(is_raw(x)); } //: hook replaced in a later layer int space_base(const reagent& x) { return current_call().default_space ? (current_call().default_space + /*skip alloc id*/1) : 0; } int address(int offset, int base) { assert(offset >= 0); if (base == 0) return offset; // raw int size = get_or_insert(Memory, base); if (offset >= size) { // todo: test raise << current_recipe_name() << ": location " << offset << " is out of bounds " << size << " at " << base << '\n' << end(); DUMP(""); exit(1); return 0; } return base + /*skip length*/1 + offset; } //: reads and writes to the 'default-space' variable have special behavior :(after "Begin Preprocess write_memory(x, data)") if (x.name == "default-space") { if (!is_mu_space(x)) raise << maybe(current_recipe_name()) << "'default-space' should be of type address:array:location, but is " << to_string(x.type) << '\n' << end(); if (SIZE(data) != 2) raise << maybe(current_recipe_name()) << "'default-space' getting data from non-address\n" << end(); current_call().default_space = data.at(/*skip alloc id*/1); return; } :(code) bool is_mu_space(reagent/*copy*/ x) { canonize_type(x); if (!is_compound_type_starting_with(x.type, "address")) return false; drop_from_type(x, "address"); if (!is_compound_type_starting_with(x.type, "array")) return false; drop_from_type(x, "array"); return x.type && x.type->atom && x.type->name == "location"; } :(scenario get_default_space) def main [ # prepare default-space address 10:num/alloc-id, 11:num <- copy 0, 1000 # prepare default-space payload 1000:num <- copy 0 # alloc id of payload 1001:num <- copy 5 # length # actual start of this recipe default-space:space <- copy 10:space 2:space/raw <- copy default-space:space ] +mem: storing 1000 in location 3 :(after "Begin Preprocess read_memory(x)") if (x.name == "default-space") { vector<double> result; result.push_back(/*alloc id*/0); result.push_back(current_call().default_space); return result; } //:: fix 'get' :(scenario lookup_sidesteps_default_space_in_get) def main [ # prepare default-space address 10:num/alloc-id, 11:num <- copy 0, 1000 # prepare default-space payload 1000:num <- copy 0 # alloc id of payload 1001:num <- copy 5 # length # prepare payload outside the local scope 2000:num/alloc-id, 2001:num/x, 2002:num/y <- copy 0, 34, 35 # actual start of this recipe default-space:space <- copy 10:space # a local address 2:num, 3:num <- copy 0, 2000 3000:num/raw <- get *2:&:point, 1:offset ] +mem: storing 35 in location 3000 :(before "Read element" following "case GET:") element.properties.push_back(pair<string, string_tree*>("raw", NULL)); //:: fix 'index' :(scenario lookup_sidesteps_default_space_in_index) def main [ # prepare default-space address 10:num/alloc-id, 11:num <- copy 0, 1000 # prepare default-space payload 1000:num <- copy 0 # alloc id of payload 1001:num <- copy 5 # length # prepare an array address 20:num/alloc-id, 21:num <- copy 0, 2000 # prepare an array payload 2000:num/alloc-id, 2001:num/length, 2002:num/index:0, 2003:num/index:1 <- copy 0, 2, 34, 35 # actual start of this recipe default-space:space <- copy 10:&:@:location 1:&:@:num <- copy 20:&:@:num/raw 3000:num/raw <- index *1:&:@:num, 1 ] +mem: storing 35 in location 3000 :(before "Read element" following "case INDEX:") element.properties.push_back(pair<string, string_tree*>("raw", NULL)); //:: 'local-scope' is a convenience operation to automatically deduce //:: the amount of space to allocate in a default space with names :(scenario local_scope) def main [ local-scope x:num <- copy 0 y:num <- copy 3 ] # allocate space for x and y, as well as the chaining slot at indices 0 and 1 +mem: array length is 4 :(before "End is_disqualified Special-cases") if (x.name == "number-of-locals") x.initialized = true; :(before "End is_special_name Special-cases") if (s == "number-of-locals") return true; :(before "End Rewrite Instruction(curr, recipe result)") // rewrite 'local-scope' to // ``` // default-space:space <- new location:type, number-of-locals:literal // ``` // where number-of-locals is Name[recipe][""] if (curr.name == "local-scope") { rewrite_default_space_instruction(curr); } :(code) void rewrite_default_space_instruction(instruction& curr) { if (!curr.ingredients.empty()) raise << "'" << to_original_string(curr) << "' can't take any ingredients\n" << end(); curr.name = "new"; curr.ingredients.push_back(reagent("location:type")); curr.ingredients.push_back(reagent("number-of-locals:literal")); if (!curr.products.empty()) raise << "local-scope can't take any results\n" << end(); curr.products.push_back(reagent("default-space:space")); } :(after "Begin Preprocess read_memory(x)") if (x.name == "number-of-locals") { vector<double> result; result.push_back(Name[get(Recipe_ordinal, current_recipe_name())][""]); if (result.back() == 0) raise << "no space allocated for default-space in recipe " << current_recipe_name() << "; are you using names?\n" << end(); return result; } :(after "Begin Preprocess write_memory(x, data)") if (x.name == "number-of-locals") { raise << maybe(current_recipe_name()) << "can't write to special name 'number-of-locals'\n" << end(); return; } //:: all recipes must set default-space one way or another :(before "End Globals") bool Hide_missing_default_space_errors = true; :(before "End Checks") Transform.push_back(check_default_space); // idempotent :(code) void check_default_space(const recipe_ordinal r) { if (Hide_missing_default_space_errors) return; // skip previous core tests; this is only for Mu code const recipe& caller = get(Recipe, r); // End check_default_space Special-cases // assume recipes with only numeric addresses know what they're doing (usually tests) if (!contains_non_special_name(r)) return; trace(9991, "transform") << "--- check that recipe " << caller.name << " sets default-space" << end(); if (caller.steps.empty()) return; if (!starts_by_setting_default_space(caller)) raise << caller.name << " does not seem to start with 'local-scope' or 'default-space'\n" << end(); } bool starts_by_setting_default_space(const recipe& r) { return !r.steps.empty() && !r.steps.at(0).products.empty() && r.steps.at(0).products.at(0).name == "default-space"; } :(after "Load Mu Prelude") Hide_missing_default_space_errors = false; :(after "Test Runs") Hide_missing_default_space_errors = true; :(after "Running Main") Hide_missing_default_space_errors = false; :(code) bool contains_non_special_name(const recipe_ordinal r) { for (map<string, int>::iterator p = Name[r].begin(); p != Name[r].end(); ++p) { if (p->first.empty()) continue; if (p->first.find("stash_") == 0) continue; // generated by rewrite_stashes_to_text (cross-layer) if (!is_special_name(p->first)) return true; } return false; }