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, return absolute file names. Otherwise return names\n\
110 that are relative to the specified directory.\n\
111 If MATCH is non-nil, mention only file names that match the regexp MATCH.\n\
112 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.\n\
113 NOSORT is useful if you plan to sort the result yourself.")
114 (directory
, full
, match
, nosort
)
115 Lisp_Object directory
, full
, match
, nosort
;
119 Lisp_Object list
, name
, dirfilename
;
121 struct re_pattern_buffer
*bufp
;
123 /* If the file name has special constructs in it,
124 call the corresponding file handler. */
125 handler
= Ffind_file_name_handler (directory
, Qdirectory_files
);
131 args
[1] = Qdirectory_files
;
136 return Ffuncall (6, args
);
140 struct gcpro gcpro1
, gcpro2
;
142 /* Because of file name handlers, these functions might call
143 Ffuncall, and cause a GC. */
145 directory
= Fexpand_file_name (directory
, Qnil
);
147 GCPRO2 (match
, directory
);
148 dirfilename
= Fdirectory_file_name (directory
);
154 CHECK_STRING (match
, 3);
156 /* MATCH might be a flawed regular expression. Rather than
157 catching and signaling our own errors, we just call
158 compile_pattern to do the work for us. */
160 bufp
= compile_pattern (match
, 0,
161 buffer_defaults
.downcase_table
->contents
, 0);
163 bufp
= compile_pattern (match
, 0, 0, 0);
167 /* Now *bufp is the compiled form of MATCH; don't call anything
168 which might compile a new regexp until we're done with the loop! */
170 /* Do this opendir after anything which might signal an error; if
171 an error is signaled while the directory stream is open, we
172 have to make sure it gets closed, and setting up an
173 unwind_protect to do so would be a pain. */
174 d
= opendir (XSTRING (dirfilename
)->data
);
176 report_file_error ("Opening directory", Fcons (directory
, Qnil
));
179 dirnamelen
= XSTRING (directory
)->size
;
181 /* Loop reading blocks */
184 DIRENTRY
*dp
= readdir (d
);
189 if (DIRENTRY_NONEMPTY (dp
))
192 || (0 <= re_search (bufp
, dp
->d_name
, len
, 0, len
, 0)))
196 int afterdirindex
= dirnamelen
;
197 int total
= len
+ dirnamelen
;
200 /* Decide whether we need to add a directory separator. */
203 || !IS_ANY_SEP (XSTRING (directory
)->data
[dirnamelen
- 1]))
207 name
= make_uninit_string (total
+ needsep
);
208 bcopy (XSTRING (directory
)->data
, XSTRING (name
)->data
,
211 XSTRING (name
)->data
[afterdirindex
++] = DIRECTORY_SEP
;
213 XSTRING (name
)->data
+ afterdirindex
, len
);
216 name
= make_string (dp
->d_name
, len
);
217 list
= Fcons (name
, list
);
224 return Fsort (Fnreverse (list
), Qstring_lessp
);
227 Lisp_Object
file_name_completion ();
229 DEFUN ("file-name-completion", Ffile_name_completion
, Sfile_name_completion
,
231 "Complete file name FILE in directory DIRECTORY.\n\
232 Returns the longest string\n\
233 common to all file names in DIRECTORY that start with FILE.\n\
234 If there is only one and FILE matches it exactly, returns t.\n\
235 Returns nil if DIR contains no name starting with FILE.")
237 Lisp_Object file
, directory
;
241 /* If the directory name has special constructs in it,
242 call the corresponding file handler. */
243 handler
= Ffind_file_name_handler (directory
, Qfile_name_completion
);
245 return call3 (handler
, Qfile_name_completion
, file
, directory
);
247 /* If the file name has special constructs in it,
248 call the corresponding file handler. */
249 handler
= Ffind_file_name_handler (file
, Qfile_name_completion
);
251 return call3 (handler
, Qfile_name_completion
, file
, directory
);
253 return file_name_completion (file
, directory
, 0, 0);
256 DEFUN ("file-name-all-completions", Ffile_name_all_completions
,
257 Sfile_name_all_completions
, 2, 2, 0,
258 "Return a list of all completions of file name FILE in directory DIRECTORY.\n\
259 These are all file names in directory DIRECTORY which begin with FILE.")
261 Lisp_Object file
, directory
;
265 /* If the directory name has special constructs in it,
266 call the corresponding file handler. */
267 handler
= Ffind_file_name_handler (directory
, Qfile_name_all_completions
);
269 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
271 /* If the file name has special constructs in it,
272 call the corresponding file handler. */
273 handler
= Ffind_file_name_handler (file
, Qfile_name_all_completions
);
275 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
277 return file_name_completion (file
, directory
, 1, 0);
281 file_name_completion (file
, dirname
, all_flag
, ver_flag
)
282 Lisp_Object file
, dirname
;
283 int all_flag
, ver_flag
;
287 int bestmatchsize
, skip
;
288 register int compare
, matchsize
;
289 unsigned char *p1
, *p2
;
291 Lisp_Object bestmatch
, tem
, elt
, name
;
295 int count
= specpdl_ptr
- specpdl
;
296 struct gcpro gcpro1
, gcpro2
, gcpro3
;
299 extern DIRENTRY
* readdirver ();
301 DIRENTRY
*((* readfunc
) ());
303 /* Filename completion on VMS ignores case, since VMS filesys does. */
304 specbind (Qcompletion_ignore_case
, Qt
);
308 readfunc
= readdirver
;
309 file
= Fupcase (file
);
311 CHECK_STRING (file
, 0);
314 #ifdef FILE_SYSTEM_CASE
315 file
= FILE_SYSTEM_CASE (file
);
318 GCPRO3 (file
, dirname
, bestmatch
);
319 dirname
= Fexpand_file_name (dirname
, Qnil
);
321 /* With passcount = 0, ignore files that end in an ignored extension.
322 If nothing found then try again with passcount = 1, don't ignore them.
323 If looking for all completions, start with passcount = 1,
324 so always take even the ignored ones.
326 ** It would not actually be helpful to the user to ignore any possible
327 completions when making a list of them.** */
329 for (passcount
= !!all_flag
; NILP (bestmatch
) && passcount
< 2; passcount
++)
331 if (!(d
= opendir (XSTRING (Fdirectory_file_name (dirname
))->data
)))
332 report_file_error ("Opening directory", Fcons (dirname
, Qnil
));
334 /* Loop reading blocks */
335 /* (att3b compiler bug requires do a null comparison this way) */
342 dp
= (*readfunc
) (d
);
350 if (!NILP (Vquit_flag
) && NILP (Vinhibit_quit
))
352 if (! DIRENTRY_NONEMPTY (dp
)
353 || len
< XSTRING (file
)->size
354 || 0 <= scmp (dp
->d_name
, XSTRING (file
)->data
,
355 XSTRING (file
)->size
))
358 if (file_name_completion_stat (dirname
, dp
, &st
) < 0)
361 directoryp
= ((st
.st_mode
& S_IFMT
) == S_IFDIR
);
365 #ifndef TRIVIAL_DIRECTORY_ENTRY
366 #define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, ".."))
368 /* "." and ".." are never interesting as completions, but are
369 actually in the way in a directory contains only one file. */
370 if (!passcount
&& TRIVIAL_DIRECTORY_ENTRY (dp
->d_name
))
375 /* Compare extensions-to-be-ignored against end of this file name */
376 /* if name is not an exact match against specified string */
377 if (!passcount
&& len
> XSTRING (file
)->size
)
378 /* and exit this for loop if a match is found */
379 for (tem
= Vcompletion_ignored_extensions
;
380 CONSP (tem
); tem
= XCONS (tem
)->cdr
)
382 elt
= XCONS (tem
)->car
;
383 if (!STRINGP (elt
)) continue;
384 skip
= len
- XSTRING (elt
)->size
;
385 if (skip
< 0) continue;
387 if (0 <= scmp (dp
->d_name
+ skip
,
389 XSTRING (elt
)->size
))
395 /* If an ignored-extensions match was found,
396 don't process this name as a completion. */
397 if (!passcount
&& CONSP (tem
))
404 XSETFASTINT (zero
, 0);
406 /* Ignore this element if it fails to match all the regexps. */
407 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
408 regexps
= XCONS (regexps
)->cdr
)
410 tem
= Fstring_match (XCONS (regexps
)->car
, elt
, zero
);
418 /* Update computation of how much all possible completions match */
422 if (all_flag
|| NILP (bestmatch
))
424 /* This is a possible completion */
427 /* This completion is a directory; make it end with '/' */
428 name
= Ffile_name_as_directory (make_string (dp
->d_name
, len
));
431 name
= make_string (dp
->d_name
, len
);
434 bestmatch
= Fcons (name
, bestmatch
);
439 bestmatchsize
= XSTRING (name
)->size
;
444 compare
= min (bestmatchsize
, len
);
445 p1
= XSTRING (bestmatch
)->data
;
446 p2
= (unsigned char *) dp
->d_name
;
447 matchsize
= scmp(p1
, p2
, compare
);
450 if (completion_ignore_case
)
452 /* If this is an exact match except for case,
453 use it as the best match rather than one that is not
454 an exact match. This way, we get the case pattern
455 of the actual match. */
456 if ((matchsize
== len
457 && matchsize
+ !!directoryp
458 < XSTRING (bestmatch
)->size
)
460 /* If there is no exact match ignoring case,
461 prefer a match that does not change the case
465 (matchsize
+ !!directoryp
466 == XSTRING (bestmatch
)->size
))
467 /* If there is more than one exact match aside from
468 case, and one of them is exact including case,
470 && !bcmp (p2
, XSTRING (file
)->data
, XSTRING (file
)->size
)
471 && bcmp (p1
, XSTRING (file
)->data
, XSTRING (file
)->size
)))
473 bestmatch
= make_string (dp
->d_name
, len
);
475 bestmatch
= Ffile_name_as_directory (bestmatch
);
479 /* If this dirname all matches, see if implicit following
482 && compare
== matchsize
483 && bestmatchsize
> matchsize
484 && IS_ANY_SEP (p1
[matchsize
]))
486 bestmatchsize
= matchsize
;
493 bestmatch
= unbind_to (count
, bestmatch
);
495 if (all_flag
|| NILP (bestmatch
))
497 if (matchcount
== 1 && bestmatchsize
== XSTRING (file
)->size
)
499 return Fsubstring (bestmatch
, make_number (0), make_number (bestmatchsize
));
503 return Fsignal (Qquit
, Qnil
);
506 file_name_completion_stat (dirname
, dp
, st_addr
)
509 struct stat
*st_addr
;
511 int len
= NAMLEN (dp
);
512 int pos
= XSTRING (dirname
)->size
;
514 char *fullname
= (char *) alloca (len
+ pos
+ 2);
516 bcopy (XSTRING (dirname
)->data
, fullname
, pos
);
518 if (!IS_DIRECTORY_SEP (fullname
[pos
- 1]))
519 fullname
[pos
++] = DIRECTORY_SEP
;
522 bcopy (dp
->d_name
, fullname
+ pos
, len
);
523 fullname
[pos
+ len
] = 0;
526 /* We want to return success if a link points to a nonexistent file,
527 but we want to return the status for what the link points to,
528 in case it is a directory. */
529 value
= lstat (fullname
, st_addr
);
530 stat (fullname
, st_addr
);
533 return stat (fullname
, st_addr
);
539 DEFUN ("file-name-all-versions", Ffile_name_all_versions
,
540 Sfile_name_all_versions
, 2, 2, 0,
541 "Return a list of all versions of file name FILE in directory DIRECTORY.")
543 Lisp_Object file
, directory
;
545 return file_name_completion (file
, directory
, 1, 1);
548 DEFUN ("file-version-limit", Ffile_version_limit
, Sfile_version_limit
, 1, 1, 0,
549 "Return the maximum number of versions allowed for FILE.\n\
550 Returns nil if the file cannot be opened or if there is no version limit.")
552 Lisp_Object filename
;
557 struct XABFHC xabfhc
;
560 filename
= Fexpand_file_name (filename
, Qnil
);
562 xabfhc
= cc$rms_xabfhc
;
563 fab
.fab$l_fna
= XSTRING (filename
)->data
;
564 fab
.fab$b_fns
= strlen (fab
.fab$l_fna
);
565 fab
.fab$l_xab
= (char *) &xabfhc
;
566 status
= sys$
open (&fab
, 0, 0);
567 if (status
!= RMS$_NORMAL
) /* Probably non-existent file */
569 sys$
close (&fab
, 0, 0);
570 if (xabfhc
.xab$w_verlimit
== 32767)
571 return Qnil
; /* No version limit */
573 return make_number (xabfhc
.xab$w_verlimit
);
582 return Fcons (make_number (time
>> 16),
583 Fcons (make_number (time
& 0177777), Qnil
));
586 DEFUN ("file-attributes", Ffile_attributes
, Sfile_attributes
, 1, 1, 0,
587 "Return a list of attributes of file FILENAME.\n\
588 Value is nil if specified file cannot be opened.\n\
589 Otherwise, list elements are:\n\
590 0. t for directory, string (name linked to) for symbolic link, or nil.\n\
591 1. Number of links to file.\n\
594 4. Last access time, as a list of two integers.\n\
595 First integer has high-order 16 bits of time, second has low 16 bits.\n\
596 5. Last modification time, likewise.\n\
597 6. Last status change time, likewise.\n\
598 7. Size in bytes (-1, if number is out of range).\n\
599 8. File modes, as a string of ten letters or dashes as in ls -l.\n\
600 9. t iff file's gid would change if file were deleted and recreated.\n\
602 11. Device number.\n\
604 If file does not exist, returns nil.")
606 Lisp_Object filename
;
608 Lisp_Object values
[12];
615 filename
= Fexpand_file_name (filename
, Qnil
);
617 /* If the file name has special constructs in it,
618 call the corresponding file handler. */
619 handler
= Ffind_file_name_handler (filename
, Qfile_attributes
);
621 return call2 (handler
, Qfile_attributes
, filename
);
623 if (lstat (XSTRING (filename
)->data
, &s
) < 0)
626 switch (s
.st_mode
& S_IFMT
)
629 values
[0] = Qnil
; break;
631 values
[0] = Qt
; break;
634 values
[0] = Ffile_symlink_p (filename
); break;
637 values
[1] = make_number (s
.st_nlink
);
638 values
[2] = make_number (s
.st_uid
);
639 values
[3] = make_number (s
.st_gid
);
640 values
[4] = make_time (s
.st_atime
);
641 values
[5] = make_time (s
.st_mtime
);
642 values
[6] = make_time (s
.st_ctime
);
643 values
[7] = make_number ((int) s
.st_size
);
644 /* If the size is out of range, give back -1. */
645 if (XINT (values
[7]) != s
.st_size
)
646 XSETINT (values
[7], -1);
647 filemodestring (&s
, modes
);
648 values
[8] = make_string (modes
, 10);
649 #ifdef BSD4_3 /* Gross kludge to avoid lack of "#if defined(...)" in VMS */
650 #define BSD4_2 /* A new meaning to the term `backwards compatibility' */
652 #ifdef BSD4_2 /* file gid will be dir gid */
653 dirname
= Ffile_name_directory (filename
);
654 if (! NILP (dirname
) && stat (XSTRING (dirname
)->data
, &sdir
) == 0)
655 values
[9] = (sdir
.st_gid
!= s
.st_gid
) ? Qt
: Qnil
;
656 else /* if we can't tell, assume worst */
658 #else /* file gid will be egid */
660 values
[9] = Qnil
; /* sorry, no group IDs on NT */
661 #else /* not WINDOWSNT */
662 values
[9] = (s
.st_gid
!= getegid ()) ? Qt
: Qnil
;
663 #endif /* not WINDOWSNT */
664 #endif /* BSD4_2 (or BSD4_3) */
666 #undef BSD4_2 /* ok, you can look again without throwing up */
669 /* Fill in the inode and device values specially...see nt.c. */
670 if (!get_inode_and_device_vals (filename
, &values
[10], &values
[11])) {
673 #else /* not WINDOWSNT */
674 values
[10] = make_number (s
.st_ino
);
675 values
[11] = make_number (s
.st_dev
);
676 #endif /* not WINDOWSNT */
677 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
682 Qdirectory_files
= intern ("directory-files");
683 Qfile_name_completion
= intern ("file-name-completion");
684 Qfile_name_all_completions
= intern ("file-name-all-completions");
685 Qfile_attributes
= intern ("file-attributes");
687 defsubr (&Sdirectory_files
);
688 defsubr (&Sfile_name_completion
);
690 defsubr (&Sfile_name_all_versions
);
691 defsubr (&Sfile_version_limit
);
693 defsubr (&Sfile_name_all_completions
);
694 defsubr (&Sfile_attributes
);
697 Qcompletion_ignore_case
= intern ("completion-ignore-case");
698 staticpro (&Qcompletion_ignore_case
);
701 DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions
,
702 "*Completion ignores filenames ending in any string in this list.\n\
703 This variable does not affect lists of possible completions,\n\
704 but does affect the commands that actually do completions.");
705 Vcompletion_ignored_extensions
= Qnil
;