rio 0.3.7 → 0.3.8

data/lib/rio/if/stream.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -49,7 +49,7 @@ module RIO
     #
     def gets(sep_string=$/) target.gets(sep_string) end
 
-    # Slurps the contents of the rio into a string. See also Rio#contents
+    # Slurps the contents of the rio into a string.
     #
     #  astring = rio('afile.txt').contents # slurp the entire contents of afile.txt into astring
     # 
@@ -195,6 +195,68 @@ module RIO
     def readline(*args) target.readline(*args) end
 
 
+    # Calls IO#readpartial
+    #
+    # Reads at most maxlen bytes from the I/O stream but it blocks
+    # only if ios has no data immediately available. If the optional
+    # outbuf argument is present, it must reference a String, which
+    # will receive the data. It raises EOFError on end of file.
+    #
+    # readpartial is designed for streams such as pipe, socket, tty, etc. It
+    # blocks only when no data immediately available. This means that it
+    # blocks only when following all conditions hold.
+    #
+    #     * the buffer in the IO object is empty.
+    #     * the content of the stream is empty.
+    #     * the stream is not reached to EOF.
+    #
+    # When readpartial blocks, it waits data or EOF on the stream. If some
+    # data is reached, readpartial returns with the data. If EOF is reached,
+    # readpartial raises EOFError.
+    #
+    # When readpartial doesn�t blocks, it returns or raises immediately. If
+    # the buffer is not empty, it returns the data in the buffer. Otherwise
+    # if the stream has some content, it returns the data in the
+    # stream. Otherwise if the stream is reached to EOF, it raises EOFError.
+    #
+    #    r, w = IO.pipe           #               buffer          pipe content
+    #    w << "abc"               #               ""              "abc".
+    #    r.readpartial(4096)      #=> "abc"       ""              ""
+    #    r.readpartial(4096)      # blocks because buffer and pipe is empty.
+    #
+    #    r, w = IO.pipe           #               buffer          pipe content
+    #    w << "abc"               #               ""              "abc"
+    #    w.close                  #               ""              "abc" EOF
+    #    r.readpartial(4096)      #=> "abc"       ""              EOF
+    #    r.readpartial(4096)      # raises EOFError
+    #
+    #    r, w = IO.pipe           #               buffer          pipe content
+    #    w << "abc\ndef\n"        #               ""              "abc\ndef\n"
+    #    r.gets                   #=> "abc\n"     "def\n"         ""
+    #    w << "ghi\n"             #               "def\n"         "ghi\n"
+    #    r.readpartial(4096)      #=> "def\n"     ""              "ghi\n"
+    #    r.readpartial(4096)      #=> "ghi\n"     ""              ""
+    #
+    # Note that readpartial is nonblocking-flag insensitive. It blocks even
+    # if the nonblocking-flag is set.
+    #
+    # Also note that readpartial behaves similar to sysread in blocking
+    # mode. The behavior is identical when the buffer is empty.
+    # ios.reopen(other_IO) => ios ios.reopen(path, mode_str) => ios
+    #
+    # Reassociates ios with the I/O stream given in other_IO or to a new
+    # stream opened on path. This may dynamically change the actual class of
+    # this stream.
+    #
+    #    f1 = File.new("testfile")
+    #    f2 = File.new("testfile")
+    #    f2.readlines[0]   #=> "This is line one\n"
+    #    f2.reopen(f1)     #=> #<File:testfile>
+    #    f2.readlines[0]   #=> "This is line one\n"
+    #
+    def readpartial(*args) target.readpartial(*args) end
+
+
     # Calls IO::print
     #
     # Writes the given object(s) to the Rio.  If the output record separator ($\) is not nil, 
@@ -283,7 +345,7 @@ module RIO
     #  ario.write(*args)
     #  ario.close
     #
-    def write!(*argv) target.write!(*argv); self end
+    def write!(*argv) target.write!(*argv) end
 
 
     # Calls IO#write
@@ -292,7 +354,7 @@ module RIO
     # it will be converted to a
     # string using +to_s+. Returns the number of bytes written.
     #
-    def write(*argv) target.write(*argv); self end
+    def write(*argv) target.write(*argv) end
 
 
     # Calls IO#eof?
@@ -404,8 +466,8 @@ module RIO
     # query file-oriented I/O streams. Arguments and results are platform
     # dependent. If _arg_ is a number, its value is passed directly. If
     # it is a string, it is interpreted as a binary sequence of bytes
-    # (+Array#pack+ might be a useful way to build this string). On Unix
-    # platforms, see +fcntl(2)+ for details. Not implemented on all
+    # (<tt>Array#pack</tt> might be a useful way to build this string). On Unix
+    # platforms, see <tt>fcntl(2)</tt> for details. Not implemented on all
     # platforms.
     #
     #
