X-Git-Url: http://git.hcoop.net/bpt/guile.git/blobdiff_plain/69bc9ff335d5f32b1262dcc96d3109321248f8cc..083629bea45242d2d38d8cb6b89e84d8df7f06ff:/libguile/ports.c diff --git a/libguile/ports.c b/libguile/ports.c index 4e27a0c55..1cc9058b7 100644 --- a/libguile/ports.c +++ b/libguile/ports.c @@ -1,4 +1,4 @@ -/* Copyright (C) 1995,1996,1997,1998,1999 Free Software Foundation, Inc. +/* Copyright (C) 1995,1996,1997,1998,1999, 2000 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 @@ -38,20 +38,30 @@ * 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 */ + /* Headers. */ #include -#include "_scm.h" -#include "genio.h" -#include "chars.h" +#include "libguile/_scm.h" +#include "libguile/eval.h" +#include "libguile/objects.h" +#include "libguile/smob.h" +#include "libguile/chars.h" -#include "fports.h" -#include "strports.h" -#include "vports.h" -#include "keywords.h" +#include "libguile/keywords.h" +#include "libguile/root.h" +#include "libguile/strings.h" -#include "ports.h" +#include "libguile/validate.h" +#include "libguile/ports.h" + +#ifdef HAVE_STRING_H +#include +#endif #ifdef HAVE_MALLOC_H #include @@ -74,67 +84,174 @@ * Indexes into this table are used when generating type * tags for smobjects (if you know a tag you can get an index and conversely). */ -scm_ptobfuns *scm_ptobs; +scm_ptob_descriptor *scm_ptobs; int scm_numptob; /* GC marker for a port with stream of SCM type. */ SCM -scm_markstream (ptr) - SCM ptr; +scm_markstream (SCM ptr) { int openp; - openp = SCM_CAR (ptr) & SCM_OPN; + openp = SCM_CELL_WORD_0 (ptr) & SCM_OPN; if (openp) - return SCM_STREAM (ptr); + return SCM_PACK (SCM_STREAM (ptr)); else return SCM_BOOL_F; } +/* + * We choose to use an interface similar to the smob interface with + * fill_input and write as standard fields, passed to the port + * type constructor, and optional fields set by setters. + */ + +static void +flush_port_default (SCM port) +{ +} + +static void +end_input_default (SCM port, int offset) +{ +} -long -scm_newptob (ptob) - scm_ptobfuns *ptob; +scm_bits_t +scm_make_port_type (char *name, + int (*fill_input) (SCM port), + void (*write) (SCM port, const void *data, size_t size)) { char *tmp; if (255 <= scm_numptob) goto ptoberr; - tmp = (char *) realloc ((char *) scm_ptobs, (1 + scm_numptob) * sizeof (scm_ptobfuns)); + SCM_DEFER_INTS; + SCM_SYSCALL (tmp = (char *) realloc ((char *) scm_ptobs, + (1 + scm_numptob) + * sizeof (scm_ptob_descriptor))); if (tmp) { - scm_ptobs = (scm_ptobfuns *) tmp; - scm_ptobs[scm_numptob].mark = ptob->mark; - scm_ptobs[scm_numptob].free = ptob->free; - scm_ptobs[scm_numptob].print = ptob->print; - scm_ptobs[scm_numptob].equalp = ptob->equalp; - scm_ptobs[scm_numptob].fflush = ptob->fflush; - scm_ptobs[scm_numptob].read_flush = ptob->read_flush; - scm_ptobs[scm_numptob].fclose = ptob->fclose; - scm_ptobs[scm_numptob].fill_buffer = ptob->fill_buffer; - scm_ptobs[scm_numptob].seek = ptob->seek; - scm_ptobs[scm_numptob].ftruncate = ptob->ftruncate; - scm_ptobs[scm_numptob].input_waiting_p = ptob->input_waiting_p; + scm_ptobs = (scm_ptob_descriptor *) tmp; + + scm_ptobs[scm_numptob].name = name; + scm_ptobs[scm_numptob].mark = 0; + scm_ptobs[scm_numptob].free = scm_free0; + scm_ptobs[scm_numptob].print = scm_port_print; + scm_ptobs[scm_numptob].equalp = 0; + scm_ptobs[scm_numptob].close = 0; + + scm_ptobs[scm_numptob].write = write; + scm_ptobs[scm_numptob].flush = flush_port_default; + + scm_ptobs[scm_numptob].end_input = end_input_default; + scm_ptobs[scm_numptob].fill_input = fill_input; + scm_ptobs[scm_numptob].input_waiting = 0; + + scm_ptobs[scm_numptob].seek = 0; + scm_ptobs[scm_numptob].truncate = 0; + scm_numptob++; } + SCM_ALLOW_INTS; if (!tmp) - ptoberr:scm_wta (SCM_MAKINUM ((long) scm_numptob), (char *) SCM_NALLOC, "newptob"); + { + ptoberr: + scm_memory_error ("scm_make_port_type"); + } + /* Make a class object if Goops is present */ + if (scm_port_class) + scm_make_port_classes (scm_numptob - 1, SCM_PTOBNAME (scm_numptob - 1)); return scm_tc7_port + (scm_numptob - 1) * 256; } - +void +scm_set_port_mark (long tc, SCM (*mark) (SCM)) +{ + scm_ptobs[SCM_TC2PTOBNUM (tc)].mark = mark; +} -SCM_PROC(s_char_ready_p, "char-ready?", 0, 1, 0, scm_char_ready_p); +void +scm_set_port_free (long tc, scm_sizet (*free) (SCM)) +{ + scm_ptobs[SCM_TC2PTOBNUM (tc)].free = free; +} -SCM -scm_char_ready_p (port) - SCM port; +void +scm_set_port_print (long tc, int (*print) (SCM exp, SCM port, + scm_print_state *pstate)) { - scm_port *pt = SCM_PTAB_ENTRY (port); + scm_ptobs[SCM_TC2PTOBNUM (tc)].print = print; +} + +void +scm_set_port_equalp (long tc, SCM (*equalp) (SCM, SCM)) +{ + scm_ptobs[SCM_TC2PTOBNUM (tc)].equalp = equalp; +} + +void +scm_set_port_flush (long tc, void (*flush) (SCM port)) +{ + scm_ptobs[SCM_TC2PTOBNUM (tc)].flush = flush; +} + +void +scm_set_port_end_input (long tc, void (*end_input) (SCM port, int offset)) +{ + scm_ptobs[SCM_TC2PTOBNUM (tc)].end_input = end_input; +} + +void +scm_set_port_close (long tc, int (*close) (SCM)) +{ + scm_ptobs[SCM_TC2PTOBNUM (tc)].close = close; +} + +void +scm_set_port_seek (long tc, off_t (*seek) (SCM port, + off_t OFFSET, + int WHENCE)) +{ + scm_ptobs[SCM_TC2PTOBNUM (tc)].seek = seek; +} + +void +scm_set_port_truncate (long tc, void (*truncate) (SCM port, off_t length)) +{ + scm_ptobs[SCM_TC2PTOBNUM (tc)].truncate = truncate; +} + +void +scm_set_port_input_waiting (long tc, int (*input_waiting) (SCM)) +{ + scm_ptobs[SCM_TC2PTOBNUM (tc)].input_waiting = input_waiting; +} + + + +SCM_DEFINE (scm_char_ready_p, "char-ready?", 0, 1, 0, + (SCM port), + "Returns @code{#t} if a character is ready on input @var{port} and\n" + "returns @code{#f} otherwise. If @code{char-ready?} returns @code{#t}\n" + "then the next @code{read-char} operation on @var{port} is\n" + "guaranteed not to hang. If @var{port} is a file port at end of\n" + "file then @code{char-ready?} returns @code{#t}.\n" + "@footnote{@code{char-ready?} exists to make it possible for a\n" + "program to accept characters from interactive ports without getting\n" + "stuck waiting for input. Any input editors associated with such ports\n" + "must make sure that characters whose existence has been asserted by\n" + "@code{char-ready?} cannot be rubbed out. If @code{char-ready?} were to\n" + "return @code{#f} at end of file, a port at end of file would be\n" + "indistinguishable from an interactive port that has no ready\n" + "characters.}") +#define FUNC_NAME s_scm_char_ready_p +{ + scm_port *pt; if (SCM_UNBNDP (port)) port = scm_cur_inp; else - SCM_ASSERT (SCM_NIMP (port) && SCM_OPINPORTP (port), port, SCM_ARG1, - s_char_ready_p); + SCM_VALIDATE_OPINPORT (1,port); + + pt = SCM_PTAB_ENTRY (port); /* if the current read buffer is filled, or the last pushed-back char has been read and the saved buffer is @@ -145,121 +262,159 @@ scm_char_ready_p (port) return SCM_BOOL_T; else { - scm_ptobfuns *ptob = &scm_ptobs[SCM_PTOBNUM (port)]; + scm_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (port)]; - if (ptob->input_waiting_p) - return (ptob->input_waiting_p (port)) ? SCM_BOOL_T : SCM_BOOL_F; + if (ptob->input_waiting) + return SCM_BOOL(ptob->input_waiting (port)); else return SCM_BOOL_T; } } +#undef FUNC_NAME + +/* move up to read_len chars from port's putback and/or read buffers + into memory starting at dest. returns the number of chars moved. */ +size_t scm_take_from_input_buffers (SCM port, char *dest, size_t read_len) +{ + scm_port *pt = SCM_PTAB_ENTRY (port); + size_t chars_read = 0; + size_t from_buf = min (pt->read_end - pt->read_pos, read_len); + + if (from_buf > 0) + { + memcpy (dest, pt->read_pos, from_buf); + pt->read_pos += from_buf; + chars_read += from_buf; + read_len -= from_buf; + dest += from_buf; + } + + /* if putback was active, try the real input buffer too. */ + if (pt->read_buf == pt->putback_buf) + { + from_buf = min (pt->saved_read_end - pt->saved_read_pos, read_len); + if (from_buf > 0) + { + memcpy (dest, pt->saved_read_pos, from_buf); + pt->saved_read_pos += from_buf; + chars_read += from_buf; + } + } + return chars_read; +} /* Clear a port's read buffers, returning the contents. */ -SCM_PROC (s_drain_input, "drain-input", 1, 0, 0, scm_drain_input); -SCM -scm_drain_input (SCM port) +SCM_DEFINE (scm_drain_input, "drain-input", 1, 0, 0, + (SCM port), + "Drains @var{PORT}'s read buffers (including any pushed-back characters)\n" + "and returns the contents as a single string.") +#define FUNC_NAME s_scm_drain_input { SCM result; scm_port *pt = SCM_PTAB_ENTRY (port); int count; - char *dst; - SCM_ASSERT (SCM_NIMP (port) && SCM_OPINPORTP (port), port, SCM_ARG1, - s_drain_input); + SCM_VALIDATE_OPINPORT (1,port); count = pt->read_end - pt->read_pos; if (pt->read_buf == pt->putback_buf) count += pt->saved_read_end - pt->saved_read_pos; result = scm_makstr (count, 0); - dst = SCM_CHARS (result); - - while (pt->read_pos < pt->read_end) - *dst++ = *(pt->read_pos++); - - if (pt->read_buf == pt->putback_buf) - { - while (pt->saved_read_pos < pt->saved_read_end) - *dst++ = *(pt->saved_read_pos++); - } + scm_take_from_input_buffers (port, SCM_STRING_CHARS (result), count); return result; } +#undef FUNC_NAME /* Standard ports --- current input, output, error, and more(!). */ -SCM_PROC(s_current_input_port, "current-input-port", 0, 0, 0, scm_current_input_port); - -SCM -scm_current_input_port () +SCM_DEFINE (scm_current_input_port, "current-input-port", 0, 0, 0, + (), + "Returns the current input port. This is the default port used by many\n" + "input procedures. Initially, @code{current-input-port} returns the\n" + "value of @code{???}.") +#define FUNC_NAME s_scm_current_input_port { return scm_cur_inp; } - -SCM_PROC(s_current_output_port, "current-output-port", 0, 0, 0, scm_current_output_port); - -SCM -scm_current_output_port () +#undef FUNC_NAME + +SCM_DEFINE (scm_current_output_port, "current-output-port", 0, 0, 0, + (), + "Returns the current output port. This is the default port used by many\n" + "output procedures. Initially, @code{current-output-port} returns the\n" + "value of @code{???}.") +#define FUNC_NAME s_scm_current_output_port { return scm_cur_outp; } +#undef FUNC_NAME -SCM_PROC(s_current_error_port, "current-error-port", 0, 0, 0, scm_current_error_port); - -SCM -scm_current_error_port () +SCM_DEFINE (scm_current_error_port, "current-error-port", 0, 0, 0, + (), + "Return the port to which errors and warnings should be sent (the\n" + "@dfn{standard error} in Unix and C terminology).") +#define FUNC_NAME s_scm_current_error_port { return scm_cur_errp; } +#undef FUNC_NAME -SCM_PROC(s_current_load_port, "current-load-port", 0, 0, 0, scm_current_load_port); - -SCM -scm_current_load_port () +SCM_DEFINE (scm_current_load_port, "current-load-port", 0, 0, 0, + (), + "Return the current-load-port.\n" + "The load port is used internally by `primitive-load'.") +#define FUNC_NAME s_scm_current_load_port { return scm_cur_loadp; } - -SCM_PROC(s_set_current_input_port, "set-current-input-port", 1, 0, 0, scm_set_current_input_port); - -SCM -scm_set_current_input_port (port) - SCM port; +#undef FUNC_NAME + +SCM_DEFINE (scm_set_current_input_port, "set-current-input-port", 1, 0, 0, + (SCM port), + "@deffnx primitive set-current-output-port port\n" + "@deffnx primitive set-current-error-port port\n" + "Change the ports returned by @code{current-input-port},\n" + "@code{current-output-port} and @code{current-error-port}, respectively,\n" + "so that they use the supplied @var{port} for input or output.") +#define FUNC_NAME s_scm_set_current_input_port { SCM oinp = scm_cur_inp; - SCM_ASSERT (SCM_NIMP (port) && SCM_OPINPORTP (port), port, SCM_ARG1, s_set_current_input_port); + SCM_VALIDATE_OPINPORT (1,port); scm_cur_inp = port; return oinp; } +#undef FUNC_NAME -SCM_PROC(s_set_current_output_port, "set-current-output-port", 1, 0, 0, scm_set_current_output_port); - -SCM -scm_set_current_output_port (port) - SCM port; +SCM_DEFINE (scm_set_current_output_port, "set-current-output-port", 1, 0, 0, + (SCM port), + "Set the current default output port to PORT.") +#define FUNC_NAME s_scm_set_current_output_port { SCM ooutp = scm_cur_outp; port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_OPOUTPORTP (port), port, SCM_ARG1, s_set_current_output_port); + SCM_VALIDATE_OPOUTPORT (1,port); scm_cur_outp = port; return ooutp; } +#undef FUNC_NAME -SCM_PROC(s_set_current_error_port, "set-current-error-port", 1, 0, 0, scm_set_current_error_port); - -SCM -scm_set_current_error_port (port) - SCM port; +SCM_DEFINE (scm_set_current_error_port, "set-current-error-port", 1, 0, 0, + (SCM port), + "Set the current default error port to PORT.") +#define FUNC_NAME s_scm_set_current_error_port { SCM oerrp = scm_cur_errp; port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_OPOUTPORTP (port), port, SCM_ARG1, s_set_current_error_port); + SCM_VALIDATE_OPOUTPORT (1,port); scm_cur_errp = port; return oerrp; } +#undef FUNC_NAME /* The port table --- an array of pointers to ports. */ @@ -272,8 +427,7 @@ int scm_port_table_room = 20; /* Size of the array. */ /* Add a port to the table. */ scm_port * -scm_add_to_port_table (port) - SCM port; +scm_add_to_port_table (SCM port) { scm_port *entry; @@ -300,7 +454,8 @@ scm_add_to_port_table (port) entry->column_number = 0; entry->putback_buf = 0; entry->putback_buf_size = 0; - entry->rw_active = 0; + entry->rw_active = SCM_PORT_NEITHER; + entry->rw_random = 0; scm_port_table[scm_port_table_size] = entry; scm_port_table_size++; @@ -311,8 +466,7 @@ scm_add_to_port_table (port) /* Remove a port from the table and destroy it. */ void -scm_remove_from_port_table (port) - SCM port; +scm_remove_from_port_table (SCM port) { scm_port *p = SCM_PTAB_ENTRY (port); int i = p->entry; @@ -334,32 +488,42 @@ scm_remove_from_port_table (port) } #ifdef GUILE_DEBUG -/* Undocumented functions for debugging. */ -/* Return the number of ports in the table. */ +/* Functions for debugging. */ -SCM_PROC(s_pt_size, "pt-size", 0, 0, 0, scm_pt_size); -SCM -scm_pt_size () +SCM_DEFINE (scm_pt_size, "pt-size", 0, 0, 0, + (), + "Returns the number of ports in the port table.\n" + "`pt-size' is only included in GUILE_DEBUG builds.") +#define FUNC_NAME s_scm_pt_size { return SCM_MAKINUM (scm_port_table_size); } +#undef FUNC_NAME -/* Return the ith member of the port table. */ -SCM_PROC(s_pt_member, "pt-member", 1, 0, 0, scm_pt_member); -SCM -scm_pt_member (member) - SCM member; +SCM_DEFINE (scm_pt_member, "pt-member", 1, 0, 0, + (SCM index), + "Returns the port at INDEX in the port table.\n" + "`pt-member' is only included in GUILE_DEBUG builds.") +#define FUNC_NAME s_scm_pt_member { int i; - SCM_ASSERT (SCM_INUMP (member), member, SCM_ARG1, s_pt_member); - i = SCM_INUM (member); + SCM_VALIDATE_INUM_COPY (1,index,i); if (i < 0 || i >= scm_port_table_size) return SCM_BOOL_F; else return scm_port_table[i]->port; } +#undef FUNC_NAME #endif +void +scm_port_non_buffer (scm_port *pt) +{ + pt->read_pos = pt->read_buf = pt->read_end = &pt->shortbuf; + pt->write_buf = pt->write_pos = &pt->shortbuf; + pt->read_buf_size = pt->write_buf_size = 1; + pt->write_end = pt->write_buf + pt->write_buf_size; +} /* Revealed counts --- an oddity inherited from SCSH. */ @@ -369,8 +533,7 @@ scm_pt_member (member) */ int -scm_revealed_count (port) - SCM port; +scm_revealed_count (SCM port) { return SCM_REVEALED(port); } @@ -379,31 +542,31 @@ scm_revealed_count (port) /* Return the revealed count for a port. */ -SCM_PROC(s_port_revealed, "port-revealed", 1, 0, 0, scm_port_revealed); - -SCM -scm_port_revealed (port) - SCM port; +SCM_DEFINE (scm_port_revealed, "port-revealed", 1, 0, 0, + (SCM port), + "Returns the revealed count for @var{port}.") +#define FUNC_NAME s_scm_port_revealed { port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port), port, SCM_ARG1, s_port_revealed); + SCM_VALIDATE_PORT (1,port); return SCM_MAKINUM (scm_revealed_count (port)); } +#undef FUNC_NAME /* Set the revealed count for a port. */ -SCM_PROC(s_set_port_revealed_x, "set-port-revealed!", 2, 0, 0, scm_set_port_revealed_x); - -SCM -scm_set_port_revealed_x (port, rcount) - SCM port; - SCM rcount; +SCM_DEFINE (scm_set_port_revealed_x, "set-port-revealed!", 2, 0, 0, + (SCM port, SCM rcount), + "Sets the revealed count for a port to a given value.\n" + "The return value is unspecified.") +#define FUNC_NAME s_scm_set_port_revealed_x { port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port), port, SCM_ARG1, s_set_port_revealed_x); - SCM_ASSERT (SCM_INUMP (rcount), rcount, SCM_ARG2, s_set_port_revealed_x); + SCM_VALIDATE_PORT (1,port); + SCM_VALIDATE_INUM (2,rcount); SCM_REVEALED (port) = SCM_INUM (rcount); return SCM_UNSPECIFIED; } +#undef FUNC_NAME @@ -416,8 +579,7 @@ scm_set_port_revealed_x (port, rcount) */ long -scm_mode_bits (modes) - char *modes; +scm_mode_bits (char *modes) { return (SCM_OPN | (strchr (modes, 'r') || strchr (modes, '+') ? SCM_RDNG : 0) @@ -433,29 +595,32 @@ scm_mode_bits (modes) * Some modes such as "append" are only used when opening * a file and are not returned here. */ -SCM_PROC(s_port_mode, "port-mode", 1, 0, 0, scm_port_mode); - -SCM -scm_port_mode (port) - SCM port; +SCM_DEFINE (scm_port_mode, "port-mode", 1, 0, 0, + (SCM port), + "Returns the port modes associated with the open port @var{port}. These\n" + "will not necessarily be identical to the modes used when the port was\n" + "opened, since modes such as \"append\" which are used only during\n" + "port creation are not retained.") +#define FUNC_NAME s_scm_port_mode { char modes[3]; modes[0] = '\0'; port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_OPPORTP (port), port, SCM_ARG1, s_port_mode); - if (SCM_CAR (port) & SCM_RDNG) { - if (SCM_CAR (port) & SCM_WRTNG) + SCM_VALIDATE_OPPORT (1,port); + if (SCM_CELL_WORD_0 (port) & SCM_RDNG) { + if (SCM_CELL_WORD_0 (port) & SCM_WRTNG) strcpy (modes, "r+"); else strcpy (modes, "r"); } - else if (SCM_CAR (port) & SCM_WRTNG) + else if (SCM_CELL_WORD_0 (port) & SCM_WRTNG) strcpy (modes, "w"); - if (SCM_CAR (port) & SCM_BUF0) + if (SCM_CELL_WORD_0 (port) & SCM_BUF0) strcat (modes, "0"); return scm_makfromstr (modes, strlen (modes), 0); } +#undef FUNC_NAME @@ -465,39 +630,121 @@ scm_port_mode (port) * Call the close operation on a port object. * see also scm_close. */ -SCM_PROC(s_close_port, "close-port", 1, 0, 0, scm_close_port); - -SCM -scm_close_port (port) - SCM port; +SCM_DEFINE (scm_close_port, "close-port", 1, 0, 0, + (SCM port), + "Close the specified port object. Returns @code{#t} if it successfully\n" + "closes a port or @code{#f} if it was already\n" + "closed. An exception may be raised if an error occurs, for example\n" + "when flushing buffered output.\n" + "See also @ref{Ports and File Descriptors, close}, for a procedure\n" + "which can close file descriptors.") +#define FUNC_NAME s_scm_close_port { scm_sizet i; int rv; port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port), port, SCM_ARG1, - s_close_port); + SCM_VALIDATE_PORT (1, port); if (SCM_CLOSEDP (port)) return SCM_BOOL_F; i = SCM_PTOBNUM (port); - if (scm_ptobs[i].fclose) - rv = (scm_ptobs[i].fclose) (port); + if (scm_ptobs[i].close) + rv = (scm_ptobs[i].close) (port); else rv = 0; scm_remove_from_port_table (port); SCM_SETAND_CAR (port, ~SCM_OPN); - return (rv < 0) ? SCM_BOOL_F : SCM_BOOL_T; + return SCM_NEGATE_BOOL (rv < 0); +} +#undef FUNC_NAME + +SCM_DEFINE (scm_close_input_port, "close-input-port", 1, 0, 0, + (SCM port), + "Close the specified input port object. The routine has no effect if\n" + "the file has already been closed. An exception may be raised if an\n" + "error occurs. The value returned is unspecified.\n\n" + "See also @ref{Ports and File Descriptors, close}, for a procedure\n" + "which can close file descriptors.") +#define FUNC_NAME s_scm_close_input_port +{ + SCM_VALIDATE_INPUT_PORT (1, port); + scm_close_port (port); + return SCM_UNSPECIFIED; } +#undef FUNC_NAME + +SCM_DEFINE (scm_close_output_port, "close-output-port", 1, 0, 0, + (SCM port), + "Close the specified output port object. The routine has no effect if\n" + "the file has already been closed. An exception may be raised if an\n" + "error occurs. The value returned is unspecified.\n\n" + "See also @ref{Ports and File Descriptors, close}, for a procedure\n" + "which can close file descriptors.") +#define FUNC_NAME s_scm_close_output_port +{ + port = SCM_COERCE_OUTPORT (port); + SCM_VALIDATE_OUTPUT_PORT (1, port); + scm_close_port (port); + return SCM_UNSPECIFIED; +} +#undef FUNC_NAME + +SCM_DEFINE (scm_port_for_each, "port-for-each", 1, 0, 0, + (SCM proc), + "Apply @var{proc} to each port in the Guile port table\n" + "in turn. The return value is unspecified. More specifically,\n" + "@var{proc} is applied exactly once to every port that exists\n" + "in the system at the time @var{port-for-each} is invoked.\n" + "Changes to the port table while @var{port-for-each} is running\n" + "have no effect as far as @var{port-for-each} is concerned.\n") +#define FUNC_NAME s_scm_port_for_each +{ + int i; + SCM ports; -SCM_PROC(s_close_all_ports_except, "close-all-ports-except", 0, 0, 1, scm_close_all_ports_except); + SCM_VALIDATE_PROC (1, proc); -SCM -scm_close_all_ports_except (ports) - SCM ports; + /* when pre-emptive multithreading is supported, access to the port + table will need to be controlled by a mutex. */ + + /* Even without pre-emptive multithreading, running arbitrary code + while scanning the port table is unsafe because the port table + can change arbitrarily (from a GC, for example). So we build a + list in advance while blocking the GC. -mvo */ + + SCM_DEFER_INTS; + scm_block_gc++; + ports = SCM_EOL; + for (i = 0; i < scm_port_table_size; i++) + ports = scm_cons (scm_port_table[i]->port, ports); + scm_block_gc--; + SCM_ALLOW_INTS; + + while (ports != SCM_EOL) + { + scm_apply (proc, scm_cons (SCM_CAR (ports), SCM_EOL), SCM_EOL); + ports = SCM_CDR (ports); + } + + return SCM_UNSPECIFIED; +} +#undef FUNC_NAME + +#if (SCM_DEBUG_DEPRECATED == 0) + +SCM_DEFINE (scm_close_all_ports_except, "close-all-ports-except", 0, 0, 1, + (SCM ports), + "[DEPRECATED] Close all open file ports used by the interpreter\n" + "except for those supplied as arguments. This procedure\n" + "was intended to be used before an exec call to close file descriptors\n" + "which are not needed in the new process. However it has the\n" + "undesirable side-effect of flushing buffes, so it's deprecated.\n" + "Use port-for-each instead.") +#define FUNC_NAME s_scm_close_all_ports_except { int i = 0; - SCM_ASSERT (SCM_NIMP (ports) && SCM_CONSP (ports), ports, SCM_ARG1, s_close_all_ports_except); + SCM_VALIDATE_REST_ARGUMENT (ports); while (i < scm_port_table_size) { SCM thisport = scm_port_table[i]->port; @@ -508,8 +755,8 @@ scm_close_all_ports_except (ports) { SCM port = SCM_COERCE_OUTPORT (SCM_CAR (ports_ptr)); if (i == 0) - SCM_ASSERT (SCM_NIMP (port) && SCM_OPPORTP (port), port, SCM_ARG1, s_close_all_ports_except); - if (port == thisport) + SCM_VALIDATE_OPPORT (SCM_ARG1,port); + if (SCM_EQ_P (port, thisport)) found = 1; ports_ptr = SCM_CDR (ports_ptr); } @@ -521,97 +768,133 @@ scm_close_all_ports_except (ports) } return SCM_UNSPECIFIED; } +#undef FUNC_NAME +#endif /* Utter miscellany. Gosh, we should clean this up some time. */ -SCM_PROC(s_input_port_p, "input-port?", 1, 0, 0, scm_input_port_p); - -SCM -scm_input_port_p (x) - SCM x; +SCM_DEFINE (scm_input_port_p, "input-port?", 1, 0, 0, + (SCM x), + "Returns @code{#t} if @var{x} is an input port, otherwise returns\n" + "@code{#f}. Any object satisfying this predicate also satisfies\n" + "@code{port?}.") +#define FUNC_NAME s_scm_input_port_p { if (SCM_IMP (x)) - return SCM_BOOL_F; - return SCM_INPORTP (x) ? SCM_BOOL_T : SCM_BOOL_F; + return SCM_BOOL_F; + return SCM_BOOL(SCM_INPUT_PORT_P (x)); } - -SCM_PROC(s_output_port_p, "output-port?", 1, 0, 0, scm_output_port_p); - -SCM -scm_output_port_p (x) - SCM x; +#undef FUNC_NAME + +SCM_DEFINE (scm_output_port_p, "output-port?", 1, 0, 0, + (SCM x), + "Returns @code{#t} if @var{x} is an output port, otherwise returns\n" + "@code{#f}. Any object satisfying this predicate also satisfies\n" + "@code{port?}.") +#define FUNC_NAME s_scm_output_port_p { if (SCM_IMP (x)) - return SCM_BOOL_F; - return SCM_OUTPORTP (x) ? SCM_BOOL_T : SCM_BOOL_F; + return SCM_BOOL_F; + if (SCM_PORT_WITH_PS_P (x)) + x = SCM_PORT_WITH_PS_PORT (x); + return SCM_BOOL(SCM_OUTPUT_PORT_P (x)); } +#undef FUNC_NAME - -SCM_PROC(s_eof_object_p, "eof-object?", 1, 0, 0, scm_eof_object_p); - -SCM -scm_eof_object_p (x) - SCM x; +SCM_DEFINE (scm_port_p, "port?", 1, 0, 0, + (SCM x), + "Returns a boolean indicating whether @var{x} is a port.\n" + "Equivalent to @code{(or (input-port? X) (output-port? X))}.") +#define FUNC_NAME s_scm_port_p { - return SCM_EOF_OBJECT_P (x) ? SCM_BOOL_T : SCM_BOOL_F; + return SCM_BOOL (SCM_PORTP (x)); } +#undef FUNC_NAME -SCM_PROC(s_force_output, "force-output", 0, 1, 0, scm_force_output); +SCM_DEFINE (scm_port_closed_p, "port-closed?", 1, 0, 0, + (SCM port), + "Returns @code{#t} if @var{port} is closed or @code{#f} if it is open.") +#define FUNC_NAME s_scm_port_closed_p +{ + SCM_VALIDATE_PORT (1,port); + return SCM_NEGATE_BOOL(SCM_OPPORTP (port)); +} +#undef FUNC_NAME -SCM -scm_force_output (port) - SCM port; +SCM_DEFINE (scm_eof_object_p, "eof-object?", 1, 0, 0, + (SCM x), + "Returns @code{#t} if @var{x} is an end-of-file object; otherwise\n" + "returns @code{#f}.") +#define FUNC_NAME s_scm_eof_object_p +{ + return SCM_BOOL(SCM_EOF_OBJECT_P (x)); +} +#undef FUNC_NAME + +SCM_DEFINE (scm_force_output, "force-output", 0, 1, 0, + (SCM port), + "Flush the specified output port, or the current output port if @var{port}\n" + "is omitted. The current output buffer contents are passed to the \n" + "underlying port implementation (e.g., in the case of fports, the\n" + "data will be written to the file and the output buffer will be cleared.)\n" + "It has no effect on an unbuffered port.\n\n" + "The return value is unspecified.") +#define FUNC_NAME s_scm_force_output { if (SCM_UNBNDP (port)) port = scm_cur_outp; else { port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_OPOUTPORTP (port), port, SCM_ARG1, - s_force_output); + SCM_VALIDATE_OPOUTPORT (1,port); } - scm_fflush (port); + scm_flush (port); return SCM_UNSPECIFIED; } +#undef FUNC_NAME -SCM_PROC (s_flush_all_ports, "flush-all-ports", 0, 0, 0, scm_flush_all_ports); -SCM -scm_flush_all_ports (void) +SCM_DEFINE (scm_flush_all_ports, "flush-all-ports", 0, 0, 0, + (), + "Equivalent to calling @code{force-output} on\n" + "all open output ports. The return value is unspecified.") +#define FUNC_NAME s_scm_flush_all_ports { int i; for (i = 0; i < scm_port_table_size; i++) { if (SCM_OPOUTPORTP (scm_port_table[i]->port)) - scm_fflush (scm_port_table[i]->port); + scm_flush (scm_port_table[i]->port); } return SCM_UNSPECIFIED; } - -SCM_PROC(s_read_char, "read-char", 0, 1, 0, scm_read_char); - -SCM -scm_read_char (port) - SCM port; +#undef FUNC_NAME + +SCM_DEFINE (scm_read_char, "read-char", 0, 1, 0, + (SCM port), + "Returns the next character available from @var{port}, updating\n" + "@var{port} to point to the following character. If no more\n" + "characters are available, an end-of-file object is returned.") +#define FUNC_NAME s_scm_read_char { int c; if (SCM_UNBNDP (port)) port = scm_cur_inp; - else - SCM_ASSERT (SCM_NIMP (port) && SCM_OPINPORTP (port), port, SCM_ARG1, s_read_char); + SCM_VALIDATE_OPINPORT (1,port); c = scm_getc (port); if (EOF == c) return SCM_EOF_VAL; - return SCM_MAKICHR (c); + return SCM_MAKE_CHAR (c); } +#undef FUNC_NAME /* this should only be called when the read buffer is empty. it - tries to refill the buffer. it returns the first char from + tries to refill the read buffer. it returns the first char from the port, which is either EOF or *(pt->read_pos). */ int -scm_fill_buffer (SCM port) +scm_fill_input (SCM port) { scm_port *pt = SCM_PTAB_ENTRY (port); @@ -625,20 +908,19 @@ scm_fill_buffer (SCM port) if (pt->read_pos < pt->read_end) return *(pt->read_pos); } - return scm_ptobs[SCM_PTOBNUM (port)].fill_buffer (port); + return scm_ptobs[SCM_PTOBNUM (port)].fill_input (port); } int -scm_getc (port) - SCM port; +scm_getc (SCM port) { int c; scm_port *pt = SCM_PTAB_ENTRY (port); if (pt->rw_active == SCM_PORT_WRITE) { - /* may be marginally faster than calling scm_fflush. */ - scm_ptobs[SCM_PTOBNUM (port)].fflush (port); + /* may be marginally faster than calling scm_flush. */ + scm_ptobs[SCM_PTOBNUM (port)].flush (port); } if (pt->rw_random) @@ -646,7 +928,7 @@ scm_getc (port) if (pt->read_pos >= pt->read_end) { - if (scm_fill_buffer (port) == EOF) + if (scm_fill_input (port) == EOF) return EOF; } @@ -669,79 +951,27 @@ scm_getc (port) } void -scm_putc (c, port) - int c; - SCM port; +scm_putc (char c, SCM port) { - scm_port *pt = SCM_PTAB_ENTRY (port); - scm_ptobfuns *ptob = &scm_ptobs[SCM_PTOBNUM (port)]; - - if (pt->rw_active == SCM_PORT_READ) - scm_read_flush (port); - - *(pt->write_pos++) = (char) c; - - if (pt->write_pos == pt->write_end) - ptob->fflush (port); - - if (pt->rw_random) - pt->rw_active = SCM_PORT_WRITE; + scm_lfwrite (&c, 1, port); } void -scm_puts (s, port) - char *s; - SCM port; +scm_puts (const char *s, SCM port) { - scm_port *pt = SCM_PTAB_ENTRY (port); - scm_ptobfuns *ptob = &scm_ptobs[SCM_PTOBNUM (port)]; - - if (pt->rw_active == SCM_PORT_READ) - scm_read_flush (port); - - while (*s != 0) - { - *pt->write_pos++ = *s++; - if (pt->write_pos == pt->write_end) - ptob->fflush (port); - } - /* If the port is line-buffered, flush it. */ - if ((SCM_CAR (port) & SCM_BUFLINE) - && memchr (pt->write_buf, '\n', pt->write_pos - pt->write_buf)) - ptob->fflush (port); - - if (pt->rw_random) - pt->rw_active = SCM_PORT_WRITE; + scm_lfwrite (s, strlen (s), port); } void -scm_lfwrite (ptr, size, port) - char *ptr; - scm_sizet size; - SCM port; +scm_lfwrite (const char *ptr, scm_sizet size, SCM port) { scm_port *pt = SCM_PTAB_ENTRY (port); - scm_ptobfuns *ptob = &scm_ptobs[SCM_PTOBNUM (port)]; + scm_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (port)]; if (pt->rw_active == SCM_PORT_READ) - scm_read_flush (port); + scm_end_input (port); - while (size > 0) - { - int space = pt->write_end - pt->write_pos; - int write_len = (size > space) ? space : size; - - strncpy (pt->write_pos, ptr, write_len); - pt->write_pos += write_len; - size -= write_len; - ptr += write_len; - if (write_len == space) - ptob->fflush (port); - } - /* If the port is line-buffered, flush it. */ - if ((SCM_CAR (port) & SCM_BUFLINE) - && memchr (pt->write_buf, '\n', pt->write_pos - pt->write_buf)) - (ptob->fflush) (port); + ptob->write (port, ptr, size); if (pt->rw_random) pt->rw_active = SCM_PORT_WRITE; @@ -749,16 +979,14 @@ scm_lfwrite (ptr, size, port) void -scm_fflush (port) - SCM port; +scm_flush (SCM port) { scm_sizet i = SCM_PTOBNUM (port); - (scm_ptobs[i].fflush) (port); + (scm_ptobs[i].flush) (port); } void -scm_read_flush (port) - SCM port; +scm_end_input (SCM port) { int offset; scm_port *pt = SCM_PTAB_ENTRY (port); @@ -774,16 +1002,14 @@ scm_read_flush (port) else offset = 0; - scm_ptobs[SCM_PTOBNUM (port)].read_flush (port, offset); + scm_ptobs[SCM_PTOBNUM (port)].end_input (port, offset); } void -scm_ungetc (c, port) - int c; - SCM port; +scm_ungetc (int c, SCM port) { scm_port *pt = SCM_PTAB_ENTRY (port); @@ -823,7 +1049,8 @@ scm_ungetc (c, port) { if (pt->putback_buf == NULL) { - pt->putback_buf = (char *) malloc (pt->putback_buf_size); + pt->putback_buf + = (unsigned char *) malloc (SCM_INITIAL_PUTBACK_BUF_SIZE); if (pt->putback_buf == NULL) scm_memory_error ("scm_ungetc"); pt->putback_buf_size = SCM_INITIAL_PUTBACK_BUF_SIZE; @@ -857,10 +1084,7 @@ scm_ungetc (c, port) void -scm_ungets (s, n, port) - char *s; - int n; - SCM port; +scm_ungets (const char *s, int n, SCM port) { /* This is simple minded and inefficient, but unreading strings is * probably not a common operation, and remember that line and @@ -873,71 +1097,100 @@ scm_ungets (s, n, port) } -SCM_PROC(s_peek_char, "peek-char", 0, 1, 0, scm_peek_char); - -SCM -scm_peek_char (port) - SCM port; +SCM_DEFINE (scm_peek_char, "peek-char", 0, 1, 0, + (SCM port), + "Returns the next character available from @var{port},\n" + "@emph{without} updating @var{port} to point to the following\n" + "character. If no more characters are available, an end-of-file object\n" + "is returned.@footnote{The value returned by a call to @code{peek-char}\n" + "is the same as the value that would have been returned by a call to\n" + "@code{read-char} on the same port. The only difference is that the very\n" + "next call to @code{read-char} or @code{peek-char} on that\n" + "@var{port} will return the value returned by the preceding call to\n" + "@code{peek-char}. In particular, a call to @code{peek-char} on an\n" + "interactive port will hang waiting for input whenever a call to\n" + "@code{read-char} would have hung.}") +#define FUNC_NAME s_scm_peek_char { int c; if (SCM_UNBNDP (port)) port = scm_cur_inp; else - SCM_ASSERT (SCM_NIMP (port) && SCM_OPINPORTP (port), port, SCM_ARG1, s_peek_char); + SCM_VALIDATE_OPINPORT (1,port); c = scm_getc (port); if (EOF == c) return SCM_EOF_VAL; scm_ungetc (c, port); - return SCM_MAKICHR (c); + return SCM_MAKE_CHAR (c); } - -SCM_PROC (s_unread_char, "unread-char", 2, 0, 0, scm_unread_char); - -SCM -scm_unread_char (cobj, port) - SCM cobj; - SCM port; +#undef FUNC_NAME + +SCM_DEFINE (scm_unread_char, "unread-char", 1, 1, 0, + (SCM cobj, SCM port), + "Place @var{char} in @var{port} so that it will be read by the\n" + "next read operation. If called multiple times, the unread characters\n" + "will be read again in last-in first-out order. If @var{port} is\n" + "not supplied, the current input port is used.") +#define FUNC_NAME s_scm_unread_char { int c; - SCM_ASSERT (SCM_ICHRP (cobj), cobj, SCM_ARG1, s_unread_char); - + SCM_VALIDATE_CHAR (1,cobj); if (SCM_UNBNDP (port)) port = scm_cur_inp; else - SCM_ASSERT (SCM_NIMP (port) && SCM_OPINPORTP (port), port, SCM_ARG2, s_unread_char); + SCM_VALIDATE_OPINPORT (2,port); - - c = SCM_ICHR (cobj); + c = SCM_CHAR (cobj); scm_ungetc (c, port); return cobj; } - -SCM_PROC (s_unread_string, "unread-string", 2, 0, 0, scm_unread_string); - -SCM -scm_unread_string (str, port) - SCM str; - SCM port; +#undef FUNC_NAME + +SCM_DEFINE (scm_unread_string, "unread-string", 2, 0, 0, + (SCM str, SCM port), + "Place the string @var{str} in @var{port} so that its characters will be\n" + "read in subsequent read operations. If called multiple times, the\n" + "unread characters will be read again in last-in first-out order. If\n" + "@var{port} is not supplied, the current-input-port is used.") +#define FUNC_NAME s_scm_unread_string { - SCM_ASSERT (SCM_NIMP (str) && SCM_STRINGP (str), - str, SCM_ARG1, s_unread_string); - + SCM_VALIDATE_STRING (1,str); if (SCM_UNBNDP (port)) port = scm_cur_inp; else - SCM_ASSERT (SCM_NIMP (port) && SCM_OPINPORTP (port), - port, SCM_ARG2, s_unread_string); + SCM_VALIDATE_OPINPORT (2,port); - scm_ungets (SCM_ROUCHARS (str), SCM_LENGTH (str), port); + scm_ungets (SCM_STRING_CHARS (str), SCM_STRING_LENGTH (str), port); return str; } - -SCM_PROC (s_lseek, "lseek", 3, 0, 0, scm_lseek); -SCM -scm_lseek (SCM object, SCM offset, SCM whence) +#undef FUNC_NAME + +SCM_DEFINE (scm_seek, "seek", 3, 0, 0, + (SCM object, SCM offset, SCM whence), + "Sets the current position of @var{fd/port} to the integer @var{offset},\n" + "which is interpreted according to the value of @var{whence}.\n\n" + "One of the following variables should be supplied\n" + "for @var{whence}:\n" + "@defvar SEEK_SET\n" + "Seek from the beginning of the file.\n" + "@end defvar\n" + "@defvar SEEK_CUR\n" + "Seek from the current position.\n" + "@end defvar\n" + "@defvar SEEK_END\n" + "Seek from the end of the file.\n" + "@end defvar\n\n" + "If @var{fd/port} is a file descriptor, the underlying system call is\n" + "@code{lseek}. @var{port} may be a string port.\n\n" + "The value returned is the new position in the file. This means that\n" + "the current position of a port can be obtained using:\n" + "@smalllisp\n" + "(seek port 0 SEEK_CUR)\n" + "@end smalllisp") +#define FUNC_NAME s_scm_seek { off_t off; off_t rv; @@ -945,43 +1198,40 @@ scm_lseek (SCM object, SCM offset, SCM whence) object = SCM_COERCE_OUTPORT (object); - off = scm_num2long (offset, (char *)SCM_ARG2, s_lseek); - SCM_ASSERT (SCM_INUMP (whence), whence, SCM_ARG3, s_lseek); - how = SCM_INUM (whence); + off = SCM_NUM2LONG (2,offset); + SCM_VALIDATE_INUM_COPY (3,whence,how); if (how != SEEK_SET && how != SEEK_CUR && how != SEEK_END) - scm_out_of_range (s_lseek, whence); - if (SCM_NIMP (object) && SCM_OPPORTP (object)) + SCM_OUT_OF_RANGE (3, whence); + if (SCM_OPPORTP (object)) { - scm_port *pt = SCM_PTAB_ENTRY (object); - scm_ptobfuns *ptob = scm_ptobs + SCM_PTOBNUM (object); + scm_ptob_descriptor *ptob = scm_ptobs + SCM_PTOBNUM (object); if (!ptob->seek) - scm_misc_error (s_lseek, "port is not seekable", - scm_cons (object, SCM_EOL)); + SCM_MISC_ERROR ("port is not seekable", + scm_cons (object, SCM_EOL)); else - { - if (pt->rw_active == SCM_PORT_READ) - scm_read_flush (object); - else if (pt->rw_active == SCM_PORT_WRITE) - ptob->fflush (object); - - rv = ptob->seek (object, off, how); - } + rv = ptob->seek (object, off, how); } else /* file descriptor?. */ { - SCM_ASSERT (SCM_INUMP (object), object, SCM_ARG1, s_lseek); + SCM_VALIDATE_INUM (1,object); rv = lseek (SCM_INUM (object), off, how); if (rv == -1) - scm_syserror (s_lseek); + SCM_SYSERROR; } return scm_long2num (rv); } - -SCM_PROC (s_truncate_file, "truncate-file", 1, 1, 0, scm_truncate_file); - -SCM -scm_truncate_file (SCM object, SCM length) +#undef FUNC_NAME + +SCM_DEFINE (scm_truncate_file, "truncate-file", 1, 1, 0, + (SCM object, SCM length), + "Truncates the object referred to by @var{obj} to at most @var{size} bytes.\n" + "@var{obj} can be a string containing a file name or an integer file\n" + "descriptor or a port. @var{size} may be omitted if @var{obj} is not\n" + "a file name, in which case the truncation occurs at the current port.\n" + "position.\n\n" + "The return value is unspecified.") +#define FUNC_NAME s_scm_truncate_file { int rv; off_t c_length; @@ -991,248 +1241,193 @@ scm_truncate_file (SCM object, SCM length) if (SCM_UNBNDP (length)) { /* must supply length if object is a filename. */ - if (SCM_NIMP (object) && SCM_ROSTRINGP (object)) - scm_wrong_num_args (scm_makfrom0str (s_truncate_file)); + if (SCM_STRINGP (object)) + SCM_MISC_ERROR("must supply length if OBJECT is a filename",SCM_EOL); - length = scm_lseek (object, SCM_INUM0, SCM_MAKINUM (SEEK_CUR)); + length = scm_seek (object, SCM_INUM0, SCM_MAKINUM (SEEK_CUR)); } - c_length = scm_num2long (length, (char *)SCM_ARG2, s_truncate_file); + c_length = SCM_NUM2LONG (2,length); if (c_length < 0) - scm_misc_error (s_truncate_file, "negative offset", SCM_EOL); + SCM_MISC_ERROR ("negative offset", SCM_EOL); object = SCM_COERCE_OUTPORT (object); if (SCM_INUMP (object)) { SCM_SYSCALL (rv = ftruncate (SCM_INUM (object), c_length)); } - else if (SCM_NIMP (object) && SCM_OPOUTPORTP (object)) + else if (SCM_OPOUTPORTP (object)) { scm_port *pt = SCM_PTAB_ENTRY (object); - scm_ptobfuns *ptob = scm_ptobs + SCM_PTOBNUM (object); + scm_ptob_descriptor *ptob = scm_ptobs + SCM_PTOBNUM (object); - if (!ptob->ftruncate) - scm_misc_error (s_truncate_file, "port is not truncatable", SCM_EOL); + if (!ptob->truncate) + SCM_MISC_ERROR ("port is not truncatable", SCM_EOL); if (pt->rw_active == SCM_PORT_READ) - scm_read_flush (object); + scm_end_input (object); else if (pt->rw_active == SCM_PORT_WRITE) - ptob->fflush (object); + ptob->flush (object); - ptob->ftruncate (object, c_length); + ptob->truncate (object, c_length); rv = 0; } else { - SCM_ASSERT (SCM_NIMP (object) && SCM_ROSTRINGP (object), - object, SCM_ARG1, s_truncate_file); - SCM_COERCE_SUBSTR (object); - SCM_SYSCALL (rv = truncate (SCM_ROCHARS (object), c_length)); + SCM_VALIDATE_STRING (1, object); + SCM_STRING_COERCE_0TERMINATION_X (object); + SCM_SYSCALL (rv = truncate (SCM_STRING_CHARS (object), c_length)); } if (rv == -1) - scm_syserror (s_truncate_file); + SCM_SYSERROR; return SCM_UNSPECIFIED; } +#undef FUNC_NAME -SCM_PROC (s_port_line, "port-line", 1, 0, 0, scm_port_line); - -SCM -scm_port_line (port) - SCM port; +SCM_DEFINE (scm_port_line, "port-line", 1, 0, 0, + (SCM port), + "Return the current line number for PORT.") +#define FUNC_NAME s_scm_port_line { port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port) && SCM_OPENP (port), - port, - SCM_ARG1, - s_port_line); + SCM_VALIDATE_OPENPORT (1,port); return SCM_MAKINUM (SCM_LINUM (port)); } +#undef FUNC_NAME -SCM_PROC (s_set_port_line_x, "set-port-line!", 2, 0, 0, scm_set_port_line_x); - -SCM -scm_set_port_line_x (port, line) - SCM port; - SCM line; +SCM_DEFINE (scm_set_port_line_x, "set-port-line!", 2, 0, 0, + (SCM port, SCM line), + "Set the current line number for PORT to LINE.") +#define FUNC_NAME s_scm_set_port_line_x { port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port) && SCM_OPENP (port), - port, - SCM_ARG1, - s_set_port_line_x); - SCM_ASSERT (SCM_INUMP (line), line, SCM_ARG2, s_set_port_line_x); - return SCM_PTAB_ENTRY (port)->line_number = SCM_INUM (line); + SCM_VALIDATE_OPENPORT (1,port); + SCM_VALIDATE_INUM (2,line); + SCM_PTAB_ENTRY (port)->line_number = SCM_INUM (line); + return SCM_UNSPECIFIED; } - -SCM_PROC (s_port_column, "port-column", 1, 0, 0, scm_port_column); - -SCM -scm_port_column (port) - SCM port; +#undef FUNC_NAME + +SCM_DEFINE (scm_port_column, "port-column", 1, 0, 0, + (SCM port), + "@deffnx primitive port-line [input-port]\n" + "Return the current column number or line number of @var{input-port},\n" + "using the current input port if none is specified. If the number is\n" + "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n" + "- i.e. the first character of the first line is line 0, column 0.\n" + "(However, when you display a file position, for example in an error\n" + "message, we recommand you add 1 to get 1-origin integers. This is\n" + "because lines and column numbers traditionally start with 1, and that is\n" + "what non-programmers will find most natural.)") +#define FUNC_NAME s_scm_port_column { port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port) && SCM_OPENP (port), - port, - SCM_ARG1, - s_port_column); + SCM_VALIDATE_OPENPORT (1,port); return SCM_MAKINUM (SCM_COL (port)); } - -SCM_PROC (s_set_port_column_x, "set-port-column!", 2, 0, 0, scm_set_port_column_x); - -SCM -scm_set_port_column_x (port, column) - SCM port; - SCM column; +#undef FUNC_NAME + +SCM_DEFINE (scm_set_port_column_x, "set-port-column!", 2, 0, 0, + (SCM port, SCM column), + "@deffnx primitive set-port-line! port line\n" + "Set the current column or line number of @var{port}, using the\n" + "current input port if none is specified.") +#define FUNC_NAME s_scm_set_port_column_x { port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port) && SCM_OPENP (port), - port, - SCM_ARG1, - s_set_port_column_x); - SCM_ASSERT (SCM_INUMP (column), column, SCM_ARG2, s_set_port_column_x); - return SCM_PTAB_ENTRY (port)->column_number = SCM_INUM (column); + SCM_VALIDATE_OPENPORT (1,port); + SCM_VALIDATE_INUM (2,column); + SCM_PTAB_ENTRY (port)->column_number = SCM_INUM (column); + return SCM_UNSPECIFIED; } - -SCM_PROC (s_port_filename, "port-filename", 1, 0, 0, scm_port_filename); - -SCM -scm_port_filename (port) - SCM port; +#undef FUNC_NAME + +SCM_DEFINE (scm_port_filename, "port-filename", 1, 0, 0, + (SCM port), + "Return the filename associated with @var{port}. This function returns\n" + "the strings \"standard input\", \"standard output\" and \"standard error\"\n" + "when called on the current input, output and error ports respectively.") +#define FUNC_NAME s_scm_port_filename { port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port) && SCM_OPENP (port), - port, - SCM_ARG1, - s_port_filename); - return SCM_PTAB_ENTRY (port)->file_name; + SCM_VALIDATE_OPENPORT (1,port); + return SCM_FILENAME (port); } - -SCM_PROC (s_set_port_filename_x, "set-port-filename!", 2, 0, 0, scm_set_port_filename_x); - -SCM -scm_set_port_filename_x (port, filename) - SCM port; - SCM filename; +#undef FUNC_NAME + +SCM_DEFINE (scm_set_port_filename_x, "set-port-filename!", 2, 0, 0, + (SCM port, SCM filename), + "Change the filename associated with @var{port}, using the current input\n" + "port if none is specified. Note that this does not change the port's\n" + "source of data, but only the value that is returned by\n" + "@code{port-filename} and reported in diagnostic output.") +#define FUNC_NAME s_scm_set_port_filename_x { port = SCM_COERCE_OUTPORT (port); - SCM_ASSERT (SCM_NIMP (port) && SCM_PORTP (port) && SCM_OPENP (port), - port, - SCM_ARG1, - s_set_port_filename_x); + SCM_VALIDATE_OPENPORT (1,port); /* We allow the user to set the filename to whatever he likes. */ - return SCM_PTAB_ENTRY (port)->file_name = filename; + SCM_SET_FILENAME (port, filename); + return SCM_UNSPECIFIED; } +#undef FUNC_NAME #ifndef ttyname extern char * ttyname(); #endif +void +scm_print_port_mode (SCM exp, SCM port) +{ + scm_puts (SCM_CLOSEDP (exp) + ? "closed: " + : (SCM_RDNG & SCM_CELL_WORD_0 (exp) + ? (SCM_WRTNG & SCM_CELL_WORD_0 (exp) + ? "input-output: " + : "input: ") + : (SCM_WRTNG & SCM_CELL_WORD_0 (exp) + ? "output: " + : "bogus: ")), + port); +} -void -scm_prinport (exp, port, type) - SCM exp; - SCM port; - char *type; +int +scm_port_print (SCM exp, SCM port, scm_print_state *pstate) { + char *type = SCM_PTOBNAME (SCM_PTOBNUM (exp)); + if (!type) + type = "port"; scm_puts ("#<", port); - if (SCM_CLOSEDP (exp)) - scm_puts ("closed: ", port); - else - { - if (SCM_RDNG & SCM_CAR (exp)) - scm_puts ("input: ", port); - if (SCM_WRTNG & SCM_CAR (exp)) - scm_puts ("output: ", port); - } + scm_print_port_mode (exp, port); scm_puts (type, port); scm_putc (' ', port); - if (SCM_OPFPORTP (exp)) - { - int fdes = (SCM_FSTREAM (exp))->fdes; - - if (isatty (fdes)) - scm_puts (ttyname (fdes), port); - else - scm_intprint (fdes, 10, port); - } - else - { - scm_intprint (SCM_CDR (exp), 16, port); - } + scm_intprint (SCM_CELL_WORD_1 (exp), 16, port); scm_putc ('>', port); + return 1; } - void scm_ports_prehistory () { scm_numptob = 0; - scm_ptobs = (scm_ptobfuns *) malloc (sizeof (scm_ptobfuns)); - - /* WARNING: These scm_newptob calls must be done in this order. - * They must agree with the port declarations in tags.h. - */ - /* scm_tc16_fport = */ scm_newptob (&scm_fptob); - /* scm_tc16_pipe was here */ scm_newptob (&scm_fptob); /* dummy. */ - /* scm_tc16_strport = */ scm_newptob (&scm_stptob); - /* scm_tc16_sfport = */ scm_newptob (&scm_sfptob); + scm_ptobs = (scm_ptob_descriptor *) malloc (sizeof (scm_ptob_descriptor)); } /* Void ports. */ -int scm_tc16_void_port = 0; - -static int -print_void_port (SCM exp, SCM port, scm_print_state *pstate) -{ - scm_prinport (exp, port, "void"); - return 1; -} +scm_bits_t scm_tc16_void_port = 0; -static void -flush_void_port (SCM port) +static int fill_input_void_port (SCM port) { + return EOF; } static void -read_flush_void_port (SCM port, int offset) +write_void_port (SCM port, const void *data, size_t size) { } -static int -close_void_port (SCM port) -{ - return 0; /* this is ignored by scm_close_port. */ -} - - - -static int -noop0 (SCM stream) -{ - return 0; -} - - -static struct scm_ptobfuns void_port_ptob = -{ - 0, - noop0, - print_void_port, - 0, /* equal? */ - flush_void_port, - read_flush_void_port, - close_void_port, - 0, - 0, - 0, - 0, -}; - SCM -scm_void_port (mode_str) - char * mode_str; +scm_void_port (char *mode_str) { int mode_bits; SCM answer; @@ -1242,26 +1437,27 @@ scm_void_port (mode_str) SCM_DEFER_INTS; mode_bits = scm_mode_bits (mode_str); pt = scm_add_to_port_table (answer); + scm_port_non_buffer (pt); SCM_SETPTAB_ENTRY (answer, pt); SCM_SETSTREAM (answer, 0); - SCM_SETCAR (answer, scm_tc16_void_port | mode_bits); + SCM_SET_CELL_TYPE (answer, scm_tc16_void_port | mode_bits); SCM_ALLOW_INTS; return answer; } - -SCM_PROC (s_sys_make_void_port, "%make-void-port", 1, 0, 0, scm_sys_make_void_port); - -SCM -scm_sys_make_void_port (mode) - SCM mode; +SCM_DEFINE (scm_sys_make_void_port, "%make-void-port", 1, 0, 0, + (SCM mode), + "Create and return a new void port. A void port acts like\n" + "/dev/null. The @var{mode} argument\n" + "specifies the input/output modes for this port: see the\n" + "documentation for @code{open-file} in @ref{File Ports}.") +#define FUNC_NAME s_scm_sys_make_void_port { - SCM_ASSERT (SCM_NIMP (mode) && SCM_ROSTRINGP (mode), mode, - SCM_ARG1, s_sys_make_void_port); - - SCM_COERCE_SUBSTR (mode); - return scm_void_port (SCM_ROCHARS (mode)); + SCM_VALIDATE_STRING (1, mode); + SCM_STRING_COERCE_0TERMINATION_X (mode); + return scm_void_port (SCM_STRING_CHARS (mode)); } +#undef FUNC_NAME /* Initialization. */ @@ -1274,6 +1470,15 @@ scm_init_ports () scm_sysintern ("SEEK_CUR", SCM_MAKINUM (SEEK_CUR)); scm_sysintern ("SEEK_END", SCM_MAKINUM (SEEK_END)); - scm_tc16_void_port = scm_newptob (&void_port_ptob); -#include "ports.x" + scm_tc16_void_port = scm_make_port_type ("void", fill_input_void_port, + write_void_port); +#ifndef SCM_MAGIC_SNARFER +#include "libguile/ports.x" +#endif } + +/* + Local Variables: + c-file-style: "gnu" + End: +*/