guile/guile-core/doc ChangeLog scheme-io.texi

[Gary Houston]

CVSROOT:        /cvs
Module name:    guile
Changes by:     Gary Houston <address@hidden>   01/05/01 14:05:44

Modified files:
        guile-core/doc : ChangeLog scheme-io.texi 

Log message:
        * scheme-io.texi: Removed obsolete section Binary IO.  Added
        new section Block Reading and Writing.  Updated section
        Line/Delimited with module usage.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/doc/ChangeLog.diff?cvsroot=OldCVS&tr1=1.76&tr2=1.77&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/doc/scheme-io.texi.diff?cvsroot=OldCVS&tr1=1.9&tr2=1.10&r1=text&r2=text

Patches:
Index: guile/guile-core/doc/ChangeLog
diff -u guile/guile-core/doc/ChangeLog:1.76 guile/guile-core/doc/ChangeLog:1.77
--- guile/guile-core/doc/ChangeLog:1.76 Sun Apr 29 16:01:07 2001
+++ guile/guile-core/doc/ChangeLog      Tue May  1 14:05:44 2001
@@ -1,3 +1,9 @@
+2001-05-01  Gary Houston  <address@hidden>
+
+       * scheme-io.texi: Removed obsolete section Binary IO.  Added
+       new section Block Reading and Writing.  Updated section
+       Line/Delimited with module usage.
+
 2001-04-29  Neil Jerram  <address@hidden>
 
        * deprecated.texi (Tags): Removed - deprecation expired.
Index: guile/guile-core/doc/scheme-io.texi
diff -u guile/guile-core/doc/scheme-io.texi:1.9 
guile/guile-core/doc/scheme-io.texi:1.10
--- guile/guile-core/doc/scheme-io.texi:1.9     Sun Apr 29 16:01:07 2001
+++ guile/guile-core/doc/scheme-io.texi Tue May  1 14:05:44 2001
@@ -9,7 +9,7 @@
 * Closing::                     Procedures to close a port.
 * Random Access::               Moving around a random access port.
 * Line/Delimited::              Read and write lines or delimited text.
-* Binary IO::                   Save and restore Scheme objects.
+* Block Reading and Writing::   Reading and writing blocks of text.
 * Default Ports::               Defaults for input, output and errors.
 * Port Types::                  Types of port and how to make them.
 @end menu
@@ -323,23 +323,21 @@
 position.  The return value is unspecified.
 @end deffn
 
-
 @node Line/Delimited
address@hidden Handling Line Oriented and Delimited Text
address@hidden Line Oriented and Delimited Text
 
-[Line-oriented and delimited IO.  Or should this be merged into the
-previous two sections?]
+The delimited-I/O module can be accessed with:
 
-Extended I/O procedures are available which read or write lines of text
-or read text delimited by a specified set of characters.
address@hidden
+(use-modules (ice-9 rdelim))
address@hidden smalllisp
 
address@hidden fwrite
address@hidden fread
-Interfaces to @code{read}/@code{fread} and @code{write}/@code{fwrite} are
-also available, as @code{uniform-array-read!} and @code{uniform-array-write!},
address@hidden Arrays}.
+It can be used to read or write lines of text, or read text delimited by
+a specified set of characters.  It's similar to the @code{(scsh rdelim)}
+module from guile-scsh, but does not use multiple values or character
+sets and has an extra procedure @code{write-line}.
 
address@hidden begin (scm-doc-string "boot-9.scm" "read-line")
address@hidden begin (scm-doc-string "rdelim.scm" "read-line")
 @deffn procedure read-line [port] [handle-delim]
 Return a line of text from @var{port} if specified, otherwise from the
 value returned by @code{(current-input-port)}.  Under Unix, a line of text
@@ -359,13 +357,10 @@
 @item split
 Return a pair containing the string read from the port and the
 terminating delimiter or end-of-file object.
-
-NOTE: if the scsh module is loaded then
-multiple values are returned instead of a pair.
 @end table
 @end deffn
 
address@hidden begin (scm-doc-string "boot-9.scm" "read-line!")
address@hidden begin (scm-doc-string "rdelim.scm" "read-line!")
 @deffn procedure read-line! buf [port]
 Read a line of text into the supplied string @var{buf} and return the
 number of characters added to @var{buf}.  If @var{buf} is filled, then
@@ -374,18 +369,15 @@
 specified, otherwise from the value returned by @code{(current-input-port)}.
 @end deffn
 
address@hidden begin (scm-doc-string "boot-9.scm" "read-delimited")
address@hidden begin (scm-doc-string "rdelim.scm" "read-delimited")
 @deffn procedure read-delimited delims [port] [handle-delim]
 Read text until one of the characters in the string @var{delims} is found
 or end-of-file is reached.  Read from @var{port} if supplied, otherwise
 from the value returned by @code{(current-input-port)}.
 @var{handle-delim} takes the same values as described for @code{read-line}.
-
-NOTE: if the scsh module is loaded then @var{delims} must be an scsh
-char-set, not a string.
 @end deffn
 
address@hidden begin (scm-doc-string "boot-9.scm" "read-delimited!")
address@hidden begin (scm-doc-string "rdelim.scm" "read-delimited!")
 @deffn procedure read-delimited! delims buf [port] [handle-delim] [start] [end]
 Read text into the supplied string @var{buf} and return the number of
 characters added to @var{buf} (subject to @var{handle-delim}, which takes
@@ -395,9 +387,6 @@
 @var{delims} is found
 or end-of-file is reached.  Read from @var{port} if supplied, otherwise
 from the value returned by @code{(current-input-port)}.
-
-NOTE: if the scsh module is loaded then @var{delims} must be an scsh
-char-set, not a string.
 @end deffn
 
 @deffn primitive write-line obj [port]
@@ -440,19 +429,20 @@
 @code{(#<eof> . #<eof>)}.
 @end deffn
 
address@hidden Binary IO
address@hidden Saving and Restoring Scheme Objects
address@hidden Block reading and writing
address@hidden Block reading and writing
 
address@hidden primitive binary-read [port]
-Read and return an object from @var{port} in a binary format.
-If omitted, @var{port} defaults to the current output port.
address@hidden deffn
+The Block-string-I/O module can be accessed with:
 
address@hidden primitive binary-write obj [port]
-Write @var{obj} to @var{port} in a binary format.
-If omitted, @var{port} defaults to the current output port.
address@hidden deffn
address@hidden
+(use-modules (ice-9 rw))
address@hidden smalllisp
 
+It currently contains a single procedure which helps implement
+the @code{(scsh rw)} module in guile-scsh.
+
address@hidden primitive read-string!/partial str [port_or_fdes] [start] [end]
address@hidden deffn
 
 @node Default Ports
 @section Default Ports for Input, Output and Errors