uh-wm 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 304d345d72ebfed7045a3ac0cd0bdb58fe8fbd31
-  data.tar.gz: cb5379acb77ac283dbb0f28b27e4e93fe9e13b5f
+  metadata.gz: 6e40ae2e6f815683ba49a0cf70e0a2832b15198a
+  data.tar.gz: 2f2c5eabef44d6acfa2dbb4901d81fea647b121f
 SHA512:
-  metadata.gz: fdc8985073e35f6d54f1d627e0233ab0ebdad4cfe25ce0baf8d7b1847083f942fc91fbf9e36ee4bac812f489df4bc190660d947bcdcf8e6f5454380376363897
-  data.tar.gz: a69f26be2e7bfd9781222840f0bec1508d962f7fc192e2b5908718dd496f7a996827cee6f6abc92b2639e173766b7a10164772cd8d6f221ba2966cc79a52bc09
+  metadata.gz: d423c12bb61f6fce43f7c2fb28b8d3a823197abb719dbe02380706dfcf4755b7e190b0fe8e8d72a683e8e883e9659272eae7d43244abe1ab3b0ef208af9ba19a
+  data.tar.gz: 0a21755650d31e190d9df030866a2822d9fe347dc4ed7f94b90834f5312331135fb26151ab3b4a5df9014fd1e8d7debee1cd6c468392734e174aa025c877350a

data/README.md

@@ -22,11 +22,11 @@ specific messages, so it's easy to write your own layout.
   * configuration with a run control file;
   * key bindings with user defined code as callback;
   * configurable modifier key;
-  * support user-defined layout strategies;
+  * user-defined layout strategies;
   * external program execution;
   * no re-parenting (therefore, no window decoration either);
   * no grabbing of the modifier key alone;
-  * no mouse handling;
+  * no mouse event handling;
   * no EWMH support;
   * very limited ICCCM support.
 
