Commit | Line | Data |
---|---|---|
14d55bce | 1 | /* Lisp functions for making directory listings. |
0b5538bd | 2 | Copyright (C) 1985, 1986, 1993, 1994, 1999, 2000, 2001, 2002, 2003, |
76b6f707 | 3 | 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
14d55bce RS |
4 | |
5 | This file is part of GNU Emacs. | |
6 | ||
9ec0b715 | 7 | GNU Emacs is free software: you can redistribute it and/or modify |
14d55bce | 8 | it under the terms of the GNU General Public License as published by |
9ec0b715 GM |
9 | the Free Software Foundation, either version 3 of the License, or |
10 | (at your option) any later version. | |
14d55bce RS |
11 | |
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. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
9ec0b715 | 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
14d55bce RS |
19 | |
20 | ||
3964b9a7 RS |
21 | #include <config.h> |
22 | ||
14d55bce RS |
23 | #include <stdio.h> |
24 | #include <sys/types.h> | |
25 | #include <sys/stat.h> | |
d7306fe6 | 26 | #include <setjmp.h> |
14d55bce | 27 | |
5b9c0a1d | 28 | #ifdef HAVE_PWD_H |
6b61353c | 29 | #include <pwd.h> |
5b9c0a1d | 30 | #endif |
6b61353c | 31 | #include <grp.h> |
6b61353c | 32 | |
7cc9f69f | 33 | #include <errno.h> |
68c45bf0 | 34 | |
dfcf069d AS |
35 | #ifdef HAVE_UNISTD_H |
36 | #include <unistd.h> | |
37 | #endif | |
38 | ||
d6717cdb JB |
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. | |
47 | ||
48 | Since applying strlen to the name always works, we'll just do that. */ | |
49 | #define NAMLEN(p) strlen (p->d_name) | |
50 | ||
14d55bce RS |
51 | #ifdef SYSV_SYSTEM_DIR |
52 | ||
53 | #include <dirent.h> | |
54 | #define DIRENTRY struct dirent | |
14d55bce | 55 | |
128ecc89 | 56 | #else /* not SYSV_SYSTEM_DIR */ |
14d55bce | 57 | |
128ecc89 RS |
58 | #ifdef MSDOS |
59 | #include <dirent.h> | |
60 | #else | |
14d55bce | 61 | #include <sys/dir.h> |
128ecc89 | 62 | #endif |
14d55bce | 63 | |
851cab13 DL |
64 | #include <sys/stat.h> |
65 | ||
128ecc89 | 66 | #ifndef MSDOS |
14d55bce | 67 | #define DIRENTRY struct direct |
14d55bce RS |
68 | |
69 | extern DIR *opendir (); | |
70 | extern struct direct *readdir (); | |
71 | ||
128ecc89 RS |
72 | #endif /* not MSDOS */ |
73 | #endif /* not SYSV_SYSTEM_DIR */ | |
74 | ||
8f7f8c65 EZ |
75 | /* Some versions of Cygwin don't have d_ino in `struct dirent'. */ |
76 | #if defined(MSDOS) || defined(__CYGWIN__) | |
128ecc89 RS |
77 | #define DIRENTRY_NONEMPTY(p) ((p)->d_name[0] != 0) |
78 | #else | |
79 | #define DIRENTRY_NONEMPTY(p) ((p)->d_ino) | |
14d55bce RS |
80 | #endif |
81 | ||
14d55bce | 82 | #include "lisp.h" |
fa8459a3 | 83 | #include "systime.h" |
14d55bce RS |
84 | #include "buffer.h" |
85 | #include "commands.h" | |
d2f6dae8 | 86 | #include "character.h" |
bd33479f KH |
87 | #include "charset.h" |
88 | #include "coding.h" | |
14d55bce | 89 | #include "regex.h" |
8c8a7c58 | 90 | #include "blockinput.h" |
14d55bce | 91 | |
e50c66d3 KH |
92 | /* Returns a search buffer, with a fastmap allocated and ready to go. */ |
93 | extern struct re_pattern_buffer *compile_pattern (); | |
c7e466e1 | 94 | |
851cab13 DL |
95 | /* From filemode.c. Can't go in Lisp.h because of `stat'. */ |
96 | extern void filemodestring P_ ((struct stat *, char *)); | |
97 | ||
14d55bce RS |
98 | /* if system does not have symbolic links, it does not have lstat. |
99 | In that case, use ordinary stat instead. */ | |
100 | ||
101 | #ifndef S_IFLNK | |
102 | #define lstat stat | |
103 | #endif | |
104 | ||
97e98a56 | 105 | extern int completion_ignore_case; |
ecd3f8b2 | 106 | extern Lisp_Object Qcompletion_ignore_case; |
f676868d | 107 | extern Lisp_Object Vcompletion_regexp_list; |
65156807 | 108 | extern Lisp_Object Vw32_get_true_file_attributes; |
ccbcf979 | 109 | |
14d55bce | 110 | Lisp_Object Vcompletion_ignored_extensions; |
32f4334d | 111 | Lisp_Object Qdirectory_files; |
4424b255 | 112 | Lisp_Object Qdirectory_files_and_attributes; |
32f4334d RS |
113 | Lisp_Object Qfile_name_completion; |
114 | Lisp_Object Qfile_name_all_completions; | |
434e6714 | 115 | Lisp_Object Qfile_attributes; |
4424b255 | 116 | Lisp_Object Qfile_attributes_lessp; |
b3f04ced RS |
117 | |
118 | static int scmp P_ ((unsigned char *, unsigned char *, int)); | |
14d55bce | 119 | \f |
65156807 EZ |
120 | #ifdef WINDOWSNT |
121 | Lisp_Object | |
122 | directory_files_internal_w32_unwind (Lisp_Object arg) | |
123 | { | |
124 | Vw32_get_true_file_attributes = arg; | |
125 | return Qnil; | |
126 | } | |
127 | #endif | |
2488aba5 AI |
128 | |
129 | Lisp_Object | |
130 | directory_files_internal_unwind (dh) | |
131 | Lisp_Object dh; | |
132 | { | |
9d291bdf | 133 | DIR *d = (DIR *) XSAVE_VALUE (dh)->pointer; |
d15b573e | 134 | BLOCK_INPUT; |
2488aba5 | 135 | closedir (d); |
d15b573e | 136 | UNBLOCK_INPUT; |
2488aba5 AI |
137 | return Qnil; |
138 | } | |
139 | ||
177c0ea7 | 140 | /* Function shared by Fdirectory_files and Fdirectory_files_and_attributes. |
4424b255 | 141 | When ATTRS is zero, return a list of directory filenames; when |
6b61353c KH |
142 | non-zero, return a list of directory filenames and their attributes. |
143 | In the latter case, ID_FORMAT is passed to Ffile_attributes. */ | |
f69f9da1 | 144 | |
4424b255 | 145 | Lisp_Object |
6b61353c | 146 | directory_files_internal (directory, full, match, nosort, attrs, id_format) |
23bd240f | 147 | Lisp_Object directory, full, match, nosort; |
4424b255 | 148 | int attrs; |
6b61353c | 149 | Lisp_Object id_format; |
14d55bce RS |
150 | { |
151 | DIR *d; | |
388ac098 GM |
152 | int directory_nbytes; |
153 | Lisp_Object list, dirfilename, encoded_directory; | |
6bbd7a29 | 154 | struct re_pattern_buffer *bufp = NULL; |
96d64004 | 155 | int needsep = 0; |
aed13378 | 156 | int count = SPECPDL_INDEX (); |
388ac098 | 157 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5; |
8e42f043 | 158 | DIRENTRY *dp; |
65156807 EZ |
159 | #ifdef WINDOWSNT |
160 | Lisp_Object w32_save = Qnil; | |
161 | #endif | |
32f4334d | 162 | |
96d64004 | 163 | /* Because of file name handlers, these functions might call |
6155fae1 | 164 | Ffuncall, and cause a GC. */ |
388ac098 GM |
165 | list = encoded_directory = dirfilename = Qnil; |
166 | GCPRO5 (match, directory, list, dirfilename, encoded_directory); | |
96d64004 | 167 | dirfilename = Fdirectory_file_name (directory); |
6155fae1 | 168 | |
265a9e55 | 169 | if (!NILP (match)) |
14d55bce | 170 | { |
b7826503 | 171 | CHECK_STRING (match); |
ebb9e16f JB |
172 | |
173 | /* MATCH might be a flawed regular expression. Rather than | |
8e6208c5 | 174 | catching and signaling our own errors, we just call |
ebb9e16f | 175 | compile_pattern to do the work for us. */ |
c872c6b2 RS |
176 | /* Pass 1 for the MULTIBYTE arg |
177 | because we do make multibyte strings if the contents warrant. */ | |
1a9fbabe EZ |
178 | # ifdef WINDOWSNT |
179 | /* Windows users want case-insensitive wildcards. */ | |
180 | bufp = compile_pattern (match, 0, | |
181 | buffer_defaults.case_canon_table, 0, 1); | |
182 | # else /* !WINDOWSNT */ | |
3e937712 | 183 | bufp = compile_pattern (match, 0, Qnil, 0, 1); |
1a9fbabe | 184 | # endif /* !WINDOWSNT */ |
14d55bce RS |
185 | } |
186 | ||
b3edfc9b | 187 | /* Note: ENCODE_FILE and DECODE_FILE can GC because they can run |
388ac098 GM |
188 | run_pre_post_conversion_on_str which calls Lisp directly and |
189 | indirectly. */ | |
6c8b4f07 SM |
190 | if (STRING_MULTIBYTE (dirfilename)) |
191 | dirfilename = ENCODE_FILE (dirfilename); | |
192 | encoded_directory = (STRING_MULTIBYTE (directory) | |
193 | ? ENCODE_FILE (directory) : directory); | |
24c2a54f | 194 | |
e50c66d3 | 195 | /* Now *bufp is the compiled form of MATCH; don't call anything |
6155fae1 JB |
196 | which might compile a new regexp until we're done with the loop! */ |
197 | ||
d15b573e | 198 | BLOCK_INPUT; |
d5db4077 | 199 | d = opendir (SDATA (dirfilename)); |
d15b573e | 200 | UNBLOCK_INPUT; |
388ac098 | 201 | if (d == NULL) |
23bd240f | 202 | report_file_error ("Opening directory", Fcons (directory, Qnil)); |
14d55bce | 203 | |
2488aba5 AI |
204 | /* Unfortunately, we can now invoke expand-file-name and |
205 | file-attributes on filenames, both of which can throw, so we must | |
206 | do a proper unwind-protect. */ | |
207 | record_unwind_protect (directory_files_internal_unwind, | |
9d291bdf | 208 | make_save_value (d, 0)); |
2488aba5 | 209 | |
65156807 EZ |
210 | #ifdef WINDOWSNT |
211 | if (attrs) | |
212 | { | |
213 | extern Lisp_Object Qlocal; | |
214 | extern int is_slow_fs (const char *); | |
215 | ||
216 | /* Do this only once to avoid doing it (in w32.c:stat) for each | |
217 | file in the directory, when we call Ffile_attributes below. */ | |
218 | record_unwind_protect (directory_files_internal_w32_unwind, | |
219 | Vw32_get_true_file_attributes); | |
220 | w32_save = Vw32_get_true_file_attributes; | |
221 | if (EQ (Vw32_get_true_file_attributes, Qlocal)) | |
222 | { | |
65156807 EZ |
223 | /* w32.c:stat will notice these bindings and avoid calling |
224 | GetDriveType for each file. */ | |
b6046155 | 225 | if (is_slow_fs (SDATA (dirfilename))) |
65156807 EZ |
226 | Vw32_get_true_file_attributes = Qnil; |
227 | else | |
228 | Vw32_get_true_file_attributes = Qt; | |
229 | } | |
230 | } | |
231 | #endif | |
232 | ||
d5db4077 | 233 | directory_nbytes = SBYTES (directory); |
c81a9bdc | 234 | re_match_object = Qt; |
14d55bce | 235 | |
96d64004 | 236 | /* Decide whether we need to add a directory separator. */ |
388ac098 | 237 | if (directory_nbytes == 0 |
d5db4077 | 238 | || !IS_ANY_SEP (SREF (directory, directory_nbytes - 1))) |
96d64004 | 239 | needsep = 1; |
96d64004 | 240 | |
8e42f043 | 241 | /* Loop reading blocks until EOF or error. */ |
f69f9da1 | 242 | for (;;) |
14d55bce | 243 | { |
f69f9da1 GM |
244 | errno = 0; |
245 | dp = readdir (d); | |
246 | ||
9d291bdf | 247 | if (dp == NULL && (0 |
f69f9da1 | 248 | #ifdef EAGAIN |
9d291bdf SM |
249 | || errno == EAGAIN |
250 | #endif | |
251 | #ifdef EINTR | |
252 | || errno == EINTR | |
f69f9da1 | 253 | #endif |
9d291bdf SM |
254 | )) |
255 | { QUIT; continue; } | |
177c0ea7 | 256 | |
f69f9da1 GM |
257 | if (dp == NULL) |
258 | break; | |
259 | ||
128ecc89 | 260 | if (DIRENTRY_NONEMPTY (dp)) |
14d55bce | 261 | { |
e23f810c | 262 | int len; |
2488aba5 | 263 | int wanted = 0; |
388ac098 GM |
264 | Lisp_Object name, finalname; |
265 | struct gcpro gcpro1, gcpro2; | |
e23f810c KH |
266 | |
267 | len = NAMLEN (dp); | |
9ad4f3e5 | 268 | name = finalname = make_unibyte_string (dp->d_name, len); |
388ac098 | 269 | GCPRO2 (finalname, name); |
177c0ea7 | 270 | |
6c8b4f07 | 271 | /* Note: DECODE_FILE can GC; it should protect its argument, |
388ac098 GM |
272 | though. */ |
273 | name = DECODE_FILE (name); | |
d5db4077 | 274 | len = SBYTES (name); |
e23f810c | 275 | |
2488aba5 AI |
276 | /* Now that we have unwind_protect in place, we might as well |
277 | allow matching to be interrupted. */ | |
278 | immediate_quit = 1; | |
279 | QUIT; | |
280 | ||
265a9e55 | 281 | if (NILP (match) |
d5db4077 | 282 | || (0 <= re_search (bufp, SDATA (name), len, 0, len, 0))) |
388ac098 | 283 | wanted = 1; |
2488aba5 AI |
284 | |
285 | immediate_quit = 0; | |
286 | ||
287 | if (wanted) | |
14d55bce | 288 | { |
265a9e55 | 289 | if (!NILP (full)) |
14d55bce | 290 | { |
e23f810c | 291 | Lisp_Object fullname; |
388ac098 GM |
292 | int nbytes = len + directory_nbytes + needsep; |
293 | int nchars; | |
5617588f | 294 | |
388ac098 | 295 | fullname = make_uninit_multibyte_string (nbytes, nbytes); |
d5db4077 | 296 | bcopy (SDATA (directory), SDATA (fullname), |
388ac098 | 297 | directory_nbytes); |
177c0ea7 | 298 | |
5617588f | 299 | if (needsep) |
d549c5db | 300 | SSET (fullname, directory_nbytes, DIRECTORY_SEP); |
177c0ea7 | 301 | |
d5db4077 KR |
302 | bcopy (SDATA (name), |
303 | SDATA (fullname) + directory_nbytes + needsep, | |
388ac098 | 304 | len); |
177c0ea7 | 305 | |
d5db4077 | 306 | nchars = chars_in_text (SDATA (fullname), nbytes); |
388ac098 GM |
307 | |
308 | /* Some bug somewhere. */ | |
309 | if (nchars > nbytes) | |
310 | abort (); | |
177c0ea7 | 311 | |
437fcd47 | 312 | STRING_SET_CHARS (fullname, nchars); |
388ac098 | 313 | if (nchars == nbytes) |
d5db4077 | 314 | STRING_SET_UNIBYTE (fullname); |
177c0ea7 | 315 | |
4424b255 GV |
316 | finalname = fullname; |
317 | } | |
aab9c564 KH |
318 | else |
319 | finalname = name; | |
4424b255 GV |
320 | |
321 | if (attrs) | |
322 | { | |
323 | /* Construct an expanded filename for the directory entry. | |
324 | Use the decoded names for input to Ffile_attributes. */ | |
388ac098 GM |
325 | Lisp_Object decoded_fullname, fileattrs; |
326 | struct gcpro gcpro1, gcpro2; | |
327 | ||
328 | decoded_fullname = fileattrs = Qnil; | |
329 | GCPRO2 (decoded_fullname, fileattrs); | |
4424b255 | 330 | |
388ac098 | 331 | /* Both Fexpand_file_name and Ffile_attributes can GC. */ |
4424b255 | 332 | decoded_fullname = Fexpand_file_name (name, directory); |
6b61353c | 333 | fileattrs = Ffile_attributes (decoded_fullname, id_format); |
4424b255 GV |
334 | |
335 | list = Fcons (Fcons (finalname, fileattrs), list); | |
388ac098 | 336 | UNGCPRO; |
4424b255 GV |
337 | } |
338 | else | |
388ac098 | 339 | list = Fcons (finalname, list); |
14d55bce | 340 | } |
388ac098 GM |
341 | |
342 | UNGCPRO; | |
14d55bce RS |
343 | } |
344 | } | |
2488aba5 | 345 | |
d15b573e | 346 | BLOCK_INPUT; |
14d55bce | 347 | closedir (d); |
d15b573e | 348 | UNBLOCK_INPUT; |
65156807 EZ |
349 | #ifdef WINDOWSNT |
350 | if (attrs) | |
351 | Vw32_get_true_file_attributes = w32_save; | |
352 | #endif | |
2488aba5 AI |
353 | |
354 | /* Discard the unwind protect. */ | |
355 | specpdl_ptr = specpdl + count; | |
356 | ||
388ac098 GM |
357 | if (NILP (nosort)) |
358 | list = Fsort (Fnreverse (list), | |
359 | attrs ? Qfile_attributes_lessp : Qstring_lessp); | |
177c0ea7 | 360 | |
388ac098 | 361 | RETURN_UNGCPRO (list); |
14d55bce | 362 | } |
4424b255 GV |
363 | |
364 | ||
365 | DEFUN ("directory-files", Fdirectory_files, Sdirectory_files, 1, 4, 0, | |
335c5470 PJ |
366 | doc: /* Return a list of names of files in DIRECTORY. |
367 | There are three optional arguments: | |
368 | If FULL is non-nil, return absolute file names. Otherwise return names | |
369 | that are relative to the specified directory. | |
370 | If MATCH is non-nil, mention only file names that match the regexp MATCH. | |
371 | If NOSORT is non-nil, the list is not sorted--its order is unpredictable. | |
a489517b JB |
372 | Otherwise, the list returned is sorted with `string-lessp'. |
373 | NOSORT is useful if you plan to sort the result yourself. */) | |
335c5470 | 374 | (directory, full, match, nosort) |
4424b255 GV |
375 | Lisp_Object directory, full, match, nosort; |
376 | { | |
377 | Lisp_Object handler; | |
4ece81a6 | 378 | directory = Fexpand_file_name (directory, Qnil); |
4424b255 GV |
379 | |
380 | /* If the file name has special constructs in it, | |
381 | call the corresponding file handler. */ | |
382 | handler = Ffind_file_name_handler (directory, Qdirectory_files); | |
383 | if (!NILP (handler)) | |
6b61353c KH |
384 | return call5 (handler, Qdirectory_files, directory, |
385 | full, match, nosort); | |
4424b255 | 386 | |
6b61353c | 387 | return directory_files_internal (directory, full, match, nosort, 0, Qnil); |
4424b255 GV |
388 | } |
389 | ||
335c5470 | 390 | DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes, |
6b61353c | 391 | Sdirectory_files_and_attributes, 1, 5, 0, |
335c5470 | 392 | doc: /* Return a list of names of files and their attributes in DIRECTORY. |
6b61353c | 393 | There are four optional arguments: |
335c5470 PJ |
394 | If FULL is non-nil, return absolute file names. Otherwise return names |
395 | that are relative to the specified directory. | |
396 | If MATCH is non-nil, mention only file names that match the regexp MATCH. | |
397 | If NOSORT is non-nil, the list is not sorted--its order is unpredictable. | |
6b61353c KH |
398 | NOSORT is useful if you plan to sort the result yourself. |
399 | ID-FORMAT specifies the preferred format of attributes uid and gid, see | |
6c5665e9 EZ |
400 | `file-attributes' for further documentation. |
401 | On MS-Windows, performance depends on `w32-get-true-file-attributes', | |
402 | which see. */) | |
6b61353c KH |
403 | (directory, full, match, nosort, id_format) |
404 | Lisp_Object directory, full, match, nosort, id_format; | |
4424b255 GV |
405 | { |
406 | Lisp_Object handler; | |
4ece81a6 | 407 | directory = Fexpand_file_name (directory, Qnil); |
4424b255 GV |
408 | |
409 | /* If the file name has special constructs in it, | |
410 | call the corresponding file handler. */ | |
411 | handler = Ffind_file_name_handler (directory, Qdirectory_files_and_attributes); | |
412 | if (!NILP (handler)) | |
6b61353c KH |
413 | return call6 (handler, Qdirectory_files_and_attributes, |
414 | directory, full, match, nosort, id_format); | |
4424b255 | 415 | |
6b61353c | 416 | return directory_files_internal (directory, full, match, nosort, 1, id_format); |
4424b255 GV |
417 | } |
418 | ||
14d55bce RS |
419 | \f |
420 | Lisp_Object file_name_completion (); | |
421 | ||
422 | DEFUN ("file-name-completion", Ffile_name_completion, Sfile_name_completion, | |
abfb1932 | 423 | 2, 3, 0, |
335c5470 PJ |
424 | doc: /* Complete file name FILE in directory DIRECTORY. |
425 | Returns the longest string | |
426 | common to all file names in DIRECTORY that start with FILE. | |
427 | If there is only one and FILE matches it exactly, returns t. | |
2f60660a | 428 | Returns nil if DIRECTORY contains no name starting with FILE. |
335c5470 | 429 | |
b6ce54d6 RS |
430 | If PREDICATE is non-nil, call PREDICATE with each possible |
431 | completion (in absolute form) and ignore it if PREDICATE returns nil. | |
432 | ||
335c5470 PJ |
433 | This function ignores some of the possible completions as |
434 | determined by the variable `completion-ignored-extensions', which see. */) | |
abfb1932 RS |
435 | (file, directory, predicate) |
436 | Lisp_Object file, directory, predicate; | |
14d55bce | 437 | { |
32f4334d | 438 | Lisp_Object handler; |
32f4334d | 439 | |
8436e231 | 440 | /* If the directory name has special constructs in it, |
32f4334d | 441 | call the corresponding file handler. */ |
23bd240f | 442 | handler = Ffind_file_name_handler (directory, Qfile_name_completion); |
32f4334d | 443 | if (!NILP (handler)) |
abfb1932 | 444 | return call4 (handler, Qfile_name_completion, file, directory, predicate); |
32f4334d | 445 | |
8436e231 RS |
446 | /* If the file name has special constructs in it, |
447 | call the corresponding file handler. */ | |
448 | handler = Ffind_file_name_handler (file, Qfile_name_completion); | |
449 | if (!NILP (handler)) | |
abfb1932 | 450 | return call4 (handler, Qfile_name_completion, file, directory, predicate); |
8436e231 | 451 | |
abfb1932 | 452 | return file_name_completion (file, directory, 0, 0, predicate); |
14d55bce RS |
453 | } |
454 | ||
455 | DEFUN ("file-name-all-completions", Ffile_name_all_completions, | |
335c5470 PJ |
456 | Sfile_name_all_completions, 2, 2, 0, |
457 | doc: /* Return a list of all completions of file name FILE in directory DIRECTORY. | |
458 | These are all file names in directory DIRECTORY which begin with FILE. */) | |
459 | (file, directory) | |
23bd240f | 460 | Lisp_Object file, directory; |
14d55bce | 461 | { |
32f4334d RS |
462 | Lisp_Object handler; |
463 | ||
8436e231 | 464 | /* If the directory name has special constructs in it, |
32f4334d | 465 | call the corresponding file handler. */ |
23bd240f | 466 | handler = Ffind_file_name_handler (directory, Qfile_name_all_completions); |
32f4334d | 467 | if (!NILP (handler)) |
23bd240f | 468 | return call3 (handler, Qfile_name_all_completions, file, directory); |
32f4334d | 469 | |
8436e231 RS |
470 | /* If the file name has special constructs in it, |
471 | call the corresponding file handler. */ | |
472 | handler = Ffind_file_name_handler (file, Qfile_name_all_completions); | |
473 | if (!NILP (handler)) | |
23bd240f | 474 | return call3 (handler, Qfile_name_all_completions, file, directory); |
8436e231 | 475 | |
abfb1932 | 476 | return file_name_completion (file, directory, 1, 0, Qnil); |
14d55bce RS |
477 | } |
478 | ||
dfcf069d | 479 | static int file_name_completion_stat (); |
01bb4018 | 480 | Lisp_Object Qdefault_directory; |
dfcf069d | 481 | |
14d55bce | 482 | Lisp_Object |
abfb1932 | 483 | file_name_completion (file, dirname, all_flag, ver_flag, predicate) |
14d55bce RS |
484 | Lisp_Object file, dirname; |
485 | int all_flag, ver_flag; | |
abfb1932 | 486 | Lisp_Object predicate; |
14d55bce RS |
487 | { |
488 | DIR *d; | |
3271a8f5 | 489 | int bestmatchsize = 0; |
14d55bce | 490 | int matchcount = 0; |
abfb1932 RS |
491 | /* If ALL_FLAG is 1, BESTMATCH is the list of all matches, decoded. |
492 | If ALL_FLAG is 0, BESTMATCH is either nil | |
493 | or the best match so far, not decoded. */ | |
14d55bce | 494 | Lisp_Object bestmatch, tem, elt, name; |
24c2a54f RS |
495 | Lisp_Object encoded_file; |
496 | Lisp_Object encoded_dir; | |
14d55bce RS |
497 | struct stat st; |
498 | int directoryp; | |
3271a8f5 SM |
499 | /* If includeall is zero, exclude files in completion-ignored-extensions as |
500 | well as "." and "..". Until shown otherwise, assume we can't exclude | |
501 | anything. */ | |
502 | int includeall = 1; | |
aed13378 | 503 | int count = SPECPDL_INDEX (); |
24c2a54f | 504 | struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5; |
3fcc88cc | 505 | |
6bbd7a29 GM |
506 | elt = Qnil; |
507 | ||
b7826503 | 508 | CHECK_STRING (file); |
14d55bce | 509 | |
128ecc89 RS |
510 | #ifdef FILE_SYSTEM_CASE |
511 | file = FILE_SYSTEM_CASE (file); | |
512 | #endif | |
14d55bce | 513 | bestmatch = Qnil; |
24c2a54f RS |
514 | encoded_file = encoded_dir = Qnil; |
515 | GCPRO5 (file, dirname, bestmatch, encoded_file, encoded_dir); | |
3fcc88cc | 516 | dirname = Fexpand_file_name (dirname, Qnil); |
01bb4018 | 517 | specbind (Qdefault_directory, dirname); |
14d55bce | 518 | |
24c2a54f RS |
519 | /* Do completion on the encoded file name |
520 | because the other names in the directory are (we presume) | |
521 | encoded likewise. We decode the completed string at the end. */ | |
2a54a229 SM |
522 | /* Actually, this is not quite true any more: we do most of the completion |
523 | work with decoded file names, but we still do some filtering based | |
524 | on the encoded file name. */ | |
6c8b4f07 | 525 | encoded_file = STRING_MULTIBYTE (file) ? ENCODE_FILE (file) : file; |
24c2a54f RS |
526 | |
527 | encoded_dir = ENCODE_FILE (dirname); | |
528 | ||
3271a8f5 SM |
529 | BLOCK_INPUT; |
530 | d = opendir (SDATA (Fdirectory_file_name (encoded_dir))); | |
531 | UNBLOCK_INPUT; | |
532 | if (!d) | |
533 | report_file_error ("Opening directory", Fcons (dirname, Qnil)); | |
14d55bce | 534 | |
3271a8f5 SM |
535 | record_unwind_protect (directory_files_internal_unwind, |
536 | make_save_value (d, 0)); | |
14d55bce | 537 | |
3271a8f5 SM |
538 | /* Loop reading blocks */ |
539 | /* (att3b compiler bug requires do a null comparison this way) */ | |
540 | while (1) | |
14d55bce | 541 | { |
3271a8f5 SM |
542 | DIRENTRY *dp; |
543 | int len; | |
544 | int canexclude = 0; | |
14d55bce | 545 | |
3271a8f5 SM |
546 | errno = 0; |
547 | dp = readdir (d); | |
548 | if (dp == NULL && (0 | |
9d291bdf | 549 | # ifdef EAGAIN |
3271a8f5 | 550 | || errno == EAGAIN |
9d291bdf SM |
551 | # endif |
552 | # ifdef EINTR | |
3271a8f5 | 553 | || errno == EINTR |
9d291bdf | 554 | # endif |
3271a8f5 SM |
555 | )) |
556 | { QUIT; continue; } | |
9d291bdf | 557 | |
3271a8f5 | 558 | if (!dp) break; |
14d55bce | 559 | |
3271a8f5 | 560 | len = NAMLEN (dp); |
14d55bce | 561 | |
3271a8f5 SM |
562 | QUIT; |
563 | if (! DIRENTRY_NONEMPTY (dp) | |
564 | || len < SCHARS (encoded_file) | |
565 | || 0 <= scmp (dp->d_name, SDATA (encoded_file), | |
566 | SCHARS (encoded_file))) | |
567 | continue; | |
14d55bce | 568 | |
3271a8f5 SM |
569 | if (file_name_completion_stat (encoded_dir, dp, &st) < 0) |
570 | continue; | |
14d55bce | 571 | |
3271a8f5 SM |
572 | directoryp = ((st.st_mode & S_IFMT) == S_IFDIR); |
573 | tem = Qnil; | |
574 | /* If all_flag is set, always include all. | |
575 | It would not actually be helpful to the user to ignore any possible | |
576 | completions when making a list of them. */ | |
577 | if (!all_flag) | |
578 | { | |
579 | int skip; | |
2cd298e2 | 580 | |
7519c40d | 581 | #if 0 /* FIXME: The `scmp' call compares an encoded and a decoded string. */ |
2cd298e2 SM |
582 | /* If this entry matches the current bestmatch, the only |
583 | thing it can do is increase matchcount, so don't bother | |
584 | investigating it any further. */ | |
585 | if (!completion_ignore_case | |
586 | /* The return result depends on whether it's the sole match. */ | |
587 | && matchcount > 1 | |
588 | && !includeall /* This match may allow includeall to 0. */ | |
589 | && len >= bestmatchsize | |
590 | && 0 > scmp (dp->d_name, SDATA (bestmatch), bestmatchsize)) | |
591 | continue; | |
7519c40d | 592 | #endif |
2cd298e2 | 593 | |
3271a8f5 | 594 | if (directoryp) |
ad456ad4 RS |
595 | { |
596 | #ifndef TRIVIAL_DIRECTORY_ENTRY | |
597 | #define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, "..")) | |
598 | #endif | |
abfb1932 RS |
599 | /* "." and ".." are never interesting as completions, and are |
600 | actually in the way in a directory with only one file. */ | |
3271a8f5 SM |
601 | if (TRIVIAL_DIRECTORY_ENTRY (dp->d_name)) |
602 | canexclude = 1; | |
603 | else if (len > SCHARS (encoded_file)) | |
d013f29b EZ |
604 | /* Ignore directories if they match an element of |
605 | completion-ignored-extensions which ends in a slash. */ | |
606 | for (tem = Vcompletion_ignored_extensions; | |
607 | CONSP (tem); tem = XCDR (tem)) | |
608 | { | |
609 | int elt_len; | |
2a54a229 | 610 | unsigned char *p1; |
d013f29b EZ |
611 | |
612 | elt = XCAR (tem); | |
613 | if (!STRINGP (elt)) | |
614 | continue; | |
a74aaa9d EZ |
615 | /* Need to encode ELT, since scmp compares unibyte |
616 | strings only. */ | |
617 | elt = ENCODE_FILE (elt); | |
d5db4077 | 618 | elt_len = SCHARS (elt) - 1; /* -1 for trailing / */ |
7a8d465a | 619 | if (elt_len <= 0) |
d013f29b | 620 | continue; |
d5db4077 | 621 | p1 = SDATA (elt); |
d013f29b EZ |
622 | if (p1[elt_len] != '/') |
623 | continue; | |
624 | skip = len - elt_len; | |
625 | if (skip < 0) | |
626 | continue; | |
627 | ||
628 | if (0 <= scmp (dp->d_name + skip, p1, elt_len)) | |
629 | continue; | |
630 | break; | |
631 | } | |
ad456ad4 RS |
632 | } |
633 | else | |
3271a8f5 | 634 | { |
14d55bce RS |
635 | /* Compare extensions-to-be-ignored against end of this file name */ |
636 | /* if name is not an exact match against specified string */ | |
3271a8f5 | 637 | if (len > SCHARS (encoded_file)) |
14d55bce RS |
638 | /* and exit this for loop if a match is found */ |
639 | for (tem = Vcompletion_ignored_extensions; | |
70949dac | 640 | CONSP (tem); tem = XCDR (tem)) |
14d55bce | 641 | { |
70949dac | 642 | elt = XCAR (tem); |
88cf1852 | 643 | if (!STRINGP (elt)) continue; |
a74aaa9d EZ |
644 | /* Need to encode ELT, since scmp compares unibyte |
645 | strings only. */ | |
646 | elt = ENCODE_FILE (elt); | |
d5db4077 | 647 | skip = len - SCHARS (elt); |
14d55bce RS |
648 | if (skip < 0) continue; |
649 | ||
650 | if (0 <= scmp (dp->d_name + skip, | |
d5db4077 KR |
651 | SDATA (elt), |
652 | SCHARS (elt))) | |
14d55bce RS |
653 | continue; |
654 | break; | |
655 | } | |
656 | } | |
657 | ||
f676868d KH |
658 | /* If an ignored-extensions match was found, |
659 | don't process this name as a completion. */ | |
3271a8f5 SM |
660 | if (CONSP (tem)) |
661 | canexclude = 1; | |
f676868d | 662 | |
3271a8f5 SM |
663 | if (!includeall && canexclude) |
664 | /* We're not including all files and this file can be excluded. */ | |
665 | continue; | |
9c691c00 | 666 | |
3271a8f5 SM |
667 | if (includeall && !canexclude) |
668 | { /* If we have one non-excludable file, we want to exclude the | |
669 | excudable files. */ | |
670 | includeall = 0; | |
671 | /* Throw away any previous excludable match found. */ | |
672 | bestmatch = Qnil; | |
673 | bestmatchsize = 0; | |
674 | matchcount = 0; | |
f676868d | 675 | } |
3271a8f5 SM |
676 | } |
677 | /* FIXME: If we move this `decode' earlier we can eliminate | |
678 | the repeated ENCODE_FILE on Vcompletion_ignored_extensions. */ | |
679 | name = make_unibyte_string (dp->d_name, len); | |
680 | name = DECODE_FILE (name); | |
681 | ||
682 | { | |
683 | Lisp_Object regexps; | |
684 | Lisp_Object zero; | |
685 | XSETFASTINT (zero, 0); | |
686 | ||
687 | /* Ignore this element if it fails to match all the regexps. */ | |
cc524e3b CY |
688 | if (completion_ignore_case) |
689 | { | |
690 | for (regexps = Vcompletion_regexp_list; CONSP (regexps); | |
691 | regexps = XCDR (regexps)) | |
692 | if (fast_string_match_ignore_case (XCAR (regexps), name) < 0) | |
693 | break; | |
694 | } | |
695 | else | |
696 | { | |
697 | for (regexps = Vcompletion_regexp_list; CONSP (regexps); | |
698 | regexps = XCDR (regexps)) | |
699 | if (fast_string_match (XCAR (regexps), name) < 0) | |
700 | break; | |
701 | } | |
702 | ||
3271a8f5 SM |
703 | if (CONSP (regexps)) |
704 | continue; | |
705 | } | |
706 | ||
707 | /* This is a possible completion */ | |
708 | if (directoryp) | |
709 | /* This completion is a directory; make it end with '/'. */ | |
710 | name = Ffile_name_as_directory (name); | |
711 | ||
712 | /* Test the predicate, if any. */ | |
713 | if (!NILP (predicate)) | |
714 | { | |
715 | Lisp_Object val; | |
716 | struct gcpro gcpro1; | |
14d55bce | 717 | |
3271a8f5 SM |
718 | GCPRO1 (name); |
719 | val = call1 (predicate, name); | |
720 | UNGCPRO; | |
c4c52bb7 | 721 | |
3271a8f5 SM |
722 | if (NILP (val)) |
723 | continue; | |
724 | } | |
abfb1932 | 725 | |
3271a8f5 | 726 | /* Suitably record this match. */ |
14d55bce | 727 | |
3271a8f5 | 728 | matchcount++; |
f676868d | 729 | |
3271a8f5 SM |
730 | if (all_flag) |
731 | bestmatch = Fcons (name, bestmatch); | |
732 | else if (NILP (bestmatch)) | |
733 | { | |
734 | bestmatch = name; | |
735 | bestmatchsize = SCHARS (name); | |
736 | } | |
737 | else | |
738 | { | |
739 | Lisp_Object zero = make_number (0); | |
740 | /* FIXME: This is a copy of the code in Ftry_completion. */ | |
741 | int compare = min (bestmatchsize, SCHARS (name)); | |
742 | Lisp_Object tem | |
743 | = Fcompare_strings (bestmatch, zero, | |
744 | make_number (compare), | |
745 | name, zero, | |
746 | make_number (compare), | |
747 | completion_ignore_case ? Qt : Qnil); | |
748 | int matchsize | |
749 | = (EQ (tem, Qt) ? compare | |
750 | : XINT (tem) < 0 ? - XINT (tem) - 1 | |
751 | : XINT (tem) - 1); | |
752 | ||
753 | if (completion_ignore_case) | |
f676868d | 754 | { |
3271a8f5 SM |
755 | /* If this is an exact match except for case, |
756 | use it as the best match rather than one that is not | |
757 | an exact match. This way, we get the case pattern | |
758 | of the actual match. */ | |
759 | /* This tests that the current file is an exact match | |
760 | but BESTMATCH is not (it is too long). */ | |
761 | if ((matchsize == SCHARS (name) | |
2cd298e2 | 762 | && matchsize + !!directoryp < SCHARS (bestmatch)) |
3271a8f5 SM |
763 | || |
764 | /* If there is no exact match ignoring case, | |
765 | prefer a match that does not change the case | |
766 | of the input. */ | |
767 | /* If there is more than one exact match aside from | |
768 | case, and one of them is exact including case, | |
769 | prefer that one. */ | |
770 | /* This == checks that, of current file and BESTMATCH, | |
771 | either both or neither are exact. */ | |
772 | (((matchsize == SCHARS (name)) | |
773 | == | |
774 | (matchsize + !!directoryp == SCHARS (bestmatch))) | |
775 | && (tem = Fcompare_strings (name, zero, | |
776 | make_number (SCHARS (file)), | |
777 | file, zero, | |
778 | Qnil, | |
779 | Qnil), | |
780 | EQ (Qt, tem)) | |
781 | && (tem = Fcompare_strings (bestmatch, zero, | |
782 | make_number (SCHARS (file)), | |
783 | file, zero, | |
784 | Qnil, | |
785 | Qnil), | |
786 | ! EQ (Qt, tem)))) | |
787 | bestmatch = name; | |
14d55bce | 788 | } |
3271a8f5 | 789 | bestmatchsize = matchsize; |
2cd298e2 SM |
790 | |
791 | /* If the best completion so far is reduced to the string | |
792 | we're trying to complete, then we already know there's no | |
793 | other completion, so there's no point looking any further. */ | |
794 | if (matchsize <= SCHARS (file) | |
795 | && !includeall /* A future match may allow includeall to 0. */ | |
796 | /* If completion-ignore-case is non-nil, don't | |
797 | short-circuit because we want to find the best | |
798 | possible match *including* case differences. */ | |
799 | && (!completion_ignore_case || matchsize == 0) | |
800 | /* The return value depends on whether it's the sole match. */ | |
801 | && matchcount > 1) | |
802 | break; | |
803 | ||
14d55bce | 804 | } |
14d55bce RS |
805 | } |
806 | ||
3fcc88cc | 807 | UNGCPRO; |
3271a8f5 | 808 | /* This closes the directory. */ |
c3a3229c | 809 | bestmatch = unbind_to (count, bestmatch); |
14d55bce | 810 | |
265a9e55 | 811 | if (all_flag || NILP (bestmatch)) |
2a54a229 | 812 | return bestmatch; |
928b5acc SM |
813 | /* Return t if the supplied string is an exact match (counting case); |
814 | it does not require any change to be made. */ | |
815 | if (matchcount == 1 && !NILP (Fequal (bestmatch, file))) | |
14d55bce | 816 | return Qt; |
24c2a54f RS |
817 | bestmatch = Fsubstring (bestmatch, make_number (0), |
818 | make_number (bestmatchsize)); | |
24c2a54f | 819 | return bestmatch; |
14d55bce RS |
820 | } |
821 | ||
b3f04ced RS |
822 | /* Compare exactly LEN chars of strings at S1 and S2, |
823 | ignoring case if appropriate. | |
824 | Return -1 if strings match, | |
825 | else number of chars that match at the beginning. */ | |
826 | ||
827 | static int | |
828 | scmp (s1, s2, len) | |
829 | register unsigned char *s1, *s2; | |
830 | int len; | |
831 | { | |
832 | register int l = len; | |
833 | ||
834 | if (completion_ignore_case) | |
835 | { | |
836 | while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++)) | |
837 | l--; | |
838 | } | |
839 | else | |
840 | { | |
841 | while (l && *s1++ == *s2++) | |
842 | l--; | |
843 | } | |
844 | if (l == 0) | |
845 | return -1; | |
846 | else | |
847 | return len - l; | |
848 | } | |
849 | ||
dfcf069d | 850 | static int |
14d55bce RS |
851 | file_name_completion_stat (dirname, dp, st_addr) |
852 | Lisp_Object dirname; | |
853 | DIRENTRY *dp; | |
854 | struct stat *st_addr; | |
855 | { | |
856 | int len = NAMLEN (dp); | |
d5db4077 | 857 | int pos = SCHARS (dirname); |
7e3cf34f | 858 | int value; |
14d55bce RS |
859 | char *fullname = (char *) alloca (len + pos + 2); |
860 | ||
04924ee3 RS |
861 | #ifdef MSDOS |
862 | #if __DJGPP__ > 1 | |
863 | /* Some fields of struct stat are *very* expensive to compute on MS-DOS, | |
864 | but aren't required here. Avoid computing the following fields: | |
865 | st_inode, st_size and st_nlink for directories, and the execute bits | |
866 | in st_mode for non-directory files with non-standard extensions. */ | |
867 | ||
868 | unsigned short save_djstat_flags = _djstat_flags; | |
869 | ||
870 | _djstat_flags = _STAT_INODE | _STAT_EXEC_MAGIC | _STAT_DIRSIZE; | |
871 | #endif /* __DJGPP__ > 1 */ | |
872 | #endif /* MSDOS */ | |
873 | ||
d5db4077 | 874 | bcopy (SDATA (dirname), fullname, pos); |
0b39d75d RS |
875 | if (!IS_DIRECTORY_SEP (fullname[pos - 1])) |
876 | fullname[pos++] = DIRECTORY_SEP; | |
14d55bce RS |
877 | |
878 | bcopy (dp->d_name, fullname + pos, len); | |
879 | fullname[pos + len] = 0; | |
880 | ||
a889bd0e | 881 | #ifdef S_IFLNK |
7e3cf34f RS |
882 | /* We want to return success if a link points to a nonexistent file, |
883 | but we want to return the status for what the link points to, | |
884 | in case it is a directory. */ | |
885 | value = lstat (fullname, st_addr); | |
886 | stat (fullname, st_addr); | |
887 | return value; | |
a889bd0e | 888 | #else |
04924ee3 RS |
889 | value = stat (fullname, st_addr); |
890 | #ifdef MSDOS | |
891 | #if __DJGPP__ > 1 | |
892 | _djstat_flags = save_djstat_flags; | |
893 | #endif /* __DJGPP__ > 1 */ | |
894 | #endif /* MSDOS */ | |
895 | return value; | |
896 | #endif /* S_IFLNK */ | |
14d55bce RS |
897 | } |
898 | \f | |
899 | Lisp_Object | |
900 | make_time (time) | |
e5124be7 | 901 | time_t time; |
14d55bce RS |
902 | { |
903 | return Fcons (make_number (time >> 16), | |
904 | Fcons (make_number (time & 0177777), Qnil)); | |
905 | } | |
906 | ||
8aaaec6b EZ |
907 | static char * |
908 | stat_uname (struct stat *st) | |
909 | { | |
910 | #ifdef WINDOWSNT | |
911 | return st->st_uname; | |
912 | #else | |
913 | struct passwd *pw = (struct passwd *) getpwuid (st->st_uid); | |
914 | ||
915 | if (pw) | |
916 | return pw->pw_name; | |
917 | else | |
918 | return NULL; | |
919 | #endif | |
920 | } | |
921 | ||
922 | static char * | |
923 | stat_gname (struct stat *st) | |
924 | { | |
925 | #ifdef WINDOWSNT | |
926 | return st->st_gname; | |
927 | #else | |
928 | struct group *gr = (struct group *) getgrgid (st->st_gid); | |
929 | ||
930 | if (gr) | |
931 | return gr->gr_name; | |
932 | else | |
933 | return NULL; | |
934 | #endif | |
935 | } | |
936 | ||
51105b13 EZ |
937 | /* Make an integer or float number for UID and GID, while being |
938 | careful not to produce negative numbers due to signed integer | |
939 | overflow. */ | |
940 | static Lisp_Object | |
941 | make_uid (struct stat *st) | |
942 | { | |
943 | EMACS_INT uid = st->st_uid; | |
944 | ||
945 | if (sizeof (st->st_uid) > sizeof (uid) || uid < 0 || FIXNUM_OVERFLOW_P (uid)) | |
946 | return make_float ((double)st->st_uid); | |
947 | return make_number (uid); | |
948 | } | |
949 | ||
950 | static Lisp_Object | |
951 | make_gid (struct stat *st) | |
952 | { | |
953 | EMACS_INT gid = st->st_gid; | |
954 | ||
955 | if (sizeof (st->st_gid) > sizeof (gid) || gid < 0 || FIXNUM_OVERFLOW_P (gid)) | |
956 | return make_float ((double)st->st_gid); | |
957 | return make_number (gid); | |
958 | } | |
959 | ||
6b61353c | 960 | DEFUN ("file-attributes", Ffile_attributes, Sfile_attributes, 1, 2, 0, |
335c5470 PJ |
961 | doc: /* Return a list of attributes of file FILENAME. |
962 | Value is nil if specified file cannot be opened. | |
6b61353c KH |
963 | |
964 | ID-FORMAT specifies the preferred format of attributes uid and gid (see | |
965 | below) - valid values are 'string and 'integer. The latter is the default, | |
966 | but we plan to change that, so you should specify a non-nil value for | |
967 | ID-FORMAT if you use the returned uid or gid. | |
968 | ||
969 | Elements of the attribute list are: | |
335c5470 PJ |
970 | 0. t for directory, string (name linked to) for symbolic link, or nil. |
971 | 1. Number of links to file. | |
78e7d1fe EZ |
972 | 2. File uid as a string or a number. If a string value cannot be |
973 | looked up, a numeric value, either an integer or a float, is returned. | |
6b61353c | 974 | 3. File gid, likewise. |
335c5470 PJ |
975 | 4. Last access time, as a list of two integers. |
976 | First integer has high-order 16 bits of time, second has low 16 bits. | |
e02131a2 EZ |
977 | (See a note below about access time on FAT-based filesystems.) |
978 | 5. Last modification time, likewise. This is the time of the last | |
979 | change to the file's contents. | |
980 | 6. Last status change time, likewise. This is the time of last change | |
981 | to the file's attributes: owner and group, access mode bits, etc. | |
335c5470 PJ |
982 | 7. Size in bytes. |
983 | This is a floating point number if the size is too large for an integer. | |
984 | 8. File modes, as a string of ten letters or dashes as in ls -l. | |
e0f24100 | 985 | 9. t if file's gid would change if file were deleted and recreated. |
e02131a2 EZ |
986 | 10. inode number. If inode number is larger than what Emacs integer |
987 | can hold, but still fits into a 32-bit number, this is a cons cell | |
988 | containing two integers: first the high part, then the low 16 bits. | |
989 | If the inode number is wider than 32 bits, this is of the form | |
990 | (HIGH MIDDLE . LOW): first the high 24 bits, then middle 24 bits, | |
991 | and finally the low 16 bits. | |
992 | 11. Filesystem device number. If it is larger than what the Emacs | |
993 | integer can hold, this is a cons cell, similar to the inode number. | |
994 | ||
995 | On most filesystems, the combination of the inode and the device | |
996 | number uniquely identifies the file. | |
6c5665e9 EZ |
997 | |
998 | On MS-Windows, performance depends on `w32-get-true-file-attributes', | |
21f73755 EZ |
999 | which see. |
1000 | ||
1001 | On some FAT-based filesystems, only the date of last access is recorded, | |
1002 | so last access time will always be midnight of that day. */) | |
6b61353c KH |
1003 | (filename, id_format) |
1004 | Lisp_Object filename, id_format; | |
14d55bce RS |
1005 | { |
1006 | Lisp_Object values[12]; | |
24c2a54f | 1007 | Lisp_Object encoded; |
14d55bce | 1008 | struct stat s; |
0a974c85 | 1009 | #if defined (BSD4_2) || defined (BSD4_3) |
b3edfc9b | 1010 | Lisp_Object dirname; |
14d55bce | 1011 | struct stat sdir; |
b3edfc9b | 1012 | #endif |
14d55bce | 1013 | char modes[10]; |
32f4334d | 1014 | Lisp_Object handler; |
7435aef8 | 1015 | struct gcpro gcpro1; |
1cab27d2 | 1016 | EMACS_INT ino, uid, gid; |
51105b13 | 1017 | char *uname = NULL, *gname = NULL; |
14d55bce RS |
1018 | |
1019 | filename = Fexpand_file_name (filename, Qnil); | |
32f4334d RS |
1020 | |
1021 | /* If the file name has special constructs in it, | |
1022 | call the corresponding file handler. */ | |
a617e913 | 1023 | handler = Ffind_file_name_handler (filename, Qfile_attributes); |
32f4334d | 1024 | if (!NILP (handler)) |
6b61353c KH |
1025 | { /* Only pass the extra arg if it is used to help backward compatibility |
1026 | with old file handlers which do not implement the new arg. --Stef */ | |
1027 | if (NILP (id_format)) | |
1028 | return call2 (handler, Qfile_attributes, filename); | |
1029 | else | |
1030 | return call3 (handler, Qfile_attributes, filename, id_format); | |
1031 | } | |
32f4334d | 1032 | |
7435aef8 | 1033 | GCPRO1 (filename); |
24c2a54f | 1034 | encoded = ENCODE_FILE (filename); |
7435aef8 | 1035 | UNGCPRO; |
24c2a54f | 1036 | |
d5db4077 | 1037 | if (lstat (SDATA (encoded), &s) < 0) |
14d55bce RS |
1038 | return Qnil; |
1039 | ||
1040 | switch (s.st_mode & S_IFMT) | |
1041 | { | |
1042 | default: | |
1043 | values[0] = Qnil; break; | |
1044 | case S_IFDIR: | |
1045 | values[0] = Qt; break; | |
1046 | #ifdef S_IFLNK | |
1047 | case S_IFLNK: | |
1048 | values[0] = Ffile_symlink_p (filename); break; | |
1049 | #endif | |
1050 | } | |
1051 | values[1] = make_number (s.st_nlink); | |
51105b13 EZ |
1052 | |
1053 | if (!(NILP (id_format) || EQ (id_format, Qinteger))) | |
6b61353c | 1054 | { |
8c8a7c58 | 1055 | BLOCK_INPUT; |
8aaaec6b | 1056 | uname = stat_uname (&s); |
8aaaec6b | 1057 | gname = stat_gname (&s); |
8c8a7c58 | 1058 | UNBLOCK_INPUT; |
6b61353c | 1059 | } |
51105b13 | 1060 | if (uname) |
80904120 | 1061 | values[2] = DECODE_SYSTEM (build_string (uname)); |
51105b13 EZ |
1062 | else |
1063 | values[2] = make_uid (&s); | |
1064 | if (gname) | |
80904120 | 1065 | values[3] = DECODE_SYSTEM (build_string (gname)); |
51105b13 EZ |
1066 | else |
1067 | values[3] = make_gid (&s); | |
1068 | ||
14d55bce RS |
1069 | values[4] = make_time (s.st_atime); |
1070 | values[5] = make_time (s.st_mtime); | |
1071 | values[6] = make_time (s.st_ctime); | |
68c45bf0 | 1072 | values[7] = make_number (s.st_size); |
cb1846b4 | 1073 | /* If the size is out of range for an integer, return a float. */ |
60fc6069 | 1074 | if (XINT (values[7]) != s.st_size) |
cb1846b4 | 1075 | values[7] = make_float ((double)s.st_size); |
4bc12672 JR |
1076 | /* If the size is negative, and its type is long, convert it back to |
1077 | positive. */ | |
1078 | if (s.st_size < 0 && sizeof (s.st_size) == sizeof (long)) | |
1079 | values[7] = make_float ((double) ((unsigned long) s.st_size)); | |
1080 | ||
14d55bce RS |
1081 | filemodestring (&s, modes); |
1082 | values[8] = make_string (modes, 10); | |
0a974c85 | 1083 | #if defined (BSD4_2) || defined (BSD4_3) /* file gid will be dir gid */ |
14d55bce | 1084 | dirname = Ffile_name_directory (filename); |
24c2a54f RS |
1085 | if (! NILP (dirname)) |
1086 | encoded = ENCODE_FILE (dirname); | |
d5db4077 | 1087 | if (! NILP (dirname) && stat (SDATA (encoded), &sdir) == 0) |
01388a3d | 1088 | values[9] = (sdir.st_gid != s.st_gid) ? Qt : Qnil; |
14d55bce RS |
1089 | else /* if we can't tell, assume worst */ |
1090 | values[9] = Qt; | |
1091 | #else /* file gid will be egid */ | |
01388a3d | 1092 | values[9] = (s.st_gid != getegid ()) ? Qt : Qnil; |
14d55bce | 1093 | #endif /* BSD4_2 (or BSD4_3) */ |
b55445d6 | 1094 | /* Shut up GCC warnings in FIXNUM_OVERFLOW_P below. */ |
e058f331 EZ |
1095 | if (sizeof (s.st_ino) > sizeof (ino)) |
1096 | ino = (EMACS_INT)(s.st_ino & 0xffffffff); | |
1097 | else | |
1098 | ino = s.st_ino; | |
1099 | if (!FIXNUM_OVERFLOW_P (ino) | |
1100 | && (sizeof (s.st_ino) <= sizeof (ino) || (s.st_ino & ~INTMASK) == 0)) | |
1101 | /* Keep the most common cases as integers. */ | |
1102 | values[10] = make_number (ino); | |
1103 | else if (sizeof (s.st_ino) <= sizeof (ino) | |
1104 | || ((s.st_ino >> 16) & ~INTMASK) == 0) | |
4c637faa RS |
1105 | /* To allow inode numbers larger than VALBITS, separate the bottom |
1106 | 16 bits. */ | |
e058f331 EZ |
1107 | values[10] = Fcons (make_number ((EMACS_INT)(s.st_ino >> 16)), |
1108 | make_number ((EMACS_INT)(s.st_ino & 0xffff))); | |
4c637faa | 1109 | else |
e058f331 EZ |
1110 | { |
1111 | /* To allow inode numbers beyond 32 bits, separate into 2 24-bit | |
ff8ddc7b | 1112 | high parts and a 16-bit bottom part. |
25ae5671 EZ |
1113 | The code on the next line avoids a compiler warning on |
1114 | systems where st_ino is 32 bit wide. (bug#766). */ | |
ff8ddc7b | 1115 | EMACS_INT high_ino = s.st_ino >> 31 >> 1; |
e058f331 EZ |
1116 | EMACS_INT low_ino = s.st_ino & 0xffffffff; |
1117 | ||
1118 | values[10] = Fcons (make_number (high_ino >> 8), | |
1119 | Fcons (make_number (((high_ino & 0xff) << 16) | |
1120 | + (low_ino >> 16)), | |
1121 | make_number (low_ino & 0xffff))); | |
1122 | } | |
68c45bf0 | 1123 | |
7412d429 EZ |
1124 | /* Likewise for device, but don't let it become negative. We used |
1125 | to use FIXNUM_OVERFLOW_P here, but that won't catch large | |
1126 | positive numbers such as 0xFFEEDDCC. */ | |
1127 | if ((EMACS_INT)s.st_dev < 0 | |
1128 | || (EMACS_INT)s.st_dev > MOST_POSITIVE_FIXNUM) | |
68c45bf0 PE |
1129 | values[11] = Fcons (make_number (s.st_dev >> 16), |
1130 | make_number (s.st_dev & 0xffff)); | |
1131 | else | |
1132 | values[11] = make_number (s.st_dev); | |
1133 | ||
14d55bce RS |
1134 | return Flist (sizeof(values) / sizeof(values[0]), values); |
1135 | } | |
4424b255 GV |
1136 | |
1137 | DEFUN ("file-attributes-lessp", Ffile_attributes_lessp, Sfile_attributes_lessp, 2, 2, 0, | |
335c5470 PJ |
1138 | doc: /* Return t if first arg file attributes list is less than second. |
1139 | Comparison is in lexicographic order and case is significant. */) | |
1140 | (f1, f2) | |
4424b255 GV |
1141 | Lisp_Object f1, f2; |
1142 | { | |
1143 | return Fstring_lessp (Fcar (f1), Fcar (f2)); | |
1144 | } | |
14d55bce | 1145 | \f |
dfcf069d | 1146 | void |
14d55bce RS |
1147 | syms_of_dired () |
1148 | { | |
32f4334d | 1149 | Qdirectory_files = intern ("directory-files"); |
4424b255 | 1150 | Qdirectory_files_and_attributes = intern ("directory-files-and-attributes"); |
32f4334d RS |
1151 | Qfile_name_completion = intern ("file-name-completion"); |
1152 | Qfile_name_all_completions = intern ("file-name-all-completions"); | |
434e6714 | 1153 | Qfile_attributes = intern ("file-attributes"); |
4424b255 | 1154 | Qfile_attributes_lessp = intern ("file-attributes-lessp"); |
01bb4018 | 1155 | Qdefault_directory = intern ("default-directory"); |
32f4334d | 1156 | |
a2d3836c | 1157 | staticpro (&Qdirectory_files); |
4424b255 | 1158 | staticpro (&Qdirectory_files_and_attributes); |
a2d3836c EN |
1159 | staticpro (&Qfile_name_completion); |
1160 | staticpro (&Qfile_name_all_completions); | |
1161 | staticpro (&Qfile_attributes); | |
4424b255 | 1162 | staticpro (&Qfile_attributes_lessp); |
01bb4018 | 1163 | staticpro (&Qdefault_directory); |
a2d3836c | 1164 | |
14d55bce | 1165 | defsubr (&Sdirectory_files); |
4424b255 | 1166 | defsubr (&Sdirectory_files_and_attributes); |
14d55bce | 1167 | defsubr (&Sfile_name_completion); |
14d55bce RS |
1168 | defsubr (&Sfile_name_all_completions); |
1169 | defsubr (&Sfile_attributes); | |
4424b255 | 1170 | defsubr (&Sfile_attributes_lessp); |
14d55bce | 1171 | |
14d55bce | 1172 | DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions, |
407a52c4 LT |
1173 | doc: /* Completion ignores file names ending in any string in this list. |
1174 | It does not ignore them if all possible completions end in one of | |
1175 | these strings or when displaying a list of completions. | |
1176 | It ignores directory names if they match any string in this list which | |
1177 | ends in a slash. */); | |
14d55bce RS |
1178 | Vcompletion_ignored_extensions = Qnil; |
1179 | } | |
6b61353c KH |
1180 | |
1181 | /* arch-tag: 1ac8deca-4d8f-4d41-ade9-089154d98c03 | |
1182 | (do not change this comment) */ |