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/weaks.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_hash
;
513 scm_i_pthread_mutex_t scm_i_port_table_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
516 /* Port finalization. */
519 static void finalize_port (GC_PTR
, GC_PTR
);
521 /* Register a finalizer for PORT. */
522 static SCM_C_INLINE_KEYWORD
void
523 register_finalizer_for_port (SCM port
)
525 GC_finalization_proc prev_finalizer
;
526 GC_PTR prev_finalization_data
;
528 /* Register a finalizer for PORT so that its iconv CDs get freed and
529 optionally its type's `free' function gets called. */
530 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (port
), finalize_port
, 0,
532 &prev_finalization_data
);
535 /* Finalize the object (a port) pointed to by PTR. */
537 finalize_port (GC_PTR ptr
, GC_PTR data
)
540 SCM port
= PTR2SCM (ptr
);
542 if (!SCM_PORTP (port
))
545 if (SCM_OPENP (port
))
547 if (SCM_REVEALED (port
) > 0)
548 /* Keep "revealed" ports alive and re-register a finalizer. */
549 register_finalizer_for_port (port
);
554 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
555 if (port_type
>= scm_numptob
)
558 if (scm_ptobs
[port_type
].free
)
559 /* Yes, I really do mean `.free' rather than `.close'. `.close'
560 is for explicit `close-port' by user. */
561 scm_ptobs
[port_type
].free (port
);
563 entry
= SCM_PTAB_ENTRY (port
);
565 if (entry
->input_cd
!= (iconv_t
) -1)
566 iconv_close (entry
->input_cd
);
567 if (entry
->output_cd
!= (iconv_t
) -1)
568 iconv_close (entry
->output_cd
);
570 SCM_SETSTREAM (port
, 0);
571 SCM_CLR_PORT_OPEN_FLAG (port
);
573 scm_gc_ports_collected
++;
582 /* This function is not and should not be thread safe. */
584 scm_new_port_table_entry (scm_t_bits tag
)
585 #define FUNC_NAME "scm_new_port_table_entry"
588 We initialize the cell to empty, this is in case scm_gc_calloc
589 triggers GC ; we don't want the GC to scan a half-finished Z.
592 SCM z
= scm_cons (SCM_EOL
, SCM_EOL
);
593 scm_t_port
*entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
596 entry
->file_name
= SCM_BOOL_F
;
597 entry
->rw_active
= SCM_PORT_NEITHER
;
600 /* Initialize this port with the thread's current default
602 enc
= scm_i_default_port_encoding ();
603 entry
->encoding
= enc
? scm_gc_strdup (enc
, "port") : NULL
;
605 /* The conversion descriptors will be opened lazily. */
606 entry
->input_cd
= (iconv_t
) -1;
607 entry
->output_cd
= (iconv_t
) -1;
609 entry
->ilseq_handler
= scm_i_get_conversion_strategy (SCM_BOOL_F
);
611 SCM_SET_CELL_TYPE (z
, tag
);
612 SCM_SETPTAB_ENTRY (z
, entry
);
614 scm_hashq_set_x (scm_i_port_weak_hash
, z
, SCM_BOOL_F
);
616 /* For each new port, register a finalizer so that it port type's free
617 function can be invoked eventually. */
618 register_finalizer_for_port (z
);
624 /* Remove a port from the table and destroy it. */
627 scm_i_remove_port (SCM port
)
628 #define FUNC_NAME "scm_remove_port"
632 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
634 p
= SCM_PTAB_ENTRY (port
);
635 scm_port_non_buffer (p
);
636 p
->putback_buf
= NULL
;
637 p
->putback_buf_size
= 0;
639 if (p
->input_cd
!= (iconv_t
) -1)
641 iconv_close (p
->input_cd
);
642 p
->input_cd
= (iconv_t
) -1;
645 if (p
->output_cd
!= (iconv_t
) -1)
647 iconv_close (p
->output_cd
);
648 p
->output_cd
= (iconv_t
) -1;
651 SCM_SETPTAB_ENTRY (port
, 0);
653 scm_hashq_remove_x (scm_i_port_weak_hash
, port
);
655 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
660 /* Functions for debugging. */
662 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
664 "Return the number of ports in the port table. @code{pt-size}\n"
665 "is only included in @code{--enable-guile-debug} builds.")
666 #define FUNC_NAME s_scm_pt_size
668 return scm_from_int (SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
));
674 scm_port_non_buffer (scm_t_port
*pt
)
676 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
677 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
678 pt
->read_buf_size
= pt
->write_buf_size
= 1;
679 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
683 /* Revealed counts --- an oddity inherited from SCSH. */
685 /* Find a port in the table and return its revealed count.
686 Also used by the garbage collector.
690 scm_revealed_count (SCM port
)
692 return SCM_REVEALED(port
);
697 /* Return the revealed count for a port. */
699 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
701 "Return the revealed count for @var{port}.")
702 #define FUNC_NAME s_scm_port_revealed
704 port
= SCM_COERCE_OUTPORT (port
);
705 SCM_VALIDATE_OPENPORT (1, port
);
706 return scm_from_int (scm_revealed_count (port
));
710 /* Set the revealed count for a port. */
711 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
712 (SCM port
, SCM rcount
),
713 "Sets the revealed count for a port to a given value.\n"
714 "The return value is unspecified.")
715 #define FUNC_NAME s_scm_set_port_revealed_x
717 port
= SCM_COERCE_OUTPORT (port
);
718 SCM_VALIDATE_OPENPORT (1, port
);
719 SCM_REVEALED (port
) = scm_to_int (rcount
);
720 return SCM_UNSPECIFIED
;
726 /* Retrieving a port's mode. */
728 /* Return the flags that characterize a port based on the mode
729 * string used to open a file for that port.
731 * See PORT FLAGS in scm.h
735 scm_i_mode_bits_n (SCM modes
)
738 | (scm_i_string_contains_char (modes
, 'r')
739 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
740 | (scm_i_string_contains_char (modes
, 'w')
741 || scm_i_string_contains_char (modes
, 'a')
742 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
743 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
744 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
748 scm_mode_bits (char *modes
)
750 return scm_i_mode_bits (scm_from_locale_string (modes
));
754 scm_i_mode_bits (SCM modes
)
758 if (!scm_is_string (modes
))
759 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
761 bits
= scm_i_mode_bits_n (modes
);
762 scm_remember_upto_here_1 (modes
);
766 /* Return the mode flags from an open port.
767 * Some modes such as "append" are only used when opening
768 * a file and are not returned here. */
770 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
772 "Return the port modes associated with the open port @var{port}.\n"
773 "These will not necessarily be identical to the modes used when\n"
774 "the port was opened, since modes such as \"append\" which are\n"
775 "used only during port creation are not retained.")
776 #define FUNC_NAME s_scm_port_mode
781 port
= SCM_COERCE_OUTPORT (port
);
782 SCM_VALIDATE_OPPORT (1, port
);
783 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
784 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
785 strcpy (modes
, "r+");
789 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
791 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
793 return scm_from_locale_string (modes
);
802 * Call the close operation on a port object.
803 * see also scm_close.
805 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
807 "Close the specified port object. Return @code{#t} if it\n"
808 "successfully closes a port or @code{#f} if it was already\n"
809 "closed. An exception may be raised if an error occurs, for\n"
810 "example when flushing buffered output. See also @ref{Ports and\n"
811 "File Descriptors, close}, for a procedure which can close file\n"
813 #define FUNC_NAME s_scm_close_port
818 port
= SCM_COERCE_OUTPORT (port
);
820 SCM_VALIDATE_PORT (1, port
);
821 if (SCM_CLOSEDP (port
))
823 i
= SCM_PTOBNUM (port
);
824 if (scm_ptobs
[i
].close
)
825 rv
= (scm_ptobs
[i
].close
) (port
);
828 scm_i_remove_port (port
);
829 SCM_CLR_PORT_OPEN_FLAG (port
);
830 return scm_from_bool (rv
>= 0);
834 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
836 "Close the specified input port object. The routine has no effect if\n"
837 "the file has already been closed. An exception may be raised if an\n"
838 "error occurs. The value returned is unspecified.\n\n"
839 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
840 "which can close file descriptors.")
841 #define FUNC_NAME s_scm_close_input_port
843 SCM_VALIDATE_INPUT_PORT (1, port
);
844 scm_close_port (port
);
845 return SCM_UNSPECIFIED
;
849 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
851 "Close the specified output port object. The routine has no effect if\n"
852 "the file has already been closed. An exception may be raised if an\n"
853 "error occurs. The value returned is unspecified.\n\n"
854 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
855 "which can close file descriptors.")
856 #define FUNC_NAME s_scm_close_output_port
858 port
= SCM_COERCE_OUTPORT (port
);
859 SCM_VALIDATE_OUTPUT_PORT (1, port
);
860 scm_close_port (port
);
861 return SCM_UNSPECIFIED
;
866 collect_keys (void *unused
, SCM key
, SCM value
, SCM result
)
868 return scm_cons (key
, result
);
872 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
876 /* Copy out the port table as a list so that we get strong references
877 to all the values. */
878 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
879 ports
= scm_internal_hash_fold (collect_keys
, NULL
,
880 SCM_EOL
, scm_i_port_weak_hash
);
881 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
883 for (; scm_is_pair (ports
); ports
= scm_cdr (ports
))
885 SCM p
= scm_car (ports
);
891 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
893 "Apply @var{proc} to each port in the Guile port table\n"
894 "in turn. The return value is unspecified. More specifically,\n"
895 "@var{proc} is applied exactly once to every port that exists\n"
896 "in the system at the time @var{port-for-each} is invoked.\n"
897 "Changes to the port table while @var{port-for-each} is running\n"
898 "have no effect as far as @var{port-for-each} is concerned.")
899 #define FUNC_NAME s_scm_port_for_each
903 SCM_VALIDATE_PROC (1, proc
);
905 /* Copy out the port table as a list so that we get strong references
906 to all the values. */
907 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
908 ports
= scm_internal_hash_fold (collect_keys
, NULL
,
909 SCM_EOL
, scm_i_port_weak_hash
);
910 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
912 for (; scm_is_pair (ports
); ports
= scm_cdr (ports
))
913 if (SCM_PORTP (SCM_CAR (ports
)))
914 scm_call_1 (proc
, SCM_CAR (ports
));
916 return SCM_UNSPECIFIED
;
922 /* Utter miscellany. Gosh, we should clean this up some time. */
924 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
926 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
927 "@code{#f}. Any object satisfying this predicate also satisfies\n"
929 #define FUNC_NAME s_scm_input_port_p
931 return scm_from_bool (SCM_INPUT_PORT_P (x
));
935 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
937 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
938 "@code{#f}. Any object satisfying this predicate also satisfies\n"
940 #define FUNC_NAME s_scm_output_port_p
942 x
= SCM_COERCE_OUTPORT (x
);
943 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
947 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
949 "Return a boolean indicating whether @var{x} is a port.\n"
950 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
952 #define FUNC_NAME s_scm_port_p
954 return scm_from_bool (SCM_PORTP (x
));
958 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
960 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
962 #define FUNC_NAME s_scm_port_closed_p
964 SCM_VALIDATE_PORT (1, port
);
965 return scm_from_bool (!SCM_OPPORTP (port
));
969 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
971 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
973 #define FUNC_NAME s_scm_eof_object_p
975 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
979 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
981 "Flush the specified output port, or the current output port if @var{port}\n"
982 "is omitted. The current output buffer contents are passed to the\n"
983 "underlying port implementation (e.g., in the case of fports, the\n"
984 "data will be written to the file and the output buffer will be cleared.)\n"
985 "It has no effect on an unbuffered port.\n\n"
986 "The return value is unspecified.")
987 #define FUNC_NAME s_scm_force_output
989 if (SCM_UNBNDP (port
))
990 port
= scm_current_output_port ();
993 port
= SCM_COERCE_OUTPORT (port
);
994 SCM_VALIDATE_OPOUTPORT (1, port
);
997 return SCM_UNSPECIFIED
;
1003 flush_output_port (void *closure
, SCM port
)
1005 if (SCM_OPOUTPORTP (port
))
1009 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
1011 "Equivalent to calling @code{force-output} on\n"
1012 "all open output ports. The return value is unspecified.")
1013 #define FUNC_NAME s_scm_flush_all_ports
1015 scm_c_port_for_each (&flush_output_port
, NULL
);
1016 return SCM_UNSPECIFIED
;
1020 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1022 "Return the next character available from @var{port}, updating\n"
1023 "@var{port} to point to the following character. If no more\n"
1024 "characters are available, the end-of-file object is returned.\n"
1026 "When @var{port}'s data cannot be decoded according to its\n"
1027 "character encoding, a @code{decoding-error} is raised and\n"
1028 "@var{port} points past the erroneous byte sequence.\n")
1029 #define FUNC_NAME s_scm_read_char
1032 if (SCM_UNBNDP (port
))
1033 port
= scm_current_input_port ();
1034 SCM_VALIDATE_OPINPORT (1, port
);
1035 c
= scm_getc (port
);
1038 return SCM_MAKE_CHAR (c
);
1042 /* Update the line and column number of PORT after consumption of C. */
1044 update_port_lf (scm_t_wchar c
, SCM port
)
1069 #define SCM_MBCHAR_BUF_SIZE (4)
1071 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1072 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1074 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1076 scm_t_wchar codepoint
;
1078 if (utf8_buf
[0] <= 0x7f)
1081 codepoint
= utf8_buf
[0];
1083 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1086 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1087 | (utf8_buf
[1] & 0x3f);
1089 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1092 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1093 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1094 | (utf8_buf
[2] & 0x3f);
1099 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1100 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1101 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1102 | (utf8_buf
[3] & 0x3f);
1108 /* Read a UTF-8 sequence from PORT. On success, return 0 and set
1109 *CODEPOINT to the codepoint that was read, fill BUF with its UTF-8
1110 representation, and set *LEN to the length in bytes. Return
1111 `EILSEQ' on error. */
1113 get_utf8_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1114 scm_t_uint8 buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1116 #define ASSERT_NOT_EOF(b) \
1117 if (SCM_UNLIKELY ((b) == EOF)) \
1119 #define CONSUME_PEEKED_BYTE() \
1126 pt
= SCM_PTAB_ENTRY (port
);
1128 byte
= scm_get_byte_or_eof (port
);
1135 buf
[0] = (scm_t_uint8
) byte
;
1140 *codepoint
= buf
[0];
1141 else if (buf
[0] >= 0xc2 && buf
[0] <= 0xdf)
1144 byte
= scm_peek_byte_or_eof (port
);
1145 ASSERT_NOT_EOF (byte
);
1147 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1150 CONSUME_PEEKED_BYTE ();
1151 buf
[1] = (scm_t_uint8
) byte
;
1154 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x1f) << 6UL
1157 else if ((buf
[0] & 0xf0) == 0xe0)
1160 byte
= scm_peek_byte_or_eof (port
);
1161 ASSERT_NOT_EOF (byte
);
1163 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80
1164 || (buf
[0] == 0xe0 && byte
< 0xa0)
1165 || (buf
[0] == 0xed && byte
> 0x9f)))
1168 CONSUME_PEEKED_BYTE ();
1169 buf
[1] = (scm_t_uint8
) byte
;
1172 byte
= scm_peek_byte_or_eof (port
);
1173 ASSERT_NOT_EOF (byte
);
1175 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1178 CONSUME_PEEKED_BYTE ();
1179 buf
[2] = (scm_t_uint8
) byte
;
1182 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x0f) << 12UL
1183 | ((scm_t_wchar
) buf
[1] & 0x3f) << 6UL
1186 else if (buf
[0] >= 0xf0 && buf
[0] <= 0xf4)
1189 byte
= scm_peek_byte_or_eof (port
);
1190 ASSERT_NOT_EOF (byte
);
1192 if (SCM_UNLIKELY (((byte
& 0xc0) != 0x80)
1193 || (buf
[0] == 0xf0 && byte
< 0x90)
1194 || (buf
[0] == 0xf4 && byte
> 0x8f)))
1197 CONSUME_PEEKED_BYTE ();
1198 buf
[1] = (scm_t_uint8
) byte
;
1201 byte
= scm_peek_byte_or_eof (port
);
1202 ASSERT_NOT_EOF (byte
);
1204 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1207 CONSUME_PEEKED_BYTE ();
1208 buf
[2] = (scm_t_uint8
) byte
;
1211 byte
= scm_peek_byte_or_eof (port
);
1212 ASSERT_NOT_EOF (byte
);
1214 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1217 CONSUME_PEEKED_BYTE ();
1218 buf
[3] = (scm_t_uint8
) byte
;
1221 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x07) << 18UL
1222 | ((scm_t_wchar
) buf
[1] & 0x3f) << 12UL
1223 | ((scm_t_wchar
) buf
[2] & 0x3f) << 6UL
1232 /* Here we could choose the consume the faulty byte when it's not a
1233 valid starting byte, but it's not a requirement. What Section 3.9
1234 of Unicode 6.0.0 mandates, though, is to not consume a byte that
1235 would otherwise be a valid starting byte. */
1239 #undef CONSUME_PEEKED_BYTE
1240 #undef ASSERT_NOT_EOF
1243 /* Likewise, read a byte sequence from PORT, passing it through its
1244 input conversion descriptor. */
1246 get_iconv_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1247 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1251 size_t bytes_consumed
, output_size
;
1253 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1255 pt
= SCM_PTAB_ENTRY (port
);
1257 for (output_size
= 0, output
= (char *) utf8_buf
,
1258 bytes_consumed
= 0, err
= 0;
1259 err
== 0 && output_size
== 0
1260 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1264 size_t input_left
, output_left
, done
;
1266 byte_read
= scm_get_byte_or_eof (port
);
1267 if (byte_read
== EOF
)
1269 if (bytes_consumed
== 0)
1271 *codepoint
= (scm_t_wchar
) EOF
;
1279 buf
[bytes_consumed
] = byte_read
;
1282 input_left
= bytes_consumed
+ 1;
1283 output_left
= sizeof (utf8_buf
);
1285 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1286 &output
, &output_left
);
1287 if (done
== (size_t) -1)
1291 /* Missing input: keep trying. */
1295 output_size
= sizeof (utf8_buf
) - output_left
;
1298 if (SCM_UNLIKELY (output_size
== 0))
1299 /* An unterminated sequence. */
1301 else if (SCM_LIKELY (err
== 0))
1303 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1304 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1305 *len
= bytes_consumed
;
1311 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1312 with the byte representation of the codepoint in PORT's encoding, and
1313 set *LEN to the length in bytes of that representation. Return 0 on
1314 success and an errno value on error. */
1316 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1317 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1320 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1322 if (pt
->input_cd
== (iconv_t
) -1)
1323 /* Initialize the conversion descriptors, if needed. */
1324 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1326 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
1327 if (pt
->input_cd
== (iconv_t
) -1)
1328 err
= get_utf8_codepoint (port
, codepoint
, (scm_t_uint8
*) buf
, len
);
1330 err
= get_iconv_codepoint (port
, codepoint
, buf
, len
);
1332 if (SCM_LIKELY (err
== 0))
1333 update_port_lf (*codepoint
, port
);
1334 else if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1338 update_port_lf (*codepoint
, port
);
1344 /* Read a codepoint from PORT and return it. */
1347 #define FUNC_NAME "scm_getc"
1351 scm_t_wchar codepoint
;
1352 char buf
[SCM_MBCHAR_BUF_SIZE
];
1354 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1355 if (SCM_UNLIKELY (err
!= 0))
1356 /* At this point PORT should point past the invalid encoding, as per
1357 R6RS-lib Section 8.2.4. */
1358 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1364 /* this should only be called when the read buffer is empty. it
1365 tries to refill the read buffer. it returns the first char from
1366 the port, which is either EOF or *(pt->read_pos). */
1368 scm_fill_input (SCM port
)
1370 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1372 assert (pt
->read_pos
== pt
->read_end
);
1374 if (pt
->read_buf
== pt
->putback_buf
)
1376 /* finished reading put-back chars. */
1377 pt
->read_buf
= pt
->saved_read_buf
;
1378 pt
->read_pos
= pt
->saved_read_pos
;
1379 pt
->read_end
= pt
->saved_read_end
;
1380 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1381 if (pt
->read_pos
< pt
->read_end
)
1382 return *(pt
->read_pos
);
1384 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1390 * This function differs from scm_c_write; it updates port line and
1394 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1396 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1397 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1399 if (pt
->rw_active
== SCM_PORT_READ
)
1400 scm_end_input (port
);
1402 ptob
->write (port
, ptr
, size
);
1404 for (; size
; ptr
++, size
--)
1405 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1408 pt
->rw_active
= SCM_PORT_WRITE
;
1411 /* Write STR to PORT from START inclusive to END exclusive. */
1413 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1415 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1417 if (pt
->rw_active
== SCM_PORT_READ
)
1418 scm_end_input (port
);
1420 if (end
== (size_t) -1)
1421 end
= scm_i_string_length (str
);
1423 scm_display (scm_c_substring (str
, start
, end
), port
);
1426 pt
->rw_active
= SCM_PORT_WRITE
;
1431 * Used by an application to read arbitrary number of bytes from an
1432 * SCM port. Same semantics as libc read, except that scm_c_read only
1433 * returns less than SIZE bytes if at end-of-file.
1435 * Warning: Doesn't update port line and column counts! */
1437 /* This structure, and the following swap_buffer function, are used
1438 for temporarily swapping a port's own read buffer, and the buffer
1439 that the caller of scm_c_read provides. */
1440 struct port_and_swap_buffer
1443 unsigned char *buffer
;
1448 swap_buffer (void *data
)
1450 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1451 unsigned char *old_buf
= psb
->pt
->read_buf
;
1452 size_t old_size
= psb
->pt
->read_buf_size
;
1454 /* Make the port use (buffer, size) from the struct. */
1455 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1456 psb
->pt
->read_buf_size
= psb
->size
;
1458 /* Save the port's old (buffer, size) in the struct. */
1459 psb
->buffer
= old_buf
;
1460 psb
->size
= old_size
;
1464 scm_c_read (SCM port
, void *buffer
, size_t size
)
1465 #define FUNC_NAME "scm_c_read"
1468 size_t n_read
= 0, n_available
;
1469 struct port_and_swap_buffer psb
;
1471 SCM_VALIDATE_OPINPORT (1, port
);
1473 pt
= SCM_PTAB_ENTRY (port
);
1474 if (pt
->rw_active
== SCM_PORT_WRITE
)
1475 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1478 pt
->rw_active
= SCM_PORT_READ
;
1480 /* Take bytes first from the port's read buffer. */
1481 if (pt
->read_pos
< pt
->read_end
)
1483 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1484 memcpy (buffer
, pt
->read_pos
, n_available
);
1485 buffer
= (char *) buffer
+ n_available
;
1486 pt
->read_pos
+= n_available
;
1487 n_read
+= n_available
;
1488 size
-= n_available
;
1491 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1495 /* Now we will call scm_fill_input repeatedly until we have read the
1496 requested number of bytes. (Note that a single scm_fill_input
1497 call does not guarantee to fill the whole of the port's read
1499 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1501 /* The port that we are reading from is unbuffered - i.e. does
1502 not have its own persistent buffer - but we have a buffer,
1503 provided by our caller, that is the right size for the data
1504 that is wanted. For the following scm_fill_input calls,
1505 therefore, we use the buffer in hand as the port's read
1508 We need to make sure that the port's normal (1 byte) buffer
1509 is reinstated in case one of the scm_fill_input () calls
1510 throws an exception; we use the scm_dynwind_* API to achieve
1513 A consequence of this optimization is that the fill_input
1514 functions can't unget characters. That'll push data to the
1515 pushback buffer instead of this psb buffer. */
1517 unsigned char *pback
= pt
->putback_buf
;
1520 psb
.buffer
= buffer
;
1522 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1523 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1524 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1526 /* Call scm_fill_input until we have all the bytes that we need,
1528 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1530 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1531 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1534 if (pback
!= pt
->putback_buf
1535 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1536 scm_misc_error (FUNC_NAME
,
1537 "scm_c_read must not call a fill function that pushes "
1538 "back characters onto an unbuffered port", SCM_EOL
);
1540 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1542 /* Reinstate the port's normal buffer. */
1547 /* The port has its own buffer. It is important that we use it,
1548 even if it happens to be smaller than our caller's buffer, so
1549 that a custom port implementation's entry points (in
1550 particular, fill_input) can rely on the buffer always being
1551 the same as they first set up. */
1552 while (size
&& (scm_fill_input (port
) != EOF
))
1554 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1555 memcpy (buffer
, pt
->read_pos
, n_available
);
1556 buffer
= (char *) buffer
+ n_available
;
1557 pt
->read_pos
+= n_available
;
1558 n_read
+= n_available
;
1559 size
-= n_available
;
1569 * Used by an application to write arbitrary number of bytes to an SCM
1570 * port. Similar semantics as libc write. However, unlike libc
1571 * write, scm_c_write writes the requested number of bytes and has no
1574 * Warning: Doesn't update port line and column counts!
1578 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1579 #define FUNC_NAME "scm_c_write"
1582 scm_t_ptob_descriptor
*ptob
;
1584 SCM_VALIDATE_OPOUTPORT (1, port
);
1586 pt
= SCM_PTAB_ENTRY (port
);
1587 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1589 if (pt
->rw_active
== SCM_PORT_READ
)
1590 scm_end_input (port
);
1592 ptob
->write (port
, ptr
, size
);
1595 pt
->rw_active
= SCM_PORT_WRITE
;
1600 scm_flush (SCM port
)
1602 long i
= SCM_PTOBNUM (port
);
1604 (scm_ptobs
[i
].flush
) (port
);
1608 scm_end_input (SCM port
)
1611 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1613 if (pt
->read_buf
== pt
->putback_buf
)
1615 offset
= pt
->read_end
- pt
->read_pos
;
1616 pt
->read_buf
= pt
->saved_read_buf
;
1617 pt
->read_pos
= pt
->saved_read_pos
;
1618 pt
->read_end
= pt
->saved_read_end
;
1619 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1624 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1631 scm_unget_byte (int c
, SCM port
)
1632 #define FUNC_NAME "scm_unget_byte"
1634 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1636 if (pt
->read_buf
== pt
->putback_buf
)
1637 /* already using the put-back buffer. */
1639 /* enlarge putback_buf if necessary. */
1640 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1641 && pt
->read_buf
== pt
->read_pos
)
1643 size_t new_size
= pt
->read_buf_size
* 2;
1644 unsigned char *tmp
= (unsigned char *)
1645 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1648 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1649 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1650 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1653 /* shift any existing bytes to buffer + 1. */
1654 if (pt
->read_pos
== pt
->read_end
)
1655 pt
->read_end
= pt
->read_buf
+ 1;
1656 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1658 int count
= pt
->read_end
- pt
->read_pos
;
1660 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1661 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1664 pt
->read_pos
= pt
->read_buf
;
1667 /* switch to the put-back buffer. */
1669 if (pt
->putback_buf
== NULL
)
1672 = (unsigned char *) scm_gc_malloc_pointerless
1673 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1674 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1677 pt
->saved_read_buf
= pt
->read_buf
;
1678 pt
->saved_read_pos
= pt
->read_pos
;
1679 pt
->saved_read_end
= pt
->read_end
;
1680 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1682 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1683 pt
->read_end
= pt
->read_buf
+ 1;
1684 pt
->read_buf_size
= pt
->putback_buf_size
;
1690 pt
->rw_active
= SCM_PORT_READ
;
1695 scm_ungetc (scm_t_wchar c
, SCM port
)
1696 #define FUNC_NAME "scm_ungetc"
1698 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1700 char result_buf
[10];
1701 const char *encoding
;
1705 if (pt
->encoding
!= NULL
)
1706 encoding
= pt
->encoding
;
1708 encoding
= "ISO-8859-1";
1710 len
= sizeof (result_buf
);
1711 result
= u32_conv_to_encoding (encoding
,
1712 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1713 (uint32_t *) &c
, 1, NULL
,
1716 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1717 scm_encoding_error (FUNC_NAME
, errno
,
1718 "conversion to port encoding failed",
1719 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1721 for (i
= len
- 1; i
>= 0; i
--)
1722 scm_unget_byte (result
[i
], port
);
1724 if (SCM_UNLIKELY (result
!= result_buf
))
1729 /* What should col be in this case?
1730 * We'll leave it at -1.
1732 SCM_LINUM (port
) -= 1;
1741 scm_ungets (const char *s
, int n
, SCM port
)
1743 /* This is simple minded and inefficient, but unreading strings is
1744 * probably not a common operation, and remember that line and
1745 * column numbers have to be handled...
1747 * Please feel free to write an optimized version!
1750 scm_ungetc (s
[n
], port
);
1754 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1756 "Return the next character available from @var{port},\n"
1757 "@emph{without} updating @var{port} to point to the following\n"
1758 "character. If no more characters are available, the\n"
1759 "end-of-file object is returned.\n"
1761 "The value returned by\n"
1762 "a call to @code{peek-char} is the same as the value that would\n"
1763 "have been returned by a call to @code{read-char} on the same\n"
1764 "port. The only difference is that the very next call to\n"
1765 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1766 "return the value returned by the preceding call to\n"
1767 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1768 "an interactive port will hang waiting for input whenever a call\n"
1769 "to @code{read-char} would have hung.\n"
1771 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1772 "if such a situation occurs. However, unlike with @code{read-char},\n"
1773 "@var{port} still points at the beginning of the erroneous byte\n"
1774 "sequence when the error is raised.\n")
1775 #define FUNC_NAME s_scm_peek_char
1780 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1781 long column
, line
, i
;
1784 if (SCM_UNBNDP (port
))
1785 port
= scm_current_input_port ();
1786 SCM_VALIDATE_OPINPORT (1, port
);
1788 column
= SCM_COL (port
);
1789 line
= SCM_LINUM (port
);
1791 err
= get_codepoint (port
, &c
, bytes
, &len
);
1793 for (i
= len
- 1; i
>= 0; i
--)
1794 scm_unget_byte (bytes
[i
], port
);
1796 SCM_COL (port
) = column
;
1797 SCM_LINUM (port
) = line
;
1799 if (SCM_UNLIKELY (err
!= 0))
1801 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1803 /* Shouldn't happen since `catch' always aborts to prompt. */
1804 result
= SCM_BOOL_F
;
1807 result
= SCM_EOF_VAL
;
1809 result
= SCM_MAKE_CHAR (c
);
1815 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1816 (SCM cobj
, SCM port
),
1817 "Place @var{char} in @var{port} so that it will be read by the\n"
1818 "next read operation. If called multiple times, the unread characters\n"
1819 "will be read again in last-in first-out order. If @var{port} is\n"
1820 "not supplied, the current input port is used.")
1821 #define FUNC_NAME s_scm_unread_char
1825 SCM_VALIDATE_CHAR (1, cobj
);
1826 if (SCM_UNBNDP (port
))
1827 port
= scm_current_input_port ();
1828 SCM_VALIDATE_OPINPORT (2, port
);
1830 c
= SCM_CHAR (cobj
);
1832 scm_ungetc (c
, port
);
1837 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1838 (SCM str
, SCM port
),
1839 "Place the string @var{str} in @var{port} so that its characters will be\n"
1840 "read in subsequent read operations. If called multiple times, the\n"
1841 "unread characters will be read again in last-in first-out order. If\n"
1842 "@var{port} is not supplied, the current-input-port is used.")
1843 #define FUNC_NAME s_scm_unread_string
1846 SCM_VALIDATE_STRING (1, str
);
1847 if (SCM_UNBNDP (port
))
1848 port
= scm_current_input_port ();
1849 SCM_VALIDATE_OPINPORT (2, port
);
1851 n
= scm_i_string_length (str
);
1854 scm_ungetc (scm_i_string_ref (str
, n
), port
);
1860 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1861 (SCM fd_port
, SCM offset
, SCM whence
),
1862 "Sets the current position of @var{fd/port} to the integer\n"
1863 "@var{offset}, which is interpreted according to the value of\n"
1866 "One of the following variables should be supplied for\n"
1868 "@defvar SEEK_SET\n"
1869 "Seek from the beginning of the file.\n"
1871 "@defvar SEEK_CUR\n"
1872 "Seek from the current position.\n"
1874 "@defvar SEEK_END\n"
1875 "Seek from the end of the file.\n"
1877 "If @var{fd/port} is a file descriptor, the underlying system\n"
1878 "call is @code{lseek}. @var{port} may be a string port.\n"
1880 "The value returned is the new position in the file. This means\n"
1881 "that the current position of a port can be obtained using:\n"
1883 "(seek port 0 SEEK_CUR)\n"
1885 #define FUNC_NAME s_scm_seek
1889 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1891 how
= scm_to_int (whence
);
1892 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1893 SCM_OUT_OF_RANGE (3, whence
);
1895 if (SCM_OPPORTP (fd_port
))
1897 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1898 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1899 off_t_or_off64_t rv
;
1902 SCM_MISC_ERROR ("port is not seekable",
1903 scm_cons (fd_port
, SCM_EOL
));
1905 rv
= ptob
->seek (fd_port
, off
, how
);
1906 return scm_from_off_t_or_off64_t (rv
);
1908 else /* file descriptor?. */
1910 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1911 off_t_or_off64_t rv
;
1912 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1915 return scm_from_off_t_or_off64_t (rv
);
1924 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1925 doesn't have the filename version truncate(), hence this code. */
1926 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1928 truncate (const char *file
, off_t length
)
1932 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1936 ret
= ftruncate (fdes
, length
);
1939 int save_errno
= errno
;
1945 return close (fdes
);
1947 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1949 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1950 (SCM object
, SCM length
),
1951 "Truncate @var{file} to @var{length} bytes. @var{file} can be a\n"
1952 "filename string, a port object, or an integer file descriptor.\n"
1953 "The return value is unspecified.\n"
1955 "For a port or file descriptor @var{length} can be omitted, in\n"
1956 "which case the file is truncated at the current position (per\n"
1957 "@code{ftell} above).\n"
1959 "On most systems a file can be extended by giving a length\n"
1960 "greater than the current size, but this is not mandatory in the\n"
1962 #define FUNC_NAME s_scm_truncate_file
1966 /* "object" can be a port, fdes or filename.
1968 Negative "length" makes no sense, but it's left to truncate() or
1969 ftruncate() to give back an error for that (normally EINVAL).
1972 if (SCM_UNBNDP (length
))
1974 /* must supply length if object is a filename. */
1975 if (scm_is_string (object
))
1976 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
1978 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
1981 object
= SCM_COERCE_OUTPORT (object
);
1982 if (scm_is_integer (object
))
1984 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1985 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
1988 else if (SCM_OPOUTPORTP (object
))
1990 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1991 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
1992 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1994 if (!ptob
->truncate
)
1995 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
1996 if (pt
->rw_active
== SCM_PORT_READ
)
1997 scm_end_input (object
);
1998 else if (pt
->rw_active
== SCM_PORT_WRITE
)
1999 ptob
->flush (object
);
2001 ptob
->truncate (object
, c_length
);
2006 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2007 char *str
= scm_to_locale_string (object
);
2009 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
2016 return SCM_UNSPECIFIED
;
2020 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
2022 "Return the current line number for @var{port}.\n"
2024 "The first line of a file is 0. But you might want to add 1\n"
2025 "when printing line numbers, since starting from 1 is\n"
2026 "traditional in error messages, and likely to be more natural to\n"
2028 #define FUNC_NAME s_scm_port_line
2030 port
= SCM_COERCE_OUTPORT (port
);
2031 SCM_VALIDATE_OPENPORT (1, port
);
2032 return scm_from_long (SCM_LINUM (port
));
2036 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
2037 (SCM port
, SCM line
),
2038 "Set the current line number for @var{port} to @var{line}. The\n"
2039 "first line of a file is 0.")
2040 #define FUNC_NAME s_scm_set_port_line_x
2042 port
= SCM_COERCE_OUTPORT (port
);
2043 SCM_VALIDATE_OPENPORT (1, port
);
2044 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
2045 return SCM_UNSPECIFIED
;
2049 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
2051 "Return the current column number of @var{port}.\n"
2052 "If the number is\n"
2053 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
2054 "- i.e. the first character of the first line is line 0, column 0.\n"
2055 "(However, when you display a file position, for example in an error\n"
2056 "message, we recommend you add 1 to get 1-origin integers. This is\n"
2057 "because lines and column numbers traditionally start with 1, and that is\n"
2058 "what non-programmers will find most natural.)")
2059 #define FUNC_NAME s_scm_port_column
2061 port
= SCM_COERCE_OUTPORT (port
);
2062 SCM_VALIDATE_OPENPORT (1, port
);
2063 return scm_from_int (SCM_COL (port
));
2067 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
2068 (SCM port
, SCM column
),
2069 "Set the current column of @var{port}. Before reading the first\n"
2070 "character on a line the column should be 0.")
2071 #define FUNC_NAME s_scm_set_port_column_x
2073 port
= SCM_COERCE_OUTPORT (port
);
2074 SCM_VALIDATE_OPENPORT (1, port
);
2075 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
2076 return SCM_UNSPECIFIED
;
2080 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
2082 "Return the filename associated with @var{port}, or @code{#f}\n"
2083 "if no filename is associated with the port.")
2084 #define FUNC_NAME s_scm_port_filename
2086 port
= SCM_COERCE_OUTPORT (port
);
2087 SCM_VALIDATE_OPENPORT (1, port
);
2088 return SCM_FILENAME (port
);
2092 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
2093 (SCM port
, SCM filename
),
2094 "Change the filename associated with @var{port}, using the current input\n"
2095 "port if none is specified. Note that this does not change the port's\n"
2096 "source of data, but only the value that is returned by\n"
2097 "@code{port-filename} and reported in diagnostic output.")
2098 #define FUNC_NAME s_scm_set_port_filename_x
2100 port
= SCM_COERCE_OUTPORT (port
);
2101 SCM_VALIDATE_OPENPORT (1, port
);
2102 /* We allow the user to set the filename to whatever he likes. */
2103 SCM_SET_FILENAME (port
, filename
);
2104 return SCM_UNSPECIFIED
;
2108 /* A fluid specifying the default encoding for newly created ports. If it is
2109 a string, that is the encoding. If it is #f, it is in the "native"
2110 (Latin-1) encoding. */
2111 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
2113 static int scm_port_encoding_init
= 0;
2115 /* Use ENCODING as the default encoding for future ports. */
2117 scm_i_set_default_port_encoding (const char *encoding
)
2119 if (!scm_port_encoding_init
2120 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2121 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
2124 if (encoding
== NULL
2125 || !strcmp (encoding
, "ASCII")
2126 || !strcmp (encoding
, "ANSI_X3.4-1968")
2127 || !strcmp (encoding
, "ISO-8859-1"))
2128 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2130 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
2131 scm_from_locale_string (encoding
));
2134 /* Return the name of the default encoding for newly created ports; a
2135 return value of NULL means "ISO-8859-1". */
2137 scm_i_default_port_encoding (void)
2139 if (!scm_port_encoding_init
)
2141 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2147 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
2148 if (!scm_is_string (encoding
))
2151 return scm_i_string_chars (encoding
);
2156 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2159 iconv_t new_input_cd
, new_output_cd
;
2161 new_input_cd
= (iconv_t
) -1;
2162 new_output_cd
= (iconv_t
) -1;
2164 /* Set the character encoding for this port. */
2165 pt
= SCM_PTAB_ENTRY (port
);
2167 if (encoding
== NULL
)
2168 encoding
= "ISO-8859-1";
2170 if (pt
->encoding
!= encoding
)
2171 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2173 /* If ENCODING is UTF-8, then no conversion descriptor is opened
2174 because we do I/O ourselves. This saves 100+ KiB for each
2176 if (strcmp (encoding
, "UTF-8"))
2178 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2180 /* Open an input iconv conversion descriptor, from ENCODING
2181 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2182 implementations can typically convert from anything to
2183 UTF-8, but not to UTF-32 (see
2184 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2185 new_input_cd
= iconv_open ("UTF-8", encoding
);
2186 if (new_input_cd
== (iconv_t
) -1)
2187 goto invalid_encoding
;
2190 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2192 new_output_cd
= iconv_open (encoding
, "UTF-8");
2193 if (new_output_cd
== (iconv_t
) -1)
2195 if (new_input_cd
!= (iconv_t
) -1)
2196 iconv_close (new_input_cd
);
2197 goto invalid_encoding
;
2202 if (pt
->input_cd
!= (iconv_t
) -1)
2203 iconv_close (pt
->input_cd
);
2204 if (pt
->output_cd
!= (iconv_t
) -1)
2205 iconv_close (pt
->output_cd
);
2207 pt
->input_cd
= new_input_cd
;
2208 pt
->output_cd
= new_output_cd
;
2215 err
= scm_from_locale_string (encoding
);
2216 scm_misc_error ("scm_i_set_port_encoding_x",
2217 "invalid or unknown character encoding ~s",
2222 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2224 "Returns, as a string, the character encoding that @var{port}\n"
2225 "uses to interpret its input and output.\n")
2226 #define FUNC_NAME s_scm_port_encoding
2231 SCM_VALIDATE_PORT (1, port
);
2233 pt
= SCM_PTAB_ENTRY (port
);
2236 return scm_from_locale_string (pt
->encoding
);
2242 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2243 (SCM port
, SCM enc
),
2244 "Sets the character encoding that will be used to interpret all\n"
2245 "port I/O. New ports are created with the encoding\n"
2246 "appropriate for the current locale if @code{setlocale} has \n"
2247 "been called or ISO-8859-1 otherwise\n"
2248 "and this procedure can be used to modify that encoding.\n")
2249 #define FUNC_NAME s_scm_set_port_encoding_x
2253 SCM_VALIDATE_PORT (1, port
);
2254 SCM_VALIDATE_STRING (2, enc
);
2256 enc_str
= scm_to_locale_string (enc
);
2257 scm_i_set_port_encoding_x (port
, enc_str
);
2260 return SCM_UNSPECIFIED
;
2265 /* This determines how conversions handle unconvertible characters. */
2266 SCM_GLOBAL_VARIABLE (scm_conversion_strategy
, "%port-conversion-strategy");
2267 static int scm_conversion_strategy_init
= 0;
2269 scm_t_string_failed_conversion_handler
2270 scm_i_get_conversion_strategy (SCM port
)
2274 if (scm_is_false (port
))
2276 if (!scm_conversion_strategy_init
2277 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2278 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2281 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (scm_conversion_strategy
));
2282 if (scm_is_false (encoding
))
2283 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2285 return (scm_t_string_failed_conversion_handler
) scm_to_int (encoding
);
2291 pt
= SCM_PTAB_ENTRY (port
);
2292 return pt
->ilseq_handler
;
2298 scm_i_set_conversion_strategy_x (SCM port
,
2299 scm_t_string_failed_conversion_handler handler
)
2304 strategy
= scm_from_int ((int) handler
);
2306 if (scm_is_false (port
))
2308 /* Set the default encoding for future ports. */
2309 if (!scm_conversion_strategy_init
2310 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2311 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2313 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
), strategy
);
2317 /* Set the character encoding for this port. */
2318 pt
= SCM_PTAB_ENTRY (port
);
2319 pt
->ilseq_handler
= handler
;
2323 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2324 1, 0, 0, (SCM port
),
2325 "Returns the behavior of the port when handling a character that\n"
2326 "is not representable in the port's current encoding.\n"
2327 "It returns the symbol @code{error} if unrepresentable characters\n"
2328 "should cause exceptions, @code{substitute} if the port should\n"
2329 "try to replace unrepresentable characters with question marks or\n"
2330 "approximate characters, or @code{escape} if unrepresentable\n"
2331 "characters should be converted to string escapes.\n"
2333 "If @var{port} is @code{#f}, then the current default behavior\n"
2334 "will be returned. New ports will have this default behavior\n"
2335 "when they are created.\n")
2336 #define FUNC_NAME s_scm_port_conversion_strategy
2338 scm_t_string_failed_conversion_handler h
;
2340 SCM_VALIDATE_OPPORT (1, port
);
2342 if (!scm_is_false (port
))
2344 SCM_VALIDATE_OPPORT (1, port
);
2347 h
= scm_i_get_conversion_strategy (port
);
2348 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2349 return scm_from_latin1_symbol ("error");
2350 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2351 return scm_from_latin1_symbol ("substitute");
2352 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2353 return scm_from_latin1_symbol ("escape");
2357 /* Never gets here. */
2358 return SCM_UNDEFINED
;
2362 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2364 (SCM port
, SCM sym
),
2365 "Sets the behavior of the interpreter when outputting a character\n"
2366 "that is not representable in the port's current encoding.\n"
2367 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2368 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2369 "when an unconvertible character is encountered. If it is\n"
2370 "@code{'substitute}, then unconvertible characters will \n"
2371 "be replaced with approximate characters, or with question marks\n"
2372 "if no approximately correct character is available.\n"
2373 "If it is @code{'escape},\n"
2374 "it will appear as a hex escape when output.\n"
2376 "If @var{port} is an open port, the conversion error behavior\n"
2377 "is set for that port. If it is @code{#f}, it is set as the\n"
2378 "default behavior for any future ports that get created in\n"
2380 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2386 if (!scm_is_false (port
))
2388 SCM_VALIDATE_OPPORT (1, port
);
2391 err
= scm_from_latin1_symbol ("error");
2392 if (scm_is_true (scm_eqv_p (sym
, err
)))
2394 scm_i_set_conversion_strategy_x (port
, SCM_FAILED_CONVERSION_ERROR
);
2395 return SCM_UNSPECIFIED
;
2398 qm
= scm_from_latin1_symbol ("substitute");
2399 if (scm_is_true (scm_eqv_p (sym
, qm
)))
2401 scm_i_set_conversion_strategy_x (port
,
2402 SCM_FAILED_CONVERSION_QUESTION_MARK
);
2403 return SCM_UNSPECIFIED
;
2406 esc
= scm_from_latin1_symbol ("escape");
2407 if (scm_is_true (scm_eqv_p (sym
, esc
)))
2409 scm_i_set_conversion_strategy_x (port
,
2410 SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
);
2411 return SCM_UNSPECIFIED
;
2414 SCM_MISC_ERROR ("unknown conversion behavior ~s", scm_list_1 (sym
));
2416 return SCM_UNSPECIFIED
;
2423 scm_print_port_mode (SCM exp
, SCM port
)
2425 scm_puts (SCM_CLOSEDP (exp
)
2427 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2428 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2431 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2438 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2440 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2443 scm_puts ("#<", port
);
2444 scm_print_port_mode (exp
, port
);
2445 scm_puts (type
, port
);
2446 scm_putc (' ', port
);
2447 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2448 scm_putc ('>', port
);
2456 scm_t_bits scm_tc16_void_port
= 0;
2458 static int fill_input_void_port (SCM port SCM_UNUSED
)
2464 write_void_port (SCM port SCM_UNUSED
,
2465 const void *data SCM_UNUSED
,
2466 size_t size SCM_UNUSED
)
2471 scm_i_void_port (long mode_bits
)
2473 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
2475 SCM answer
= scm_new_port_table_entry (scm_tc16_void_port
);
2476 scm_t_port
* pt
= SCM_PTAB_ENTRY(answer
);
2478 scm_port_non_buffer (pt
);
2480 SCM_SETSTREAM (answer
, 0);
2481 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
2482 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
2488 scm_void_port (char *mode_str
)
2490 return scm_i_void_port (scm_mode_bits (mode_str
));
2493 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2495 "Create and return a new void port. A void port acts like\n"
2496 "@file{/dev/null}. The @var{mode} argument\n"
2497 "specifies the input/output modes for this port: see the\n"
2498 "documentation for @code{open-file} in @ref{File Ports}.")
2499 #define FUNC_NAME s_scm_sys_make_void_port
2501 return scm_i_void_port (scm_i_mode_bits (mode
));
2506 /* Initialization. */
2511 /* lseek() symbols. */
2512 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2513 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2514 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2516 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2519 cur_inport_fluid
= scm_make_fluid ();
2520 cur_outport_fluid
= scm_make_fluid ();
2521 cur_errport_fluid
= scm_make_fluid ();
2522 cur_loadport_fluid
= scm_make_fluid ();
2524 scm_i_port_weak_hash
= scm_make_weak_key_hash_table (SCM_I_MAKINUM(31));
2526 #include "libguile/ports.x"
2528 /* Use Latin-1 as the default port encoding. */
2529 SCM_VARIABLE_SET (default_port_encoding_var
, scm_make_fluid ());
2530 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2531 scm_port_encoding_init
= 1;
2533 SCM_VARIABLE_SET (scm_conversion_strategy
, scm_make_fluid ());
2534 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
),
2535 scm_from_int ((int) SCM_FAILED_CONVERSION_QUESTION_MARK
));
2536 scm_conversion_strategy_init
= 1;