dired.c 28.1 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
/* Lisp functions for making directory listings.
2 3
   Copyright (C) 1985, 1986, 1993, 1994, 1999, 2000, 2001
     Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Karl Heuer's avatar
Karl Heuer committed
9
the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
21 22


23 24
#include <config.h>

Richard M. Stallman's avatar
Richard M. Stallman committed
25 26 27 28
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>

29
#include "systime.h"
30
#include <errno.h>
31

32 33 34 35 36 37
#ifdef VMS
#include <string.h>
#include <rms.h>
#include <rmsdef.h>
#endif

Andreas Schwab's avatar
Andreas Schwab committed
38 39 40 41
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

42 43 44 45 46 47 48 49 50 51 52 53
/* The d_nameln member of a struct dirent includes the '\0' character
   on some systems, but not on others.  What's worse, you can't tell
   at compile-time which one it will be, since it really depends on
   the sort of system providing the filesystem you're reading from,
   not the system you are running on.  Paul Eggert
   <eggert@bi.twinsun.com> says this occurs when Emacs is running on a
   SunOS 4.1.2 host, reading a directory that is remote-mounted from a
   Solaris 2.1 host and is in a native Solaris 2.1 filesystem.

   Since applying strlen to the name always works, we'll just do that.  */
#define NAMLEN(p) strlen (p->d_name)

Richard M. Stallman's avatar
Richard M. Stallman committed
54 55 56 57 58
#ifdef SYSV_SYSTEM_DIR

#include <dirent.h>
#define DIRENTRY struct dirent

59
#else /* not SYSV_SYSTEM_DIR */
Richard M. Stallman's avatar
Richard M. Stallman committed
60 61 62 63

#ifdef NONSYSTEM_DIR_LIBRARY
#include "ndir.h"
#else /* not NONSYSTEM_DIR_LIBRARY */
64 65 66
#ifdef MSDOS
#include <dirent.h>
#else
Richard M. Stallman's avatar
Richard M. Stallman committed
67
#include <sys/dir.h>
68
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
69 70
#endif /* not NONSYSTEM_DIR_LIBRARY */

71 72
#include <sys/stat.h>

73
#ifndef MSDOS
Richard M. Stallman's avatar
Richard M. Stallman committed
74 75 76 77 78
#define DIRENTRY struct direct

extern DIR *opendir ();
extern struct direct *readdir ();

79 80 81 82 83 84 85
#endif /* not MSDOS */
#endif /* not SYSV_SYSTEM_DIR */

#ifdef MSDOS
#define DIRENTRY_NONEMPTY(p) ((p)->d_name[0] != 0)
#else
#define DIRENTRY_NONEMPTY(p) ((p)->d_ino)
Richard M. Stallman's avatar
Richard M. Stallman committed
86 87 88 89 90
#endif

#include "lisp.h"
#include "buffer.h"
#include "commands.h"
91 92
#include "charset.h"
#include "coding.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
93 94
#include "regex.h"

95 96
/* Returns a search buffer, with a fastmap allocated and ready to go.  */
extern struct re_pattern_buffer *compile_pattern ();
97

98 99 100
/* From filemode.c.  Can't go in Lisp.h because of `stat'.  */
extern void filemodestring P_ ((struct stat *, char *));

Richard M. Stallman's avatar
Richard M. Stallman committed
101 102 103 104 105 106 107
/* if system does not have symbolic links, it does not have lstat.
   In that case, use ordinary stat instead.  */

#ifndef S_IFLNK
#define lstat stat
#endif

108
extern int completion_ignore_case;
109
extern Lisp_Object Vcompletion_regexp_list;
110
extern Lisp_Object Vfile_name_coding_system, Vdefault_file_name_coding_system;
111

Richard M. Stallman's avatar
Richard M. Stallman committed
112 113
Lisp_Object Vcompletion_ignored_extensions;
Lisp_Object Qcompletion_ignore_case;
114
Lisp_Object Qdirectory_files;
115
Lisp_Object Qdirectory_files_and_attributes;
116 117
Lisp_Object Qfile_name_completion;
Lisp_Object Qfile_name_all_completions;
Jim Blandy's avatar
Jim Blandy committed
118
Lisp_Object Qfile_attributes;
119
Lisp_Object Qfile_attributes_lessp;
Richard M. Stallman's avatar
Richard M. Stallman committed
120

121 122 123 124 125 126 127 128 129 130

Lisp_Object
directory_files_internal_unwind (dh)
     Lisp_Object dh;
{
  DIR *d = (DIR *) ((XINT (XCAR (dh)) << 16) + XINT (XCDR (dh)));
  closedir (d);
  return Qnil;
}

131 132 133
/* Function shared by Fdirectory_files and Fdirectory_files_and_attributes.  
   When ATTRS is zero, return a list of directory filenames; when
   non-zero, return a list of directory filenames and their attributes.  */
134

135 136
Lisp_Object
directory_files_internal (directory, full, match, nosort, attrs)
137
     Lisp_Object directory, full, match, nosort;
138
     int attrs;
