1 /* Copyright (C) 1995,1996,1997,1998,1999 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 */
56 #include "scm_validate.h"
71 #ifdef HAVE_SYS_IOCTL_H
72 #include <sys/ioctl.h>
76 /* The port kind table --- a dynamically resized array of port types. */
79 /* scm_ptobs scm_numptob
80 * implement a dynamicly resized array of ptob records.
81 * Indexes into this table are used when generating type
82 * tags for smobjects (if you know a tag you can get an index and conversely).
84 scm_ptob_descriptor
*scm_ptobs
;
87 /* GC marker for a port with stream of SCM type. */
89 scm_markstream (SCM ptr
)
92 openp
= SCM_CAR (ptr
) & SCM_OPN
;
94 return SCM_STREAM (ptr
);
100 * We choose to use an interface similar to the smob interface with
101 * fill_input and write as standard fields, passed to the port
102 * type constructor, and optional fields set by setters.
105 static void flush_void_port (SCM port
);
106 static void end_input_void_port (SCM port
, int offset
);
107 static void write_void_port (SCM port
, const void *data
, size_t size
);
110 scm_make_port_type (char *name
,
111 int (*fill_input
) (SCM port
),
112 void (*write
) (SCM port
, const void *data
, size_t size
))
115 if (255 <= scm_numptob
)
118 SCM_SYSCALL (tmp
= (char *) realloc ((char *) scm_ptobs
,
120 * sizeof (scm_ptob_descriptor
)));
123 scm_ptobs
= (scm_ptob_descriptor
*) tmp
;
125 scm_ptobs
[scm_numptob
].name
= name
;
126 scm_ptobs
[scm_numptob
].mark
= 0;
127 scm_ptobs
[scm_numptob
].free
= scm_free0
;
128 scm_ptobs
[scm_numptob
].print
= scm_port_print
;
129 scm_ptobs
[scm_numptob
].equalp
= 0;
130 scm_ptobs
[scm_numptob
].close
= 0;
132 scm_ptobs
[scm_numptob
].write
= write
;
133 scm_ptobs
[scm_numptob
].flush
= flush_void_port
;
135 scm_ptobs
[scm_numptob
].end_input
= end_input_void_port
;
136 scm_ptobs
[scm_numptob
].fill_input
= fill_input
;
137 scm_ptobs
[scm_numptob
].input_waiting
= 0;
139 scm_ptobs
[scm_numptob
].seek
= 0;
140 scm_ptobs
[scm_numptob
].truncate
= 0;
146 ptoberr
:scm_wta (SCM_MAKINUM ((long) scm_numptob
),
147 (char *) SCM_NALLOC
, "scm_make_port_type");
148 /* Make a class object if Goops is present */
150 scm_make_port_classes (scm_numptob
- 1, SCM_PTOBNAME (scm_numptob
- 1));
151 return scm_tc7_port
+ (scm_numptob
- 1) * 256;
155 scm_set_port_mark (long tc
, SCM (*mark
) (SCM
))
157 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].mark
= mark
;
161 scm_set_port_free (long tc
, scm_sizet (*free
) (SCM
))
163 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].free
= free
;
167 scm_set_port_print (long tc
, int (*print
) (SCM exp
, SCM port
,
168 scm_print_state
*pstate
))
170 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].print
= print
;
174 scm_set_port_equalp (long tc
, SCM (*equalp
) (SCM
, SCM
))
176 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].equalp
= equalp
;
180 scm_set_port_flush (long tc
, void (*flush
) (SCM port
))
182 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].flush
= flush
;
186 scm_set_port_end_input (long tc
, void (*end_input
) (SCM port
, int offset
))
188 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].end_input
= end_input
;
192 scm_set_port_close (long tc
, int (*close
) (SCM
))
194 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].close
= close
;
198 scm_set_port_seek (long tc
, off_t (*seek
) (SCM port
,
202 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].seek
= seek
;
206 scm_set_port_truncate (long tc
, void (*truncate
) (SCM port
, off_t length
))
208 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].truncate
= truncate
;
212 scm_set_port_input_waiting (long tc
, int (*input_waiting
) (SCM
))
214 scm_ptobs
[SCM_TC2PTOBNUM (tc
)].input_waiting
= input_waiting
;
219 SCM_DEFINE (scm_char_ready_p
, "char-ready?", 0, 1, 0,
221 "Returns @code{#t} if a character is ready on input @var{port} and\n"
222 "returns @code{#f} otherwise. If @code{char-ready?} returns @code{#t}\n"
223 "then the next @code{read-char} operation on @var{port} is\n"
224 "guaranteed not to hang. If @var{port} is a file port at end of\n"
225 "file then @code{char-ready?} returns @code{#t}.\n"
226 "@footnote{@code{char-ready?} exists to make it possible for a\n"
227 "program to accept characters from interactive ports without getting\n"
228 "stuck waiting for input. Any input editors associated with such ports\n"
229 "must make sure that characters whose existence has been asserted by\n"
230 "@code{char-ready?} cannot be rubbed out. If @code{char-ready?} were to\n"
231 "return @code{#f} at end of file, a port at end of file would be\n"
232 "indistinguishable from an interactive port that has no ready\n"
234 #define FUNC_NAME s_scm_char_ready_p
238 if (SCM_UNBNDP (port
))
241 SCM_VALIDATE_OPINPORT (1,port
);
243 pt
= SCM_PTAB_ENTRY (port
);
245 /* if the current read buffer is filled, or the
246 last pushed-back char has been read and the saved buffer is
247 filled, result is true. */
248 if (pt
->read_pos
< pt
->read_end
249 || (pt
->read_buf
== pt
->putback_buf
250 && pt
->saved_read_pos
< pt
->saved_read_end
))
254 scm_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
256 if (ptob
->input_waiting
)
257 return SCM_BOOL(ptob
->input_waiting (port
));
264 /* Clear a port's read buffers, returning the contents. */
265 SCM_DEFINE (scm_drain_input
, "drain-input", 1, 0, 0,
267 "Drains @var{PORT}'s read buffers (including any pushed-back characters)\n"
268 "and returns the contents as a single string.")
269 #define FUNC_NAME s_scm_drain_input
272 scm_port
*pt
= SCM_PTAB_ENTRY (port
);
276 SCM_VALIDATE_OPINPORT (1,port
);
278 count
= pt
->read_end
- pt
->read_pos
;
279 if (pt
->read_buf
== pt
->putback_buf
)
280 count
+= pt
->saved_read_end
- pt
->saved_read_pos
;
282 result
= scm_makstr (count
, 0);
283 dst
= SCM_CHARS (result
);
285 while (pt
->read_pos
< pt
->read_end
)
286 *dst
++ = *(pt
->read_pos
++);
288 if (pt
->read_buf
== pt
->putback_buf
)
290 while (pt
->saved_read_pos
< pt
->saved_read_end
)
291 *dst
++ = *(pt
->saved_read_pos
++);
299 /* Standard ports --- current input, output, error, and more(!). */
301 SCM_DEFINE (scm_current_input_port
, "current-input-port", 0, 0, 0,
303 "Returns the current input port. This is the default port used by many\n"
304 "input procedures. Initially, @code{current-input-port} returns the\n"
305 "value of @code{???}.")
306 #define FUNC_NAME s_scm_current_input_port
312 SCM_DEFINE (scm_current_output_port
, "current-output-port", 0, 0, 0,
314 "Returns the current output port. This is the default port used by many\n"
315 "output procedures. Initially, @code{current-output-port} returns the\n"
316 "value of @code{???}.")
317 #define FUNC_NAME s_scm_current_output_port
323 SCM_DEFINE (scm_current_error_port
, "current-error-port", 0, 0, 0,
325 "Return the port to which errors and warnings should be sent (the\n"
326 "@dfn{standard error} in Unix and C terminology).")
327 #define FUNC_NAME s_scm_current_error_port
333 SCM_DEFINE (scm_current_load_port
, "current-load-port", 0, 0, 0,
335 "Return the current-load-port.\n"
336 "The load port is used internally by `primitive-load'.")
337 #define FUNC_NAME s_scm_current_load_port
339 return scm_cur_loadp
;
343 SCM_DEFINE (scm_set_current_input_port
, "set-current-input-port", 1, 0, 0,
345 "@deffnx primitive set-current-output-port port\n"
346 "@deffnx primitive set-current-error-port port\n"
347 "Change the ports returned by @code{current-input-port},\n"
348 "@code{current-output-port} and @code{current-error-port}, respectively,\n"
349 "so that they use the supplied @var{port} for input or output.")
350 #define FUNC_NAME s_scm_set_current_input_port
352 SCM oinp
= scm_cur_inp
;
353 SCM_VALIDATE_OPINPORT (1,port
);
360 SCM_DEFINE (scm_set_current_output_port
, "set-current-output-port", 1, 0, 0,
362 "Set the current default output port to PORT.")
363 #define FUNC_NAME s_scm_set_current_output_port
365 SCM ooutp
= scm_cur_outp
;
366 port
= SCM_COERCE_OUTPORT (port
);
367 SCM_VALIDATE_OPOUTPORT (1,port
);
374 SCM_DEFINE (scm_set_current_error_port
, "set-current-error-port", 1, 0, 0,
376 "Set the current default error port to PORT.")
377 #define FUNC_NAME s_scm_set_current_error_port
379 SCM oerrp
= scm_cur_errp
;
380 port
= SCM_COERCE_OUTPORT (port
);
381 SCM_VALIDATE_OPOUTPORT (1,port
);
388 /* The port table --- an array of pointers to ports. */
390 scm_port
**scm_port_table
;
392 int scm_port_table_size
= 0; /* Number of ports in scm_port_table. */
393 int scm_port_table_room
= 20; /* Size of the array. */
395 /* Add a port to the table. */
398 scm_add_to_port_table (SCM port
)
402 if (scm_port_table_size
== scm_port_table_room
)
404 void *newt
= realloc ((char *) scm_port_table
,
405 (scm_sizet
) (sizeof (scm_port
*)
406 * scm_port_table_room
* 2));
408 scm_memory_error ("scm_add_to_port_table");
409 scm_port_table
= (scm_port
**) newt
;
410 scm_port_table_room
*= 2;
412 entry
= (scm_port
*) malloc (sizeof (scm_port
));
414 scm_memory_error ("scm_add_to_port_table");
417 entry
->entry
= scm_port_table_size
;
420 entry
->file_name
= SCM_BOOL_F
;
421 entry
->line_number
= 0;
422 entry
->column_number
= 0;
423 entry
->putback_buf
= 0;
424 entry
->putback_buf_size
= 0;
425 entry
->rw_active
= SCM_PORT_NEITHER
;
426 entry
->rw_random
= 0;
428 scm_port_table
[scm_port_table_size
] = entry
;
429 scm_port_table_size
++;
434 /* Remove a port from the table and destroy it. */
437 scm_remove_from_port_table (SCM port
)
439 scm_port
*p
= SCM_PTAB_ENTRY (port
);
442 if (i
>= scm_port_table_size
)
443 scm_wta (port
, "Port not in table", "scm_remove_from_port_table");
445 free (p
->putback_buf
);
447 /* Since we have just freed slot i we can shrink the table by moving
448 the last entry to that slot... */
449 if (i
< scm_port_table_size
- 1)
451 scm_port_table
[i
] = scm_port_table
[scm_port_table_size
- 1];
452 scm_port_table
[i
]->entry
= i
;
454 SCM_SETPTAB_ENTRY (port
, 0);
455 scm_port_table_size
--;
459 /* Functions for debugging. */
461 SCM_DEFINE (scm_pt_size
, "pt-size", 0, 0, 0,
463 "Returns the number of ports in the port table.\n"
464 "`pt-size' is only included in GUILE_DEBUG builds.")
465 #define FUNC_NAME s_scm_pt_size
467 return SCM_MAKINUM (scm_port_table_size
);
471 SCM_DEFINE (scm_pt_member
, "pt-member", 1, 0, 0,
473 "Returns the port at INDEX in the port table.\n"
474 "`pt-member' is only included in GUILE_DEBUG builds.")
475 #define FUNC_NAME s_scm_pt_member
478 SCM_VALIDATE_INUM_COPY (1,index
,i
);
479 if (i
< 0 || i
>= scm_port_table_size
)
482 return scm_port_table
[i
]->port
;
489 /* Revealed counts --- an oddity inherited from SCSH. */
491 /* Find a port in the table and return its revealed count.
492 Also used by the garbage collector.
496 scm_revealed_count (SCM port
)
498 return SCM_REVEALED(port
);
503 /* Return the revealed count for a port. */
505 SCM_DEFINE (scm_port_revealed
, "port-revealed", 1, 0, 0,
507 "Returns the revealed count for @var{port}.")
508 #define FUNC_NAME s_scm_port_revealed
510 port
= SCM_COERCE_OUTPORT (port
);
511 SCM_VALIDATE_PORT (1,port
);
512 return SCM_MAKINUM (scm_revealed_count (port
));
516 /* Set the revealed count for a port. */
517 SCM_DEFINE (scm_set_port_revealed_x
, "set-port-revealed!", 2, 0, 0,
518 (SCM port
, SCM rcount
),
519 "Sets the revealed count for a port to a given value.\n"
520 "The return value is unspecified.")
521 #define FUNC_NAME s_scm_set_port_revealed_x
523 port
= SCM_COERCE_OUTPORT (port
);
524 SCM_VALIDATE_PORT (1,port
);
525 SCM_VALIDATE_INUM (2,rcount
);
526 SCM_REVEALED (port
) = SCM_INUM (rcount
);
527 return SCM_UNSPECIFIED
;
533 /* Retrieving a port's mode. */
535 /* Return the flags that characterize a port based on the mode
536 * string used to open a file for that port.
538 * See PORT FLAGS in scm.h
542 scm_mode_bits (char *modes
)
545 | (strchr (modes
, 'r') || strchr (modes
, '+') ? SCM_RDNG
: 0)
546 | ( strchr (modes
, 'w')
547 || strchr (modes
, 'a')
548 || strchr (modes
, '+') ? SCM_WRTNG
: 0)
549 | (strchr (modes
, '0') ? SCM_BUF0
: 0)
550 | (strchr (modes
, 'l') ? SCM_BUFLINE
: 0));
554 /* Return the mode flags from an open port.
555 * Some modes such as "append" are only used when opening
556 * a file and are not returned here. */
558 SCM_DEFINE (scm_port_mode
, "port-mode", 1, 0, 0,
560 "Returns the port modes associated with the open port @var{port}. These\n"
561 "will not necessarily be identical to the modes used when the port was\n"
562 "opened, since modes such as \"append\" which are used only during\n"
563 "port creation are not retained.")
564 #define FUNC_NAME s_scm_port_mode
569 port
= SCM_COERCE_OUTPORT (port
);
570 SCM_VALIDATE_OPPORT (1,port
);
571 if (SCM_CAR (port
) & SCM_RDNG
) {
572 if (SCM_CAR (port
) & SCM_WRTNG
)
573 strcpy (modes
, "r+");
577 else if (SCM_CAR (port
) & SCM_WRTNG
)
579 if (SCM_CAR (port
) & SCM_BUF0
)
581 return scm_makfromstr (modes
, strlen (modes
), 0);
590 * Call the close operation on a port object.
591 * see also scm_close.
593 SCM_DEFINE (scm_close_port
, "close-port", 1, 0, 0,
595 "Close the specified port object. Returns @code{#t} if it successfully\n"
596 "closes a port or @code{#f} if it was already\n"
597 "closed. An exception may be raised if an error occurs, for example\n"
598 "when flushing buffered output.\n"
599 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
600 "which can close file descriptors.")
601 #define FUNC_NAME s_scm_close_port
606 port
= SCM_COERCE_OUTPORT (port
);
608 SCM_VALIDATE_PORT (1,port
);
609 if (SCM_CLOSEDP (port
))
611 i
= SCM_PTOBNUM (port
);
612 if (scm_ptobs
[i
].close
)
613 rv
= (scm_ptobs
[i
].close
) (port
);
616 scm_remove_from_port_table (port
);
617 SCM_SETAND_CAR (port
, ~SCM_OPN
);
618 return SCM_NEGATE_BOOL(rv
< 0);
622 SCM_DEFINE (scm_close_all_ports_except
, "close-all-ports-except", 0, 0, 1,
624 "Close all open file ports used by the interpreter\n"
625 "except for those supplied as arguments. This procedure\n"
626 "is intended to be used before an exec call to close file descriptors\n"
627 "which are not needed in the new process.Close all open file ports used by the interpreter\n"
628 "except for those supplied as arguments. This procedure\n"
629 "is intended to be used before an exec call to close file descriptors\n"
630 "which are not needed in the new process.")
631 #define FUNC_NAME s_scm_close_all_ports_except
634 SCM_VALIDATE_CONS (1,ports
);
635 while (i
< scm_port_table_size
)
637 SCM thisport
= scm_port_table
[i
]->port
;
639 SCM ports_ptr
= ports
;
641 while (SCM_NNULLP (ports_ptr
))
643 SCM port
= SCM_COERCE_OUTPORT (SCM_CAR (ports_ptr
));
645 SCM_VALIDATE_OPPORT (SCM_ARG1
,port
);
646 if (port
== thisport
)
648 ports_ptr
= SCM_CDR (ports_ptr
);
653 /* i is not to be incremented here. */
654 scm_close_port (thisport
);
656 return SCM_UNSPECIFIED
;
662 /* Utter miscellany. Gosh, we should clean this up some time. */
664 SCM_DEFINE (scm_input_port_p
, "input-port?", 1, 0, 0,
666 "Returns @code{#t} if @var{x} is an input port, otherwise returns\n"
667 "@code{#f}. Any object satisfying this predicate also satisfies\n"
669 #define FUNC_NAME s_scm_input_port_p
673 return SCM_BOOL(SCM_INPORTP (x
));
677 SCM_DEFINE (scm_output_port_p
, "output-port?", 1, 0, 0,
679 "Returns @code{#t} if @var{x} is an output port, otherwise returns\n"
680 "@code{#f}. Any object satisfying this predicate also satisfies\n"
682 #define FUNC_NAME s_scm_output_port_p
686 if (SCM_PORT_WITH_PS_P (x
))
687 x
= SCM_PORT_WITH_PS_PORT (x
);
688 return SCM_BOOL(SCM_OUTPORTP (x
));
692 SCM_DEFINE (scm_port_closed_p
, "port-closed?", 1, 0, 0,
694 "Returns @code{#t} if @var{port} is closed or @code{#f} if it is open.")
695 #define FUNC_NAME s_scm_port_closed_p
697 SCM_VALIDATE_PORT (1,port
);
698 return SCM_NEGATE_BOOL(SCM_OPPORTP (port
));
702 SCM_DEFINE (scm_eof_object_p
, "eof-object?", 1, 0, 0,
704 "Returns @code{#t} if @var{x} is an end-of-file object; otherwise\n"
705 "returns @code{#f}.")
706 #define FUNC_NAME s_scm_eof_object_p
708 return SCM_BOOL(SCM_EOF_OBJECT_P (x
));
712 SCM_DEFINE (scm_force_output
, "force-output", 0, 1, 0,
714 "Flush the specified output port, or the current output port if @var{port}\n"
715 "is omitted. The current output buffer contents are passed to the \n"
716 "underlying port implementation (e.g., in the case of fports, the\n"
717 "data will be written to the file and the output buffer will be cleared.)\n"
718 "It has no effect on an unbuffered port.\n\n"
719 "The return value is unspecified.")
720 #define FUNC_NAME s_scm_force_output
722 if (SCM_UNBNDP (port
))
726 port
= SCM_COERCE_OUTPORT (port
);
727 SCM_VALIDATE_OPOUTPORT (1,port
);
730 return SCM_UNSPECIFIED
;
734 SCM_DEFINE (scm_flush_all_ports
, "flush-all-ports", 0, 0, 0,
736 "Equivalent to calling @code{force-output} on\n"
737 "all open output ports. The return value is unspecified.")
738 #define FUNC_NAME s_scm_flush_all_ports
742 for (i
= 0; i
< scm_port_table_size
; i
++)
744 if (SCM_OPOUTPORTP (scm_port_table
[i
]->port
))
745 scm_flush (scm_port_table
[i
]->port
);
747 return SCM_UNSPECIFIED
;
751 SCM_DEFINE (scm_read_char
, "read-char", 0, 1, 0,
753 "Returns the next character available from @var{port}, updating\n"
754 "@var{port} to point to the following character. If no more\n"
755 "characters are available, an end-of-file object is returned.")
756 #define FUNC_NAME s_scm_read_char
759 if (SCM_UNBNDP (port
))
761 SCM_VALIDATE_OPINPORT (1,port
);
765 return SCM_MAKICHR (c
);
769 /* this should only be called when the read buffer is empty. it
770 tries to refill the read buffer. it returns the first char from
771 the port, which is either EOF or *(pt->read_pos). */
773 scm_fill_input (SCM port
)
775 scm_port
*pt
= SCM_PTAB_ENTRY (port
);
777 if (pt
->read_buf
== pt
->putback_buf
)
779 /* finished reading put-back chars. */
780 pt
->read_buf
= pt
->saved_read_buf
;
781 pt
->read_pos
= pt
->saved_read_pos
;
782 pt
->read_end
= pt
->saved_read_end
;
783 pt
->read_buf_size
= pt
->saved_read_buf_size
;
784 if (pt
->read_pos
< pt
->read_end
)
785 return *(pt
->read_pos
);
787 return scm_ptobs
[SCM_PTOBNUM (port
)].fill_input (port
);
794 scm_port
*pt
= SCM_PTAB_ENTRY (port
);
796 if (pt
->rw_active
== SCM_PORT_WRITE
)
798 /* may be marginally faster than calling scm_flush. */
799 scm_ptobs
[SCM_PTOBNUM (port
)].flush (port
);
803 pt
->rw_active
= SCM_PORT_READ
;
805 if (pt
->read_pos
>= pt
->read_end
)
807 if (scm_fill_input (port
) == EOF
)
811 c
= *(pt
->read_pos
++);
830 scm_putc (char c
, SCM port
)
832 scm_lfwrite (&c
, 1, port
);
836 scm_puts (const char *s
, SCM port
)
838 scm_lfwrite (s
, strlen (s
), port
);
842 scm_lfwrite (const char *ptr
, scm_sizet size
, SCM port
)
844 scm_port
*pt
= SCM_PTAB_ENTRY (port
);
845 scm_ptob_descriptor
*ptob
= &scm_ptobs
[SCM_PTOBNUM (port
)];
847 if (pt
->rw_active
== SCM_PORT_READ
)
848 scm_end_input (port
);
850 ptob
->write (port
, ptr
, size
);
853 pt
->rw_active
= SCM_PORT_WRITE
;
860 scm_sizet i
= SCM_PTOBNUM (port
);
861 (scm_ptobs
[i
].flush
) (port
);
865 scm_end_input (SCM port
)
868 scm_port
*pt
= SCM_PTAB_ENTRY (port
);
870 if (pt
->read_buf
== pt
->putback_buf
)
872 offset
= pt
->read_end
- pt
->read_pos
;
873 pt
->read_buf
= pt
->saved_read_buf
;
874 pt
->read_pos
= pt
->saved_read_pos
;
875 pt
->read_end
= pt
->saved_read_end
;
876 pt
->read_buf_size
= pt
->saved_read_buf_size
;
881 scm_ptobs
[SCM_PTOBNUM (port
)].end_input (port
, offset
);
888 scm_ungetc (int c
, SCM port
)
890 scm_port
*pt
= SCM_PTAB_ENTRY (port
);
892 if (pt
->read_buf
== pt
->putback_buf
)
893 /* already using the put-back buffer. */
895 /* enlarge putback_buf if necessary. */
896 if (pt
->read_end
== pt
->read_buf
+ pt
->read_buf_size
897 && pt
->read_buf
== pt
->read_pos
)
899 int new_size
= pt
->read_buf_size
* 2;
901 (unsigned char *) realloc (pt
->putback_buf
, new_size
);
904 scm_memory_error ("scm_ungetc");
905 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
= tmp
;
906 pt
->read_end
= pt
->read_buf
+ pt
->read_buf_size
;
907 pt
->read_buf_size
= pt
->putback_buf_size
= new_size
;
910 /* shift any existing bytes to buffer + 1. */
911 if (pt
->read_pos
== pt
->read_end
)
912 pt
->read_end
= pt
->read_buf
+ 1;
913 else if (pt
->read_pos
!= pt
->read_buf
+ 1)
915 int count
= pt
->read_end
- pt
->read_pos
;
917 memmove (pt
->read_buf
+ 1, pt
->read_pos
, count
);
918 pt
->read_end
= pt
->read_buf
+ 1 + count
;
921 pt
->read_pos
= pt
->read_buf
;
924 /* switch to the put-back buffer. */
926 if (pt
->putback_buf
== NULL
)
928 pt
->putback_buf
= (char *) malloc (SCM_INITIAL_PUTBACK_BUF_SIZE
);
929 if (pt
->putback_buf
== NULL
)
930 scm_memory_error ("scm_ungetc");
931 pt
->putback_buf_size
= SCM_INITIAL_PUTBACK_BUF_SIZE
;
934 pt
->saved_read_buf
= pt
->read_buf
;
935 pt
->saved_read_pos
= pt
->read_pos
;
936 pt
->saved_read_end
= pt
->read_end
;
937 pt
->saved_read_buf_size
= pt
->read_buf_size
;
939 pt
->read_pos
= pt
->read_buf
= pt
->putback_buf
;
940 pt
->read_end
= pt
->read_buf
+ 1;
941 pt
->read_buf_size
= pt
->putback_buf_size
;
947 pt
->rw_active
= SCM_PORT_READ
;
951 /* What should col be in this case?
952 * We'll leave it at -1.
954 SCM_LINUM (port
) -= 1;
962 scm_ungets (const char *s
, int n
, SCM port
)
964 /* This is simple minded and inefficient, but unreading strings is
965 * probably not a common operation, and remember that line and
966 * column numbers have to be handled...
968 * Please feel free to write an optimized version!
971 scm_ungetc (s
[n
], port
);
975 SCM_DEFINE (scm_peek_char
, "peek-char", 0, 1, 0,
977 "Returns the next character available from @var{port},\n"
978 "@emph{without} updating @var{port} to point to the following\n"
979 "character. If no more characters are available, an end-of-file object\n"
980 "is returned.@footnote{The value returned by a call to @code{peek-char}\n"
981 "is the same as the value that would have been returned by a call to\n"
982 "@code{read-char} on the same port. The only difference is that the very\n"
983 "next call to @code{read-char} or @code{peek-char} on that\n"
984 "@var{port} will return the value returned by the preceding call to\n"
985 "@code{peek-char}. In particular, a call to @code{peek-char} on an\n"
986 "interactive port will hang waiting for input whenever a call to\n"
987 "@code{read-char} would have hung.}")
988 #define FUNC_NAME s_scm_peek_char
991 if (SCM_UNBNDP (port
))
994 SCM_VALIDATE_OPINPORT (1,port
);
998 scm_ungetc (c
, port
);
999 return SCM_MAKICHR (c
);
1003 SCM_DEFINE (scm_unread_char
, "unread-char", 2, 0, 0,
1004 (SCM cobj
, SCM port
),
1005 "Place @var{char} in @var{port} so that it will be read by the\n"
1006 "next read operation. If called multiple times, the unread characters\n"
1007 "will be read again in last-in first-out order. If @var{port} is\n"
1008 "not supplied, the current input port is used.")
1009 #define FUNC_NAME s_scm_unread_char
1013 SCM_VALIDATE_ICHR (1,cobj
);
1014 if (SCM_UNBNDP (port
))
1017 SCM_VALIDATE_OPINPORT (2,port
);
1019 c
= SCM_ICHR (cobj
);
1021 scm_ungetc (c
, port
);
1026 SCM_DEFINE (scm_unread_string
, "unread-string", 2, 0, 0,
1027 (SCM str
, SCM port
),
1028 "Place the string @var{str} in @var{port} so that its characters will be\n"
1029 "read in subsequent read operations. If called multiple times, the\n"
1030 "unread characters will be read again in last-in first-out order. If\n"
1031 "@var{port} is not supplied, the current-input-port is used.")
1032 #define FUNC_NAME s_scm_unread_string
1034 SCM_VALIDATE_STRING (1,str
);
1035 if (SCM_UNBNDP (port
))
1038 SCM_VALIDATE_OPINPORT (2,port
);
1040 scm_ungets (SCM_ROUCHARS (str
), SCM_LENGTH (str
), port
);
1046 SCM_DEFINE (scm_seek
, "seek", 3, 0, 0,
1047 (SCM object
, SCM offset
, SCM whence
),
1048 "Sets the current position of @var{fd/port} to the integer @var{offset},\n"
1049 "which is interpreted according to the value of @var{whence}.\n\n"
1050 "One of the following variables should be supplied\n"
1051 "for @var{whence}:\n"
1052 "@defvar SEEK_SET\n"
1053 "Seek from the beginning of the file.\n"
1055 "@defvar SEEK_CUR\n"
1056 "Seek from the current position.\n"
1058 "@defvar SEEK_END\n"
1059 "Seek from the end of the file.\n"
1061 "If @var{fd/port} is a file descriptor, the underlying system call is\n"
1062 "@code{lseek}. @var{port} may be a string port.\n\n"
1063 "The value returned is the new position in the file. This means that\n"
1064 "the current position of a port can be obtained using:\n"
1066 "(seek port 0 SEEK_CUR)\n"
1068 #define FUNC_NAME s_scm_seek
1074 object
= SCM_COERCE_OUTPORT (object
);
1076 off
= SCM_NUM2LONG (2,offset
);
1077 SCM_VALIDATE_INUM_COPY (3,whence
,how
);
1078 if (how
!= SEEK_SET
&& how
!= SEEK_CUR
&& how
!= SEEK_END
)
1079 SCM_OUT_OF_RANGE (3, whence
);
1080 if (SCM_OPPORTP (object
))
1082 scm_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1085 SCM_MISC_ERROR ("port is not seekable",
1086 scm_cons (object
, SCM_EOL
));
1088 rv
= ptob
->seek (object
, off
, how
);
1090 else /* file descriptor?. */
1092 SCM_VALIDATE_INUM (1,object
);
1093 rv
= lseek (SCM_INUM (object
), off
, how
);
1097 return scm_long2num (rv
);
1101 SCM_DEFINE (scm_truncate_file
, "truncate-file", 1, 1, 0,
1102 (SCM object
, SCM length
),
1103 "Truncates the object referred to by @var{obj} to at most @var{size} bytes.\n"
1104 "@var{obj} can be a string containing a file name or an integer file\n"
1105 "descriptor or a port. @var{size} may be omitted if @var{obj} is not\n"
1106 "a file name, in which case the truncation occurs at the current port.\n"
1108 "The return value is unspecified.")
1109 #define FUNC_NAME s_scm_truncate_file
1114 /* object can be a port, fdes or filename. */
1116 if (SCM_UNBNDP (length
))
1118 /* must supply length if object is a filename. */
1119 if (SCM_ROSTRINGP (object
))
1120 SCM_MISC_ERROR("must supply length if OBJECT is a filename",SCM_EOL
);
1122 length
= scm_seek (object
, SCM_INUM0
, SCM_MAKINUM (SEEK_CUR
));
1124 c_length
= SCM_NUM2LONG (2,length
);
1126 SCM_MISC_ERROR ("negative offset", SCM_EOL
);
1128 object
= SCM_COERCE_OUTPORT (object
);
1129 if (SCM_INUMP (object
))
1131 SCM_SYSCALL (rv
= ftruncate (SCM_INUM (object
), c_length
));
1133 else if (SCM_OPOUTPORTP (object
))
1135 scm_port
*pt
= SCM_PTAB_ENTRY (object
);
1136 scm_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (object
);
1138 if (!ptob
->truncate
)
1139 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL
);
1140 if (pt
->rw_active
== SCM_PORT_READ
)
1141 scm_end_input (object
);
1142 else if (pt
->rw_active
== SCM_PORT_WRITE
)
1143 ptob
->flush (object
);
1145 ptob
->truncate (object
, c_length
);
1150 SCM_VALIDATE_ROSTRING (1,object
);
1151 SCM_COERCE_SUBSTR (object
);
1152 SCM_SYSCALL (rv
= truncate (SCM_ROCHARS (object
), c_length
));
1156 return SCM_UNSPECIFIED
;
1160 SCM_DEFINE (scm_port_line
, "port-line", 1, 0, 0,
1162 "Return the current line number for PORT.")
1163 #define FUNC_NAME s_scm_port_line
1165 port
= SCM_COERCE_OUTPORT (port
);
1166 SCM_VALIDATE_OPENPORT (1,port
);
1167 return SCM_MAKINUM (SCM_LINUM (port
));
1171 SCM_DEFINE (scm_set_port_line_x
, "set-port-line!", 2, 0, 0,
1172 (SCM port
, SCM line
),
1173 "Set the current line number for PORT to LINE.")
1174 #define FUNC_NAME s_scm_set_port_line_x
1176 port
= SCM_COERCE_OUTPORT (port
);
1177 SCM_VALIDATE_OPENPORT (1,port
);
1178 SCM_VALIDATE_INUM (2,line
);
1179 return SCM_PTAB_ENTRY (port
)->line_number
= SCM_INUM (line
);
1183 SCM_DEFINE (scm_port_column
, "port-column", 1, 0, 0,
1185 "@deffnx primitive port-line [input-port]\n"
1186 "Return the current column number or line number of @var{input-port},\n"
1187 "using the current input port if none is specified. If the number is\n"
1188 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
1189 "- i.e. the first character of the first line is line 0, column 0.\n"
1190 "(However, when you display a file position, for example in an error\n"
1191 "message, we recommand you add 1 to get 1-origin integers. This is\n"
1192 "because lines and column numbers traditionally start with 1, and that is\n"
1193 "what non-programmers will find most natural.)")
1194 #define FUNC_NAME s_scm_port_column
1196 port
= SCM_COERCE_OUTPORT (port
);
1197 SCM_VALIDATE_OPENPORT (1,port
);
1198 return SCM_MAKINUM (SCM_COL (port
));
1202 SCM_DEFINE (scm_set_port_column_x
, "set-port-column!", 2, 0, 0,
1203 (SCM port
, SCM column
),
1204 "@deffnx primitive set-port-line! [input-port] line\n"
1205 "Set the current column or line number of @var{input-port}, using the\n"
1206 "current input port if none is specified.")
1207 #define FUNC_NAME s_scm_set_port_column_x
1209 port
= SCM_COERCE_OUTPORT (port
);
1210 SCM_VALIDATE_OPENPORT (1,port
);
1211 SCM_VALIDATE_INUM (2,column
);
1212 return SCM_PTAB_ENTRY (port
)->column_number
= SCM_INUM (column
);
1216 SCM_DEFINE (scm_port_filename
, "port-filename", 1, 0, 0,
1218 "Return the filename associated with @var{port}. This function returns\n"
1219 "the strings \"standard input\", \"standard output\" and \"standard error\""
1220 "when called on the current input, output and error ports respectively.")
1221 #define FUNC_NAME s_scm_port_filename
1223 port
= SCM_COERCE_OUTPORT (port
);
1224 SCM_VALIDATE_OPENPORT (1,port
);
1225 return SCM_PTAB_ENTRY (port
)->file_name
;
1229 SCM_DEFINE (scm_set_port_filename_x
, "set-port-filename!", 2, 0, 0,
1230 (SCM port
, SCM filename
),
1231 "Change the filename associated with @var{port}, using the current input\n"
1232 "port if none is specified. Note that this does not change the port's\n"
1233 "source of data, but only the value that is returned by\n"
1234 "@code{port-filename} and reported in diagnostic output.")
1235 #define FUNC_NAME s_scm_set_port_filename_x
1237 port
= SCM_COERCE_OUTPORT (port
);
1238 SCM_VALIDATE_OPENPORT (1,port
);
1239 /* We allow the user to set the filename to whatever he likes. */
1240 return SCM_PTAB_ENTRY (port
)->file_name
= filename
;
1245 extern char * ttyname();
1249 scm_print_port_mode (SCM exp
, SCM port
)
1251 scm_puts (SCM_CLOSEDP (exp
)
1253 : (SCM_RDNG
& SCM_CAR (exp
)
1254 ? (SCM_WRTNG
& SCM_CAR (exp
)
1257 : (SCM_WRTNG
& SCM_CAR (exp
)
1264 scm_port_print (SCM exp
, SCM port
, scm_print_state
*pstate
)
1266 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
1269 scm_puts ("#<", port
);
1270 scm_print_port_mode (exp
, port
);
1271 scm_puts (type
, port
);
1272 scm_putc (' ', port
);
1273 scm_intprint (SCM_CDR (exp
), 16, port
);
1274 scm_putc ('>', port
);
1278 extern void scm_make_fptob ();
1279 extern void scm_make_stptob ();
1280 extern void scm_make_sfptob ();
1283 scm_ports_prehistory ()
1286 scm_ptobs
= (scm_ptob_descriptor
*) malloc (sizeof (scm_ptob_descriptor
));
1288 /* WARNING: These scm_newptob calls must be done in this order.
1289 * They must agree with the port declarations in tags.h.
1291 /* scm_tc16_fport = */ scm_make_fptob ();
1292 /* scm_tc16_pipe was here */ scm_make_fptob (); /* dummy. */
1293 /* scm_tc16_strport = */ scm_make_stptob ();
1294 /* scm_tc16_sfport = */ scm_make_sfptob ();
1301 long scm_tc16_void_port
= 0;
1304 flush_void_port (SCM port
)
1309 end_input_void_port (SCM port
, int offset
)
1314 write_void_port (SCM port
, const void *data
, size_t size
)
1319 scm_void_port (char *mode_str
)
1325 SCM_NEWCELL (answer
);
1327 mode_bits
= scm_mode_bits (mode_str
);
1328 pt
= scm_add_to_port_table (answer
);
1329 SCM_SETPTAB_ENTRY (answer
, pt
);
1330 SCM_SETSTREAM (answer
, 0);
1331 SCM_SETCAR (answer
, scm_tc16_void_port
| mode_bits
);
1337 SCM_DEFINE (scm_sys_make_void_port
, "%make-void-port", 1, 0, 0,
1339 "Create and return a new void port. The @var{mode} argument describes\n"
1340 "the input/output modes for this port; for a description, see the\n"
1341 "documentation for @code{open-file} in @ref{File Ports}.")
1342 #define FUNC_NAME s_scm_sys_make_void_port
1344 SCM_VALIDATE_ROSTRING (1,mode
);
1345 SCM_COERCE_SUBSTR (mode
);
1346 return scm_void_port (SCM_ROCHARS (mode
));
1351 /* Initialization. */
1356 /* lseek() symbols. */
1357 scm_sysintern ("SEEK_SET", SCM_MAKINUM (SEEK_SET
));
1358 scm_sysintern ("SEEK_CUR", SCM_MAKINUM (SEEK_CUR
));
1359 scm_sysintern ("SEEK_END", SCM_MAKINUM (SEEK_END
));
1361 scm_tc16_void_port
= scm_make_port_type ("void", 0, write_void_port
);