Changeset 186

Timestamp:

03/20/2006 12:16:17 PM (3 years ago)

Author:

petli

Message:

New mixin: DynamicColorBorderClient?. border.py was restructured for this, but the old BorderClient? should still work as it used to.

Location:

trunk

Files:

• NEWS (modified) (1 diff)
• examples/petliwm.py (modified) (2 diffs)
• plwm/border.py (modified) (4 diffs)

trunk/NEWS

@@ -8 +8 @@
 wmevents.ClientIconified and wmevents.ClientDeiconified is sent,
 respectively. 
+
+** New border mixin: DynamicColorBorderClient
+
+This mixin chooses the border color dynamically based on the window
+title.  Will only work well on non-palette visuals, on PseudoColor
+displays and the like it will soon have gobbled all colors.
 
 

trunk/examples/petliwm.py

@@ -173 +173 @@
 class MyClient(wmanager.Client,
                outline.XorOutlineClient,
-               border.BorderClient,
+               border.DynamicColorBorderClient,
                modestatus.ModeFocusedTitleClient,
                misc.InitialKeepOnScreenClient,
@@ -189 +189 @@
     border_color_name = "grey20"
     border_focuscolor_name = "grey60"
+
+    border_dynamic_saturation = 0.3
+    border_dynamic_brightness = 0.7
+
+    border_dynamic_focus_saturation = 1.0
+    border_dynamic_focus_brightness = 0.7
 
     traceim_filters = [

trunk/plwm/border.py

@@ -1 @@
-# $Id: border.py,v 1.7 2002-03-04 13:35:59 petli Exp $
+# $Id: border.py,v 1.8 2006-03-20 18:16:17 petli Exp $
 #
 # border.py -- change border color on focused client
@@ -19 +19 @@
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-import wmevents, cfilter
-
-class BorderClient:
+from Xlib import X, Xatom
+import wmanager, wmevents, cfilter
+
+class BorderClientBase:
     no_border_clients = cfilter.false
     border_default_width = 3
@@ -29 +30 @@
     
     def __client_init__(self):
+        self.border_color = None
+        self.border_focuscolor = None
+
         if self.no_border_clients(self):
-            self.border_color = None
-            self.border_focuscolor = None
             self.setborderwidth(0)
 
         else:
-            resname = self.wm.rdb_get('.border.color', '.Border.Color', '#000000')
-            if self.border_color_name is not None:
-                self.border_color = self.screen.get_color(
-                    self.border_color_name, default = resname)
-            else:
-                self.border_color = self.screen.get_color(resname)
-
-            resname = self.wm.rdb_get('.border.focus.color',
-                                      '.Border.Focus.Color', '#000000')
-            if self.border_focuscolor_name is not None:
-                self.border_focuscolor = self.screen.get_color(
-                    self.border_focuscolor_name, default = resname)
-            else:
-                self.border_focuscolor = self.screen.get_color(resname)
-
             self.setborderwidth(self.border_default_width)
-            self.window.change_attributes(border_pixel = self.border_color) 
 
             self.dispatch.add_handler(wmevents.ClientFocusIn, self.border_get_focus)
             self.dispatch.add_handler(wmevents.ClientFocusOut, self.border_lose_focus)
-   
+
+            self.border_set_colors()
+            self.border_update()
+
+    def border_update(self):
+        """Update the border color.  Call this after chaning
+        border_color or border_focuscolor
+        """
+        if self.focused:
+            if self.border_focuscolor is not None:
+                self.window.change_attributes(border_pixel = self.border_focuscolor)
+        else:
+            if self.border_color is not None:
+                self.window.change_attributes(border_pixel = self.border_color) 
+
+    def border_set_colors(self):
+        """Override this to set border_color and border_focuscolor.
+        This is called during client initialization to get the initial colors.
+        """
+        raise NotImplementedError('%s.border_set_colors()' % self.__class__)
+            
     def border_get_focus(self, event):
         if self.border_focuscolor is not None:
@@ -64 +70 @@
             self.window.change_attributes(border_pixel = self.border_color)
 
+
+class BorderClient(BorderClientBase):
+    """Set border color to one or another if the client is focused or not."""
+    border_color_name = None
+    border_focuscolor_name = None
+
+    def border_set_colors(self):
+        resname = self.wm.rdb_get('.border.color', '.Border.Color', '#000000')
+        if self.border_color_name is not None:
+            self.border_color = self.screen.get_color(
+                self.border_color_name, default = resname)
+        else:
+            self.border_color = self.screen.get_color(resname)
+
+        resname = self.wm.rdb_get('.border.focus.color',
+                                  '.Border.Focus.Color', '#000000')
+        if self.border_focuscolor_name is not None:
+            self.border_focuscolor = self.screen.get_color(
+                self.border_focuscolor_name, default = resname)
+        else:
+            self.border_focuscolor = self.screen.get_color(resname)
+
+
+class DynamicColorBorderClient(BorderClientBase):
+
+    """Change the color of the border based on some client property,
+    by default the window title.
+
+    Obviously this class shouldn't be used with palette-based visuals.
+
+
+    Subclass and override border_dynamic_install_handler() and
+    border_dynamic_get_hue() to change this behaviour.
+
+    The hue will be the same for a client (as long as the title or
+    whatever doesn't change) but the saturation and brightness is
+    changed depending on the client is focused or not.  This is
+    controlled with four attributes, in the range [0.0, 1.0]:
+
+    Non-focused:
+      border_dynamic_saturation 
+      border_dynamic_brightness
+
+    Focused:
+      border_dynamic_focus_saturation 
+      border_dynamic_focus_brightness
+
+
+    However, experimentation shows that HSV isn't very good, as
+    confirmed by
+    http://www.poynton.com/notes/colour_and_gamma/ColorFAQ.html#RTFToC36
+
+    Varying the brightness changes the perceived color, only changing
+    the saturation works reasonably well.  This might be a problem
+    with the colorsys module, too.
+
+    If anyone manages to understand it, maybe the CIE XYZ model should
+    be tried instead.
+    """
+
+    border_dynamic_saturation = 0.3
+    border_dynamic_brightness = 0.7
+
+    border_dynamic_focus_saturation = 1.0
+    border_dynamic_focus_brightness = 0.7
+
+    def __client_init__(self):
+        # FIXME: check visual, and scream if it isn't suitable for
+        # this kind of color-grabbing.  Even better: fall back on
+        # default colors.
+        
+        BorderClientBase.__client_init__(self)
+        self.border_dynamic_install_handler()
+
+    #
+    # Override these methods to change color property
+    #
+    
+    def border_dynamic_install_handler(self):
+        self.dispatch.add_handler(X.PropertyNotify, self.border_dynamic_property_notify)
+
+    def border_dynamic_get_hue(self):
+        """Return the hue for this client, in the range [0.0, 1.0]"""
+
+        # We can't really know the range of hash, but there's probably
+        # at least 24 bits.  Xor them into eight bits and use that for hue
+
+        th = hash(self.get_title())
+
+        h = th & 0xff
+        h ^= (th >> 8) & 0xff
+        h ^= (th >> 16) & 0xff
+        
+        return float(h) / 0xff
+
+    #
+    # Internalish methods
+    #
+
+    def border_dynamic_property_notify(self, event):
+        if event.atom == Xatom.WM_NAME:
+            self.border_set_colors()
+            self.border_update()
+
+    def border_set_colors(self):
+        hue = self.border_dynamic_get_hue()
+
+        self.border_color = self.border_dynamic_get_color_hsv(
+            hue, self.border_dynamic_saturation,
+            self.border_dynamic_brightness)
+
+        self.border_focuscolor = self.border_dynamic_get_color_hsv(
+            hue, self.border_dynamic_focus_saturation,
+            self.border_dynamic_focus_brightness)
+
+        
+    def border_dynamic_get_color_hsv(self, hue, saturation, brightness):
+        import colorsys
+        r, g, b = colorsys.hsv_to_rgb(hue, saturation, brightness)
+        return self.screen.get_color((r * 65535, g * 65535, b * 65535))
+
+    #
+    # I tested using chroma instead of HSV.  Didn't really work that
+    # much better, but I keep the code here if anyone want's to experiment with it
+    #
+    
+    border_dynamic_luminance = 0.3
+    border_dynamic_focus_luminance = 0.7
+
+    def border_dynamic_get_chroma(self):
+        """Return the Cr, Cb for this client, in the range [0, 255]"""
+
+        h = hash(self.get_title())
+        return h & 0xff, (h >> 8) & 0xff
+
+    def border_set_colors_chroma(self):
+        cr, cb = self.border_dynamic_get_chroma()
+
+        self.border_color = self.border_dynamic_get_color(
+            self.border_dynamic_luminance, cr, cb)
+        self.border_focuscolor = self.border_dynamic_get_color(
+            self.border_dynamic_focus_luminance, cr, cb)
+
+    def border_dynamic_get_chroma_color(self, y, cb, cr):
+        # See http://www.poynton.com/notes/colour_and_gamma/ColorFAQ.html#RTFToC30
+
+        # scale [0.0, 1.0] to [16, 235] => [0, 219]
+        y *= 219
+
+        # get cr and cb in range [-112, +112]
+        cb = max(min(cb - 128, 112), -112)
+        cr = max(min(cr - 128, 112), -112)
+
+        # Do the matrix multiplication, but skip the divide-by-256 as
+        # we actually want the range [0, 65535]
+        
+        r = (298.082 * y + 408.583 * cr)
+        g = (298.082 * y - 100.291 * cb - 208.120 * cr)
+        b = (298.082 * y + 516.411 * cb)
+
+        # clamp into range
+        r = min(max(r, 0), 65535)
+        g = min(max(g, 0), 65535)
+        b = min(max(b, 0), 65535)
+
+        # and return the color
+        return self.screen.get_color((r, g, b))