open-file should handle binary mode and coding declarations
[bpt/guile.git] / libguile / fports.c
1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2004, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
2 *
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
7 *
8 * This library is distributed in the hope that it will be useful, but
9 * 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.
12 *
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16 * 02110-1301 USA
17 */
18
19
20 \f
21 #define _LARGEFILE64_SOURCE /* ask for stat64 etc */
22
23 #ifdef HAVE_CONFIG_H
24 # include <config.h>
25 #endif
26
27 #include <stdio.h>
28 #include <fcntl.h>
29 #include "libguile/_scm.h"
30 #include "libguile/strings.h"
31 #include "libguile/validate.h"
32 #include "libguile/gc.h"
33 #include "libguile/posix.h"
34 #include "libguile/dynwind.h"
35 #include "libguile/hashtab.h"
36
37 #include "libguile/fports.h"
38
39 #ifdef HAVE_STRING_H
40 #include <string.h>
41 #endif
42 #ifdef HAVE_UNISTD_H
43 #include <unistd.h>
44 #endif
45 #ifdef HAVE_IO_H
46 #include <io.h>
47 #endif
48 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
49 #include <sys/stat.h>
50 #endif
51
52 #include <errno.h>
53 #include <sys/types.h>
54
55 #include "libguile/iselect.h"
56
57 /* Some defines for Windows (native port, not Cygwin). */
58 #ifdef __MINGW32__
59 # include <sys/stat.h>
60 # include <winsock2.h>
61 #endif /* __MINGW32__ */
62
63 #include <full-write.h>
64
65 /* Mingw (version 3.4.5, circa 2006) has ftruncate as an alias for chsize
66 already, but have this code here in case that wasn't so in past versions,
67 or perhaps to help other minimal DOS environments.
68
69 gnulib ftruncate.c has code using fcntl F_CHSIZE and F_FREESP, which
70 might be possibilities if we've got other systems without ftruncate. */
71
72 #if defined HAVE_CHSIZE && ! defined HAVE_FTRUNCATE
73 # define ftruncate(fd, size) chsize (fd, size)
74 # undef HAVE_FTRUNCATE
75 # define HAVE_FTRUNCATE 1
76 #endif
77
78 #if SIZEOF_OFF_T == SIZEOF_INT
79 #define OFF_T_MAX INT_MAX
80 #define OFF_T_MIN INT_MIN
81 #elif SIZEOF_OFF_T == SIZEOF_LONG
82 #define OFF_T_MAX LONG_MAX
83 #define OFF_T_MIN LONG_MIN
84 #elif SIZEOF_OFF_T == SIZEOF_LONG_LONG
85 #define OFF_T_MAX LONG_LONG_MAX
86 #define OFF_T_MIN LONG_LONG_MIN
87 #else
88 #error Oops, unknown OFF_T size
89 #endif
90
91 scm_t_bits scm_tc16_fport;
92
93
94 /* default buffer size, used if the O/S won't supply a value. */
95 static const size_t default_buffer_size = 1024;
96
97 /* create FPORT buffer with specified sizes (or -1 to use default size or
98 0 for no buffer. */
99 static void
100 scm_fport_buffer_add (SCM port, long read_size, int write_size)
101 #define FUNC_NAME "scm_fport_buffer_add"
102 {
103 scm_t_port *pt = SCM_PTAB_ENTRY (port);
104
105 if (read_size == -1 || write_size == -1)
106 {
107 size_t default_size;
108 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
109 struct stat st;
110 scm_t_fport *fp = SCM_FSTREAM (port);
111
112 default_size = (fstat (fp->fdes, &st) == -1) ? default_buffer_size
113 : st.st_blksize;
114 #else
115 default_size = default_buffer_size;
116 #endif
117 if (read_size == -1)
118 read_size = default_size;
119 if (write_size == -1)
120 write_size = default_size;
121 }
122
123 if (SCM_INPUT_PORT_P (port) && read_size > 0)
124 {
125 pt->read_buf = scm_gc_malloc_pointerless (read_size, "port buffer");
126 pt->read_pos = pt->read_end = pt->read_buf;
127 pt->read_buf_size = read_size;
128 }
129 else
130 {
131 pt->read_pos = pt->read_buf = pt->read_end = &pt->shortbuf;
132 pt->read_buf_size = 1;
133 }
134
135 if (SCM_OUTPUT_PORT_P (port) && write_size > 0)
136 {
137 pt->write_buf = scm_gc_malloc_pointerless (write_size, "port buffer");
138 pt->write_pos = pt->write_buf;
139 pt->write_buf_size = write_size;
140 }
141 else
142 {
143 pt->write_buf = pt->write_pos = &pt->shortbuf;
144 pt->write_buf_size = 1;
145 }
146
147 pt->write_end = pt->write_buf + pt->write_buf_size;
148 if (read_size > 0 || write_size > 0)
149 SCM_SET_CELL_WORD_0 (port, SCM_CELL_WORD_0 (port) & ~SCM_BUF0);
150 else
151 SCM_SET_CELL_WORD_0 (port, SCM_CELL_WORD_0 (port) | SCM_BUF0);
152 }
153 #undef FUNC_NAME
154
155 SCM_DEFINE (scm_setvbuf, "setvbuf", 2, 1, 0,
156 (SCM port, SCM mode, SCM size),
157 "Set the buffering mode for @var{port}. @var{mode} can be:\n"
158 "@table @code\n"
159 "@item _IONBF\n"
160 "non-buffered\n"
161 "@item _IOLBF\n"
162 "line buffered\n"
163 "@item _IOFBF\n"
164 "block buffered, using a newly allocated buffer of @var{size} bytes.\n"
165 "If @var{size} is omitted, a default size will be used.\n"
166 "@end table")
167 #define FUNC_NAME s_scm_setvbuf
168 {
169 int cmode;
170 long csize;
171 scm_t_port *pt;
172
173 port = SCM_COERCE_OUTPORT (port);
174
175 SCM_VALIDATE_OPFPORT (1,port);
176 cmode = scm_to_int (mode);
177 if (cmode != _IONBF && cmode != _IOFBF && cmode != _IOLBF)
178 scm_out_of_range (FUNC_NAME, mode);
179
180 if (cmode == _IOLBF)
181 {
182 SCM_SET_CELL_WORD_0 (port, SCM_CELL_WORD_0 (port) | SCM_BUFLINE);
183 cmode = _IOFBF;
184 }
185 else
186 {
187 SCM_SET_CELL_WORD_0 (port, SCM_CELL_WORD_0 (port) & ~(scm_t_bits)SCM_BUFLINE);
188 }
189
190 if (SCM_UNBNDP (size))
191 {
192 if (cmode == _IOFBF)
193 csize = -1;
194 else
195 csize = 0;
196 }
197 else
198 {
199 csize = scm_to_int (size);
200 if (csize < 0 || (cmode == _IONBF && csize > 0))
201 scm_out_of_range (FUNC_NAME, size);
202 }
203
204 pt = SCM_PTAB_ENTRY (port);
205
206 /* silently discards buffered and put-back chars. */
207 if (pt->read_buf == pt->putback_buf)
208 {
209 pt->read_buf = pt->saved_read_buf;
210 pt->read_pos = pt->saved_read_pos;
211 pt->read_end = pt->saved_read_end;
212 pt->read_buf_size = pt->saved_read_buf_size;
213 }
214 if (pt->read_buf != &pt->shortbuf)
215 scm_gc_free (pt->read_buf, pt->read_buf_size, "port buffer");
216 if (pt->write_buf != &pt->shortbuf)
217 scm_gc_free (pt->write_buf, pt->write_buf_size, "port buffer");
218
219 scm_fport_buffer_add (port, csize, csize);
220 return SCM_UNSPECIFIED;
221 }
222 #undef FUNC_NAME
223
224 /* Move ports with the specified file descriptor to new descriptors,
225 * resetting the revealed count to 0.
226 */
227 static void
228 scm_i_evict_port (void *closure, SCM port)
229 {
230 int fd = * (int*) closure;
231
232 if (SCM_FPORTP (port))
233 {
234 scm_t_port *p;
235 scm_t_fport *fp;
236
237 /* XXX: In some cases, we can encounter a port with no associated ptab
238 entry. */
239 p = SCM_PTAB_ENTRY (port);
240 fp = (p != NULL) ? (scm_t_fport *) p->stream : NULL;
241
242 if ((fp != NULL) && (fp->fdes == fd))
243 {
244 fp->fdes = dup (fd);
245 if (fp->fdes == -1)
246 scm_syserror ("scm_evict_ports");
247 scm_set_port_revealed_x (port, scm_from_int (0));
248 }
249 }
250 }
251
252 void
253 scm_evict_ports (int fd)
254 {
255 scm_c_port_for_each (scm_i_evict_port, (void *) &fd);
256 }
257
258
259 SCM_DEFINE (scm_file_port_p, "file-port?", 1, 0, 0,
260 (SCM obj),
261 "Determine whether @var{obj} is a port that is related to a file.")
262 #define FUNC_NAME s_scm_file_port_p
263 {
264 return scm_from_bool (SCM_FPORTP (obj));
265 }
266 #undef FUNC_NAME
267
268
269 static SCM sys_file_port_name_canonicalization;
270 SCM_SYMBOL (sym_relative, "relative");
271 SCM_SYMBOL (sym_absolute, "absolute");
272
273 static SCM
274 fport_canonicalize_filename (SCM filename)
275 {
276 SCM mode = scm_fluid_ref (sys_file_port_name_canonicalization);
277
278 if (!scm_is_string (filename))
279 {
280 return filename;
281 }
282 else if (scm_is_eq (mode, sym_relative))
283 {
284 SCM path, rel;
285
286 path = scm_variable_ref (scm_c_module_lookup (scm_the_root_module (),
287 "%load-path"));
288 rel = scm_i_relativize_path (filename, path);
289
290 return scm_is_true (rel) ? rel : filename;
291 }
292 else if (scm_is_eq (mode, sym_absolute))
293 {
294 char *str, *canon;
295
296 str = scm_to_locale_string (filename);
297 canon = canonicalize_file_name (str);
298 free (str);
299
300 return canon ? scm_take_locale_string (canon) : filename;
301 }
302 else
303 {
304 return filename;
305 }
306 }
307
308
309 /* scm_open_file
310 * Return a new port open on a given file.
311 *
312 * The mode string must match the pattern: [rwa+]** which
313 * is interpreted in the usual unix way.
314 *
315 * Return the new port.
316 */
317 SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
318 (SCM filename, SCM mode),
319 "Open the file whose name is @var{filename}, and return a port\n"
320 "representing that file. The attributes of the port are\n"
321 "determined by the @var{mode} string. The way in which this is\n"
322 "interpreted is similar to C stdio. The first character must be\n"
323 "one of the following:\n"
324 "@table @samp\n"
325 "@item r\n"
326 "Open an existing file for input.\n"
327 "@item w\n"
328 "Open a file for output, creating it if it doesn't already exist\n"
329 "or removing its contents if it does.\n"
330 "@item a\n"
331 "Open a file for output, creating it if it doesn't already\n"
332 "exist. All writes to the port will go to the end of the file.\n"
333 "The \"append mode\" can be turned off while the port is in use\n"
334 "@pxref{Ports and File Descriptors, fcntl}\n"
335 "@end table\n"
336 "The following additional characters can be appended:\n"
337 "@table @samp\n"
338 "@item b\n"
339 "Open the underlying file in binary mode, if supported by the system.\n"
340 "Also, open the file using the binary-compatible character encoding\n"
341 "\"ISO-8859-1\", ignoring the port's encoding and the coding declaration\n"
342 "at the top of the input file, if any.\n"
343 "@item +\n"
344 "Open the port for both input and output. E.g., @code{r+}: open\n"
345 "an existing file for both input and output.\n"
346 "@item 0\n"
347 "Create an \"unbuffered\" port. In this case input and output\n"
348 "operations are passed directly to the underlying port\n"
349 "implementation without additional buffering. This is likely to\n"
350 "slow down I/O operations. The buffering mode can be changed\n"
351 "while a port is in use @pxref{Ports and File Descriptors,\n"
352 "setvbuf}\n"
353 "@item l\n"
354 "Add line-buffering to the port. The port output buffer will be\n"
355 "automatically flushed whenever a newline character is written.\n"
356 "@end table\n"
357 "When the file is opened, this procedure will scan for a coding\n"
358 "declaration@pxref{Character Encoding of Source Files}. If present\n"
359 "will use that encoding for interpreting the file. Otherwise, the\n"
360 "port's encoding will be used.\n"
361 "\n"
362 "In theory we could create read/write ports which were buffered\n"
363 "in one direction only. However this isn't included in the\n"
364 "current interfaces. If a file cannot be opened with the access\n"
365 "requested, @code{open-file} throws an exception.")
366 #define FUNC_NAME s_scm_open_file
367 {
368 SCM port;
369 int fdes, flags = 0, use_encoding = 1;
370 unsigned int retries;
371 char *file, *md, *ptr;
372
373 scm_dynwind_begin (0);
374
375 file = scm_to_locale_string (filename);
376 scm_dynwind_free (file);
377
378 md = scm_to_locale_string (mode);
379 scm_dynwind_free (md);
380
381 switch (*md)
382 {
383 case 'r':
384 flags |= O_RDONLY;
385 break;
386 case 'w':
387 flags |= O_WRONLY | O_CREAT | O_TRUNC;
388 break;
389 case 'a':
390 flags |= O_WRONLY | O_CREAT | O_APPEND;
391 break;
392 default:
393 scm_out_of_range (FUNC_NAME, mode);
394 }
395 ptr = md + 1;
396 while (*ptr != '\0')
397 {
398 switch (*ptr)
399 {
400 case '+':
401 flags = (flags & ~(O_RDONLY | O_WRONLY)) | O_RDWR;
402 break;
403 case 'b':
404 use_encoding = 0;
405 #if defined (O_BINARY)
406 flags |= O_BINARY;
407 #endif
408 break;
409 case '0': /* unbuffered: handled later. */
410 case 'l': /* line buffered: handled during output. */
411 break;
412 default:
413 scm_out_of_range (FUNC_NAME, mode);
414 }
415 ptr++;
416 }
417
418 for (retries = 0, fdes = -1;
419 fdes < 0 && retries < 2;
420 retries++)
421 {
422 SCM_SYSCALL (fdes = open_or_open64 (file, flags, 0666));
423 if (fdes == -1)
424 {
425 int en = errno;
426
427 if (en == EMFILE && retries == 0)
428 /* Run the GC in case it collects open file ports that are no
429 longer referenced. */
430 scm_i_gc (FUNC_NAME);
431 else
432 SCM_SYSERROR_MSG ("~A: ~S",
433 scm_cons (scm_strerror (scm_from_int (en)),
434 scm_cons (filename, SCM_EOL)), en);
435 }
436 }
437
438 /* Create a port from this file descriptor. The port's encoding is initially
439 %default-port-encoding. */
440 port = scm_i_fdes_to_port (fdes, scm_i_mode_bits (mode),
441 fport_canonicalize_filename (filename));
442
443 if (use_encoding)
444 {
445 /* If this file has a coding declaration, use that as the port
446 encoding. */
447 if (SCM_INPUT_PORT_P (port))
448 {
449 char *enc = scm_i_scan_for_encoding (port);
450 if (enc != NULL)
451 scm_i_set_port_encoding_x (port, enc);
452 }
453 }
454 else
455 /* If this is a binary file, use the binary-friendly ISO-8859-1
456 encoding. */
457 scm_i_set_port_encoding_x (port, NULL);
458
459 scm_dynwind_end ();
460
461 return port;
462 }
463 #undef FUNC_NAME
464
465 \f
466 #ifdef __MINGW32__
467 /*
468 * Try getting the appropiate file flags for a given file descriptor
469 * under Windows. This incorporates some fancy operations because Windows
470 * differentiates between file, pipe and socket descriptors.
471 */
472 #ifndef O_ACCMODE
473 # define O_ACCMODE 0x0003
474 #endif
475
476 static int getflags (int fdes)
477 {
478 int flags = 0;
479 struct stat buf;
480 int error, optlen = sizeof (int);
481
482 /* Is this a socket ? */
483 if (getsockopt (fdes, SOL_SOCKET, SO_ERROR, (void *) &error, &optlen) >= 0)
484 flags = O_RDWR;
485 /* Maybe a regular file ? */
486 else if (fstat (fdes, &buf) < 0)
487 flags = -1;
488 else
489 {
490 /* Or an anonymous pipe handle ? */
491 if (buf.st_mode & _S_IFIFO)
492 flags = PeekNamedPipe ((HANDLE) _get_osfhandle (fdes), NULL, 0,
493 NULL, NULL, NULL) ? O_RDONLY : O_WRONLY;
494 /* stdin ? */
495 else if (fdes == fileno (stdin) && isatty (fdes))
496 flags = O_RDONLY;
497 /* stdout / stderr ? */
498 else if ((fdes == fileno (stdout) || fdes == fileno (stderr)) &&
499 isatty (fdes))
500 flags = O_WRONLY;
501 else
502 flags = buf.st_mode;
503 }
504 return flags;
505 }
506 #endif /* __MINGW32__ */
507
508 /* Building Guile ports from a file descriptor. */
509
510 /* Build a Scheme port from an open file descriptor `fdes'.
511 MODE indicates whether FILE is open for reading or writing; it uses
512 the same notation as open-file's second argument.
513 NAME is a string to be used as the port's filename.
514 */
515 SCM
516 scm_i_fdes_to_port (int fdes, long mode_bits, SCM name)
517 #define FUNC_NAME "scm_fdes_to_port"
518 {
519 SCM port;
520 scm_t_port *pt;
521 int flags;
522
523 /* test that fdes is valid. */
524 #ifdef __MINGW32__
525 flags = getflags (fdes);
526 #else
527 flags = fcntl (fdes, F_GETFL, 0);
528 #endif
529 if (flags == -1)
530 SCM_SYSERROR;
531 flags &= O_ACCMODE;
532 if (flags != O_RDWR
533 && ((flags != O_WRONLY && (mode_bits & SCM_WRTNG))
534 || (flags != O_RDONLY && (mode_bits & SCM_RDNG))))
535 {
536 SCM_MISC_ERROR ("requested file mode not available on fdes", SCM_EOL);
537 }
538
539 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex);
540
541 port = scm_new_port_table_entry (scm_tc16_fport);
542 SCM_SET_CELL_TYPE(port, scm_tc16_fport | mode_bits);
543 pt = SCM_PTAB_ENTRY(port);
544 {
545 scm_t_fport *fp
546 = (scm_t_fport *) scm_gc_malloc_pointerless (sizeof (scm_t_fport),
547 "file port");
548
549 fp->fdes = fdes;
550 pt->rw_random = SCM_FDES_RANDOM_P (fdes);
551 SCM_SETSTREAM (port, fp);
552 if (mode_bits & SCM_BUF0)
553 scm_fport_buffer_add (port, 0, 0);
554 else
555 scm_fport_buffer_add (port, -1, -1);
556 }
557 SCM_SET_FILENAME (port, name);
558 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex);
559 return port;
560 }
561 #undef FUNC_NAME
562
563 SCM
564 scm_fdes_to_port (int fdes, char *mode, SCM name)
565 {
566 return scm_i_fdes_to_port (fdes, scm_mode_bits (mode), name);
567 }
568
569 /* Return a lower bound on the number of bytes available for input. */
570 static int
571 fport_input_waiting (SCM port)
572 {
573 #ifdef HAVE_SELECT
574 int fdes = SCM_FSTREAM (port)->fdes;
575 struct timeval timeout;
576 SELECT_TYPE read_set;
577 SELECT_TYPE write_set;
578 SELECT_TYPE except_set;
579
580 FD_ZERO (&read_set);
581 FD_ZERO (&write_set);
582 FD_ZERO (&except_set);
583
584 FD_SET (fdes, &read_set);
585
586 timeout.tv_sec = 0;
587 timeout.tv_usec = 0;
588
589 if (select (SELECT_SET_SIZE,
590 &read_set, &write_set, &except_set, &timeout)
591 < 0)
592 scm_syserror ("fport_input_waiting");
593 return FD_ISSET (fdes, &read_set) ? 1 : 0;
594
595 #elif HAVE_IOCTL && defined (FIONREAD)
596 /* Note: cannot test just defined(FIONREAD) here, since mingw has FIONREAD
597 (for use with winsock ioctlsocket()) but not ioctl(). */
598 int fdes = SCM_FSTREAM (port)->fdes;
599 int remir;
600 ioctl(fdes, FIONREAD, &remir);
601 return remir;
602
603 #else
604 scm_misc_error ("fport_input_waiting",
605 "Not fully implemented on this platform",
606 SCM_EOL);
607 #endif
608 }
609
610 \f
611 static int
612 fport_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
613 {
614 scm_puts ("#<", port);
615 scm_print_port_mode (exp, port);
616 if (SCM_OPFPORTP (exp))
617 {
618 int fdes;
619 SCM name = SCM_FILENAME (exp);
620 if (scm_is_string (name) || scm_is_symbol (name))
621 scm_display (name, port);
622 else
623 scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp)), port);
624 scm_putc (' ', port);
625 fdes = (SCM_FSTREAM (exp))->fdes;
626
627 #ifdef HAVE_TTYNAME
628 if (isatty (fdes))
629 scm_display (scm_ttyname (exp), port);
630 else
631 #endif /* HAVE_TTYNAME */
632 scm_intprint (fdes, 10, port);
633 }
634 else
635 {
636 scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp)), port);
637 scm_putc (' ', port);
638 scm_uintprint ((scm_t_bits) SCM_PTAB_ENTRY (exp), 16, port);
639 }
640 scm_putc ('>', port);
641 return 1;
642 }
643
644 #ifndef __MINGW32__
645 /* thread-local block for input on fport's fdes. */
646 static void
647 fport_wait_for_input (SCM port)
648 {
649 int fdes = SCM_FSTREAM (port)->fdes;
650
651 if (!fport_input_waiting (port))
652 {
653 int n;
654 SELECT_TYPE readfds;
655 int flags = fcntl (fdes, F_GETFL);
656
657 if (flags == -1)
658 scm_syserror ("scm_fdes_wait_for_input");
659 if (!(flags & O_NONBLOCK))
660 do
661 {
662 FD_ZERO (&readfds);
663 FD_SET (fdes, &readfds);
664 n = scm_std_select (fdes + 1, &readfds, NULL, NULL, NULL);
665 }
666 while (n == -1 && errno == EINTR);
667 }
668 }
669 #endif /* !__MINGW32__ */
670
671 static void fport_flush (SCM port);
672
673 /* fill a port's read-buffer with a single read. returns the first
674 char or EOF if end of file. */
675 static scm_t_wchar
676 fport_fill_input (SCM port)
677 {
678 long count;
679 scm_t_port *pt = SCM_PTAB_ENTRY (port);
680 scm_t_fport *fp = SCM_FSTREAM (port);
681
682 #ifndef __MINGW32__
683 fport_wait_for_input (port);
684 #endif /* !__MINGW32__ */
685 SCM_SYSCALL (count = read (fp->fdes, pt->read_buf, pt->read_buf_size));
686 if (count == -1)
687 scm_syserror ("fport_fill_input");
688 if (count == 0)
689 return (scm_t_wchar) EOF;
690 else
691 {
692 pt->read_pos = pt->read_buf;
693 pt->read_end = pt->read_buf + count;
694 return *pt->read_buf;
695 }
696 }
697
698 static scm_t_off
699 fport_seek (SCM port, scm_t_off offset, int whence)
700 {
701 scm_t_port *pt = SCM_PTAB_ENTRY (port);
702 scm_t_fport *fp = SCM_FSTREAM (port);
703 off_t_or_off64_t rv;
704 off_t_or_off64_t result;
705
706 if (pt->rw_active == SCM_PORT_WRITE)
707 {
708 if (offset != 0 || whence != SEEK_CUR)
709 {
710 fport_flush (port);
711 result = rv = lseek_or_lseek64 (fp->fdes, offset, whence);
712 }
713 else
714 {
715 /* read current position without disturbing the buffer. */
716 rv = lseek_or_lseek64 (fp->fdes, offset, whence);
717 result = rv + (pt->write_pos - pt->write_buf);
718 }
719 }
720 else if (pt->rw_active == SCM_PORT_READ)
721 {
722 if (offset != 0 || whence != SEEK_CUR)
723 {
724 /* could expand to avoid a second seek. */
725 scm_end_input (port);
726 result = rv = lseek_or_lseek64 (fp->fdes, offset, whence);
727 }
728 else
729 {
730 /* read current position without disturbing the buffer
731 (particularly the unread-char buffer). */
732 rv = lseek_or_lseek64 (fp->fdes, offset, whence);
733 result = rv - (pt->read_end - pt->read_pos);
734
735 if (pt->read_buf == pt->putback_buf)
736 result -= pt->saved_read_end - pt->saved_read_pos;
737 }
738 }
739 else /* SCM_PORT_NEITHER */
740 {
741 result = rv = lseek_or_lseek64 (fp->fdes, offset, whence);
742 }
743
744 if (rv == -1)
745 scm_syserror ("fport_seek");
746
747 return result;
748 }
749
750 static void
751 fport_truncate (SCM port, scm_t_off length)
752 {
753 scm_t_fport *fp = SCM_FSTREAM (port);
754
755 if (ftruncate (fp->fdes, length) == -1)
756 scm_syserror ("ftruncate");
757 }
758
759 static void
760 fport_write (SCM port, const void *data, size_t size)
761 #define FUNC_NAME "fport_write"
762 {
763 /* this procedure tries to minimize the number of writes/flushes. */
764 scm_t_port *pt = SCM_PTAB_ENTRY (port);
765
766 if (pt->write_buf == &pt->shortbuf
767 || (pt->write_pos == pt->write_buf && size >= pt->write_buf_size))
768 {
769 /* Unbuffered port, or port with empty buffer and data won't fit in
770 buffer. */
771 if (full_write (SCM_FPORT_FDES (port), data, size) < size)
772 SCM_SYSERROR;
773
774 return;
775 }
776
777 {
778 scm_t_off space = pt->write_end - pt->write_pos;
779
780 if (size <= space)
781 {
782 /* data fits in buffer. */
783 memcpy (pt->write_pos, data, size);
784 pt->write_pos += size;
785 if (pt->write_pos == pt->write_end)
786 {
787 fport_flush (port);
788 /* we can skip the line-buffering check if nothing's buffered. */
789 return;
790 }
791 }
792 else
793 {
794 memcpy (pt->write_pos, data, space);
795 pt->write_pos = pt->write_end;
796 fport_flush (port);
797 {
798 const void *ptr = ((const char *) data) + space;
799 size_t remaining = size - space;
800
801 if (size >= pt->write_buf_size)
802 {
803 if (full_write (SCM_FPORT_FDES (port), ptr, remaining)
804 < remaining)
805 SCM_SYSERROR;
806 return;
807 }
808 else
809 {
810 memcpy (pt->write_pos, ptr, remaining);
811 pt->write_pos += remaining;
812 }
813 }
814 }
815
816 /* handle line buffering. */
817 if ((SCM_CELL_WORD_0 (port) & SCM_BUFLINE) && memchr (data, '\n', size))
818 fport_flush (port);
819 }
820 }
821 #undef FUNC_NAME
822
823 static void
824 fport_flush (SCM port)
825 {
826 scm_t_port *pt = SCM_PTAB_ENTRY (port);
827 scm_t_fport *fp = SCM_FSTREAM (port);
828 unsigned char *ptr = pt->write_buf;
829 long init_size = pt->write_pos - pt->write_buf;
830 long remaining = init_size;
831
832 while (remaining > 0)
833 {
834 long count;
835
836 SCM_SYSCALL (count = write (fp->fdes, ptr, remaining));
837 if (count < 0)
838 {
839 /* error. assume nothing was written this call, but
840 fix up the buffer for any previous successful writes. */
841 long done = init_size - remaining;
842
843 if (done > 0)
844 {
845 int i;
846
847 for (i = 0; i < remaining; i++)
848 {
849 *(pt->write_buf + i) = *(pt->write_buf + done + i);
850 }
851 pt->write_pos = pt->write_buf + remaining;
852 }
853 if (scm_gc_running_p)
854 {
855 /* silently ignore the error. scm_error would abort if we
856 called it now. */
857 count = remaining;
858 }
859 else
860 scm_syserror ("fport_flush");
861 }
862 ptr += count;
863 remaining -= count;
864 }
865 pt->write_pos = pt->write_buf;
866 pt->rw_active = SCM_PORT_NEITHER;
867 }
868
869 /* clear the read buffer and adjust the file position for unread bytes. */
870 static void
871 fport_end_input (SCM port, int offset)
872 {
873 scm_t_fport *fp = SCM_FSTREAM (port);
874 scm_t_port *pt = SCM_PTAB_ENTRY (port);
875
876 offset += pt->read_end - pt->read_pos;
877
878 if (offset > 0)
879 {
880 pt->read_pos = pt->read_end;
881 /* will throw error if unread-char used at beginning of file
882 then attempting to write. seems correct. */
883 if (lseek (fp->fdes, -offset, SEEK_CUR) == -1)
884 scm_syserror ("fport_end_input");
885 }
886 pt->rw_active = SCM_PORT_NEITHER;
887 }
888
889 static int
890 fport_close (SCM port)
891 {
892 scm_t_fport *fp = SCM_FSTREAM (port);
893 scm_t_port *pt = SCM_PTAB_ENTRY (port);
894 int rv;
895
896 fport_flush (port);
897 SCM_SYSCALL (rv = close (fp->fdes));
898 if (rv == -1 && errno != EBADF)
899 {
900 if (scm_gc_running_p)
901 /* silently ignore the error. scm_error would abort if we
902 called it now. */
903 ;
904 else
905 scm_syserror ("fport_close");
906 }
907 if (pt->read_buf == pt->putback_buf)
908 pt->read_buf = pt->saved_read_buf;
909 if (pt->read_buf != &pt->shortbuf)
910 scm_gc_free (pt->read_buf, pt->read_buf_size, "port buffer");
911 if (pt->write_buf != &pt->shortbuf)
912 scm_gc_free (pt->write_buf, pt->write_buf_size, "port buffer");
913 scm_gc_free (fp, sizeof (*fp), "file port");
914 return rv;
915 }
916
917 static size_t
918 fport_free (SCM port)
919 {
920 fport_close (port);
921 return 0;
922 }
923
924 static scm_t_bits
925 scm_make_fptob ()
926 {
927 scm_t_bits tc = scm_make_port_type ("file", fport_fill_input, fport_write);
928
929 scm_set_port_free (tc, fport_free);
930 scm_set_port_print (tc, fport_print);
931 scm_set_port_flush (tc, fport_flush);
932 scm_set_port_end_input (tc, fport_end_input);
933 scm_set_port_close (tc, fport_close);
934 scm_set_port_seek (tc, fport_seek);
935 scm_set_port_truncate (tc, fport_truncate);
936 scm_set_port_input_waiting (tc, fport_input_waiting);
937
938 return tc;
939 }
940
941 void
942 scm_init_fports ()
943 {
944 scm_tc16_fport = scm_make_fptob ();
945
946 scm_c_define ("_IOFBF", scm_from_int (_IOFBF));
947 scm_c_define ("_IOLBF", scm_from_int (_IOLBF));
948 scm_c_define ("_IONBF", scm_from_int (_IONBF));
949
950 sys_file_port_name_canonicalization = scm_make_fluid ();
951 scm_c_define ("%file-port-name-canonicalization",
952 sys_file_port_name_canonicalization);
953
954 #include "libguile/fports.x"
955 }
956
957 /*
958 Local Variables:
959 c-file-style: "gnu"
960 End:
961 */