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 (SCM2PTR (port
), finalize_port
, 0,
530 &prev_finalization_data
);
533 /* Finalize the object (a port) pointed to by PTR. */
535 finalize_port (GC_PTR ptr
, GC_PTR data
)
538 SCM port
= PTR2SCM (ptr
);
540 if (!SCM_PORTP (port
))
543 if (SCM_OPENP (port
))
545 if (SCM_REVEALED (port
) > 0)
546 /* Keep "revealed" ports alive and re-register a finalizer. */
547 register_finalizer_for_port (port
);
552 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
553 if (port_type
>= scm_numptob
)
556 if (scm_ptobs
[port_type
].free
)
557 /* Yes, I really do mean `.free' rather than `.close'. `.close'
558 is for explicit `close-port' by user. */
559 scm_ptobs
[port_type
].free (port
);
561 entry
= SCM_PTAB_ENTRY (port
);
563 if (entry
->input_cd
!= (iconv_t
) -1)
564 iconv_close (entry
->input_cd
);
565 if (entry
->output_cd
!= (iconv_t
) -1)
566 iconv_close (entry
->output_cd
);
568 SCM_SETSTREAM (port
, 0);
569 SCM_CLR_PORT_OPEN_FLAG (port
);
571 scm_gc_ports_collected
++;
581 scm_c_make_port_with_encoding (scm_t_bits tag
, unsigned long mode_bits
,
582 const char *encoding
,
583 scm_t_string_failed_conversion_handler handler
,
589 entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
590 ret
= scm_cell (tag
| mode_bits
, (scm_t_bits
)entry
);
592 entry
->file_name
= SCM_BOOL_F
;
593 entry
->rw_active
= SCM_PORT_NEITHER
;
595 entry
->stream
= stream
;
596 entry
->encoding
= encoding
? scm_gc_strdup (encoding
, "port") : NULL
;
597 /* The conversion descriptors will be opened lazily. */
598 entry
->input_cd
= (iconv_t
) -1;
599 entry
->output_cd
= (iconv_t
) -1;
600 entry
->ilseq_handler
= handler
;
602 scm_weak_set_add_x (scm_i_port_weak_set
, ret
);
604 /* For each new port, register a finalizer so that it port type's free
605 function can be invoked eventually. */
606 register_finalizer_for_port (ret
);
612 scm_c_make_port (scm_t_bits tag
, unsigned long mode_bits
, scm_t_bits stream
)
614 return scm_c_make_port_with_encoding (tag
, mode_bits
,
615 scm_i_default_port_encoding (),
616 scm_i_get_conversion_strategy (SCM_BOOL_F
),
621 scm_new_port_table_entry (scm_t_bits tag
)
623 return scm_c_make_port (tag
, 0, 0);
626 /* Remove a port from the table and destroy it. */
629 scm_i_remove_port (SCM port
)
630 #define FUNC_NAME "scm_remove_port"
634 p
= SCM_PTAB_ENTRY (port
);
635 scm_port_non_buffer (p
);
636 SCM_SETPTAB_ENTRY (port
, 0);
637 scm_weak_set_remove_x (scm_i_port_weak_set
, port
);
639 p
->putback_buf
= NULL
;
640 p
->putback_buf_size
= 0;
642 if (p
->input_cd
!= (iconv_t
) -1)
644 iconv_close (p
->input_cd
);
645 p
->input_cd
= (iconv_t
) -1;
648 if (p
->output_cd
!= (iconv_t
) -1)
650 iconv_close (p
->output_cd
);
651 p
->output_cd
= (iconv_t
) -1;
658 scm_port_non_buffer (scm_t_port
*pt
)
660 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
661 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
662 pt
->read_buf_size
= pt
->write_buf_size
= 1;
663 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
667 /* Revealed counts --- an oddity inherited from SCSH. */
669 /* Find a port in the table and return its revealed count.
670 Also used by the garbage collector.
674 scm_revealed_count (SCM port
)
676 return SCM_REVEALED(port
);
681 /* Return the revealed count for a port. */
683 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
685 "Return the revealed count for @var{port}.")
686 #define FUNC_NAME s_scm_port_revealed
688 port
= SCM_COERCE_OUTPORT (port
);
689 SCM_VALIDATE_OPENPORT (1, port
);
690 return scm_from_int (scm_revealed_count (port
));
694 /* Set the revealed count for a port. */
695 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
696 (SCM port
, SCM rcount
),
697 "Sets the revealed count for a port to a given value.\n"
698 "The return value is unspecified.")
699 #define FUNC_NAME s_scm_set_port_revealed_x
701 port
= SCM_COERCE_OUTPORT (port
);
702 SCM_VALIDATE_OPENPORT (1, port
);
703 SCM_REVEALED (port
) = scm_to_int (rcount
);
704 return SCM_UNSPECIFIED
;
710 /* Retrieving a port's mode. */
712 /* Return the flags that characterize a port based on the mode
713 * string used to open a file for that port.
715 * See PORT FLAGS in scm.h
719 scm_i_mode_bits_n (SCM modes
)
722 | (scm_i_string_contains_char (modes
, 'r')
723 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
724 | (scm_i_string_contains_char (modes
, 'w')
725 || scm_i_string_contains_char (modes
, 'a')
726 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
727 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
728 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
732 scm_mode_bits (char *modes
)
734 return scm_i_mode_bits (scm_from_locale_string (modes
));
738 scm_i_mode_bits (SCM modes
)
742 if (!scm_is_string (modes
))
743 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
745 bits
= scm_i_mode_bits_n (modes
);
746 scm_remember_upto_here_1 (modes
);
750 /* Return the mode flags from an open port.
751 * Some modes such as "append" are only used when opening
752 * a file and are not returned here. */
754 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
756 "Return the port modes associated with the open port @var{port}.\n"
757 "These will not necessarily be identical to the modes used when\n"
758 "the port was opened, since modes such as \"append\" which are\n"
759 "used only during port creation are not retained.")
760 #define FUNC_NAME s_scm_port_mode
765 port
= SCM_COERCE_OUTPORT (port
);
766 SCM_VALIDATE_OPPORT (1, port
);
767 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
768 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
769 strcpy (modes
, "r+");
773 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
775 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
777 return scm_from_locale_string (modes
);
786 * Call the close operation on a port object.
787 * see also scm_close.
789 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
791 "Close the specified port object. Return @code{#t} if it\n"
792 "successfully closes a port or @code{#f} if it was already\n"
793 "closed. An exception may be raised if an error occurs, for\n"
794 "example when flushing buffered output. See also @ref{Ports and\n"
795 "File Descriptors, close}, for a procedure which can close file\n"
797 #define FUNC_NAME s_scm_close_port
802 port
= SCM_COERCE_OUTPORT (port
);
804 SCM_VALIDATE_PORT (1, port
);
805 if (SCM_CLOSEDP (port
))
807 i
= SCM_PTOBNUM (port
);
808 if (scm_ptobs
[i
].close
)
809 rv
= (scm_ptobs
[i
].close
) (port
);
812 scm_i_remove_port (port
);
813 SCM_CLR_PORT_OPEN_FLAG (port
);
814 return scm_from_bool (rv
>= 0);
818 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
820 "Close the specified input port object. The routine has no effect if\n"
821 "the file has already been closed. An exception may be raised if an\n"
822 "error occurs. The value returned is unspecified.\n\n"
823 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
824 "which can close file descriptors.")
825 #define FUNC_NAME s_scm_close_input_port
827 SCM_VALIDATE_INPUT_PORT (1, port
);
828 scm_close_port (port
);
829 return SCM_UNSPECIFIED
;
833 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
835 "Close the specified output port object. The routine has no effect if\n"
836 "the file has already been closed. An exception may be raised if an\n"
837 "error occurs. The value returned is unspecified.\n\n"
838 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
839 "which can close file descriptors.")
840 #define FUNC_NAME s_scm_close_output_port
842 port
= SCM_COERCE_OUTPORT (port
);
843 SCM_VALIDATE_OUTPUT_PORT (1, port
);
844 scm_close_port (port
);
845 return SCM_UNSPECIFIED
;
851 void (*proc
) (void *data
, SCM p
);
856 for_each_trampoline (void *data
, SCM port
, SCM result
)
858 struct for_each_data
*d
= data
;
860 d
->proc (d
->data
, port
);
866 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
868 struct for_each_data d
;
873 scm_c_weak_set_fold (for_each_trampoline
, &d
, SCM_EOL
,
874 scm_i_port_weak_set
);
878 scm_for_each_trampoline (void *data
, SCM port
)
880 scm_call_1 (PTR2SCM (data
), port
);
883 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
885 "Apply @var{proc} to each port in the Guile port table\n"
886 "in turn. The return value is unspecified. More specifically,\n"
887 "@var{proc} is applied exactly once to every port that exists\n"
888 "in the system at the time @var{port-for-each} is invoked.\n"
889 "Changes to the port table while @var{port-for-each} is running\n"
890 "have no effect as far as @var{port-for-each} is concerned.")
891 #define FUNC_NAME s_scm_port_for_each
893 SCM_VALIDATE_PROC (1, proc
);
895 scm_c_port_for_each (scm_for_each_trampoline
, SCM2PTR (proc
));
897 return SCM_UNSPECIFIED
;
903 /* Utter miscellany. Gosh, we should clean this up some time. */
905 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
907 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
908 "@code{#f}. Any object satisfying this predicate also satisfies\n"
910 #define FUNC_NAME s_scm_input_port_p
912 return scm_from_bool (SCM_INPUT_PORT_P (x
));
916 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
918 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
919 "@code{#f}. Any object satisfying this predicate also satisfies\n"
921 #define FUNC_NAME s_scm_output_port_p
923 x
= SCM_COERCE_OUTPORT (x
);
924 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
928 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
930 "Return a boolean indicating whether @var{x} is a port.\n"
931 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
933 #define FUNC_NAME s_scm_port_p
935 return scm_from_bool (SCM_PORTP (x
));
939 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
941 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
943 #define FUNC_NAME s_scm_port_closed_p
945 SCM_VALIDATE_PORT (1, port
);
946 return scm_from_bool (!SCM_OPPORTP (port
));
950 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
952 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
954 #define FUNC_NAME s_scm_eof_object_p
956 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
960 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
962 "Flush the specified output port, or the current output port if @var{port}\n"
963 "is omitted. The current output buffer contents are passed to the\n"
964 "underlying port implementation (e.g., in the case of fports, the\n"
965 "data will be written to the file and the output buffer will be cleared.)\n"
966 "It has no effect on an unbuffered port.\n\n"
967 "The return value is unspecified.")
968 #define FUNC_NAME s_scm_force_output
970 if (SCM_UNBNDP (port
))
971 port
= scm_current_output_port ();
974 port
= SCM_COERCE_OUTPORT (port
);
975 SCM_VALIDATE_OPOUTPORT (1, port
);
978 return SCM_UNSPECIFIED
;
984 flush_output_port (void *closure
, SCM port
)
986 if (SCM_OPOUTPORTP (port
))
990 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
992 "Equivalent to calling @code{force-output} on\n"
993 "all open output ports. The return value is unspecified.")
994 #define FUNC_NAME s_scm_flush_all_ports
996 scm_c_port_for_each (&flush_output_port
, NULL
);
997 return SCM_UNSPECIFIED
;
1001 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1003 "Return the next character available from @var{port}, updating\n"
1004 "@var{port} to point to the following character. If no more\n"
1005 "characters are available, the end-of-file object is returned.\n"
1007 "When @var{port}'s data cannot be decoded according to its\n"
1008 "character encoding, a @code{decoding-error} is raised and\n"
1009 "@var{port} points past the erroneous byte sequence.\n")
1010 #define FUNC_NAME s_scm_read_char
1013 if (SCM_UNBNDP (port
))
1014 port
= scm_current_input_port ();
1015 SCM_VALIDATE_OPINPORT (1, port
);
1016 c
= scm_getc (port
);
1019 return SCM_MAKE_CHAR (c
);
1023 /* Update the line and column number of PORT after consumption of C. */
1025 update_port_lf (scm_t_wchar c
, SCM port
)
1050 #define SCM_MBCHAR_BUF_SIZE (4)
1052 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1053 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1055 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1057 scm_t_wchar codepoint
;
1059 if (utf8_buf
[0] <= 0x7f)
1062 codepoint
= utf8_buf
[0];
1064 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1067 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1068 | (utf8_buf
[1] & 0x3f);
1070 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1073 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1074 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1075 | (utf8_buf
[2] & 0x3f);
1080 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1081 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1082 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1083 | (utf8_buf
[3] & 0x3f);
1089 /* Read a UTF-8 sequence from PORT. On success, return 0 and set
1090 *CODEPOINT to the codepoint that was read, fill BUF with its UTF-8
1091 representation, and set *LEN to the length in bytes. Return
1092 `EILSEQ' on error. */
1094 get_utf8_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1095 scm_t_uint8 buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1097 #define ASSERT_NOT_EOF(b) \
1098 if (SCM_UNLIKELY ((b) == EOF)) \
1100 #define CONSUME_PEEKED_BYTE() \
1107 pt
= SCM_PTAB_ENTRY (port
);
1109 byte
= scm_get_byte_or_eof (port
);
1116 buf
[0] = (scm_t_uint8
) byte
;
1121 *codepoint
= buf
[0];
1122 else if (buf
[0] >= 0xc2 && buf
[0] <= 0xdf)
1125 byte
= scm_peek_byte_or_eof (port
);
1126 ASSERT_NOT_EOF (byte
);
1128 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1131 CONSUME_PEEKED_BYTE ();
1132 buf
[1] = (scm_t_uint8
) byte
;
1135 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x1f) << 6UL
1138 else if ((buf
[0] & 0xf0) == 0xe0)
1141 byte
= scm_peek_byte_or_eof (port
);
1142 ASSERT_NOT_EOF (byte
);
1144 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80
1145 || (buf
[0] == 0xe0 && byte
< 0xa0)
1146 || (buf
[0] == 0xed && byte
> 0x9f)))
1149 CONSUME_PEEKED_BYTE ();
1150 buf
[1] = (scm_t_uint8
) byte
;
1153 byte
= scm_peek_byte_or_eof (port
);
1154 ASSERT_NOT_EOF (byte
);
1156 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1159 CONSUME_PEEKED_BYTE ();
1160 buf
[2] = (scm_t_uint8
) byte
;
1163 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x0f) << 12UL
1164 | ((scm_t_wchar
) buf
[1] & 0x3f) << 6UL
1167 else if (buf
[0] >= 0xf0 && buf
[0] <= 0xf4)
1170 byte
= scm_peek_byte_or_eof (port
);
1171 ASSERT_NOT_EOF (byte
);
1173 if (SCM_UNLIKELY (((byte
& 0xc0) != 0x80)
1174 || (buf
[0] == 0xf0 && byte
< 0x90)
1175 || (buf
[0] == 0xf4 && byte
> 0x8f)))
1178 CONSUME_PEEKED_BYTE ();
1179 buf
[1] = (scm_t_uint8
) byte
;
1182 byte
= scm_peek_byte_or_eof (port
);
1183 ASSERT_NOT_EOF (byte
);
1185 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1188 CONSUME_PEEKED_BYTE ();
1189 buf
[2] = (scm_t_uint8
) byte
;
1192 byte
= scm_peek_byte_or_eof (port
);
1193 ASSERT_NOT_EOF (byte
);
1195 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1198 CONSUME_PEEKED_BYTE ();
1199 buf
[3] = (scm_t_uint8
) byte
;
1202 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x07) << 18UL
1203 | ((scm_t_wchar
) buf
[1] & 0x3f) << 12UL
1204 | ((scm_t_wchar
) buf
[2] & 0x3f) << 6UL
1213 /* Here we could choose the consume the faulty byte when it's not a
1214 valid starting byte, but it's not a requirement. What Section 3.9
1215 of Unicode 6.0.0 mandates, though, is to not consume a byte that
1216 would otherwise be a valid starting byte. */
1220 #undef CONSUME_PEEKED_BYTE
1221 #undef ASSERT_NOT_EOF
1224 /* Likewise, read a byte sequence from PORT, passing it through its
1225 input conversion descriptor. */
1227 get_iconv_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1228 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1232 size_t bytes_consumed
, output_size
;
1234 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1236 pt
= SCM_PTAB_ENTRY (port
);
1238 for (output_size
= 0, output
= (char *) utf8_buf
,
1239 bytes_consumed
= 0, err
= 0;
1240 err
== 0 && output_size
== 0
1241 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1245 size_t input_left
, output_left
, done
;
1247 byte_read
= scm_get_byte_or_eof (port
);
1248 if (byte_read
== EOF
)
1250 if (bytes_consumed
== 0)
1252 *codepoint
= (scm_t_wchar
) EOF
;
1260 buf
[bytes_consumed
] = byte_read
;
1263 input_left
= bytes_consumed
+ 1;
1264 output_left
= sizeof (utf8_buf
);
1266 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1267 &output
, &output_left
);
1268 if (done
== (size_t) -1)
1272 /* Missing input: keep trying. */
1276 output_size
= sizeof (utf8_buf
) - output_left
;
1279 if (SCM_UNLIKELY (output_size
== 0))
1280 /* An unterminated sequence. */
1282 else if (SCM_LIKELY (err
== 0))
1284 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1285 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1286 *len
= bytes_consumed
;
1292 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1293 with the byte representation of the codepoint in PORT's encoding, and
1294 set *LEN to the length in bytes of that representation. Return 0 on
1295 success and an errno value on error. */
1297 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1298 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1301 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1303 if (pt
->input_cd
== (iconv_t
) -1)
1304 /* Initialize the conversion descriptors, if needed. */
1305 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1307 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
1308 if (pt
->input_cd
== (iconv_t
) -1)
1309 err
= get_utf8_codepoint (port
, codepoint
, (scm_t_uint8
*) buf
, len
);
1311 err
= get_iconv_codepoint (port
, codepoint
, buf
, len
);
1313 if (SCM_LIKELY (err
== 0))
1314 update_port_lf (*codepoint
, port
);
1315 else if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1319 update_port_lf (*codepoint
, port
);
1325 /* Read a codepoint from PORT and return it. */
1328 #define FUNC_NAME "scm_getc"
1332 scm_t_wchar codepoint
;
1333 char buf
[SCM_MBCHAR_BUF_SIZE
];
1335 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1336 if (SCM_UNLIKELY (err
!= 0))
1337 /* At this point PORT should point past the invalid encoding, as per
1338 R6RS-lib Section 8.2.4. */
1339 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1345 /* this should only be called when the read buffer is empty. it
1346 tries to refill the read buffer. it returns the first char from
1347 the port, which is either EOF or *(pt->read_pos). */
1349 scm_fill_input (SCM port
)
1351 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1353 assert (pt
->read_pos
== pt
->read_end
);
1355 if (pt
->read_buf
== pt
->putback_buf
)
1357 /* finished reading put-back chars. */
1358 pt
->read_buf
= pt
->saved_read_buf
;
1359 pt
->read_pos
= pt
->saved_read_pos
;
1360 pt
->read_end
= pt
->saved_read_end
;
1361 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1362 if (pt
->read_pos
< pt
->read_end
)
1363 return *(pt
->read_pos
);
1365 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1371 * This function differs from scm_c_write; it updates port line and
1375 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1377 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1378 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1380 if (pt
->rw_active
== SCM_PORT_READ
)
1381 scm_end_input (port
);
1383 ptob
->write (port
, ptr
, size
);
1385 for (; size
; ptr
++, size
--)
1386 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1389 pt
->rw_active
= SCM_PORT_WRITE
;
1392 /* Write STR to PORT from START inclusive to END exclusive. */
1394 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1396 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1398 if (pt
->rw_active
== SCM_PORT_READ
)
1399 scm_end_input (port
);
1401 if (end
== (size_t) -1)
1402 end
= scm_i_string_length (str
);
1404 scm_display (scm_c_substring (str
, start
, end
), port
);
1407 pt
->rw_active
= SCM_PORT_WRITE
;
1412 * Used by an application to read arbitrary number of bytes from an
1413 * SCM port. Same semantics as libc read, except that scm_c_read only
1414 * returns less than SIZE bytes if at end-of-file.
1416 * Warning: Doesn't update port line and column counts! */
1418 /* This structure, and the following swap_buffer function, are used
1419 for temporarily swapping a port's own read buffer, and the buffer
1420 that the caller of scm_c_read provides. */
1421 struct port_and_swap_buffer
1424 unsigned char *buffer
;
1429 swap_buffer (void *data
)
1431 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1432 unsigned char *old_buf
= psb
->pt
->read_buf
;
1433 size_t old_size
= psb
->pt
->read_buf_size
;
1435 /* Make the port use (buffer, size) from the struct. */
1436 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1437 psb
->pt
->read_buf_size
= psb
->size
;
1439 /* Save the port's old (buffer, size) in the struct. */
1440 psb
->buffer
= old_buf
;
1441 psb
->size
= old_size
;
1445 scm_c_read (SCM port
, void *buffer
, size_t size
)
1446 #define FUNC_NAME "scm_c_read"
1449 size_t n_read
= 0, n_available
;
1450 struct port_and_swap_buffer psb
;
1452 SCM_VALIDATE_OPINPORT (1, port
);
1454 pt
= SCM_PTAB_ENTRY (port
);
1455 if (pt
->rw_active
== SCM_PORT_WRITE
)
1456 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1459 pt
->rw_active
= SCM_PORT_READ
;
1461 /* Take bytes first from the port's read buffer. */
1462 if (pt
->read_pos
< pt
->read_end
)
1464 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1465 memcpy (buffer
, pt
->read_pos
, n_available
);
1466 buffer
= (char *) buffer
+ n_available
;
1467 pt
->read_pos
+= n_available
;
1468 n_read
+= n_available
;
1469 size
-= n_available
;
1472 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1476 /* Now we will call scm_fill_input repeatedly until we have read the
1477 requested number of bytes. (Note that a single scm_fill_input
1478 call does not guarantee to fill the whole of the port's read
1480 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1482 /* The port that we are reading from is unbuffered - i.e. does
1483 not have its own persistent buffer - but we have a buffer,
1484 provided by our caller, that is the right size for the data
1485 that is wanted. For the following scm_fill_input calls,
1486 therefore, we use the buffer in hand as the port's read
1489 We need to make sure that the port's normal (1 byte) buffer
1490 is reinstated in case one of the scm_fill_input () calls
1491 throws an exception; we use the scm_dynwind_* API to achieve
1494 A consequence of this optimization is that the fill_input
1495 functions can't unget characters. That'll push data to the
1496 pushback buffer instead of this psb buffer. */
1498 unsigned char *pback
= pt
->putback_buf
;
1501 psb
.buffer
= buffer
;
1503 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1504 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1505 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1507 /* Call scm_fill_input until we have all the bytes that we need,
1509 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1511 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1512 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1515 if (pback
!= pt
->putback_buf
1516 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1517 scm_misc_error (FUNC_NAME
,
1518 "scm_c_read must not call a fill function that pushes "
1519 "back characters onto an unbuffered port", SCM_EOL
);
1521 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1523 /* Reinstate the port's normal buffer. */
1528 /* The port has its own buffer. It is important that we use it,
1529 even if it happens to be smaller than our caller's buffer, so
1530 that a custom port implementation's entry points (in
1531 particular, fill_input) can rely on the buffer always being
1532 the same as they first set up. */
1533 while (size
&& (scm_fill_input (port
) != EOF
))
1535 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1536 memcpy (buffer
, pt
->read_pos
, n_available
);
1537 buffer
= (char *) buffer
+ n_available
;
1538 pt
->read_pos
+= n_available
;
1539 n_read
+= n_available
;
1540 size
-= n_available
;
1550 * Used by an application to write arbitrary number of bytes to an SCM
1551 * port. Similar semantics as libc write. However, unlike libc
1552 * write, scm_c_write writes the requested number of bytes and has no
1555 * Warning: Doesn't update port line and column counts!
1559 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1560 #define FUNC_NAME "scm_c_write"
1563 scm_t_ptob_descriptor
*ptob
;
1565 SCM_VALIDATE_OPOUTPORT (1, port
);
1567 pt
= SCM_PTAB_ENTRY (port
);
1568 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1570 if (pt
->rw_active
== SCM_PORT_READ
)
1571 scm_end_input (port
);
1573 ptob
->write (port
, ptr
, size
);
1576 pt
->rw_active
= SCM_PORT_WRITE
;
1581 scm_flush (SCM port
)
1583 long i
= SCM_PTOBNUM (port
);
1585 (scm_ptobs
[i
].flush
) (port
);
1589 scm_end_input (SCM port
)
1592 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1594 if (pt
->read_buf
== pt
->putback_buf
)
1596 offset
= pt
->read_end
- pt
->read_pos
;
1597 pt
->read_buf
= pt
->saved_read_buf
;
1598 pt
->read_pos
= pt
->saved_read_pos
;
1599 pt
->read_end
= pt
->saved_read_end
;
1600 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1605 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1612 scm_unget_byte (int c
, SCM port
)
1613 #define FUNC_NAME "scm_unget_byte"
1615 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1617 if (pt
->read_buf
== pt
->putback_buf
)
1618 /* already using the put-back buffer. */
1620 /* enlarge putback_buf if necessary. */
1621 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1622 && pt
->read_buf
== pt
->read_pos
)
1624 size_t new_size
= pt
->read_buf_size
* 2;
1625 unsigned char *tmp
= (unsigned char *)
1626 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1629 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1630 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1631 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1634 /* shift any existing bytes to buffer + 1. */
1635 if (pt
->read_pos
== pt
->read_end
)
1636 pt
->read_end
= pt
->read_buf
+ 1;
1637 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1639 int count
= pt
->read_end
- pt
->read_pos
;
1641 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1642 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1645 pt
->read_pos
= pt
->read_buf
;
1648 /* switch to the put-back buffer. */
1650 if (pt
->putback_buf
== NULL
)
1653 = (unsigned char *) scm_gc_malloc_pointerless
1654 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1655 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1658 pt
->saved_read_buf
= pt
->read_buf
;
1659 pt
->saved_read_pos
= pt
->read_pos
;
1660 pt
->saved_read_end
= pt
->read_end
;
1661 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1663 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1664 pt
->read_end
= pt
->read_buf
+ 1;
1665 pt
->read_buf_size
= pt
->putback_buf_size
;
1671 pt
->rw_active
= SCM_PORT_READ
;
1676 scm_ungetc (scm_t_wchar c
, SCM port
)
1677 #define FUNC_NAME "scm_ungetc"
1679 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1681 char result_buf
[10];
1682 const char *encoding
;
1686 if (pt
->encoding
!= NULL
)
1687 encoding
= pt
->encoding
;
1689 encoding
= "ISO-8859-1";
1691 len
= sizeof (result_buf
);
1692 result
= u32_conv_to_encoding (encoding
,
1693 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1694 (uint32_t *) &c
, 1, NULL
,
1697 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1698 scm_encoding_error (FUNC_NAME
, errno
,
1699 "conversion to port encoding failed",
1700 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1702 for (i
= len
- 1; i
>= 0; i
--)
1703 scm_unget_byte (result
[i
], port
);
1705 if (SCM_UNLIKELY (result
!= result_buf
))
1710 /* What should col be in this case?
1711 * We'll leave it at -1.
1713 SCM_LINUM (port
) -= 1;
1722 scm_ungets (const char *s
, int n
, SCM port
)
1724 /* This is simple minded and inefficient, but unreading strings is
1725 * probably not a common operation, and remember that line and
1726 * column numbers have to be handled...
1728 * Please feel free to write an optimized version!
1731 scm_ungetc (s
[n
], port
);
1735 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1737 "Return the next character available from @var{port},\n"
1738 "@emph{without} updating @var{port} to point to the following\n"
1739 "character. If no more characters are available, the\n"
1740 "end-of-file object is returned.\n"
1742 "The value returned by\n"
1743 "a call to @code{peek-char} is the same as the value that would\n"
1744 "have been returned by a call to @code{read-char} on the same\n"
1745 "port. The only difference is that the very next call to\n"
1746 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1747 "return the value returned by the preceding call to\n"
1748 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1749 "an interactive port will hang waiting for input whenever a call\n"
1750 "to @code{read-char} would have hung.\n"
1752 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1753 "if such a situation occurs. However, unlike with @code{read-char},\n"
1754 "@var{port} still points at the beginning of the erroneous byte\n"
1755 "sequence when the error is raised.\n")
1756 #define FUNC_NAME s_scm_peek_char
1761 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1762 long column
, line
, i
;
1765 if (SCM_UNBNDP (port
))
1766 port
= scm_current_input_port ();
1767 SCM_VALIDATE_OPINPORT (1, port
);
1769 column
= SCM_COL (port
);
1770 line
= SCM_LINUM (port
);
1772 err
= get_codepoint (port
, &c
, bytes
, &len
);
1774 for (i
= len
- 1; i
>= 0; i
--)
1775 scm_unget_byte (bytes
[i
], port
);
1777 SCM_COL (port
) = column
;
1778 SCM_LINUM (port
) = line
;
1780 if (SCM_UNLIKELY (err
!= 0))
1782 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1784 /* Shouldn't happen since `catch' always aborts to prompt. */
1785 result
= SCM_BOOL_F
;
1788 result
= SCM_EOF_VAL
;
1790 result
= SCM_MAKE_CHAR (c
);
1796 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1797 (SCM cobj
, SCM port
),
1798 "Place @var{char} in @var{port} so that it will be read by the\n"
1799 "next read operation. If called multiple times, the unread characters\n"
1800 "will be read again in last-in first-out order. If @var{port} is\n"
1801 "not supplied, the current input port is used.")
1802 #define FUNC_NAME s_scm_unread_char
1806 SCM_VALIDATE_CHAR (1, cobj
);
1807 if (SCM_UNBNDP (port
))
1808 port
= scm_current_input_port ();
1809 SCM_VALIDATE_OPINPORT (2, port
);
1811 c
= SCM_CHAR (cobj
);
1813 scm_ungetc (c
, port
);
1818 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1819 (SCM str
, SCM port
),
1820 "Place the string @var{str} in @var{port} so that its characters will be\n"
1821 "read in subsequent read operations. If called multiple times, the\n"
1822 "unread characters will be read again in last-in first-out order. If\n"
1823 "@var{port} is not supplied, the current-input-port is used.")
1824 #define FUNC_NAME s_scm_unread_string
1827 SCM_VALIDATE_STRING (1, str
);
1828 if (SCM_UNBNDP (port
))
1829 port
= scm_current_input_port ();
1830 SCM_VALIDATE_OPINPORT (2, port
);
1832 n
= scm_i_string_length (str
);
1835 scm_ungetc (scm_i_string_ref (str
, n
), port
);
1841 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1842 (SCM fd_port
, SCM offset
, SCM whence
),
1843 "Sets the current position of @var{fd/port} to the integer\n"
1844 "@var{offset}, which is interpreted according to the value of\n"
1847 "One of the following variables should be supplied for\n"
1849 "@defvar SEEK_SET\n"
1850 "Seek from the beginning of the file.\n"
1852 "@defvar SEEK_CUR\n"
1853 "Seek from the current position.\n"
1855 "@defvar SEEK_END\n"
1856 "Seek from the end of the file.\n"
1858 "If @var{fd/port} is a file descriptor, the underlying system\n"
1859 "call is @code{lseek}. @var{port} may be a string port.\n"
1861 "The value returned is the new position in the file. This means\n"
1862 "that the current position of a port can be obtained using:\n"
1864 "(seek port 0 SEEK_CUR)\n"
1866 #define FUNC_NAME s_scm_seek
1870 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1872 how
= scm_to_int (whence
);
1873 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1874 SCM_OUT_OF_RANGE (3, whence
);
1876 if (SCM_OPPORTP (fd_port
))
1878 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1879 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1880 off_t_or_off64_t rv
;
1883 SCM_MISC_ERROR ("port is not seekable",
1884 scm_cons (fd_port
, SCM_EOL
));
1886 rv
= ptob
->seek (fd_port
, off
, how
);
1887 return scm_from_off_t_or_off64_t (rv
);
1889 else /* file descriptor?. */
1891 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1892 off_t_or_off64_t rv
;
1893 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1896 return scm_from_off_t_or_off64_t (rv
);
1905 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1906 doesn't have the filename version truncate(), hence this code. */
1907 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1909 truncate (const char *file
, off_t length
)
1913 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1917 ret
= ftruncate (fdes
, length
);
1920 int save_errno
= errno
;
1926 return close (fdes
);
1928 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1930 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1931 (SCM object
, SCM length
),
1932 "Truncate @var{file} to @var{length} bytes. @var{file} can be a\n"
1933 "filename string, a port object, or an integer file descriptor.\n"
1934 "The return value is unspecified.\n"
1936 "For a port or file descriptor @var{length} can be omitted, in\n"
1937 "which case the file is truncated at the current position (per\n"
1938 "@code{ftell} above).\n"
1940 "On most systems a file can be extended by giving a length\n"
1941 "greater than the current size, but this is not mandatory in the\n"
1943 #define FUNC_NAME s_scm_truncate_file
1947 /* "object" can be a port, fdes or filename.
1949 Negative "length" makes no sense, but it's left to truncate() or
1950 ftruncate() to give back an error for that (normally EINVAL).
1953 if (SCM_UNBNDP (length
))
1955 /* must supply length if object is a filename. */
1956 if (scm_is_string (object
))
1957 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
1959 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
1962 object
= SCM_COERCE_OUTPORT (object
);
1963 if (scm_is_integer (object
))
1965 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1966 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
1969 else if (SCM_OPOUTPORTP (object
))
1971 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1972 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
1973 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1975 if (!ptob
->truncate
)
1976 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
1977 if (pt
->rw_active
== SCM_PORT_READ
)
1978 scm_end_input (object
);
1979 else if (pt
->rw_active
== SCM_PORT_WRITE
)
1980 ptob
->flush (object
);
1982 ptob
->truncate (object
, c_length
);
1987 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1988 char *str
= scm_to_locale_string (object
);
1990 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
1997 return SCM_UNSPECIFIED
;
2001 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
2003 "Return the current line number for @var{port}.\n"
2005 "The first line of a file is 0. But you might want to add 1\n"
2006 "when printing line numbers, since starting from 1 is\n"
2007 "traditional in error messages, and likely to be more natural to\n"
2009 #define FUNC_NAME s_scm_port_line
2011 port
= SCM_COERCE_OUTPORT (port
);
2012 SCM_VALIDATE_OPENPORT (1, port
);
2013 return scm_from_long (SCM_LINUM (port
));
2017 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
2018 (SCM port
, SCM line
),
2019 "Set the current line number for @var{port} to @var{line}. The\n"
2020 "first line of a file is 0.")
2021 #define FUNC_NAME s_scm_set_port_line_x
2023 port
= SCM_COERCE_OUTPORT (port
);
2024 SCM_VALIDATE_OPENPORT (1, port
);
2025 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
2026 return SCM_UNSPECIFIED
;
2030 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
2032 "Return the current column number of @var{port}.\n"
2033 "If the number is\n"
2034 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
2035 "- i.e. the first character of the first line is line 0, column 0.\n"
2036 "(However, when you display a file position, for example in an error\n"
2037 "message, we recommend you add 1 to get 1-origin integers. This is\n"
2038 "because lines and column numbers traditionally start with 1, and that is\n"
2039 "what non-programmers will find most natural.)")
2040 #define FUNC_NAME s_scm_port_column
2042 port
= SCM_COERCE_OUTPORT (port
);
2043 SCM_VALIDATE_OPENPORT (1, port
);
2044 return scm_from_int (SCM_COL (port
));
2048 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
2049 (SCM port
, SCM column
),
2050 "Set the current column of @var{port}. Before reading the first\n"
2051 "character on a line the column should be 0.")
2052 #define FUNC_NAME s_scm_set_port_column_x
2054 port
= SCM_COERCE_OUTPORT (port
);
2055 SCM_VALIDATE_OPENPORT (1, port
);
2056 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
2057 return SCM_UNSPECIFIED
;
2061 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
2063 "Return the filename associated with @var{port}, or @code{#f}\n"
2064 "if no filename is associated with the port.")
2065 #define FUNC_NAME s_scm_port_filename
2067 port
= SCM_COERCE_OUTPORT (port
);
2068 SCM_VALIDATE_OPENPORT (1, port
);
2069 return SCM_FILENAME (port
);
2073 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
2074 (SCM port
, SCM filename
),
2075 "Change the filename associated with @var{port}, using the current input\n"
2076 "port if none is specified. Note that this does not change the port's\n"
2077 "source of data, but only the value that is returned by\n"
2078 "@code{port-filename} and reported in diagnostic output.")
2079 #define FUNC_NAME s_scm_set_port_filename_x
2081 port
= SCM_COERCE_OUTPORT (port
);
2082 SCM_VALIDATE_OPENPORT (1, port
);
2083 /* We allow the user to set the filename to whatever he likes. */
2084 SCM_SET_FILENAME (port
, filename
);
2085 return SCM_UNSPECIFIED
;
2089 /* A fluid specifying the default encoding for newly created ports. If it is
2090 a string, that is the encoding. If it is #f, it is in the "native"
2091 (Latin-1) encoding. */
2092 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
2094 static int scm_port_encoding_init
= 0;
2096 /* Use ENCODING as the default encoding for future ports. */
2098 scm_i_set_default_port_encoding (const char *encoding
)
2100 if (!scm_port_encoding_init
2101 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2102 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
2105 if (encoding
== NULL
2106 || !strcmp (encoding
, "ASCII")
2107 || !strcmp (encoding
, "ANSI_X3.4-1968")
2108 || !strcmp (encoding
, "ISO-8859-1"))
2109 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2111 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
2112 scm_from_locale_string (encoding
));
2115 /* Return the name of the default encoding for newly created ports; a
2116 return value of NULL means "ISO-8859-1". */
2118 scm_i_default_port_encoding (void)
2120 if (!scm_port_encoding_init
)
2122 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2128 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
2129 if (!scm_is_string (encoding
))
2132 return scm_i_string_chars (encoding
);
2137 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2140 iconv_t new_input_cd
, new_output_cd
;
2142 new_input_cd
= (iconv_t
) -1;
2143 new_output_cd
= (iconv_t
) -1;
2145 /* Set the character encoding for this port. */
2146 pt
= SCM_PTAB_ENTRY (port
);
2148 if (encoding
== NULL
)
2149 encoding
= "ISO-8859-1";
2151 if (pt
->encoding
!= encoding
)
2152 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2154 /* If ENCODING is UTF-8, then no conversion descriptor is opened
2155 because we do I/O ourselves. This saves 100+ KiB for each
2157 if (strcmp (encoding
, "UTF-8"))
2159 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2161 /* Open an input iconv conversion descriptor, from ENCODING
2162 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2163 implementations can typically convert from anything to
2164 UTF-8, but not to UTF-32 (see
2165 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2166 new_input_cd
= iconv_open ("UTF-8", encoding
);
2167 if (new_input_cd
== (iconv_t
) -1)
2168 goto invalid_encoding
;
2171 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2173 new_output_cd
= iconv_open (encoding
, "UTF-8");
2174 if (new_output_cd
== (iconv_t
) -1)
2176 if (new_input_cd
!= (iconv_t
) -1)
2177 iconv_close (new_input_cd
);
2178 goto invalid_encoding
;
2183 if (pt
->input_cd
!= (iconv_t
) -1)
2184 iconv_close (pt
->input_cd
);
2185 if (pt
->output_cd
!= (iconv_t
) -1)
2186 iconv_close (pt
->output_cd
);
2188 pt
->input_cd
= new_input_cd
;
2189 pt
->output_cd
= new_output_cd
;
2196 err
= scm_from_locale_string (encoding
);
2197 scm_misc_error ("scm_i_set_port_encoding_x",
2198 "invalid or unknown character encoding ~s",
2203 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2205 "Returns, as a string, the character encoding that @var{port}\n"
2206 "uses to interpret its input and output.\n")
2207 #define FUNC_NAME s_scm_port_encoding
2212 SCM_VALIDATE_PORT (1, port
);
2214 pt
= SCM_PTAB_ENTRY (port
);
2217 return scm_from_locale_string (pt
->encoding
);
2223 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2224 (SCM port
, SCM enc
),
2225 "Sets the character encoding that will be used to interpret all\n"
2226 "port I/O. New ports are created with the encoding\n"
2227 "appropriate for the current locale if @code{setlocale} has \n"
2228 "been called or ISO-8859-1 otherwise\n"
2229 "and this procedure can be used to modify that encoding.\n")
2230 #define FUNC_NAME s_scm_set_port_encoding_x
2234 SCM_VALIDATE_PORT (1, port
);
2235 SCM_VALIDATE_STRING (2, enc
);
2237 enc_str
= scm_to_locale_string (enc
);
2238 scm_i_set_port_encoding_x (port
, enc_str
);
2241 return SCM_UNSPECIFIED
;
2246 /* This determines how conversions handle unconvertible characters. */
2247 SCM_GLOBAL_VARIABLE (scm_conversion_strategy
, "%port-conversion-strategy");
2248 static int scm_conversion_strategy_init
= 0;
2250 scm_t_string_failed_conversion_handler
2251 scm_i_get_conversion_strategy (SCM port
)
2255 if (scm_is_false (port
))
2257 if (!scm_conversion_strategy_init
2258 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2259 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2262 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (scm_conversion_strategy
));
2263 if (scm_is_false (encoding
))
2264 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2266 return (scm_t_string_failed_conversion_handler
) scm_to_int (encoding
);
2272 pt
= SCM_PTAB_ENTRY (port
);
2273 return pt
->ilseq_handler
;
2279 scm_i_set_conversion_strategy_x (SCM port
,
2280 scm_t_string_failed_conversion_handler handler
)
2285 strategy
= scm_from_int ((int) handler
);
2287 if (scm_is_false (port
))
2289 /* Set the default encoding for future ports. */
2290 if (!scm_conversion_strategy_init
2291 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2292 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2294 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
), strategy
);
2298 /* Set the character encoding for this port. */
2299 pt
= SCM_PTAB_ENTRY (port
);
2300 pt
->ilseq_handler
= handler
;
2304 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2305 1, 0, 0, (SCM port
),
2306 "Returns the behavior of the port when handling a character that\n"
2307 "is not representable in the port's current encoding.\n"
2308 "It returns the symbol @code{error} if unrepresentable characters\n"
2309 "should cause exceptions, @code{substitute} if the port should\n"
2310 "try to replace unrepresentable characters with question marks or\n"
2311 "approximate characters, or @code{escape} if unrepresentable\n"
2312 "characters should be converted to string escapes.\n"
2314 "If @var{port} is @code{#f}, then the current default behavior\n"
2315 "will be returned. New ports will have this default behavior\n"
2316 "when they are created.\n")
2317 #define FUNC_NAME s_scm_port_conversion_strategy
2319 scm_t_string_failed_conversion_handler h
;
2321 SCM_VALIDATE_OPPORT (1, port
);
2323 if (!scm_is_false (port
))
2325 SCM_VALIDATE_OPPORT (1, port
);
2328 h
= scm_i_get_conversion_strategy (port
);
2329 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2330 return scm_from_latin1_symbol ("error");
2331 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2332 return scm_from_latin1_symbol ("substitute");
2333 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2334 return scm_from_latin1_symbol ("escape");
2338 /* Never gets here. */
2339 return SCM_UNDEFINED
;
2343 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2345 (SCM port
, SCM sym
),
2346 "Sets the behavior of the interpreter when outputting a character\n"
2347 "that is not representable in the port's current encoding.\n"
2348 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2349 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2350 "when an unconvertible character is encountered. If it is\n"
2351 "@code{'substitute}, then unconvertible characters will \n"
2352 "be replaced with approximate characters, or with question marks\n"
2353 "if no approximately correct character is available.\n"
2354 "If it is @code{'escape},\n"
2355 "it will appear as a hex escape when output.\n"
2357 "If @var{port} is an open port, the conversion error behavior\n"
2358 "is set for that port. If it is @code{#f}, it is set as the\n"
2359 "default behavior for any future ports that get created in\n"
2361 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2367 if (!scm_is_false (port
))
2369 SCM_VALIDATE_OPPORT (1, port
);
2372 err
= scm_from_latin1_symbol ("error");
2373 if (scm_is_true (scm_eqv_p (sym
, err
)))
2375 scm_i_set_conversion_strategy_x (port
, SCM_FAILED_CONVERSION_ERROR
);
2376 return SCM_UNSPECIFIED
;
2379 qm
= scm_from_latin1_symbol ("substitute");
2380 if (scm_is_true (scm_eqv_p (sym
, qm
)))
2382 scm_i_set_conversion_strategy_x (port
,
2383 SCM_FAILED_CONVERSION_QUESTION_MARK
);
2384 return SCM_UNSPECIFIED
;
2387 esc
= scm_from_latin1_symbol ("escape");
2388 if (scm_is_true (scm_eqv_p (sym
, esc
)))
2390 scm_i_set_conversion_strategy_x (port
,
2391 SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
);
2392 return SCM_UNSPECIFIED
;
2395 SCM_MISC_ERROR ("unknown conversion behavior ~s", scm_list_1 (sym
));
2397 return SCM_UNSPECIFIED
;
2404 scm_print_port_mode (SCM exp
, SCM port
)
2406 scm_puts (SCM_CLOSEDP (exp
)
2408 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2409 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2412 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2419 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2421 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2424 scm_puts ("#<", port
);
2425 scm_print_port_mode (exp
, port
);
2426 scm_puts (type
, port
);
2427 scm_putc (' ', port
);
2428 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2429 scm_putc ('>', port
);
2437 scm_t_bits scm_tc16_void_port
= 0;
2439 static int fill_input_void_port (SCM port SCM_UNUSED
)
2445 write_void_port (SCM port SCM_UNUSED
,
2446 const void *data SCM_UNUSED
,
2447 size_t size SCM_UNUSED
)
2452 scm_i_void_port (long mode_bits
)
2456 ret
= scm_c_make_port (scm_tc16_void_port
, mode_bits
, 0);
2458 scm_port_non_buffer (SCM_PTAB_ENTRY (ret
));
2464 scm_void_port (char *mode_str
)
2466 return scm_i_void_port (scm_mode_bits (mode_str
));
2469 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2471 "Create and return a new void port. A void port acts like\n"
2472 "@file{/dev/null}. The @var{mode} argument\n"
2473 "specifies the input/output modes for this port: see the\n"
2474 "documentation for @code{open-file} in @ref{File Ports}.")
2475 #define FUNC_NAME s_scm_sys_make_void_port
2477 return scm_i_void_port (scm_i_mode_bits (mode
));
2482 /* Initialization. */
2487 /* lseek() symbols. */
2488 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2489 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2490 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2492 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2495 cur_inport_fluid
= scm_make_fluid ();
2496 cur_outport_fluid
= scm_make_fluid ();
2497 cur_errport_fluid
= scm_make_fluid ();
2498 cur_loadport_fluid
= scm_make_fluid ();
2500 scm_i_port_weak_set
= scm_c_make_weak_set (31);
2502 #include "libguile/ports.x"
2504 /* Use Latin-1 as the default port encoding. */
2505 SCM_VARIABLE_SET (default_port_encoding_var
, scm_make_fluid ());
2506 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2507 scm_port_encoding_init
= 1;
2509 SCM_VARIABLE_SET (scm_conversion_strategy
, scm_make_fluid ());
2510 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
),
2511 scm_from_int ((int) SCM_FAILED_CONVERSION_QUESTION_MARK
));
2512 scm_conversion_strategy_init
= 1;