1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2003, 2004, 2006, 2007 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #define _LARGEFILE64_SOURCE /* ask for stat64 etc */
30 #include <fcntl.h> /* for chsize on mingw */
34 #include "libguile/_scm.h"
35 #include "libguile/async.h"
36 #include "libguile/eval.h"
37 #include "libguile/fports.h" /* direct access for seek and truncate */
38 #include "libguile/objects.h"
39 #include "libguile/goops.h"
40 #include "libguile/smob.h"
41 #include "libguile/chars.h"
42 #include "libguile/dynwind.h"
44 #include "libguile/keywords.h"
45 #include "libguile/root.h"
46 #include "libguile/strings.h"
47 #include "libguile/mallocs.h"
48 #include "libguile/validate.h"
49 #include "libguile/ports.h"
50 #include "libguile/vectors.h"
51 #include "libguile/fluids.h"
65 #ifdef HAVE_SYS_IOCTL_H
66 #include <sys/ioctl.h>
69 /* Mingw (version 3.4.5, circa 2006) has ftruncate as an alias for chsize
70 already, but have this code here in case that wasn't so in past versions,
71 or perhaps to help other minimal DOS environments.
73 gnulib ftruncate.c has code using fcntl F_CHSIZE and F_FREESP, which
74 might be possibilities if we've got other systems without ftruncate. */
76 #if HAVE_CHSIZE && ! HAVE_FTRUNCATE
77 #define ftruncate(fd, size) chsize (fd, size)
79 #define HAVE_FTRUNCATE 1
83 /* The port kind table --- a dynamically resized array of port types. */
86 /* scm_ptobs scm_numptob
87 * implement a dynamicly resized array of ptob records.
88 * Indexes into this table are used when generating type
89 * tags for smobjects (if you know a tag you can get an index and conversely).
91 scm_t_ptob_descriptor
*scm_ptobs
;
94 /* GC marker for a port with stream of SCM type. */
96 scm_markstream (SCM ptr
)
99 openp
= SCM_CELL_WORD_0 (ptr
) & SCM_OPN
;
101 return SCM_PACK (SCM_STREAM (ptr
));
107 * We choose to use an interface similar to the smob interface with
108 * fill_input and write as standard fields, passed to the port
109 * type constructor, and optional fields set by setters.
113 flush_port_default (SCM port SCM_UNUSED
)
118 end_input_default (SCM port SCM_UNUSED
, int offset SCM_UNUSED
)
123 scm_port_free0 (SCM port
)
129 scm_make_port_type (char *name
,
130 int (*fill_input
) (SCM port
),
131 void (*write
) (SCM port
, const void *data
, size_t size
))
134 if (255 <= scm_numptob
)
136 SCM_CRITICAL_SECTION_START
;
137 tmp
= (char *) scm_gc_realloc ((char *) scm_ptobs
,
138 scm_numptob
* sizeof (scm_t_ptob_descriptor
),
140 * sizeof (scm_t_ptob_descriptor
),
144 scm_ptobs
= (scm_t_ptob_descriptor
*) tmp
;
146 scm_ptobs
[scm_numptob
].name
= name
;
147 scm_ptobs
[scm_numptob
].mark
= 0;
148 scm_ptobs
[scm_numptob
].free
= scm_port_free0
;
149 scm_ptobs
[scm_numptob
].print
= scm_port_print
;
150 scm_ptobs
[scm_numptob
].equalp
= 0;
151 scm_ptobs
[scm_numptob
].close
= 0;
153 scm_ptobs
[scm_numptob
].write
= write
;
154 scm_ptobs
[scm_numptob
].flush
= flush_port_default
;
156 scm_ptobs
[scm_numptob
].end_input
= end_input_default
;
157 scm_ptobs
[scm_numptob
].fill_input
= fill_input
;
158 scm_ptobs
[scm_numptob
].input_waiting
= 0;
160 scm_ptobs
[scm_numptob
].seek
= 0;
161 scm_ptobs
[scm_numptob
].truncate
= 0;
165 SCM_CRITICAL_SECTION_END
;
169 scm_memory_error ("scm_make_port_type");
171 /* Make a class object if Goops is present */
173 scm_make_port_classes (scm_numptob
- 1, SCM_PTOBNAME (scm_numptob
- 1));
174 return scm_tc7_port
+ (scm_numptob
- 1) * 256;
178 scm_set_port_mark (scm_t_bits tc
, SCM (*mark
) (SCM
))
180 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].mark
= mark
;
184 scm_set_port_free (scm_t_bits tc
, size_t (*free
) (SCM
))
186 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].free
= free
;
190 scm_set_port_print (scm_t_bits tc
, int (*print
) (SCM exp
, SCM port
,
191 scm_print_state
*pstate
))
193 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].print
= print
;
197 scm_set_port_equalp (scm_t_bits tc
, SCM (*equalp
) (SCM
, SCM
))
199 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].equalp
= equalp
;
203 scm_set_port_flush (scm_t_bits tc
, void (*flush
) (SCM port
))
205 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].flush
= flush
;
209 scm_set_port_end_input (scm_t_bits tc
, void (*end_input
) (SCM port
, int offset
))
211 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].end_input
= end_input
;
215 scm_set_port_close (scm_t_bits tc
, int (*close
) (SCM
))
217 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].close
= close
;
221 scm_set_port_seek (scm_t_bits tc
, off_t (*seek
) (SCM port
,
225 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].seek
= seek
;
229 scm_set_port_truncate (scm_t_bits tc
, void (*truncate
) (SCM port
, off_t length
))
231 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].truncate
= truncate
;
235 scm_set_port_input_waiting (scm_t_bits tc
, int (*input_waiting
) (SCM
))
237 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].input_waiting
= input_waiting
;
242 SCM_DEFINE (scm_char_ready_p
, "char-ready?", 0, 1, 0,
244 "Return @code{#t} if a character is ready on input @var{port}\n"
245 "and return @code{#f} otherwise. If @code{char-ready?} returns\n"
246 "@code{#t} then the next @code{read-char} operation on\n"
247 "@var{port} is guaranteed not to hang. If @var{port} is a file\n"
248 "port at end of file then @code{char-ready?} returns @code{#t}.\n"
250 "@code{char-ready?} exists to make it possible for a\n"
251 "program to accept characters from interactive ports without\n"
252 "getting stuck waiting for input. Any input editors associated\n"
253 "with such ports must make sure that characters whose existence\n"
254 "has been asserted by @code{char-ready?} cannot be rubbed out.\n"
255 "If @code{char-ready?} were to return @code{#f} at end of file,\n"
256 "a port at end of file would be indistinguishable from an\n"
257 "interactive port that has no ready characters.")
258 #define FUNC_NAME s_scm_char_ready_p
262 if (SCM_UNBNDP (port
))
263 port
= scm_current_input_port ();
265 SCM_VALIDATE_OPINPORT (1, port
);
267 pt
= SCM_PTAB_ENTRY (port
);
269 /* if the current read buffer is filled, or the
270 last pushed-back char has been read and the saved buffer is
271 filled, result is true. */
272 if (pt
->read_pos
< pt
->read_end
273 || (pt
->read_buf
== pt
->putback_buf
274 && pt
->saved_read_pos
< pt
->saved_read_end
))
278 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
280 if (ptob
->input_waiting
)
281 return scm_from_bool(ptob
->input_waiting (port
));
288 /* move up to read_len chars from port's putback and/or read buffers
289 into memory starting at dest. returns the number of chars moved. */
290 size_t scm_take_from_input_buffers (SCM port
, char *dest
, size_t read_len
)
292 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
293 size_t chars_read
= 0;
294 size_t from_buf
= min (pt
->read_end
- pt
->read_pos
, read_len
);
298 memcpy (dest
, pt
->read_pos
, from_buf
);
299 pt
->read_pos
+= from_buf
;
300 chars_read
+= from_buf
;
301 read_len
-= from_buf
;
305 /* if putback was active, try the real input buffer too. */
306 if (pt
->read_buf
== pt
->putback_buf
)
308 from_buf
= min (pt
->saved_read_end
- pt
->saved_read_pos
, read_len
);
311 memcpy (dest
, pt
->saved_read_pos
, from_buf
);
312 pt
->saved_read_pos
+= from_buf
;
313 chars_read
+= from_buf
;
319 /* Clear a port's read buffers, returning the contents. */
320 SCM_DEFINE (scm_drain_input
, "drain-input", 1, 0, 0,
322 "This procedure clears a port's input buffers, similar\n"
323 "to the way that force-output clears the output buffer. The\n"
324 "contents of the buffers are returned as a single string, e.g.,\n"
327 "(define p (open-input-file ...))\n"
328 "(drain-input p) => empty string, nothing buffered yet.\n"
329 "(unread-char (read-char p) p)\n"
330 "(drain-input p) => initial chars from p, up to the buffer size.\n"
332 "Draining the buffers may be useful for cleanly finishing\n"
333 "buffered I/O so that the file descriptor can be used directly\n"
334 "for further input.")
335 #define FUNC_NAME s_scm_drain_input
342 SCM_VALIDATE_OPINPORT (1, port
);
343 pt
= SCM_PTAB_ENTRY (port
);
345 count
= pt
->read_end
- pt
->read_pos
;
346 if (pt
->read_buf
== pt
->putback_buf
)
347 count
+= pt
->saved_read_end
- pt
->saved_read_pos
;
349 result
= scm_i_make_string (count
, &data
);
350 scm_take_from_input_buffers (port
, data
, count
);
356 /* Standard ports --- current input, output, error, and more(!). */
358 static SCM cur_inport_fluid
;
359 static SCM cur_outport_fluid
;
360 static SCM cur_errport_fluid
;
361 static SCM cur_loadport_fluid
;
363 SCM_DEFINE (scm_current_input_port
, "current-input-port", 0, 0, 0,
365 "Return the current input port. This is the default port used\n"
366 "by many input procedures. Initially, @code{current-input-port}\n"
367 "returns the @dfn{standard input} in Unix and C terminology.")
368 #define FUNC_NAME s_scm_current_input_port
370 return scm_fluid_ref (cur_inport_fluid
);
374 SCM_DEFINE (scm_current_output_port
, "current-output-port", 0, 0, 0,
376 "Return the current output port. This is the default port used\n"
377 "by many output procedures. Initially,\n"
378 "@code{current-output-port} returns the @dfn{standard output} in\n"
379 "Unix and C terminology.")
380 #define FUNC_NAME s_scm_current_output_port
382 return scm_fluid_ref (cur_outport_fluid
);
386 SCM_DEFINE (scm_current_error_port
, "current-error-port", 0, 0, 0,
388 "Return the port to which errors and warnings should be sent (the\n"
389 "@dfn{standard error} in Unix and C terminology).")
390 #define FUNC_NAME s_scm_current_error_port
392 return scm_fluid_ref (cur_errport_fluid
);
396 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
398 "Return the current-load-port.\n"
399 "The load port is used internally by @code{primitive-load}.")
400 #define FUNC_NAME s_scm_current_load_port
402 return scm_fluid_ref (cur_loadport_fluid
);
406 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
408 "@deffnx {Scheme Procedure} set-current-output-port port\n"
409 "@deffnx {Scheme Procedure} set-current-error-port port\n"
410 "Change the ports returned by @code{current-input-port},\n"
411 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
412 "so that they use the supplied @var{port} for input or output.")
413 #define FUNC_NAME s_scm_set_current_input_port
415 SCM oinp
= scm_fluid_ref (cur_inport_fluid
);
416 SCM_VALIDATE_OPINPORT (1, port
);
417 scm_fluid_set_x (cur_inport_fluid
, port
);
423 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
425 "Set the current default output port to @var{port}.")
426 #define FUNC_NAME s_scm_set_current_output_port
428 SCM ooutp
= scm_fluid_ref (cur_outport_fluid
);
429 port
= SCM_COERCE_OUTPORT (port
);
430 SCM_VALIDATE_OPOUTPORT (1, port
);
431 scm_fluid_set_x (cur_outport_fluid
, port
);
437 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
439 "Set the current default error port to @var{port}.")
440 #define FUNC_NAME s_scm_set_current_error_port
442 SCM oerrp
= scm_fluid_ref (cur_errport_fluid
);
443 port
= SCM_COERCE_OUTPORT (port
);
444 SCM_VALIDATE_OPOUTPORT (1, port
);
445 scm_fluid_set_x (cur_errport_fluid
, port
);
451 scm_dynwind_current_input_port (SCM port
)
452 #define FUNC_NAME NULL
454 SCM_VALIDATE_OPINPORT (1, port
);
455 scm_dynwind_fluid (cur_inport_fluid
, port
);
460 scm_dynwind_current_output_port (SCM port
)
461 #define FUNC_NAME NULL
463 port
= SCM_COERCE_OUTPORT (port
);
464 SCM_VALIDATE_OPOUTPORT (1, port
);
465 scm_dynwind_fluid (cur_outport_fluid
, port
);
470 scm_dynwind_current_error_port (SCM port
)
471 #define FUNC_NAME NULL
473 port
= SCM_COERCE_OUTPORT (port
);
474 SCM_VALIDATE_OPOUTPORT (1, port
);
475 scm_dynwind_fluid (cur_errport_fluid
, port
);
480 scm_i_dynwind_current_load_port (SCM port
)
482 scm_dynwind_fluid (cur_loadport_fluid
, port
);
486 /* The port table --- an array of pointers to ports. */
488 scm_t_port
**scm_i_port_table
= NULL
;
490 long scm_i_port_table_size
= 0; /* Number of ports in SCM_I_PORT_TABLE. */
491 long scm_i_port_table_room
= 20; /* Actual size of the array. */
493 scm_i_pthread_mutex_t scm_i_port_table_mutex
= SCM_I_PTHREAD_MUTEX_INITIALIZER
;
496 /* Port finalization. */
499 static void finalize_port (GC_PTR
, GC_PTR
);
501 /* Register a finalizer for PORT, if needed by its port type. */
502 static SCM_C_INLINE_KEYWORD
void
503 register_finalizer_for_port (SCM port
)
507 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
508 if (scm_ptobs
[port_type
].free
)
510 GC_finalization_proc prev_finalizer
;
511 GC_PTR prev_finalization_data
;
513 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (port
), finalize_port
, 0,
515 &prev_finalization_data
);
519 /* Finalize the object (a port) pointed to by PTR. */
521 finalize_port (GC_PTR ptr
, GC_PTR data
)
524 SCM port
= PTR2SCM (ptr
);
526 if (!SCM_PORTP (port
))
529 if (SCM_OPENP (port
))
531 if (SCM_REVEALED (port
) > 0)
532 /* Keep "revealed" ports alive and re-register a finalizer. */
533 register_finalizer_for_port (port
);
536 port_type
= SCM_TC2PTOBNUM (SCM_CELL_TYPE (port
));
537 if (port_type
>= scm_numptob
)
540 if (scm_ptobs
[port_type
].free
)
541 /* Yes, I really do mean `.free' rather than `.close'. `.close'
542 is for explicit `close-port' by user. */
543 scm_ptobs
[port_type
].free (port
);
545 SCM_SETSTREAM (port
, 0);
546 SCM_CLR_PORT_OPEN_FLAG (port
);
547 scm_remove_from_port_table (port
);
549 scm_gc_ports_collected
++;
558 /* This function is not and should not be thread safe. */
560 scm_new_port_table_entry (scm_t_bits tag
)
561 #define FUNC_NAME "scm_new_port_table_entry"
564 We initialize the cell to empty, this is in case scm_gc_calloc
565 triggers GC ; we don't want the GC to scan a half-finished Z.
568 SCM z
= scm_cons (SCM_EOL
, SCM_EOL
);
569 scm_t_port
*entry
= (scm_t_port
*) scm_gc_calloc (sizeof (scm_t_port
), "port");
570 if (scm_i_port_table_size
== scm_i_port_table_room
)
572 /* initial malloc is in gc.c. this doesn't use scm_gc_malloc etc.,
573 since it can never be freed during gc. */
574 /* XXX (Ludo): Why not do it actually? */
575 size_t new_size
= scm_i_port_table_room
* 2;
576 /* XXX (Ludo): Can we use `GC_REALLOC' with
577 `GC_MALLOC_ATOMIC'-allocated data? */
578 void *newt
= scm_gc_realloc ((char *) scm_i_port_table
,
579 scm_i_port_table_room
* sizeof (scm_t_port
*),
580 new_size
* sizeof (scm_t_port
*),
582 scm_i_port_table
= (scm_t_port
**) newt
;
583 scm_i_port_table_room
= new_size
;
586 entry
->entry
= scm_i_port_table_size
;
588 entry
->file_name
= SCM_BOOL_F
;
589 entry
->rw_active
= SCM_PORT_NEITHER
;
591 scm_i_port_table
[scm_i_port_table_size
] = entry
;
592 scm_i_port_table_size
++;
595 SCM_SET_CELL_TYPE(z
, tag
);
596 SCM_SETPTAB_ENTRY(z
, entry
);
598 /* For each new port, register a finalizer so that it port type's free
599 function can be invoked eventually. */
600 register_finalizer_for_port (z
);
606 #if SCM_ENABLE_DEPRECATED==1
608 scm_add_to_port_table (SCM port
)
610 SCM z
= scm_new_port_table_entry (scm_tc7_port
);
611 scm_t_port
* pt
= SCM_PTAB_ENTRY(z
);
614 SCM_SETCAR(z
, SCM_EOL
);
615 SCM_SETCDR(z
, SCM_EOL
);
616 SCM_SETPTAB_ENTRY (port
, pt
);
622 /* Remove a port from the table and destroy it. */
624 /* This function is not and should not be thread safe. */
627 scm_remove_from_port_table (SCM port
)
628 #define FUNC_NAME "scm_remove_from_port_table"
630 scm_t_port
*p
= SCM_PTAB_ENTRY (port
);
633 if (i
>= scm_i_port_table_size
)
634 SCM_MISC_ERROR ("Port not in table: ~S", scm_list_1 (port
));
636 scm_gc_free (p
->putback_buf
, p
->putback_buf_size
, "putback buffer");
637 scm_gc_free (p
, sizeof (scm_t_port
), "port");
638 /* Since we have just freed slot i we can shrink the table by moving
639 the last entry to that slot... */
640 if (i
< scm_i_port_table_size
- 1)
642 scm_i_port_table
[i
] = scm_i_port_table
[scm_i_port_table_size
- 1];
643 scm_i_port_table
[i
]->entry
= i
;
645 SCM_SETPTAB_ENTRY (port
, 0);
646 scm_i_port_table_size
--;
652 /* Functions for debugging. */
654 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
656 "Return the number of ports in the port table. @code{pt-size}\n"
657 "is only included in @code{--enable-guile-debug} builds.")
658 #define FUNC_NAME s_scm_pt_size
660 return scm_from_int (scm_i_port_table_size
);
664 SCM_DEFINE (scm_pt_member
, "pt-member", 1, 0, 0,
666 "Return the port at @var{index} in the port table.\n"
667 "@code{pt-member} is only included in\n"
668 "@code{--enable-guile-debug} builds.")
669 #define FUNC_NAME s_scm_pt_member
671 size_t i
= scm_to_size_t (index
);
672 if (i
>= scm_i_port_table_size
)
675 return scm_i_port_table
[i
]->port
;
681 scm_port_non_buffer (scm_t_port
*pt
)
683 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
684 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
685 pt
->read_buf_size
= pt
->write_buf_size
= 1;
686 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
690 /* Revealed counts --- an oddity inherited from SCSH. */
692 /* Find a port in the table and return its revealed count.
693 Also used by the garbage collector.
697 scm_revealed_count (SCM port
)
699 return SCM_REVEALED(port
);
704 /* Return the revealed count for a port. */
706 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
708 "Return the revealed count for @var{port}.")
709 #define FUNC_NAME s_scm_port_revealed
711 port
= SCM_COERCE_OUTPORT (port
);
712 SCM_VALIDATE_OPENPORT (1, port
);
713 return scm_from_int (scm_revealed_count (port
));
717 /* Set the revealed count for a port. */
718 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
719 (SCM port
, SCM rcount
),
720 "Sets the revealed count for a port to a given value.\n"
721 "The return value is unspecified.")
722 #define FUNC_NAME s_scm_set_port_revealed_x
724 port
= SCM_COERCE_OUTPORT (port
);
725 SCM_VALIDATE_OPENPORT (1, port
);
726 SCM_REVEALED (port
) = scm_to_int (rcount
);
727 return SCM_UNSPECIFIED
;
733 /* Retrieving a port's mode. */
735 /* Return the flags that characterize a port based on the mode
736 * string used to open a file for that port.
738 * See PORT FLAGS in scm.h
742 scm_i_mode_bits_n (const char *modes
, size_t n
)
745 | (memchr (modes
, 'r', n
) || memchr (modes
, '+', n
) ? SCM_RDNG
: 0)
746 | ( memchr (modes
, 'w', n
)
747 || memchr (modes
, 'a', n
)
748 || memchr (modes
, '+', n
) ? SCM_WRTNG
: 0)
749 | (memchr (modes
, '0', n
) ? SCM_BUF0
: 0)
750 | (memchr (modes
, 'l', n
) ? SCM_BUFLINE
: 0));
754 scm_mode_bits (char *modes
)
756 return scm_i_mode_bits_n (modes
, strlen (modes
));
760 scm_i_mode_bits (SCM modes
)
764 if (!scm_is_string (modes
))
765 scm_wrong_type_arg_msg (NULL
, 0, modes
, "string");
767 bits
= scm_i_mode_bits_n (scm_i_string_chars (modes
),
768 scm_i_string_length (modes
));
769 scm_remember_upto_here_1 (modes
);
773 /* Return the mode flags from an open port.
774 * Some modes such as "append" are only used when opening
775 * a file and are not returned here. */
777 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
779 "Return the port modes associated with the open port @var{port}.\n"
780 "These will not necessarily be identical to the modes used when\n"
781 "the port was opened, since modes such as \"append\" which are\n"
782 "used only during port creation are not retained.")
783 #define FUNC_NAME s_scm_port_mode
788 port
= SCM_COERCE_OUTPORT (port
);
789 SCM_VALIDATE_OPPORT (1, port
);
790 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
791 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
792 strcpy (modes
, "r+");
796 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
798 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
800 return scm_from_locale_string (modes
);
809 * Call the close operation on a port object.
810 * see also scm_close.
812 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
814 "Close the specified port object. Return @code{#t} if it\n"
815 "successfully closes a port or @code{#f} if it was already\n"
816 "closed. An exception may be raised if an error occurs, for\n"
817 "example when flushing buffered output. See also @ref{Ports and\n"
818 "File Descriptors, close}, for a procedure which can close file\n"
820 #define FUNC_NAME s_scm_close_port
825 port
= SCM_COERCE_OUTPORT (port
);
827 SCM_VALIDATE_PORT (1, port
);
828 if (SCM_CLOSEDP (port
))
830 i
= SCM_PTOBNUM (port
);
831 if (scm_ptobs
[i
].close
)
832 rv
= (scm_ptobs
[i
].close
) (port
);
835 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
836 scm_remove_from_port_table (port
);
837 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
838 SCM_CLR_PORT_OPEN_FLAG (port
);
839 return scm_from_bool (rv
>= 0);
843 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
845 "Close the specified input port object. The routine has no effect if\n"
846 "the file has already been closed. An exception may be raised if an\n"
847 "error occurs. The value returned is unspecified.\n\n"
848 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
849 "which can close file descriptors.")
850 #define FUNC_NAME s_scm_close_input_port
852 SCM_VALIDATE_INPUT_PORT (1, port
);
853 scm_close_port (port
);
854 return SCM_UNSPECIFIED
;
858 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
860 "Close the specified output port object. The routine has no effect if\n"
861 "the file has already been closed. An exception may be raised if an\n"
862 "error occurs. The value returned is unspecified.\n\n"
863 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
864 "which can close file descriptors.")
865 #define FUNC_NAME s_scm_close_output_port
867 port
= SCM_COERCE_OUTPORT (port
);
868 SCM_VALIDATE_OUTPUT_PORT (1, port
);
869 scm_close_port (port
);
870 return SCM_UNSPECIFIED
;
875 scm_c_port_for_each (void (*proc
)(void *data
, SCM p
), void *data
)
881 /* Even without pre-emptive multithreading, running arbitrary code
882 while scanning the port table is unsafe because the port table
883 can change arbitrarily (from a GC, for example). So we first
884 collect the ports into a vector. -mvo */
886 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
887 n
= scm_i_port_table_size
;
888 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
890 ports
= scm_c_make_vector (n
, SCM_BOOL_F
);
892 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
893 if (n
> scm_i_port_table_size
)
894 n
= scm_i_port_table_size
;
895 for (i
= 0; i
< n
; i
++)
896 SCM_SIMPLE_VECTOR_SET (ports
, i
, scm_i_port_table
[i
]->port
);
897 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
899 for (i
= 0; i
< n
; i
++)
900 proc (data
, SCM_SIMPLE_VECTOR_REF (ports
, i
));
902 scm_remember_upto_here_1 (ports
);
905 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
907 "Apply @var{proc} to each port in the Guile port table\n"
908 "in turn. The return value is unspecified. More specifically,\n"
909 "@var{proc} is applied exactly once to every port that exists\n"
910 "in the system at the time @var{port-for-each} is invoked.\n"
911 "Changes to the port table while @var{port-for-each} is running\n"
912 "have no effect as far as @var{port-for-each} is concerned.")
913 #define FUNC_NAME s_scm_port_for_each
915 SCM_VALIDATE_PROC (1, proc
);
917 scm_c_port_for_each ((void (*)(void*,SCM
))scm_call_1
, proc
);
918 return SCM_UNSPECIFIED
;
924 /* Utter miscellany. Gosh, we should clean this up some time. */
926 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
928 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
929 "@code{#f}. Any object satisfying this predicate also satisfies\n"
931 #define FUNC_NAME s_scm_input_port_p
933 return scm_from_bool (SCM_INPUT_PORT_P (x
));
937 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
939 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
940 "@code{#f}. Any object satisfying this predicate also satisfies\n"
942 #define FUNC_NAME s_scm_output_port_p
944 x
= SCM_COERCE_OUTPORT (x
);
945 return scm_from_bool (SCM_OUTPUT_PORT_P (x
));
949 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
951 "Return a boolean indicating whether @var{x} is a port.\n"
952 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
954 #define FUNC_NAME s_scm_port_p
956 return scm_from_bool (SCM_PORTP (x
));
960 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
962 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
964 #define FUNC_NAME s_scm_port_closed_p
966 SCM_VALIDATE_PORT (1, port
);
967 return scm_from_bool (!SCM_OPPORTP (port
));
971 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
973 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
975 #define FUNC_NAME s_scm_eof_object_p
977 return scm_from_bool(SCM_EOF_OBJECT_P (x
));
981 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
983 "Flush the specified output port, or the current output port if @var{port}\n"
984 "is omitted. The current output buffer contents are passed to the\n"
985 "underlying port implementation (e.g., in the case of fports, the\n"
986 "data will be written to the file and the output buffer will be cleared.)\n"
987 "It has no effect on an unbuffered port.\n\n"
988 "The return value is unspecified.")
989 #define FUNC_NAME s_scm_force_output
991 if (SCM_UNBNDP (port
))
992 port
= scm_current_output_port ();
995 port
= SCM_COERCE_OUTPORT (port
);
996 SCM_VALIDATE_OPOUTPORT (1, port
);
999 return SCM_UNSPECIFIED
;
1003 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
1005 "Equivalent to calling @code{force-output} on\n"
1006 "all open output ports. The return value is unspecified.")
1007 #define FUNC_NAME s_scm_flush_all_ports
1011 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
1012 for (i
= 0; i
< scm_i_port_table_size
; i
++)
1014 if (SCM_OPOUTPORTP (scm_i_port_table
[i
]->port
))
1015 scm_flush (scm_i_port_table
[i
]->port
);
1017 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
1018 return SCM_UNSPECIFIED
;
1022 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
1024 "Return the next character available from @var{port}, updating\n"
1025 "@var{port} to point to the following character. If no more\n"
1026 "characters are available, the end-of-file object is returned.")
1027 #define FUNC_NAME s_scm_read_char
1030 if (SCM_UNBNDP (port
))
1031 port
= scm_current_input_port ();
1032 SCM_VALIDATE_OPINPORT (1, port
);
1033 c
= scm_getc (port
);
1036 return SCM_MAKE_CHAR (c
);
1040 /* this should only be called when the read buffer is empty. it
1041 tries to refill the read buffer. it returns the first char from
1042 the port, which is either EOF or *(pt->read_pos). */
1044 scm_fill_input (SCM port
)
1046 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1048 if (pt
->read_buf
== pt
->putback_buf
)
1050 /* finished reading put-back chars. */
1051 pt
->read_buf
= pt
->saved_read_buf
;
1052 pt
->read_pos
= pt
->saved_read_pos
;
1053 pt
->read_end
= pt
->saved_read_end
;
1054 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1055 if (pt
->read_pos
< pt
->read_end
)
1056 return *(pt
->read_pos
);
1058 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
1065 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1067 if (pt
->rw_active
== SCM_PORT_WRITE
)
1068 /* may be marginally faster than calling scm_flush. */
1069 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1072 pt
->rw_active
= SCM_PORT_READ
;
1074 if (pt
->read_pos
>= pt
->read_end
)
1076 if (scm_fill_input (port
) == EOF
)
1080 c
= *(pt
->read_pos
++);
1107 scm_putc (char c
, SCM port
)
1109 SCM_ASSERT_TYPE (SCM_OPOUTPORTP (port
), port
, 0, NULL
, "output port");
1110 scm_lfwrite (&c
, 1, port
);
1114 scm_puts (const char *s
, SCM port
)
1116 SCM_ASSERT_TYPE (SCM_OPOUTPORTP (port
), port
, 0, NULL
, "output port");
1117 scm_lfwrite (s
, strlen (s
), port
);
1122 * This function differs from scm_c_write; it updates port line and
1126 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
1128 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1129 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1131 if (pt
->rw_active
== SCM_PORT_READ
)
1132 scm_end_input (port
);
1134 ptob
->write (port
, ptr
, size
);
1136 for (; size
; ptr
++, size
--) {
1139 else if (*ptr
== '\b') {
1142 else if (*ptr
== '\n') {
1145 else if (*ptr
== '\r') {
1148 else if (*ptr
== '\t') {
1157 pt
->rw_active
= SCM_PORT_WRITE
;
1162 * Used by an application to read arbitrary number of bytes from an
1163 * SCM port. Same semantics as libc read, except that scm_c_read only
1164 * returns less than SIZE bytes if at end-of-file.
1166 * Warning: Doesn't update port line and column counts! */
1169 scm_c_read (SCM port
, void *buffer
, size_t size
)
1171 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1172 size_t n_read
= 0, n_available
;
1174 if (pt
->rw_active
== SCM_PORT_WRITE
)
1175 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1178 pt
->rw_active
= SCM_PORT_READ
;
1180 if (SCM_READ_BUFFER_EMPTY_P (pt
))
1182 if (scm_fill_input (port
) == EOF
)
1186 n_available
= pt
->read_end
- pt
->read_pos
;
1188 while (n_available
< size
)
1190 memcpy (buffer
, pt
->read_pos
, n_available
);
1191 buffer
= (char *) buffer
+ n_available
;
1192 pt
->read_pos
+= n_available
;
1193 n_read
+= n_available
;
1195 if (SCM_READ_BUFFER_EMPTY_P (pt
))
1197 if (scm_fill_input (port
) == EOF
)
1201 size
-= n_available
;
1202 n_available
= pt
->read_end
- pt
->read_pos
;
1205 memcpy (buffer
, pt
->read_pos
, size
);
1206 pt
->read_pos
+= size
;
1208 return n_read
+ size
;
1213 * Used by an application to write arbitrary number of bytes to an SCM
1214 * port. Similar semantics as libc write. However, unlike libc
1215 * write, scm_c_write writes the requested number of bytes and has no
1218 * Warning: Doesn't update port line and column counts!
1222 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1224 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1225 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1227 if (pt
->rw_active
== SCM_PORT_READ
)
1228 scm_end_input (port
);
1230 ptob
->write (port
, ptr
, size
);
1233 pt
->rw_active
= SCM_PORT_WRITE
;
1237 scm_flush (SCM port
)
1239 long i
= SCM_PTOBNUM (port
);
1240 assert ((i
>= 0) && (i
< scm_i_port_table_size
));
1241 (scm_ptobs
[i
].flush
) (port
);
1245 scm_end_input (SCM port
)
1248 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1250 if (pt
->read_buf
== pt
->putback_buf
)
1252 offset
= pt
->read_end
- pt
->read_pos
;
1253 pt
->read_buf
= pt
->saved_read_buf
;
1254 pt
->read_pos
= pt
->saved_read_pos
;
1255 pt
->read_end
= pt
->saved_read_end
;
1256 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1261 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1268 scm_ungetc (int c
, SCM port
)
1269 #define FUNC_NAME "scm_ungetc"
1271 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1273 if (pt
->read_buf
== pt
->putback_buf
)
1274 /* already using the put-back buffer. */
1276 /* enlarge putback_buf if necessary. */
1277 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1278 && pt
->read_buf
== pt
->read_pos
)
1280 size_t new_size
= pt
->read_buf_size
* 2;
1281 unsigned char *tmp
= (unsigned char *)
1282 /* XXX: Can we use `GC_REALLOC' with `GC_MALLOC_ATOMIC'-allocated
1284 scm_gc_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1287 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1288 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1289 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1292 /* shift any existing bytes to buffer + 1. */
1293 if (pt
->read_pos
== pt
->read_end
)
1294 pt
->read_end
= pt
->read_buf
+ 1;
1295 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1297 int count
= pt
->read_end
- pt
->read_pos
;
1299 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1300 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1303 pt
->read_pos
= pt
->read_buf
;
1306 /* switch to the put-back buffer. */
1308 if (pt
->putback_buf
== NULL
)
1311 = (unsigned char *) scm_gc_malloc_pointerless
1312 (SCM_INITIAL_PUTBACK_BUF_SIZE
, "putback buffer");
1313 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1316 pt
->saved_read_buf
= pt
->read_buf
;
1317 pt
->saved_read_pos
= pt
->read_pos
;
1318 pt
->saved_read_end
= pt
->read_end
;
1319 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1321 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1322 pt
->read_end
= pt
->read_buf
+ 1;
1323 pt
->read_buf_size
= pt
->putback_buf_size
;
1329 pt
->rw_active
= SCM_PORT_READ
;
1333 /* What should col be in this case?
1334 * We'll leave it at -1.
1336 SCM_LINUM (port
) -= 1;
1345 scm_ungets (const char *s
, int n
, SCM port
)
1347 /* This is simple minded and inefficient, but unreading strings is
1348 * probably not a common operation, and remember that line and
1349 * column numbers have to be handled...
1351 * Please feel free to write an optimized version!
1354 scm_ungetc (s
[n
], port
);
1358 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1360 "Return the next character available from @var{port},\n"
1361 "@emph{without} updating @var{port} to point to the following\n"
1362 "character. If no more characters are available, the\n"
1363 "end-of-file object is returned.\n"
1365 "The value returned by\n"
1366 "a call to @code{peek-char} is the same as the value that would\n"
1367 "have been returned by a call to @code{read-char} on the same\n"
1368 "port. The only difference is that the very next call to\n"
1369 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1370 "return the value returned by the preceding call to\n"
1371 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1372 "an interactive port will hang waiting for input whenever a call\n"
1373 "to @code{read-char} would have hung.")
1374 #define FUNC_NAME s_scm_peek_char
1377 if (SCM_UNBNDP (port
))
1378 port
= scm_current_input_port ();
1380 SCM_VALIDATE_OPINPORT (1, port
);
1381 column
= SCM_COL(port
);
1382 c
= scm_getc (port
);
1385 scm_ungetc (c
, port
);
1386 SCM_COL(port
) = column
;
1387 return SCM_MAKE_CHAR (c
);
1391 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1392 (SCM cobj
, SCM port
),
1393 "Place @var{char} in @var{port} so that it will be read by the\n"
1394 "next read operation. If called multiple times, the unread characters\n"
1395 "will be read again in last-in first-out order. If @var{port} is\n"
1396 "not supplied, the current input port is used.")
1397 #define FUNC_NAME s_scm_unread_char
1401 SCM_VALIDATE_CHAR (1, cobj
);
1402 if (SCM_UNBNDP (port
))
1403 port
= scm_current_input_port ();
1405 SCM_VALIDATE_OPINPORT (2, port
);
1407 c
= SCM_CHAR (cobj
);
1409 scm_ungetc (c
, port
);
1414 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1415 (SCM str
, SCM port
),
1416 "Place the string @var{str} in @var{port} so that its characters will be\n"
1417 "read in subsequent read operations. If called multiple times, the\n"
1418 "unread characters will be read again in last-in first-out order. If\n"
1419 "@var{port} is not supplied, the current-input-port is used.")
1420 #define FUNC_NAME s_scm_unread_string
1422 SCM_VALIDATE_STRING (1, str
);
1423 if (SCM_UNBNDP (port
))
1424 port
= scm_current_input_port ();
1426 SCM_VALIDATE_OPINPORT (2, port
);
1428 scm_ungets (scm_i_string_chars (str
), scm_i_string_length (str
), port
);
1434 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1435 (SCM fd_port
, SCM offset
, SCM whence
),
1436 "Sets the current position of @var{fd/port} to the integer\n"
1437 "@var{offset}, which is interpreted according to the value of\n"
1440 "One of the following variables should be supplied for\n"
1442 "@defvar SEEK_SET\n"
1443 "Seek from the beginning of the file.\n"
1445 "@defvar SEEK_CUR\n"
1446 "Seek from the current position.\n"
1448 "@defvar SEEK_END\n"
1449 "Seek from the end of the file.\n"
1451 "If @var{fd/port} is a file descriptor, the underlying system\n"
1452 "call is @code{lseek}. @var{port} may be a string port.\n"
1454 "The value returned is the new position in the file. This means\n"
1455 "that the current position of a port can be obtained using:\n"
1457 "(seek port 0 SEEK_CUR)\n"
1459 #define FUNC_NAME s_scm_seek
1463 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1465 how
= scm_to_int (whence
);
1466 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1467 SCM_OUT_OF_RANGE (3, whence
);
1469 if (SCM_OPFPORTP (fd_port
))
1471 /* go direct to fport code to allow 64-bit offsets */
1472 return scm_i_fport_seek (fd_port
, offset
, how
);
1474 else if (SCM_OPPORTP (fd_port
))
1476 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1477 off_t off
= scm_to_off_t (offset
);
1481 SCM_MISC_ERROR ("port is not seekable",
1482 scm_cons (fd_port
, SCM_EOL
));
1484 rv
= ptob
->seek (fd_port
, off
, how
);
1485 return scm_from_off_t (rv
);
1487 else /* file descriptor?. */
1489 off_t_or_off64_t off
= scm_to_off_t_or_off64_t (offset
);
1490 off_t_or_off64_t rv
;
1491 rv
= lseek_or_lseek64 (scm_to_int (fd_port
), off
, how
);
1494 return scm_from_off_t_or_off64_t (rv
);
1503 /* Mingw has ftruncate(), perhaps implemented above using chsize, but
1504 doesn't have the filename version truncate(), hence this code. */
1505 #if HAVE_FTRUNCATE && ! HAVE_TRUNCATE
1507 truncate (const char *file
, off_t length
)
1511 fdes
= open (file
, O_BINARY
| O_WRONLY
);
1515 ret
= ftruncate (fdes
, length
);
1518 int save_errno
= errno
;
1524 return close (fdes
);
1526 #endif /* HAVE_FTRUNCATE && ! HAVE_TRUNCATE */
1528 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1529 (SCM object
, SCM length
),
1530 "Truncate @var{file} to @var{length} bytes. @var{file} can be a\n"
1531 "filename string, a port object, or an integer file descriptor.\n"
1532 "The return value is unspecified.\n"
1534 "For a port or file descriptor @var{length} can be omitted, in\n"
1535 "which case the file is truncated at the current position (per\n"
1536 "@code{ftell} above).\n"
1538 "On most systems a file can be extended by giving a length\n"
1539 "greater than the current size, but this is not mandatory in the\n"
1541 #define FUNC_NAME s_scm_truncate_file
1545 /* "object" can be a port, fdes or filename.
1547 Negative "length" makes no sense, but it's left to truncate() or
1548 ftruncate() to give back an error for that (normally EINVAL).
1551 if (SCM_UNBNDP (length
))
1553 /* must supply length if object is a filename. */
1554 if (scm_is_string (object
))
1555 SCM_MISC_ERROR("must supply length if OBJECT is a filename", SCM_EOL
);
1557 length
= scm_seek (object
, SCM_INUM0
, scm_from_int (SEEK_CUR
));
1560 object
= SCM_COERCE_OUTPORT (object
);
1561 if (scm_is_integer (object
))
1563 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1564 SCM_SYSCALL (rv
= ftruncate_or_ftruncate64 (scm_to_int (object
),
1567 else if (SCM_OPOUTFPORTP (object
))
1569 /* go direct to fport code to allow 64-bit offsets */
1570 rv
= scm_i_fport_truncate (object
, length
);
1572 else if (SCM_OPOUTPORTP (object
))
1574 off_t c_length
= scm_to_off_t (length
);
1575 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
1576 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1578 if (!ptob
->truncate
)
1579 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
1580 if (pt
->rw_active
== SCM_PORT_READ
)
1581 scm_end_input (object
);
1582 else if (pt
->rw_active
== SCM_PORT_WRITE
)
1583 ptob
->flush (object
);
1585 ptob
->truncate (object
, c_length
);
1590 off_t_or_off64_t c_length
= scm_to_off_t_or_off64_t (length
);
1591 char *str
= scm_to_locale_string (object
);
1593 SCM_SYSCALL (rv
= truncate_or_truncate64 (str
, c_length
));
1600 return SCM_UNSPECIFIED
;
1604 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
1606 "Return the current line number for @var{port}.\n"
1608 "The first line of a file is 0. But you might want to add 1\n"
1609 "when printing line numbers, since starting from 1 is\n"
1610 "traditional in error messages, and likely to be more natural to\n"
1612 #define FUNC_NAME s_scm_port_line
1614 port
= SCM_COERCE_OUTPORT (port
);
1615 SCM_VALIDATE_OPENPORT (1, port
);
1616 return scm_from_long (SCM_LINUM (port
));
1620 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
1621 (SCM port
, SCM line
),
1622 "Set the current line number for @var{port} to @var{line}. The\n"
1623 "first line of a file is 0.")
1624 #define FUNC_NAME s_scm_set_port_line_x
1626 port
= SCM_COERCE_OUTPORT (port
);
1627 SCM_VALIDATE_OPENPORT (1, port
);
1628 SCM_PTAB_ENTRY (port
)->line_number
= scm_to_long (line
);
1629 return SCM_UNSPECIFIED
;
1633 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
1635 "Return the current column number of @var{port}.\n"
1636 "If the number is\n"
1637 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
1638 "- i.e. the first character of the first line is line 0, column 0.\n"
1639 "(However, when you display a file position, for example in an error\n"
1640 "message, we recommend you add 1 to get 1-origin integers. This is\n"
1641 "because lines and column numbers traditionally start with 1, and that is\n"
1642 "what non-programmers will find most natural.)")
1643 #define FUNC_NAME s_scm_port_column
1645 port
= SCM_COERCE_OUTPORT (port
);
1646 SCM_VALIDATE_OPENPORT (1, port
);
1647 return scm_from_int (SCM_COL (port
));
1651 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
1652 (SCM port
, SCM column
),
1653 "Set the current column of @var{port}. Before reading the first\n"
1654 "character on a line the column should be 0.")
1655 #define FUNC_NAME s_scm_set_port_column_x
1657 port
= SCM_COERCE_OUTPORT (port
);
1658 SCM_VALIDATE_OPENPORT (1, port
);
1659 SCM_PTAB_ENTRY (port
)->column_number
= scm_to_int (column
);
1660 return SCM_UNSPECIFIED
;
1664 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
1666 "Return the filename associated with @var{port}. This function returns\n"
1667 "the strings \"standard input\", \"standard output\" and \"standard error\"\n"
1668 "when called on the current input, output and error ports respectively.")
1669 #define FUNC_NAME s_scm_port_filename
1671 port
= SCM_COERCE_OUTPORT (port
);
1672 SCM_VALIDATE_OPENPORT (1, port
);
1673 return SCM_FILENAME (port
);
1677 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
1678 (SCM port
, SCM filename
),
1679 "Change the filename associated with @var{port}, using the current input\n"
1680 "port if none is specified. Note that this does not change the port's\n"
1681 "source of data, but only the value that is returned by\n"
1682 "@code{port-filename} and reported in diagnostic output.")
1683 #define FUNC_NAME s_scm_set_port_filename_x
1685 port
= SCM_COERCE_OUTPORT (port
);
1686 SCM_VALIDATE_OPENPORT (1, port
);
1687 /* We allow the user to set the filename to whatever he likes. */
1688 SCM_SET_FILENAME (port
, filename
);
1689 return SCM_UNSPECIFIED
;
1694 scm_print_port_mode (SCM exp
, SCM port
)
1696 scm_puts (SCM_CLOSEDP (exp
)
1698 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
1699 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
1702 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
1709 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
1711 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
1714 scm_puts ("#<", port
);
1715 scm_print_port_mode (exp
, port
);
1716 scm_puts (type
, port
);
1717 scm_putc (' ', port
);
1718 scm_uintprint (SCM_CELL_WORD_1 (exp
), 16, port
);
1719 scm_putc ('>', port
);
1724 scm_ports_prehistory ()
1729 /* In order for the ports to be collectable, the port table must not be
1730 scanned by the GC. */
1732 scm_gc_malloc_pointerless (scm_i_port_table_room
1733 * sizeof (scm_t_port
*),
1741 scm_t_bits scm_tc16_void_port
= 0;
1743 static int fill_input_void_port (SCM port SCM_UNUSED
)
1749 write_void_port (SCM port SCM_UNUSED
,
1750 const void *data SCM_UNUSED
,
1751 size_t size SCM_UNUSED
)
1756 scm_i_void_port (long mode_bits
)
1758 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
1760 SCM answer
= scm_new_port_table_entry (scm_tc16_void_port
);
1761 scm_t_port
* pt
= SCM_PTAB_ENTRY(answer
);
1763 scm_port_non_buffer (pt
);
1765 SCM_SETSTREAM (answer
, 0);
1766 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
1767 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
1773 scm_void_port (char *mode_str
)
1775 return scm_i_void_port (scm_mode_bits (mode_str
));
1778 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
1780 "Create and return a new void port. A void port acts like\n"
1781 "@file{/dev/null}. The @var{mode} argument\n"
1782 "specifies the input/output modes for this port: see the\n"
1783 "documentation for @code{open-file} in @ref{File Ports}.")
1784 #define FUNC_NAME s_scm_sys_make_void_port
1786 return scm_i_void_port (scm_i_mode_bits (mode
));
1791 /* Initialization. */
1796 /* lseek() symbols. */
1797 scm_c_define ("SEEK_SET", scm_from_int (SEEK_SET
));
1798 scm_c_define ("SEEK_CUR", scm_from_int (SEEK_CUR
));
1799 scm_c_define ("SEEK_END", scm_from_int (SEEK_END
));
1801 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
1804 cur_inport_fluid
= scm_permanent_object (scm_make_fluid ());
1805 cur_outport_fluid
= scm_permanent_object (scm_make_fluid ());
1806 cur_errport_fluid
= scm_permanent_object (scm_make_fluid ());
1807 cur_loadport_fluid
= scm_permanent_object (scm_make_fluid ());
1809 #include "libguile/ports.x"