1 /* Lisp functions for making directory listings.
2 Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
25 #include <sys/types.h>
34 /* The d_nameln member of a struct dirent includes the '\0' character
35 on some systems, but not on others. What's worse, you can't tell
36 at compile-time which one it will be, since it really depends on
37 the sort of system providing the filesystem you're reading from,
38 not the system you are running on. Paul Eggert
39 <eggert@bi.twinsun.com> says this occurs when Emacs is running on a
40 SunOS 4.1.2 host, reading a directory that is remote-mounted from a
41 Solaris 2.1 host and is in a native Solaris 2.1 filesystem.
43 Since applying strlen to the name always works, we'll just do that. */
44 #define NAMLEN(p) strlen (p->d_name)
46 #ifdef SYSV_SYSTEM_DIR
49 #define DIRENTRY struct dirent
51 #else /* not SYSV_SYSTEM_DIR */
53 #ifdef NONSYSTEM_DIR_LIBRARY
55 #else /* not NONSYSTEM_DIR_LIBRARY */
61 #endif /* not NONSYSTEM_DIR_LIBRARY */
64 #define DIRENTRY struct direct
66 extern DIR *opendir ();
67 extern struct direct
*readdir ();
69 #endif /* not MSDOS */
70 #endif /* not SYSV_SYSTEM_DIR */
73 #define DIRENTRY_NONEMPTY(p) ((p)->d_name[0] != 0)
75 #define DIRENTRY_NONEMPTY(p) ((p)->d_ino)
84 /* Returns a search buffer, with a fastmap allocated and ready to go. */
85 extern struct re_pattern_buffer
*compile_pattern ();
87 #define min(a, b) ((a) < (b) ? (a) : (b))
89 /* if system does not have symbolic links, it does not have lstat.
90 In that case, use ordinary stat instead. */
96 extern int completion_ignore_case
;
97 extern Lisp_Object Vcompletion_regexp_list
;
99 Lisp_Object Vcompletion_ignored_extensions
;
100 Lisp_Object Qcompletion_ignore_case
;
101 Lisp_Object Qdirectory_files
;
102 Lisp_Object Qfile_name_completion
;
103 Lisp_Object Qfile_name_all_completions
;
104 Lisp_Object Qfile_attributes
;
106 DEFUN ("directory-files", Fdirectory_files
, Sdirectory_files
, 1, 4, 0,
107 "Return a list of names of files in DIRECTORY.\n\
108 There are three optional arguments:\n\
109 If FULL is non-nil, absolute pathnames of the files are returned.\n\
110 If MATCH is non-nil, only pathnames containing that regexp are returned.\n\
111 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.\n\
112 NOSORT is useful if you plan to sort the result yourself.")
113 (directory
, full
, match
, nosort
)
114 Lisp_Object directory
, full
, match
, nosort
;
118 Lisp_Object list
, name
, dirfilename
;
120 struct re_pattern_buffer
*bufp
;
122 /* If the file name has special constructs in it,
123 call the corresponding file handler. */
124 handler
= Ffind_file_name_handler (directory
, Qdirectory_files
);
130 args
[1] = Qdirectory_files
;
135 return Ffuncall (6, args
);
139 struct gcpro gcpro1
, gcpro2
;
141 /* Because of file name handlers, these functions might call
142 Ffuncall, and cause a GC. */
144 directory
= Fexpand_file_name (directory
, Qnil
);
146 GCPRO2 (match
, directory
);
147 dirfilename
= Fdirectory_file_name (directory
);
153 CHECK_STRING (match
, 3);
155 /* MATCH might be a flawed regular expression. Rather than
156 catching and signaling our own errors, we just call
157 compile_pattern to do the work for us. */
159 bufp
= compile_pattern (match
, 0,
160 buffer_defaults
.downcase_table
->contents
, 0);
162 bufp
= compile_pattern (match
, 0, 0, 0);
166 /* Now *bufp is the compiled form of MATCH; don't call anything
167 which might compile a new regexp until we're done with the loop! */
169 /* Do this opendir after anything which might signal an error; if
170 an error is signaled while the directory stream is open, we
171 have to make sure it gets closed, and setting up an
172 unwind_protect to do so would be a pain. */
173 d
= opendir (XSTRING (dirfilename
)->data
);
175 report_file_error ("Opening directory", Fcons (directory
, Qnil
));
178 dirnamelen
= XSTRING (directory
)->size
;
180 /* Loop reading blocks */
183 DIRENTRY
*dp
= readdir (d
);
188 if (DIRENTRY_NONEMPTY (dp
))
191 || (0 <= re_search (bufp
, dp
->d_name
, len
, 0, len
, 0)))
195 int afterdirindex
= dirnamelen
;
196 int total
= len
+ dirnamelen
;
199 /* Decide whether we need to add a directory separator. */
202 || !IS_ANY_SEP (XSTRING (directory
)->data
[dirnamelen
- 1]))
206 name
= make_uninit_string (total
+ needsep
);
207 bcopy (XSTRING (directory
)->data
, XSTRING (name
)->data
,
210 XSTRING (name
)->data
[afterdirindex
++] = DIRECTORY_SEP
;
212 XSTRING (name
)->data
+ afterdirindex
, len
);
215 name
= make_string (dp
->d_name
, len
);
216 list
= Fcons (name
, list
);
223 return Fsort (Fnreverse (list
), Qstring_lessp
);
226 Lisp_Object
file_name_completion ();
228 DEFUN ("file-name-completion", Ffile_name_completion
, Sfile_name_completion
,
230 "Complete file name FILE in directory DIRECTORY.\n\
231 Returns the longest string\n\
232 common to all filenames in DIRECTORY that start with FILE.\n\
233 If there is only one and FILE matches it exactly, returns t.\n\
234 Returns nil if DIR contains no name starting with FILE.")
236 Lisp_Object file
, directory
;
240 /* If the directory name has special constructs in it,
241 call the corresponding file handler. */
242 handler
= Ffind_file_name_handler (directory
, Qfile_name_completion
);
244 return call3 (handler
, Qfile_name_completion
, file
, directory
);
246 /* If the file name has special constructs in it,
247 call the corresponding file handler. */
248 handler
= Ffind_file_name_handler (file
, Qfile_name_completion
);
250 return call3 (handler
, Qfile_name_completion
, file
, directory
);
252 return file_name_completion (file
, directory
, 0, 0);
255 DEFUN ("file-name-all-completions", Ffile_name_all_completions
,
256 Sfile_name_all_completions
, 2, 2, 0,
257 "Return a list of all completions of file name FILE in directory DIRECTORY.\n\
258 These are all file names in directory DIRECTORY which begin with FILE.")
260 Lisp_Object file
, directory
;
264 /* If the directory name has special constructs in it,
265 call the corresponding file handler. */
266 handler
= Ffind_file_name_handler (directory
, Qfile_name_all_completions
);
268 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
270 /* If the file name has special constructs in it,
271 call the corresponding file handler. */
272 handler
= Ffind_file_name_handler (file
, Qfile_name_all_completions
);
274 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
276 return file_name_completion (file
, directory
, 1, 0);
280 file_name_completion (file
, dirname
, all_flag
, ver_flag
)
281 Lisp_Object file
, dirname
;
282 int all_flag
, ver_flag
;
286 int bestmatchsize
, skip
;
287 register int compare
, matchsize
;
288 unsigned char *p1
, *p2
;
290 Lisp_Object bestmatch
, tem
, elt
, name
;
294 int count
= specpdl_ptr
- specpdl
;
295 struct gcpro gcpro1
, gcpro2
, gcpro3
;
298 extern DIRENTRY
* readdirver ();
300 DIRENTRY
*((* readfunc
) ());
302 /* Filename completion on VMS ignores case, since VMS filesys does. */
303 specbind (Qcompletion_ignore_case
, Qt
);
307 readfunc
= readdirver
;
308 file
= Fupcase (file
);
310 CHECK_STRING (file
, 0);
313 #ifdef FILE_SYSTEM_CASE
314 file
= FILE_SYSTEM_CASE (file
);
317 GCPRO3 (file
, dirname
, bestmatch
);
318 dirname
= Fexpand_file_name (dirname
, Qnil
);
320 /* With passcount = 0, ignore files that end in an ignored extension.
321 If nothing found then try again with passcount = 1, don't ignore them.
322 If looking for all completions, start with passcount = 1,
323 so always take even the ignored ones.
325 ** It would not actually be helpful to the user to ignore any possible
326 completions when making a list of them.** */
328 for (passcount
= !!all_flag
; NILP (bestmatch
) && passcount
< 2; passcount
++)
330 if (!(d
= opendir (XSTRING (Fdirectory_file_name (dirname
))->data
)))
331 report_file_error ("Opening directory", Fcons (dirname
, Qnil
));
333 /* Loop reading blocks */
334 /* (att3b compiler bug requires do a null comparison this way) */
341 dp
= (*readfunc
) (d
);
349 if (!NILP (Vquit_flag
) && NILP (Vinhibit_quit
))
351 if (! DIRENTRY_NONEMPTY (dp
)
352 || len
< XSTRING (file
)->size
353 || 0 <= scmp (dp
->d_name
, XSTRING (file
)->data
,
354 XSTRING (file
)->size
))
357 if (file_name_completion_stat (dirname
, dp
, &st
) < 0)
360 directoryp
= ((st
.st_mode
& S_IFMT
) == S_IFDIR
);
364 #ifndef TRIVIAL_DIRECTORY_ENTRY
365 #define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, ".."))
367 /* "." and ".." are never interesting as completions, but are
368 actually in the way in a directory contains only one file. */
369 if (!passcount
&& TRIVIAL_DIRECTORY_ENTRY (dp
->d_name
))
374 /* Compare extensions-to-be-ignored against end of this file name */
375 /* if name is not an exact match against specified string */
376 if (!passcount
&& len
> XSTRING (file
)->size
)
377 /* and exit this for loop if a match is found */
378 for (tem
= Vcompletion_ignored_extensions
;
379 CONSP (tem
); tem
= XCONS (tem
)->cdr
)
381 elt
= XCONS (tem
)->car
;
382 if (!STRINGP (elt
)) continue;
383 skip
= len
- XSTRING (elt
)->size
;
384 if (skip
< 0) continue;
386 if (0 <= scmp (dp
->d_name
+ skip
,
388 XSTRING (elt
)->size
))
394 /* If an ignored-extensions match was found,
395 don't process this name as a completion. */
396 if (!passcount
&& CONSP (tem
))
403 XSETFASTINT (zero
, 0);
405 /* Ignore this element if it fails to match all the regexps. */
406 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
407 regexps
= XCONS (regexps
)->cdr
)
409 tem
= Fstring_match (XCONS (regexps
)->car
, elt
, zero
);
417 /* Update computation of how much all possible completions match */
421 if (all_flag
|| NILP (bestmatch
))
423 /* This is a possible completion */
426 /* This completion is a directory; make it end with '/' */
427 name
= Ffile_name_as_directory (make_string (dp
->d_name
, len
));
430 name
= make_string (dp
->d_name
, len
);
433 bestmatch
= Fcons (name
, bestmatch
);
438 bestmatchsize
= XSTRING (name
)->size
;
443 compare
= min (bestmatchsize
, len
);
444 p1
= XSTRING (bestmatch
)->data
;
445 p2
= (unsigned char *) dp
->d_name
;
446 matchsize
= scmp(p1
, p2
, compare
);
449 if (completion_ignore_case
)
451 /* If this is an exact match except for case,
452 use it as the best match rather than one that is not
453 an exact match. This way, we get the case pattern
454 of the actual match. */
455 if ((matchsize
== len
456 && matchsize
+ !!directoryp
457 < XSTRING (bestmatch
)->size
)
459 /* If there is no exact match ignoring case,
460 prefer a match that does not change the case
464 (matchsize
+ !!directoryp
465 == XSTRING (bestmatch
)->size
))
466 /* If there is more than one exact match aside from
467 case, and one of them is exact including case,
469 && !bcmp (p2
, XSTRING (file
)->data
, XSTRING (file
)->size
)
470 && bcmp (p1
, XSTRING (file
)->data
, XSTRING (file
)->size
)))
472 bestmatch
= make_string (dp
->d_name
, len
);
474 bestmatch
= Ffile_name_as_directory (bestmatch
);
478 /* If this dirname all matches, see if implicit following
481 && compare
== matchsize
482 && bestmatchsize
> matchsize
483 && IS_ANY_SEP (p1
[matchsize
]))
485 bestmatchsize
= matchsize
;
492 bestmatch
= unbind_to (count
, bestmatch
);
494 if (all_flag
|| NILP (bestmatch
))
496 if (matchcount
== 1 && bestmatchsize
== XSTRING (file
)->size
)
498 return Fsubstring (bestmatch
, make_number (0), make_number (bestmatchsize
));
502 return Fsignal (Qquit
, Qnil
);
505 file_name_completion_stat (dirname
, dp
, st_addr
)
508 struct stat
*st_addr
;
510 int len
= NAMLEN (dp
);
511 int pos
= XSTRING (dirname
)->size
;
513 char *fullname
= (char *) alloca (len
+ pos
+ 2);
515 bcopy (XSTRING (dirname
)->data
, fullname
, pos
);
517 if (!IS_DIRECTORY_SEP (fullname
[pos
- 1]))
518 fullname
[pos
++] = DIRECTORY_SEP
;
521 bcopy (dp
->d_name
, fullname
+ pos
, len
);
522 fullname
[pos
+ len
] = 0;
525 /* We want to return success if a link points to a nonexistent file,
526 but we want to return the status for what the link points to,
527 in case it is a directory. */
528 value
= lstat (fullname
, st_addr
);
529 stat (fullname
, st_addr
);
532 return stat (fullname
, st_addr
);
538 DEFUN ("file-name-all-versions", Ffile_name_all_versions
,
539 Sfile_name_all_versions
, 2, 2, 0,
540 "Return a list of all versions of file name FILE in directory DIRECTORY.")
542 Lisp_Object file
, directory
;
544 return file_name_completion (file
, directory
, 1, 1);
547 DEFUN ("file-version-limit", Ffile_version_limit
, Sfile_version_limit
, 1, 1, 0,
548 "Return the maximum number of versions allowed for FILE.\n\
549 Returns nil if the file cannot be opened or if there is no version limit.")
551 Lisp_Object filename
;
556 struct XABFHC xabfhc
;
559 filename
= Fexpand_file_name (filename
, Qnil
);
561 xabfhc
= cc$rms_xabfhc
;
562 fab
.fab$l_fna
= XSTRING (filename
)->data
;
563 fab
.fab$b_fns
= strlen (fab
.fab$l_fna
);
564 fab
.fab$l_xab
= (char *) &xabfhc
;
565 status
= sys$
open (&fab
, 0, 0);
566 if (status
!= RMS$_NORMAL
) /* Probably non-existent file */
568 sys$
close (&fab
, 0, 0);
569 if (xabfhc
.xab$w_verlimit
== 32767)
570 return Qnil
; /* No version limit */
572 return make_number (xabfhc
.xab$w_verlimit
);
581 return Fcons (make_number (time
>> 16),
582 Fcons (make_number (time
& 0177777), Qnil
));
585 DEFUN ("file-attributes", Ffile_attributes
, Sfile_attributes
, 1, 1, 0,
586 "Return a list of attributes of file FILENAME.\n\
587 Value is nil if specified file cannot be opened.\n\
588 Otherwise, list elements are:\n\
589 0. t for directory, string (name linked to) for symbolic link, or nil.\n\
590 1. Number of links to file.\n\
593 4. Last access time, as a list of two integers.\n\
594 First integer has high-order 16 bits of time, second has low 16 bits.\n\
595 5. Last modification time, likewise.\n\
596 6. Last status change time, likewise.\n\
597 7. Size in bytes (-1, if number is out of range).\n\
598 8. File modes, as a string of ten letters or dashes as in ls -l.\n\
599 9. t iff file's gid would change if file were deleted and recreated.\n\
601 11. Device number.\n\
603 If file does not exist, returns nil.")
605 Lisp_Object filename
;
607 Lisp_Object values
[12];
614 filename
= Fexpand_file_name (filename
, Qnil
);
616 /* If the file name has special constructs in it,
617 call the corresponding file handler. */
618 handler
= Ffind_file_name_handler (filename
, Qfile_attributes
);
620 return call2 (handler
, Qfile_attributes
, filename
);
622 if (lstat (XSTRING (filename
)->data
, &s
) < 0)
625 switch (s
.st_mode
& S_IFMT
)
628 values
[0] = Qnil
; break;
630 values
[0] = Qt
; break;
633 values
[0] = Ffile_symlink_p (filename
); break;
636 values
[1] = make_number (s
.st_nlink
);
637 values
[2] = make_number (s
.st_uid
);
638 values
[3] = make_number (s
.st_gid
);
639 values
[4] = make_time (s
.st_atime
);
640 values
[5] = make_time (s
.st_mtime
);
641 values
[6] = make_time (s
.st_ctime
);
642 values
[7] = make_number ((int) s
.st_size
);
643 /* If the size is out of range, give back -1. */
644 if (XINT (values
[7]) != s
.st_size
)
645 XSETINT (values
[7], -1);
646 filemodestring (&s
, modes
);
647 values
[8] = make_string (modes
, 10);
648 #ifdef BSD4_3 /* Gross kludge to avoid lack of "#if defined(...)" in VMS */
649 #define BSD4_2 /* A new meaning to the term `backwards compatibility' */
651 #ifdef BSD4_2 /* file gid will be dir gid */
652 dirname
= Ffile_name_directory (filename
);
653 if (! NILP (dirname
) && stat (XSTRING (dirname
)->data
, &sdir
) == 0)
654 values
[9] = (sdir
.st_gid
!= s
.st_gid
) ? Qt
: Qnil
;
655 else /* if we can't tell, assume worst */
657 #else /* file gid will be egid */
659 values
[9] = Qnil
; /* sorry, no group IDs on NT */
660 #else /* not WINDOWSNT */
661 values
[9] = (s
.st_gid
!= getegid ()) ? Qt
: Qnil
;
662 #endif /* not WINDOWSNT */
663 #endif /* BSD4_2 (or BSD4_3) */
665 #undef BSD4_2 /* ok, you can look again without throwing up */
668 /* Fill in the inode and device values specially...see nt.c. */
669 if (!get_inode_and_device_vals (filename
, &values
[10], &values
[11])) {
672 #else /* not WINDOWSNT */
673 values
[10] = make_number (s
.st_ino
);
674 values
[11] = make_number (s
.st_dev
);
675 #endif /* not WINDOWSNT */
676 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
681 Qdirectory_files
= intern ("directory-files");
682 Qfile_name_completion
= intern ("file-name-completion");
683 Qfile_name_all_completions
= intern ("file-name-all-completions");
684 Qfile_attributes
= intern ("file-attributes");
686 defsubr (&Sdirectory_files
);
687 defsubr (&Sfile_name_completion
);
689 defsubr (&Sfile_name_all_versions
);
690 defsubr (&Sfile_version_limit
);
692 defsubr (&Sfile_name_all_completions
);
693 defsubr (&Sfile_attributes
);
696 Qcompletion_ignore_case
= intern ("completion-ignore-case");
697 staticpro (&Qcompletion_ignore_case
);
700 DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions
,
701 "*Completion ignores filenames ending in any string in this list.\n\
702 This variable does not affect lists of possible completions,\n\
703 but does affect the commands that actually do completions.");
704 Vcompletion_ignored_extensions
= Qnil
;