1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program 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
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
43 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
51 #include "libguile/_scm.h"
52 #include "libguile/eval.h"
53 #include "libguile/objects.h"
54 #include "libguile/smob.h"
55 #include "libguile/chars.h"
57 #include "libguile/keywords.h"
58 #include "libguile/root.h"
59 #include "libguile/strings.h"
61 #include "libguile/validate.h"
62 #include "libguile/ports.h"
76 #ifdef HAVE_SYS_IOCTL_H
77 #include <sys/ioctl.h>
81 /* The port kind table --- a dynamically resized array of port types. */
84 /* scm_ptobs scm_numptob
85 * implement a dynamicly resized array of ptob records.
86 * Indexes into this table are used when generating type
87 * tags for smobjects (if you know a tag you can get an index and conversely).
89 scm_t_ptob_descriptor
*scm_ptobs
;
92 /* GC marker for a port with stream of SCM type. */
94 scm_markstream (SCM ptr
)
97 openp
= SCM_CELL_WORD_0 (ptr
) & SCM_OPN
;
99 return SCM_PACK (SCM_STREAM (ptr
));
105 * We choose to use an interface similar to the smob interface with
106 * fill_input and write as standard fields, passed to the port
107 * type constructor, and optional fields set by setters.
111 flush_port_default (SCM port SCM_UNUSED
)
116 end_input_default (SCM port SCM_UNUSED
, int offset SCM_UNUSED
)
121 scm_make_port_type (char *name
,
122 int (*fill_input
) (SCM port
),
123 void (*write
) (SCM port
, const void *data
, size_t size
))
126 if (255 <= scm_numptob
)
129 SCM_SYSCALL (tmp
= (char *) realloc ((char *) scm_ptobs
,
131 * sizeof (scm_t_ptob_descriptor
)));
134 scm_ptobs
= (scm_t_ptob_descriptor
*) tmp
;
136 scm_ptobs
[scm_numptob
].name
= name
;
137 scm_ptobs
[scm_numptob
].mark
= 0;
138 scm_ptobs
[scm_numptob
].free
= scm_free0
;
139 scm_ptobs
[scm_numptob
].print
= scm_port_print
;
140 scm_ptobs
[scm_numptob
].equalp
= 0;
141 scm_ptobs
[scm_numptob
].close
= 0;
143 scm_ptobs
[scm_numptob
].write
= write
;
144 scm_ptobs
[scm_numptob
].flush
= flush_port_default
;
146 scm_ptobs
[scm_numptob
].end_input
= end_input_default
;
147 scm_ptobs
[scm_numptob
].fill_input
= fill_input
;
148 scm_ptobs
[scm_numptob
].input_waiting
= 0;
150 scm_ptobs
[scm_numptob
].seek
= 0;
151 scm_ptobs
[scm_numptob
].truncate
= 0;
159 scm_memory_error ("scm_make_port_type");
161 /* Make a class object if Goops is present */
163 scm_make_port_classes (scm_numptob
- 1, SCM_PTOBNAME (scm_numptob
- 1));
164 return scm_tc7_port
+ (scm_numptob
- 1) * 256;
168 scm_set_port_mark (long tc
, SCM (*mark
) (SCM
))
170 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].mark
= mark
;
174 scm_set_port_free (long tc
, size_t (*free
) (SCM
))
176 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].free
= free
;
180 scm_set_port_print (long tc
, int (*print
) (SCM exp
, SCM port
,
181 scm_print_state
*pstate
))
183 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].print
= print
;
187 scm_set_port_equalp (long tc
, SCM (*equalp
) (SCM
, SCM
))
189 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].equalp
= equalp
;
193 scm_set_port_flush (long tc
, void (*flush
) (SCM port
))
195 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].flush
= flush
;
199 scm_set_port_end_input (long tc
, void (*end_input
) (SCM port
, int offset
))
201 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].end_input
= end_input
;
205 scm_set_port_close (long tc
, int (*close
) (SCM
))
207 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].close
= close
;
211 scm_set_port_seek (long tc
, off_t (*seek
) (SCM port
,
215 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].seek
= seek
;
219 scm_set_port_truncate (long tc
, void (*truncate
) (SCM port
, off_t length
))
221 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].truncate
= truncate
;
225 scm_set_port_input_waiting (long tc
, int (*input_waiting
) (SCM
))
227 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].input_waiting
= input_waiting
;
232 SCM_DEFINE (scm_char_ready_p
, "char-ready?", 0, 1, 0,
234 "Return @code{#t} if a character is ready on input @var{port}\n"
235 "and return @code{#f} otherwise. If @code{char-ready?} returns\n"
236 "@code{#t} then the next @code{read-char} operation on\n"
237 "@var{port} is guaranteed not to hang. If @var{port} is a file\n"
238 "port at end of file then @code{char-ready?} returns @code{#t}.\n"
239 "@footnote{@code{char-ready?} exists to make it possible for a\n"
240 "program to accept characters from interactive ports without\n"
241 "getting stuck waiting for input. Any input editors associated\n"
242 "with such ports must make sure that characters whose existence\n"
243 "has been asserted by @code{char-ready?} cannot be rubbed out.\n"
244 "If @code{char-ready?} were to return @code{#f} at end of file,\n"
245 "a port at end of file would be indistinguishable from an\n"
246 "interactive port that has no ready characters.}")
247 #define FUNC_NAME s_scm_char_ready_p
251 if (SCM_UNBNDP (port
))
254 SCM_VALIDATE_OPINPORT (1,port
);
256 pt
= SCM_PTAB_ENTRY (port
);
258 /* if the current read buffer is filled, or the
259 last pushed-back char has been read and the saved buffer is
260 filled, result is true. */
261 if (pt
->read_pos
< pt
->read_end
262 || (pt
->read_buf
== pt
->putback_buf
263 && pt
->saved_read_pos
< pt
->saved_read_end
))
267 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
269 if (ptob
->input_waiting
)
270 return SCM_BOOL(ptob
->input_waiting (port
));
277 /* move up to read_len chars from port's putback and/or read buffers
278 into memory starting at dest. returns the number of chars moved. */
279 size_t scm_take_from_input_buffers (SCM port
, char *dest
, size_t read_len
)
281 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
282 size_t chars_read
= 0;
283 size_t from_buf
= min (pt
->read_end
- pt
->read_pos
, read_len
);
287 memcpy (dest
, pt
->read_pos
, from_buf
);
288 pt
->read_pos
+= from_buf
;
289 chars_read
+= from_buf
;
290 read_len
-= from_buf
;
294 /* if putback was active, try the real input buffer too. */
295 if (pt
->read_buf
== pt
->putback_buf
)
297 from_buf
= min (pt
->saved_read_end
- pt
->saved_read_pos
, read_len
);
300 memcpy (dest
, pt
->saved_read_pos
, from_buf
);
301 pt
->saved_read_pos
+= from_buf
;
302 chars_read
+= from_buf
;
308 /* Clear a port's read buffers, returning the contents. */
309 SCM_DEFINE (scm_drain_input
, "drain-input", 1, 0, 0,
311 "Drain @var{port}'s read buffers (including any pushed-back\n"
312 "characters) and return the content as a single string.")
313 #define FUNC_NAME s_scm_drain_input
316 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
319 SCM_VALIDATE_OPINPORT (1,port
);
321 count
= pt
->read_end
- pt
->read_pos
;
322 if (pt
->read_buf
== pt
->putback_buf
)
323 count
+= pt
->saved_read_end
- pt
->saved_read_pos
;
325 result
= scm_allocate_string (count
);
326 scm_take_from_input_buffers (port
, SCM_STRING_CHARS (result
), count
);
333 /* Standard ports --- current input, output, error, and more(!). */
335 SCM_DEFINE (scm_current_input_port
, "current-input-port", 0, 0, 0,
337 "Return the current input port. This is the default port used\n"
338 "by many input procedures. Initially, @code{current-input-port}\n"
339 "returns the @dfn{standard input} in Unix and C terminology.")
340 #define FUNC_NAME s_scm_current_input_port
346 SCM_DEFINE (scm_current_output_port
, "current-output-port", 0, 0, 0,
348 "Return the current output port. This is the default port used\n"
349 "by many output procedures. Initially, \n"
350 "@code{current-output-port} returns the @dfn{standard output} in\n"
351 "Unix and C terminology.")
352 #define FUNC_NAME s_scm_current_output_port
358 SCM_DEFINE (scm_current_error_port
, "current-error-port", 0, 0, 0,
360 "Return the port to which errors and warnings should be sent (the\n"
361 "@dfn{standard error} in Unix and C terminology).")
362 #define FUNC_NAME s_scm_current_error_port
368 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
370 "Return the current-load-port.\n"
371 "The load port is used internally by @code{primitive-load}.")
372 #define FUNC_NAME s_scm_current_load_port
374 return scm_cur_loadp
;
378 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
380 "@deffnx primitive set-current-output-port port\n"
381 "@deffnx primitive set-current-error-port port\n"
382 "Change the ports returned by @code{current-input-port},\n"
383 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
384 "so that they use the supplied @var{port} for input or output.")
385 #define FUNC_NAME s_scm_set_current_input_port
387 SCM oinp
= scm_cur_inp
;
388 SCM_VALIDATE_OPINPORT (1,port
);
395 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
397 "Set the current default output port to @var{port}.")
398 #define FUNC_NAME s_scm_set_current_output_port
400 SCM ooutp
= scm_cur_outp
;
401 port
= SCM_COERCE_OUTPORT (port
);
402 SCM_VALIDATE_OPOUTPORT (1,port
);
409 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
411 "Set the current default error port to @var{port}.")
412 #define FUNC_NAME s_scm_set_current_error_port
414 SCM oerrp
= scm_cur_errp
;
415 port
= SCM_COERCE_OUTPORT (port
);
416 SCM_VALIDATE_OPOUTPORT (1,port
);
423 /* The port table --- an array of pointers to ports. */
425 scm_t_port
**scm_t_portable
;
427 long scm_t_portable_size
= 0; /* Number of ports in scm_t_portable. */
428 long scm_t_portable_room
= 20; /* Size of the array. */
430 /* Add a port to the table. */
433 scm_add_to_port_table (SCM port
)
434 #define FUNC_NAME "scm_add_to_port_table"
438 if (scm_t_portable_size
== scm_t_portable_room
)
440 /* initial malloc is in gc.c. this doesn't use scm_must_malloc etc.,
441 since it can never be freed during gc. */
442 void *newt
= realloc ((char *) scm_t_portable
,
443 (size_t) (sizeof (scm_t_port
*)
444 * scm_t_portable_room
* 2));
446 scm_memory_error ("scm_add_to_port_table");
447 scm_t_portable
= (scm_t_port
**) newt
;
448 scm_t_portable_room
*= 2;
450 entry
= (scm_t_port
*) scm_must_malloc (sizeof (scm_t_port
), FUNC_NAME
);
453 entry
->entry
= scm_t_portable_size
;
456 entry
->file_name
= SCM_BOOL_F
;
457 entry
->line_number
= 0;
458 entry
->column_number
= 0;
459 entry
->putback_buf
= 0;
460 entry
->putback_buf_size
= 0;
461 entry
->rw_active
= SCM_PORT_NEITHER
;
462 entry
->rw_random
= 0;
464 scm_t_portable
[scm_t_portable_size
] = entry
;
465 scm_t_portable_size
++;
471 /* Remove a port from the table and destroy it. */
474 scm_remove_from_port_table (SCM port
)
475 #define FUNC_NAME "scm_remove_from_port_table"
477 scm_t_port
*p
= SCM_PTAB_ENTRY (port
);
480 if (i
>= scm_t_portable_size
)
481 SCM_MISC_ERROR ("Port not in table: ~S", SCM_LIST1 (port
));
483 scm_must_free (p
->putback_buf
);
485 /* Since we have just freed slot i we can shrink the table by moving
486 the last entry to that slot... */
487 if (i
< scm_t_portable_size
- 1)
489 scm_t_portable
[i
] = scm_t_portable
[scm_t_portable_size
- 1];
490 scm_t_portable
[i
]->entry
= i
;
492 SCM_SETPTAB_ENTRY (port
, 0);
493 scm_t_portable_size
--;
499 /* Functions for debugging. */
501 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
503 "Return the number of ports in the port table. @code{pt-size}\n"
504 "is only included in @code{--enable-guile-debug} builds.")
505 #define FUNC_NAME s_scm_pt_size
507 return SCM_MAKINUM (scm_t_portable_size
);
511 SCM_DEFINE (scm_pt_member
, "pt-member", 1, 0, 0,
513 "Return the port at @var{index} in the port table.\n"
514 "@code{pt-member} is only included in\n"
515 "@code{--enable-guile-debug} builds.")
516 #define FUNC_NAME s_scm_pt_member
519 SCM_VALIDATE_INUM_COPY (1,index
,i
);
520 if (i
< 0 || i
>= scm_t_portable_size
)
523 return scm_t_portable
[i
]->port
;
529 scm_port_non_buffer (scm_t_port
*pt
)
531 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
532 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
533 pt
->read_buf_size
= pt
->write_buf_size
= 1;
534 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
538 /* Revealed counts --- an oddity inherited from SCSH. */
540 /* Find a port in the table and return its revealed count.
541 Also used by the garbage collector.
545 scm_revealed_count (SCM port
)
547 return SCM_REVEALED(port
);
552 /* Return the revealed count for a port. */
554 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
556 "Return the revealed count for @var{port}.")
557 #define FUNC_NAME s_scm_port_revealed
559 port
= SCM_COERCE_OUTPORT (port
);
560 SCM_VALIDATE_OPENPORT (1,port
);
561 return SCM_MAKINUM (scm_revealed_count (port
));
565 /* Set the revealed count for a port. */
566 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
567 (SCM port
, SCM rcount
),
568 "Sets the revealed count for a port to a given value.\n"
569 "The return value is unspecified.")
570 #define FUNC_NAME s_scm_set_port_revealed_x
572 port
= SCM_COERCE_OUTPORT (port
);
573 SCM_VALIDATE_OPENPORT (1,port
);
574 SCM_VALIDATE_INUM (2,rcount
);
575 SCM_REVEALED (port
) = SCM_INUM (rcount
);
576 return SCM_UNSPECIFIED
;
582 /* Retrieving a port's mode. */
584 /* Return the flags that characterize a port based on the mode
585 * string used to open a file for that port.
587 * See PORT FLAGS in scm.h
591 scm_mode_bits (char *modes
)
594 | (strchr (modes
, 'r') || strchr (modes
, '+') ? SCM_RDNG
: 0)
595 | ( strchr (modes
, 'w')
596 || strchr (modes
, 'a')
597 || strchr (modes
, '+') ? SCM_WRTNG
: 0)
598 | (strchr (modes
, '0') ? SCM_BUF0
: 0)
599 | (strchr (modes
, 'l') ? SCM_BUFLINE
: 0));
603 /* Return the mode flags from an open port.
604 * Some modes such as "append" are only used when opening
605 * a file and are not returned here. */
607 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
609 "Return the port modes associated with the open port @var{port}.\n"
610 "These will not necessarily be identical to the modes used when\n"
611 "the port was opened, since modes such as \"append\" which are\n"
612 "used only during port creation are not retained.")
613 #define FUNC_NAME s_scm_port_mode
618 port
= SCM_COERCE_OUTPORT (port
);
619 SCM_VALIDATE_OPPORT (1,port
);
620 if (SCM_CELL_WORD_0 (port
) & SCM_RDNG
) {
621 if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
622 strcpy (modes
, "r+");
626 else if (SCM_CELL_WORD_0 (port
) & SCM_WRTNG
)
628 if (SCM_CELL_WORD_0 (port
) & SCM_BUF0
)
630 return scm_mem2string (modes
, strlen (modes
));
639 * Call the close operation on a port object.
640 * see also scm_close.
642 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
644 "Close the specified port object. Return @code{#t} if it\n"
645 "successfully closes a port or @code{#f} if it was already\n"
646 "closed. An exception may be raised if an error occurs, for\n"
647 "example when flushing buffered output. See also @ref{Ports and\n"
648 "File Descriptors, close}, for a procedure which can close file\n"
650 #define FUNC_NAME s_scm_close_port
655 port
= SCM_COERCE_OUTPORT (port
);
657 SCM_VALIDATE_PORT (1, port
);
658 if (SCM_CLOSEDP (port
))
660 i
= SCM_PTOBNUM (port
);
661 if (scm_ptobs
[i
].close
)
662 rv
= (scm_ptobs
[i
].close
) (port
);
665 scm_remove_from_port_table (port
);
666 SCM_CLR_PORT_OPEN_FLAG (port
);
667 return SCM_BOOL (rv
>= 0);
671 SCM_DEFINE (scm_close_input_port
, "close-input-port", 1, 0, 0,
673 "Close the specified input port object. The routine has no effect if\n"
674 "the file has already been closed. An exception may be raised if an\n"
675 "error occurs. The value returned is unspecified.\n\n"
676 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
677 "which can close file descriptors.")
678 #define FUNC_NAME s_scm_close_input_port
680 SCM_VALIDATE_INPUT_PORT (1, port
);
681 scm_close_port (port
);
682 return SCM_UNSPECIFIED
;
686 SCM_DEFINE (scm_close_output_port
, "close-output-port", 1, 0, 0,
688 "Close the specified output port object. The routine has no effect if\n"
689 "the file has already been closed. An exception may be raised if an\n"
690 "error occurs. The value returned is unspecified.\n\n"
691 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
692 "which can close file descriptors.")
693 #define FUNC_NAME s_scm_close_output_port
695 port
= SCM_COERCE_OUTPORT (port
);
696 SCM_VALIDATE_OUTPUT_PORT (1, port
);
697 scm_close_port (port
);
698 return SCM_UNSPECIFIED
;
702 SCM_DEFINE (scm_port_for_each
, "port-for-each", 1, 0, 0,
704 "Apply @var{proc} to each port in the Guile port table\n"
705 "in turn. The return value is unspecified. More specifically,\n"
706 "@var{proc} is applied exactly once to every port that exists\n"
707 "in the system at the time @var{port-for-each} is invoked.\n"
708 "Changes to the port table while @var{port-for-each} is running\n"
709 "have no effect as far as @var{port-for-each} is concerned.\n")
710 #define FUNC_NAME s_scm_port_for_each
715 SCM_VALIDATE_PROC (1, proc
);
717 /* when pre-emptive multithreading is supported, access to the port
718 table will need to be controlled by a mutex. */
720 /* Even without pre-emptive multithreading, running arbitrary code
721 while scanning the port table is unsafe because the port table
722 can change arbitrarily (from a GC, for example). So we build a
723 list in advance while blocking the GC. -mvo */
728 for (i
= 0; i
< scm_t_portable_size
; i
++)
729 ports
= scm_cons (scm_t_portable
[i
]->port
, ports
);
733 while (ports
!= SCM_EOL
)
735 scm_apply (proc
, scm_cons (SCM_CAR (ports
), SCM_EOL
), SCM_EOL
);
736 ports
= SCM_CDR (ports
);
739 return SCM_UNSPECIFIED
;
743 #if (SCM_DEBUG_DEPRECATED == 0)
745 SCM_DEFINE (scm_close_all_ports_except
, "close-all-ports-except", 0, 0, 1,
747 "[DEPRECATED] Close all open file ports used by the interpreter\n"
748 "except for those supplied as arguments. This procedure\n"
749 "was intended to be used before an exec call to close file descriptors\n"
750 "which are not needed in the new process. However it has the\n"
751 "undesirable side-effect of flushing buffes, so it's deprecated.\n"
752 "Use port-for-each instead.")
753 #define FUNC_NAME s_scm_close_all_ports_except
756 SCM_VALIDATE_REST_ARGUMENT (ports
);
757 while (i
< scm_t_portable_size
)
759 SCM thisport
= scm_t_portable
[i
]->port
;
761 SCM ports_ptr
= ports
;
763 while (!SCM_NULLP (ports_ptr
))
765 SCM port
= SCM_COERCE_OUTPORT (SCM_CAR (ports_ptr
));
767 SCM_VALIDATE_OPPORT (SCM_ARG1
,port
);
768 if (SCM_EQ_P (port
, thisport
))
770 ports_ptr
= SCM_CDR (ports_ptr
);
775 /* i is not to be incremented here. */
776 scm_close_port (thisport
);
778 return SCM_UNSPECIFIED
;
785 /* Utter miscellany. Gosh, we should clean this up some time. */
787 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
789 "Return @code{#t} if @var{x} is an input port, otherwise return\n"
790 "@code{#f}. Any object satisfying this predicate also satisfies\n"
792 #define FUNC_NAME s_scm_input_port_p
794 return SCM_BOOL (SCM_INPUT_PORT_P (x
));
798 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
800 "Return @code{#t} if @var{x} is an output port, otherwise return\n"
801 "@code{#f}. Any object satisfying this predicate also satisfies\n"
803 #define FUNC_NAME s_scm_output_port_p
805 SCM_COERCE_OUTPORT (x
);
806 return SCM_BOOL (SCM_OUTPUT_PORT_P (x
));
810 SCM_DEFINE (scm_port_p
, "port?", 1, 0, 0,
812 "Return a boolean indicating whether @var{x} is a port.\n"
813 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
815 #define FUNC_NAME s_scm_port_p
817 return SCM_BOOL (SCM_PORTP (x
));
821 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
823 "Return @code{#t} if @var{port} is closed or @code{#f} if it is\n"
825 #define FUNC_NAME s_scm_port_closed_p
827 SCM_VALIDATE_PORT (1,port
);
828 return SCM_BOOL (!SCM_OPPORTP (port
));
832 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
834 "Return @code{#t} if @var{x} is an end-of-file object; otherwise\n"
836 #define FUNC_NAME s_scm_eof_object_p
838 return SCM_BOOL(SCM_EOF_OBJECT_P (x
));
842 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
844 "Flush the specified output port, or the current output port if @var{port}\n"
845 "is omitted. The current output buffer contents are passed to the \n"
846 "underlying port implementation (e.g., in the case of fports, the\n"
847 "data will be written to the file and the output buffer will be cleared.)\n"
848 "It has no effect on an unbuffered port.\n\n"
849 "The return value is unspecified.")
850 #define FUNC_NAME s_scm_force_output
852 if (SCM_UNBNDP (port
))
856 port
= SCM_COERCE_OUTPORT (port
);
857 SCM_VALIDATE_OPOUTPORT (1,port
);
860 return SCM_UNSPECIFIED
;
864 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
866 "Equivalent to calling @code{force-output} on\n"
867 "all open output ports. The return value is unspecified.")
868 #define FUNC_NAME s_scm_flush_all_ports
872 for (i
= 0; i
< scm_t_portable_size
; i
++)
874 if (SCM_OPOUTPORTP (scm_t_portable
[i
]->port
))
875 scm_flush (scm_t_portable
[i
]->port
);
877 return SCM_UNSPECIFIED
;
881 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
883 "Return the next character available from @var{port}, updating\n"
884 "@var{port} to point to the following character. If no more\n"
885 "characters are available, the end-of-file object is returned.")
886 #define FUNC_NAME s_scm_read_char
889 if (SCM_UNBNDP (port
))
891 SCM_VALIDATE_OPINPORT (1,port
);
895 return SCM_MAKE_CHAR (c
);
899 /* this should only be called when the read buffer is empty. it
900 tries to refill the read buffer. it returns the first char from
901 the port, which is either EOF or *(pt->read_pos). */
903 scm_fill_input (SCM port
)
905 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
907 if (pt
->read_buf
== pt
->putback_buf
)
909 /* finished reading put-back chars. */
910 pt
->read_buf
= pt
->saved_read_buf
;
911 pt
->read_pos
= pt
->saved_read_pos
;
912 pt
->read_end
= pt
->saved_read_end
;
913 pt
->read_buf_size
= pt
->saved_read_buf_size
;
914 if (pt
->read_pos
< pt
->read_end
)
915 return *(pt
->read_pos
);
917 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
924 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
926 if (pt
->rw_active
== SCM_PORT_WRITE
)
928 /* may be marginally faster than calling scm_flush. */
929 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
933 pt
->rw_active
= SCM_PORT_READ
;
935 if (pt
->read_pos
>= pt
->read_end
)
937 if (scm_fill_input (port
) == EOF
)
941 c
= *(pt
->read_pos
++);
960 scm_putc (char c
, SCM port
)
962 scm_lfwrite (&c
, 1, port
);
966 scm_puts (const char *s
, SCM port
)
968 scm_lfwrite (s
, strlen (s
), port
);
973 * This function differs from scm_c_write; it updates port line and
977 scm_lfwrite (const char *ptr
, size_t size
, SCM port
)
979 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
980 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
982 if (pt
->rw_active
== SCM_PORT_READ
)
983 scm_end_input (port
);
985 ptob
->write (port
, ptr
, size
);
987 for (; size
; ptr
++, size
--) {
991 else if (*ptr
== '\t') {
1000 pt
->rw_active
= SCM_PORT_WRITE
;
1005 * Used by an application to read arbitrary number of bytes from an
1006 * SCM port. Same semantics as libc read, except that scm_c_read only
1007 * returns less than SIZE bytes if at end-of-file.
1009 * Warning: Doesn't update port line and column counts! */
1012 scm_c_read (SCM port
, void *buffer
, size_t size
)
1014 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1015 size_t n_read
= 0, n_available
;
1017 if (pt
->rw_active
== SCM_PORT_WRITE
)
1018 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
1021 pt
->rw_active
= SCM_PORT_READ
;
1023 if (SCM_READ_BUFFER_EMPTY_P (pt
))
1025 if (scm_fill_input (port
) == EOF
)
1029 n_available
= pt
->read_end
- pt
->read_pos
;
1031 while (n_available
< size
)
1033 memcpy (buffer
, pt
->read_pos
, n_available
);
1034 buffer
= (char *) buffer
+ n_available
;
1035 pt
->read_pos
+= n_available
;
1036 n_read
+= n_available
;
1038 if (SCM_READ_BUFFER_EMPTY_P (pt
))
1040 if (scm_fill_input (port
) == EOF
)
1044 size
-= n_available
;
1045 n_available
= pt
->read_end
- pt
->read_pos
;
1048 memcpy (buffer
, pt
->read_pos
, size
);
1049 pt
->read_pos
+= size
;
1051 return n_read
+ size
;
1056 * Used by an application to write arbitrary number of bytes to an SCM
1057 * port. Similar semantics as libc write. However, unlike libc
1058 * write, scm_c_write writes the requested number of bytes and has no
1061 * Warning: Doesn't update port line and column counts!
1065 scm_c_write (SCM port
, const void *ptr
, size_t size
)
1067 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1068 scm_t_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
1070 if (pt
->rw_active
== SCM_PORT_READ
)
1071 scm_end_input (port
);
1073 ptob
->write (port
, ptr
, size
);
1076 pt
->rw_active
= SCM_PORT_WRITE
;
1080 scm_flush (SCM port
)
1082 long i
= SCM_PTOBNUM (port
);
1083 (scm_ptobs
[i
].flush
) (port
);
1087 scm_end_input (SCM port
)
1090 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1092 if (pt
->read_buf
== pt
->putback_buf
)
1094 offset
= pt
->read_end
- pt
->read_pos
;
1095 pt
->read_buf
= pt
->saved_read_buf
;
1096 pt
->read_pos
= pt
->saved_read_pos
;
1097 pt
->read_end
= pt
->saved_read_end
;
1098 pt
->read_buf_size
= pt
->saved_read_buf_size
;
1103 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
1110 scm_ungetc (int c
, SCM port
)
1111 #define FUNC_NAME "scm_ungetc"
1113 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
1115 if (pt
->read_buf
== pt
->putback_buf
)
1116 /* already using the put-back buffer. */
1118 /* enlarge putback_buf if necessary. */
1119 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
1120 && pt
->read_buf
== pt
->read_pos
)
1122 size_t new_size
= pt
->read_buf_size
* 2;
1123 unsigned char *tmp
= (unsigned char *)
1124 scm_must_realloc (pt
->putback_buf
, pt
->read_buf_size
, new_size
,
1127 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
1128 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
1129 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
1132 /* shift any existing bytes to buffer + 1. */
1133 if (pt
->read_pos
== pt
->read_end
)
1134 pt
->read_end
= pt
->read_buf
+ 1;
1135 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
1137 int count
= pt
->read_end
- pt
->read_pos
;
1139 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
1140 pt
->read_end
= pt
->read_buf
+ 1 + count
;
1143 pt
->read_pos
= pt
->read_buf
;
1146 /* switch to the put-back buffer. */
1148 if (pt
->putback_buf
== NULL
)
1151 = (unsigned char *) scm_must_malloc (SCM_INITIAL_PUTBACK_BUF_SIZE
,
1153 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
1156 pt
->saved_read_buf
= pt
->read_buf
;
1157 pt
->saved_read_pos
= pt
->read_pos
;
1158 pt
->saved_read_end
= pt
->read_end
;
1159 pt
->saved_read_buf_size
= pt
->read_buf_size
;
1161 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
1162 pt
->read_end
= pt
->read_buf
+ 1;
1163 pt
->read_buf_size
= pt
->putback_buf_size
;
1169 pt
->rw_active
= SCM_PORT_READ
;
1173 /* What should col be in this case?
1174 * We'll leave it at -1.
1176 SCM_LINUM (port
) -= 1;
1185 scm_ungets (const char *s
, int n
, SCM port
)
1187 /* This is simple minded and inefficient, but unreading strings is
1188 * probably not a common operation, and remember that line and
1189 * column numbers have to be handled...
1191 * Please feel free to write an optimized version!
1194 scm_ungetc (s
[n
], port
);
1198 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
1200 "Return the next character available from @var{port},\n"
1201 "@emph{without} updating @var{port} to point to the following\n"
1202 "character. If no more characters are available, the\n"
1203 "end-of-file object is returned.@footnote{The value returned by\n"
1204 "a call to @code{peek-char} is the same as the value that would\n"
1205 "have been returned by a call to @code{read-char} on the same\n"
1206 "port. The only difference is that the very next call to\n"
1207 "@code{read-char} or @code{peek-char} on that @var{port} will\n"
1208 "return the value returned by the preceding call to\n"
1209 "@code{peek-char}. In particular, a call to @code{peek-char} on\n"
1210 "an interactive port will hang waiting for input whenever a call\n"
1211 "to @code{read-char} would have hung.}")
1212 #define FUNC_NAME s_scm_peek_char
1215 if (SCM_UNBNDP (port
))
1218 SCM_VALIDATE_OPINPORT (1,port
);
1219 c
= scm_getc (port
);
1222 scm_ungetc (c
, port
);
1223 return SCM_MAKE_CHAR (c
);
1227 SCM_DEFINE (scm_unread_char
, "unread-char", 1, 1, 0,
1228 (SCM cobj
, SCM port
),
1229 "Place @var{char} in @var{port} so that it will be read by the\n"
1230 "next read operation. If called multiple times, the unread characters\n"
1231 "will be read again in last-in first-out order. If @var{port} is\n"
1232 "not supplied, the current input port is used.")
1233 #define FUNC_NAME s_scm_unread_char
1237 SCM_VALIDATE_CHAR (1,cobj
);
1238 if (SCM_UNBNDP (port
))
1241 SCM_VALIDATE_OPINPORT (2,port
);
1243 c
= SCM_CHAR (cobj
);
1245 scm_ungetc (c
, port
);
1250 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1251 (SCM str
, SCM port
),
1252 "Place the string @var{str} in @var{port} so that its characters will be\n"
1253 "read in subsequent read operations. If called multiple times, the\n"
1254 "unread characters will be read again in last-in first-out order. If\n"
1255 "@var{port} is not supplied, the current-input-port is used.")
1256 #define FUNC_NAME s_scm_unread_string
1258 SCM_VALIDATE_STRING (1,str
);
1259 if (SCM_UNBNDP (port
))
1262 SCM_VALIDATE_OPINPORT (2,port
);
1264 scm_ungets (SCM_STRING_CHARS (str
), SCM_STRING_LENGTH (str
), port
);
1270 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1271 (SCM fd_port
, SCM offset
, SCM whence
),
1272 "Sets the current position of @var{fd/port} to the integer\n"
1273 "@var{offset}, which is interpreted according to the value of\n"
1276 "One of the following variables should be supplied for\n"
1278 "@defvar SEEK_SET\n"
1279 "Seek from the beginning of the file.\n"
1281 "@defvar SEEK_CUR\n"
1282 "Seek from the current position.\n"
1284 "@defvar SEEK_END\n"
1285 "Seek from the end of the file.\n"
1287 "If @var{fd/port} is a file descriptor, the underlying system\n"
1288 "call is @code{lseek}. @var{port} may be a string port.\n"
1290 "The value returned is the new position in the file. This means\n"
1291 "that the current position of a port can be obtained using:\n"
1293 "(seek port 0 SEEK_CUR)\n"
1295 #define FUNC_NAME s_scm_seek
1301 fd_port
= SCM_COERCE_OUTPORT (fd_port
);
1303 off
= SCM_NUM2LONG (2, offset
);
1304 SCM_VALIDATE_INUM_COPY (3, whence
, how
);
1305 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1306 SCM_OUT_OF_RANGE (3, whence
);
1307 if (SCM_OPPORTP (fd_port
))
1309 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (fd_port
);
1312 SCM_MISC_ERROR ("port is not seekable",
1313 scm_cons (fd_port
, SCM_EOL
));
1315 rv
= ptob
->seek (fd_port
, off
, how
);
1317 else /* file descriptor?. */
1319 SCM_VALIDATE_INUM (1,fd_port
);
1320 rv
= lseek (SCM_INUM (fd_port
), off
, how
);
1324 return scm_long2num (rv
);
1328 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1329 (SCM object
, SCM length
),
1330 "Truncates the object referred to by @var{object} to at most\n"
1331 "@var{length} bytes. @var{object} can be a string containing a\n"
1332 "file name or an integer file descriptor or a port.\n"
1333 "@var{length} may be omitted if @var{object} is not a file name,\n"
1334 "in which case the truncation occurs at the current port.\n"
1335 "position. The return value is unspecified.")
1336 #define FUNC_NAME s_scm_truncate_file
1341 /* object can be a port, fdes or filename. */
1343 if (SCM_UNBNDP (length
))
1345 /* must supply length if object is a filename. */
1346 if (SCM_STRINGP (object
))
1347 SCM_MISC_ERROR("must supply length if OBJECT is a filename",SCM_EOL
);
1349 length
= scm_seek (object
, SCM_INUM0
, SCM_MAKINUM (SEEK_CUR
));
1351 c_length
= SCM_NUM2LONG (2,length
);
1353 SCM_MISC_ERROR ("negative offset", SCM_EOL
);
1355 object
= SCM_COERCE_OUTPORT (object
);
1356 if (SCM_INUMP (object
))
1358 SCM_SYSCALL (rv
= ftruncate (SCM_INUM (object
), c_length
));
1360 else if (SCM_OPOUTPORTP (object
))
1362 scm_t_port
*pt
= SCM_PTAB_ENTRY (object
);
1363 scm_t_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1365 if (!ptob
->truncate
)
1366 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
1367 if (pt
->rw_active
== SCM_PORT_READ
)
1368 scm_end_input (object
);
1369 else if (pt
->rw_active
== SCM_PORT_WRITE
)
1370 ptob
->flush (object
);
1372 ptob
->truncate (object
, c_length
);
1377 SCM_VALIDATE_STRING (1, object
);
1378 SCM_STRING_COERCE_0TERMINATION_X (object
);
1379 SCM_SYSCALL (rv
= truncate (SCM_STRING_CHARS (object
), c_length
));
1383 return SCM_UNSPECIFIED
;
1387 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
1389 "Return the current line number for @var{port}.")
1390 #define FUNC_NAME s_scm_port_line
1392 port
= SCM_COERCE_OUTPORT (port
);
1393 SCM_VALIDATE_OPENPORT (1,port
);
1394 return SCM_MAKINUM (SCM_LINUM (port
));
1398 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
1399 (SCM port
, SCM line
),
1400 "Set the current line number for @var{port} to @var{line}.")
1401 #define FUNC_NAME s_scm_set_port_line_x
1403 port
= SCM_COERCE_OUTPORT (port
);
1404 SCM_VALIDATE_OPENPORT (1,port
);
1405 SCM_VALIDATE_INUM (2,line
);
1406 SCM_PTAB_ENTRY (port
)->line_number
= SCM_INUM (line
);
1407 return SCM_UNSPECIFIED
;
1411 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
1413 "@deffnx primitive port-line port\n"
1414 "Return the current column number or line number of @var{port},\n"
1415 "using the current input port if none is specified. If the number is\n"
1416 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
1417 "- i.e. the first character of the first line is line 0, column 0.\n"
1418 "(However, when you display a file position, for example in an error\n"
1419 "message, we recommend you add 1 to get 1-origin integers. This is\n"
1420 "because lines and column numbers traditionally start with 1, and that is\n"
1421 "what non-programmers will find most natural.)")
1422 #define FUNC_NAME s_scm_port_column
1424 port
= SCM_COERCE_OUTPORT (port
);
1425 SCM_VALIDATE_OPENPORT (1,port
);
1426 return SCM_MAKINUM (SCM_COL (port
));
1430 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
1431 (SCM port
, SCM column
),
1432 "@deffnx primitive set-port-line! port line\n"
1433 "Set the current column or line number of @var{port}, using the\n"
1434 "current input port if none is specified.")
1435 #define FUNC_NAME s_scm_set_port_column_x
1437 port
= SCM_COERCE_OUTPORT (port
);
1438 SCM_VALIDATE_OPENPORT (1,port
);
1439 SCM_VALIDATE_INUM (2,column
);
1440 SCM_PTAB_ENTRY (port
)->column_number
= SCM_INUM (column
);
1441 return SCM_UNSPECIFIED
;
1445 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
1447 "Return the filename associated with @var{port}. This function returns\n"
1448 "the strings \"standard input\", \"standard output\" and \"standard error\"\n"
1449 "when called on the current input, output and error ports respectively.")
1450 #define FUNC_NAME s_scm_port_filename
1452 port
= SCM_COERCE_OUTPORT (port
);
1453 SCM_VALIDATE_OPENPORT (1,port
);
1454 return SCM_FILENAME (port
);
1458 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
1459 (SCM port
, SCM filename
),
1460 "Change the filename associated with @var{port}, using the current input\n"
1461 "port if none is specified. Note that this does not change the port's\n"
1462 "source of data, but only the value that is returned by\n"
1463 "@code{port-filename} and reported in diagnostic output.")
1464 #define FUNC_NAME s_scm_set_port_filename_x
1466 port
= SCM_COERCE_OUTPORT (port
);
1467 SCM_VALIDATE_OPENPORT (1,port
);
1468 /* We allow the user to set the filename to whatever he likes. */
1469 SCM_SET_FILENAME (port
, filename
);
1470 return SCM_UNSPECIFIED
;
1475 extern char * ttyname();
1479 scm_print_port_mode (SCM exp
, SCM port
)
1481 scm_puts (SCM_CLOSEDP (exp
)
1483 : (SCM_RDNG
& SCM_CELL_WORD_0 (exp
)
1484 ? (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
1487 : (SCM_WRTNG
& SCM_CELL_WORD_0 (exp
)
1494 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
1496 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
1499 scm_puts ("#<", port
);
1500 scm_print_port_mode (exp
, port
);
1501 scm_puts (type
, port
);
1502 scm_putc (' ', port
);
1503 scm_intprint (SCM_CELL_WORD_1 (exp
), 16, port
);
1504 scm_putc ('>', port
);
1509 scm_ports_prehistory ()
1512 scm_ptobs
= (scm_t_ptob_descriptor
*) malloc (sizeof (scm_t_ptob_descriptor
));
1519 scm_t_bits scm_tc16_void_port
= 0;
1521 static int fill_input_void_port (SCM port SCM_UNUSED
)
1527 write_void_port (SCM port SCM_UNUSED
,
1528 const void *data SCM_UNUSED
,
1529 size_t size SCM_UNUSED
)
1534 scm_void_port (char *mode_str
)
1540 SCM_NEWCELL (answer
);
1542 mode_bits
= scm_mode_bits (mode_str
);
1543 pt
= scm_add_to_port_table (answer
);
1544 scm_port_non_buffer (pt
);
1545 SCM_SETPTAB_ENTRY (answer
, pt
);
1546 SCM_SETSTREAM (answer
, 0);
1547 SCM_SET_CELL_TYPE (answer
, scm_tc16_void_port
| mode_bits
);
1552 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
1554 "Create and return a new void port. A void port acts like\n"
1555 "/dev/null. The @var{mode} argument\n"
1556 "specifies the input/output modes for this port: see the\n"
1557 "documentation for @code{open-file} in @ref{File Ports}.")
1558 #define FUNC_NAME s_scm_sys_make_void_port
1560 SCM_VALIDATE_STRING (1, mode
);
1561 SCM_STRING_COERCE_0TERMINATION_X (mode
);
1562 return scm_void_port (SCM_STRING_CHARS (mode
));
1567 /* Initialization. */
1572 /* lseek() symbols. */
1573 scm_c_define ("SEEK_SET", SCM_MAKINUM (SEEK_SET
));
1574 scm_c_define ("SEEK_CUR", SCM_MAKINUM (SEEK_CUR
));
1575 scm_c_define ("SEEK_END", SCM_MAKINUM (SEEK_END
));
1577 scm_tc16_void_port
= scm_make_port_type ("void", fill_input_void_port
,
1579 #ifndef SCM_MAGIC_SNARFER
1580 #include "libguile/ports.x"