rumai 2.1.0 → 3.0.0

data/doc/intro.erb

@@ -10,8 +10,11 @@
 %|chapter "Introduction"
   %|project
     <%= $project %> is a [Ruby](<%= ruby_url %>) interface to the [wmii](<%= wmii_url %>) window manager.
+
     * It excels at dynamic arrangement of clients, columns, views, and tags.
-    * It provides an <%= xref 'shell', 'interactive shell' %> for live entertainment.
+
+    * It provides an <%= xref 'shell', 'interactive shell' %> for live entertainment and experimentation.
+
     * It contains a pure Ruby client for the [9P2000 protocol](<%= p9p_url %>) on which wmii's [IXP file-system interface](<%= wmii_ixp_url %>) is built.
 
   These features distinguish <%= $project %> from the competition:

data/doc/usage.erb

@@ -59,7 +59,7 @@
 
         <code>
         colors = %w[ red green blue black orange brown gray navy gold ]
-        colors.each {|c| system "xterm -bg #{c} -title #{c} -e read &" }
+        colors.each {|c| system "xterm -bg #{c} -title #{c} -e sh -c read &" }
         </code>
       }.gsub(/^\s+/, '')
 

data/lib/rumai.rb

@@ -8,8 +8,8 @@ gem 'inochi', '~> 1'
 require 'inochi'
 
 Inochi.init :Rumai,
