dwm-meillo

diff dwm.h @ 457:e97ad13f04dc

added a general comment to dwm.h how dwm is basically organized
author Anselm R. Garbe <arg@10kloc.org>
date Tue, 12 Sep 2006 08:14:22 +0200
parents d11d739ad9df
children 3c3f429dca99
line diff
     1.1 --- a/dwm.h	Mon Sep 11 17:31:21 2006 +0200
     1.2 +++ b/dwm.h	Tue Sep 12 08:14:22 2006 +0200
     1.3 @@ -1,6 +1,46 @@
     1.4  /*
     1.5   * (C)opyright MMVI Anselm R. Garbe <garbeam at gmail dot com>
     1.6   * See LICENSE file for license details.
     1.7 + *
     1.8 + * dynamic window manager is designed like any other X client as well. It is
     1.9 + * driven through handling X events. In contrast to other X clients, a window
    1.10 + * manager like dwm selects for SubstructureRedirectMask on the root window, to
    1.11 + * receive events about child window appearance and disappearance.  Only one X
    1.12 + * connection at a time is allowed to select for this event mask by any X
    1.13 + * server, thus only one window manager instance can be executed at a time.
    1.14 + * Any attempt to select for SubstructureRedirectMask by any connection after
    1.15 + * another connection already selected for those events, will result in an
    1.16 + * error generated by the server. Such errors are reported through calling the
    1.17 + * current X error handler.
    1.18 + *
    1.19 + * Calls to pop an X event from the event queue of the X connection are
    1.20 + * blocking.  Due the fact, that dwm reads status text from standard input, a
    1.21 + * select-driven main loop has been implemented which selects for reads on the
    1.22 + * X connection and STDIN_FILENO to handle all data smoothly and without
    1.23 + * busy-loop quirks..  The event handlers of dwm are organized in an array
    1.24 + * which is accessed whenever a new event has been popped. This allows event
    1.25 + * dispatching in O(1) time.
    1.26 + *
    1.27 + * Each child window of the root window is called a client in window manager
    1.28 + * terminology, except windows which have set the override_redirect flag.
    1.29 + * Clients are organized in a global doubly-linked client list, the focus
    1.30 + * history is remembered through a global stack list. Each client contains an
    1.31 + * array of Bools of the same size as the global tags array to indicate the
    1.32 + * tags of a client. There are no other data structures to organize the clients
    1.33 + * in tag lists, because a single global list is most simple. All clients which
    1.34 + * have at least one tag enabled of the current tags viewed, will be visible on
    1.35 + * the screen, all other clients are banned to the x-location 2 * screen width.
    1.36 + * This avoids having additional layers of workspace handling.
    1.37 + *
    1.38 + * For each client dwm creates a small title window which is resized whenever
    1.39 + * the WM_NAME or _NET_WM_NAME properties are updated.
    1.40 + *
    1.41 + * Keys and tagging rules are organized as arrays as well and defined in the
    1.42 + * config.h file. These arrays are kept static in event.o and tag.o
    1.43 + * respectively, because no other part of dwm needs access to them.
    1.44 + *
    1.45 + * The current mode is represented by the arrange function pointer which wether
    1.46 + * points to dofloat or dotile. 
    1.47   */
    1.48  
    1.49  #include "config.h"