* list.c (scm_list, scm_cons_star, scm_null_p, scm_list_p),
[bpt/guile.git] / libguile / ports.c
1 /* Copyright (C) 1995,1996,1997,1998,1999, 2000, 2001 Free Software Foundation, Inc.
2 *
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)
6 * any later version.
7 *
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.
12 *
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
17 *
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
20 *
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.
26 *
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
29 *
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.
37 *
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. */
41
42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
43 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
44
45 \f
46 /* Headers. */
47
48 #include <stdio.h>
49 #include <errno.h>
50
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"
56
57 #include "libguile/keywords.h"
58 #include "libguile/root.h"
59 #include "libguile/strings.h"
60
61 #include "libguile/validate.h"
62 #include "libguile/ports.h"
63
64 #ifdef HAVE_STRING_H
65 #include <string.h>
66 #endif
67
68 #ifdef HAVE_MALLOC_H
69 #include <malloc.h>
70 #endif
71
72 #ifdef HAVE_UNISTD_H
73 #include <unistd.h>
74 #endif
75
76 #ifdef HAVE_SYS_IOCTL_H
77 #include <sys/ioctl.h>
78 #endif
79
80 \f
81 /* The port kind table --- a dynamically resized array of port types. */
82
83
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).
88 */
89 scm_ptob_descriptor *scm_ptobs;
90 int scm_numptob;
91
92 /* GC marker for a port with stream of SCM type. */
93 SCM
94 scm_markstream (SCM ptr)
95 {
96 int openp;
97 openp = SCM_CELL_WORD_0 (ptr) & SCM_OPN;
98 if (openp)
99 return SCM_PACK (SCM_STREAM (ptr));
100 else
101 return SCM_BOOL_F;
102 }
103
104 /*
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.
108 */
109
110 static void
111 flush_port_default (SCM port)
112 {
113 }
114
115 static void
116 end_input_default (SCM port, int offset)
117 {
118 }
119
120 scm_bits_t
121 scm_make_port_type (char *name,
122 int (*fill_input) (SCM port),
123 void (*write) (SCM port, const void *data, size_t size))
124 {
125 char *tmp;
126 if (255 <= scm_numptob)
127 goto ptoberr;
128 SCM_DEFER_INTS;
129 SCM_SYSCALL (tmp = (char *) realloc ((char *) scm_ptobs,
130 (1 + scm_numptob)
131 * sizeof (scm_ptob_descriptor)));
132 if (tmp)
133 {
134 scm_ptobs = (scm_ptob_descriptor *) tmp;
135
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;
142
143 scm_ptobs[scm_numptob].write = write;
144 scm_ptobs[scm_numptob].flush = flush_port_default;
145
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;
149
150 scm_ptobs[scm_numptob].seek = 0;
151 scm_ptobs[scm_numptob].truncate = 0;
152
153 scm_numptob++;
154 }
155 SCM_ALLOW_INTS;
156 if (!tmp)
157 {
158 ptoberr:
159 scm_memory_error ("scm_make_port_type");
160 }
161 /* Make a class object if Goops is present */
162 if (scm_port_class)
163 scm_make_port_classes (scm_numptob - 1, SCM_PTOBNAME (scm_numptob - 1));
164 return scm_tc7_port + (scm_numptob - 1) * 256;
165 }
166
167 void
168 scm_set_port_mark (long tc, SCM (*mark) (SCM))
169 {
170 scm_ptobs[SCM_TC2PTOBNUM (tc)].mark = mark;
171 }
172
173 void
174 scm_set_port_free (long tc, scm_sizet (*free) (SCM))
175 {
176 scm_ptobs[SCM_TC2PTOBNUM (tc)].free = free;
177 }
178
179 void
180 scm_set_port_print (long tc, int (*print) (SCM exp, SCM port,
181 scm_print_state *pstate))
182 {
183 scm_ptobs[SCM_TC2PTOBNUM (tc)].print = print;
184 }
185
186 void
187 scm_set_port_equalp (long tc, SCM (*equalp) (SCM, SCM))
188 {
189 scm_ptobs[SCM_TC2PTOBNUM (tc)].equalp = equalp;
190 }
191
192 void
193 scm_set_port_flush (long tc, void (*flush) (SCM port))
194 {
195 scm_ptobs[SCM_TC2PTOBNUM (tc)].flush = flush;
196 }
197
198 void
199 scm_set_port_end_input (long tc, void (*end_input) (SCM port, int offset))
200 {
201 scm_ptobs[SCM_TC2PTOBNUM (tc)].end_input = end_input;
202 }
203
204 void
205 scm_set_port_close (long tc, int (*close) (SCM))
206 {
207 scm_ptobs[SCM_TC2PTOBNUM (tc)].close = close;
208 }
209
210 void
211 scm_set_port_seek (long tc, off_t (*seek) (SCM port,
212 off_t OFFSET,
213 int WHENCE))
214 {
215 scm_ptobs[SCM_TC2PTOBNUM (tc)].seek = seek;
216 }
217
218 void
219 scm_set_port_truncate (long tc, void (*truncate) (SCM port, off_t length))
220 {
221 scm_ptobs[SCM_TC2PTOBNUM (tc)].truncate = truncate;
222 }
223
224 void
225 scm_set_port_input_waiting (long tc, int (*input_waiting) (SCM))
226 {
227 scm_ptobs[SCM_TC2PTOBNUM (tc)].input_waiting = input_waiting;
228 }
229
230 \f
231
232 SCM_DEFINE (scm_char_ready_p, "char-ready?", 0, 1, 0,
233 (SCM port),
234 "Returns @code{#t} if a character is ready on input @var{port} and\n"
235 "returns @code{#f} otherwise. If @code{char-ready?} returns @code{#t}\n"
236 "then the next @code{read-char} operation on @var{port} is\n"
237 "guaranteed not to hang. If @var{port} is a file port at end of\n"
238 "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 getting\n"
241 "stuck waiting for input. Any input editors associated with such ports\n"
242 "must make sure that characters whose existence has been asserted by\n"
243 "@code{char-ready?} cannot be rubbed out. If @code{char-ready?} were to\n"
244 "return @code{#f} at end of file, a port at end of file would be\n"
245 "indistinguishable from an interactive port that has no ready\n"
246 "characters.}")
247 #define FUNC_NAME s_scm_char_ready_p
248 {
249 scm_port *pt;
250
251 if (SCM_UNBNDP (port))
252 port = scm_cur_inp;
253 else
254 SCM_VALIDATE_OPINPORT (1,port);
255
256 pt = SCM_PTAB_ENTRY (port);
257
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))
264 return SCM_BOOL_T;
265 else
266 {
267 scm_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (port)];
268
269 if (ptob->input_waiting)
270 return SCM_BOOL(ptob->input_waiting (port));
271 else
272 return SCM_BOOL_T;
273 }
274 }
275 #undef FUNC_NAME
276
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)
280 {
281 scm_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);
284
285 if (from_buf > 0)
286 {
287 memcpy (dest, pt->read_pos, from_buf);
288 pt->read_pos += from_buf;
289 chars_read += from_buf;
290 read_len -= from_buf;
291 dest += from_buf;
292 }
293
294 /* if putback was active, try the real input buffer too. */
295 if (pt->read_buf == pt->putback_buf)
296 {
297 from_buf = min (pt->saved_read_end - pt->saved_read_pos, read_len);
298 if (from_buf > 0)
299 {
300 memcpy (dest, pt->saved_read_pos, from_buf);
301 pt->saved_read_pos += from_buf;
302 chars_read += from_buf;
303 }
304 }
305 return chars_read;
306 }
307
308 /* Clear a port's read buffers, returning the contents. */
309 SCM_DEFINE (scm_drain_input, "drain-input", 1, 0, 0,
310 (SCM port),
311 "Drain @var{port}'s read buffers (including any pushed-back\n"
312 "characters) and returns the content as a single string.")
313 #define FUNC_NAME s_scm_drain_input
314 {
315 SCM result;
316 scm_port *pt = SCM_PTAB_ENTRY (port);
317 int count;
318
319 SCM_VALIDATE_OPINPORT (1,port);
320
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;
324
325 result = scm_makstr (count, 0);
326 scm_take_from_input_buffers (port, SCM_STRING_CHARS (result), count);
327
328 return result;
329 }
330 #undef FUNC_NAME
331
332 \f
333 /* Standard ports --- current input, output, error, and more(!). */
334
335 SCM_DEFINE (scm_current_input_port, "current-input-port", 0, 0, 0,
336 (),
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
341 {
342 return scm_cur_inp;
343 }
344 #undef FUNC_NAME
345
346 SCM_DEFINE (scm_current_output_port, "current-output-port", 0, 0, 0,
347 (),
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
353 {
354 return scm_cur_outp;
355 }
356 #undef FUNC_NAME
357
358 SCM_DEFINE (scm_current_error_port, "current-error-port", 0, 0, 0,
359 (),
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
363 {
364 return scm_cur_errp;
365 }
366 #undef FUNC_NAME
367
368 SCM_DEFINE (scm_current_load_port, "current-load-port", 0, 0, 0,
369 (),
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
373 {
374 return scm_cur_loadp;
375 }
376 #undef FUNC_NAME
377
378 SCM_DEFINE (scm_set_current_input_port, "set-current-input-port", 1, 0, 0,
379 (SCM port),
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
386 {
387 SCM oinp = scm_cur_inp;
388 SCM_VALIDATE_OPINPORT (1,port);
389 scm_cur_inp = port;
390 return oinp;
391 }
392 #undef FUNC_NAME
393
394
395 SCM_DEFINE (scm_set_current_output_port, "set-current-output-port", 1, 0, 0,
396 (SCM port),
397 "Set the current default output port to @var{port}.")
398 #define FUNC_NAME s_scm_set_current_output_port
399 {
400 SCM ooutp = scm_cur_outp;
401 port = SCM_COERCE_OUTPORT (port);
402 SCM_VALIDATE_OPOUTPORT (1,port);
403 scm_cur_outp = port;
404 return ooutp;
405 }
406 #undef FUNC_NAME
407
408
409 SCM_DEFINE (scm_set_current_error_port, "set-current-error-port", 1, 0, 0,
410 (SCM port),
411 "Set the current default error port to @var{port}.")
412 #define FUNC_NAME s_scm_set_current_error_port
413 {
414 SCM oerrp = scm_cur_errp;
415 port = SCM_COERCE_OUTPORT (port);
416 SCM_VALIDATE_OPOUTPORT (1,port);
417 scm_cur_errp = port;
418 return oerrp;
419 }
420 #undef FUNC_NAME
421
422 \f
423 /* The port table --- an array of pointers to ports. */
424
425 scm_port **scm_port_table;
426
427 int scm_port_table_size = 0; /* Number of ports in scm_port_table. */
428 int scm_port_table_room = 20; /* Size of the array. */
429
430 /* Add a port to the table. */
431
432 scm_port *
433 scm_add_to_port_table (SCM port)
434 {
435 scm_port *entry;
436
437 if (scm_port_table_size == scm_port_table_room)
438 {
439 void *newt = realloc ((char *) scm_port_table,
440 (scm_sizet) (sizeof (scm_port *)
441 * scm_port_table_room * 2));
442 if (newt == NULL)
443 scm_memory_error ("scm_add_to_port_table");
444 scm_port_table = (scm_port **) newt;
445 scm_port_table_room *= 2;
446 }
447 entry = (scm_port *) malloc (sizeof (scm_port));
448 if (entry == NULL)
449 scm_memory_error ("scm_add_to_port_table");
450
451 entry->port = port;
452 entry->entry = scm_port_table_size;
453 entry->revealed = 0;
454 entry->stream = 0;
455 entry->file_name = SCM_BOOL_F;
456 entry->line_number = 0;
457 entry->column_number = 0;
458 entry->putback_buf = 0;
459 entry->putback_buf_size = 0;
460 entry->rw_active = SCM_PORT_NEITHER;
461 entry->rw_random = 0;
462
463 scm_port_table[scm_port_table_size] = entry;
464 scm_port_table_size++;
465
466 return entry;
467 }
468
469 /* Remove a port from the table and destroy it. */
470
471 void
472 scm_remove_from_port_table (SCM port)
473 #define FUNC_NAME "scm_remove_from_port_table"
474 {
475 scm_port *p = SCM_PTAB_ENTRY (port);
476 int i = p->entry;
477
478 if (i >= scm_port_table_size)
479 SCM_MISC_ERROR ("Port not in table: ~S", SCM_LIST1 (port));
480 if (p->putback_buf)
481 free (p->putback_buf);
482 free (p);
483 /* Since we have just freed slot i we can shrink the table by moving
484 the last entry to that slot... */
485 if (i < scm_port_table_size - 1)
486 {
487 scm_port_table[i] = scm_port_table[scm_port_table_size - 1];
488 scm_port_table[i]->entry = i;
489 }
490 SCM_SETPTAB_ENTRY (port, 0);
491 scm_port_table_size--;
492 }
493 #undef FUNC_NAME
494
495
496 #ifdef GUILE_DEBUG
497 /* Functions for debugging. */
498
499 SCM_DEFINE (scm_pt_size, "pt-size", 0, 0, 0,
500 (),
501 "Returns the number of ports in the port table. @code{pt-size}\n"
502 "is only included in @code{--enable-guile-debug} builds.")
503 #define FUNC_NAME s_scm_pt_size
504 {
505 return SCM_MAKINUM (scm_port_table_size);
506 }
507 #undef FUNC_NAME
508
509 SCM_DEFINE (scm_pt_member, "pt-member", 1, 0, 0,
510 (SCM index),
511 "Returns the port at @var{index} in the port table.\n"
512 "@code{pt-member} is only included in\n"
513 "@code{--enable-guile-debug} builds.")
514 #define FUNC_NAME s_scm_pt_member
515 {
516 int i;
517 SCM_VALIDATE_INUM_COPY (1,index,i);
518 if (i < 0 || i >= scm_port_table_size)
519 return SCM_BOOL_F;
520 else
521 return scm_port_table[i]->port;
522 }
523 #undef FUNC_NAME
524 #endif
525
526 void
527 scm_port_non_buffer (scm_port *pt)
528 {
529 pt->read_pos = pt->read_buf = pt->read_end = &pt->shortbuf;
530 pt->write_buf = pt->write_pos = &pt->shortbuf;
531 pt->read_buf_size = pt->write_buf_size = 1;
532 pt->write_end = pt->write_buf + pt->write_buf_size;
533 }
534
535 \f
536 /* Revealed counts --- an oddity inherited from SCSH. */
537
538 /* Find a port in the table and return its revealed count.
539 Also used by the garbage collector.
540 */
541
542 int
543 scm_revealed_count (SCM port)
544 {
545 return SCM_REVEALED(port);
546 }
547
548
549
550 /* Return the revealed count for a port. */
551
552 SCM_DEFINE (scm_port_revealed, "port-revealed", 1, 0, 0,
553 (SCM port),
554 "Returns the revealed count for @var{port}.")
555 #define FUNC_NAME s_scm_port_revealed
556 {
557 port = SCM_COERCE_OUTPORT (port);
558 SCM_VALIDATE_PORT (1,port);
559 return SCM_MAKINUM (scm_revealed_count (port));
560 }
561 #undef FUNC_NAME
562
563 /* Set the revealed count for a port. */
564 SCM_DEFINE (scm_set_port_revealed_x, "set-port-revealed!", 2, 0, 0,
565 (SCM port, SCM rcount),
566 "Sets the revealed count for a port to a given value.\n"
567 "The return value is unspecified.")
568 #define FUNC_NAME s_scm_set_port_revealed_x
569 {
570 port = SCM_COERCE_OUTPORT (port);
571 SCM_VALIDATE_PORT (1,port);
572 SCM_VALIDATE_INUM (2,rcount);
573 SCM_REVEALED (port) = SCM_INUM (rcount);
574 return SCM_UNSPECIFIED;
575 }
576 #undef FUNC_NAME
577
578
579 \f
580 /* Retrieving a port's mode. */
581
582 /* Return the flags that characterize a port based on the mode
583 * string used to open a file for that port.
584 *
585 * See PORT FLAGS in scm.h
586 */
587
588 long
589 scm_mode_bits (char *modes)
590 {
591 return (SCM_OPN
592 | (strchr (modes, 'r') || strchr (modes, '+') ? SCM_RDNG : 0)
593 | ( strchr (modes, 'w')
594 || strchr (modes, 'a')
595 || strchr (modes, '+') ? SCM_WRTNG : 0)
596 | (strchr (modes, '0') ? SCM_BUF0 : 0)
597 | (strchr (modes, 'l') ? SCM_BUFLINE : 0));
598 }
599
600
601 /* Return the mode flags from an open port.
602 * Some modes such as "append" are only used when opening
603 * a file and are not returned here. */
604
605 SCM_DEFINE (scm_port_mode, "port-mode", 1, 0, 0,
606 (SCM port),
607 "Returns the port modes associated with the open port @var{port}. These\n"
608 "will not necessarily be identical to the modes used when the port was\n"
609 "opened, since modes such as \"append\" which are used only during\n"
610 "port creation are not retained.")
611 #define FUNC_NAME s_scm_port_mode
612 {
613 char modes[4];
614 modes[0] = '\0';
615
616 port = SCM_COERCE_OUTPORT (port);
617 SCM_VALIDATE_OPPORT (1,port);
618 if (SCM_CELL_WORD_0 (port) & SCM_RDNG) {
619 if (SCM_CELL_WORD_0 (port) & SCM_WRTNG)
620 strcpy (modes, "r+");
621 else
622 strcpy (modes, "r");
623 }
624 else if (SCM_CELL_WORD_0 (port) & SCM_WRTNG)
625 strcpy (modes, "w");
626 if (SCM_CELL_WORD_0 (port) & SCM_BUF0)
627 strcat (modes, "0");
628 return scm_makfromstr (modes, strlen (modes), 0);
629 }
630 #undef FUNC_NAME
631
632
633 \f
634 /* Closing ports. */
635
636 /* scm_close_port
637 * Call the close operation on a port object.
638 * see also scm_close.
639 */
640 SCM_DEFINE (scm_close_port, "close-port", 1, 0, 0,
641 (SCM port),
642 "Close the specified port object. Returns @code{#t} if it successfully\n"
643 "closes a port or @code{#f} if it was already\n"
644 "closed. An exception may be raised if an error occurs, for example\n"
645 "when flushing buffered output.\n"
646 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
647 "which can close file descriptors.")
648 #define FUNC_NAME s_scm_close_port
649 {
650 scm_sizet i;
651 int rv;
652
653 port = SCM_COERCE_OUTPORT (port);
654
655 SCM_VALIDATE_PORT (1, port);
656 if (SCM_CLOSEDP (port))
657 return SCM_BOOL_F;
658 i = SCM_PTOBNUM (port);
659 if (scm_ptobs[i].close)
660 rv = (scm_ptobs[i].close) (port);
661 else
662 rv = 0;
663 scm_remove_from_port_table (port);
664 SCM_SETAND_CAR (port, ~SCM_OPN);
665 return SCM_NEGATE_BOOL (rv < 0);
666 }
667 #undef FUNC_NAME
668
669 SCM_DEFINE (scm_close_input_port, "close-input-port", 1, 0, 0,
670 (SCM port),
671 "Close the specified input port object. The routine has no effect if\n"
672 "the file has already been closed. An exception may be raised if an\n"
673 "error occurs. The value returned is unspecified.\n\n"
674 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
675 "which can close file descriptors.")
676 #define FUNC_NAME s_scm_close_input_port
677 {
678 SCM_VALIDATE_INPUT_PORT (1, port);
679 scm_close_port (port);
680 return SCM_UNSPECIFIED;
681 }
682 #undef FUNC_NAME
683
684 SCM_DEFINE (scm_close_output_port, "close-output-port", 1, 0, 0,
685 (SCM port),
686 "Close the specified output port object. The routine has no effect if\n"
687 "the file has already been closed. An exception may be raised if an\n"
688 "error occurs. The value returned is unspecified.\n\n"
689 "See also @ref{Ports and File Descriptors, close}, for a procedure\n"
690 "which can close file descriptors.")
691 #define FUNC_NAME s_scm_close_output_port
692 {
693 port = SCM_COERCE_OUTPORT (port);
694 SCM_VALIDATE_OUTPUT_PORT (1, port);
695 scm_close_port (port);
696 return SCM_UNSPECIFIED;
697 }
698 #undef FUNC_NAME
699
700 SCM_DEFINE (scm_port_for_each, "port-for-each", 1, 0, 0,
701 (SCM proc),
702 "Apply @var{proc} to each port in the Guile port table\n"
703 "in turn. The return value is unspecified. More specifically,\n"
704 "@var{proc} is applied exactly once to every port that exists\n"
705 "in the system at the time @var{port-for-each} is invoked.\n"
706 "Changes to the port table while @var{port-for-each} is running\n"
707 "have no effect as far as @var{port-for-each} is concerned.\n")
708 #define FUNC_NAME s_scm_port_for_each
709 {
710 int i;
711 SCM ports;
712
713 SCM_VALIDATE_PROC (1, proc);
714
715 /* when pre-emptive multithreading is supported, access to the port
716 table will need to be controlled by a mutex. */
717
718 /* Even without pre-emptive multithreading, running arbitrary code
719 while scanning the port table is unsafe because the port table
720 can change arbitrarily (from a GC, for example). So we build a
721 list in advance while blocking the GC. -mvo */
722
723 SCM_DEFER_INTS;
724 scm_block_gc++;
725 ports = SCM_EOL;
726 for (i = 0; i < scm_port_table_size; i++)
727 ports = scm_cons (scm_port_table[i]->port, ports);
728 scm_block_gc--;
729 SCM_ALLOW_INTS;
730
731 while (ports != SCM_EOL)
732 {
733 scm_apply (proc, scm_cons (SCM_CAR (ports), SCM_EOL), SCM_EOL);
734 ports = SCM_CDR (ports);
735 }
736
737 return SCM_UNSPECIFIED;
738 }
739 #undef FUNC_NAME
740
741 #if (SCM_DEBUG_DEPRECATED == 0)
742
743 SCM_DEFINE (scm_close_all_ports_except, "close-all-ports-except", 0, 0, 1,
744 (SCM ports),
745 "[DEPRECATED] Close all open file ports used by the interpreter\n"
746 "except for those supplied as arguments. This procedure\n"
747 "was intended to be used before an exec call to close file descriptors\n"
748 "which are not needed in the new process. However it has the\n"
749 "undesirable side-effect of flushing buffes, so it's deprecated.\n"
750 "Use port-for-each instead.")
751 #define FUNC_NAME s_scm_close_all_ports_except
752 {
753 int i = 0;
754 SCM_VALIDATE_REST_ARGUMENT (ports);
755 while (i < scm_port_table_size)
756 {
757 SCM thisport = scm_port_table[i]->port;
758 int found = 0;
759 SCM ports_ptr = ports;
760
761 while (SCM_NNULLP (ports_ptr))
762 {
763 SCM port = SCM_COERCE_OUTPORT (SCM_CAR (ports_ptr));
764 if (i == 0)
765 SCM_VALIDATE_OPPORT (SCM_ARG1,port);
766 if (SCM_EQ_P (port, thisport))
767 found = 1;
768 ports_ptr = SCM_CDR (ports_ptr);
769 }
770 if (found)
771 i++;
772 else
773 /* i is not to be incremented here. */
774 scm_close_port (thisport);
775 }
776 return SCM_UNSPECIFIED;
777 }
778 #undef FUNC_NAME
779
780 #endif
781
782 \f
783 /* Utter miscellany. Gosh, we should clean this up some time. */
784
785 SCM_DEFINE (scm_input_port_p, "input-port?", 1, 0, 0,
786 (SCM x),
787 "Returns @code{#t} if @var{x} is an input port, otherwise returns\n"
788 "@code{#f}. Any object satisfying this predicate also satisfies\n"
789 "@code{port?}.")
790 #define FUNC_NAME s_scm_input_port_p
791 {
792 if (SCM_IMP (x))
793 return SCM_BOOL_F;
794 return SCM_BOOL(SCM_INPUT_PORT_P (x));
795 }
796 #undef FUNC_NAME
797
798 SCM_DEFINE (scm_output_port_p, "output-port?", 1, 0, 0,
799 (SCM x),
800 "Returns @code{#t} if @var{x} is an output port, otherwise returns\n"
801 "@code{#f}. Any object satisfying this predicate also satisfies\n"
802 "@code{port?}.")
803 #define FUNC_NAME s_scm_output_port_p
804 {
805 if (SCM_IMP (x))
806 return SCM_BOOL_F;
807 if (SCM_PORT_WITH_PS_P (x))
808 x = SCM_PORT_WITH_PS_PORT (x);
809 return SCM_BOOL(SCM_OUTPUT_PORT_P (x));
810 }
811 #undef FUNC_NAME
812
813 SCM_DEFINE (scm_port_p, "port?", 1, 0, 0,
814 (SCM x),
815 "Returns a boolean indicating whether @var{x} is a port.\n"
816 "Equivalent to @code{(or (input-port? @var{x}) (output-port?\n"
817 "@var{x}))}.")
818 #define FUNC_NAME s_scm_port_p
819 {
820 return SCM_BOOL (SCM_PORTP (x));
821 }
822 #undef FUNC_NAME
823
824 SCM_DEFINE (scm_port_closed_p, "port-closed?", 1, 0, 0,
825 (SCM port),
826 "Returns @code{#t} if @var{port} is closed or @code{#f} if it is open.")
827 #define FUNC_NAME s_scm_port_closed_p
828 {
829 SCM_VALIDATE_PORT (1,port);
830 return SCM_NEGATE_BOOL(SCM_OPPORTP (port));
831 }
832 #undef FUNC_NAME
833
834 SCM_DEFINE (scm_eof_object_p, "eof-object?", 1, 0, 0,
835 (SCM x),
836 "Returns @code{#t} if @var{x} is an end-of-file object; otherwise\n"
837 "returns @code{#f}.")
838 #define FUNC_NAME s_scm_eof_object_p
839 {
840 return SCM_BOOL(SCM_EOF_OBJECT_P (x));
841 }
842 #undef FUNC_NAME
843
844 SCM_DEFINE (scm_force_output, "force-output", 0, 1, 0,
845 (SCM port),
846 "Flush the specified output port, or the current output port if @var{port}\n"
847 "is omitted. The current output buffer contents are passed to the \n"
848 "underlying port implementation (e.g., in the case of fports, the\n"
849 "data will be written to the file and the output buffer will be cleared.)\n"
850 "It has no effect on an unbuffered port.\n\n"
851 "The return value is unspecified.")
852 #define FUNC_NAME s_scm_force_output
853 {
854 if (SCM_UNBNDP (port))
855 port = scm_cur_outp;
856 else
857 {
858 port = SCM_COERCE_OUTPORT (port);
859 SCM_VALIDATE_OPOUTPORT (1,port);
860 }
861 scm_flush (port);
862 return SCM_UNSPECIFIED;
863 }
864 #undef FUNC_NAME
865
866 SCM_DEFINE (scm_flush_all_ports, "flush-all-ports", 0, 0, 0,
867 (),
868 "Equivalent to calling @code{force-output} on\n"
869 "all open output ports. The return value is unspecified.")
870 #define FUNC_NAME s_scm_flush_all_ports
871 {
872 int i;
873
874 for (i = 0; i < scm_port_table_size; i++)
875 {
876 if (SCM_OPOUTPORTP (scm_port_table[i]->port))
877 scm_flush (scm_port_table[i]->port);
878 }
879 return SCM_UNSPECIFIED;
880 }
881 #undef FUNC_NAME
882
883 SCM_DEFINE (scm_read_char, "read-char", 0, 1, 0,
884 (SCM port),
885 "Returns the next character available from @var{port}, updating\n"
886 "@var{port} to point to the following character. If no more\n"
887 "characters are available, an end-of-file object is returned.")
888 #define FUNC_NAME s_scm_read_char
889 {
890 int c;
891 if (SCM_UNBNDP (port))
892 port = scm_cur_inp;
893 SCM_VALIDATE_OPINPORT (1,port);
894 c = scm_getc (port);
895 if (EOF == c)
896 return SCM_EOF_VAL;
897 return SCM_MAKE_CHAR (c);
898 }
899 #undef FUNC_NAME
900
901 /* this should only be called when the read buffer is empty. it
902 tries to refill the read buffer. it returns the first char from
903 the port, which is either EOF or *(pt->read_pos). */
904 int
905 scm_fill_input (SCM port)
906 {
907 scm_port *pt = SCM_PTAB_ENTRY (port);
908
909 if (pt->read_buf == pt->putback_buf)
910 {
911 /* finished reading put-back chars. */
912 pt->read_buf = pt->saved_read_buf;
913 pt->read_pos = pt->saved_read_pos;
914 pt->read_end = pt->saved_read_end;
915 pt->read_buf_size = pt->saved_read_buf_size;
916 if (pt->read_pos < pt->read_end)
917 return *(pt->read_pos);
918 }
919 return scm_ptobs[SCM_PTOBNUM (port)].fill_input (port);
920 }
921
922 int
923 scm_getc (SCM port)
924 {
925 int c;
926 scm_port *pt = SCM_PTAB_ENTRY (port);
927
928 if (pt->rw_active == SCM_PORT_WRITE)
929 {
930 /* may be marginally faster than calling scm_flush. */
931 scm_ptobs[SCM_PTOBNUM (port)].flush (port);
932 }
933
934 if (pt->rw_random)
935 pt->rw_active = SCM_PORT_READ;
936
937 if (pt->read_pos >= pt->read_end)
938 {
939 if (scm_fill_input (port) == EOF)
940 return EOF;
941 }
942
943 c = *(pt->read_pos++);
944
945 if (c == '\n')
946 {
947 SCM_INCLINE (port);
948 }
949 else if (c == '\t')
950 {
951 SCM_TABCOL (port);
952 }
953 else
954 {
955 SCM_INCCOL (port);
956 }
957
958 return c;
959 }
960
961 void
962 scm_putc (char c, SCM port)
963 {
964 scm_lfwrite (&c, 1, port);
965 }
966
967 void
968 scm_puts (const char *s, SCM port)
969 {
970 scm_lfwrite (s, strlen (s), port);
971 }
972
973 /* scm_lfwrite
974 *
975 * Currently, this function has an identical implementation to
976 * scm_c_write. We could have turned it into a macro expanding into a
977 * call to scm_c_write. However, the implementation is small and
978 * might differ in the future.
979 */
980
981 void
982 scm_lfwrite (const char *ptr, scm_sizet size, SCM port)
983 {
984 scm_port *pt = SCM_PTAB_ENTRY (port);
985 scm_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (port)];
986
987 if (pt->rw_active == SCM_PORT_READ)
988 scm_end_input (port);
989
990 ptob->write (port, ptr, size);
991
992 if (pt->rw_random)
993 pt->rw_active = SCM_PORT_WRITE;
994 }
995
996 /* scm_c_read
997 *
998 * Used by an application to read arbitrary number of bytes from an
999 * SCM port. Same semantics as libc read, except that scm_c_read only
1000 * returns less than SIZE bytes if at end-of-file.
1001 *
1002 * Warning: Doesn't update port line and column counts! */
1003
1004 scm_sizet
1005 scm_c_read (SCM port, void *buffer, scm_sizet size)
1006 {
1007 scm_port *pt = SCM_PTAB_ENTRY (port);
1008 scm_sizet n_read = 0, n_available;
1009
1010 if (pt->rw_active == SCM_PORT_WRITE)
1011 scm_ptobs[SCM_PTOBNUM (port)].flush (port);
1012
1013 if (pt->rw_random)
1014 pt->rw_active = SCM_PORT_READ;
1015
1016 if (SCM_READ_BUFFER_EMPTY_P (pt))
1017 {
1018 if (scm_fill_input (port) == EOF)
1019 return 0;
1020 }
1021
1022 n_available = pt->read_end - pt->read_pos;
1023
1024 while (n_available < size)
1025 {
1026 memcpy (buffer, pt->read_pos, n_available);
1027 buffer += n_available;
1028 pt->read_pos += n_available;
1029 n_read += n_available;
1030
1031 if (SCM_READ_BUFFER_EMPTY_P (pt))
1032 {
1033 if (scm_fill_input (port) == EOF)
1034 return n_read;
1035 }
1036
1037 size -= n_available;
1038 n_available = pt->read_end - pt->read_pos;
1039 }
1040
1041 memcpy (buffer, pt->read_pos, size);
1042 pt->read_pos += size;
1043
1044 return n_read + size;
1045 }
1046
1047 /* scm_c_write
1048 *
1049 * Used by an application to write arbitrary number of bytes to an SCM
1050 * port. Similar semantics as libc write. However, unlike libc
1051 * write, scm_c_write writes the requested number of bytes and has no
1052 * return value.
1053 *
1054 * Warning: Doesn't update port line and column counts!
1055 */
1056
1057 void
1058 scm_c_write (SCM port, const void *ptr, scm_sizet size)
1059 {
1060 scm_port *pt = SCM_PTAB_ENTRY (port);
1061 scm_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (port)];
1062
1063 if (pt->rw_active == SCM_PORT_READ)
1064 scm_end_input (port);
1065
1066 ptob->write (port, ptr, size);
1067
1068 if (pt->rw_random)
1069 pt->rw_active = SCM_PORT_WRITE;
1070 }
1071
1072 void
1073 scm_flush (SCM port)
1074 {
1075 scm_sizet i = SCM_PTOBNUM (port);
1076 (scm_ptobs[i].flush) (port);
1077 }
1078
1079 void
1080 scm_end_input (SCM port)
1081 {
1082 int offset;
1083 scm_port *pt = SCM_PTAB_ENTRY (port);
1084
1085 if (pt->read_buf == pt->putback_buf)
1086 {
1087 offset = pt->read_end - pt->read_pos;
1088 pt->read_buf = pt->saved_read_buf;
1089 pt->read_pos = pt->saved_read_pos;
1090 pt->read_end = pt->saved_read_end;
1091 pt->read_buf_size = pt->saved_read_buf_size;
1092 }
1093 else
1094 offset = 0;
1095
1096 scm_ptobs[SCM_PTOBNUM (port)].end_input (port, offset);
1097 }
1098
1099 \f
1100
1101
1102 void
1103 scm_ungetc (int c, SCM port)
1104 {
1105 scm_port *pt = SCM_PTAB_ENTRY (port);
1106
1107 if (pt->read_buf == pt->putback_buf)
1108 /* already using the put-back buffer. */
1109 {
1110 /* enlarge putback_buf if necessary. */
1111 if (pt->read_end == pt->read_buf + pt->read_buf_size
1112 && pt->read_buf == pt->read_pos)
1113 {
1114 int new_size = pt->read_buf_size * 2;
1115 unsigned char *tmp =
1116 (unsigned char *) realloc (pt->putback_buf, new_size);
1117
1118 if (tmp == NULL)
1119 scm_memory_error ("scm_ungetc");
1120 pt->read_pos = pt->read_buf = pt->putback_buf = tmp;
1121 pt->read_end = pt->read_buf + pt->read_buf_size;
1122 pt->read_buf_size = pt->putback_buf_size = new_size;
1123 }
1124
1125 /* shift any existing bytes to buffer + 1. */
1126 if (pt->read_pos == pt->read_end)
1127 pt->read_end = pt->read_buf + 1;
1128 else if (pt->read_pos != pt->read_buf + 1)
1129 {
1130 int count = pt->read_end - pt->read_pos;
1131
1132 memmove (pt->read_buf + 1, pt->read_pos, count);
1133 pt->read_end = pt->read_buf + 1 + count;
1134 }
1135
1136 pt->read_pos = pt->read_buf;
1137 }
1138 else
1139 /* switch to the put-back buffer. */
1140 {
1141 if (pt->putback_buf == NULL)
1142 {
1143 pt->putback_buf
1144 = (unsigned char *) malloc (SCM_INITIAL_PUTBACK_BUF_SIZE);
1145 if (pt->putback_buf == NULL)
1146 scm_memory_error ("scm_ungetc");
1147 pt->putback_buf_size = SCM_INITIAL_PUTBACK_BUF_SIZE;
1148 }
1149
1150 pt->saved_read_buf = pt->read_buf;
1151 pt->saved_read_pos = pt->read_pos;
1152 pt->saved_read_end = pt->read_end;
1153 pt->saved_read_buf_size = pt->read_buf_size;
1154
1155 pt->read_pos = pt->read_buf = pt->putback_buf;
1156 pt->read_end = pt->read_buf + 1;
1157 pt->read_buf_size = pt->putback_buf_size;
1158 }
1159
1160 *pt->read_buf = c;
1161
1162 if (pt->rw_random)
1163 pt->rw_active = SCM_PORT_READ;
1164
1165 if (c == '\n')
1166 {
1167 /* What should col be in this case?
1168 * We'll leave it at -1.
1169 */
1170 SCM_LINUM (port) -= 1;
1171 }
1172 else
1173 SCM_COL(port) -= 1;
1174 }
1175
1176
1177 void
1178 scm_ungets (const char *s, int n, SCM port)
1179 {
1180 /* This is simple minded and inefficient, but unreading strings is
1181 * probably not a common operation, and remember that line and
1182 * column numbers have to be handled...
1183 *
1184 * Please feel free to write an optimized version!
1185 */
1186 while (n--)
1187 scm_ungetc (s[n], port);
1188 }
1189
1190
1191 SCM_DEFINE (scm_peek_char, "peek-char", 0, 1, 0,
1192 (SCM port),
1193 "Returns the next character available from @var{port},\n"
1194 "@emph{without} updating @var{port} to point to the following\n"
1195 "character. If no more characters are available, an end-of-file object\n"
1196 "is returned.@footnote{The value returned by a call to @code{peek-char}\n"
1197 "is the same as the value that would have been returned by a call to\n"
1198 "@code{read-char} on the same port. The only difference is that the very\n"
1199 "next call to @code{read-char} or @code{peek-char} on that\n"
1200 "@var{port} will return the value returned by the preceding call to\n"
1201 "@code{peek-char}. In particular, a call to @code{peek-char} on an\n"
1202 "interactive port will hang waiting for input whenever a call to\n"
1203 "@code{read-char} would have hung.}")
1204 #define FUNC_NAME s_scm_peek_char
1205 {
1206 int c;
1207 if (SCM_UNBNDP (port))
1208 port = scm_cur_inp;
1209 else
1210 SCM_VALIDATE_OPINPORT (1,port);
1211 c = scm_getc (port);
1212 if (EOF == c)
1213 return SCM_EOF_VAL;
1214 scm_ungetc (c, port);
1215 return SCM_MAKE_CHAR (c);
1216 }
1217 #undef FUNC_NAME
1218
1219 SCM_DEFINE (scm_unread_char, "unread-char", 1, 1, 0,
1220 (SCM cobj, SCM port),
1221 "Place @var{char} in @var{port} so that it will be read by the\n"
1222 "next read operation. If called multiple times, the unread characters\n"
1223 "will be read again in last-in first-out order. If @var{port} is\n"
1224 "not supplied, the current input port is used.")
1225 #define FUNC_NAME s_scm_unread_char
1226 {
1227 int c;
1228
1229 SCM_VALIDATE_CHAR (1,cobj);
1230 if (SCM_UNBNDP (port))
1231 port = scm_cur_inp;
1232 else
1233 SCM_VALIDATE_OPINPORT (2,port);
1234
1235 c = SCM_CHAR (cobj);
1236
1237 scm_ungetc (c, port);
1238 return cobj;
1239 }
1240 #undef FUNC_NAME
1241
1242 SCM_DEFINE (scm_unread_string, "unread-string", 2, 0, 0,
1243 (SCM str, SCM port),
1244 "Place the string @var{str} in @var{port} so that its characters will be\n"
1245 "read in subsequent read operations. If called multiple times, the\n"
1246 "unread characters will be read again in last-in first-out order. If\n"
1247 "@var{port} is not supplied, the current-input-port is used.")
1248 #define FUNC_NAME s_scm_unread_string
1249 {
1250 SCM_VALIDATE_STRING (1,str);
1251 if (SCM_UNBNDP (port))
1252 port = scm_cur_inp;
1253 else
1254 SCM_VALIDATE_OPINPORT (2,port);
1255
1256 scm_ungets (SCM_STRING_CHARS (str), SCM_STRING_LENGTH (str), port);
1257
1258 return str;
1259 }
1260 #undef FUNC_NAME
1261
1262 SCM_DEFINE (scm_seek, "seek", 3, 0, 0,
1263 (SCM object, SCM offset, SCM whence),
1264 "Sets the current position of @var{fd/port} to the integer @var{offset},\n"
1265 "which is interpreted according to the value of @var{whence}.\n\n"
1266 "One of the following variables should be supplied\n"
1267 "for @var{whence}:\n"
1268 "@defvar SEEK_SET\n"
1269 "Seek from the beginning of the file.\n"
1270 "@end defvar\n"
1271 "@defvar SEEK_CUR\n"
1272 "Seek from the current position.\n"
1273 "@end defvar\n"
1274 "@defvar SEEK_END\n"
1275 "Seek from the end of the file.\n"
1276 "@end defvar\n\n"
1277 "If @var{fd/port} is a file descriptor, the underlying system call is\n"
1278 "@code{lseek}. @var{port} may be a string port.\n\n"
1279 "The value returned is the new position in the file. This means that\n"
1280 "the current position of a port can be obtained using:\n"
1281 "@smalllisp\n"
1282 "(seek port 0 SEEK_CUR)\n"
1283 "@end smalllisp")
1284 #define FUNC_NAME s_scm_seek
1285 {
1286 off_t off;
1287 off_t rv;
1288 int how;
1289
1290 object = SCM_COERCE_OUTPORT (object);
1291
1292 off = SCM_NUM2LONG (2, offset);
1293 SCM_VALIDATE_INUM_COPY (3, whence, how);
1294 if (how != SEEK_SET && how != SEEK_CUR && how != SEEK_END)
1295 SCM_OUT_OF_RANGE (3, whence);
1296 if (SCM_OPPORTP (object))
1297 {
1298 scm_ptob_descriptor *ptob = scm_ptobs + SCM_PTOBNUM (object);
1299
1300 if (!ptob->seek)
1301 SCM_MISC_ERROR ("port is not seekable",
1302 scm_cons (object, SCM_EOL));
1303 else
1304 rv = ptob->seek (object, off, how);
1305 }
1306 else /* file descriptor?. */
1307 {
1308 SCM_VALIDATE_INUM (1,object);
1309 rv = lseek (SCM_INUM (object), off, how);
1310 if (rv == -1)
1311 SCM_SYSERROR;
1312 }
1313 return scm_long2num (rv);
1314 }
1315 #undef FUNC_NAME
1316
1317 SCM_DEFINE (scm_truncate_file, "truncate-file", 1, 1, 0,
1318 (SCM object, SCM length),
1319 "Truncates the object referred to by @var{obj} to at most @var{size} bytes.\n"
1320 "@var{obj} can be a string containing a file name or an integer file\n"
1321 "descriptor or a port. @var{size} may be omitted if @var{obj} is not\n"
1322 "a file name, in which case the truncation occurs at the current port.\n"
1323 "position.\n\n"
1324 "The return value is unspecified.")
1325 #define FUNC_NAME s_scm_truncate_file
1326 {
1327 int rv;
1328 off_t c_length;
1329
1330 /* object can be a port, fdes or filename. */
1331
1332 if (SCM_UNBNDP (length))
1333 {
1334 /* must supply length if object is a filename. */
1335 if (SCM_STRINGP (object))
1336 SCM_MISC_ERROR("must supply length if OBJECT is a filename",SCM_EOL);
1337
1338 length = scm_seek (object, SCM_INUM0, SCM_MAKINUM (SEEK_CUR));
1339 }
1340 c_length = SCM_NUM2LONG (2,length);
1341 if (c_length < 0)
1342 SCM_MISC_ERROR ("negative offset", SCM_EOL);
1343
1344 object = SCM_COERCE_OUTPORT (object);
1345 if (SCM_INUMP (object))
1346 {
1347 SCM_SYSCALL (rv = ftruncate (SCM_INUM (object), c_length));
1348 }
1349 else if (SCM_OPOUTPORTP (object))
1350 {
1351 scm_port *pt = SCM_PTAB_ENTRY (object);
1352 scm_ptob_descriptor *ptob = scm_ptobs + SCM_PTOBNUM (object);
1353
1354 if (!ptob->truncate)
1355 SCM_MISC_ERROR ("port is not truncatable", SCM_EOL);
1356 if (pt->rw_active == SCM_PORT_READ)
1357 scm_end_input (object);
1358 else if (pt->rw_active == SCM_PORT_WRITE)
1359 ptob->flush (object);
1360
1361 ptob->truncate (object, c_length);
1362 rv = 0;
1363 }
1364 else
1365 {
1366 SCM_VALIDATE_STRING (1, object);
1367 SCM_STRING_COERCE_0TERMINATION_X (object);
1368 SCM_SYSCALL (rv = truncate (SCM_STRING_CHARS (object), c_length));
1369 }
1370 if (rv == -1)
1371 SCM_SYSERROR;
1372 return SCM_UNSPECIFIED;
1373 }
1374 #undef FUNC_NAME
1375
1376 SCM_DEFINE (scm_port_line, "port-line", 1, 0, 0,
1377 (SCM port),
1378 "Return the current line number for @var{port}.")
1379 #define FUNC_NAME s_scm_port_line
1380 {
1381 port = SCM_COERCE_OUTPORT (port);
1382 SCM_VALIDATE_OPENPORT (1,port);
1383 return SCM_MAKINUM (SCM_LINUM (port));
1384 }
1385 #undef FUNC_NAME
1386
1387 SCM_DEFINE (scm_set_port_line_x, "set-port-line!", 2, 0, 0,
1388 (SCM port, SCM line),
1389 "Set the current line number for @var{port} to @var{line}.")
1390 #define FUNC_NAME s_scm_set_port_line_x
1391 {
1392 port = SCM_COERCE_OUTPORT (port);
1393 SCM_VALIDATE_OPENPORT (1,port);
1394 SCM_VALIDATE_INUM (2,line);
1395 SCM_PTAB_ENTRY (port)->line_number = SCM_INUM (line);
1396 return SCM_UNSPECIFIED;
1397 }
1398 #undef FUNC_NAME
1399
1400 SCM_DEFINE (scm_port_column, "port-column", 1, 0, 0,
1401 (SCM port),
1402 "@deffnx primitive port-line port\n"
1403 "Return the current column number or line number of @var{port},\n"
1404 "using the current input port if none is specified. If the number is\n"
1405 "unknown, the result is #f. Otherwise, the result is a 0-origin integer\n"
1406 "- i.e. the first character of the first line is line 0, column 0.\n"
1407 "(However, when you display a file position, for example in an error\n"
1408 "message, we recommend you add 1 to get 1-origin integers. This is\n"
1409 "because lines and column numbers traditionally start with 1, and that is\n"
1410 "what non-programmers will find most natural.)")
1411 #define FUNC_NAME s_scm_port_column
1412 {
1413 port = SCM_COERCE_OUTPORT (port);
1414 SCM_VALIDATE_OPENPORT (1,port);
1415 return SCM_MAKINUM (SCM_COL (port));
1416 }
1417 #undef FUNC_NAME
1418
1419 SCM_DEFINE (scm_set_port_column_x, "set-port-column!", 2, 0, 0,
1420 (SCM port, SCM column),
1421 "@deffnx primitive set-port-line! port line\n"
1422 "Set the current column or line number of @var{port}, using the\n"
1423 "current input port if none is specified.")
1424 #define FUNC_NAME s_scm_set_port_column_x
1425 {
1426 port = SCM_COERCE_OUTPORT (port);
1427 SCM_VALIDATE_OPENPORT (1,port);
1428 SCM_VALIDATE_INUM (2,column);
1429 SCM_PTAB_ENTRY (port)->column_number = SCM_INUM (column);
1430 return SCM_UNSPECIFIED;
1431 }
1432 #undef FUNC_NAME
1433
1434 SCM_DEFINE (scm_port_filename, "port-filename", 1, 0, 0,
1435 (SCM port),
1436 "Return the filename associated with @var{port}. This function returns\n"
1437 "the strings \"standard input\", \"standard output\" and \"standard error\"\n"
1438 "when called on the current input, output and error ports respectively.")
1439 #define FUNC_NAME s_scm_port_filename
1440 {
1441 port = SCM_COERCE_OUTPORT (port);
1442 SCM_VALIDATE_OPENPORT (1,port);
1443 return SCM_FILENAME (port);
1444 }
1445 #undef FUNC_NAME
1446
1447 SCM_DEFINE (scm_set_port_filename_x, "set-port-filename!", 2, 0, 0,
1448 (SCM port, SCM filename),
1449 "Change the filename associated with @var{port}, using the current input\n"
1450 "port if none is specified. Note that this does not change the port's\n"
1451 "source of data, but only the value that is returned by\n"
1452 "@code{port-filename} and reported in diagnostic output.")
1453 #define FUNC_NAME s_scm_set_port_filename_x
1454 {
1455 port = SCM_COERCE_OUTPORT (port);
1456 SCM_VALIDATE_OPENPORT (1,port);
1457 /* We allow the user to set the filename to whatever he likes. */
1458 SCM_SET_FILENAME (port, filename);
1459 return SCM_UNSPECIFIED;
1460 }
1461 #undef FUNC_NAME
1462
1463 #ifndef ttyname
1464 extern char * ttyname();
1465 #endif
1466
1467 void
1468 scm_print_port_mode (SCM exp, SCM port)
1469 {
1470 scm_puts (SCM_CLOSEDP (exp)
1471 ? "closed: "
1472 : (SCM_RDNG & SCM_CELL_WORD_0 (exp)
1473 ? (SCM_WRTNG & SCM_CELL_WORD_0 (exp)
1474 ? "input-output: "
1475 : "input: ")
1476 : (SCM_WRTNG & SCM_CELL_WORD_0 (exp)
1477 ? "output: "
1478 : "bogus: ")),
1479 port);
1480 }
1481
1482 int
1483 scm_port_print (SCM exp, SCM port, scm_print_state *pstate)
1484 {
1485 char *type = SCM_PTOBNAME (SCM_PTOBNUM (exp));
1486 if (!type)
1487 type = "port";
1488 scm_puts ("#<", port);
1489 scm_print_port_mode (exp, port);
1490 scm_puts (type, port);
1491 scm_putc (' ', port);
1492 scm_intprint (SCM_CELL_WORD_1 (exp), 16, port);
1493 scm_putc ('>', port);
1494 return 1;
1495 }
1496
1497 void
1498 scm_ports_prehistory ()
1499 {
1500 scm_numptob = 0;
1501 scm_ptobs = (scm_ptob_descriptor *) malloc (sizeof (scm_ptob_descriptor));
1502 }
1503
1504 \f
1505
1506 /* Void ports. */
1507
1508 scm_bits_t scm_tc16_void_port = 0;
1509
1510 static int fill_input_void_port (SCM port)
1511 {
1512 return EOF;
1513 }
1514
1515 static void
1516 write_void_port (SCM port, const void *data, size_t size)
1517 {
1518 }
1519
1520 SCM
1521 scm_void_port (char *mode_str)
1522 {
1523 int mode_bits;
1524 SCM answer;
1525 scm_port * pt;
1526
1527 SCM_NEWCELL (answer);
1528 SCM_DEFER_INTS;
1529 mode_bits = scm_mode_bits (mode_str);
1530 pt = scm_add_to_port_table (answer);
1531 scm_port_non_buffer (pt);
1532 SCM_SETPTAB_ENTRY (answer, pt);
1533 SCM_SETSTREAM (answer, 0);
1534 SCM_SET_CELL_TYPE (answer, scm_tc16_void_port | mode_bits);
1535 SCM_ALLOW_INTS;
1536 return answer;
1537 }
1538
1539 SCM_DEFINE (scm_sys_make_void_port, "%make-void-port", 1, 0, 0,
1540 (SCM mode),
1541 "Create and return a new void port. A void port acts like\n"
1542 "/dev/null. The @var{mode} argument\n"
1543 "specifies the input/output modes for this port: see the\n"
1544 "documentation for @code{open-file} in @ref{File Ports}.")
1545 #define FUNC_NAME s_scm_sys_make_void_port
1546 {
1547 SCM_VALIDATE_STRING (1, mode);
1548 SCM_STRING_COERCE_0TERMINATION_X (mode);
1549 return scm_void_port (SCM_STRING_CHARS (mode));
1550 }
1551 #undef FUNC_NAME
1552
1553 \f
1554 /* Initialization. */
1555
1556 void
1557 scm_init_ports ()
1558 {
1559 /* lseek() symbols. */
1560 scm_sysintern ("SEEK_SET", SCM_MAKINUM (SEEK_SET));
1561 scm_sysintern ("SEEK_CUR", SCM_MAKINUM (SEEK_CUR));
1562 scm_sysintern ("SEEK_END", SCM_MAKINUM (SEEK_END));
1563
1564 scm_tc16_void_port = scm_make_port_type ("void", fill_input_void_port,
1565 write_void_port);
1566 #ifndef SCM_MAGIC_SNARFER
1567 #include "libguile/ports.x"
1568 #endif
1569 }
1570
1571 /*
1572 Local Variables:
1573 c-file-style: "gnu"
1574 End:
1575 */