comparison dwm.h @ 460:ab4b08d49d24

some more simplifications of intro comment in dwm.h, this should suffice for comments in dwm
author Anselm R. Garbe <arg@10kloc.org>
date Tue, 12 Sep 2006 09:50:06 +0200
parents 3c3f429dca99
children 210a99f18657
comparison
equal deleted inserted replaced
459:3c3f429dca99 460:ab4b08d49d24
3 * See LICENSE file for license details. 3 * See LICENSE file for license details.
4 * 4 *
5 * dynamic window manager is designed like any other X client as well. It is 5 * dynamic window manager is designed like any other X client as well. It is
6 * driven through handling X events. In contrast to other X clients, a window 6 * driven through handling X events. In contrast to other X clients, a window
7 * manager like dwm selects for SubstructureRedirectMask on the root window, to 7 * manager like dwm selects for SubstructureRedirectMask on the root window, to
8 * receive events about child window appearance and disappearance. Only one X 8 * receive events about window appearance and disappearance. Only one X
9 * connection at a time is allowed to select for this event mask. 9 * connection at a time is allowed to select for this event mask.
10 * 10 *
11 * Calls to fetch an X event from the event queue of the X connection are 11 * Calls to fetch an X event from the X event queue connection are blocking.
12 * blocking. Due the fact, that dwm reads status text from standard input, a 12 * Due reading status text from standard input, a select-driven main loop has
13 * select-driven main loop has been implemented which selects for reads on the 13 * been implemented which selects for reads on the X connection and
14 * X connection and STDIN_FILENO to handle all data smoothly and without 14 * STDIN_FILENO to handle all data smoothly and without busy-loop quirks. The
15 * busy-loop quirks. The event handlers of dwm are organized in an array which 15 * event handlers of dwm are organized in an array which is accessed whenever a
16 * is accessed whenever a new event has been fetched. This allows event 16 * new event has been fetched. This allows event dispatching in O(1) time.
17 * dispatching in O(1) time.
18 * 17 *
19 * Each child window of the root window is called a client in window manager 18 * Each child of the root window is called a client, except windows which have
20 * terminology, except windows which have set the override_redirect flag. 19 * set the override_redirect flag. Clients are organized in a global
21 * Clients are organized in a global doubly-linked client list, the focus 20 * doubly-linked client list, the focus history is remembered through a global
22 * history is remembered through a global stack list. Each client contains an 21 * stack list. Each client contains an array of Bools of the same size as the
23 * array of Bools of the same size as the global tags array to indicate the 22 * global tags array to indicate the tags of a client. For each client dwm
24 * tags of a client. There are no other data structures to organize the clients 23 * creates a small title window which is resized whenever the WM_NAME or
25 * in tag lists. All clients which have at least one tag enabled of the current 24 * _NET_WM_NAME properties are updated or the client is resized.
26 * tags viewed, will be visible on the screen, all other clients are banned to
27 * the x-location x + 2 * screen width. This avoids having additional layers
28 * of workspace handling.
29 * 25 *
30 * For each client dwm creates a small title window which is resized whenever
31 * the WM_NAME or _NET_WM_NAME properties are updated or the client is resized.
32 * Keys and tagging rules are organized as arrays and defined in the config.h 26 * Keys and tagging rules are organized as arrays and defined in the config.h
33 * file. These arrays are kept static in event.o and tag.o respectively, 27 * file. These arrays are kept static in event.o and tag.o respectively,
34 * because no other part of dwm needs access to them. The current mode is 28 * because no other part of dwm needs access to them. The current mode is
35 * represented by the arrange function pointer which wether points to dofloat 29 * represented by the arrange function pointer which wether points to dofloat
36 * or dotile. 30 * or dotile.