rumai 1.0.0 → 2.0.0

data/lib/rumai/ixp/transport.rb

@@ -14,15 +14,21 @@ module Rumai
       attr_reader :msize
 
       def initialize aStream
-        @stream    = aStream
-        @sendLock  = Mutex.new
-        @recvLock  = Mutex.new
-
-        @responses = {} # tag => message
-        @tagPool   = RangedPool.new(0...BYTE2_MASK)
+        @stream   = aStream
+        @sendLock = Mutex.new
+        @recvBays = Hash.new {|h,k| h[k] = Queue.new } # tag => Queue(message)
+
+        # background thread which continuously receives
+        # and dispatches messages from the 9P2000 server
+        Thread.new do
+          while true
+            msg = Fcall.from_9p @stream
+            @recvBays[msg.tag] << msg
+          end
+        end.priority = -1
 
-        @fidPool   = RangedPool.new(0...BYTE4_MASK)
-        @msize     = Tversion::MSIZE
+        @tagPool = RangedPool.new(0...BYTE2_MASK)
+        @fidPool = RangedPool.new(0...BYTE4_MASK)
 
         # establish connection with 9P2000 server
         req = Tversion.new(
@@ -48,7 +54,8 @@ module Rumai
 
       # A finite, thread-safe pool of range members.
       class RangedPool
-        # how many new members should be added to the pool when the pool is empty?
+        # how many new members should be added
+        # to the pool when the pool is empty?
         FILL_RATE = 10
 
         def initialize aRange
@@ -56,35 +63,36 @@ module Rumai
           @lim = aRange.last
           @lim = @lim.succ unless aRange.exclude_end?
 
-          @pool = Array.new
-          @lock = Mutex.new
+          @pool = Queue.new
         end
 
         # Returns an unoccupied range member from the pool.
         def obtain
-          until member = @lock.synchronize { @pool.shift }
-            # the pool is empty, so fill it
-            @lock.synchronize do
-              FILL_RATE.times do
-                if @pos != @lim
-                  @pool.push @pos
-                  @pos = @pos.succ
-                else
-                  break
-                end
+          begin
+            @pool.deq true
+
+          rescue ThreadError
+            # pool is empty, so fill it
+            FILL_RATE.times do
+              if @pos != @lim
+                @pool << @pos
+                @pos = @pos.succ
+              else
+                # range is exhausted, so give other threads
+                # a chance to fill the pool before retrying
+                Thread.pass
+                break
               end
-            end or Thread.pass # range is exhausted, so wait for other threads to fill the pool
-          end
+            end
 
-          member
+            retry
+          end
         end
 
         # Marks the given member as being unoccupied so
         # that it may be occupied again in the future.
         def release aMember
-          @lock.synchronize do
-            @pool.push aMember
-          end
+          @pool << aMember
         end
       end
 
@@ -94,32 +102,24 @@ module Rumai
       # worrying about the details of tag collisions and thread safety.
       #
       def talk aRequest
-        # send the messsage
-        ticket = aRequest.tag = @tagPool.obtain
+        # send the request
+        tag = @tagPool.obtain
+        bay = @recvBays[tag]
 
+        aRequest.tag = tag
+        output = aRequest.to_9p
         @sendLock.synchronize do
-          @stream << aRequest.to_9p
+          @stream << output
         end
 
         # receive the response
-        while true
-          # check for *my* response in the bucket
-          if response = @recvLock.synchronize { @responses.delete ticket }
-            @tagPool.release ticket
-
-            if response.is_a? Rerror
-              raise Error, "#{response.ename.inspect} in response to #{aRequest.inspect}"
-            else
-              return response
-            end
+        response = bay.shift
+        @tagPool.release tag
 
-          # put the next response into the bucket
-          else
-            @recvLock.synchronize do
-              response = Fcall.from_9p @stream
-              @responses[response.tag] = response
-            end
-          end
+        if response.is_a? Rerror
+          raise Error, "#{response.ename.inspect} in response to #{aRequest.inspect}"
+        else
+          return response
         end
       end
 
@@ -170,8 +170,15 @@ module Rumai
       end
 
       # Encapsulates I/O access over a file handle (fid).
+      # NOTE that this class is NOT thread-safe.
       class FidStream
-        attr_reader :fid
+        attr_reader :fid, :stat
+
+        attr_reader :eof
+        alias eof? eof
+
+        attr_accessor :pos
+        alias tell pos
 
         def initialize aAgent, aPathFid, aMessageSize
           @agent  = aAgent
@@ -179,6 +186,13 @@ module Rumai
           @msize  = aMessageSize
           @stat   = @agent.stat_fid @fid
           @closed = false
+          rewind
+        end
+
+        # Rewinds the stream to the beginning.
+        def rewind
+          @pos = 0
+          @eof = false
         end
 
         # Closes this stream.
@@ -186,25 +200,41 @@ module Rumai
           unless @closed
             @agent.clunk @fid
             @closed = true
+            @eof = true
           end
         end
 
-        # Returns the entire content of this stream.  If this
-        # stream corresponds to a directory, then an Array of Stat
-        # (one for each file in the directory) will be returned.
-        def read
+        # Returns true if this stream is closed.
+        def closed?
+          @closed
+        end
+
+        # Reads some data from this stream at the current position.
+        #
+        # aPartial:: When false, the entire content of this stream
+        #            is read and returned.  When true, the maximum
+        #            amount of content that can fit inside a
+        #            single 9P2000 message is read and returned.
+        #
+        # If this stream corresponds to a directory, then an Array of
+        # Stat (one for each file in the directory) will be returned.
+        #
+        def read aPartial = false
           raise 'cannot read from a closed stream' if @closed
 
           content = ''
-          offset = 0
-
           begin
-            chunk = read_partial(offset)
-            content << chunk
+            req = Tread.new(
+              :fid    => @fid,
+              :offset => @pos,
+              :count  => @msize
+            )
+            rsp = @agent.talk(req)
 
-            count = chunk.length
-            offset = (offset + count) % BYTE8_LIMIT
-          end until count < @msize
+            content << rsp.data
+            count = rsp.count
+            @pos += count
+          end until @eof = count.zero? or aPartial
 
           # the content of a directory is a sequence
           # of Stat for all files in that directory
@@ -220,43 +250,26 @@ module Rumai
           content
         end
 
-        # Returns the maximum amount of content that can fit in
-        # one 9P2000 message, starting from the given offset.
-        #
-        # The end of file is reached when the returned
-        # content string is empty (has zero length).
-        def read_partial aOffset = 0
-          raise 'cannot read from a closed stream' if @closed
-
-          req = Tread.new(
-            :fid    => @fid,
-            :offset => aOffset,
-            :count  => @msize
-          )
-          rsp = @agent.talk(req)
-          rsp.data
-        end
-
-        # Writes the given content to the beginning of this stream.
+        # Writes the given content at the current position in this stream.
         def write aContent
           raise 'closed streams cannot be written to' if @closed
           raise 'directories cannot be written to' if @stat.directory?
 
-          offset = 0
-          content = aContent.to_s
+          data = aContent.to_s
+          limit = data.length + @pos
 
-          while offset < content.length
-            chunk = content[offset, @msize]
+          while @pos < limit
+            chunk = data[@pos, @msize]
 
             req = Twrite.new(
               :fid    => @fid,
-              :offset => offset,
+              :offset => @pos,
               :count  => chunk.length,
               :data   => chunk
             )
             rsp = @agent.talk(req)
 
-            offset += rsp.count
+            @pos += rsp.count
           end
         end
 
@@ -264,9 +277,9 @@ module Rumai
       end
 
       # Returns the content of the file/directory at the given path.
-      def read aPath
+      def read aPath, *aArgs
         open aPath do |f|
-          f.read
+          f.read(*aArgs)
         end
       end
 

data/lib/rumai/nfo.rb

@@ -6,8 +6,8 @@
 module Rumai
   NFO = {
     :name    => 'Rumai',
-    :version => '1.0.0',
-    :release => '2008-01-26',
+    :version => '2.0.0',
+    :release => '2008-02-04',
     :website => 'http://rumai.rubyforge.org',
     :home    => File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
   }

data/lib/rumai/wm.rb

@@ -143,7 +143,7 @@ module Rumai
       super "#{aPathPrefix}/#{aId}"
 
       if aId.to_s == 'sel' and ctl.exist?
-        @id = ctl.read
+        @id = ctl.read.split.first
         @path = File.join(File.dirname(@path), @id)
       else
         @id = File.basename(@path)
@@ -178,7 +178,7 @@ module Rumai
     def focus aView = nil
       if exist? and not focus?
         (aView ? [aView] : self.views).each do |v|
-          if a = self.area(v)
+          if a = self.area(v) and a.exist?
             v.focus
             a.focus
 
@@ -202,15 +202,6 @@ module Rumai
 
     # Sends this client to the given destination within the given view.
     def send aAreaOrId, aView = View.curr
-      if aAreaOrId.to_s != 'toggle'
-        # XXX: it is an error to send a floating client directly to a
-        #      managed area, so we gotta "ground" it first and then send it
-        #      to the desired managed area. John-Galt will fix this someday.
-        if area(aView).float?
-          aView.ctl.write "send #{@id} toggle"
-        end
-      end
-
       dst = area_to_id(aAreaOrId)
       aView.ctl.write "send #{@id} #{dst}"
     end
@@ -221,6 +212,11 @@ module Rumai
       aView.ctl.write "swap #{@id} #{dst}"
     end
 
+    # Terminates this client nicely (requests this window to be closed).
+    def kill
+      ctl.write :kill
+    end
+
     ##
     #
     # WM hierarchy
@@ -316,9 +312,8 @@ module Rumai
 
     def area_to_id aAreaOrId
       if aAreaOrId.respond_to? :id
-        # XXX: +1 until John-Galt fixes this: right now, index 1
-        #      is floating area; but ~ (0) should be floating area.
-        aAreaOrId.id+1
+        id = aAreaOrId.id
+        id == '~' ? :toggle : id
       else
         aAreaOrId
       end
@@ -359,13 +354,13 @@ module Rumai
 
     # aView:: the view which contains this area.
     def initialize aAreaId, aView = View.curr
-      @id = aAreaId.to_i
+      @id = Integer(aAreaId) rescue aAreaId
       @view = aView
     end
 
     # Checks if this area is the floating area.
     def float?
-      @id == 0
+      @id == '~'
     end
 
     # Checks if this area is a column in the managed area.
@@ -392,7 +387,7 @@ module Rumai
     include ClientContainer
       # Returns the IDs of the clients in this area.
       def client_ids
-        @view.client_ids ctl_id
+        @view.client_ids @id
       end
 
     include Enumerable
@@ -403,7 +398,7 @@ module Rumai
 
     # Sets the layout of clients in this column.
     def layout= aMode
-      @view.ctl.write "colmode #{ctl_id} #{aMode}"
+      @view.ctl.write "colmode #{@id} #{aMode}"
     end
 
     ##
@@ -414,7 +409,7 @@ module Rumai
 
     # Puts focus on this area.
     def focus
-      @view.ctl.write "select #{ctl_id}"
+      @view.ctl.write "select #{@id}"
     end
 
     ##
@@ -491,11 +486,6 @@ module Rumai
 
     private
 
-    # Makes the ID usable in wmii's /ctl commands.
-    def ctl_id
-      float? ? '~' : @id
-    end
-
     # Moves the given client into this area.
     def import_client c
       if exist?
@@ -594,7 +584,7 @@ module Rumai
     end
 
     # Returns the floating area of this view.
-    def floating_area
+    def floater
       areas.first
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rumai
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors: []
 
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-26 00:00:00 -08:00
+date: 2008-02-04 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: Ruby interface to wmii.
+description: Ruby interface to the wmii window manager.
 email: 
 executables: 
 - rumai
@@ -41,7 +41,6 @@ files:
 - doc
 - doc/guide.html
 - doc/guide.erb
-- doc/index.html
 - doc/api
 - doc/api/classes
 - doc/api/classes/Time.html
@@ -69,8 +68,6 @@ files:
 - doc/api/classes/Rumai/Area.src
 - doc/api/classes/Rumai/Area.src/M000094.html
 - doc/api/classes/Rumai/Area.src/M000080.html
-- doc/api/classes/Rumai/Area.src/M000096.html
-- doc/api/classes/Rumai/Area.src/M000091.html
 - doc/api/classes/Rumai/Area.src/M000086.html
 - doc/api/classes/Rumai/Area.src/M000095.html
 - doc/api/classes/Rumai/Area.src/M000093.html
@@ -80,6 +77,8 @@ files:
 - doc/api/classes/Rumai/Area.src/M000083.html
 - doc/api/classes/Rumai/Area.src/M000087.html
 - doc/api/classes/Rumai/Area.src/M000081.html
+- doc/api/classes/Rumai/Area.src/M000079.html
+- doc/api/classes/Rumai/Area.src/M000092.html
 - doc/api/classes/Rumai/Area.src/M000088.html
 - doc/api/classes/Rumai/Area.src/M000082.html
 - doc/api/classes/Rumai/Area.src/M000090.html
@@ -90,6 +89,7 @@ files:
 - doc/api/classes/Rumai/Client.src/M000121.html
 - doc/api/classes/Rumai/Client.src/M000124.html
 - doc/api/classes/Rumai/Client.src/M000114.html
+- doc/api/classes/Rumai/Client.src/M000113.html
 - doc/api/classes/Rumai/Client.src/M000115.html
 - doc/api/classes/Rumai/Client.src/M000119.html
 - doc/api/classes/Rumai/Client.src/M000127.html
@@ -112,16 +112,14 @@ files:
 - doc/api/classes/Rumai/IXP/Struct.src
 - doc/api/classes/Rumai/IXP/Struct.src/M000032.html
 - doc/api/classes/Rumai/IXP/Struct.src/M000033.html
-- doc/api/classes/Rumai/IXP/Struct.src/M000035.html
 - doc/api/classes/Rumai/IXP/Struct.src/M000031.html
 - doc/api/classes/Rumai/IXP/Struct.src/M000030.html
-- doc/api/classes/Rumai/IXP/Struct.src/M000034.html
 - doc/api/classes/Rumai/IXP/Rflush.html
 - doc/api/classes/Rumai/IXP/Tauth.html
 - doc/api/classes/Rumai/IXP/Fcall.html
 - doc/api/classes/Rumai/IXP/Tcreate.html
 - doc/api/classes/Rumai/IXP/Fcall.src
-- doc/api/classes/Rumai/IXP/Fcall.src/M000074.html
+- doc/api/classes/Rumai/IXP/Fcall.src/M000070.html
 - doc/api/classes/Rumai/IXP/Fcall.src/M000073.html
 - doc/api/classes/Rumai/IXP/Fcall.src/M000071.html
 - doc/api/classes/Rumai/IXP/Fcall.src/M000072.html
@@ -132,27 +130,27 @@ files:
 - doc/api/classes/Rumai/IXP/Tattach.html
 - doc/api/classes/Rumai/IXP/Rremove.html
 - doc/api/classes/Rumai/IXP/Stat.src
-- doc/api/classes/Rumai/IXP/Stat.src/M000076.html
+- doc/api/classes/Rumai/IXP/Stat.src/M000075.html
 - doc/api/classes/Rumai/IXP/Rerror.html
 - doc/api/classes/Rumai/IXP/Stream.src
-- doc/api/classes/Rumai/IXP/Stream.src/M000045.html
+- doc/api/classes/Rumai/IXP/Stream.src/M000043.html
 - doc/api/classes/Rumai/IXP/Struct.html
 - doc/api/classes/Rumai/IXP/Struct
 - doc/api/classes/Rumai/IXP/Struct/Field
 - doc/api/classes/Rumai/IXP/Struct/Field/CounteeField.html
 - doc/api/classes/Rumai/IXP/Struct/Field/CounterField.html
 - doc/api/classes/Rumai/IXP/Struct/Field/CounteeField.src
-- doc/api/classes/Rumai/IXP/Struct/Field/CounteeField.src/M000043.html
-- doc/api/classes/Rumai/IXP/Struct/Field/CounteeField.src/M000044.html
+- doc/api/classes/Rumai/IXP/Struct/Field/CounteeField.src/M000041.html
+- doc/api/classes/Rumai/IXP/Struct/Field/CounteeField.src/M000042.html
 - doc/api/classes/Rumai/IXP/Struct/Field/CounterField.src
-- doc/api/classes/Rumai/IXP/Struct/Field/CounterField.src/M000042.html
+- doc/api/classes/Rumai/IXP/Struct/Field/CounterField.src/M000040.html
 - doc/api/classes/Rumai/IXP/Struct/Field.src
 - doc/api/classes/Rumai/IXP/Struct/Field.src/M000038.html
 - doc/api/classes/Rumai/IXP/Struct/Field.src/M000036.html
-- doc/api/classes/Rumai/IXP/Struct/Field.src/M000040.html
 - doc/api/classes/Rumai/IXP/Struct/Field.src/M000037.html
-- doc/api/classes/Rumai/IXP/Struct/Field.src/M000041.html
+- doc/api/classes/Rumai/IXP/Struct/Field.src/M000035.html
 - doc/api/classes/Rumai/IXP/Struct/Field.src/M000039.html
+- doc/api/classes/Rumai/IXP/Struct/Field.src/M000034.html
 - doc/api/classes/Rumai/IXP/Struct/Field.html
 - doc/api/classes/Rumai/IXP/Tstat.html
 - doc/api/classes/Rumai/IXP/Rstat.html
@@ -171,16 +169,17 @@ files:
 - doc/api/classes/Rumai/IXP/Tremove.html
 - doc/api/classes/Rumai/IXP/Agent
 - doc/api/classes/Rumai/IXP/Agent/FidStream.src
-- doc/api/classes/Rumai/IXP/Agent/FidStream.src/M000066.html
+- doc/api/classes/Rumai/IXP/Agent/FidStream.src/M000060.html
 - doc/api/classes/Rumai/IXP/Agent/FidStream.src/M000063.html
 - doc/api/classes/Rumai/IXP/Agent/FidStream.src/M000065.html
+- doc/api/classes/Rumai/IXP/Agent/FidStream.src/M000061.html
 - doc/api/classes/Rumai/IXP/Agent/FidStream.src/M000064.html
 - doc/api/classes/Rumai/IXP/Agent/FidStream.src/M000062.html
 - doc/api/classes/Rumai/IXP/Agent/FidStream.html
 - doc/api/classes/Rumai/IXP/Agent/MODES.src
-- doc/api/classes/Rumai/IXP/Agent/MODES.src/M000061.html
+- doc/api/classes/Rumai/IXP/Agent/MODES.src/M000059.html
 - doc/api/classes/Rumai/IXP/Agent/RangedPool.src
-- doc/api/classes/Rumai/IXP/Agent/RangedPool.src/M000070.html
+- doc/api/classes/Rumai/IXP/Agent/RangedPool.src/M000067.html
 - doc/api/classes/Rumai/IXP/Agent/RangedPool.src/M000068.html
 - doc/api/classes/Rumai/IXP/Agent/RangedPool.src/M000069.html
 - doc/api/classes/Rumai/IXP/Agent/MODES.html
@@ -188,12 +187,11 @@ files:
 - doc/api/classes/Rumai/IXP/Rwalk.html
 - doc/api/classes/Rumai/IXP/Agent.html
 - doc/api/classes/Rumai/IXP/Terror.src
-- doc/api/classes/Rumai/IXP/Terror.src/M000075.html
+- doc/api/classes/Rumai/IXP/Terror.src/M000074.html
 - doc/api/classes/Rumai/IXP/Error.html
 - doc/api/classes/Rumai/IXP/Tclunk.html
 - doc/api/classes/Rumai/IXP/Ropen.html
 - doc/api/classes/Rumai/IXP/Agent.src
-- doc/api/classes/Rumai/IXP/Agent.src/M000060.html
 - doc/api/classes/Rumai/IXP/Agent.src/M000055.html
 - doc/api/classes/Rumai/IXP/Agent.src/M000056.html
 - doc/api/classes/Rumai/IXP/Agent.src/M000051.html
@@ -203,20 +201,22 @@ files:
 - doc/api/classes/Rumai/IXP/Agent.src/M000054.html
 - doc/api/classes/Rumai/IXP/Agent.src/M000049.html
 - doc/api/classes/Rumai/IXP/Agent.src/M000047.html
+- doc/api/classes/Rumai/IXP/Agent.src/M000044.html
+- doc/api/classes/Rumai/IXP/Agent.src/M000045.html
 - doc/api/classes/Rumai/IXP/Agent.src/M000052.html
 - doc/api/classes/Rumai/IXP/Agent.src/M000046.html
 - doc/api/classes/Rumai/IXP/Agent.src/M000053.html
-- doc/api/classes/Rumai/IXP/Agent.src/M000059.html
 - doc/api/classes/Rumai/IXP/Agent.src/M000057.html
 - doc/api/classes/Rumai/IXP/Rversion.html
 - doc/api/classes/Rumai/IXP/Rattach.html
 - doc/api/classes/Rumai/Chain.src
+- doc/api/classes/Rumai/Chain.src/M000076.html
 - doc/api/classes/Rumai/Chain.src/M000078.html
-- doc/api/classes/Rumai/Chain.src/M000079.html
 - doc/api/classes/Rumai/Chain.src/M000077.html
 - doc/api/classes/Rumai/Node.src
 - doc/api/classes/Rumai/Node.src/M000101.html
 - doc/api/classes/Rumai/Node.src/M000111.html
+- doc/api/classes/Rumai/Node.src/M000096.html
 - doc/api/classes/Rumai/Node.src/M000106.html
 - doc/api/classes/Rumai/Node.src/M000110.html
 - doc/api/classes/Rumai/Node.src/M000103.html
@@ -224,7 +224,6 @@ files:
 - doc/api/classes/Rumai/Node.src/M000100.html
 - doc/api/classes/Rumai/Node.src/M000098.html
 - doc/api/classes/Rumai/Node.src/M000109.html
-- doc/api/classes/Rumai/Node.src/M000113.html
 - doc/api/classes/Rumai/Node.src/M000105.html
 - doc/api/classes/Rumai/Node.src/M000099.html
 - doc/api/classes/Rumai/Node.src/M000112.html
@@ -315,6 +314,6 @@ rubyforge_project: rumai
 rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
-summary: Ruby interface to wmii.
+summary: Ruby interface to the wmii window manager.
 test_files: []