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/deprecation.h"
44 #include "libguile/eval.h"
45 #include "libguile/fports.h" /* direct access for seek and truncate */
46 #include "libguile/goops.h"
47 #include "libguile/smob.h"
48 #include "libguile/chars.h"
49 #include "libguile/dynwind.h"
51 #include "libguile/keywords.h"
52 #include "libguile/hashtab.h"
53 #include "libguile/root.h"
54 #include "libguile/strings.h"
55 #include "libguile/mallocs.h"
56 #include "libguile/validate.h"
57 #include "libguile/ports.h"
58 #include "libguile/vectors.h"
59 #include "libguile/weak-set.h"
60 #include "libguile/fluids.h"
61 #include "libguile/eq.h"
75 #ifdef HAVE_SYS_IOCTL_H
76 #include <sys/ioctl.h>
79 /* Mingw (version 3.4.5, circa 2006) has ftruncate as an alias for chsize
80 already, but have this code here in case that wasn't so in past versions,
81 or perhaps to help other minimal DOS environments.
83 gnulib ftruncate.c has code using fcntl F_CHSIZE and F_FREESP, which
84 might be possibilities if we've got other systems without ftruncate. */
86 #if defined HAVE_CHSIZE && ! defined HAVE_FTRUNCATE
87 #define ftruncate(fd, size) chsize (fd, size)
89 #define HAVE_FTRUNCATE 1
93 /* The port kind table --- a dynamically resized array of port types. */
96 /* scm_ptobs scm_numptob
97 * implement a dynamically resized array of ptob records.
98 * Indexes into this table are used when generating type
99 * tags for smobjects (if you know a tag you can get an index and conversely).
101 scm_t_ptob_descriptor
*scm_ptobs
= NULL
;
102 long scm_numptob
= 0;
104 /* GC marker for a port with stream of SCM type. */
106 scm_markstream (SCM ptr
)
109 openp
= SCM_CELL_WORD_0 (ptr
) & SCM_OPN
;
111 return SCM_PACK (SCM_STREAM (ptr
));
117 * We choose to use an interface similar to the smob interface with
118 * fill_input and write as standard fields, passed to the port
119 * type constructor, and optional fields set by setters.
123 flush_port_default (SCM port SCM_UNUSED
)
128 end_input_default (SCM port SCM_UNUSED
, int offset SCM_UNUSED
)
133 scm_make_port_type (char *name
,
134 int (*fill_input
) (SCM port
),
135 void (*write
) (SCM port
, const void *data
, size_t size
))
138 if (SCM_I_MAX_PORT_TYPE_COUNT
- 1 <= scm_numptob
)
140 SCM_CRITICAL_SECTION_START
;
141 tmp
= (char *) scm_gc_realloc ((char *) scm_ptobs
,
142 scm_numptob
* sizeof (scm_t_ptob_descriptor
),
144 * sizeof (scm_t_ptob_descriptor
),
148 scm_ptobs
= (scm_t_ptob_descriptor
*) tmp
;
150 scm_ptobs
[scm_numptob
].name
= name
;
151 scm_ptobs
[scm_numptob
].mark
= 0;
152 scm_ptobs
[scm_numptob
].free
= NULL
;
153 scm_ptobs
[scm_numptob
].print
= scm_port_print
;
154 scm_ptobs
[scm_numptob
].equalp
= 0;
155 scm_ptobs
[scm_numptob
].close
= 0;
157 scm_ptobs
[scm_numptob
].write
= write
;
158 scm_ptobs
[scm_numptob
].flush
= flush_port_default
;
160 scm_ptobs
[scm_numptob
].end_input
= end_input_default
;
161 scm_ptobs
[scm_numptob
].fill_input
= fill_input
;
162 scm_ptobs
[scm_numptob
].input_waiting
= 0;
164 scm_ptobs
[scm_numptob
].seek
= 0;
165 scm_ptobs
[scm_numptob
].truncate
= 0;
169 SCM_CRITICAL_SECTION_END
;
173 scm_memory_error ("scm_make_port_type");
175 /* Make a class object if Goops is present */
176 if (SCM_UNPACK (scm_port_class
[0]) != 0)
177 scm_make_port_classes (scm_numptob
- 1, SCM_PTOBNAME (scm_numptob
- 1));
178 return scm_tc7_port
+ (scm_numptob
- 1) * 256;
182 scm_set_port_mark (scm_t_bits tc
, SCM (*mark
) (SCM
))
184 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].mark
= mark
;
188 scm_set_port_free (scm_t_bits tc
, size_t (*free
) (SCM
))
190 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].free
= free
;
194 scm_set_port_print (scm_t_bits tc
, int (*print
) (SCM exp
, SCM port
,
195 scm_print_state
*pstate
))
197 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].print
= print
;
201 scm_set_port_equalp (scm_t_bits tc
, SCM (*equalp
) (SCM
, SCM
))
203 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].equalp
= equalp
;
207 scm_set_port_flush (scm_t_bits tc
, void (*flush
) (SCM port
))
209 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].flush
= flush
;
213 scm_set_port_end_input (scm_t_bits tc
, void (*end_input
) (SCM port
, int offset
))
215 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].end_input
= end_input
;
219 scm_set_port_close (scm_t_bits tc
, int (*close
) (SCM
))
221 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].close
= close
;
225 scm_set_port_seek (scm_t_bits tc
,
226 scm_t_off (*seek
) (SCM
, scm_t_off
, int))
228 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].seek
= seek
;
232 scm_set_port_truncate (scm_t_bits tc
, void (*truncate
) (SCM
, scm_t_off
))
234 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].truncate
= truncate
;
238 scm_set_port_input_waiting (scm_t_bits tc
, int (*input_waiting
) (SCM
))
240 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].input_waiting
= input_waiting
;
245 SCM_DEFINE (scm_char_ready_p
, "char-ready?", 0, 1, 0,
247 "Return @code{#t} if a character is ready on input @var{port}\n"
248 "and return @code{#f} otherwise. If @code{char-ready?} returns\n"
249 "@code{#t} then the next @code{read-char} operation on\n"
250 "@var{port} is guaranteed not to hang. If @var{port} is a file\n"
251 "port at end of file then @code{char-ready?} returns @code{#t}.\n"
253 "@code{char-ready?} exists to make it possible for a\n"
254 "program to accept characters from interactive ports without\n"
255 "getting stuck waiting for input. Any input editors associated\n"
256 "with such ports must make sure that characters whose existence\n"
257 "has been asserted by @code{char-ready?} cannot be rubbed out.\n"
258 "If @code{char-ready?} were to return @code{#f} at end of file,\n"
259 "a port at end of file would be indistinguishable from an\n"
260 "interactive port that has no ready characters.")
261 #define FUNC_NAME s_scm_char_ready_p
265 if (SCM_UNBNDP (port
))
266 port
= scm_current_input_port ();
267 /* It's possible to close the current input port, so validate even in
269 SCM_VALIDATE_OPINPORT (1, port
);
271 pt
= SCM_PTAB_ENTRY (port
);
273 /* if the current read buffer is filled, or the
274 last pushed-back char has been read and the saved buffer is
275 filled, result is true. */
276 if (pt
->read_pos
< pt
->read_end
277 || (pt
->read_buf
== pt
->putback_buf
278 && pt
->saved_read_pos
< pt
->saved_read_end
))
282 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
284 if (ptob
->input_waiting
)
285 return scm_from_bool(ptob
->input_waiting (port
));
292 /* move up to read_len chars from port's putback and/or read buffers
293 into memory starting at dest. returns the number of chars moved. */
294 size_t scm_take_from_input_buffers (SCM port
, char *dest
, size_t read_len
)
296 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
297 size_t chars_read
= 0;
298 size_t from_buf
= min (pt
->read_end
- pt
->read_pos
, read_len
);
302 memcpy (dest
, pt
->read_pos
, from_buf
);
303 pt
->read_pos
+= from_buf
;
304 chars_read
+= from_buf
;
305 read_len
-= from_buf
;
309 /* if putback was active, try the real input buffer too. */
310 if (pt
->read_buf
== pt
->putback_buf
)
312 from_buf
= min (pt
->saved_read_end
- pt
->saved_read_pos
, read_len
);
315 memcpy (dest
, pt
->saved_read_pos
, from_buf
);
316 pt
->saved_read_pos
+= from_buf
;
317 chars_read
+= from_buf
;
323 /* Clear a port's read buffers, returning the contents. */
324 SCM_DEFINE (scm_drain_input
, "drain-input", 1, 0, 0,
326 "This procedure clears a port's input buffers, similar\n"
327 "to the way that force-output clears the output buffer. The\n"
328 "contents of the buffers are returned as a single string, e.g.,\n"
331 "(define p (open-input-file ...))\n"
332 "(drain-input p) => empty string, nothing buffered yet.\n"
333 "(unread-char (read-char p) p)\n"
334 "(drain-input p) => initial chars from p, up to the buffer size.\n"
336 "Draining the buffers may be useful for cleanly finishing\n"
337 "buffered I/O so that the file descriptor can be used directly\n"
338 "for further input.")
339 #define FUNC_NAME s_scm_drain_input
346 SCM_VALIDATE_OPINPORT (1, port
);
347 pt
= SCM_PTAB_ENTRY (port
);
349 count
= pt
->read_end
- pt
->read_pos
;
350 if (pt
->read_buf
== pt
->putback_buf
)
351 count
+= pt
->saved_read_end
- pt
->saved_read_pos
;
355 result
= scm_i_make_string (count
, &data
, 0);
356 scm_take_from_input_buffers (port
, data
, count
);
359 result
= scm_nullstr
;
366 /* Standard ports --- current input, output, error, and more(!). */
368 static SCM cur_inport_fluid
= SCM_BOOL_F
;
369 static SCM cur_outport_fluid
= SCM_BOOL_F
;
370 static SCM cur_errport_fluid
= SCM_BOOL_F
;
371 static SCM cur_loadport_fluid
= SCM_BOOL_F
;
373 SCM_DEFINE (scm_current_input_port
, "current-input-port", 0, 0, 0,
375 "Return the current input port. This is the default port used\n"
376 "by many input procedures. Initially, @code{current-input-port}\n"
377 "returns the @dfn{standard input} in Unix and C terminology.")
378 #define FUNC_NAME s_scm_current_input_port
380 if (scm_is_true (cur_inport_fluid
))
381 return scm_fluid_ref (cur_inport_fluid
);
387 SCM_DEFINE (scm_current_output_port
, "current-output-port", 0, 0, 0,
389 "Return the current output port. This is the default port used\n"
390 "by many output procedures. Initially,\n"
391 "@code{current-output-port} returns the @dfn{standard output} in\n"
392 "Unix and C terminology.")
393 #define FUNC_NAME s_scm_current_output_port
395 if (scm_is_true (cur_outport_fluid
))
396 return scm_fluid_ref (cur_outport_fluid
);
402 SCM_DEFINE (scm_current_error_port
, "current-error-port", 0, 0, 0,
404 "Return the port to which errors and warnings should be sent (the\n"
405 "@dfn{standard error} in Unix and C terminology).")
406 #define FUNC_NAME s_scm_current_error_port
408 if (scm_is_true (cur_errport_fluid
))
409 return scm_fluid_ref (cur_errport_fluid
);
415 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
417 "Return the current-load-port.\n"
418 "The load port is used internally by @code{primitive-load}.")
419 #define FUNC_NAME s_scm_current_load_port
421 return scm_fluid_ref (cur_loadport_fluid
);
425 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
427 "@deffnx {Scheme Procedure} set-current-output-port port\n"
428 "@deffnx {Scheme Procedure} set-current-error-port port\n"
429 "Change the ports returned by @code{current-input-port},\n"
430 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
431 "so that they use the supplied @var{port} for input or output.")
432 #define FUNC_NAME s_scm_set_current_input_port
434 SCM oinp
= scm_fluid_ref (cur_inport_fluid
);
435 SCM_VALIDATE_OPINPORT (1, port
);
436 scm_fluid_set_x (cur_inport_fluid
, port
);
442 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
444 "Set the current default output port to @var{port}.")
445 #define FUNC_NAME s_scm_set_current_output_port
447 SCM ooutp
= scm_fluid_ref (cur_outport_fluid
);
448 port
= SCM_COERCE_OUTPORT (port
);
449 SCM_VALIDATE_OPOUTPORT (1, port
);
450 scm_fluid_set_x (cur_outport_fluid
, port
);
456 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
458 "Set the current default error port to @var{port}.")
459 #define FUNC_NAME s_scm_set_current_error_port
461 SCM oerrp
= scm_fluid_ref (cur_errport_fluid
);
462 port
= SCM_COERCE_OUTPORT (port
);
463 SCM_VALIDATE_OPOUTPORT (1, port
);
464 scm_fluid_set_x (cur_errport_fluid
, port
);
470 scm_dynwind_current_input_port (SCM port
)
471 #define FUNC_NAME NULL
473 SCM_VALIDATE_OPINPORT (1, port
);
474 scm_dynwind_fluid (cur_inport_fluid
, port
);
479 scm_dynwind_current_output_port (SCM port
)
480 #define FUNC_NAME NULL
482 port
= SCM_COERCE_OUTPORT (port
);
483 SCM_VALIDATE_OPOUTPORT (1, port
);
484 scm_dynwind_fluid (cur_outport_fluid
, port
);
489 scm_dynwind_current_error_port (SCM port
)
490 #define FUNC_NAME NULL
492 port
= SCM_COERCE_OUTPORT (port
);
493 SCM_VALIDATE_OPOUTPORT (1, port
);
494 scm_dynwind_fluid (cur_errport_fluid
, port
);
499 scm_i_dynwind_current_load_port (SCM port
)
501 scm_dynwind_fluid (cur_loadport_fluid
, port
);
505 /* The port table --- an array of pointers to ports. */
508 We need a global registry of ports to flush them all at exit, and to
509 get all the ports matching a file descriptor.
511 SCM scm_i_port_weak_set
;
514 /* Port finalization. */
517 static void finalize_port (GC_PTR
, GC_PTR
);
519 /* Register a finalizer for PORT. */
520 static SCM_C_INLINE_KEYWORD
void
521 register_finalizer_for_port (SCM port
)
523 GC_finalization_proc prev_finalizer
;
524 GC_PTR prev_finalization_data
;
526 /* Register a finalizer for PORT so that its iconv CDs get freed and
527 optionally its type's `free' function gets called. */
528 GC_REGISTER_FINALIZER_NO_ORDER (SCM_HEAP_OBJECT_BASE (port
),
531 &prev_finalization_data
);
534 /* Finalize the object (a port) pointed to by PTR. */
536 finalize_port (GC_PTR ptr
, GC_PTR data
)
539 SCM port
= SCM_PACK_POINTER (ptr
);
541 if (!SCM_PORTP (port
))
544 if (SCM_OPENP (port
))
546 if (SCM_REVEALED (port
) > 0)
547 /* Keep "revealed" ports alive and re-register a finalizer. */
548 register_finalizer_for_port (port
);
553 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
554 if (port_type
>= scm_numptob
)
557 if (scm_ptobs
[port_type
].free
)
558 /* Yes, I really do mean `.free' rather than `.close'. `.close'
559 is for explicit `close-port' by user. */
560 scm_ptobs
[port_type
].free (port
);
562 entry
= SCM_PTAB_ENTRY (port
);
564 if (entry
->input_cd
!= (iconv_t
) -1)
565 iconv_close (entry
->input_cd
);
566 if (entry
->output_cd
!= (iconv_t
) -1)
567 iconv_close (entry
->output_cd
);
569 SCM_SETSTREAM (port
, 0);
570 SCM_CLR_PORT_OPEN_FLAG (port
);
572 scm_gc_ports_collected
++;
582 scm_c_make_port_with_encoding (scm_t_bits tag
, unsigned long mode_bits
,
583 const char *encoding
,
584 scm_t_string_failed_conversion_handler handler
,
590 entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
591 ret
= scm_cell (tag
| mode_bits
, (scm_t_bits
)entry
);
593 entry
->file_name
= SCM_BOOL_F
;
594 entry
->rw_active
= SCM_PORT_NEITHER
;
596 entry
->stream
= stream
;
597 entry
->encoding
= encoding
? scm_gc_strdup (encoding
, "port") : NULL
;
598 /* The conversion descriptors will be opened lazily. */
599 entry
->input_cd
= (iconv_t
) -1;
600 entry
->output_cd
= (iconv_t
) -1;
601 entry
->ilseq_handler
= handler
;
603 scm_weak_set_add_x (scm_i_port_weak_set
, ret
);
605 /* For each new port, register a finalizer so that it port type's free
606 function can be invoked eventually. */
607 register_finalizer_for_port (ret
);
613 scm_c_make_port (scm_t_bits tag
, unsigned long mode_bits
, scm_t_bits stream
)
615 return scm_c_make_port_with_encoding (tag
, mode_bits
,
616 scm_i_default_port_encoding (),
617 scm_i_get_conversion_strategy (SCM_BOOL_F
),
622 scm_new_port_table_entry (scm_t_bits tag
)
624 return scm_c_make_port (tag
, 0, 0);
627 /* Remove a port from the table and destroy it. */
630 scm_i_remove_port (SCM port
)
631 #define FUNC_NAME "scm_remove_port"
635 p
= SCM_PTAB_ENTRY (port
);
636 scm_port_non_buffer (p
);
637 SCM_SETPTAB_ENTRY (port
, 0);
638 scm_weak_set_remove_x (scm_i_port_weak_set
, port
);
640 p
->putback_buf
= NULL
;
641 p
->putback_buf_size
= 0;
643 if (p
->input_cd
!= (iconv_t
) -1)
645 iconv_close (p
->input_cd
);
646 p
->input_cd
= (iconv_t
) -1;
649 if (p
->output_cd
!= (iconv_t
) -1)
651 iconv_close (p
->output_cd
);
652 p
->output_cd
= (iconv_t
) -1;
659 scm_port_non_buffer (scm_t_port
*pt
)
661 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
662 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
663 pt
->read_buf_size
= pt
->write_buf_size
= 1;
664 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
668 /* Revealed counts --- an oddity inherited from SCSH. */
670 /* Find a port in the table and return its revealed count.
671 Also used by the garbage collector.
675 scm_revealed_count (SCM port
)
677 return SCM_REVEALED(port
);
682 /* Return the revealed count for a port. */
684 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
686 "Return the revealed count for @var{port}.")
687 #define FUNC_NAME s_scm_port_revealed
689 port
= SCM_COERCE_OUTPORT (port
);
690 SCM_VALIDATE_OPENPORT (1, port
);
691 return scm_from_int (scm_revealed_count (port
));
695 /* Set the revealed count for a port. */
696 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
697 (SCM port
, SCM rcount
),
698 "Sets the revealed count for a port to a given value.\n"
699 "The return value is unspecified.")
700 #define FUNC_NAME s_scm_set_port_revealed_x
702 port
= SCM_COERCE_OUTPORT (port
);
703 SCM_VALIDATE_OPENPORT (1, port
);
704 SCM_REVEALED (port
) = scm_to_int (rcount
);
705 return SCM_UNSPECIFIED
;
711 /* Retrieving a port's mode. */
713 /* Return the flags that characterize a port based on the mode
714 * string used to open a file for that port.
716 * See PORT FLAGS in scm.h
720 scm_i_mode_bits_n (SCM modes
)
723 | (scm_i_string_contains_char (modes
, 'r')
724 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
725 | (scm_i_string_contains_char (modes
, 'w')
726 || scm_i_string_contains_char (modes
, 'a')
727 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
728 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
729 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
733 scm_mode_bits (char *modes
)
735 return scm_i_mode_bits (scm_from_locale_string (modes
));
739 scm_i_mode_bits (SCM modes
)
743 if (!scm_is_string (modes
))
744 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
746 bits
= scm_i_mode_bits_n (modes
);
747 scm_remember_upto_here_1 (modes
);
751 /* Return the mode flags from an open port.
752 * Some modes such as "append" are only used when opening
753 * a file and are not returned here. */
755 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
757 "Return the port modes associated with the open port @var{port}.\n"
758 "These will not necessarily be identical to the modes used when\n"
759 "the port was opened, since modes such as \"append\" which are\n"
760 "used only during port creation are not retained.")
761 #define FUNC_NAME s_scm_port_mode
766 port
= SCM_COERCE_OUTPORT (port
);
767 SCM_VALIDATE_OPPORT (1, port
);
768 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
769 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
770 strcpy (modes
, "r+");
774 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
776 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
778 return scm_from_locale_string (modes
);
787 * Call the close operation on a port object.
788 * see also scm_close.
790 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
792 "Close the specified port object. Return @code{#t} if it\n"
793 "successfully closes a port or @code{#f} if it was already\n"
794 "closed. An exception may be raised if an error occurs, for\n"
795 "example when flushing buffered output. See also @ref{Ports and\n"
796 "File Descriptors, close}, for a procedure which can close file\n"
798 #define FUNC_NAME s_scm_close_port
803 port
= SCM_COERCE_OUTPORT (port
);
805 SCM_VALIDATE_PORT (1, port
);
806 if (SCM_CLOSEDP (port
))
808 i
= SCM_PTOBNUM (port
);
809 if (scm_ptobs
[i
].close
)
810 rv
= (scm_ptobs
[i
].close
) (port
);
813 scm_i_remove_port (port
);
814 SCM_CLR_PORT_OPEN_FLAG (port
);
815 return scm_from_bool (rv
>= 0);
819 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
821 "Close the specified input port object. The routine has no effect if\n"
822 "the file has already been closed. An exception may be raised if an\n"
823 "error occurs. The value returned is unspecified.\n\n"
824 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
825 "which can close file descriptors.")
826 #define FUNC_NAME s_scm_close_input_port
828 SCM_VALIDATE_INPUT_PORT (1, port
);
829 scm_close_port (port
);
830 return SCM_UNSPECIFIED
;
834 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
836 "Close the specified output port object. The routine has no effect if\n"
837 "the file has already been closed. An exception may be raised if an\n"
838 "error occurs. The value returned is unspecified.\n\n"
839 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
840 "which can close file descriptors.")
841 #define FUNC_NAME s_scm_close_output_port
843 port
= SCM_COERCE_OUTPORT (port
);
844 SCM_VALIDATE_OUTPUT_PORT (1, port
);
845 scm_close_port (port
);
846 return SCM_UNSPECIFIED
;
852 void (*proc
) (void *data
, SCM p
);
857 for_each_trampoline (void *data
, SCM port
, SCM result
)
859 struct for_each_data
*d
= data
;
861 d
->proc (d
->data
, port
);
867 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
869 struct for_each_data d
;
874 scm_c_weak_set_fold (for_each_trampoline
, &d
, SCM_EOL
,
875 scm_i_port_weak_set
);
879 scm_for_each_trampoline (void *data
, SCM port
)
881 scm_call_1 (SCM_PACK_POINTER (data
), port
);
884 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
886 "Apply @var{proc} to each port in the Guile port table\n"
887 "in turn. The return value is unspecified. More specifically,\n"
888 "@var{proc} is applied exactly once to every port that exists\n"
889 "in the system at the time @var{port-for-each} is invoked.\n"
890 "Changes to the port table while @var{port-for-each} is running\n"
891 "have no effect as far as @var{port-for-each} is concerned.")
892 #define FUNC_NAME s_scm_port_for_each
894 SCM_VALIDATE_PROC (1, proc
);
896 scm_c_port_for_each (scm_for_each_trampoline
, SCM_UNPACK_POINTER (proc
));
898 return SCM_UNSPECIFIED
;
904 /* Utter miscellany. Gosh, we should clean this up some time. */
906 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
908 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
909 "@code{#f}. Any object satisfying this predicate also satisfies\n"
911 #define FUNC_NAME s_scm_input_port_p
913 return scm_from_bool (SCM_INPUT_PORT_P (x
));
917 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
919 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
920 "@code{#f}. Any object satisfying this predicate also satisfies\n"
922 #define FUNC_NAME s_scm_output_port_p
924 x
= SCM_COERCE_OUTPORT (x
);
925 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
929 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
931 "Return a boolean indicating whether @var{x} is a port.\n"
932 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
934 #define FUNC_NAME s_scm_port_p
936 return scm_from_bool (SCM_PORTP (x
));
940 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
942 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
944 #define FUNC_NAME s_scm_port_closed_p
946 SCM_VALIDATE_PORT (1, port
);
947 return scm_from_bool (!SCM_OPPORTP (port
));
951 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
953 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
955 #define FUNC_NAME s_scm_eof_object_p
957 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
961 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
963 "Flush the specified output port, or the current output port if @var{port}\n"
964 "is omitted. The current output buffer contents are passed to the\n"
965 "underlying port implementation (e.g., in the case of fports, the\n"
966 "data will be written to the file and the output buffer will be cleared.)\n"
967 "It has no effect on an unbuffered port.\n\n"
968 "The return value is unspecified.")
969 #define FUNC_NAME s_scm_force_output
971 if (SCM_UNBNDP (port
))
972 port
= scm_current_output_port ();
975 port
= SCM_COERCE_OUTPORT (port
);
976 SCM_VALIDATE_OPOUTPORT (1, port
);
979 return SCM_UNSPECIFIED
;
985 flush_output_port (void *closure
, SCM port
)
987 if (SCM_OPOUTPORTP (port
))
991 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
993 "Equivalent to calling @code{force-output} on\n"
994 "all open output ports. The return value is unspecified.")
995 #define FUNC_NAME s_scm_flush_all_ports
997 scm_c_port_for_each (&flush_output_port
, NULL
);
998 return SCM_UNSPECIFIED
;
1002 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1004 "Return the next character available from @var{port}, updating\n"
1005 "@var{port} to point to the following character. If no more\n"
1006 "characters are available, the end-of-file object is returned.\n"
1008 "When @var{port}'s data cannot be decoded according to its\n"
1009 "character encoding, a @code{decoding-error} is raised and\n"
1010 "@var{port} points past the erroneous byte sequence.\n")
1011 #define FUNC_NAME s_scm_read_char
1014 if (SCM_UNBNDP (port
))
1015 port
= scm_current_input_port ();
1016 SCM_VALIDATE_OPINPORT (1, port
);
1017 c
= scm_getc (port
);
1020 return SCM_MAKE_CHAR (c
);
1024 /* Update the line and column number of PORT after consumption of C. */
1026 update_port_lf (scm_t_wchar c
, SCM port
)
1051 #define SCM_MBCHAR_BUF_SIZE (4)
1053 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1054 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1056 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1058 scm_t_wchar codepoint
;
1060 if (utf8_buf
[0] <= 0x7f)
1063 codepoint
= utf8_buf
[0];
1065 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1068 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1069 | (utf8_buf
[1] & 0x3f);
1071 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1074 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1075 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1076 | (utf8_buf
[2] & 0x3f);
1081 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1082 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1083 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1084 | (utf8_buf
[3] & 0x3f);
1090 /* Read a UTF-8 sequence from PORT. On success, return 0 and set
1091 *CODEPOINT to the codepoint that was read, fill BUF with its UTF-8
1092 representation, and set *LEN to the length in bytes. Return
1093 `EILSEQ' on error. */
1095 get_utf8_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1096 scm_t_uint8 buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1098 #define ASSERT_NOT_EOF(b) \
1099 if (SCM_UNLIKELY ((b) == EOF)) \
1101 #define CONSUME_PEEKED_BYTE() \
1108 pt
= SCM_PTAB_ENTRY (port
);
1110 byte
= scm_get_byte_or_eof (port
);
1117 buf
[0] = (scm_t_uint8
) byte
;
1122 *codepoint
= buf
[0];
1123 else if (buf
[0] >= 0xc2 && buf
[0] <= 0xdf)
1126 byte
= scm_peek_byte_or_eof (port
);
1127 ASSERT_NOT_EOF (byte
);
1129 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1132 CONSUME_PEEKED_BYTE ();
1133 buf
[1] = (scm_t_uint8
) byte
;
1136 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x1f) << 6UL
1139 else if ((buf
[0] & 0xf0) == 0xe0)
1142 byte
= scm_peek_byte_or_eof (port
);
1143 ASSERT_NOT_EOF (byte
);
1145 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80
1146 || (buf
[0] == 0xe0 && byte
< 0xa0)
1147 || (buf
[0] == 0xed && byte
> 0x9f)))
1150 CONSUME_PEEKED_BYTE ();
1151 buf
[1] = (scm_t_uint8
) byte
;
1154 byte
= scm_peek_byte_or_eof (port
);
1155 ASSERT_NOT_EOF (byte
);
1157 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1160 CONSUME_PEEKED_BYTE ();
1161 buf
[2] = (scm_t_uint8
) byte
;
1164 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x0f) << 12UL
1165 | ((scm_t_wchar
) buf
[1] & 0x3f) << 6UL
1168 else if (buf
[0] >= 0xf0 && buf
[0] <= 0xf4)
1171 byte
= scm_peek_byte_or_eof (port
);
1172 ASSERT_NOT_EOF (byte
);
1174 if (SCM_UNLIKELY (((byte
& 0xc0) != 0x80)
1175 || (buf
[0] == 0xf0 && byte
< 0x90)
1176 || (buf
[0] == 0xf4 && byte
> 0x8f)))
1179 CONSUME_PEEKED_BYTE ();
1180 buf
[1] = (scm_t_uint8
) byte
;
1183 byte
= scm_peek_byte_or_eof (port
);
1184 ASSERT_NOT_EOF (byte
);
1186 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1189 CONSUME_PEEKED_BYTE ();
1190 buf
[2] = (scm_t_uint8
) byte
;
1193 byte
= scm_peek_byte_or_eof (port
);
1194 ASSERT_NOT_EOF (byte
);
1196 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1199 CONSUME_PEEKED_BYTE ();
1200 buf
[3] = (scm_t_uint8
) byte
;
1203 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x07) << 18UL
1204 | ((scm_t_wchar
) buf
[1] & 0x3f) << 12UL
1205 | ((scm_t_wchar
) buf
[2] & 0x3f) << 6UL
1214 /* Here we could choose the consume the faulty byte when it's not a
1215 valid starting byte, but it's not a requirement. What Section 3.9
1216 of Unicode 6.0.0 mandates, though, is to not consume a byte that
1217 would otherwise be a valid starting byte. */
1221 #undef CONSUME_PEEKED_BYTE
1222 #undef ASSERT_NOT_EOF
1225 /* Likewise, read a byte sequence from PORT, passing it through its
1226 input conversion descriptor. */
1228 get_iconv_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1229 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1233 size_t bytes_consumed
, output_size
;
1235 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1237 pt
= SCM_PTAB_ENTRY (port
);
1239 for (output_size
= 0, output
= (char *) utf8_buf
,
1240 bytes_consumed
= 0, err
= 0;
1241 err
== 0 && output_size
== 0
1242 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1246 size_t input_left
, output_left
, done
;
1248 byte_read
= scm_get_byte_or_eof (port
);
1249 if (byte_read
== EOF
)
1251 if (bytes_consumed
== 0)
1253 *codepoint
= (scm_t_wchar
) EOF
;
1261 buf
[bytes_consumed
] = byte_read
;
1264 input_left
= bytes_consumed
+ 1;
1265 output_left
= sizeof (utf8_buf
);
1267 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1268 &output
, &output_left
);
1269 if (done
== (size_t) -1)
1273 /* Missing input: keep trying. */
1277 output_size
= sizeof (utf8_buf
) - output_left
;
1280 if (SCM_UNLIKELY (output_size
== 0))
1281 /* An unterminated sequence. */
1283 else if (SCM_LIKELY (err
== 0))
1285 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1286 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1287 *len
= bytes_consumed
;
1293 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1294 with the byte representation of the codepoint in PORT's encoding, and
1295 set *LEN to the length in bytes of that representation. Return 0 on
1296 success and an errno value on error. */
1298 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1299 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1302 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1304 if (pt
->input_cd
== (iconv_t
) -1)
1305 /* Initialize the conversion descriptors, if needed. */
1306 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1308 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
1309 if (pt
->input_cd
== (iconv_t
) -1)
1310 err
= get_utf8_codepoint (port
, codepoint
, (scm_t_uint8
*) buf
, len
);
1312 err
= get_iconv_codepoint (port
, codepoint
, buf
, len
);
1314 if (SCM_LIKELY (err
== 0))
1315 update_port_lf (*codepoint
, port
);
1316 else if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1320 update_port_lf (*codepoint
, port
);
1326 /* Read a codepoint from PORT and return it. */
1329 #define FUNC_NAME "scm_getc"
1333 scm_t_wchar codepoint
;
1334 char buf
[SCM_MBCHAR_BUF_SIZE
];
1336 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1337 if (SCM_UNLIKELY (err
!= 0))
1338 /* At this point PORT should point past the invalid encoding, as per
1339 R6RS-lib Section 8.2.4. */
1340 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1346 /* this should only be called when the read buffer is empty. it
1347 tries to refill the read buffer. it returns the first char from
1348 the port, which is either EOF or *(pt->read_pos). */
1350 scm_fill_input (SCM port
)
1352 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1354 assert (pt
->read_pos
== pt
->read_end
);
1356 if (pt
->read_buf
== pt
->putback_buf
)
1358 /* finished reading put-back chars. */
1359 pt
->read_buf
= pt
->saved_read_buf
;
1360 pt
->read_pos
= pt
->saved_read_pos
;
1361 pt
->read_end
= pt
->saved_read_end
;
1362 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1363 if (pt
->read_pos
< pt
->read_end
)
1364 return *(pt
->read_pos
);
1366 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1372 * This function differs from scm_c_write; it updates port line and
1376 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1378 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1379 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1381 if (pt
->rw_active
== SCM_PORT_READ
)
1382 scm_end_input (port
);
1384 ptob
->write (port
, ptr
, size
);
1386 for (; size
; ptr
++, size
--)
1387 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1390 pt
->rw_active
= SCM_PORT_WRITE
;
1393 /* Write STR to PORT from START inclusive to END exclusive. */
1395 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1397 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1399 if (pt
->rw_active
== SCM_PORT_READ
)
1400 scm_end_input (port
);
1402 if (end
== (size_t) -1)
1403 end
= scm_i_string_length (str
);
1405 scm_display (scm_c_substring (str
, start
, end
), port
);
1408 pt
->rw_active
= SCM_PORT_WRITE
;
1413 * Used by an application to read arbitrary number of bytes from an
1414 * SCM port. Same semantics as libc read, except that scm_c_read only
1415 * returns less than SIZE bytes if at end-of-file.
1417 * Warning: Doesn't update port line and column counts! */
1419 /* This structure, and the following swap_buffer function, are used
1420 for temporarily swapping a port's own read buffer, and the buffer
1421 that the caller of scm_c_read provides. */
1422 struct port_and_swap_buffer
1425 unsigned char *buffer
;
1430 swap_buffer (void *data
)
1432 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1433 unsigned char *old_buf
= psb
->pt
->read_buf
;
1434 size_t old_size
= psb
->pt
->read_buf_size
;
1436 /* Make the port use (buffer, size) from the struct. */
1437 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1438 psb
->pt
->read_buf_size
= psb
->size
;
1440 /* Save the port's old (buffer, size) in the struct. */
1441 psb
->buffer
= old_buf
;
1442 psb
->size
= old_size
;
1446 scm_c_read (SCM port
, void *buffer
, size_t size
)
1447 #define FUNC_NAME "scm_c_read"
1450 size_t n_read
= 0, n_available
;
1451 struct port_and_swap_buffer psb
;
1453 SCM_VALIDATE_OPINPORT (1, port
);
1455 pt
= SCM_PTAB_ENTRY (port
);
1456 if (pt
->rw_active
== SCM_PORT_WRITE
)
1457 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1460 pt
->rw_active
= SCM_PORT_READ
;
1462 /* Take bytes first from the port's read buffer. */
1463 if (pt
->read_pos
< pt
->read_end
)
1465 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1466 memcpy (buffer
, pt
->read_pos
, n_available
);
1467 buffer
= (char *) buffer
+ n_available
;
1468 pt
->read_pos
+= n_available
;
1469 n_read
+= n_available
;
1470 size
-= n_available
;
1473 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1477 /* Now we will call scm_fill_input repeatedly until we have read the
1478 requested number of bytes. (Note that a single scm_fill_input
1479 call does not guarantee to fill the whole of the port's read
1481 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1483 /* The port that we are reading from is unbuffered - i.e. does
1484 not have its own persistent buffer - but we have a buffer,
1485 provided by our caller, that is the right size for the data
1486 that is wanted. For the following scm_fill_input calls,
1487 therefore, we use the buffer in hand as the port's read
1490 We need to make sure that the port's normal (1 byte) buffer
1491 is reinstated in case one of the scm_fill_input () calls
1492 throws an exception; we use the scm_dynwind_* API to achieve
1495 A consequence of this optimization is that the fill_input
1496 functions can't unget characters. That'll push data to the
1497 pushback buffer instead of this psb buffer. */
1499 unsigned char *pback
= pt
->putback_buf
;
1502 psb
.buffer
= buffer
;
1504 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1505 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1506 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1508 /* Call scm_fill_input until we have all the bytes that we need,
1510 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1512 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1513 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1516 if (pback
!= pt
->putback_buf
1517 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1518 scm_misc_error (FUNC_NAME
,
1519 "scm_c_read must not call a fill function that pushes "
1520 "back characters onto an unbuffered port", SCM_EOL
);
1522 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1524 /* Reinstate the port's normal buffer. */
1529 /* The port has its own buffer. It is important that we use it,
1530 even if it happens to be smaller than our caller's buffer, so
1531 that a custom port implementation's entry points (in
1532 particular, fill_input) can rely on the buffer always being
1533 the same as they first set up. */
1534 while (size
&& (scm_fill_input (port
) != EOF
))
1536 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1537 memcpy (buffer
, pt
->read_pos
, n_available
);
1538 buffer
= (char *) buffer
+ n_available
;
1539 pt
->read_pos
+= n_available
;
1540 n_read
+= n_available
;
1541 size
-= n_available
;
1551 * Used by an application to write arbitrary number of bytes to an SCM
1552 * port. Similar semantics as libc write. However, unlike libc
1553 * write, scm_c_write writes the requested number of bytes and has no
1556 * Warning: Doesn't update port line and column counts!
1560 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1561 #define FUNC_NAME "scm_c_write"
1564 scm_t_ptob_descriptor
*ptob
;
1566 SCM_VALIDATE_OPOUTPORT (1, port
);
1568 pt
= SCM_PTAB_ENTRY (port
);
1569 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1571 if (pt
->rw_active
== SCM_PORT_READ
)
1572 scm_end_input (port
);
1574 ptob
->write (port
, ptr
, size
);
1577 pt
->rw_active
= SCM_PORT_WRITE
;
1582 scm_flush (SCM port
)
1584 long i
= SCM_PTOBNUM (port
);
1586 (scm_ptobs
[i
].flush
) (port
);
1590 scm_end_input (SCM port
)
1593 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1595 if (pt
->read_buf
== pt
->putback_buf
)
1597 offset
= pt
->read_end
- pt
->read_pos
;
1598 pt
->read_buf
= pt
->saved_read_buf
;
1599 pt
->read_pos
= pt
->saved_read_pos
;
1600 pt
->read_end
= pt
->saved_read_end
;
1601 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1606 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1613 scm_unget_byte (int c
, SCM port
)
1614 #define FUNC_NAME "scm_unget_byte"
1616 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1618 if (pt
->read_buf
== pt
->putback_buf
)
1619 /* already using the put-back buffer. */
1621 /* enlarge putback_buf if necessary. */
1622 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1623 && pt
->read_buf
== pt
->read_pos
)
1625 size_t new_size
= pt
->read_buf_size
* 2;
1626 unsigned char *tmp
= (unsigned char *)
1627 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1630 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1631 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1632 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1635 /* shift any existing bytes to buffer + 1. */
1636 if (pt
->read_pos
== pt
->read_end
)
1637 pt
->read_end
= pt
->read_buf
+ 1;
1638 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1640 int count
= pt
->read_end
- pt
->read_pos
;
1642 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1643 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1646 pt
->read_pos
= pt
->read_buf
;
1649 /* switch to the put-back buffer. */
1651 if (pt
->putback_buf
== NULL
)
1654 = (unsigned char *) scm_gc_malloc_pointerless
1655 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1656 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1659 pt
->saved_read_buf
= pt
->read_buf
;
1660 pt
->saved_read_pos
= pt
->read_pos
;
1661 pt
->saved_read_end
= pt
->read_end
;
1662 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1664 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1665 pt
->read_end
= pt
->read_buf
+ 1;
1666 pt
->read_buf_size
= pt
->putback_buf_size
;
1672 pt
->rw_active
= SCM_PORT_READ
;
1677 scm_ungetc (scm_t_wchar c
, SCM port
)
1678 #define FUNC_NAME "scm_ungetc"
1680 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1682 char result_buf
[10];
1683 const char *encoding
;
1687 if (pt
->encoding
!= NULL
)
1688 encoding
= pt
->encoding
;
1690 encoding
= "ISO-8859-1";
1692 len
= sizeof (result_buf
);
1693 result
= u32_conv_to_encoding (encoding
,
1694 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1695 (uint32_t *) &c
, 1, NULL
,
1698 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1699 scm_encoding_error (FUNC_NAME
, errno
,
1700 "conversion to port encoding failed",
1701 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1703 for (i
= len
- 1; i
>= 0; i
--)
1704 scm_unget_byte (result
[i
], port
);
1706 if (SCM_UNLIKELY (result
!= result_buf
))
1711 /* What should col be in this case?
1712 * We'll leave it at -1.
1714 SCM_LINUM (port
) -= 1;
1723 scm_ungets (const char *s
, int n
, SCM port
)
1725 /* This is simple minded and inefficient, but unreading strings is
1726 * probably not a common operation, and remember that line and
1727 * column numbers have to be handled...
1729 * Please feel free to write an optimized version!
1732 scm_ungetc (s
[n
], port
);
1736 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1738 "Return the next character available from @var{port},\n"
1739 "@emph{without} updating @var{port} to point to the following\n"
1740 "character. If no more characters are available, the\n"
1741 "end-of-file object is returned.\n"
1743 "The value returned by\n"
1744 "a call to @code{peek-char} is the same as the value that would\n"
1745 "have been returned by a call to @code{read-char} on the same\n"
1746 "port. The only difference is that the very next call to\n"
1747 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1748 "return the value returned by the preceding call to\n"
1749 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1750 "an interactive port will hang waiting for input whenever a call\n"
1751 "to @code{read-char} would have hung.\n"
1753 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1754 "if such a situation occurs. However, unlike with @code{read-char},\n"
1755 "@var{port} still points at the beginning of the erroneous byte\n"
1756 "sequence when the error is raised.\n")
1757 #define FUNC_NAME s_scm_peek_char
1762 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1763 long column
, line
, i
;
1766 if (SCM_UNBNDP (port
))
1767 port
= scm_current_input_port ();
1768 SCM_VALIDATE_OPINPORT (1, port
);
1770 column
= SCM_COL (port
);
1771 line
= SCM_LINUM (port
);
1773 err
= get_codepoint (port
, &c
, bytes
, &len
);
1775 for (i
= len
- 1; i
>= 0; i
--)
1776 scm_unget_byte (bytes
[i
], port
);
1778 SCM_COL (port
) = column
;
1779 SCM_LINUM (port
) = line
;
1781 if (SCM_UNLIKELY (err
!= 0))
1783 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1785 /* Shouldn't happen since `catch' always aborts to prompt. */
1786 result
= SCM_BOOL_F
;
1789 result
= SCM_EOF_VAL
;
1791 result
= SCM_MAKE_CHAR (c
);
1797 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1798 (SCM cobj
, SCM port
),
1799 "Place @var{char} in @var{port} so that it will be read by the\n"
1800 "next read operation. If called multiple times, the unread characters\n"
1801 "will be read again in last-in first-out order. If @var{port} is\n"
1802 "not supplied, the current input port is used.")
1803 #define FUNC_NAME s_scm_unread_char
1807 SCM_VALIDATE_CHAR (1, cobj
);
1808 if (SCM_UNBNDP (port
))
1809 port
= scm_current_input_port ();
1810 SCM_VALIDATE_OPINPORT (2, port
);
1812 c
= SCM_CHAR (cobj
);
1814 scm_ungetc (c
, port
);
1819 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1820 (SCM str
, SCM port
),
1821 "Place the string @var{str} in @var{port} so that its characters will be\n"
1822 "read in subsequent read operations. If called multiple times, the\n"
1823 "unread characters will be read again in last-in first-out order. If\n"
1824 "@var{port} is not supplied, the current-input-port is used.")
1825 #define FUNC_NAME s_scm_unread_string
1828 SCM_VALIDATE_STRING (1, str
);
1829 if (SCM_UNBNDP (port
))
1830 port
= scm_current_input_port ();
1831 SCM_VALIDATE_OPINPORT (2, port
);
1833 n
= scm_i_string_length (str
);
1836 scm_ungetc (scm_i_string_ref (str
, n
), port
);
1842 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1843 (SCM fd_port
, SCM offset
, SCM whence
),
1844 "Sets the current position of @var{fd/port} to the integer\n"
1845 "@var{offset}, which is interpreted according to the value of\n"
1848 "One of the following variables should be supplied for\n"
1850 "@defvar SEEK_SET\n"
1851 "Seek from the beginning of the file.\n"
1853 "@defvar SEEK_CUR\n"
1854 "Seek from the current position.\n"
1856 "@defvar SEEK_END\n"
1857 "Seek from the end of the file.\n"
1859 "If @var{fd/port} is a file descriptor, the underlying system\n"
1860 "call is @code{lseek}. @var{port} may be a string port.\n"
1862 "The value returned is the new position in the file. This means\n"
1863 "that the current position of a port can be obtained using:\n"
1865 "(seek port 0 SEEK_CUR)\n"
1867 #define FUNC_NAME s_scm_seek
1871 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1873 how
= scm_to_int (whence
);
1874 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1875 SCM_OUT_OF_RANGE (3, whence
);
1877 if (SCM_OPPORTP (fd_port
))
1879 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1880 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1881 off_t_or_off64_t rv
;
1884 SCM_MISC_ERROR ("port is not seekable",
1885 scm_cons (fd_port
, SCM_EOL
));
1887 rv
= ptob
->seek (fd_port
, off
, how
);
1888 return scm_from_off_t_or_off64_t (rv
);
1890 else /* file descriptor?. */
1892 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1893 off_t_or_off64_t rv
;
1894 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1897 return scm_from_off_t_or_off64_t (rv
);
1906 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1907 doesn't have the filename version truncate(), hence this code. */
1908 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1910 truncate (const char *file
, off_t length
)
1914 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1918 ret
= ftruncate (fdes
, length
);
1921 int save_errno
= errno
;
1927 return close (fdes
);
1929 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1931 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1932 (SCM object
, SCM length
),
1933 "Truncate @var{file} to @var{length} bytes. @var{file} can be a\n"
1934 "filename string, a port object, or an integer file descriptor.\n"
1935 "The return value is unspecified.\n"
1937 "For a port or file descriptor @var{length} can be omitted, in\n"
1938 "which case the file is truncated at the current position (per\n"
1939 "@code{ftell} above).\n"
1941 "On most systems a file can be extended by giving a length\n"
1942 "greater than the current size, but this is not mandatory in the\n"
1944 #define FUNC_NAME s_scm_truncate_file
1948 /* "object" can be a port, fdes or filename.
1950 Negative "length" makes no sense, but it's left to truncate() or
1951 ftruncate() to give back an error for that (normally EINVAL).
1954 if (SCM_UNBNDP (length
))
1956 /* must supply length if object is a filename. */
1957 if (scm_is_string (object
))
1958 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
1960 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
1963 object
= SCM_COERCE_OUTPORT (object
);
1964 if (scm_is_integer (object
))
1966 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1967 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
1970 else if (SCM_OPOUTPORTP (object
))
1972 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1973 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
1974 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1976 if (!ptob
->truncate
)
1977 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
1978 if (pt
->rw_active
== SCM_PORT_READ
)
1979 scm_end_input (object
);
1980 else if (pt
->rw_active
== SCM_PORT_WRITE
)
1981 ptob
->flush (object
);
1983 ptob
->truncate (object
, c_length
);
1988 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1989 char *str
= scm_to_locale_string (object
);
1991 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
1998 return SCM_UNSPECIFIED
;
2002 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
2004 "Return the current line number for @var{port}.\n"
2006 "The first line of a file is 0. But you might want to add 1\n"
2007 "when printing line numbers, since starting from 1 is\n"
2008 "traditional in error messages, and likely to be more natural to\n"
2010 #define FUNC_NAME s_scm_port_line
2012 port
= SCM_COERCE_OUTPORT (port
);
2013 SCM_VALIDATE_OPENPORT (1, port
);
2014 return scm_from_long (SCM_LINUM (port
));
2018 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
2019 (SCM port
, SCM line
),
2020 "Set the current line number for @var{port} to @var{line}. The\n"
2021 "first line of a file is 0.")
2022 #define FUNC_NAME s_scm_set_port_line_x
2024 port
= SCM_COERCE_OUTPORT (port
);
2025 SCM_VALIDATE_OPENPORT (1, port
);
2026 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
2027 return SCM_UNSPECIFIED
;
2031 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
2033 "Return the current column number of @var{port}.\n"
2034 "If the number is\n"
2035 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
2036 "- i.e. the first character of the first line is line 0, column 0.\n"
2037 "(However, when you display a file position, for example in an error\n"
2038 "message, we recommend you add 1 to get 1-origin integers. This is\n"
2039 "because lines and column numbers traditionally start with 1, and that is\n"
2040 "what non-programmers will find most natural.)")
2041 #define FUNC_NAME s_scm_port_column
2043 port
= SCM_COERCE_OUTPORT (port
);
2044 SCM_VALIDATE_OPENPORT (1, port
);
2045 return scm_from_int (SCM_COL (port
));
2049 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
2050 (SCM port
, SCM column
),
2051 "Set the current column of @var{port}. Before reading the first\n"
2052 "character on a line the column should be 0.")
2053 #define FUNC_NAME s_scm_set_port_column_x
2055 port
= SCM_COERCE_OUTPORT (port
);
2056 SCM_VALIDATE_OPENPORT (1, port
);
2057 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
2058 return SCM_UNSPECIFIED
;
2062 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
2064 "Return the filename associated with @var{port}, or @code{#f}\n"
2065 "if no filename is associated with the port.")
2066 #define FUNC_NAME s_scm_port_filename
2068 port
= SCM_COERCE_OUTPORT (port
);
2069 SCM_VALIDATE_OPENPORT (1, port
);
2070 return SCM_FILENAME (port
);
2074 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
2075 (SCM port
, SCM filename
),
2076 "Change the filename associated with @var{port}, using the current input\n"
2077 "port if none is specified. Note that this does not change the port's\n"
2078 "source of data, but only the value that is returned by\n"
2079 "@code{port-filename} and reported in diagnostic output.")
2080 #define FUNC_NAME s_scm_set_port_filename_x
2082 port
= SCM_COERCE_OUTPORT (port
);
2083 SCM_VALIDATE_OPENPORT (1, port
);
2084 /* We allow the user to set the filename to whatever he likes. */
2085 SCM_SET_FILENAME (port
, filename
);
2086 return SCM_UNSPECIFIED
;
2090 /* A fluid specifying the default encoding for newly created ports. If it is
2091 a string, that is the encoding. If it is #f, it is in the "native"
2092 (Latin-1) encoding. */
2093 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
2095 static int scm_port_encoding_init
= 0;
2097 /* Use ENCODING as the default encoding for future ports. */
2099 scm_i_set_default_port_encoding (const char *encoding
)
2101 if (!scm_port_encoding_init
2102 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2103 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
2106 if (encoding
== NULL
2107 || !strcmp (encoding
, "ASCII")
2108 || !strcmp (encoding
, "ANSI_X3.4-1968")
2109 || !strcmp (encoding
, "ISO-8859-1"))
2110 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2112 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
2113 scm_from_locale_string (encoding
));
2116 /* Return the name of the default encoding for newly created ports; a
2117 return value of NULL means "ISO-8859-1". */
2119 scm_i_default_port_encoding (void)
2121 if (!scm_port_encoding_init
)
2123 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2129 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
2130 if (!scm_is_string (encoding
))
2133 return scm_i_string_chars (encoding
);
2138 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2141 iconv_t new_input_cd
, new_output_cd
;
2143 new_input_cd
= (iconv_t
) -1;
2144 new_output_cd
= (iconv_t
) -1;
2146 /* Set the character encoding for this port. */
2147 pt
= SCM_PTAB_ENTRY (port
);
2149 if (encoding
== NULL
)
2150 encoding
= "ISO-8859-1";
2152 if (pt
->encoding
!= encoding
)
2153 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2155 /* If ENCODING is UTF-8, then no conversion descriptor is opened
2156 because we do I/O ourselves. This saves 100+ KiB for each
2158 if (strcmp (encoding
, "UTF-8"))
2160 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2162 /* Open an input iconv conversion descriptor, from ENCODING
2163 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2164 implementations can typically convert from anything to
2165 UTF-8, but not to UTF-32 (see
2166 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2167 new_input_cd
= iconv_open ("UTF-8", encoding
);
2168 if (new_input_cd
== (iconv_t
) -1)
2169 goto invalid_encoding
;
2172 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2174 new_output_cd
= iconv_open (encoding
, "UTF-8");
2175 if (new_output_cd
== (iconv_t
) -1)
2177 if (new_input_cd
!= (iconv_t
) -1)
2178 iconv_close (new_input_cd
);
2179 goto invalid_encoding
;
2184 if (pt
->input_cd
!= (iconv_t
) -1)
2185 iconv_close (pt
->input_cd
);
2186 if (pt
->output_cd
!= (iconv_t
) -1)
2187 iconv_close (pt
->output_cd
);
2189 pt
->input_cd
= new_input_cd
;
2190 pt
->output_cd
= new_output_cd
;
2197 err
= scm_from_locale_string (encoding
);
2198 scm_misc_error ("scm_i_set_port_encoding_x",
2199 "invalid or unknown character encoding ~s",
2204 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2206 "Returns, as a string, the character encoding that @var{port}\n"
2207 "uses to interpret its input and output.\n")
2208 #define FUNC_NAME s_scm_port_encoding
2213 SCM_VALIDATE_PORT (1, port
);
2215 pt
= SCM_PTAB_ENTRY (port
);
2218 return scm_from_locale_string (pt
->encoding
);
2224 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2225 (SCM port
, SCM enc
),
2226 "Sets the character encoding that will be used to interpret all\n"
2227 "port I/O. New ports are created with the encoding\n"
2228 "appropriate for the current locale if @code{setlocale} has \n"
2229 "been called or ISO-8859-1 otherwise\n"
2230 "and this procedure can be used to modify that encoding.\n")
2231 #define FUNC_NAME s_scm_set_port_encoding_x
2235 SCM_VALIDATE_PORT (1, port
);
2236 SCM_VALIDATE_STRING (2, enc
);
2238 enc_str
= scm_to_locale_string (enc
);
2239 scm_i_set_port_encoding_x (port
, enc_str
);
2242 return SCM_UNSPECIFIED
;
2247 /* This determines how conversions handle unconvertible characters. */
2248 SCM_GLOBAL_VARIABLE (scm_conversion_strategy
, "%port-conversion-strategy");
2249 static int scm_conversion_strategy_init
= 0;
2251 scm_t_string_failed_conversion_handler
2252 scm_i_get_conversion_strategy (SCM port
)
2256 if (scm_is_false (port
))
2258 if (!scm_conversion_strategy_init
2259 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2260 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2263 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (scm_conversion_strategy
));
2264 if (scm_is_false (encoding
))
2265 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2267 return (scm_t_string_failed_conversion_handler
) scm_to_int (encoding
);
2273 pt
= SCM_PTAB_ENTRY (port
);
2274 return pt
->ilseq_handler
;
2280 scm_i_set_conversion_strategy_x (SCM port
,
2281 scm_t_string_failed_conversion_handler handler
)
2286 strategy
= scm_from_int ((int) handler
);
2288 if (scm_is_false (port
))
2290 /* Set the default encoding for future ports. */
2291 if (!scm_conversion_strategy_init
2292 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2293 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2295 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
), strategy
);
2299 /* Set the character encoding for this port. */
2300 pt
= SCM_PTAB_ENTRY (port
);
2301 pt
->ilseq_handler
= handler
;
2305 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2306 1, 0, 0, (SCM port
),
2307 "Returns the behavior of the port when handling a character that\n"
2308 "is not representable in the port's current encoding.\n"
2309 "It returns the symbol @code{error} if unrepresentable characters\n"
2310 "should cause exceptions, @code{substitute} if the port should\n"
2311 "try to replace unrepresentable characters with question marks or\n"
2312 "approximate characters, or @code{escape} if unrepresentable\n"
2313 "characters should be converted to string escapes.\n"
2315 "If @var{port} is @code{#f}, then the current default behavior\n"
2316 "will be returned. New ports will have this default behavior\n"
2317 "when they are created.\n")
2318 #define FUNC_NAME s_scm_port_conversion_strategy
2320 scm_t_string_failed_conversion_handler h
;
2322 SCM_VALIDATE_OPPORT (1, port
);
2324 if (!scm_is_false (port
))
2326 SCM_VALIDATE_OPPORT (1, port
);
2329 h
= scm_i_get_conversion_strategy (port
);
2330 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2331 return scm_from_latin1_symbol ("error");
2332 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2333 return scm_from_latin1_symbol ("substitute");
2334 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2335 return scm_from_latin1_symbol ("escape");
2339 /* Never gets here. */
2340 return SCM_UNDEFINED
;
2344 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2346 (SCM port
, SCM sym
),
2347 "Sets the behavior of the interpreter when outputting a character\n"
2348 "that is not representable in the port's current encoding.\n"
2349 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2350 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2351 "when an unconvertible character is encountered. If it is\n"
2352 "@code{'substitute}, then unconvertible characters will \n"
2353 "be replaced with approximate characters, or with question marks\n"
2354 "if no approximately correct character is available.\n"
2355 "If it is @code{'escape},\n"
2356 "it will appear as a hex escape when output.\n"
2358 "If @var{port} is an open port, the conversion error behavior\n"
2359 "is set for that port. If it is @code{#f}, it is set as the\n"
2360 "default behavior for any future ports that get created in\n"
2362 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2368 if (!scm_is_false (port
))
2370 SCM_VALIDATE_OPPORT (1, port
);
2373 err
= scm_from_latin1_symbol ("error");
2374 if (scm_is_true (scm_eqv_p (sym
, err
)))
2376 scm_i_set_conversion_strategy_x (port
, SCM_FAILED_CONVERSION_ERROR
);
2377 return SCM_UNSPECIFIED
;
2380 qm
= scm_from_latin1_symbol ("substitute");
2381 if (scm_is_true (scm_eqv_p (sym
, qm
)))
2383 scm_i_set_conversion_strategy_x (port
,
2384 SCM_FAILED_CONVERSION_QUESTION_MARK
);
2385 return SCM_UNSPECIFIED
;
2388 esc
= scm_from_latin1_symbol ("escape");
2389 if (scm_is_true (scm_eqv_p (sym
, esc
)))
2391 scm_i_set_conversion_strategy_x (port
,
2392 SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
);
2393 return SCM_UNSPECIFIED
;
2396 SCM_MISC_ERROR ("unknown conversion behavior ~s", scm_list_1 (sym
));
2398 return SCM_UNSPECIFIED
;
2405 scm_print_port_mode (SCM exp
, SCM port
)
2407 scm_puts (SCM_CLOSEDP (exp
)
2409 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2410 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2413 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2420 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2422 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2425 scm_puts ("#<", port
);
2426 scm_print_port_mode (exp
, port
);
2427 scm_puts (type
, port
);
2428 scm_putc (' ', port
);
2429 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2430 scm_putc ('>', port
);
2438 scm_t_bits scm_tc16_void_port
= 0;
2440 static int fill_input_void_port (SCM port SCM_UNUSED
)
2446 write_void_port (SCM port SCM_UNUSED
,
2447 const void *data SCM_UNUSED
,
2448 size_t size SCM_UNUSED
)
2453 scm_i_void_port (long mode_bits
)
2457 ret
= scm_c_make_port (scm_tc16_void_port
, mode_bits
, 0);
2459 scm_port_non_buffer (SCM_PTAB_ENTRY (ret
));
2465 scm_void_port (char *mode_str
)
2467 return scm_i_void_port (scm_mode_bits (mode_str
));
2470 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2472 "Create and return a new void port. A void port acts like\n"
2473 "@file{/dev/null}. The @var{mode} argument\n"
2474 "specifies the input/output modes for this port: see the\n"
2475 "documentation for @code{open-file} in @ref{File Ports}.")
2476 #define FUNC_NAME s_scm_sys_make_void_port
2478 return scm_i_void_port (scm_i_mode_bits (mode
));
2483 /* Initialization. */
2488 /* lseek() symbols. */
2489 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2490 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2491 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2493 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2496 cur_inport_fluid
= scm_make_fluid ();
2497 cur_outport_fluid
= scm_make_fluid ();
2498 cur_errport_fluid
= scm_make_fluid ();
2499 cur_loadport_fluid
= scm_make_fluid ();
2501 scm_i_port_weak_set
= scm_c_make_weak_set (31);
2503 #include "libguile/ports.x"
2505 /* Use Latin-1 as the default port encoding. */
2506 SCM_VARIABLE_SET (default_port_encoding_var
, scm_make_fluid ());
2507 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2508 scm_port_encoding_init
= 1;
2510 SCM_VARIABLE_SET (scm_conversion_strategy
, scm_make_fluid ());
2511 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
),
2512 scm_from_int ((int) SCM_FAILED_CONVERSION_QUESTION_MARK
));
2513 scm_conversion_strategy_init
= 1;