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_UNDEFINED
;
422 static scm_i_pthread_mutex_t cwp_var_mutex
423 = SCM_I_PTHREAD_MUTEX_INITIALIZER
;
425 scm_i_scm_pthread_mutex_lock (&cwp_var_mutex
);
426 if (SCM_UNBNDP (cwp_var
))
427 cwp_var
= scm_c_private_variable ("guile", "current-warning-port");
428 scm_i_pthread_mutex_unlock (&cwp_var_mutex
);
430 return scm_call_0 (scm_variable_ref (cwp_var
));
433 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
435 "Return the current-load-port.\n"
436 "The load port is used internally by @code{primitive-load}.")
437 #define FUNC_NAME s_scm_current_load_port
439 return scm_fluid_ref (cur_loadport_fluid
);
443 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
445 "@deffnx {Scheme Procedure} set-current-output-port port\n"
446 "@deffnx {Scheme Procedure} set-current-error-port port\n"
447 "Change the ports returned by @code{current-input-port},\n"
448 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
449 "so that they use the supplied @var{port} for input or output.")
450 #define FUNC_NAME s_scm_set_current_input_port
452 SCM oinp
= scm_fluid_ref (cur_inport_fluid
);
453 SCM_VALIDATE_OPINPORT (1, port
);
454 scm_fluid_set_x (cur_inport_fluid
, port
);
460 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
462 "Set the current default output port to @var{port}.")
463 #define FUNC_NAME s_scm_set_current_output_port
465 SCM ooutp
= scm_fluid_ref (cur_outport_fluid
);
466 port
= SCM_COERCE_OUTPORT (port
);
467 SCM_VALIDATE_OPOUTPORT (1, port
);
468 scm_fluid_set_x (cur_outport_fluid
, port
);
474 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
476 "Set the current default error port to @var{port}.")
477 #define FUNC_NAME s_scm_set_current_error_port
479 SCM oerrp
= scm_fluid_ref (cur_errport_fluid
);
480 port
= SCM_COERCE_OUTPORT (port
);
481 SCM_VALIDATE_OPOUTPORT (1, port
);
482 scm_fluid_set_x (cur_errport_fluid
, port
);
489 scm_set_current_warning_port (SCM port
)
491 static SCM cwp_var
= SCM_BOOL_F
;
493 if (scm_is_false (cwp_var
))
494 cwp_var
= scm_c_private_lookup ("guile", "current-warning-port");
496 return scm_call_1 (scm_variable_ref (cwp_var
), port
);
501 scm_dynwind_current_input_port (SCM port
)
502 #define FUNC_NAME NULL
504 SCM_VALIDATE_OPINPORT (1, port
);
505 scm_dynwind_fluid (cur_inport_fluid
, port
);
510 scm_dynwind_current_output_port (SCM port
)
511 #define FUNC_NAME NULL
513 port
= SCM_COERCE_OUTPORT (port
);
514 SCM_VALIDATE_OPOUTPORT (1, port
);
515 scm_dynwind_fluid (cur_outport_fluid
, port
);
520 scm_dynwind_current_error_port (SCM port
)
521 #define FUNC_NAME NULL
523 port
= SCM_COERCE_OUTPORT (port
);
524 SCM_VALIDATE_OPOUTPORT (1, port
);
525 scm_dynwind_fluid (cur_errport_fluid
, port
);
530 scm_i_dynwind_current_load_port (SCM port
)
532 scm_dynwind_fluid (cur_loadport_fluid
, port
);
536 /* The port table --- an array of pointers to ports. */
539 We need a global registry of ports to flush them all at exit, and to
540 get all the ports matching a file descriptor. The associated values
541 are alists, where additional information can be associated with ports.
543 SCM scm_i_port_weak_hash
;
545 scm_i_pthread_mutex_t scm_i_port_table_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
548 /* Port finalization. */
551 static void finalize_port (void *, void *);
553 /* Register a finalizer for PORT. */
554 static SCM_C_INLINE_KEYWORD
void
555 register_finalizer_for_port (SCM port
)
557 /* Register a finalizer for PORT so that its iconv CDs get freed and
558 optionally its type's `free' function gets called. */
559 scm_i_set_finalizer (SCM2PTR (port
), finalize_port
, NULL
);
562 /* Finalize the object (a port) pointed to by PTR. */
564 finalize_port (void *ptr
, void *data
)
567 SCM port
= PTR2SCM (ptr
);
569 if (!SCM_PORTP (port
))
572 if (SCM_OPENP (port
))
574 if (SCM_REVEALED (port
) > 0)
575 /* Keep "revealed" ports alive and re-register a finalizer. */
576 register_finalizer_for_port (port
);
581 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
582 if (port_type
>= scm_numptob
)
585 if (scm_ptobs
[port_type
].free
)
586 /* Yes, I really do mean `.free' rather than `.close'. `.close'
587 is for explicit `close-port' by user. */
588 scm_ptobs
[port_type
].free (port
);
590 entry
= SCM_PTAB_ENTRY (port
);
592 if (entry
->input_cd
!= (iconv_t
) -1)
593 iconv_close (entry
->input_cd
);
594 if (entry
->output_cd
!= (iconv_t
) -1)
595 iconv_close (entry
->output_cd
);
597 SCM_SETSTREAM (port
, 0);
598 SCM_CLR_PORT_OPEN_FLAG (port
);
600 scm_gc_ports_collected
++;
609 /* This function is not and should not be thread safe. */
611 scm_new_port_table_entry (scm_t_bits tag
)
612 #define FUNC_NAME "scm_new_port_table_entry"
615 We initialize the cell to empty, this is in case scm_gc_calloc
616 triggers GC ; we don't want the GC to scan a half-finished Z.
619 SCM z
= scm_cons (SCM_EOL
, SCM_EOL
);
620 scm_t_port
*entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
623 entry
->file_name
= SCM_BOOL_F
;
624 entry
->rw_active
= SCM_PORT_NEITHER
;
627 /* Initialize this port with the thread's current default
629 enc
= scm_i_default_port_encoding ();
630 entry
->encoding
= enc
? scm_gc_strdup (enc
, "port") : NULL
;
632 /* The conversion descriptors will be opened lazily. */
633 entry
->input_cd
= (iconv_t
) -1;
634 entry
->output_cd
= (iconv_t
) -1;
636 entry
->ilseq_handler
= scm_i_default_port_conversion_handler ();
638 SCM_SET_CELL_TYPE (z
, tag
);
639 SCM_SETPTAB_ENTRY (z
, entry
);
641 scm_hashq_set_x (scm_i_port_weak_hash
, z
, SCM_EOL
);
643 /* For each new port, register a finalizer so that it port type's free
644 function can be invoked eventually. */
645 register_finalizer_for_port (z
);
651 #if SCM_ENABLE_DEPRECATED==1
653 scm_add_to_port_table (SCM port
)
658 scm_c_issue_deprecation_warning ("scm_add_to_port_table is deprecated.");
660 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
661 z
= scm_new_port_table_entry (scm_tc7_port
);
662 pt
= SCM_PTAB_ENTRY(z
);
664 SCM_SETCAR (z
, SCM_EOL
);
665 SCM_SETCDR (z
, SCM_EOL
);
666 SCM_SETPTAB_ENTRY (port
, pt
);
667 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
674 /* Remove a port from the table and destroy it. */
677 scm_i_remove_port (SCM port
)
678 #define FUNC_NAME "scm_remove_port"
682 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
684 p
= SCM_PTAB_ENTRY (port
);
685 scm_port_non_buffer (p
);
686 p
->putback_buf
= NULL
;
687 p
->putback_buf_size
= 0;
689 if (p
->input_cd
!= (iconv_t
) -1)
691 iconv_close (p
->input_cd
);
692 p
->input_cd
= (iconv_t
) -1;
695 if (p
->output_cd
!= (iconv_t
) -1)
697 iconv_close (p
->output_cd
);
698 p
->output_cd
= (iconv_t
) -1;
701 SCM_SETPTAB_ENTRY (port
, 0);
703 scm_hashq_remove_x (scm_i_port_weak_hash
, port
);
705 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
710 /* Functions for debugging. */
712 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
714 "Return the number of ports in the port table. @code{pt-size}\n"
715 "is only included in @code{--enable-guile-debug} builds.")
716 #define FUNC_NAME s_scm_pt_size
718 return scm_from_int (SCM_HASHTABLE_N_ITEMS (scm_i_port_weak_hash
));
724 scm_port_non_buffer (scm_t_port
*pt
)
726 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
727 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
728 pt
->read_buf_size
= pt
->write_buf_size
= 1;
729 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
733 /* Revealed counts --- an oddity inherited from SCSH. */
735 /* Find a port in the table and return its revealed count.
736 Also used by the garbage collector.
740 scm_revealed_count (SCM port
)
742 return SCM_REVEALED(port
);
747 /* Return the revealed count for a port. */
749 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
751 "Return the revealed count for @var{port}.")
752 #define FUNC_NAME s_scm_port_revealed
754 port
= SCM_COERCE_OUTPORT (port
);
755 SCM_VALIDATE_OPENPORT (1, port
);
756 return scm_from_int (scm_revealed_count (port
));
760 /* Set the revealed count for a port. */
761 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
762 (SCM port
, SCM rcount
),
763 "Sets the revealed count for a port to a given value.\n"
764 "The return value is unspecified.")
765 #define FUNC_NAME s_scm_set_port_revealed_x
767 port
= SCM_COERCE_OUTPORT (port
);
768 SCM_VALIDATE_OPENPORT (1, port
);
769 SCM_REVEALED (port
) = scm_to_int (rcount
);
770 return SCM_UNSPECIFIED
;
776 /* Retrieving a port's mode. */
778 /* Return the flags that characterize a port based on the mode
779 * string used to open a file for that port.
781 * See PORT FLAGS in scm.h
785 scm_i_mode_bits_n (SCM modes
)
788 | (scm_i_string_contains_char (modes
, 'r')
789 || scm_i_string_contains_char (modes
, '+') ? SCM_RDNG
: 0)
790 | (scm_i_string_contains_char (modes
, 'w')
791 || scm_i_string_contains_char (modes
, 'a')
792 || scm_i_string_contains_char (modes
, '+') ? SCM_WRTNG
: 0)
793 | (scm_i_string_contains_char (modes
, '0') ? SCM_BUF0
: 0)
794 | (scm_i_string_contains_char (modes
, 'l') ? SCM_BUFLINE
: 0));
798 scm_mode_bits (char *modes
)
800 return scm_i_mode_bits (scm_from_locale_string (modes
));
804 scm_i_mode_bits (SCM modes
)
808 if (!scm_is_string (modes
))
809 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
811 bits
= scm_i_mode_bits_n (modes
);
812 scm_remember_upto_here_1 (modes
);
816 /* Return the mode flags from an open port.
817 * Some modes such as "append" are only used when opening
818 * a file and are not returned here. */
820 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
822 "Return the port modes associated with the open port @var{port}.\n"
823 "These will not necessarily be identical to the modes used when\n"
824 "the port was opened, since modes such as \"append\" which are\n"
825 "used only during port creation are not retained.")
826 #define FUNC_NAME s_scm_port_mode
831 port
= SCM_COERCE_OUTPORT (port
);
832 SCM_VALIDATE_OPPORT (1, port
);
833 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
834 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
835 strcpy (modes
, "r+");
839 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
841 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
843 return scm_from_locale_string (modes
);
852 * Call the close operation on a port object.
853 * see also scm_close.
855 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
857 "Close the specified port object. Return @code{#t} if it\n"
858 "successfully closes a port or @code{#f} if it was already\n"
859 "closed. An exception may be raised if an error occurs, for\n"
860 "example when flushing buffered output. See also @ref{Ports and\n"
861 "File Descriptors, close}, for a procedure which can close file\n"
863 #define FUNC_NAME s_scm_close_port
868 port
= SCM_COERCE_OUTPORT (port
);
870 SCM_VALIDATE_PORT (1, port
);
871 if (SCM_CLOSEDP (port
))
873 i
= SCM_PTOBNUM (port
);
874 if (scm_ptobs
[i
].close
)
875 rv
= (scm_ptobs
[i
].close
) (port
);
878 scm_i_remove_port (port
);
879 SCM_CLR_PORT_OPEN_FLAG (port
);
880 return scm_from_bool (rv
>= 0);
884 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
886 "Close the specified input port object. The routine has no effect if\n"
887 "the file has already been closed. An exception may be raised if an\n"
888 "error occurs. The value returned is unspecified.\n\n"
889 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
890 "which can close file descriptors.")
891 #define FUNC_NAME s_scm_close_input_port
893 SCM_VALIDATE_INPUT_PORT (1, port
);
894 scm_close_port (port
);
895 return SCM_UNSPECIFIED
;
899 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
901 "Close the specified output port object. The routine has no effect if\n"
902 "the file has already been closed. An exception may be raised if an\n"
903 "error occurs. The value returned is unspecified.\n\n"
904 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
905 "which can close file descriptors.")
906 #define FUNC_NAME s_scm_close_output_port
908 port
= SCM_COERCE_OUTPORT (port
);
909 SCM_VALIDATE_OUTPUT_PORT (1, port
);
910 scm_close_port (port
);
911 return SCM_UNSPECIFIED
;
916 collect_keys (void *unused
, SCM key
, SCM value
, SCM result
)
918 return scm_cons (key
, result
);
922 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
926 /* Copy out the port table as a list so that we get strong references
927 to all the values. */
928 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
929 ports
= scm_internal_hash_fold (collect_keys
, NULL
,
930 SCM_EOL
, scm_i_port_weak_hash
);
931 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
933 for (; scm_is_pair (ports
); ports
= scm_cdr (ports
))
935 SCM p
= scm_car (ports
);
941 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
943 "Apply @var{proc} to each port in the Guile port table\n"
944 "in turn. The return value is unspecified. More specifically,\n"
945 "@var{proc} is applied exactly once to every port that exists\n"
946 "in the system at the time @code{port-for-each} is invoked.\n"
947 "Changes to the port table while @code{port-for-each} is running\n"
948 "have no effect as far as @code{port-for-each} is concerned.")
949 #define FUNC_NAME s_scm_port_for_each
953 SCM_VALIDATE_PROC (1, proc
);
955 /* Copy out the port table as a list so that we get strong references
956 to all the values. */
957 scm_i_pthread_mutex_lock (&scm_i_port_table_mutex
);
958 ports
= scm_internal_hash_fold (collect_keys
, NULL
,
959 SCM_EOL
, scm_i_port_weak_hash
);
960 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
962 for (; scm_is_pair (ports
); ports
= scm_cdr (ports
))
963 if (SCM_PORTP (SCM_CAR (ports
)))
964 scm_call_1 (proc
, SCM_CAR (ports
));
966 return SCM_UNSPECIFIED
;
972 /* Utter miscellany. Gosh, we should clean this up some time. */
974 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
976 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
977 "@code{#f}. Any object satisfying this predicate also satisfies\n"
979 #define FUNC_NAME s_scm_input_port_p
981 return scm_from_bool (SCM_INPUT_PORT_P (x
));
985 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
987 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
988 "@code{#f}. Any object satisfying this predicate also satisfies\n"
990 #define FUNC_NAME s_scm_output_port_p
992 x
= SCM_COERCE_OUTPORT (x
);
993 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
997 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
999 "Return a boolean indicating whether @var{x} is a port.\n"
1000 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
1002 #define FUNC_NAME s_scm_port_p
1004 return scm_from_bool (SCM_PORTP (x
));
1008 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
1010 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
1012 #define FUNC_NAME s_scm_port_closed_p
1014 SCM_VALIDATE_PORT (1, port
);
1015 return scm_from_bool (!SCM_OPPORTP (port
));
1019 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
1021 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
1022 "return @code{#f}.")
1023 #define FUNC_NAME s_scm_eof_object_p
1025 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
1029 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
1031 "Flush the specified output port, or the current output port if @var{port}\n"
1032 "is omitted. The current output buffer contents are passed to the\n"
1033 "underlying port implementation (e.g., in the case of fports, the\n"
1034 "data will be written to the file and the output buffer will be cleared.)\n"
1035 "It has no effect on an unbuffered port.\n\n"
1036 "The return value is unspecified.")
1037 #define FUNC_NAME s_scm_force_output
1039 if (SCM_UNBNDP (port
))
1040 port
= scm_current_output_port ();
1043 port
= SCM_COERCE_OUTPORT (port
);
1044 SCM_VALIDATE_OPOUTPORT (1, port
);
1047 return SCM_UNSPECIFIED
;
1053 flush_output_port (void *closure
, SCM port
)
1055 if (SCM_OPOUTPORTP (port
))
1059 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
1061 "Equivalent to calling @code{force-output} on\n"
1062 "all open output ports. The return value is unspecified.")
1063 #define FUNC_NAME s_scm_flush_all_ports
1065 scm_c_port_for_each (&flush_output_port
, NULL
);
1066 return SCM_UNSPECIFIED
;
1070 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1072 "Return the next character available from @var{port}, updating\n"
1073 "@var{port} to point to the following character. If no more\n"
1074 "characters are available, the end-of-file object is returned.\n"
1076 "When @var{port}'s data cannot be decoded according to its\n"
1077 "character encoding, a @code{decoding-error} is raised and\n"
1078 "@var{port} points past the erroneous byte sequence.\n")
1079 #define FUNC_NAME s_scm_read_char
1082 if (SCM_UNBNDP (port
))
1083 port
= scm_current_input_port ();
1084 SCM_VALIDATE_OPINPORT (1, port
);
1085 c
= scm_getc (port
);
1088 return SCM_MAKE_CHAR (c
);
1092 /* Update the line and column number of PORT after consumption of C. */
1094 update_port_lf (scm_t_wchar c
, SCM port
)
1119 #define SCM_MBCHAR_BUF_SIZE (4)
1121 /* Convert the SIZE-byte UTF-8 sequence in UTF8_BUF to a codepoint.
1122 UTF8_BUF is assumed to contain a valid UTF-8 sequence. */
1124 utf8_to_codepoint (const scm_t_uint8
*utf8_buf
, size_t size
)
1126 scm_t_wchar codepoint
;
1128 if (utf8_buf
[0] <= 0x7f)
1131 codepoint
= utf8_buf
[0];
1133 else if ((utf8_buf
[0] & 0xe0) == 0xc0)
1136 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x1f) << 6UL
1137 | (utf8_buf
[1] & 0x3f);
1139 else if ((utf8_buf
[0] & 0xf0) == 0xe0)
1142 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x0f) << 12UL
1143 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 6UL
1144 | (utf8_buf
[2] & 0x3f);
1149 codepoint
= ((scm_t_wchar
) utf8_buf
[0] & 0x07) << 18UL
1150 | ((scm_t_wchar
) utf8_buf
[1] & 0x3f) << 12UL
1151 | ((scm_t_wchar
) utf8_buf
[2] & 0x3f) << 6UL
1152 | (utf8_buf
[3] & 0x3f);
1158 /* Read a UTF-8 sequence from PORT. On success, return 0 and set
1159 *CODEPOINT to the codepoint that was read, fill BUF with its UTF-8
1160 representation, and set *LEN to the length in bytes. Return
1161 `EILSEQ' on error. */
1163 get_utf8_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1164 scm_t_uint8 buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1166 #define ASSERT_NOT_EOF(b) \
1167 if (SCM_UNLIKELY ((b) == EOF)) \
1169 #define CONSUME_PEEKED_BYTE() \
1176 pt
= SCM_PTAB_ENTRY (port
);
1178 byte
= scm_get_byte_or_eof (port
);
1185 buf
[0] = (scm_t_uint8
) byte
;
1190 *codepoint
= buf
[0];
1191 else if (buf
[0] >= 0xc2 && buf
[0] <= 0xdf)
1194 byte
= scm_peek_byte_or_eof (port
);
1195 ASSERT_NOT_EOF (byte
);
1197 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1200 CONSUME_PEEKED_BYTE ();
1201 buf
[1] = (scm_t_uint8
) byte
;
1204 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x1f) << 6UL
1207 else if ((buf
[0] & 0xf0) == 0xe0)
1210 byte
= scm_peek_byte_or_eof (port
);
1211 ASSERT_NOT_EOF (byte
);
1213 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80
1214 || (buf
[0] == 0xe0 && byte
< 0xa0)
1215 || (buf
[0] == 0xed && byte
> 0x9f)))
1218 CONSUME_PEEKED_BYTE ();
1219 buf
[1] = (scm_t_uint8
) byte
;
1222 byte
= scm_peek_byte_or_eof (port
);
1223 ASSERT_NOT_EOF (byte
);
1225 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1228 CONSUME_PEEKED_BYTE ();
1229 buf
[2] = (scm_t_uint8
) byte
;
1232 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x0f) << 12UL
1233 | ((scm_t_wchar
) buf
[1] & 0x3f) << 6UL
1236 else if (buf
[0] >= 0xf0 && buf
[0] <= 0xf4)
1239 byte
= scm_peek_byte_or_eof (port
);
1240 ASSERT_NOT_EOF (byte
);
1242 if (SCM_UNLIKELY (((byte
& 0xc0) != 0x80)
1243 || (buf
[0] == 0xf0 && byte
< 0x90)
1244 || (buf
[0] == 0xf4 && byte
> 0x8f)))
1247 CONSUME_PEEKED_BYTE ();
1248 buf
[1] = (scm_t_uint8
) byte
;
1251 byte
= scm_peek_byte_or_eof (port
);
1252 ASSERT_NOT_EOF (byte
);
1254 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1257 CONSUME_PEEKED_BYTE ();
1258 buf
[2] = (scm_t_uint8
) byte
;
1261 byte
= scm_peek_byte_or_eof (port
);
1262 ASSERT_NOT_EOF (byte
);
1264 if (SCM_UNLIKELY ((byte
& 0xc0) != 0x80))
1267 CONSUME_PEEKED_BYTE ();
1268 buf
[3] = (scm_t_uint8
) byte
;
1271 *codepoint
= ((scm_t_wchar
) buf
[0] & 0x07) << 18UL
1272 | ((scm_t_wchar
) buf
[1] & 0x3f) << 12UL
1273 | ((scm_t_wchar
) buf
[2] & 0x3f) << 6UL
1282 /* Here we could choose the consume the faulty byte when it's not a
1283 valid starting byte, but it's not a requirement. What Section 3.9
1284 of Unicode 6.0.0 mandates, though, is to not consume a byte that
1285 would otherwise be a valid starting byte. */
1289 #undef CONSUME_PEEKED_BYTE
1290 #undef ASSERT_NOT_EOF
1293 /* Likewise, read a byte sequence from PORT, passing it through its
1294 input conversion descriptor. */
1296 get_iconv_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1297 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1301 size_t bytes_consumed
, output_size
;
1303 scm_t_uint8 utf8_buf
[SCM_MBCHAR_BUF_SIZE
];
1305 pt
= SCM_PTAB_ENTRY (port
);
1307 for (output_size
= 0, output
= (char *) utf8_buf
,
1308 bytes_consumed
= 0, err
= 0;
1309 err
== 0 && output_size
== 0
1310 && (bytes_consumed
== 0 || byte_read
!= EOF
);
1314 size_t input_left
, output_left
, done
;
1316 byte_read
= scm_get_byte_or_eof (port
);
1317 if (byte_read
== EOF
)
1319 if (bytes_consumed
== 0)
1321 *codepoint
= (scm_t_wchar
) EOF
;
1329 buf
[bytes_consumed
] = byte_read
;
1332 input_left
= bytes_consumed
+ 1;
1333 output_left
= sizeof (utf8_buf
);
1335 done
= iconv (pt
->input_cd
, &input
, &input_left
,
1336 &output
, &output_left
);
1337 if (done
== (size_t) -1)
1341 /* Missing input: keep trying. */
1345 output_size
= sizeof (utf8_buf
) - output_left
;
1348 if (SCM_UNLIKELY (output_size
== 0))
1349 /* An unterminated sequence. */
1351 else if (SCM_LIKELY (err
== 0))
1353 /* Convert the UTF8_BUF sequence to a Unicode code point. */
1354 *codepoint
= utf8_to_codepoint (utf8_buf
, output_size
);
1355 *len
= bytes_consumed
;
1361 /* Read a codepoint from PORT and return it in *CODEPOINT. Fill BUF
1362 with the byte representation of the codepoint in PORT's encoding, and
1363 set *LEN to the length in bytes of that representation. Return 0 on
1364 success and an errno value on error. */
1366 get_codepoint (SCM port
, scm_t_wchar
*codepoint
,
1367 char buf
[SCM_MBCHAR_BUF_SIZE
], size_t *len
)
1370 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1372 if (pt
->input_cd
== (iconv_t
) -1)
1373 /* Initialize the conversion descriptors, if needed. */
1374 scm_i_set_port_encoding_x (port
, pt
->encoding
);
1376 /* FIXME: In 2.1, add a flag to determine whether a port is UTF-8. */
1377 if (pt
->input_cd
== (iconv_t
) -1)
1378 err
= get_utf8_codepoint (port
, codepoint
, (scm_t_uint8
*) buf
, len
);
1380 err
= get_iconv_codepoint (port
, codepoint
, buf
, len
);
1382 if (SCM_LIKELY (err
== 0))
1383 update_port_lf (*codepoint
, port
);
1384 else if (pt
->ilseq_handler
== SCM_ICONVEH_QUESTION_MARK
)
1388 update_port_lf (*codepoint
, port
);
1394 /* Read a codepoint from PORT and return it. */
1397 #define FUNC_NAME "scm_getc"
1401 scm_t_wchar codepoint
;
1402 char buf
[SCM_MBCHAR_BUF_SIZE
];
1404 err
= get_codepoint (port
, &codepoint
, buf
, &len
);
1405 if (SCM_UNLIKELY (err
!= 0))
1406 /* At this point PORT should point past the invalid encoding, as per
1407 R6RS-lib Section 8.2.4. */
1408 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1414 /* this should only be called when the read buffer is empty. it
1415 tries to refill the read buffer. it returns the first char from
1416 the port, which is either EOF or *(pt->read_pos). */
1418 scm_fill_input (SCM port
)
1420 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1422 assert (pt
->read_pos
== pt
->read_end
);
1424 if (pt
->read_buf
== pt
->putback_buf
)
1426 /* finished reading put-back chars. */
1427 pt
->read_buf
= pt
->saved_read_buf
;
1428 pt
->read_pos
= pt
->saved_read_pos
;
1429 pt
->read_end
= pt
->saved_read_end
;
1430 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1431 if (pt
->read_pos
< pt
->read_end
)
1432 return *(pt
->read_pos
);
1434 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1440 * This function differs from scm_c_write; it updates port line and
1444 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1446 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1447 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1449 if (pt
->rw_active
== SCM_PORT_READ
)
1450 scm_end_input (port
);
1452 ptob
->write (port
, ptr
, size
);
1454 for (; size
; ptr
++, size
--)
1455 update_port_lf ((scm_t_wchar
) (unsigned char) *ptr
, port
);
1458 pt
->rw_active
= SCM_PORT_WRITE
;
1461 /* Write STR to PORT from START inclusive to END exclusive. */
1463 scm_lfwrite_substr (SCM str
, size_t start
, size_t end
, SCM port
)
1465 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1467 if (pt
->rw_active
== SCM_PORT_READ
)
1468 scm_end_input (port
);
1470 if (end
== (size_t) -1)
1471 end
= scm_i_string_length (str
);
1473 scm_i_display_substring (str
, start
, end
, port
);
1476 pt
->rw_active
= SCM_PORT_WRITE
;
1481 * Used by an application to read arbitrary number of bytes from an
1482 * SCM port. Same semantics as libc read, except that scm_c_read only
1483 * returns less than SIZE bytes if at end-of-file.
1485 * Warning: Doesn't update port line and column counts! */
1487 /* This structure, and the following swap_buffer function, are used
1488 for temporarily swapping a port's own read buffer, and the buffer
1489 that the caller of scm_c_read provides. */
1490 struct port_and_swap_buffer
1493 unsigned char *buffer
;
1498 swap_buffer (void *data
)
1500 struct port_and_swap_buffer
*psb
= (struct port_and_swap_buffer
*) data
;
1501 unsigned char *old_buf
= psb
->pt
->read_buf
;
1502 size_t old_size
= psb
->pt
->read_buf_size
;
1504 /* Make the port use (buffer, size) from the struct. */
1505 psb
->pt
->read_pos
= psb
->pt
->read_buf
= psb
->pt
->read_end
= psb
->buffer
;
1506 psb
->pt
->read_buf_size
= psb
->size
;
1508 /* Save the port's old (buffer, size) in the struct. */
1509 psb
->buffer
= old_buf
;
1510 psb
->size
= old_size
;
1514 scm_c_read (SCM port
, void *buffer
, size_t size
)
1515 #define FUNC_NAME "scm_c_read"
1518 size_t n_read
= 0, n_available
;
1519 struct port_and_swap_buffer psb
;
1521 SCM_VALIDATE_OPINPORT (1, port
);
1523 pt
= SCM_PTAB_ENTRY (port
);
1524 if (pt
->rw_active
== SCM_PORT_WRITE
)
1525 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1528 pt
->rw_active
= SCM_PORT_READ
;
1530 /* Take bytes first from the port's read buffer. */
1531 if (pt
->read_pos
< pt
->read_end
)
1533 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1534 memcpy (buffer
, pt
->read_pos
, n_available
);
1535 buffer
= (char *) buffer
+ n_available
;
1536 pt
->read_pos
+= n_available
;
1537 n_read
+= n_available
;
1538 size
-= n_available
;
1541 /* Avoid the scm_dynwind_* costs if we now have enough data. */
1545 /* Now we will call scm_fill_input repeatedly until we have read the
1546 requested number of bytes. (Note that a single scm_fill_input
1547 call does not guarantee to fill the whole of the port's read
1549 if (pt
->read_buf_size
<= 1 && pt
->encoding
== NULL
)
1551 /* The port that we are reading from is unbuffered - i.e. does
1552 not have its own persistent buffer - but we have a buffer,
1553 provided by our caller, that is the right size for the data
1554 that is wanted. For the following scm_fill_input calls,
1555 therefore, we use the buffer in hand as the port's read
1558 We need to make sure that the port's normal (1 byte) buffer
1559 is reinstated in case one of the scm_fill_input () calls
1560 throws an exception; we use the scm_dynwind_* API to achieve
1563 A consequence of this optimization is that the fill_input
1564 functions can't unget characters. That'll push data to the
1565 pushback buffer instead of this psb buffer. */
1567 unsigned char *pback
= pt
->putback_buf
;
1570 psb
.buffer
= buffer
;
1572 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
1573 scm_dynwind_rewind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1574 scm_dynwind_unwind_handler (swap_buffer
, &psb
, SCM_F_WIND_EXPLICITLY
);
1576 /* Call scm_fill_input until we have all the bytes that we need,
1578 while (pt
->read_buf_size
&& (scm_fill_input (port
) != EOF
))
1580 pt
->read_buf_size
-= (pt
->read_end
- pt
->read_pos
);
1581 pt
->read_pos
= pt
->read_buf
= pt
->read_end
;
1584 if (pback
!= pt
->putback_buf
1585 || pt
->read_buf
- (unsigned char *) buffer
< 0)
1586 scm_misc_error (FUNC_NAME
,
1587 "scm_c_read must not call a fill function that pushes "
1588 "back characters onto an unbuffered port", SCM_EOL
);
1590 n_read
+= pt
->read_buf
- (unsigned char *) buffer
;
1592 /* Reinstate the port's normal buffer. */
1597 /* The port has its own buffer. It is important that we use it,
1598 even if it happens to be smaller than our caller's buffer, so
1599 that a custom port implementation's entry points (in
1600 particular, fill_input) can rely on the buffer always being
1601 the same as they first set up. */
1602 while (size
&& (scm_fill_input (port
) != EOF
))
1604 n_available
= min (size
, pt
->read_end
- pt
->read_pos
);
1605 memcpy (buffer
, pt
->read_pos
, n_available
);
1606 buffer
= (char *) buffer
+ n_available
;
1607 pt
->read_pos
+= n_available
;
1608 n_read
+= n_available
;
1609 size
-= n_available
;
1619 * Used by an application to write arbitrary number of bytes to an SCM
1620 * port. Similar semantics as libc write. However, unlike libc
1621 * write, scm_c_write writes the requested number of bytes and has no
1624 * Warning: Doesn't update port line and column counts!
1628 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1629 #define FUNC_NAME "scm_c_write"
1632 scm_t_ptob_descriptor
*ptob
;
1634 SCM_VALIDATE_OPOUTPORT (1, port
);
1636 pt
= SCM_PTAB_ENTRY (port
);
1637 ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1639 if (pt
->rw_active
== SCM_PORT_READ
)
1640 scm_end_input (port
);
1642 ptob
->write (port
, ptr
, size
);
1645 pt
->rw_active
= SCM_PORT_WRITE
;
1650 scm_flush (SCM port
)
1652 long i
= SCM_PTOBNUM (port
);
1654 (scm_ptobs
[i
].flush
) (port
);
1658 scm_end_input (SCM port
)
1661 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1663 if (pt
->read_buf
== pt
->putback_buf
)
1665 offset
= pt
->read_end
- pt
->read_pos
;
1666 pt
->read_buf
= pt
->saved_read_buf
;
1667 pt
->read_pos
= pt
->saved_read_pos
;
1668 pt
->read_end
= pt
->saved_read_end
;
1669 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1674 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1681 scm_unget_byte (int c
, SCM port
)
1682 #define FUNC_NAME "scm_unget_byte"
1684 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1686 if (pt
->read_buf
== pt
->putback_buf
)
1687 /* already using the put-back buffer. */
1689 /* enlarge putback_buf if necessary. */
1690 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1691 && pt
->read_buf
== pt
->read_pos
)
1693 size_t new_size
= pt
->read_buf_size
* 2;
1694 unsigned char *tmp
= (unsigned char *)
1695 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1698 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1699 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1700 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1703 /* shift any existing bytes to buffer + 1. */
1704 if (pt
->read_pos
== pt
->read_end
)
1705 pt
->read_end
= pt
->read_buf
+ 1;
1706 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1708 int count
= pt
->read_end
- pt
->read_pos
;
1710 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1711 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1714 pt
->read_pos
= pt
->read_buf
;
1717 /* switch to the put-back buffer. */
1719 if (pt
->putback_buf
== NULL
)
1722 = (unsigned char *) scm_gc_malloc_pointerless
1723 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1724 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1727 pt
->saved_read_buf
= pt
->read_buf
;
1728 pt
->saved_read_pos
= pt
->read_pos
;
1729 pt
->saved_read_end
= pt
->read_end
;
1730 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1732 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1733 pt
->read_end
= pt
->read_buf
+ 1;
1734 pt
->read_buf_size
= pt
->putback_buf_size
;
1740 pt
->rw_active
= SCM_PORT_READ
;
1745 scm_ungetc (scm_t_wchar c
, SCM port
)
1746 #define FUNC_NAME "scm_ungetc"
1748 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1750 char result_buf
[10];
1751 const char *encoding
;
1755 if (pt
->encoding
!= NULL
)
1756 encoding
= pt
->encoding
;
1758 encoding
= "ISO-8859-1";
1760 len
= sizeof (result_buf
);
1761 result
= u32_conv_to_encoding (encoding
,
1762 (enum iconv_ilseq_handler
) pt
->ilseq_handler
,
1763 (uint32_t *) &c
, 1, NULL
,
1766 if (SCM_UNLIKELY (result
== NULL
|| len
== 0))
1767 scm_encoding_error (FUNC_NAME
, errno
,
1768 "conversion to port encoding failed",
1769 SCM_BOOL_F
, SCM_MAKE_CHAR (c
));
1771 for (i
= len
- 1; i
>= 0; i
--)
1772 scm_unget_byte (result
[i
], port
);
1774 if (SCM_UNLIKELY (result
!= result_buf
))
1779 /* What should col be in this case?
1780 * We'll leave it at -1.
1782 SCM_LINUM (port
) -= 1;
1791 scm_ungets (const char *s
, int n
, SCM port
)
1793 /* This is simple minded and inefficient, but unreading strings is
1794 * probably not a common operation, and remember that line and
1795 * column numbers have to be handled...
1797 * Please feel free to write an optimized version!
1800 scm_ungetc (s
[n
], port
);
1804 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1806 "Return the next character available from @var{port},\n"
1807 "@emph{without} updating @var{port} to point to the following\n"
1808 "character. If no more characters are available, the\n"
1809 "end-of-file object is returned.\n"
1811 "The value returned by\n"
1812 "a call to @code{peek-char} is the same as the value that would\n"
1813 "have been returned by a call to @code{read-char} on the same\n"
1814 "port. The only difference is that the very next call to\n"
1815 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1816 "return the value returned by the preceding call to\n"
1817 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1818 "an interactive port will hang waiting for input whenever a call\n"
1819 "to @code{read-char} would have hung.\n"
1821 "As for @code{read-char}, a @code{decoding-error} may be raised\n"
1822 "if such a situation occurs. However, unlike with @code{read-char},\n"
1823 "@var{port} still points at the beginning of the erroneous byte\n"
1824 "sequence when the error is raised.\n")
1825 #define FUNC_NAME s_scm_peek_char
1830 char bytes
[SCM_MBCHAR_BUF_SIZE
];
1831 long column
, line
, i
;
1834 if (SCM_UNBNDP (port
))
1835 port
= scm_current_input_port ();
1836 SCM_VALIDATE_OPINPORT (1, port
);
1838 column
= SCM_COL (port
);
1839 line
= SCM_LINUM (port
);
1841 err
= get_codepoint (port
, &c
, bytes
, &len
);
1843 for (i
= len
- 1; i
>= 0; i
--)
1844 scm_unget_byte (bytes
[i
], port
);
1846 SCM_COL (port
) = column
;
1847 SCM_LINUM (port
) = line
;
1849 if (SCM_UNLIKELY (err
!= 0))
1851 scm_decoding_error (FUNC_NAME
, err
, "input decoding error", port
);
1853 /* Shouldn't happen since `catch' always aborts to prompt. */
1854 result
= SCM_BOOL_F
;
1857 result
= SCM_EOF_VAL
;
1859 result
= SCM_MAKE_CHAR (c
);
1865 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1866 (SCM cobj
, SCM port
),
1867 "Place character @var{cobj} in @var{port} so that it will be\n"
1868 "read by the next read operation. If called multiple times, the\n"
1869 "unread characters will be read again in last-in first-out\n"
1870 "order. If @var{port} is not supplied, the current input port\n"
1872 #define FUNC_NAME s_scm_unread_char
1876 SCM_VALIDATE_CHAR (1, cobj
);
1877 if (SCM_UNBNDP (port
))
1878 port
= scm_current_input_port ();
1879 SCM_VALIDATE_OPINPORT (2, port
);
1881 c
= SCM_CHAR (cobj
);
1883 scm_ungetc (c
, port
);
1888 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1889 (SCM str
, SCM port
),
1890 "Place the string @var{str} in @var{port} so that its characters will be\n"
1891 "read in subsequent read operations. If called multiple times, the\n"
1892 "unread characters will be read again in last-in first-out order. If\n"
1893 "@var{port} is not supplied, the current-input-port is used.")
1894 #define FUNC_NAME s_scm_unread_string
1897 SCM_VALIDATE_STRING (1, str
);
1898 if (SCM_UNBNDP (port
))
1899 port
= scm_current_input_port ();
1900 SCM_VALIDATE_OPINPORT (2, port
);
1902 n
= scm_i_string_length (str
);
1905 scm_ungetc (scm_i_string_ref (str
, n
), port
);
1911 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1912 (SCM fd_port
, SCM offset
, SCM whence
),
1913 "Sets the current position of @var{fd_port} to the integer\n"
1914 "@var{offset}, which is interpreted according to the value of\n"
1917 "One of the following variables should be supplied for\n"
1919 "@defvar SEEK_SET\n"
1920 "Seek from the beginning of the file.\n"
1922 "@defvar SEEK_CUR\n"
1923 "Seek from the current position.\n"
1925 "@defvar SEEK_END\n"
1926 "Seek from the end of the file.\n"
1928 "If @var{fd_port} is a file descriptor, the underlying system\n"
1929 "call is @code{lseek}. @var{port} may be a string port.\n"
1931 "The value returned is the new position in the file. This means\n"
1932 "that the current position of a port can be obtained using:\n"
1934 "(seek port 0 SEEK_CUR)\n"
1936 #define FUNC_NAME s_scm_seek
1940 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1942 how
= scm_to_int (whence
);
1943 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1944 SCM_OUT_OF_RANGE (3, whence
);
1946 if (SCM_OPPORTP (fd_port
))
1948 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1949 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1950 off_t_or_off64_t rv
;
1953 SCM_MISC_ERROR ("port is not seekable",
1954 scm_cons (fd_port
, SCM_EOL
));
1956 rv
= ptob
->seek (fd_port
, off
, how
);
1957 return scm_from_off_t_or_off64_t (rv
);
1959 else /* file descriptor?. */
1961 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1962 off_t_or_off64_t rv
;
1963 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1966 return scm_from_off_t_or_off64_t (rv
);
1975 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1976 doesn't have the filename version truncate(), hence this code. */
1977 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1979 truncate (const char *file
, off_t length
)
1983 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1987 ret
= ftruncate (fdes
, length
);
1990 int save_errno
= errno
;
1996 return close (fdes
);
1998 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
2000 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
2001 (SCM object
, SCM length
),
2002 "Truncate file @var{object} to @var{length} bytes. @var{object}\n"
2003 "can be a filename string, a port object, or an integer file\n"
2005 "The return value is unspecified.\n"
2007 "For a port or file descriptor @var{length} can be omitted, in\n"
2008 "which case the file is truncated at the current position (per\n"
2009 "@code{ftell} above).\n"
2011 "On most systems a file can be extended by giving a length\n"
2012 "greater than the current size, but this is not mandatory in the\n"
2014 #define FUNC_NAME s_scm_truncate_file
2018 /* "object" can be a port, fdes or filename.
2020 Negative "length" makes no sense, but it's left to truncate() or
2021 ftruncate() to give back an error for that (normally EINVAL).
2024 if (SCM_UNBNDP (length
))
2026 /* must supply length if object is a filename. */
2027 if (scm_is_string (object
))
2028 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
2030 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
2033 object
= SCM_COERCE_OUTPORT (object
);
2034 if (scm_is_integer (object
))
2036 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2037 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
2040 else if (SCM_OPOUTPORTP (object
))
2042 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2043 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
2044 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
2046 if (!ptob
->truncate
)
2047 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
2048 if (pt
->rw_active
== SCM_PORT_READ
)
2049 scm_end_input (object
);
2050 else if (pt
->rw_active
== SCM_PORT_WRITE
)
2051 ptob
->flush (object
);
2053 ptob
->truncate (object
, c_length
);
2058 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
2059 char *str
= scm_to_locale_string (object
);
2061 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
2068 return SCM_UNSPECIFIED
;
2072 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
2074 "Return the current line number for @var{port}.\n"
2076 "The first line of a file is 0. But you might want to add 1\n"
2077 "when printing line numbers, since starting from 1 is\n"
2078 "traditional in error messages, and likely to be more natural to\n"
2080 #define FUNC_NAME s_scm_port_line
2082 port
= SCM_COERCE_OUTPORT (port
);
2083 SCM_VALIDATE_OPENPORT (1, port
);
2084 return scm_from_long (SCM_LINUM (port
));
2088 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
2089 (SCM port
, SCM line
),
2090 "Set the current line number for @var{port} to @var{line}. The\n"
2091 "first line of a file is 0.")
2092 #define FUNC_NAME s_scm_set_port_line_x
2094 port
= SCM_COERCE_OUTPORT (port
);
2095 SCM_VALIDATE_OPENPORT (1, port
);
2096 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
2097 return SCM_UNSPECIFIED
;
2101 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
2103 "Return the current column number of @var{port}.\n"
2104 "If the number is\n"
2105 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
2106 "- i.e. the first character of the first line is line 0, column 0.\n"
2107 "(However, when you display a file position, for example in an error\n"
2108 "message, we recommend you add 1 to get 1-origin integers. This is\n"
2109 "because lines and column numbers traditionally start with 1, and that is\n"
2110 "what non-programmers will find most natural.)")
2111 #define FUNC_NAME s_scm_port_column
2113 port
= SCM_COERCE_OUTPORT (port
);
2114 SCM_VALIDATE_OPENPORT (1, port
);
2115 return scm_from_int (SCM_COL (port
));
2119 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
2120 (SCM port
, SCM column
),
2121 "Set the current column of @var{port}. Before reading the first\n"
2122 "character on a line the column should be 0.")
2123 #define FUNC_NAME s_scm_set_port_column_x
2125 port
= SCM_COERCE_OUTPORT (port
);
2126 SCM_VALIDATE_OPENPORT (1, port
);
2127 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
2128 return SCM_UNSPECIFIED
;
2132 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
2134 "Return the filename associated with @var{port}, or @code{#f}\n"
2135 "if no filename is associated with the port.")
2136 #define FUNC_NAME s_scm_port_filename
2138 port
= SCM_COERCE_OUTPORT (port
);
2139 SCM_VALIDATE_OPENPORT (1, port
);
2140 return SCM_FILENAME (port
);
2144 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
2145 (SCM port
, SCM filename
),
2146 "Change the filename associated with @var{port}, using the current input\n"
2147 "port if none is specified. Note that this does not change the port's\n"
2148 "source of data, but only the value that is returned by\n"
2149 "@code{port-filename} and reported in diagnostic output.")
2150 #define FUNC_NAME s_scm_set_port_filename_x
2152 port
= SCM_COERCE_OUTPORT (port
);
2153 SCM_VALIDATE_OPENPORT (1, port
);
2154 /* We allow the user to set the filename to whatever he likes. */
2155 SCM_SET_FILENAME (port
, filename
);
2156 return SCM_UNSPECIFIED
;
2160 /* A fluid specifying the default encoding for newly created ports. If it is
2161 a string, that is the encoding. If it is #f, it is in the "native"
2162 (Latin-1) encoding. */
2163 SCM_VARIABLE (default_port_encoding_var
, "%default-port-encoding");
2165 static int scm_port_encoding_init
= 0;
2167 /* Use ENCODING as the default encoding for future ports. */
2169 scm_i_set_default_port_encoding (const char *encoding
)
2171 if (!scm_port_encoding_init
2172 || !scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2173 scm_misc_error (NULL
, "tried to set port encoding fluid before it is initialized",
2176 if (encoding
== NULL
2177 || !strcmp (encoding
, "ASCII")
2178 || !strcmp (encoding
, "ANSI_X3.4-1968")
2179 || !strcmp (encoding
, "ISO-8859-1"))
2180 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
), SCM_BOOL_F
);
2182 scm_fluid_set_x (SCM_VARIABLE_REF (default_port_encoding_var
),
2183 scm_from_locale_string (encoding
));
2186 /* Return the name of the default encoding for newly created ports; a
2187 return value of NULL means "ISO-8859-1". */
2189 scm_i_default_port_encoding (void)
2191 if (!scm_port_encoding_init
)
2193 else if (!scm_is_fluid (SCM_VARIABLE_REF (default_port_encoding_var
)))
2199 encoding
= scm_fluid_ref (SCM_VARIABLE_REF (default_port_encoding_var
));
2200 if (!scm_is_string (encoding
))
2203 return scm_i_string_chars (encoding
);
2208 scm_i_set_port_encoding_x (SCM port
, const char *encoding
)
2211 iconv_t new_input_cd
, new_output_cd
;
2213 new_input_cd
= (iconv_t
) -1;
2214 new_output_cd
= (iconv_t
) -1;
2216 /* Set the character encoding for this port. */
2217 pt
= SCM_PTAB_ENTRY (port
);
2219 if (encoding
== NULL
)
2220 encoding
= "ISO-8859-1";
2222 if (pt
->encoding
!= encoding
)
2223 pt
->encoding
= scm_gc_strdup (encoding
, "port");
2225 /* If ENCODING is UTF-8, then no conversion descriptor is opened
2226 because we do I/O ourselves. This saves 100+ KiB for each
2228 if (strcmp (encoding
, "UTF-8"))
2230 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
)
2232 /* Open an input iconv conversion descriptor, from ENCODING
2233 to UTF-8. We choose UTF-8, not UTF-32, because iconv
2234 implementations can typically convert from anything to
2235 UTF-8, but not to UTF-32 (see
2236 <http://lists.gnu.org/archive/html/bug-libunistring/2010-09/msg00007.html>). */
2237 new_input_cd
= iconv_open ("UTF-8", encoding
);
2238 if (new_input_cd
== (iconv_t
) -1)
2239 goto invalid_encoding
;
2242 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
2244 new_output_cd
= iconv_open (encoding
, "UTF-8");
2245 if (new_output_cd
== (iconv_t
) -1)
2247 if (new_input_cd
!= (iconv_t
) -1)
2248 iconv_close (new_input_cd
);
2249 goto invalid_encoding
;
2254 if (pt
->input_cd
!= (iconv_t
) -1)
2255 iconv_close (pt
->input_cd
);
2256 if (pt
->output_cd
!= (iconv_t
) -1)
2257 iconv_close (pt
->output_cd
);
2259 pt
->input_cd
= new_input_cd
;
2260 pt
->output_cd
= new_output_cd
;
2267 err
= scm_from_locale_string (encoding
);
2268 scm_misc_error ("scm_i_set_port_encoding_x",
2269 "invalid or unknown character encoding ~s",
2274 SCM_DEFINE (scm_port_encoding
, "port-encoding", 1, 0, 0,
2276 "Returns, as a string, the character encoding that @var{port}\n"
2277 "uses to interpret its input and output.\n")
2278 #define FUNC_NAME s_scm_port_encoding
2283 SCM_VALIDATE_PORT (1, port
);
2285 pt
= SCM_PTAB_ENTRY (port
);
2288 return scm_from_locale_string (pt
->encoding
);
2294 SCM_DEFINE (scm_set_port_encoding_x
, "set-port-encoding!", 2, 0, 0,
2295 (SCM port
, SCM enc
),
2296 "Sets the character encoding that will be used to interpret all\n"
2297 "port I/O. New ports are created with the encoding\n"
2298 "appropriate for the current locale if @code{setlocale} has \n"
2299 "been called or ISO-8859-1 otherwise\n"
2300 "and this procedure can be used to modify that encoding.\n")
2301 #define FUNC_NAME s_scm_set_port_encoding_x
2305 SCM_VALIDATE_PORT (1, port
);
2306 SCM_VALIDATE_STRING (2, enc
);
2308 enc_str
= scm_to_locale_string (enc
);
2309 scm_i_set_port_encoding_x (port
, enc_str
);
2312 return SCM_UNSPECIFIED
;
2317 /* A fluid specifying the default conversion handler for newly created
2318 ports. Its value should be one of the symbols below. */
2319 SCM_VARIABLE (default_conversion_strategy_var
,
2320 "%default-port-conversion-strategy");
2322 /* Whether the above fluid is initialized. */
2323 static int scm_conversion_strategy_init
= 0;
2325 /* The possible conversion strategies. */
2326 SCM_SYMBOL (sym_error
, "error");
2327 SCM_SYMBOL (sym_substitute
, "substitute");
2328 SCM_SYMBOL (sym_escape
, "escape");
2330 /* Return the default failed encoding conversion policy for new created
2332 scm_t_string_failed_conversion_handler
2333 scm_i_default_port_conversion_handler (void)
2335 scm_t_string_failed_conversion_handler handler
;
2337 if (!scm_conversion_strategy_init
2338 || !scm_is_fluid (SCM_VARIABLE_REF (default_conversion_strategy_var
)))
2339 handler
= SCM_FAILED_CONVERSION_QUESTION_MARK
;
2344 fluid
= SCM_VARIABLE_REF (default_conversion_strategy_var
);
2345 value
= scm_fluid_ref (fluid
);
2347 if (scm_is_eq (sym_substitute
, value
))
2348 handler
= SCM_FAILED_CONVERSION_QUESTION_MARK
;
2349 else if (scm_is_eq (sym_escape
, value
))
2350 handler
= SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
;
2352 /* Default to 'error also when the fluid's value is not one of
2353 the valid symbols. */
2354 handler
= SCM_FAILED_CONVERSION_ERROR
;
2360 /* Use HANDLER as the default conversion strategy for future ports. */
2362 scm_i_set_default_port_conversion_handler (scm_t_string_failed_conversion_handler
2367 if (!scm_conversion_strategy_init
2368 || !scm_is_fluid (SCM_VARIABLE_REF (default_conversion_strategy_var
)))
2369 scm_misc_error (NULL
, "tried to set conversion strategy fluid before it is initialized",
2374 case SCM_FAILED_CONVERSION_ERROR
:
2375 strategy
= sym_error
;
2378 case SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
:
2379 strategy
= sym_escape
;
2382 case SCM_FAILED_CONVERSION_QUESTION_MARK
:
2383 strategy
= sym_substitute
;
2390 scm_fluid_set_x (SCM_VARIABLE_REF (default_conversion_strategy_var
),
2394 SCM_DEFINE (scm_port_conversion_strategy
, "port-conversion-strategy",
2395 1, 0, 0, (SCM port
),
2396 "Returns the behavior of the port when handling a character that\n"
2397 "is not representable in the port's current encoding.\n"
2398 "It returns the symbol @code{error} if unrepresentable characters\n"
2399 "should cause exceptions, @code{substitute} if the port should\n"
2400 "try to replace unrepresentable characters with question marks or\n"
2401 "approximate characters, or @code{escape} if unrepresentable\n"
2402 "characters should be converted to string escapes.\n"
2404 "If @var{port} is @code{#f}, then the current default behavior\n"
2405 "will be returned. New ports will have this default behavior\n"
2406 "when they are created.\n")
2407 #define FUNC_NAME s_scm_port_conversion_strategy
2409 scm_t_string_failed_conversion_handler h
;
2411 if (scm_is_false (port
))
2412 h
= scm_i_default_port_conversion_handler ();
2417 SCM_VALIDATE_OPPORT (1, port
);
2418 pt
= SCM_PTAB_ENTRY (port
);
2420 h
= pt
->ilseq_handler
;
2423 if (h
== SCM_FAILED_CONVERSION_ERROR
)
2424 return scm_from_latin1_symbol ("error");
2425 else if (h
== SCM_FAILED_CONVERSION_QUESTION_MARK
)
2426 return scm_from_latin1_symbol ("substitute");
2427 else if (h
== SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
)
2428 return scm_from_latin1_symbol ("escape");
2432 /* Never gets here. */
2433 return SCM_UNDEFINED
;
2437 SCM_DEFINE (scm_set_port_conversion_strategy_x
, "set-port-conversion-strategy!",
2439 (SCM port
, SCM sym
),
2440 "Sets the behavior of the interpreter when outputting a character\n"
2441 "that is not representable in the port's current encoding.\n"
2442 "@var{sym} can be either @code{'error}, @code{'substitute}, or\n"
2443 "@code{'escape}. If it is @code{'error}, an error will be thrown\n"
2444 "when an unconvertible character is encountered. If it is\n"
2445 "@code{'substitute}, then unconvertible characters will \n"
2446 "be replaced with approximate characters, or with question marks\n"
2447 "if no approximately correct character is available.\n"
2448 "If it is @code{'escape},\n"
2449 "it will appear as a hex escape when output.\n"
2451 "If @var{port} is an open port, the conversion error behavior\n"
2452 "is set for that port. If it is @code{#f}, it is set as the\n"
2453 "default behavior for any future ports that get created in\n"
2455 #define FUNC_NAME s_scm_set_port_conversion_strategy_x
2457 scm_t_string_failed_conversion_handler handler
;
2459 if (scm_is_eq (sym
, sym_error
))
2460 handler
= SCM_FAILED_CONVERSION_ERROR
;
2461 else if (scm_is_eq (sym
, sym_substitute
))
2462 handler
= SCM_FAILED_CONVERSION_QUESTION_MARK
;
2463 else if (scm_is_eq (sym
, sym_escape
))
2464 handler
= SCM_FAILED_CONVERSION_ESCAPE_SEQUENCE
;
2466 SCM_MISC_ERROR ("unknown conversion strategy ~s", scm_list_1 (sym
));
2468 if (scm_is_false (port
))
2469 scm_i_set_default_port_conversion_handler (handler
);
2472 SCM_VALIDATE_OPPORT (1, port
);
2473 SCM_PTAB_ENTRY (port
)->ilseq_handler
= handler
;
2476 return SCM_UNSPECIFIED
;
2483 scm_print_port_mode (SCM exp
, SCM port
)
2485 scm_puts (SCM_CLOSEDP (exp
)
2487 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
2488 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2491 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
2498 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
2500 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
2503 scm_puts ("#<", port
);
2504 scm_print_port_mode (exp
, port
);
2505 scm_puts (type
, port
);
2506 scm_putc (' ', port
);
2507 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
2508 scm_putc ('>', port
);
2516 scm_t_bits scm_tc16_void_port
= 0;
2518 static int fill_input_void_port (SCM port SCM_UNUSED
)
2524 write_void_port (SCM port SCM_UNUSED
,
2525 const void *data SCM_UNUSED
,
2526 size_t size SCM_UNUSED
)
2531 scm_i_void_port (long mode_bits
)
2533 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
2535 SCM answer
= scm_new_port_table_entry (scm_tc16_void_port
);
2536 scm_t_port
* pt
= SCM_PTAB_ENTRY(answer
);
2538 scm_port_non_buffer (pt
);
2540 SCM_SETSTREAM (answer
, 0);
2541 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
2542 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
2548 scm_void_port (char *mode_str
)
2550 return scm_i_void_port (scm_mode_bits (mode_str
));
2553 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
2555 "Create and return a new void port. A void port acts like\n"
2556 "@file{/dev/null}. The @var{mode} argument\n"
2557 "specifies the input/output modes for this port: see the\n"
2558 "documentation for @code{open-file} in @ref{File Ports}.")
2559 #define FUNC_NAME s_scm_sys_make_void_port
2561 return scm_i_void_port (scm_i_mode_bits (mode
));
2566 /* Initialization. */
2571 /* lseek() symbols. */
2572 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
2573 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
2574 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
2576 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
2579 cur_inport_fluid
= scm_make_fluid ();
2580 cur_outport_fluid
= scm_make_fluid ();
2581 cur_errport_fluid
= scm_make_fluid ();
2582 cur_loadport_fluid
= scm_make_fluid ();
2584 scm_i_port_weak_hash
= scm_make_weak_key_hash_table (SCM_I_MAKINUM(31));
2586 #include "libguile/ports.x"
2588 /* Use Latin-1 as the default port encoding. */
2589 SCM_VARIABLE_SET (default_port_encoding_var
,
2590 scm_make_fluid_with_default (SCM_BOOL_F
));
2591 scm_port_encoding_init
= 1;
2593 SCM_VARIABLE_SET (default_conversion_strategy_var
,
2594 scm_make_fluid_with_default (sym_substitute
));
2595 scm_conversion_strategy_init
= 1;
2597 /* These bindings are used when boot-9 turns `current-input-port' et
2598 al into parameters. They are then removed from the guile module. */
2599 scm_c_define ("%current-input-port-fluid", cur_inport_fluid
);
2600 scm_c_define ("%current-output-port-fluid", cur_outport_fluid
);
2601 scm_c_define ("%current-error-port-fluid", cur_errport_fluid
);