@@ -69,12 +69,12 @@ simple example is provided below, more details are available in the
 [`RunControl` class documentation][run_control_doc].
 
 ``` ruby
-DMENU     = 'dmenu_run -b'.freeze
-VT        = 'urxvt'.freeze
+DMENU     = 'dmenu_run -b'
+VT        = 'urxvt'
 BROWSERS  = %w[
   arora chromium firebird firefox galeon iceweasel konqueror pentadactyl
   phoenix vimperator
-].freeze
+]
 
 
 modifier :mod1                # This key is added to the modifier mask for *all*
@@ -124,6 +124,217 @@ available in the [`ActionsHandler` class documentation][actions_doc]
 [actions_doc]: http://www.rubydoc.info/gems/uh-wm/Uh/WM/ActionsHandler
 
 
+Extensive configuration example
+-------------------------------
+
+``` ruby
+COLORS    = {
+  bg:   'rgb:0c/0c/0c'.freeze,
+  fg:   'rgb:d0/d0/d0'.freeze,
+  sel:  'rgb:d7/00/5f'.freeze,
+  hi:   'rgb:82/00/3a'.freeze
+}.freeze
+DMENU     = ('dmenu_run -b -nb %s -nf %s -sb %s -sf %s' %
+              COLORS.values_at(:bg, :fg, :sel, :fg)).freeze
+VT        = 'urxvt'.freeze
+VT_SHELL  = "#{VT} -e zsh -i -c".freeze
+LOCKER    = 'xautolock -locknow &'.freeze
+BROWSERS  = %w[
+  arora chrome chromium firebird firefox galeon iceweasel konqueror pentadactyl
+  phoenix vimperator
+].freeze
+DATETIME  = -> { Time.new.strftime('%FT%T %a') }.freeze
+
+
+worker    :kqueue, timeout: 1
+modifier  :mod1
+layout    colors: COLORS, bar_status: DATETIME
+
+key(:Q)           { quit }
+key(:z)           { execute LOCKER }
+
+key(:enter)       { execute VT }
+key(:p)           { execute DMENU }
+
+key(:c)           { layout_screen_sel :succ }
+key(:C)           { layout_screen_set :succ }
+(0..9).each       { |e| key(e)          { layout_view_sel e } }
+(0..9).each       { |e| key(e, :shift)  { layout_view_set e } }
+key(:w)           { layout_view_sel 'www' }
+key(:W)           { layout_view_set 'www' }
+key(:h)           { layout_column_sel :pred }
+key(:s)           { layout_column_sel :succ }
+key(:n)           { layout_client_sel :pred }
+key(:t)           { layout_client_sel :succ }
+key(:d)           { layout_column_mode_toggle }
+key(:N)           { layout_client_swap :pred }
+key(:T)           { layout_client_swap :succ }
+key(:H)           { layout_client_column_set :pred }
+key(:S)           { layout_client_column_set :succ }
+
+key(:tab)         { layout_history_view_pred }
+
+key(:e)           { kill_current }
+
+key(:apostrophe)  { execute 'mocp --toggle-pause' }
+key(:comma)       { execute 'mixer vol -3' }
+key(:period)      { execute 'mixer vol +3' }
+key(:Apostrophe)  { execute 'mocp --seek 30' }
+key(:Comma)       { execute 'mocp --previous' }
+key(:Period)      { execute 'mocp --next' }
+
+key(:l)           { log_layout }
+key(:L)           { log_client }
+key(:backspace)   { log_separator }
+
+if ENV['DISPLAY'] == ':42'
+  key(:q)         { quit }
+  key(:f)         { execute VT }
+  key(:F)         { execute 'firefox -P test' }
+end
+
+rule BROWSERS do
+  layout_view_set 'www'
+  next unless layout.current_view.columns.size == 1
+  next unless layout.current_view.clients.size >= 2
+  next unless layout.current_view.clients.any? { |c| c.wclass =~ /\A#{VT}/i }
+  layout_client_column_set :succ
+end
+
+rule VT do
+  next unless layout.current_view.columns.size == 1
+  next unless layout.current_view.clients.size >= 2
+  if layout.current_view.clients.all? { |c| c.wclass =~ /\A#{VT}/i }
+    layout_client_column_set :succ
+  elsif layout.current_view.clients.any? { |c| c.wclass =~ /\Afirefox/i }
+    layout_client_column_set :pred
+  end
+end
+
+rule 'xephyr' do
+  if layout.current_view.clients.select { |c| c.wclass =~ /\Axephyr/i }.size > 1
+    layout_screen_set :succ
+    layout_view_set 7
+    layout_view_sel 7
+    layout_screen_sel :pred
+    layout_screen_set :succ
+    layout_column_mode_toggle
+  else
+    layout_client_column_set :succ
+  end
+end
+
+launch do
+  layout_screen_sel :succ
+
+  layout_view_sel '2'
+  execute! "#{VT_SHELL} 'tail -F ~/.uhwm.log'"
+
+  layout_view_sel '1'
+  execute! "#{VT_SHELL} mutt"
+  layout_column_mode_toggle
+  execute! "#{VT_SHELL} 'mtr -n foo.example; exec zsh'"
+  execute! "#{VT_SHELL} 'mtr -n bar.example; exec zsh'"
+
+  execute! "#{VT_SHELL} 'ssh -t foo.example zsh -i -c \\\"tmux attach -t irc\\\"; exec zsh'"
+  layout_client_column_set :succ
+
+  execute! "#{VT_SHELL} 'ssh -t foo.example tmux attach -t log; exec zsh'"
+  layout_client_column_set :succ
+  layout_column_mode_toggle
+  execute! "#{VT_SHELL} 'ssh -t bar.example tmux attach -t log; exec zsh'"
+  execute! "#{VT_SHELL} 'tmux attach -t log; exec zsh'"
+  layout_column_sel :pred
+
+  layout_screen_sel :pred
+
+  execute! "#{VT_SHELL} mutt"
+  execute! "#{VT_SHELL} 'vim ~/TODO; exec zsh'"
+  layout_client_column_set :succ
+  execute! VT
+  layout_client_column_set :succ
+
+  layout_view_sel '2'
+  execute! "#{VT_SHELL} 'cd ~/src/.../uh-wm; exec zsh'"
+  execute! "#{VT_SHELL} 'cd ~/src/.../uh-wm; exec zsh'"
+  layout_client_column_set :pred
+
+  layout_view_sel '4'
+  execute! "#{VT_SHELL} mocp; exec zsh"
+  execute! VT
+  layout_client_column_set :succ
+
+  layout_view_sel '8'
+  execute! "#{VT_SHELL} 'top -o res; exec zsh'"
+  execute! VT
+  layout_client_column_set :succ
+
+  layout_view_sel '1'
+end if ENV['DISPLAY'] == ':0'
+
+launch do
+  layout_view_sel '2'
+  execute! "#{VT_SHELL} 'tail -F ~/.uhwm.log'"
+
+  layout_view_sel '1'
+  execute! "#{VT_SHELL} 'echo hello\!; exec zsh'"
+  execute! VT
+  layout_client_column_set :succ
+end if ENV['DISPLAY'] == ':42'
+```
+
+
+BUGS
+----
+
+* Signal handling is broken under certain undocumented conditions.
+
+* Unicode is not supported everywhere (the `uh` ruby gem does not yet
+  support unicode text drawing).
+
+* Column width in default layout is hard coded.
+
+
+FAQ
+---
+
+#### uhwm is stealing focus, how can I disable it?
+
+  You can't (yet). The default layout will be modified to accept an
+`autofocus: false` option in a future release.
+
+#### What are the default key bindings?
+
+  Juste one: `mod+shift+q` is bound to the `quit` action.
+
+#### How can I implement my own layout?
+
+  A layout is a simple ruby object responding to a set of messages:
+`register`, `current_client`, `suggest_geo`, `<<`, `remove`, `update`
+and `expose`. No documentation is available yet, so read the source
+code or the cucumber scenarios in `features/layout/protocol.feature`.
+
+#### Can I change the default behavior ignoring current view selection?
+
+  Yes, just test for this condition in the key binding code. For
+example the following code will select the last historized view (if
+you are on view `"1"`, and select view `"2"` twice, the view `"1"` is
+selected.
+
+``` ruby
+# Replace the "simple" view selection key binding...
+key(:m) { layout_view_sel 'my_view' }
+# ...with this:
+key :m do
+  if layout.current_view.id == 'my_view'
+    layout_view_sel layout.history.last_view.id
+  else
+    layout_view_sel 'my_view'
+  end
+end
+```
+
+
 
 [badge-version-img]:  https://img.shields.io/gem/v/uh-wm.svg?style=flat-square
 [badge-version-uri]:  https://rubygems.org/gems/uh-wm

data/lib/uh/wm/actions_handler.rb

@@ -75,7 +75,7 @@ module Uh
           meth = layout_method m
           log "#{layout.class.name}##{meth} #{args.inspect}"
           begin
-            layout.send(meth, *args)
+            layout.send meth, *args
           rescue NoMethodError
             log_error "Layout does not implement `#{meth}'"
           end

data/lib/uh/wm/version.rb

@@ -1,5 +1,5 @@
 module Uh
   module WM
-    VERSION = '0.0.10'
+    VERSION = '0.0.11'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uh-wm
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Thibault Jouan