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, 675 Mass Ave, Cambridge, MA 02139, USA. */
24 #include <sys/types.h>
33 /* The d_nameln member of a struct dirent includes the '\0' character
34 on some systems, but not on others. What's worse, you can't tell
35 at compile-time which one it will be, since it really depends on
36 the sort of system providing the filesystem you're reading from,
37 not the system you are running on. Paul Eggert
38 <eggert@bi.twinsun.com> says this occurs when Emacs is running on a
39 SunOS 4.1.2 host, reading a directory that is remote-mounted from a
40 Solaris 2.1 host and is in a native Solaris 2.1 filesystem.
42 Since applying strlen to the name always works, we'll just do that. */
43 #define NAMLEN(p) strlen (p->d_name)
45 #ifdef SYSV_SYSTEM_DIR
48 #define DIRENTRY struct dirent
50 #else /* not SYSV_SYSTEM_DIR */
52 #ifdef NONSYSTEM_DIR_LIBRARY
54 #else /* not NONSYSTEM_DIR_LIBRARY */
60 #endif /* not NONSYSTEM_DIR_LIBRARY */
63 #define DIRENTRY struct direct
65 extern DIR *opendir ();
66 extern struct direct
*readdir ();
68 #endif /* not MSDOS */
69 #endif /* not SYSV_SYSTEM_DIR */
72 #define DIRENTRY_NONEMPTY(p) ((p)->d_name[0] != 0)
74 #define DIRENTRY_NONEMPTY(p) ((p)->d_ino)
83 /* Returns a search buffer, with a fastmap allocated and ready to go. */
84 extern struct re_pattern_buffer
*compile_pattern ();
86 #define min(a, b) ((a) < (b) ? (a) : (b))
88 /* if system does not have symbolic links, it does not have lstat.
89 In that case, use ordinary stat instead. */
95 extern int completion_ignore_case
;
96 extern Lisp_Object Vcompletion_regexp_list
;
98 Lisp_Object Vcompletion_ignored_extensions
;
99 Lisp_Object Qcompletion_ignore_case
;
100 Lisp_Object Qdirectory_files
;
101 Lisp_Object Qfile_name_completion
;
102 Lisp_Object Qfile_name_all_completions
;
103 Lisp_Object Qfile_attributes
;
105 DEFUN ("directory-files", Fdirectory_files
, Sdirectory_files
, 1, 4, 0,
106 "Return a list of names of files in DIRECTORY.\n\
107 There are three optional arguments:\n\
108 If FULL is non-nil, absolute pathnames of the files are returned.\n\
109 If MATCH is non-nil, only pathnames containing that regexp are returned.\n\
110 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.\n\
111 NOSORT is useful if you plan to sort the result yourself.")
112 (dirname
, full
, match
, nosort
)
113 Lisp_Object dirname
, full
, match
, nosort
;
117 Lisp_Object list
, name
, dirfilename
;
119 struct re_pattern_buffer
*bufp
;
121 /* If the file name has special constructs in it,
122 call the corresponding file handler. */
123 handler
= Ffind_file_name_handler (dirname
, Qdirectory_files
);
129 args
[1] = Qdirectory_files
;
134 return Ffuncall (6, args
);
138 struct gcpro gcpro1
, gcpro2
;
140 /* Because of file name handlers, these functions might call
141 Ffuncall, and cause a GC. */
143 dirname
= Fexpand_file_name (dirname
, Qnil
);
145 GCPRO2 (match
, dirname
);
146 dirfilename
= Fdirectory_file_name (dirname
);
152 CHECK_STRING (match
, 3);
154 /* MATCH might be a flawed regular expression. Rather than
155 catching and signalling our own errors, we just call
156 compile_pattern to do the work for us. */
158 bufp
= compile_pattern (match
, 0,
159 buffer_defaults
.downcase_table
->contents
, 0);
161 bufp
= compile_pattern (match
, 0, 0, 0);
165 /* Now *bufp is the compiled form of MATCH; don't call anything
166 which might compile a new regexp until we're done with the loop! */
168 /* Do this opendir after anything which might signal an error; if
169 an error is signalled while the directory stream is open, we
170 have to make sure it gets closed, and setting up an
171 unwind_protect to do so would be a pain. */
172 d
= opendir (XSTRING (dirfilename
)->data
);
174 report_file_error ("Opening directory", Fcons (dirname
, Qnil
));
177 dirnamelen
= XSTRING (dirname
)->size
;
179 /* Loop reading blocks */
182 DIRENTRY
*dp
= readdir (d
);
187 if (DIRENTRY_NONEMPTY (dp
))
190 || (0 <= re_search (bufp
, dp
->d_name
, len
, 0, len
, 0)))
194 int afterdirindex
= dirnamelen
;
195 int total
= len
+ dirnamelen
;
198 /* Decide whether we need to add a directory separator. */
201 || !IS_ANY_SEP (XSTRING (dirname
)->data
[dirnamelen
- 1]))
205 name
= make_uninit_string (total
+ needsep
);
206 bcopy (XSTRING (dirname
)->data
, XSTRING (name
)->data
,
209 XSTRING (name
)->data
[afterdirindex
++] = DIRECTORY_SEP
;
211 XSTRING (name
)->data
+ afterdirindex
, len
);
214 name
= make_string (dp
->d_name
, len
);
215 list
= Fcons (name
, list
);
222 return Fsort (Fnreverse (list
), Qstring_lessp
);
225 Lisp_Object
file_name_completion ();
227 DEFUN ("file-name-completion", Ffile_name_completion
, Sfile_name_completion
,
229 "Complete file name FILE in directory DIR.\n\
230 Returns the longest string\n\
231 common to all filenames in DIR that start with FILE.\n\
232 If there is only one and FILE matches it exactly, returns t.\n\
233 Returns nil if DIR contains no name starting with FILE.")
235 Lisp_Object file
, dirname
;
239 /* If the file name has special constructs in it,
240 call the corresponding file handler. */
241 handler
= Ffind_file_name_handler (dirname
, Qfile_name_completion
);
243 return call3 (handler
, Qfile_name_completion
, file
, dirname
);
245 return file_name_completion (file
, dirname
, 0, 0);
248 DEFUN ("file-name-all-completions", Ffile_name_all_completions
,
249 Sfile_name_all_completions
, 2, 2, 0,
250 "Return a list of all completions of file name FILE in directory DIR.\n\
251 These are all file names in directory DIR which begin with FILE.")
253 Lisp_Object file
, dirname
;
257 /* If the file name has special constructs in it,
258 call the corresponding file handler. */
259 handler
= Ffind_file_name_handler (dirname
, Qfile_name_all_completions
);
261 return call3 (handler
, Qfile_name_all_completions
, file
, dirname
);
263 return file_name_completion (file
, dirname
, 1, 0);
267 file_name_completion (file
, dirname
, all_flag
, ver_flag
)
268 Lisp_Object file
, dirname
;
269 int all_flag
, ver_flag
;
273 int bestmatchsize
, skip
;
274 register int compare
, matchsize
;
275 unsigned char *p1
, *p2
;
277 Lisp_Object bestmatch
, tem
, elt
, name
;
281 int count
= specpdl_ptr
- specpdl
;
282 struct gcpro gcpro1
, gcpro2
, gcpro3
;
285 extern DIRENTRY
* readdirver ();
287 DIRENTRY
*((* readfunc
) ());
289 /* Filename completion on VMS ignores case, since VMS filesys does. */
290 specbind (Qcompletion_ignore_case
, Qt
);
294 readfunc
= readdirver
;
295 file
= Fupcase (file
);
297 CHECK_STRING (file
, 0);
300 #ifdef FILE_SYSTEM_CASE
301 file
= FILE_SYSTEM_CASE (file
);
304 GCPRO3 (file
, dirname
, bestmatch
);
305 dirname
= Fexpand_file_name (dirname
, Qnil
);
307 /* With passcount = 0, ignore files that end in an ignored extension.
308 If nothing found then try again with passcount = 1, don't ignore them.
309 If looking for all completions, start with passcount = 1,
310 so always take even the ignored ones.
312 ** It would not actually be helpful to the user to ignore any possible
313 completions when making a list of them.** */
315 for (passcount
= !!all_flag
; NILP (bestmatch
) && passcount
< 2; passcount
++)
317 if (!(d
= opendir (XSTRING (Fdirectory_file_name (dirname
))->data
)))
318 report_file_error ("Opening directory", Fcons (dirname
, Qnil
));
320 /* Loop reading blocks */
321 /* (att3b compiler bug requires do a null comparison this way) */
328 dp
= (*readfunc
) (d
);
336 if (!NILP (Vquit_flag
) && NILP (Vinhibit_quit
))
338 if (! DIRENTRY_NONEMPTY (dp
)
339 || len
< XSTRING (file
)->size
340 || 0 <= scmp (dp
->d_name
, XSTRING (file
)->data
,
341 XSTRING (file
)->size
))
344 if (file_name_completion_stat (dirname
, dp
, &st
) < 0)
347 directoryp
= ((st
.st_mode
& S_IFMT
) == S_IFDIR
);
351 #ifndef TRIVIAL_DIRECTORY_ENTRY
352 #define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, ".."))
354 /* "." and ".." are never interesting as completions, but are
355 actually in the way in a directory contains only one file. */
356 if (!passcount
&& TRIVIAL_DIRECTORY_ENTRY (dp
->d_name
))
361 /* Compare extensions-to-be-ignored against end of this file name */
362 /* if name is not an exact match against specified string */
363 if (!passcount
&& len
> XSTRING (file
)->size
)
364 /* and exit this for loop if a match is found */
365 for (tem
= Vcompletion_ignored_extensions
;
366 CONSP (tem
); tem
= XCONS (tem
)->cdr
)
368 elt
= XCONS (tem
)->car
;
369 if (!STRINGP (elt
)) continue;
370 skip
= len
- XSTRING (elt
)->size
;
371 if (skip
< 0) continue;
373 if (0 <= scmp (dp
->d_name
+ skip
,
375 XSTRING (elt
)->size
))
381 /* If an ignored-extensions match was found,
382 don't process this name as a completion. */
383 if (!passcount
&& CONSP (tem
))
390 XSETFASTINT (zero
, 0);
392 /* Ignore this element if it fails to match all the regexps. */
393 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
394 regexps
= XCONS (regexps
)->cdr
)
396 tem
= Fstring_match (XCONS (regexps
)->car
, elt
, zero
);
404 /* Update computation of how much all possible completions match */
408 if (all_flag
|| NILP (bestmatch
))
410 /* This is a possible completion */
413 /* This completion is a directory; make it end with '/' */
414 name
= Ffile_name_as_directory (make_string (dp
->d_name
, len
));
417 name
= make_string (dp
->d_name
, len
);
420 bestmatch
= Fcons (name
, bestmatch
);
425 bestmatchsize
= XSTRING (name
)->size
;
430 compare
= min (bestmatchsize
, len
);
431 p1
= XSTRING (bestmatch
)->data
;
432 p2
= (unsigned char *) dp
->d_name
;
433 matchsize
= scmp(p1
, p2
, compare
);
436 if (completion_ignore_case
)
438 /* If this is an exact match except for case,
439 use it as the best match rather than one that is not
440 an exact match. This way, we get the case pattern
441 of the actual match. */
442 if ((matchsize
== len
443 && matchsize
+ !!directoryp
444 < XSTRING (bestmatch
)->size
)
446 /* If there is no exact match ignoring case,
447 prefer a match that does not change the case
451 (matchsize
+ !!directoryp
452 == XSTRING (bestmatch
)->size
))
453 /* If there is more than one exact match aside from
454 case, and one of them is exact including case,
456 && !bcmp (p2
, XSTRING (file
)->data
, XSTRING (file
)->size
)
457 && bcmp (p1
, XSTRING (file
)->data
, XSTRING (file
)->size
)))
459 bestmatch
= make_string (dp
->d_name
, len
);
461 bestmatch
= Ffile_name_as_directory (bestmatch
);
465 /* If this dirname all matches, see if implicit following
468 && compare
== matchsize
469 && bestmatchsize
> matchsize
470 && IS_ANY_SEP (p1
[matchsize
]))
472 bestmatchsize
= matchsize
;
479 bestmatch
= unbind_to (count
, bestmatch
);
481 if (all_flag
|| NILP (bestmatch
))
483 if (matchcount
== 1 && bestmatchsize
== XSTRING (file
)->size
)
485 return Fsubstring (bestmatch
, make_number (0), make_number (bestmatchsize
));
489 return Fsignal (Qquit
, Qnil
);
492 file_name_completion_stat (dirname
, dp
, st_addr
)
495 struct stat
*st_addr
;
497 int len
= NAMLEN (dp
);
498 int pos
= XSTRING (dirname
)->size
;
500 char *fullname
= (char *) alloca (len
+ pos
+ 2);
502 bcopy (XSTRING (dirname
)->data
, fullname
, pos
);
504 if (!IS_DIRECTORY_SEP (fullname
[pos
- 1]))
505 fullname
[pos
++] = DIRECTORY_SEP
;
508 bcopy (dp
->d_name
, fullname
+ pos
, len
);
509 fullname
[pos
+ len
] = 0;
512 /* We want to return success if a link points to a nonexistent file,
513 but we want to return the status for what the link points to,
514 in case it is a directory. */
515 value
= lstat (fullname
, st_addr
);
516 stat (fullname
, st_addr
);
519 return stat (fullname
, st_addr
);
525 DEFUN ("file-name-all-versions", Ffile_name_all_versions
,
526 Sfile_name_all_versions
, 2, 2, 0,
527 "Return a list of all versions of file name FILE in directory DIR.")
529 Lisp_Object file
, dirname
;
531 return file_name_completion (file
, dirname
, 1, 1);
534 DEFUN ("file-version-limit", Ffile_version_limit
, Sfile_version_limit
, 1, 1, 0,
535 "Return the maximum number of versions allowed for FILE.\n\
536 Returns nil if the file cannot be opened or if there is no version limit.")
538 Lisp_Object filename
;
543 struct XABFHC xabfhc
;
546 filename
= Fexpand_file_name (filename
, Qnil
);
548 xabfhc
= cc$rms_xabfhc
;
549 fab
.fab$l_fna
= XSTRING (filename
)->data
;
550 fab
.fab$b_fns
= strlen (fab
.fab$l_fna
);
551 fab
.fab$l_xab
= (char *) &xabfhc
;
552 status
= sys$
open (&fab
, 0, 0);
553 if (status
!= RMS$_NORMAL
) /* Probably non-existent file */
555 sys$
close (&fab
, 0, 0);
556 if (xabfhc
.xab$w_verlimit
== 32767)
557 return Qnil
; /* No version limit */
559 return make_number (xabfhc
.xab$w_verlimit
);
568 return Fcons (make_number (time
>> 16),
569 Fcons (make_number (time
& 0177777), Qnil
));
572 DEFUN ("file-attributes", Ffile_attributes
, Sfile_attributes
, 1, 1, 0,
573 "Return a list of attributes of file FILENAME.\n\
574 Value is nil if specified file cannot be opened.\n\
575 Otherwise, list elements are:\n\
576 0. t for directory, string (name linked to) for symbolic link, or nil.\n\
577 1. Number of links to file.\n\
580 4. Last access time, as a list of two integers.\n\
581 First integer has high-order 16 bits of time, second has low 16 bits.\n\
582 5. Last modification time, likewise.\n\
583 6. Last status change time, likewise.\n\
584 7. Size in bytes (-1, if number is out of range).\n\
585 8. File modes, as a string of ten letters or dashes as in ls -l.\n\
586 9. t iff file's gid would change if file were deleted and recreated.\n\
588 11. Device number.\n\
590 If file does not exist, returns nil.")
592 Lisp_Object filename
;
594 Lisp_Object values
[12];
601 filename
= Fexpand_file_name (filename
, Qnil
);
603 /* If the file name has special constructs in it,
604 call the corresponding file handler. */
605 handler
= Ffind_file_name_handler (filename
, Qfile_attributes
);
607 return call2 (handler
, Qfile_attributes
, filename
);
609 if (lstat (XSTRING (filename
)->data
, &s
) < 0)
614 char *tmpnam
= XSTRING (Ffile_name_nondirectory (filename
))->data
;
615 int l
= strlen (tmpnam
);
618 && S_ISREG (s
.st_mode
)
619 && (stricmp (&tmpnam
[l
- 4], ".com") == 0
620 || stricmp (&tmpnam
[l
- 4], ".exe") == 0
621 || stricmp (&tmpnam
[l
- 4], ".bat") == 0))
623 s
.st_mode
|= S_IEXEC
;
628 switch (s
.st_mode
& S_IFMT
)
631 values
[0] = Qnil
; break;
633 values
[0] = Qt
; break;
636 values
[0] = Ffile_symlink_p (filename
); break;
639 values
[1] = make_number (s
.st_nlink
);
640 values
[2] = make_number (s
.st_uid
);
641 values
[3] = make_number (s
.st_gid
);
642 values
[4] = make_time (s
.st_atime
);
643 values
[5] = make_time (s
.st_mtime
);
644 values
[6] = make_time (s
.st_ctime
);
645 values
[7] = make_number ((int) s
.st_size
);
646 /* If the size is out of range, give back -1. */
647 if (XINT (values
[7]) != s
.st_size
)
648 XSETINT (values
[7], -1);
649 filemodestring (&s
, modes
);
650 values
[8] = make_string (modes
, 10);
651 #ifdef BSD4_3 /* Gross kludge to avoid lack of "#if defined(...)" in VMS */
652 #define BSD4_2 /* A new meaning to the term `backwards compatibility' */
654 #ifdef BSD4_2 /* file gid will be dir gid */
655 dirname
= Ffile_name_directory (filename
);
656 if (! NILP (dirname
) && stat (XSTRING (dirname
)->data
, &sdir
) == 0)
657 values
[9] = (sdir
.st_gid
!= s
.st_gid
) ? Qt
: Qnil
;
658 else /* if we can't tell, assume worst */
660 #else /* file gid will be egid */
662 values
[9] = Qnil
; /* sorry, no group IDs on NT */
663 #else /* not WINDOWSNT */
664 values
[9] = (s
.st_gid
!= getegid ()) ? Qt
: Qnil
;
665 #endif /* not WINDOWSNT */
666 #endif /* BSD4_2 (or BSD4_3) */
668 #undef BSD4_2 /* ok, you can look again without throwing up */
671 /* Fill in the inode and device values specially...see nt.c. */
672 if (!get_inode_and_device_vals (filename
, &values
[10], &values
[11])) {
675 #else /* not WINDOWSNT */
676 values
[10] = make_number (s
.st_ino
);
677 values
[11] = make_number (s
.st_dev
);
678 #endif /* not WINDOWSNT */
679 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
684 Qdirectory_files
= intern ("directory-files");
685 Qfile_name_completion
= intern ("file-name-completion");
686 Qfile_name_all_completions
= intern ("file-name-all-completions");
687 Qfile_attributes
= intern ("file-attributes");
689 defsubr (&Sdirectory_files
);
690 defsubr (&Sfile_name_completion
);
692 defsubr (&Sfile_name_all_versions
);
693 defsubr (&Sfile_version_limit
);
695 defsubr (&Sfile_name_all_completions
);
696 defsubr (&Sfile_attributes
);
699 Qcompletion_ignore_case
= intern ("completion-ignore-case");
700 staticpro (&Qcompletion_ignore_case
);
703 DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions
,
704 "*Completion ignores filenames ending in any string in this list.\n\
705 This variable does not affect lists of possible completions,\n\
706 but does affect the commands that actually do completions.");
707 Vcompletion_ignored_extensions
= Qnil
;