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
= 0;
369 static SCM cur_outport_fluid
= 0;
370 static SCM cur_errport_fluid
= 0;
371 static SCM cur_loadport_fluid
= 0;
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 (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 (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 (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 #if SCM_ENABLE_DEPRECATED==1
626 scm_add_to_port_table (SCM port
)
631 scm_c_issue_deprecation_warning ("scm_add_to_port_table is deprecated.");
633 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
634 z
= scm_new_port_table_entry (scm_tc7_port
);
635 pt
= SCM_PTAB_ENTRY(z
);
637 SCM_SETCAR (z
, SCM_EOL
);
638 SCM_SETCDR (z
, SCM_EOL
);
639 SCM_SETPTAB_ENTRY (port
, pt
);
640 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
647 /* Remove a port from the table and destroy it. */
650 scm_i_remove_port (SCM port
)
651 #define FUNC_NAME "scm_remove_port"
655 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
657 p
= SCM_PTAB_ENTRY (port
);
658 scm_port_non_buffer (p
);
659 p
->putback_buf
= NULL
;
660 p
->putback_buf_size
= 0;
662 if (p
->input_cd
!= (iconv_t
) -1)
664 iconv_close (p
->input_cd
);
665 p
->input_cd
= (iconv_t
) -1;
668 if (p
->output_cd
!= (iconv_t
) -1)
670 iconv_close (p
->output_cd
);
671 p
->output_cd
= (iconv_t
) -1;
674 SCM_SETPTAB_ENTRY (port
, 0);
676 scm_hashq_remove_x (scm_i_port_weak_hash
, port
);
678 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
683 /* Functions for debugging. */
685 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
687 "Return the number of ports in the port table. @code{pt-size}\n"
688 "is only included in @code{--enable-guile-debug} builds.")
689 #define FUNC_NAME s_scm_pt_size
691 return scm_from_int (SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
));
697 scm_port_non_buffer (scm_t_port
*pt
)
699 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
700 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
701 pt
->read_buf_size
= pt
->write_buf_size
= 1;
702 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
706 /* Revealed counts --- an oddity inherited from SCSH. */
708 /* Find a port in the table and return its revealed count.
709 Also used by the garbage collector.
713 scm_revealed_count (SCM port
)
715 return SCM_REVEALED(port
);
720 /* Return the revealed count for a port. */
722 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
724 "Return the revealed count for @var{port}.")
725 #define FUNC_NAME s_scm_port_revealed
727 port
= SCM_COERCE_OUTPORT (port
);
728 SCM_VALIDATE_OPENPORT (1, port
);
729 return scm_from_int (scm_revealed_count (port
));
733 /* Set the revealed count for a port. */
734 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
735 (SCM port
, SCM rcount
),
736 "Sets the revealed count for a port to a given value.\n"
737 "The return value is unspecified.")
738 #define FUNC_NAME s_scm_set_port_revealed_x
740 port
= SCM_COERCE_OUTPORT (port
);
741 SCM_VALIDATE_OPENPORT (1, port
);
742 SCM_REVEALED (port
) = scm_to_int (rcount
);
743 return SCM_UNSPECIFIED
;
749 /* Retrieving a port's mode. */
751 /* Return the flags that characterize a port based on the mode
752 * string used to open a file for that port.
754 * See PORT FLAGS in scm.h
758 scm_i_mode_bits_n (SCM modes
)
761 | (scm_i_string_contains_char (modes
, 'r')
762 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
763 | (scm_i_string_contains_char (modes
, 'w')
764 || scm_i_string_contains_char (modes
, 'a')
765 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
766 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
767 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
771 scm_mode_bits (char *modes
)
773 return scm_i_mode_bits (scm_from_locale_string (modes
));
777 scm_i_mode_bits (SCM modes
)
781 if (!scm_is_string (modes
))
782 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
784 bits
= scm_i_mode_bits_n (modes
);
785 scm_remember_upto_here_1 (modes
);
789 /* Return the mode flags from an open port.
790 * Some modes such as "append" are only used when opening
791 * a file and are not returned here. */
793 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
795 "Return the port modes associated with the open port @var{port}.\n"
796 "These will not necessarily be identical to the modes used when\n"
797 "the port was opened, since modes such as \"append\" which are\n"
798 "used only during port creation are not retained.")
799 #define FUNC_NAME s_scm_port_mode
804 port
= SCM_COERCE_OUTPORT (port
);
805 SCM_VALIDATE_OPPORT (1, port
);
806 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
807 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
808 strcpy (modes
, "r+");
812 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
814 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
816 return scm_from_locale_string (modes
);
825 * Call the close operation on a port object.
826 * see also scm_close.
828 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
830 "Close the specified port object. Return @code{#t} if it\n"
831 "successfully closes a port or @code{#f} if it was already\n"
832 "closed. An exception may be raised if an error occurs, for\n"
833 "example when flushing buffered output. See also @ref{Ports and\n"
834 "File Descriptors, close}, for a procedure which can close file\n"
836 #define FUNC_NAME s_scm_close_port
841 port
= SCM_COERCE_OUTPORT (port
);
843 SCM_VALIDATE_PORT (1, port
);
844 if (SCM_CLOSEDP (port
))
846 i
= SCM_PTOBNUM (port
);
847 if (scm_ptobs
[i
].close
)
848 rv
= (scm_ptobs
[i
].close
) (port
);
851 scm_i_remove_port (port
);
852 SCM_CLR_PORT_OPEN_FLAG (port
);
853 return scm_from_bool (rv
>= 0);
857 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
859 "Close the specified input port object. The routine has no effect if\n"
860 "the file has already been closed. An exception may be raised if an\n"
861 "error occurs. The value returned is unspecified.\n\n"
862 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
863 "which can close file descriptors.")
864 #define FUNC_NAME s_scm_close_input_port
866 SCM_VALIDATE_INPUT_PORT (1, port
);
867 scm_close_port (port
);
868 return SCM_UNSPECIFIED
;
872 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
874 "Close the specified output port object. The routine has no effect if\n"
875 "the file has already been closed. An exception may be raised if an\n"
876 "error occurs. The value returned is unspecified.\n\n"
877 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
878 "which can close file descriptors.")
879 #define FUNC_NAME s_scm_close_output_port
881 port
= SCM_COERCE_OUTPORT (port
);
882 SCM_VALIDATE_OUTPUT_PORT (1, port
);
883 scm_close_port (port
);
884 return SCM_UNSPECIFIED
;
889 collect_keys (void *unused
, SCM key
, SCM value
, SCM result
)
891 return scm_cons (key
, result
);
895 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
899 /* Copy out the port table as a list so that we get strong references
900 to all the values. */
901 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
902 ports
= scm_internal_hash_fold (collect_keys
, NULL
,
903 SCM_EOL
, scm_i_port_weak_hash
);
904 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
906 for (; scm_is_pair (ports
); ports
= scm_cdr (ports
))
908 SCM p
= scm_car (ports
);
914 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
916 "Apply @var{proc} to each port in the Guile port table\n"
917 "in turn. The return value is unspecified. More specifically,\n"
918 "@var{proc} is applied exactly once to every port that exists\n"
919 "in the system at the time @var{port-for-each} is invoked.\n"
920 "Changes to the port table while @var{port-for-each} is running\n"
921 "have no effect as far as @var{port-for-each} is concerned.")
922 #define FUNC_NAME s_scm_port_for_each
924 SCM_VALIDATE_PROC (1, proc
);
926 scm_c_port_for_each ((void (*)(void*,SCM
))scm_call_1
, proc
);
927 return SCM_UNSPECIFIED
;
933 /* Utter miscellany. Gosh, we should clean this up some time. */
935 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
937 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
938 "@code{#f}. Any object satisfying this predicate also satisfies\n"
940 #define FUNC_NAME s_scm_input_port_p
942 return scm_from_bool (SCM_INPUT_PORT_P (x
));
946 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
948 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
949 "@code{#f}. Any object satisfying this predicate also satisfies\n"
951 #define FUNC_NAME s_scm_output_port_p
953 x
= SCM_COERCE_OUTPORT (x
);
954 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
958 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
960 "Return a boolean indicating whether @var{x} is a port.\n"
961 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
963 #define FUNC_NAME s_scm_port_p
965 return scm_from_bool (SCM_PORTP (x
));
969 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
971 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
973 #define FUNC_NAME s_scm_port_closed_p
975 SCM_VALIDATE_PORT (1, port
);
976 return scm_from_bool (!SCM_OPPORTP (port
));
980 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
982 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
984 #define FUNC_NAME s_scm_eof_object_p
986 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
990 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
992 "Flush the specified output port, or the current output port if @var{port}\n"
993 "is omitted. The current output buffer contents are passed to the\n"
994 "underlying port implementation (e.g., in the case of fports, the\n"
995 "data will be written to the file and the output buffer will be cleared.)\n"
996 "It has no effect on an unbuffered port.\n\n"
997 "The return value is unspecified.")
998 #define FUNC_NAME s_scm_force_output
1000 if (SCM_UNBNDP (port
))
1001 port
= scm_current_output_port ();
1004 port
= SCM_COERCE_OUTPORT (port
);
1005 SCM_VALIDATE_OPOUTPORT (1, port
);
1008 return SCM_UNSPECIFIED
;
1014 flush_output_port (void *closure
, SCM port
)
1016 if (SCM_OPOUTPORTP (port
))
1020 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
1022 "Equivalent to calling @code{force-output} on\n"
1023 "all open output ports. The return value is unspecified.")
1024 #define FUNC_NAME s_scm_flush_all_ports
1026 scm_c_port_for_each (&flush_output_port
, NULL
);
1027 return SCM_UNSPECIFIED
;
1031 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1033 "Return the next character available from @var{port}, updating\n"
1034 "@var{port} to point to the following character. If no more\n"
1035 "characters are available, the end-of-file object is returned.\n"
1037 "When @var{port}'s data cannot be decoded according to its\n"
1038 "character encoding, a @code{decoding-error} is raised and\n"
1039 "@var{port} points past the erroneous byte sequence.\n")
1040 #define FUNC_NAME s_scm_read_char
1043 if (SCM_UNBNDP (port
))
1044 port
= scm_current_input_port ();
1045 SCM_VALIDATE_OPINPORT (1, port
);
1046 c
= scm_getc (port
);
1049 return SCM_MAKE_CHAR (c
);
1053 /* Update the line and column number of PORT after consumption of C. */
1055 update_port_lf (scm_t_wchar c
, SCM port
)
1080 #define SCM_MBCHAR_BUF_SIZE (4)
1082 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1083 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1085 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1087 scm_t_wchar codepoint
;
1089 if (utf8_buf
[0] <= 0x7f)
1092 codepoint
= utf8_buf
[0];
1094 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1097 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1098 | (utf8_buf
[1] & 0x3f);
1100 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1103 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1104 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1105 | (utf8_buf
[2] & 0x3f);
1110 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1111 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1112 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1113 | (utf8_buf
[3] & 0x3f);
1119 /* Read a UTF-8 sequence from PORT. On success, return 0 and set
1120 *CODEPOINT to the codepoint that was read, fill BUF with its UTF-8
1121 representation, and set *LEN to the length in bytes. Return
1122 `EILSEQ' on error. */
1124 get_utf8_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1125 scm_t_uint8 buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1127 #define ASSERT_NOT_EOF(b) \
1128 if (SCM_UNLIKELY ((b) == EOF)) \
1135 byte
= scm_get_byte_or_eof (port
);
1142 buf
[0] = (scm_t_uint8
) byte
;
1147 *codepoint
= buf
[0];
1148 else if (buf
[0] >= 0xc2 && buf
[0] <= 0xdf)
1151 byte
= scm_get_byte_or_eof (port
);
1152 ASSERT_NOT_EOF (byte
);
1154 buf
[1] = (scm_t_uint8
) byte
;
1157 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1160 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x1f) << 6UL
1163 else if ((buf
[0] & 0xf0) == 0xe0)
1166 byte
= scm_get_byte_or_eof (port
);
1167 if (SCM_UNLIKELY (byte
== EOF
))
1170 buf
[1] = (scm_t_uint8
) byte
;
1173 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80
1174 || (buf
[0] == 0xe0 && byte
< 0xa0)
1175 || (buf
[0] == 0xed && byte
> 0x9f)))
1177 /* Swallow the 3rd byte. */
1178 byte
= scm_get_byte_or_eof (port
);
1179 ASSERT_NOT_EOF (byte
);
1180 *len
= 3, buf
[2] = byte
;
1185 byte
= scm_get_byte_or_eof (port
);
1186 ASSERT_NOT_EOF (byte
);
1188 buf
[2] = (scm_t_uint8
) byte
;
1191 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1194 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x0f) << 12UL
1195 | ((scm_t_wchar
) buf
[1] & 0x3f) << 6UL
1198 else if (buf
[0] >= 0xf0 && buf
[0] <= 0xf4)
1201 byte
= scm_get_byte_or_eof (port
);
1202 ASSERT_NOT_EOF (byte
);
1204 buf
[1] = (scm_t_uint8
) byte
;
1207 if (SCM_UNLIKELY (((byte
& 0xc0) != 0x80)
1208 || (buf
[0] == 0xf0 && byte
< 0x90)
1209 || (buf
[0] == 0xf4 && byte
> 0x8f)))
1211 /* Swallow the 3rd and 4th bytes. */
1212 byte
= scm_get_byte_or_eof (port
);
1213 ASSERT_NOT_EOF (byte
);
1214 *len
= 3, buf
[2] = byte
;
1216 byte
= scm_get_byte_or_eof (port
);
1217 ASSERT_NOT_EOF (byte
);
1218 *len
= 4, buf
[3] = byte
;
1222 byte
= scm_get_byte_or_eof (port
);
1223 ASSERT_NOT_EOF (byte
);
1225 buf
[2] = (scm_t_uint8
) byte
;
1228 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1230 /* Swallow the 4th byte. */
1231 byte
= scm_get_byte_or_eof (port
);
1232 ASSERT_NOT_EOF (byte
);
1233 *len
= 4, buf
[3] = byte
;
1237 byte
= scm_get_byte_or_eof (port
);
1238 ASSERT_NOT_EOF (byte
);
1240 buf
[3] = (scm_t_uint8
) byte
;
1243 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
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
1259 #undef ASSERT_NOT_EOF
1262 /* Likewise, read a byte sequence from PORT, passing it through its
1263 input conversion descriptor. */
1265 get_iconv_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1266 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1270 size_t bytes_consumed
, output_size
;
1272 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1274 pt
= SCM_PTAB_ENTRY (port
);
1276 for (output_size
= 0, output
= (char *) utf8_buf
,
1277 bytes_consumed
= 0, err
= 0;
1278 err
== 0 && output_size
== 0
1279 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1283 size_t input_left
, output_left
, done
;
1285 byte_read
= scm_get_byte_or_eof (port
);
1286 if (byte_read
== EOF
)
1288 if (bytes_consumed
== 0)
1290 *codepoint
= (scm_t_wchar
) EOF
;
1298 buf
[bytes_consumed
] = byte_read
;
1301 input_left
= bytes_consumed
+ 1;
1302 output_left
= sizeof (utf8_buf
);
1304 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1305 &output
, &output_left
);
1306 if (done
== (size_t) -1)
1310 /* Missing input: keep trying. */
1314 output_size
= sizeof (utf8_buf
) - output_left
;
1317 if (SCM_UNLIKELY (output_size
== 0))
1318 /* An unterminated sequence. */
1320 else if (SCM_LIKELY (err
== 0))
1322 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1323 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1324 *len
= bytes_consumed
;
1330 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1331 with the byte representation of the codepoint in PORT's encoding, and
1332 set *LEN to the length in bytes of that representation. Return 0 on
1333 success and an errno value on error. */
1335 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1336 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1339 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1341 if (pt
->input_cd
== (iconv_t
) -1)
1342 /* Initialize the conversion descriptors, if needed. */
1343 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1345 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
1346 if (pt
->input_cd
== (iconv_t
) -1)
1347 err
= get_utf8_codepoint (port
, codepoint
, (scm_t_uint8
*) buf
, len
);
1349 err
= get_iconv_codepoint (port
, codepoint
, buf
, len
);
1351 if (SCM_LIKELY (err
== 0))
1352 update_port_lf (*codepoint
, port
);
1353 else if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1357 update_port_lf (*codepoint
, port
);
1363 /* Read a codepoint from PORT and return it. */
1366 #define FUNC_NAME "scm_getc"
1370 scm_t_wchar codepoint
;
1371 char buf
[SCM_MBCHAR_BUF_SIZE
];
1373 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1374 if (SCM_UNLIKELY (err
!= 0))
1375 /* At this point PORT should point past the invalid encoding, as per
1376 R6RS-lib Section 8.2.4. */
1377 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1383 /* this should only be called when the read buffer is empty. it
1384 tries to refill the read buffer. it returns the first char from
1385 the port, which is either EOF or *(pt->read_pos). */
1387 scm_fill_input (SCM port
)
1389 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1391 assert (pt
->read_pos
== pt
->read_end
);
1393 if (pt
->read_buf
== pt
->putback_buf
)
1395 /* finished reading put-back chars. */
1396 pt
->read_buf
= pt
->saved_read_buf
;
1397 pt
->read_pos
= pt
->saved_read_pos
;
1398 pt
->read_end
= pt
->saved_read_end
;
1399 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1400 if (pt
->read_pos
< pt
->read_end
)
1401 return *(pt
->read_pos
);
1403 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1409 * This function differs from scm_c_write; it updates port line and
1413 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1415 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1416 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1418 if (pt
->rw_active
== SCM_PORT_READ
)
1419 scm_end_input (port
);
1421 ptob
->write (port
, ptr
, size
);
1423 for (; size
; ptr
++, size
--)
1424 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1427 pt
->rw_active
= SCM_PORT_WRITE
;
1430 /* Write STR to PORT from START inclusive to END exclusive. */
1432 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1434 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1436 if (pt
->rw_active
== SCM_PORT_READ
)
1437 scm_end_input (port
);
1439 if (end
== (size_t) -1)
1440 end
= scm_i_string_length (str
);
1442 scm_display (scm_c_substring (str
, start
, end
), port
);
1445 pt
->rw_active
= SCM_PORT_WRITE
;
1450 * Used by an application to read arbitrary number of bytes from an
1451 * SCM port. Same semantics as libc read, except that scm_c_read only
1452 * returns less than SIZE bytes if at end-of-file.
1454 * Warning: Doesn't update port line and column counts! */
1456 /* This structure, and the following swap_buffer function, are used
1457 for temporarily swapping a port's own read buffer, and the buffer
1458 that the caller of scm_c_read provides. */
1459 struct port_and_swap_buffer
1462 unsigned char *buffer
;
1467 swap_buffer (void *data
)
1469 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1470 unsigned char *old_buf
= psb
->pt
->read_buf
;
1471 size_t old_size
= psb
->pt
->read_buf_size
;
1473 /* Make the port use (buffer, size) from the struct. */
1474 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1475 psb
->pt
->read_buf_size
= psb
->size
;
1477 /* Save the port's old (buffer, size) in the struct. */
1478 psb
->buffer
= old_buf
;
1479 psb
->size
= old_size
;
1483 scm_c_read (SCM port
, void *buffer
, size_t size
)
1484 #define FUNC_NAME "scm_c_read"
1487 size_t n_read
= 0, n_available
;
1488 struct port_and_swap_buffer psb
;
1490 SCM_VALIDATE_OPINPORT (1, port
);
1492 pt
= SCM_PTAB_ENTRY (port
);
1493 if (pt
->rw_active
== SCM_PORT_WRITE
)
1494 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1497 pt
->rw_active
= SCM_PORT_READ
;
1499 /* Take bytes first from the port's read buffer. */
1500 if (pt
->read_pos
< pt
->read_end
)
1502 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1503 memcpy (buffer
, pt
->read_pos
, n_available
);
1504 buffer
= (char *) buffer
+ n_available
;
1505 pt
->read_pos
+= n_available
;
1506 n_read
+= n_available
;
1507 size
-= n_available
;
1510 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1514 /* Now we will call scm_fill_input repeatedly until we have read the
1515 requested number of bytes. (Note that a single scm_fill_input
1516 call does not guarantee to fill the whole of the port's read
1518 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1520 /* The port that we are reading from is unbuffered - i.e. does
1521 not have its own persistent buffer - but we have a buffer,
1522 provided by our caller, that is the right size for the data
1523 that is wanted. For the following scm_fill_input calls,
1524 therefore, we use the buffer in hand as the port's read
1527 We need to make sure that the port's normal (1 byte) buffer
1528 is reinstated in case one of the scm_fill_input () calls
1529 throws an exception; we use the scm_dynwind_* API to achieve
1532 A consequence of this optimization is that the fill_input
1533 functions can't unget characters. That'll push data to the
1534 pushback buffer instead of this psb buffer. */
1536 unsigned char *pback
= pt
->putback_buf
;
1539 psb
.buffer
= buffer
;
1541 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1542 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1543 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1545 /* Call scm_fill_input until we have all the bytes that we need,
1547 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1549 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1550 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1553 if (pback
!= pt
->putback_buf
1554 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1555 scm_misc_error (FUNC_NAME
,
1556 "scm_c_read must not call a fill function that pushes "
1557 "back characters onto an unbuffered port", SCM_EOL
);
1559 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1561 /* Reinstate the port's normal buffer. */
1566 /* The port has its own buffer. It is important that we use it,
1567 even if it happens to be smaller than our caller's buffer, so
1568 that a custom port implementation's entry points (in
1569 particular, fill_input) can rely on the buffer always being
1570 the same as they first set up. */
1571 while (size
&& (scm_fill_input (port
) != EOF
))
1573 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1574 memcpy (buffer
, pt
->read_pos
, n_available
);
1575 buffer
= (char *) buffer
+ n_available
;
1576 pt
->read_pos
+= n_available
;
1577 n_read
+= n_available
;
1578 size
-= n_available
;
1588 * Used by an application to write arbitrary number of bytes to an SCM
1589 * port. Similar semantics as libc write. However, unlike libc
1590 * write, scm_c_write writes the requested number of bytes and has no
1593 * Warning: Doesn't update port line and column counts!
1597 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1598 #define FUNC_NAME "scm_c_write"
1601 scm_t_ptob_descriptor
*ptob
;
1603 SCM_VALIDATE_OPOUTPORT (1, port
);
1605 pt
= SCM_PTAB_ENTRY (port
);
1606 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1608 if (pt
->rw_active
== SCM_PORT_READ
)
1609 scm_end_input (port
);
1611 ptob
->write (port
, ptr
, size
);
1614 pt
->rw_active
= SCM_PORT_WRITE
;
1619 scm_flush (SCM port
)
1621 long i
= SCM_PTOBNUM (port
);
1623 (scm_ptobs
[i
].flush
) (port
);
1627 scm_end_input (SCM port
)
1630 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1632 if (pt
->read_buf
== pt
->putback_buf
)
1634 offset
= pt
->read_end
- pt
->read_pos
;
1635 pt
->read_buf
= pt
->saved_read_buf
;
1636 pt
->read_pos
= pt
->saved_read_pos
;
1637 pt
->read_end
= pt
->saved_read_end
;
1638 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1643 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1650 scm_unget_byte (int c
, SCM port
)
1651 #define FUNC_NAME "scm_unget_byte"
1653 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1655 if (pt
->read_buf
== pt
->putback_buf
)
1656 /* already using the put-back buffer. */
1658 /* enlarge putback_buf if necessary. */
1659 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1660 && pt
->read_buf
== pt
->read_pos
)
1662 size_t new_size
= pt
->read_buf_size
* 2;
1663 unsigned char *tmp
= (unsigned char *)
1664 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1667 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1668 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1669 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1672 /* shift any existing bytes to buffer + 1. */
1673 if (pt
->read_pos
== pt
->read_end
)
1674 pt
->read_end
= pt
->read_buf
+ 1;
1675 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1677 int count
= pt
->read_end
- pt
->read_pos
;
1679 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1680 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1683 pt
->read_pos
= pt
->read_buf
;
1686 /* switch to the put-back buffer. */
1688 if (pt
->putback_buf
== NULL
)
1691 = (unsigned char *) scm_gc_malloc_pointerless
1692 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1693 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1696 pt
->saved_read_buf
= pt
->read_buf
;
1697 pt
->saved_read_pos
= pt
->read_pos
;
1698 pt
->saved_read_end
= pt
->read_end
;
1699 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1701 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1702 pt
->read_end
= pt
->read_buf
+ 1;
1703 pt
->read_buf_size
= pt
->putback_buf_size
;
1709 pt
->rw_active
= SCM_PORT_READ
;
1714 scm_ungetc (scm_t_wchar c
, SCM port
)
1715 #define FUNC_NAME "scm_ungetc"
1717 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1719 char result_buf
[10];
1720 const char *encoding
;
1724 if (pt
->encoding
!= NULL
)
1725 encoding
= pt
->encoding
;
1727 encoding
= "ISO-8859-1";
1729 len
= sizeof (result_buf
);
1730 result
= u32_conv_to_encoding (encoding
,
1731 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1732 (uint32_t *) &c
, 1, NULL
,
1735 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1736 scm_encoding_error (FUNC_NAME
, errno
,
1737 "conversion to port encoding failed",
1738 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1740 for (i
= len
- 1; i
>= 0; i
--)
1741 scm_unget_byte (result
[i
], port
);
1743 if (SCM_UNLIKELY (result
!= result_buf
))
1748 /* What should col be in this case?
1749 * We'll leave it at -1.
1751 SCM_LINUM (port
) -= 1;
1760 scm_ungets (const char *s
, int n
, SCM port
)
1762 /* This is simple minded and inefficient, but unreading strings is
1763 * probably not a common operation, and remember that line and
1764 * column numbers have to be handled...
1766 * Please feel free to write an optimized version!
1769 scm_ungetc (s
[n
], port
);
1773 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1775 "Return the next character available from @var{port},\n"
1776 "@emph{without} updating @var{port} to point to the following\n"
1777 "character. If no more characters are available, the\n"
1778 "end-of-file object is returned.\n"
1780 "The value returned by\n"
1781 "a call to @code{peek-char} is the same as the value that would\n"
1782 "have been returned by a call to @code{read-char} on the same\n"
1783 "port. The only difference is that the very next call to\n"
1784 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1785 "return the value returned by the preceding call to\n"
1786 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1787 "an interactive port will hang waiting for input whenever a call\n"
1788 "to @code{read-char} would have hung.\n"
1790 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1791 "if such a situation occurs. However, unlike with @code{read-char},\n"
1792 "@var{port} still points at the beginning of the erroneous byte\n"
1793 "sequence when the error is raised.\n")
1794 #define FUNC_NAME s_scm_peek_char
1799 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1800 long column
, line
, i
;
1803 if (SCM_UNBNDP (port
))
1804 port
= scm_current_input_port ();
1805 SCM_VALIDATE_OPINPORT (1, port
);
1807 column
= SCM_COL (port
);
1808 line
= SCM_LINUM (port
);
1810 err
= get_codepoint (port
, &c
, bytes
, &len
);
1812 for (i
= len
- 1; i
>= 0; i
--)
1813 scm_unget_byte (bytes
[i
], port
);
1815 SCM_COL (port
) = column
;
1816 SCM_LINUM (port
) = line
;
1818 if (SCM_UNLIKELY (err
!= 0))
1820 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1822 /* Shouldn't happen since `catch' always aborts to prompt. */
1823 result
= SCM_BOOL_F
;
1826 result
= SCM_EOF_VAL
;
1828 result
= SCM_MAKE_CHAR (c
);
1834 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1835 (SCM cobj
, SCM port
),
1836 "Place @var{char} in @var{port} so that it will be read by the\n"
1837 "next read operation. If called multiple times, the unread characters\n"
1838 "will be read again in last-in first-out order. If @var{port} is\n"
1839 "not supplied, the current input port is used.")
1840 #define FUNC_NAME s_scm_unread_char
1844 SCM_VALIDATE_CHAR (1, cobj
);
1845 if (SCM_UNBNDP (port
))
1846 port
= scm_current_input_port ();
1847 SCM_VALIDATE_OPINPORT (2, port
);
1849 c
= SCM_CHAR (cobj
);
1851 scm_ungetc (c
, port
);
1856 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1857 (SCM str
, SCM port
),
1858 "Place the string @var{str} in @var{port} so that its characters will be\n"
1859 "read in subsequent read operations. If called multiple times, the\n"
1860 "unread characters will be read again in last-in first-out order. If\n"
1861 "@var{port} is not supplied, the current-input-port is used.")
1862 #define FUNC_NAME s_scm_unread_string
1865 SCM_VALIDATE_STRING (1, str
);
1866 if (SCM_UNBNDP (port
))
1867 port
= scm_current_input_port ();
1868 SCM_VALIDATE_OPINPORT (2, port
);
1870 n
= scm_i_string_length (str
);
1873 scm_ungetc (scm_i_string_ref (str
, n
), port
);
1879 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1880 (SCM fd_port
, SCM offset
, SCM whence
),
1881 "Sets the current position of @var{fd/port} to the integer\n"
1882 "@var{offset}, which is interpreted according to the value of\n"
1885 "One of the following variables should be supplied for\n"
1887 "@defvar SEEK_SET\n"
1888 "Seek from the beginning of the file.\n"
1890 "@defvar SEEK_CUR\n"
1891 "Seek from the current position.\n"
1893 "@defvar SEEK_END\n"
1894 "Seek from the end of the file.\n"
1896 "If @var{fd/port} is a file descriptor, the underlying system\n"
1897 "call is @code{lseek}. @var{port} may be a string port.\n"
1899 "The value returned is the new position in the file. This means\n"
1900 "that the current position of a port can be obtained using:\n"
1902 "(seek port 0 SEEK_CUR)\n"
1904 #define FUNC_NAME s_scm_seek
1908 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1910 how
= scm_to_int (whence
);
1911 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1912 SCM_OUT_OF_RANGE (3, whence
);
1914 if (SCM_OPPORTP (fd_port
))
1916 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1917 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1918 off_t_or_off64_t rv
;
1921 SCM_MISC_ERROR ("port is not seekable",
1922 scm_cons (fd_port
, SCM_EOL
));
1924 rv
= ptob
->seek (fd_port
, off
, how
);
1925 return scm_from_off_t_or_off64_t (rv
);
1927 else /* file descriptor?. */
1929 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1930 off_t_or_off64_t rv
;
1931 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1934 return scm_from_off_t_or_off64_t (rv
);
1943 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1944 doesn't have the filename version truncate(), hence this code. */
1945 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1947 truncate (const char *file
, off_t length
)
1951 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1955 ret
= ftruncate (fdes
, length
);
1958 int save_errno
= errno
;
1964 return close (fdes
);
1966 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1968 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1969 (SCM object
, SCM length
),
1970 "Truncate @var{file} to @var{length} bytes. @var{file} can be a\n"
1971 "filename string, a port object, or an integer file descriptor.\n"
1972 "The return value is unspecified.\n"
1974 "For a port or file descriptor @var{length} can be omitted, in\n"
1975 "which case the file is truncated at the current position (per\n"
1976 "@code{ftell} above).\n"
1978 "On most systems a file can be extended by giving a length\n"
1979 "greater than the current size, but this is not mandatory in the\n"
1981 #define FUNC_NAME s_scm_truncate_file
1985 /* "object" can be a port, fdes or filename.
1987 Negative "length" makes no sense, but it's left to truncate() or
1988 ftruncate() to give back an error for that (normally EINVAL).
1991 if (SCM_UNBNDP (length
))
1993 /* must supply length if object is a filename. */
1994 if (scm_is_string (object
))
1995 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
1997 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
2000 object
= SCM_COERCE_OUTPORT (object
);
2001 if (scm_is_integer (object
))
2003 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2004 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
2007 else if (SCM_OPOUTPORTP (object
))
2009 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2010 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
2011 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
2013 if (!ptob
->truncate
)
2014 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
2015 if (pt
->rw_active
== SCM_PORT_READ
)
2016 scm_end_input (object
);
2017 else if (pt
->rw_active
== SCM_PORT_WRITE
)
2018 ptob
->flush (object
);
2020 ptob
->truncate (object
, c_length
);
2025 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2026 char *str
= scm_to_locale_string (object
);
2028 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
2035 return SCM_UNSPECIFIED
;
2039 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
2041 "Return the current line number for @var{port}.\n"
2043 "The first line of a file is 0. But you might want to add 1\n"
2044 "when printing line numbers, since starting from 1 is\n"
2045 "traditional in error messages, and likely to be more natural to\n"
2047 #define FUNC_NAME s_scm_port_line
2049 port
= SCM_COERCE_OUTPORT (port
);
2050 SCM_VALIDATE_OPENPORT (1, port
);
2051 return scm_from_long (SCM_LINUM (port
));
2055 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
2056 (SCM port
, SCM line
),
2057 "Set the current line number for @var{port} to @var{line}. The\n"
2058 "first line of a file is 0.")
2059 #define FUNC_NAME s_scm_set_port_line_x
2061 port
= SCM_COERCE_OUTPORT (port
);
2062 SCM_VALIDATE_OPENPORT (1, port
);
2063 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
2064 return SCM_UNSPECIFIED
;
2068 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
2070 "Return the current column number of @var{port}.\n"
2071 "If the number is\n"
2072 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
2073 "- i.e. the first character of the first line is line 0, column 0.\n"
2074 "(However, when you display a file position, for example in an error\n"
2075 "message, we recommend you add 1 to get 1-origin integers. This is\n"
2076 "because lines and column numbers traditionally start with 1, and that is\n"
2077 "what non-programmers will find most natural.)")
2078 #define FUNC_NAME s_scm_port_column
2080 port
= SCM_COERCE_OUTPORT (port
);
2081 SCM_VALIDATE_OPENPORT (1, port
);
2082 return scm_from_int (SCM_COL (port
));
2086 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
2087 (SCM port
, SCM column
),
2088 "Set the current column of @var{port}. Before reading the first\n"
2089 "character on a line the column should be 0.")
2090 #define FUNC_NAME s_scm_set_port_column_x
2092 port
= SCM_COERCE_OUTPORT (port
);
2093 SCM_VALIDATE_OPENPORT (1, port
);
2094 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
2095 return SCM_UNSPECIFIED
;
2099 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
2101 "Return the filename associated with @var{port}, or @code{#f}\n"
2102 "if no filename is associated with the port.")
2103 #define FUNC_NAME s_scm_port_filename
2105 port
= SCM_COERCE_OUTPORT (port
);
2106 SCM_VALIDATE_OPENPORT (1, port
);
2107 return SCM_FILENAME (port
);
2111 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
2112 (SCM port
, SCM filename
),
2113 "Change the filename associated with @var{port}, using the current input\n"
2114 "port if none is specified. Note that this does not change the port's\n"
2115 "source of data, but only the value that is returned by\n"
2116 "@code{port-filename} and reported in diagnostic output.")
2117 #define FUNC_NAME s_scm_set_port_filename_x
2119 port
= SCM_COERCE_OUTPORT (port
);
2120 SCM_VALIDATE_OPENPORT (1, port
);
2121 /* We allow the user to set the filename to whatever he likes. */
2122 SCM_SET_FILENAME (port
, filename
);
2123 return SCM_UNSPECIFIED
;
2127 /* A fluid specifying the default encoding for newly created ports. If it is
2128 a string, that is the encoding. If it is #f, it is in the "native"
2129 (Latin-1) encoding. */
2130 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
2132 static int scm_port_encoding_init
= 0;
2134 /* Use ENCODING as the default encoding for future ports. */
2136 scm_i_set_default_port_encoding (const char *encoding
)
2138 if (!scm_port_encoding_init
2139 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2140 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
2143 if (encoding
== NULL
2144 || !strcmp (encoding
, "ASCII")
2145 || !strcmp (encoding
, "ANSI_X3.4-1968")
2146 || !strcmp (encoding
, "ISO-8859-1"))
2147 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2149 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
2150 scm_from_locale_string (encoding
));
2153 /* Return the name of the default encoding for newly created ports; a
2154 return value of NULL means "ISO-8859-1". */
2156 scm_i_default_port_encoding (void)
2158 if (!scm_port_encoding_init
)
2160 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2166 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
2167 if (!scm_is_string (encoding
))
2170 return scm_i_string_chars (encoding
);
2175 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2178 iconv_t new_input_cd
, new_output_cd
;
2180 new_input_cd
= (iconv_t
) -1;
2181 new_output_cd
= (iconv_t
) -1;
2183 /* Set the character encoding for this port. */
2184 pt
= SCM_PTAB_ENTRY (port
);
2186 if (encoding
== NULL
)
2187 encoding
= "ISO-8859-1";
2189 if (pt
->encoding
!= encoding
)
2190 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2192 /* If ENCODING is UTF-8, then no conversion descriptor is opened
2193 because we do I/O ourselves. This saves 100+ KiB for each
2195 if (strcmp (encoding
, "UTF-8"))
2197 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2199 /* Open an input iconv conversion descriptor, from ENCODING
2200 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2201 implementations can typically convert from anything to
2202 UTF-8, but not to UTF-32 (see
2203 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2204 new_input_cd
= iconv_open ("UTF-8", encoding
);
2205 if (new_input_cd
== (iconv_t
) -1)
2206 goto invalid_encoding
;
2209 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2211 new_output_cd
= iconv_open (encoding
, "UTF-8");
2212 if (new_output_cd
== (iconv_t
) -1)
2214 if (new_input_cd
!= (iconv_t
) -1)
2215 iconv_close (new_input_cd
);
2216 goto invalid_encoding
;
2221 if (pt
->input_cd
!= (iconv_t
) -1)
2222 iconv_close (pt
->input_cd
);
2223 if (pt
->output_cd
!= (iconv_t
) -1)
2224 iconv_close (pt
->output_cd
);
2226 pt
->input_cd
= new_input_cd
;
2227 pt
->output_cd
= new_output_cd
;
2234 err
= scm_from_locale_string (encoding
);
2235 scm_misc_error ("scm_i_set_port_encoding_x",
2236 "invalid or unknown character encoding ~s",
2241 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2243 "Returns, as a string, the character encoding that @var{port}\n"
2244 "uses to interpret its input and output.\n")
2245 #define FUNC_NAME s_scm_port_encoding
2250 SCM_VALIDATE_PORT (1, port
);
2252 pt
= SCM_PTAB_ENTRY (port
);
2255 return scm_from_locale_string (pt
->encoding
);
2261 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2262 (SCM port
, SCM enc
),
2263 "Sets the character encoding that will be used to interpret all\n"
2264 "port I/O. New ports are created with the encoding\n"
2265 "appropriate for the current locale if @code{setlocale} has \n"
2266 "been called or ISO-8859-1 otherwise\n"
2267 "and this procedure can be used to modify that encoding.\n")
2268 #define FUNC_NAME s_scm_set_port_encoding_x
2272 SCM_VALIDATE_PORT (1, port
);
2273 SCM_VALIDATE_STRING (2, enc
);
2275 enc_str
= scm_to_locale_string (enc
);
2276 scm_i_set_port_encoding_x (port
, enc_str
);
2279 return SCM_UNSPECIFIED
;
2284 /* This determines how conversions handle unconvertible characters. */
2285 SCM_GLOBAL_VARIABLE (scm_conversion_strategy
, "%port-conversion-strategy");
2286 static int scm_conversion_strategy_init
= 0;
2288 scm_t_string_failed_conversion_handler
2289 scm_i_get_conversion_strategy (SCM port
)
2293 if (scm_is_false (port
))
2295 if (!scm_conversion_strategy_init
2296 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2297 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2300 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (scm_conversion_strategy
));
2301 if (scm_is_false (encoding
))
2302 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2304 return (scm_t_string_failed_conversion_handler
) scm_to_int (encoding
);
2310 pt
= SCM_PTAB_ENTRY (port
);
2311 return pt
->ilseq_handler
;
2317 scm_i_set_conversion_strategy_x (SCM port
,
2318 scm_t_string_failed_conversion_handler handler
)
2323 strategy
= scm_from_int ((int) handler
);
2325 if (scm_is_false (port
))
2327 /* Set the default encoding for future ports. */
2328 if (!scm_conversion_strategy
2329 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2330 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2332 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
), strategy
);
2336 /* Set the character encoding for this port. */
2337 pt
= SCM_PTAB_ENTRY (port
);
2338 pt
->ilseq_handler
= handler
;
2342 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2343 1, 0, 0, (SCM port
),
2344 "Returns the behavior of the port when handling a character that\n"
2345 "is not representable in the port's current encoding.\n"
2346 "It returns the symbol @code{error} if unrepresentable characters\n"
2347 "should cause exceptions, @code{substitute} if the port should\n"
2348 "try to replace unrepresentable characters with question marks or\n"
2349 "approximate characters, or @code{escape} if unrepresentable\n"
2350 "characters should be converted to string escapes.\n"
2352 "If @var{port} is @code{#f}, then the current default behavior\n"
2353 "will be returned. New ports will have this default behavior\n"
2354 "when they are created.\n")
2355 #define FUNC_NAME s_scm_port_conversion_strategy
2357 scm_t_string_failed_conversion_handler h
;
2359 SCM_VALIDATE_OPPORT (1, port
);
2361 if (!scm_is_false (port
))
2363 SCM_VALIDATE_OPPORT (1, port
);
2366 h
= scm_i_get_conversion_strategy (port
);
2367 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2368 return scm_from_latin1_symbol ("error");
2369 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2370 return scm_from_latin1_symbol ("substitute");
2371 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2372 return scm_from_latin1_symbol ("escape");
2376 /* Never gets here. */
2377 return SCM_UNDEFINED
;
2381 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2383 (SCM port
, SCM sym
),
2384 "Sets the behavior of the interpreter when outputting a character\n"
2385 "that is not representable in the port's current encoding.\n"
2386 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2387 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2388 "when an unconvertible character is encountered. If it is\n"
2389 "@code{'substitute}, then unconvertible characters will \n"
2390 "be replaced with approximate characters, or with question marks\n"
2391 "if no approximately correct character is available.\n"
2392 "If it is @code{'escape},\n"
2393 "it will appear as a hex escape when output.\n"
2395 "If @var{port} is an open port, the conversion error behavior\n"
2396 "is set for that port. If it is @code{#f}, it is set as the\n"
2397 "default behavior for any future ports that get created in\n"
2399 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2405 if (!scm_is_false (port
))
2407 SCM_VALIDATE_OPPORT (1, port
);
2410 err
= scm_from_latin1_symbol ("error");
2411 if (scm_is_true (scm_eqv_p (sym
, err
)))
2413 scm_i_set_conversion_strategy_x (port
, SCM_FAILED_CONVERSION_ERROR
);
2414 return SCM_UNSPECIFIED
;
2417 qm
= scm_from_latin1_symbol ("substitute");
2418 if (scm_is_true (scm_eqv_p (sym
, qm
)))
2420 scm_i_set_conversion_strategy_x (port
,
2421 SCM_FAILED_CONVERSION_QUESTION_MARK
);
2422 return SCM_UNSPECIFIED
;
2425 esc
= scm_from_latin1_symbol ("escape");
2426 if (scm_is_true (scm_eqv_p (sym
, esc
)))
2428 scm_i_set_conversion_strategy_x (port
,
2429 SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
);
2430 return SCM_UNSPECIFIED
;
2433 SCM_MISC_ERROR ("unknown conversion behavior ~s", scm_list_1 (sym
));
2435 return SCM_UNSPECIFIED
;
2442 scm_print_port_mode (SCM exp
, SCM port
)
2444 scm_puts (SCM_CLOSEDP (exp
)
2446 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2447 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2450 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2457 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2459 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2462 scm_puts ("#<", port
);
2463 scm_print_port_mode (exp
, port
);
2464 scm_puts (type
, port
);
2465 scm_putc (' ', port
);
2466 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2467 scm_putc ('>', port
);
2475 scm_t_bits scm_tc16_void_port
= 0;
2477 static int fill_input_void_port (SCM port SCM_UNUSED
)
2483 write_void_port (SCM port SCM_UNUSED
,
2484 const void *data SCM_UNUSED
,
2485 size_t size SCM_UNUSED
)
2490 scm_i_void_port (long mode_bits
)
2492 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
2494 SCM answer
= scm_new_port_table_entry (scm_tc16_void_port
);
2495 scm_t_port
* pt
= SCM_PTAB_ENTRY(answer
);
2497 scm_port_non_buffer (pt
);
2499 SCM_SETSTREAM (answer
, 0);
2500 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
2501 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
2507 scm_void_port (char *mode_str
)
2509 return scm_i_void_port (scm_mode_bits (mode_str
));
2512 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2514 "Create and return a new void port. A void port acts like\n"
2515 "@file{/dev/null}. The @var{mode} argument\n"
2516 "specifies the input/output modes for this port: see the\n"
2517 "documentation for @code{open-file} in @ref{File Ports}.")
2518 #define FUNC_NAME s_scm_sys_make_void_port
2520 return scm_i_void_port (scm_i_mode_bits (mode
));
2525 /* Initialization. */
2530 /* lseek() symbols. */
2531 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2532 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2533 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2535 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2538 cur_inport_fluid
= scm_make_fluid ();
2539 cur_outport_fluid
= scm_make_fluid ();
2540 cur_errport_fluid
= scm_make_fluid ();
2541 cur_loadport_fluid
= scm_make_fluid ();
2543 scm_i_port_weak_hash
= scm_make_weak_key_hash_table (SCM_I_MAKINUM(31));
2545 #include "libguile/ports.x"
2547 /* Use Latin-1 as the default port encoding. */
2548 SCM_VARIABLE_SET (default_port_encoding_var
, scm_make_fluid ());
2549 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2550 scm_port_encoding_init
= 1;
2552 SCM_VARIABLE_SET (scm_conversion_strategy
, scm_make_fluid ());
2553 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
),
2554 scm_from_int ((int) SCM_FAILED_CONVERSION_QUESTION_MARK
));
2555 scm_conversion_strategy_init
= 1;