1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include "libguile/_scm.h"
27 #include "libguile/strings.h"
28 #include "libguile/validate.h"
29 #include "libguile/gc.h"
30 #include "libguile/posix.h"
31 #include "libguile/dynwind.h"
33 #include "libguile/fports.h"
46 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
52 #include "libguile/iselect.h"
54 /* Some defines for Windows (native port, not Cygwin). */
56 # include <sys/stat.h>
57 # include <winsock2.h>
58 # define ftruncate(fd, size) chsize (fd, size)
59 #endif /* __MINGW32__ */
62 scm_t_bits scm_tc16_fport
;
65 /* default buffer size, used if the O/S won't supply a value. */
66 static const size_t default_buffer_size
= 1024;
68 /* create FPORT buffer with specified sizes (or -1 to use default size or
71 scm_fport_buffer_add (SCM port
, long read_size
, int write_size
)
72 #define FUNC_NAME "scm_fport_buffer_add"
74 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
76 if (read_size
== -1 || write_size
== -1)
79 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
81 scm_t_fport
*fp
= SCM_FSTREAM (port
);
83 default_size
= (fstat (fp
->fdes
, &st
) == -1) ? default_buffer_size
86 default_size
= default_buffer_size
;
89 read_size
= default_size
;
91 write_size
= default_size
;
94 if (SCM_INPUT_PORT_P (port
) && read_size
> 0)
96 pt
->read_buf
= scm_gc_malloc (read_size
, "port buffer");
97 pt
->read_pos
= pt
->read_end
= pt
->read_buf
;
98 pt
->read_buf_size
= read_size
;
102 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
103 pt
->read_buf_size
= 1;
106 if (SCM_OUTPUT_PORT_P (port
) && write_size
> 0)
108 pt
->write_buf
= scm_gc_malloc (write_size
, "port buffer");
109 pt
->write_pos
= pt
->write_buf
;
110 pt
->write_buf_size
= write_size
;
114 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
115 pt
->write_buf_size
= 1;
118 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
119 if (read_size
> 0 || write_size
> 0)
120 SCM_SET_CELL_WORD_0 (port
, SCM_CELL_WORD_0 (port
) & ~SCM_BUF0
);
122 SCM_SET_CELL_WORD_0 (port
, SCM_CELL_WORD_0 (port
) | SCM_BUF0
);
126 SCM_DEFINE (scm_setvbuf
, "setvbuf", 2, 1, 0,
127 (SCM port
, SCM mode
, SCM size
),
128 "Set the buffering mode for @var{port}. @var{mode} can be:\n"
135 "block buffered, using a newly allocated buffer of @var{size} bytes.\n"
136 "If @var{size} is omitted, a default size will be used.\n"
138 #define FUNC_NAME s_scm_setvbuf
144 port
= SCM_COERCE_OUTPORT (port
);
146 SCM_VALIDATE_OPFPORT (1,port
);
147 cmode
= scm_to_int (mode
);
148 if (cmode
!= _IONBF
&& cmode
!= _IOFBF
&& cmode
!= _IOLBF
)
149 scm_out_of_range (FUNC_NAME
, mode
);
153 SCM_SET_CELL_WORD_0 (port
, SCM_CELL_WORD_0 (port
) | SCM_BUFLINE
);
158 SCM_SET_CELL_WORD_0 (port
, SCM_CELL_WORD_0 (port
) ^ SCM_BUFLINE
);
161 if (SCM_UNBNDP (size
))
170 csize
= scm_to_int (size
);
171 if (csize
< 0 || (cmode
== _IONBF
&& csize
> 0))
172 scm_out_of_range (FUNC_NAME
, size
);
175 pt
= SCM_PTAB_ENTRY (port
);
177 /* silently discards buffered and put-back chars. */
178 if (pt
->read_buf
== pt
->putback_buf
)
180 pt
->read_buf
= pt
->saved_read_buf
;
181 pt
->read_pos
= pt
->saved_read_pos
;
182 pt
->read_end
= pt
->saved_read_end
;
183 pt
->read_buf_size
= pt
->saved_read_buf_size
;
185 if (pt
->read_buf
!= &pt
->shortbuf
)
186 scm_gc_free (pt
->read_buf
, pt
->read_buf_size
, "port buffer");
187 if (pt
->write_buf
!= &pt
->shortbuf
)
188 scm_gc_free (pt
->write_buf
, pt
->write_buf_size
, "port buffer");
190 scm_fport_buffer_add (port
, csize
, csize
);
191 return SCM_UNSPECIFIED
;
195 /* Move ports with the specified file descriptor to new descriptors,
196 * resetting the revealed count to 0.
200 scm_evict_ports (int fd
)
204 scm_mutex_lock (&scm_i_port_table_mutex
);
206 for (i
= 0; i
< scm_i_port_table_size
; i
++)
208 SCM port
= scm_i_port_table
[i
]->port
;
210 if (SCM_FPORTP (port
))
212 scm_t_fport
*fp
= SCM_FSTREAM (port
);
218 scm_syserror ("scm_evict_ports");
219 scm_set_port_revealed_x (port
, scm_from_int (0));
224 scm_mutex_unlock (&scm_i_port_table_mutex
);
228 SCM_DEFINE (scm_file_port_p
, "file-port?", 1, 0, 0,
230 "Determine whether @var{obj} is a port that is related to a file.")
231 #define FUNC_NAME s_scm_file_port_p
233 return scm_from_bool (SCM_FPORTP (obj
));
239 * Return a new port open on a given file.
241 * The mode string must match the pattern: [rwa+]** which
242 * is interpreted in the usual unix way.
244 * Return the new port.
246 SCM_DEFINE (scm_open_file
, "open-file", 2, 0, 0,
247 (SCM filename
, SCM mode
),
248 "Open the file whose name is @var{filename}, and return a port\n"
249 "representing that file. The attributes of the port are\n"
250 "determined by the @var{mode} string. The way in which this is\n"
251 "interpreted is similar to C stdio. The first character must be\n"
252 "one of the following:\n"
255 "Open an existing file for input.\n"
257 "Open a file for output, creating it if it doesn't already exist\n"
258 "or removing its contents if it does.\n"
260 "Open a file for output, creating it if it doesn't already\n"
261 "exist. All writes to the port will go to the end of the file.\n"
262 "The \"append mode\" can be turned off while the port is in use\n"
263 "@pxref{Ports and File Descriptors, fcntl}\n"
265 "The following additional characters can be appended:\n"
268 "Open the port for both input and output. E.g., @code{r+}: open\n"
269 "an existing file for both input and output.\n"
271 "Create an \"unbuffered\" port. In this case input and output\n"
272 "operations are passed directly to the underlying port\n"
273 "implementation without additional buffering. This is likely to\n"
274 "slow down I/O operations. The buffering mode can be changed\n"
275 "while a port is in use @pxref{Ports and File Descriptors,\n"
278 "Add line-buffering to the port. The port output buffer will be\n"
279 "automatically flushed whenever a newline character is written.\n"
281 "In theory we could create read/write ports which were buffered\n"
282 "in one direction only. However this isn't included in the\n"
283 "current interfaces. If a file cannot be opened with the access\n"
284 "requested, @code{open-file} throws an exception.")
285 #define FUNC_NAME s_scm_open_file
296 file
= scm_to_locale_string (filename
);
297 scm_frame_free (file
);
299 md
= scm_to_locale_string (mode
);
308 flags
|= O_WRONLY
| O_CREAT
| O_TRUNC
;
311 flags
|= O_WRONLY
| O_CREAT
| O_APPEND
;
314 scm_out_of_range (FUNC_NAME
, mode
);
322 flags
= (flags
& ~(O_RDONLY
| O_WRONLY
)) | O_RDWR
;
325 #if defined (O_BINARY)
329 case '0': /* unbuffered: handled later. */
330 case 'l': /* line buffered: handled during output. */
333 scm_out_of_range (FUNC_NAME
, mode
);
337 SCM_SYSCALL (fdes
= open (file
, flags
, 0666));
342 SCM_SYSERROR_MSG ("~A: ~S",
343 scm_cons (scm_strerror (scm_from_int (en
)),
344 scm_cons (filename
, SCM_EOL
)), en
);
346 port
= scm_i_fdes_to_port (fdes
, scm_i_mode_bits (mode
), filename
);
357 * Try getting the appropiate file flags for a given file descriptor
358 * under Windows. This incorporates some fancy operations because Windows
359 * differentiates between file, pipe and socket descriptors.
362 # define O_ACCMODE 0x0003
365 static int getflags (int fdes
)
369 int error
, optlen
= sizeof (int);
371 /* Is this a socket ? */
372 if (getsockopt (fdes
, SOL_SOCKET
, SO_ERROR
, (void *) &error
, &optlen
) >= 0)
374 /* Maybe a regular file ? */
375 else if (fstat (fdes
, &buf
) < 0)
379 /* Or an anonymous pipe handle ? */
380 if (buf
.st_mode
& _S_IFIFO
)
381 flags
= PeekNamedPipe ((HANDLE
) _get_osfhandle (fdes
), NULL
, 0,
382 NULL
, NULL
, NULL
) ? O_RDONLY
: O_WRONLY
;
384 else if (fdes
== fileno (stdin
) && isatty (fdes
))
386 /* stdout / stderr ? */
387 else if ((fdes
== fileno (stdout
) || fdes
== fileno (stderr
)) &&
395 #endif /* __MINGW32__ */
397 /* Building Guile ports from a file descriptor. */
399 /* Build a Scheme port from an open file descriptor `fdes'.
400 MODE indicates whether FILE is open for reading or writing; it uses
401 the same notation as open-file's second argument.
402 NAME is a string to be used as the port's filename.
405 scm_i_fdes_to_port (int fdes
, long mode_bits
, SCM name
)
406 #define FUNC_NAME "scm_fdes_to_port"
412 /* test that fdes is valid. */
414 flags
= getflags (fdes
);
416 flags
= fcntl (fdes
, F_GETFL
, 0);
422 && ((flags
!= O_WRONLY
&& (mode_bits
& SCM_WRTNG
))
423 || (flags
!= O_RDONLY
&& (mode_bits
& SCM_RDNG
))))
425 SCM_MISC_ERROR ("requested file mode not available on fdes", SCM_EOL
);
428 scm_mutex_lock (&scm_i_port_table_mutex
);
430 port
= scm_new_port_table_entry (scm_tc16_fport
);
431 SCM_SET_CELL_TYPE(port
, scm_tc16_fport
| mode_bits
);
432 pt
= SCM_PTAB_ENTRY(port
);
435 = (scm_t_fport
*) scm_gc_malloc (sizeof (scm_t_fport
), "file port");
438 pt
->rw_random
= SCM_FDES_RANDOM_P (fdes
);
439 SCM_SETSTREAM (port
, fp
);
440 if (mode_bits
& SCM_BUF0
)
441 scm_fport_buffer_add (port
, 0, 0);
443 scm_fport_buffer_add (port
, -1, -1);
445 SCM_SET_FILENAME (port
, name
);
446 scm_mutex_unlock (&scm_i_port_table_mutex
);
452 scm_fdes_to_port (int fdes
, char *mode
, SCM name
)
454 return scm_i_fdes_to_port (fdes
, scm_mode_bits (mode
), name
);
457 /* Return a lower bound on the number of bytes available for input. */
459 fport_input_waiting (SCM port
)
461 int fdes
= SCM_FSTREAM (port
)->fdes
;
464 struct timeval timeout
;
465 SELECT_TYPE read_set
;
466 SELECT_TYPE write_set
;
467 SELECT_TYPE except_set
;
470 FD_ZERO (&write_set
);
471 FD_ZERO (&except_set
);
473 FD_SET (fdes
, &read_set
);
478 if (select (SELECT_SET_SIZE
,
479 &read_set
, &write_set
, &except_set
, &timeout
)
481 scm_syserror ("fport_input_waiting");
482 return FD_ISSET (fdes
, &read_set
) ? 1 : 0;
483 #elif defined (FIONREAD)
485 ioctl(fdes
, FIONREAD
, &remir
);
488 scm_misc_error ("fport_input_waiting",
489 "Not fully implemented on this platform",
496 fport_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
498 scm_puts ("#<", port
);
499 scm_print_port_mode (exp
, port
);
500 if (SCM_OPFPORTP (exp
))
503 SCM name
= SCM_FILENAME (exp
);
504 if (scm_is_string (name
) || scm_is_symbol (name
))
505 scm_display (name
, port
);
507 scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp
)), port
);
508 scm_putc (' ', port
);
509 fdes
= (SCM_FSTREAM (exp
))->fdes
;
513 scm_display (scm_ttyname (exp
), port
);
515 #endif /* HAVE_TTYNAME */
516 scm_intprint (fdes
, 10, port
);
520 scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp
)), port
);
521 scm_putc (' ', port
);
522 scm_intprint ((scm_t_bits
) SCM_PTAB_ENTRY (exp
), 16, port
);
524 scm_putc ('>', port
);
529 /* thread-local block for input on fport's fdes. */
531 fport_wait_for_input (SCM port
)
533 int fdes
= SCM_FSTREAM (port
)->fdes
;
535 if (!fport_input_waiting (port
))
539 int flags
= fcntl (fdes
, F_GETFL
);
542 scm_syserror ("scm_fdes_wait_for_input");
543 if (!(flags
& O_NONBLOCK
))
547 FD_SET (fdes
, &readfds
);
548 n
= scm_internal_select (fdes
+ 1, &readfds
, NULL
, NULL
, NULL
);
550 while (n
== -1 && errno
== EINTR
);
553 #endif /* !__MINGW32__ */
555 static void fport_flush (SCM port
);
557 /* fill a port's read-buffer with a single read. returns the first
558 char or EOF if end of file. */
560 fport_fill_input (SCM port
)
563 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
564 scm_t_fport
*fp
= SCM_FSTREAM (port
);
567 fport_wait_for_input (port
);
568 #endif /* !__MINGW32__ */
569 SCM_SYSCALL (count
= read (fp
->fdes
, pt
->read_buf
, pt
->read_buf_size
));
571 scm_syserror ("fport_fill_input");
576 pt
->read_pos
= pt
->read_buf
;
577 pt
->read_end
= pt
->read_buf
+ count
;
578 return *pt
->read_buf
;
583 fport_seek (SCM port
, off_t offset
, int whence
)
585 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
586 scm_t_fport
*fp
= SCM_FSTREAM (port
);
590 if (pt
->rw_active
== SCM_PORT_WRITE
)
592 if (offset
!= 0 || whence
!= SEEK_CUR
)
595 result
= rv
= lseek (fp
->fdes
, offset
, whence
);
599 /* read current position without disturbing the buffer. */
600 rv
= lseek (fp
->fdes
, offset
, whence
);
601 result
= rv
+ (pt
->write_pos
- pt
->write_buf
);
604 else if (pt
->rw_active
== SCM_PORT_READ
)
606 if (offset
!= 0 || whence
!= SEEK_CUR
)
608 /* could expand to avoid a second seek. */
609 scm_end_input (port
);
610 result
= rv
= lseek (fp
->fdes
, offset
, whence
);
614 /* read current position without disturbing the buffer
615 (particularly the unread-char buffer). */
616 rv
= lseek (fp
->fdes
, offset
, whence
);
617 result
= rv
- (pt
->read_end
- pt
->read_pos
);
619 if (pt
->read_buf
== pt
->putback_buf
)
620 result
-= pt
->saved_read_end
- pt
->saved_read_pos
;
623 else /* SCM_PORT_NEITHER */
625 result
= rv
= lseek (fp
->fdes
, offset
, whence
);
629 scm_syserror ("fport_seek");
635 fport_truncate (SCM port
, off_t length
)
637 scm_t_fport
*fp
= SCM_FSTREAM (port
);
639 if (ftruncate (fp
->fdes
, length
) == -1)
640 scm_syserror ("ftruncate");
643 /* helper for fport_write: try to write data, using multiple system
644 calls if required. */
645 #define FUNC_NAME "write_all"
646 static void write_all (SCM port
, const void *data
, size_t remaining
)
648 int fdes
= SCM_FSTREAM (port
)->fdes
;
650 while (remaining
> 0)
654 SCM_SYSCALL (done
= write (fdes
, data
, remaining
));
659 data
= ((const char *) data
) + done
;
665 fport_write (SCM port
, const void *data
, size_t size
)
667 /* this procedure tries to minimize the number of writes/flushes. */
668 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
670 if (pt
->write_buf
== &pt
->shortbuf
671 || (pt
->write_pos
== pt
->write_buf
&& size
>= pt
->write_buf_size
))
673 /* "unbuffered" port, or
674 port with empty buffer and data won't fit in buffer. */
675 write_all (port
, data
, size
);
680 off_t space
= pt
->write_end
- pt
->write_pos
;
684 /* data fits in buffer. */
685 memcpy (pt
->write_pos
, data
, size
);
686 pt
->write_pos
+= size
;
687 if (pt
->write_pos
== pt
->write_end
)
690 /* we can skip the line-buffering check if nothing's buffered. */
696 memcpy (pt
->write_pos
, data
, space
);
697 pt
->write_pos
= pt
->write_end
;
700 const void *ptr
= ((const char *) data
) + space
;
701 size_t remaining
= size
- space
;
703 if (size
>= pt
->write_buf_size
)
705 write_all (port
, ptr
, remaining
);
710 memcpy (pt
->write_pos
, ptr
, remaining
);
711 pt
->write_pos
+= remaining
;
716 /* handle line buffering. */
717 if ((SCM_CELL_WORD_0 (port
) & SCM_BUFLINE
) && memchr (data
, '\n', size
))
722 /* becomes 1 when process is exiting: normal exception handling won't
723 work by this time. */
724 extern int scm_i_terminating
;
727 fport_flush (SCM port
)
729 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
730 scm_t_fport
*fp
= SCM_FSTREAM (port
);
731 unsigned char *ptr
= pt
->write_buf
;
732 long init_size
= pt
->write_pos
- pt
->write_buf
;
733 long remaining
= init_size
;
735 while (remaining
> 0)
739 SCM_SYSCALL (count
= write (fp
->fdes
, ptr
, remaining
));
742 /* error. assume nothing was written this call, but
743 fix up the buffer for any previous successful writes. */
744 long done
= init_size
- remaining
;
750 for (i
= 0; i
< remaining
; i
++)
752 *(pt
->write_buf
+ i
) = *(pt
->write_buf
+ done
+ i
);
754 pt
->write_pos
= pt
->write_buf
+ remaining
;
756 if (scm_i_terminating
)
758 const char *msg
= "Error: could not flush file-descriptor ";
761 write (2, msg
, strlen (msg
));
762 sprintf (buf
, "%d\n", fp
->fdes
);
763 write (2, buf
, strlen (buf
));
767 else if (scm_gc_running_p
)
769 /* silently ignore the error. scm_error would abort if we
774 scm_syserror ("fport_flush");
779 pt
->write_pos
= pt
->write_buf
;
780 pt
->rw_active
= SCM_PORT_NEITHER
;
783 /* clear the read buffer and adjust the file position for unread bytes. */
785 fport_end_input (SCM port
, int offset
)
787 scm_t_fport
*fp
= SCM_FSTREAM (port
);
788 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
790 offset
+= pt
->read_end
- pt
->read_pos
;
794 pt
->read_pos
= pt
->read_end
;
795 /* will throw error if unread-char used at beginning of file
796 then attempting to write. seems correct. */
797 if (lseek (fp
->fdes
, -offset
, SEEK_CUR
) == -1)
798 scm_syserror ("fport_end_input");
800 pt
->rw_active
= SCM_PORT_NEITHER
;
804 fport_close (SCM port
)
806 scm_t_fport
*fp
= SCM_FSTREAM (port
);
807 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
811 SCM_SYSCALL (rv
= close (fp
->fdes
));
812 if (rv
== -1 && errno
!= EBADF
)
814 if (scm_gc_running_p
)
815 /* silently ignore the error. scm_error would abort if we
819 scm_syserror ("fport_close");
821 if (pt
->read_buf
== pt
->putback_buf
)
822 pt
->read_buf
= pt
->saved_read_buf
;
823 if (pt
->read_buf
!= &pt
->shortbuf
)
824 scm_gc_free (pt
->read_buf
, pt
->read_buf_size
, "port buffer");
825 if (pt
->write_buf
!= &pt
->shortbuf
)
826 scm_gc_free (pt
->write_buf
, pt
->write_buf_size
, "port buffer");
827 scm_gc_free (fp
, sizeof (*fp
), "file port");
832 fport_free (SCM port
)
841 scm_t_bits tc
= scm_make_port_type ("file", fport_fill_input
, fport_write
);
843 scm_set_port_free (tc
, fport_free
);
844 scm_set_port_print (tc
, fport_print
);
845 scm_set_port_flush (tc
, fport_flush
);
846 scm_set_port_end_input (tc
, fport_end_input
);
847 scm_set_port_close (tc
, fport_close
);
848 scm_set_port_seek (tc
, fport_seek
);
849 scm_set_port_truncate (tc
, fport_truncate
);
850 scm_set_port_input_waiting (tc
, fport_input_waiting
);
858 scm_tc16_fport
= scm_make_fptob ();
860 scm_c_define ("_IOFBF", scm_from_int (_IOFBF
));
861 scm_c_define ("_IOLBF", scm_from_int (_IOLBF
));
862 scm_c_define ("_IONBF", scm_from_int (_IONBF
));
864 #include "libguile/fports.x"