1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document Class and Dir

Browse Source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@5222 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
dave 2003-12-19 15:18:09 +00:00
parent a4874e20ae
commit 5076ed519b
4 changed files with 421 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

305
dir.c
View File

@ -255,6 +255,12 @@ dir_s_alloc(klass)
return obj;
}
/*
* call-seq:
* Dir.new( string ) -> aDir
*
* Returns a new directory object for the named directory.
*/
static VALUE
dir_initialize(dir, dirname)
VALUE dir, dirname;
@ -282,6 +288,17 @@ dir_initialize(dir, dirname)
return dir;
}
/*
* call-seq:
* Dir.open( string ) => aDir
* Dir.open( string ) {| aDir | block } => anObject
*
* With no block, <code>open</code> is a synonym for
* <code>Dir::new</code>. If a block is present, it is passed
* <i>aDir</i> as a parameter. The directory is closed at the end of
* the block, and <code>Dir::open</code> returns the value of the
* block.
*/
static VALUE
dir_s_open(klass, dirname)
VALUE klass, dirname;
@ -308,6 +325,15 @@ dir_closed()
if (dirp->dir == NULL) dir_closed();\
} while (0)
/*
* call-seq:
* dir.path => string or nil
*
* Returns the path parameter passed to <em>dir</em>'s constructor.
*
* d = Dir.new("..")
* d.path #=> ".."
*/
static VALUE
dir_path(dir)
VALUE dir;
@ -319,6 +345,18 @@ dir_path(dir)
return rb_str_new2(dirp->path);
}
/*
* call-seq:
* dir.read => string or nil
*
* Reads the next entry from <em>dir</em> and returns it as a string.
* Returns <code>nil</code> at the end of the stream.
*
* d = Dir.new("testdir")
* d.read #=> "."
* d.read #=> ".."
* d.read #=> "config.h"
*/
static VALUE
dir_read(dir)
VALUE dir;
@ -341,6 +379,23 @@ dir_read(dir)
return Qnil; /* not reached */
}
/*
* call-seq:
* dir.each { |filename| block } => dir
*
* Calls the block once for each entry in this directory, passing the
* filename of each entry as a parameter to the block.
*
* d = Dir.new("testdir")
* d.each {|x| puts "Got #{x}" }
*
* <em>produces:</em>
*
* Got .
* Got ..
* Got config.h
* Got main.rb
*/
static VALUE
dir_each(dir)
VALUE dir;
@ -356,6 +411,19 @@ dir_each(dir)
return dir;
}
/*
* call-seq:
* dir.pos => integer
* dir.tell => integer
*
* Returns the current position in <em>dir</em>. See also
* <code>Dir#seek</code>.
*
* d = Dir.new("testdir")
* d.tell #=> 0
* d.read #=> "."
* d.tell #=> 12
*/
static VALUE
dir_tell(dir)
VALUE dir;
@ -372,6 +440,20 @@ dir_tell(dir)
#endif
}
/*
* call-seq:
* dir.seek( integer ) => dir
*
* Seeks to a particular location in <em>dir</em>. <i>integer</i>
* must be a value returned by <code>Dir#tell</code>.
*
* d = Dir.new("testdir") #=> #<Dir:0x401b3c40>
* d.read #=> "."
* i = d.tell #=> 12
* d.read #=> ".."
* d.seek(i) #=> #<Dir:0x401b3c40>
* d.read #=> ".."
*/
static VALUE
dir_seek(dir, pos)
VALUE dir, pos;
@ -387,6 +469,20 @@ dir_seek(dir, pos)
#endif
}
/*
* call-seq:
* dir.pos( integer ) => integer
*
* Synonym for <code>Dir#seek</code>, but returns the position
* parameter.
*
* d = Dir.new("testdir") #=> #<Dir:0x401b3c40>
* d.read #=> "."
* i = d.pos #=> 12
* d.read #=> ".."
* d.pos = i #=> 12
* d.read #=> ".."
*/
static VALUE
dir_set_pos(dir, pos)
VALUE dir, pos;
@ -395,6 +491,17 @@ dir_set_pos(dir, pos)
return pos;
}
/*
* call-seq:
* dir.rewind => dir
*
* Repositions <em>dir</em> to the first entry.
*
* d = Dir.new("testdir")
* d.read #=> "."
* d.rewind #=> #<Dir:0x401b3fb0>
* d.read #=> "."
*/
static VALUE
dir_rewind(dir)
VALUE dir;
@ -406,6 +513,16 @@ dir_rewind(dir)
return dir;
}
/*
* call-seq:
* dir.close => nil
*
* Closes the directory stream. Any further attempts to access
* <em>dir</em> will raise an <code>IOError</code>.
*
* d = Dir.new("testdir")
* d.close #=> nil
*/
static VALUE
dir_close(dir)
VALUE dir;
@ -442,6 +559,45 @@ chdir_restore(path)
return Qnil;
}
/*
* call-seq:
* Dir.chdir( [ string] ) => 0
* Dir.chdir( [ string] ) {| path | block } => anObject
*
* Changes the current working directory of the process to the given
* string. When called without an argument, changes the directory to
* the value of the environment variable <code>HOME</code>, or
* <code>LOGDIR</code>. <code>SystemCallError</code> (probably
* <code>Errno::ENOENT</code>) if the target directory does not exist.
*
* If a block is given, it is passed the name of the new current
* directory, and the block is executed with that as the current
* directory. The original working directory is restored when the block
* exits. The return value of <code>chdir</code> is the value of the
* block. <code>chdir</code> blocks can be nested, but in a
* multi-threaded program an error will be raised if a thread attempts
* to open a <code>chdir</code> block while another thread has one
* open.
*
* Dir.chdir("/var/spool/mail")
* puts Dir.pwd
* Dir.chdir("/tmp") do
* puts Dir.pwd
* Dir.chdir("/usr") do
* puts Dir.pwd
* end
* puts Dir.pwd
* end
* puts Dir.pwd
*
* <em>produces:</em>
*
* /var/spool/mail
* /tmp
* /usr
* /tmp
* /var/spool/mail
*/
static VALUE
dir_s_chdir(argc, argv, obj)
int argc;
@ -482,6 +638,17 @@ dir_s_chdir(argc, argv, obj)
return INT2FIX(0);
}
/*
* call-seq:
* Dir.getwd => string
* Dir.pwd => string
*
* Returns the path to the current working directory of this process as
* a string.
*
* Dir.chdir("/tmp") #=> 0
* Dir.getwd #=> "/tmp"
*/
static VALUE
dir_s_getwd(dir)
VALUE dir;
@ -512,6 +679,15 @@ check_dirname(dir)
}
}
/*
* call-seq:
* Dir.chroot( string ) => 0
*
* Changes this process's idea of the file system root. Only a
* privileged process may make this call. Not available on all
* platforms. On Unix systems, see <code>chroot(2)</code> for more
* information.
*/
static VALUE
dir_s_chroot(dir, path)
VALUE dir, path;
@ -529,6 +705,19 @@ dir_s_chroot(dir, path)
#endif
}
/*
* call-seq:
* Dir.mkdir( string [, integer] ) => 0
*
* Makes a new directory named by <i>string</i>, with permissions
* specified by the optional parameter <i>anInteger</i>. The
* permissions may be modified by the value of
* <code>File::umask</code>, and are ignored on NT. Raises a
* <code>SystemCallError</code> if the directory cannot be created. See
* also the discussion of permissions in the class documentation for
* <code>File</code>.
*
*/
static VALUE
dir_s_mkdir(argc, argv, obj)
int argc;
@ -557,6 +746,15 @@ dir_s_mkdir(argc, argv, obj)
return INT2FIX(0);
}
/*
* call-seq:
* Dir.delete( string ) => 0
* Dir.rmdir( string ) => 0
* Dir.unlink( string ) => 0
*
* Deletes the named directory. Raises a subclass of
* <code>SystemCallError</code> if the directory isn't empty.
*/
static VALUE
dir_s_rmdir(obj, dir)
VALUE obj, dir;
@ -1010,6 +1208,14 @@ rb_push_glob(str, flags)
return ary;
}
/*
* call-seq:
* Dir[ string ] => array
*
* Equivalent to calling
* <em>dir</em>.<code>glob(</code><i>string,</i><code>0)</code>.
*
*/
static VALUE
dir_s_aref(obj, str)
VALUE obj, str;
@ -1017,6 +1223,27 @@ dir_s_aref(obj, str)
return rb_push_glob(str, 0);
}
/*
* call-seq:
* Dir.glob( string, [flags] ) => array
* Dir.glob( string, [flags] ) {| filename | block } => false
*
* Returns the filenames found by expanding the pattern given in
* <i>string</i>, either as an <i>array</i> or as parameters to the
* block. Note that this pattern is not a regexp (it's closer to a
* shell glob). See <code>File::fnmatch</code> for
* details of file name matching and the meaning of the <i>flags</i>
* parameter.
*
* Dir["config.?"] #=> ["config.h"]
* Dir.glob("config.?") #=> ["config.h"]
* Dir.glob("*.[a-z][a-z]") #=> ["main.rb"]
* Dir.glob("*.[^r]*") #=> ["config.h"]
* Dir.glob("*.{rb,h}") #=> ["main.rb", "config.h"]
* Dir.glob("*") #=> ["config.h", "main.rb"]
* Dir.glob("*", File::FNM_DOTMATCH) #=> [".", "..", "config.h", "main.rb"]
*
*/
static VALUE
dir_s_glob(argc, argv, obj)
int argc;
@ -1034,6 +1261,23 @@ dir_s_glob(argc, argv, obj)
return rb_push_glob(str, flags);
}
/*
* call-seq:
* Dir.foreach( dirname ) {| filename | block } => nil
*
* Calls the block once for each entry in the named directory, passing
* the filename of each entry as a parameter to the block.
*
* Dir.foreach("testdir") {|x| puts "Got #{x}" }
*
* <em>produces:</em>
*
* Got .
* Got ..
* Got config.h
* Got main.rb
*
*/
static VALUE
dir_foreach(io, dirname)
VALUE io, dirname;
@ -1045,6 +1289,17 @@ dir_foreach(io, dirname)
return Qnil;
}
/*
* call-seq:
* Dir.entries( dirname ) => array
*
* Returns an array containing all of the filenames in the given
* directory. Will raise a <code>SystemCallError</code> if the named
* directory doesn't exist.
*
* Dir.entries("testdir") #=> [".", "..", "config.h", "main.rb"]
*
*/
static VALUE
dir_entries(io, dirname)
VALUE io, dirname;
@ -1055,6 +1310,45 @@ dir_entries(io, dirname)
return rb_ensure(rb_Array, dir, dir_close, dir);
}
/*
* call-seq:
* File.fnmatch( pattern, path, [flags] ) => (true or false)
* File.fnmatch?( pattern, path, [flags] ) => (true or false)
*
* Returns true if <i>path</i> matches against <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>.
*
* File.fnmatch('cat', 'cat') #=> true
* File.fnmatch('cat', 'category') #=> false
* File.fnmatch('c{at,ub}s', 'cats') #=> false
* File.fnmatch('c{at,ub}s', 'cubs') #=> false
* File.fnmatch('c{at,ub}s', 'cat') #=> false
*
* File.fnmatch('c?t', 'cat') #=> true
* File.fnmatch('c\?t', 'cat') #=> false
* File.fnmatch('c??t', 'cat') #=> false
* File.fnmatch('c*', 'cats') #=> true
* File.fnmatch('c/ * FIXME * /t', 'c/a/b/c/t') #=> true
* File.fnmatch('c*t', 'cat') #=> true
* File.fnmatch('c\at', 'cat') #=> true
* File.fnmatch('c\at', 'cat', File::FNM_NOESCAPE) #=> false
* File.fnmatch('a?b', 'a/b') #=> true
* File.fnmatch('a?b', 'a/b', File::FNM_PATHNAME) #=> false
*
* File.fnmatch('*', '.profile') #=> false
* File.fnmatch('*', '.profile', File::FNM_DOTMATCH) #=> true
* File.fnmatch('*', 'dave/.profile') #=> true
* File.fnmatch('*', 'dave/.profile', File::FNM_DOTMATCH) #=> true
* File.fnmatch('*', 'dave/.profile', File::FNM_PATHNAME) #=> false
* File.fnmatch('* / FIXME *', 'dave/.profile', File::FNM_PATHNAME) #=> false
* STRICT = File::FNM_PATHNAME | File::FNM_DOTMATCH
* File.fnmatch('* / FIXME *', 'dave/.profile', STRICT) #=> true
*/
static VALUE
file_s_fnmatch(argc, argv, obj)
int argc;
@ -1079,6 +1373,17 @@ file_s_fnmatch(argc, argv, obj)
return Qfalse;
}
/*
* Objects of class <code>Dir</code> are directory streams representing
* directories in the underlying file system. They provide a variety of
* ways to list directories and their contents. See also
* <code>File</code>.
*
* The directory used in these examples contains the two regular files
* (<code>config.h</code> and <code>main.rb</code>), the parent
* directory (<code>..</code>), and the directory itself
* (<code>.</code>).
*/
void
Init_Dir()
{

18
lib/net/telnet.rb
View File

@ -277,7 +277,7 @@ module Net # :nodoc:
@options["Binmode"] = false
else
unless (true == @options["Binmode"] or false == @options["Binmode"])
raise ArgumentError, "Binmode option required true or false"
raise ArgumentError, "Binmode option must be true or false"
end
end
@ -285,7 +285,7 @@ module Net # :nodoc:
@options["Telnetmode"] = true
else
unless (true == @options["Telnetmode"] or false == @options["Telnetmode"])
raise ArgumentError, "Telnetmode option required true or false"
raise ArgumentError, "Telnetmode option must be true or false"
end
end
@ -330,7 +330,7 @@ module Net # :nodoc:
elsif @options["Proxy"].kind_of?(IO)
@sock = @options["Proxy"]
else
raise "Error; Proxy is Net::Telnet or IO object."
raise "Error: Proxy must be an instance of Net::Telnet or IO."
end
else
message = "Trying " + @options["Host"] + "...\n"
@ -347,7 +347,7 @@ module Net # :nodoc:
end
end
rescue TimeoutError
raise TimeoutError, "timed-out; opening of the host"
raise TimeoutError, "timed out while opening a connection to the host"
rescue
@log.write($ERROR_INFO.to_s + "\n") if @options.has_key?("Output_log")
@dumplog.log_dump('#', $ERROR_INFO.to_s + "\n") if @options.has_key?("Dump_log")
@ -382,7 +382,7 @@ module Net # :nodoc:
when true, false
@options["Telnetmode"] = mode
else
raise ArgumentError, "required true or false"
raise ArgumentError, "argument must be true or false, or missing"
end
end
@ -393,7 +393,7 @@ module Net # :nodoc:
if (true == mode or false == mode)
@options["Telnetmode"] = mode
else
raise ArgumentError, "required true or false"
raise ArgumentError, "argument must be true or false"
end
end
@ -406,7 +406,7 @@ module Net # :nodoc:
when true, false
@options["Binmode"] = mode
else
raise ArgumentError, "required true or false"
raise ArgumentError, "argument must be true or false"
end
end
@ -415,7 +415,7 @@ module Net # :nodoc:
if (true == mode or false == mode)
@options["Binmode"] = mode
else
raise ArgumentError, "required true or false"
raise ArgumentError, "argument must be true or false"
end
end
@ -542,7 +542,7 @@ module Net # :nodoc:
rest = ''
until(prompt === line and not IO::select([@sock], nil, nil, waittime))
unless IO::select([@sock], nil, nil, time_out)
raise TimeoutError, "timed-out; wait for the next data"
raise TimeoutError, "timed out while waiting for more data"
end
begin
c = @sock.sysread(1024 * 1024)

6
lib/rdoc/parsers/parse_c.rb
View File

@ -182,10 +182,14 @@ module RDoc
def find_class_comment(class_name, class_meth)
comment = nil
if @body =~ %r{((?>/\*.*?\*/\s+))
(static\s+)?void\s+Init_#{class_name}\s*\(\)}xm
class_meth.comment = mangle_comment($1)
comment = $1
elsif @body =~ %r{Document-class:\s#{class_name}.*?\n((?>.*?\*/))}m
comment = $1
end
class_meth.comment = mangle_comment(comment) if comment
end
def do_classes

125
object.c
View File

@ -704,6 +704,16 @@ rb_mod_initialize(module)
return Qnil;
}
/*
* call-seq:
* Class.new(super_class=Object) => a_class
*
* Creates a new anonymous (unnamed) class with the given superclass
* (or <code>Object</code> if no parameter is given). You can give a
* class a name by assigning the class object to a constant.
*
*/
static VALUE
rb_class_initialize(argc, argv, klass)
int argc;
@ -726,6 +736,15 @@ rb_class_initialize(argc, argv, klass)
return klass;
}
/*
* call-seq:
* class.allocate() => obj
*
* Allocates space for a new object of <i>class</i>'s class. The
* returned object must be an instance of <i>class</i>.
*
*/
VALUE
rb_obj_alloc(klass)
VALUE klass;
@ -755,6 +774,18 @@ rb_class_allocate_instance(klass)
return (VALUE)obj;
}
/*
* call-seq:
* class.new(args, ...) => obj
*
* Calls <code>allocate</code> to create a new object of
* <i>class</i>'s class, then invokes that object's
* <code>initialize</code> method, passing it <i>args</i>.
* This is the method that ends up getting called whenever
* an object is constructed using .new.
*
*/
VALUE
rb_class_new_instance(argc, argv, klass)
int argc;
@ -769,6 +800,18 @@ rb_class_new_instance(argc, argv, klass)
return obj;
}
/*
* call-seq:
* class.superclass -> a_super_class or nil
*
* Returns the superclass of <i>class</i>, or <code>nil</code>.
*
* File.superclass #=> IO
* IO.superclass #=> Object
* Object.superclass #=> nil
*
*/
static VALUE
rb_class_superclass(klass)
VALUE klass;
@ -1363,6 +1406,65 @@ boot_defclass(name, super)
VALUE ruby_top_self;
/*
* Document-class: Class
*
* Classes in Ruby are first-class objects---each is an instance of
* class <code>Class</code>.
*
* When a new class is created (typically using <code>class Name ...
* end</code>), an object of type <code>Class</code> is created and
* assigned to a global constant (<code>Name</code> in this case). When
* <code>Name.new</code> is called to create a new object, the
* <code>new</code> method in <code>Class</code> is run by default.
* This can be demonstrated by overriding <code>new</code> in
* <code>Class</code>:
*
* class Class
* alias oldNew new
* def new(*args)
* print "Creating a new ", self.name, "\n"
* oldNew(*args)
* end
* end
*
*
* class Name
* end
*
*
* n = Name.new
*
* <em>produces:</em>
*
* Creating a new Name
*
* Classes, modules, and objects are interrelated. In the diagram
* that follows, the arrows represent inheritance, and the
* parentheses meta-classes. All metaclasses are instances
* of the class `Class'.
*
* +------------------+
* | |
* Object---->(Object) |
* ^ ^ ^ ^ |
* | | | | |
* | | +-----+ +---------+ |
* | | | | |
* | +-----------+ | |
* | | | | |
* +------+ | Module--->(Module) |
* | | ^ ^ |
* OtherClass-->(OtherClass) | | |
* | | |
* Class---->(Class) |
* ^ |
* | |
* +----------------+
*
*
*/
void
Init_Object()
{
@ -1387,29 +1489,6 @@ Init_Object()
rb_define_private_method(rb_cModule, "method_removed", rb_obj_dummy, 1);
rb_define_private_method(rb_cModule, "method_undefined", rb_obj_dummy, 1);
/*
* Ruby's Class Hierarchy Chart
*
* +------------------+
* | |
* Object---->(Object) |
* ^ ^ ^ ^ |
* | | | | |
* | | +-----+ +---------+ |
* | | | | |
* | +-----------+ | |
* | | | | |
* +------+ | Module--->(Module) |
* | | ^ ^ |
* OtherClass-->(OtherClass) | | |
* | | |
* Class---->(Class) |
* ^ |
* | |
* +----------------+
*
* + All metaclasses are instances of the class `Class'.
*/
rb_define_method(rb_mKernel, "nil?", rb_false, 0);
rb_define_method(rb_mKernel, "==", rb_obj_equal, 1);