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)
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. */
26 #include <sys/types.h>
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
63 #define DIRENTRY struct dirent
65 #else /* not SYSV_SYSTEM_DIR */
67 #ifdef NONSYSTEM_DIR_LIBRARY
69 #else /* not NONSYSTEM_DIR_LIBRARY */
75 #endif /* not NONSYSTEM_DIR_LIBRARY */
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)
92 #define DIRENTRY_NONEMPTY(p) ((p)->d_ino)
99 #include "character.h"
103 #include "blockinput.h"
105 /* Returns a search buffer, with a fastmap allocated and ready to go. */
106 extern struct re_pattern_buffer
*compile_pattern ();
108 /* From filemode.c. Can't go in Lisp.h because of `stat'. */
109 extern void filemodestring
P_ ((struct stat
*, char *));
111 /* if system does not have symbolic links, it does not have lstat.
112 In that case, use ordinary stat instead. */
118 extern int completion_ignore_case
;
119 extern Lisp_Object Qcompletion_ignore_case
;
120 extern Lisp_Object Vcompletion_regexp_list
;
122 Lisp_Object Vcompletion_ignored_extensions
;
123 Lisp_Object Qdirectory_files
;
124 Lisp_Object Qdirectory_files_and_attributes
;
125 Lisp_Object Qfile_name_completion
;
126 Lisp_Object Qfile_name_all_completions
;
127 Lisp_Object Qfile_attributes
;
128 Lisp_Object Qfile_attributes_lessp
;
130 static int scmp
P_ ((unsigned char *, unsigned char *, int));
134 directory_files_internal_unwind (dh
)
137 DIR *d
= (DIR *) XSAVE_VALUE (dh
)->pointer
;
144 /* Function shared by Fdirectory_files and Fdirectory_files_and_attributes.
145 When ATTRS is zero, return a list of directory filenames; when
146 non-zero, return a list of directory filenames and their attributes.
147 In the latter case, ID_FORMAT is passed to Ffile_attributes. */
150 directory_files_internal (directory
, full
, match
, nosort
, attrs
, id_format
)
151 Lisp_Object directory
, full
, match
, nosort
;
153 Lisp_Object id_format
;
156 int directory_nbytes
;
157 Lisp_Object list
, dirfilename
, encoded_directory
;
158 struct re_pattern_buffer
*bufp
= NULL
;
160 int count
= SPECPDL_INDEX ();
161 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
164 /* Because of file name handlers, these functions might call
165 Ffuncall, and cause a GC. */
166 list
= encoded_directory
= dirfilename
= Qnil
;
167 GCPRO5 (match
, directory
, list
, dirfilename
, encoded_directory
);
168 dirfilename
= Fdirectory_file_name (directory
);
172 CHECK_STRING (match
);
174 /* MATCH might be a flawed regular expression. Rather than
175 catching and signaling our own errors, we just call
176 compile_pattern to do the work for us. */
177 /* Pass 1 for the MULTIBYTE arg
178 because we do make multibyte strings if the contents warrant. */
180 bufp
= compile_pattern (match
, 0,
181 buffer_defaults
.downcase_table
, 0, 1);
184 /* Windows users want case-insensitive wildcards. */
185 bufp
= compile_pattern (match
, 0,
186 buffer_defaults
.case_canon_table
, 0, 1);
187 # else /* !WINDOWSNT */
188 bufp
= compile_pattern (match
, 0, Qnil
, 0, 1);
189 # endif /* !WINDOWSNT */
193 /* Note: ENCODE_FILE and DECODE_FILE can GC because they can run
194 run_pre_post_conversion_on_str which calls Lisp directly and
196 if (STRING_MULTIBYTE (dirfilename
))
197 dirfilename
= ENCODE_FILE (dirfilename
);
198 encoded_directory
= (STRING_MULTIBYTE (directory
)
199 ? ENCODE_FILE (directory
) : directory
);
201 /* Now *bufp is the compiled form of MATCH; don't call anything
202 which might compile a new regexp until we're done with the loop! */
205 d
= opendir (SDATA (dirfilename
));
208 report_file_error ("Opening directory", Fcons (directory
, Qnil
));
210 /* Unfortunately, we can now invoke expand-file-name and
211 file-attributes on filenames, both of which can throw, so we must
212 do a proper unwind-protect. */
213 record_unwind_protect (directory_files_internal_unwind
,
214 make_save_value (d
, 0));
216 directory_nbytes
= SBYTES (directory
);
217 re_match_object
= Qt
;
219 /* Decide whether we need to add a directory separator. */
221 if (directory_nbytes
== 0
222 || !IS_ANY_SEP (SREF (directory
, directory_nbytes
- 1)))
226 /* Loop reading blocks until EOF or error. */
245 if (DIRENTRY_NONEMPTY (dp
))
249 Lisp_Object name
, finalname
;
250 struct gcpro gcpro1
, gcpro2
;
253 name
= finalname
= make_unibyte_string (dp
->d_name
, len
);
254 GCPRO2 (finalname
, name
);
256 /* Note: DECODE_FILE can GC; it should protect its argument,
258 name
= DECODE_FILE (name
);
261 /* Now that we have unwind_protect in place, we might as well
262 allow matching to be interrupted. */
267 || (0 <= re_search (bufp
, SDATA (name
), len
, 0, len
, 0)))
276 Lisp_Object fullname
;
277 int nbytes
= len
+ directory_nbytes
+ needsep
;
280 fullname
= make_uninit_multibyte_string (nbytes
, nbytes
);
281 bcopy (SDATA (directory
), SDATA (fullname
),
285 SSET (fullname
, directory_nbytes
, DIRECTORY_SEP
);
288 SDATA (fullname
) + directory_nbytes
+ needsep
,
291 nchars
= chars_in_text (SDATA (fullname
), nbytes
);
293 /* Some bug somewhere. */
297 STRING_SET_CHARS (fullname
, nchars
);
298 if (nchars
== nbytes
)
299 STRING_SET_UNIBYTE (fullname
);
301 finalname
= fullname
;
308 /* Construct an expanded filename for the directory entry.
309 Use the decoded names for input to Ffile_attributes. */
310 Lisp_Object decoded_fullname
, fileattrs
;
311 struct gcpro gcpro1
, gcpro2
;
313 decoded_fullname
= fileattrs
= Qnil
;
314 GCPRO2 (decoded_fullname
, fileattrs
);
316 /* Both Fexpand_file_name and Ffile_attributes can GC. */
317 decoded_fullname
= Fexpand_file_name (name
, directory
);
318 fileattrs
= Ffile_attributes (decoded_fullname
, id_format
);
320 list
= Fcons (Fcons (finalname
, fileattrs
), list
);
324 list
= Fcons (finalname
, list
);
335 /* Discard the unwind protect. */
336 specpdl_ptr
= specpdl
+ count
;
339 list
= Fsort (Fnreverse (list
),
340 attrs
? Qfile_attributes_lessp
: Qstring_lessp
);
342 RETURN_UNGCPRO (list
);
346 DEFUN ("directory-files", Fdirectory_files
, Sdirectory_files
, 1, 4, 0,
347 doc
: /* Return a list of names of files in DIRECTORY.
348 There are three optional arguments:
349 If FULL is non-nil, return absolute file names. Otherwise return names
350 that are relative to the specified directory.
351 If MATCH is non-nil, mention only file names that match the regexp MATCH.
352 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
353 NOSORT is useful if you plan to sort the result yourself. */)
354 (directory
, full
, match
, nosort
)
355 Lisp_Object directory
, full
, match
, nosort
;
358 directory
= Fexpand_file_name (directory
, Qnil
);
360 /* If the file name has special constructs in it,
361 call the corresponding file handler. */
362 handler
= Ffind_file_name_handler (directory
, Qdirectory_files
);
364 return call5 (handler
, Qdirectory_files
, directory
,
365 full
, match
, nosort
);
367 return directory_files_internal (directory
, full
, match
, nosort
, 0, Qnil
);
370 DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes
,
371 Sdirectory_files_and_attributes
, 1, 5, 0,
372 doc
: /* Return a list of names of files and their attributes in DIRECTORY.
373 There are four optional arguments:
374 If FULL is non-nil, return absolute file names. Otherwise return names
375 that are relative to the specified directory.
376 If MATCH is non-nil, mention only file names that match the regexp MATCH.
377 If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
378 NOSORT is useful if you plan to sort the result yourself.
379 ID-FORMAT specifies the preferred format of attributes uid and gid, see
380 `file-attributes' for further documentation.
381 On MS-Windows, performance depends on `w32-get-true-file-attributes',
383 (directory
, full
, match
, nosort
, id_format
)
384 Lisp_Object directory
, full
, match
, nosort
, id_format
;
387 directory
= Fexpand_file_name (directory
, Qnil
);
389 /* If the file name has special constructs in it,
390 call the corresponding file handler. */
391 handler
= Ffind_file_name_handler (directory
, Qdirectory_files_and_attributes
);
393 return call6 (handler
, Qdirectory_files_and_attributes
,
394 directory
, full
, match
, nosort
, id_format
);
396 return directory_files_internal (directory
, full
, match
, nosort
, 1, id_format
);
400 Lisp_Object
file_name_completion ();
402 DEFUN ("file-name-completion", Ffile_name_completion
, Sfile_name_completion
,
404 doc
: /* Complete file name FILE in directory DIRECTORY.
405 Returns the longest string
406 common to all file names in DIRECTORY that start with FILE.
407 If there is only one and FILE matches it exactly, returns t.
408 Returns nil if DIRECTORY contains no name starting with FILE.
410 If PREDICATE is non-nil, call PREDICATE with each possible
411 completion (in absolute form) and ignore it if PREDICATE returns nil.
413 This function ignores some of the possible completions as
414 determined by the variable `completion-ignored-extensions', which see. */)
415 (file
, directory
, predicate
)
416 Lisp_Object file
, directory
, predicate
;
420 /* If the directory name has special constructs in it,
421 call the corresponding file handler. */
422 handler
= Ffind_file_name_handler (directory
, Qfile_name_completion
);
424 return call4 (handler
, Qfile_name_completion
, file
, directory
, predicate
);
426 /* If the file name has special constructs in it,
427 call the corresponding file handler. */
428 handler
= Ffind_file_name_handler (file
, Qfile_name_completion
);
430 return call4 (handler
, Qfile_name_completion
, file
, directory
, predicate
);
432 return file_name_completion (file
, directory
, 0, 0, predicate
);
435 DEFUN ("file-name-all-completions", Ffile_name_all_completions
,
436 Sfile_name_all_completions
, 2, 2, 0,
437 doc
: /* Return a list of all completions of file name FILE in directory DIRECTORY.
438 These are all file names in directory DIRECTORY which begin with FILE. */)
440 Lisp_Object file
, directory
;
444 /* If the directory name has special constructs in it,
445 call the corresponding file handler. */
446 handler
= Ffind_file_name_handler (directory
, Qfile_name_all_completions
);
448 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
450 /* If the file name has special constructs in it,
451 call the corresponding file handler. */
452 handler
= Ffind_file_name_handler (file
, Qfile_name_all_completions
);
454 return call3 (handler
, Qfile_name_all_completions
, file
, directory
);
456 return file_name_completion (file
, directory
, 1, 0, Qnil
);
459 static int file_name_completion_stat ();
460 Lisp_Object Qdefault_directory
;
463 file_name_completion (file
, dirname
, all_flag
, ver_flag
, predicate
)
464 Lisp_Object file
, dirname
;
465 int all_flag
, ver_flag
;
466 Lisp_Object predicate
;
469 int bestmatchsize
= 0;
471 /* If ALL_FLAG is 1, BESTMATCH is the list of all matches, decoded.
472 If ALL_FLAG is 0, BESTMATCH is either nil
473 or the best match so far, not decoded. */
474 Lisp_Object bestmatch
, tem
, elt
, name
;
475 Lisp_Object encoded_file
;
476 Lisp_Object encoded_dir
;
479 /* If includeall is zero, exclude files in completion-ignored-extensions as
480 well as "." and "..". Until shown otherwise, assume we can't exclude
483 int count
= SPECPDL_INDEX ();
484 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
489 extern DIRENTRY
* readdirver ();
491 DIRENTRY
*((* readfunc
) ());
493 /* Filename completion on VMS ignores case, since VMS filesys does. */
494 specbind (Qcompletion_ignore_case
, Qt
);
498 readfunc
= readdirver
;
499 file
= Fupcase (file
);
504 #ifdef FILE_SYSTEM_CASE
505 file
= FILE_SYSTEM_CASE (file
);
508 encoded_file
= encoded_dir
= Qnil
;
509 GCPRO5 (file
, dirname
, bestmatch
, encoded_file
, encoded_dir
);
510 dirname
= Fexpand_file_name (dirname
, Qnil
);
511 specbind (Qdefault_directory
, dirname
);
513 /* Do completion on the encoded file name
514 because the other names in the directory are (we presume)
515 encoded likewise. We decode the completed string at the end. */
516 /* Actually, this is not quite true any more: we do most of the completion
517 work with decoded file names, but we still do some filtering based
518 on the encoded file name. */
519 encoded_file
= STRING_MULTIBYTE (file
) ? ENCODE_FILE (file
) : file
;
521 encoded_dir
= ENCODE_FILE (dirname
);
524 d
= opendir (SDATA (Fdirectory_file_name (encoded_dir
)));
527 report_file_error ("Opening directory", Fcons (dirname
, Qnil
));
529 record_unwind_protect (directory_files_internal_unwind
,
530 make_save_value (d
, 0));
532 /* Loop reading blocks */
533 /* (att3b compiler bug requires do a null comparison this way) */
541 dp
= (*readfunc
) (d
);
561 if (! DIRENTRY_NONEMPTY (dp
)
562 || len
< SCHARS (encoded_file
)
563 || 0 <= scmp (dp
->d_name
, SDATA (encoded_file
),
564 SCHARS (encoded_file
)))
567 if (file_name_completion_stat (encoded_dir
, dp
, &st
) < 0)
570 directoryp
= ((st
.st_mode
& S_IFMT
) == S_IFDIR
);
572 /* If all_flag is set, always include all.
573 It would not actually be helpful to the user to ignore any possible
574 completions when making a list of them. */
580 #ifndef TRIVIAL_DIRECTORY_ENTRY
581 #define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, ".."))
583 /* "." and ".." are never interesting as completions, and are
584 actually in the way in a directory with only one file. */
585 if (TRIVIAL_DIRECTORY_ENTRY (dp
->d_name
))
587 else if (len
> SCHARS (encoded_file
))
588 /* Ignore directories if they match an element of
589 completion-ignored-extensions which ends in a slash. */
590 for (tem
= Vcompletion_ignored_extensions
;
591 CONSP (tem
); tem
= XCDR (tem
))
599 /* Need to encode ELT, since scmp compares unibyte
601 elt
= ENCODE_FILE (elt
);
602 elt_len
= SCHARS (elt
) - 1; /* -1 for trailing / */
606 if (p1
[elt_len
] != '/')
608 skip
= len
- elt_len
;
612 if (0 <= scmp (dp
->d_name
+ skip
, p1
, elt_len
))
619 /* Compare extensions-to-be-ignored against end of this file name */
620 /* if name is not an exact match against specified string */
621 if (len
> SCHARS (encoded_file
))
622 /* and exit this for loop if a match is found */
623 for (tem
= Vcompletion_ignored_extensions
;
624 CONSP (tem
); tem
= XCDR (tem
))
627 if (!STRINGP (elt
)) continue;
628 /* Need to encode ELT, since scmp compares unibyte
630 elt
= ENCODE_FILE (elt
);
631 skip
= len
- SCHARS (elt
);
632 if (skip
< 0) continue;
634 if (0 <= scmp (dp
->d_name
+ skip
,
642 /* If an ignored-extensions match was found,
643 don't process this name as a completion. */
647 if (!includeall
&& canexclude
)
648 /* We're not including all files and this file can be excluded. */
651 if (includeall
&& !canexclude
)
652 { /* If we have one non-excludable file, we want to exclude the
655 /* Throw away any previous excludable match found. */
661 /* FIXME: If we move this `decode' earlier we can eliminate
662 the repeated ENCODE_FILE on Vcompletion_ignored_extensions. */
663 name
= make_unibyte_string (dp
->d_name
, len
);
664 name
= DECODE_FILE (name
);
669 XSETFASTINT (zero
, 0);
671 /* Ignore this element if it fails to match all the regexps. */
672 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
673 regexps
= XCDR (regexps
))
674 if (fast_string_match (XCAR (regexps
), name
) < 0)
680 /* This is a possible completion */
682 /* This completion is a directory; make it end with '/'. */
683 name
= Ffile_name_as_directory (name
);
685 /* Test the predicate, if any. */
686 if (!NILP (predicate
))
692 val
= call1 (predicate
, name
);
699 /* Suitably record this match. */
704 bestmatch
= Fcons (name
, bestmatch
);
705 else if (NILP (bestmatch
))
708 bestmatchsize
= SCHARS (name
);
712 Lisp_Object zero
= make_number (0);
713 /* FIXME: This is a copy of the code in Ftry_completion. */
714 int compare
= min (bestmatchsize
, SCHARS (name
));
716 = Fcompare_strings (bestmatch
, zero
,
717 make_number (compare
),
719 make_number (compare
),
720 completion_ignore_case
? Qt
: Qnil
);
722 = (EQ (tem
, Qt
) ? compare
723 : XINT (tem
) < 0 ? - XINT (tem
) - 1
726 if (completion_ignore_case
)
728 /* If this is an exact match except for case,
729 use it as the best match rather than one that is not
730 an exact match. This way, we get the case pattern
731 of the actual match. */
732 /* This tests that the current file is an exact match
733 but BESTMATCH is not (it is too long). */
734 if ((matchsize
== SCHARS (name
)
735 && matchsize
+ !!directoryp
736 < SCHARS (bestmatch
))
738 /* If there is no exact match ignoring case,
739 prefer a match that does not change the case
741 /* If there is more than one exact match aside from
742 case, and one of them is exact including case,
744 /* This == checks that, of current file and BESTMATCH,
745 either both or neither are exact. */
746 (((matchsize
== SCHARS (name
))
748 (matchsize
+ !!directoryp
== SCHARS (bestmatch
)))
749 && (tem
= Fcompare_strings (name
, zero
,
750 make_number (SCHARS (file
)),
755 && (tem
= Fcompare_strings (bestmatch
, zero
,
756 make_number (SCHARS (file
)),
763 bestmatchsize
= matchsize
;
768 /* This closes the directory. */
769 bestmatch
= unbind_to (count
, bestmatch
);
771 if (all_flag
|| NILP (bestmatch
))
773 if (matchcount
== 1 && bestmatchsize
== SCHARS (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
);
834 if (!IS_DIRECTORY_SEP (fullname
[pos
- 1]))
835 fullname
[pos
++] = DIRECTORY_SEP
;
838 bcopy (dp
->d_name
, fullname
+ pos
, len
);
839 fullname
[pos
+ len
] = 0;
842 /* We want to return success if a link points to a nonexistent file,
843 but we want to return the status for what the link points to,
844 in case it is a directory. */
845 value
= lstat (fullname
, st_addr
);
846 stat (fullname
, st_addr
);
849 value
= stat (fullname
, st_addr
);
852 _djstat_flags
= save_djstat_flags
;
853 #endif /* __DJGPP__ > 1 */
861 DEFUN ("file-name-all-versions", Ffile_name_all_versions
,
862 Sfile_name_all_versions
, 2, 2, 0,
863 doc
: /* Return a list of all versions of file name FILE in directory DIRECTORY. */)
865 Lisp_Object file
, directory
;
867 return file_name_completion (file
, directory
, 1, 1, Qnil
);
870 DEFUN ("file-version-limit", Ffile_version_limit
, Sfile_version_limit
, 1, 1, 0,
871 doc
: /* Return the maximum number of versions allowed for FILE.
872 Returns nil if the file cannot be opened or if there is no version limit. */)
874 Lisp_Object filename
;
879 struct XABFHC xabfhc
;
882 filename
= Fexpand_file_name (filename
, Qnil
);
884 xabfhc
= cc$rms_xabfhc
;
885 fab
.fab$l_fna
= SDATA (filename
);
886 fab
.fab$b_fns
= strlen (fab
.fab$l_fna
);
887 fab
.fab$l_xab
= (char *) &xabfhc
;
888 status
= sys$
open (&fab
, 0, 0);
889 if (status
!= RMS$_NORMAL
) /* Probably non-existent file */
891 sys$
close (&fab
, 0, 0);
892 if (xabfhc
.xab$w_verlimit
== 32767)
893 return Qnil
; /* No version limit */
895 return make_number (xabfhc
.xab$w_verlimit
);
904 return Fcons (make_number (time
>> 16),
905 Fcons (make_number (time
& 0177777), Qnil
));
909 stat_uname (struct stat
*st
)
914 struct passwd
*pw
= (struct passwd
*) getpwuid (st
->st_uid
);
924 stat_gname (struct stat
*st
)
929 struct group
*gr
= (struct group
*) getgrgid (st
->st_gid
);
938 DEFUN ("file-attributes", Ffile_attributes
, Sfile_attributes
, 1, 2, 0,
939 doc
: /* Return a list of attributes of file FILENAME.
940 Value is nil if specified file cannot be opened.
942 ID-FORMAT specifies the preferred format of attributes uid and gid (see
943 below) - valid values are 'string and 'integer. The latter is the default,
944 but we plan to change that, so you should specify a non-nil value for
945 ID-FORMAT if you use the returned uid or gid.
947 Elements of the attribute list are:
948 0. t for directory, string (name linked to) for symbolic link, or nil.
949 1. Number of links to file.
950 2. File uid as a string or an integer. If a string value cannot be
951 looked up, the integer value is returned.
952 3. File gid, likewise.
953 4. Last access time, as a list of two integers.
954 First integer has high-order 16 bits of time, second has low 16 bits.
955 5. Last modification time, likewise.
956 6. Last status change time, likewise.
958 This is a floating point number if the size is too large for an integer.
959 8. File modes, as a string of ten letters or dashes as in ls -l.
960 9. t if file's gid would change if file were deleted and recreated.
961 10. inode number. If inode number is larger than the Emacs integer,
962 but still fits into a 32-bit number, this is a cons cell containing two
963 integers: first the high part, then the low 16 bits. If the inode number
964 is wider than 32 bits, this is a cons cell containing three integers:
965 first the high 24 bits, then middle 24 bits, and finally the low 16 bits.
966 11. Device number. If it is larger than the Emacs integer, this is
967 a cons cell, similar to the inode number.
969 On MS-Windows, performance depends on `w32-get-true-file-attributes',
971 (filename
, id_format
)
972 Lisp_Object filename
, id_format
;
974 Lisp_Object values
[12];
977 #if defined (BSD4_2) || defined (BSD4_3)
987 filename
= Fexpand_file_name (filename
, Qnil
);
989 /* If the file name has special constructs in it,
990 call the corresponding file handler. */
991 handler
= Ffind_file_name_handler (filename
, Qfile_attributes
);
993 { /* Only pass the extra arg if it is used to help backward compatibility
994 with old file handlers which do not implement the new arg. --Stef */
995 if (NILP (id_format
))
996 return call2 (handler
, Qfile_attributes
, filename
);
998 return call3 (handler
, Qfile_attributes
, filename
, id_format
);
1002 encoded
= ENCODE_FILE (filename
);
1005 if (lstat (SDATA (encoded
), &s
) < 0)
1008 switch (s
.st_mode
& S_IFMT
)
1011 values
[0] = Qnil
; break;
1013 values
[0] = Qt
; break;
1016 values
[0] = Ffile_symlink_p (filename
); break;
1019 values
[1] = make_number (s
.st_nlink
);
1020 if (NILP (id_format
) || EQ (id_format
, Qinteger
))
1022 values
[2] = make_fixnum_or_float (s
.st_uid
);
1023 values
[3] = make_fixnum_or_float (s
.st_gid
);
1028 uname
= stat_uname (&s
);
1029 values
[2] = (uname
? build_string (uname
)
1030 : make_fixnum_or_float (s
.st_uid
));
1031 gname
= stat_gname (&s
);
1032 values
[3] = (gname
? build_string (gname
)
1033 : make_fixnum_or_float (s
.st_gid
));
1036 values
[4] = make_time (s
.st_atime
);
1037 values
[5] = make_time (s
.st_mtime
);
1038 values
[6] = make_time (s
.st_ctime
);
1039 values
[7] = make_number (s
.st_size
);
1040 /* If the size is out of range for an integer, return a float. */
1041 if (XINT (values
[7]) != s
.st_size
)
1042 values
[7] = make_float ((double)s
.st_size
);
1043 /* If the size is negative, and its type is long, convert it back to
1045 if (s
.st_size
< 0 && sizeof (s
.st_size
) == sizeof (long))
1046 values
[7] = make_float ((double) ((unsigned long) s
.st_size
));
1048 filemodestring (&s
, modes
);
1049 values
[8] = make_string (modes
, 10);
1050 #if defined (BSD4_2) || defined (BSD4_3) /* file gid will be dir gid */
1051 dirname
= Ffile_name_directory (filename
);
1052 if (! NILP (dirname
))
1053 encoded
= ENCODE_FILE (dirname
);
1054 if (! NILP (dirname
) && stat (SDATA (encoded
), &sdir
) == 0)
1055 values
[9] = (sdir
.st_gid
!= s
.st_gid
) ? Qt
: Qnil
;
1056 else /* if we can't tell, assume worst */
1058 #else /* file gid will be egid */
1059 values
[9] = (s
.st_gid
!= getegid ()) ? Qt
: Qnil
;
1060 #endif /* BSD4_2 (or BSD4_3) */
1061 /* Shut up GCC warnings in FIXNUM_OVERFLOW_P below. */
1062 if (sizeof (s
.st_ino
) > sizeof (ino
))
1063 ino
= (EMACS_INT
)(s
.st_ino
& 0xffffffff);
1066 if (!FIXNUM_OVERFLOW_P (ino
)
1067 && (sizeof (s
.st_ino
) <= sizeof (ino
) || (s
.st_ino
& ~INTMASK
) == 0))
1068 /* Keep the most common cases as integers. */
1069 values
[10] = make_number (ino
);
1070 else if (sizeof (s
.st_ino
) <= sizeof (ino
)
1071 || ((s
.st_ino
>> 16) & ~INTMASK
) == 0)
1072 /* To allow inode numbers larger than VALBITS, separate the bottom
1074 values
[10] = Fcons (make_number ((EMACS_INT
)(s
.st_ino
>> 16)),
1075 make_number ((EMACS_INT
)(s
.st_ino
& 0xffff)));
1078 /* To allow inode numbers beyond 32 bits, separate into 2 24-bit
1079 high parts and a 16-bit bottom part. */
1080 EMACS_INT high_ino
= s
.st_ino
>> 32;
1081 EMACS_INT low_ino
= s
.st_ino
& 0xffffffff;
1083 values
[10] = Fcons (make_number (high_ino
>> 8),
1084 Fcons (make_number (((high_ino
& 0xff) << 16)
1086 make_number (low_ino
& 0xffff)));
1089 /* Likewise for device, but don't let it become negative. We used
1090 to use FIXNUM_OVERFLOW_P here, but that won't catch large
1091 positive numbers such as 0xFFEEDDCC. */
1092 if ((EMACS_INT
)s
.st_dev
< 0
1093 || (EMACS_INT
)s
.st_dev
> MOST_POSITIVE_FIXNUM
)
1094 values
[11] = Fcons (make_number (s
.st_dev
>> 16),
1095 make_number (s
.st_dev
& 0xffff));
1097 values
[11] = make_number (s
.st_dev
);
1099 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
1102 DEFUN ("file-attributes-lessp", Ffile_attributes_lessp
, Sfile_attributes_lessp
, 2, 2, 0,
1103 doc
: /* Return t if first arg file attributes list is less than second.
1104 Comparison is in lexicographic order and case is significant. */)
1108 return Fstring_lessp (Fcar (f1
), Fcar (f2
));
1114 Qdirectory_files
= intern ("directory-files");
1115 Qdirectory_files_and_attributes
= intern ("directory-files-and-attributes");
1116 Qfile_name_completion
= intern ("file-name-completion");
1117 Qfile_name_all_completions
= intern ("file-name-all-completions");
1118 Qfile_attributes
= intern ("file-attributes");
1119 Qfile_attributes_lessp
= intern ("file-attributes-lessp");
1120 Qdefault_directory
= intern ("default-directory");
1122 staticpro (&Qdirectory_files
);
1123 staticpro (&Qdirectory_files_and_attributes
);
1124 staticpro (&Qfile_name_completion
);
1125 staticpro (&Qfile_name_all_completions
);
1126 staticpro (&Qfile_attributes
);
1127 staticpro (&Qfile_attributes_lessp
);
1128 staticpro (&Qdefault_directory
);
1130 defsubr (&Sdirectory_files
);
1131 defsubr (&Sdirectory_files_and_attributes
);
1132 defsubr (&Sfile_name_completion
);
1134 defsubr (&Sfile_name_all_versions
);
1135 defsubr (&Sfile_version_limit
);
1137 defsubr (&Sfile_name_all_completions
);
1138 defsubr (&Sfile_attributes
);
1139 defsubr (&Sfile_attributes_lessp
);
1141 DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions
,
1142 doc
: /* Completion ignores file names ending in any string in this list.
1143 It does not ignore them if all possible completions end in one of
1144 these strings or when displaying a list of completions.
1145 It ignores directory names if they match any string in this list which
1146 ends in a slash. */);
1147 Vcompletion_ignored_extensions
= Qnil
;
1150 /* arch-tag: 1ac8deca-4d8f-4d41-ade9-089154d98c03
1151 (do not change this comment) */