-  :version => '2.1.0',
-  :release => '2009-05-09',
+  :version => '3.0.0',
+  :release => '2009-05-11',
   :website => 'http://snk.tuxfamily.org/lib/rumai/',
   :tagline => 'Ruby interface to the wmii window manager',
   :develop => {

data/lib/rumai/wm.rb

@@ -15,67 +15,11 @@ class Object #:nodoc:
 end
 
 module Rumai
-  # access to global WM state
-
-    ROOT = Node.new '/'
-
-    # Returns the root of IXP file system hierarchy.
-    def fs
-      ROOT
-    end
-
-    # Returns the current set of tags.
-    def tags
-      fs.tag.entries.sort - %w[sel]
-    end
-
-    # Returns the current set of views.
-    def views
-      tags.map! {|t| View.new t }
-    end
-
-    module ClientContainer
-      # see definition below!
-    end
-
-    include ClientContainer
-
-      # Returns the IDs of the current set of clients.
-      def client_ids
-        fs.client.entries - %w[sel]
-      end
-
-    # Returns the name of the currently focused tag.
-    def curr_tag
-      curr_view.id
-    end
-
-    # Returns the name of the next tag.
-    def next_tag
-      next_view.id
-    end
-
-    # Returns the name of the previous tag.
-    def prev_tag
-      prev_view.id
-    end
-
-
-  # multiple client grouping: allows you to group a set of clients
-  # together and perform operations on all of them simultaneously.
-
-    GROUPING_TAG = '@'
-
-    # Returns a list of all grouped clients in
-    # the currently focused view. If there are
-    # no grouped clients, then the currently
-    # focused client is returned in the list.
-    def grouping
-      list = curr_view.clients.select {|c| c.group? }
-      list << curr_client if list.empty? and curr_client.exist?
-      list
-    end
-
+  IXP_FS_ROOT         = Node.new('/')
+  FOCUSED_WIDGET_ID   = 'sel'.freeze
+  FLOATING_AREA_ID    = '~'.freeze
+  CLIENT_GROUPING_TAG = '@'.freeze
+  CLIENT_STICKY_TAG   = '/./'.freeze
 
   # abstraction of WM components
 
@@ -118,7 +62,7 @@ module Rumai
     ##
     # The basic building block of the WM hierarchy.
     #
-    # NOTE: Inheritors must have a 'current' class method.
+    # NOTE: Inheritors must define a 'curr' class method.
     # NOTE: Inheritors must override the 'focus' method.
     #
     module WidgetImpl #:nodoc:
@@ -147,11 +91,11 @@ module Rumai
       def initialize id, path_prefix
         super "#{path_prefix}/#{id}"
 
-        if id.to_s == 'sel' and ctl.exist?
+        if id == FOCUSED_WIDGET_ID and ctl.exist?
           @id = ctl.read.split.first
-          @path = File.join(File.dirname(@path), @id)
+          super "#{path_prefix}/#{@id}"
         else
-          @id = File.basename(@path)
+          @id = id.to_s
         end
       end
     end
@@ -168,7 +112,7 @@ module Rumai
       # Returns the currently focused client.
       #
       def self.curr
-        new :sel
+        new FOCUSED_WIDGET_ID
       end
 
       include Chain
@@ -187,7 +131,7 @@ module Rumai
         #
         def focus view = nil
           if exist? and not focus?
-            Array(view || self.views).each do |v|
+            (view ? [view] : self.views).each do |v|
               if a = self.area(v) and a.exist?
                 v.focus
                 a.focus
@@ -200,9 +144,7 @@ module Rumai
                 distance = (src - dst).abs
                 direction = src < dst ? :down : :up
 
-                distance.times do
-                  v.ctl.write "select #{direction}"
-                end
+                distance.times { v.move_focus direction }
 
                 break
               end
@@ -218,6 +160,8 @@ module Rumai
           view.ctl.write "send #{@id} #{dst}"
         end
 
+        alias move send
+
         ##
         # Swaps this client with the given destination within the given view.
         #
@@ -233,6 +177,77 @@ module Rumai
           ctl.write :kill
         end
 
+        ##
+        # Terminates this client forcefully.
+        #
+        def slay
+          ctl.write :slay
+        end
+
+        ##
+        # Maximizes this client to occupy the entire screen on the current view.
+        #
+        def fullscreen
+          ctl.write 'Fullscreen on'
+        end
+
+        ##
+        # Restores this client back to its original size on the current view.
+        #
+        def unfullscreen
+          ctl.write 'Fullscreen off'
+        end
+
+        ##
+        # Toggles the fullscreen status of this client on the current view.
+        #
+        def fullscreen!
+          ctl.write 'Fullscreen toggle'
+        end
+
+        ##
+        # Checks if this client is currently fullscreen on the current view.
+        #
+        def fullscreen?
+          #
+          # If the client's dimensions match those of the
+          # floating area, then we know it is fullscreen.
+          #
+          View.curr.manifest =~ /^# #{FLOATING_AREA_ID} (\d+) (\d+)\n.*^#{FLOATING_AREA_ID} #{@id} \d+ \d+ \1 \2 /m
+        end
+
+        ##
+        # Checks if this client is sticky (appears in all views).
+        #
+        def stick?
+          tags.include? CLIENT_STICKY_TAG
+        end
+
+        ##
+        # Makes this client sticky (appears in all views).
+        #
+        def stick
+          tag CLIENT_STICKY_TAG
+        end
+
+        ##
+        # Makes this client unsticky (does not appear in all views).
+        #
+        def unstick
+          untag CLIENT_STICKY_TAG
+        end
+
+        ##
+        # Toggles the stickyness of this client.
+        #
+        def stick!
+          if stick?
+            unstick
+          else
+            stick
+          end
+        end
+
       # WM hierarchy
 
         ##
@@ -304,7 +319,7 @@ module Rumai
         # Checks if this client is included in the current grouping.
         #
         def group?
-          tags.include? GROUPING_TAG
+          tags.include? CLIENT_GROUPING_TAG
         end
 
         ##
@@ -312,7 +327,7 @@ module Rumai
         #
         def group
           with_tags do
-            push GROUPING_TAG
+            push CLIENT_GROUPING_TAG
           end
         end
 
@@ -320,13 +335,13 @@ module Rumai
         # Removes this client to the current grouping.
         #
         def ungroup
-          untag GROUPING_TAG
+          untag CLIENT_GROUPING_TAG
         end
 
         ##
         # Toggles the presence of this client in the current grouping.
         #
-        def toggle_group
+        def group!
           if group?
             ungroup
           else
@@ -336,10 +351,13 @@ module Rumai
 
       private
 
+      ##
+      # Returns the wmii ID of the given area.
+      #
       def area_to_id area_or_id
         if area_or_id.respond_to? :id
           id = area_or_id.id
-          id == '~' ? :toggle : id
+          id == FLOATING_AREA_ID ? :toggle : id
         else
           area_or_id
         end
@@ -365,7 +383,7 @@ module Rumai
       end
 
       # multiple client grouping
-      %w[group ungroup toggle_group].each do |meth|
+      %w[group ungroup group!].each do |meth|
         define_method meth do
           clients.each do |c|
             c.__send__ meth
@@ -399,17 +417,19 @@ module Rumai
       ##
       # Checks if this area is the floating area.
       #
-      def float?
-        @id == '~'
+      def floating?
+        @id == FLOATING_AREA_ID
       end
 
       ##
       # Checks if this is a managed area (a column).
       #
       def column?
-        not float?
+        not floating?
       end
 
+      alias managed? column?
+
       include WidgetImpl
 
         ##
@@ -419,6 +439,13 @@ module Rumai
           View.curr.area_of_client Client.curr
         end
 
+        ##
+        # Returns the floating area in the given view.
+        #
+        def self.floating view = View.curr
+          new FLOATING_AREA_ID, view
+        end
+
       include Chain
 
         ##
@@ -487,11 +514,10 @@ module Rumai
 
           insert clients
 
-          # adjust the order of clients in this
-          # area to reflect the tail-wise insertion
+          # move inserted clients to bottom
           clients.each_with_index do |c, i|
             until c.id == self.client_ids[-i.succ]
-              c.swap :down
+              c.send :down
             end
           end
         end
@@ -520,11 +546,10 @@ module Rumai
 
           insert clients
 
-          # adjust the order of clients in this
-          # area to reflect the head-wise insertion
+          # move inserted clients to top
           clients.each_with_index do |c, i|
             until c.id == self.client_ids[i]
-              c.swap :up
+              c.send :up
             end
           end
         end
@@ -601,14 +626,14 @@ module Rumai
         # Returns the currently focused view.
         #
         def self.curr
-          new :sel
+          new FOCUSED_WIDGET_ID
         end
 
         ##
         # Focuses this view.
         #
         def focus
-          Rumai.fs.ctl.write "view #{@id}"
+          IXP_FS_ROOT.ctl.write "view #{@id}"
         end
 
       include Chain
@@ -643,12 +668,21 @@ module Rumai
         super view_id, '/tag'
       end
 
-      ##
-      # Returns the manifest of all areas and clients in this view.
-      #
-      def manifest
-        index.read || ''
-      end
+      # WM operations
+
+        ##
+        # Returns the manifest of all areas and clients in this view.
+        #
+        def manifest
+          index.read || ''
+        end
+
+        ##
+        # Moves the focus from the current client in the given direction.
+        #
+        def select direction
+          ctl.write "select #{direction}"
+        end
 
       # WM hierarchy
 
@@ -673,9 +707,7 @@ module Rumai
         # Returns the IDs of all areas in this view.
         #
         def area_ids
-          ids = manifest.scan(/^# (\d+)/).flatten
-          ids.unshift '~' # the floating area
-          ids
+          manifest.scan(/^# (\d+)/).flatten.unshift(FLOATING_AREA_ID)
         end
 
         ##
@@ -688,8 +720,8 @@ module Rumai
         ##
         # Returns the floating area of this view.
         #
-        def floater
-          areas.first
+        def floating_area
+          Area.floating self
         end
 
         ##
@@ -699,6 +731,8 @@ module Rumai
           areas[1..-1]
         end
 
+        alias managed_areas columns
+
         ##
         # Resiliently iterates through possibly destructive changes to
         # each column.  That is, if the given block creates new
@@ -719,6 +753,8 @@ module Rumai
           end
         end
 
+        alias each_managed_area each_column
+
       # visual arrangement of clients
 
         ##
@@ -731,17 +767,23 @@ module Rumai
         #
         def arrange_as_larswm
           maintain_focus do
-            float, main, *extra = areas
-
             # keep only one client in the primary column
+            main = Area.new(1, self)
             main.length = 1
+            main.layout = :default
+
+            # collapse remaining areas into secondary column
+            extra = columns[1..-1]
 
             if extra.length > 1
-              # collapse remaining areas into secondary column
               extra.reverse.each_cons(2) do |src, dst|
                 dst.concat src
               end
             end
+
+            if dock = extra.first
+              dock.layout = :default
+            end
           end
         end
 
@@ -823,7 +865,7 @@ module Rumai
       # before the given block was executed.
       #
       def maintain_focus
-        c = Rumai.curr_client
+        c = Client.curr
         yield
         c.focus
       end
@@ -836,47 +878,75 @@ module Rumai
       end
     end
 
-  # shortcuts for interactive WM manipulation (via IRB)
-
-    # provide easy access to container state information
-    [Client, Area, View].each {|c| c.extend ExportInstanceMethods }
+  # access to global WM state
 
-    def curr_client
-      Client.curr
+    ##
+    # Returns the root of IXP file system hierarchy.
+    #
+    def fs
+      IXP_FS_ROOT
     end
 
-    def next_client
-      curr_client.next
+    ##
+    # Returns the current set of tags.
+    #
+    def tags
+      ary = IXP_FS_ROOT.tag.entries.sort
+      ary.delete FOCUSED_WIDGET_ID
+      ary
     end
 
-    def prev_client
-      curr_client.prev
+    ##
+    # Returns the current set of views.
+    #
+    def views
+      tags.map! {|t| View.new t }
     end
 
-    def curr_area
-      Area.curr
-    end
+    include ClientContainer
 
-    def next_area
-      curr_area.next
-    end
+      ##
+      # Returns the IDs of the current set of clients.
+      #
+      def client_ids
+        ary = IXP_FS_ROOT.client.entries
+        ary.delete FOCUSED_WIDGET_ID
+        ary
+      end
 
-    def prev_area
-      curr_area.prev
-    end
+    def curr_client ; Client.curr       ; end
+    def next_client ; curr_client.next  ; end
+    def prev_client ; curr_client.prev  ; end
 
-    def curr_view
-      View.curr
-    end
+    def curr_area   ; Area.curr         ; end
+    def next_area   ; curr_area.next    ; end
+    def prev_area   ; curr_area.prev    ; end
 
-    def next_view
-      curr_view.next
-    end
+    def curr_view   ; View.curr         ; end
+    def next_view   ; curr_view.next    ; end
+    def prev_view   ; curr_view.prev    ; end
 
-    def prev_view
-      curr_view.prev
+    def curr_tag    ; curr_view.id      ; end
+    def next_tag    ; next_view.id      ; end
+    def prev_tag    ; prev_view.id      ; end
+
+    ##
+    # Returns a list of all grouped clients in
+    # the currently focused view. If there are
+    # no grouped clients, then the currently
+    # focused client is returned in the list.
+    #
+    def grouping
+      list = curr_view.clients.select {|c| c.group? }
+      list << curr_client if list.empty? and curr_client.exist?
+      list
     end
 
+  # shortcuts for interactive WM manipulation (via IRB)
+
+    # provide easy access to container state information
+    [Client, Area, View].each {|c| c.extend ExportInstanceMethods }
+
     def focus_client id
       Client.focus id
     end
@@ -890,5 +960,5 @@ module Rumai
     end
 
     # provide easy access to this module's instance methods
-    module_function(*instance_methods)
+    module_function(*instance_methods(false))
 end