1 /* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004,
2 * 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public License
6 * as published by the Free Software Foundation; either version 3 of
7 * the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 #define _LARGEFILE64_SOURCE /* ask for stat64 etc */
32 #include <fcntl.h> /* for chsize on mingw */
37 #include <striconveh.h>
41 #include "libguile/_scm.h"
42 #include "libguile/async.h"
43 #include "libguile/eval.h"
44 #include "libguile/fports.h" /* direct access for seek and truncate */
45 #include "libguile/goops.h"
46 #include "libguile/smob.h"
47 #include "libguile/chars.h"
48 #include "libguile/dynwind.h"
50 #include "libguile/keywords.h"
51 #include "libguile/hashtab.h"
52 #include "libguile/root.h"
53 #include "libguile/strings.h"
54 #include "libguile/mallocs.h"
55 #include "libguile/validate.h"
56 #include "libguile/ports.h"
57 #include "libguile/vectors.h"
58 #include "libguile/weaks.h"
59 #include "libguile/fluids.h"
60 #include "libguile/eq.h"
74 #ifdef HAVE_SYS_IOCTL_H
75 #include <sys/ioctl.h>
78 /* Mingw (version 3.4.5, circa 2006) has ftruncate as an alias for chsize
79 already, but have this code here in case that wasn't so in past versions,
80 or perhaps to help other minimal DOS environments.
82 gnulib ftruncate.c has code using fcntl F_CHSIZE and F_FREESP, which
83 might be possibilities if we've got other systems without ftruncate. */
85 #if defined HAVE_CHSIZE && ! defined HAVE_FTRUNCATE
86 #define ftruncate(fd, size) chsize (fd, size)
88 #define HAVE_FTRUNCATE 1
92 /* The port kind table --- a dynamically resized array of port types. */
95 /* scm_ptobs scm_numptob
96 * implement a dynamically resized array of ptob records.
97 * Indexes into this table are used when generating type
98 * tags for smobjects (if you know a tag you can get an index and conversely).
100 scm_t_ptob_descriptor
*scm_ptobs
= NULL
;
101 long scm_numptob
= 0;
103 /* GC marker for a port with stream of SCM type. */
105 scm_markstream (SCM ptr
)
108 openp
= SCM_CELL_WORD_0 (ptr
) & SCM_OPN
;
110 return SCM_PACK (SCM_STREAM (ptr
));
116 * We choose to use an interface similar to the smob interface with
117 * fill_input and write as standard fields, passed to the port
118 * type constructor, and optional fields set by setters.
122 flush_port_default (SCM port SCM_UNUSED
)
127 end_input_default (SCM port SCM_UNUSED
, int offset SCM_UNUSED
)
132 scm_make_port_type (char *name
,
133 int (*fill_input
) (SCM port
),
134 void (*write
) (SCM port
, const void *data
, size_t size
))
137 if (SCM_I_MAX_PORT_TYPE_COUNT
- 1 <= scm_numptob
)
139 SCM_CRITICAL_SECTION_START
;
140 tmp
= (char *) scm_gc_realloc ((char *) scm_ptobs
,
141 scm_numptob
* sizeof (scm_t_ptob_descriptor
),
143 * sizeof (scm_t_ptob_descriptor
),
147 scm_ptobs
= (scm_t_ptob_descriptor
*) tmp
;
149 scm_ptobs
[scm_numptob
].name
= name
;
150 scm_ptobs
[scm_numptob
].mark
= 0;
151 scm_ptobs
[scm_numptob
].free
= NULL
;
152 scm_ptobs
[scm_numptob
].print
= scm_port_print
;
153 scm_ptobs
[scm_numptob
].equalp
= 0;
154 scm_ptobs
[scm_numptob
].close
= 0;
156 scm_ptobs
[scm_numptob
].write
= write
;
157 scm_ptobs
[scm_numptob
].flush
= flush_port_default
;
159 scm_ptobs
[scm_numptob
].end_input
= end_input_default
;
160 scm_ptobs
[scm_numptob
].fill_input
= fill_input
;
161 scm_ptobs
[scm_numptob
].input_waiting
= 0;
163 scm_ptobs
[scm_numptob
].seek
= 0;
164 scm_ptobs
[scm_numptob
].truncate
= 0;
168 SCM_CRITICAL_SECTION_END
;
172 scm_memory_error ("scm_make_port_type");
174 /* Make a class object if Goops is present */
175 if (SCM_UNPACK (scm_port_class
[0]) != 0)
176 scm_make_port_classes (scm_numptob
- 1, SCM_PTOBNAME (scm_numptob
- 1));
177 return scm_tc7_port
+ (scm_numptob
- 1) * 256;
181 scm_set_port_mark (scm_t_bits tc
, SCM (*mark
) (SCM
))
183 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].mark
= mark
;
187 scm_set_port_free (scm_t_bits tc
, size_t (*free
) (SCM
))
189 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].free
= free
;
193 scm_set_port_print (scm_t_bits tc
, int (*print
) (SCM exp
, SCM port
,
194 scm_print_state
*pstate
))
196 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].print
= print
;
200 scm_set_port_equalp (scm_t_bits tc
, SCM (*equalp
) (SCM
, SCM
))
202 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].equalp
= equalp
;
206 scm_set_port_flush (scm_t_bits tc
, void (*flush
) (SCM port
))
208 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].flush
= flush
;
212 scm_set_port_end_input (scm_t_bits tc
, void (*end_input
) (SCM port
, int offset
))
214 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].end_input
= end_input
;
218 scm_set_port_close (scm_t_bits tc
, int (*close
) (SCM
))
220 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].close
= close
;
224 scm_set_port_seek (scm_t_bits tc
,
225 scm_t_off (*seek
) (SCM
, scm_t_off
, int))
227 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].seek
= seek
;
231 scm_set_port_truncate (scm_t_bits tc
, void (*truncate
) (SCM
, scm_t_off
))
233 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].truncate
= truncate
;
237 scm_set_port_input_waiting (scm_t_bits tc
, int (*input_waiting
) (SCM
))
239 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].input_waiting
= input_waiting
;
244 SCM_DEFINE (scm_char_ready_p
, "char-ready?", 0, 1, 0,
246 "Return @code{#t} if a character is ready on input @var{port}\n"
247 "and return @code{#f} otherwise. If @code{char-ready?} returns\n"
248 "@code{#t} then the next @code{read-char} operation on\n"
249 "@var{port} is guaranteed not to hang. If @var{port} is a file\n"
250 "port at end of file then @code{char-ready?} returns @code{#t}.\n"
252 "@code{char-ready?} exists to make it possible for a\n"
253 "program to accept characters from interactive ports without\n"
254 "getting stuck waiting for input. Any input editors associated\n"
255 "with such ports must make sure that characters whose existence\n"
256 "has been asserted by @code{char-ready?} cannot be rubbed out.\n"
257 "If @code{char-ready?} were to return @code{#f} at end of file,\n"
258 "a port at end of file would be indistinguishable from an\n"
259 "interactive port that has no ready characters.")
260 #define FUNC_NAME s_scm_char_ready_p
264 if (SCM_UNBNDP (port
))
265 port
= scm_current_input_port ();
266 /* It's possible to close the current input port, so validate even in
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
;
354 result
= scm_i_make_string (count
, &data
);
355 scm_take_from_input_buffers (port
, data
, count
);
358 result
= scm_nullstr
;
365 /* Standard ports --- current input, output, error, and more(!). */
367 static SCM cur_inport_fluid
= 0;
368 static SCM cur_outport_fluid
= 0;
369 static SCM cur_errport_fluid
= 0;
370 static SCM cur_loadport_fluid
= 0;
372 SCM_DEFINE (scm_current_input_port
, "current-input-port", 0, 0, 0,
374 "Return the current input port. This is the default port used\n"
375 "by many input procedures. Initially, @code{current-input-port}\n"
376 "returns the @dfn{standard input} in Unix and C terminology.")
377 #define FUNC_NAME s_scm_current_input_port
379 if (cur_inport_fluid
)
380 return scm_fluid_ref (cur_inport_fluid
);
386 SCM_DEFINE (scm_current_output_port
, "current-output-port", 0, 0, 0,
388 "Return the current output port. This is the default port used\n"
389 "by many output procedures. Initially,\n"
390 "@code{current-output-port} returns the @dfn{standard output} in\n"
391 "Unix and C terminology.")
392 #define FUNC_NAME s_scm_current_output_port
394 if (cur_outport_fluid
)
395 return scm_fluid_ref (cur_outport_fluid
);
401 SCM_DEFINE (scm_current_error_port
, "current-error-port", 0, 0, 0,
403 "Return the port to which errors and warnings should be sent (the\n"
404 "@dfn{standard error} in Unix and C terminology).")
405 #define FUNC_NAME s_scm_current_error_port
407 if (cur_errport_fluid
)
408 return scm_fluid_ref (cur_errport_fluid
);
414 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
416 "Return the current-load-port.\n"
417 "The load port is used internally by @code{primitive-load}.")
418 #define FUNC_NAME s_scm_current_load_port
420 return scm_fluid_ref (cur_loadport_fluid
);
424 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
426 "@deffnx {Scheme Procedure} set-current-output-port port\n"
427 "@deffnx {Scheme Procedure} set-current-error-port port\n"
428 "Change the ports returned by @code{current-input-port},\n"
429 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
430 "so that they use the supplied @var{port} for input or output.")
431 #define FUNC_NAME s_scm_set_current_input_port
433 SCM oinp
= scm_fluid_ref (cur_inport_fluid
);
434 SCM_VALIDATE_OPINPORT (1, port
);
435 scm_fluid_set_x (cur_inport_fluid
, port
);
441 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
443 "Set the current default output port to @var{port}.")
444 #define FUNC_NAME s_scm_set_current_output_port
446 SCM ooutp
= scm_fluid_ref (cur_outport_fluid
);
447 port
= SCM_COERCE_OUTPORT (port
);
448 SCM_VALIDATE_OPOUTPORT (1, port
);
449 scm_fluid_set_x (cur_outport_fluid
, port
);
455 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
457 "Set the current default error port to @var{port}.")
458 #define FUNC_NAME s_scm_set_current_error_port
460 SCM oerrp
= scm_fluid_ref (cur_errport_fluid
);
461 port
= SCM_COERCE_OUTPORT (port
);
462 SCM_VALIDATE_OPOUTPORT (1, port
);
463 scm_fluid_set_x (cur_errport_fluid
, port
);
469 scm_dynwind_current_input_port (SCM port
)
470 #define FUNC_NAME NULL
472 SCM_VALIDATE_OPINPORT (1, port
);
473 scm_dynwind_fluid (cur_inport_fluid
, port
);
478 scm_dynwind_current_output_port (SCM port
)
479 #define FUNC_NAME NULL
481 port
= SCM_COERCE_OUTPORT (port
);
482 SCM_VALIDATE_OPOUTPORT (1, port
);
483 scm_dynwind_fluid (cur_outport_fluid
, port
);
488 scm_dynwind_current_error_port (SCM port
)
489 #define FUNC_NAME NULL
491 port
= SCM_COERCE_OUTPORT (port
);
492 SCM_VALIDATE_OPOUTPORT (1, port
);
493 scm_dynwind_fluid (cur_errport_fluid
, port
);
498 scm_i_dynwind_current_load_port (SCM port
)
500 scm_dynwind_fluid (cur_loadport_fluid
, port
);
504 /* The port table --- an array of pointers to ports. */
507 We need a global registry of ports to flush them all at exit, and to
508 get all the ports matching a file descriptor.
510 SCM scm_i_port_weak_hash
;
512 scm_i_pthread_mutex_t scm_i_port_table_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
515 /* Port finalization. */
518 static void finalize_port (GC_PTR
, GC_PTR
);
520 /* Register a finalizer for PORT. */
521 static SCM_C_INLINE_KEYWORD
void
522 register_finalizer_for_port (SCM port
)
525 GC_finalization_proc prev_finalizer
;
526 GC_PTR prev_finalization_data
;
528 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
530 /* Register a finalizer for PORT so that its iconv CDs get freed and
531 optionally its type's `free' function gets called. */
532 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (port
), finalize_port
, 0,
534 &prev_finalization_data
);
537 /* Finalize the object (a port) pointed to by PTR. */
539 finalize_port (GC_PTR ptr
, GC_PTR data
)
542 SCM port
= PTR2SCM (ptr
);
544 if (!SCM_PORTP (port
))
547 if (SCM_OPENP (port
))
549 if (SCM_REVEALED (port
) > 0)
550 /* Keep "revealed" ports alive and re-register a finalizer. */
551 register_finalizer_for_port (port
);
556 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
557 if (port_type
>= scm_numptob
)
560 if (scm_ptobs
[port_type
].free
)
561 /* Yes, I really do mean `.free' rather than `.close'. `.close'
562 is for explicit `close-port' by user. */
563 scm_ptobs
[port_type
].free (port
);
565 entry
= SCM_PTAB_ENTRY (port
);
567 if (entry
->input_cd
!= (iconv_t
) -1)
568 iconv_close (entry
->input_cd
);
569 if (entry
->output_cd
!= (iconv_t
) -1)
570 iconv_close (entry
->output_cd
);
572 SCM_SETSTREAM (port
, 0);
573 SCM_CLR_PORT_OPEN_FLAG (port
);
575 scm_gc_ports_collected
++;
584 /* This function is not and should not be thread safe. */
586 scm_new_port_table_entry (scm_t_bits tag
)
587 #define FUNC_NAME "scm_new_port_table_entry"
590 We initialize the cell to empty, this is in case scm_gc_calloc
591 triggers GC ; we don't want the GC to scan a half-finished Z.
594 SCM z
= scm_cons (SCM_EOL
, SCM_EOL
);
595 scm_t_port
*entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
598 entry
->file_name
= SCM_BOOL_F
;
599 entry
->rw_active
= SCM_PORT_NEITHER
;
602 /* Initialize this port with the thread's current default
604 enc
= scm_i_default_port_encoding ();
605 entry
->encoding
= enc
? scm_gc_strdup (enc
, "port") : NULL
;
607 /* The conversion descriptors will be opened lazily. */
608 entry
->input_cd
= (iconv_t
) -1;
609 entry
->output_cd
= (iconv_t
) -1;
611 entry
->ilseq_handler
= scm_i_get_conversion_strategy (SCM_BOOL_F
);
613 SCM_SET_CELL_TYPE (z
, tag
);
614 SCM_SETPTAB_ENTRY (z
, entry
);
616 scm_hashq_set_x (scm_i_port_weak_hash
, z
, SCM_BOOL_F
);
618 /* For each new port, register a finalizer so that it port type's free
619 function can be invoked eventually. */
620 register_finalizer_for_port (z
);
626 #if SCM_ENABLE_DEPRECATED==1
628 scm_add_to_port_table (SCM port
)
630 SCM z
= scm_new_port_table_entry (scm_tc7_port
);
631 scm_t_port
* pt
= SCM_PTAB_ENTRY(z
);
634 SCM_SETCAR (z
, SCM_EOL
);
635 SCM_SETCDR (z
, SCM_EOL
);
636 SCM_SETPTAB_ENTRY (port
, pt
);
642 /* Remove a port from the table and destroy it. */
644 /* This function is not and should not be thread safe. */
646 scm_i_remove_port (SCM port
)
647 #define FUNC_NAME "scm_remove_port"
649 scm_t_port
*p
= SCM_PTAB_ENTRY (port
);
651 scm_port_non_buffer (p
);
653 p
->putback_buf
= NULL
;
654 p
->putback_buf_size
= 0;
656 SCM_SETPTAB_ENTRY (port
, 0);
657 scm_hashq_remove_x (scm_i_port_weak_hash
, port
);
662 /* Functions for debugging. */
664 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
666 "Return the number of ports in the port table. @code{pt-size}\n"
667 "is only included in @code{--enable-guile-debug} builds.")
668 #define FUNC_NAME s_scm_pt_size
670 return scm_from_int (SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
));
676 scm_port_non_buffer (scm_t_port
*pt
)
678 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
679 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
680 pt
->read_buf_size
= pt
->write_buf_size
= 1;
681 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
685 /* Revealed counts --- an oddity inherited from SCSH. */
687 /* Find a port in the table and return its revealed count.
688 Also used by the garbage collector.
692 scm_revealed_count (SCM port
)
694 return SCM_REVEALED(port
);
699 /* Return the revealed count for a port. */
701 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
703 "Return the revealed count for @var{port}.")
704 #define FUNC_NAME s_scm_port_revealed
706 port
= SCM_COERCE_OUTPORT (port
);
707 SCM_VALIDATE_OPENPORT (1, port
);
708 return scm_from_int (scm_revealed_count (port
));
712 /* Set the revealed count for a port. */
713 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
714 (SCM port
, SCM rcount
),
715 "Sets the revealed count for a port to a given value.\n"
716 "The return value is unspecified.")
717 #define FUNC_NAME s_scm_set_port_revealed_x
719 port
= SCM_COERCE_OUTPORT (port
);
720 SCM_VALIDATE_OPENPORT (1, port
);
721 SCM_REVEALED (port
) = scm_to_int (rcount
);
722 return SCM_UNSPECIFIED
;
728 /* Retrieving a port's mode. */
730 /* Return the flags that characterize a port based on the mode
731 * string used to open a file for that port.
733 * See PORT FLAGS in scm.h
737 scm_i_mode_bits_n (SCM modes
)
740 | (scm_i_string_contains_char (modes
, 'r')
741 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
742 | (scm_i_string_contains_char (modes
, 'w')
743 || scm_i_string_contains_char (modes
, 'a')
744 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
745 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
746 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
750 scm_mode_bits (char *modes
)
752 return scm_i_mode_bits (scm_from_locale_string (modes
));
756 scm_i_mode_bits (SCM modes
)
760 if (!scm_is_string (modes
))
761 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
763 bits
= scm_i_mode_bits_n (modes
);
764 scm_remember_upto_here_1 (modes
);
768 /* Return the mode flags from an open port.
769 * Some modes such as "append" are only used when opening
770 * a file and are not returned here. */
772 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
774 "Return the port modes associated with the open port @var{port}.\n"
775 "These will not necessarily be identical to the modes used when\n"
776 "the port was opened, since modes such as \"append\" which are\n"
777 "used only during port creation are not retained.")
778 #define FUNC_NAME s_scm_port_mode
783 port
= SCM_COERCE_OUTPORT (port
);
784 SCM_VALIDATE_OPPORT (1, port
);
785 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
786 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
787 strcpy (modes
, "r+");
791 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
793 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
795 return scm_from_locale_string (modes
);
804 * Call the close operation on a port object.
805 * see also scm_close.
807 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
809 "Close the specified port object. Return @code{#t} if it\n"
810 "successfully closes a port or @code{#f} if it was already\n"
811 "closed. An exception may be raised if an error occurs, for\n"
812 "example when flushing buffered output. See also @ref{Ports and\n"
813 "File Descriptors, close}, for a procedure which can close file\n"
815 #define FUNC_NAME s_scm_close_port
820 port
= SCM_COERCE_OUTPORT (port
);
822 SCM_VALIDATE_PORT (1, port
);
823 if (SCM_CLOSEDP (port
))
825 i
= SCM_PTOBNUM (port
);
826 if (scm_ptobs
[i
].close
)
827 rv
= (scm_ptobs
[i
].close
) (port
);
830 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
831 scm_i_remove_port (port
);
832 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
833 SCM_CLR_PORT_OPEN_FLAG (port
);
834 return scm_from_bool (rv
>= 0);
838 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
840 "Close the specified input port object. The routine has no effect if\n"
841 "the file has already been closed. An exception may be raised if an\n"
842 "error occurs. The value returned is unspecified.\n\n"
843 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
844 "which can close file descriptors.")
845 #define FUNC_NAME s_scm_close_input_port
847 SCM_VALIDATE_INPUT_PORT (1, port
);
848 scm_close_port (port
);
849 return SCM_UNSPECIFIED
;
853 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
855 "Close the specified output port object. The routine has no effect if\n"
856 "the file has already been closed. An exception may be raised if an\n"
857 "error occurs. The value returned is unspecified.\n\n"
858 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
859 "which can close file descriptors.")
860 #define FUNC_NAME s_scm_close_output_port
862 port
= SCM_COERCE_OUTPORT (port
);
863 SCM_VALIDATE_OUTPUT_PORT (1, port
);
864 scm_close_port (port
);
865 return SCM_UNSPECIFIED
;
870 scm_i_collect_keys_in_vector (void *closure
, SCM key
, SCM value
, SCM result
)
872 int *i
= (int*) closure
;
873 scm_c_vector_set_x (result
, *i
, key
);
880 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
886 /* Even without pre-emptive multithreading, running arbitrary code
887 while scanning the port table is unsafe because the port table
888 can change arbitrarily (from a GC, for example). So we first
889 collect the ports into a vector. -mvo */
891 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
892 n
= SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
);
893 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
894 ports
= scm_c_make_vector (n
, SCM_BOOL_F
);
896 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
897 ports
= scm_internal_hash_fold (scm_i_collect_keys_in_vector
, &i
,
898 ports
, scm_i_port_weak_hash
);
899 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
901 for (i
= 0; i
< n
; i
++) {
902 SCM p
= SCM_SIMPLE_VECTOR_REF (ports
, i
);
907 scm_remember_upto_here_1 (ports
);
910 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
912 "Apply @var{proc} to each port in the Guile port table\n"
913 "in turn. The return value is unspecified. More specifically,\n"
914 "@var{proc} is applied exactly once to every port that exists\n"
915 "in the system at the time @var{port-for-each} is invoked.\n"
916 "Changes to the port table while @var{port-for-each} is running\n"
917 "have no effect as far as @var{port-for-each} is concerned.")
918 #define FUNC_NAME s_scm_port_for_each
920 SCM_VALIDATE_PROC (1, proc
);
922 scm_c_port_for_each ((void (*)(void*,SCM
))scm_call_1
, proc
);
923 return SCM_UNSPECIFIED
;
929 /* Utter miscellany. Gosh, we should clean this up some time. */
931 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
933 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
934 "@code{#f}. Any object satisfying this predicate also satisfies\n"
936 #define FUNC_NAME s_scm_input_port_p
938 return scm_from_bool (SCM_INPUT_PORT_P (x
));
942 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
944 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
945 "@code{#f}. Any object satisfying this predicate also satisfies\n"
947 #define FUNC_NAME s_scm_output_port_p
949 x
= SCM_COERCE_OUTPORT (x
);
950 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
954 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
956 "Return a boolean indicating whether @var{x} is a port.\n"
957 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
959 #define FUNC_NAME s_scm_port_p
961 return scm_from_bool (SCM_PORTP (x
));
965 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
967 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
969 #define FUNC_NAME s_scm_port_closed_p
971 SCM_VALIDATE_PORT (1, port
);
972 return scm_from_bool (!SCM_OPPORTP (port
));
976 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
978 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
980 #define FUNC_NAME s_scm_eof_object_p
982 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
986 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
988 "Flush the specified output port, or the current output port if @var{port}\n"
989 "is omitted. The current output buffer contents are passed to the\n"
990 "underlying port implementation (e.g., in the case of fports, the\n"
991 "data will be written to the file and the output buffer will be cleared.)\n"
992 "It has no effect on an unbuffered port.\n\n"
993 "The return value is unspecified.")
994 #define FUNC_NAME s_scm_force_output
996 if (SCM_UNBNDP (port
))
997 port
= scm_current_output_port ();
1000 port
= SCM_COERCE_OUTPORT (port
);
1001 SCM_VALIDATE_OPOUTPORT (1, port
);
1004 return SCM_UNSPECIFIED
;
1010 flush_output_port (void *closure
, SCM port
)
1012 if (SCM_OPOUTPORTP (port
))
1016 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
1018 "Equivalent to calling @code{force-output} on\n"
1019 "all open output ports. The return value is unspecified.")
1020 #define FUNC_NAME s_scm_flush_all_ports
1022 scm_c_port_for_each (&flush_output_port
, NULL
);
1023 return SCM_UNSPECIFIED
;
1027 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1029 "Return the next character available from @var{port}, updating\n"
1030 "@var{port} to point to the following character. If no more\n"
1031 "characters are available, the end-of-file object is returned.\n"
1033 "When @var{port}'s data cannot be decoded according to its\n"
1034 "character encoding, a @code{decoding-error} is raised and\n"
1035 "@var{port} points past the erroneous byte sequence.\n")
1036 #define FUNC_NAME s_scm_read_char
1039 if (SCM_UNBNDP (port
))
1040 port
= scm_current_input_port ();
1041 SCM_VALIDATE_OPINPORT (1, port
);
1042 c
= scm_getc (port
);
1045 return SCM_MAKE_CHAR (c
);
1049 /* Update the line and column number of PORT after consumption of C. */
1051 update_port_lf (scm_t_wchar c
, SCM port
)
1075 #define SCM_MBCHAR_BUF_SIZE (4)
1077 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1078 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1080 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1082 scm_t_wchar codepoint
;
1084 if (utf8_buf
[0] <= 0x7f)
1087 codepoint
= utf8_buf
[0];
1089 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1092 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1093 | (utf8_buf
[1] & 0x3f);
1095 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1098 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1099 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1100 | (utf8_buf
[2] & 0x3f);
1105 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1106 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1107 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1108 | (utf8_buf
[3] & 0x3f);
1114 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1115 with the byte representation of the codepoint in PORT's encoding, and
1116 set *LEN to the length in bytes of that representation. Return 0 on
1117 success and an errno value on error. */
1119 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1120 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1123 size_t bytes_consumed
, output_size
;
1125 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1126 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1128 if (SCM_UNLIKELY (pt
->input_cd
== (iconv_t
) -1))
1129 /* Initialize the conversion descriptors. */
1130 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1132 for (output_size
= 0, output
= (char *) utf8_buf
,
1133 bytes_consumed
= 0, err
= 0;
1134 err
== 0 && output_size
== 0
1135 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1139 size_t input_left
, output_left
, done
;
1141 byte_read
= scm_get_byte_or_eof (port
);
1142 if (byte_read
== EOF
)
1144 if (bytes_consumed
== 0)
1146 *codepoint
= (scm_t_wchar
) EOF
;
1154 buf
[bytes_consumed
] = byte_read
;
1157 input_left
= bytes_consumed
+ 1;
1158 output_left
= sizeof (utf8_buf
);
1160 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1161 &output
, &output_left
);
1162 if (done
== (size_t) -1)
1166 /* Missing input: keep trying. */
1170 output_size
= sizeof (utf8_buf
) - output_left
;
1173 if (SCM_UNLIKELY (err
!= 0))
1175 /* Reset the `iconv' state. */
1176 iconv (pt
->input_cd
, NULL
, NULL
, NULL
, NULL
);
1178 if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1184 /* Fail when the strategy is SCM_ICONVEH_ERROR or
1185 SCM_ICONVEH_ESCAPE_SEQUENCE (the latter doesn't make sense for
1186 input encoding errors.) */
1189 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1190 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1192 if (SCM_LIKELY (err
== 0))
1193 update_port_lf (*codepoint
, port
);
1195 *len
= bytes_consumed
;
1200 /* Read a codepoint from PORT and return it. */
1203 #define FUNC_NAME "scm_getc"
1207 scm_t_wchar codepoint
;
1208 char buf
[SCM_MBCHAR_BUF_SIZE
];
1210 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1211 if (SCM_UNLIKELY (err
!= 0))
1212 /* At this point PORT should point past the invalid encoding, as per
1213 R6RS-lib Section 8.2.4. */
1214 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1220 /* this should only be called when the read buffer is empty. it
1221 tries to refill the read buffer. it returns the first char from
1222 the port, which is either EOF or *(pt->read_pos). */
1224 scm_fill_input (SCM port
)
1226 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1228 assert (pt
->read_pos
== pt
->read_end
);
1230 if (pt
->read_buf
== pt
->putback_buf
)
1232 /* finished reading put-back chars. */
1233 pt
->read_buf
= pt
->saved_read_buf
;
1234 pt
->read_pos
= pt
->saved_read_pos
;
1235 pt
->read_end
= pt
->saved_read_end
;
1236 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1237 if (pt
->read_pos
< pt
->read_end
)
1238 return *(pt
->read_pos
);
1240 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1246 * This function differs from scm_c_write; it updates port line and
1250 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1252 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1253 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1255 if (pt
->rw_active
== SCM_PORT_READ
)
1256 scm_end_input (port
);
1258 ptob
->write (port
, ptr
, size
);
1260 for (; size
; ptr
++, size
--)
1261 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1264 pt
->rw_active
= SCM_PORT_WRITE
;
1267 /* Write STR to PORT from START inclusive to END exclusive. */
1269 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1271 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1273 if (pt
->rw_active
== SCM_PORT_READ
)
1274 scm_end_input (port
);
1276 if (end
== (size_t) -1)
1277 end
= scm_i_string_length (str
);
1279 scm_display (scm_c_substring (str
, start
, end
), port
);
1282 pt
->rw_active
= SCM_PORT_WRITE
;
1287 * Used by an application to read arbitrary number of bytes from an
1288 * SCM port. Same semantics as libc read, except that scm_c_read only
1289 * returns less than SIZE bytes if at end-of-file.
1291 * Warning: Doesn't update port line and column counts! */
1293 /* This structure, and the following swap_buffer function, are used
1294 for temporarily swapping a port's own read buffer, and the buffer
1295 that the caller of scm_c_read provides. */
1296 struct port_and_swap_buffer
1299 unsigned char *buffer
;
1304 swap_buffer (void *data
)
1306 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1307 unsigned char *old_buf
= psb
->pt
->read_buf
;
1308 size_t old_size
= psb
->pt
->read_buf_size
;
1310 /* Make the port use (buffer, size) from the struct. */
1311 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1312 psb
->pt
->read_buf_size
= psb
->size
;
1314 /* Save the port's old (buffer, size) in the struct. */
1315 psb
->buffer
= old_buf
;
1316 psb
->size
= old_size
;
1320 scm_c_read (SCM port
, void *buffer
, size_t size
)
1321 #define FUNC_NAME "scm_c_read"
1324 size_t n_read
= 0, n_available
;
1325 struct port_and_swap_buffer psb
;
1327 SCM_VALIDATE_OPINPORT (1, port
);
1329 pt
= SCM_PTAB_ENTRY (port
);
1330 if (pt
->rw_active
== SCM_PORT_WRITE
)
1331 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1334 pt
->rw_active
= SCM_PORT_READ
;
1336 /* Take bytes first from the port's read buffer. */
1337 if (pt
->read_pos
< pt
->read_end
)
1339 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1340 memcpy (buffer
, pt
->read_pos
, n_available
);
1341 buffer
= (char *) buffer
+ n_available
;
1342 pt
->read_pos
+= n_available
;
1343 n_read
+= n_available
;
1344 size
-= n_available
;
1347 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1351 /* Now we will call scm_fill_input repeatedly until we have read the
1352 requested number of bytes. (Note that a single scm_fill_input
1353 call does not guarantee to fill the whole of the port's read
1355 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1357 /* The port that we are reading from is unbuffered - i.e. does
1358 not have its own persistent buffer - but we have a buffer,
1359 provided by our caller, that is the right size for the data
1360 that is wanted. For the following scm_fill_input calls,
1361 therefore, we use the buffer in hand as the port's read
1364 We need to make sure that the port's normal (1 byte) buffer
1365 is reinstated in case one of the scm_fill_input () calls
1366 throws an exception; we use the scm_dynwind_* API to achieve
1369 A consequence of this optimization is that the fill_input
1370 functions can't unget characters. That'll push data to the
1371 pushback buffer instead of this psb buffer. */
1373 unsigned char *pback
= pt
->putback_buf
;
1376 psb
.buffer
= buffer
;
1378 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1379 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1380 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1382 /* Call scm_fill_input until we have all the bytes that we need,
1384 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1386 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1387 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1390 if (pback
!= pt
->putback_buf
1391 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1392 scm_misc_error (FUNC_NAME
,
1393 "scm_c_read must not call a fill function that pushes "
1394 "back characters onto an unbuffered port", SCM_EOL
);
1396 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1398 /* Reinstate the port's normal buffer. */
1403 /* The port has its own buffer. It is important that we use it,
1404 even if it happens to be smaller than our caller's buffer, so
1405 that a custom port implementation's entry points (in
1406 particular, fill_input) can rely on the buffer always being
1407 the same as they first set up. */
1408 while (size
&& (scm_fill_input (port
) != EOF
))
1410 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1411 memcpy (buffer
, pt
->read_pos
, n_available
);
1412 buffer
= (char *) buffer
+ n_available
;
1413 pt
->read_pos
+= n_available
;
1414 n_read
+= n_available
;
1415 size
-= n_available
;
1425 * Used by an application to write arbitrary number of bytes to an SCM
1426 * port. Similar semantics as libc write. However, unlike libc
1427 * write, scm_c_write writes the requested number of bytes and has no
1430 * Warning: Doesn't update port line and column counts!
1434 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1435 #define FUNC_NAME "scm_c_write"
1438 scm_t_ptob_descriptor
*ptob
;
1440 SCM_VALIDATE_OPOUTPORT (1, port
);
1442 pt
= SCM_PTAB_ENTRY (port
);
1443 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1445 if (pt
->rw_active
== SCM_PORT_READ
)
1446 scm_end_input (port
);
1448 ptob
->write (port
, ptr
, size
);
1451 pt
->rw_active
= SCM_PORT_WRITE
;
1456 scm_flush (SCM port
)
1458 long i
= SCM_PTOBNUM (port
);
1460 (scm_ptobs
[i
].flush
) (port
);
1464 scm_end_input (SCM port
)
1467 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1469 if (pt
->read_buf
== pt
->putback_buf
)
1471 offset
= pt
->read_end
- pt
->read_pos
;
1472 pt
->read_buf
= pt
->saved_read_buf
;
1473 pt
->read_pos
= pt
->saved_read_pos
;
1474 pt
->read_end
= pt
->saved_read_end
;
1475 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1480 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1487 scm_unget_byte (int c
, SCM port
)
1488 #define FUNC_NAME "scm_unget_byte"
1490 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1492 if (pt
->read_buf
== pt
->putback_buf
)
1493 /* already using the put-back buffer. */
1495 /* enlarge putback_buf if necessary. */
1496 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1497 && pt
->read_buf
== pt
->read_pos
)
1499 size_t new_size
= pt
->read_buf_size
* 2;
1500 unsigned char *tmp
= (unsigned char *)
1501 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1504 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1505 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1506 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1509 /* shift any existing bytes to buffer + 1. */
1510 if (pt
->read_pos
== pt
->read_end
)
1511 pt
->read_end
= pt
->read_buf
+ 1;
1512 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1514 int count
= pt
->read_end
- pt
->read_pos
;
1516 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1517 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1520 pt
->read_pos
= pt
->read_buf
;
1523 /* switch to the put-back buffer. */
1525 if (pt
->putback_buf
== NULL
)
1528 = (unsigned char *) scm_gc_malloc_pointerless
1529 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1530 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1533 pt
->saved_read_buf
= pt
->read_buf
;
1534 pt
->saved_read_pos
= pt
->read_pos
;
1535 pt
->saved_read_end
= pt
->read_end
;
1536 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1538 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1539 pt
->read_end
= pt
->read_buf
+ 1;
1540 pt
->read_buf_size
= pt
->putback_buf_size
;
1546 pt
->rw_active
= SCM_PORT_READ
;
1551 scm_ungetc (scm_t_wchar c
, SCM port
)
1552 #define FUNC_NAME "scm_ungetc"
1554 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1556 char result_buf
[10];
1557 const char *encoding
;
1561 if (pt
->encoding
!= NULL
)
1562 encoding
= pt
->encoding
;
1564 encoding
= "ISO-8859-1";
1566 len
= sizeof (result_buf
);
1567 result
= u32_conv_to_encoding (encoding
,
1568 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1569 (uint32_t *) &c
, 1, NULL
,
1572 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1573 scm_encoding_error (FUNC_NAME
, errno
,
1574 "conversion to port encoding failed",
1575 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1577 for (i
= len
- 1; i
>= 0; i
--)
1578 scm_unget_byte (result
[i
], port
);
1580 if (SCM_UNLIKELY (result
!= result_buf
))
1585 /* What should col be in this case?
1586 * We'll leave it at -1.
1588 SCM_LINUM (port
) -= 1;
1597 scm_ungets (const char *s
, int n
, SCM port
)
1599 /* This is simple minded and inefficient, but unreading strings is
1600 * probably not a common operation, and remember that line and
1601 * column numbers have to be handled...
1603 * Please feel free to write an optimized version!
1606 scm_ungetc (s
[n
], port
);
1610 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1612 "Return the next character available from @var{port},\n"
1613 "@emph{without} updating @var{port} to point to the following\n"
1614 "character. If no more characters are available, the\n"
1615 "end-of-file object is returned.\n"
1617 "The value returned by\n"
1618 "a call to @code{peek-char} is the same as the value that would\n"
1619 "have been returned by a call to @code{read-char} on the same\n"
1620 "port. The only difference is that the very next call to\n"
1621 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1622 "return the value returned by the preceding call to\n"
1623 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1624 "an interactive port will hang waiting for input whenever a call\n"
1625 "to @code{read-char} would have hung.\n"
1627 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1628 "if such a situation occurs. However, unlike with @code{read-char},\n"
1629 "@var{port} still points at the beginning of the erroneous byte\n"
1630 "sequence when the error is raised.\n")
1631 #define FUNC_NAME s_scm_peek_char
1636 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1637 long column
, line
, i
;
1640 if (SCM_UNBNDP (port
))
1641 port
= scm_current_input_port ();
1642 SCM_VALIDATE_OPINPORT (1, port
);
1644 column
= SCM_COL (port
);
1645 line
= SCM_LINUM (port
);
1647 err
= get_codepoint (port
, &c
, bytes
, &len
);
1649 for (i
= len
- 1; i
>= 0; i
--)
1650 scm_unget_byte (bytes
[i
], port
);
1652 SCM_COL (port
) = column
;
1653 SCM_LINUM (port
) = line
;
1655 if (SCM_UNLIKELY (err
!= 0))
1657 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1659 /* Shouldn't happen since `catch' always aborts to prompt. */
1660 result
= SCM_BOOL_F
;
1663 result
= SCM_EOF_VAL
;
1665 result
= SCM_MAKE_CHAR (c
);
1671 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1672 (SCM cobj
, SCM port
),
1673 "Place @var{char} in @var{port} so that it will be read by the\n"
1674 "next read operation. If called multiple times, the unread characters\n"
1675 "will be read again in last-in first-out order. If @var{port} is\n"
1676 "not supplied, the current input port is used.")
1677 #define FUNC_NAME s_scm_unread_char
1681 SCM_VALIDATE_CHAR (1, cobj
);
1682 if (SCM_UNBNDP (port
))
1683 port
= scm_current_input_port ();
1684 SCM_VALIDATE_OPINPORT (2, port
);
1686 c
= SCM_CHAR (cobj
);
1688 scm_ungetc (c
, port
);
1693 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1694 (SCM str
, SCM port
),
1695 "Place the string @var{str} in @var{port} so that its characters will be\n"
1696 "read in subsequent read operations. If called multiple times, the\n"
1697 "unread characters will be read again in last-in first-out order. If\n"
1698 "@var{port} is not supplied, the current-input-port is used.")
1699 #define FUNC_NAME s_scm_unread_string
1702 SCM_VALIDATE_STRING (1, str
);
1703 if (SCM_UNBNDP (port
))
1704 port
= scm_current_input_port ();
1705 SCM_VALIDATE_OPINPORT (2, port
);
1707 n
= scm_i_string_length (str
);
1710 scm_ungetc (scm_i_string_ref (str
, n
), port
);
1716 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1717 (SCM fd_port
, SCM offset
, SCM whence
),
1718 "Sets the current position of @var{fd/port} to the integer\n"
1719 "@var{offset}, which is interpreted according to the value of\n"
1722 "One of the following variables should be supplied for\n"
1724 "@defvar SEEK_SET\n"
1725 "Seek from the beginning of the file.\n"
1727 "@defvar SEEK_CUR\n"
1728 "Seek from the current position.\n"
1730 "@defvar SEEK_END\n"
1731 "Seek from the end of the file.\n"
1733 "If @var{fd/port} is a file descriptor, the underlying system\n"
1734 "call is @code{lseek}. @var{port} may be a string port.\n"
1736 "The value returned is the new position in the file. This means\n"
1737 "that the current position of a port can be obtained using:\n"
1739 "(seek port 0 SEEK_CUR)\n"
1741 #define FUNC_NAME s_scm_seek
1745 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1747 how
= scm_to_int (whence
);
1748 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1749 SCM_OUT_OF_RANGE (3, whence
);
1751 if (SCM_OPPORTP (fd_port
))
1753 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1754 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1755 off_t_or_off64_t rv
;
1758 SCM_MISC_ERROR ("port is not seekable",
1759 scm_cons (fd_port
, SCM_EOL
));
1761 rv
= ptob
->seek (fd_port
, off
, how
);
1762 return scm_from_off_t_or_off64_t (rv
);
1764 else /* file descriptor?. */
1766 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1767 off_t_or_off64_t rv
;
1768 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1771 return scm_from_off_t_or_off64_t (rv
);
1780 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1781 doesn't have the filename version truncate(), hence this code. */
1782 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1784 truncate (const char *file
, off_t length
)
1788 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1792 ret
= ftruncate (fdes
, length
);
1795 int save_errno
= errno
;
1801 return close (fdes
);
1803 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1805 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1806 (SCM object
, SCM length
),
1807 "Truncate @var{file} to @var{length} bytes. @var{file} can be a\n"
1808 "filename string, a port object, or an integer file descriptor.\n"
1809 "The return value is unspecified.\n"
1811 "For a port or file descriptor @var{length} can be omitted, in\n"
1812 "which case the file is truncated at the current position (per\n"
1813 "@code{ftell} above).\n"
1815 "On most systems a file can be extended by giving a length\n"
1816 "greater than the current size, but this is not mandatory in the\n"
1818 #define FUNC_NAME s_scm_truncate_file
1822 /* "object" can be a port, fdes or filename.
1824 Negative "length" makes no sense, but it's left to truncate() or
1825 ftruncate() to give back an error for that (normally EINVAL).
1828 if (SCM_UNBNDP (length
))
1830 /* must supply length if object is a filename. */
1831 if (scm_is_string (object
))
1832 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
1834 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
1837 object
= SCM_COERCE_OUTPORT (object
);
1838 if (scm_is_integer (object
))
1840 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1841 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
1844 else if (SCM_OPOUTPORTP (object
))
1846 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1847 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
1848 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1850 if (!ptob
->truncate
)
1851 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
1852 if (pt
->rw_active
== SCM_PORT_READ
)
1853 scm_end_input (object
);
1854 else if (pt
->rw_active
== SCM_PORT_WRITE
)
1855 ptob
->flush (object
);
1857 ptob
->truncate (object
, c_length
);
1862 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1863 char *str
= scm_to_locale_string (object
);
1865 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
1872 return SCM_UNSPECIFIED
;
1876 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
1878 "Return the current line number for @var{port}.\n"
1880 "The first line of a file is 0. But you might want to add 1\n"
1881 "when printing line numbers, since starting from 1 is\n"
1882 "traditional in error messages, and likely to be more natural to\n"
1884 #define FUNC_NAME s_scm_port_line
1886 port
= SCM_COERCE_OUTPORT (port
);
1887 SCM_VALIDATE_OPENPORT (1, port
);
1888 return scm_from_long (SCM_LINUM (port
));
1892 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
1893 (SCM port
, SCM line
),
1894 "Set the current line number for @var{port} to @var{line}. The\n"
1895 "first line of a file is 0.")
1896 #define FUNC_NAME s_scm_set_port_line_x
1898 port
= SCM_COERCE_OUTPORT (port
);
1899 SCM_VALIDATE_OPENPORT (1, port
);
1900 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
1901 return SCM_UNSPECIFIED
;
1905 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
1907 "Return the current column number of @var{port}.\n"
1908 "If the number is\n"
1909 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
1910 "- i.e. the first character of the first line is line 0, column 0.\n"
1911 "(However, when you display a file position, for example in an error\n"
1912 "message, we recommend you add 1 to get 1-origin integers. This is\n"
1913 "because lines and column numbers traditionally start with 1, and that is\n"
1914 "what non-programmers will find most natural.)")
1915 #define FUNC_NAME s_scm_port_column
1917 port
= SCM_COERCE_OUTPORT (port
);
1918 SCM_VALIDATE_OPENPORT (1, port
);
1919 return scm_from_int (SCM_COL (port
));
1923 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
1924 (SCM port
, SCM column
),
1925 "Set the current column of @var{port}. Before reading the first\n"
1926 "character on a line the column should be 0.")
1927 #define FUNC_NAME s_scm_set_port_column_x
1929 port
= SCM_COERCE_OUTPORT (port
);
1930 SCM_VALIDATE_OPENPORT (1, port
);
1931 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
1932 return SCM_UNSPECIFIED
;
1936 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
1938 "Return the filename associated with @var{port}. This function returns\n"
1939 "the strings \"standard input\", \"standard output\" and \"standard error\"\n"
1940 "when called on the current input, output and error ports respectively.")
1941 #define FUNC_NAME s_scm_port_filename
1943 port
= SCM_COERCE_OUTPORT (port
);
1944 SCM_VALIDATE_OPENPORT (1, port
);
1945 return SCM_FILENAME (port
);
1949 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
1950 (SCM port
, SCM filename
),
1951 "Change the filename associated with @var{port}, using the current input\n"
1952 "port if none is specified. Note that this does not change the port's\n"
1953 "source of data, but only the value that is returned by\n"
1954 "@code{port-filename} and reported in diagnostic output.")
1955 #define FUNC_NAME s_scm_set_port_filename_x
1957 port
= SCM_COERCE_OUTPORT (port
);
1958 SCM_VALIDATE_OPENPORT (1, port
);
1959 /* We allow the user to set the filename to whatever he likes. */
1960 SCM_SET_FILENAME (port
, filename
);
1961 return SCM_UNSPECIFIED
;
1965 /* A fluid specifying the default encoding for newly created ports. If it is
1966 a string, that is the encoding. If it is #f, it is in the "native"
1967 (Latin-1) encoding. */
1968 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
1970 static int scm_port_encoding_init
= 0;
1972 /* Use ENCODING as the default encoding for future ports. */
1974 scm_i_set_default_port_encoding (const char *encoding
)
1976 if (!scm_port_encoding_init
1977 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
1978 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
1981 if (encoding
== NULL
1982 || !strcmp (encoding
, "ASCII")
1983 || !strcmp (encoding
, "ANSI_X3.4-1968")
1984 || !strcmp (encoding
, "ISO-8859-1"))
1985 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
1987 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
1988 scm_from_locale_string (encoding
));
1991 /* Return the name of the default encoding for newly created ports; a
1992 return value of NULL means "ISO-8859-1". */
1994 scm_i_default_port_encoding (void)
1996 if (!scm_port_encoding_init
)
1998 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2004 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
2005 if (!scm_is_string (encoding
))
2008 return scm_i_string_chars (encoding
);
2013 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2016 iconv_t new_input_cd
, new_output_cd
;
2018 new_input_cd
= (iconv_t
) -1;
2019 new_output_cd
= (iconv_t
) -1;
2021 /* Set the character encoding for this port. */
2022 pt
= SCM_PTAB_ENTRY (port
);
2024 if (encoding
== NULL
)
2025 encoding
= "ISO-8859-1";
2027 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2029 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2031 /* Open an input iconv conversion descriptor, from ENCODING
2032 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2033 implementations can typically convert from anything to
2034 UTF-8, but not to UTF-32 (see
2035 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2036 new_input_cd
= iconv_open ("UTF-8", encoding
);
2037 if (new_input_cd
== (iconv_t
) -1)
2038 goto invalid_encoding
;
2041 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2043 new_output_cd
= iconv_open (encoding
, "UTF-8");
2044 if (new_output_cd
== (iconv_t
) -1)
2046 if (new_input_cd
!= (iconv_t
) -1)
2047 iconv_close (new_input_cd
);
2048 goto invalid_encoding
;
2052 if (pt
->input_cd
!= (iconv_t
) -1)
2053 iconv_close (pt
->input_cd
);
2054 if (pt
->output_cd
!= (iconv_t
) -1)
2055 iconv_close (pt
->output_cd
);
2057 pt
->input_cd
= new_input_cd
;
2058 pt
->output_cd
= new_output_cd
;
2065 err
= scm_from_locale_string (encoding
);
2066 scm_misc_error ("scm_i_set_port_encoding_x",
2067 "invalid or unknown character encoding ~s",
2072 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2074 "Returns, as a string, the character encoding that @var{port}\n"
2075 "uses to interpret its input and output.\n")
2076 #define FUNC_NAME s_scm_port_encoding
2081 SCM_VALIDATE_PORT (1, port
);
2083 pt
= SCM_PTAB_ENTRY (port
);
2086 return scm_from_locale_string (pt
->encoding
);
2092 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2093 (SCM port
, SCM enc
),
2094 "Sets the character encoding that will be used to interpret all\n"
2095 "port I/O. New ports are created with the encoding\n"
2096 "appropriate for the current locale if @code{setlocale} has \n"
2097 "been called or ISO-8859-1 otherwise\n"
2098 "and this procedure can be used to modify that encoding.\n")
2099 #define FUNC_NAME s_scm_set_port_encoding_x
2103 SCM_VALIDATE_PORT (1, port
);
2104 SCM_VALIDATE_STRING (2, enc
);
2106 enc_str
= scm_to_locale_string (enc
);
2107 scm_i_set_port_encoding_x (port
, enc_str
);
2109 return SCM_UNSPECIFIED
;
2114 /* This determines how conversions handle unconvertible characters. */
2115 SCM_GLOBAL_VARIABLE (scm_conversion_strategy
, "%port-conversion-strategy");
2116 static int scm_conversion_strategy_init
= 0;
2118 scm_t_string_failed_conversion_handler
2119 scm_i_get_conversion_strategy (SCM port
)
2123 if (scm_is_false (port
))
2125 if (!scm_conversion_strategy_init
2126 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2127 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2130 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (scm_conversion_strategy
));
2131 if (scm_is_false (encoding
))
2132 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2134 return (scm_t_string_failed_conversion_handler
) scm_to_int (encoding
);
2140 pt
= SCM_PTAB_ENTRY (port
);
2141 return pt
->ilseq_handler
;
2147 scm_i_set_conversion_strategy_x (SCM port
,
2148 scm_t_string_failed_conversion_handler handler
)
2153 strategy
= scm_from_int ((int) handler
);
2155 if (scm_is_false (port
))
2157 /* Set the default encoding for future ports. */
2158 if (!scm_conversion_strategy
2159 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2160 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2162 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
), strategy
);
2166 /* Set the character encoding for this port. */
2167 pt
= SCM_PTAB_ENTRY (port
);
2168 pt
->ilseq_handler
= handler
;
2172 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2173 1, 0, 0, (SCM port
),
2174 "Returns the behavior of the port when handling a character that\n"
2175 "is not representable in the port's current encoding.\n"
2176 "It returns the symbol @code{error} if unrepresentable characters\n"
2177 "should cause exceptions, @code{substitute} if the port should\n"
2178 "try to replace unrepresentable characters with question marks or\n"
2179 "approximate characters, or @code{escape} if unrepresentable\n"
2180 "characters should be converted to string escapes.\n"
2182 "If @var{port} is @code{#f}, then the current default behavior\n"
2183 "will be returned. New ports will have this default behavior\n"
2184 "when they are created.\n")
2185 #define FUNC_NAME s_scm_port_conversion_strategy
2187 scm_t_string_failed_conversion_handler h
;
2189 SCM_VALIDATE_OPPORT (1, port
);
2191 if (!scm_is_false (port
))
2193 SCM_VALIDATE_OPPORT (1, port
);
2196 h
= scm_i_get_conversion_strategy (port
);
2197 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2198 return scm_from_latin1_symbol ("error");
2199 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2200 return scm_from_latin1_symbol ("substitute");
2201 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2202 return scm_from_latin1_symbol ("escape");
2206 /* Never gets here. */
2207 return SCM_UNDEFINED
;
2211 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2213 (SCM port
, SCM sym
),
2214 "Sets the behavior of the interpreter when outputting a character\n"
2215 "that is not representable in the port's current encoding.\n"
2216 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2217 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2218 "when an unconvertible character is encountered. If it is\n"
2219 "@code{'substitute}, then unconvertible characters will \n"
2220 "be replaced with approximate characters, or with question marks\n"
2221 "if no approximately correct character is available.\n"
2222 "If it is @code{'escape},\n"
2223 "it will appear as a hex escape when output.\n"
2225 "If @var{port} is an open port, the conversion error behavior\n"
2226 "is set for that port. If it is @code{#f}, it is set as the\n"
2227 "default behavior for any future ports that get created in\n"
2229 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2235 if (!scm_is_false (port
))
2237 SCM_VALIDATE_OPPORT (1, port
);
2240 err
= scm_from_latin1_symbol ("error");
2241 if (scm_is_true (scm_eqv_p (sym
, err
)))
2243 scm_i_set_conversion_strategy_x (port
, SCM_FAILED_CONVERSION_ERROR
);
2244 return SCM_UNSPECIFIED
;
2247 qm
= scm_from_latin1_symbol ("substitute");
2248 if (scm_is_true (scm_eqv_p (sym
, qm
)))
2250 scm_i_set_conversion_strategy_x (port
,
2251 SCM_FAILED_CONVERSION_QUESTION_MARK
);
2252 return SCM_UNSPECIFIED
;
2255 esc
= scm_from_latin1_symbol ("escape");
2256 if (scm_is_true (scm_eqv_p (sym
, esc
)))
2258 scm_i_set_conversion_strategy_x (port
,
2259 SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
);
2260 return SCM_UNSPECIFIED
;
2263 SCM_MISC_ERROR ("unknown conversion behavior ~s", scm_list_1 (sym
));
2265 return SCM_UNSPECIFIED
;
2272 scm_print_port_mode (SCM exp
, SCM port
)
2274 scm_puts (SCM_CLOSEDP (exp
)
2276 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2277 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2280 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2287 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2289 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2292 scm_puts ("#<", port
);
2293 scm_print_port_mode (exp
, port
);
2294 scm_puts (type
, port
);
2295 scm_putc (' ', port
);
2296 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2297 scm_putc ('>', port
);
2305 scm_t_bits scm_tc16_void_port
= 0;
2307 static int fill_input_void_port (SCM port SCM_UNUSED
)
2313 write_void_port (SCM port SCM_UNUSED
,
2314 const void *data SCM_UNUSED
,
2315 size_t size SCM_UNUSED
)
2320 scm_i_void_port (long mode_bits
)
2322 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
2324 SCM answer
= scm_new_port_table_entry (scm_tc16_void_port
);
2325 scm_t_port
* pt
= SCM_PTAB_ENTRY(answer
);
2327 scm_port_non_buffer (pt
);
2329 SCM_SETSTREAM (answer
, 0);
2330 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
2331 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
2337 scm_void_port (char *mode_str
)
2339 return scm_i_void_port (scm_mode_bits (mode_str
));
2342 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2344 "Create and return a new void port. A void port acts like\n"
2345 "@file{/dev/null}. The @var{mode} argument\n"
2346 "specifies the input/output modes for this port: see the\n"
2347 "documentation for @code{open-file} in @ref{File Ports}.")
2348 #define FUNC_NAME s_scm_sys_make_void_port
2350 return scm_i_void_port (scm_i_mode_bits (mode
));
2355 /* Initialization. */
2360 /* lseek() symbols. */
2361 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2362 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2363 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2365 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2368 cur_inport_fluid
= scm_make_fluid ();
2369 cur_outport_fluid
= scm_make_fluid ();
2370 cur_errport_fluid
= scm_make_fluid ();
2371 cur_loadport_fluid
= scm_make_fluid ();
2373 scm_i_port_weak_hash
= scm_make_weak_key_hash_table (SCM_I_MAKINUM(31));
2375 #include "libguile/ports.x"
2377 /* Use Latin-1 as the default port encoding. */
2378 SCM_VARIABLE_SET (default_port_encoding_var
, scm_make_fluid ());
2379 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2380 scm_port_encoding_init
= 1;
2382 SCM_VARIABLE_SET (scm_conversion_strategy
, scm_make_fluid ());
2383 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
),
2384 scm_from_int ((int) SCM_FAILED_CONVERSION_QUESTION_MARK
));
2385 scm_conversion_strategy_init
= 1;