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);
342 SCM_SYMBOL (scm_sym_regular
, "regular");
343 SCM_SYMBOL (scm_sym_directory
, "directory");
345 SCM_SYMBOL (scm_sym_symlink
, "symlink");
347 SCM_SYMBOL (scm_sym_block_special
, "block-special");
348 SCM_SYMBOL (scm_sym_char_special
, "char-special");
349 SCM_SYMBOL (scm_sym_fifo
, "fifo");
350 SCM_SYMBOL (scm_sym_sock
, "socket");
351 SCM_SYMBOL (scm_sym_unknown
, "unknown");
354 scm_stat2scm (struct stat
*stat_temp
)
356 SCM ans
= scm_make_vector (SCM_MAKINUM (15), SCM_UNSPECIFIED
);
357 SCM
*ve
= SCM_VELTS (ans
);
359 ve
[0] = scm_ulong2num ((unsigned long) stat_temp
->st_dev
);
360 ve
[1] = scm_ulong2num ((unsigned long) stat_temp
->st_ino
);
361 ve
[2] = scm_ulong2num ((unsigned long) stat_temp
->st_mode
);
362 ve
[3] = scm_ulong2num ((unsigned long) stat_temp
->st_nlink
);
363 ve
[4] = scm_ulong2num ((unsigned long) stat_temp
->st_uid
);
364 ve
[5] = scm_ulong2num ((unsigned long) stat_temp
->st_gid
);
366 ve
[6] = scm_ulong2num ((unsigned long) stat_temp
->st_rdev
);
370 ve
[7] = scm_ulong2num ((unsigned long) stat_temp
->st_size
);
371 ve
[8] = scm_ulong2num ((unsigned long) stat_temp
->st_atime
);
372 ve
[9] = scm_ulong2num ((unsigned long) stat_temp
->st_mtime
);
373 ve
[10] = scm_ulong2num ((unsigned long) stat_temp
->st_ctime
);
374 #ifdef HAVE_ST_BLKSIZE
375 ve
[11] = scm_ulong2num ((unsigned long) stat_temp
->st_blksize
);
377 ve
[11] = scm_ulong2num (4096L);
379 #ifdef HAVE_ST_BLOCKS
380 ve
[12] = scm_ulong2num ((unsigned long) stat_temp
->st_blocks
);
385 int mode
= stat_temp
->st_mode
;
388 ve
[13] = scm_sym_regular
;
389 else if (S_ISDIR (mode
))
390 ve
[13] = scm_sym_directory
;
392 else if (S_ISLNK (mode
))
393 ve
[13] = scm_sym_symlink
;
395 else if (S_ISBLK (mode
))
396 ve
[13] = scm_sym_block_special
;
397 else if (S_ISCHR (mode
))
398 ve
[13] = scm_sym_char_special
;
399 else if (S_ISFIFO (mode
))
400 ve
[13] = scm_sym_fifo
;
402 else if (S_ISSOCK (mode
))
403 ve
[13] = scm_sym_sock
;
406 ve
[13] = scm_sym_unknown
;
408 ve
[14] = SCM_MAKINUM ((~S_IFMT
) & mode
);
410 /* the layout of the bits in ve[14] is intended to be portable.
411 If there are systems that don't follow the usual convention,
412 the following could be used:
415 if (S_ISUID & mode) tmp += 1;
417 if (S_IRGRP & mode) tmp += 1;
419 if (S_ISVTX & mode) tmp += 1;
421 if (S_IRUSR & mode) tmp += 1;
423 if (S_IWUSR & mode) tmp += 1;
425 if (S_IXUSR & mode) tmp += 1;
427 if (S_IWGRP & mode) tmp += 1;
429 if (S_IXGRP & mode) tmp += 1;
431 if (S_IROTH & mode) tmp += 1;
433 if (S_IWOTH & mode) tmp += 1;
435 if (S_IXOTH & mode) tmp += 1;
437 ve[14] = SCM_MAKINUM (tmp);
445 SCM_DEFINE (scm_stat
, "stat", 1, 0, 0,
447 "Returns an object containing various information\n"
448 "about the file determined by @var{obj}.\n"
449 "@var{obj} can be a string containing a file name or a port or integer file\n"
450 "descriptor which is open on a file (in which case @code{fstat} is used\n"
451 "as the underlying system call).\n\n"
452 "The object returned by @code{stat} can be passed as a single parameter\n"
453 "to the following procedures, all of which return integers:\n\n"
456 "The device containing the file.\n"
458 "The file serial number, which distinguishes this file from all other\n"
459 "files on the same device.\n"
461 "The mode of the file. This includes file type information\n"
462 "and the file permission bits. See @code{stat:type} and @code{stat:perms}\n"
465 "The number of hard links to the file.\n"
467 "The user ID of the file's owner.\n"
469 "The group ID of the file.\n"
471 "Device ID; this entry is defined only for character or block\n"
474 "The size of a regular file in bytes.\n"
476 "The last access time for the file.\n"
478 "The last modification time for the file.\n"
480 "The last modification time for the attributes of the file.\n"
481 "@item stat:blksize\n"
482 "The optimal block size for reading or writing the file, in bytes.\n"
483 "@item stat:blocks\n"
484 "The amount of disk space that the file occupies measured in units of\n"
487 "In addition, the following procedures return the information\n"
488 "from stat:mode in a more convenient form:\n\n"
491 "A symbol representing the type of file. Possible values are\n"
492 "regular, directory, symlink, block-special, char-special,\n"
493 "fifo, socket and unknown\n"
495 "An integer representing the access permission bits.\n"
497 #define FUNC_NAME s_scm_stat
501 struct stat stat_temp
;
503 if (SCM_INUMP (object
))
504 SCM_SYSCALL (rv
= fstat (SCM_INUM (object
), &stat_temp
));
507 SCM_VALIDATE_NIM (1,object
);
508 if (SCM_STRINGP (object
))
510 SCM_STRING_COERCE_0TERMINATION_X (object
);
511 SCM_SYSCALL (rv
= stat (SCM_STRING_CHARS (object
), &stat_temp
));
515 object
= SCM_COERCE_OUTPORT (object
);
516 SCM_VALIDATE_OPFPORT(1,object
);
517 fdes
= SCM_FPORT_FDES (object
);
518 SCM_SYSCALL (rv
= fstat (fdes
, &stat_temp
));
525 SCM_SYSERROR_MSG ("~A: ~S",
526 scm_listify (scm_makfrom0str (strerror (errno
)),
530 return scm_stat2scm (&stat_temp
);
535 /* {Modifying Directories}
538 SCM_DEFINE (scm_link
, "link", 2, 0, 0,
539 (SCM oldpath
, SCM newpath
),
540 "Creates a new name @var{path-to} in the file system for the file\n"
541 "named by @var{path-from}. If @var{path-from} is a symbolic link, the\n"
542 "link may or may not be followed depending on the system.")
543 #define FUNC_NAME s_scm_link
547 SCM_VALIDATE_STRING (1, oldpath
);
548 SCM_STRING_COERCE_0TERMINATION_X (oldpath
);
549 SCM_VALIDATE_STRING (2, newpath
);
550 SCM_STRING_COERCE_0TERMINATION_X (newpath
);
551 SCM_SYSCALL (val
= link (SCM_STRING_CHARS (oldpath
), SCM_STRING_CHARS (newpath
)));
554 return SCM_UNSPECIFIED
;
560 SCM_DEFINE (scm_rename
, "rename-file", 2, 0, 0,
561 (SCM oldname
, SCM newname
),
562 "Renames the file specified by @var{path-from} to @var{path-to}.\n"
563 "The return value is unspecified.")
564 #define FUNC_NAME s_scm_rename
567 SCM_VALIDATE_STRING (1, oldname
);
568 SCM_VALIDATE_STRING (2, newname
);
569 SCM_STRING_COERCE_0TERMINATION_X (oldname
);
570 SCM_STRING_COERCE_0TERMINATION_X (newname
);
572 SCM_SYSCALL (rv
= rename (SCM_STRING_CHARS (oldname
), SCM_STRING_CHARS (newname
)));
574 SCM_SYSCALL (rv
= link (SCM_STRING_CHARS (oldname
), SCM_STRING_CHARS (newname
)));
577 SCM_SYSCALL (rv
= unlink (SCM_STRING_CHARS (oldname
)));;
579 /* unlink failed. remove new name */
580 SCM_SYSCALL (unlink (SCM_STRING_CHARS (newname
)));
585 return SCM_UNSPECIFIED
;
590 SCM_DEFINE (scm_delete_file
, "delete-file", 1, 0, 0,
592 "Deletes (or \"unlinks\") the file specified by @var{path}.")
593 #define FUNC_NAME s_scm_delete_file
596 SCM_VALIDATE_STRING (1, str
);
597 SCM_STRING_COERCE_0TERMINATION_X (str
);
598 SCM_SYSCALL (ans
= unlink (SCM_STRING_CHARS (str
)));
601 return SCM_UNSPECIFIED
;
606 SCM_DEFINE (scm_mkdir
, "mkdir", 1, 1, 0,
607 (SCM path
, SCM mode
),
608 "Create a new directory named by @var{path}. If @var{mode} is omitted\n"
609 "then the permissions of the directory file are set using the current\n"
610 "umask. Otherwise they are set to the decimal value specified with\n"
611 "@var{mode}. The return value is unspecified.")
612 #define FUNC_NAME s_scm_mkdir
616 SCM_VALIDATE_STRING (1, path
);
617 SCM_STRING_COERCE_0TERMINATION_X (path
);
618 if (SCM_UNBNDP (mode
))
622 SCM_SYSCALL (rv
= mkdir (SCM_STRING_CHARS (path
), 0777 ^ mask
));
626 SCM_VALIDATE_INUM (2,mode
);
627 SCM_SYSCALL (rv
= mkdir (SCM_STRING_CHARS (path
), SCM_INUM (mode
)));
631 return SCM_UNSPECIFIED
;
634 #endif /* HAVE_MKDIR */
637 SCM_DEFINE (scm_rmdir
, "rmdir", 1, 0, 0,
639 "Remove the existing directory named by @var{path}. The directory must\n"
640 "be empty for this to succeed. The return value is unspecified.")
641 #define FUNC_NAME s_scm_rmdir
645 SCM_VALIDATE_STRING (1, path
);
646 SCM_STRING_COERCE_0TERMINATION_X (path
);
647 SCM_SYSCALL (val
= rmdir (SCM_STRING_CHARS (path
)));
650 return SCM_UNSPECIFIED
;
656 /* {Examining Directories}
661 SCM_DEFINE (scm_directory_stream_p
, "directory-stream?", 1, 0, 0,
663 "Returns a boolean indicating whether @var{object} is a directory stream\n"
664 "as returned by @code{opendir}.")
665 #define FUNC_NAME s_scm_directory_stream_p
667 return SCM_BOOL(SCM_DIRP (obj
));
671 SCM_DEFINE (scm_opendir
, "opendir", 1, 0, 0,
673 "Open the directory specified by @var{path} and return a directory\n"
675 #define FUNC_NAME s_scm_opendir
678 SCM_VALIDATE_STRING (1, dirname
);
679 SCM_STRING_COERCE_0TERMINATION_X (dirname
);
680 SCM_SYSCALL (ds
= opendir (SCM_STRING_CHARS (dirname
)));
683 SCM_RETURN_NEWSMOB (scm_tc16_dir
| SCM_OPN
, ds
);
688 SCM_DEFINE (scm_readdir
, "readdir", 1, 0, 0,
690 "Return (as a string) the next directory entry from the directory stream\n"
691 "@var{stream}. If there is no remaining entry to be read then the\n"
692 "end of file object is returned.")
693 #define FUNC_NAME s_scm_readdir
695 struct dirent
*rdent
;
696 SCM_VALIDATE_OPDIR (1,port
);
698 SCM_SYSCALL (rdent
= readdir ((DIR *) SCM_CELL_WORD_1 (port
)));
701 return (rdent
? scm_makfromstr (rdent
->d_name
, NAMLEN (rdent
), 0)
708 SCM_DEFINE (scm_rewinddir
, "rewinddir", 1, 0, 0,
710 "Reset the directory port @var{stream} so that the next call to\n"
711 "@code{readdir} will return the first directory entry.")
712 #define FUNC_NAME s_scm_rewinddir
714 SCM_VALIDATE_OPDIR (1,port
);
715 rewinddir ((DIR *) SCM_CELL_WORD_1 (port
));
716 return SCM_UNSPECIFIED
;
722 SCM_DEFINE (scm_closedir
, "closedir", 1, 0, 0,
724 "Close the directory stream @var{stream}.\n"
725 "The return value is unspecified.")
726 #define FUNC_NAME s_scm_closedir
730 SCM_VALIDATE_DIR (1,port
);
731 if (SCM_CLOSEDP (port
))
733 return SCM_UNSPECIFIED
;
735 SCM_SYSCALL (sts
= closedir ((DIR *) SCM_CELL_WORD_1 (port
)));
738 SCM_SET_CELL_WORD_0 (port
, scm_tc16_dir
);
739 return SCM_UNSPECIFIED
;
747 scm_dir_print (SCM exp
, SCM port
, scm_print_state
*pstate
)
749 scm_puts ("#<", port
);
750 if (SCM_CLOSEDP (exp
))
751 scm_puts ("closed: ", port
);
752 scm_puts ("directory stream ", port
);
753 scm_intprint (SCM_CELL_WORD_1 (exp
), 16, port
);
754 scm_putc ('>', port
);
763 closedir ((DIR *) SCM_CELL_WORD_1 (p
));
768 /* {Navigating Directories}
772 SCM_DEFINE (scm_chdir
, "chdir", 1, 0, 0,
774 "Change the current working directory to @var{path}.\n"
775 "The return value is unspecified.")
776 #define FUNC_NAME s_scm_chdir
780 SCM_VALIDATE_STRING (1, str
);
781 SCM_STRING_COERCE_0TERMINATION_X (str
);
782 SCM_SYSCALL (ans
= chdir (SCM_STRING_CHARS (str
)));
785 return SCM_UNSPECIFIED
;
790 SCM_DEFINE (scm_getcwd
, "getcwd", 0, 0, 0,
792 "Returns the name of the current working directory.")
793 #define FUNC_NAME s_scm_getcwd
796 scm_sizet size
= 100;
800 wd
= scm_must_malloc (size
, FUNC_NAME
);
801 while ((rv
= getcwd (wd
, size
)) == 0 && errno
== ERANGE
)
805 wd
= scm_must_malloc (size
, FUNC_NAME
);
809 result
= scm_makfromstr (wd
, strlen (wd
), 0);
814 #endif /* HAVE_GETCWD */
820 /* check that element is a port or file descriptor. if it's a port
821 and its buffer is ready for use, add it to the ports_ready list.
822 otherwise add its file descriptor to *set. the type of list can be
823 determined from pos: SCM_ARG1 for reads, SCM_ARG2 for writes,
824 SCM_ARG3 for excepts. */
826 set_element (SELECT_TYPE
*set
, SCM
*ports_ready
, SCM element
, int pos
)
830 if (SCM_INUMP (element
))
832 fd
= SCM_INUM (element
);
838 element
= SCM_COERCE_OUTPORT (element
);
839 SCM_ASSERT (SCM_OPFPORTP (element
), element
, pos
, "select");
842 /* check whether port has buffered input. */
843 scm_port
*pt
= SCM_PTAB_ENTRY (element
);
845 if (pt
->read_pos
< pt
->read_end
)
848 else if (pos
== SCM_ARG2
)
850 /* check whether port's output buffer has room. */
851 scm_port
*pt
= SCM_PTAB_ENTRY (element
);
853 /* > 1 since writing the last byte in the buffer causes flush. */
854 if (pt
->write_end
- pt
->write_pos
> 1)
857 fd
= use_buf
? -1 : SCM_FPORT_FDES (element
);
860 *ports_ready
= scm_cons (element
, *ports_ready
);
866 /* check list_or_vec, a list or vector of ports or file descriptors,
867 adding each member to either the ports_ready list (if it's a port
868 with a usable buffer) or to *set. the kind of list_or_vec can be
869 determined from pos: SCM_ARG1 for reads, SCM_ARG2 for writes,
870 SCM_ARG3 for excepts. */
872 fill_select_type (SELECT_TYPE
*set
, SCM
*ports_ready
, SCM list_or_vec
, int pos
)
876 if (SCM_VECTORP (list_or_vec
))
878 int i
= SCM_VECTOR_LENGTH (list_or_vec
);
879 SCM
*ve
= SCM_VELTS (list_or_vec
);
883 int fd
= set_element (set
, ports_ready
, ve
[i
], pos
);
891 while (!SCM_NULLP (list_or_vec
))
893 int fd
= set_element (set
, ports_ready
, SCM_CAR (list_or_vec
), pos
);
897 list_or_vec
= SCM_CDR (list_or_vec
);
904 /* if element (a file descriptor or port) appears in *set, cons it to
905 list. return list. */
907 get_element (SELECT_TYPE
*set
, SCM element
, SCM list
)
911 if (SCM_INUMP (element
))
913 fd
= SCM_INUM (element
);
917 fd
= SCM_FPORT_FDES (SCM_COERCE_OUTPORT (element
));
919 if (FD_ISSET (fd
, set
))
920 list
= scm_cons (element
, list
);
924 /* construct component of scm_select return value.
925 set: pointer to set of file descriptors found by select to be ready
926 ports_ready: ports ready due to buffering
927 list_or_vec: original list/vector handed to scm_select.
928 the return value is a list/vector of ready ports/file descriptors.
929 works by finding the objects in list which correspond to members of
930 *set and appending them to ports_ready. result is converted to a
931 vector if list_or_vec is a vector. */
933 retrieve_select_type (SELECT_TYPE
*set
, SCM ports_ready
, SCM list_or_vec
)
935 SCM answer_list
= ports_ready
;
937 if (SCM_VECTORP (list_or_vec
))
939 int i
= SCM_VECTOR_LENGTH (list_or_vec
);
940 SCM
*ve
= SCM_VELTS (list_or_vec
);
944 answer_list
= get_element (set
, ve
[i
], answer_list
);
946 return scm_vector (answer_list
);
950 /* list_or_vec must be a list. */
951 while (!SCM_NULLP (list_or_vec
))
953 answer_list
= get_element (set
, SCM_CAR (list_or_vec
), answer_list
);
954 list_or_vec
= SCM_CDR (list_or_vec
);
960 /* Static helper functions above refer to s_scm_select directly as s_select */
961 SCM_DEFINE (scm_select
, "select", 3, 2, 0,
962 (SCM reads
, SCM writes
, SCM excepts
, SCM secs
, SCM usecs
),
963 "This procedure has a variety of uses: waiting for the ability\n"
964 "to provide input, accept output, or the existance of\n"
965 "exceptional conditions on a collection of ports or file\n"
966 "descriptors, or waiting for a timeout to occur.\n"
967 "It also returns if interrupted by a signal.\n\n"
968 "@var{reads}, @var{writes} and @var{excepts} can be lists or\n"
969 "vectors, with each member a port or a file descriptor.\n"
970 "The value returned is a list of three corresponding\n"
971 "lists or vectors containing only the members which meet the\n"
972 "specified requirement. The ability of port buffers to\n"
973 "provide input or accept output is taken into account.\n"
974 "Ordering of the input lists or vectors is not preserved.\n\n"
975 "The optional arguments @var{secs} and @var{usecs} specify the\n"
976 "timeout. Either @var{secs} can be specified alone, as\n"
977 "either an integer or a real number, or both @var{secs} and\n"
978 "@var{usecs} can be specified as integers, in which case\n"
979 "@var{usecs} is an additional timeout expressed in\n"
980 "microseconds. If @var{secs} is omitted or is @code{#f} then\n"
981 "select will wait for as long as it takes for one of the other\n"
982 "conditions to be satisfied.\n\n"
983 "The scsh version of @code{select} differs as follows:\n"
984 "Only vectors are accepted for the first three arguments.\n"
985 "The @var{usecs} argument is not supported.\n"
986 "Multiple values are returned instead of a list.\n"
987 "Duplicates in the input vectors appear only once in output.\n"
988 "An additional @code{select!} interface is provided.\n"
990 #define FUNC_NAME s_scm_select
992 struct timeval timeout
;
993 struct timeval
* time_ptr
;
994 SELECT_TYPE read_set
;
995 SELECT_TYPE write_set
;
996 SELECT_TYPE except_set
;
1000 /* these lists accumulate ports which are ready due to buffering.
1001 their file descriptors don't need to be added to the select sets. */
1002 SCM read_ports_ready
= SCM_EOL
;
1003 SCM write_ports_ready
= SCM_EOL
;
1006 if (SCM_VECTORP (reads
))
1008 read_count
= SCM_VECTOR_LENGTH (reads
);
1012 read_count
= scm_ilength (reads
);
1013 SCM_ASSERT (read_count
>= 0, reads
, SCM_ARG1
, FUNC_NAME
);
1015 if (SCM_VECTORP (writes
))
1017 write_count
= SCM_VECTOR_LENGTH (writes
);
1021 write_count
= scm_ilength (writes
);
1022 SCM_ASSERT (write_count
>= 0, writes
, SCM_ARG2
, FUNC_NAME
);
1024 if (SCM_VECTORP (excepts
))
1026 except_count
= SCM_VECTOR_LENGTH (excepts
);
1030 except_count
= scm_ilength (excepts
);
1031 SCM_ASSERT (except_count
>= 0, excepts
, SCM_ARG3
, FUNC_NAME
);
1034 FD_ZERO (&read_set
);
1035 FD_ZERO (&write_set
);
1036 FD_ZERO (&except_set
);
1038 max_fd
= fill_select_type (&read_set
, &read_ports_ready
, reads
, SCM_ARG1
);
1041 int write_max
= fill_select_type (&write_set
, &write_ports_ready
,
1043 int except_max
= fill_select_type (&except_set
, NULL
,
1046 if (write_max
> max_fd
)
1048 if (except_max
> max_fd
)
1049 max_fd
= except_max
;
1052 /* if there's a port with a ready buffer, don't block, just
1053 check for ready file descriptors. */
1054 if (!SCM_NULLP (read_ports_ready
) || !SCM_NULLP (write_ports_ready
))
1057 timeout
.tv_usec
= 0;
1058 time_ptr
= &timeout
;
1060 else if (SCM_UNBNDP (secs
) || SCM_FALSEP (secs
))
1064 if (SCM_INUMP (secs
))
1066 timeout
.tv_sec
= SCM_INUM (secs
);
1067 if (SCM_UNBNDP (usecs
))
1068 timeout
.tv_usec
= 0;
1071 SCM_VALIDATE_INUM (5,usecs
);
1072 timeout
.tv_usec
= SCM_INUM (usecs
);
1077 double fl
= scm_num2dbl (secs
, FUNC_NAME
);
1079 if (!SCM_UNBNDP (usecs
))
1080 SCM_WRONG_TYPE_ARG (4, secs
);
1082 SCM_OUT_OF_RANGE (4, secs
);
1083 timeout
.tv_sec
= (long) fl
;
1084 timeout
.tv_usec
= (long) ((fl
- timeout
.tv_sec
) * 1000000);
1086 time_ptr
= &timeout
;
1090 #ifdef GUILE_ISELECT
1091 int rv
= scm_internal_select (max_fd
+ 1,
1092 &read_set
, &write_set
, &except_set
,
1095 int rv
= select (max_fd
+ 1,
1096 &read_set
, &write_set
, &except_set
, time_ptr
);
1101 return scm_listify (retrieve_select_type (&read_set
, read_ports_ready
,
1103 retrieve_select_type (&write_set
, write_ports_ready
,
1105 retrieve_select_type (&except_set
, SCM_EOL
, excepts
),
1109 #endif /* HAVE_SELECT */
1113 SCM_DEFINE (scm_fcntl
, "fcntl", 2, 1, 0,
1114 (SCM object
, SCM cmd
, SCM value
),
1115 "Apply @var{command} to the specified file descriptor or the underlying\n"
1116 "file descriptor of the specified port. @var{value} is an optional\n"
1117 "integer argument.\n\n"
1118 "Values for @var{command} are:\n\n"
1121 "Duplicate a file descriptor\n"
1123 "Get flags associated with the file descriptor.\n"
1125 "Set flags associated with the file descriptor to @var{value}.\n"
1127 "Get flags associated with the open file.\n"
1129 "Set flags associated with the open file to @var{value}\n"
1131 "Get the process ID of a socket's owner, for @code{SIGIO} signals.\n"
1133 "Set the process that owns a socket to @var{value}, for @code{SIGIO} signals.\n"
1134 "@item FD_CLOEXEC\n"
1135 "The value used to indicate the \"close on exec\" flag with @code{F_GETFL} or\n"
1138 #define FUNC_NAME s_scm_fcntl
1144 object
= SCM_COERCE_OUTPORT (object
);
1146 SCM_VALIDATE_INUM (2,cmd
);
1147 if (SCM_OPFPORTP (object
))
1148 fdes
= SCM_FPORT_FDES (object
);
1151 SCM_VALIDATE_INUM (1,object
);
1152 fdes
= SCM_INUM (object
);
1155 if (SCM_UNBNDP (value
)) {
1158 SCM_VALIDATE_INUM_COPY (SCM_ARG3
, value
, ivalue
);
1161 SCM_SYSCALL (rv
= fcntl (fdes
, SCM_INUM (cmd
), ivalue
));
1164 return SCM_MAKINUM (rv
);
1168 SCM_DEFINE (scm_fsync
, "fsync", 1, 0, 0,
1170 "Copies any unwritten data for the specified output file descriptor to disk.\n"
1171 "If @var{port/fd} is a port, its buffer is flushed before the underlying\n"
1172 "file descriptor is fsync'd.\n"
1173 "The return value is unspecified.")
1174 #define FUNC_NAME s_scm_fsync
1178 object
= SCM_COERCE_OUTPORT (object
);
1180 if (SCM_OPFPORTP (object
))
1183 fdes
= SCM_FPORT_FDES (object
);
1187 SCM_VALIDATE_INUM (1,object
);
1188 fdes
= SCM_INUM (object
);
1190 if (fsync (fdes
) == -1)
1192 return SCM_UNSPECIFIED
;
1197 SCM_DEFINE (scm_symlink
, "symlink", 2, 0, 0,
1198 (SCM oldpath
, SCM newpath
),
1199 "Create a symbolic link named @var{path-to} with the value (i.e., pointing to)\n"
1200 "@var{path-from}. The return value is unspecified.")
1201 #define FUNC_NAME s_scm_symlink
1205 SCM_VALIDATE_STRING (1, oldpath
);
1206 SCM_VALIDATE_STRING (2, newpath
);
1207 SCM_STRING_COERCE_0TERMINATION_X (oldpath
);
1208 SCM_STRING_COERCE_0TERMINATION_X (newpath
);
1209 SCM_SYSCALL (val
= symlink (SCM_STRING_CHARS (oldpath
), SCM_STRING_CHARS (newpath
)));
1212 return SCM_UNSPECIFIED
;
1215 #endif /* HAVE_SYMLINK */
1217 #ifdef HAVE_READLINK
1218 SCM_DEFINE (scm_readlink
, "readlink", 1, 0, 0,
1220 "Returns the value of the symbolic link named by\n"
1221 "@var{path} (a string), i.e., the\n"
1222 "file that the link points to.")
1223 #define FUNC_NAME s_scm_readlink
1229 SCM_VALIDATE_STRING (1, path
);
1230 SCM_STRING_COERCE_0TERMINATION_X (path
);
1231 buf
= scm_must_malloc (size
, FUNC_NAME
);
1232 while ((rv
= readlink (SCM_STRING_CHARS (path
), buf
, size
)) == size
)
1234 scm_must_free (buf
);
1236 buf
= scm_must_malloc (size
, FUNC_NAME
);
1240 result
= scm_makfromstr (buf
, rv
, 0);
1241 scm_must_free (buf
);
1245 #endif /* HAVE_READLINK */
1248 SCM_DEFINE (scm_lstat
, "lstat", 1, 0, 0,
1250 "Similar to @code{stat}, but does not follow symbolic links, i.e.,\n"
1251 "it will return information about a symbolic link itself, not the \n"
1252 "file it points to. @var{path} must be a string.")
1253 #define FUNC_NAME s_scm_lstat
1256 struct stat stat_temp
;
1258 SCM_VALIDATE_STRING (1, str
);
1259 SCM_STRING_COERCE_0TERMINATION_X (str
);
1260 SCM_SYSCALL (rv
= lstat (SCM_STRING_CHARS (str
), &stat_temp
));
1265 SCM_SYSERROR_MSG ("~A: ~S",
1266 scm_listify (scm_makfrom0str (strerror (errno
)),
1268 SCM_UNDEFINED
), en
);
1270 return scm_stat2scm(&stat_temp
);
1273 #endif /* HAVE_LSTAT */
1275 SCM_DEFINE (scm_copy_file
, "copy-file", 2, 0, 0,
1276 (SCM oldfile
, SCM newfile
),
1277 "Copy the file specified by @var{path-from} to @var{path-to}.\n"
1278 "The return value is unspecified.")
1279 #define FUNC_NAME s_scm_copy_file
1284 struct stat oldstat
;
1286 SCM_VALIDATE_STRING (1, oldfile
);
1287 SCM_STRING_COERCE_0TERMINATION_X (oldfile
);
1288 SCM_VALIDATE_STRING (2, newfile
);
1289 SCM_STRING_COERCE_0TERMINATION_X (newfile
);
1290 if (stat (SCM_STRING_CHARS (oldfile
), &oldstat
) == -1)
1292 oldfd
= open (SCM_STRING_CHARS (oldfile
), O_RDONLY
);
1296 /* use POSIX flags instead of 07777?. */
1297 newfd
= open (SCM_STRING_CHARS (newfile
), O_WRONLY
| O_CREAT
| O_TRUNC
,
1298 oldstat
.st_mode
& 07777);
1302 while ((n
= read (oldfd
, buf
, sizeof buf
)) > 0)
1303 if (write (newfd
, buf
, n
) != n
)
1310 if (close (newfd
) == -1)
1312 return SCM_UNSPECIFIED
;
1317 /* Filename manipulation */
1321 SCM_DEFINE (scm_dirname
, "dirname", 1, 0, 0,
1324 #define FUNC_NAME s_scm_dirname
1328 unsigned long int len
;
1330 SCM_VALIDATE_STRING (1,filename
);
1332 s
= SCM_ROCHARS (filename
);
1333 len
= SCM_STRING_LENGTH (filename
);
1336 while (i
>= 0 && s
[i
] == '/') --i
;
1337 while (i
>= 0 && s
[i
] != '/') --i
;
1338 while (i
>= 0 && s
[i
] == '/') --i
;
1341 if (len
> 0 && s
[0] == '/')
1342 return scm_substring (filename
, SCM_INUM0
, SCM_MAKINUM (1));
1344 return scm_dot_string
;
1347 return scm_substring (filename
, SCM_INUM0
, SCM_MAKINUM (i
+ 1));
1351 SCM_DEFINE (scm_basename
, "basename", 1, 1, 0,
1352 (SCM filename
, SCM suffix
),
1354 #define FUNC_NAME s_scm_basename
1359 SCM_VALIDATE_STRING (1,filename
);
1360 f
= SCM_ROCHARS (filename
);
1361 len
= SCM_STRING_LENGTH (filename
);
1363 if (SCM_UNBNDP (suffix
))
1367 SCM_VALIDATE_STRING (2, suffix
);
1368 s
= SCM_ROCHARS (suffix
);
1369 j
= SCM_STRING_LENGTH (suffix
) - 1;
1372 while (i
>= 0 && f
[i
] == '/') --i
;
1374 while (i
>= 0 && j
>= 0 && f
[i
] == s
[j
]) --i
, --j
;
1377 while (i
>= 0 && f
[i
] != '/') --i
;
1380 if (len
> 0 && f
[0] == '/')
1381 return scm_substring (filename
, SCM_INUM0
, SCM_MAKINUM (1));
1383 return scm_dot_string
;
1386 return scm_substring (filename
, SCM_MAKINUM (i
+ 1), SCM_MAKINUM (end
+ 1));
1397 scm_tc16_dir
= scm_make_smob_type_mfpe ("directory", 0,
1398 NULL
, scm_dir_free
,scm_dir_print
, NULL
);
1400 scm_dot_string
= scm_permanent_object (scm_makfrom0str ("."));
1403 scm_sysintern ("O_RDONLY", scm_long2num (O_RDONLY
));
1406 scm_sysintern ("O_WRONLY", scm_long2num (O_WRONLY
));
1409 scm_sysintern ("O_RDWR", scm_long2num (O_RDWR
));
1412 scm_sysintern ("O_CREAT", scm_long2num (O_CREAT
));
1415 scm_sysintern ("O_EXCL", scm_long2num (O_EXCL
));
1418 scm_sysintern ("O_NOCTTY", scm_long2num (O_NOCTTY
));
1421 scm_sysintern ("O_TRUNC", scm_long2num (O_TRUNC
));
1424 scm_sysintern ("O_APPEND", scm_long2num (O_APPEND
));
1427 scm_sysintern ("O_NONBLOCK", scm_long2num (O_NONBLOCK
));
1430 scm_sysintern ("O_NDELAY", scm_long2num (O_NDELAY
));
1433 scm_sysintern ("O_SYNC", scm_long2num (O_SYNC
));
1437 scm_sysintern ("F_DUPFD", scm_long2num (F_DUPFD
));
1440 scm_sysintern ("F_GETFD", scm_long2num (F_GETFD
));
1443 scm_sysintern ("F_SETFD", scm_long2num (F_SETFD
));
1446 scm_sysintern ("F_GETFL", scm_long2num (F_GETFL
));
1449 scm_sysintern ("F_SETFL", scm_long2num (F_SETFL
));
1452 scm_sysintern ("F_GETOWN", scm_long2num (F_GETOWN
));
1455 scm_sysintern ("F_SETOWN", scm_long2num (F_SETOWN
));
1458 scm_sysintern ("FD_CLOEXEC", scm_long2num (FD_CLOEXEC
));
1461 #include "libguile/filesys.x"