@@ -446,21 +508,22 @@ module RIO
     # Calls IO#pid
     #  ario.pid    => fixnum
     # Returns the process ID of a child process associated with _ario_.
-    # This will be set by +IO::popen+.
+    # This will be set by <tt>IO::popen</tt>.
     #
-    # pipe = IO.popen("-")
-    # if pipe
-    # $stderr.puts "In parent, child pid is #{pipe.pid}"
-    # else
-    # $stderr.puts "In child, pid is #{$$}"
-    # end
+    #  pipe = IO.popen("-")
+    #  if pipe
+    #    $stderr.puts "In parent, child pid is #{pipe.pid}"
+    #  else
+    #    $stderr.puts "In child, pid is #{$$}"
+    #  end
     #
-    # _produces:_
+    # produces:
     #
-    # In child, pid is 26209
-    # In parent, child pid is 26209
+    #  In child, pid is 26209
+    #  In parent, child pid is 26209
     #
     #
+    def pid() target.pid end
 
 
     # Calls IO#putc
@@ -489,6 +552,7 @@ module RIO
     # f.getc   #=> 104
     #
     #
+    def getc() target.getc() end
 
     # Calls IO#readchar
     #      ario.readchar   => fixnum
@@ -511,6 +575,8 @@ module RIO
     # f2.readlines[0]   #=> "This is line one\n"
     #
     #
+    #def reopen(m) target.reopen(m) end
+
 
     # Calls IO#stat
     #      ario.stat    => stat
@@ -525,29 +591,19 @@ module RIO
     #
     #
 
-    # Calls IO#tell
-    #      ario.pos     => integer
-    #      ario.tell    => integer
-    # Returns the current offset (in bytes) of _ario_.
-    #
-    # f = rio("testfile")
-    # f.pos    #=> 0
-    # f.gets   #=> "This is line one\n"
-    # f.pos    #=> 17
-    #
-    #
-
     # Calls IO#to_i
     #   to_i()
     # Alias for #fileno
     #
     #
+    def to_i() target.to_i() end
 
     # Calls IO#to_io
     #  ario.to_io -> ios
     # Returns _ario_.
     #
     #
+    def to_io() target.to_io() end
 
     # Calls IO#tty?
     #  ario.tty?     => true or false

data/lib/rio/if/string.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/if/temp.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/if/test.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -75,7 +75,7 @@ module RIO
     # Returns +true+ if the named file is a symbolic link.
     def symlink?() target.symlink? end
 
-    # Returns +true+ if a Rio is not closed?
+    # Returns +true+ if a Rio is not #closed?
     def open?() target.open?() end 
 
     # Calls IO#closed?
@@ -84,9 +84,42 @@ module RIO
     # both reader and writer), +false+ otherwise.
     def closed?() target.closed?()  end
 
+    # call-seq:
+    #  fnmatch?( pattern, [flags] ) => (true or false)
+    #
     # Calls File#fnmatch?
     #
-    # Returns true if path matches against pattern
+    # Returns true if Rio#path matches <i>pattern</i>. The
+    # pattern is not a regular expression; instead it follows rules
+    # similar to shell filename globbing. It may contain the following
+    # metacharacters:
+    #
+    # <i>flags</i> is a bitwise OR of the <code>FNM_xxx</code> parameters.
+    # The same glob pattern and flags are used by <code>Dir::glob</code>.
+    #
+    #  rio('cat').fnmatch?('cat')              #=> true
+    #  rio('category').fnmatch?('cat')         #=> false
+    #  rio('cats').fnmatch?('c{at,ub}s')       #=> false
+    #  rio('cubs').fnmatch?('c{at,ub}s')       #=> false
+    #  rio('cat').fnmatch?('c{at,ub}s')        #=> false
+    #
+    #  rio('cat').fnmatch?('c?t')              #=> true
+    #  rio('cat').fnmatch?('c\?t')             #=> false
+    #  rio('cat').fnmatch?('c??t')             #=> false
+    #  rio('cats').fnmatch?('c*')              #=> true
+    #
+    #  rio('cat').fnmatch?('c*t')                       #=> true
+    #  rio('cat').fnmatch?('c\at')                      #=> true
+    #  rio('cat').fnmatch?('c\at',File::FNM_NOESCAPE)   #=> false
+    #  rio('a/b').fnmatch?('a?b')                       #=> true
+    #  rio('a/b').fnmatch?('a?b',File::FNM_PATHNAME)    #=> false
+    #
+    #  rio('.profile').fnmatch?('*')                           #=> false
+    #  rio('.profile').fnmatch?('*',File::FNM_DOTMATCH)        #=> true
+    #  rio('dave/.profile').fnmatch?('*')                      #=> true
+    #  rio('dave/.profile').fnmatch?('*',File::FNM_DOTMATCH)   #=> true
+    #  rio('dave/.profile').fnmatch?('*',File::FNM_PATHNAME)   #=> false
+    #
     def fnmatch?(*args) target.fnmatch?(*args) end
 
     # Calls File#ftype

