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, 2009 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 of the License, or
10 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
38 /* The d_nameln member of a struct dirent includes the '\0' character
39 on some systems, but not on others. What's worse, you can't tell
40 at compile-time which one it will be, since it really depends on
41 the sort of system providing the filesystem you're reading from,
42 not the system you are running on. Paul Eggert
43 <eggert@bi.twinsun.com> says this occurs when Emacs is running on a
44 SunOS 4.1.2 host, reading a directory that is remote-mounted from a
45 Solaris 2.1 host and is in a native Solaris 2.1 filesystem.
47 Since applying strlen to the name always works, we'll just do that. */
48 #define NAMLEN(p) strlen (p->d_name)
50 #ifdef SYSV_SYSTEM_DIR
53 #define DIRENTRY struct dirent
55 #else /* not SYSV_SYSTEM_DIR */
66 #define DIRENTRY struct direct
68 extern DIR *opendir ();
69 extern struct direct
*readdir ();
71 #endif /* not MSDOS */
72 #endif /* not SYSV_SYSTEM_DIR */
74 /* Some versions of Cygwin don't have d_ino in `struct dirent'. */
75 #if defined(MSDOS) || defined(__CYGWIN__)
76 #define DIRENTRY_NONEMPTY(p) ((p)->d_name[0] != 0)
78 #define DIRENTRY_NONEMPTY(p) ((p)->d_ino)
85 #include "character.h"
89 #include "blockinput.h"
91 /* Returns a search buffer, with a fastmap allocated and ready to go. */
92 extern struct re_pattern_buffer
*compile_pattern ();
94 /* From filemode.c. Can't go in Lisp.h because of `stat'. */
95 extern void filemodestring
P_ ((struct stat
*, char *));
97 /* if system does not have symbolic links, it does not have lstat.
98 In that case, use ordinary stat instead. */
104 extern int completion_ignore_case
;
105 extern Lisp_Object Qcompletion_ignore_case
;
106 extern Lisp_Object Vcompletion_regexp_list
;
108 Lisp_Object Vcompletion_ignored_extensions
;
109 Lisp_Object Qdirectory_files
;
110 Lisp_Object Qdirectory_files_and_attributes
;
111 Lisp_Object Qfile_name_completion
;
112 Lisp_Object Qfile_name_all_completions
;
113 Lisp_Object Qfile_attributes
;
114 Lisp_Object Qfile_attributes_lessp
;
116 static int scmp
P_ ((unsigned char *, unsigned char *, int));
120 directory_files_internal_unwind (dh
)
123 DIR *d
= (DIR *) XSAVE_VALUE (dh
)->pointer
;
130 /* Function shared by Fdirectory_files and Fdirectory_files_and_attributes.
131 When ATTRS is zero, return a list of directory filenames; when
132 non-zero, return a list of directory filenames and their attributes.
133 In the latter case, ID_FORMAT is passed to Ffile_attributes. */
136 directory_files_internal (directory
, full
, match
, nosort
, attrs
, id_format
)
137 Lisp_Object directory
, full
, match
, nosort
;
139 Lisp_Object id_format
;
142 int directory_nbytes
;
143 Lisp_Object list
, dirfilename
, encoded_directory
;
144 struct re_pattern_buffer
*bufp
= NULL
;
146 int count
= SPECPDL_INDEX ();
147 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
150 /* Because of file name handlers, these functions might call
151 Ffuncall, and cause a GC. */
152 list
= encoded_directory
= dirfilename
= Qnil
;
153 GCPRO5 (match
, directory
, list
, dirfilename
, encoded_directory
);
154 dirfilename
= Fdirectory_file_name (directory
);
158 CHECK_STRING (match
);
160 /* MATCH might be a flawed regular expression. Rather than
161 catching and signaling our own errors, we just call
162 compile_pattern to do the work for us. */
163 /* Pass 1 for the MULTIBYTE arg
164 because we do make multibyte strings if the contents warrant. */
166 /* Windows users want case-insensitive wildcards. */
167 bufp
= compile_pattern (match
, 0,
168 buffer_defaults
.case_canon_table
, 0, 1);
169 # else /* !WINDOWSNT */
170 bufp
= compile_pattern (match
, 0, Qnil
, 0, 1);
171 # endif /* !WINDOWSNT */
174 /* Note: ENCODE_FILE and DECODE_FILE can GC because they can run
175 run_pre_post_conversion_on_str which calls Lisp directly and
177 if (STRING_MULTIBYTE (dirfilename
))
178 dirfilename
= ENCODE_FILE (dirfilename
);
179 encoded_directory
= (STRING_MULTIBYTE (directory
)
180 ? ENCODE_FILE (directory
) : directory
);
182 /* Now *bufp is the compiled form of MATCH; don't call anything
183 which might compile a new regexp until we're done with the loop! */
186 d
= opendir (SDATA (dirfilename
));
189 report_file_error ("Opening directory", Fcons (directory
, Qnil
));
191 /* Unfortunately, we can now invoke expand-file-name and
192 file-attributes on filenames, both of which can throw, so we must
193 do a proper unwind-protect. */
194 record_unwind_protect (directory_files_internal_unwind
,
195 make_save_value (d
, 0));
197 directory_nbytes
= SBYTES (directory
);
198 re_match_object
= Qt
;
200 /* Decide whether we need to add a directory separator. */
201 if (directory_nbytes
== 0
202 || !IS_ANY_SEP (SREF (directory
, directory_nbytes
- 1)))
205 /* Loop reading blocks until EOF or error. */
224 if (DIRENTRY_NONEMPTY (dp
))
228 Lisp_Object name
, finalname
;
229 struct gcpro gcpro1
, gcpro2
;
232 name
= finalname
= make_unibyte_string (dp
->d_name
, len
);
233 GCPRO2 (finalname
, name
);
235 /* Note: DECODE_FILE can GC; it should protect its argument,
237 name
= DECODE_FILE (name
);
240 /* Now that we have unwind_protect in place, we might as well
241 allow matching to be interrupted. */
246 || (0 <= re_search (bufp
, SDATA (name
), len
, 0, len
, 0)))
255 Lisp_Object fullname
;
256 int nbytes
= len
+ directory_nbytes
+ needsep
;
259 fullname
= make_uninit_multibyte_string (nbytes
, nbytes
);
260 bcopy (SDATA (directory
), SDATA (fullname
),
264 SSET (fullname
, directory_nbytes
, DIRECTORY_SEP
);
267 SDATA (fullname
) + directory_nbytes
+ needsep
,
270 nchars
= chars_in_text (SDATA (fullname
), nbytes
);
272 /* Some bug somewhere. */
276 STRING_SET_CHARS (fullname
, nchars
);
277 if (nchars
== nbytes
)
278 STRING_SET_UNIBYTE (fullname
);
280 finalname
= fullname
;
287 /* Construct an expanded filename for the directory entry.
288 Use the decoded names for input to Ffile_attributes. */
289 Lisp_Object decoded_fullname
, fileattrs
;
290 struct gcpro gcpro1
, gcpro2
;
292 decoded_fullname
= fileattrs
= Qnil
;
293 GCPRO2 (decoded_fullname
, fileattrs
);
295 /* Both Fexpand_file_name and Ffile_attributes can GC. */
296 decoded_fullname
= Fexpand_file_name (name
, directory
);
297 fileattrs
= Ffile_attributes (decoded_fullname
, id_format
);
299 list
= Fcons (Fcons (finalname
, fileattrs
), list
);
303 list
= Fcons (finalname
, list
);
314 /* Discard the unwind protect. */
315 specpdl_ptr
= specpdl
+ count
;
318 list
= Fsort (Fnreverse (list
),
319 attrs
? Qfile_attributes_lessp
: Qstring_lessp
);
321 RETURN_UNGCPRO (list
);
325 DEFUN ("directory-files", Fdirectory_files
, Sdirectory_files
, 1, 4, 0,
326 doc
: /* Return a list of names of files in DIRECTORY.
327 There are three optional arguments:
328 If FULL is non-nil, return absolute file names. Otherwise return names
329 that are relative to the specified directory.
330 If MATCH is non-nil, mention only file names that match the regexp MATCH.
331 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
332 Otherwise, the list returned is sorted with `stringp-lessp'.
333 NOSORT is useful if you plan to sort the result yourself. */)
334 (directory
, full
, match
, nosort
)
335 Lisp_Object directory
, full
, match
, nosort
;
338 directory
= Fexpand_file_name (directory
, Qnil
);
340 /* If the file name has special constructs in it,
341 call the corresponding file handler. */
342 handler
= Ffind_file_name_handler (directory
, Qdirectory_files
);
344 return call5 (handler
, Qdirectory_files
, directory
,
345 full
, match
, nosort
);
347 return directory_files_internal (directory
, full
, match
, nosort
, 0, Qnil
);
350 DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes
,
351 Sdirectory_files_and_attributes
, 1, 5, 0,
352 doc
: /* Return a list of names of files and their attributes in DIRECTORY.
353 There are four optional arguments:
354 If FULL is non-nil, return absolute file names. Otherwise return names
355 that are relative to the specified directory.
356 If MATCH is non-nil, mention only file names that match the regexp MATCH.
357 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
358 NOSORT is useful if you plan to sort the result yourself.
359 ID-FORMAT specifies the preferred format of attributes uid and gid, see
360 `file-attributes' for further documentation.
361 On MS-Windows, performance depends on `w32-get-true-file-attributes',
363 (directory
, full
, match
, nosort
, id_format
)
364 Lisp_Object directory
, full
, match
, nosort
, id_format
;
367 directory
= Fexpand_file_name (directory
, Qnil
);
369 /* If the file name has special constructs in it,
370 call the corresponding file handler. */
371 handler
= Ffind_file_name_handler (directory
, Qdirectory_files_and_attributes
);
373 return call6 (handler
, Qdirectory_files_and_attributes
,
374 directory
, full
, match
, nosort
, id_format
);
376 return directory_files_internal (directory
, full
, match
, nosort
, 1, id_format
);
380 Lisp_Object
file_name_completion ();
382 DEFUN ("file-name-completion", Ffile_name_completion
, Sfile_name_completion
,
384 doc
: /* Complete file name FILE in directory DIRECTORY.
385 Returns the longest string
386 common to all file names in DIRECTORY that start with FILE.
387 If there is only one and FILE matches it exactly, returns t.
388 Returns nil if DIRECTORY contains no name starting with FILE.
390 If PREDICATE is non-nil, call PREDICATE with each possible
391 completion (in absolute form) and ignore it if PREDICATE returns nil.
393 This function ignores some of the possible completions as
394 determined by the variable `completion-ignored-extensions', which see. */)
395 (file
, directory
, predicate
)
396 Lisp_Object file
, directory
, predicate
;
400 /* If the directory name has special constructs in it,
401 call the corresponding file handler. */
402 handler
= Ffind_file_name_handler (directory
, Qfile_name_completion
);
404 return call4 (handler
, Qfile_name_completion
, file
, directory
, predicate
);
406 /* If the file name has special constructs in it,
407 call the corresponding file handler. */
408 handler
= Ffind_file_name_handler (file
, Qfile_name_completion
);
410 return call4 (handler
, Qfile_name_completion
, file
, directory
, predicate
);
412 return file_name_completion (file
, directory
, 0, 0, predicate
);
415 DEFUN ("file-name-all-completions", Ffile_name_all_completions
,
416 Sfile_name_all_completions
, 2, 2, 0,
417 doc
: /* Return a list of all completions of file name FILE in directory DIRECTORY.
418 These are all file names in directory DIRECTORY which begin with FILE. */)
420 Lisp_Object file
, directory
;
424 /* If the directory name has special constructs in it,
425 call the corresponding file handler. */
426 handler
= Ffind_file_name_handler (directory
, Qfile_name_all_completions
);
428 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
430 /* If the file name has special constructs in it,
431 call the corresponding file handler. */
432 handler
= Ffind_file_name_handler (file
, Qfile_name_all_completions
);
434 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
436 return file_name_completion (file
, directory
, 1, 0, Qnil
);
439 static int file_name_completion_stat ();
440 Lisp_Object Qdefault_directory
;
443 file_name_completion (file
, dirname
, all_flag
, ver_flag
, predicate
)
444 Lisp_Object file
, dirname
;
445 int all_flag
, ver_flag
;
446 Lisp_Object predicate
;
449 int bestmatchsize
= 0;
451 /* If ALL_FLAG is 1, BESTMATCH is the list of all matches, decoded.
452 If ALL_FLAG is 0, BESTMATCH is either nil
453 or the best match so far, not decoded. */
454 Lisp_Object bestmatch
, tem
, elt
, name
;
455 Lisp_Object encoded_file
;
456 Lisp_Object encoded_dir
;
459 /* If includeall is zero, exclude files in completion-ignored-extensions as
460 well as "." and "..". Until shown otherwise, assume we can't exclude
463 int count
= SPECPDL_INDEX ();
464 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
470 #ifdef FILE_SYSTEM_CASE
471 file
= FILE_SYSTEM_CASE (file
);
474 encoded_file
= encoded_dir
= Qnil
;
475 GCPRO5 (file
, dirname
, bestmatch
, encoded_file
, encoded_dir
);
476 dirname
= Fexpand_file_name (dirname
, Qnil
);
477 specbind (Qdefault_directory
, dirname
);
479 /* Do completion on the encoded file name
480 because the other names in the directory are (we presume)
481 encoded likewise. We decode the completed string at the end. */
482 /* Actually, this is not quite true any more: we do most of the completion
483 work with decoded file names, but we still do some filtering based
484 on the encoded file name. */
485 encoded_file
= STRING_MULTIBYTE (file
) ? ENCODE_FILE (file
) : file
;
487 encoded_dir
= ENCODE_FILE (dirname
);
490 d
= opendir (SDATA (Fdirectory_file_name (encoded_dir
)));
493 report_file_error ("Opening directory", Fcons (dirname
, Qnil
));
495 record_unwind_protect (directory_files_internal_unwind
,
496 make_save_value (d
, 0));
498 /* Loop reading blocks */
499 /* (att3b compiler bug requires do a null comparison this way) */
523 if (! DIRENTRY_NONEMPTY (dp
)
524 || len
< SCHARS (encoded_file
)
525 || 0 <= scmp (dp
->d_name
, SDATA (encoded_file
),
526 SCHARS (encoded_file
)))
529 if (file_name_completion_stat (encoded_dir
, dp
, &st
) < 0)
532 directoryp
= ((st
.st_mode
& S_IFMT
) == S_IFDIR
);
534 /* If all_flag is set, always include all.
535 It would not actually be helpful to the user to ignore any possible
536 completions when making a list of them. */
541 /* If this entry matches the current bestmatch, the only
542 thing it can do is increase matchcount, so don't bother
543 investigating it any further. */
544 if (!completion_ignore_case
545 /* The return result depends on whether it's the sole match. */
547 && !includeall
/* This match may allow includeall to 0. */
548 && len
>= bestmatchsize
549 && 0 > scmp (dp
->d_name
, SDATA (bestmatch
), bestmatchsize
))
554 #ifndef TRIVIAL_DIRECTORY_ENTRY
555 #define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, ".."))
557 /* "." and ".." are never interesting as completions, and are
558 actually in the way in a directory with only one file. */
559 if (TRIVIAL_DIRECTORY_ENTRY (dp
->d_name
))
561 else if (len
> SCHARS (encoded_file
))
562 /* Ignore directories if they match an element of
563 completion-ignored-extensions which ends in a slash. */
564 for (tem
= Vcompletion_ignored_extensions
;
565 CONSP (tem
); tem
= XCDR (tem
))
573 /* Need to encode ELT, since scmp compares unibyte
575 elt
= ENCODE_FILE (elt
);
576 elt_len
= SCHARS (elt
) - 1; /* -1 for trailing / */
580 if (p1
[elt_len
] != '/')
582 skip
= len
- elt_len
;
586 if (0 <= scmp (dp
->d_name
+ skip
, p1
, elt_len
))
593 /* Compare extensions-to-be-ignored against end of this file name */
594 /* if name is not an exact match against specified string */
595 if (len
> SCHARS (encoded_file
))
596 /* and exit this for loop if a match is found */
597 for (tem
= Vcompletion_ignored_extensions
;
598 CONSP (tem
); tem
= XCDR (tem
))
601 if (!STRINGP (elt
)) continue;
602 /* Need to encode ELT, since scmp compares unibyte
604 elt
= ENCODE_FILE (elt
);
605 skip
= len
- SCHARS (elt
);
606 if (skip
< 0) continue;
608 if (0 <= scmp (dp
->d_name
+ skip
,
616 /* If an ignored-extensions match was found,
617 don't process this name as a completion. */
621 if (!includeall
&& canexclude
)
622 /* We're not including all files and this file can be excluded. */
625 if (includeall
&& !canexclude
)
626 { /* If we have one non-excludable file, we want to exclude the
629 /* Throw away any previous excludable match found. */
635 /* FIXME: If we move this `decode' earlier we can eliminate
636 the repeated ENCODE_FILE on Vcompletion_ignored_extensions. */
637 name
= make_unibyte_string (dp
->d_name
, len
);
638 name
= DECODE_FILE (name
);
643 XSETFASTINT (zero
, 0);
645 /* Ignore this element if it fails to match all the regexps. */
646 if (completion_ignore_case
)
648 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
649 regexps
= XCDR (regexps
))
650 if (fast_string_match_ignore_case (XCAR (regexps
), name
) < 0)
655 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
656 regexps
= XCDR (regexps
))
657 if (fast_string_match (XCAR (regexps
), name
) < 0)
665 /* This is a possible completion */
667 /* This completion is a directory; make it end with '/'. */
668 name
= Ffile_name_as_directory (name
);
670 /* Test the predicate, if any. */
671 if (!NILP (predicate
))
677 val
= call1 (predicate
, name
);
684 /* Suitably record this match. */
689 bestmatch
= Fcons (name
, bestmatch
);
690 else if (NILP (bestmatch
))
693 bestmatchsize
= SCHARS (name
);
697 Lisp_Object zero
= make_number (0);
698 /* FIXME: This is a copy of the code in Ftry_completion. */
699 int compare
= min (bestmatchsize
, SCHARS (name
));
701 = Fcompare_strings (bestmatch
, zero
,
702 make_number (compare
),
704 make_number (compare
),
705 completion_ignore_case
? Qt
: Qnil
);
707 = (EQ (tem
, Qt
) ? compare
708 : XINT (tem
) < 0 ? - XINT (tem
) - 1
711 if (completion_ignore_case
)
713 /* If this is an exact match except for case,
714 use it as the best match rather than one that is not
715 an exact match. This way, we get the case pattern
716 of the actual match. */
717 /* This tests that the current file is an exact match
718 but BESTMATCH is not (it is too long). */
719 if ((matchsize
== SCHARS (name
)
720 && matchsize
+ !!directoryp
< SCHARS (bestmatch
))
722 /* If there is no exact match ignoring case,
723 prefer a match that does not change the case
725 /* If there is more than one exact match aside from
726 case, and one of them is exact including case,
728 /* This == checks that, of current file and BESTMATCH,
729 either both or neither are exact. */
730 (((matchsize
== SCHARS (name
))
732 (matchsize
+ !!directoryp
== SCHARS (bestmatch
)))
733 && (tem
= Fcompare_strings (name
, zero
,
734 make_number (SCHARS (file
)),
739 && (tem
= Fcompare_strings (bestmatch
, zero
,
740 make_number (SCHARS (file
)),
747 bestmatchsize
= matchsize
;
749 /* If the best completion so far is reduced to the string
750 we're trying to complete, then we already know there's no
751 other completion, so there's no point looking any further. */
752 if (matchsize
<= SCHARS (file
)
753 && !includeall
/* A future match may allow includeall to 0. */
754 /* If completion-ignore-case is non-nil, don't
755 short-circuit because we want to find the best
756 possible match *including* case differences. */
757 && (!completion_ignore_case
|| matchsize
== 0)
758 /* The return value depends on whether it's the sole match. */
766 /* This closes the directory. */
767 bestmatch
= unbind_to (count
, bestmatch
);
769 if (all_flag
|| NILP (bestmatch
))
771 /* Return t if the supplied string is an exact match (counting case);
772 it does not require any change to be made. */
773 if (matchcount
== 1 && !NILP (Fequal (bestmatch
, file
)))
775 bestmatch
= Fsubstring (bestmatch
, make_number (0),
776 make_number (bestmatchsize
));
780 /* Compare exactly LEN chars of strings at S1 and S2,
781 ignoring case if appropriate.
782 Return -1 if strings match,
783 else number of chars that match at the beginning. */
787 register unsigned char *s1
, *s2
;
790 register int l
= len
;
792 if (completion_ignore_case
)
794 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
799 while (l
&& *s1
++ == *s2
++)
809 file_name_completion_stat (dirname
, dp
, st_addr
)
812 struct stat
*st_addr
;
814 int len
= NAMLEN (dp
);
815 int pos
= SCHARS (dirname
);
817 char *fullname
= (char *) alloca (len
+ pos
+ 2);
821 /* Some fields of struct stat are *very* expensive to compute on MS-DOS,
822 but aren't required here. Avoid computing the following fields:
823 st_inode, st_size and st_nlink for directories, and the execute bits
824 in st_mode for non-directory files with non-standard extensions. */
826 unsigned short save_djstat_flags
= _djstat_flags
;
828 _djstat_flags
= _STAT_INODE
| _STAT_EXEC_MAGIC
| _STAT_DIRSIZE
;
829 #endif /* __DJGPP__ > 1 */
832 bcopy (SDATA (dirname
), fullname
, pos
);
833 if (!IS_DIRECTORY_SEP (fullname
[pos
- 1]))
834 fullname
[pos
++] = DIRECTORY_SEP
;
836 bcopy (dp
->d_name
, fullname
+ pos
, len
);
837 fullname
[pos
+ len
] = 0;
840 /* We want to return success if a link points to a nonexistent file,
841 but we want to return the status for what the link points to,
842 in case it is a directory. */
843 value
= lstat (fullname
, st_addr
);
844 stat (fullname
, st_addr
);
847 value
= stat (fullname
, st_addr
);
850 _djstat_flags
= save_djstat_flags
;
851 #endif /* __DJGPP__ > 1 */
861 return Fcons (make_number (time
>> 16),
862 Fcons (make_number (time
& 0177777), Qnil
));
866 stat_uname (struct stat
*st
)
871 struct passwd
*pw
= (struct passwd
*) getpwuid (st
->st_uid
);
881 stat_gname (struct stat
*st
)
886 struct group
*gr
= (struct group
*) getgrgid (st
->st_gid
);
895 DEFUN ("file-attributes", Ffile_attributes
, Sfile_attributes
, 1, 2, 0,
896 doc
: /* Return a list of attributes of file FILENAME.
897 Value is nil if specified file cannot be opened.
899 ID-FORMAT specifies the preferred format of attributes uid and gid (see
900 below) - valid values are 'string and 'integer. The latter is the default,
901 but we plan to change that, so you should specify a non-nil value for
902 ID-FORMAT if you use the returned uid or gid.
904 Elements of the attribute list are:
905 0. t for directory, string (name linked to) for symbolic link, or nil.
906 1. Number of links to file.
907 2. File uid as a string or an integer. If a string value cannot be
908 looked up, the integer value is returned.
909 3. File gid, likewise.
910 4. Last access time, as a list of two integers.
911 First integer has high-order 16 bits of time, second has low 16 bits.
912 5. Last modification time, likewise.
913 6. Last status change time, likewise.
915 This is a floating point number if the size is too large for an integer.
916 8. File modes, as a string of ten letters or dashes as in ls -l.
917 9. t if file's gid would change if file were deleted and recreated.
918 10. inode number. If inode number is larger than the Emacs integer,
919 but still fits into a 32-bit number, this is a cons cell containing two
920 integers: first the high part, then the low 16 bits. If the inode number
921 is wider than 32 bits, this is a cons cell containing three integers:
922 first the high 24 bits, then middle 24 bits, and finally 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.
926 On MS-Windows, performance depends on `w32-get-true-file-attributes',
928 (filename
, id_format
)
929 Lisp_Object filename
, id_format
;
931 Lisp_Object values
[12];
934 #if defined (BSD4_2) || defined (BSD4_3)
941 EMACS_INT ino
, uid
, gid
;
944 filename
= Fexpand_file_name (filename
, Qnil
);
946 /* If the file name has special constructs in it,
947 call the corresponding file handler. */
948 handler
= Ffind_file_name_handler (filename
, Qfile_attributes
);
950 { /* Only pass the extra arg if it is used to help backward compatibility
951 with old file handlers which do not implement the new arg. --Stef */
952 if (NILP (id_format
))
953 return call2 (handler
, Qfile_attributes
, filename
);
955 return call3 (handler
, Qfile_attributes
, filename
, id_format
);
959 encoded
= ENCODE_FILE (filename
);
962 if (lstat (SDATA (encoded
), &s
) < 0)
965 switch (s
.st_mode
& S_IFMT
)
968 values
[0] = Qnil
; break;
970 values
[0] = Qt
; break;
973 values
[0] = Ffile_symlink_p (filename
); break;
976 values
[1] = make_number (s
.st_nlink
);
979 if (NILP (id_format
) || EQ (id_format
, Qinteger
))
981 values
[2] = make_fixnum_or_float (uid
);
982 values
[3] = make_fixnum_or_float (gid
);
987 uname
= stat_uname (&s
);
988 values
[2] = (uname
? build_string (uname
)
989 : make_fixnum_or_float (uid
));
990 gname
= stat_gname (&s
);
991 values
[3] = (gname
? build_string (gname
)
992 : make_fixnum_or_float (gid
));
995 values
[4] = make_time (s
.st_atime
);
996 values
[5] = make_time (s
.st_mtime
);
997 values
[6] = make_time (s
.st_ctime
);
998 values
[7] = make_number (s
.st_size
);
999 /* If the size is out of range for an integer, return a float. */
1000 if (XINT (values
[7]) != s
.st_size
)
1001 values
[7] = make_float ((double)s
.st_size
);
1002 /* If the size is negative, and its type is long, convert it back to
1004 if (s
.st_size
< 0 && sizeof (s
.st_size
) == sizeof (long))
1005 values
[7] = make_float ((double) ((unsigned long) s
.st_size
));
1007 filemodestring (&s
, modes
);
1008 values
[8] = make_string (modes
, 10);
1009 #if defined (BSD4_2) || defined (BSD4_3) /* file gid will be dir gid */
1010 dirname
= Ffile_name_directory (filename
);
1011 if (! NILP (dirname
))
1012 encoded
= ENCODE_FILE (dirname
);
1013 if (! NILP (dirname
) && stat (SDATA (encoded
), &sdir
) == 0)
1014 values
[9] = (sdir
.st_gid
!= s
.st_gid
) ? Qt
: Qnil
;
1015 else /* if we can't tell, assume worst */
1017 #else /* file gid will be egid */
1018 values
[9] = (s
.st_gid
!= getegid ()) ? Qt
: Qnil
;
1019 #endif /* BSD4_2 (or BSD4_3) */
1020 /* Shut up GCC warnings in FIXNUM_OVERFLOW_P below. */
1021 if (sizeof (s
.st_ino
) > sizeof (ino
))
1022 ino
= (EMACS_INT
)(s
.st_ino
& 0xffffffff);
1025 if (!FIXNUM_OVERFLOW_P (ino
)
1026 && (sizeof (s
.st_ino
) <= sizeof (ino
) || (s
.st_ino
& ~INTMASK
) == 0))
1027 /* Keep the most common cases as integers. */
1028 values
[10] = make_number (ino
);
1029 else if (sizeof (s
.st_ino
) <= sizeof (ino
)
1030 || ((s
.st_ino
>> 16) & ~INTMASK
) == 0)
1031 /* To allow inode numbers larger than VALBITS, separate the bottom
1033 values
[10] = Fcons (make_number ((EMACS_INT
)(s
.st_ino
>> 16)),
1034 make_number ((EMACS_INT
)(s
.st_ino
& 0xffff)));
1037 /* To allow inode numbers beyond 32 bits, separate into 2 24-bit
1038 high parts and a 16-bit bottom part.
1039 The code on the next line avoids a compiler warning on
1040 systems where st_ino is 32 bit wide. (bug#766). */
1041 EMACS_INT high_ino
= s
.st_ino
>> 31 >> 1;
1042 EMACS_INT low_ino
= s
.st_ino
& 0xffffffff;
1044 values
[10] = Fcons (make_number (high_ino
>> 8),
1045 Fcons (make_number (((high_ino
& 0xff) << 16)
1047 make_number (low_ino
& 0xffff)));
1050 /* Likewise for device, but don't let it become negative. We used
1051 to use FIXNUM_OVERFLOW_P here, but that won't catch large
1052 positive numbers such as 0xFFEEDDCC. */
1053 if ((EMACS_INT
)s
.st_dev
< 0
1054 || (EMACS_INT
)s
.st_dev
> MOST_POSITIVE_FIXNUM
)
1055 values
[11] = Fcons (make_number (s
.st_dev
>> 16),
1056 make_number (s
.st_dev
& 0xffff));
1058 values
[11] = make_number (s
.st_dev
);
1060 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
1063 DEFUN ("file-attributes-lessp", Ffile_attributes_lessp
, Sfile_attributes_lessp
, 2, 2, 0,
1064 doc
: /* Return t if first arg file attributes list is less than second.
1065 Comparison is in lexicographic order and case is significant. */)
1069 return Fstring_lessp (Fcar (f1
), Fcar (f2
));
1075 Qdirectory_files
= intern ("directory-files");
1076 Qdirectory_files_and_attributes
= intern ("directory-files-and-attributes");
1077 Qfile_name_completion
= intern ("file-name-completion");
1078 Qfile_name_all_completions
= intern ("file-name-all-completions");
1079 Qfile_attributes
= intern ("file-attributes");
1080 Qfile_attributes_lessp
= intern ("file-attributes-lessp");
1081 Qdefault_directory
= intern ("default-directory");
1083 staticpro (&Qdirectory_files
);
1084 staticpro (&Qdirectory_files_and_attributes
);
1085 staticpro (&Qfile_name_completion
);
1086 staticpro (&Qfile_name_all_completions
);
1087 staticpro (&Qfile_attributes
);
1088 staticpro (&Qfile_attributes_lessp
);
1089 staticpro (&Qdefault_directory
);
1091 defsubr (&Sdirectory_files
);
1092 defsubr (&Sdirectory_files_and_attributes
);
1093 defsubr (&Sfile_name_completion
);
1094 defsubr (&Sfile_name_all_completions
);
1095 defsubr (&Sfile_attributes
);
1096 defsubr (&Sfile_attributes_lessp
);
1098 DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions
,
1099 doc
: /* Completion ignores file names ending in any string in this list.
1100 It does not ignore them if all possible completions end in one of
1101 these strings or when displaying a list of completions.
1102 It ignores directory names if they match any string in this list which
1103 ends in a slash. */);
1104 Vcompletion_ignored_extensions
= Qnil
;
1107 /* arch-tag: 1ac8deca-4d8f-4d41-ade9-089154d98c03
1108 (do not change this comment) */