Richard M. Stallman's avatar
Richard M. Stallman committed
139 140
{
  DIR *d;
141 142
  int directory_nbytes;
  Lisp_Object list, dirfilename, encoded_directory;
143
  struct re_pattern_buffer *bufp = NULL;
144
  int needsep = 0;
145
  int count = specpdl_ptr - specpdl;
146
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
147 148
  DIRENTRY *dp;
  int retry_p;
149

150
  /* Because of file name handlers, these functions might call
151
     Ffuncall, and cause a GC.  */
152 153
  list = encoded_directory = dirfilename = Qnil;
  GCPRO5 (match, directory, list, dirfilename, encoded_directory);
154 155
  directory = Fexpand_file_name (directory, Qnil);
  dirfilename = Fdirectory_file_name (directory);
156

Jim Blandy's avatar
Jim Blandy committed
157
  if (!NILP (match))
Richard M. Stallman's avatar
Richard M. Stallman committed
158 159
    {
      CHECK_STRING (match, 3);
Jim Blandy's avatar
Jim Blandy committed
160 161

      /* MATCH might be a flawed regular expression.  Rather than
Karl Heuer's avatar
Karl Heuer committed
162
	 catching and signaling our own errors, we just call
Jim Blandy's avatar
Jim Blandy committed
163
	 compile_pattern to do the work for us.  */
164 165
      /* Pass 1 for the MULTIBYTE arg
	 because we do make multibyte strings if the contents warrant.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
166
#ifdef VMS
167
      bufp = compile_pattern (match, 0,
168
			      buffer_defaults.downcase_table, 0, 1);
Richard M. Stallman's avatar
Richard M. Stallman committed
169
#else
170
      bufp = compile_pattern (match, 0, Qnil, 0, 1);
Richard M. Stallman's avatar
Richard M. Stallman committed
171 172 173
#endif
    }

174
  /* Note: ENCODE_FILE and DECODE_FILE can GC because they can run
175 176
     run_pre_post_conversion_on_str which calls Lisp directly and
     indirectly.  */
177 178 179
  dirfilename = ENCODE_FILE (dirfilename);
  encoded_directory = ENCODE_FILE (directory);

180
  /* Now *bufp is the compiled form of MATCH; don't call anything
181 182 183
     which might compile a new regexp until we're done with the loop!  */

  /* Do this opendir after anything which might signal an error; if
Karl Heuer's avatar
Karl Heuer committed
184
     an error is signaled while the directory stream is open, we
185 186
     have to make sure it gets closed, and setting up an
     unwind_protect to do so would be a pain.  */
187 188
 retry:
  
189
  d = opendir (XSTRING (dirfilename)->data);
190
  if (d == NULL)
191
    report_file_error ("Opening directory", Fcons (directory, Qnil));
Richard M. Stallman's avatar
Richard M. Stallman committed
192

193 194 195 196 197 198 199
  /* Unfortunately, we can now invoke expand-file-name and
     file-attributes on filenames, both of which can throw, so we must
     do a proper unwind-protect.  */
  record_unwind_protect (directory_files_internal_unwind,
			 Fcons (make_number (((unsigned long) d) >> 16),
				make_number (((unsigned long) d) & 0xffff)));

200
  directory_nbytes = STRING_BYTES (XSTRING (directory));
201
  re_match_object = Qt;
Richard M. Stallman's avatar
Richard M. Stallman committed
202

203 204
  /* Decide whether we need to add a directory separator.  */
#ifndef VMS
205 206
  if (directory_nbytes == 0
      || !IS_ANY_SEP (XSTRING (directory)->data[directory_nbytes - 1]))
207
    needsep = 1;
208
#endif /* not VMS */
209

210
  /* Loop reading blocks until EOF or error.  */
211
  for (;;)
Richard M. Stallman's avatar
Richard M. Stallman committed
212
    {
213 214 215 216 217 218 219 220 221 222 223
      errno = 0;
      dp = readdir (d);

#ifdef EAGAIN
      if (dp == NULL && errno == EAGAIN)
	continue;
#endif
      
      if (dp == NULL)
	break;

224
      if (DIRENTRY_NONEMPTY (dp))
Richard M. Stallman's avatar
Richard M. Stallman committed
225
	{
226
	  int len;
227
	  int wanted = 0;
228 229
	  Lisp_Object name, finalname;
	  struct gcpro gcpro1, gcpro2;
230 231

	  len = NAMLEN (dp);
232
	  name = finalname = make_unibyte_string (dp->d_name, len);
233 234 235 236 237
	  GCPRO2 (finalname, name);
	  
	  /* Note: ENCODE_FILE can GC; it should protect its argument,
	     though.  */
	  name = DECODE_FILE (name);
238 239
	  len = STRING_BYTES (XSTRING (name));

240 241 242 243 244
	  /* Now that we have unwind_protect in place, we might as well
             allow matching to be interrupted.  */
	  immediate_quit = 1;
	  QUIT;

Jim Blandy's avatar
Jim Blandy committed
245
	  if (NILP (match)
246
	      || (0 <= re_search (bufp, XSTRING (name)->data, len, 0, len, 0)))
247
	    wanted = 1;
248 249 250 251

	  immediate_quit = 0;

	  if (wanted)
Richard M. Stallman's avatar
Richard M. Stallman committed
252
	    {
Jim Blandy's avatar
Jim Blandy committed
253
	      if (!NILP (full))
Richard M. Stallman's avatar
Richard M. Stallman committed
254
		{
255
		  Lisp_Object fullname;
256 257
		  int nbytes = len + directory_nbytes + needsep;
		  int nchars;
258

259
		  fullname = make_uninit_multibyte_string (nbytes, nbytes);
260
		  bcopy (XSTRING (directory)->data, XSTRING (fullname)->data,
261 262
			 directory_nbytes);
		  
263
		  if (needsep)
264
		    XSTRING (fullname)->data[directory_nbytes] = DIRECTORY_SEP;
265
		  
266
		  bcopy (XSTRING (name)->data,
267 268 269 270 271 272 273 274 275
			 XSTRING (fullname)->data + directory_nbytes + needsep,
			 len);
		  
		  nchars = chars_in_text (XSTRING (fullname)->data, nbytes);

		  /* Some bug somewhere.  */
		  if (nchars > nbytes)
		    abort ();
		      
276
		  XSTRING (fullname)->size = nchars;
277
		  if (nchars == nbytes)
278
		    SET_STRING_BYTES (XSTRING (fullname), -1);
279
		  
280 281
		  finalname = fullname;
		}
282 283
	      else
		finalname = name;
284 285 286 287 288

	      if (attrs)
		{
		  /* Construct an expanded filename for the directory entry.
		     Use the decoded names for input to Ffile_attributes.  */
289 290 291 292 293
		  Lisp_Object decoded_fullname, fileattrs;
		  struct gcpro gcpro1, gcpro2;

		  decoded_fullname = fileattrs = Qnil;
		  GCPRO2 (decoded_fullname, fileattrs);
294

295
		  /* Both Fexpand_file_name and Ffile_attributes can GC.  */
296 297 298 299
		  decoded_fullname = Fexpand_file_name (name, directory);
		  fileattrs = Ffile_attributes (decoded_fullname);

		  list = Fcons (Fcons (finalname, fileattrs), list);
300
		  UNGCPRO;
301 302
		}
	      else
303
		list = Fcons (finalname, list);
Richard M. Stallman's avatar
Richard M. Stallman committed
304
	    }
305 306

	  UNGCPRO;
Richard M. Stallman's avatar
Richard M. Stallman committed
307 308
	}
    }
309

310 311 312 313 314
  retry_p = 0;
#ifdef EINTR
  retry_p |= errno == EINTR;
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
315
  closedir (d);
316 317 318 319

  /* Discard the unwind protect.  */
  specpdl_ptr = specpdl + count;

320
  if (retry_p)
321 322 323 324
    {
      list = Qnil;
      goto retry;
    }
325

326 327 328 329 330
  if (NILP (nosort))
    list = Fsort (Fnreverse (list),
		  attrs ? Qfile_attributes_lessp : Qstring_lessp);
  
  RETURN_UNGCPRO (list);
Richard M. Stallman's avatar
Richard M. Stallman committed
331
}
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397


DEFUN ("directory-files", Fdirectory_files, Sdirectory_files, 1, 4, 0,
  "Return a list of names of files in DIRECTORY.\n\
There are three optional arguments:\n\
If FULL is non-nil, return absolute file names.  Otherwise return names\n\
 that are relative to the specified directory.\n\
If MATCH is non-nil, mention only file names that match the regexp MATCH.\n\
If NOSORT is non-nil, the list is not sorted--its order is unpredictable.\n\
 NOSORT is useful if you plan to sort the result yourself.")
  (directory, full, match, nosort)
     Lisp_Object directory, full, match, nosort;
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
  handler = Ffind_file_name_handler (directory, Qdirectory_files);
  if (!NILP (handler))
    {
      Lisp_Object args[6];

      args[0] = handler;
      args[1] = Qdirectory_files;
      args[2] = directory;
      args[3] = full;
      args[4] = match;
      args[5] = nosort;
      return Ffuncall (6, args);
    }

  return directory_files_internal (directory, full, match, nosort, 0);
}

DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes, Sdirectory_files_and_attributes, 1, 4, 0,
  "Return a list of names of files and their attributes in DIRECTORY.\n\
There are three optional arguments:\n\
If FULL is non-nil, return absolute file names.  Otherwise return names\n\
 that are relative to the specified directory.\n\
If MATCH is non-nil, mention only file names that match the regexp MATCH.\n\
If NOSORT is non-nil, the list is not sorted--its order is unpredictable.\n\
 NOSORT is useful if you plan to sort the result yourself.")
  (directory, full, match, nosort)
     Lisp_Object directory, full, match, nosort;
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
  handler = Ffind_file_name_handler (directory, Qdirectory_files_and_attributes);
  if (!NILP (handler))
    {
      Lisp_Object args[6];

      args[0] = handler;
      args[1] = Qdirectory_files_and_attributes;
      args[2] = directory;
      args[3] = full;
      args[4] = match;
      args[5] = nosort;
      return Ffuncall (6, args);
    }

  return directory_files_internal (directory, full, match, nosort, 1);
}

Richard M. Stallman's avatar
Richard M. Stallman committed
398 399 400 401 402

Lisp_Object file_name_completion ();

DEFUN ("file-name-completion", Ffile_name_completion, Sfile_name_completion,
  2, 2, 0,
403
  "Complete file name FILE in directory DIRECTORY.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
404
Returns the longest string\n\
405
common to all file names in DIRECTORY that start with FILE.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
406 407
If there is only one and FILE matches it exactly, returns t.\n\
Returns nil if DIR contains no name starting with FILE.")
408 409
  (file, directory)
     Lisp_Object file, directory;
Richard M. Stallman's avatar
Richard M. Stallman committed
410
{
411 412
  Lisp_Object handler;

413
  /* If the directory name has special constructs in it,
414
     call the corresponding file handler.  */
415
  handler = Ffind_file_name_handler (directory, Qfile_name_completion);
416
  if (!NILP (handler))
417
    return call3 (handler, Qfile_name_completion, file, directory);
418

419 420 421 422
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
  handler = Ffind_file_name_handler (file, Qfile_name_completion);
  if (!NILP (handler))
423
    return call3 (handler, Qfile_name_completion, file, directory);
424

425
  return file_name_completion (file, directory, 0, 0);
Richard M. Stallman's avatar
Richard M. Stallman committed
426 427 428 429
}

DEFUN ("file-name-all-completions", Ffile_name_all_completions,
  Sfile_name_all_completions, 2, 2, 0,
430 431 432 433
  "Return a list of all completions of file name FILE in directory DIRECTORY.\n\
These are all file names in directory DIRECTORY which begin with FILE.")
  (file, directory)
     Lisp_Object file, directory;
Richard M. Stallman's avatar
Richard M. Stallman committed
434
{
435 436
  Lisp_Object handler;

437
  /* If the directory name has special constructs in it,
438
     call the corresponding file handler.  */
439
  handler = Ffind_file_name_handler (directory, Qfile_name_all_completions);
440
  if (!NILP (handler))
441
    return call3 (handler, Qfile_name_all_completions, file, directory);
442

443 444 445 446
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
  handler = Ffind_file_name_handler (file, Qfile_name_all_completions);
  if (!NILP (handler))
447
    return call3 (handler, Qfile_name_all_completions, file, directory);
448

449
  return file_name_completion (file, directory, 1, 0);
Richard M. Stallman's avatar
Richard M. Stallman committed
450 451
}

Andreas Schwab's avatar
Andreas Schwab committed
452 453
static int file_name_completion_stat ();

Richard M. Stallman's avatar
Richard M. Stallman committed
454 455 456 457 458 459
Lisp_Object
file_name_completion (file, dirname, all_flag, ver_flag)
     Lisp_Object file, dirname;
     int all_flag, ver_flag;
{
  DIR *d;
460
  int bestmatchsize = 0, skip;
Richard M. Stallman's avatar
Richard M. Stallman committed
461 462 463 464
  register int compare, matchsize;
  unsigned char *p1, *p2;
  int matchcount = 0;
  Lisp_Object bestmatch, tem, elt, name;
465 466
  Lisp_Object encoded_file;
  Lisp_Object encoded_dir;
Richard M. Stallman's avatar
Richard M. Stallman committed
467 468 469 470
  struct stat st;
  int directoryp;
  int passcount;
  int count = specpdl_ptr - specpdl;
471
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
472

473 474
  elt = Qnil;

Richard M. Stallman's avatar
Richard M. Stallman committed
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
#ifdef VMS
  extern DIRENTRY * readdirver ();

  DIRENTRY *((* readfunc) ());

  /* Filename completion on VMS ignores case, since VMS filesys does.  */
  specbind (Qcompletion_ignore_case, Qt);

  readfunc = readdir;
  if (ver_flag)
    readfunc = readdirver;
  file = Fupcase (file);
#else  /* not VMS */
  CHECK_STRING (file, 0);
#endif /* not VMS */

491 492 493
#ifdef FILE_SYSTEM_CASE
  file = FILE_SYSTEM_CASE (file);
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
494
  bestmatch = Qnil;
495 496
  encoded_file = encoded_dir = Qnil;
  GCPRO5 (file, dirname, bestmatch, encoded_file, encoded_dir);
497
  dirname = Fexpand_file_name (dirname, Qnil);
Richard M. Stallman's avatar
Richard M. Stallman committed
498

499 500 501 502 503 504 505
  /* Do completion on the encoded file name
     because the other names in the directory are (we presume)
     encoded likewise.  We decode the completed string at the end.  */
  encoded_file = ENCODE_FILE (file);

  encoded_dir = ENCODE_FILE (dirname);

Richard M. Stallman's avatar
Richard M. Stallman committed
506 507 508 509 510 511 512 513
  /* With passcount = 0, ignore files that end in an ignored extension.
     If nothing found then try again with passcount = 1, don't ignore them.
     If looking for all completions, start with passcount = 1,
     so always take even the ignored ones.

     ** It would not actually be helpful to the user to ignore any possible
     completions when making a list of them.**  */

Jim Blandy's avatar
Jim Blandy committed
514
  for (passcount = !!all_flag; NILP (bestmatch) && passcount < 2; passcount++)
Richard M. Stallman's avatar
Richard M. Stallman committed
515
    {
516 517
      d = opendir (XSTRING (Fdirectory_file_name (encoded_dir))->data);
      if (!d)
Richard M. Stallman's avatar
Richard M. Stallman committed
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
	report_file_error ("Opening directory", Fcons (dirname, Qnil));

      /* Loop reading blocks */
      /* (att3b compiler bug requires do a null comparison this way) */
      while (1)
	{
	  DIRENTRY *dp;
	  int len;

#ifdef VMS
	  dp = (*readfunc) (d);
#else
	  dp = readdir (d);
#endif
	  if (!dp) break;

	  len = NAMLEN (dp);

Jim Blandy's avatar
Jim Blandy committed
536
	  if (!NILP (Vquit_flag) && NILP (Vinhibit_quit))
Richard M. Stallman's avatar
Richard M. Stallman committed
537
	    goto quit;
538
	  if (! DIRENTRY_NONEMPTY (dp)
539 540 541
	      || len < XSTRING (encoded_file)->size
	      || 0 <= scmp (dp->d_name, XSTRING (encoded_file)->data,
			    XSTRING (encoded_file)->size))
Richard M. Stallman's avatar
Richard M. Stallman committed
542 543
	    continue;

544
          if (file_name_completion_stat (encoded_dir, dp, &st) < 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
545 546 547 548
            continue;

          directoryp = ((st.st_mode & S_IFMT) == S_IFDIR);
	  tem = Qnil;
549 550 551 552 553 554 555 556 557 558 559
          if (directoryp)
	    {
#ifndef TRIVIAL_DIRECTORY_ENTRY
#define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, ".."))
#endif
	      /* "." and ".." are never interesting as completions, but are
		 actually in the way in a directory contains only one file.  */
	      if (!passcount && TRIVIAL_DIRECTORY_ENTRY (dp->d_name))
		continue;
	    }
	  else
Richard M. Stallman's avatar
Richard M. Stallman committed
560 561 562
            {
	      /* Compare extensions-to-be-ignored against end of this file name */
	      /* if name is not an exact match against specified string */
563
	      if (!passcount && len > XSTRING (encoded_file)->size)
Richard M. Stallman's avatar
Richard M. Stallman committed
564 565
		/* and exit this for loop if a match is found */
		for (tem = Vcompletion_ignored_extensions;
566
		     CONSP (tem); tem = XCDR (tem))
Richard M. Stallman's avatar
Richard M. Stallman committed
567
		  {
568
		    elt = XCAR (tem);
569
		    if (!STRINGP (elt)) continue;
Richard M. Stallman's avatar
Richard M. Stallman committed
570 571 572 573 574 575 576 577 578 579 580
		    skip = len - XSTRING (elt)->size;
		    if (skip < 0) continue;

		    if (0 <= scmp (dp->d_name + skip,
				   XSTRING (elt)->data,
				   XSTRING (elt)->size))
		      continue;
		    break;
		  }
	    }

581 582 583 584 585 586
	  /* If an ignored-extensions match was found,
	     don't process this name as a completion.  */
	  if (!passcount && CONSP (tem))
	    continue;

	  if (!passcount)
Richard M. Stallman's avatar
Richard M. Stallman committed
587
	    {
588 589
	      Lisp_Object regexps;
	      Lisp_Object zero;
590
	      XSETFASTINT (zero, 0);
591 592 593

	      /* Ignore this element if it fails to match all the regexps.  */
	      for (regexps = Vcompletion_regexp_list; CONSP (regexps);
594
		   regexps = XCDR (regexps))
595
		{
596 597
		  tem = Fstring_match (XCAR (regexps),
				       make_string (dp->d_name, len), zero);
598 599 600 601 602 603
		  if (NILP (tem))
		    break;
		}
	      if (CONSP (regexps))
		continue;
	    }
Richard M. Stallman's avatar
Richard M. Stallman committed
604

605
	  /* Update computation of how much all possible completions match */
Richard M. Stallman's avatar
Richard M. Stallman committed
606

607 608 609 610 611 612
	  matchcount++;

	  if (all_flag || NILP (bestmatch))
	    {
	      /* This is a possible completion */
	      if (directoryp)
Richard M. Stallman's avatar
Richard M. Stallman committed
613
		{
614 615 616 617 618 619 620
		  /* This completion is a directory; make it end with '/' */
		  name = Ffile_name_as_directory (make_string (dp->d_name, len));
		}
	      else
		name = make_string (dp->d_name, len);
	      if (all_flag)
		{
621
		  name = DECODE_FILE (name);
622
		  bestmatch = Fcons (name, bestmatch);
Richard M. Stallman's avatar
Richard M. Stallman committed
623 624 625
		}
	      else
		{
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
		  bestmatch = name;
		  bestmatchsize = XSTRING (name)->size;
		}
	    }
	  else
	    {
	      compare = min (bestmatchsize, len);
	      p1 = XSTRING (bestmatch)->data;
	      p2 = (unsigned char *) dp->d_name;
	      matchsize = scmp(p1, p2, compare);
	      if (matchsize < 0)
		matchsize = compare;
	      if (completion_ignore_case)
		{
		  /* If this is an exact match except for case,
		     use it as the best match rather than one that is not
		     an exact match.  This way, we get the case pattern
		     of the actual match.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
644 645
		  /* This tests that the current file is an exact match
		     but BESTMATCH is not (it is too long).  */
646 647 648 649 650 651 652
		  if ((matchsize == len
		       && matchsize + !!directoryp 
			  < XSTRING (bestmatch)->size)
		      ||
		      /* If there is no exact match ignoring case,
			 prefer a match that does not change the case
			 of the input.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
653 654 655 656 657
		      /* If there is more than one exact match aside from
			 case, and one of them is exact including case,
			 prefer that one.  */
		      /* This == checks that, of current file and BESTMATCH,
			 either both or neither are exact.  */
658 659 660 661
		      (((matchsize == len)
			==
			(matchsize + !!directoryp 
			 == XSTRING (bestmatch)->size))
662 663
		       && !bcmp (p2, XSTRING (encoded_file)->data, XSTRING (encoded_file)->size)
		       && bcmp (p1, XSTRING (encoded_file)->data, XSTRING (encoded_file)->size)))
664
		    {
665 666 667
		      bestmatch = make_string (dp->d_name, len);
		      if (directoryp)
			bestmatch = Ffile_name_as_directory (bestmatch);
668
		    }
Richard M. Stallman's avatar
Richard M. Stallman committed
669
		}
670 671 672 673 674 675

	      /* If this dirname all matches, see if implicit following
		 slash does too.  */
	      if (directoryp
		  && compare == matchsize
		  && bestmatchsize > matchsize
676
		  && IS_ANY_SEP (p1[matchsize]))
677 678
		matchsize++;
	      bestmatchsize = matchsize;
Richard M. Stallman's avatar
Richard M. Stallman committed
679 680 681 682 683
	    }
	}
      closedir (d);
    }

684 685
  UNGCPRO;
  bestmatch = unbind_to (count, bestmatch);
Richard M. Stallman's avatar
Richard M. Stallman committed
686

Jim Blandy's avatar
Jim Blandy committed
687
  if (all_flag || NILP (bestmatch))
688
    {
689 690
      if (STRINGP (bestmatch))
	bestmatch = DECODE_FILE (bestmatch);
691 692
      return bestmatch;
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
693 694
  if (matchcount == 1 && bestmatchsize == XSTRING (file)->size)
    return Qt;
695 696 697 698
  bestmatch = Fsubstring (bestmatch, make_number (0),
			  make_number (bestmatchsize));
  /* Now that we got the right initial segment of BESTMATCH,
     decode it from the coding system in use.  */
699
  bestmatch = DECODE_FILE (bestmatch);
700 701
  return bestmatch;

Richard M. Stallman's avatar
Richard M. Stallman committed
702 703 704 705 706 707
 quit:
  if (d) closedir (d);
  Vquit_flag = Qnil;
  return Fsignal (Qquit, Qnil);
}

Andreas Schwab's avatar
Andreas Schwab committed
708
static int
Richard M. Stallman's avatar
Richard M. Stallman committed
709 710 711 712 713 714 715
file_name_completion_stat (dirname, dp, st_addr)
     Lisp_Object dirname;
     DIRENTRY *dp;
     struct stat *st_addr;
{
  int len = NAMLEN (dp);
  int pos = XSTRING (dirname)->size;
716
  int value;
Richard M. Stallman's avatar
Richard M. Stallman committed
717 718
  char *fullname = (char *) alloca (len + pos + 2);

719 720 721 722 723 724 725 726 727 728 729 730 731
#ifdef MSDOS
#if __DJGPP__ > 1
  /* Some fields of struct stat are *very* expensive to compute on MS-DOS,
     but aren't required here.  Avoid computing the following fields:
     st_inode, st_size and st_nlink for directories, and the execute bits
     in st_mode for non-directory files with non-standard extensions.  */

  unsigned short save_djstat_flags = _djstat_flags;

  _djstat_flags = _STAT_INODE | _STAT_EXEC_MAGIC | _STAT_DIRSIZE;
#endif /* __DJGPP__ > 1 */
#endif /* MSDOS */

Richard M. Stallman's avatar
Richard M. Stallman committed
732 733
  bcopy (XSTRING (dirname)->data, fullname, pos);
#ifndef VMS
734 735
  if (!IS_DIRECTORY_SEP (fullname[pos - 1]))
    fullname[pos++] = DIRECTORY_SEP;
Richard M. Stallman's avatar
Richard M. Stallman committed
736 737 738 739 740
#endif

  bcopy (dp->d_name, fullname + pos, len);
  fullname[pos + len] = 0;

741
#ifdef S_IFLNK
742 743 744 745 746 747
  /* We want to return success if a link points to a nonexistent file,
     but we want to return the status for what the link points to,
     in case it is a directory.  */
  value = lstat (fullname, st_addr);
  stat (fullname, st_addr);
  return value;
748
#else
749 750 751 752 753 754 755 756
  value = stat (fullname, st_addr);
#ifdef MSDOS
#if __DJGPP__ > 1
  _djstat_flags = save_djstat_flags;
#endif /* __DJGPP__ > 1 */
#endif /* MSDOS */
  return value;
#endif /* S_IFLNK */
Richard M. Stallman's avatar
Richard M. Stallman committed
757 758
}

759 760 761 762
#ifdef VMS

DEFUN ("file-name-all-versions", Ffile_name_all_versions,
  Sfile_name_all_versions, 2, 2, 0,
763 764 765
  "Return a list of all versions of file name FILE in directory DIRECTORY.")
  (file, directory)
     Lisp_Object file, directory;
766
{
767
  return file_name_completion (file, directory, 1, 1);
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
}

DEFUN ("file-version-limit", Ffile_version_limit, Sfile_version_limit, 1, 1, 0,
  "Return the maximum number of versions allowed for FILE.\n\
Returns nil if the file cannot be opened or if there is no version limit.")
  (filename)
     Lisp_Object filename;
{
  Lisp_Object retval;
  struct FAB    fab;
  struct RAB    rab;
  struct XABFHC xabfhc;
  int status;

  filename = Fexpand_file_name (filename, Qnil);
  fab      = cc$rms_fab;
  xabfhc   = cc$rms_xabfhc;
  fab.fab$l_fna = XSTRING (filename)->data;
  fab.fab$b_fns = strlen (fab.fab$l_fna);
  fab.fab$l_xab = (char *) &xabfhc;
  status = sys$open (&fab, 0, 0);
  if (status != RMS$_NORMAL)	/* Probably non-existent file */
    return Qnil;
  sys$close (&fab, 0, 0);
  if (xabfhc.xab$w_verlimit == 32767)
    return Qnil;		/* No version limit */
  else
    return make_number (xabfhc.xab$w_verlimit);
}

#endif /* VMS */

Richard M. Stallman's avatar
Richard M. Stallman committed
800 801
Lisp_Object
make_time (time)
802
     time_t time;
Richard M. Stallman's avatar
Richard M. Stallman committed
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
{
  return Fcons (make_number (time >> 16),
		Fcons (make_number (time & 0177777), Qnil));
}

DEFUN ("file-attributes", Ffile_attributes, Sfile_attributes, 1, 1, 0,
  "Return a list of attributes of file FILENAME.\n\
Value is nil if specified file cannot be opened.\n\
Otherwise, list elements are:\n\
 0. t for directory, string (name linked to) for symbolic link, or nil.\n\
 1. Number of links to file.\n\
 2. File uid.\n\
 3. File gid.\n\
 4. Last access time, as a list of two integers.\n\
  First integer has high-order 16 bits of time, second has low 16 bits.\n\
 5. Last modification time, likewise.\n\
 6. Last status change time, likewise.\n\
820 821
 7. Size in bytes.\n\
  This is a floating point number if the size is too large for an integer.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
822 823
 8. File modes, as a string of ten letters or dashes as in ls -l.\n\
 9. t iff file's gid would change if file were deleted and recreated.\n\
824
10. inode number.  If inode number is larger than the Emacs integer,\n\
825 826
  this is a cons cell containing two integers: first the high part,\n\
  then the low 16 bits.\n\
Eli Zaretskii's avatar
Eli Zaretskii committed
827 828
11. Device number.  If it is larger than the Emacs integer, this is\n\
  a cons cell, similar to the inode number.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
829
\n\
830
If file does not exist, returns nil.")
Richard M. Stallman's avatar
Richard M. Stallman committed
831 832 833 834
  (filename)
     Lisp_Object filename;
{
  Lisp_Object values[12];
835
  Lisp_Object encoded;
Richard M. Stallman's avatar
Richard M. Stallman committed
836
  struct stat s;
837
#if defined (BSD4_2) || defined (BSD4_3)
838
  Lisp_Object dirname;
Richard M. Stallman's avatar
Richard M. Stallman committed
839
  struct stat sdir;
840
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
841
  char modes[10];
842
  Lisp_Object handler;
Richard M. Stallman's avatar
Richard M. Stallman committed
843 844

  filename = Fexpand_file_name (filename, Qnil);
845 846 847

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
848
  handler = Ffind_file_name_handler (filename, Qfile_attributes);
849 850 851
  if (!NILP (handler))
    return call2 (handler, Qfile_attributes, filename);

852 853 854
  encoded = ENCODE_FILE (filename);

  if (lstat (XSTRING (encoded)->data, &s) < 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
    return Qnil;

  switch (s.st_mode & S_IFMT)
    {
    default:
      values[0] = Qnil; break;
    case S_IFDIR:
      values[0] = Qt; break;
#ifdef S_IFLNK
    case S_IFLNK:
      values[0] = Ffile_symlink_p (filename); break;
#endif
    }
  values[1] = make_number (s.st_nlink);
  values[2] = make_number (s.st_uid);
  values[3] = make_number (s.st_gid);
  values[4] = make_time (s.st_atime);
  values[5] = make_time (s.st_mtime);
  values[6] = make_time (s.st_ctime);
874
  values[7] = make_number (s.st_size);
875
  /* If the size is out of range for an integer, return a float.  */
876
  if (XINT (values[7]) != s.st_size)
877
    values[7] = make_float ((double)s.st_size);
Richard M. Stallman's avatar
Richard M. Stallman committed
878 879
  filemodestring (&s, modes);
  values[8] = make_string (modes, 10);
880
#if defined (BSD4_2) || defined (BSD4_3) /* file gid will be dir gid */
Richard M. Stallman's avatar
Richard M. Stallman committed
881
  dirname = Ffile_name_directory (filename);
882 883 884
  if (! NILP (dirname))
    encoded = ENCODE_FILE (dirname);
  if (! NILP (dirname) && stat (XSTRING (encoded)->data, &sdir) == 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
885 886 887 888 889 890
    values[9] = (sdir.st_gid != s.st_gid) ? Qt : Qnil;
  else					/* if we can't tell, assume worst */
    values[9] = Qt;
#else					/* file gid will be egid */
  values[9] = (s.st_gid != getegid ()) ? Qt : Qnil;
#endif	/* BSD4_2 (or BSD4_3) */
891
  /* Cast -1 to avoid warning if int is not as wide as VALBITS.  */
892
  if (FIXNUM_OVERFLOW_P (s.st_ino))
893 894 895 896 897 898 899
    /* To allow inode numbers larger than VALBITS, separate the bottom
       16 bits.  */
    values[10] = Fcons (make_number (s.st_ino >> 16),
			make_number (s.st_ino & 0xffff));
  else
    /* But keep the most common cases as integers.  */
    values[10] = make_number (s.st_ino);
900 901

  /* Likewise for device.  */
902
  if (FIXNUM_OVERFLOW_P (s.st_dev))
903 904 905 906 907
    values[11] = Fcons (make_number (s.st_dev >> 16),
			make_number (s.st_dev & 0xffff));
  else
    values[11] = make_number (s.st_dev);

Richard M. Stallman's avatar
Richard M. Stallman committed
908 909
  return Flist (sizeof(values) / sizeof(values[0]), values);
}
910 911 912 913 914 915 916 917 918

DEFUN ("file-attributes-lessp", Ffile_attributes_lessp, Sfile_attributes_lessp, 2, 2, 0,
  "Return t if first arg file attributes list is less than second.\n\
Comparison is in lexicographic order and case is significant.")
  (f1, f2)
     Lisp_Object f1, f2;
{
  return Fstring_lessp (Fcar (f1), Fcar (f2));
}
Richard M. Stallman's avatar
Richard M. Stallman committed
919

Andreas Schwab's avatar
Andreas Schwab committed
920
void
Richard M. Stallman's avatar
Richard M. Stallman committed
921 922
syms_of_dired ()
{
923
  Qdirectory_files = intern ("directory-files");
924
  Qdirectory_files_and_attributes = intern ("directory-files-and-attributes");
925 926
  Qfile_name_completion = intern ("file-name-completion");
  Qfile_name_all_completions = intern ("file-name-all-completions");
Jim Blandy's avatar
Jim Blandy committed
927
  Qfile_attributes = intern ("file-attributes");
928
  Qfile_attributes_lessp = intern ("file-attributes-lessp");
929

930
  staticpro (&Qdirectory_files);
931
  staticpro (&Qdirectory_files_and_attributes);
932 933 934
  staticpro (&Qfile_name_completion);
  staticpro (&Qfile_name_all_completions);
  staticpro (&Qfile_attributes);
935
  staticpro (&Qfile_attributes_lessp);
936

Richard M. Stallman's avatar
Richard M. Stallman committed
937
  defsubr (&Sdirectory_files);
938
  defsubr (&Sdirectory_files_and_attributes);
Richard M. Stallman's avatar
Richard M. Stallman committed
939 940 941
  defsubr (&Sfile_name_completion);
#ifdef VMS
  defsubr (&Sfile_name_all_versions);
942
  defsubr (&Sfile_version_limit);
Richard M. Stallman's avatar
Richard M. Stallman committed
943 944 945
#endif /* VMS */
  defsubr (&Sfile_name_all_completions);
  defsubr (&Sfile_attributes);
946
  defsubr (&Sfile_attributes_lessp);
Richard M. Stallman's avatar
Richard M. Stallman committed
947 948 949 950 951 952 953 954 955 956 957 958

#ifdef VMS
  Qcompletion_ignore_case = intern ("completion-ignore-case");
  staticpro (&Qcompletion_ignore_case);
#endif /* VMS */

  DEFVAR_LISP ("completion-ignored-extensions", &Vcompletion_ignored_extensions,
    "*Completion ignores filenames ending in any string in this list.\n\
This variable does not affect lists of possible completions,\n\
but does affect the commands that actually do completions.");
  Vcompletion_ignored_extensions = Qnil;
}