1 /* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004,
2 * 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public License
6 * as published by the Free Software Foundation; either version 3 of
7 * the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 #define _LARGEFILE64_SOURCE /* ask for stat64 etc */
32 #include <fcntl.h> /* for chsize on mingw */
37 #include <striconveh.h>
41 #include "libguile/_scm.h"
42 #include "libguile/async.h"
43 #include "libguile/deprecation.h"
44 #include "libguile/eval.h"
45 #include "libguile/fports.h" /* direct access for seek and truncate */
46 #include "libguile/goops.h"
47 #include "libguile/smob.h"
48 #include "libguile/chars.h"
49 #include "libguile/dynwind.h"
51 #include "libguile/keywords.h"
52 #include "libguile/hashtab.h"
53 #include "libguile/root.h"
54 #include "libguile/strings.h"
55 #include "libguile/mallocs.h"
56 #include "libguile/validate.h"
57 #include "libguile/ports.h"
58 #include "libguile/vectors.h"
59 #include "libguile/weaks.h"
60 #include "libguile/fluids.h"
61 #include "libguile/eq.h"
75 #ifdef HAVE_SYS_IOCTL_H
76 #include <sys/ioctl.h>
79 /* Mingw (version 3.4.5, circa 2006) has ftruncate as an alias for chsize
80 already, but have this code here in case that wasn't so in past versions,
81 or perhaps to help other minimal DOS environments.
83 gnulib ftruncate.c has code using fcntl F_CHSIZE and F_FREESP, which
84 might be possibilities if we've got other systems without ftruncate. */
86 #if defined HAVE_CHSIZE && ! defined HAVE_FTRUNCATE
87 #define ftruncate(fd, size) chsize (fd, size)
89 #define HAVE_FTRUNCATE 1
93 /* The port kind table --- a dynamically resized array of port types. */
96 /* scm_ptobs scm_numptob
97 * implement a dynamically resized array of ptob records.
98 * Indexes into this table are used when generating type
99 * tags for smobjects (if you know a tag you can get an index and conversely).
101 scm_t_ptob_descriptor
*scm_ptobs
= NULL
;
102 long scm_numptob
= 0;
104 /* GC marker for a port with stream of SCM type. */
106 scm_markstream (SCM ptr
)
109 openp
= SCM_CELL_WORD_0 (ptr
) & SCM_OPN
;
111 return SCM_PACK (SCM_STREAM (ptr
));
117 * We choose to use an interface similar to the smob interface with
118 * fill_input and write as standard fields, passed to the port
119 * type constructor, and optional fields set by setters.
123 flush_port_default (SCM port SCM_UNUSED
)
128 end_input_default (SCM port SCM_UNUSED
, int offset SCM_UNUSED
)
133 scm_make_port_type (char *name
,
134 int (*fill_input
) (SCM port
),
135 void (*write
) (SCM port
, const void *data
, size_t size
))
138 if (SCM_I_MAX_PORT_TYPE_COUNT
- 1 <= scm_numptob
)
140 SCM_CRITICAL_SECTION_START
;
141 tmp
= (char *) scm_gc_realloc ((char *) scm_ptobs
,
142 scm_numptob
* sizeof (scm_t_ptob_descriptor
),
144 * sizeof (scm_t_ptob_descriptor
),
148 scm_ptobs
= (scm_t_ptob_descriptor
*) tmp
;
150 scm_ptobs
[scm_numptob
].name
= name
;
151 scm_ptobs
[scm_numptob
].mark
= 0;
152 scm_ptobs
[scm_numptob
].free
= NULL
;
153 scm_ptobs
[scm_numptob
].print
= scm_port_print
;
154 scm_ptobs
[scm_numptob
].equalp
= 0;
155 scm_ptobs
[scm_numptob
].close
= 0;
157 scm_ptobs
[scm_numptob
].write
= write
;
158 scm_ptobs
[scm_numptob
].flush
= flush_port_default
;
160 scm_ptobs
[scm_numptob
].end_input
= end_input_default
;
161 scm_ptobs
[scm_numptob
].fill_input
= fill_input
;
162 scm_ptobs
[scm_numptob
].input_waiting
= 0;
164 scm_ptobs
[scm_numptob
].seek
= 0;
165 scm_ptobs
[scm_numptob
].truncate
= 0;
169 SCM_CRITICAL_SECTION_END
;
173 scm_memory_error ("scm_make_port_type");
175 /* Make a class object if Goops is present */
176 if (SCM_UNPACK (scm_port_class
[0]) != 0)
177 scm_make_port_classes (scm_numptob
- 1, SCM_PTOBNAME (scm_numptob
- 1));
178 return scm_tc7_port
+ (scm_numptob
- 1) * 256;
182 scm_set_port_mark (scm_t_bits tc
, SCM (*mark
) (SCM
))
184 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].mark
= mark
;
188 scm_set_port_free (scm_t_bits tc
, size_t (*free
) (SCM
))
190 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].free
= free
;
194 scm_set_port_print (scm_t_bits tc
, int (*print
) (SCM exp
, SCM port
,
195 scm_print_state
*pstate
))
197 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].print
= print
;
201 scm_set_port_equalp (scm_t_bits tc
, SCM (*equalp
) (SCM
, SCM
))
203 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].equalp
= equalp
;
207 scm_set_port_flush (scm_t_bits tc
, void (*flush
) (SCM port
))
209 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].flush
= flush
;
213 scm_set_port_end_input (scm_t_bits tc
, void (*end_input
) (SCM port
, int offset
))
215 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].end_input
= end_input
;
219 scm_set_port_close (scm_t_bits tc
, int (*close
) (SCM
))
221 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].close
= close
;
225 scm_set_port_seek (scm_t_bits tc
,
226 scm_t_off (*seek
) (SCM
, scm_t_off
, int))
228 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].seek
= seek
;
232 scm_set_port_truncate (scm_t_bits tc
, void (*truncate
) (SCM
, scm_t_off
))
234 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].truncate
= truncate
;
238 scm_set_port_input_waiting (scm_t_bits tc
, int (*input_waiting
) (SCM
))
240 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].input_waiting
= input_waiting
;
245 SCM_DEFINE (scm_char_ready_p
, "char-ready?", 0, 1, 0,
247 "Return @code{#t} if a character is ready on input @var{port}\n"
248 "and return @code{#f} otherwise. If @code{char-ready?} returns\n"
249 "@code{#t} then the next @code{read-char} operation on\n"
250 "@var{port} is guaranteed not to hang. If @var{port} is a file\n"
251 "port at end of file then @code{char-ready?} returns @code{#t}.\n"
253 "@code{char-ready?} exists to make it possible for a\n"
254 "program to accept characters from interactive ports without\n"
255 "getting stuck waiting for input. Any input editors associated\n"
256 "with such ports must make sure that characters whose existence\n"
257 "has been asserted by @code{char-ready?} cannot be rubbed out.\n"
258 "If @code{char-ready?} were to return @code{#f} at end of file,\n"
259 "a port at end of file would be indistinguishable from an\n"
260 "interactive port that has no ready characters.")
261 #define FUNC_NAME s_scm_char_ready_p
265 if (SCM_UNBNDP (port
))
266 port
= scm_current_input_port ();
267 /* It's possible to close the current input port, so validate even in
269 SCM_VALIDATE_OPINPORT (1, port
);
271 pt
= SCM_PTAB_ENTRY (port
);
273 /* if the current read buffer is filled, or the
274 last pushed-back char has been read and the saved buffer is
275 filled, result is true. */
276 if (pt
->read_pos
< pt
->read_end
277 || (pt
->read_buf
== pt
->putback_buf
278 && pt
->saved_read_pos
< pt
->saved_read_end
))
282 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
284 if (ptob
->input_waiting
)
285 return scm_from_bool(ptob
->input_waiting (port
));
292 /* move up to read_len chars from port's putback and/or read buffers
293 into memory starting at dest. returns the number of chars moved. */
294 size_t scm_take_from_input_buffers (SCM port
, char *dest
, size_t read_len
)
296 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
297 size_t chars_read
= 0;
298 size_t from_buf
= min (pt
->read_end
- pt
->read_pos
, read_len
);
302 memcpy (dest
, pt
->read_pos
, from_buf
);
303 pt
->read_pos
+= from_buf
;
304 chars_read
+= from_buf
;
305 read_len
-= from_buf
;
309 /* if putback was active, try the real input buffer too. */
310 if (pt
->read_buf
== pt
->putback_buf
)
312 from_buf
= min (pt
->saved_read_end
- pt
->saved_read_pos
, read_len
);
315 memcpy (dest
, pt
->saved_read_pos
, from_buf
);
316 pt
->saved_read_pos
+= from_buf
;
317 chars_read
+= from_buf
;
323 /* Clear a port's read buffers, returning the contents. */
324 SCM_DEFINE (scm_drain_input
, "drain-input", 1, 0, 0,
326 "This procedure clears a port's input buffers, similar\n"
327 "to the way that force-output clears the output buffer. The\n"
328 "contents of the buffers are returned as a single string, e.g.,\n"
331 "(define p (open-input-file ...))\n"
332 "(drain-input p) => empty string, nothing buffered yet.\n"
333 "(unread-char (read-char p) p)\n"
334 "(drain-input p) => initial chars from p, up to the buffer size.\n"
336 "Draining the buffers may be useful for cleanly finishing\n"
337 "buffered I/O so that the file descriptor can be used directly\n"
338 "for further input.")
339 #define FUNC_NAME s_scm_drain_input
346 SCM_VALIDATE_OPINPORT (1, port
);
347 pt
= SCM_PTAB_ENTRY (port
);
349 count
= pt
->read_end
- pt
->read_pos
;
350 if (pt
->read_buf
== pt
->putback_buf
)
351 count
+= pt
->saved_read_end
- pt
->saved_read_pos
;
355 result
= scm_i_make_string (count
, &data
, 0);
356 scm_take_from_input_buffers (port
, data
, count
);
359 result
= scm_nullstr
;
366 /* Standard ports --- current input, output, error, and more(!). */
368 static SCM cur_inport_fluid
= SCM_BOOL_F
;
369 static SCM cur_outport_fluid
= SCM_BOOL_F
;
370 static SCM cur_errport_fluid
= SCM_BOOL_F
;
371 static SCM cur_loadport_fluid
= SCM_BOOL_F
;
373 SCM_DEFINE (scm_current_input_port
, "current-input-port", 0, 0, 0,
375 "Return the current input port. This is the default port used\n"
376 "by many input procedures. Initially, @code{current-input-port}\n"
377 "returns the @dfn{standard input} in Unix and C terminology.")
378 #define FUNC_NAME s_scm_current_input_port
380 if (scm_is_true (cur_inport_fluid
))
381 return scm_fluid_ref (cur_inport_fluid
);
387 SCM_DEFINE (scm_current_output_port
, "current-output-port", 0, 0, 0,
389 "Return the current output port. This is the default port used\n"
390 "by many output procedures. Initially,\n"
391 "@code{current-output-port} returns the @dfn{standard output} in\n"
392 "Unix and C terminology.")
393 #define FUNC_NAME s_scm_current_output_port
395 if (scm_is_true (cur_outport_fluid
))
396 return scm_fluid_ref (cur_outport_fluid
);
402 SCM_DEFINE (scm_current_error_port
, "current-error-port", 0, 0, 0,
404 "Return the port to which errors and warnings should be sent (the\n"
405 "@dfn{standard error} in Unix and C terminology).")
406 #define FUNC_NAME s_scm_current_error_port
408 if (scm_is_true (cur_errport_fluid
))
409 return scm_fluid_ref (cur_errport_fluid
);
416 scm_current_warning_port (void)
418 static SCM cwp_var
= SCM_BOOL_F
;
420 if (scm_is_false (cwp_var
))
421 cwp_var
= scm_c_private_lookup ("guile", "current-warning-port");
423 return scm_call_0 (scm_variable_ref (cwp_var
));
426 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
428 "Return the current-load-port.\n"
429 "The load port is used internally by @code{primitive-load}.")
430 #define FUNC_NAME s_scm_current_load_port
432 return scm_fluid_ref (cur_loadport_fluid
);
436 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
438 "@deffnx {Scheme Procedure} set-current-output-port port\n"
439 "@deffnx {Scheme Procedure} set-current-error-port port\n"
440 "Change the ports returned by @code{current-input-port},\n"
441 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
442 "so that they use the supplied @var{port} for input or output.")
443 #define FUNC_NAME s_scm_set_current_input_port
445 SCM oinp
= scm_fluid_ref (cur_inport_fluid
);
446 SCM_VALIDATE_OPINPORT (1, port
);
447 scm_fluid_set_x (cur_inport_fluid
, port
);
453 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
455 "Set the current default output port to @var{port}.")
456 #define FUNC_NAME s_scm_set_current_output_port
458 SCM ooutp
= scm_fluid_ref (cur_outport_fluid
);
459 port
= SCM_COERCE_OUTPORT (port
);
460 SCM_VALIDATE_OPOUTPORT (1, port
);
461 scm_fluid_set_x (cur_outport_fluid
, port
);
467 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
469 "Set the current default error port to @var{port}.")
470 #define FUNC_NAME s_scm_set_current_error_port
472 SCM oerrp
= scm_fluid_ref (cur_errport_fluid
);
473 port
= SCM_COERCE_OUTPORT (port
);
474 SCM_VALIDATE_OPOUTPORT (1, port
);
475 scm_fluid_set_x (cur_errport_fluid
, port
);
482 scm_set_current_warning_port (SCM port
)
484 static SCM cwp_var
= SCM_BOOL_F
;
486 if (scm_is_false (cwp_var
))
487 cwp_var
= scm_c_private_lookup ("guile", "current-warning-port");
489 return scm_call_1 (scm_variable_ref (cwp_var
), port
);
494 scm_dynwind_current_input_port (SCM port
)
495 #define FUNC_NAME NULL
497 SCM_VALIDATE_OPINPORT (1, port
);
498 scm_dynwind_fluid (cur_inport_fluid
, port
);
503 scm_dynwind_current_output_port (SCM port
)
504 #define FUNC_NAME NULL
506 port
= SCM_COERCE_OUTPORT (port
);
507 SCM_VALIDATE_OPOUTPORT (1, port
);
508 scm_dynwind_fluid (cur_outport_fluid
, port
);
513 scm_dynwind_current_error_port (SCM port
)
514 #define FUNC_NAME NULL
516 port
= SCM_COERCE_OUTPORT (port
);
517 SCM_VALIDATE_OPOUTPORT (1, port
);
518 scm_dynwind_fluid (cur_errport_fluid
, port
);
523 scm_i_dynwind_current_load_port (SCM port
)
525 scm_dynwind_fluid (cur_loadport_fluid
, port
);
529 /* The port table --- an array of pointers to ports. */
532 We need a global registry of ports to flush them all at exit, and to
533 get all the ports matching a file descriptor.
535 SCM scm_i_port_weak_hash
;
537 scm_i_pthread_mutex_t scm_i_port_table_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
540 /* Port finalization. */
543 static void finalize_port (GC_PTR
, GC_PTR
);
545 /* Register a finalizer for PORT. */
546 static SCM_C_INLINE_KEYWORD
void
547 register_finalizer_for_port (SCM port
)
549 GC_finalization_proc prev_finalizer
;
550 GC_PTR prev_finalization_data
;
552 /* Register a finalizer for PORT so that its iconv CDs get freed and
553 optionally its type's `free' function gets called. */
554 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (port
), finalize_port
, 0,
556 &prev_finalization_data
);
559 /* Finalize the object (a port) pointed to by PTR. */
561 finalize_port (GC_PTR ptr
, GC_PTR data
)
564 SCM port
= PTR2SCM (ptr
);
566 if (!SCM_PORTP (port
))
569 if (SCM_OPENP (port
))
571 if (SCM_REVEALED (port
) > 0)
572 /* Keep "revealed" ports alive and re-register a finalizer. */
573 register_finalizer_for_port (port
);
578 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
579 if (port_type
>= scm_numptob
)
582 if (scm_ptobs
[port_type
].free
)
583 /* Yes, I really do mean `.free' rather than `.close'. `.close'
584 is for explicit `close-port' by user. */
585 scm_ptobs
[port_type
].free (port
);
587 entry
= SCM_PTAB_ENTRY (port
);
589 if (entry
->input_cd
!= (iconv_t
) -1)
590 iconv_close (entry
->input_cd
);
591 if (entry
->output_cd
!= (iconv_t
) -1)
592 iconv_close (entry
->output_cd
);
594 SCM_SETSTREAM (port
, 0);
595 SCM_CLR_PORT_OPEN_FLAG (port
);
597 scm_gc_ports_collected
++;
606 /* This function is not and should not be thread safe. */
608 scm_new_port_table_entry (scm_t_bits tag
)
609 #define FUNC_NAME "scm_new_port_table_entry"
612 We initialize the cell to empty, this is in case scm_gc_calloc
613 triggers GC ; we don't want the GC to scan a half-finished Z.
616 SCM z
= scm_cons (SCM_EOL
, SCM_EOL
);
617 scm_t_port
*entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
620 entry
->file_name
= SCM_BOOL_F
;
621 entry
->rw_active
= SCM_PORT_NEITHER
;
624 /* Initialize this port with the thread's current default
626 enc
= scm_i_default_port_encoding ();
627 entry
->encoding
= enc
? scm_gc_strdup (enc
, "port") : NULL
;
629 /* The conversion descriptors will be opened lazily. */
630 entry
->input_cd
= (iconv_t
) -1;
631 entry
->output_cd
= (iconv_t
) -1;
633 entry
->ilseq_handler
= scm_i_get_conversion_strategy (SCM_BOOL_F
);
635 SCM_SET_CELL_TYPE (z
, tag
);
636 SCM_SETPTAB_ENTRY (z
, entry
);
638 scm_hashq_set_x (scm_i_port_weak_hash
, z
, SCM_BOOL_F
);
640 /* For each new port, register a finalizer so that it port type's free
641 function can be invoked eventually. */
642 register_finalizer_for_port (z
);
648 #if SCM_ENABLE_DEPRECATED==1
650 scm_add_to_port_table (SCM port
)
655 scm_c_issue_deprecation_warning ("scm_add_to_port_table is deprecated.");
657 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
658 z
= scm_new_port_table_entry (scm_tc7_port
);
659 pt
= SCM_PTAB_ENTRY(z
);
661 SCM_SETCAR (z
, SCM_EOL
);
662 SCM_SETCDR (z
, SCM_EOL
);
663 SCM_SETPTAB_ENTRY (port
, pt
);
664 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
671 /* Remove a port from the table and destroy it. */
674 scm_i_remove_port (SCM port
)
675 #define FUNC_NAME "scm_remove_port"
679 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
681 p
= SCM_PTAB_ENTRY (port
);
682 scm_port_non_buffer (p
);
683 p
->putback_buf
= NULL
;
684 p
->putback_buf_size
= 0;
686 if (p
->input_cd
!= (iconv_t
) -1)
688 iconv_close (p
->input_cd
);
689 p
->input_cd
= (iconv_t
) -1;
692 if (p
->output_cd
!= (iconv_t
) -1)
694 iconv_close (p
->output_cd
);
695 p
->output_cd
= (iconv_t
) -1;
698 SCM_SETPTAB_ENTRY (port
, 0);
700 scm_hashq_remove_x (scm_i_port_weak_hash
, port
);
702 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
707 /* Functions for debugging. */
709 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
711 "Return the number of ports in the port table. @code{pt-size}\n"
712 "is only included in @code{--enable-guile-debug} builds.")
713 #define FUNC_NAME s_scm_pt_size
715 return scm_from_int (SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
));
721 scm_port_non_buffer (scm_t_port
*pt
)
723 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
724 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
725 pt
->read_buf_size
= pt
->write_buf_size
= 1;
726 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
730 /* Revealed counts --- an oddity inherited from SCSH. */
732 /* Find a port in the table and return its revealed count.
733 Also used by the garbage collector.
737 scm_revealed_count (SCM port
)
739 return SCM_REVEALED(port
);
744 /* Return the revealed count for a port. */
746 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
748 "Return the revealed count for @var{port}.")
749 #define FUNC_NAME s_scm_port_revealed
751 port
= SCM_COERCE_OUTPORT (port
);
752 SCM_VALIDATE_OPENPORT (1, port
);
753 return scm_from_int (scm_revealed_count (port
));
757 /* Set the revealed count for a port. */
758 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
759 (SCM port
, SCM rcount
),
760 "Sets the revealed count for a port to a given value.\n"
761 "The return value is unspecified.")
762 #define FUNC_NAME s_scm_set_port_revealed_x
764 port
= SCM_COERCE_OUTPORT (port
);
765 SCM_VALIDATE_OPENPORT (1, port
);
766 SCM_REVEALED (port
) = scm_to_int (rcount
);
767 return SCM_UNSPECIFIED
;
773 /* Retrieving a port's mode. */
775 /* Return the flags that characterize a port based on the mode
776 * string used to open a file for that port.
778 * See PORT FLAGS in scm.h
782 scm_i_mode_bits_n (SCM modes
)
785 | (scm_i_string_contains_char (modes
, 'r')
786 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
787 | (scm_i_string_contains_char (modes
, 'w')
788 || scm_i_string_contains_char (modes
, 'a')
789 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
790 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
791 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
795 scm_mode_bits (char *modes
)
797 return scm_i_mode_bits (scm_from_locale_string (modes
));
801 scm_i_mode_bits (SCM modes
)
805 if (!scm_is_string (modes
))
806 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
808 bits
= scm_i_mode_bits_n (modes
);
809 scm_remember_upto_here_1 (modes
);
813 /* Return the mode flags from an open port.
814 * Some modes such as "append" are only used when opening
815 * a file and are not returned here. */
817 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
819 "Return the port modes associated with the open port @var{port}.\n"
820 "These will not necessarily be identical to the modes used when\n"
821 "the port was opened, since modes such as \"append\" which are\n"
822 "used only during port creation are not retained.")
823 #define FUNC_NAME s_scm_port_mode
828 port
= SCM_COERCE_OUTPORT (port
);
829 SCM_VALIDATE_OPPORT (1, port
);
830 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
831 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
832 strcpy (modes
, "r+");
836 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
838 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
840 return scm_from_locale_string (modes
);
849 * Call the close operation on a port object.
850 * see also scm_close.
852 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
854 "Close the specified port object. Return @code{#t} if it\n"
855 "successfully closes a port or @code{#f} if it was already\n"
856 "closed. An exception may be raised if an error occurs, for\n"
857 "example when flushing buffered output. See also @ref{Ports and\n"
858 "File Descriptors, close}, for a procedure which can close file\n"
860 #define FUNC_NAME s_scm_close_port
865 port
= SCM_COERCE_OUTPORT (port
);
867 SCM_VALIDATE_PORT (1, port
);
868 if (SCM_CLOSEDP (port
))
870 i
= SCM_PTOBNUM (port
);
871 if (scm_ptobs
[i
].close
)
872 rv
= (scm_ptobs
[i
].close
) (port
);
875 scm_i_remove_port (port
);
876 SCM_CLR_PORT_OPEN_FLAG (port
);
877 return scm_from_bool (rv
>= 0);
881 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
883 "Close the specified input port object. The routine has no effect if\n"
884 "the file has already been closed. An exception may be raised if an\n"
885 "error occurs. The value returned is unspecified.\n\n"
886 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
887 "which can close file descriptors.")
888 #define FUNC_NAME s_scm_close_input_port
890 SCM_VALIDATE_INPUT_PORT (1, port
);
891 scm_close_port (port
);
892 return SCM_UNSPECIFIED
;
896 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
898 "Close the specified output port object. The routine has no effect if\n"
899 "the file has already been closed. An exception may be raised if an\n"
900 "error occurs. The value returned is unspecified.\n\n"
901 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
902 "which can close file descriptors.")
903 #define FUNC_NAME s_scm_close_output_port
905 port
= SCM_COERCE_OUTPORT (port
);
906 SCM_VALIDATE_OUTPUT_PORT (1, port
);
907 scm_close_port (port
);
908 return SCM_UNSPECIFIED
;
913 collect_keys (void *unused
, SCM key
, SCM value
, SCM result
)
915 return scm_cons (key
, result
);
919 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
923 /* Copy out the port table as a list so that we get strong references
924 to all the values. */
925 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
926 ports
= scm_internal_hash_fold (collect_keys
, NULL
,
927 SCM_EOL
, scm_i_port_weak_hash
);
928 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
930 for (; scm_is_pair (ports
); ports
= scm_cdr (ports
))
932 SCM p
= scm_car (ports
);
938 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
940 "Apply @var{proc} to each port in the Guile port table\n"
941 "in turn. The return value is unspecified. More specifically,\n"
942 "@var{proc} is applied exactly once to every port that exists\n"
943 "in the system at the time @var{port-for-each} is invoked.\n"
944 "Changes to the port table while @var{port-for-each} is running\n"
945 "have no effect as far as @var{port-for-each} is concerned.")
946 #define FUNC_NAME s_scm_port_for_each
950 SCM_VALIDATE_PROC (1, proc
);
952 /* Copy out the port table as a list so that we get strong references
953 to all the values. */
954 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
955 ports
= scm_internal_hash_fold (collect_keys
, NULL
,
956 SCM_EOL
, scm_i_port_weak_hash
);
957 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
959 for (; scm_is_pair (ports
); ports
= scm_cdr (ports
))
960 if (SCM_PORTP (SCM_CAR (ports
)))
961 scm_call_1 (proc
, SCM_CAR (ports
));
963 return SCM_UNSPECIFIED
;
969 /* Utter miscellany. Gosh, we should clean this up some time. */
971 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
973 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
974 "@code{#f}. Any object satisfying this predicate also satisfies\n"
976 #define FUNC_NAME s_scm_input_port_p
978 return scm_from_bool (SCM_INPUT_PORT_P (x
));
982 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
984 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
985 "@code{#f}. Any object satisfying this predicate also satisfies\n"
987 #define FUNC_NAME s_scm_output_port_p
989 x
= SCM_COERCE_OUTPORT (x
);
990 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
994 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
996 "Return a boolean indicating whether @var{x} is a port.\n"
997 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
999 #define FUNC_NAME s_scm_port_p
1001 return scm_from_bool (SCM_PORTP (x
));
1005 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
1007 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
1009 #define FUNC_NAME s_scm_port_closed_p
1011 SCM_VALIDATE_PORT (1, port
);
1012 return scm_from_bool (!SCM_OPPORTP (port
));
1016 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
1018 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
1019 "return @code{#f}.")
1020 #define FUNC_NAME s_scm_eof_object_p
1022 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
1026 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
1028 "Flush the specified output port, or the current output port if @var{port}\n"
1029 "is omitted. The current output buffer contents are passed to the\n"
1030 "underlying port implementation (e.g., in the case of fports, the\n"
1031 "data will be written to the file and the output buffer will be cleared.)\n"
1032 "It has no effect on an unbuffered port.\n\n"
1033 "The return value is unspecified.")
1034 #define FUNC_NAME s_scm_force_output
1036 if (SCM_UNBNDP (port
))
1037 port
= scm_current_output_port ();
1040 port
= SCM_COERCE_OUTPORT (port
);
1041 SCM_VALIDATE_OPOUTPORT (1, port
);
1044 return SCM_UNSPECIFIED
;
1050 flush_output_port (void *closure
, SCM port
)
1052 if (SCM_OPOUTPORTP (port
))
1056 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
1058 "Equivalent to calling @code{force-output} on\n"
1059 "all open output ports. The return value is unspecified.")
1060 #define FUNC_NAME s_scm_flush_all_ports
1062 scm_c_port_for_each (&flush_output_port
, NULL
);
1063 return SCM_UNSPECIFIED
;
1067 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1069 "Return the next character available from @var{port}, updating\n"
1070 "@var{port} to point to the following character. If no more\n"
1071 "characters are available, the end-of-file object is returned.\n"
1073 "When @var{port}'s data cannot be decoded according to its\n"
1074 "character encoding, a @code{decoding-error} is raised and\n"
1075 "@var{port} points past the erroneous byte sequence.\n")
1076 #define FUNC_NAME s_scm_read_char
1079 if (SCM_UNBNDP (port
))
1080 port
= scm_current_input_port ();
1081 SCM_VALIDATE_OPINPORT (1, port
);
1082 c
= scm_getc (port
);
1085 return SCM_MAKE_CHAR (c
);
1089 /* Update the line and column number of PORT after consumption of C. */
1091 update_port_lf (scm_t_wchar c
, SCM port
)
1116 #define SCM_MBCHAR_BUF_SIZE (4)
1118 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1119 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1121 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1123 scm_t_wchar codepoint
;
1125 if (utf8_buf
[0] <= 0x7f)
1128 codepoint
= utf8_buf
[0];
1130 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1133 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1134 | (utf8_buf
[1] & 0x3f);
1136 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1139 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1140 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1141 | (utf8_buf
[2] & 0x3f);
1146 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1147 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1148 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1149 | (utf8_buf
[3] & 0x3f);
1155 /* Read a UTF-8 sequence from PORT. On success, return 0 and set
1156 *CODEPOINT to the codepoint that was read, fill BUF with its UTF-8
1157 representation, and set *LEN to the length in bytes. Return
1158 `EILSEQ' on error. */
1160 get_utf8_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1161 scm_t_uint8 buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1163 #define ASSERT_NOT_EOF(b) \
1164 if (SCM_UNLIKELY ((b) == EOF)) \
1166 #define CONSUME_PEEKED_BYTE() \
1173 pt
= SCM_PTAB_ENTRY (port
);
1175 byte
= scm_get_byte_or_eof (port
);
1182 buf
[0] = (scm_t_uint8
) byte
;
1187 *codepoint
= buf
[0];
1188 else if (buf
[0] >= 0xc2 && buf
[0] <= 0xdf)
1191 byte
= scm_peek_byte_or_eof (port
);
1192 ASSERT_NOT_EOF (byte
);
1194 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1197 CONSUME_PEEKED_BYTE ();
1198 buf
[1] = (scm_t_uint8
) byte
;
1201 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x1f) << 6UL
1204 else if ((buf
[0] & 0xf0) == 0xe0)
1207 byte
= scm_peek_byte_or_eof (port
);
1208 ASSERT_NOT_EOF (byte
);
1210 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80
1211 || (buf
[0] == 0xe0 && byte
< 0xa0)
1212 || (buf
[0] == 0xed && byte
> 0x9f)))
1215 CONSUME_PEEKED_BYTE ();
1216 buf
[1] = (scm_t_uint8
) byte
;
1219 byte
= scm_peek_byte_or_eof (port
);
1220 ASSERT_NOT_EOF (byte
);
1222 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1225 CONSUME_PEEKED_BYTE ();
1226 buf
[2] = (scm_t_uint8
) byte
;
1229 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x0f) << 12UL
1230 | ((scm_t_wchar
) buf
[1] & 0x3f) << 6UL
1233 else if (buf
[0] >= 0xf0 && buf
[0] <= 0xf4)
1236 byte
= scm_peek_byte_or_eof (port
);
1237 ASSERT_NOT_EOF (byte
);
1239 if (SCM_UNLIKELY (((byte
& 0xc0) != 0x80)
1240 || (buf
[0] == 0xf0 && byte
< 0x90)
1241 || (buf
[0] == 0xf4 && byte
> 0x8f)))
1244 CONSUME_PEEKED_BYTE ();
1245 buf
[1] = (scm_t_uint8
) byte
;
1248 byte
= scm_peek_byte_or_eof (port
);
1249 ASSERT_NOT_EOF (byte
);
1251 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1254 CONSUME_PEEKED_BYTE ();
1255 buf
[2] = (scm_t_uint8
) byte
;
1258 byte
= scm_peek_byte_or_eof (port
);
1259 ASSERT_NOT_EOF (byte
);
1261 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1264 CONSUME_PEEKED_BYTE ();
1265 buf
[3] = (scm_t_uint8
) byte
;
1268 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x07) << 18UL
1269 | ((scm_t_wchar
) buf
[1] & 0x3f) << 12UL
1270 | ((scm_t_wchar
) buf
[2] & 0x3f) << 6UL
1279 /* Here we could choose the consume the faulty byte when it's not a
1280 valid starting byte, but it's not a requirement. What Section 3.9
1281 of Unicode 6.0.0 mandates, though, is to not consume a byte that
1282 would otherwise be a valid starting byte. */
1286 #undef CONSUME_PEEKED_BYTE
1287 #undef ASSERT_NOT_EOF
1290 /* Likewise, read a byte sequence from PORT, passing it through its
1291 input conversion descriptor. */
1293 get_iconv_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1294 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1298 size_t bytes_consumed
, output_size
;
1300 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1302 pt
= SCM_PTAB_ENTRY (port
);
1304 for (output_size
= 0, output
= (char *) utf8_buf
,
1305 bytes_consumed
= 0, err
= 0;
1306 err
== 0 && output_size
== 0
1307 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1311 size_t input_left
, output_left
, done
;
1313 byte_read
= scm_get_byte_or_eof (port
);
1314 if (byte_read
== EOF
)
1316 if (bytes_consumed
== 0)
1318 *codepoint
= (scm_t_wchar
) EOF
;
1326 buf
[bytes_consumed
] = byte_read
;
1329 input_left
= bytes_consumed
+ 1;
1330 output_left
= sizeof (utf8_buf
);
1332 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1333 &output
, &output_left
);
1334 if (done
== (size_t) -1)
1338 /* Missing input: keep trying. */
1342 output_size
= sizeof (utf8_buf
) - output_left
;
1345 if (SCM_UNLIKELY (output_size
== 0))
1346 /* An unterminated sequence. */
1348 else if (SCM_LIKELY (err
== 0))
1350 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1351 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1352 *len
= bytes_consumed
;
1358 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1359 with the byte representation of the codepoint in PORT's encoding, and
1360 set *LEN to the length in bytes of that representation. Return 0 on
1361 success and an errno value on error. */
1363 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1364 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1367 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1369 if (pt
->input_cd
== (iconv_t
) -1)
1370 /* Initialize the conversion descriptors, if needed. */
1371 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1373 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
1374 if (pt
->input_cd
== (iconv_t
) -1)
1375 err
= get_utf8_codepoint (port
, codepoint
, (scm_t_uint8
*) buf
, len
);
1377 err
= get_iconv_codepoint (port
, codepoint
, buf
, len
);
1379 if (SCM_LIKELY (err
== 0))
1380 update_port_lf (*codepoint
, port
);
1381 else if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1385 update_port_lf (*codepoint
, port
);
1391 /* Read a codepoint from PORT and return it. */
1394 #define FUNC_NAME "scm_getc"
1398 scm_t_wchar codepoint
;
1399 char buf
[SCM_MBCHAR_BUF_SIZE
];
1401 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1402 if (SCM_UNLIKELY (err
!= 0))
1403 /* At this point PORT should point past the invalid encoding, as per
1404 R6RS-lib Section 8.2.4. */
1405 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1411 /* this should only be called when the read buffer is empty. it
1412 tries to refill the read buffer. it returns the first char from
1413 the port, which is either EOF or *(pt->read_pos). */
1415 scm_fill_input (SCM port
)
1417 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1419 assert (pt
->read_pos
== pt
->read_end
);
1421 if (pt
->read_buf
== pt
->putback_buf
)
1423 /* finished reading put-back chars. */
1424 pt
->read_buf
= pt
->saved_read_buf
;
1425 pt
->read_pos
= pt
->saved_read_pos
;
1426 pt
->read_end
= pt
->saved_read_end
;
1427 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1428 if (pt
->read_pos
< pt
->read_end
)
1429 return *(pt
->read_pos
);
1431 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1437 * This function differs from scm_c_write; it updates port line and
1441 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1443 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1444 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1446 if (pt
->rw_active
== SCM_PORT_READ
)
1447 scm_end_input (port
);
1449 ptob
->write (port
, ptr
, size
);
1451 for (; size
; ptr
++, size
--)
1452 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1455 pt
->rw_active
= SCM_PORT_WRITE
;
1458 /* Write STR to PORT from START inclusive to END exclusive. */
1460 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1462 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1464 if (pt
->rw_active
== SCM_PORT_READ
)
1465 scm_end_input (port
);
1467 if (end
== (size_t) -1)
1468 end
= scm_i_string_length (str
);
1470 scm_display (scm_c_substring (str
, start
, end
), port
);
1473 pt
->rw_active
= SCM_PORT_WRITE
;
1478 * Used by an application to read arbitrary number of bytes from an
1479 * SCM port. Same semantics as libc read, except that scm_c_read only
1480 * returns less than SIZE bytes if at end-of-file.
1482 * Warning: Doesn't update port line and column counts! */
1484 /* This structure, and the following swap_buffer function, are used
1485 for temporarily swapping a port's own read buffer, and the buffer
1486 that the caller of scm_c_read provides. */
1487 struct port_and_swap_buffer
1490 unsigned char *buffer
;
1495 swap_buffer (void *data
)
1497 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1498 unsigned char *old_buf
= psb
->pt
->read_buf
;
1499 size_t old_size
= psb
->pt
->read_buf_size
;
1501 /* Make the port use (buffer, size) from the struct. */
1502 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1503 psb
->pt
->read_buf_size
= psb
->size
;
1505 /* Save the port's old (buffer, size) in the struct. */
1506 psb
->buffer
= old_buf
;
1507 psb
->size
= old_size
;
1511 scm_c_read (SCM port
, void *buffer
, size_t size
)
1512 #define FUNC_NAME "scm_c_read"
1515 size_t n_read
= 0, n_available
;
1516 struct port_and_swap_buffer psb
;
1518 SCM_VALIDATE_OPINPORT (1, port
);
1520 pt
= SCM_PTAB_ENTRY (port
);
1521 if (pt
->rw_active
== SCM_PORT_WRITE
)
1522 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1525 pt
->rw_active
= SCM_PORT_READ
;
1527 /* Take bytes first from the port's read buffer. */
1528 if (pt
->read_pos
< pt
->read_end
)
1530 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1531 memcpy (buffer
, pt
->read_pos
, n_available
);
1532 buffer
= (char *) buffer
+ n_available
;
1533 pt
->read_pos
+= n_available
;
1534 n_read
+= n_available
;
1535 size
-= n_available
;
1538 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1542 /* Now we will call scm_fill_input repeatedly until we have read the
1543 requested number of bytes. (Note that a single scm_fill_input
1544 call does not guarantee to fill the whole of the port's read
1546 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1548 /* The port that we are reading from is unbuffered - i.e. does
1549 not have its own persistent buffer - but we have a buffer,
1550 provided by our caller, that is the right size for the data
1551 that is wanted. For the following scm_fill_input calls,
1552 therefore, we use the buffer in hand as the port's read
1555 We need to make sure that the port's normal (1 byte) buffer
1556 is reinstated in case one of the scm_fill_input () calls
1557 throws an exception; we use the scm_dynwind_* API to achieve
1560 A consequence of this optimization is that the fill_input
1561 functions can't unget characters. That'll push data to the
1562 pushback buffer instead of this psb buffer. */
1564 unsigned char *pback
= pt
->putback_buf
;
1567 psb
.buffer
= buffer
;
1569 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1570 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1571 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1573 /* Call scm_fill_input until we have all the bytes that we need,
1575 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1577 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1578 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1581 if (pback
!= pt
->putback_buf
1582 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1583 scm_misc_error (FUNC_NAME
,
1584 "scm_c_read must not call a fill function that pushes "
1585 "back characters onto an unbuffered port", SCM_EOL
);
1587 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1589 /* Reinstate the port's normal buffer. */
1594 /* The port has its own buffer. It is important that we use it,
1595 even if it happens to be smaller than our caller's buffer, so
1596 that a custom port implementation's entry points (in
1597 particular, fill_input) can rely on the buffer always being
1598 the same as they first set up. */
1599 while (size
&& (scm_fill_input (port
) != EOF
))
1601 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1602 memcpy (buffer
, pt
->read_pos
, n_available
);
1603 buffer
= (char *) buffer
+ n_available
;
1604 pt
->read_pos
+= n_available
;
1605 n_read
+= n_available
;
1606 size
-= n_available
;
1616 * Used by an application to write arbitrary number of bytes to an SCM
1617 * port. Similar semantics as libc write. However, unlike libc
1618 * write, scm_c_write writes the requested number of bytes and has no
1621 * Warning: Doesn't update port line and column counts!
1625 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1626 #define FUNC_NAME "scm_c_write"
1629 scm_t_ptob_descriptor
*ptob
;
1631 SCM_VALIDATE_OPOUTPORT (1, port
);
1633 pt
= SCM_PTAB_ENTRY (port
);
1634 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1636 if (pt
->rw_active
== SCM_PORT_READ
)
1637 scm_end_input (port
);
1639 ptob
->write (port
, ptr
, size
);
1642 pt
->rw_active
= SCM_PORT_WRITE
;
1647 scm_flush (SCM port
)
1649 long i
= SCM_PTOBNUM (port
);
1651 (scm_ptobs
[i
].flush
) (port
);
1655 scm_end_input (SCM port
)
1658 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1660 if (pt
->read_buf
== pt
->putback_buf
)
1662 offset
= pt
->read_end
- pt
->read_pos
;
1663 pt
->read_buf
= pt
->saved_read_buf
;
1664 pt
->read_pos
= pt
->saved_read_pos
;
1665 pt
->read_end
= pt
->saved_read_end
;
1666 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1671 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1678 scm_unget_byte (int c
, SCM port
)
1679 #define FUNC_NAME "scm_unget_byte"
1681 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1683 if (pt
->read_buf
== pt
->putback_buf
)
1684 /* already using the put-back buffer. */
1686 /* enlarge putback_buf if necessary. */
1687 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1688 && pt
->read_buf
== pt
->read_pos
)
1690 size_t new_size
= pt
->read_buf_size
* 2;
1691 unsigned char *tmp
= (unsigned char *)
1692 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1695 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1696 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1697 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1700 /* shift any existing bytes to buffer + 1. */
1701 if (pt
->read_pos
== pt
->read_end
)
1702 pt
->read_end
= pt
->read_buf
+ 1;
1703 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1705 int count
= pt
->read_end
- pt
->read_pos
;
1707 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1708 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1711 pt
->read_pos
= pt
->read_buf
;
1714 /* switch to the put-back buffer. */
1716 if (pt
->putback_buf
== NULL
)
1719 = (unsigned char *) scm_gc_malloc_pointerless
1720 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1721 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1724 pt
->saved_read_buf
= pt
->read_buf
;
1725 pt
->saved_read_pos
= pt
->read_pos
;
1726 pt
->saved_read_end
= pt
->read_end
;
1727 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1729 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1730 pt
->read_end
= pt
->read_buf
+ 1;
1731 pt
->read_buf_size
= pt
->putback_buf_size
;
1737 pt
->rw_active
= SCM_PORT_READ
;
1742 scm_ungetc (scm_t_wchar c
, SCM port
)
1743 #define FUNC_NAME "scm_ungetc"
1745 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1747 char result_buf
[10];
1748 const char *encoding
;
1752 if (pt
->encoding
!= NULL
)
1753 encoding
= pt
->encoding
;
1755 encoding
= "ISO-8859-1";
1757 len
= sizeof (result_buf
);
1758 result
= u32_conv_to_encoding (encoding
,
1759 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1760 (uint32_t *) &c
, 1, NULL
,
1763 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1764 scm_encoding_error (FUNC_NAME
, errno
,
1765 "conversion to port encoding failed",
1766 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1768 for (i
= len
- 1; i
>= 0; i
--)
1769 scm_unget_byte (result
[i
], port
);
1771 if (SCM_UNLIKELY (result
!= result_buf
))
1776 /* What should col be in this case?
1777 * We'll leave it at -1.
1779 SCM_LINUM (port
) -= 1;
1788 scm_ungets (const char *s
, int n
, SCM port
)
1790 /* This is simple minded and inefficient, but unreading strings is
1791 * probably not a common operation, and remember that line and
1792 * column numbers have to be handled...
1794 * Please feel free to write an optimized version!
1797 scm_ungetc (s
[n
], port
);
1801 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1803 "Return the next character available from @var{port},\n"
1804 "@emph{without} updating @var{port} to point to the following\n"
1805 "character. If no more characters are available, the\n"
1806 "end-of-file object is returned.\n"
1808 "The value returned by\n"
1809 "a call to @code{peek-char} is the same as the value that would\n"
1810 "have been returned by a call to @code{read-char} on the same\n"
1811 "port. The only difference is that the very next call to\n"
1812 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1813 "return the value returned by the preceding call to\n"
1814 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1815 "an interactive port will hang waiting for input whenever a call\n"
1816 "to @code{read-char} would have hung.\n"
1818 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1819 "if such a situation occurs. However, unlike with @code{read-char},\n"
1820 "@var{port} still points at the beginning of the erroneous byte\n"
1821 "sequence when the error is raised.\n")
1822 #define FUNC_NAME s_scm_peek_char
1827 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1828 long column
, line
, i
;
1831 if (SCM_UNBNDP (port
))
1832 port
= scm_current_input_port ();
1833 SCM_VALIDATE_OPINPORT (1, port
);
1835 column
= SCM_COL (port
);
1836 line
= SCM_LINUM (port
);
1838 err
= get_codepoint (port
, &c
, bytes
, &len
);
1840 for (i
= len
- 1; i
>= 0; i
--)
1841 scm_unget_byte (bytes
[i
], port
);
1843 SCM_COL (port
) = column
;
1844 SCM_LINUM (port
) = line
;
1846 if (SCM_UNLIKELY (err
!= 0))
1848 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1850 /* Shouldn't happen since `catch' always aborts to prompt. */
1851 result
= SCM_BOOL_F
;
1854 result
= SCM_EOF_VAL
;
1856 result
= SCM_MAKE_CHAR (c
);
1862 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1863 (SCM cobj
, SCM port
),
1864 "Place @var{char} in @var{port} so that it will be read by the\n"
1865 "next read operation. If called multiple times, the unread characters\n"
1866 "will be read again in last-in first-out order. If @var{port} is\n"
1867 "not supplied, the current input port is used.")
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 @var{file} to @var{length} bytes. @var{file} can be a\n"
1999 "filename string, a port object, or an integer file descriptor.\n"
2000 "The return value is unspecified.\n"
2002 "For a port or file descriptor @var{length} can be omitted, in\n"
2003 "which case the file is truncated at the current position (per\n"
2004 "@code{ftell} above).\n"
2006 "On most systems a file can be extended by giving a length\n"
2007 "greater than the current size, but this is not mandatory in the\n"
2009 #define FUNC_NAME s_scm_truncate_file
2013 /* "object" can be a port, fdes or filename.
2015 Negative "length" makes no sense, but it's left to truncate() or
2016 ftruncate() to give back an error for that (normally EINVAL).
2019 if (SCM_UNBNDP (length
))
2021 /* must supply length if object is a filename. */
2022 if (scm_is_string (object
))
2023 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
2025 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
2028 object
= SCM_COERCE_OUTPORT (object
);
2029 if (scm_is_integer (object
))
2031 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2032 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
2035 else if (SCM_OPOUTPORTP (object
))
2037 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2038 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
2039 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
2041 if (!ptob
->truncate
)
2042 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
2043 if (pt
->rw_active
== SCM_PORT_READ
)
2044 scm_end_input (object
);
2045 else if (pt
->rw_active
== SCM_PORT_WRITE
)
2046 ptob
->flush (object
);
2048 ptob
->truncate (object
, c_length
);
2053 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2054 char *str
= scm_to_locale_string (object
);
2056 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
2063 return SCM_UNSPECIFIED
;
2067 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
2069 "Return the current line number for @var{port}.\n"
2071 "The first line of a file is 0. But you might want to add 1\n"
2072 "when printing line numbers, since starting from 1 is\n"
2073 "traditional in error messages, and likely to be more natural to\n"
2075 #define FUNC_NAME s_scm_port_line
2077 port
= SCM_COERCE_OUTPORT (port
);
2078 SCM_VALIDATE_OPENPORT (1, port
);
2079 return scm_from_long (SCM_LINUM (port
));
2083 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
2084 (SCM port
, SCM line
),
2085 "Set the current line number for @var{port} to @var{line}. The\n"
2086 "first line of a file is 0.")
2087 #define FUNC_NAME s_scm_set_port_line_x
2089 port
= SCM_COERCE_OUTPORT (port
);
2090 SCM_VALIDATE_OPENPORT (1, port
);
2091 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
2092 return SCM_UNSPECIFIED
;
2096 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
2098 "Return the current column number of @var{port}.\n"
2099 "If the number is\n"
2100 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
2101 "- i.e. the first character of the first line is line 0, column 0.\n"
2102 "(However, when you display a file position, for example in an error\n"
2103 "message, we recommend you add 1 to get 1-origin integers. This is\n"
2104 "because lines and column numbers traditionally start with 1, and that is\n"
2105 "what non-programmers will find most natural.)")
2106 #define FUNC_NAME s_scm_port_column
2108 port
= SCM_COERCE_OUTPORT (port
);
2109 SCM_VALIDATE_OPENPORT (1, port
);
2110 return scm_from_int (SCM_COL (port
));
2114 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
2115 (SCM port
, SCM column
),
2116 "Set the current column of @var{port}. Before reading the first\n"
2117 "character on a line the column should be 0.")
2118 #define FUNC_NAME s_scm_set_port_column_x
2120 port
= SCM_COERCE_OUTPORT (port
);
2121 SCM_VALIDATE_OPENPORT (1, port
);
2122 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
2123 return SCM_UNSPECIFIED
;
2127 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
2129 "Return the filename associated with @var{port}, or @code{#f}\n"
2130 "if no filename is associated with the port.")
2131 #define FUNC_NAME s_scm_port_filename
2133 port
= SCM_COERCE_OUTPORT (port
);
2134 SCM_VALIDATE_OPENPORT (1, port
);
2135 return SCM_FILENAME (port
);
2139 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
2140 (SCM port
, SCM filename
),
2141 "Change the filename associated with @var{port}, using the current input\n"
2142 "port if none is specified. Note that this does not change the port's\n"
2143 "source of data, but only the value that is returned by\n"
2144 "@code{port-filename} and reported in diagnostic output.")
2145 #define FUNC_NAME s_scm_set_port_filename_x
2147 port
= SCM_COERCE_OUTPORT (port
);
2148 SCM_VALIDATE_OPENPORT (1, port
);
2149 /* We allow the user to set the filename to whatever he likes. */
2150 SCM_SET_FILENAME (port
, filename
);
2151 return SCM_UNSPECIFIED
;
2155 /* A fluid specifying the default encoding for newly created ports. If it is
2156 a string, that is the encoding. If it is #f, it is in the "native"
2157 (Latin-1) encoding. */
2158 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
2160 static int scm_port_encoding_init
= 0;
2162 /* Use ENCODING as the default encoding for future ports. */
2164 scm_i_set_default_port_encoding (const char *encoding
)
2166 if (!scm_port_encoding_init
2167 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2168 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
2171 if (encoding
== NULL
2172 || !strcmp (encoding
, "ASCII")
2173 || !strcmp (encoding
, "ANSI_X3.4-1968")
2174 || !strcmp (encoding
, "ISO-8859-1"))
2175 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2177 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
2178 scm_from_locale_string (encoding
));
2181 /* Return the name of the default encoding for newly created ports; a
2182 return value of NULL means "ISO-8859-1". */
2184 scm_i_default_port_encoding (void)
2186 if (!scm_port_encoding_init
)
2188 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2194 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
2195 if (!scm_is_string (encoding
))
2198 return scm_i_string_chars (encoding
);
2203 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2206 iconv_t new_input_cd
, new_output_cd
;
2208 new_input_cd
= (iconv_t
) -1;
2209 new_output_cd
= (iconv_t
) -1;
2211 /* Set the character encoding for this port. */
2212 pt
= SCM_PTAB_ENTRY (port
);
2214 if (encoding
== NULL
)
2215 encoding
= "ISO-8859-1";
2217 if (pt
->encoding
!= encoding
)
2218 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2220 /* If ENCODING is UTF-8, then no conversion descriptor is opened
2221 because we do I/O ourselves. This saves 100+ KiB for each
2223 if (strcmp (encoding
, "UTF-8"))
2225 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2227 /* Open an input iconv conversion descriptor, from ENCODING
2228 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2229 implementations can typically convert from anything to
2230 UTF-8, but not to UTF-32 (see
2231 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2232 new_input_cd
= iconv_open ("UTF-8", encoding
);
2233 if (new_input_cd
== (iconv_t
) -1)
2234 goto invalid_encoding
;
2237 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2239 new_output_cd
= iconv_open (encoding
, "UTF-8");
2240 if (new_output_cd
== (iconv_t
) -1)
2242 if (new_input_cd
!= (iconv_t
) -1)
2243 iconv_close (new_input_cd
);
2244 goto invalid_encoding
;
2249 if (pt
->input_cd
!= (iconv_t
) -1)
2250 iconv_close (pt
->input_cd
);
2251 if (pt
->output_cd
!= (iconv_t
) -1)
2252 iconv_close (pt
->output_cd
);
2254 pt
->input_cd
= new_input_cd
;
2255 pt
->output_cd
= new_output_cd
;
2262 err
= scm_from_locale_string (encoding
);
2263 scm_misc_error ("scm_i_set_port_encoding_x",
2264 "invalid or unknown character encoding ~s",
2269 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2271 "Returns, as a string, the character encoding that @var{port}\n"
2272 "uses to interpret its input and output.\n")
2273 #define FUNC_NAME s_scm_port_encoding
2278 SCM_VALIDATE_PORT (1, port
);
2280 pt
= SCM_PTAB_ENTRY (port
);
2283 return scm_from_locale_string (pt
->encoding
);
2289 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2290 (SCM port
, SCM enc
),
2291 "Sets the character encoding that will be used to interpret all\n"
2292 "port I/O. New ports are created with the encoding\n"
2293 "appropriate for the current locale if @code{setlocale} has \n"
2294 "been called or ISO-8859-1 otherwise\n"
2295 "and this procedure can be used to modify that encoding.\n")
2296 #define FUNC_NAME s_scm_set_port_encoding_x
2300 SCM_VALIDATE_PORT (1, port
);
2301 SCM_VALIDATE_STRING (2, enc
);
2303 enc_str
= scm_to_locale_string (enc
);
2304 scm_i_set_port_encoding_x (port
, enc_str
);
2307 return SCM_UNSPECIFIED
;
2312 /* This determines how conversions handle unconvertible characters. */
2313 SCM_GLOBAL_VARIABLE (scm_conversion_strategy
, "%port-conversion-strategy");
2314 static int scm_conversion_strategy_init
= 0;
2316 scm_t_string_failed_conversion_handler
2317 scm_i_get_conversion_strategy (SCM port
)
2321 if (scm_is_false (port
))
2323 if (!scm_conversion_strategy_init
2324 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2325 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2328 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (scm_conversion_strategy
));
2329 if (scm_is_false (encoding
))
2330 return SCM_FAILED_CONVERSION_QUESTION_MARK
;
2332 return (scm_t_string_failed_conversion_handler
) scm_to_int (encoding
);
2338 pt
= SCM_PTAB_ENTRY (port
);
2339 return pt
->ilseq_handler
;
2345 scm_i_set_conversion_strategy_x (SCM port
,
2346 scm_t_string_failed_conversion_handler handler
)
2351 strategy
= scm_from_int ((int) handler
);
2353 if (scm_is_false (port
))
2355 /* Set the default encoding for future ports. */
2356 if (!scm_conversion_strategy_init
2357 || !scm_is_fluid (SCM_VARIABLE_REF (scm_conversion_strategy
)))
2358 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2360 scm_fluid_set_x (SCM_VARIABLE_REF (scm_conversion_strategy
), strategy
);
2364 /* Set the character encoding for this port. */
2365 pt
= SCM_PTAB_ENTRY (port
);
2366 pt
->ilseq_handler
= handler
;
2370 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2371 1, 0, 0, (SCM port
),
2372 "Returns the behavior of the port when handling a character that\n"
2373 "is not representable in the port's current encoding.\n"
2374 "It returns the symbol @code{error} if unrepresentable characters\n"
2375 "should cause exceptions, @code{substitute} if the port should\n"
2376 "try to replace unrepresentable characters with question marks or\n"
2377 "approximate characters, or @code{escape} if unrepresentable\n"
2378 "characters should be converted to string escapes.\n"
2380 "If @var{port} is @code{#f}, then the current default behavior\n"
2381 "will be returned. New ports will have this default behavior\n"
2382 "when they are created.\n")
2383 #define FUNC_NAME s_scm_port_conversion_strategy
2385 scm_t_string_failed_conversion_handler h
;
2387 SCM_VALIDATE_OPPORT (1, port
);
2389 if (!scm_is_false (port
))
2391 SCM_VALIDATE_OPPORT (1, port
);
2394 h
= scm_i_get_conversion_strategy (port
);
2395 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2396 return scm_from_latin1_symbol ("error");
2397 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2398 return scm_from_latin1_symbol ("substitute");
2399 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2400 return scm_from_latin1_symbol ("escape");
2404 /* Never gets here. */
2405 return SCM_UNDEFINED
;
2409 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2411 (SCM port
, SCM sym
),
2412 "Sets the behavior of the interpreter when outputting a character\n"
2413 "that is not representable in the port's current encoding.\n"
2414 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2415 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2416 "when an unconvertible character is encountered. If it is\n"
2417 "@code{'substitute}, then unconvertible characters will \n"
2418 "be replaced with approximate characters, or with question marks\n"
2419 "if no approximately correct character is available.\n"
2420 "If it is @code{'escape},\n"
2421 "it will appear as a hex escape when output.\n"
2423 "If @var{port} is an open port, the conversion error behavior\n"
2424 "is set for that port. If it is @code{#f}, it is set as the\n"
2425 "default behavior for any future ports that get created in\n"
2427 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2433 if (!scm_is_false (port
))
2435 SCM_VALIDATE_OPPORT (1, port
);
2438 err
= scm_from_latin1_symbol ("error");
2439 if (scm_is_true (scm_eqv_p (sym
, err
)))
2441 scm_i_set_conversion_strategy_x (port
, SCM_FAILED_CONVERSION_ERROR
);
2442 return SCM_UNSPECIFIED
;
2445 qm
= scm_from_latin1_symbol ("substitute");
2446 if (scm_is_true (scm_eqv_p (sym
, qm
)))
2448 scm_i_set_conversion_strategy_x (port
,
2449 SCM_FAILED_CONVERSION_QUESTION_MARK
);
2450 return SCM_UNSPECIFIED
;
2453 esc
= scm_from_latin1_symbol ("escape");
2454 if (scm_is_true (scm_eqv_p (sym
, esc
)))
2456 scm_i_set_conversion_strategy_x (port
,
2457 SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
);
2458 return SCM_UNSPECIFIED
;
2461 SCM_MISC_ERROR ("unknown conversion behavior ~s", scm_list_1 (sym
));
2463 return SCM_UNSPECIFIED
;
2470 scm_print_port_mode (SCM exp
, SCM port
)
2472 scm_puts (SCM_CLOSEDP (exp
)
2474 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2475 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2478 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2485 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2487 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2490 scm_puts ("#<", port
);
2491 scm_print_port_mode (exp
, port
);
2492 scm_puts (type
, port
);
2493 scm_putc (' ', port
);
2494 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2495 scm_putc ('>', port
);
2503 scm_t_bits scm_tc16_void_port
= 0;
2505 static int fill_input_void_port (SCM port SCM_UNUSED
)
2511 write_void_port (SCM port SCM_UNUSED
,
2512 const void *data SCM_UNUSED
,
2513 size_t size SCM_UNUSED
)
2518 scm_i_void_port (long mode_bits
)
2520 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
2522 SCM answer
= scm_new_port_table_entry (scm_tc16_void_port
);
2523 scm_t_port
* pt
= SCM_PTAB_ENTRY(answer
);
2525 scm_port_non_buffer (pt
);
2527 SCM_SETSTREAM (answer
, 0);
2528 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
2529 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
2535 scm_void_port (char *mode_str
)
2537 return scm_i_void_port (scm_mode_bits (mode_str
));
2540 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2542 "Create and return a new void port. A void port acts like\n"
2543 "@file{/dev/null}. The @var{mode} argument\n"
2544 "specifies the input/output modes for this port: see the\n"
2545 "documentation for @code{open-file} in @ref{File Ports}.")
2546 #define FUNC_NAME s_scm_sys_make_void_port
2548 return scm_i_void_port (scm_i_mode_bits (mode
));
2553 /* Initialization. */
2558 /* lseek() symbols. */
2559 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2560 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2561 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2563 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2566 cur_inport_fluid
= scm_make_fluid ();
2567 cur_outport_fluid
= scm_make_fluid ();
2568 cur_errport_fluid
= scm_make_fluid ();
2569 cur_loadport_fluid
= scm_make_fluid ();
2571 scm_i_port_weak_hash
= scm_make_weak_key_hash_table (SCM_I_MAKINUM(31));
2573 #include "libguile/ports.x"
2575 /* Use Latin-1 as the default port encoding. */
2576 SCM_VARIABLE_SET (default_port_encoding_var
,
2577 scm_make_fluid_with_default (SCM_BOOL_F
));
2578 scm_port_encoding_init
= 1;
2580 SCM_VARIABLE_SET (scm_conversion_strategy
,
2581 scm_make_fluid_with_default
2582 (scm_from_int ((int) SCM_FAILED_CONVERSION_QUESTION_MARK
)));
2583 scm_conversion_strategy_init
= 1;