1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2003, 2004, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 #define _LARGEFILE64_SOURCE /* ask for stat64 etc */
31 #include <fcntl.h> /* for chsize on mingw */
34 #include "libguile/_scm.h"
35 #include "libguile/async.h"
36 #include "libguile/eval.h"
37 #include "libguile/fports.h" /* direct access for seek and truncate */
38 #include "libguile/objects.h"
39 #include "libguile/goops.h"
40 #include "libguile/smob.h"
41 #include "libguile/chars.h"
42 #include "libguile/dynwind.h"
44 #include "libguile/keywords.h"
45 #include "libguile/hashtab.h"
46 #include "libguile/root.h"
47 #include "libguile/strings.h"
48 #include "libguile/mallocs.h"
49 #include "libguile/validate.h"
50 #include "libguile/ports.h"
51 #include "libguile/vectors.h"
52 #include "libguile/weaks.h"
53 #include "libguile/fluids.h"
71 #ifdef HAVE_SYS_IOCTL_H
72 #include <sys/ioctl.h>
75 /* Mingw (version 3.4.5, circa 2006) has ftruncate as an alias for chsize
76 already, but have this code here in case that wasn't so in past versions,
77 or perhaps to help other minimal DOS environments.
79 gnulib ftruncate.c has code using fcntl F_CHSIZE and F_FREESP, which
80 might be possibilities if we've got other systems without ftruncate. */
82 #if HAVE_CHSIZE && ! HAVE_FTRUNCATE
83 #define ftruncate(fd, size) chsize (fd, size)
85 #define HAVE_FTRUNCATE 1
89 /* The port kind table --- a dynamically resized array of port types. */
92 /* scm_ptobs scm_numptob
93 * implement a dynamically resized array of ptob records.
94 * Indexes into this table are used when generating type
95 * tags for smobjects (if you know a tag you can get an index and conversely).
97 scm_t_ptob_descriptor
*scm_ptobs
;
100 /* GC marker for a port with stream of SCM type. */
102 scm_markstream (SCM ptr
)
105 openp
= SCM_CELL_WORD_0 (ptr
) & SCM_OPN
;
107 return SCM_PACK (SCM_STREAM (ptr
));
113 * We choose to use an interface similar to the smob interface with
114 * fill_input and write as standard fields, passed to the port
115 * type constructor, and optional fields set by setters.
119 flush_port_default (SCM port SCM_UNUSED
)
124 end_input_default (SCM port SCM_UNUSED
, int offset SCM_UNUSED
)
129 scm_port_free0 (SCM port
)
135 scm_make_port_type (char *name
,
136 int (*fill_input
) (SCM port
),
137 void (*write
) (SCM port
, const void *data
, size_t size
))
140 if (SCM_I_MAX_PORT_TYPE_COUNT
- 1 <= scm_numptob
)
142 SCM_CRITICAL_SECTION_START
;
143 SCM_SYSCALL (tmp
= (char *) realloc ((char *) scm_ptobs
,
145 * sizeof (scm_t_ptob_descriptor
)));
148 scm_ptobs
= (scm_t_ptob_descriptor
*) tmp
;
150 scm_ptobs
[scm_numptob
].name
= name
;
151 scm_ptobs
[scm_numptob
].mark
= 0;
152 scm_ptobs
[scm_numptob
].free
= scm_port_free0
;
153 scm_ptobs
[scm_numptob
].print
= scm_port_print
;
154 scm_ptobs
[scm_numptob
].equalp
= 0;
155 scm_ptobs
[scm_numptob
].close
= 0;
157 scm_ptobs
[scm_numptob
].write
= write
;
158 scm_ptobs
[scm_numptob
].flush
= flush_port_default
;
160 scm_ptobs
[scm_numptob
].end_input
= end_input_default
;
161 scm_ptobs
[scm_numptob
].fill_input
= fill_input
;
162 scm_ptobs
[scm_numptob
].input_waiting
= 0;
164 scm_ptobs
[scm_numptob
].seek
= 0;
165 scm_ptobs
[scm_numptob
].truncate
= 0;
169 SCM_CRITICAL_SECTION_END
;
173 scm_memory_error ("scm_make_port_type");
175 /* Make a class object if Goops is present */
176 if (SCM_UNPACK (scm_port_class
[0]) != 0)
177 scm_make_port_classes (scm_numptob
- 1, SCM_PTOBNAME (scm_numptob
- 1));
178 return scm_tc7_port
+ (scm_numptob
- 1) * 256;
182 scm_set_port_mark (scm_t_bits tc
, SCM (*mark
) (SCM
))
184 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].mark
= mark
;
188 scm_set_port_free (scm_t_bits tc
, size_t (*free
) (SCM
))
190 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].free
= free
;
194 scm_set_port_print (scm_t_bits tc
, int (*print
) (SCM exp
, SCM port
,
195 scm_print_state
*pstate
))
197 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].print
= print
;
201 scm_set_port_equalp (scm_t_bits tc
, SCM (*equalp
) (SCM
, SCM
))
203 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].equalp
= equalp
;
207 scm_set_port_flush (scm_t_bits tc
, void (*flush
) (SCM port
))
209 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].flush
= flush
;
213 scm_set_port_end_input (scm_t_bits tc
, void (*end_input
) (SCM port
, int offset
))
215 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].end_input
= end_input
;
219 scm_set_port_close (scm_t_bits tc
, int (*close
) (SCM
))
221 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].close
= close
;
225 scm_set_port_seek (scm_t_bits tc
,
226 scm_t_off (*seek
) (SCM
, scm_t_off
, int))
228 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].seek
= seek
;
232 scm_set_port_truncate (scm_t_bits tc
, void (*truncate
) (SCM
, scm_t_off
))
234 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].truncate
= truncate
;
238 scm_set_port_input_waiting (scm_t_bits tc
, int (*input_waiting
) (SCM
))
240 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].input_waiting
= input_waiting
;
245 SCM_DEFINE (scm_char_ready_p
, "char-ready?", 0, 1, 0,
247 "Return @code{#t} if a character is ready on input @var{port}\n"
248 "and return @code{#f} otherwise. If @code{char-ready?} returns\n"
249 "@code{#t} then the next @code{read-char} operation on\n"
250 "@var{port} is guaranteed not to hang. If @var{port} is a file\n"
251 "port at end of file then @code{char-ready?} returns @code{#t}.\n"
253 "@code{char-ready?} exists to make it possible for a\n"
254 "program to accept characters from interactive ports without\n"
255 "getting stuck waiting for input. Any input editors associated\n"
256 "with such ports must make sure that characters whose existence\n"
257 "has been asserted by @code{char-ready?} cannot be rubbed out.\n"
258 "If @code{char-ready?} were to return @code{#f} at end of file,\n"
259 "a port at end of file would be indistinguishable from an\n"
260 "interactive port that has no ready characters.")
261 #define FUNC_NAME s_scm_char_ready_p
265 if (SCM_UNBNDP (port
))
266 port
= scm_current_input_port ();
268 SCM_VALIDATE_OPINPORT (1, port
);
270 pt
= SCM_PTAB_ENTRY (port
);
272 /* if the current read buffer is filled, or the
273 last pushed-back char has been read and the saved buffer is
274 filled, result is true. */
275 if (pt
->read_pos
< pt
->read_end
276 || (pt
->read_buf
== pt
->putback_buf
277 && pt
->saved_read_pos
< pt
->saved_read_end
))
281 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
283 if (ptob
->input_waiting
)
284 return scm_from_bool(ptob
->input_waiting (port
));
291 /* move up to read_len chars from port's putback and/or read buffers
292 into memory starting at dest. returns the number of chars moved. */
293 size_t scm_take_from_input_buffers (SCM port
, char *dest
, size_t read_len
)
295 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
296 size_t chars_read
= 0;
297 size_t from_buf
= min (pt
->read_end
- pt
->read_pos
, read_len
);
301 memcpy (dest
, pt
->read_pos
, from_buf
);
302 pt
->read_pos
+= from_buf
;
303 chars_read
+= from_buf
;
304 read_len
-= from_buf
;
308 /* if putback was active, try the real input buffer too. */
309 if (pt
->read_buf
== pt
->putback_buf
)
311 from_buf
= min (pt
->saved_read_end
- pt
->saved_read_pos
, read_len
);
314 memcpy (dest
, pt
->saved_read_pos
, from_buf
);
315 pt
->saved_read_pos
+= from_buf
;
316 chars_read
+= from_buf
;
322 /* Clear a port's read buffers, returning the contents. */
323 SCM_DEFINE (scm_drain_input
, "drain-input", 1, 0, 0,
325 "This procedure clears a port's input buffers, similar\n"
326 "to the way that force-output clears the output buffer. The\n"
327 "contents of the buffers are returned as a single string, e.g.,\n"
330 "(define p (open-input-file ...))\n"
331 "(drain-input p) => empty string, nothing buffered yet.\n"
332 "(unread-char (read-char p) p)\n"
333 "(drain-input p) => initial chars from p, up to the buffer size.\n"
335 "Draining the buffers may be useful for cleanly finishing\n"
336 "buffered I/O so that the file descriptor can be used directly\n"
337 "for further input.")
338 #define FUNC_NAME s_scm_drain_input
345 SCM_VALIDATE_OPINPORT (1, port
);
346 pt
= SCM_PTAB_ENTRY (port
);
348 count
= pt
->read_end
- pt
->read_pos
;
349 if (pt
->read_buf
== pt
->putback_buf
)
350 count
+= pt
->saved_read_end
- pt
->saved_read_pos
;
352 result
= scm_i_make_string (count
, &data
);
353 scm_take_from_input_buffers (port
, data
, count
);
359 /* Standard ports --- current input, output, error, and more(!). */
361 static SCM cur_inport_fluid
;
362 static SCM cur_outport_fluid
;
363 static SCM cur_errport_fluid
;
364 static SCM cur_loadport_fluid
;
366 SCM_DEFINE (scm_current_input_port
, "current-input-port", 0, 0, 0,
368 "Return the current input port. This is the default port used\n"
369 "by many input procedures. Initially, @code{current-input-port}\n"
370 "returns the @dfn{standard input} in Unix and C terminology.")
371 #define FUNC_NAME s_scm_current_input_port
373 return scm_fluid_ref (cur_inport_fluid
);
377 SCM_DEFINE (scm_current_output_port
, "current-output-port", 0, 0, 0,
379 "Return the current output port. This is the default port used\n"
380 "by many output procedures. Initially,\n"
381 "@code{current-output-port} returns the @dfn{standard output} in\n"
382 "Unix and C terminology.")
383 #define FUNC_NAME s_scm_current_output_port
385 return scm_fluid_ref (cur_outport_fluid
);
389 SCM_DEFINE (scm_current_error_port
, "current-error-port", 0, 0, 0,
391 "Return the port to which errors and warnings should be sent (the\n"
392 "@dfn{standard error} in Unix and C terminology).")
393 #define FUNC_NAME s_scm_current_error_port
395 return scm_fluid_ref (cur_errport_fluid
);
399 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
401 "Return the current-load-port.\n"
402 "The load port is used internally by @code{primitive-load}.")
403 #define FUNC_NAME s_scm_current_load_port
405 return scm_fluid_ref (cur_loadport_fluid
);
409 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
411 "@deffnx {Scheme Procedure} set-current-output-port port\n"
412 "@deffnx {Scheme Procedure} set-current-error-port port\n"
413 "Change the ports returned by @code{current-input-port},\n"
414 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
415 "so that they use the supplied @var{port} for input or output.")
416 #define FUNC_NAME s_scm_set_current_input_port
418 SCM oinp
= scm_fluid_ref (cur_inport_fluid
);
419 SCM_VALIDATE_OPINPORT (1, port
);
420 scm_fluid_set_x (cur_inport_fluid
, port
);
426 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
428 "Set the current default output port to @var{port}.")
429 #define FUNC_NAME s_scm_set_current_output_port
431 SCM ooutp
= scm_fluid_ref (cur_outport_fluid
);
432 port
= SCM_COERCE_OUTPORT (port
);
433 SCM_VALIDATE_OPOUTPORT (1, port
);
434 scm_fluid_set_x (cur_outport_fluid
, port
);
440 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
442 "Set the current default error port to @var{port}.")
443 #define FUNC_NAME s_scm_set_current_error_port
445 SCM oerrp
= scm_fluid_ref (cur_errport_fluid
);
446 port
= SCM_COERCE_OUTPORT (port
);
447 SCM_VALIDATE_OPOUTPORT (1, port
);
448 scm_fluid_set_x (cur_errport_fluid
, port
);
454 scm_dynwind_current_input_port (SCM port
)
455 #define FUNC_NAME NULL
457 SCM_VALIDATE_OPINPORT (1, port
);
458 scm_dynwind_fluid (cur_inport_fluid
, port
);
463 scm_dynwind_current_output_port (SCM port
)
464 #define FUNC_NAME NULL
466 port
= SCM_COERCE_OUTPORT (port
);
467 SCM_VALIDATE_OPOUTPORT (1, port
);
468 scm_dynwind_fluid (cur_outport_fluid
, port
);
473 scm_dynwind_current_error_port (SCM port
)
474 #define FUNC_NAME NULL
476 port
= SCM_COERCE_OUTPORT (port
);
477 SCM_VALIDATE_OPOUTPORT (1, port
);
478 scm_dynwind_fluid (cur_errport_fluid
, port
);
483 scm_i_dynwind_current_load_port (SCM port
)
485 scm_dynwind_fluid (cur_loadport_fluid
, port
);
489 /* The port table --- an array of pointers to ports. */
492 We need a global registry of ports to flush them all at exit, and to
493 get all the ports matching a file descriptor.
495 SCM scm_i_port_weak_hash
;
497 scm_i_pthread_mutex_t scm_i_port_table_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
499 /* This function is not and should not be thread safe. */
502 scm_new_port_table_entry (scm_t_bits tag
)
503 #define FUNC_NAME "scm_new_port_table_entry"
506 We initialize the cell to empty, this is in case scm_gc_calloc
507 triggers GC ; we don't want the GC to scan a half-finished Z.
510 SCM z
= scm_cons (SCM_EOL
, SCM_EOL
);
511 scm_t_port
*entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
513 entry
->file_name
= SCM_BOOL_F
;
514 entry
->rw_active
= SCM_PORT_NEITHER
;
517 SCM_SET_CELL_TYPE (z
, tag
);
518 SCM_SETPTAB_ENTRY (z
, entry
);
520 scm_hashq_set_x (scm_i_port_weak_hash
, z
, SCM_BOOL_F
);
526 #if SCM_ENABLE_DEPRECATED==1
528 scm_add_to_port_table (SCM port
)
530 SCM z
= scm_new_port_table_entry (scm_tc7_port
);
531 scm_t_port
* pt
= SCM_PTAB_ENTRY(z
);
534 SCM_SETCAR (z
, SCM_EOL
);
535 SCM_SETCDR (z
, SCM_EOL
);
536 SCM_SETPTAB_ENTRY (port
, pt
);
542 /* Remove a port from the table and destroy it. */
544 /* This function is not and should not be thread safe. */
546 scm_i_remove_port (SCM port
)
547 #define FUNC_NAME "scm_remove_port"
549 scm_t_port
*p
= SCM_PTAB_ENTRY (port
);
551 scm_gc_free (p
->putback_buf
, p
->putback_buf_size
, "putback buffer");
552 scm_gc_free (p
, sizeof (scm_t_port
), "port");
554 SCM_SETPTAB_ENTRY (port
, 0);
555 scm_hashq_remove_x (scm_i_port_weak_hash
, port
);
560 /* Functions for debugging. */
562 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
564 "Return the number of ports in the port table. @code{pt-size}\n"
565 "is only included in @code{--enable-guile-debug} builds.")
566 #define FUNC_NAME s_scm_pt_size
568 return scm_from_int (SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
));
574 scm_port_non_buffer (scm_t_port
*pt
)
576 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
577 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
578 pt
->read_buf_size
= pt
->write_buf_size
= 1;
579 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
583 /* Revealed counts --- an oddity inherited from SCSH. */
585 /* Find a port in the table and return its revealed count.
586 Also used by the garbage collector.
590 scm_revealed_count (SCM port
)
592 return SCM_REVEALED(port
);
597 /* Return the revealed count for a port. */
599 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
601 "Return the revealed count for @var{port}.")
602 #define FUNC_NAME s_scm_port_revealed
604 port
= SCM_COERCE_OUTPORT (port
);
605 SCM_VALIDATE_OPENPORT (1, port
);
606 return scm_from_int (scm_revealed_count (port
));
610 /* Set the revealed count for a port. */
611 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
612 (SCM port
, SCM rcount
),
613 "Sets the revealed count for a port to a given value.\n"
614 "The return value is unspecified.")
615 #define FUNC_NAME s_scm_set_port_revealed_x
617 port
= SCM_COERCE_OUTPORT (port
);
618 SCM_VALIDATE_OPENPORT (1, port
);
619 SCM_REVEALED (port
) = scm_to_int (rcount
);
620 return SCM_UNSPECIFIED
;
626 /* Retrieving a port's mode. */
628 /* Return the flags that characterize a port based on the mode
629 * string used to open a file for that port.
631 * See PORT FLAGS in scm.h
635 scm_i_mode_bits_n (const char *modes
, size_t n
)
638 | (memchr (modes
, 'r', n
) || memchr (modes
, '+', n
) ? SCM_RDNG
: 0)
639 | ( memchr (modes
, 'w', n
)
640 || memchr (modes
, 'a', n
)
641 || memchr (modes
, '+', n
) ? SCM_WRTNG
: 0)
642 | (memchr (modes
, '0', n
) ? SCM_BUF0
: 0)
643 | (memchr (modes
, 'l', n
) ? SCM_BUFLINE
: 0));
647 scm_mode_bits (char *modes
)
649 return scm_i_mode_bits_n (modes
, strlen (modes
));
653 scm_i_mode_bits (SCM modes
)
657 if (!scm_is_string (modes
))
658 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
660 bits
= scm_i_mode_bits_n (scm_i_string_chars (modes
),
661 scm_i_string_length (modes
));
662 scm_remember_upto_here_1 (modes
);
666 /* Return the mode flags from an open port.
667 * Some modes such as "append" are only used when opening
668 * a file and are not returned here. */
670 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
672 "Return the port modes associated with the open port @var{port}.\n"
673 "These will not necessarily be identical to the modes used when\n"
674 "the port was opened, since modes such as \"append\" which are\n"
675 "used only during port creation are not retained.")
676 #define FUNC_NAME s_scm_port_mode
681 port
= SCM_COERCE_OUTPORT (port
);
682 SCM_VALIDATE_OPPORT (1, port
);
683 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
684 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
685 strcpy (modes
, "r+");
689 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
691 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
693 return scm_from_locale_string (modes
);
702 * Call the close operation on a port object.
703 * see also scm_close.
705 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
707 "Close the specified port object. Return @code{#t} if it\n"
708 "successfully closes a port or @code{#f} if it was already\n"
709 "closed. An exception may be raised if an error occurs, for\n"
710 "example when flushing buffered output. See also @ref{Ports and\n"
711 "File Descriptors, close}, for a procedure which can close file\n"
713 #define FUNC_NAME s_scm_close_port
718 port
= SCM_COERCE_OUTPORT (port
);
720 SCM_VALIDATE_PORT (1, port
);
721 if (SCM_CLOSEDP (port
))
723 i
= SCM_PTOBNUM (port
);
724 if (scm_ptobs
[i
].close
)
725 rv
= (scm_ptobs
[i
].close
) (port
);
728 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
729 scm_i_remove_port (port
);
730 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
731 SCM_CLR_PORT_OPEN_FLAG (port
);
732 return scm_from_bool (rv
>= 0);
736 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
738 "Close the specified input port object. The routine has no effect if\n"
739 "the file has already been closed. An exception may be raised if an\n"
740 "error occurs. The value returned is unspecified.\n\n"
741 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
742 "which can close file descriptors.")
743 #define FUNC_NAME s_scm_close_input_port
745 SCM_VALIDATE_INPUT_PORT (1, port
);
746 scm_close_port (port
);
747 return SCM_UNSPECIFIED
;
751 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
753 "Close the specified output port object. The routine has no effect if\n"
754 "the file has already been closed. An exception may be raised if an\n"
755 "error occurs. The value returned is unspecified.\n\n"
756 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
757 "which can close file descriptors.")
758 #define FUNC_NAME s_scm_close_output_port
760 port
= SCM_COERCE_OUTPORT (port
);
761 SCM_VALIDATE_OUTPUT_PORT (1, port
);
762 scm_close_port (port
);
763 return SCM_UNSPECIFIED
;
768 scm_i_collect_keys_in_vector (void *closure
, SCM key
, SCM value
, SCM result
)
770 int *i
= (int*) closure
;
771 scm_c_vector_set_x (result
, *i
, key
);
778 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
784 /* Even without pre-emptive multithreading, running arbitrary code
785 while scanning the port table is unsafe because the port table
786 can change arbitrarily (from a GC, for example). So we first
787 collect the ports into a vector. -mvo */
789 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
790 n
= SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
);
791 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
792 ports
= scm_c_make_vector (n
, SCM_BOOL_F
);
794 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
795 ports
= scm_internal_hash_fold (scm_i_collect_keys_in_vector
, &i
,
796 ports
, scm_i_port_weak_hash
);
797 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
799 for (i
= 0; i
< n
; i
++) {
800 SCM p
= SCM_SIMPLE_VECTOR_REF (ports
, i
);
805 scm_remember_upto_here_1 (ports
);
808 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
810 "Apply @var{proc} to each port in the Guile port table\n"
811 "in turn. The return value is unspecified. More specifically,\n"
812 "@var{proc} is applied exactly once to every port that exists\n"
813 "in the system at the time @var{port-for-each} is invoked.\n"
814 "Changes to the port table while @var{port-for-each} is running\n"
815 "have no effect as far as @var{port-for-each} is concerned.")
816 #define FUNC_NAME s_scm_port_for_each
818 SCM_VALIDATE_PROC (1, proc
);
820 scm_c_port_for_each ((void (*)(void*,SCM
))scm_call_1
, proc
);
821 return SCM_UNSPECIFIED
;
827 /* Utter miscellany. Gosh, we should clean this up some time. */
829 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
831 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
832 "@code{#f}. Any object satisfying this predicate also satisfies\n"
834 #define FUNC_NAME s_scm_input_port_p
836 return scm_from_bool (SCM_INPUT_PORT_P (x
));
840 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
842 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
843 "@code{#f}. Any object satisfying this predicate also satisfies\n"
845 #define FUNC_NAME s_scm_output_port_p
847 x
= SCM_COERCE_OUTPORT (x
);
848 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
852 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
854 "Return a boolean indicating whether @var{x} is a port.\n"
855 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
857 #define FUNC_NAME s_scm_port_p
859 return scm_from_bool (SCM_PORTP (x
));
863 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
865 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
867 #define FUNC_NAME s_scm_port_closed_p
869 SCM_VALIDATE_PORT (1, port
);
870 return scm_from_bool (!SCM_OPPORTP (port
));
874 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
876 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
878 #define FUNC_NAME s_scm_eof_object_p
880 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
884 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
886 "Flush the specified output port, or the current output port if @var{port}\n"
887 "is omitted. The current output buffer contents are passed to the\n"
888 "underlying port implementation (e.g., in the case of fports, the\n"
889 "data will be written to the file and the output buffer will be cleared.)\n"
890 "It has no effect on an unbuffered port.\n\n"
891 "The return value is unspecified.")
892 #define FUNC_NAME s_scm_force_output
894 if (SCM_UNBNDP (port
))
895 port
= scm_current_output_port ();
898 port
= SCM_COERCE_OUTPORT (port
);
899 SCM_VALIDATE_OPOUTPORT (1, port
);
902 return SCM_UNSPECIFIED
;
908 flush_output_port (void *closure
, SCM port
)
910 if (SCM_OPOUTPORTP (port
))
914 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
916 "Equivalent to calling @code{force-output} on\n"
917 "all open output ports. The return value is unspecified.")
918 #define FUNC_NAME s_scm_flush_all_ports
920 scm_c_port_for_each (&flush_output_port
, NULL
);
921 return SCM_UNSPECIFIED
;
925 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
927 "Return the next character available from @var{port}, updating\n"
928 "@var{port} to point to the following character. If no more\n"
929 "characters are available, the end-of-file object is returned.")
930 #define FUNC_NAME s_scm_read_char
933 if (SCM_UNBNDP (port
))
934 port
= scm_current_input_port ();
935 SCM_VALIDATE_OPINPORT (1, port
);
939 return SCM_MAKE_CHAR (c
);
943 /* this should only be called when the read buffer is empty. it
944 tries to refill the read buffer. it returns the first char from
945 the port, which is either EOF or *(pt->read_pos). */
947 scm_fill_input (SCM port
)
949 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
951 assert (pt
->read_pos
== pt
->read_end
);
953 if (pt
->read_buf
== pt
->putback_buf
)
955 /* finished reading put-back chars. */
956 pt
->read_buf
= pt
->saved_read_buf
;
957 pt
->read_pos
= pt
->saved_read_pos
;
958 pt
->read_end
= pt
->saved_read_end
;
959 pt
->read_buf_size
= pt
->saved_read_buf_size
;
960 if (pt
->read_pos
< pt
->read_end
)
961 return *(pt
->read_pos
);
963 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
969 * This function differs from scm_c_write; it updates port line and
973 update_port_lf (scm_t_wchar c
, SCM port
)
1001 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1003 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1004 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1006 if (pt
->rw_active
== SCM_PORT_READ
)
1007 scm_end_input (port
);
1009 ptob
->write (port
, ptr
, size
);
1011 for (; size
; ptr
++, size
--)
1012 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1015 pt
->rw_active
= SCM_PORT_WRITE
;
1018 /* Write a scheme string STR to PORT from START inclusive to END
1021 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1023 size_t i
, size
= scm_i_string_length (str
);
1024 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1025 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1030 if (pt
->rw_active
== SCM_PORT_READ
)
1031 scm_end_input (port
);
1037 buf
= scm_to_stringn (scm_c_substring (str
, start
, end
), &len
,
1038 NULL
, iconveh_escape_sequence
);
1039 ptob
->write (port
, buf
, len
);
1042 for (i
= 0; i
< size
; i
++)
1044 p
= scm_i_string_ref (str
, i
+ start
);
1045 update_port_lf (p
, port
);
1049 pt
->rw_active
= SCM_PORT_WRITE
;
1052 /* Write a scheme string STR to PORT. */
1054 scm_lfwrite_str (SCM str
, SCM port
)
1056 scm_lfwrite_substr (str
, 0, -1, port
);
1061 * Used by an application to read arbitrary number of bytes from an
1062 * SCM port. Same semantics as libc read, except that scm_c_read only
1063 * returns less than SIZE bytes if at end-of-file.
1065 * Warning: Doesn't update port line and column counts! */
1067 /* This structure, and the following swap_buffer function, are used
1068 for temporarily swapping a port's own read buffer, and the buffer
1069 that the caller of scm_c_read provides. */
1070 struct port_and_swap_buffer
1073 unsigned char *buffer
;
1078 swap_buffer (void *data
)
1080 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1081 unsigned char *old_buf
= psb
->pt
->read_buf
;
1082 size_t old_size
= psb
->pt
->read_buf_size
;
1084 /* Make the port use (buffer, size) from the struct. */
1085 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1086 psb
->pt
->read_buf_size
= psb
->size
;
1088 /* Save the port's old (buffer, size) in the struct. */
1089 psb
->buffer
= old_buf
;
1090 psb
->size
= old_size
;
1094 scm_c_read (SCM port
, void *buffer
, size_t size
)
1095 #define FUNC_NAME "scm_c_read"
1098 size_t n_read
= 0, n_available
;
1099 struct port_and_swap_buffer psb
;
1101 SCM_VALIDATE_OPINPORT (1, port
);
1103 pt
= SCM_PTAB_ENTRY (port
);
1104 if (pt
->rw_active
== SCM_PORT_WRITE
)
1105 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1108 pt
->rw_active
= SCM_PORT_READ
;
1110 /* Take bytes first from the port's read buffer. */
1111 if (pt
->read_pos
< pt
->read_end
)
1113 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1114 memcpy (buffer
, pt
->read_pos
, n_available
);
1115 buffer
= (char *) buffer
+ n_available
;
1116 pt
->read_pos
+= n_available
;
1117 n_read
+= n_available
;
1118 size
-= n_available
;
1121 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1125 /* Now we will call scm_fill_input repeatedly until we have read the
1126 requested number of bytes. (Note that a single scm_fill_input
1127 call does not guarantee to fill the whole of the port's read
1129 if (pt
->read_buf_size
<= 1)
1131 /* The port that we are reading from is unbuffered - i.e. does
1132 not have its own persistent buffer - but we have a buffer,
1133 provided by our caller, that is the right size for the data
1134 that is wanted. For the following scm_fill_input calls,
1135 therefore, we use the buffer in hand as the port's read
1138 We need to make sure that the port's normal (1 byte) buffer
1139 is reinstated in case one of the scm_fill_input () calls
1140 throws an exception; we use the scm_dynwind_* API to achieve
1143 psb
.buffer
= buffer
;
1145 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1146 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1147 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1149 /* Call scm_fill_input until we have all the bytes that we need,
1151 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1153 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1154 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1156 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1158 /* Reinstate the port's normal buffer. */
1163 /* The port has its own buffer. It is important that we use it,
1164 even if it happens to be smaller than our caller's buffer, so
1165 that a custom port implementation's entry points (in
1166 particular, fill_input) can rely on the buffer always being
1167 the same as they first set up. */
1168 while (size
&& (scm_fill_input (port
) != EOF
))
1170 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1171 memcpy (buffer
, pt
->read_pos
, n_available
);
1172 buffer
= (char *) buffer
+ n_available
;
1173 pt
->read_pos
+= n_available
;
1174 n_read
+= n_available
;
1175 size
-= n_available
;
1185 * Used by an application to write arbitrary number of bytes to an SCM
1186 * port. Similar semantics as libc write. However, unlike libc
1187 * write, scm_c_write writes the requested number of bytes and has no
1190 * Warning: Doesn't update port line and column counts!
1194 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1195 #define FUNC_NAME "scm_c_write"
1198 scm_t_ptob_descriptor
*ptob
;
1200 SCM_VALIDATE_OPOUTPORT (1, port
);
1202 pt
= SCM_PTAB_ENTRY (port
);
1203 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1205 if (pt
->rw_active
== SCM_PORT_READ
)
1206 scm_end_input (port
);
1208 ptob
->write (port
, ptr
, size
);
1211 pt
->rw_active
= SCM_PORT_WRITE
;
1216 scm_flush (SCM port
)
1218 long i
= SCM_PTOBNUM (port
);
1219 (scm_ptobs
[i
].flush
) (port
);
1223 scm_end_input (SCM port
)
1226 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1228 if (pt
->read_buf
== pt
->putback_buf
)
1230 offset
= pt
->read_end
- pt
->read_pos
;
1231 pt
->read_buf
= pt
->saved_read_buf
;
1232 pt
->read_pos
= pt
->saved_read_pos
;
1233 pt
->read_end
= pt
->saved_read_end
;
1234 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1239 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1246 scm_ungetc (int c
, SCM port
)
1247 #define FUNC_NAME "scm_ungetc"
1249 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1251 if (pt
->read_buf
== pt
->putback_buf
)
1252 /* already using the put-back buffer. */
1254 /* enlarge putback_buf if necessary. */
1255 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1256 && pt
->read_buf
== pt
->read_pos
)
1258 size_t new_size
= pt
->read_buf_size
* 2;
1259 unsigned char *tmp
= (unsigned char *)
1260 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1263 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1264 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1265 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1268 /* shift any existing bytes to buffer + 1. */
1269 if (pt
->read_pos
== pt
->read_end
)
1270 pt
->read_end
= pt
->read_buf
+ 1;
1271 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1273 int count
= pt
->read_end
- pt
->read_pos
;
1275 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1276 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1279 pt
->read_pos
= pt
->read_buf
;
1282 /* switch to the put-back buffer. */
1284 if (pt
->putback_buf
== NULL
)
1287 = (unsigned char *) scm_gc_malloc (SCM_INITIAL_PUTBACK_BUF_SIZE
,
1289 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1292 pt
->saved_read_buf
= pt
->read_buf
;
1293 pt
->saved_read_pos
= pt
->read_pos
;
1294 pt
->saved_read_end
= pt
->read_end
;
1295 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1297 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1298 pt
->read_end
= pt
->read_buf
+ 1;
1299 pt
->read_buf_size
= pt
->putback_buf_size
;
1305 pt
->rw_active
= SCM_PORT_READ
;
1309 /* What should col be in this case?
1310 * We'll leave it at -1.
1312 SCM_LINUM (port
) -= 1;
1321 scm_ungets (const char *s
, int n
, SCM port
)
1323 /* This is simple minded and inefficient, but unreading strings is
1324 * probably not a common operation, and remember that line and
1325 * column numbers have to be handled...
1327 * Please feel free to write an optimized version!
1330 scm_ungetc (s
[n
], port
);
1334 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1336 "Return the next character available from @var{port},\n"
1337 "@emph{without} updating @var{port} to point to the following\n"
1338 "character. If no more characters are available, the\n"
1339 "end-of-file object is returned.\n"
1341 "The value returned by\n"
1342 "a call to @code{peek-char} is the same as the value that would\n"
1343 "have been returned by a call to @code{read-char} on the same\n"
1344 "port. The only difference is that the very next call to\n"
1345 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1346 "return the value returned by the preceding call to\n"
1347 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1348 "an interactive port will hang waiting for input whenever a call\n"
1349 "to @code{read-char} would have hung.")
1350 #define FUNC_NAME s_scm_peek_char
1353 if (SCM_UNBNDP (port
))
1354 port
= scm_current_input_port ();
1356 SCM_VALIDATE_OPINPORT (1, port
);
1357 column
= SCM_COL(port
);
1358 c
= scm_getc (port
);
1361 scm_ungetc (c
, port
);
1362 SCM_COL(port
) = column
;
1363 return SCM_MAKE_CHAR (c
);
1367 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1368 (SCM cobj
, SCM port
),
1369 "Place @var{char} in @var{port} so that it will be read by the\n"
1370 "next read operation. If called multiple times, the unread characters\n"
1371 "will be read again in last-in first-out order. If @var{port} is\n"
1372 "not supplied, the current input port is used.")
1373 #define FUNC_NAME s_scm_unread_char
1377 SCM_VALIDATE_CHAR (1, cobj
);
1378 if (SCM_UNBNDP (port
))
1379 port
= scm_current_input_port ();
1381 SCM_VALIDATE_OPINPORT (2, port
);
1383 c
= SCM_CHAR (cobj
);
1385 scm_ungetc (c
, port
);
1390 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1391 (SCM str
, SCM port
),
1392 "Place the string @var{str} in @var{port} so that its characters will be\n"
1393 "read in subsequent read operations. If called multiple times, the\n"
1394 "unread characters will be read again in last-in first-out order. If\n"
1395 "@var{port} is not supplied, the current-input-port is used.")
1396 #define FUNC_NAME s_scm_unread_string
1398 SCM_VALIDATE_STRING (1, str
);
1399 if (SCM_UNBNDP (port
))
1400 port
= scm_current_input_port ();
1402 SCM_VALIDATE_OPINPORT (2, port
);
1404 scm_ungets (scm_i_string_chars (str
), scm_i_string_length (str
), port
);
1410 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1411 (SCM fd_port
, SCM offset
, SCM whence
),
1412 "Sets the current position of @var{fd/port} to the integer\n"
1413 "@var{offset}, which is interpreted according to the value of\n"
1416 "One of the following variables should be supplied for\n"
1418 "@defvar SEEK_SET\n"
1419 "Seek from the beginning of the file.\n"
1421 "@defvar SEEK_CUR\n"
1422 "Seek from the current position.\n"
1424 "@defvar SEEK_END\n"
1425 "Seek from the end of the file.\n"
1427 "If @var{fd/port} is a file descriptor, the underlying system\n"
1428 "call is @code{lseek}. @var{port} may be a string port.\n"
1430 "The value returned is the new position in the file. This means\n"
1431 "that the current position of a port can be obtained using:\n"
1433 "(seek port 0 SEEK_CUR)\n"
1435 #define FUNC_NAME s_scm_seek
1439 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1441 how
= scm_to_int (whence
);
1442 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1443 SCM_OUT_OF_RANGE (3, whence
);
1445 if (SCM_OPPORTP (fd_port
))
1447 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1448 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1449 off_t_or_off64_t rv
;
1452 SCM_MISC_ERROR ("port is not seekable",
1453 scm_cons (fd_port
, SCM_EOL
));
1455 rv
= ptob
->seek (fd_port
, off
, how
);
1456 return scm_from_off_t_or_off64_t (rv
);
1458 else /* file descriptor?. */
1460 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1461 off_t_or_off64_t rv
;
1462 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1465 return scm_from_off_t_or_off64_t (rv
);
1474 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1475 doesn't have the filename version truncate(), hence this code. */
1476 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1478 truncate (const char *file
, off_t length
)
1482 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1486 ret
= ftruncate (fdes
, length
);
1489 int save_errno
= errno
;
1495 return close (fdes
);
1497 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1499 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1500 (SCM object
, SCM length
),
1501 "Truncate @var{file} to @var{length} bytes. @var{file} can be a\n"
1502 "filename string, a port object, or an integer file descriptor.\n"
1503 "The return value is unspecified.\n"
1505 "For a port or file descriptor @var{length} can be omitted, in\n"
1506 "which case the file is truncated at the current position (per\n"
1507 "@code{ftell} above).\n"
1509 "On most systems a file can be extended by giving a length\n"
1510 "greater than the current size, but this is not mandatory in the\n"
1512 #define FUNC_NAME s_scm_truncate_file
1516 /* "object" can be a port, fdes or filename.
1518 Negative "length" makes no sense, but it's left to truncate() or
1519 ftruncate() to give back an error for that (normally EINVAL).
1522 if (SCM_UNBNDP (length
))
1524 /* must supply length if object is a filename. */
1525 if (scm_is_string (object
))
1526 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
1528 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
1531 object
= SCM_COERCE_OUTPORT (object
);
1532 if (scm_is_integer (object
))
1534 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1535 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
1538 else if (SCM_OPOUTPORTP (object
))
1540 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1541 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
1542 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1544 if (!ptob
->truncate
)
1545 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
1546 if (pt
->rw_active
== SCM_PORT_READ
)
1547 scm_end_input (object
);
1548 else if (pt
->rw_active
== SCM_PORT_WRITE
)
1549 ptob
->flush (object
);
1551 ptob
->truncate (object
, c_length
);
1556 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1557 char *str
= scm_to_locale_string (object
);
1559 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
1566 return SCM_UNSPECIFIED
;
1570 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
1572 "Return the current line number for @var{port}.\n"
1574 "The first line of a file is 0. But you might want to add 1\n"
1575 "when printing line numbers, since starting from 1 is\n"
1576 "traditional in error messages, and likely to be more natural to\n"
1578 #define FUNC_NAME s_scm_port_line
1580 port
= SCM_COERCE_OUTPORT (port
);
1581 SCM_VALIDATE_OPENPORT (1, port
);
1582 return scm_from_long (SCM_LINUM (port
));
1586 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
1587 (SCM port
, SCM line
),
1588 "Set the current line number for @var{port} to @var{line}. The\n"
1589 "first line of a file is 0.")
1590 #define FUNC_NAME s_scm_set_port_line_x
1592 port
= SCM_COERCE_OUTPORT (port
);
1593 SCM_VALIDATE_OPENPORT (1, port
);
1594 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
1595 return SCM_UNSPECIFIED
;
1599 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
1601 "Return the current column number of @var{port}.\n"
1602 "If the number is\n"
1603 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
1604 "- i.e. the first character of the first line is line 0, column 0.\n"
1605 "(However, when you display a file position, for example in an error\n"
1606 "message, we recommend you add 1 to get 1-origin integers. This is\n"
1607 "because lines and column numbers traditionally start with 1, and that is\n"
1608 "what non-programmers will find most natural.)")
1609 #define FUNC_NAME s_scm_port_column
1611 port
= SCM_COERCE_OUTPORT (port
);
1612 SCM_VALIDATE_OPENPORT (1, port
);
1613 return scm_from_int (SCM_COL (port
));
1617 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
1618 (SCM port
, SCM column
),
1619 "Set the current column of @var{port}. Before reading the first\n"
1620 "character on a line the column should be 0.")
1621 #define FUNC_NAME s_scm_set_port_column_x
1623 port
= SCM_COERCE_OUTPORT (port
);
1624 SCM_VALIDATE_OPENPORT (1, port
);
1625 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
1626 return SCM_UNSPECIFIED
;
1630 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
1632 "Return the filename associated with @var{port}. This function returns\n"
1633 "the strings \"standard input\", \"standard output\" and \"standard error\"\n"
1634 "when called on the current input, output and error ports respectively.")
1635 #define FUNC_NAME s_scm_port_filename
1637 port
= SCM_COERCE_OUTPORT (port
);
1638 SCM_VALIDATE_OPENPORT (1, port
);
1639 return SCM_FILENAME (port
);
1643 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
1644 (SCM port
, SCM filename
),
1645 "Change the filename associated with @var{port}, using the current input\n"
1646 "port if none is specified. Note that this does not change the port's\n"
1647 "source of data, but only the value that is returned by\n"
1648 "@code{port-filename} and reported in diagnostic output.")
1649 #define FUNC_NAME s_scm_set_port_filename_x
1651 port
= SCM_COERCE_OUTPORT (port
);
1652 SCM_VALIDATE_OPENPORT (1, port
);
1653 /* We allow the user to set the filename to whatever he likes. */
1654 SCM_SET_FILENAME (port
, filename
);
1655 return SCM_UNSPECIFIED
;
1660 scm_print_port_mode (SCM exp
, SCM port
)
1662 scm_puts (SCM_CLOSEDP (exp
)
1664 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
1665 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
1668 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
1675 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
1677 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
1680 scm_puts ("#<", port
);
1681 scm_print_port_mode (exp
, port
);
1682 scm_puts (type
, port
);
1683 scm_putc (' ', port
);
1684 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
1685 scm_putc ('>', port
);
1690 scm_ports_prehistory ()
1693 scm_ptobs
= (scm_t_ptob_descriptor
*) scm_malloc (sizeof (scm_t_ptob_descriptor
));
1700 scm_t_bits scm_tc16_void_port
= 0;
1702 static int fill_input_void_port (SCM port SCM_UNUSED
)
1708 write_void_port (SCM port SCM_UNUSED
,
1709 const void *data SCM_UNUSED
,
1710 size_t size SCM_UNUSED
)
1715 scm_i_void_port (long mode_bits
)
1717 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
1719 SCM answer
= scm_new_port_table_entry (scm_tc16_void_port
);
1720 scm_t_port
* pt
= SCM_PTAB_ENTRY(answer
);
1722 scm_port_non_buffer (pt
);
1724 SCM_SETSTREAM (answer
, 0);
1725 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
1726 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
1732 scm_void_port (char *mode_str
)
1734 return scm_i_void_port (scm_mode_bits (mode_str
));
1737 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
1739 "Create and return a new void port. A void port acts like\n"
1740 "@file{/dev/null}. The @var{mode} argument\n"
1741 "specifies the input/output modes for this port: see the\n"
1742 "documentation for @code{open-file} in @ref{File Ports}.")
1743 #define FUNC_NAME s_scm_sys_make_void_port
1745 return scm_i_void_port (scm_i_mode_bits (mode
));
1750 /* Initialization. */
1755 /* lseek() symbols. */
1756 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
1757 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
1758 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
1760 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
1763 cur_inport_fluid
= scm_permanent_object (scm_make_fluid ());
1764 cur_outport_fluid
= scm_permanent_object (scm_make_fluid ());
1765 cur_errport_fluid
= scm_permanent_object (scm_make_fluid ());
1766 cur_loadport_fluid
= scm_permanent_object (scm_make_fluid ());
1768 scm_i_port_weak_hash
= scm_permanent_object (scm_make_weak_key_hash_table (SCM_I_MAKINUM(31)));
1770 #include "libguile/ports.x"