add %file-port-name-canonicalization option
[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* loc_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 if (!scm_is_string (filename))
277 {
278 return filename;
279 }
280 else if (scm_is_eq (*loc_file_port_name_canonicalization, sym_relative))
281 {
282 char *str, *canon;
283 SCM scanon, load_path;
284
285 str = scm_to_locale_string (filename);
286 canon = canonicalize_file_name (str);
287 free (str);
288
289 if (!canon)
290 return filename;
291
292 scanon = scm_take_locale_string (canon);
293
294 for (load_path = scm_variable_ref
295 (scm_c_module_lookup (scm_the_root_module (), "%load-path"));
296 scm_is_pair (load_path);
297 load_path = scm_cdr (load_path))
298 if (scm_is_true (scm_string_prefix_p (scm_car (load_path),
299 scanon,
300 SCM_UNDEFINED, SCM_UNDEFINED,
301 SCM_UNDEFINED, SCM_UNDEFINED)))
302 return scm_substring (scanon,
303 scm_string_length (scm_car (load_path)),
304 SCM_UNDEFINED);
305 return filename;
306 }
307 else if (scm_is_eq (*loc_file_port_name_canonicalization, sym_absolute))
308 {
309 char *str, *canon;
310
311 str = scm_to_locale_string (filename);
312 canon = canonicalize_file_name (str);
313 free (str);
314
315 return canon ? scm_take_locale_string (canon) : filename;
316 }
317 else
318 {
319 return filename;
320 }
321 }
322
323
324 /* scm_open_file
325 * Return a new port open on a given file.
326 *
327 * The mode string must match the pattern: [rwa+]** which
328 * is interpreted in the usual unix way.
329 *
330 * Return the new port.
331 */
332 SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
333 (SCM filename, SCM mode),
334 "Open the file whose name is @var{filename}, and return a port\n"
335 "representing that file. The attributes of the port are\n"
336 "determined by the @var{mode} string. The way in which this is\n"
337 "interpreted is similar to C stdio. The first character must be\n"
338 "one of the following:\n"
339 "@table @samp\n"
340 "@item r\n"
341 "Open an existing file for input.\n"
342 "@item w\n"
343 "Open a file for output, creating it if it doesn't already exist\n"
344 "or removing its contents if it does.\n"
345 "@item a\n"
346 "Open a file for output, creating it if it doesn't already\n"
347 "exist. All writes to the port will go to the end of the file.\n"
348 "The \"append mode\" can be turned off while the port is in use\n"
349 "@pxref{Ports and File Descriptors, fcntl}\n"
350 "@end table\n"
351 "The following additional characters can be appended:\n"
352 "@table @samp\n"
353 "@item b\n"
354 "Open the underlying file in binary mode, if supported by the operating system. "
355 "@item +\n"
356 "Open the port for both input and output. E.g., @code{r+}: open\n"
357 "an existing file for both input and output.\n"
358 "@item 0\n"
359 "Create an \"unbuffered\" port. In this case input and output\n"
360 "operations are passed directly to the underlying port\n"
361 "implementation without additional buffering. This is likely to\n"
362 "slow down I/O operations. The buffering mode can be changed\n"
363 "while a port is in use @pxref{Ports and File Descriptors,\n"
364 "setvbuf}\n"
365 "@item l\n"
366 "Add line-buffering to the port. The port output buffer will be\n"
367 "automatically flushed whenever a newline character is written.\n"
368 "@end table\n"
369 "In theory we could create read/write ports which were buffered\n"
370 "in one direction only. However this isn't included in the\n"
371 "current interfaces. If a file cannot be opened with the access\n"
372 "requested, @code{open-file} throws an exception.")
373 #define FUNC_NAME s_scm_open_file
374 {
375 SCM port;
376 int fdes, flags = 0;
377 unsigned int retries;
378 char *file, *md, *ptr;
379
380 scm_dynwind_begin (0);
381
382 file = scm_to_locale_string (filename);
383 scm_dynwind_free (file);
384
385 md = scm_to_locale_string (mode);
386 scm_dynwind_free (md);
387
388 switch (*md)
389 {
390 case 'r':
391 flags |= O_RDONLY;
392 break;
393 case 'w':
394 flags |= O_WRONLY | O_CREAT | O_TRUNC;
395 break;
396 case 'a':
397 flags |= O_WRONLY | O_CREAT | O_APPEND;
398 break;
399 default:
400 scm_out_of_range (FUNC_NAME, mode);
401 }
402 ptr = md + 1;
403 while (*ptr != '\0')
404 {
405 switch (*ptr)
406 {
407 case '+':
408 flags = (flags & ~(O_RDONLY | O_WRONLY)) | O_RDWR;
409 break;
410 case 'b':
411 #if defined (O_BINARY)
412 flags |= O_BINARY;
413 #endif
414 break;
415 case '0': /* unbuffered: handled later. */
416 case 'l': /* line buffered: handled during output. */
417 break;
418 default:
419 scm_out_of_range (FUNC_NAME, mode);
420 }
421 ptr++;
422 }
423
424 for (retries = 0, fdes = -1;
425 fdes < 0 && retries < 2;
426 retries++)
427 {
428 SCM_SYSCALL (fdes = open_or_open64 (file, flags, 0666));
429 if (fdes == -1)
430 {
431 int en = errno;
432
433 if (en == EMFILE && retries == 0)
434 /* Run the GC in case it collects open file ports that are no
435 longer referenced. */
436 scm_i_gc (FUNC_NAME);
437 else
438 SCM_SYSERROR_MSG ("~A: ~S",
439 scm_cons (scm_strerror (scm_from_int (en)),
440 scm_cons (filename, SCM_EOL)), en);
441 }
442 }
443
444 port = scm_i_fdes_to_port (fdes, scm_i_mode_bits (mode),
445 fport_canonicalize_filename (filename));
446
447 scm_dynwind_end ();
448
449 return port;
450 }
451 #undef FUNC_NAME
452
453 \f
454 #ifdef __MINGW32__
455 /*
456 * Try getting the appropiate file flags for a given file descriptor
457 * under Windows. This incorporates some fancy operations because Windows
458 * differentiates between file, pipe and socket descriptors.
459 */
460 #ifndef O_ACCMODE
461 # define O_ACCMODE 0x0003
462 #endif
463
464 static int getflags (int fdes)
465 {
466 int flags = 0;
467 struct stat buf;
468 int error, optlen = sizeof (int);
469
470 /* Is this a socket ? */
471 if (getsockopt (fdes, SOL_SOCKET, SO_ERROR, (void *) &error, &optlen) >= 0)
472 flags = O_RDWR;
473 /* Maybe a regular file ? */
474 else if (fstat (fdes, &buf) < 0)
475 flags = -1;
476 else
477 {
478 /* Or an anonymous pipe handle ? */
479 if (buf.st_mode & _S_IFIFO)
480 flags = PeekNamedPipe ((HANDLE) _get_osfhandle (fdes), NULL, 0,
481 NULL, NULL, NULL) ? O_RDONLY : O_WRONLY;
482 /* stdin ? */
483 else if (fdes == fileno (stdin) && isatty (fdes))
484 flags = O_RDONLY;
485 /* stdout / stderr ? */
486 else if ((fdes == fileno (stdout) || fdes == fileno (stderr)) &&
487 isatty (fdes))
488 flags = O_WRONLY;
489 else
490 flags = buf.st_mode;
491 }
492 return flags;
493 }
494 #endif /* __MINGW32__ */
495
496 /* Building Guile ports from a file descriptor. */
497
498 /* Build a Scheme port from an open file descriptor `fdes'.
499 MODE indicates whether FILE is open for reading or writing; it uses
500 the same notation as open-file's second argument.
501 NAME is a string to be used as the port's filename.
502 */
503 SCM
504 scm_i_fdes_to_port (int fdes, long mode_bits, SCM name)
505 #define FUNC_NAME "scm_fdes_to_port"
506 {
507 SCM port;
508 scm_t_port *pt;
509 int flags;
510
511 /* test that fdes is valid. */
512 #ifdef __MINGW32__
513 flags = getflags (fdes);
514 #else
515 flags = fcntl (fdes, F_GETFL, 0);
516 #endif
517 if (flags == -1)
518 SCM_SYSERROR;
519 flags &= O_ACCMODE;
520 if (flags != O_RDWR
521 && ((flags != O_WRONLY && (mode_bits & SCM_WRTNG))
522 || (flags != O_RDONLY && (mode_bits & SCM_RDNG))))
523 {
524 SCM_MISC_ERROR ("requested file mode not available on fdes", SCM_EOL);
525 }
526
527 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex);
528
529 port = scm_new_port_table_entry (scm_tc16_fport);
530 SCM_SET_CELL_TYPE(port, scm_tc16_fport | mode_bits);
531 pt = SCM_PTAB_ENTRY(port);
532 {
533 scm_t_fport *fp
534 = (scm_t_fport *) scm_gc_malloc_pointerless (sizeof (scm_t_fport),
535 "file port");
536
537 fp->fdes = fdes;
538 pt->rw_random = SCM_FDES_RANDOM_P (fdes);
539 SCM_SETSTREAM (port, fp);
540 if (mode_bits & SCM_BUF0)
541 scm_fport_buffer_add (port, 0, 0);
542 else
543 scm_fport_buffer_add (port, -1, -1);
544 }
545 SCM_SET_FILENAME (port, name);
546 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex);
547 return port;
548 }
549 #undef FUNC_NAME
550
551 SCM
552 scm_fdes_to_port (int fdes, char *mode, SCM name)
553 {
554 return scm_i_fdes_to_port (fdes, scm_mode_bits (mode), name);
555 }
556
557 /* Return a lower bound on the number of bytes available for input. */
558 static int
559 fport_input_waiting (SCM port)
560 {
561 #ifdef HAVE_SELECT
562 int fdes = SCM_FSTREAM (port)->fdes;
563 struct timeval timeout;
564 SELECT_TYPE read_set;
565 SELECT_TYPE write_set;
566 SELECT_TYPE except_set;
567
568 FD_ZERO (&read_set);
569 FD_ZERO (&write_set);
570 FD_ZERO (&except_set);
571
572 FD_SET (fdes, &read_set);
573
574 timeout.tv_sec = 0;
575 timeout.tv_usec = 0;
576
577 if (select (SELECT_SET_SIZE,
578 &read_set, &write_set, &except_set, &timeout)
579 < 0)
580 scm_syserror ("fport_input_waiting");
581 return FD_ISSET (fdes, &read_set) ? 1 : 0;
582
583 #elif HAVE_IOCTL && defined (FIONREAD)
584 /* Note: cannot test just defined(FIONREAD) here, since mingw has FIONREAD
585 (for use with winsock ioctlsocket()) but not ioctl(). */
586 int fdes = SCM_FSTREAM (port)->fdes;
587 int remir;
588 ioctl(fdes, FIONREAD, &remir);
589 return remir;
590
591 #else
592 scm_misc_error ("fport_input_waiting",
593 "Not fully implemented on this platform",
594 SCM_EOL);
595 #endif
596 }
597
598 \f
599 static int
600 fport_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
601 {
602 scm_puts ("#<", port);
603 scm_print_port_mode (exp, port);
604 if (SCM_OPFPORTP (exp))
605 {
606 int fdes;
607 SCM name = SCM_FILENAME (exp);
608 if (scm_is_string (name) || scm_is_symbol (name))
609 scm_display (name, port);
610 else
611 scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp)), port);
612 scm_putc (' ', port);
613 fdes = (SCM_FSTREAM (exp))->fdes;
614
615 #ifdef HAVE_TTYNAME
616 if (isatty (fdes))
617 scm_display (scm_ttyname (exp), port);
618 else
619 #endif /* HAVE_TTYNAME */
620 scm_intprint (fdes, 10, port);
621 }
622 else
623 {
624 scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp)), port);
625 scm_putc (' ', port);
626 scm_uintprint ((scm_t_bits) SCM_PTAB_ENTRY (exp), 16, port);
627 }
628 scm_putc ('>', port);
629 return 1;
630 }
631
632 #ifndef __MINGW32__
633 /* thread-local block for input on fport's fdes. */
634 static void
635 fport_wait_for_input (SCM port)
636 {
637 int fdes = SCM_FSTREAM (port)->fdes;
638
639 if (!fport_input_waiting (port))
640 {
641 int n;
642 SELECT_TYPE readfds;
643 int flags = fcntl (fdes, F_GETFL);
644
645 if (flags == -1)
646 scm_syserror ("scm_fdes_wait_for_input");
647 if (!(flags & O_NONBLOCK))
648 do
649 {
650 FD_ZERO (&readfds);
651 FD_SET (fdes, &readfds);
652 n = scm_std_select (fdes + 1, &readfds, NULL, NULL, NULL);
653 }
654 while (n == -1 && errno == EINTR);
655 }
656 }
657 #endif /* !__MINGW32__ */
658
659 static void fport_flush (SCM port);
660
661 /* fill a port's read-buffer with a single read. returns the first
662 char or EOF if end of file. */
663 static scm_t_wchar
664 fport_fill_input (SCM port)
665 {
666 long count;
667 scm_t_port *pt = SCM_PTAB_ENTRY (port);
668 scm_t_fport *fp = SCM_FSTREAM (port);
669
670 #ifndef __MINGW32__
671 fport_wait_for_input (port);
672 #endif /* !__MINGW32__ */
673 SCM_SYSCALL (count = read (fp->fdes, pt->read_buf, pt->read_buf_size));
674 if (count == -1)
675 scm_syserror ("fport_fill_input");
676 if (count == 0)
677 return (scm_t_wchar) EOF;
678 else
679 {
680 pt->read_pos = pt->read_buf;
681 pt->read_end = pt->read_buf + count;
682 return *pt->read_buf;
683 }
684 }
685
686 static scm_t_off
687 fport_seek (SCM port, scm_t_off offset, int whence)
688 {
689 scm_t_port *pt = SCM_PTAB_ENTRY (port);
690 scm_t_fport *fp = SCM_FSTREAM (port);
691 off_t_or_off64_t rv;
692 off_t_or_off64_t result;
693
694 if (pt->rw_active == SCM_PORT_WRITE)
695 {
696 if (offset != 0 || whence != SEEK_CUR)
697 {
698 fport_flush (port);
699 result = rv = lseek_or_lseek64 (fp->fdes, offset, whence);
700 }
701 else
702 {
703 /* read current position without disturbing the buffer. */
704 rv = lseek_or_lseek64 (fp->fdes, offset, whence);
705 result = rv + (pt->write_pos - pt->write_buf);
706 }
707 }
708 else if (pt->rw_active == SCM_PORT_READ)
709 {
710 if (offset != 0 || whence != SEEK_CUR)
711 {
712 /* could expand to avoid a second seek. */
713 scm_end_input (port);
714 result = rv = lseek_or_lseek64 (fp->fdes, offset, whence);
715 }
716 else
717 {
718 /* read current position without disturbing the buffer
719 (particularly the unread-char buffer). */
720 rv = lseek_or_lseek64 (fp->fdes, offset, whence);
721 result = rv - (pt->read_end - pt->read_pos);
722
723 if (pt->read_buf == pt->putback_buf)
724 result -= pt->saved_read_end - pt->saved_read_pos;
725 }
726 }
727 else /* SCM_PORT_NEITHER */
728 {
729 result = rv = lseek_or_lseek64 (fp->fdes, offset, whence);
730 }
731
732 if (rv == -1)
733 scm_syserror ("fport_seek");
734
735 return result;
736 }
737
738 static void
739 fport_truncate (SCM port, scm_t_off length)
740 {
741 scm_t_fport *fp = SCM_FSTREAM (port);
742
743 if (ftruncate (fp->fdes, length) == -1)
744 scm_syserror ("ftruncate");
745 }
746
747 static void
748 fport_write (SCM port, const void *data, size_t size)
749 #define FUNC_NAME "fport_write"
750 {
751 /* this procedure tries to minimize the number of writes/flushes. */
752 scm_t_port *pt = SCM_PTAB_ENTRY (port);
753
754 if (pt->write_buf == &pt->shortbuf
755 || (pt->write_pos == pt->write_buf && size >= pt->write_buf_size))
756 {
757 /* Unbuffered port, or port with empty buffer and data won't fit in
758 buffer. */
759 if (full_write (SCM_FPORT_FDES (port), data, size) < size)
760 SCM_SYSERROR;
761
762 return;
763 }
764
765 {
766 scm_t_off space = pt->write_end - pt->write_pos;
767
768 if (size <= space)
769 {
770 /* data fits in buffer. */
771 memcpy (pt->write_pos, data, size);
772 pt->write_pos += size;
773 if (pt->write_pos == pt->write_end)
774 {
775 fport_flush (port);
776 /* we can skip the line-buffering check if nothing's buffered. */
777 return;
778 }
779 }
780 else
781 {
782 memcpy (pt->write_pos, data, space);
783 pt->write_pos = pt->write_end;
784 fport_flush (port);
785 {
786 const void *ptr = ((const char *) data) + space;
787 size_t remaining = size - space;
788
789 if (size >= pt->write_buf_size)
790 {
791 if (full_write (SCM_FPORT_FDES (port), ptr, remaining)
792 < remaining)
793 SCM_SYSERROR;
794 return;
795 }
796 else
797 {
798 memcpy (pt->write_pos, ptr, remaining);
799 pt->write_pos += remaining;
800 }
801 }
802 }
803
804 /* handle line buffering. */
805 if ((SCM_CELL_WORD_0 (port) & SCM_BUFLINE) && memchr (data, '\n', size))
806 fport_flush (port);
807 }
808 }
809 #undef FUNC_NAME
810
811 /* becomes 1 when process is exiting: normal exception handling won't
812 work by this time. */
813 extern int scm_i_terminating;
814
815 static void
816 fport_flush (SCM port)
817 {
818 scm_t_port *pt = SCM_PTAB_ENTRY (port);
819 scm_t_fport *fp = SCM_FSTREAM (port);
820 unsigned char *ptr = pt->write_buf;
821 long init_size = pt->write_pos - pt->write_buf;
822 long remaining = init_size;
823
824 while (remaining > 0)
825 {
826 long count;
827
828 SCM_SYSCALL (count = write (fp->fdes, ptr, remaining));
829 if (count < 0)
830 {
831 /* error. assume nothing was written this call, but
832 fix up the buffer for any previous successful writes. */
833 long done = init_size - remaining;
834
835 if (done > 0)
836 {
837 int i;
838
839 for (i = 0; i < remaining; i++)
840 {
841 *(pt->write_buf + i) = *(pt->write_buf + done + i);
842 }
843 pt->write_pos = pt->write_buf + remaining;
844 }
845 if (scm_i_terminating)
846 {
847 const char *msg = "Error: could not flush file-descriptor ";
848 char buf[11];
849
850 full_write (2, msg, strlen (msg));
851 sprintf (buf, "%d\n", fp->fdes);
852 full_write (2, buf, strlen (buf));
853
854 count = remaining;
855 }
856 else if (scm_gc_running_p)
857 {
858 /* silently ignore the error. scm_error would abort if we
859 called it now. */
860 count = remaining;
861 }
862 else
863 scm_syserror ("fport_flush");
864 }
865 ptr += count;
866 remaining -= count;
867 }
868 pt->write_pos = pt->write_buf;
869 pt->rw_active = SCM_PORT_NEITHER;
870 }
871
872 /* clear the read buffer and adjust the file position for unread bytes. */
873 static void
874 fport_end_input (SCM port, int offset)
875 {
876 scm_t_fport *fp = SCM_FSTREAM (port);
877 scm_t_port *pt = SCM_PTAB_ENTRY (port);
878
879 offset += pt->read_end - pt->read_pos;
880
881 if (offset > 0)
882 {
883 pt->read_pos = pt->read_end;
884 /* will throw error if unread-char used at beginning of file
885 then attempting to write. seems correct. */
886 if (lseek (fp->fdes, -offset, SEEK_CUR) == -1)
887 scm_syserror ("fport_end_input");
888 }
889 pt->rw_active = SCM_PORT_NEITHER;
890 }
891
892 static int
893 fport_close (SCM port)
894 {
895 scm_t_fport *fp = SCM_FSTREAM (port);
896 scm_t_port *pt = SCM_PTAB_ENTRY (port);
897 int rv;
898
899 fport_flush (port);
900 SCM_SYSCALL (rv = close (fp->fdes));
901 if (rv == -1 && errno != EBADF)
902 {
903 if (scm_gc_running_p)
904 /* silently ignore the error. scm_error would abort if we
905 called it now. */
906 ;
907 else
908 scm_syserror ("fport_close");
909 }
910 if (pt->read_buf == pt->putback_buf)
911 pt->read_buf = pt->saved_read_buf;
912 if (pt->read_buf != &pt->shortbuf)
913 scm_gc_free (pt->read_buf, pt->read_buf_size, "port buffer");
914 if (pt->write_buf != &pt->shortbuf)
915 scm_gc_free (pt->write_buf, pt->write_buf_size, "port buffer");
916 scm_gc_free (fp, sizeof (*fp), "file port");
917 return rv;
918 }
919
920 static size_t
921 fport_free (SCM port)
922 {
923 fport_close (port);
924 return 0;
925 }
926
927 static scm_t_bits
928 scm_make_fptob ()
929 {
930 scm_t_bits tc = scm_make_port_type ("file", fport_fill_input, fport_write);
931
932 scm_set_port_free (tc, fport_free);
933 scm_set_port_print (tc, fport_print);
934 scm_set_port_flush (tc, fport_flush);
935 scm_set_port_end_input (tc, fport_end_input);
936 scm_set_port_close (tc, fport_close);
937 scm_set_port_seek (tc, fport_seek);
938 scm_set_port_truncate (tc, fport_truncate);
939 scm_set_port_input_waiting (tc, fport_input_waiting);
940
941 return tc;
942 }
943
944 void
945 scm_init_fports ()
946 {
947 scm_tc16_fport = scm_make_fptob ();
948
949 scm_c_define ("_IOFBF", scm_from_int (_IOFBF));
950 scm_c_define ("_IOLBF", scm_from_int (_IOLBF));
951 scm_c_define ("_IONBF", scm_from_int (_IONBF));
952
953 loc_file_port_name_canonicalization =
954 SCM_VARIABLE_LOC (scm_c_define ("%file-port-name-canonicalization",
955 SCM_BOOL_F));
956
957 #include "libguile/fports.x"
958 }
959
960 /*
961 Local Variables:
962 c-file-style: "gnu"
963 End:
964 */