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, 2010 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>
39 /* The d_nameln member of a struct dirent includes the '\0' character
40 on some systems, but not on others. What's worse, you can't tell
41 at compile-time which one it will be, since it really depends on
42 the sort of system providing the filesystem you're reading from,
43 not the system you are running on. Paul Eggert
44 <eggert@bi.twinsun.com> says this occurs when Emacs is running on a
45 SunOS 4.1.2 host, reading a directory that is remote-mounted from a
46 Solaris 2.1 host and is in a native Solaris 2.1 filesystem.
48 Since applying strlen to the name always works, we'll just do that. */
49 #define NAMLEN(p) strlen (p->d_name)
51 #ifdef SYSV_SYSTEM_DIR
54 #define DIRENTRY struct dirent
56 #else /* not SYSV_SYSTEM_DIR */
67 #define DIRENTRY struct direct
69 extern DIR *opendir ();
70 extern struct direct
*readdir ();
72 #endif /* not MSDOS */
73 #endif /* not SYSV_SYSTEM_DIR */
75 /* Some versions of Cygwin don't have d_ino in `struct dirent'. */
76 #if defined(MSDOS) || defined(__CYGWIN__)
77 #define DIRENTRY_NONEMPTY(p) ((p)->d_name[0] != 0)
79 #define DIRENTRY_NONEMPTY(p) ((p)->d_ino)
86 #include "character.h"
90 #include "blockinput.h"
92 /* Returns a search buffer, with a fastmap allocated and ready to go. */
93 extern struct re_pattern_buffer
*compile_pattern ();
95 /* From filemode.c. Can't go in Lisp.h because of `stat'. */
96 extern void filemodestring (struct stat
*, char *);
98 /* if system does not have symbolic links, it does not have lstat.
99 In that case, use ordinary stat instead. */
105 extern int completion_ignore_case
;
106 extern Lisp_Object Qcompletion_ignore_case
;
107 extern Lisp_Object Vcompletion_regexp_list
;
108 extern Lisp_Object Vw32_get_true_file_attributes
;
110 Lisp_Object Vcompletion_ignored_extensions
;
111 Lisp_Object Qdirectory_files
;
112 Lisp_Object Qdirectory_files_and_attributes
;
113 Lisp_Object Qfile_name_completion
;
114 Lisp_Object Qfile_name_all_completions
;
115 Lisp_Object Qfile_attributes
;
116 Lisp_Object Qfile_attributes_lessp
;
118 static int scmp (unsigned char *, unsigned char *, int);
122 directory_files_internal_w32_unwind (Lisp_Object arg
)
124 Vw32_get_true_file_attributes
= arg
;
130 directory_files_internal_unwind (Lisp_Object dh
)
132 DIR *d
= (DIR *) XSAVE_VALUE (dh
)->pointer
;
139 /* Function shared by Fdirectory_files and Fdirectory_files_and_attributes.
140 When ATTRS is zero, return a list of directory filenames; when
141 non-zero, return a list of directory filenames and their attributes.
142 In the latter case, ID_FORMAT is passed to Ffile_attributes. */
145 directory_files_internal (Lisp_Object directory
, Lisp_Object full
, Lisp_Object match
, Lisp_Object nosort
, int attrs
, Lisp_Object id_format
)
148 int directory_nbytes
;
149 Lisp_Object list
, dirfilename
, encoded_directory
;
150 struct re_pattern_buffer
*bufp
= NULL
;
152 int count
= SPECPDL_INDEX ();
153 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
156 Lisp_Object w32_save
= Qnil
;
159 /* Because of file name handlers, these functions might call
160 Ffuncall, and cause a GC. */
161 list
= encoded_directory
= dirfilename
= Qnil
;
162 GCPRO5 (match
, directory
, list
, dirfilename
, encoded_directory
);
163 dirfilename
= Fdirectory_file_name (directory
);
167 CHECK_STRING (match
);
169 /* MATCH might be a flawed regular expression. Rather than
170 catching and signaling our own errors, we just call
171 compile_pattern to do the work for us. */
172 /* Pass 1 for the MULTIBYTE arg
173 because we do make multibyte strings if the contents warrant. */
175 /* Windows users want case-insensitive wildcards. */
176 bufp
= compile_pattern (match
, 0,
177 buffer_defaults
.case_canon_table
, 0, 1);
178 # else /* !WINDOWSNT */
179 bufp
= compile_pattern (match
, 0, Qnil
, 0, 1);
180 # endif /* !WINDOWSNT */
183 /* Note: ENCODE_FILE and DECODE_FILE can GC because they can run
184 run_pre_post_conversion_on_str which calls Lisp directly and
186 if (STRING_MULTIBYTE (dirfilename
))
187 dirfilename
= ENCODE_FILE (dirfilename
);
188 encoded_directory
= (STRING_MULTIBYTE (directory
)
189 ? ENCODE_FILE (directory
) : directory
);
191 /* Now *bufp is the compiled form of MATCH; don't call anything
192 which might compile a new regexp until we're done with the loop! */
195 d
= opendir (SDATA (dirfilename
));
198 report_file_error ("Opening directory", Fcons (directory
, Qnil
));
200 /* Unfortunately, we can now invoke expand-file-name and
201 file-attributes on filenames, both of which can throw, so we must
202 do a proper unwind-protect. */
203 record_unwind_protect (directory_files_internal_unwind
,
204 make_save_value (d
, 0));
209 extern Lisp_Object Qlocal
;
210 extern int is_slow_fs (const char *);
212 /* Do this only once to avoid doing it (in w32.c:stat) for each
213 file in the directory, when we call Ffile_attributes below. */
214 record_unwind_protect (directory_files_internal_w32_unwind
,
215 Vw32_get_true_file_attributes
);
216 w32_save
= Vw32_get_true_file_attributes
;
217 if (EQ (Vw32_get_true_file_attributes
, Qlocal
))
219 /* w32.c:stat will notice these bindings and avoid calling
220 GetDriveType for each file. */
221 if (is_slow_fs (SDATA (dirfilename
)))
222 Vw32_get_true_file_attributes
= Qnil
;
224 Vw32_get_true_file_attributes
= Qt
;
229 directory_nbytes
= SBYTES (directory
);
230 re_match_object
= Qt
;
232 /* Decide whether we need to add a directory separator. */
233 if (directory_nbytes
== 0
234 || !IS_ANY_SEP (SREF (directory
, directory_nbytes
- 1)))
237 /* Loop reading blocks until EOF or error. */
256 if (DIRENTRY_NONEMPTY (dp
))
260 Lisp_Object name
, finalname
;
261 struct gcpro gcpro1
, gcpro2
;
264 name
= finalname
= make_unibyte_string (dp
->d_name
, len
);
265 GCPRO2 (finalname
, name
);
267 /* Note: DECODE_FILE can GC; it should protect its argument,
269 name
= DECODE_FILE (name
);
272 /* Now that we have unwind_protect in place, we might as well
273 allow matching to be interrupted. */
278 || (0 <= re_search (bufp
, SDATA (name
), len
, 0, len
, 0)))
287 Lisp_Object fullname
;
288 int nbytes
= len
+ directory_nbytes
+ needsep
;
291 fullname
= make_uninit_multibyte_string (nbytes
, nbytes
);
292 bcopy (SDATA (directory
), SDATA (fullname
),
296 SSET (fullname
, directory_nbytes
, DIRECTORY_SEP
);
299 SDATA (fullname
) + directory_nbytes
+ needsep
,
302 nchars
= chars_in_text (SDATA (fullname
), nbytes
);
304 /* Some bug somewhere. */
308 STRING_SET_CHARS (fullname
, nchars
);
309 if (nchars
== nbytes
)
310 STRING_SET_UNIBYTE (fullname
);
312 finalname
= fullname
;
319 /* Construct an expanded filename for the directory entry.
320 Use the decoded names for input to Ffile_attributes. */
321 Lisp_Object decoded_fullname
, fileattrs
;
322 struct gcpro gcpro1
, gcpro2
;
324 decoded_fullname
= fileattrs
= Qnil
;
325 GCPRO2 (decoded_fullname
, fileattrs
);
327 /* Both Fexpand_file_name and Ffile_attributes can GC. */
328 decoded_fullname
= Fexpand_file_name (name
, directory
);
329 fileattrs
= Ffile_attributes (decoded_fullname
, id_format
);
331 list
= Fcons (Fcons (finalname
, fileattrs
), list
);
335 list
= Fcons (finalname
, list
);
347 Vw32_get_true_file_attributes
= w32_save
;
350 /* Discard the unwind protect. */
351 specpdl_ptr
= specpdl
+ count
;
354 list
= Fsort (Fnreverse (list
),
355 attrs
? Qfile_attributes_lessp
: Qstring_lessp
);
357 RETURN_UNGCPRO (list
);
361 DEFUN ("directory-files", Fdirectory_files
, Sdirectory_files
, 1, 4, 0,
362 doc
: /* Return a list of names of files in DIRECTORY.
363 There are three optional arguments:
364 If FULL is non-nil, return absolute file names. Otherwise return names
365 that are relative to the specified directory.
366 If MATCH is non-nil, mention only file names that match the regexp MATCH.
367 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
368 Otherwise, the list returned is sorted with `string-lessp'.
369 NOSORT is useful if you plan to sort the result yourself. */)
370 (directory
, full
, match
, nosort
)
371 Lisp_Object directory
, full
, match
, nosort
;
374 directory
= Fexpand_file_name (directory
, Qnil
);
376 /* If the file name has special constructs in it,
377 call the corresponding file handler. */
378 handler
= Ffind_file_name_handler (directory
, Qdirectory_files
);
380 return call5 (handler
, Qdirectory_files
, directory
,
381 full
, match
, nosort
);
383 return directory_files_internal (directory
, full
, match
, nosort
, 0, Qnil
);
386 DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes
,
387 Sdirectory_files_and_attributes
, 1, 5, 0,
388 doc
: /* Return a list of names of files and their attributes in DIRECTORY.
389 There are four optional arguments:
390 If FULL is non-nil, return absolute file names. Otherwise return names
391 that are relative to the specified directory.
392 If MATCH is non-nil, mention only file names that match the regexp MATCH.
393 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
394 NOSORT is useful if you plan to sort the result yourself.
395 ID-FORMAT specifies the preferred format of attributes uid and gid, see
396 `file-attributes' for further documentation.
397 On MS-Windows, performance depends on `w32-get-true-file-attributes',
399 (directory
, full
, match
, nosort
, id_format
)
400 Lisp_Object directory
, full
, match
, nosort
, id_format
;
403 directory
= Fexpand_file_name (directory
, Qnil
);
405 /* If the file name has special constructs in it,
406 call the corresponding file handler. */
407 handler
= Ffind_file_name_handler (directory
, Qdirectory_files_and_attributes
);
409 return call6 (handler
, Qdirectory_files_and_attributes
,
410 directory
, full
, match
, nosort
, id_format
);
412 return directory_files_internal (directory
, full
, match
, nosort
, 1, id_format
);
416 Lisp_Object
file_name_completion (Lisp_Object file
, Lisp_Object dirname
, int all_flag
, int ver_flag
, Lisp_Object predicate
);
418 DEFUN ("file-name-completion", Ffile_name_completion
, Sfile_name_completion
,
420 doc
: /* Complete file name FILE in directory DIRECTORY.
421 Returns the longest string
422 common to all file names in DIRECTORY that start with FILE.
423 If there is only one and FILE matches it exactly, returns t.
424 Returns nil if DIRECTORY contains no name starting with FILE.
426 If PREDICATE is non-nil, call PREDICATE with each possible
427 completion (in absolute form) and ignore it if PREDICATE returns nil.
429 This function ignores some of the possible completions as
430 determined by the variable `completion-ignored-extensions', which see. */)
431 (file
, directory
, predicate
)
432 Lisp_Object file
, directory
, predicate
;
436 /* If the directory name has special constructs in it,
437 call the corresponding file handler. */
438 handler
= Ffind_file_name_handler (directory
, Qfile_name_completion
);
440 return call4 (handler
, Qfile_name_completion
, file
, directory
, predicate
);
442 /* If the file name has special constructs in it,
443 call the corresponding file handler. */
444 handler
= Ffind_file_name_handler (file
, Qfile_name_completion
);
446 return call4 (handler
, Qfile_name_completion
, file
, directory
, predicate
);
448 return file_name_completion (file
, directory
, 0, 0, predicate
);
451 DEFUN ("file-name-all-completions", Ffile_name_all_completions
,
452 Sfile_name_all_completions
, 2, 2, 0,
453 doc
: /* Return a list of all completions of file name FILE in directory DIRECTORY.
454 These are all file names in directory DIRECTORY which begin with FILE. */)
456 Lisp_Object file
, directory
;
460 /* If the directory name has special constructs in it,
461 call the corresponding file handler. */
462 handler
= Ffind_file_name_handler (directory
, Qfile_name_all_completions
);
464 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
466 /* If the file name has special constructs in it,
467 call the corresponding file handler. */
468 handler
= Ffind_file_name_handler (file
, Qfile_name_all_completions
);
470 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
472 return file_name_completion (file
, directory
, 1, 0, Qnil
);
475 static int file_name_completion_stat (Lisp_Object dirname
, DIRENTRY
*dp
, struct stat
*st_addr
);
476 Lisp_Object Qdefault_directory
;
479 file_name_completion (Lisp_Object file
, Lisp_Object dirname
, int all_flag
, int ver_flag
, Lisp_Object predicate
)
482 int bestmatchsize
= 0;
484 /* If ALL_FLAG is 1, BESTMATCH is the list of all matches, decoded.
485 If ALL_FLAG is 0, BESTMATCH is either nil
486 or the best match so far, not decoded. */
487 Lisp_Object bestmatch
, tem
, elt
, name
;
488 Lisp_Object encoded_file
;
489 Lisp_Object encoded_dir
;
492 /* If includeall is zero, exclude files in completion-ignored-extensions as
493 well as "." and "..". Until shown otherwise, assume we can't exclude
496 int count
= SPECPDL_INDEX ();
497 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
503 #ifdef FILE_SYSTEM_CASE
504 file
= FILE_SYSTEM_CASE (file
);
507 encoded_file
= encoded_dir
= Qnil
;
508 GCPRO5 (file
, dirname
, bestmatch
, encoded_file
, encoded_dir
);
509 dirname
= Fexpand_file_name (dirname
, Qnil
);
510 specbind (Qdefault_directory
, dirname
);
512 /* Do completion on the encoded file name
513 because the other names in the directory are (we presume)
514 encoded likewise. We decode the completed string at the end. */
515 /* Actually, this is not quite true any more: we do most of the completion
516 work with decoded file names, but we still do some filtering based
517 on the encoded file name. */
518 encoded_file
= STRING_MULTIBYTE (file
) ? ENCODE_FILE (file
) : file
;
520 encoded_dir
= ENCODE_FILE (dirname
);
523 d
= opendir (SDATA (Fdirectory_file_name (encoded_dir
)));
526 report_file_error ("Opening directory", Fcons (dirname
, Qnil
));
528 record_unwind_protect (directory_files_internal_unwind
,
529 make_save_value (d
, 0));
531 /* Loop reading blocks */
532 /* (att3b compiler bug requires do a null comparison this way) */
556 if (! DIRENTRY_NONEMPTY (dp
)
557 || len
< SCHARS (encoded_file
)
558 || 0 <= scmp (dp
->d_name
, SDATA (encoded_file
),
559 SCHARS (encoded_file
)))
562 if (file_name_completion_stat (encoded_dir
, dp
, &st
) < 0)
565 directoryp
= ((st
.st_mode
& S_IFMT
) == S_IFDIR
);
567 /* If all_flag is set, always include all.
568 It would not actually be helpful to the user to ignore any possible
569 completions when making a list of them. */
574 #if 0 /* FIXME: The `scmp' call compares an encoded and a decoded string. */
575 /* If this entry matches the current bestmatch, the only
576 thing it can do is increase matchcount, so don't bother
577 investigating it any further. */
578 if (!completion_ignore_case
579 /* The return result depends on whether it's the sole match. */
581 && !includeall
/* This match may allow includeall to 0. */
582 && len
>= bestmatchsize
583 && 0 > scmp (dp
->d_name
, SDATA (bestmatch
), bestmatchsize
))
589 #ifndef TRIVIAL_DIRECTORY_ENTRY
590 #define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, ".."))
592 /* "." and ".." are never interesting as completions, and are
593 actually in the way in a directory with only one file. */
594 if (TRIVIAL_DIRECTORY_ENTRY (dp
->d_name
))
596 else if (len
> SCHARS (encoded_file
))
597 /* Ignore directories if they match an element of
598 completion-ignored-extensions which ends in a slash. */
599 for (tem
= Vcompletion_ignored_extensions
;
600 CONSP (tem
); tem
= XCDR (tem
))
608 /* Need to encode ELT, since scmp compares unibyte
610 elt
= ENCODE_FILE (elt
);
611 elt_len
= SCHARS (elt
) - 1; /* -1 for trailing / */
615 if (p1
[elt_len
] != '/')
617 skip
= len
- elt_len
;
621 if (0 <= scmp (dp
->d_name
+ skip
, p1
, elt_len
))
628 /* Compare extensions-to-be-ignored against end of this file name */
629 /* if name is not an exact match against specified string */
630 if (len
> SCHARS (encoded_file
))
631 /* and exit this for loop if a match is found */
632 for (tem
= Vcompletion_ignored_extensions
;
633 CONSP (tem
); tem
= XCDR (tem
))
636 if (!STRINGP (elt
)) continue;
637 /* Need to encode ELT, since scmp compares unibyte
639 elt
= ENCODE_FILE (elt
);
640 skip
= len
- SCHARS (elt
);
641 if (skip
< 0) continue;
643 if (0 <= scmp (dp
->d_name
+ skip
,
651 /* If an ignored-extensions match was found,
652 don't process this name as a completion. */
656 if (!includeall
&& canexclude
)
657 /* We're not including all files and this file can be excluded. */
660 if (includeall
&& !canexclude
)
661 { /* If we have one non-excludable file, we want to exclude the
664 /* Throw away any previous excludable match found. */
670 /* FIXME: If we move this `decode' earlier we can eliminate
671 the repeated ENCODE_FILE on Vcompletion_ignored_extensions. */
672 name
= make_unibyte_string (dp
->d_name
, len
);
673 name
= DECODE_FILE (name
);
678 XSETFASTINT (zero
, 0);
680 /* Ignore this element if it fails to match all the regexps. */
681 if (completion_ignore_case
)
683 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
684 regexps
= XCDR (regexps
))
685 if (fast_string_match_ignore_case (XCAR (regexps
), name
) < 0)
690 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
691 regexps
= XCDR (regexps
))
692 if (fast_string_match (XCAR (regexps
), name
) < 0)
700 /* This is a possible completion */
702 /* This completion is a directory; make it end with '/'. */
703 name
= Ffile_name_as_directory (name
);
705 /* Test the predicate, if any. */
706 if (!NILP (predicate
))
712 val
= call1 (predicate
, name
);
719 /* Suitably record this match. */
724 bestmatch
= Fcons (name
, bestmatch
);
725 else if (NILP (bestmatch
))
728 bestmatchsize
= SCHARS (name
);
732 Lisp_Object zero
= make_number (0);
733 /* FIXME: This is a copy of the code in Ftry_completion. */
734 int compare
= min (bestmatchsize
, SCHARS (name
));
736 = Fcompare_strings (bestmatch
, zero
,
737 make_number (compare
),
739 make_number (compare
),
740 completion_ignore_case
? Qt
: Qnil
);
742 = (EQ (tem
, Qt
) ? compare
743 : XINT (tem
) < 0 ? - XINT (tem
) - 1
746 if (completion_ignore_case
)
748 /* If this is an exact match except for case,
749 use it as the best match rather than one that is not
750 an exact match. This way, we get the case pattern
751 of the actual match. */
752 /* This tests that the current file is an exact match
753 but BESTMATCH is not (it is too long). */
754 if ((matchsize
== SCHARS (name
)
755 && matchsize
+ !!directoryp
< SCHARS (bestmatch
))
757 /* If there is no exact match ignoring case,
758 prefer a match that does not change the case
760 /* If there is more than one exact match aside from
761 case, and one of them is exact including case,
763 /* This == checks that, of current file and BESTMATCH,
764 either both or neither are exact. */
765 (((matchsize
== SCHARS (name
))
767 (matchsize
+ !!directoryp
== SCHARS (bestmatch
)))
768 && (tem
= Fcompare_strings (name
, zero
,
769 make_number (SCHARS (file
)),
774 && (tem
= Fcompare_strings (bestmatch
, zero
,
775 make_number (SCHARS (file
)),
782 bestmatchsize
= matchsize
;
784 /* If the best completion so far is reduced to the string
785 we're trying to complete, then we already know there's no
786 other completion, so there's no point looking any further. */
787 if (matchsize
<= SCHARS (file
)
788 && !includeall
/* A future match may allow includeall to 0. */
789 /* If completion-ignore-case is non-nil, don't
790 short-circuit because we want to find the best
791 possible match *including* case differences. */
792 && (!completion_ignore_case
|| matchsize
== 0)
793 /* The return value depends on whether it's the sole match. */
801 /* This closes the directory. */
802 bestmatch
= unbind_to (count
, bestmatch
);
804 if (all_flag
|| NILP (bestmatch
))
806 /* Return t if the supplied string is an exact match (counting case);
807 it does not require any change to be made. */
808 if (matchcount
== 1 && !NILP (Fequal (bestmatch
, file
)))
810 bestmatch
= Fsubstring (bestmatch
, make_number (0),
811 make_number (bestmatchsize
));
815 /* Compare exactly LEN chars of strings at S1 and S2,
816 ignoring case if appropriate.
817 Return -1 if strings match,
818 else number of chars that match at the beginning. */
821 scmp (register unsigned char *s1
, register unsigned char *s2
, int len
)
823 register int l
= len
;
825 if (completion_ignore_case
)
827 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
832 while (l
&& *s1
++ == *s2
++)
842 file_name_completion_stat (Lisp_Object dirname
, DIRENTRY
*dp
, struct stat
*st_addr
)
844 int len
= NAMLEN (dp
);
845 int pos
= SCHARS (dirname
);
847 char *fullname
= (char *) alloca (len
+ pos
+ 2);
850 /* Some fields of struct stat are *very* expensive to compute on MS-DOS,
851 but aren't required here. Avoid computing the following fields:
852 st_inode, st_size and st_nlink for directories, and the execute bits
853 in st_mode for non-directory files with non-standard extensions. */
855 unsigned short save_djstat_flags
= _djstat_flags
;
857 _djstat_flags
= _STAT_INODE
| _STAT_EXEC_MAGIC
| _STAT_DIRSIZE
;
860 bcopy (SDATA (dirname
), fullname
, pos
);
861 if (!IS_DIRECTORY_SEP (fullname
[pos
- 1]))
862 fullname
[pos
++] = DIRECTORY_SEP
;
864 bcopy (dp
->d_name
, fullname
+ pos
, len
);
865 fullname
[pos
+ len
] = 0;
868 /* We want to return success if a link points to a nonexistent file,
869 but we want to return the status for what the link points to,
870 in case it is a directory. */
871 value
= lstat (fullname
, st_addr
);
872 stat (fullname
, st_addr
);
875 value
= stat (fullname
, st_addr
);
877 _djstat_flags
= save_djstat_flags
;
884 make_time (time_t time
)
886 return Fcons (make_number (time
>> 16),
887 Fcons (make_number (time
& 0177777), Qnil
));
891 stat_uname (struct stat
*st
)
896 struct passwd
*pw
= (struct passwd
*) getpwuid (st
->st_uid
);
906 stat_gname (struct stat
*st
)
911 struct group
*gr
= (struct group
*) getgrgid (st
->st_gid
);
920 DEFUN ("file-attributes", Ffile_attributes
, Sfile_attributes
, 1, 2, 0,
921 doc
: /* Return a list of attributes of file FILENAME.
922 Value is nil if specified file cannot be opened.
924 ID-FORMAT specifies the preferred format of attributes uid and gid (see
925 below) - valid values are 'string and 'integer. The latter is the
926 default, but we plan to change that, so you should specify a non-nil value
927 for ID-FORMAT if you use the returned uid or gid.
929 Elements of the attribute list are:
930 0. t for directory, string (name linked to) for symbolic link, or nil.
931 1. Number of links to file.
932 2. File uid as a string or a number. If a string value cannot be
933 looked up, a numeric value, either an integer or a float, is returned.
934 3. File gid, likewise.
935 4. Last access time, as a list of two integers.
936 First integer has high-order 16 bits of time, second has low 16 bits.
937 (See a note below about access time on FAT-based filesystems.)
938 5. Last modification time, likewise. This is the time of the last
939 change to the file's contents.
940 6. Last status change time, likewise. This is the time of last change
941 to the file's attributes: owner and group, access mode bits, etc.
943 This is a floating point number if the size is too large for an integer.
944 8. File modes, as a string of ten letters or dashes as in ls -l.
945 9. t if file's gid would change if file were deleted and recreated.
946 10. inode number. If inode number is larger than what Emacs integer
947 can hold, but still fits into a 32-bit number, this is a cons cell
948 containing two integers: first the high part, then the low 16 bits.
949 If the inode number is wider than 32 bits, this is of the form
950 (HIGH MIDDLE . LOW): first the high 24 bits, then middle 24 bits,
951 and finally the low 16 bits.
952 11. Filesystem device number. If it is larger than what the Emacs
953 integer can hold, this is a cons cell, similar to the inode number.
955 On most filesystems, the combination of the inode and the device
956 number uniquely identifies the file.
958 On MS-Windows, performance depends on `w32-get-true-file-attributes',
961 On some FAT-based filesystems, only the date of last access is recorded,
962 so last access time will always be midnight of that day. */)
963 (filename
, id_format
)
964 Lisp_Object filename
, id_format
;
966 Lisp_Object values
[12];
976 char *uname
= NULL
, *gname
= NULL
;
978 filename
= Fexpand_file_name (filename
, Qnil
);
980 /* If the file name has special constructs in it,
981 call the corresponding file handler. */
982 handler
= Ffind_file_name_handler (filename
, Qfile_attributes
);
984 { /* Only pass the extra arg if it is used to help backward compatibility
985 with old file handlers which do not implement the new arg. --Stef */
986 if (NILP (id_format
))
987 return call2 (handler
, Qfile_attributes
, filename
);
989 return call3 (handler
, Qfile_attributes
, filename
, id_format
);
993 encoded
= ENCODE_FILE (filename
);
996 if (lstat (SDATA (encoded
), &s
) < 0)
999 switch (s
.st_mode
& S_IFMT
)
1002 values
[0] = Qnil
; break;
1004 values
[0] = Qt
; break;
1007 values
[0] = Ffile_symlink_p (filename
); break;
1010 values
[1] = make_number (s
.st_nlink
);
1012 if (!(NILP (id_format
) || EQ (id_format
, Qinteger
)))
1015 uname
= stat_uname (&s
);
1016 gname
= stat_gname (&s
);
1020 values
[2] = DECODE_SYSTEM (build_string (uname
));
1022 values
[2] = make_fixnum_or_float (s
.st_uid
);
1024 values
[3] = DECODE_SYSTEM (build_string (gname
));
1026 values
[3] = make_fixnum_or_float (s
.st_gid
);
1028 values
[4] = make_time (s
.st_atime
);
1029 values
[5] = make_time (s
.st_mtime
);
1030 values
[6] = make_time (s
.st_ctime
);
1031 values
[7] = make_fixnum_or_float (s
.st_size
);
1032 /* If the size is negative, and its type is long, convert it back to
1034 if (s
.st_size
< 0 && sizeof (s
.st_size
) == sizeof (long))
1035 values
[7] = make_float ((double) ((unsigned long) s
.st_size
));
1037 filemodestring (&s
, modes
);
1038 values
[8] = make_string (modes
, 10);
1039 #ifdef BSD4_2 /* file gid will be dir gid */
1040 dirname
= Ffile_name_directory (filename
);
1041 if (! NILP (dirname
))
1042 encoded
= ENCODE_FILE (dirname
);
1043 if (! NILP (dirname
) && stat (SDATA (encoded
), &sdir
) == 0)
1044 values
[9] = (sdir
.st_gid
!= s
.st_gid
) ? Qt
: Qnil
;
1045 else /* if we can't tell, assume worst */
1047 #else /* file gid will be egid */
1048 values
[9] = (s
.st_gid
!= getegid ()) ? Qt
: Qnil
;
1049 #endif /* not BSD4_2 */
1050 if (!FIXNUM_OVERFLOW_P (s
.st_ino
))
1051 /* Keep the most common cases as integers. */
1052 values
[10] = make_number (s
.st_ino
);
1053 else if (!FIXNUM_OVERFLOW_P (s
.st_ino
>> 16))
1054 /* To allow inode numbers larger than VALBITS, separate the bottom
1056 values
[10] = Fcons (make_number ((EMACS_INT
)(s
.st_ino
>> 16)),
1057 make_number ((EMACS_INT
)(s
.st_ino
& 0xffff)));
1060 /* To allow inode numbers beyond 32 bits, separate into 2 24-bit
1061 high parts and a 16-bit bottom part.
1062 The code on the next line avoids a compiler warning on
1063 systems where st_ino is 32 bit wide. (bug#766). */
1064 EMACS_INT high_ino
= s
.st_ino
>> 31 >> 1;
1065 EMACS_INT low_ino
= s
.st_ino
& 0xffffffff;
1067 values
[10] = Fcons (make_number (high_ino
>> 8),
1068 Fcons (make_number (((high_ino
& 0xff) << 16)
1070 make_number (low_ino
& 0xffff)));
1073 /* Likewise for device. */
1074 if (FIXNUM_OVERFLOW_P (s
.st_dev
))
1075 values
[11] = Fcons (make_number (s
.st_dev
>> 16),
1076 make_number (s
.st_dev
& 0xffff));
1078 values
[11] = make_number (s
.st_dev
);
1080 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
1083 DEFUN ("file-attributes-lessp", Ffile_attributes_lessp
, Sfile_attributes_lessp
, 2, 2, 0,
1084 doc
: /* Return t if first arg file attributes list is less than second.
1085 Comparison is in lexicographic order and case is significant. */)
1089 return Fstring_lessp (Fcar (f1
), Fcar (f2
));
1093 syms_of_dired (void)
1095 Qdirectory_files
= intern_c_string ("directory-files");
1096 Qdirectory_files_and_attributes
= intern_c_string ("directory-files-and-attributes");
1097 Qfile_name_completion
= intern_c_string ("file-name-completion");
1098 Qfile_name_all_completions
= intern_c_string ("file-name-all-completions");
1099 Qfile_attributes
= intern_c_string ("file-attributes");
1100 Qfile_attributes_lessp
= intern_c_string ("file-attributes-lessp");
1101 Qdefault_directory
= intern_c_string ("default-directory");
1103 staticpro (&Qdirectory_files
);
1104 staticpro (&Qdirectory_files_and_attributes
);
1105 staticpro (&Qfile_name_completion
);
1106 staticpro (&Qfile_name_all_completions
);
1107 staticpro (&Qfile_attributes
);
1108 staticpro (&Qfile_attributes_lessp
);
1109 staticpro (&Qdefault_directory
);
1111 defsubr (&Sdirectory_files
);
1112 defsubr (&Sdirectory_files_and_attributes
);
1113 defsubr (&Sfile_name_completion
);
1114 defsubr (&Sfile_name_all_completions
);
1115 defsubr (&Sfile_attributes
);
1116 defsubr (&Sfile_attributes_lessp
);
1118 DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions
,
1119 doc
: /* Completion ignores file names ending in any string in this list.
1120 It does not ignore them if all possible completions end in one of
1121 these strings or when displaying a list of completions.
1122 It ignores directory names if they match any string in this list which
1123 ends in a slash. */);
1124 Vcompletion_ignored_extensions
= Qnil
;
1127 /* arch-tag: 1ac8deca-4d8f-4d41-ade9-089154d98c03
1128 (do not change this comment) */