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 static scm_t_ptob_descriptor
**scm_ptobs
= NULL
;
102 static long scm_numptob
= 0; /* Number of port types. */
103 static long scm_ptobs_size
= 0; /* Number of slots in the port type
105 static scm_i_pthread_mutex_t scm_ptobs_lock
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
108 scm_c_num_port_types (void)
112 scm_i_pthread_mutex_lock (&scm_ptobs_lock
);
114 scm_i_pthread_mutex_unlock (&scm_ptobs_lock
);
119 scm_t_ptob_descriptor
*
120 scm_c_port_type_ref (long ptobnum
)
122 scm_t_ptob_descriptor
*ret
= NULL
;
124 scm_i_pthread_mutex_lock (&scm_ptobs_lock
);
126 if (0 <= ptobnum
&& ptobnum
< scm_numptob
)
127 ret
= scm_ptobs
[ptobnum
];
129 scm_i_pthread_mutex_unlock (&scm_ptobs_lock
);
132 scm_out_of_range ("scm_c_port_type_ref", scm_from_long (ptobnum
));
138 scm_c_port_type_add_x (scm_t_ptob_descriptor
*desc
)
142 scm_i_pthread_mutex_lock (&scm_ptobs_lock
);
144 if (scm_numptob
+ 1 < SCM_I_MAX_PORT_TYPE_COUNT
)
146 if (scm_numptob
== scm_ptobs_size
)
148 unsigned long old_size
= scm_ptobs_size
;
149 scm_t_ptob_descriptor
**old_ptobs
= scm_ptobs
;
151 /* Currently there are only 9 predefined port types, so one
152 resize will cover it. */
153 scm_ptobs_size
= old_size
+ 10;
155 if (scm_ptobs_size
>= SCM_I_MAX_PORT_TYPE_COUNT
)
156 scm_ptobs_size
= SCM_I_MAX_PORT_TYPE_COUNT
;
158 scm_ptobs
= scm_gc_malloc (sizeof (*scm_ptobs
) * scm_ptobs_size
,
161 memcpy (scm_ptobs
, old_ptobs
, sizeof (*scm_ptobs
) * scm_numptob
);
165 scm_ptobs
[ret
] = desc
;
168 scm_i_pthread_mutex_unlock (&scm_ptobs_lock
);
171 scm_out_of_range ("scm_c_port_type_add_x", scm_from_long (scm_numptob
));
177 * We choose to use an interface similar to the smob interface with
178 * fill_input and write as standard fields, passed to the port
179 * type constructor, and optional fields set by setters.
183 flush_port_default (SCM port SCM_UNUSED
)
188 end_input_default (SCM port SCM_UNUSED
, int offset SCM_UNUSED
)
193 scm_make_port_type (char *name
,
194 int (*fill_input
) (SCM port
),
195 void (*write
) (SCM port
, const void *data
, size_t size
))
197 scm_t_ptob_descriptor
*desc
;
200 desc
= scm_gc_malloc_pointerless (sizeof (*desc
), "port-type");
201 memset (desc
, 0, sizeof (*desc
));
204 desc
->print
= scm_port_print
;
206 desc
->flush
= flush_port_default
;
207 desc
->end_input
= end_input_default
;
208 desc
->fill_input
= fill_input
;
210 ptobnum
= scm_c_port_type_add_x (desc
);
212 /* Make a class object if GOOPS is present. */
213 if (SCM_UNPACK (scm_port_class
[0]) != 0)
214 scm_make_port_classes (ptobnum
, name
);
216 return scm_tc7_port
+ ptobnum
* 256;
220 scm_set_port_mark (scm_t_bits tc
, SCM (*mark
) (SCM
))
222 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->mark
= mark
;
226 scm_set_port_free (scm_t_bits tc
, size_t (*free
) (SCM
))
228 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->free
= free
;
232 scm_set_port_print (scm_t_bits tc
, int (*print
) (SCM exp
, SCM port
,
233 scm_print_state
*pstate
))
235 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->print
= print
;
239 scm_set_port_equalp (scm_t_bits tc
, SCM (*equalp
) (SCM
, SCM
))
241 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->equalp
= equalp
;
245 scm_set_port_flush (scm_t_bits tc
, void (*flush
) (SCM port
))
247 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->flush
= flush
;
251 scm_set_port_end_input (scm_t_bits tc
, void (*end_input
) (SCM port
, int offset
))
253 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->end_input
= end_input
;
257 scm_set_port_close (scm_t_bits tc
, int (*close
) (SCM
))
259 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->close
= close
;
263 scm_set_port_seek (scm_t_bits tc
,
264 scm_t_off (*seek
) (SCM
, scm_t_off
, int))
266 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->seek
= seek
;
270 scm_set_port_truncate (scm_t_bits tc
, void (*truncate
) (SCM
, scm_t_off
))
272 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->truncate
= truncate
;
276 scm_set_port_input_waiting (scm_t_bits tc
, int (*input_waiting
) (SCM
))
278 scm_c_port_type_ref (SCM_TC2PTOBNUM (tc
))->input_waiting
= input_waiting
;
283 SCM_DEFINE (scm_char_ready_p
, "char-ready?", 0, 1, 0,
285 "Return @code{#t} if a character is ready on input @var{port}\n"
286 "and return @code{#f} otherwise. If @code{char-ready?} returns\n"
287 "@code{#t} then the next @code{read-char} operation on\n"
288 "@var{port} is guaranteed not to hang. If @var{port} is a file\n"
289 "port at end of file then @code{char-ready?} returns @code{#t}.\n"
291 "@code{char-ready?} exists to make it possible for a\n"
292 "program to accept characters from interactive ports without\n"
293 "getting stuck waiting for input. Any input editors associated\n"
294 "with such ports must make sure that characters whose existence\n"
295 "has been asserted by @code{char-ready?} cannot be rubbed out.\n"
296 "If @code{char-ready?} were to return @code{#f} at end of file,\n"
297 "a port at end of file would be indistinguishable from an\n"
298 "interactive port that has no ready characters.")
299 #define FUNC_NAME s_scm_char_ready_p
303 if (SCM_UNBNDP (port
))
304 port
= scm_current_input_port ();
305 /* It's possible to close the current input port, so validate even in
307 SCM_VALIDATE_OPINPORT (1, port
);
309 pt
= SCM_PTAB_ENTRY (port
);
311 /* if the current read buffer is filled, or the
312 last pushed-back char has been read and the saved buffer is
313 filled, result is true. */
314 if (pt
->read_pos
< pt
->read_end
315 || (pt
->read_buf
== pt
->putback_buf
316 && pt
->saved_read_pos
< pt
->saved_read_end
))
320 scm_t_ptob_descriptor
*ptob
= SCM_PORT_DESCRIPTOR (port
);
322 if (ptob
->input_waiting
)
323 return scm_from_bool(ptob
->input_waiting (port
));
330 /* move up to read_len chars from port's putback and/or read buffers
331 into memory starting at dest. returns the number of chars moved. */
333 scm_take_from_input_buffers (SCM port
, char *dest
, size_t read_len
)
335 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
336 size_t chars_read
= 0;
337 size_t from_buf
= min (pt
->read_end
- pt
->read_pos
, read_len
);
341 memcpy (dest
, pt
->read_pos
, from_buf
);
342 pt
->read_pos
+= from_buf
;
343 chars_read
+= from_buf
;
344 read_len
-= from_buf
;
348 /* if putback was active, try the real input buffer too. */
349 if (pt
->read_buf
== pt
->putback_buf
)
351 from_buf
= min (pt
->saved_read_end
- pt
->saved_read_pos
, read_len
);
354 memcpy (dest
, pt
->saved_read_pos
, from_buf
);
355 pt
->saved_read_pos
+= from_buf
;
356 chars_read
+= from_buf
;
362 /* Clear a port's read buffers, returning the contents. */
363 SCM_DEFINE (scm_drain_input
, "drain-input", 1, 0, 0,
365 "This procedure clears a port's input buffers, similar\n"
366 "to the way that force-output clears the output buffer. The\n"
367 "contents of the buffers are returned as a single string, e.g.,\n"
370 "(define p (open-input-file ...))\n"
371 "(drain-input p) => empty string, nothing buffered yet.\n"
372 "(unread-char (read-char p) p)\n"
373 "(drain-input p) => initial chars from p, up to the buffer size.\n"
375 "Draining the buffers may be useful for cleanly finishing\n"
376 "buffered I/O so that the file descriptor can be used directly\n"
377 "for further input.")
378 #define FUNC_NAME s_scm_drain_input
385 SCM_VALIDATE_OPINPORT (1, port
);
386 pt
= SCM_PTAB_ENTRY (port
);
388 count
= pt
->read_end
- pt
->read_pos
;
389 if (pt
->read_buf
== pt
->putback_buf
)
390 count
+= pt
->saved_read_end
- pt
->saved_read_pos
;
394 result
= scm_i_make_string (count
, &data
, 0);
395 scm_take_from_input_buffers (port
, data
, count
);
398 result
= scm_nullstr
;
405 /* Standard ports --- current input, output, error, and more(!). */
407 static SCM cur_inport_fluid
= SCM_BOOL_F
;
408 static SCM cur_outport_fluid
= SCM_BOOL_F
;
409 static SCM cur_errport_fluid
= SCM_BOOL_F
;
410 static SCM cur_loadport_fluid
= SCM_BOOL_F
;
412 SCM_DEFINE (scm_current_input_port
, "current-input-port", 0, 0, 0,
414 "Return the current input port. This is the default port used\n"
415 "by many input procedures. Initially, @code{current-input-port}\n"
416 "returns the @dfn{standard input} in Unix and C terminology.")
417 #define FUNC_NAME s_scm_current_input_port
419 if (scm_is_true (cur_inport_fluid
))
420 return scm_fluid_ref (cur_inport_fluid
);
426 SCM_DEFINE (scm_current_output_port
, "current-output-port", 0, 0, 0,
428 "Return the current output port. This is the default port used\n"
429 "by many output procedures. Initially,\n"
430 "@code{current-output-port} returns the @dfn{standard output} in\n"
431 "Unix and C terminology.")
432 #define FUNC_NAME s_scm_current_output_port
434 if (scm_is_true (cur_outport_fluid
))
435 return scm_fluid_ref (cur_outport_fluid
);
441 SCM_DEFINE (scm_current_error_port
, "current-error-port", 0, 0, 0,
443 "Return the port to which errors and warnings should be sent (the\n"
444 "@dfn{standard error} in Unix and C terminology).")
445 #define FUNC_NAME s_scm_current_error_port
447 if (scm_is_true (cur_errport_fluid
))
448 return scm_fluid_ref (cur_errport_fluid
);
454 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
456 "Return the current-load-port.\n"
457 "The load port is used internally by @code{primitive-load}.")
458 #define FUNC_NAME s_scm_current_load_port
460 return scm_fluid_ref (cur_loadport_fluid
);
464 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
466 "@deffnx {Scheme Procedure} set-current-output-port port\n"
467 "@deffnx {Scheme Procedure} set-current-error-port port\n"
468 "Change the ports returned by @code{current-input-port},\n"
469 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
470 "so that they use the supplied @var{port} for input or output.")
471 #define FUNC_NAME s_scm_set_current_input_port
473 SCM oinp
= scm_fluid_ref (cur_inport_fluid
);
474 SCM_VALIDATE_OPINPORT (1, port
);
475 scm_fluid_set_x (cur_inport_fluid
, port
);
481 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
483 "Set the current default output port to @var{port}.")
484 #define FUNC_NAME s_scm_set_current_output_port
486 SCM ooutp
= scm_fluid_ref (cur_outport_fluid
);
487 port
= SCM_COERCE_OUTPORT (port
);
488 SCM_VALIDATE_OPOUTPORT (1, port
);
489 scm_fluid_set_x (cur_outport_fluid
, port
);
495 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
497 "Set the current default error port to @var{port}.")
498 #define FUNC_NAME s_scm_set_current_error_port
500 SCM oerrp
= scm_fluid_ref (cur_errport_fluid
);
501 port
= SCM_COERCE_OUTPORT (port
);
502 SCM_VALIDATE_OPOUTPORT (1, port
);
503 scm_fluid_set_x (cur_errport_fluid
, port
);
509 scm_dynwind_current_input_port (SCM port
)
510 #define FUNC_NAME NULL
512 SCM_VALIDATE_OPINPORT (1, port
);
513 scm_dynwind_fluid (cur_inport_fluid
, port
);
518 scm_dynwind_current_output_port (SCM port
)
519 #define FUNC_NAME NULL
521 port
= SCM_COERCE_OUTPORT (port
);
522 SCM_VALIDATE_OPOUTPORT (1, port
);
523 scm_dynwind_fluid (cur_outport_fluid
, port
);
528 scm_dynwind_current_error_port (SCM port
)
529 #define FUNC_NAME NULL
531 port
= SCM_COERCE_OUTPORT (port
);
532 SCM_VALIDATE_OPOUTPORT (1, port
);
533 scm_dynwind_fluid (cur_errport_fluid
, port
);
538 scm_i_dynwind_current_load_port (SCM port
)
540 scm_dynwind_fluid (cur_loadport_fluid
, port
);
544 /* The port table --- an array of pointers to ports. */
547 We need a global registry of ports to flush them all at exit, and to
548 get all the ports matching a file descriptor.
550 SCM scm_i_port_weak_set
;
553 /* Port finalization. */
556 static void finalize_port (GC_PTR
, GC_PTR
);
558 /* Register a finalizer for PORT. */
559 static SCM_C_INLINE_KEYWORD
void
560 register_finalizer_for_port (SCM port
)
562 GC_finalization_proc prev_finalizer
;
563 GC_PTR prev_finalization_data
;
565 /* Register a finalizer for PORT so that its iconv CDs get freed and
566 optionally its type's `free' function gets called. */
567 GC_REGISTER_FINALIZER_NO_ORDER (SCM_HEAP_OBJECT_BASE (port
),
570 &prev_finalization_data
);
573 /* Finalize the object (a port) pointed to by PTR. */
575 finalize_port (GC_PTR ptr
, GC_PTR data
)
577 SCM port
= SCM_PACK_POINTER (ptr
);
579 if (!SCM_PORTP (port
))
582 if (SCM_OPENP (port
))
584 if (SCM_REVEALED (port
) > 0)
585 /* Keep "revealed" ports alive and re-register a finalizer. */
586 register_finalizer_for_port (port
);
589 scm_t_ptob_descriptor
*ptob
= SCM_PORT_DESCRIPTOR (port
);
593 /* Yes, I really do mean `free' rather than `close'. `close'
594 is for explicit `close-port' by user. */
597 entry
= SCM_PTAB_ENTRY (port
);
599 if (entry
->input_cd
!= (iconv_t
) -1)
600 iconv_close (entry
->input_cd
);
601 if (entry
->output_cd
!= (iconv_t
) -1)
602 iconv_close (entry
->output_cd
);
604 SCM_SETSTREAM (port
, 0);
605 SCM_CLR_PORT_OPEN_FLAG (port
);
607 scm_gc_ports_collected
++;
617 scm_c_make_port_with_encoding (scm_t_bits tag
, unsigned long mode_bits
,
618 const char *encoding
,
619 scm_t_string_failed_conversion_handler handler
,
624 scm_t_ptob_descriptor
*ptob
;
626 entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
627 ptob
= scm_c_port_type_ref (SCM_TC2PTOBNUM (tag
));
629 ret
= scm_words (tag
| mode_bits
, 3);
630 SCM_SET_CELL_WORD_1 (ret
, (scm_t_bits
) entry
);
631 SCM_SET_CELL_WORD_2 (ret
, (scm_t_bits
) ptob
);
633 #if SCM_USE_PTHREAD_THREADS
634 scm_i_pthread_mutex_init (&entry
->lock
, scm_i_pthread_mutexattr_recursive
);
637 entry
->file_name
= SCM_BOOL_F
;
638 entry
->rw_active
= SCM_PORT_NEITHER
;
640 entry
->stream
= stream
;
641 entry
->encoding
= encoding
? scm_gc_strdup (encoding
, "port") : NULL
;
642 /* The conversion descriptors will be opened lazily. */
643 entry
->input_cd
= (iconv_t
) -1;
644 entry
->output_cd
= (iconv_t
) -1;
645 entry
->ilseq_handler
= handler
;
647 scm_weak_set_add_x (scm_i_port_weak_set
, ret
);
649 /* For each new port, register a finalizer so that it port type's free
650 function can be invoked eventually. */
651 register_finalizer_for_port (ret
);
657 scm_c_make_port (scm_t_bits tag
, unsigned long mode_bits
, scm_t_bits stream
)
659 return scm_c_make_port_with_encoding (tag
, mode_bits
,
660 scm_i_default_port_encoding (),
661 scm_i_get_conversion_strategy (SCM_BOOL_F
),
666 scm_new_port_table_entry (scm_t_bits tag
)
668 return scm_c_make_port (tag
, 0, 0);
671 /* Remove a port from the table and destroy it. */
674 scm_i_remove_port (SCM port
)
675 #define FUNC_NAME "scm_remove_port"
679 p
= SCM_PTAB_ENTRY (port
);
680 scm_port_non_buffer (p
);
681 SCM_SETPTAB_ENTRY (port
, 0);
682 scm_weak_set_remove_x (scm_i_port_weak_set
, port
);
684 p
->putback_buf
= NULL
;
685 p
->putback_buf_size
= 0;
687 if (p
->input_cd
!= (iconv_t
) -1)
689 iconv_close (p
->input_cd
);
690 p
->input_cd
= (iconv_t
) -1;
693 if (p
->output_cd
!= (iconv_t
) -1)
695 iconv_close (p
->output_cd
);
696 p
->output_cd
= (iconv_t
) -1;
703 scm_port_non_buffer (scm_t_port
*pt
)
705 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
706 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
707 pt
->read_buf_size
= pt
->write_buf_size
= 1;
708 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
712 /* Revealed counts --- an oddity inherited from SCSH. */
714 /* Find a port in the table and return its revealed count.
715 Also used by the garbage collector.
719 scm_revealed_count (SCM port
)
721 return SCM_REVEALED(port
);
726 /* Return the revealed count for a port. */
728 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
730 "Return the revealed count for @var{port}.")
731 #define FUNC_NAME s_scm_port_revealed
733 port
= SCM_COERCE_OUTPORT (port
);
734 SCM_VALIDATE_OPENPORT (1, port
);
735 return scm_from_int (scm_revealed_count (port
));
739 /* Set the revealed count for a port. */
740 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
741 (SCM port
, SCM rcount
),
742 "Sets the revealed count for a port to a given value.\n"
743 "The return value is unspecified.")
744 #define FUNC_NAME s_scm_set_port_revealed_x
746 port
= SCM_COERCE_OUTPORT (port
);
747 SCM_VALIDATE_OPENPORT (1, port
);
748 SCM_REVEALED (port
) = scm_to_int (rcount
);
749 return SCM_UNSPECIFIED
;
755 /* Retrieving a port's mode. */
757 /* Return the flags that characterize a port based on the mode
758 * string used to open a file for that port.
760 * See PORT FLAGS in scm.h
764 scm_i_mode_bits_n (SCM modes
)
767 | (scm_i_string_contains_char (modes
, 'r')
768 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
769 | (scm_i_string_contains_char (modes
, 'w')
770 || scm_i_string_contains_char (modes
, 'a')
771 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
772 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
773 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
777 scm_mode_bits (char *modes
)
779 return scm_i_mode_bits (scm_from_locale_string (modes
));
783 scm_i_mode_bits (SCM modes
)
787 if (!scm_is_string (modes
))
788 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
790 bits
= scm_i_mode_bits_n (modes
);
791 scm_remember_upto_here_1 (modes
);
795 /* Return the mode flags from an open port.
796 * Some modes such as "append" are only used when opening
797 * a file and are not returned here. */
799 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
801 "Return the port modes associated with the open port @var{port}.\n"
802 "These will not necessarily be identical to the modes used when\n"
803 "the port was opened, since modes such as \"append\" which are\n"
804 "used only during port creation are not retained.")
805 #define FUNC_NAME s_scm_port_mode
810 port
= SCM_COERCE_OUTPORT (port
);
811 SCM_VALIDATE_OPPORT (1, port
);
812 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
813 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
814 strcpy (modes
, "r+");
818 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
820 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
823 return scm_from_latin1_string (modes
);
832 * Call the close operation on a port object.
833 * see also scm_close.
835 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
837 "Close the specified port object. Return @code{#t} if it\n"
838 "successfully closes a port or @code{#f} if it was already\n"
839 "closed. An exception may be raised if an error occurs, for\n"
840 "example when flushing buffered output. See also @ref{Ports and\n"
841 "File Descriptors, close}, for a procedure which can close file\n"
843 #define FUNC_NAME s_scm_close_port
847 port
= SCM_COERCE_OUTPORT (port
);
849 SCM_VALIDATE_PORT (1, port
);
850 if (SCM_CLOSEDP (port
))
852 if (SCM_PORT_DESCRIPTOR (port
)->close
)
853 rv
= SCM_PORT_DESCRIPTOR (port
)->close (port
);
856 scm_i_remove_port (port
);
857 SCM_CLR_PORT_OPEN_FLAG (port
);
858 return scm_from_bool (rv
>= 0);
862 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
864 "Close the specified input port object. The routine has no effect if\n"
865 "the file has already been closed. An exception may be raised if an\n"
866 "error occurs. The value returned is unspecified.\n\n"
867 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
868 "which can close file descriptors.")
869 #define FUNC_NAME s_scm_close_input_port
871 SCM_VALIDATE_INPUT_PORT (1, port
);
872 scm_close_port (port
);
873 return SCM_UNSPECIFIED
;
877 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
879 "Close the specified output port object. The routine has no effect if\n"
880 "the file has already been closed. An exception may be raised if an\n"
881 "error occurs. The value returned is unspecified.\n\n"
882 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
883 "which can close file descriptors.")
884 #define FUNC_NAME s_scm_close_output_port
886 port
= SCM_COERCE_OUTPORT (port
);
887 SCM_VALIDATE_OUTPUT_PORT (1, port
);
888 scm_close_port (port
);
889 return SCM_UNSPECIFIED
;
895 void (*proc
) (void *data
, SCM p
);
900 for_each_trampoline (void *data
, SCM port
, SCM result
)
902 struct for_each_data
*d
= data
;
904 d
->proc (d
->data
, port
);
910 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
912 struct for_each_data d
;
917 scm_c_weak_set_fold (for_each_trampoline
, &d
, SCM_EOL
,
918 scm_i_port_weak_set
);
922 scm_for_each_trampoline (void *data
, SCM port
)
924 scm_call_1 (SCM_PACK_POINTER (data
), port
);
927 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
929 "Apply @var{proc} to each port in the Guile port table\n"
930 "in turn. The return value is unspecified. More specifically,\n"
931 "@var{proc} is applied exactly once to every port that exists\n"
932 "in the system at the time @var{port-for-each} is invoked.\n"
933 "Changes to the port table while @var{port-for-each} is running\n"
934 "have no effect as far as @var{port-for-each} is concerned.")
935 #define FUNC_NAME s_scm_port_for_each
937 SCM_VALIDATE_PROC (1, proc
);
939 scm_c_port_for_each (scm_for_each_trampoline
, SCM_UNPACK_POINTER (proc
));
941 return SCM_UNSPECIFIED
;
947 /* Utter miscellany. Gosh, we should clean this up some time. */
949 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
951 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
952 "@code{#f}. Any object satisfying this predicate also satisfies\n"
954 #define FUNC_NAME s_scm_input_port_p
956 return scm_from_bool (SCM_INPUT_PORT_P (x
));
960 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
962 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
963 "@code{#f}. Any object satisfying this predicate also satisfies\n"
965 #define FUNC_NAME s_scm_output_port_p
967 x
= SCM_COERCE_OUTPORT (x
);
968 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
972 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
974 "Return a boolean indicating whether @var{x} is a port.\n"
975 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
977 #define FUNC_NAME s_scm_port_p
979 return scm_from_bool (SCM_PORTP (x
));
983 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
985 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
987 #define FUNC_NAME s_scm_port_closed_p
989 SCM_VALIDATE_PORT (1, port
);
990 return scm_from_bool (!SCM_OPPORTP (port
));
994 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
996 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
998 #define FUNC_NAME s_scm_eof_object_p
1000 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
1004 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
1006 "Flush the specified output port, or the current output port if @var{port}\n"
1007 "is omitted. The current output buffer contents are passed to the\n"
1008 "underlying port implementation (e.g., in the case of fports, the\n"
1009 "data will be written to the file and the output buffer will be cleared.)\n"
1010 "It has no effect on an unbuffered port.\n\n"
1011 "The return value is unspecified.")
1012 #define FUNC_NAME s_scm_force_output
1014 if (SCM_UNBNDP (port
))
1015 port
= scm_current_output_port ();
1018 port
= SCM_COERCE_OUTPORT (port
);
1019 SCM_VALIDATE_OPOUTPORT (1, port
);
1022 return SCM_UNSPECIFIED
;
1028 flush_output_port (void *closure
, SCM port
)
1030 if (SCM_OPOUTPORTP (port
))
1034 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
1036 "Equivalent to calling @code{force-output} on\n"
1037 "all open output ports. The return value is unspecified.")
1038 #define FUNC_NAME s_scm_flush_all_ports
1040 scm_c_port_for_each (&flush_output_port
, NULL
);
1041 return SCM_UNSPECIFIED
;
1045 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1047 "Return the next character available from @var{port}, updating\n"
1048 "@var{port} to point to the following character. If no more\n"
1049 "characters are available, the end-of-file object is returned.\n"
1051 "When @var{port}'s data cannot be decoded according to its\n"
1052 "character encoding, a @code{decoding-error} is raised and\n"
1053 "@var{port} points past the erroneous byte sequence.\n")
1054 #define FUNC_NAME s_scm_read_char
1057 if (SCM_UNBNDP (port
))
1058 port
= scm_current_input_port ();
1059 SCM_VALIDATE_OPINPORT (1, port
);
1060 c
= scm_getc (port
);
1063 return SCM_MAKE_CHAR (c
);
1067 /* Update the line and column number of PORT after consumption of C. */
1069 update_port_lf (scm_t_wchar c
, SCM port
)
1094 #define SCM_MBCHAR_BUF_SIZE (4)
1096 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1097 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1099 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1101 scm_t_wchar codepoint
;
1103 if (utf8_buf
[0] <= 0x7f)
1106 codepoint
= utf8_buf
[0];
1108 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1111 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1112 | (utf8_buf
[1] & 0x3f);
1114 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1117 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1118 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1119 | (utf8_buf
[2] & 0x3f);
1124 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1125 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1126 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1127 | (utf8_buf
[3] & 0x3f);
1133 /* Read a UTF-8 sequence from PORT. On success, return 0 and set
1134 *CODEPOINT to the codepoint that was read, fill BUF with its UTF-8
1135 representation, and set *LEN to the length in bytes. Return
1136 `EILSEQ' on error. */
1138 get_utf8_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1139 scm_t_uint8 buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1141 #define ASSERT_NOT_EOF(b) \
1142 if (SCM_UNLIKELY ((b) == EOF)) \
1144 #define CONSUME_PEEKED_BYTE() \
1151 pt
= SCM_PTAB_ENTRY (port
);
1153 byte
= scm_get_byte_or_eof (port
);
1160 buf
[0] = (scm_t_uint8
) byte
;
1165 *codepoint
= buf
[0];
1166 else if (buf
[0] >= 0xc2 && buf
[0] <= 0xdf)
1169 byte
= scm_peek_byte_or_eof (port
);
1170 ASSERT_NOT_EOF (byte
);
1172 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1175 CONSUME_PEEKED_BYTE ();
1176 buf
[1] = (scm_t_uint8
) byte
;
1179 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x1f) << 6UL
1182 else if ((buf
[0] & 0xf0) == 0xe0)
1185 byte
= scm_peek_byte_or_eof (port
);
1186 ASSERT_NOT_EOF (byte
);
1188 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80
1189 || (buf
[0] == 0xe0 && byte
< 0xa0)
1190 || (buf
[0] == 0xed && byte
> 0x9f)))
1193 CONSUME_PEEKED_BYTE ();
1194 buf
[1] = (scm_t_uint8
) byte
;
1197 byte
= scm_peek_byte_or_eof (port
);
1198 ASSERT_NOT_EOF (byte
);
1200 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1203 CONSUME_PEEKED_BYTE ();
1204 buf
[2] = (scm_t_uint8
) byte
;
1207 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x0f) << 12UL
1208 | ((scm_t_wchar
) buf
[1] & 0x3f) << 6UL
1211 else if (buf
[0] >= 0xf0 && buf
[0] <= 0xf4)
1214 byte
= scm_peek_byte_or_eof (port
);
1215 ASSERT_NOT_EOF (byte
);
1217 if (SCM_UNLIKELY (((byte
& 0xc0) != 0x80)
1218 || (buf
[0] == 0xf0 && byte
< 0x90)
1219 || (buf
[0] == 0xf4 && byte
> 0x8f)))
1222 CONSUME_PEEKED_BYTE ();
1223 buf
[1] = (scm_t_uint8
) byte
;
1226 byte
= scm_peek_byte_or_eof (port
);
1227 ASSERT_NOT_EOF (byte
);
1229 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1232 CONSUME_PEEKED_BYTE ();
1233 buf
[2] = (scm_t_uint8
) byte
;
1236 byte
= scm_peek_byte_or_eof (port
);
1237 ASSERT_NOT_EOF (byte
);
1239 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1242 CONSUME_PEEKED_BYTE ();
1243 buf
[3] = (scm_t_uint8
) byte
;
1246 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x07) << 18UL
1247 | ((scm_t_wchar
) buf
[1] & 0x3f) << 12UL
1248 | ((scm_t_wchar
) buf
[2] & 0x3f) << 6UL
1257 /* Here we could choose the consume the faulty byte when it's not a
1258 valid starting byte, but it's not a requirement. What Section 3.9
1259 of Unicode 6.0.0 mandates, though, is to not consume a byte that
1260 would otherwise be a valid starting byte. */
1264 #undef CONSUME_PEEKED_BYTE
1265 #undef ASSERT_NOT_EOF
1268 /* Likewise, read a byte sequence from PORT, passing it through its
1269 input conversion descriptor. */
1271 get_iconv_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1272 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1276 size_t bytes_consumed
, output_size
;
1278 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1280 pt
= SCM_PTAB_ENTRY (port
);
1282 for (output_size
= 0, output
= (char *) utf8_buf
,
1283 bytes_consumed
= 0, err
= 0;
1284 err
== 0 && output_size
== 0
1285 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1289 size_t input_left
, output_left
, done
;
1291 byte_read
= scm_get_byte_or_eof (port
);
1292 if (byte_read
== EOF
)
1294 if (bytes_consumed
== 0)
1296 *codepoint
= (scm_t_wchar
) EOF
;
1304 buf
[bytes_consumed
] = byte_read
;
1307 input_left
= bytes_consumed
+ 1;
1308 output_left
= sizeof (utf8_buf
);
1310 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1311 &output
, &output_left
);
1312 if (done
== (size_t) -1)
1316 /* Missing input: keep trying. */
1320 output_size
= sizeof (utf8_buf
) - output_left
;
1323 if (SCM_UNLIKELY (output_size
== 0))
1324 /* An unterminated sequence. */
1326 else if (SCM_LIKELY (err
== 0))
1328 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1329 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1330 *len
= bytes_consumed
;
1336 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1337 with the byte representation of the codepoint in PORT's encoding, and
1338 set *LEN to the length in bytes of that representation. Return 0 on
1339 success and an errno value on error. */
1341 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1342 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1345 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1347 if (pt
->input_cd
== (iconv_t
) -1)
1348 /* Initialize the conversion descriptors, if needed. */
1349 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1351 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
1352 if (pt
->input_cd
== (iconv_t
) -1)
1353 err
= get_utf8_codepoint (port
, codepoint
, (scm_t_uint8
*) buf
, len
);
1355 err
= get_iconv_codepoint (port
, codepoint
, buf
, len
);
1357 if (SCM_LIKELY (err
== 0))
1358 update_port_lf (*codepoint
, port
);
1359 else if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1363 update_port_lf (*codepoint
, port
);
1369 /* Read a codepoint from PORT and return it. */
1372 #define FUNC_NAME "scm_getc"
1376 scm_t_wchar codepoint
;
1377 char buf
[SCM_MBCHAR_BUF_SIZE
];
1379 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1380 if (SCM_UNLIKELY (err
!= 0))
1381 /* At this point PORT should point past the invalid encoding, as per
1382 R6RS-lib Section 8.2.4. */
1383 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1389 /* this should only be called when the read buffer is empty. it
1390 tries to refill the read buffer. it returns the first char from
1391 the port, which is either EOF or *(pt->read_pos). */
1393 scm_fill_input (SCM port
)
1395 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1397 assert (pt
->read_pos
== pt
->read_end
);
1399 if (pt
->read_buf
== pt
->putback_buf
)
1401 /* finished reading put-back chars. */
1402 pt
->read_buf
= pt
->saved_read_buf
;
1403 pt
->read_pos
= pt
->saved_read_pos
;
1404 pt
->read_end
= pt
->saved_read_end
;
1405 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1406 if (pt
->read_pos
< pt
->read_end
)
1407 return *(pt
->read_pos
);
1409 return SCM_PORT_DESCRIPTOR (port
)->fill_input (port
);
1415 * This function differs from scm_c_write; it updates port line and
1419 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1421 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1422 scm_t_ptob_descriptor
*ptob
= SCM_PORT_DESCRIPTOR (port
);
1424 if (pt
->rw_active
== SCM_PORT_READ
)
1425 scm_end_input (port
);
1427 ptob
->write (port
, ptr
, size
);
1429 for (; size
; ptr
++, size
--)
1430 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1433 pt
->rw_active
= SCM_PORT_WRITE
;
1436 /* Write STR to PORT from START inclusive to END exclusive. */
1438 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1440 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1442 if (pt
->rw_active
== SCM_PORT_READ
)
1443 scm_end_input (port
);
1445 if (end
== (size_t) -1)
1446 end
= scm_i_string_length (str
);
1448 scm_display (scm_c_substring (str
, start
, end
), port
);
1451 pt
->rw_active
= SCM_PORT_WRITE
;
1456 * Used by an application to read arbitrary number of bytes from an
1457 * SCM port. Same semantics as libc read, except that scm_c_read only
1458 * returns less than SIZE bytes if at end-of-file.
1460 * Warning: Doesn't update port line and column counts! */
1462 /* This structure, and the following swap_buffer function, are used
1463 for temporarily swapping a port's own read buffer, and the buffer
1464 that the caller of scm_c_read provides. */
1465 struct port_and_swap_buffer
1468 unsigned char *buffer
;
1473 swap_buffer (void *data
)
1475 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1476 unsigned char *old_buf
= psb
->pt
->read_buf
;
1477 size_t old_size
= psb
->pt
->read_buf_size
;
1479 /* Make the port use (buffer, size) from the struct. */
1480 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1481 psb
->pt
->read_buf_size
= psb
->size
;
1483 /* Save the port's old (buffer, size) in the struct. */
1484 psb
->buffer
= old_buf
;
1485 psb
->size
= old_size
;
1489 scm_c_read (SCM port
, void *buffer
, size_t size
)
1490 #define FUNC_NAME "scm_c_read"
1493 size_t n_read
= 0, n_available
;
1494 struct port_and_swap_buffer psb
;
1496 SCM_VALIDATE_OPINPORT (1, port
);
1498 pt
= SCM_PTAB_ENTRY (port
);
1499 if (pt
->rw_active
== SCM_PORT_WRITE
)
1500 SCM_PORT_DESCRIPTOR (port
)->flush (port
);
1503 pt
->rw_active
= SCM_PORT_READ
;
1505 /* Take bytes first from the port's read buffer. */
1506 if (pt
->read_pos
< pt
->read_end
)
1508 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1509 memcpy (buffer
, pt
->read_pos
, n_available
);
1510 buffer
= (char *) buffer
+ n_available
;
1511 pt
->read_pos
+= n_available
;
1512 n_read
+= n_available
;
1513 size
-= n_available
;
1516 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1520 /* Now we will call scm_fill_input repeatedly until we have read the
1521 requested number of bytes. (Note that a single scm_fill_input
1522 call does not guarantee to fill the whole of the port's read
1524 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1526 /* The port that we are reading from is unbuffered - i.e. does
1527 not have its own persistent buffer - but we have a buffer,
1528 provided by our caller, that is the right size for the data
1529 that is wanted. For the following scm_fill_input calls,
1530 therefore, we use the buffer in hand as the port's read
1533 We need to make sure that the port's normal (1 byte) buffer
1534 is reinstated in case one of the scm_fill_input () calls
1535 throws an exception; we use the scm_dynwind_* API to achieve
1538 A consequence of this optimization is that the fill_input
1539 functions can't unget characters. That'll push data to the
1540 pushback buffer instead of this psb buffer. */
1542 unsigned char *pback
= pt
->putback_buf
;
1545 psb
.buffer
= buffer
;
1547 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1548 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1549 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1551 /* Call scm_fill_input until we have all the bytes that we need,
1553 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1555 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1556 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1559 if (pback
!= pt
->putback_buf
1560 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1561 scm_misc_error (FUNC_NAME
,
1562 "scm_c_read must not call a fill function that pushes "
1563 "back characters onto an unbuffered port", SCM_EOL
);
1565 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1567 /* Reinstate the port's normal buffer. */
1572 /* The port has its own buffer. It is important that we use it,
1573 even if it happens to be smaller than our caller's buffer, so
1574 that a custom port implementation's entry points (in
1575 particular, fill_input) can rely on the buffer always being
1576 the same as they first set up. */
1577 while (size
&& (scm_fill_input (port
) != EOF
))
1579 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1580 memcpy (buffer
, pt
->read_pos
, n_available
);
1581 buffer
= (char *) buffer
+ n_available
;
1582 pt
->read_pos
+= n_available
;
1583 n_read
+= n_available
;
1584 size
-= n_available
;
1594 * Used by an application to write arbitrary number of bytes to an SCM
1595 * port. Similar semantics as libc write. However, unlike libc
1596 * write, scm_c_write writes the requested number of bytes and has no
1599 * Warning: Doesn't update port line and column counts!
1603 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1604 #define FUNC_NAME "scm_c_write"
1607 scm_t_ptob_descriptor
*ptob
;
1609 SCM_VALIDATE_OPOUTPORT (1, port
);
1611 pt
= SCM_PTAB_ENTRY (port
);
1612 ptob
= SCM_PORT_DESCRIPTOR (port
);
1614 if (pt
->rw_active
== SCM_PORT_READ
)
1615 scm_end_input (port
);
1617 ptob
->write (port
, ptr
, size
);
1620 pt
->rw_active
= SCM_PORT_WRITE
;
1625 scm_flush (SCM port
)
1627 SCM_PORT_DESCRIPTOR (port
)->flush (port
);
1631 scm_end_input (SCM port
)
1634 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1636 if (pt
->read_buf
== pt
->putback_buf
)
1638 offset
= pt
->read_end
- pt
->read_pos
;
1639 pt
->read_buf
= pt
->saved_read_buf
;
1640 pt
->read_pos
= pt
->saved_read_pos
;
1641 pt
->read_end
= pt
->saved_read_end
;
1642 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1647 SCM_PORT_DESCRIPTOR (port
)->end_input (port
, offset
);
1654 scm_unget_byte (int c
, SCM port
)
1655 #define FUNC_NAME "scm_unget_byte"
1657 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1659 if (pt
->read_buf
== pt
->putback_buf
)
1660 /* already using the put-back buffer. */
1662 /* enlarge putback_buf if necessary. */
1663 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1664 && pt
->read_buf
== pt
->read_pos
)
1666 size_t new_size
= pt
->read_buf_size
* 2;
1667 unsigned char *tmp
= (unsigned char *)
1668 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1671 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1672 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1673 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1676 /* shift any existing bytes to buffer + 1. */
1677 if (pt
->read_pos
== pt
->read_end
)
1678 pt
->read_end
= pt
->read_buf
+ 1;
1679 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1681 int count
= pt
->read_end
- pt
->read_pos
;
1683 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1684 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1687 pt
->read_pos
= pt
->read_buf
;
1690 /* switch to the put-back buffer. */
1692 if (pt
->putback_buf
== NULL
)
1695 = (unsigned char *) scm_gc_malloc_pointerless
1696 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1697 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1700 pt
->saved_read_buf
= pt
->read_buf
;
1701 pt
->saved_read_pos
= pt
->read_pos
;
1702 pt
->saved_read_end
= pt
->read_end
;
1703 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1705 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1706 pt
->read_end
= pt
->read_buf
+ 1;
1707 pt
->read_buf_size
= pt
->putback_buf_size
;
1713 pt
->rw_active
= SCM_PORT_READ
;
1718 scm_ungetc (scm_t_wchar c
, SCM port
)
1719 #define FUNC_NAME "scm_ungetc"
1721 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1723 char result_buf
[10];
1724 const char *encoding
;
1728 if (pt
->encoding
!= NULL
)
1729 encoding
= pt
->encoding
;
1731 encoding
= "ISO-8859-1";
1733 len
= sizeof (result_buf
);
1734 result
= u32_conv_to_encoding (encoding
,
1735 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1736 (uint32_t *) &c
, 1, NULL
,
1739 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1740 scm_encoding_error (FUNC_NAME
, errno
,
1741 "conversion to port encoding failed",
1742 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1744 for (i
= len
- 1; i
>= 0; i
--)
1745 scm_unget_byte (result
[i
], port
);
1747 if (SCM_UNLIKELY (result
!= result_buf
))
1752 /* What should col be in this case?
1753 * We'll leave it at -1.
1755 SCM_LINUM (port
) -= 1;
1764 scm_ungets (const char *s
, int n
, SCM port
)
1766 /* This is simple minded and inefficient, but unreading strings is
1767 * probably not a common operation, and remember that line and
1768 * column numbers have to be handled...
1770 * Please feel free to write an optimized version!
1773 scm_ungetc (s
[n
], port
);
1777 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1779 "Return the next character available from @var{port},\n"
1780 "@emph{without} updating @var{port} to point to the following\n"
1781 "character. If no more characters are available, the\n"
1782 "end-of-file object is returned.\n"
1784 "The value returned by\n"
1785 "a call to @code{peek-char} is the same as the value that would\n"
1786 "have been returned by a call to @code{read-char} on the same\n"
1787 "port. The only difference is that the very next call to\n"
1788 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1789 "return the value returned by the preceding call to\n"
1790 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1791 "an interactive port will hang waiting for input whenever a call\n"
1792 "to @code{read-char} would have hung.\n"
1794 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1795 "if such a situation occurs. However, unlike with @code{read-char},\n"
1796 "@var{port} still points at the beginning of the erroneous byte\n"
1797 "sequence when the error is raised.\n")
1798 #define FUNC_NAME s_scm_peek_char
1803 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1804 long column
, line
, i
;
1807 if (SCM_UNBNDP (port
))
1808 port
= scm_current_input_port ();
1809 SCM_VALIDATE_OPINPORT (1, port
);
1811 column
= SCM_COL (port
);
1812 line
= SCM_LINUM (port
);
1814 err
= get_codepoint (port
, &c
, bytes
, &len
);
1816 for (i
= len
- 1; i
>= 0; i
--)
1817 scm_unget_byte (bytes
[i
], port
);
1819 SCM_COL (port
) = column
;
1820 SCM_LINUM (port
) = line
;
1822 if (SCM_UNLIKELY (err
!= 0))
1824 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1826 /* Shouldn't happen since `catch' always aborts to prompt. */
1827 result
= SCM_BOOL_F
;
1830 result
= SCM_EOF_VAL
;
1832 result
= SCM_MAKE_CHAR (c
);
1838 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1839 (SCM cobj
, SCM port
),
1840 "Place @var{char} in @var{port} so that it will be read by the\n"
1841 "next read operation. If called multiple times, the unread characters\n"
1842 "will be read again in last-in first-out order. If @var{port} is\n"
1843 "not supplied, the current input port is used.")
1844 #define FUNC_NAME s_scm_unread_char
1848 SCM_VALIDATE_CHAR (1, cobj
);
1849 if (SCM_UNBNDP (port
))
1850 port
= scm_current_input_port ();
1851 SCM_VALIDATE_OPINPORT (2, port
);
1853 c
= SCM_CHAR (cobj
);
1855 scm_ungetc (c
, port
);
1860 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1861 (SCM str
, SCM port
),
1862 "Place the string @var{str} in @var{port} so that its characters will be\n"
1863 "read in subsequent read operations. If called multiple times, the\n"
1864 "unread characters will be read again in last-in first-out order. If\n"
1865 "@var{port} is not supplied, the current-input-port is used.")
1866 #define FUNC_NAME s_scm_unread_string
1869 SCM_VALIDATE_STRING (1, str
);
1870 if (SCM_UNBNDP (port
))
1871 port
= scm_current_input_port ();
1872 SCM_VALIDATE_OPINPORT (2, port
);
1874 n
= scm_i_string_length (str
);
1877 scm_ungetc (scm_i_string_ref (str
, n
), port
);
1883 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1884 (SCM fd_port
, SCM offset
, SCM whence
),
1885 "Sets the current position of @var{fd/port} to the integer\n"
1886 "@var{offset}, which is interpreted according to the value of\n"
1889 "One of the following variables should be supplied for\n"
1891 "@defvar SEEK_SET\n"
1892 "Seek from the beginning of the file.\n"
1894 "@defvar SEEK_CUR\n"
1895 "Seek from the current position.\n"
1897 "@defvar SEEK_END\n"
1898 "Seek from the end of the file.\n"
1900 "If @var{fd/port} is a file descriptor, the underlying system\n"
1901 "call is @code{lseek}. @var{port} may be a string port.\n"
1903 "The value returned is the new position in the file. This means\n"
1904 "that the current position of a port can be obtained using:\n"
1906 "(seek port 0 SEEK_CUR)\n"
1908 #define FUNC_NAME s_scm_seek
1912 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1914 how
= scm_to_int (whence
);
1915 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1916 SCM_OUT_OF_RANGE (3, whence
);
1918 if (SCM_OPPORTP (fd_port
))
1920 scm_t_ptob_descriptor
*ptob
= SCM_PORT_DESCRIPTOR (fd_port
);
1921 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1922 off_t_or_off64_t rv
;
1925 SCM_MISC_ERROR ("port is not seekable",
1926 scm_cons (fd_port
, SCM_EOL
));
1928 rv
= ptob
->seek (fd_port
, off
, how
);
1929 return scm_from_off_t_or_off64_t (rv
);
1931 else /* file descriptor?. */
1933 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1934 off_t_or_off64_t rv
;
1935 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1938 return scm_from_off_t_or_off64_t (rv
);
1947 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1948 doesn't have the filename version truncate(), hence this code. */
1949 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1951 truncate (const char *file
, off_t length
)
1955 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1959 ret
= ftruncate (fdes
, length
);
1962 int save_errno
= errno
;
1968 return close (fdes
);
1970 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1972 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1973 (SCM object
, SCM length
),
1974 "Truncate @var{file} to @var{length} bytes. @var{file} can be a\n"
1975 "filename string, a port object, or an integer file descriptor.\n"
1976 "The return value is unspecified.\n"
1978 "For a port or file descriptor @var{length} can be omitted, in\n"
1979 "which case the file is truncated at the current position (per\n"
1980 "@code{ftell} above).\n"
1982 "On most systems a file can be extended by giving a length\n"
1983 "greater than the current size, but this is not mandatory in the\n"
1985 #define FUNC_NAME s_scm_truncate_file
1989 /* "object" can be a port, fdes or filename.
1991 Negative "length" makes no sense, but it's left to truncate() or
1992 ftruncate() to give back an error for that (normally EINVAL).
1995 if (SCM_UNBNDP (length
))
1997 /* must supply length if object is a filename. */
1998 if (scm_is_string (object
))
1999 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
2001 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
2004 object
= SCM_COERCE_OUTPORT (object
);
2005 if (scm_is_integer (object
))
2007 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2008 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
2011 else if (SCM_OPOUTPORTP (object
))
2013 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2014 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
2015 scm_t_ptob_descriptor
*ptob
= SCM_PORT_DESCRIPTOR (object
);
2017 if (!ptob
->truncate
)
2018 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
2019 if (pt
->rw_active
== SCM_PORT_READ
)
2020 scm_end_input (object
);
2021 else if (pt
->rw_active
== SCM_PORT_WRITE
)
2022 ptob
->flush (object
);
2024 ptob
->truncate (object
, c_length
);
2029 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2030 char *str
= scm_to_locale_string (object
);
2032 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
2039 return SCM_UNSPECIFIED
;
2043 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
2045 "Return the current line number for @var{port}.\n"
2047 "The first line of a file is 0. But you might want to add 1\n"
2048 "when printing line numbers, since starting from 1 is\n"
2049 "traditional in error messages, and likely to be more natural to\n"
2051 #define FUNC_NAME s_scm_port_line
2053 port
= SCM_COERCE_OUTPORT (port
);
2054 SCM_VALIDATE_OPENPORT (1, port
);
2055 return scm_from_long (SCM_LINUM (port
));
2059 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
2060 (SCM port
, SCM line
),
2061 "Set the current line number for @var{port} to @var{line}. The\n"
2062 "first line of a file is 0.")
2063 #define FUNC_NAME s_scm_set_port_line_x
2065 port
= SCM_COERCE_OUTPORT (port
);
2066 SCM_VALIDATE_OPENPORT (1, port
);
2067 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
2068 return SCM_UNSPECIFIED
;
2072 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
2074 "Return the current column number of @var{port}.\n"
2075 "If the number is\n"
2076 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
2077 "- i.e. the first character of the first line is line 0, column 0.\n"
2078 "(However, when you display a file position, for example in an error\n"
2079 "message, we recommend you add 1 to get 1-origin integers. This is\n"
2080 "because lines and column numbers traditionally start with 1, and that is\n"
2081 "what non-programmers will find most natural.)")
2082 #define FUNC_NAME s_scm_port_column
2084 port
= SCM_COERCE_OUTPORT (port
);
2085 SCM_VALIDATE_OPENPORT (1, port
);
2086 return scm_from_int (SCM_COL (port
));
2090 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
2091 (SCM port
, SCM column
),
2092 "Set the current column of @var{port}. Before reading the first\n"
2093 "character on a line the column should be 0.")
2094 #define FUNC_NAME s_scm_set_port_column_x
2096 port
= SCM_COERCE_OUTPORT (port
);
2097 SCM_VALIDATE_OPENPORT (1, port
);
2098 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
2099 return SCM_UNSPECIFIED
;
2103 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
2105 "Return the filename associated with @var{port}, or @code{#f}\n"
2106 "if no filename is associated with the port.")
2107 #define FUNC_NAME s_scm_port_filename
2109 port
= SCM_COERCE_OUTPORT (port
);
2110 SCM_VALIDATE_OPENPORT (1, port
);
2111 return SCM_FILENAME (port
);
2115 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
2116 (SCM port
, SCM filename
),
2117 "Change the filename associated with @var{port}, using the current input\n"
2118 "port if none is specified. Note that this does not change the port's\n"
2119 "source of data, but only the value that is returned by\n"
2120 "@code{port-filename} and reported in diagnostic output.")
2121 #define FUNC_NAME s_scm_set_port_filename_x
2123 port
= SCM_COERCE_OUTPORT (port
);
2124 SCM_VALIDATE_OPENPORT (1, port
);
2125 /* We allow the user to set the filename to whatever he likes. */
2126 SCM_SET_FILENAME (port
, filename
);
2127 return SCM_UNSPECIFIED
;
2131 /* A fluid specifying the default encoding for newly created ports. If it is
2132 a string, that is the encoding. If it is #f, it is in the "native"
2133 (Latin-1) encoding. */
2134 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
2136 static int scm_port_encoding_init
= 0;
2138 /* Use ENCODING as the default encoding for future ports. */
2140 scm_i_set_default_port_encoding (const char *encoding
)
2142 if (!scm_port_encoding_init
2143 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2144 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
2147 if (encoding
== NULL
2148 || !strcmp (encoding
, "ASCII")
2149 || !strcmp (encoding
, "ANSI_X3.4-1968")
2150 || !strcmp (encoding
, "ISO-8859-1"))
2151 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2153 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
2154 scm_from_locale_string (encoding
));
2157 /* Return the name of the default encoding for newly created ports; a
2158 return value of NULL means "ISO-8859-1". */
2160 scm_i_default_port_encoding (void)
2162 if (!scm_port_encoding_init
)
2164 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2170 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
2171 if (!scm_is_string (encoding
))
2174 return scm_i_string_chars (encoding
);
2179 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2182 iconv_t new_input_cd
, new_output_cd
;
2184 new_input_cd
= (iconv_t
) -1;
2185 new_output_cd
= (iconv_t
) -1;
2187 /* Set the character encoding for this port. */
2188 pt
= SCM_PTAB_ENTRY (port
);
2190 if (encoding
== NULL
)
2191 encoding
= "ISO-8859-1";
2193 if (pt
->encoding
!= encoding
)
2194 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2196 /* If ENCODING is UTF-8, then no conversion descriptor is opened
2197 because we do I/O ourselves. This saves 100+ KiB for each
2199 if (strcmp (encoding
, "UTF-8"))
2201 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2203 /* Open an input iconv conversion descriptor, from ENCODING
2204 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2205 implementations can typically convert from anything to
2206 UTF-8, but not to UTF-32 (see
2207 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2208 new_input_cd
= iconv_open ("UTF-8", encoding
);
2209 if (new_input_cd
== (iconv_t
) -1)
2210 goto invalid_encoding
;
2213 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2215 new_output_cd
= iconv_open (encoding
, "UTF-8");
2216 if (new_output_cd
== (iconv_t
) -1)
2218 if (new_input_cd
!= (iconv_t
) -1)
2219 iconv_close (new_input_cd
);
2220 goto invalid_encoding
;
2225 if (pt
->input_cd
!= (iconv_t
) -1)
2226 iconv_close (pt
->input_cd
);
2227 if (pt
->output_cd
!= (iconv_t
) -1)
2228 iconv_close (pt
->output_cd
);
2230 pt
->input_cd
= new_input_cd
;
2231 pt
->output_cd
= new_output_cd
;
2238 err
= scm_from_locale_string (encoding
);
2239 scm_misc_error ("scm_i_set_port_encoding_x",
2240 "invalid or unknown character encoding ~s",
2245 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2247 "Returns, as a string, the character encoding that @var{port}\n"
2248 "uses to interpret its input and output.\n")
2249 #define FUNC_NAME s_scm_port_encoding
2254 SCM_VALIDATE_PORT (1, port
);
2256 pt
= SCM_PTAB_ENTRY (port
);
2259 return scm_from_locale_string (pt
->encoding
);
2265 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2266 (SCM port
, SCM enc
),
2267 "Sets the character encoding that will be used to interpret all\n"
2268 "port I/O. New ports are created with the encoding\n"
2269 "appropriate for the current locale if @code{setlocale} has \n"
2270 "been called or ISO-8859-1 otherwise\n"
2271 "and this procedure can be used to modify that encoding.\n")
2272 #define FUNC_NAME s_scm_set_port_encoding_x
2276 SCM_VALIDATE_PORT (1, port
);
2277 SCM_VALIDATE_STRING (2, enc
);
2279 enc_str
= scm_to_locale_string (enc
);
2280 scm_i_set_port_encoding_x (port
, enc_str
);
2283 return SCM_UNSPECIFIED
;
2288 /* This determines how conversions handle unconvertible characters. */
2289 SCM_GLOBAL_VARIABLE (scm_conversion_strategy
, "%port-conversion-strategy");
2290 static int scm_conversion_strategy_init
= 0;
2292 scm_t_string_failed_conversion_handler
2293 scm_i_get_conversion_strategy (SCM port
)
2297 if (scm_is_false (port
))
2299 if (!scm_conversion_strategy_init
2300 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2301 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2304 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (scm_conversion_strategy
));
2305 if (scm_is_false (encoding
))
2306 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2308 return (scm_t_string_failed_conversion_handler
) scm_to_int (encoding
);
2314 pt
= SCM_PTAB_ENTRY (port
);
2315 return pt
->ilseq_handler
;
2321 scm_i_set_conversion_strategy_x (SCM port
,
2322 scm_t_string_failed_conversion_handler handler
)
2327 strategy
= scm_from_int ((int) handler
);
2329 if (scm_is_false (port
))
2331 /* Set the default encoding for future ports. */
2332 if (!scm_conversion_strategy_init
2333 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2334 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2336 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
), strategy
);
2340 /* Set the character encoding for this port. */
2341 pt
= SCM_PTAB_ENTRY (port
);
2342 pt
->ilseq_handler
= handler
;
2346 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2347 1, 0, 0, (SCM port
),
2348 "Returns the behavior of the port when handling a character that\n"
2349 "is not representable in the port's current encoding.\n"
2350 "It returns the symbol @code{error} if unrepresentable characters\n"
2351 "should cause exceptions, @code{substitute} if the port should\n"
2352 "try to replace unrepresentable characters with question marks or\n"
2353 "approximate characters, or @code{escape} if unrepresentable\n"
2354 "characters should be converted to string escapes.\n"
2356 "If @var{port} is @code{#f}, then the current default behavior\n"
2357 "will be returned. New ports will have this default behavior\n"
2358 "when they are created.\n")
2359 #define FUNC_NAME s_scm_port_conversion_strategy
2361 scm_t_string_failed_conversion_handler h
;
2363 SCM_VALIDATE_OPPORT (1, port
);
2365 if (!scm_is_false (port
))
2367 SCM_VALIDATE_OPPORT (1, port
);
2370 h
= scm_i_get_conversion_strategy (port
);
2371 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2372 return scm_from_latin1_symbol ("error");
2373 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2374 return scm_from_latin1_symbol ("substitute");
2375 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2376 return scm_from_latin1_symbol ("escape");
2380 /* Never gets here. */
2381 return SCM_UNDEFINED
;
2385 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2387 (SCM port
, SCM sym
),
2388 "Sets the behavior of the interpreter when outputting a character\n"
2389 "that is not representable in the port's current encoding.\n"
2390 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2391 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2392 "when an unconvertible character is encountered. If it is\n"
2393 "@code{'substitute}, then unconvertible characters will \n"
2394 "be replaced with approximate characters, or with question marks\n"
2395 "if no approximately correct character is available.\n"
2396 "If it is @code{'escape},\n"
2397 "it will appear as a hex escape when output.\n"
2399 "If @var{port} is an open port, the conversion error behavior\n"
2400 "is set for that port. If it is @code{#f}, it is set as the\n"
2401 "default behavior for any future ports that get created in\n"
2403 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2409 if (!scm_is_false (port
))
2411 SCM_VALIDATE_OPPORT (1, port
);
2414 err
= scm_from_latin1_symbol ("error");
2415 if (scm_is_true (scm_eqv_p (sym
, err
)))
2417 scm_i_set_conversion_strategy_x (port
, SCM_FAILED_CONVERSION_ERROR
);
2418 return SCM_UNSPECIFIED
;
2421 qm
= scm_from_latin1_symbol ("substitute");
2422 if (scm_is_true (scm_eqv_p (sym
, qm
)))
2424 scm_i_set_conversion_strategy_x (port
,
2425 SCM_FAILED_CONVERSION_QUESTION_MARK
);
2426 return SCM_UNSPECIFIED
;
2429 esc
= scm_from_latin1_symbol ("escape");
2430 if (scm_is_true (scm_eqv_p (sym
, esc
)))
2432 scm_i_set_conversion_strategy_x (port
,
2433 SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
);
2434 return SCM_UNSPECIFIED
;
2437 SCM_MISC_ERROR ("unknown conversion behavior ~s", scm_list_1 (sym
));
2439 return SCM_UNSPECIFIED
;
2446 scm_print_port_mode (SCM exp
, SCM port
)
2448 scm_puts (SCM_CLOSEDP (exp
)
2450 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2451 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2454 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2461 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2463 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2466 scm_puts ("#<", port
);
2467 scm_print_port_mode (exp
, port
);
2468 scm_puts (type
, port
);
2469 scm_putc (' ', port
);
2470 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2471 scm_putc ('>', port
);
2479 scm_t_bits scm_tc16_void_port
= 0;
2481 static int fill_input_void_port (SCM port SCM_UNUSED
)
2487 write_void_port (SCM port SCM_UNUSED
,
2488 const void *data SCM_UNUSED
,
2489 size_t size SCM_UNUSED
)
2494 scm_i_void_port (long mode_bits
)
2498 ret
= scm_c_make_port (scm_tc16_void_port
, mode_bits
, 0);
2500 scm_port_non_buffer (SCM_PTAB_ENTRY (ret
));
2506 scm_void_port (char *mode_str
)
2508 return scm_i_void_port (scm_mode_bits (mode_str
));
2511 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2513 "Create and return a new void port. A void port acts like\n"
2514 "@file{/dev/null}. The @var{mode} argument\n"
2515 "specifies the input/output modes for this port: see the\n"
2516 "documentation for @code{open-file} in @ref{File Ports}.")
2517 #define FUNC_NAME s_scm_sys_make_void_port
2519 return scm_i_void_port (scm_i_mode_bits (mode
));
2524 /* Initialization. */
2529 /* lseek() symbols. */
2530 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2531 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2532 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2534 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2537 cur_inport_fluid
= scm_make_fluid ();
2538 cur_outport_fluid
= scm_make_fluid ();
2539 cur_errport_fluid
= scm_make_fluid ();
2540 cur_loadport_fluid
= scm_make_fluid ();
2542 scm_i_port_weak_set
= scm_c_make_weak_set (31);
2544 #include "libguile/ports.x"
2546 /* Use Latin-1 as the default port encoding. */
2547 SCM_VARIABLE_SET (default_port_encoding_var
, scm_make_fluid ());
2548 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2549 scm_port_encoding_init
= 1;
2551 SCM_VARIABLE_SET (scm_conversion_strategy
, scm_make_fluid ());
2552 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
),
2553 scm_from_int ((int) SCM_FAILED_CONVERSION_QUESTION_MARK
));
2554 scm_conversion_strategy_init
= 1;