1 /* Copyright (C) 1996, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
43 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
47 #include "libguile/_scm.h"
48 #include "libguile/smob.h"
49 #include "libguile/feature.h"
50 #include "libguile/fports.h"
51 #include "libguile/iselect.h"
52 #include "libguile/strings.h"
53 #include "libguile/vectors.h"
55 #include "libguile/validate.h"
56 #include "libguile/filesys.h"
63 #ifdef TIME_WITH_SYS_TIME
64 # include <sys/time.h>
68 # include <sys/time.h>
78 #ifdef LIBC_H_WITH_UNISTD_H
82 #ifdef HAVE_SYS_SELECT_H
83 #include <sys/select.h>
90 #include <sys/types.h>
99 # define NAMLEN(dirent) strlen((dirent)->d_name)
101 # define dirent direct
102 # define NAMLEN(dirent) (dirent)->d_namlen
104 # include <sys/ndir.h>
107 # include <sys/dir.h>
114 /* Ultrix has S_IFSOCK, but no S_ISSOCK. Ipe! */
115 #if defined (S_IFSOCK) && ! defined (S_ISSOCK)
116 #define S_ISSOCK(mode) (((mode) & S_IFMT) == S_IFSOCK)
126 SCM_DEFINE (scm_chown
, "chown", 3, 0, 0,
127 (SCM object
, SCM owner
, SCM group
),
128 "Change the ownership and group of the file referred to by @var{object} to\n"
129 "the integer values @var{owner} and @var{group}. @var{object} can be\n"
130 "a string containing a file name or, if the platform\n"
131 "supports fchown, a port or integer file descriptor\n"
132 "which is open on the file. The return value\n"
133 "is unspecified.\n\n"
134 "If @var{object} is a symbolic link, either the\n"
135 "ownership of the link or the ownership of the referenced file will be\n"
136 "changed depending on the operating system (lchown is\n"
137 "unsupported at present). If @var{owner} or @var{group} is specified\n"
138 "as @code{-1}, then that ID is not changed.")
139 #define FUNC_NAME s_scm_chown
143 object
= SCM_COERCE_OUTPORT (object
);
145 SCM_VALIDATE_INUM (2,owner
);
146 SCM_VALIDATE_INUM (3,group
);
148 if (SCM_INUMP (object
) || (SCM_OPFPORTP (object
)))
150 int fdes
= SCM_INUMP (object
) ? SCM_INUM (object
)
151 : SCM_FPORT_FDES (object
);
153 SCM_SYSCALL (rv
= fchown (fdes
, SCM_INUM (owner
), SCM_INUM (group
)));
158 SCM_VALIDATE_STRING (1, object
);
159 SCM_STRING_COERCE_0TERMINATION_X (object
);
160 SCM_SYSCALL (rv
= chown (SCM_STRING_CHARS (object
),
161 SCM_INUM (owner
), SCM_INUM (group
)));
165 return SCM_UNSPECIFIED
;
170 SCM_DEFINE (scm_chmod
, "chmod", 2, 0, 0,
171 (SCM object
, SCM mode
),
172 "Changes the permissions of the file referred to by @var{obj}.\n"
173 "@var{obj} can be a string containing a file name or a port or integer file\n"
174 "descriptor which is open on a file (in which case @code{fchmod} is used\n"
175 "as the underlying system call).\n"
176 "@var{mode} specifies\n"
177 "the new permissions as a decimal number, e.g., @code{(chmod \"foo\" #o755)}.\n"
178 "The return value is unspecified.")
179 #define FUNC_NAME s_scm_chmod
184 object
= SCM_COERCE_OUTPORT (object
);
186 SCM_VALIDATE_INUM (2,mode
);
187 if (SCM_INUMP (object
) || SCM_OPFPORTP (object
))
189 if (SCM_INUMP (object
))
190 fdes
= SCM_INUM (object
);
192 fdes
= SCM_FPORT_FDES (object
);
193 SCM_SYSCALL (rv
= fchmod (fdes
, SCM_INUM (mode
)));
197 SCM_VALIDATE_STRING (1, object
);
198 SCM_STRING_COERCE_0TERMINATION_X (object
);
199 SCM_SYSCALL (rv
= chmod (SCM_STRING_CHARS (object
), SCM_INUM (mode
)));
203 return SCM_UNSPECIFIED
;
207 SCM_DEFINE (scm_umask
, "umask", 0, 1, 0,
209 "If @var{mode} is omitted, retuns a decimal number representing the current\n"
210 "file creation mask. Otherwise the file creation mask is set to\n"
211 "@var{mode} and the previous value is returned.\n\n"
212 "E.g., @code{(umask #o022)} sets the mask to octal 22, decimal 18.")
213 #define FUNC_NAME s_scm_umask
216 if (SCM_UNBNDP (mode
))
223 SCM_VALIDATE_INUM (1,mode
);
224 mask
= umask (SCM_INUM (mode
));
226 return SCM_MAKINUM (mask
);
232 SCM_DEFINE (scm_open_fdes
, "open-fdes", 2, 1, 0,
233 (SCM path
, SCM flags
, SCM mode
),
234 "Similar to @code{open} but returns a file descriptor instead of a\n"
236 #define FUNC_NAME s_scm_open_fdes
242 SCM_VALIDATE_STRING (1, path
);
243 SCM_STRING_COERCE_0TERMINATION_X (path
);
244 iflags
= SCM_NUM2LONG(2,flags
);
245 imode
= SCM_NUM2LONG_DEF(3,mode
,0666);
246 SCM_SYSCALL (fd
= open (SCM_STRING_CHARS (path
), iflags
, imode
));
249 return SCM_MAKINUM (fd
);
253 SCM_DEFINE (scm_open
, "open", 2, 1, 0,
254 (SCM path
, SCM flags
, SCM mode
),
255 "Open the file named by @var{path} for reading and/or writing.\n"
256 "@var{flags} is an integer specifying how the file should be opened.\n"
257 "@var{mode} is an integer specifying the permission bits of the file, if\n"
258 "it needs to be created, before the umask is applied. The default is 666\n"
259 "(Unix itself has no default).\n\n"
260 "@var{flags} can be constructed by combining variables using @code{logior}.\n"
261 "Basic flags are:\n\n"
263 "Open the file read-only.\n"
266 "Open the file write-only. \n"
269 "Open the file read/write.\n"
272 "Append to the file instead of truncating.\n"
275 "Create the file if it does not already exist.\n"
277 "See the Unix documentation of the @code{open} system call\n"
278 "for additional flags.")
279 #define FUNC_NAME s_scm_open
286 fd
= SCM_INUM (scm_open_fdes (path
, flags
, mode
));
287 iflags
= SCM_NUM2LONG (2,flags
);
290 if (iflags
& O_APPEND
)
292 else if (iflags
& O_CREAT
)
298 if (iflags
& O_APPEND
)
300 else if (iflags
& O_WRONLY
)
305 newpt
= scm_fdes_to_port (fd
, port_mode
, path
);
310 SCM_DEFINE (scm_close
, "close", 1, 0, 0,
312 "Similar to close-port (@pxref{Generic Port Operations, close-port}),\n"
313 "but also works on file descriptors. A side\n"
314 "effect of closing a file descriptor is that any ports using that file\n"
315 "descriptor are moved to a different file descriptor and have\n"
316 "their revealed counts set to zero.")
317 #define FUNC_NAME s_scm_close
322 fd_or_port
= SCM_COERCE_OUTPORT (fd_or_port
);
324 if (SCM_PORTP (fd_or_port
))
325 return scm_close_port (fd_or_port
);
326 SCM_VALIDATE_INUM (1,fd_or_port
);
327 fd
= SCM_INUM (fd_or_port
);
328 scm_evict_ports (fd
); /* see scsh manual. */
329 SCM_SYSCALL (rv
= close (fd
));
330 /* following scsh, closing an already closed file descriptor is
332 if (rv
< 0 && errno
!= EBADF
)
334 return SCM_NEGATE_BOOL(rv
< 0);
338 SCM_DEFINE (scm_close_fdes
, "close-fdes", 1, 0, 0,
340 "A simple wrapper for the @code{close} system call.\n"
341 "Close file descriptor @var{fd}, which must be an integer.\n"
342 "Unlike close (@pxref{Ports and File Descriptors, close}),\n"
343 "the file descriptor will be closed even if a port is using it.\n"
344 "The return value is unspecified.")
345 #define FUNC_NAME s_scm_close_fdes
350 SCM_VALIDATE_INUM_COPY (1, fd
, c_fd
);
351 SCM_SYSCALL (rv
= close (c_fd
));
354 return SCM_UNSPECIFIED
;
362 SCM_SYMBOL (scm_sym_regular
, "regular");
363 SCM_SYMBOL (scm_sym_directory
, "directory");
365 SCM_SYMBOL (scm_sym_symlink
, "symlink");
367 SCM_SYMBOL (scm_sym_block_special
, "block-special");
368 SCM_SYMBOL (scm_sym_char_special
, "char-special");
369 SCM_SYMBOL (scm_sym_fifo
, "fifo");
370 SCM_SYMBOL (scm_sym_sock
, "socket");
371 SCM_SYMBOL (scm_sym_unknown
, "unknown");
374 scm_stat2scm (struct stat
*stat_temp
)
376 SCM ans
= scm_make_vector (SCM_MAKINUM (15), SCM_UNSPECIFIED
);
377 SCM
*ve
= SCM_VELTS (ans
);
379 ve
[0] = scm_ulong2num ((unsigned long) stat_temp
->st_dev
);
380 ve
[1] = scm_ulong2num ((unsigned long) stat_temp
->st_ino
);
381 ve
[2] = scm_ulong2num ((unsigned long) stat_temp
->st_mode
);
382 ve
[3] = scm_ulong2num ((unsigned long) stat_temp
->st_nlink
);
383 ve
[4] = scm_ulong2num ((unsigned long) stat_temp
->st_uid
);
384 ve
[5] = scm_ulong2num ((unsigned long) stat_temp
->st_gid
);
386 ve
[6] = scm_ulong2num ((unsigned long) stat_temp
->st_rdev
);
390 ve
[7] = scm_ulong2num ((unsigned long) stat_temp
->st_size
);
391 ve
[8] = scm_ulong2num ((unsigned long) stat_temp
->st_atime
);
392 ve
[9] = scm_ulong2num ((unsigned long) stat_temp
->st_mtime
);
393 ve
[10] = scm_ulong2num ((unsigned long) stat_temp
->st_ctime
);
394 #ifdef HAVE_ST_BLKSIZE
395 ve
[11] = scm_ulong2num ((unsigned long) stat_temp
->st_blksize
);
397 ve
[11] = scm_ulong2num (4096L);
399 #ifdef HAVE_ST_BLOCKS
400 ve
[12] = scm_ulong2num ((unsigned long) stat_temp
->st_blocks
);
405 int mode
= stat_temp
->st_mode
;
408 ve
[13] = scm_sym_regular
;
409 else if (S_ISDIR (mode
))
410 ve
[13] = scm_sym_directory
;
412 else if (S_ISLNK (mode
))
413 ve
[13] = scm_sym_symlink
;
415 else if (S_ISBLK (mode
))
416 ve
[13] = scm_sym_block_special
;
417 else if (S_ISCHR (mode
))
418 ve
[13] = scm_sym_char_special
;
419 else if (S_ISFIFO (mode
))
420 ve
[13] = scm_sym_fifo
;
422 else if (S_ISSOCK (mode
))
423 ve
[13] = scm_sym_sock
;
426 ve
[13] = scm_sym_unknown
;
428 ve
[14] = SCM_MAKINUM ((~S_IFMT
) & mode
);
430 /* the layout of the bits in ve[14] is intended to be portable.
431 If there are systems that don't follow the usual convention,
432 the following could be used:
435 if (S_ISUID & mode) tmp += 1;
437 if (S_IRGRP & mode) tmp += 1;
439 if (S_ISVTX & mode) tmp += 1;
441 if (S_IRUSR & mode) tmp += 1;
443 if (S_IWUSR & mode) tmp += 1;
445 if (S_IXUSR & mode) tmp += 1;
447 if (S_IWGRP & mode) tmp += 1;
449 if (S_IXGRP & mode) tmp += 1;
451 if (S_IROTH & mode) tmp += 1;
453 if (S_IWOTH & mode) tmp += 1;
455 if (S_IXOTH & mode) tmp += 1;
457 ve[14] = SCM_MAKINUM (tmp);
465 SCM_DEFINE (scm_stat
, "stat", 1, 0, 0,
467 "Returns an object containing various information\n"
468 "about the file determined by @var{obj}.\n"
469 "@var{obj} can be a string containing a file name or a port or integer file\n"
470 "descriptor which is open on a file (in which case @code{fstat} is used\n"
471 "as the underlying system call).\n\n"
472 "The object returned by @code{stat} can be passed as a single parameter\n"
473 "to the following procedures, all of which return integers:\n\n"
476 "The device containing the file.\n"
478 "The file serial number, which distinguishes this file from all other\n"
479 "files on the same device.\n"
481 "The mode of the file. This includes file type information\n"
482 "and the file permission bits. See @code{stat:type} and @code{stat:perms}\n"
485 "The number of hard links to the file.\n"
487 "The user ID of the file's owner.\n"
489 "The group ID of the file.\n"
491 "Device ID; this entry is defined only for character or block\n"
494 "The size of a regular file in bytes.\n"
496 "The last access time for the file.\n"
498 "The last modification time for the file.\n"
500 "The last modification time for the attributes of the file.\n"
501 "@item stat:blksize\n"
502 "The optimal block size for reading or writing the file, in bytes.\n"
503 "@item stat:blocks\n"
504 "The amount of disk space that the file occupies measured in units of\n"
507 "In addition, the following procedures return the information\n"
508 "from stat:mode in a more convenient form:\n\n"
511 "A symbol representing the type of file. Possible values are\n"
512 "regular, directory, symlink, block-special, char-special,\n"
513 "fifo, socket and unknown\n"
515 "An integer representing the access permission bits.\n"
517 #define FUNC_NAME s_scm_stat
521 struct stat stat_temp
;
523 if (SCM_INUMP (object
))
524 SCM_SYSCALL (rv
= fstat (SCM_INUM (object
), &stat_temp
));
527 SCM_VALIDATE_NIM (1,object
);
528 if (SCM_STRINGP (object
))
530 SCM_STRING_COERCE_0TERMINATION_X (object
);
531 SCM_SYSCALL (rv
= stat (SCM_STRING_CHARS (object
), &stat_temp
));
535 object
= SCM_COERCE_OUTPORT (object
);
536 SCM_VALIDATE_OPFPORT(1,object
);
537 fdes
= SCM_FPORT_FDES (object
);
538 SCM_SYSCALL (rv
= fstat (fdes
, &stat_temp
));
545 SCM_SYSERROR_MSG ("~A: ~S",
546 scm_listify (scm_makfrom0str (strerror (errno
)),
550 return scm_stat2scm (&stat_temp
);
555 /* {Modifying Directories}
558 SCM_DEFINE (scm_link
, "link", 2, 0, 0,
559 (SCM oldpath
, SCM newpath
),
560 "Creates a new name @var{path-to} in the file system for the file\n"
561 "named by @var{path-from}. If @var{path-from} is a symbolic link, the\n"
562 "link may or may not be followed depending on the system.")
563 #define FUNC_NAME s_scm_link
567 SCM_VALIDATE_STRING (1, oldpath
);
568 SCM_STRING_COERCE_0TERMINATION_X (oldpath
);
569 SCM_VALIDATE_STRING (2, newpath
);
570 SCM_STRING_COERCE_0TERMINATION_X (newpath
);
571 SCM_SYSCALL (val
= link (SCM_STRING_CHARS (oldpath
), SCM_STRING_CHARS (newpath
)));
574 return SCM_UNSPECIFIED
;
580 SCM_DEFINE (scm_rename
, "rename-file", 2, 0, 0,
581 (SCM oldname
, SCM newname
),
582 "Renames the file specified by @var{path-from} to @var{path-to}.\n"
583 "The return value is unspecified.")
584 #define FUNC_NAME s_scm_rename
587 SCM_VALIDATE_STRING (1, oldname
);
588 SCM_VALIDATE_STRING (2, newname
);
589 SCM_STRING_COERCE_0TERMINATION_X (oldname
);
590 SCM_STRING_COERCE_0TERMINATION_X (newname
);
592 SCM_SYSCALL (rv
= rename (SCM_STRING_CHARS (oldname
), SCM_STRING_CHARS (newname
)));
594 SCM_SYSCALL (rv
= link (SCM_STRING_CHARS (oldname
), SCM_STRING_CHARS (newname
)));
597 SCM_SYSCALL (rv
= unlink (SCM_STRING_CHARS (oldname
)));;
599 /* unlink failed. remove new name */
600 SCM_SYSCALL (unlink (SCM_STRING_CHARS (newname
)));
605 return SCM_UNSPECIFIED
;
610 SCM_DEFINE (scm_delete_file
, "delete-file", 1, 0, 0,
612 "Deletes (or \"unlinks\") the file specified by @var{path}.")
613 #define FUNC_NAME s_scm_delete_file
616 SCM_VALIDATE_STRING (1, str
);
617 SCM_STRING_COERCE_0TERMINATION_X (str
);
618 SCM_SYSCALL (ans
= unlink (SCM_STRING_CHARS (str
)));
621 return SCM_UNSPECIFIED
;
626 SCM_DEFINE (scm_mkdir
, "mkdir", 1, 1, 0,
627 (SCM path
, SCM mode
),
628 "Create a new directory named by @var{path}. If @var{mode} is omitted\n"
629 "then the permissions of the directory file are set using the current\n"
630 "umask. Otherwise they are set to the decimal value specified with\n"
631 "@var{mode}. The return value is unspecified.")
632 #define FUNC_NAME s_scm_mkdir
636 SCM_VALIDATE_STRING (1, path
);
637 SCM_STRING_COERCE_0TERMINATION_X (path
);
638 if (SCM_UNBNDP (mode
))
642 SCM_SYSCALL (rv
= mkdir (SCM_STRING_CHARS (path
), 0777 ^ mask
));
646 SCM_VALIDATE_INUM (2,mode
);
647 SCM_SYSCALL (rv
= mkdir (SCM_STRING_CHARS (path
), SCM_INUM (mode
)));
651 return SCM_UNSPECIFIED
;
654 #endif /* HAVE_MKDIR */
657 SCM_DEFINE (scm_rmdir
, "rmdir", 1, 0, 0,
659 "Remove the existing directory named by @var{path}. The directory must\n"
660 "be empty for this to succeed. The return value is unspecified.")
661 #define FUNC_NAME s_scm_rmdir
665 SCM_VALIDATE_STRING (1, path
);
666 SCM_STRING_COERCE_0TERMINATION_X (path
);
667 SCM_SYSCALL (val
= rmdir (SCM_STRING_CHARS (path
)));
670 return SCM_UNSPECIFIED
;
676 /* {Examining Directories}
679 scm_bits_t scm_tc16_dir
;
681 SCM_DEFINE (scm_directory_stream_p
, "directory-stream?", 1, 0, 0,
683 "Returns a boolean indicating whether @var{object} is a directory stream\n"
684 "as returned by @code{opendir}.")
685 #define FUNC_NAME s_scm_directory_stream_p
687 return SCM_BOOL(SCM_DIRP (obj
));
691 SCM_DEFINE (scm_opendir
, "opendir", 1, 0, 0,
693 "Open the directory specified by @var{path} and return a directory\n"
695 #define FUNC_NAME s_scm_opendir
698 SCM_VALIDATE_STRING (1, dirname
);
699 SCM_STRING_COERCE_0TERMINATION_X (dirname
);
700 SCM_SYSCALL (ds
= opendir (SCM_STRING_CHARS (dirname
)));
703 SCM_RETURN_NEWSMOB (scm_tc16_dir
| SCM_OPN
, ds
);
708 SCM_DEFINE (scm_readdir
, "readdir", 1, 0, 0,
710 "Return (as a string) the next directory entry from the directory stream\n"
711 "@var{stream}. If there is no remaining entry to be read then the\n"
712 "end of file object is returned.")
713 #define FUNC_NAME s_scm_readdir
715 struct dirent
*rdent
;
716 SCM_VALIDATE_OPDIR (1,port
);
718 SCM_SYSCALL (rdent
= readdir ((DIR *) SCM_CELL_WORD_1 (port
)));
721 return (rdent
? scm_makfromstr (rdent
->d_name
, NAMLEN (rdent
), 0)
728 SCM_DEFINE (scm_rewinddir
, "rewinddir", 1, 0, 0,
730 "Reset the directory port @var{stream} so that the next call to\n"
731 "@code{readdir} will return the first directory entry.")
732 #define FUNC_NAME s_scm_rewinddir
734 SCM_VALIDATE_OPDIR (1,port
);
735 rewinddir ((DIR *) SCM_CELL_WORD_1 (port
));
736 return SCM_UNSPECIFIED
;
742 SCM_DEFINE (scm_closedir
, "closedir", 1, 0, 0,
744 "Close the directory stream @var{stream}.\n"
745 "The return value is unspecified.")
746 #define FUNC_NAME s_scm_closedir
750 SCM_VALIDATE_DIR (1,port
);
751 if (SCM_CLOSEDP (port
))
753 return SCM_UNSPECIFIED
;
755 SCM_SYSCALL (sts
= closedir ((DIR *) SCM_CELL_WORD_1 (port
)));
758 SCM_SET_CELL_WORD_0 (port
, scm_tc16_dir
);
759 return SCM_UNSPECIFIED
;
767 scm_dir_print (SCM exp
, SCM port
, scm_print_state
*pstate
)
769 scm_puts ("#<", port
);
770 if (SCM_CLOSEDP (exp
))
771 scm_puts ("closed: ", port
);
772 scm_puts ("directory stream ", port
);
773 scm_intprint (SCM_CELL_WORD_1 (exp
), 16, port
);
774 scm_putc ('>', port
);
783 closedir ((DIR *) SCM_CELL_WORD_1 (p
));
788 /* {Navigating Directories}
792 SCM_DEFINE (scm_chdir
, "chdir", 1, 0, 0,
794 "Change the current working directory to @var{path}.\n"
795 "The return value is unspecified.")
796 #define FUNC_NAME s_scm_chdir
800 SCM_VALIDATE_STRING (1, str
);
801 SCM_STRING_COERCE_0TERMINATION_X (str
);
802 SCM_SYSCALL (ans
= chdir (SCM_STRING_CHARS (str
)));
805 return SCM_UNSPECIFIED
;
810 SCM_DEFINE (scm_getcwd
, "getcwd", 0, 0, 0,
812 "Returns the name of the current working directory.")
813 #define FUNC_NAME s_scm_getcwd
816 scm_sizet size
= 100;
820 wd
= scm_must_malloc (size
, FUNC_NAME
);
821 while ((rv
= getcwd (wd
, size
)) == 0 && errno
== ERANGE
)
825 wd
= scm_must_malloc (size
, FUNC_NAME
);
829 result
= scm_makfromstr (wd
, strlen (wd
), 0);
834 #endif /* HAVE_GETCWD */
840 /* check that element is a port or file descriptor. if it's a port
841 and its buffer is ready for use, add it to the ports_ready list.
842 otherwise add its file descriptor to *set. the type of list can be
843 determined from pos: SCM_ARG1 for reads, SCM_ARG2 for writes,
844 SCM_ARG3 for excepts. */
846 set_element (SELECT_TYPE
*set
, SCM
*ports_ready
, SCM element
, int pos
)
850 if (SCM_INUMP (element
))
852 fd
= SCM_INUM (element
);
858 element
= SCM_COERCE_OUTPORT (element
);
859 SCM_ASSERT (SCM_OPFPORTP (element
), element
, pos
, "select");
862 /* check whether port has buffered input. */
863 scm_port
*pt
= SCM_PTAB_ENTRY (element
);
865 if (pt
->read_pos
< pt
->read_end
)
868 else if (pos
== SCM_ARG2
)
870 /* check whether port's output buffer has room. */
871 scm_port
*pt
= SCM_PTAB_ENTRY (element
);
873 /* > 1 since writing the last byte in the buffer causes flush. */
874 if (pt
->write_end
- pt
->write_pos
> 1)
877 fd
= use_buf
? -1 : SCM_FPORT_FDES (element
);
880 *ports_ready
= scm_cons (element
, *ports_ready
);
886 /* check list_or_vec, a list or vector of ports or file descriptors,
887 adding each member to either the ports_ready list (if it's a port
888 with a usable buffer) or to *set. the kind of list_or_vec can be
889 determined from pos: SCM_ARG1 for reads, SCM_ARG2 for writes,
890 SCM_ARG3 for excepts. */
892 fill_select_type (SELECT_TYPE
*set
, SCM
*ports_ready
, SCM list_or_vec
, int pos
)
896 if (SCM_VECTORP (list_or_vec
))
898 int i
= SCM_VECTOR_LENGTH (list_or_vec
);
899 SCM
*ve
= SCM_VELTS (list_or_vec
);
903 int fd
= set_element (set
, ports_ready
, ve
[i
], pos
);
911 while (!SCM_NULLP (list_or_vec
))
913 int fd
= set_element (set
, ports_ready
, SCM_CAR (list_or_vec
), pos
);
917 list_or_vec
= SCM_CDR (list_or_vec
);
924 /* if element (a file descriptor or port) appears in *set, cons it to
925 list. return list. */
927 get_element (SELECT_TYPE
*set
, SCM element
, SCM list
)
931 if (SCM_INUMP (element
))
933 fd
= SCM_INUM (element
);
937 fd
= SCM_FPORT_FDES (SCM_COERCE_OUTPORT (element
));
939 if (FD_ISSET (fd
, set
))
940 list
= scm_cons (element
, list
);
944 /* construct component of scm_select return value.
945 set: pointer to set of file descriptors found by select to be ready
946 ports_ready: ports ready due to buffering
947 list_or_vec: original list/vector handed to scm_select.
948 the return value is a list/vector of ready ports/file descriptors.
949 works by finding the objects in list which correspond to members of
950 *set and appending them to ports_ready. result is converted to a
951 vector if list_or_vec is a vector. */
953 retrieve_select_type (SELECT_TYPE
*set
, SCM ports_ready
, SCM list_or_vec
)
955 SCM answer_list
= ports_ready
;
957 if (SCM_VECTORP (list_or_vec
))
959 int i
= SCM_VECTOR_LENGTH (list_or_vec
);
960 SCM
*ve
= SCM_VELTS (list_or_vec
);
964 answer_list
= get_element (set
, ve
[i
], answer_list
);
966 return scm_vector (answer_list
);
970 /* list_or_vec must be a list. */
971 while (!SCM_NULLP (list_or_vec
))
973 answer_list
= get_element (set
, SCM_CAR (list_or_vec
), answer_list
);
974 list_or_vec
= SCM_CDR (list_or_vec
);
980 /* Static helper functions above refer to s_scm_select directly as s_select */
981 SCM_DEFINE (scm_select
, "select", 3, 2, 0,
982 (SCM reads
, SCM writes
, SCM excepts
, SCM secs
, SCM usecs
),
983 "This procedure has a variety of uses: waiting for the ability\n"
984 "to provide input, accept output, or the existance of\n"
985 "exceptional conditions on a collection of ports or file\n"
986 "descriptors, or waiting for a timeout to occur.\n"
987 "It also returns if interrupted by a signal.\n\n"
988 "@var{reads}, @var{writes} and @var{excepts} can be lists or\n"
989 "vectors, with each member a port or a file descriptor.\n"
990 "The value returned is a list of three corresponding\n"
991 "lists or vectors containing only the members which meet the\n"
992 "specified requirement. The ability of port buffers to\n"
993 "provide input or accept output is taken into account.\n"
994 "Ordering of the input lists or vectors is not preserved.\n\n"
995 "The optional arguments @var{secs} and @var{usecs} specify the\n"
996 "timeout. Either @var{secs} can be specified alone, as\n"
997 "either an integer or a real number, or both @var{secs} and\n"
998 "@var{usecs} can be specified as integers, in which case\n"
999 "@var{usecs} is an additional timeout expressed in\n"
1000 "microseconds. If @var{secs} is omitted or is @code{#f} then\n"
1001 "select will wait for as long as it takes for one of the other\n"
1002 "conditions to be satisfied.\n\n"
1003 "The scsh version of @code{select} differs as follows:\n"
1004 "Only vectors are accepted for the first three arguments.\n"
1005 "The @var{usecs} argument is not supported.\n"
1006 "Multiple values are returned instead of a list.\n"
1007 "Duplicates in the input vectors appear only once in output.\n"
1008 "An additional @code{select!} interface is provided.\n"
1010 #define FUNC_NAME s_scm_select
1012 struct timeval timeout
;
1013 struct timeval
* time_ptr
;
1014 SELECT_TYPE read_set
;
1015 SELECT_TYPE write_set
;
1016 SELECT_TYPE except_set
;
1020 /* these lists accumulate ports which are ready due to buffering.
1021 their file descriptors don't need to be added to the select sets. */
1022 SCM read_ports_ready
= SCM_EOL
;
1023 SCM write_ports_ready
= SCM_EOL
;
1026 if (SCM_VECTORP (reads
))
1028 read_count
= SCM_VECTOR_LENGTH (reads
);
1032 read_count
= scm_ilength (reads
);
1033 SCM_ASSERT (read_count
>= 0, reads
, SCM_ARG1
, FUNC_NAME
);
1035 if (SCM_VECTORP (writes
))
1037 write_count
= SCM_VECTOR_LENGTH (writes
);
1041 write_count
= scm_ilength (writes
);
1042 SCM_ASSERT (write_count
>= 0, writes
, SCM_ARG2
, FUNC_NAME
);
1044 if (SCM_VECTORP (excepts
))
1046 except_count
= SCM_VECTOR_LENGTH (excepts
);
1050 except_count
= scm_ilength (excepts
);
1051 SCM_ASSERT (except_count
>= 0, excepts
, SCM_ARG3
, FUNC_NAME
);
1054 FD_ZERO (&read_set
);
1055 FD_ZERO (&write_set
);
1056 FD_ZERO (&except_set
);
1058 max_fd
= fill_select_type (&read_set
, &read_ports_ready
, reads
, SCM_ARG1
);
1061 int write_max
= fill_select_type (&write_set
, &write_ports_ready
,
1063 int except_max
= fill_select_type (&except_set
, NULL
,
1066 if (write_max
> max_fd
)
1068 if (except_max
> max_fd
)
1069 max_fd
= except_max
;
1072 /* if there's a port with a ready buffer, don't block, just
1073 check for ready file descriptors. */
1074 if (!SCM_NULLP (read_ports_ready
) || !SCM_NULLP (write_ports_ready
))
1077 timeout
.tv_usec
= 0;
1078 time_ptr
= &timeout
;
1080 else if (SCM_UNBNDP (secs
) || SCM_FALSEP (secs
))
1084 if (SCM_INUMP (secs
))
1086 timeout
.tv_sec
= SCM_INUM (secs
);
1087 if (SCM_UNBNDP (usecs
))
1088 timeout
.tv_usec
= 0;
1091 SCM_VALIDATE_INUM (5,usecs
);
1092 timeout
.tv_usec
= SCM_INUM (usecs
);
1097 double fl
= scm_num2dbl (secs
, FUNC_NAME
);
1099 if (!SCM_UNBNDP (usecs
))
1100 SCM_WRONG_TYPE_ARG (4, secs
);
1102 SCM_OUT_OF_RANGE (4, secs
);
1103 timeout
.tv_sec
= (long) fl
;
1104 timeout
.tv_usec
= (long) ((fl
- timeout
.tv_sec
) * 1000000);
1106 time_ptr
= &timeout
;
1110 #ifdef GUILE_ISELECT
1111 int rv
= scm_internal_select (max_fd
+ 1,
1112 &read_set
, &write_set
, &except_set
,
1115 int rv
= select (max_fd
+ 1,
1116 &read_set
, &write_set
, &except_set
, time_ptr
);
1121 return scm_listify (retrieve_select_type (&read_set
, read_ports_ready
,
1123 retrieve_select_type (&write_set
, write_ports_ready
,
1125 retrieve_select_type (&except_set
, SCM_EOL
, excepts
),
1129 #endif /* HAVE_SELECT */
1133 SCM_DEFINE (scm_fcntl
, "fcntl", 2, 1, 0,
1134 (SCM object
, SCM cmd
, SCM value
),
1135 "Apply @var{command} to the specified file descriptor or the underlying\n"
1136 "file descriptor of the specified port. @var{value} is an optional\n"
1137 "integer argument.\n\n"
1138 "Values for @var{command} are:\n\n"
1141 "Duplicate a file descriptor\n"
1143 "Get flags associated with the file descriptor.\n"
1145 "Set flags associated with the file descriptor to @var{value}.\n"
1147 "Get flags associated with the open file.\n"
1149 "Set flags associated with the open file to @var{value}\n"
1151 "Get the process ID of a socket's owner, for @code{SIGIO} signals.\n"
1153 "Set the process that owns a socket to @var{value}, for @code{SIGIO} signals.\n"
1154 "@item FD_CLOEXEC\n"
1155 "The value used to indicate the \"close on exec\" flag with @code{F_GETFL} or\n"
1158 #define FUNC_NAME s_scm_fcntl
1164 object
= SCM_COERCE_OUTPORT (object
);
1166 SCM_VALIDATE_INUM (2,cmd
);
1167 if (SCM_OPFPORTP (object
))
1168 fdes
= SCM_FPORT_FDES (object
);
1171 SCM_VALIDATE_INUM (1,object
);
1172 fdes
= SCM_INUM (object
);
1175 if (SCM_UNBNDP (value
)) {
1178 SCM_VALIDATE_INUM_COPY (SCM_ARG3
, value
, ivalue
);
1181 SCM_SYSCALL (rv
= fcntl (fdes
, SCM_INUM (cmd
), ivalue
));
1184 return SCM_MAKINUM (rv
);
1188 SCM_DEFINE (scm_fsync
, "fsync", 1, 0, 0,
1190 "Copies any unwritten data for the specified output file descriptor to disk.\n"
1191 "If @var{port/fd} is a port, its buffer is flushed before the underlying\n"
1192 "file descriptor is fsync'd.\n"
1193 "The return value is unspecified.")
1194 #define FUNC_NAME s_scm_fsync
1198 object
= SCM_COERCE_OUTPORT (object
);
1200 if (SCM_OPFPORTP (object
))
1203 fdes
= SCM_FPORT_FDES (object
);
1207 SCM_VALIDATE_INUM (1,object
);
1208 fdes
= SCM_INUM (object
);
1210 if (fsync (fdes
) == -1)
1212 return SCM_UNSPECIFIED
;
1217 SCM_DEFINE (scm_symlink
, "symlink", 2, 0, 0,
1218 (SCM oldpath
, SCM newpath
),
1219 "Create a symbolic link named @var{path-to} with the value (i.e., pointing to)\n"
1220 "@var{path-from}. The return value is unspecified.")
1221 #define FUNC_NAME s_scm_symlink
1225 SCM_VALIDATE_STRING (1, oldpath
);
1226 SCM_VALIDATE_STRING (2, newpath
);
1227 SCM_STRING_COERCE_0TERMINATION_X (oldpath
);
1228 SCM_STRING_COERCE_0TERMINATION_X (newpath
);
1229 SCM_SYSCALL (val
= symlink (SCM_STRING_CHARS (oldpath
), SCM_STRING_CHARS (newpath
)));
1232 return SCM_UNSPECIFIED
;
1235 #endif /* HAVE_SYMLINK */
1237 #ifdef HAVE_READLINK
1238 SCM_DEFINE (scm_readlink
, "readlink", 1, 0, 0,
1240 "Returns the value of the symbolic link named by\n"
1241 "@var{path} (a string), i.e., the\n"
1242 "file that the link points to.")
1243 #define FUNC_NAME s_scm_readlink
1249 SCM_VALIDATE_STRING (1, path
);
1250 SCM_STRING_COERCE_0TERMINATION_X (path
);
1251 buf
= scm_must_malloc (size
, FUNC_NAME
);
1252 while ((rv
= readlink (SCM_STRING_CHARS (path
), buf
, size
)) == size
)
1254 scm_must_free (buf
);
1256 buf
= scm_must_malloc (size
, FUNC_NAME
);
1260 result
= scm_makfromstr (buf
, rv
, 0);
1261 scm_must_free (buf
);
1265 #endif /* HAVE_READLINK */
1268 SCM_DEFINE (scm_lstat
, "lstat", 1, 0, 0,
1270 "Similar to @code{stat}, but does not follow symbolic links, i.e.,\n"
1271 "it will return information about a symbolic link itself, not the \n"
1272 "file it points to. @var{path} must be a string.")
1273 #define FUNC_NAME s_scm_lstat
1276 struct stat stat_temp
;
1278 SCM_VALIDATE_STRING (1, str
);
1279 SCM_STRING_COERCE_0TERMINATION_X (str
);
1280 SCM_SYSCALL (rv
= lstat (SCM_STRING_CHARS (str
), &stat_temp
));
1285 SCM_SYSERROR_MSG ("~A: ~S",
1286 scm_listify (scm_makfrom0str (strerror (errno
)),
1288 SCM_UNDEFINED
), en
);
1290 return scm_stat2scm(&stat_temp
);
1293 #endif /* HAVE_LSTAT */
1295 SCM_DEFINE (scm_copy_file
, "copy-file", 2, 0, 0,
1296 (SCM oldfile
, SCM newfile
),
1297 "Copy the file specified by @var{path-from} to @var{path-to}.\n"
1298 "The return value is unspecified.")
1299 #define FUNC_NAME s_scm_copy_file
1304 struct stat oldstat
;
1306 SCM_VALIDATE_STRING (1, oldfile
);
1307 SCM_STRING_COERCE_0TERMINATION_X (oldfile
);
1308 SCM_VALIDATE_STRING (2, newfile
);
1309 SCM_STRING_COERCE_0TERMINATION_X (newfile
);
1310 if (stat (SCM_STRING_CHARS (oldfile
), &oldstat
) == -1)
1312 oldfd
= open (SCM_STRING_CHARS (oldfile
), O_RDONLY
);
1316 /* use POSIX flags instead of 07777?. */
1317 newfd
= open (SCM_STRING_CHARS (newfile
), O_WRONLY
| O_CREAT
| O_TRUNC
,
1318 oldstat
.st_mode
& 07777);
1322 while ((n
= read (oldfd
, buf
, sizeof buf
)) > 0)
1323 if (write (newfd
, buf
, n
) != n
)
1330 if (close (newfd
) == -1)
1332 return SCM_UNSPECIFIED
;
1337 /* Filename manipulation */
1341 SCM_DEFINE (scm_dirname
, "dirname", 1, 0, 0,
1344 #define FUNC_NAME s_scm_dirname
1348 unsigned long int len
;
1350 SCM_VALIDATE_STRING (1,filename
);
1352 s
= SCM_STRING_CHARS (filename
);
1353 len
= SCM_STRING_LENGTH (filename
);
1356 while (i
>= 0 && s
[i
] == '/') --i
;
1357 while (i
>= 0 && s
[i
] != '/') --i
;
1358 while (i
>= 0 && s
[i
] == '/') --i
;
1361 if (len
> 0 && s
[0] == '/')
1362 return scm_substring (filename
, SCM_INUM0
, SCM_MAKINUM (1));
1364 return scm_dot_string
;
1367 return scm_substring (filename
, SCM_INUM0
, SCM_MAKINUM (i
+ 1));
1371 SCM_DEFINE (scm_basename
, "basename", 1, 1, 0,
1372 (SCM filename
, SCM suffix
),
1374 #define FUNC_NAME s_scm_basename
1379 SCM_VALIDATE_STRING (1,filename
);
1380 f
= SCM_STRING_CHARS (filename
);
1381 len
= SCM_STRING_LENGTH (filename
);
1383 if (SCM_UNBNDP (suffix
))
1387 SCM_VALIDATE_STRING (2, suffix
);
1388 s
= SCM_STRING_CHARS (suffix
);
1389 j
= SCM_STRING_LENGTH (suffix
) - 1;
1392 while (i
>= 0 && f
[i
] == '/') --i
;
1394 while (i
>= 0 && j
>= 0 && f
[i
] == s
[j
]) --i
, --j
;
1397 while (i
>= 0 && f
[i
] != '/') --i
;
1400 if (len
> 0 && f
[0] == '/')
1401 return scm_substring (filename
, SCM_INUM0
, SCM_MAKINUM (1));
1403 return scm_dot_string
;
1406 return scm_substring (filename
, SCM_MAKINUM (i
+ 1), SCM_MAKINUM (end
+ 1));
1417 scm_tc16_dir
= scm_make_smob_type ("directory", 0);
1418 scm_set_smob_free (scm_tc16_dir
, scm_dir_free
);
1419 scm_set_smob_print (scm_tc16_dir
, scm_dir_print
);
1421 scm_dot_string
= scm_permanent_object (scm_makfrom0str ("."));
1424 scm_sysintern ("O_RDONLY", scm_long2num (O_RDONLY
));
1427 scm_sysintern ("O_WRONLY", scm_long2num (O_WRONLY
));
1430 scm_sysintern ("O_RDWR", scm_long2num (O_RDWR
));
1433 scm_sysintern ("O_CREAT", scm_long2num (O_CREAT
));
1436 scm_sysintern ("O_EXCL", scm_long2num (O_EXCL
));
1439 scm_sysintern ("O_NOCTTY", scm_long2num (O_NOCTTY
));
1442 scm_sysintern ("O_TRUNC", scm_long2num (O_TRUNC
));
1445 scm_sysintern ("O_APPEND", scm_long2num (O_APPEND
));
1448 scm_sysintern ("O_NONBLOCK", scm_long2num (O_NONBLOCK
));
1451 scm_sysintern ("O_NDELAY", scm_long2num (O_NDELAY
));
1454 scm_sysintern ("O_SYNC", scm_long2num (O_SYNC
));
1458 scm_sysintern ("F_DUPFD", scm_long2num (F_DUPFD
));
1461 scm_sysintern ("F_GETFD", scm_long2num (F_GETFD
));
1464 scm_sysintern ("F_SETFD", scm_long2num (F_SETFD
));
1467 scm_sysintern ("F_GETFL", scm_long2num (F_GETFL
));
1470 scm_sysintern ("F_SETFL", scm_long2num (F_SETFL
));
1473 scm_sysintern ("F_GETOWN", scm_long2num (F_GETOWN
));
1476 scm_sysintern ("F_SETOWN", scm_long2num (F_SETOWN
));
1479 scm_sysintern ("FD_CLOEXEC", scm_long2num (FD_CLOEXEC
));
1482 #ifndef SCM_MAGIC_SNARFER
1483 #include "libguile/filesys.x"