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
;
601 /* Initialize this port with the thread's current default
603 if ((enc
= scm_i_get_port_encoding (SCM_BOOL_F
)) == NULL
)
604 entry
->encoding
= NULL
;
606 entry
->encoding
= scm_gc_strdup (enc
, "port");
608 /* The conversion descriptors will be opened lazily. */
609 entry
->input_cd
= (iconv_t
) -1;
610 entry
->output_cd
= (iconv_t
) -1;
612 entry
->ilseq_handler
= scm_i_get_conversion_strategy (SCM_BOOL_F
);
614 SCM_SET_CELL_TYPE (z
, tag
);
615 SCM_SETPTAB_ENTRY (z
, entry
);
617 scm_hashq_set_x (scm_i_port_weak_hash
, z
, SCM_BOOL_F
);
619 /* For each new port, register a finalizer so that it port type's free
620 function can be invoked eventually. */
621 register_finalizer_for_port (z
);
627 #if SCM_ENABLE_DEPRECATED==1
629 scm_add_to_port_table (SCM port
)
631 SCM z
= scm_new_port_table_entry (scm_tc7_port
);
632 scm_t_port
* pt
= SCM_PTAB_ENTRY(z
);
635 SCM_SETCAR (z
, SCM_EOL
);
636 SCM_SETCDR (z
, SCM_EOL
);
637 SCM_SETPTAB_ENTRY (port
, pt
);
643 /* Remove a port from the table and destroy it. */
645 /* This function is not and should not be thread safe. */
647 scm_i_remove_port (SCM port
)
648 #define FUNC_NAME "scm_remove_port"
650 scm_t_port
*p
= SCM_PTAB_ENTRY (port
);
652 scm_port_non_buffer (p
);
654 p
->putback_buf
= NULL
;
655 p
->putback_buf_size
= 0;
657 SCM_SETPTAB_ENTRY (port
, 0);
658 scm_hashq_remove_x (scm_i_port_weak_hash
, port
);
663 /* Functions for debugging. */
665 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
667 "Return the number of ports in the port table. @code{pt-size}\n"
668 "is only included in @code{--enable-guile-debug} builds.")
669 #define FUNC_NAME s_scm_pt_size
671 return scm_from_int (SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
));
677 scm_port_non_buffer (scm_t_port
*pt
)
679 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
680 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
681 pt
->read_buf_size
= pt
->write_buf_size
= 1;
682 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
686 /* Revealed counts --- an oddity inherited from SCSH. */
688 /* Find a port in the table and return its revealed count.
689 Also used by the garbage collector.
693 scm_revealed_count (SCM port
)
695 return SCM_REVEALED(port
);
700 /* Return the revealed count for a port. */
702 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
704 "Return the revealed count for @var{port}.")
705 #define FUNC_NAME s_scm_port_revealed
707 port
= SCM_COERCE_OUTPORT (port
);
708 SCM_VALIDATE_OPENPORT (1, port
);
709 return scm_from_int (scm_revealed_count (port
));
713 /* Set the revealed count for a port. */
714 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
715 (SCM port
, SCM rcount
),
716 "Sets the revealed count for a port to a given value.\n"
717 "The return value is unspecified.")
718 #define FUNC_NAME s_scm_set_port_revealed_x
720 port
= SCM_COERCE_OUTPORT (port
);
721 SCM_VALIDATE_OPENPORT (1, port
);
722 SCM_REVEALED (port
) = scm_to_int (rcount
);
723 return SCM_UNSPECIFIED
;
729 /* Retrieving a port's mode. */
731 /* Return the flags that characterize a port based on the mode
732 * string used to open a file for that port.
734 * See PORT FLAGS in scm.h
738 scm_i_mode_bits_n (SCM modes
)
741 | (scm_i_string_contains_char (modes
, 'r')
742 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
743 | (scm_i_string_contains_char (modes
, 'w')
744 || scm_i_string_contains_char (modes
, 'a')
745 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
746 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
747 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
751 scm_mode_bits (char *modes
)
753 return scm_i_mode_bits (scm_from_locale_string (modes
));
757 scm_i_mode_bits (SCM modes
)
761 if (!scm_is_string (modes
))
762 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
764 bits
= scm_i_mode_bits_n (modes
);
765 scm_remember_upto_here_1 (modes
);
769 /* Return the mode flags from an open port.
770 * Some modes such as "append" are only used when opening
771 * a file and are not returned here. */
773 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
775 "Return the port modes associated with the open port @var{port}.\n"
776 "These will not necessarily be identical to the modes used when\n"
777 "the port was opened, since modes such as \"append\" which are\n"
778 "used only during port creation are not retained.")
779 #define FUNC_NAME s_scm_port_mode
784 port
= SCM_COERCE_OUTPORT (port
);
785 SCM_VALIDATE_OPPORT (1, port
);
786 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
787 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
788 strcpy (modes
, "r+");
792 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
794 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
796 return scm_from_locale_string (modes
);
805 * Call the close operation on a port object.
806 * see also scm_close.
808 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
810 "Close the specified port object. Return @code{#t} if it\n"
811 "successfully closes a port or @code{#f} if it was already\n"
812 "closed. An exception may be raised if an error occurs, for\n"
813 "example when flushing buffered output. See also @ref{Ports and\n"
814 "File Descriptors, close}, for a procedure which can close file\n"
816 #define FUNC_NAME s_scm_close_port
821 port
= SCM_COERCE_OUTPORT (port
);
823 SCM_VALIDATE_PORT (1, port
);
824 if (SCM_CLOSEDP (port
))
826 i
= SCM_PTOBNUM (port
);
827 if (scm_ptobs
[i
].close
)
828 rv
= (scm_ptobs
[i
].close
) (port
);
831 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
832 scm_i_remove_port (port
);
833 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
834 SCM_CLR_PORT_OPEN_FLAG (port
);
835 return scm_from_bool (rv
>= 0);
839 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
841 "Close the specified input port object. The routine has no effect if\n"
842 "the file has already been closed. An exception may be raised if an\n"
843 "error occurs. The value returned is unspecified.\n\n"
844 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
845 "which can close file descriptors.")
846 #define FUNC_NAME s_scm_close_input_port
848 SCM_VALIDATE_INPUT_PORT (1, port
);
849 scm_close_port (port
);
850 return SCM_UNSPECIFIED
;
854 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
856 "Close the specified output port object. The routine has no effect if\n"
857 "the file has already been closed. An exception may be raised if an\n"
858 "error occurs. The value returned is unspecified.\n\n"
859 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
860 "which can close file descriptors.")
861 #define FUNC_NAME s_scm_close_output_port
863 port
= SCM_COERCE_OUTPORT (port
);
864 SCM_VALIDATE_OUTPUT_PORT (1, port
);
865 scm_close_port (port
);
866 return SCM_UNSPECIFIED
;
871 scm_i_collect_keys_in_vector (void *closure
, SCM key
, SCM value
, SCM result
)
873 int *i
= (int*) closure
;
874 scm_c_vector_set_x (result
, *i
, key
);
881 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
887 /* Even without pre-emptive multithreading, running arbitrary code
888 while scanning the port table is unsafe because the port table
889 can change arbitrarily (from a GC, for example). So we first
890 collect the ports into a vector. -mvo */
892 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
893 n
= SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
);
894 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
895 ports
= scm_c_make_vector (n
, SCM_BOOL_F
);
897 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
898 ports
= scm_internal_hash_fold (scm_i_collect_keys_in_vector
, &i
,
899 ports
, scm_i_port_weak_hash
);
900 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
902 for (i
= 0; i
< n
; i
++) {
903 SCM p
= SCM_SIMPLE_VECTOR_REF (ports
, i
);
908 scm_remember_upto_here_1 (ports
);
911 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
913 "Apply @var{proc} to each port in the Guile port table\n"
914 "in turn. The return value is unspecified. More specifically,\n"
915 "@var{proc} is applied exactly once to every port that exists\n"
916 "in the system at the time @var{port-for-each} is invoked.\n"
917 "Changes to the port table while @var{port-for-each} is running\n"
918 "have no effect as far as @var{port-for-each} is concerned.")
919 #define FUNC_NAME s_scm_port_for_each
921 SCM_VALIDATE_PROC (1, proc
);
923 scm_c_port_for_each ((void (*)(void*,SCM
))scm_call_1
, proc
);
924 return SCM_UNSPECIFIED
;
930 /* Utter miscellany. Gosh, we should clean this up some time. */
932 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
934 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
935 "@code{#f}. Any object satisfying this predicate also satisfies\n"
937 #define FUNC_NAME s_scm_input_port_p
939 return scm_from_bool (SCM_INPUT_PORT_P (x
));
943 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
945 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
946 "@code{#f}. Any object satisfying this predicate also satisfies\n"
948 #define FUNC_NAME s_scm_output_port_p
950 x
= SCM_COERCE_OUTPORT (x
);
951 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
955 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
957 "Return a boolean indicating whether @var{x} is a port.\n"
958 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
960 #define FUNC_NAME s_scm_port_p
962 return scm_from_bool (SCM_PORTP (x
));
966 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
968 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
970 #define FUNC_NAME s_scm_port_closed_p
972 SCM_VALIDATE_PORT (1, port
);
973 return scm_from_bool (!SCM_OPPORTP (port
));
977 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
979 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
981 #define FUNC_NAME s_scm_eof_object_p
983 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
987 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
989 "Flush the specified output port, or the current output port if @var{port}\n"
990 "is omitted. The current output buffer contents are passed to the\n"
991 "underlying port implementation (e.g., in the case of fports, the\n"
992 "data will be written to the file and the output buffer will be cleared.)\n"
993 "It has no effect on an unbuffered port.\n\n"
994 "The return value is unspecified.")
995 #define FUNC_NAME s_scm_force_output
997 if (SCM_UNBNDP (port
))
998 port
= scm_current_output_port ();
1001 port
= SCM_COERCE_OUTPORT (port
);
1002 SCM_VALIDATE_OPOUTPORT (1, port
);
1005 return SCM_UNSPECIFIED
;
1011 flush_output_port (void *closure
, SCM port
)
1013 if (SCM_OPOUTPORTP (port
))
1017 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
1019 "Equivalent to calling @code{force-output} on\n"
1020 "all open output ports. The return value is unspecified.")
1021 #define FUNC_NAME s_scm_flush_all_ports
1023 scm_c_port_for_each (&flush_output_port
, NULL
);
1024 return SCM_UNSPECIFIED
;
1028 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1030 "Return the next character available from @var{port}, updating\n"
1031 "@var{port} to point to the following character. If no more\n"
1032 "characters are available, the end-of-file object is returned.\n"
1034 "When @var{port}'s data cannot be decoded according to its\n"
1035 "character encoding, a @code{decoding-error} is raised and\n"
1036 "@var{port} points past the erroneous byte sequence.\n")
1037 #define FUNC_NAME s_scm_read_char
1040 if (SCM_UNBNDP (port
))
1041 port
= scm_current_input_port ();
1042 SCM_VALIDATE_OPINPORT (1, port
);
1043 c
= scm_getc (port
);
1046 return SCM_MAKE_CHAR (c
);
1050 /* Update the line and column number of PORT after consumption of C. */
1052 update_port_lf (scm_t_wchar c
, SCM port
)
1076 #define SCM_MBCHAR_BUF_SIZE (4)
1078 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1079 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1081 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1083 scm_t_wchar codepoint
;
1085 if (utf8_buf
[0] <= 0x7f)
1088 codepoint
= utf8_buf
[0];
1090 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1093 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1094 | (utf8_buf
[1] & 0x3f);
1096 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1099 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1100 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1101 | (utf8_buf
[2] & 0x3f);
1106 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1107 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1108 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1109 | (utf8_buf
[3] & 0x3f);
1115 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1116 with the byte representation of the codepoint in PORT's encoding, and
1117 set *LEN to the length in bytes of that representation. Return 0 on
1118 success and an errno value on error. */
1120 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1121 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1124 size_t bytes_consumed
, output_size
;
1126 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1127 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1129 if (SCM_UNLIKELY (pt
->input_cd
== (iconv_t
) -1))
1130 /* Initialize the conversion descriptors. */
1131 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1133 for (output_size
= 0, output
= (char *) utf8_buf
,
1134 bytes_consumed
= 0, err
= 0;
1135 err
== 0 && output_size
== 0
1136 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1140 size_t input_left
, output_left
, done
;
1142 byte_read
= scm_get_byte_or_eof (port
);
1143 if (byte_read
== EOF
)
1145 if (bytes_consumed
== 0)
1147 *codepoint
= (scm_t_wchar
) EOF
;
1155 buf
[bytes_consumed
] = byte_read
;
1158 input_left
= bytes_consumed
+ 1;
1159 output_left
= sizeof (utf8_buf
);
1161 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1162 &output
, &output_left
);
1163 if (done
== (size_t) -1)
1167 /* Missing input: keep trying. */
1171 output_size
= sizeof (utf8_buf
) - output_left
;
1174 if (SCM_UNLIKELY (err
!= 0))
1176 /* Reset the `iconv' state. */
1177 iconv (pt
->input_cd
, NULL
, NULL
, NULL
, NULL
);
1179 if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1185 /* Fail when the strategy is SCM_ICONVEH_ERROR or
1186 SCM_ICONVEH_ESCAPE_SEQUENCE (the latter doesn't make sense for
1187 input encoding errors.) */
1190 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1191 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1193 if (SCM_LIKELY (err
== 0))
1194 update_port_lf (*codepoint
, port
);
1196 *len
= bytes_consumed
;
1201 /* Read a codepoint from PORT and return it. */
1204 #define FUNC_NAME "scm_getc"
1208 scm_t_wchar codepoint
;
1209 char buf
[SCM_MBCHAR_BUF_SIZE
];
1211 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1212 if (SCM_UNLIKELY (err
!= 0))
1213 /* At this point PORT should point past the invalid encoding, as per
1214 R6RS-lib Section 8.2.4. */
1215 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1221 /* this should only be called when the read buffer is empty. it
1222 tries to refill the read buffer. it returns the first char from
1223 the port, which is either EOF or *(pt->read_pos). */
1225 scm_fill_input (SCM port
)
1227 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1229 assert (pt
->read_pos
== pt
->read_end
);
1231 if (pt
->read_buf
== pt
->putback_buf
)
1233 /* finished reading put-back chars. */
1234 pt
->read_buf
= pt
->saved_read_buf
;
1235 pt
->read_pos
= pt
->saved_read_pos
;
1236 pt
->read_end
= pt
->saved_read_end
;
1237 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1238 if (pt
->read_pos
< pt
->read_end
)
1239 return *(pt
->read_pos
);
1241 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1247 * This function differs from scm_c_write; it updates port line and
1251 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1253 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1254 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1256 if (pt
->rw_active
== SCM_PORT_READ
)
1257 scm_end_input (port
);
1259 ptob
->write (port
, ptr
, size
);
1261 for (; size
; ptr
++, size
--)
1262 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1265 pt
->rw_active
= SCM_PORT_WRITE
;
1268 /* Write STR to PORT from START inclusive to END exclusive. */
1270 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1272 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1274 if (pt
->rw_active
== SCM_PORT_READ
)
1275 scm_end_input (port
);
1277 if (end
== (size_t) -1)
1278 end
= scm_i_string_length (str
);
1280 scm_display (scm_c_substring (str
, start
, end
), port
);
1283 pt
->rw_active
= SCM_PORT_WRITE
;
1288 * Used by an application to read arbitrary number of bytes from an
1289 * SCM port. Same semantics as libc read, except that scm_c_read only
1290 * returns less than SIZE bytes if at end-of-file.
1292 * Warning: Doesn't update port line and column counts! */
1294 /* This structure, and the following swap_buffer function, are used
1295 for temporarily swapping a port's own read buffer, and the buffer
1296 that the caller of scm_c_read provides. */
1297 struct port_and_swap_buffer
1300 unsigned char *buffer
;
1305 swap_buffer (void *data
)
1307 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1308 unsigned char *old_buf
= psb
->pt
->read_buf
;
1309 size_t old_size
= psb
->pt
->read_buf_size
;
1311 /* Make the port use (buffer, size) from the struct. */
1312 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1313 psb
->pt
->read_buf_size
= psb
->size
;
1315 /* Save the port's old (buffer, size) in the struct. */
1316 psb
->buffer
= old_buf
;
1317 psb
->size
= old_size
;
1321 scm_c_read (SCM port
, void *buffer
, size_t size
)
1322 #define FUNC_NAME "scm_c_read"
1325 size_t n_read
= 0, n_available
;
1326 struct port_and_swap_buffer psb
;
1328 SCM_VALIDATE_OPINPORT (1, port
);
1330 pt
= SCM_PTAB_ENTRY (port
);
1331 if (pt
->rw_active
== SCM_PORT_WRITE
)
1332 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1335 pt
->rw_active
= SCM_PORT_READ
;
1337 /* Take bytes first from the port's read buffer. */
1338 if (pt
->read_pos
< pt
->read_end
)
1340 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1341 memcpy (buffer
, pt
->read_pos
, n_available
);
1342 buffer
= (char *) buffer
+ n_available
;
1343 pt
->read_pos
+= n_available
;
1344 n_read
+= n_available
;
1345 size
-= n_available
;
1348 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1352 /* Now we will call scm_fill_input repeatedly until we have read the
1353 requested number of bytes. (Note that a single scm_fill_input
1354 call does not guarantee to fill the whole of the port's read
1356 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1358 /* The port that we are reading from is unbuffered - i.e. does
1359 not have its own persistent buffer - but we have a buffer,
1360 provided by our caller, that is the right size for the data
1361 that is wanted. For the following scm_fill_input calls,
1362 therefore, we use the buffer in hand as the port's read
1365 We need to make sure that the port's normal (1 byte) buffer
1366 is reinstated in case one of the scm_fill_input () calls
1367 throws an exception; we use the scm_dynwind_* API to achieve
1370 A consequence of this optimization is that the fill_input
1371 functions can't unget characters. That'll push data to the
1372 pushback buffer instead of this psb buffer. */
1374 unsigned char *pback
= pt
->putback_buf
;
1377 psb
.buffer
= buffer
;
1379 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1380 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1381 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1383 /* Call scm_fill_input until we have all the bytes that we need,
1385 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1387 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1388 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1391 if (pback
!= pt
->putback_buf
1392 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1393 scm_misc_error (FUNC_NAME
,
1394 "scm_c_read must not call a fill function that pushes "
1395 "back characters onto an unbuffered port", SCM_EOL
);
1397 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1399 /* Reinstate the port's normal buffer. */
1404 /* The port has its own buffer. It is important that we use it,
1405 even if it happens to be smaller than our caller's buffer, so
1406 that a custom port implementation's entry points (in
1407 particular, fill_input) can rely on the buffer always being
1408 the same as they first set up. */
1409 while (size
&& (scm_fill_input (port
) != EOF
))
1411 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1412 memcpy (buffer
, pt
->read_pos
, n_available
);
1413 buffer
= (char *) buffer
+ n_available
;
1414 pt
->read_pos
+= n_available
;
1415 n_read
+= n_available
;
1416 size
-= n_available
;
1426 * Used by an application to write arbitrary number of bytes to an SCM
1427 * port. Similar semantics as libc write. However, unlike libc
1428 * write, scm_c_write writes the requested number of bytes and has no
1431 * Warning: Doesn't update port line and column counts!
1435 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1436 #define FUNC_NAME "scm_c_write"
1439 scm_t_ptob_descriptor
*ptob
;
1441 SCM_VALIDATE_OPOUTPORT (1, port
);
1443 pt
= SCM_PTAB_ENTRY (port
);
1444 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1446 if (pt
->rw_active
== SCM_PORT_READ
)
1447 scm_end_input (port
);
1449 ptob
->write (port
, ptr
, size
);
1452 pt
->rw_active
= SCM_PORT_WRITE
;
1457 scm_flush (SCM port
)
1459 long i
= SCM_PTOBNUM (port
);
1461 (scm_ptobs
[i
].flush
) (port
);
1465 scm_end_input (SCM port
)
1468 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1470 if (pt
->read_buf
== pt
->putback_buf
)
1472 offset
= pt
->read_end
- pt
->read_pos
;
1473 pt
->read_buf
= pt
->saved_read_buf
;
1474 pt
->read_pos
= pt
->saved_read_pos
;
1475 pt
->read_end
= pt
->saved_read_end
;
1476 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1481 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1488 scm_unget_byte (int c
, SCM port
)
1489 #define FUNC_NAME "scm_unget_byte"
1491 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1493 if (pt
->read_buf
== pt
->putback_buf
)
1494 /* already using the put-back buffer. */
1496 /* enlarge putback_buf if necessary. */
1497 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1498 && pt
->read_buf
== pt
->read_pos
)
1500 size_t new_size
= pt
->read_buf_size
* 2;
1501 unsigned char *tmp
= (unsigned char *)
1502 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1505 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1506 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1507 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1510 /* shift any existing bytes to buffer + 1. */
1511 if (pt
->read_pos
== pt
->read_end
)
1512 pt
->read_end
= pt
->read_buf
+ 1;
1513 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1515 int count
= pt
->read_end
- pt
->read_pos
;
1517 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1518 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1521 pt
->read_pos
= pt
->read_buf
;
1524 /* switch to the put-back buffer. */
1526 if (pt
->putback_buf
== NULL
)
1529 = (unsigned char *) scm_gc_malloc_pointerless
1530 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1531 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1534 pt
->saved_read_buf
= pt
->read_buf
;
1535 pt
->saved_read_pos
= pt
->read_pos
;
1536 pt
->saved_read_end
= pt
->read_end
;
1537 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1539 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1540 pt
->read_end
= pt
->read_buf
+ 1;
1541 pt
->read_buf_size
= pt
->putback_buf_size
;
1547 pt
->rw_active
= SCM_PORT_READ
;
1552 scm_ungetc (scm_t_wchar c
, SCM port
)
1553 #define FUNC_NAME "scm_ungetc"
1555 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1557 char result_buf
[10];
1558 const char *encoding
;
1562 if (pt
->encoding
!= NULL
)
1563 encoding
= pt
->encoding
;
1565 encoding
= "ISO-8859-1";
1567 len
= sizeof (result_buf
);
1568 result
= u32_conv_to_encoding (encoding
,
1569 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1570 (uint32_t *) &c
, 1, NULL
,
1573 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1574 scm_encoding_error (FUNC_NAME
, errno
,
1575 "conversion to port encoding failed",
1576 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1578 for (i
= len
- 1; i
>= 0; i
--)
1579 scm_unget_byte (result
[i
], port
);
1581 if (SCM_UNLIKELY (result
!= result_buf
))
1586 /* What should col be in this case?
1587 * We'll leave it at -1.
1589 SCM_LINUM (port
) -= 1;
1598 scm_ungets (const char *s
, int n
, SCM port
)
1600 /* This is simple minded and inefficient, but unreading strings is
1601 * probably not a common operation, and remember that line and
1602 * column numbers have to be handled...
1604 * Please feel free to write an optimized version!
1607 scm_ungetc (s
[n
], port
);
1611 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1613 "Return the next character available from @var{port},\n"
1614 "@emph{without} updating @var{port} to point to the following\n"
1615 "character. If no more characters are available, the\n"
1616 "end-of-file object is returned.\n"
1618 "The value returned by\n"
1619 "a call to @code{peek-char} is the same as the value that would\n"
1620 "have been returned by a call to @code{read-char} on the same\n"
1621 "port. The only difference is that the very next call to\n"
1622 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1623 "return the value returned by the preceding call to\n"
1624 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1625 "an interactive port will hang waiting for input whenever a call\n"
1626 "to @code{read-char} would have hung.\n"
1628 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1629 "if such a situation occurs. However, unlike with @code{read-char},\n"
1630 "@var{port} still points at the beginning of the erroneous byte\n"
1631 "sequence when the error is raised.\n")
1632 #define FUNC_NAME s_scm_peek_char
1637 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1638 long column
, line
, i
;
1641 if (SCM_UNBNDP (port
))
1642 port
= scm_current_input_port ();
1643 SCM_VALIDATE_OPINPORT (1, port
);
1645 column
= SCM_COL (port
);
1646 line
= SCM_LINUM (port
);
1648 err
= get_codepoint (port
, &c
, bytes
, &len
);
1650 for (i
= len
- 1; i
>= 0; i
--)
1651 scm_unget_byte (bytes
[i
], port
);
1653 SCM_COL (port
) = column
;
1654 SCM_LINUM (port
) = line
;
1656 if (SCM_UNLIKELY (err
!= 0))
1658 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1660 /* Shouldn't happen since `catch' always aborts to prompt. */
1661 result
= SCM_BOOL_F
;
1664 result
= SCM_EOF_VAL
;
1666 result
= SCM_MAKE_CHAR (c
);
1672 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1673 (SCM cobj
, SCM port
),
1674 "Place @var{char} in @var{port} so that it will be read by the\n"
1675 "next read operation. If called multiple times, the unread characters\n"
1676 "will be read again in last-in first-out order. If @var{port} is\n"
1677 "not supplied, the current input port is used.")
1678 #define FUNC_NAME s_scm_unread_char
1682 SCM_VALIDATE_CHAR (1, cobj
);
1683 if (SCM_UNBNDP (port
))
1684 port
= scm_current_input_port ();
1685 SCM_VALIDATE_OPINPORT (2, port
);
1687 c
= SCM_CHAR (cobj
);
1689 scm_ungetc (c
, port
);
1694 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1695 (SCM str
, SCM port
),
1696 "Place the string @var{str} in @var{port} so that its characters will be\n"
1697 "read in subsequent read operations. If called multiple times, the\n"
1698 "unread characters will be read again in last-in first-out order. If\n"
1699 "@var{port} is not supplied, the current-input-port is used.")
1700 #define FUNC_NAME s_scm_unread_string
1703 SCM_VALIDATE_STRING (1, str
);
1704 if (SCM_UNBNDP (port
))
1705 port
= scm_current_input_port ();
1706 SCM_VALIDATE_OPINPORT (2, port
);
1708 n
= scm_i_string_length (str
);
1711 scm_ungetc (scm_i_string_ref (str
, n
), port
);
1717 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1718 (SCM fd_port
, SCM offset
, SCM whence
),
1719 "Sets the current position of @var{fd/port} to the integer\n"
1720 "@var{offset}, which is interpreted according to the value of\n"
1723 "One of the following variables should be supplied for\n"
1725 "@defvar SEEK_SET\n"
1726 "Seek from the beginning of the file.\n"
1728 "@defvar SEEK_CUR\n"
1729 "Seek from the current position.\n"
1731 "@defvar SEEK_END\n"
1732 "Seek from the end of the file.\n"
1734 "If @var{fd/port} is a file descriptor, the underlying system\n"
1735 "call is @code{lseek}. @var{port} may be a string port.\n"
1737 "The value returned is the new position in the file. This means\n"
1738 "that the current position of a port can be obtained using:\n"
1740 "(seek port 0 SEEK_CUR)\n"
1742 #define FUNC_NAME s_scm_seek
1746 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1748 how
= scm_to_int (whence
);
1749 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1750 SCM_OUT_OF_RANGE (3, whence
);
1752 if (SCM_OPPORTP (fd_port
))
1754 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1755 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1756 off_t_or_off64_t rv
;
1759 SCM_MISC_ERROR ("port is not seekable",
1760 scm_cons (fd_port
, SCM_EOL
));
1762 rv
= ptob
->seek (fd_port
, off
, how
);
1763 return scm_from_off_t_or_off64_t (rv
);
1765 else /* file descriptor?. */
1767 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1768 off_t_or_off64_t rv
;
1769 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1772 return scm_from_off_t_or_off64_t (rv
);
1781 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1782 doesn't have the filename version truncate(), hence this code. */
1783 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1785 truncate (const char *file
, off_t length
)
1789 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1793 ret
= ftruncate (fdes
, length
);
1796 int save_errno
= errno
;
1802 return close (fdes
);
1804 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1806 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1807 (SCM object
, SCM length
),
1808 "Truncate @var{file} to @var{length} bytes. @var{file} can be a\n"
1809 "filename string, a port object, or an integer file descriptor.\n"
1810 "The return value is unspecified.\n"
1812 "For a port or file descriptor @var{length} can be omitted, in\n"
1813 "which case the file is truncated at the current position (per\n"
1814 "@code{ftell} above).\n"
1816 "On most systems a file can be extended by giving a length\n"
1817 "greater than the current size, but this is not mandatory in the\n"
1819 #define FUNC_NAME s_scm_truncate_file
1823 /* "object" can be a port, fdes or filename.
1825 Negative "length" makes no sense, but it's left to truncate() or
1826 ftruncate() to give back an error for that (normally EINVAL).
1829 if (SCM_UNBNDP (length
))
1831 /* must supply length if object is a filename. */
1832 if (scm_is_string (object
))
1833 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
1835 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
1838 object
= SCM_COERCE_OUTPORT (object
);
1839 if (scm_is_integer (object
))
1841 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1842 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
1845 else if (SCM_OPOUTPORTP (object
))
1847 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1848 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
1849 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1851 if (!ptob
->truncate
)
1852 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
1853 if (pt
->rw_active
== SCM_PORT_READ
)
1854 scm_end_input (object
);
1855 else if (pt
->rw_active
== SCM_PORT_WRITE
)
1856 ptob
->flush (object
);
1858 ptob
->truncate (object
, c_length
);
1863 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1864 char *str
= scm_to_locale_string (object
);
1866 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
1873 return SCM_UNSPECIFIED
;
1877 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
1879 "Return the current line number for @var{port}.\n"
1881 "The first line of a file is 0. But you might want to add 1\n"
1882 "when printing line numbers, since starting from 1 is\n"
1883 "traditional in error messages, and likely to be more natural to\n"
1885 #define FUNC_NAME s_scm_port_line
1887 port
= SCM_COERCE_OUTPORT (port
);
1888 SCM_VALIDATE_OPENPORT (1, port
);
1889 return scm_from_long (SCM_LINUM (port
));
1893 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
1894 (SCM port
, SCM line
),
1895 "Set the current line number for @var{port} to @var{line}. The\n"
1896 "first line of a file is 0.")
1897 #define FUNC_NAME s_scm_set_port_line_x
1899 port
= SCM_COERCE_OUTPORT (port
);
1900 SCM_VALIDATE_OPENPORT (1, port
);
1901 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
1902 return SCM_UNSPECIFIED
;
1906 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
1908 "Return the current column number of @var{port}.\n"
1909 "If the number is\n"
1910 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
1911 "- i.e. the first character of the first line is line 0, column 0.\n"
1912 "(However, when you display a file position, for example in an error\n"
1913 "message, we recommend you add 1 to get 1-origin integers. This is\n"
1914 "because lines and column numbers traditionally start with 1, and that is\n"
1915 "what non-programmers will find most natural.)")
1916 #define FUNC_NAME s_scm_port_column
1918 port
= SCM_COERCE_OUTPORT (port
);
1919 SCM_VALIDATE_OPENPORT (1, port
);
1920 return scm_from_int (SCM_COL (port
));
1924 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
1925 (SCM port
, SCM column
),
1926 "Set the current column of @var{port}. Before reading the first\n"
1927 "character on a line the column should be 0.")
1928 #define FUNC_NAME s_scm_set_port_column_x
1930 port
= SCM_COERCE_OUTPORT (port
);
1931 SCM_VALIDATE_OPENPORT (1, port
);
1932 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
1933 return SCM_UNSPECIFIED
;
1937 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
1939 "Return the filename associated with @var{port}. This function returns\n"
1940 "the strings \"standard input\", \"standard output\" and \"standard error\"\n"
1941 "when called on the current input, output and error ports respectively.")
1942 #define FUNC_NAME s_scm_port_filename
1944 port
= SCM_COERCE_OUTPORT (port
);
1945 SCM_VALIDATE_OPENPORT (1, port
);
1946 return SCM_FILENAME (port
);
1950 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
1951 (SCM port
, SCM filename
),
1952 "Change the filename associated with @var{port}, using the current input\n"
1953 "port if none is specified. Note that this does not change the port's\n"
1954 "source of data, but only the value that is returned by\n"
1955 "@code{port-filename} and reported in diagnostic output.")
1956 #define FUNC_NAME s_scm_set_port_filename_x
1958 port
= SCM_COERCE_OUTPORT (port
);
1959 SCM_VALIDATE_OPENPORT (1, port
);
1960 /* We allow the user to set the filename to whatever he likes. */
1961 SCM_SET_FILENAME (port
, filename
);
1962 return SCM_UNSPECIFIED
;
1966 /* A fluid specifying the default encoding for newly created ports. If it is
1967 a string, that is the encoding. If it is #f, it is in the "native"
1968 (Latin-1) encoding. */
1969 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
1971 static int scm_port_encoding_init
= 0;
1973 /* Return a C string representation of the current encoding. */
1975 scm_i_get_port_encoding (SCM port
)
1979 if (scm_is_false (port
))
1981 if (!scm_port_encoding_init
)
1983 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
1987 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
1988 if (!scm_is_string (encoding
))
1991 return scm_i_string_chars (encoding
);
1997 pt
= SCM_PTAB_ENTRY (port
);
1998 return pt
->encoding
;
2003 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2007 if (scm_is_false (port
))
2009 /* Set the default encoding for future ports. */
2010 if (!scm_port_encoding_init
2011 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2012 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
2015 if (encoding
== NULL
2016 || !strcmp (encoding
, "ASCII")
2017 || !strcmp (encoding
, "ANSI_X3.4-1968")
2018 || !strcmp (encoding
, "ISO-8859-1"))
2019 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2021 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
2022 scm_from_locale_string (encoding
));
2026 iconv_t new_input_cd
, new_output_cd
;
2028 new_input_cd
= (iconv_t
) -1;
2029 new_output_cd
= (iconv_t
) -1;
2031 /* Set the character encoding for this port. */
2032 pt
= SCM_PTAB_ENTRY (port
);
2034 if (encoding
== NULL
)
2035 encoding
= "ISO-8859-1";
2037 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2039 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2041 /* Open an input iconv conversion descriptor, from ENCODING
2042 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2043 implementations can typically convert from anything to
2044 UTF-8, but not to UTF-32 (see
2045 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2046 new_input_cd
= iconv_open ("UTF-8", encoding
);
2047 if (new_input_cd
== (iconv_t
) -1)
2048 goto invalid_encoding
;
2051 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2053 new_output_cd
= iconv_open (encoding
, "UTF-8");
2054 if (new_output_cd
== (iconv_t
) -1)
2056 if (new_input_cd
!= (iconv_t
) -1)
2057 iconv_close (new_input_cd
);
2058 goto invalid_encoding
;
2062 if (pt
->input_cd
!= (iconv_t
) -1)
2063 iconv_close (pt
->input_cd
);
2064 if (pt
->output_cd
!= (iconv_t
) -1)
2065 iconv_close (pt
->output_cd
);
2067 pt
->input_cd
= new_input_cd
;
2068 pt
->output_cd
= new_output_cd
;
2076 err
= scm_from_locale_string (encoding
);
2077 scm_misc_error ("scm_i_set_port_encoding_x",
2078 "invalid or unknown character encoding ~s",
2083 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2085 "Returns, as a string, the character encoding that @var{port}\n"
2086 "uses to interpret its input and output.\n")
2087 #define FUNC_NAME s_scm_port_encoding
2092 SCM_VALIDATE_PORT (1, port
);
2094 pt
= SCM_PTAB_ENTRY (port
);
2095 enc
= scm_i_get_port_encoding (port
);
2097 return scm_from_locale_string (pt
->encoding
);
2103 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2104 (SCM port
, SCM enc
),
2105 "Sets the character encoding that will be used to interpret all\n"
2106 "port I/O. New ports are created with the encoding\n"
2107 "appropriate for the current locale if @code{setlocale} has \n"
2108 "been called or ISO-8859-1 otherwise\n"
2109 "and this procedure can be used to modify that encoding.\n")
2110 #define FUNC_NAME s_scm_set_port_encoding_x
2114 SCM_VALIDATE_PORT (1, port
);
2115 SCM_VALIDATE_STRING (2, enc
);
2117 enc_str
= scm_to_locale_string (enc
);
2118 scm_i_set_port_encoding_x (port
, enc_str
);
2120 return SCM_UNSPECIFIED
;
2125 /* This determines how conversions handle unconvertible characters. */
2126 SCM_GLOBAL_VARIABLE (scm_conversion_strategy
, "%port-conversion-strategy");
2127 static int scm_conversion_strategy_init
= 0;
2129 scm_t_string_failed_conversion_handler
2130 scm_i_get_conversion_strategy (SCM port
)
2134 if (scm_is_false (port
))
2136 if (!scm_conversion_strategy_init
2137 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2138 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2141 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (scm_conversion_strategy
));
2142 if (scm_is_false (encoding
))
2143 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2145 return (scm_t_string_failed_conversion_handler
) scm_to_int (encoding
);
2151 pt
= SCM_PTAB_ENTRY (port
);
2152 return pt
->ilseq_handler
;
2158 scm_i_set_conversion_strategy_x (SCM port
,
2159 scm_t_string_failed_conversion_handler handler
)
2164 strategy
= scm_from_int ((int) handler
);
2166 if (scm_is_false (port
))
2168 /* Set the default encoding for future ports. */
2169 if (!scm_conversion_strategy
2170 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2171 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2173 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
), strategy
);
2177 /* Set the character encoding for this port. */
2178 pt
= SCM_PTAB_ENTRY (port
);
2179 pt
->ilseq_handler
= handler
;
2183 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2184 1, 0, 0, (SCM port
),
2185 "Returns the behavior of the port when handling a character that\n"
2186 "is not representable in the port's current encoding.\n"
2187 "It returns the symbol @code{error} if unrepresentable characters\n"
2188 "should cause exceptions, @code{substitute} if the port should\n"
2189 "try to replace unrepresentable characters with question marks or\n"
2190 "approximate characters, or @code{escape} if unrepresentable\n"
2191 "characters should be converted to string escapes.\n"
2193 "If @var{port} is @code{#f}, then the current default behavior\n"
2194 "will be returned. New ports will have this default behavior\n"
2195 "when they are created.\n")
2196 #define FUNC_NAME s_scm_port_conversion_strategy
2198 scm_t_string_failed_conversion_handler h
;
2200 SCM_VALIDATE_OPPORT (1, port
);
2202 if (!scm_is_false (port
))
2204 SCM_VALIDATE_OPPORT (1, port
);
2207 h
= scm_i_get_conversion_strategy (port
);
2208 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2209 return scm_from_latin1_symbol ("error");
2210 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2211 return scm_from_latin1_symbol ("substitute");
2212 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2213 return scm_from_latin1_symbol ("escape");
2217 /* Never gets here. */
2218 return SCM_UNDEFINED
;
2222 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2224 (SCM port
, SCM sym
),
2225 "Sets the behavior of the interpreter when outputting a character\n"
2226 "that is not representable in the port's current encoding.\n"
2227 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2228 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2229 "when an unconvertible character is encountered. If it is\n"
2230 "@code{'substitute}, then unconvertible characters will \n"
2231 "be replaced with approximate characters, or with question marks\n"
2232 "if no approximately correct character is available.\n"
2233 "If it is @code{'escape},\n"
2234 "it will appear as a hex escape when output.\n"
2236 "If @var{port} is an open port, the conversion error behavior\n"
2237 "is set for that port. If it is @code{#f}, it is set as the\n"
2238 "default behavior for any future ports that get created in\n"
2240 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2246 if (!scm_is_false (port
))
2248 SCM_VALIDATE_OPPORT (1, port
);
2251 err
= scm_from_latin1_symbol ("error");
2252 if (scm_is_true (scm_eqv_p (sym
, err
)))
2254 scm_i_set_conversion_strategy_x (port
, SCM_FAILED_CONVERSION_ERROR
);
2255 return SCM_UNSPECIFIED
;
2258 qm
= scm_from_latin1_symbol ("substitute");
2259 if (scm_is_true (scm_eqv_p (sym
, qm
)))
2261 scm_i_set_conversion_strategy_x (port
,
2262 SCM_FAILED_CONVERSION_QUESTION_MARK
);
2263 return SCM_UNSPECIFIED
;
2266 esc
= scm_from_latin1_symbol ("escape");
2267 if (scm_is_true (scm_eqv_p (sym
, esc
)))
2269 scm_i_set_conversion_strategy_x (port
,
2270 SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
);
2271 return SCM_UNSPECIFIED
;
2274 SCM_MISC_ERROR ("unknown conversion behavior ~s", scm_list_1 (sym
));
2276 return SCM_UNSPECIFIED
;
2283 scm_print_port_mode (SCM exp
, SCM port
)
2285 scm_puts (SCM_CLOSEDP (exp
)
2287 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2288 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2291 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2298 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2300 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2303 scm_puts ("#<", port
);
2304 scm_print_port_mode (exp
, port
);
2305 scm_puts (type
, port
);
2306 scm_putc (' ', port
);
2307 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2308 scm_putc ('>', port
);
2316 scm_t_bits scm_tc16_void_port
= 0;
2318 static int fill_input_void_port (SCM port SCM_UNUSED
)
2324 write_void_port (SCM port SCM_UNUSED
,
2325 const void *data SCM_UNUSED
,
2326 size_t size SCM_UNUSED
)
2331 scm_i_void_port (long mode_bits
)
2333 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
2335 SCM answer
= scm_new_port_table_entry (scm_tc16_void_port
);
2336 scm_t_port
* pt
= SCM_PTAB_ENTRY(answer
);
2338 scm_port_non_buffer (pt
);
2340 SCM_SETSTREAM (answer
, 0);
2341 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
2342 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
2348 scm_void_port (char *mode_str
)
2350 return scm_i_void_port (scm_mode_bits (mode_str
));
2353 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2355 "Create and return a new void port. A void port acts like\n"
2356 "@file{/dev/null}. The @var{mode} argument\n"
2357 "specifies the input/output modes for this port: see the\n"
2358 "documentation for @code{open-file} in @ref{File Ports}.")
2359 #define FUNC_NAME s_scm_sys_make_void_port
2361 return scm_i_void_port (scm_i_mode_bits (mode
));
2366 /* Initialization. */
2371 /* lseek() symbols. */
2372 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2373 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2374 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2376 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2379 cur_inport_fluid
= scm_make_fluid ();
2380 cur_outport_fluid
= scm_make_fluid ();
2381 cur_errport_fluid
= scm_make_fluid ();
2382 cur_loadport_fluid
= scm_make_fluid ();
2384 scm_i_port_weak_hash
= scm_make_weak_key_hash_table (SCM_I_MAKINUM(31));
2386 #include "libguile/ports.x"
2388 /* Use Latin-1 as the default port encoding. */
2389 SCM_VARIABLE_SET (default_port_encoding_var
, scm_make_fluid ());
2390 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2391 scm_port_encoding_init
= 1;
2393 SCM_VARIABLE_SET (scm_conversion_strategy
, scm_make_fluid ());
2394 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
),
2395 scm_from_int ((int) SCM_FAILED_CONVERSION_QUESTION_MARK
));
2396 scm_conversion_strategy_init
= 1;