*** empty log message ***
[bpt/guile.git] / libguile / ioext.c
index 3fc250d..98b9fff 100644 (file)
@@ -54,7 +54,7 @@
 #include "chars.h"
 #include "feature.h"
 
-#include "scm_validate.h"
+#include "validate.h"
 #include "ioext.h"
 
 #include <fcntl.h>
 #endif
 \f
 
-GUILE_PROC (scm_read_delimited_x, "%read-delimited!", 3, 3, 0,
+SCM_DEFINE (scm_read_delimited_x, "%read-delimited!", 3, 3, 0,
             (SCM delims, SCM buf, SCM gobble, SCM port, SCM start, SCM end),
-"Read characters from @var{port} into @var{buf} until one of the
-characters in the @var{delims} string is encountered.  If @var{gobble?}
-is true, store the delimiter character in @var{buf} as well; otherwise,
-discard it.  If @var{port} is not specified, use the value of
-@code{(current-input-port)}.  If @var{start} or @var{end} are specified,
-store data only into the substring of @var{buf} bounded by @var{start}
-and @var{end} (which default to the beginning and end of the buffer,
-respectively).
-
-Return a pair consisting of the delimiter that terminated the string and
-the number of characters read.  If reading stopped at the end of file,
-the delimiter returned is the @var{eof-object}; if the buffer was filled
-without encountering a delimiter, this value is @var{#f}.")
+           "Read characters from @var{port} into @var{buf} until one of the\n"
+           "characters in the @var{delims} string is encountered.  If @var{gobble?}\n"
+           "is true, store the delimiter character in @var{buf} as well; otherwise,\n"
+           "discard it.  If @var{port} is not specified, use the value of\n"
+           "@code{(current-input-port)}.  If @var{start} or @var{end} are specified,\n"
+           "store data only into the substring of @var{buf} bounded by @var{start}\n"
+           "and @var{end} (which default to the beginning and end of the buffer,\n"
+           "respectively).\n\n"
+           "Return a pair consisting of the delimiter that terminated the string and\n"
+           "the number of characters read.  If reading stopped at the end of file,\n"
+           "the delimiter returned is the @var{eof-object}; if the buffer was filled\n"
+           "without encountering a delimiter, this value is @var{#f}.")
 #define FUNC_NAME s_scm_read_delimited_x
 {
   long j;
@@ -92,22 +91,21 @@ without encountering a delimiter, this value is @var{#f}.")
   char *cdelims;
   int num_delims;
 
-  SCM_VALIDATE_ROSTRING_COPY(1,delims,cdelims);
+  SCM_VALIDATE_ROSTRING_COPY (1,delims,cdelims);
   num_delims = SCM_ROLENGTH (delims);
-  SCM_VALIDATE_STRING_COPY(2,buf,cbuf);
+  SCM_VALIDATE_STRING_COPY (2,buf,cbuf);
   cend = SCM_LENGTH (buf);
   if (SCM_UNBNDP (port))
     port = scm_cur_inp;
   else
-    SCM_VALIDATE_OPINPORT(4,port);
+    SCM_VALIDATE_OPINPORT (4,port);
 
-  SCM_VALIDATE_INUM_DEF_COPY(5,start,0,cstart);
-  if (cstart < 0 || cstart >= cend)
-    scm_out_of_range (FUNC_NAME, start);
+  SCM_VALIDATE_INUM_DEF_COPY (5,start,0,cstart);
+  SCM_ASSERT_RANGE(5, start, cstart >= 0 && cstart < cend);
+
+  SCM_VALIDATE_INUM_DEF_COPY (6,end,cend,tend);
+  SCM_ASSERT_RANGE(6, end, tend > cstart && tend <= cend);
 
-  SCM_VALIDATE_INUM_DEF_COPY(6,end,cend,tend);
-  if (tend <= cstart || tend > cend)
-    scm_out_of_range (FUNC_NAME, end);
   cend = tend;
 
   for (j = cstart; j < cend; j++)
@@ -122,7 +120,7 @@ without encountering a delimiter, this value is @var{#f}.")
              if (SCM_FALSEP (gobble))
                scm_ungetc (c, port);
 
-             return scm_cons (SCM_MAKICHR (c),
+             return scm_cons (SCM_MAKE_CHAR (c),
                               scm_long2num (j - cstart));
            }
        }
@@ -228,14 +226,14 @@ scm_do_read_line (SCM port, int *len_p)
  * efficiently in Scheme.
  */
 
-GUILE_PROC (scm_read_line, "%read-line", 0, 1, 0, 
+SCM_DEFINE (scm_read_line, "%read-line", 0, 1, 0, 
             (SCM port),
-"Read a newline-terminated line from @var{port}, allocating storage as
-necessary.  The newline terminator (if any) is removed from the string,
-and a pair consisting of the line and its delimiter is returned.  The
-delimiter may be either a newline or the @var{eof-object}; if
-@code{%read-line} is called at the end of file, it returns the pair
-@code{(#<eof> . #<eof>)}.")
+           "Read a newline-terminated line from @var{port}, allocating storage as\n"
+           "necessary.  The newline terminator (if any) is removed from the string,\n"
+           "and a pair consisting of the line and its delimiter is returned.  The\n"
+           "delimiter may be either a newline or the @var{eof-object}; if\n"
+           "@code{%read-line} is called at the end of file, it returns the pair\n"
+           "@code{(#<eof> . #<eof>)}.")
 #define FUNC_NAME s_scm_read_line
 {
   scm_port *pt;
@@ -245,7 +243,7 @@ delimiter may be either a newline or the @var{eof-object}; if
 
   if (SCM_UNBNDP (port))
     port = scm_cur_inp;
-  SCM_VALIDATE_OPINPORT(1,port);
+  SCM_VALIDATE_OPINPORT (1,port);
 
   pt = SCM_PTAB_ENTRY (port);
   if (pt->rw_active == SCM_PORT_WRITE)
@@ -259,7 +257,7 @@ delimiter may be either a newline or the @var{eof-object}; if
     {
       if (s[slen-1] == '\n')
        {
-         term = SCM_MAKICHR ('\n');
+         term = SCM_MAKE_CHAR ('\n');
          s[slen-1] = '\0';
          line = scm_take_str (s, slen-1);
          scm_done_malloc (-1);
@@ -281,16 +279,15 @@ delimiter may be either a newline or the @var{eof-object}; if
 }
 #undef FUNC_NAME
 
-GUILE_PROC (scm_write_line, "write-line", 1, 1, 0,
+SCM_DEFINE (scm_write_line, "write-line", 1, 1, 0,
             (SCM obj, SCM port),
-"Display @var{obj} and a newline character to @var{port}.  If @var{port}
-is not specified, @code{(current-output-port)} is used.  This function
-is equivalent to:
-
-@smalllisp
-(display obj [port])
-(newline [port])
-@end smalllisp")
+           "Display @var{obj} and a newline character to @var{port}.  If @var{port}\n"
+           "is not specified, @code{(current-output-port)} is used.  This function\n"
+           "is equivalent to:\n\n"
+           "@smalllisp\n"
+           "(display obj [port])\n"
+           "(newline [port])\n"
+           "@end smalllisp")
 #define FUNC_NAME s_scm_write_line
 {
   scm_display (obj, port);
@@ -298,23 +295,23 @@ is equivalent to:
 }
 #undef FUNC_NAME
 
-GUILE_PROC (scm_ftell, "ftell", 1, 0, 0, 
+SCM_DEFINE (scm_ftell, "ftell", 1, 0, 0, 
             (SCM object),
-"Returns an integer representing the current position of @var{fd/port},
-measured from the beginning.  Equivalent to:
-@smalllisp
-(seek port 0 SEEK_CUR)
-@end smalllisp")
+           "Returns an integer representing the current position of @var{fd/port},\n"
+           "measured from the beginning.  Equivalent to:\n"
+           "@smalllisp\n"
+           "(seek port 0 SEEK_CUR)\n"
+           "@end smalllisp")
 #define FUNC_NAME s_scm_ftell
 {
   return scm_seek (object, SCM_INUM0, SCM_MAKINUM (SEEK_CUR));
 }
 #undef FUNC_NAME
 
-GUILE_PROC (scm_fseek, "fseek", 3, 0, 0,
+SCM_DEFINE (scm_fseek, "fseek", 3, 0, 0,
             (SCM object, SCM offset, SCM whence),
-"Obsolete.  Almost the same as seek, above, but the return value is
-unspecified.")
+           "Obsolete.  Almost the same as seek, above, but the return value is\n"
+           "unspecified.")
 #define FUNC_NAME s_scm_fseek
 {
   scm_seek (object, offset, whence);
@@ -322,21 +319,18 @@ unspecified.")
 }
 #undef FUNC_NAME
 
-GUILE_PROC (scm_redirect_port, "redirect-port", 2, 0, 0,
+SCM_DEFINE (scm_redirect_port, "redirect-port", 2, 0, 0,
             (SCM old, SCM new),
-"This procedure takes two ports and duplicates the underlying file
-descriptor from @var{old-port} into @var{new-port}.  The
-current file descriptor in @var{new-port} will be closed.
-After the redirection the two ports will share a file position
-and file status flags.
-
-The return value is unspecified.
-
-Unexpected behaviour can result if both ports are subsequently used
-and the original and/or duplicate ports are buffered.
-
-This procedure does not have any side effects on other ports or
-revealed counts.")
+           "This procedure takes two ports and duplicates the underlying file\n"
+           "descriptor from @var{old-port} into @var{new-port}.  The\n"
+           "current file descriptor in @var{new-port} will be closed.\n"
+           "After the redirection the two ports will share a file position\n"
+           "and file status flags.\n\n"
+           "The return value is unspecified.\n\n"
+           "Unexpected behaviour can result if both ports are subsequently used\n"
+           "and the original and/or duplicate ports are buffered.\n\n"
+           "This procedure does not have any side effects on other ports or\n"
+           "revealed counts.")
 #define FUNC_NAME s_scm_redirect_port
 {
   int ans, oldfd, newfd;
@@ -345,8 +339,8 @@ revealed counts.")
   old = SCM_COERCE_OUTPORT (old);
   new = SCM_COERCE_OUTPORT (new);
   
-  SCM_VALIDATE_OPFPORT(1,old);
-  SCM_VALIDATE_OPFPORT(2,new);
+  SCM_VALIDATE_OPFPORT (1,old);
+  SCM_VALIDATE_OPFPORT (2,new);
   oldfd = SCM_FPORT_FDES (old);
   fp = SCM_FSTREAM (new);
   newfd = fp->fdes;
@@ -371,9 +365,9 @@ revealed counts.")
 }
 #undef FUNC_NAME
 
-GUILE_PROC (scm_dup_to_fdes, "dup->fdes", 1, 1, 0, 
+SCM_DEFINE (scm_dup_to_fdes, "dup->fdes", 1, 1, 0, 
             (SCM fd_or_port, SCM fd),
-"Returns an integer file descriptor.")
+           "Returns an integer file descriptor.")
 #define FUNC_NAME s_scm_dup_to_fdes
 {
   int oldfd, newfd, rv;
@@ -384,7 +378,7 @@ GUILE_PROC (scm_dup_to_fdes, "dup->fdes", 1, 1, 0,
     oldfd = SCM_INUM (fd_or_port);
   else
     {
-      SCM_VALIDATE_OPFPORT(1,fd_or_port);
+      SCM_VALIDATE_OPFPORT (1,fd_or_port);
       oldfd = SCM_FPORT_FDES (fd_or_port);
     }
 
@@ -397,8 +391,7 @@ GUILE_PROC (scm_dup_to_fdes, "dup->fdes", 1, 1, 0,
     }
   else
     {
-      SCM_ASSERT (SCM_INUMP (fd), fd, SCM_ARG2, FUNC_NAME);
-      newfd = SCM_INUM (fd);
+      SCM_VALIDATE_INUM_COPY (2, fd, newfd);
       if (oldfd != newfd)
        {
          scm_evict_ports (newfd);      /* see scsh manual.  */
@@ -411,14 +404,14 @@ GUILE_PROC (scm_dup_to_fdes, "dup->fdes", 1, 1, 0,
 }
 #undef FUNC_NAME
 
-GUILE_PROC (scm_fileno, "fileno", 1, 0, 0, 
+SCM_DEFINE (scm_fileno, "fileno", 1, 0, 0, 
             (SCM port),
-"Returns the integer file descriptor underlying @var{port}.
-Does not change its revealed count.")
+           "Returns the integer file descriptor underlying @var{port}.\n"
+           "Does not change its revealed count.")
 #define FUNC_NAME s_scm_fileno
 {
   port = SCM_COERCE_OUTPORT (port);
-  SCM_VALIDATE_OPFPORT(1,port);
+  SCM_VALIDATE_OPFPORT (1,port);
   return SCM_MAKINUM (SCM_FPORT_FDES (port));
 }
 #undef FUNC_NAME
@@ -427,10 +420,10 @@ Does not change its revealed count.")
    an error if the arg is not a port?
    This proc as is would be better names isattyport?
    if it is not going to assume that the arg is a port */
-GUILE_PROC (scm_isatty_p, "isatty?", 1, 0, 0, 
+SCM_DEFINE (scm_isatty_p, "isatty?", 1, 0, 0, 
             (SCM port),
-"Returns @code{#t} if @var{port} is using a serial
-non-file device, otherwise @code{#f}.")
+           "Returns @code{#t} if @var{port} is using a serial\n"
+           "non-file device, otherwise @code{#f}.")
 #define FUNC_NAME s_scm_isatty_p
 {
   int rv;
@@ -447,21 +440,19 @@ non-file device, otherwise @code{#f}.")
 
 
 
-GUILE_PROC (scm_fdopen, "fdopen", 2, 0, 0,
+SCM_DEFINE (scm_fdopen, "fdopen", 2, 0, 0,
             (SCM fdes, SCM modes),
-"Returns a new port based on the file descriptor @var{fdes}.
-Modes are given by the string @var{modes}.  The revealed count of the port
-is initialized to zero.  The modes string is the same as that accepted
-by @ref{File Ports, open-file}.")
+           "Returns a new port based on the file descriptor @var{fdes}.\n"
+           "Modes are given by the string @var{modes}.  The revealed count of the port\n"
+           "is initialized to zero.  The modes string is the same as that accepted\n"
+           "by @ref{File Ports, open-file}.")
 #define FUNC_NAME s_scm_fdopen
 {
-  SCM port;
-
-  SCM_VALIDATE_INUM(1,fdes);
-  SCM_VALIDATE_ROSTRING(2,modes);
+  SCM_VALIDATE_INUM (1,fdes);
+  SCM_VALIDATE_ROSTRING (2,modes);
   SCM_COERCE_SUBSTR (modes);
-  port = scm_fdes_to_port (SCM_INUM (fdes), SCM_ROCHARS (modes), SCM_BOOL_F);
-  return port;
+
+  return scm_fdes_to_port (SCM_INUM (fdes), SCM_ROCHARS (modes), SCM_BOOL_F);
 }
 #undef FUNC_NAME
 
@@ -472,14 +463,14 @@ by @ref{File Ports, open-file}.")
  *          #t if fdes moved. 
  * MOVE->FDES is implemented in Scheme and calls this primitive.
  */
-GUILE_PROC (scm_primitive_move_to_fdes, "primitive-move->fdes", 2, 0, 0,
+SCM_DEFINE (scm_primitive_move_to_fdes, "primitive-move->fdes", 2, 0, 0,
             (SCM port, SCM fd),
-"Moves the underlying file descriptor for @var{port} to the integer
-value @var{fdes} without changing the revealed count of @var{port}.
-Any other ports already using this descriptor will be automatically
-shifted to new descriptors and their revealed counts reset to zero.
-The return value is @code{#f} if the file descriptor already had the
-required value or @code{#t} if it was moved.")
+           "Moves the underlying file descriptor for @var{port} to the integer\n"
+           "value @var{fdes} without changing the revealed count of @var{port}.\n"
+           "Any other ports already using this descriptor will be automatically\n"
+           "shifted to new descriptors and their revealed counts reset to zero.\n"
+           "The return value is @code{#f} if the file descriptor already had the\n"
+           "required value or @code{#t} if it was moved.")
 #define FUNC_NAME s_scm_primitive_move_to_fdes
 {
   struct scm_fport *stream;
@@ -489,8 +480,8 @@ required value or @code{#t} if it was moved.")
 
   port = SCM_COERCE_OUTPORT (port);
 
-  SCM_VALIDATE_OPFPORT(1,port);
-  SCM_VALIDATE_INUM(2,fd);
+  SCM_VALIDATE_OPFPORT (1,port);
+  SCM_VALIDATE_INUM (2,fd);
   stream = SCM_FSTREAM (port);
   old_fd = stream->fdes;
   new_fd = SCM_INUM (fd);
@@ -509,17 +500,17 @@ required value or @code{#t} if it was moved.")
 #undef FUNC_NAME
 
 /* Return a list of ports using a given file descriptor.  */
-GUILE_PROC(scm_fdes_to_ports, "fdes->ports", 1, 0, 0, 
+SCM_DEFINE (scm_fdes_to_ports, "fdes->ports", 1, 0, 0, 
            (SCM fd),
-"Returns a list of existing ports which have @var{fdes} as an
-underlying file descriptor, without changing their revealed counts.")
+           "Returns a list of existing ports which have @var{fdes} as an\n"
+           "underlying file descriptor, without changing their revealed counts.")
 #define FUNC_NAME s_scm_fdes_to_ports
 {
   SCM result = SCM_EOL;
   int int_fd;
   int i;
   
-  SCM_VALIDATE_INUM_COPY(1,fd,int_fd);
+  SCM_VALIDATE_INUM_COPY (1,fd,int_fd);
 
   for (i = 0; i < scm_port_table_size; i++)
     {