** overlay face property not used for after-string property
[emacs.git] / src / dired.c
blob1a80a41633d3d05ac007fd38ccb12f904d3350e7
1 /* Lisp functions for making directory listings.
2 Copyright (C) 1985, 1986, 1993, 1994, 1999, 2000, 2001, 2002, 2003,
3 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
23 #include <config.h>
25 #include <stdio.h>
26 #include <sys/types.h>
27 #include <sys/stat.h>
29 #ifdef HAVE_PWD_H
30 #include <pwd.h>
31 #endif
32 #ifndef VMS
33 #include <grp.h>
34 #endif
36 #include <errno.h>
38 #ifdef VMS
39 #include <string.h>
40 #include <rms.h>
41 #include <rmsdef.h>
42 #endif
44 #ifdef HAVE_UNISTD_H
45 #include <unistd.h>
46 #endif
48 /* The d_nameln member of a struct dirent includes the '\0' character
49 on some systems, but not on others. What's worse, you can't tell
50 at compile-time which one it will be, since it really depends on
51 the sort of system providing the filesystem you're reading from,
52 not the system you are running on. Paul Eggert
53 <eggert@bi.twinsun.com> says this occurs when Emacs is running on a
54 SunOS 4.1.2 host, reading a directory that is remote-mounted from a
55 Solaris 2.1 host and is in a native Solaris 2.1 filesystem.
57 Since applying strlen to the name always works, we'll just do that. */
58 #define NAMLEN(p) strlen (p->d_name)
60 #ifdef SYSV_SYSTEM_DIR
62 #include <dirent.h>
63 #define DIRENTRY struct dirent
65 #else /* not SYSV_SYSTEM_DIR */
67 #ifdef NONSYSTEM_DIR_LIBRARY
68 #include "ndir.h"
69 #else /* not NONSYSTEM_DIR_LIBRARY */
70 #ifdef MSDOS
71 #include <dirent.h>
72 #else
73 #include <sys/dir.h>
74 #endif
75 #endif /* not NONSYSTEM_DIR_LIBRARY */
77 #include <sys/stat.h>
79 #ifndef MSDOS
80 #define DIRENTRY struct direct
82 extern DIR *opendir ();
83 extern struct direct *readdir ();
85 #endif /* not MSDOS */
86 #endif /* not SYSV_SYSTEM_DIR */
88 /* Some versions of Cygwin don't have d_ino in `struct dirent'. */
89 #if defined(MSDOS) || defined(__CYGWIN__)
90 #define DIRENTRY_NONEMPTY(p) ((p)->d_name[0] != 0)
91 #else
92 #define DIRENTRY_NONEMPTY(p) ((p)->d_ino)
93 #endif
95 #include "lisp.h"
96 #include "systime.h"
97 #include "buffer.h"
98 #include "commands.h"
99 #include "charset.h"
100 #include "coding.h"
101 #include "regex.h"
102 #include "blockinput.h"
104 /* Returns a search buffer, with a fastmap allocated and ready to go. */
105 extern struct re_pattern_buffer *compile_pattern ();
107 /* From filemode.c. Can't go in Lisp.h because of `stat'. */
108 extern void filemodestring P_ ((struct stat *, char *));
110 /* if system does not have symbolic links, it does not have lstat.
111 In that case, use ordinary stat instead. */
113 #ifndef S_IFLNK
114 #define lstat stat
115 #endif
117 extern int completion_ignore_case;
118 extern Lisp_Object Qcompletion_ignore_case;
119 extern Lisp_Object Vcompletion_regexp_list;
121 Lisp_Object Vcompletion_ignored_extensions;
122 Lisp_Object Qdirectory_files;
123 Lisp_Object Qdirectory_files_and_attributes;
124 Lisp_Object Qfile_name_completion;
125 Lisp_Object Qfile_name_all_completions;
126 Lisp_Object Qfile_attributes;
127 Lisp_Object Qfile_attributes_lessp;
129 static int scmp P_ ((unsigned char *, unsigned char *, int));
132 Lisp_Object
133 directory_files_internal_unwind (dh)
134 Lisp_Object dh;
136 DIR *d = (DIR *) XSAVE_VALUE (dh)->pointer;
137 BLOCK_INPUT;
138 closedir (d);
139 UNBLOCK_INPUT;
140 return Qnil;
143 /* Function shared by Fdirectory_files and Fdirectory_files_and_attributes.
144 When ATTRS is zero, return a list of directory filenames; when
145 non-zero, return a list of directory filenames and their attributes.
146 In the latter case, ID_FORMAT is passed to Ffile_attributes. */
148 Lisp_Object
149 directory_files_internal (directory, full, match, nosort, attrs, id_format)
150 Lisp_Object directory, full, match, nosort;
151 int attrs;
152 Lisp_Object id_format;
154 DIR *d;
155 int directory_nbytes;
156 Lisp_Object list, dirfilename, encoded_directory;
157 struct re_pattern_buffer *bufp = NULL;
158 int needsep = 0;
159 int count = SPECPDL_INDEX ();
160 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
161 DIRENTRY *dp;
163 /* Because of file name handlers, these functions might call
164 Ffuncall, and cause a GC. */
165 list = encoded_directory = dirfilename = Qnil;
166 GCPRO5 (match, directory, list, dirfilename, encoded_directory);
167 dirfilename = Fdirectory_file_name (directory);
169 if (!NILP (match))
171 CHECK_STRING (match);
173 /* MATCH might be a flawed regular expression. Rather than
174 catching and signaling our own errors, we just call
175 compile_pattern to do the work for us. */
176 /* Pass 1 for the MULTIBYTE arg
177 because we do make multibyte strings if the contents warrant. */
178 #ifdef VMS
179 bufp = compile_pattern (match, 0,
180 buffer_defaults.downcase_table, 0, 1);
181 #else /* !VMS */
182 # ifdef WINDOWSNT
183 /* Windows users want case-insensitive wildcards. */
184 bufp = compile_pattern (match, 0,
185 buffer_defaults.case_canon_table, 0, 1);
186 # else /* !WINDOWSNT */
187 bufp = compile_pattern (match, 0, Qnil, 0, 1);
188 # endif /* !WINDOWSNT */
189 #endif /* !VMS */
192 /* Note: ENCODE_FILE and DECODE_FILE can GC because they can run
193 run_pre_post_conversion_on_str which calls Lisp directly and
194 indirectly. */
195 dirfilename = ENCODE_FILE (dirfilename);
196 encoded_directory = ENCODE_FILE (directory);
198 /* Now *bufp is the compiled form of MATCH; don't call anything
199 which might compile a new regexp until we're done with the loop! */
201 BLOCK_INPUT;
202 d = opendir (SDATA (dirfilename));
203 UNBLOCK_INPUT;
204 if (d == NULL)
205 report_file_error ("Opening directory", Fcons (directory, Qnil));
207 /* Unfortunately, we can now invoke expand-file-name and
208 file-attributes on filenames, both of which can throw, so we must
209 do a proper unwind-protect. */
210 record_unwind_protect (directory_files_internal_unwind,
211 make_save_value (d, 0));
213 directory_nbytes = SBYTES (directory);
214 re_match_object = Qt;
216 /* Decide whether we need to add a directory separator. */
217 #ifndef VMS
218 if (directory_nbytes == 0
219 || !IS_ANY_SEP (SREF (directory, directory_nbytes - 1)))
220 needsep = 1;
221 #endif /* not VMS */
223 /* Loop reading blocks until EOF or error. */
224 for (;;)
226 errno = 0;
227 dp = readdir (d);
229 if (dp == NULL && (0
230 #ifdef EAGAIN
231 || errno == EAGAIN
232 #endif
233 #ifdef EINTR
234 || errno == EINTR
235 #endif
237 { QUIT; continue; }
239 if (dp == NULL)
240 break;
242 if (DIRENTRY_NONEMPTY (dp))
244 int len;
245 int wanted = 0;
246 Lisp_Object name, finalname;
247 struct gcpro gcpro1, gcpro2;
249 len = NAMLEN (dp);
250 name = finalname = make_unibyte_string (dp->d_name, len);
251 GCPRO2 (finalname, name);
253 /* Note: ENCODE_FILE can GC; it should protect its argument,
254 though. */
255 name = DECODE_FILE (name);
256 len = SBYTES (name);
258 /* Now that we have unwind_protect in place, we might as well
259 allow matching to be interrupted. */
260 immediate_quit = 1;
261 QUIT;
263 if (NILP (match)
264 || (0 <= re_search (bufp, SDATA (name), len, 0, len, 0)))
265 wanted = 1;
267 immediate_quit = 0;
269 if (wanted)
271 if (!NILP (full))
273 Lisp_Object fullname;
274 int nbytes = len + directory_nbytes + needsep;
275 int nchars;
277 fullname = make_uninit_multibyte_string (nbytes, nbytes);
278 bcopy (SDATA (directory), SDATA (fullname),
279 directory_nbytes);
281 if (needsep)
282 SSET (fullname, directory_nbytes, DIRECTORY_SEP);
284 bcopy (SDATA (name),
285 SDATA (fullname) + directory_nbytes + needsep,
286 len);
288 nchars = chars_in_text (SDATA (fullname), nbytes);
290 /* Some bug somewhere. */
291 if (nchars > nbytes)
292 abort ();
294 STRING_SET_CHARS (fullname, nchars);
295 if (nchars == nbytes)
296 STRING_SET_UNIBYTE (fullname);
298 finalname = fullname;
300 else
301 finalname = name;
303 if (attrs)
305 /* Construct an expanded filename for the directory entry.
306 Use the decoded names for input to Ffile_attributes. */
307 Lisp_Object decoded_fullname, fileattrs;
308 struct gcpro gcpro1, gcpro2;
310 decoded_fullname = fileattrs = Qnil;
311 GCPRO2 (decoded_fullname, fileattrs);
313 /* Both Fexpand_file_name and Ffile_attributes can GC. */
314 decoded_fullname = Fexpand_file_name (name, directory);
315 fileattrs = Ffile_attributes (decoded_fullname, id_format);
317 list = Fcons (Fcons (finalname, fileattrs), list);
318 UNGCPRO;
320 else
321 list = Fcons (finalname, list);
324 UNGCPRO;
328 BLOCK_INPUT;
329 closedir (d);
330 UNBLOCK_INPUT;
332 /* Discard the unwind protect. */
333 specpdl_ptr = specpdl + count;
335 if (NILP (nosort))
336 list = Fsort (Fnreverse (list),
337 attrs ? Qfile_attributes_lessp : Qstring_lessp);
339 RETURN_UNGCPRO (list);
343 DEFUN ("directory-files", Fdirectory_files, Sdirectory_files, 1, 4, 0,
344 doc: /* Return a list of names of files in DIRECTORY.
345 There are three optional arguments:
346 If FULL is non-nil, return absolute file names. Otherwise return names
347 that are relative to the specified directory.
348 If MATCH is non-nil, mention only file names that match the regexp MATCH.
349 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
350 NOSORT is useful if you plan to sort the result yourself. */)
351 (directory, full, match, nosort)
352 Lisp_Object directory, full, match, nosort;
354 Lisp_Object handler;
355 directory = Fexpand_file_name (directory, Qnil);
357 /* If the file name has special constructs in it,
358 call the corresponding file handler. */
359 handler = Ffind_file_name_handler (directory, Qdirectory_files);
360 if (!NILP (handler))
361 return call5 (handler, Qdirectory_files, directory,
362 full, match, nosort);
364 return directory_files_internal (directory, full, match, nosort, 0, Qnil);
367 DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes,
368 Sdirectory_files_and_attributes, 1, 5, 0,
369 doc: /* Return a list of names of files and their attributes in DIRECTORY.
370 There are four optional arguments:
371 If FULL is non-nil, return absolute file names. Otherwise return names
372 that are relative to the specified directory.
373 If MATCH is non-nil, mention only file names that match the regexp MATCH.
374 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
375 NOSORT is useful if you plan to sort the result yourself.
376 ID-FORMAT specifies the preferred format of attributes uid and gid, see
377 `file-attributes' for further documentation. */)
378 (directory, full, match, nosort, id_format)
379 Lisp_Object directory, full, match, nosort, id_format;
381 Lisp_Object handler;
382 directory = Fexpand_file_name (directory, Qnil);
384 /* If the file name has special constructs in it,
385 call the corresponding file handler. */
386 handler = Ffind_file_name_handler (directory, Qdirectory_files_and_attributes);
387 if (!NILP (handler))
388 return call6 (handler, Qdirectory_files_and_attributes,
389 directory, full, match, nosort, id_format);
391 return directory_files_internal (directory, full, match, nosort, 1, id_format);
395 Lisp_Object file_name_completion ();
397 DEFUN ("file-name-completion", Ffile_name_completion, Sfile_name_completion,
398 2, 3, 0,
399 doc: /* Complete file name FILE in directory DIRECTORY.
400 Returns the longest string
401 common to all file names in DIRECTORY that start with FILE.
402 If there is only one and FILE matches it exactly, returns t.
403 Returns nil if DIRECTORY contains no name starting with FILE.
405 If PREDICATE is non-nil, call PREDICATE with each possible
406 completion (in absolute form) and ignore it if PREDICATE returns nil.
408 This function ignores some of the possible completions as
409 determined by the variable `completion-ignored-extensions', which see. */)
410 (file, directory, predicate)
411 Lisp_Object file, directory, predicate;
413 Lisp_Object handler;
415 /* If the directory name has special constructs in it,
416 call the corresponding file handler. */
417 handler = Ffind_file_name_handler (directory, Qfile_name_completion);
418 if (!NILP (handler))
419 return call4 (handler, Qfile_name_completion, file, directory, predicate);
421 /* If the file name has special constructs in it,
422 call the corresponding file handler. */
423 handler = Ffind_file_name_handler (file, Qfile_name_completion);
424 if (!NILP (handler))
425 return call4 (handler, Qfile_name_completion, file, directory, predicate);
427 return file_name_completion (file, directory, 0, 0, predicate);
430 DEFUN ("file-name-all-completions", Ffile_name_all_completions,
431 Sfile_name_all_completions, 2, 2, 0,
432 doc: /* Return a list of all completions of file name FILE in directory DIRECTORY.
433 These are all file names in directory DIRECTORY which begin with FILE. */)
434 (file, directory)
435 Lisp_Object file, directory;
437 Lisp_Object handler;
439 /* If the directory name has special constructs in it,
440 call the corresponding file handler. */
441 handler = Ffind_file_name_handler (directory, Qfile_name_all_completions);
442 if (!NILP (handler))
443 return call3 (handler, Qfile_name_all_completions, file, directory);
445 /* If the file name has special constructs in it,
446 call the corresponding file handler. */
447 handler = Ffind_file_name_handler (file, Qfile_name_all_completions);
448 if (!NILP (handler))
449 return call3 (handler, Qfile_name_all_completions, file, directory);
451 return file_name_completion (file, directory, 1, 0, Qnil);
454 static int file_name_completion_stat ();
456 Lisp_Object
457 file_name_completion (file, dirname, all_flag, ver_flag, predicate)
458 Lisp_Object file, dirname;
459 int all_flag, ver_flag;
460 Lisp_Object predicate;
462 DIR *d;
463 int bestmatchsize = 0, skip;
464 register int compare, matchsize;
465 unsigned char *p1, *p2;
466 int matchcount = 0;
467 /* If ALL_FLAG is 1, BESTMATCH is the list of all matches, decoded.
468 If ALL_FLAG is 0, BESTMATCH is either nil
469 or the best match so far, not decoded. */
470 Lisp_Object bestmatch, tem, elt, name;
471 Lisp_Object encoded_file;
472 Lisp_Object encoded_dir;
473 struct stat st;
474 int directoryp;
475 int passcount;
476 int count = SPECPDL_INDEX ();
477 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
479 elt = Qnil;
481 #ifdef VMS
482 extern DIRENTRY * readdirver ();
484 DIRENTRY *((* readfunc) ());
486 /* Filename completion on VMS ignores case, since VMS filesys does. */
487 specbind (Qcompletion_ignore_case, Qt);
489 readfunc = readdir;
490 if (ver_flag)
491 readfunc = readdirver;
492 file = Fupcase (file);
493 #else /* not VMS */
494 CHECK_STRING (file);
495 #endif /* not VMS */
497 #ifdef FILE_SYSTEM_CASE
498 file = FILE_SYSTEM_CASE (file);
499 #endif
500 bestmatch = Qnil;
501 encoded_file = encoded_dir = Qnil;
502 GCPRO5 (file, dirname, bestmatch, encoded_file, encoded_dir);
503 dirname = Fexpand_file_name (dirname, Qnil);
505 /* Do completion on the encoded file name
506 because the other names in the directory are (we presume)
507 encoded likewise. We decode the completed string at the end. */
508 encoded_file = ENCODE_FILE (file);
510 encoded_dir = ENCODE_FILE (dirname);
512 /* With passcount = 0, ignore files that end in an ignored extension.
513 If nothing found then try again with passcount = 1, don't ignore them.
514 If looking for all completions, start with passcount = 1,
515 so always take even the ignored ones.
517 ** It would not actually be helpful to the user to ignore any possible
518 completions when making a list of them.** */
520 for (passcount = !!all_flag; NILP (bestmatch) && passcount < 2; passcount++)
522 int inner_count = SPECPDL_INDEX ();
524 BLOCK_INPUT;
525 d = opendir (SDATA (Fdirectory_file_name (encoded_dir)));
526 UNBLOCK_INPUT;
527 if (!d)
528 report_file_error ("Opening directory", Fcons (dirname, Qnil));
530 record_unwind_protect (directory_files_internal_unwind,
531 make_save_value (d, 0));
533 /* Loop reading blocks */
534 /* (att3b compiler bug requires do a null comparison this way) */
535 while (1)
537 DIRENTRY *dp;
538 int len;
540 #ifdef VMS
541 dp = (*readfunc) (d);
542 #else
543 errno = 0;
544 dp = readdir (d);
545 if (dp == NULL && (0
546 # ifdef EAGAIN
547 || errno == EAGAIN
548 # endif
549 # ifdef EINTR
550 || errno == EINTR
551 # endif
553 { QUIT; continue; }
554 #endif
556 if (!dp) break;
558 len = NAMLEN (dp);
560 QUIT;
561 if (! DIRENTRY_NONEMPTY (dp)
562 || len < SCHARS (encoded_file)
563 || 0 <= scmp (dp->d_name, SDATA (encoded_file),
564 SCHARS (encoded_file)))
565 continue;
567 if (file_name_completion_stat (encoded_dir, dp, &st) < 0)
568 continue;
570 directoryp = ((st.st_mode & S_IFMT) == S_IFDIR);
571 tem = Qnil;
572 if (directoryp)
574 #ifndef TRIVIAL_DIRECTORY_ENTRY
575 #define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, ".."))
576 #endif
577 /* "." and ".." are never interesting as completions, and are
578 actually in the way in a directory with only one file. */
579 if (!passcount && TRIVIAL_DIRECTORY_ENTRY (dp->d_name))
580 continue;
581 if (!passcount && len > SCHARS (encoded_file))
582 /* Ignore directories if they match an element of
583 completion-ignored-extensions which ends in a slash. */
584 for (tem = Vcompletion_ignored_extensions;
585 CONSP (tem); tem = XCDR (tem))
587 int elt_len;
589 elt = XCAR (tem);
590 if (!STRINGP (elt))
591 continue;
592 /* Need to encode ELT, since scmp compares unibyte
593 strings only. */
594 elt = ENCODE_FILE (elt);
595 elt_len = SCHARS (elt) - 1; /* -1 for trailing / */
596 if (elt_len <= 0)
597 continue;
598 p1 = SDATA (elt);
599 if (p1[elt_len] != '/')
600 continue;
601 skip = len - elt_len;
602 if (skip < 0)
603 continue;
605 if (0 <= scmp (dp->d_name + skip, p1, elt_len))
606 continue;
607 break;
610 else
612 /* Compare extensions-to-be-ignored against end of this file name */
613 /* if name is not an exact match against specified string */
614 if (!passcount && len > SCHARS (encoded_file))
615 /* and exit this for loop if a match is found */
616 for (tem = Vcompletion_ignored_extensions;
617 CONSP (tem); tem = XCDR (tem))
619 elt = XCAR (tem);
620 if (!STRINGP (elt)) continue;
621 /* Need to encode ELT, since scmp compares unibyte
622 strings only. */
623 elt = ENCODE_FILE (elt);
624 skip = len - SCHARS (elt);
625 if (skip < 0) continue;
627 if (0 <= scmp (dp->d_name + skip,
628 SDATA (elt),
629 SCHARS (elt)))
630 continue;
631 break;
635 /* If an ignored-extensions match was found,
636 don't process this name as a completion. */
637 if (!passcount && CONSP (tem))
638 continue;
640 if (!passcount)
642 Lisp_Object regexps;
643 Lisp_Object zero;
644 XSETFASTINT (zero, 0);
646 /* Ignore this element if it fails to match all the regexps. */
647 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
648 regexps = XCDR (regexps))
650 tem = Fstring_match (XCAR (regexps),
651 make_string (dp->d_name, len), zero);
652 if (NILP (tem))
653 break;
655 if (CONSP (regexps))
656 continue;
659 /* This is a possible completion */
660 if (directoryp)
662 /* This completion is a directory; make it end with '/' */
663 name = Ffile_name_as_directory (make_string (dp->d_name, len));
665 else
666 name = make_string (dp->d_name, len);
668 /* Test the predicate, if any. */
670 if (!NILP (predicate))
672 Lisp_Object decoded;
673 Lisp_Object val;
674 struct gcpro gcpro1;
676 GCPRO1 (name);
677 decoded = Fexpand_file_name (DECODE_FILE (name), dirname);
678 val = call1 (predicate, decoded);
679 UNGCPRO;
681 if (NILP (val))
682 continue;
685 /* Suitably record this match. */
687 matchcount++;
689 if (all_flag)
691 name = DECODE_FILE (name);
692 bestmatch = Fcons (name, bestmatch);
694 else if (NILP (bestmatch))
696 bestmatch = name;
697 bestmatchsize = SCHARS (name);
699 else
701 compare = min (bestmatchsize, len);
702 p1 = SDATA (bestmatch);
703 p2 = (unsigned char *) dp->d_name;
704 matchsize = scmp (p1, p2, compare);
705 if (matchsize < 0)
706 matchsize = compare;
707 if (completion_ignore_case)
709 /* If this is an exact match except for case,
710 use it as the best match rather than one that is not
711 an exact match. This way, we get the case pattern
712 of the actual match. */
713 /* This tests that the current file is an exact match
714 but BESTMATCH is not (it is too long). */
715 if ((matchsize == len
716 && matchsize + !!directoryp
717 < SCHARS (bestmatch))
719 /* If there is no exact match ignoring case,
720 prefer a match that does not change the case
721 of the input. */
722 /* If there is more than one exact match aside from
723 case, and one of them is exact including case,
724 prefer that one. */
725 /* This == checks that, of current file and BESTMATCH,
726 either both or neither are exact. */
727 (((matchsize == len)
729 (matchsize + !!directoryp
730 == SCHARS (bestmatch)))
731 && !bcmp (p2, SDATA (encoded_file), SCHARS (encoded_file))
732 && bcmp (p1, SDATA (encoded_file), SCHARS (encoded_file))))
733 bestmatch = name;
736 /* If this dirname all matches, see if implicit following
737 slash does too. */
738 if (directoryp
739 && compare == matchsize
740 && bestmatchsize > matchsize
741 && IS_ANY_SEP (p1[matchsize]))
742 matchsize++;
743 bestmatchsize = matchsize;
746 /* This closes the directory. */
747 bestmatch = unbind_to (inner_count, bestmatch);
750 UNGCPRO;
751 bestmatch = unbind_to (count, bestmatch);
753 if (all_flag || NILP (bestmatch))
755 if (STRINGP (bestmatch))
756 bestmatch = DECODE_FILE (bestmatch);
757 return bestmatch;
759 if (matchcount == 1 && bestmatchsize == SCHARS (file))
760 return Qt;
761 bestmatch = Fsubstring (bestmatch, make_number (0),
762 make_number (bestmatchsize));
763 /* Now that we got the right initial segment of BESTMATCH,
764 decode it from the coding system in use. */
765 bestmatch = DECODE_FILE (bestmatch);
766 return bestmatch;
769 /* Compare exactly LEN chars of strings at S1 and S2,
770 ignoring case if appropriate.
771 Return -1 if strings match,
772 else number of chars that match at the beginning. */
774 static int
775 scmp (s1, s2, len)
776 register unsigned char *s1, *s2;
777 int len;
779 register int l = len;
781 if (completion_ignore_case)
783 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
784 l--;
786 else
788 while (l && *s1++ == *s2++)
789 l--;
791 if (l == 0)
792 return -1;
793 else
794 return len - l;
797 static int
798 file_name_completion_stat (dirname, dp, st_addr)
799 Lisp_Object dirname;
800 DIRENTRY *dp;
801 struct stat *st_addr;
803 int len = NAMLEN (dp);
804 int pos = SCHARS (dirname);
805 int value;
806 char *fullname = (char *) alloca (len + pos + 2);
808 #ifdef MSDOS
809 #if __DJGPP__ > 1
810 /* Some fields of struct stat are *very* expensive to compute on MS-DOS,
811 but aren't required here. Avoid computing the following fields:
812 st_inode, st_size and st_nlink for directories, and the execute bits
813 in st_mode for non-directory files with non-standard extensions. */
815 unsigned short save_djstat_flags = _djstat_flags;
817 _djstat_flags = _STAT_INODE | _STAT_EXEC_MAGIC | _STAT_DIRSIZE;
818 #endif /* __DJGPP__ > 1 */
819 #endif /* MSDOS */
821 bcopy (SDATA (dirname), fullname, pos);
822 #ifndef VMS
823 if (!IS_DIRECTORY_SEP (fullname[pos - 1]))
824 fullname[pos++] = DIRECTORY_SEP;
825 #endif
827 bcopy (dp->d_name, fullname + pos, len);
828 fullname[pos + len] = 0;
830 #ifdef S_IFLNK
831 /* We want to return success if a link points to a nonexistent file,
832 but we want to return the status for what the link points to,
833 in case it is a directory. */
834 value = lstat (fullname, st_addr);
835 stat (fullname, st_addr);
836 return value;
837 #else
838 value = stat (fullname, st_addr);
839 #ifdef MSDOS
840 #if __DJGPP__ > 1
841 _djstat_flags = save_djstat_flags;
842 #endif /* __DJGPP__ > 1 */
843 #endif /* MSDOS */
844 return value;
845 #endif /* S_IFLNK */
848 #ifdef VMS
850 DEFUN ("file-name-all-versions", Ffile_name_all_versions,
851 Sfile_name_all_versions, 2, 2, 0,
852 doc: /* Return a list of all versions of file name FILE in directory DIRECTORY. */)
853 (file, directory)
854 Lisp_Object file, directory;
856 return file_name_completion (file, directory, 1, 1, Qnil);
859 DEFUN ("file-version-limit", Ffile_version_limit, Sfile_version_limit, 1, 1, 0,
860 doc: /* Return the maximum number of versions allowed for FILE.
861 Returns nil if the file cannot be opened or if there is no version limit. */)
862 (filename)
863 Lisp_Object filename;
865 Lisp_Object retval;
866 struct FAB fab;
867 struct RAB rab;
868 struct XABFHC xabfhc;
869 int status;
871 filename = Fexpand_file_name (filename, Qnil);
872 fab = cc$rms_fab;
873 xabfhc = cc$rms_xabfhc;
874 fab.fab$l_fna = SDATA (filename);
875 fab.fab$b_fns = strlen (fab.fab$l_fna);
876 fab.fab$l_xab = (char *) &xabfhc;
877 status = sys$open (&fab, 0, 0);
878 if (status != RMS$_NORMAL) /* Probably non-existent file */
879 return Qnil;
880 sys$close (&fab, 0, 0);
881 if (xabfhc.xab$w_verlimit == 32767)
882 return Qnil; /* No version limit */
883 else
884 return make_number (xabfhc.xab$w_verlimit);
887 #endif /* VMS */
889 Lisp_Object
890 make_time (time)
891 time_t time;
893 return Fcons (make_number (time >> 16),
894 Fcons (make_number (time & 0177777), Qnil));
897 DEFUN ("file-attributes", Ffile_attributes, Sfile_attributes, 1, 2, 0,
898 doc: /* Return a list of attributes of file FILENAME.
899 Value is nil if specified file cannot be opened.
901 ID-FORMAT specifies the preferred format of attributes uid and gid (see
902 below) - valid values are 'string and 'integer. The latter is the default,
903 but we plan to change that, so you should specify a non-nil value for
904 ID-FORMAT if you use the returned uid or gid.
906 Elements of the attribute list are:
907 0. t for directory, string (name linked to) for symbolic link, or nil.
908 1. Number of links to file.
909 2. File uid as a string or an integer. If a string value cannot be
910 looked up, the integer value is returned.
911 3. File gid, likewise.
912 4. Last access time, as a list of two integers.
913 First integer has high-order 16 bits of time, second has low 16 bits.
914 5. Last modification time, likewise.
915 6. Last status change time, likewise.
916 7. Size in bytes.
917 This is a floating point number if the size is too large for an integer.
918 8. File modes, as a string of ten letters or dashes as in ls -l.
919 9. t if file's gid would change if file were deleted and recreated.
920 10. inode number. If inode number is larger than the Emacs integer,
921 this is a cons cell containing two integers: first the high part,
922 then the low 16 bits.
923 11. Device number. If it is larger than the Emacs integer, this is
924 a cons cell, similar to the inode number. */)
925 (filename, id_format)
926 Lisp_Object filename, id_format;
928 Lisp_Object values[12];
929 Lisp_Object encoded;
930 struct stat s;
931 struct passwd *pw;
932 struct group *gr;
933 #if defined (BSD4_2) || defined (BSD4_3)
934 Lisp_Object dirname;
935 struct stat sdir;
936 #endif
937 char modes[10];
938 Lisp_Object handler;
939 struct gcpro gcpro1;
940 EMACS_INT uid, gid, ino;
942 filename = Fexpand_file_name (filename, Qnil);
944 /* If the file name has special constructs in it,
945 call the corresponding file handler. */
946 handler = Ffind_file_name_handler (filename, Qfile_attributes);
947 if (!NILP (handler))
948 { /* Only pass the extra arg if it is used to help backward compatibility
949 with old file handlers which do not implement the new arg. --Stef */
950 if (NILP (id_format))
951 return call2 (handler, Qfile_attributes, filename);
952 else
953 return call3 (handler, Qfile_attributes, filename, id_format);
956 GCPRO1 (filename);
957 encoded = ENCODE_FILE (filename);
958 UNGCPRO;
960 if (lstat (SDATA (encoded), &s) < 0)
961 return Qnil;
963 switch (s.st_mode & S_IFMT)
965 default:
966 values[0] = Qnil; break;
967 case S_IFDIR:
968 values[0] = Qt; break;
969 #ifdef S_IFLNK
970 case S_IFLNK:
971 values[0] = Ffile_symlink_p (filename); break;
972 #endif
974 values[1] = make_number (s.st_nlink);
975 /* When make_fixnum_or_float is called below with types that are
976 shorter than an int (e.g., `short'), GCC whines about comparison
977 being always false due to limited range of data type. Fix by
978 copying s.st_uid and s.st_gid into int variables. */
979 #ifdef WINDOWSNT
980 /* Windows uses signed short for the uid and gid in the stat structure,
981 but we use an int for getuid (limited to the range 0-60000).
982 So users with uid > 32767 need their uid patched back here. */
983 uid = (unsigned short) s.st_uid;
984 gid = (unsigned short) s.st_gid;
985 #else
986 uid = s.st_uid;
987 gid = s.st_gid;
988 #endif
989 if (NILP (id_format) || EQ (id_format, Qinteger))
991 values[2] = make_fixnum_or_float (uid);
992 values[3] = make_fixnum_or_float (gid);
994 else
996 BLOCK_INPUT;
997 pw = (struct passwd *) getpwuid (uid);
998 values[2] = (pw ? build_string (pw->pw_name)
999 : make_fixnum_or_float (uid));
1000 gr = (struct group *) getgrgid (gid);
1001 values[3] = (gr ? build_string (gr->gr_name)
1002 : make_fixnum_or_float (gid));
1003 UNBLOCK_INPUT;
1005 values[4] = make_time (s.st_atime);
1006 values[5] = make_time (s.st_mtime);
1007 values[6] = make_time (s.st_ctime);
1008 values[7] = make_number (s.st_size);
1009 /* If the size is out of range for an integer, return a float. */
1010 if (XINT (values[7]) != s.st_size)
1011 values[7] = make_float ((double)s.st_size);
1012 /* If the size is negative, and its type is long, convert it back to
1013 positive. */
1014 if (s.st_size < 0 && sizeof (s.st_size) == sizeof (long))
1015 values[7] = make_float ((double) ((unsigned long) s.st_size));
1017 filemodestring (&s, modes);
1018 values[8] = make_string (modes, 10);
1019 #if defined (BSD4_2) || defined (BSD4_3) /* file gid will be dir gid */
1020 dirname = Ffile_name_directory (filename);
1021 if (! NILP (dirname))
1022 encoded = ENCODE_FILE (dirname);
1023 if (! NILP (dirname) && stat (SDATA (encoded), &sdir) == 0)
1024 values[9] = (sdir.st_gid != gid) ? Qt : Qnil;
1025 else /* if we can't tell, assume worst */
1026 values[9] = Qt;
1027 #else /* file gid will be egid */
1028 values[9] = (gid != getegid ()) ? Qt : Qnil;
1029 #endif /* BSD4_2 (or BSD4_3) */
1030 /* Shut up GCC warnings in FIXNUM_OVERFLOW_P below. */
1031 ino = s.st_ino;
1032 if (FIXNUM_OVERFLOW_P (ino))
1033 /* To allow inode numbers larger than VALBITS, separate the bottom
1034 16 bits. */
1035 values[10] = Fcons (make_number (ino >> 16),
1036 make_number (ino & 0xffff));
1037 else
1038 /* But keep the most common cases as integers. */
1039 values[10] = make_number (ino);
1041 /* Likewise for device. */
1042 if (FIXNUM_OVERFLOW_P (s.st_dev))
1043 values[11] = Fcons (make_number (s.st_dev >> 16),
1044 make_number (s.st_dev & 0xffff));
1045 else
1046 values[11] = make_number (s.st_dev);
1048 return Flist (sizeof(values) / sizeof(values[0]), values);
1051 DEFUN ("file-attributes-lessp", Ffile_attributes_lessp, Sfile_attributes_lessp, 2, 2, 0,
1052 doc: /* Return t if first arg file attributes list is less than second.
1053 Comparison is in lexicographic order and case is significant. */)
1054 (f1, f2)
1055 Lisp_Object f1, f2;
1057 return Fstring_lessp (Fcar (f1), Fcar (f2));
1060 void
1061 syms_of_dired ()
1063 Qdirectory_files = intern ("directory-files");
1064 Qdirectory_files_and_attributes = intern ("directory-files-and-attributes");
1065 Qfile_name_completion = intern ("file-name-completion");
1066 Qfile_name_all_completions = intern ("file-name-all-completions");
1067 Qfile_attributes = intern ("file-attributes");
1068 Qfile_attributes_lessp = intern ("file-attributes-lessp");
1070 staticpro (&Qdirectory_files);
1071 staticpro (&Qdirectory_files_and_attributes);
1072 staticpro (&Qfile_name_completion);
1073 staticpro (&Qfile_name_all_completions);
1074 staticpro (&Qfile_attributes);
1075 staticpro (&Qfile_attributes_lessp);
1077 defsubr (&Sdirectory_files);
1078 defsubr (&Sdirectory_files_and_attributes);
1079 defsubr (&Sfile_name_completion);
1080 #ifdef VMS
1081 defsubr (&Sfile_name_all_versions);
1082 defsubr (&Sfile_version_limit);
1083 #endif /* VMS */
1084 defsubr (&Sfile_name_all_completions);
1085 defsubr (&Sfile_attributes);
1086 defsubr (&Sfile_attributes_lessp);
1088 DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions,
1089 doc: /* Completion ignores file names ending in any string in this list.
1090 It does not ignore them if all possible completions end in one of
1091 these strings or when displaying a list of completions.
1092 It ignores directory names if they match any string in this list which
1093 ends in a slash. */);
1094 Vcompletion_ignored_extensions = Qnil;
1097 /* arch-tag: 1ac8deca-4d8f-4d41-ade9-089154d98c03
1098 (do not change this comment) */