data/lib/rio/if/yaml.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/if.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/impl/path.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading

data/lib/rio/ioh.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -58,9 +58,11 @@ module RIO
     end
     class Stream < Base
       attr_reader :iostack
+      attr_accessor :hindex
       def initialize(iosp,*args)
         super
         @iostack = [@ios]
+        @hindex = -1
       end
       def initialize_copy(*args)
         #p callstr('ioh_stream:initialize_copy',*args)
@@ -75,7 +77,7 @@ module RIO
         sz || 512 
       end
 
-      def handle() @iostack[-1] end
+      def handle() @iostack[@hindex] end
       def close()  handle.close unless self.closed? end
       def closed?() handle.nil? or handle.closed? end
       def eof?() closed? or handle.eof? end
@@ -87,13 +89,22 @@ module RIO
         end
         self
       end
-
+      def puts(*args)
+        handle.puts(*args)
+      end
+      def each_bytes(nb,&block)
+        until handle.eof?
+          break unless s = handle.read(nb)
+          yield s
+        end
+        self
+      end
       extend Forwardable
       def_instance_delegators(:handle,:binmode,:stat,:rewind,
                               :each,:each_byte,:each_line,:gets,:getc,
                               :read,:readlines,:readline,:sysread,
-                              :<<,:print,:printf,:puts,:putc,:write,:syswrite,
-                              :pos,:pos=,:lineno,
+                              :<<,:print,:printf,:putc,:write,:syswrite,
+                              :pos,:pos=,:lineno,:lineno=,
                               :fileno,
                               :close_read,:close_write,
                               :fsync,:sync,:sync=,:fcntl,:ioctl)

data/lib/rio/iomode.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, Christopher Kleckner
+# Copyright (c) 2005, 2006 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
@@ -22,7 +22,7 @@
 #++
 #
 # To create the documentation for Rio run the command
-#  rake rdoc
+#  ruby build_doc.rb
 # from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
 #
 # Suggested Reading
@@ -58,7 +58,7 @@ module RIO
       
       def to_s() @mode.to_s end
 
-      abstract_method :primarily_read?, :primarily_write?, :allows_both?
+      abstract_method :primarily_read?, :primarily_write?, :allows_both?, :creates?
 
       def read_only?()
         allows_read? and !allows_write?
@@ -84,6 +84,7 @@ module RIO
       def allows_both?()
         @mode[1,1] == '+'
       end
+      def creates?() primarily_append? || primarily_write? end
     end
     class Str < Base
       include StrMethods

data/lib/rio/ios/fail.rb

@@ -0,0 +1,107 @@
+#--
+# =============================================================================== 
+# Copyright (c) 2005, 2006 Christopher Kleckner
+# All rights reserved
+#
+# This file is part of the Rio library for ruby.
+#
+# Rio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# Rio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rio; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# =============================================================================== 
+#++
+#
+# To create the documentation for Rio run the command
+#  ruby build_doc.rb
+# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+#
+# Suggested Reading
+# * RIO::Doc::SYNOPSIS
+# * RIO::Doc::INTRO
+# * RIO::Doc::HOWTO
+# * RIO::Rio
+#
+# <b>Rio is pre-alpha software. 
+# The documented interface and behavior is subject to change without notice.</b>
+
+
+require 'rio/exception/notsupported'
+
+module RIO
+  module IOS
+    module Methods
+    end
+  end
+end
+
+module RIO
+  module IOS
+    module Fail  #:nodoc: all
+      def notsupported(sym) 
+        raise RIO::Exception::NotSupported,RIO::Exception::NotSupported.emsg(sym,self)
+      end
+                                                                             
+      def <<(obj) notsupported(:<<) end
+      def binmode() notsupported(:binmode) end
+      def close() notsupported(:close) end
+      def close_read() notsupported(:close_read) end
+      def close_write() notsupported(:close_write) end
+      def closed?() notsupported(:closed?) end
+      def each(sep_string=$/,&block) notsupported(:each) end
+      def each_line(sep_string=$/,&block) notsupported(:each_line) end
+      def each_byte(sep_string=$/,&block) notsupported(:each_byte) end
+      def eof?() notsupported(:eof?) end
+      def fcntl(integer_cmd,arg) notsupported(:fcntl) end
+      def fileno() notsupported(:fileno) end
+      def to_i() notsupported(:to_i) end
+      def flush() notsupported(:flush) end
+      def fsync() notsupported(:fsync) end
+      def getc() notsupported(:getc) end
+      def gets(sep_string=$/) notsupported(:gets) end
+      def ioctl(integer_cmd,arg) notsupported(:ioctl) end
+      def isatty() notsupported(:isatty) end
+      def tty?() notsupported(:tty?) end
+      def lineno() notsupported(:lineno) end
+      def lineno=(a) notsupported(:lineno=) end
+      def pid() notsupported(:pid) end
+      def pos() notsupported(:pos) end
+      def tell() notsupported(:tell) end
+      def pos=(v) notsupported(:pos=) end
+      def print(*objs) notsupported(:print) end
+      def printf(format,*objs) notsupported(:printf) end
+      def putc(obj) notsupported(:putc) end
+      def puts(*objs) notsupported(:puts) end
+      def read(*args) notsupported(:read) end
+      def readchar() notsupported(:readchar) end
+      def readline(sep_string=$/) notsupported(:readline) end
+      def readlines(sep_string=$/) notsupported(:readlines) end
+      def readpartial(maxlen,*args)  notsupported(:readpartial) end
+      def reopen(*args) notsupported(:reopen) end
+      def rewind() notsupported(:rewind) end
+      def seek() notsupported(:seek) end
+      def stat() notsupported(:stat) end
+      def sync() notsupported(:sync) end
+      def sync=(v) notsupported(:sync=) end
+      def sysread() notsupported(:sysread) end
+      def sysseek() notsupported(:sysseek) end
+      def syswrite() notsupported(:syswrite) end
+      def ungetc() notsupported(:ungetc) end
+      def write(str) notsupported(:write) end
+      
+      def callstr(func,*args)
+        self.class.to_s+'['+self.to_s+']'+'.'+func.to_s+'('+args.join(',')+')'
+      end
+      
+    end
+  end
+end

