1 /* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004,
2 * 2006, 2007, 2008, 2009, 2010, 2011, 2012 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 bytes from PORT's putback and/or read buffers
293 into memory starting at DEST. Return the number of bytes moved.
294 PORT's line/column numbers are left unchanged. */
296 scm_take_from_input_buffers (SCM port
, char *dest
, size_t read_len
)
298 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
299 size_t bytes_read
= 0;
300 size_t from_buf
= min (pt
->read_end
- pt
->read_pos
, read_len
);
304 memcpy (dest
, pt
->read_pos
, from_buf
);
305 pt
->read_pos
+= from_buf
;
306 bytes_read
+= from_buf
;
307 read_len
-= from_buf
;
311 /* if putback was active, try the real input buffer too. */
312 if (pt
->read_buf
== pt
->putback_buf
)
314 from_buf
= min (pt
->saved_read_end
- pt
->saved_read_pos
, read_len
);
317 memcpy (dest
, pt
->saved_read_pos
, from_buf
);
318 pt
->saved_read_pos
+= from_buf
;
319 bytes_read
+= from_buf
;
326 /* Clear a port's read buffers, returning the contents. */
327 SCM_DEFINE (scm_drain_input
, "drain-input", 1, 0, 0,
329 "This procedure clears a port's input buffers, similar\n"
330 "to the way that force-output clears the output buffer. The\n"
331 "contents of the buffers are returned as a single string, e.g.,\n"
334 "(define p (open-input-file ...))\n"
335 "(drain-input p) => empty string, nothing buffered yet.\n"
336 "(unread-char (read-char p) p)\n"
337 "(drain-input p) => initial chars from p, up to the buffer size.\n"
339 "Draining the buffers may be useful for cleanly finishing\n"
340 "buffered I/O so that the file descriptor can be used directly\n"
341 "for further input.")
342 #define FUNC_NAME s_scm_drain_input
349 SCM_VALIDATE_OPINPORT (1, port
);
350 pt
= SCM_PTAB_ENTRY (port
);
352 count
= pt
->read_end
- pt
->read_pos
;
353 if (pt
->read_buf
== pt
->putback_buf
)
354 count
+= pt
->saved_read_end
- pt
->saved_read_pos
;
358 result
= scm_i_make_string (count
, &data
, 0);
359 scm_take_from_input_buffers (port
, data
, count
);
362 result
= scm_nullstr
;
369 /* Standard ports --- current input, output, error, and more(!). */
371 static SCM cur_inport_fluid
= SCM_BOOL_F
;
372 static SCM cur_outport_fluid
= SCM_BOOL_F
;
373 static SCM cur_errport_fluid
= SCM_BOOL_F
;
374 static SCM cur_loadport_fluid
= SCM_BOOL_F
;
376 SCM_DEFINE (scm_current_input_port
, "current-input-port", 0, 0, 0,
378 "Return the current input port. This is the default port used\n"
379 "by many input procedures. Initially, @code{current-input-port}\n"
380 "returns the @dfn{standard input} in Unix and C terminology.")
381 #define FUNC_NAME s_scm_current_input_port
383 if (scm_is_true (cur_inport_fluid
))
384 return scm_fluid_ref (cur_inport_fluid
);
390 SCM_DEFINE (scm_current_output_port
, "current-output-port", 0, 0, 0,
392 "Return the current output port. This is the default port used\n"
393 "by many output procedures. Initially,\n"
394 "@code{current-output-port} returns the @dfn{standard output} in\n"
395 "Unix and C terminology.")
396 #define FUNC_NAME s_scm_current_output_port
398 if (scm_is_true (cur_outport_fluid
))
399 return scm_fluid_ref (cur_outport_fluid
);
405 SCM_DEFINE (scm_current_error_port
, "current-error-port", 0, 0, 0,
407 "Return the port to which errors and warnings should be sent (the\n"
408 "@dfn{standard error} in Unix and C terminology).")
409 #define FUNC_NAME s_scm_current_error_port
411 if (scm_is_true (cur_errport_fluid
))
412 return scm_fluid_ref (cur_errport_fluid
);
419 scm_current_warning_port (void)
421 static SCM cwp_var
= SCM_BOOL_F
;
423 if (scm_is_false (cwp_var
))
424 cwp_var
= scm_c_private_lookup ("guile", "current-warning-port");
426 return scm_call_0 (scm_variable_ref (cwp_var
));
429 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
431 "Return the current-load-port.\n"
432 "The load port is used internally by @code{primitive-load}.")
433 #define FUNC_NAME s_scm_current_load_port
435 return scm_fluid_ref (cur_loadport_fluid
);
439 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
441 "@deffnx {Scheme Procedure} set-current-output-port port\n"
442 "@deffnx {Scheme Procedure} set-current-error-port port\n"
443 "Change the ports returned by @code{current-input-port},\n"
444 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
445 "so that they use the supplied @var{port} for input or output.")
446 #define FUNC_NAME s_scm_set_current_input_port
448 SCM oinp
= scm_fluid_ref (cur_inport_fluid
);
449 SCM_VALIDATE_OPINPORT (1, port
);
450 scm_fluid_set_x (cur_inport_fluid
, port
);
456 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
458 "Set the current default output port to @var{port}.")
459 #define FUNC_NAME s_scm_set_current_output_port
461 SCM ooutp
= scm_fluid_ref (cur_outport_fluid
);
462 port
= SCM_COERCE_OUTPORT (port
);
463 SCM_VALIDATE_OPOUTPORT (1, port
);
464 scm_fluid_set_x (cur_outport_fluid
, port
);
470 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
472 "Set the current default error port to @var{port}.")
473 #define FUNC_NAME s_scm_set_current_error_port
475 SCM oerrp
= scm_fluid_ref (cur_errport_fluid
);
476 port
= SCM_COERCE_OUTPORT (port
);
477 SCM_VALIDATE_OPOUTPORT (1, port
);
478 scm_fluid_set_x (cur_errport_fluid
, port
);
485 scm_set_current_warning_port (SCM port
)
487 static SCM cwp_var
= SCM_BOOL_F
;
489 if (scm_is_false (cwp_var
))
490 cwp_var
= scm_c_private_lookup ("guile", "current-warning-port");
492 return scm_call_1 (scm_variable_ref (cwp_var
), port
);
497 scm_dynwind_current_input_port (SCM port
)
498 #define FUNC_NAME NULL
500 SCM_VALIDATE_OPINPORT (1, port
);
501 scm_dynwind_fluid (cur_inport_fluid
, port
);
506 scm_dynwind_current_output_port (SCM port
)
507 #define FUNC_NAME NULL
509 port
= SCM_COERCE_OUTPORT (port
);
510 SCM_VALIDATE_OPOUTPORT (1, port
);
511 scm_dynwind_fluid (cur_outport_fluid
, port
);
516 scm_dynwind_current_error_port (SCM port
)
517 #define FUNC_NAME NULL
519 port
= SCM_COERCE_OUTPORT (port
);
520 SCM_VALIDATE_OPOUTPORT (1, port
);
521 scm_dynwind_fluid (cur_errport_fluid
, port
);
526 scm_i_dynwind_current_load_port (SCM port
)
528 scm_dynwind_fluid (cur_loadport_fluid
, port
);
532 /* The port table --- an array of pointers to ports. */
535 We need a global registry of ports to flush them all at exit, and to
536 get all the ports matching a file descriptor. The associated values
537 are alists, where additional information can be associated with ports.
539 SCM scm_i_port_weak_hash
;
541 scm_i_pthread_mutex_t scm_i_port_table_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
544 /* Port finalization. */
547 static void finalize_port (void *, void *);
549 /* Register a finalizer for PORT. */
550 static SCM_C_INLINE_KEYWORD
void
551 register_finalizer_for_port (SCM port
)
553 /* Register a finalizer for PORT so that its iconv CDs get freed and
554 optionally its type's `free' function gets called. */
555 scm_i_set_finalizer (SCM2PTR (port
), finalize_port
, NULL
);
558 /* Finalize the object (a port) pointed to by PTR. */
560 finalize_port (void *ptr
, void *data
)
563 SCM port
= PTR2SCM (ptr
);
565 if (!SCM_PORTP (port
))
568 if (SCM_OPENP (port
))
570 if (SCM_REVEALED (port
) > 0)
571 /* Keep "revealed" ports alive and re-register a finalizer. */
572 register_finalizer_for_port (port
);
577 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
578 if (port_type
>= scm_numptob
)
581 if (scm_ptobs
[port_type
].free
)
582 /* Yes, I really do mean `.free' rather than `.close'. `.close'
583 is for explicit `close-port' by user. */
584 scm_ptobs
[port_type
].free (port
);
586 entry
= SCM_PTAB_ENTRY (port
);
588 if (entry
->input_cd
!= (iconv_t
) -1)
589 iconv_close (entry
->input_cd
);
590 if (entry
->output_cd
!= (iconv_t
) -1)
591 iconv_close (entry
->output_cd
);
593 SCM_SETSTREAM (port
, 0);
594 SCM_CLR_PORT_OPEN_FLAG (port
);
596 scm_gc_ports_collected
++;
605 /* This function is not and should not be thread safe. */
607 scm_new_port_table_entry (scm_t_bits tag
)
608 #define FUNC_NAME "scm_new_port_table_entry"
611 We initialize the cell to empty, this is in case scm_gc_calloc
612 triggers GC ; we don't want the GC to scan a half-finished Z.
615 SCM z
= scm_cons (SCM_EOL
, SCM_EOL
);
616 scm_t_port
*entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
619 entry
->file_name
= SCM_BOOL_F
;
620 entry
->rw_active
= SCM_PORT_NEITHER
;
623 /* Initialize this port with the thread's current default
625 enc
= scm_i_default_port_encoding ();
626 entry
->encoding
= enc
? scm_gc_strdup (enc
, "port") : NULL
;
628 /* The conversion descriptors will be opened lazily. */
629 entry
->input_cd
= (iconv_t
) -1;
630 entry
->output_cd
= (iconv_t
) -1;
632 entry
->ilseq_handler
= scm_i_default_port_conversion_handler ();
634 SCM_SET_CELL_TYPE (z
, tag
);
635 SCM_SETPTAB_ENTRY (z
, entry
);
637 scm_hashq_set_x (scm_i_port_weak_hash
, z
, SCM_EOL
);
639 /* For each new port, register a finalizer so that it port type's free
640 function can be invoked eventually. */
641 register_finalizer_for_port (z
);
647 #if SCM_ENABLE_DEPRECATED==1
649 scm_add_to_port_table (SCM port
)
654 scm_c_issue_deprecation_warning ("scm_add_to_port_table is deprecated.");
656 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
657 z
= scm_new_port_table_entry (scm_tc7_port
);
658 pt
= SCM_PTAB_ENTRY(z
);
660 SCM_SETCAR (z
, SCM_EOL
);
661 SCM_SETCDR (z
, SCM_EOL
);
662 SCM_SETPTAB_ENTRY (port
, pt
);
663 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
670 /* Remove a port from the table and destroy it. */
673 scm_i_remove_port (SCM port
)
674 #define FUNC_NAME "scm_remove_port"
678 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
680 p
= SCM_PTAB_ENTRY (port
);
681 scm_port_non_buffer (p
);
682 p
->putback_buf
= NULL
;
683 p
->putback_buf_size
= 0;
685 if (p
->input_cd
!= (iconv_t
) -1)
687 iconv_close (p
->input_cd
);
688 p
->input_cd
= (iconv_t
) -1;
691 if (p
->output_cd
!= (iconv_t
) -1)
693 iconv_close (p
->output_cd
);
694 p
->output_cd
= (iconv_t
) -1;
697 SCM_SETPTAB_ENTRY (port
, 0);
699 scm_hashq_remove_x (scm_i_port_weak_hash
, port
);
701 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
706 /* Functions for debugging. */
708 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
710 "Return the number of ports in the port table. @code{pt-size}\n"
711 "is only included in @code{--enable-guile-debug} builds.")
712 #define FUNC_NAME s_scm_pt_size
714 return scm_from_int (SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
));
720 scm_port_non_buffer (scm_t_port
*pt
)
722 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
723 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
724 pt
->read_buf_size
= pt
->write_buf_size
= 1;
725 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
729 /* Revealed counts --- an oddity inherited from SCSH. */
731 /* Find a port in the table and return its revealed count.
732 Also used by the garbage collector.
736 scm_revealed_count (SCM port
)
738 return SCM_REVEALED(port
);
743 /* Return the revealed count for a port. */
745 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
747 "Return the revealed count for @var{port}.")
748 #define FUNC_NAME s_scm_port_revealed
750 port
= SCM_COERCE_OUTPORT (port
);
751 SCM_VALIDATE_OPENPORT (1, port
);
752 return scm_from_int (scm_revealed_count (port
));
756 /* Set the revealed count for a port. */
757 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
758 (SCM port
, SCM rcount
),
759 "Sets the revealed count for a port to a given value.\n"
760 "The return value is unspecified.")
761 #define FUNC_NAME s_scm_set_port_revealed_x
763 port
= SCM_COERCE_OUTPORT (port
);
764 SCM_VALIDATE_OPENPORT (1, port
);
765 SCM_REVEALED (port
) = scm_to_int (rcount
);
766 return SCM_UNSPECIFIED
;
772 /* Retrieving a port's mode. */
774 /* Return the flags that characterize a port based on the mode
775 * string used to open a file for that port.
777 * See PORT FLAGS in scm.h
781 scm_i_mode_bits_n (SCM modes
)
784 | (scm_i_string_contains_char (modes
, 'r')
785 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
786 | (scm_i_string_contains_char (modes
, 'w')
787 || scm_i_string_contains_char (modes
, 'a')
788 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
789 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
790 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
794 scm_mode_bits (char *modes
)
796 return scm_i_mode_bits (scm_from_locale_string (modes
));
800 scm_i_mode_bits (SCM modes
)
804 if (!scm_is_string (modes
))
805 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
807 bits
= scm_i_mode_bits_n (modes
);
808 scm_remember_upto_here_1 (modes
);
812 /* Return the mode flags from an open port.
813 * Some modes such as "append" are only used when opening
814 * a file and are not returned here. */
816 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
818 "Return the port modes associated with the open port @var{port}.\n"
819 "These will not necessarily be identical to the modes used when\n"
820 "the port was opened, since modes such as \"append\" which are\n"
821 "used only during port creation are not retained.")
822 #define FUNC_NAME s_scm_port_mode
827 port
= SCM_COERCE_OUTPORT (port
);
828 SCM_VALIDATE_OPPORT (1, port
);
829 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
830 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
831 strcpy (modes
, "r+");
835 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
837 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
839 return scm_from_locale_string (modes
);
848 * Call the close operation on a port object.
849 * see also scm_close.
851 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
853 "Close the specified port object. Return @code{#t} if it\n"
854 "successfully closes a port or @code{#f} if it was already\n"
855 "closed. An exception may be raised if an error occurs, for\n"
856 "example when flushing buffered output. See also @ref{Ports and\n"
857 "File Descriptors, close}, for a procedure which can close file\n"
859 #define FUNC_NAME s_scm_close_port
864 port
= SCM_COERCE_OUTPORT (port
);
866 SCM_VALIDATE_PORT (1, port
);
867 if (SCM_CLOSEDP (port
))
869 i
= SCM_PTOBNUM (port
);
870 if (scm_ptobs
[i
].close
)
871 rv
= (scm_ptobs
[i
].close
) (port
);
874 scm_i_remove_port (port
);
875 SCM_CLR_PORT_OPEN_FLAG (port
);
876 return scm_from_bool (rv
>= 0);
880 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
882 "Close the specified input port object. The routine has no effect if\n"
883 "the file has already been closed. An exception may be raised if an\n"
884 "error occurs. The value returned is unspecified.\n\n"
885 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
886 "which can close file descriptors.")
887 #define FUNC_NAME s_scm_close_input_port
889 SCM_VALIDATE_INPUT_PORT (1, port
);
890 scm_close_port (port
);
891 return SCM_UNSPECIFIED
;
895 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
897 "Close the specified output port object. The routine has no effect if\n"
898 "the file has already been closed. An exception may be raised if an\n"
899 "error occurs. The value returned is unspecified.\n\n"
900 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
901 "which can close file descriptors.")
902 #define FUNC_NAME s_scm_close_output_port
904 port
= SCM_COERCE_OUTPORT (port
);
905 SCM_VALIDATE_OUTPUT_PORT (1, port
);
906 scm_close_port (port
);
907 return SCM_UNSPECIFIED
;
912 collect_keys (void *unused
, SCM key
, SCM value
, SCM result
)
914 return scm_cons (key
, result
);
918 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
922 /* Copy out the port table as a list so that we get strong references
923 to all the values. */
924 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
925 ports
= scm_internal_hash_fold (collect_keys
, NULL
,
926 SCM_EOL
, scm_i_port_weak_hash
);
927 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
929 for (; scm_is_pair (ports
); ports
= scm_cdr (ports
))
931 SCM p
= scm_car (ports
);
937 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
939 "Apply @var{proc} to each port in the Guile port table\n"
940 "in turn. The return value is unspecified. More specifically,\n"
941 "@var{proc} is applied exactly once to every port that exists\n"
942 "in the system at the time @code{port-for-each} is invoked.\n"
943 "Changes to the port table while @code{port-for-each} is running\n"
944 "have no effect as far as @code{port-for-each} is concerned.")
945 #define FUNC_NAME s_scm_port_for_each
949 SCM_VALIDATE_PROC (1, proc
);
951 /* Copy out the port table as a list so that we get strong references
952 to all the values. */
953 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
954 ports
= scm_internal_hash_fold (collect_keys
, NULL
,
955 SCM_EOL
, scm_i_port_weak_hash
);
956 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
958 for (; scm_is_pair (ports
); ports
= scm_cdr (ports
))
959 if (SCM_PORTP (SCM_CAR (ports
)))
960 scm_call_1 (proc
, SCM_CAR (ports
));
962 return SCM_UNSPECIFIED
;
968 /* Utter miscellany. Gosh, we should clean this up some time. */
970 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
972 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
973 "@code{#f}. Any object satisfying this predicate also satisfies\n"
975 #define FUNC_NAME s_scm_input_port_p
977 return scm_from_bool (SCM_INPUT_PORT_P (x
));
981 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
983 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
984 "@code{#f}. Any object satisfying this predicate also satisfies\n"
986 #define FUNC_NAME s_scm_output_port_p
988 x
= SCM_COERCE_OUTPORT (x
);
989 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
993 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
995 "Return a boolean indicating whether @var{x} is a port.\n"
996 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
998 #define FUNC_NAME s_scm_port_p
1000 return scm_from_bool (SCM_PORTP (x
));
1004 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
1006 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
1008 #define FUNC_NAME s_scm_port_closed_p
1010 SCM_VALIDATE_PORT (1, port
);
1011 return scm_from_bool (!SCM_OPPORTP (port
));
1015 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
1017 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
1018 "return @code{#f}.")
1019 #define FUNC_NAME s_scm_eof_object_p
1021 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
1025 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
1027 "Flush the specified output port, or the current output port if @var{port}\n"
1028 "is omitted. The current output buffer contents are passed to the\n"
1029 "underlying port implementation (e.g., in the case of fports, the\n"
1030 "data will be written to the file and the output buffer will be cleared.)\n"
1031 "It has no effect on an unbuffered port.\n\n"
1032 "The return value is unspecified.")
1033 #define FUNC_NAME s_scm_force_output
1035 if (SCM_UNBNDP (port
))
1036 port
= scm_current_output_port ();
1039 port
= SCM_COERCE_OUTPORT (port
);
1040 SCM_VALIDATE_OPOUTPORT (1, port
);
1043 return SCM_UNSPECIFIED
;
1049 flush_output_port (void *closure
, SCM port
)
1051 if (SCM_OPOUTPORTP (port
))
1055 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
1057 "Equivalent to calling @code{force-output} on\n"
1058 "all open output ports. The return value is unspecified.")
1059 #define FUNC_NAME s_scm_flush_all_ports
1061 scm_c_port_for_each (&flush_output_port
, NULL
);
1062 return SCM_UNSPECIFIED
;
1066 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1068 "Return the next character available from @var{port}, updating\n"
1069 "@var{port} to point to the following character. If no more\n"
1070 "characters are available, the end-of-file object is returned.\n"
1072 "When @var{port}'s data cannot be decoded according to its\n"
1073 "character encoding, a @code{decoding-error} is raised and\n"
1074 "@var{port} points past the erroneous byte sequence.\n")
1075 #define FUNC_NAME s_scm_read_char
1078 if (SCM_UNBNDP (port
))
1079 port
= scm_current_input_port ();
1080 SCM_VALIDATE_OPINPORT (1, port
);
1081 c
= scm_getc (port
);
1084 return SCM_MAKE_CHAR (c
);
1088 /* Update the line and column number of PORT after consumption of C. */
1090 update_port_lf (scm_t_wchar c
, SCM port
)
1115 #define SCM_MBCHAR_BUF_SIZE (4)
1117 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1118 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1120 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1122 scm_t_wchar codepoint
;
1124 if (utf8_buf
[0] <= 0x7f)
1127 codepoint
= utf8_buf
[0];
1129 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1132 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1133 | (utf8_buf
[1] & 0x3f);
1135 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1138 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1139 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1140 | (utf8_buf
[2] & 0x3f);
1145 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1146 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1147 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1148 | (utf8_buf
[3] & 0x3f);
1154 /* Read a UTF-8 sequence from PORT. On success, return 0 and set
1155 *CODEPOINT to the codepoint that was read, fill BUF with its UTF-8
1156 representation, and set *LEN to the length in bytes. Return
1157 `EILSEQ' on error. */
1159 get_utf8_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1160 scm_t_uint8 buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1162 #define ASSERT_NOT_EOF(b) \
1163 if (SCM_UNLIKELY ((b) == EOF)) \
1165 #define CONSUME_PEEKED_BYTE() \
1172 pt
= SCM_PTAB_ENTRY (port
);
1174 byte
= scm_get_byte_or_eof (port
);
1181 buf
[0] = (scm_t_uint8
) byte
;
1186 *codepoint
= buf
[0];
1187 else if (buf
[0] >= 0xc2 && buf
[0] <= 0xdf)
1190 byte
= scm_peek_byte_or_eof (port
);
1191 ASSERT_NOT_EOF (byte
);
1193 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1196 CONSUME_PEEKED_BYTE ();
1197 buf
[1] = (scm_t_uint8
) byte
;
1200 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x1f) << 6UL
1203 else if ((buf
[0] & 0xf0) == 0xe0)
1206 byte
= scm_peek_byte_or_eof (port
);
1207 ASSERT_NOT_EOF (byte
);
1209 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80
1210 || (buf
[0] == 0xe0 && byte
< 0xa0)
1211 || (buf
[0] == 0xed && byte
> 0x9f)))
1214 CONSUME_PEEKED_BYTE ();
1215 buf
[1] = (scm_t_uint8
) byte
;
1218 byte
= scm_peek_byte_or_eof (port
);
1219 ASSERT_NOT_EOF (byte
);
1221 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1224 CONSUME_PEEKED_BYTE ();
1225 buf
[2] = (scm_t_uint8
) byte
;
1228 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x0f) << 12UL
1229 | ((scm_t_wchar
) buf
[1] & 0x3f) << 6UL
1232 else if (buf
[0] >= 0xf0 && buf
[0] <= 0xf4)
1235 byte
= scm_peek_byte_or_eof (port
);
1236 ASSERT_NOT_EOF (byte
);
1238 if (SCM_UNLIKELY (((byte
& 0xc0) != 0x80)
1239 || (buf
[0] == 0xf0 && byte
< 0x90)
1240 || (buf
[0] == 0xf4 && byte
> 0x8f)))
1243 CONSUME_PEEKED_BYTE ();
1244 buf
[1] = (scm_t_uint8
) byte
;
1247 byte
= scm_peek_byte_or_eof (port
);
1248 ASSERT_NOT_EOF (byte
);
1250 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1253 CONSUME_PEEKED_BYTE ();
1254 buf
[2] = (scm_t_uint8
) byte
;
1257 byte
= scm_peek_byte_or_eof (port
);
1258 ASSERT_NOT_EOF (byte
);
1260 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1263 CONSUME_PEEKED_BYTE ();
1264 buf
[3] = (scm_t_uint8
) byte
;
1267 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x07) << 18UL
1268 | ((scm_t_wchar
) buf
[1] & 0x3f) << 12UL
1269 | ((scm_t_wchar
) buf
[2] & 0x3f) << 6UL
1278 /* Here we could choose the consume the faulty byte when it's not a
1279 valid starting byte, but it's not a requirement. What Section 3.9
1280 of Unicode 6.0.0 mandates, though, is to not consume a byte that
1281 would otherwise be a valid starting byte. */
1285 #undef CONSUME_PEEKED_BYTE
1286 #undef ASSERT_NOT_EOF
1289 /* Likewise, read a byte sequence from PORT, passing it through its
1290 input conversion descriptor. */
1292 get_iconv_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1293 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1297 size_t bytes_consumed
, output_size
;
1299 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1301 pt
= SCM_PTAB_ENTRY (port
);
1303 for (output_size
= 0, output
= (char *) utf8_buf
,
1304 bytes_consumed
= 0, err
= 0;
1305 err
== 0 && output_size
== 0
1306 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1310 size_t input_left
, output_left
, done
;
1312 byte_read
= scm_get_byte_or_eof (port
);
1313 if (byte_read
== EOF
)
1315 if (bytes_consumed
== 0)
1317 *codepoint
= (scm_t_wchar
) EOF
;
1325 buf
[bytes_consumed
] = byte_read
;
1328 input_left
= bytes_consumed
+ 1;
1329 output_left
= sizeof (utf8_buf
);
1331 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1332 &output
, &output_left
);
1333 if (done
== (size_t) -1)
1337 /* Missing input: keep trying. */
1341 output_size
= sizeof (utf8_buf
) - output_left
;
1344 if (SCM_UNLIKELY (output_size
== 0))
1345 /* An unterminated sequence. */
1347 else if (SCM_LIKELY (err
== 0))
1349 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1350 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1351 *len
= bytes_consumed
;
1357 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1358 with the byte representation of the codepoint in PORT's encoding, and
1359 set *LEN to the length in bytes of that representation. Return 0 on
1360 success and an errno value on error. */
1362 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1363 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1366 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1368 if (pt
->input_cd
== (iconv_t
) -1)
1369 /* Initialize the conversion descriptors, if needed. */
1370 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1372 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
1373 if (pt
->input_cd
== (iconv_t
) -1)
1374 err
= get_utf8_codepoint (port
, codepoint
, (scm_t_uint8
*) buf
, len
);
1376 err
= get_iconv_codepoint (port
, codepoint
, buf
, len
);
1378 if (SCM_LIKELY (err
== 0))
1379 update_port_lf (*codepoint
, port
);
1380 else if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1384 update_port_lf (*codepoint
, port
);
1390 /* Read a codepoint from PORT and return it. */
1393 #define FUNC_NAME "scm_getc"
1397 scm_t_wchar codepoint
;
1398 char buf
[SCM_MBCHAR_BUF_SIZE
];
1400 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1401 if (SCM_UNLIKELY (err
!= 0))
1402 /* At this point PORT should point past the invalid encoding, as per
1403 R6RS-lib Section 8.2.4. */
1404 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1410 /* this should only be called when the read buffer is empty. it
1411 tries to refill the read buffer. it returns the first char from
1412 the port, which is either EOF or *(pt->read_pos). */
1414 scm_fill_input (SCM port
)
1416 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1418 assert (pt
->read_pos
== pt
->read_end
);
1420 if (pt
->read_buf
== pt
->putback_buf
)
1422 /* finished reading put-back chars. */
1423 pt
->read_buf
= pt
->saved_read_buf
;
1424 pt
->read_pos
= pt
->saved_read_pos
;
1425 pt
->read_end
= pt
->saved_read_end
;
1426 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1427 if (pt
->read_pos
< pt
->read_end
)
1428 return *(pt
->read_pos
);
1430 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1436 * This function differs from scm_c_write; it updates port line and
1440 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1442 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1443 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1445 if (pt
->rw_active
== SCM_PORT_READ
)
1446 scm_end_input (port
);
1448 ptob
->write (port
, ptr
, size
);
1450 for (; size
; ptr
++, size
--)
1451 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1454 pt
->rw_active
= SCM_PORT_WRITE
;
1457 /* Write STR to PORT from START inclusive to END exclusive. */
1459 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1461 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1463 if (pt
->rw_active
== SCM_PORT_READ
)
1464 scm_end_input (port
);
1466 if (end
== (size_t) -1)
1467 end
= scm_i_string_length (str
);
1469 scm_i_display_substring (str
, start
, end
, port
);
1472 pt
->rw_active
= SCM_PORT_WRITE
;
1477 * Used by an application to read arbitrary number of bytes from an
1478 * SCM port. Same semantics as libc read, except that scm_c_read only
1479 * returns less than SIZE bytes if at end-of-file.
1481 * Warning: Doesn't update port line and column counts! */
1483 /* This structure, and the following swap_buffer function, are used
1484 for temporarily swapping a port's own read buffer, and the buffer
1485 that the caller of scm_c_read provides. */
1486 struct port_and_swap_buffer
1489 unsigned char *buffer
;
1494 swap_buffer (void *data
)
1496 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1497 unsigned char *old_buf
= psb
->pt
->read_buf
;
1498 size_t old_size
= psb
->pt
->read_buf_size
;
1500 /* Make the port use (buffer, size) from the struct. */
1501 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1502 psb
->pt
->read_buf_size
= psb
->size
;
1504 /* Save the port's old (buffer, size) in the struct. */
1505 psb
->buffer
= old_buf
;
1506 psb
->size
= old_size
;
1510 scm_c_read (SCM port
, void *buffer
, size_t size
)
1511 #define FUNC_NAME "scm_c_read"
1514 size_t n_read
= 0, n_available
;
1515 struct port_and_swap_buffer psb
;
1517 SCM_VALIDATE_OPINPORT (1, port
);
1519 pt
= SCM_PTAB_ENTRY (port
);
1520 if (pt
->rw_active
== SCM_PORT_WRITE
)
1521 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1524 pt
->rw_active
= SCM_PORT_READ
;
1526 /* Take bytes first from the port's read buffer. */
1527 if (pt
->read_pos
< pt
->read_end
)
1529 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1530 memcpy (buffer
, pt
->read_pos
, n_available
);
1531 buffer
= (char *) buffer
+ n_available
;
1532 pt
->read_pos
+= n_available
;
1533 n_read
+= n_available
;
1534 size
-= n_available
;
1537 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1541 /* Now we will call scm_fill_input repeatedly until we have read the
1542 requested number of bytes. (Note that a single scm_fill_input
1543 call does not guarantee to fill the whole of the port's read
1545 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1547 /* The port that we are reading from is unbuffered - i.e. does
1548 not have its own persistent buffer - but we have a buffer,
1549 provided by our caller, that is the right size for the data
1550 that is wanted. For the following scm_fill_input calls,
1551 therefore, we use the buffer in hand as the port's read
1554 We need to make sure that the port's normal (1 byte) buffer
1555 is reinstated in case one of the scm_fill_input () calls
1556 throws an exception; we use the scm_dynwind_* API to achieve
1559 A consequence of this optimization is that the fill_input
1560 functions can't unget characters. That'll push data to the
1561 pushback buffer instead of this psb buffer. */
1563 unsigned char *pback
= pt
->putback_buf
;
1566 psb
.buffer
= buffer
;
1568 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1569 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1570 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1572 /* Call scm_fill_input until we have all the bytes that we need,
1574 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1576 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1577 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1580 if (pback
!= pt
->putback_buf
1581 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1582 scm_misc_error (FUNC_NAME
,
1583 "scm_c_read must not call a fill function that pushes "
1584 "back characters onto an unbuffered port", SCM_EOL
);
1586 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1588 /* Reinstate the port's normal buffer. */
1593 /* The port has its own buffer. It is important that we use it,
1594 even if it happens to be smaller than our caller's buffer, so
1595 that a custom port implementation's entry points (in
1596 particular, fill_input) can rely on the buffer always being
1597 the same as they first set up. */
1598 while (size
&& (scm_fill_input (port
) != EOF
))
1600 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1601 memcpy (buffer
, pt
->read_pos
, n_available
);
1602 buffer
= (char *) buffer
+ n_available
;
1603 pt
->read_pos
+= n_available
;
1604 n_read
+= n_available
;
1605 size
-= n_available
;
1615 * Used by an application to write arbitrary number of bytes to an SCM
1616 * port. Similar semantics as libc write. However, unlike libc
1617 * write, scm_c_write writes the requested number of bytes and has no
1620 * Warning: Doesn't update port line and column counts!
1624 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1625 #define FUNC_NAME "scm_c_write"
1628 scm_t_ptob_descriptor
*ptob
;
1630 SCM_VALIDATE_OPOUTPORT (1, port
);
1632 pt
= SCM_PTAB_ENTRY (port
);
1633 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1635 if (pt
->rw_active
== SCM_PORT_READ
)
1636 scm_end_input (port
);
1638 ptob
->write (port
, ptr
, size
);
1641 pt
->rw_active
= SCM_PORT_WRITE
;
1646 scm_flush (SCM port
)
1648 long i
= SCM_PTOBNUM (port
);
1650 (scm_ptobs
[i
].flush
) (port
);
1654 scm_end_input (SCM port
)
1657 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1659 if (pt
->read_buf
== pt
->putback_buf
)
1661 offset
= pt
->read_end
- pt
->read_pos
;
1662 pt
->read_buf
= pt
->saved_read_buf
;
1663 pt
->read_pos
= pt
->saved_read_pos
;
1664 pt
->read_end
= pt
->saved_read_end
;
1665 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1670 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1677 scm_unget_byte (int c
, SCM port
)
1678 #define FUNC_NAME "scm_unget_byte"
1680 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1682 if (pt
->read_buf
== pt
->putback_buf
)
1683 /* already using the put-back buffer. */
1685 /* enlarge putback_buf if necessary. */
1686 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1687 && pt
->read_buf
== pt
->read_pos
)
1689 size_t new_size
= pt
->read_buf_size
* 2;
1690 unsigned char *tmp
= (unsigned char *)
1691 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1694 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1695 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1696 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1699 /* shift any existing bytes to buffer + 1. */
1700 if (pt
->read_pos
== pt
->read_end
)
1701 pt
->read_end
= pt
->read_buf
+ 1;
1702 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1704 int count
= pt
->read_end
- pt
->read_pos
;
1706 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1707 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1710 pt
->read_pos
= pt
->read_buf
;
1713 /* switch to the put-back buffer. */
1715 if (pt
->putback_buf
== NULL
)
1718 = (unsigned char *) scm_gc_malloc_pointerless
1719 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1720 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1723 pt
->saved_read_buf
= pt
->read_buf
;
1724 pt
->saved_read_pos
= pt
->read_pos
;
1725 pt
->saved_read_end
= pt
->read_end
;
1726 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1728 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1729 pt
->read_end
= pt
->read_buf
+ 1;
1730 pt
->read_buf_size
= pt
->putback_buf_size
;
1736 pt
->rw_active
= SCM_PORT_READ
;
1741 scm_ungetc (scm_t_wchar c
, SCM port
)
1742 #define FUNC_NAME "scm_ungetc"
1744 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1746 char result_buf
[10];
1747 const char *encoding
;
1751 if (pt
->encoding
!= NULL
)
1752 encoding
= pt
->encoding
;
1754 encoding
= "ISO-8859-1";
1756 len
= sizeof (result_buf
);
1757 result
= u32_conv_to_encoding (encoding
,
1758 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1759 (uint32_t *) &c
, 1, NULL
,
1762 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1763 scm_encoding_error (FUNC_NAME
, errno
,
1764 "conversion to port encoding failed",
1765 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1767 for (i
= len
- 1; i
>= 0; i
--)
1768 scm_unget_byte (result
[i
], port
);
1770 if (SCM_UNLIKELY (result
!= result_buf
))
1775 /* What should col be in this case?
1776 * We'll leave it at -1.
1778 SCM_LINUM (port
) -= 1;
1787 scm_ungets (const char *s
, int n
, SCM port
)
1789 /* This is simple minded and inefficient, but unreading strings is
1790 * probably not a common operation, and remember that line and
1791 * column numbers have to be handled...
1793 * Please feel free to write an optimized version!
1796 scm_ungetc (s
[n
], port
);
1800 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1802 "Return the next character available from @var{port},\n"
1803 "@emph{without} updating @var{port} to point to the following\n"
1804 "character. If no more characters are available, the\n"
1805 "end-of-file object is returned.\n"
1807 "The value returned by\n"
1808 "a call to @code{peek-char} is the same as the value that would\n"
1809 "have been returned by a call to @code{read-char} on the same\n"
1810 "port. The only difference is that the very next call to\n"
1811 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1812 "return the value returned by the preceding call to\n"
1813 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1814 "an interactive port will hang waiting for input whenever a call\n"
1815 "to @code{read-char} would have hung.\n"
1817 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1818 "if such a situation occurs. However, unlike with @code{read-char},\n"
1819 "@var{port} still points at the beginning of the erroneous byte\n"
1820 "sequence when the error is raised.\n")
1821 #define FUNC_NAME s_scm_peek_char
1826 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1827 long column
, line
, i
;
1830 if (SCM_UNBNDP (port
))
1831 port
= scm_current_input_port ();
1832 SCM_VALIDATE_OPINPORT (1, port
);
1834 column
= SCM_COL (port
);
1835 line
= SCM_LINUM (port
);
1837 err
= get_codepoint (port
, &c
, bytes
, &len
);
1839 for (i
= len
- 1; i
>= 0; i
--)
1840 scm_unget_byte (bytes
[i
], port
);
1842 SCM_COL (port
) = column
;
1843 SCM_LINUM (port
) = line
;
1845 if (SCM_UNLIKELY (err
!= 0))
1847 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1849 /* Shouldn't happen since `catch' always aborts to prompt. */
1850 result
= SCM_BOOL_F
;
1853 result
= SCM_EOF_VAL
;
1855 result
= SCM_MAKE_CHAR (c
);
1861 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1862 (SCM cobj
, SCM port
),
1863 "Place character @var{cobj} in @var{port} so that it will be\n"
1864 "read by the next read operation. If called multiple times, the\n"
1865 "unread characters will be read again in last-in first-out\n"
1866 "order. If @var{port} is not supplied, the current input port\n"
1868 #define FUNC_NAME s_scm_unread_char
1872 SCM_VALIDATE_CHAR (1, cobj
);
1873 if (SCM_UNBNDP (port
))
1874 port
= scm_current_input_port ();
1875 SCM_VALIDATE_OPINPORT (2, port
);
1877 c
= SCM_CHAR (cobj
);
1879 scm_ungetc (c
, port
);
1884 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1885 (SCM str
, SCM port
),
1886 "Place the string @var{str} in @var{port} so that its characters will be\n"
1887 "read in subsequent read operations. If called multiple times, the\n"
1888 "unread characters will be read again in last-in first-out order. If\n"
1889 "@var{port} is not supplied, the current-input-port is used.")
1890 #define FUNC_NAME s_scm_unread_string
1893 SCM_VALIDATE_STRING (1, str
);
1894 if (SCM_UNBNDP (port
))
1895 port
= scm_current_input_port ();
1896 SCM_VALIDATE_OPINPORT (2, port
);
1898 n
= scm_i_string_length (str
);
1901 scm_ungetc (scm_i_string_ref (str
, n
), port
);
1907 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1908 (SCM fd_port
, SCM offset
, SCM whence
),
1909 "Sets the current position of @var{fd_port} to the integer\n"
1910 "@var{offset}, which is interpreted according to the value of\n"
1913 "One of the following variables should be supplied for\n"
1915 "@defvar SEEK_SET\n"
1916 "Seek from the beginning of the file.\n"
1918 "@defvar SEEK_CUR\n"
1919 "Seek from the current position.\n"
1921 "@defvar SEEK_END\n"
1922 "Seek from the end of the file.\n"
1924 "If @var{fd_port} is a file descriptor, the underlying system\n"
1925 "call is @code{lseek}. @var{port} may be a string port.\n"
1927 "The value returned is the new position in the file. This means\n"
1928 "that the current position of a port can be obtained using:\n"
1930 "(seek port 0 SEEK_CUR)\n"
1932 #define FUNC_NAME s_scm_seek
1936 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1938 how
= scm_to_int (whence
);
1939 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1940 SCM_OUT_OF_RANGE (3, whence
);
1942 if (SCM_OPPORTP (fd_port
))
1944 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1945 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1946 off_t_or_off64_t rv
;
1949 SCM_MISC_ERROR ("port is not seekable",
1950 scm_cons (fd_port
, SCM_EOL
));
1952 rv
= ptob
->seek (fd_port
, off
, how
);
1953 return scm_from_off_t_or_off64_t (rv
);
1955 else /* file descriptor?. */
1957 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1958 off_t_or_off64_t rv
;
1959 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1962 return scm_from_off_t_or_off64_t (rv
);
1971 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1972 doesn't have the filename version truncate(), hence this code. */
1973 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1975 truncate (const char *file
, off_t length
)
1979 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1983 ret
= ftruncate (fdes
, length
);
1986 int save_errno
= errno
;
1992 return close (fdes
);
1994 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1996 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1997 (SCM object
, SCM length
),
1998 "Truncate file @var{object} to @var{length} bytes. @var{object}\n"
1999 "can be a filename string, a port object, or an integer file\n"
2001 "The return value is unspecified.\n"
2003 "For a port or file descriptor @var{length} can be omitted, in\n"
2004 "which case the file is truncated at the current position (per\n"
2005 "@code{ftell} above).\n"
2007 "On most systems a file can be extended by giving a length\n"
2008 "greater than the current size, but this is not mandatory in the\n"
2010 #define FUNC_NAME s_scm_truncate_file
2014 /* "object" can be a port, fdes or filename.
2016 Negative "length" makes no sense, but it's left to truncate() or
2017 ftruncate() to give back an error for that (normally EINVAL).
2020 if (SCM_UNBNDP (length
))
2022 /* must supply length if object is a filename. */
2023 if (scm_is_string (object
))
2024 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
2026 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
2029 object
= SCM_COERCE_OUTPORT (object
);
2030 if (scm_is_integer (object
))
2032 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2033 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
2036 else if (SCM_OPOUTPORTP (object
))
2038 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2039 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
2040 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
2042 if (!ptob
->truncate
)
2043 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
2044 if (pt
->rw_active
== SCM_PORT_READ
)
2045 scm_end_input (object
);
2046 else if (pt
->rw_active
== SCM_PORT_WRITE
)
2047 ptob
->flush (object
);
2049 ptob
->truncate (object
, c_length
);
2054 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2055 char *str
= scm_to_locale_string (object
);
2057 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
2064 return SCM_UNSPECIFIED
;
2068 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
2070 "Return the current line number for @var{port}.\n"
2072 "The first line of a file is 0. But you might want to add 1\n"
2073 "when printing line numbers, since starting from 1 is\n"
2074 "traditional in error messages, and likely to be more natural to\n"
2076 #define FUNC_NAME s_scm_port_line
2078 port
= SCM_COERCE_OUTPORT (port
);
2079 SCM_VALIDATE_OPENPORT (1, port
);
2080 return scm_from_long (SCM_LINUM (port
));
2084 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
2085 (SCM port
, SCM line
),
2086 "Set the current line number for @var{port} to @var{line}. The\n"
2087 "first line of a file is 0.")
2088 #define FUNC_NAME s_scm_set_port_line_x
2090 port
= SCM_COERCE_OUTPORT (port
);
2091 SCM_VALIDATE_OPENPORT (1, port
);
2092 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
2093 return SCM_UNSPECIFIED
;
2097 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
2099 "Return the current column number of @var{port}.\n"
2100 "If the number is\n"
2101 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
2102 "- i.e. the first character of the first line is line 0, column 0.\n"
2103 "(However, when you display a file position, for example in an error\n"
2104 "message, we recommend you add 1 to get 1-origin integers. This is\n"
2105 "because lines and column numbers traditionally start with 1, and that is\n"
2106 "what non-programmers will find most natural.)")
2107 #define FUNC_NAME s_scm_port_column
2109 port
= SCM_COERCE_OUTPORT (port
);
2110 SCM_VALIDATE_OPENPORT (1, port
);
2111 return scm_from_int (SCM_COL (port
));
2115 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
2116 (SCM port
, SCM column
),
2117 "Set the current column of @var{port}. Before reading the first\n"
2118 "character on a line the column should be 0.")
2119 #define FUNC_NAME s_scm_set_port_column_x
2121 port
= SCM_COERCE_OUTPORT (port
);
2122 SCM_VALIDATE_OPENPORT (1, port
);
2123 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
2124 return SCM_UNSPECIFIED
;
2128 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
2130 "Return the filename associated with @var{port}, or @code{#f}\n"
2131 "if no filename is associated with the port.")
2132 #define FUNC_NAME s_scm_port_filename
2134 port
= SCM_COERCE_OUTPORT (port
);
2135 SCM_VALIDATE_OPENPORT (1, port
);
2136 return SCM_FILENAME (port
);
2140 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
2141 (SCM port
, SCM filename
),
2142 "Change the filename associated with @var{port}, using the current input\n"
2143 "port if none is specified. Note that this does not change the port's\n"
2144 "source of data, but only the value that is returned by\n"
2145 "@code{port-filename} and reported in diagnostic output.")
2146 #define FUNC_NAME s_scm_set_port_filename_x
2148 port
= SCM_COERCE_OUTPORT (port
);
2149 SCM_VALIDATE_OPENPORT (1, port
);
2150 /* We allow the user to set the filename to whatever he likes. */
2151 SCM_SET_FILENAME (port
, filename
);
2152 return SCM_UNSPECIFIED
;
2156 /* A fluid specifying the default encoding for newly created ports. If it is
2157 a string, that is the encoding. If it is #f, it is in the "native"
2158 (Latin-1) encoding. */
2159 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
2161 static int scm_port_encoding_init
= 0;
2163 /* Use ENCODING as the default encoding for future ports. */
2165 scm_i_set_default_port_encoding (const char *encoding
)
2167 if (!scm_port_encoding_init
2168 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2169 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
2172 if (encoding
== NULL
2173 || !strcmp (encoding
, "ASCII")
2174 || !strcmp (encoding
, "ANSI_X3.4-1968")
2175 || !strcmp (encoding
, "ISO-8859-1"))
2176 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2178 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
2179 scm_from_locale_string (encoding
));
2182 /* Return the name of the default encoding for newly created ports; a
2183 return value of NULL means "ISO-8859-1". */
2185 scm_i_default_port_encoding (void)
2187 if (!scm_port_encoding_init
)
2189 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2195 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
2196 if (!scm_is_string (encoding
))
2199 return scm_i_string_chars (encoding
);
2204 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2207 iconv_t new_input_cd
, new_output_cd
;
2209 new_input_cd
= (iconv_t
) -1;
2210 new_output_cd
= (iconv_t
) -1;
2212 /* Set the character encoding for this port. */
2213 pt
= SCM_PTAB_ENTRY (port
);
2215 if (encoding
== NULL
)
2216 encoding
= "ISO-8859-1";
2218 if (pt
->encoding
!= encoding
)
2219 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2221 /* If ENCODING is UTF-8, then no conversion descriptor is opened
2222 because we do I/O ourselves. This saves 100+ KiB for each
2224 if (strcmp (encoding
, "UTF-8"))
2226 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2228 /* Open an input iconv conversion descriptor, from ENCODING
2229 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2230 implementations can typically convert from anything to
2231 UTF-8, but not to UTF-32 (see
2232 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2233 new_input_cd
= iconv_open ("UTF-8", encoding
);
2234 if (new_input_cd
== (iconv_t
) -1)
2235 goto invalid_encoding
;
2238 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2240 new_output_cd
= iconv_open (encoding
, "UTF-8");
2241 if (new_output_cd
== (iconv_t
) -1)
2243 if (new_input_cd
!= (iconv_t
) -1)
2244 iconv_close (new_input_cd
);
2245 goto invalid_encoding
;
2250 if (pt
->input_cd
!= (iconv_t
) -1)
2251 iconv_close (pt
->input_cd
);
2252 if (pt
->output_cd
!= (iconv_t
) -1)
2253 iconv_close (pt
->output_cd
);
2255 pt
->input_cd
= new_input_cd
;
2256 pt
->output_cd
= new_output_cd
;
2263 err
= scm_from_locale_string (encoding
);
2264 scm_misc_error ("scm_i_set_port_encoding_x",
2265 "invalid or unknown character encoding ~s",
2270 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2272 "Returns, as a string, the character encoding that @var{port}\n"
2273 "uses to interpret its input and output.\n")
2274 #define FUNC_NAME s_scm_port_encoding
2279 SCM_VALIDATE_PORT (1, port
);
2281 pt
= SCM_PTAB_ENTRY (port
);
2284 return scm_from_locale_string (pt
->encoding
);
2290 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2291 (SCM port
, SCM enc
),
2292 "Sets the character encoding that will be used to interpret all\n"
2293 "port I/O. New ports are created with the encoding\n"
2294 "appropriate for the current locale if @code{setlocale} has \n"
2295 "been called or ISO-8859-1 otherwise\n"
2296 "and this procedure can be used to modify that encoding.\n")
2297 #define FUNC_NAME s_scm_set_port_encoding_x
2301 SCM_VALIDATE_PORT (1, port
);
2302 SCM_VALIDATE_STRING (2, enc
);
2304 enc_str
= scm_to_locale_string (enc
);
2305 scm_i_set_port_encoding_x (port
, enc_str
);
2308 return SCM_UNSPECIFIED
;
2313 /* A fluid specifying the default conversion handler for newly created
2314 ports. Its value should be one of the symbols below. */
2315 SCM_VARIABLE (default_conversion_strategy_var
,
2316 "%default-port-conversion-strategy");
2318 /* Whether the above fluid is initialized. */
2319 static int scm_conversion_strategy_init
= 0;
2321 /* The possible conversion strategies. */
2322 SCM_SYMBOL (sym_error
, "error");
2323 SCM_SYMBOL (sym_substitute
, "substitute");
2324 SCM_SYMBOL (sym_escape
, "escape");
2326 /* Return the default failed encoding conversion policy for new created
2328 scm_t_string_failed_conversion_handler
2329 scm_i_default_port_conversion_handler (void)
2331 scm_t_string_failed_conversion_handler handler
;
2333 if (!scm_conversion_strategy_init
2334 || !scm_is_fluid (SCM_VARIABLE_REF (default_conversion_strategy_var
)))
2335 handler
= SCM_FAILED_CONVERSION_QUESTION_MARK
;
2340 fluid
= SCM_VARIABLE_REF (default_conversion_strategy_var
);
2341 value
= scm_fluid_ref (fluid
);
2343 if (scm_is_eq (sym_substitute
, value
))
2344 handler
= SCM_FAILED_CONVERSION_QUESTION_MARK
;
2345 else if (scm_is_eq (sym_escape
, value
))
2346 handler
= SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
;
2348 /* Default to 'error also when the fluid's value is not one of
2349 the valid symbols. */
2350 handler
= SCM_FAILED_CONVERSION_ERROR
;
2356 /* Use HANDLER as the default conversion strategy for future ports. */
2358 scm_i_set_default_port_conversion_handler (scm_t_string_failed_conversion_handler
2363 if (!scm_conversion_strategy_init
2364 || !scm_is_fluid (SCM_VARIABLE_REF (default_conversion_strategy_var
)))
2365 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2370 case SCM_FAILED_CONVERSION_ERROR
:
2371 strategy
= sym_error
;
2374 case SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
:
2375 strategy
= sym_escape
;
2378 case SCM_FAILED_CONVERSION_QUESTION_MARK
:
2379 strategy
= sym_substitute
;
2386 scm_fluid_set_x (SCM_VARIABLE_REF (default_conversion_strategy_var
),
2390 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2391 1, 0, 0, (SCM port
),
2392 "Returns the behavior of the port when handling a character that\n"
2393 "is not representable in the port's current encoding.\n"
2394 "It returns the symbol @code{error} if unrepresentable characters\n"
2395 "should cause exceptions, @code{substitute} if the port should\n"
2396 "try to replace unrepresentable characters with question marks or\n"
2397 "approximate characters, or @code{escape} if unrepresentable\n"
2398 "characters should be converted to string escapes.\n"
2400 "If @var{port} is @code{#f}, then the current default behavior\n"
2401 "will be returned. New ports will have this default behavior\n"
2402 "when they are created.\n")
2403 #define FUNC_NAME s_scm_port_conversion_strategy
2405 scm_t_string_failed_conversion_handler h
;
2407 if (scm_is_false (port
))
2408 h
= scm_i_default_port_conversion_handler ();
2413 SCM_VALIDATE_OPPORT (1, port
);
2414 pt
= SCM_PTAB_ENTRY (port
);
2416 h
= pt
->ilseq_handler
;
2419 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2420 return scm_from_latin1_symbol ("error");
2421 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2422 return scm_from_latin1_symbol ("substitute");
2423 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2424 return scm_from_latin1_symbol ("escape");
2428 /* Never gets here. */
2429 return SCM_UNDEFINED
;
2433 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2435 (SCM port
, SCM sym
),
2436 "Sets the behavior of the interpreter when outputting a character\n"
2437 "that is not representable in the port's current encoding.\n"
2438 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2439 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2440 "when an unconvertible character is encountered. If it is\n"
2441 "@code{'substitute}, then unconvertible characters will \n"
2442 "be replaced with approximate characters, or with question marks\n"
2443 "if no approximately correct character is available.\n"
2444 "If it is @code{'escape},\n"
2445 "it will appear as a hex escape when output.\n"
2447 "If @var{port} is an open port, the conversion error behavior\n"
2448 "is set for that port. If it is @code{#f}, it is set as the\n"
2449 "default behavior for any future ports that get created in\n"
2451 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2453 scm_t_string_failed_conversion_handler handler
;
2455 if (scm_is_eq (sym
, sym_error
))
2456 handler
= SCM_FAILED_CONVERSION_ERROR
;
2457 else if (scm_is_eq (sym
, sym_substitute
))
2458 handler
= SCM_FAILED_CONVERSION_QUESTION_MARK
;
2459 else if (scm_is_eq (sym
, sym_escape
))
2460 handler
= SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
;
2462 SCM_MISC_ERROR ("unknown conversion strategy ~s", scm_list_1 (sym
));
2464 if (scm_is_false (port
))
2465 scm_i_set_default_port_conversion_handler (handler
);
2468 SCM_VALIDATE_OPPORT (1, port
);
2469 SCM_PTAB_ENTRY (port
)->ilseq_handler
= handler
;
2472 return SCM_UNSPECIFIED
;
2479 scm_print_port_mode (SCM exp
, SCM port
)
2481 scm_puts (SCM_CLOSEDP (exp
)
2483 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2484 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2487 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2494 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2496 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2499 scm_puts ("#<", port
);
2500 scm_print_port_mode (exp
, port
);
2501 scm_puts (type
, port
);
2502 scm_putc (' ', port
);
2503 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2504 scm_putc ('>', port
);
2512 scm_t_bits scm_tc16_void_port
= 0;
2514 static int fill_input_void_port (SCM port SCM_UNUSED
)
2520 write_void_port (SCM port SCM_UNUSED
,
2521 const void *data SCM_UNUSED
,
2522 size_t size SCM_UNUSED
)
2527 scm_i_void_port (long mode_bits
)
2529 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
2531 SCM answer
= scm_new_port_table_entry (scm_tc16_void_port
);
2532 scm_t_port
* pt
= SCM_PTAB_ENTRY(answer
);
2534 scm_port_non_buffer (pt
);
2536 SCM_SETSTREAM (answer
, 0);
2537 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
2538 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
2544 scm_void_port (char *mode_str
)
2546 return scm_i_void_port (scm_mode_bits (mode_str
));
2549 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2551 "Create and return a new void port. A void port acts like\n"
2552 "@file{/dev/null}. The @var{mode} argument\n"
2553 "specifies the input/output modes for this port: see the\n"
2554 "documentation for @code{open-file} in @ref{File Ports}.")
2555 #define FUNC_NAME s_scm_sys_make_void_port
2557 return scm_i_void_port (scm_i_mode_bits (mode
));
2562 /* Initialization. */
2567 /* lseek() symbols. */
2568 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2569 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2570 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2572 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2575 cur_inport_fluid
= scm_make_fluid ();
2576 cur_outport_fluid
= scm_make_fluid ();
2577 cur_errport_fluid
= scm_make_fluid ();
2578 cur_loadport_fluid
= scm_make_fluid ();
2580 scm_i_port_weak_hash
= scm_make_weak_key_hash_table (SCM_I_MAKINUM(31));
2582 #include "libguile/ports.x"
2584 /* Use Latin-1 as the default port encoding. */
2585 SCM_VARIABLE_SET (default_port_encoding_var
,
2586 scm_make_fluid_with_default (SCM_BOOL_F
));
2587 scm_port_encoding_init
= 1;
2589 SCM_VARIABLE_SET (default_conversion_strategy_var
,
2590 scm_make_fluid_with_default (sym_substitute
));
2591 scm_conversion_strategy_init
= 1;
2593 /* These bindings are used when boot-9 turns `current-input-port' et
2594 al into parameters. They are then removed from the guile module. */
2595 scm_c_define ("%current-input-port-fluid", cur_inport_fluid
);
2596 scm_c_define ("%current-output-port-fluid", cur_outport_fluid
);
2597 scm_c_define ("%current-error-port-fluid", cur_errport_fluid
);