-/* Copyright (C) 1995,1996,1997,1998 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1997,1998,1999 Free Software Foundation, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* If you write modifications of your own for GUILE, it is your choice
* whether to permit this exception to apply to your modifications.
* If you do not wish that, delete this exception notice. */
+
+/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
+ gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
+
\f
#include <stdio.h>
#include <fcntl.h>
#include "_scm.h"
+#include "scm_validate.h"
#include "fports.h"
#ifdef HAVE_STRING_H
scm_fport_buffer_add (SCM port, int read_size, int write_size)
{
struct scm_fport *fp = SCM_FSTREAM (port);
- struct scm_port_table *pt = SCM_PTAB_ENTRY (port);
+ scm_port *pt = SCM_PTAB_ENTRY (port);
char *s_scm_fport_buffer_add = "scm_fport_buffer_add";
if (read_size == -1 || write_size == -1)
if (SCM_INPORTP (port) && read_size > 0)
{
- pt->read_buf = scm_must_malloc (read_size, s_scm_fport_buffer_add);
+ pt->read_buf = malloc (read_size);
+ if (pt->read_buf == NULL)
+ scm_memory_error (s_scm_fport_buffer_add);
pt->read_pos = pt->read_end = pt->read_buf;
pt->read_buf_size = read_size;
}
else
{
- pt->read_buf = pt->read_pos = pt->read_end = &pt->shortbuf;
+ pt->read_pos = pt->read_buf = pt->read_end = &pt->shortbuf;
pt->read_buf_size = 1;
}
if (SCM_OUTPORTP (port) && write_size > 0)
{
- pt->write_buf = scm_must_malloc (write_size, s_scm_fport_buffer_add);
+ pt->write_buf = malloc (write_size);
+ if (pt->write_buf == NULL)
+ scm_memory_error (s_scm_fport_buffer_add);
pt->write_pos = pt->write_buf;
pt->write_buf_size = write_size;
}
SCM_SETCAR (port, (SCM_CAR (port) | SCM_BUF0));
}
-SCM_PROC (s_setvbuf, "setvbuf", 2, 1, 0, scm_setvbuf);
-SCM
-scm_setvbuf (SCM port, SCM mode, SCM size)
+GUILE_PROC (scm_setvbuf, "setvbuf", 2, 1, 0,
+ (SCM port, SCM mode, SCM size),
+"Set the buffering mode for @var{port}. @var{mode} can be:
+@table @code
+@item _IONBF
+non-buffered
+@item _IOLBF
+line buffered
+@item _IOFBF
+block buffered, using a newly allocated buffer of @var{size} bytes.
+If @var{size} is omitted, a default size will be used.
+@end table
+
+
+@deffn primitive fcntl fd/port command [value]
+Apply @var{command} to the specified file descriptor or the underlying
+file descriptor of the specified port. @var{value} is an optional
+integer argument.
+
+Values for @var{command} are:
+
+@table @code
+@item F_DUPFD
+Duplicate a file descriptor
+@item F_GETFD
+Get flags associated with the file descriptor.
+@item F_SETFD
+Set flags associated with the file descriptor to @var{value}.
+@item F_GETFL
+Get flags associated with the open file.
+@item F_SETFL
+Set flags associated with the open file to @var{value}
+@item F_GETOWN
+Get the process ID of a socket's owner, for @code{SIGIO} signals.
+@item F_SETOWN
+Set the process that owns a socket to @var{value}, for @code{SIGIO} signals.
+@item FD_CLOEXEC
+The value used to indicate the "close on exec" flag with @code{F_GETFL} or
+@code{F_SETFL}.
+@end table
+")
+#define FUNC_NAME s_scm_setvbuf
{
int cmode, csize;
- struct scm_port_table *pt;
+ scm_port *pt;
port = SCM_COERCE_OUTPORT (port);
- SCM_ASSERT (SCM_NIMP (port) && SCM_OPFPORTP (port), port, SCM_ARG1,
- s_setvbuf);
- SCM_ASSERT (SCM_INUMP (mode), mode, SCM_ARG2, s_setvbuf);
- cmode = SCM_INUM (mode);
- if (cmode != _IONBF && cmode != _IOFBF)
- scm_out_of_range (s_setvbuf, mode);
+ SCM_VALIDATE_OPFPORT(1,port);
+ SCM_VALIDATE_INT_COPY(2,mode,cmode);
+ if (cmode != _IONBF && cmode != _IOFBF && cmode != _IOLBF)
+ scm_out_of_range (FUNC_NAME, mode);
+
+ if (cmode == _IOLBF)
+ {
+ SCM_SETCAR (port, SCM_CAR (port) | SCM_BUFLINE);
+ cmode = _IOFBF;
+ }
+ else
+ {
+ SCM_SETCAR (port, SCM_CAR (port) ^ SCM_BUFLINE);
+ }
+
if (SCM_UNBNDP (size))
{
if (cmode == _IOFBF)
}
else
{
- SCM_ASSERT (SCM_INUMP (size), size, SCM_ARG3, s_setvbuf);
- csize = SCM_INUM (size);
+ SCM_VALIDATE_INT_COPY(3,size,csize);
if (csize < 0 || (cmode == _IONBF && csize > 0))
- scm_out_of_range (s_setvbuf, size);
+ scm_out_of_range (FUNC_NAME, size);
}
+
pt = SCM_PTAB_ENTRY (port);
/* silently discards buffered chars. */
scm_fport_buffer_add (port, csize, csize);
return SCM_UNSPECIFIED;
}
+#undef FUNC_NAME
/* Move ports with the specified file descriptor to new descriptors,
* reseting the revealed count to 0.
*/
void
-scm_evict_ports (fd)
- int fd;
+scm_evict_ports (int fd)
{
int i;
*
* Return the new port.
*/
-SCM_PROC(s_open_file, "open-file", 2, 0, 0, scm_open_file);
-
-SCM
-scm_open_file (filename, modes)
- SCM filename;
- SCM modes;
+GUILE_PROC(scm_open_file, "open-file", 2, 0, 0,
+ (SCM filename, SCM modes),
+"Open the file whose name is @var{string}, and return a port
+representing that file. The attributes of the port are
+determined by the @var{mode} string. The way in
+which this is interpreted is similar to C stdio:
+
+The first character must be one of the following:
+
+@table @samp
+@item r
+Open an existing file for input.
+@item w
+Open a file for output, creating it if it doesn't already exist
+or removing its contents if it does.
+@item a
+Open a file for output, creating it if it doesn't already exist.
+All writes to the port will go to the end of the file.
+The "append mode" can be turned off while the port is in use
+@pxref{Ports and File Descriptors, fcntl}
+@end table
+
+The following additional characters can be appended:
+
+@table @samp
+@item +
+Open the port for both input and output. E.g., @code{r+}: open
+an existing file for both input and output.
+@item 0
+Create an "unbuffered" port. In this case input and output operations
+are passed directly to the underlying port implementation without
+additional buffering. This is likely to slow down I/O operations.
+The buffering mode can be changed while a port is in use
+@pxref{Ports and File Descriptors, setvbuf}
+@item l
+Add line-buffering to the port. The port output buffer will be
+automatically flushed whenever a newline character is written.
+@end table
+
+In theory we could create read/write ports which were buffered in one
+direction only. However this isn't included in the current interfaces.
+
+If a file cannot be opened with the access requested,
+@code{open-file} throws an exception.")
+#define FUNC_NAME s_scm_open_file
{
SCM port;
int fdes;
char *mode;
char *ptr;
- SCM_ASSERT (SCM_NIMP (filename) && SCM_ROSTRINGP (filename), filename, SCM_ARG1, s_open_file);
- SCM_ASSERT (SCM_NIMP (modes) && SCM_ROSTRINGP (modes), modes, SCM_ARG2, s_open_file);
+ SCM_VALIDATE_ROSTRING(1,filename);
+ SCM_VALIDATE_ROSTRING(2,modes);
if (SCM_SUBSTRP (filename))
filename = scm_makfromstr (SCM_ROCHARS (filename), SCM_ROLENGTH (filename), 0);
if (SCM_SUBSTRP (modes))
flags |= O_WRONLY | O_CREAT | O_APPEND;
break;
default:
- scm_out_of_range (s_open_file, modes);
+ scm_out_of_range (FUNC_NAME, modes);
}
ptr = mode + 1;
while (*ptr != '\0')
break;
case '0': /* unbuffered: handled later. */
case 'b': /* 'binary' mode: ignored. */
+ case 'l': /* line buffered: handled during output. */
break;
default:
- scm_out_of_range (s_open_file, modes);
+ scm_out_of_range (FUNC_NAME, modes);
}
ptr++;
}
{
int en = errno;
- scm_syserror_msg (s_open_file, "%s: %S",
+ scm_syserror_msg (FUNC_NAME, "%s: %S",
scm_cons (scm_makfrom0str (strerror (en)),
scm_cons (filename, SCM_EOL)),
en);
port = scm_fdes_to_port (fdes, mode, filename);
return port;
}
+#undef FUNC_NAME
\f
/* Building Guile ports from a file descriptor. */
{
long mode_bits = scm_mode_bits (mode);
SCM port;
- struct scm_port_table * pt;
+ scm_port *pt;
SCM_NEWCELL (port);
SCM_DEFER_INTS;
{
struct scm_fport *fp
- = (struct scm_fport *) scm_must_malloc (sizeof (struct scm_fport),
- "scm_fdes_to_port");
+ = (struct scm_fport *) malloc (sizeof (struct scm_fport));
+ if (fp == NULL)
+ scm_memory_error ("scm_fdes_to_port");
fp->fdes = fdes;
- fp->random = SCM_FDES_RANDOM_P (fdes);
-
+ pt->rw_random = SCM_FDES_RANDOM_P (fdes);
SCM_SETSTREAM (port, fp);
if (mode_bits & SCM_BUF0)
scm_fport_buffer_add (port, 0, 0);
}
-/* Check whether an fport's fdes can supply input. */
+/* Return a lower bound on the number of bytes available for input. */
static int
-fport_input_waiting_p (SCM port)
+fport_input_waiting (SCM port)
{
int fdes = SCM_FSTREAM (port)->fdes;
if (select (SELECT_SET_SIZE,
&read_set, &write_set, &except_set, &timeout)
< 0)
- scm_syserror ("fport_input_waiting_p");
- return FD_ISSET (fdes, &read_set);
+ scm_syserror ("fport_input_waiting");
+ return FD_ISSET (fdes, &read_set) ? 1 : 0;
#elif defined (FIONREAD)
int remir;
ioctl(fdes, FIONREAD, &remir);
return remir;
#else
- scm_misc_error ("fport_input_waiting_p",
+ scm_misc_error ("fport_input_waiting",
"Not fully implemented on this platform",
SCM_EOL);
#endif
}
-/* Clear an fport's read buffer and return buffered chars. */
-char *
-scm_fport_drain_input (SCM port, int *count_return)
-{
- struct scm_port_table *pt = SCM_PTAB_ENTRY (port);
- char *result = pt->read_pos;
-
- *count_return = pt->read_end - pt->read_pos;
- pt->read_pos = pt->read_end;
- return result;
-}
-
\f
-static int prinfport SCM_P ((SCM exp, SCM port, scm_print_state *pstate));
-
static int
-prinfport (exp, port, pstate)
- SCM exp;
- SCM port;
- scm_print_state *pstate;
+prinfport (SCM exp,SCM port,scm_print_state *pstate)
{
- SCM name;
- char * c;
- if (SCM_CLOSEDP (exp))
+ scm_puts ("#<", port);
+ scm_print_port_mode (exp, port);
+ if (SCM_OPFPORTP (exp))
{
- c = "file";
+ int fdes;
+ SCM name = SCM_PTAB_ENTRY (exp)->file_name;
+ scm_puts (SCM_NIMP (name) && SCM_ROSTRINGP (name)
+ ? SCM_ROCHARS (name)
+ : SCM_PTOBNAME (SCM_PTOBNUM (exp)),
+ port);
+ scm_putc (' ', port);
+ fdes = (SCM_FSTREAM (exp))->fdes;
+
+ if (isatty (fdes))
+ scm_puts (ttyname (fdes), port);
+ else
+ scm_intprint (fdes, 10, port);
}
else
{
- name = SCM_PTAB_ENTRY (exp)->file_name;
- if (SCM_NIMP (name) && SCM_ROSTRINGP (name))
- c = SCM_ROCHARS (name);
- else
- c = "file";
+ scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp)), port);
+ scm_putc (' ', port);
+ scm_intprint (SCM_CDR (exp), 16, port);
}
-
- scm_prinport (exp, port, c);
- return !0;
+ scm_putc ('>', port);
+ return 1;
}
#ifdef GUILE_ISELECT
{
int fdes = SCM_FSTREAM (port)->fdes;
- if (!fport_input_waiting_p (port))
+ if (!fport_input_waiting (port))
{
int n;
SELECT_TYPE readfds;
}
#endif
-static void local_fflush (SCM port);
+static void fport_flush (SCM port);
/* fill a port's read-buffer with a single read.
returns the first char and moves the read_pos pointer past it.
or returns EOF if end of file. */
static int
-fport_fill_buffer (SCM port)
+fport_fill_input (SCM port)
{
int count;
- struct scm_port_table *pt = SCM_PTAB_ENTRY (port);
+ scm_port *pt = SCM_PTAB_ENTRY (port);
struct scm_fport *fp = SCM_FSTREAM (port);
- if (fp->random)
- {
- /* flush any write buffer first: fix file position and allow the
- newly written chars to be read. */
- if (pt->write_pos > pt->write_buf)
- local_fflush (port);
- pt->write_needs_seek = 1;
- }
#ifdef GUILE_ISELECT
fport_wait_for_input (port);
#endif
SCM_SYSCALL (count = read (fp->fdes, pt->read_buf, pt->read_buf_size));
if (count == -1)
- scm_syserror ("fport_fill_buffer");
+ scm_syserror ("fport_fill_input");
if (count == 0)
return EOF;
else
{
- pt->read_pos = pt->read_buf + 1;
+ pt->read_pos = pt->read_buf;
pt->read_end = pt->read_buf + count;
- return (*(pt->read_buf));
+ return *pt->read_buf;
}
}
static off_t
-local_seek (SCM port, off_t offset, int whence)
+fport_seek (SCM port, off_t offset, int whence)
{
+ scm_port *pt = SCM_PTAB_ENTRY (port);
struct scm_fport *fp = SCM_FSTREAM (port);
+ off_t rv;
+ off_t result;
+
+ if (pt->rw_active == SCM_PORT_WRITE)
+ {
+ if (offset != 0 || whence != SEEK_CUR)
+ {
+ fport_flush (port);
+ result = rv = lseek (fp->fdes, offset, whence);
+ }
+ else
+ {
+ /* read current position without disturbing the buffer. */
+ rv = lseek (fp->fdes, offset, whence);
+ result = rv + (pt->write_pos - pt->write_buf);
+ }
+ }
+ else if (pt->rw_active == SCM_PORT_READ)
+ {
+ if (offset != 0 || whence != SEEK_CUR)
+ {
+ /* could expand to avoid a second seek. */
+ scm_end_input (port);
+ result = rv = lseek (fp->fdes, offset, whence);
+ }
+ else
+ {
+ /* read current position without disturbing the buffer
+ (particularly the unread-char buffer). */
+ rv = lseek (fp->fdes, offset, whence);
+ result = rv - (pt->read_end - pt->read_pos);
+
+ if (pt->read_buf == pt->putback_buf)
+ result -= pt->saved_read_end - pt->saved_read_pos;
+ }
+ }
+ else /* SCM_PORT_NEITHER */
+ {
+ result = rv = lseek (fp->fdes, offset, whence);
+ }
- return lseek (fp->fdes, offset, whence);
+ if (rv == -1)
+ scm_syserror ("fport_seek");
+
+ return result;
+}
+
+static void
+fport_truncate (SCM port, off_t length)
+{
+ struct scm_fport *fp = SCM_FSTREAM (port);
+
+ if (ftruncate (fp->fdes, length) == -1)
+ scm_syserror ("ftruncate");
+}
+
+static void
+fport_write (SCM port, void *data, size_t size)
+{
+ scm_port *pt = SCM_PTAB_ENTRY (port);
+
+ if (pt->write_buf == &pt->shortbuf)
+ {
+ /* "unbuffered" port. */
+ int fdes = SCM_FSTREAM (port)->fdes;
+
+ if (write (fdes, data, size) == -1)
+ scm_syserror ("fport_write");
+ }
+ else
+ {
+ const char *input = (char *) data;
+ size_t remaining = size;
+
+ while (remaining > 0)
+ {
+ int space = pt->write_end - pt->write_pos;
+ int write_len = (remaining > space) ? space : remaining;
+
+ memcpy (pt->write_pos, input, write_len);
+ pt->write_pos += write_len;
+ remaining -= write_len;
+ input += write_len;
+ if (write_len == space)
+ fport_flush (port);
+ }
+
+ /* handle line buffering. */
+ if ((SCM_CAR (port) & SCM_BUFLINE) && memchr (data, '\n', size))
+ fport_flush (port);
+ }
}
-/* becomes 1 when process is exiting: exception handling is disabled. */
+/* becomes 1 when process is exiting: normal exception handling won't
+ work by this time. */
extern int terminating;
static void
-local_fflush (SCM port)
+fport_flush (SCM port)
{
- struct scm_port_table *pt = SCM_PTAB_ENTRY (port);
+ scm_port *pt = SCM_PTAB_ENTRY (port);
struct scm_fport *fp = SCM_FSTREAM (port);
char *ptr = pt->write_buf;
int init_size = pt->write_pos - pt->write_buf;
pt->write_pos = pt->write_buf + remaining;
}
if (!terminating)
- scm_syserror ("local_fflush");
+ scm_syserror ("fport_flush");
else
{
const char *msg = "Error: could not flush file-descriptor ";
remaining -= count;
}
pt->write_pos = pt->write_buf;
+ pt->rw_active = SCM_PORT_NEITHER;
+}
+
+/* clear the read buffer and adjust the file position for unread bytes. */
+static void
+fport_end_input (SCM port, int offset)
+{
+ struct scm_fport *fp = SCM_FSTREAM (port);
+ scm_port *pt = SCM_PTAB_ENTRY (port);
+
+ offset += pt->read_end - pt->read_pos;
+
+ if (offset > 0)
+ {
+ pt->read_pos = pt->read_end;
+ /* will throw error if unread-char used at beginning of file
+ then attempting to write. seems correct. */
+ if (lseek (fp->fdes, -offset, SEEK_CUR) == -1)
+ scm_syserror ("fport_end_input");
+ }
+ pt->rw_active = SCM_PORT_NEITHER;
}
static int
-local_fclose (SCM port)
+fport_close (SCM port)
{
struct scm_fport *fp = SCM_FSTREAM (port);
- struct scm_port_table *pt = SCM_PTAB_ENTRY (port);
+ scm_port *pt = SCM_PTAB_ENTRY (port);
int rv;
-
- local_fflush (port);
+
+ fport_flush (port);
SCM_SYSCALL (rv = close (fp->fdes));
if (rv == -1 && errno != EBADF)
- scm_syserror ("local_fclose");
+ scm_syserror ("fport_close");
+ if (pt->read_buf == pt->putback_buf)
+ pt->read_buf = pt->saved_read_buf;
if (pt->read_buf != &pt->shortbuf)
- scm_must_free (pt->read_buf);
+ free (pt->read_buf);
if (pt->write_buf != &pt->shortbuf)
- scm_must_free (pt->write_buf);
- scm_must_free ((char *) fp);
+ free (pt->write_buf);
+ free ((char *) fp);
return rv;
}
-scm_ptobfuns scm_fptob =
- {
- 0,
- local_fclose,
- prinfport,
- 0,
- local_fflush,
- local_fclose,
- fport_fill_buffer,
- local_seek,
- fport_input_waiting_p,
-};
+static scm_sizet
+fport_free (SCM port)
+{
+ fport_close (port);
+ return 0;
+}
+
+void scm_make_fptob (void); /* Called from ports.c */
+
+void
+scm_make_fptob ()
+{
+ long tc = scm_make_port_type ("file", fport_fill_input, fport_write);
+ scm_set_port_free (tc, fport_free);
+ scm_set_port_print (tc, prinfport);
+ scm_set_port_flush (tc, fport_flush);
+ scm_set_port_end_input (tc, fport_end_input);
+ scm_set_port_close (tc, fport_close);
+ scm_set_port_seek (tc, fport_seek);
+ scm_set_port_truncate (tc, fport_truncate);
+ scm_set_port_input_waiting (tc, fport_input_waiting);
+}
void
scm_init_fports ()
HCoop / bpt / guile.git / blobdiff