data/lib/rio/ios/generic.rb

@@ -0,0 +1,120 @@
+#--
+# =============================================================================== 
+# Copyright (c) 2005, 2006 Christopher Kleckner
+# All rights reserved
+#
+# This file is part of the Rio library for ruby.
+#
+# Rio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# Rio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rio; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+# =============================================================================== 
+#++
+#
+# To create the documentation for Rio run the command
+#  ruby build_doc.rb
+# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+#
+# Suggested Reading
+# * RIO::Doc::SYNOPSIS
+# * RIO::Doc::INTRO
+# * RIO::Doc::HOWTO
+# * RIO::Rio
+#
+# <b>Rio is pre-alpha software. 
+# The documented interface and behavior is subject to change without notice.</b>
+
+
+require 'rio/exception/notsupported'
+
+module RIO
+  class GenericIOMode #:nodoc: all
+    def initialize(mode_string)
+      @str = mode_string
+    end
+    def to_s() @str end
+    def can_write?
+      @str =~ /^[aw]/ or @str =~ /\+/
+    end
+    def can_read?
+      @str =~ /^r/ or @str =~ /\+/
+    end
+    def appends?
+      @str =~ /^a/
+    end
+    def =~(re)
+      re =~ @str
+    end
+  end
+end
+
+module RIO
+  module IOS
+    class Generic  #:nodoc: all
+      def initialize(el,m='r')
+      end
+      
+      def <<(obj) self end
+      def binmode() self end
+      def close() nil end
+      def close_read() nil end
+      def close_write() nil end
+      def closed?() true end
+      def each(sep_string=$/,&block) self end
+      def each_line(sep_string=$/,&block) self end
+      def each_byte(sep_string=$/,&block) nil end
+      def eof?() true end
+      def fcntl(integer_cmd,arg) nil end
+      def fileno() nil end
+      def to_i() nil end
+      def flush() self end
+      def fsync() nil end
+      def getc() nil end
+      def gets(sep_string=$/) nil end
+      def ioctl(integer_cmd,arg) nil end
+      def isatty() false end
+      def tty?() false end
+      def lineno() 0 end
+      def lineno=(a) nil end
+      def pid() nil end
+      def pos() nil end
+      def tell() nil end
+      def pos=(v) self.pos end
+      def print(*objs) nil end
+      def printf(format,*objs) nil end
+      def putc(obj) nil end
+      def puts(*objs) nil end
+      def read(*args) nil end
+      def readchar() nil end
+      def readline(sep_string=$/) nil end
+      def readlines(sep_string=$/) [] end
+      def readpartial(maxlen,*args)  end
+      def reopen(*args) self end
+      def rewind() 0 end
+      def seek() 0 end
+      def stat() nil end
+      def sync() nil end
+      def sync=(v) nil end
+      def sysread() 0 end
+      def sysseek() 0 end
+      def syswrite() 0 end
+      def ungetc() nil end
+      def write(str) 0 end
+      
+      def callstr(func,*args)
+        self.class.to_s+'['+self.to_s+']'+'.'+func.to_s+'('+args.join(',')+')'
+      end
+      
+    end
+  end
+end