dired-x.el misc cleanup.

[emacs.git] / src / dired.c

/* Lisp functions for making directory listings.
   Copyright (C) 1985-1986, 1993-1994, 1999-2011 Free Software Foundation, Inc.

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
the Free Software Foundation, either version 3 of the License, or
(at your option) 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.  If not, see <http://www.gnu.org/licenses/>.  */


#include <config.h>

#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <setjmp.h>

#ifdef HAVE_PWD_H
#include <pwd.h>
#endif
#include <grp.h>

#include <errno.h>
#include <unistd.h>

/* 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)

#ifdef HAVE_DIRENT_H

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

#else /* not HAVE_DIRENT_H */

#include <sys/dir.h>
#include <sys/stat.h>

#define DIRENTRY struct direct

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

#endif /* HAVE_DIRENT_H */

#ifdef MSDOS
#define DIRENTRY_NONEMPTY(p) ((p)->d_name[0] != 0)
#else
#define DIRENTRY_NONEMPTY(p) ((p)->d_ino)
#endif

#include "lisp.h"
#include "systime.h"
#include "buffer.h"
#include "commands.h"
#include "character.h"
#include "charset.h"
#include "coding.h"
#include "regex.h"
#include "blockinput.h"

/* Returns a search buffer, with a fastmap allocated and ready to go.  */
extern struct re_pattern_buffer *compile_pattern (Lisp_Object,
                                                  struct re_registers *,
                                                  Lisp_Object, int, int);

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

/* 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

Lisp_Object Qdirectory_files;
Lisp_Object Qdirectory_files_and_attributes;
Lisp_Object Qfile_name_completion;
Lisp_Object Qfile_name_all_completions;
Lisp_Object Qfile_attributes;
Lisp_Object Qfile_attributes_lessp;

static int scmp (const char *, const char *, int);
\f
#ifdef WINDOWSNT
Lisp_Object
directory_files_internal_w32_unwind (Lisp_Object arg)
{
  Vw32_get_true_file_attributes = arg;
  return Qnil;
}
#endif

Lisp_Object
directory_files_internal_unwind (Lisp_Object dh)
{
  DIR *d = (DIR *) XSAVE_VALUE (dh)->pointer;
  BLOCK_INPUT;
  closedir (d);
  UNBLOCK_INPUT;
  return Qnil;
}

/* 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.
   In the latter case, ID_FORMAT is passed to Ffile_attributes.  */

Lisp_Object
directory_files_internal (Lisp_Object directory, Lisp_Object full, Lisp_Object match, Lisp_Object nosort, int attrs, Lisp_Object id_format)
{
  DIR *d;
  int directory_nbytes;
  Lisp_Object list, dirfilename, encoded_directory;
  struct re_pattern_buffer *bufp = NULL;
  int needsep = 0;
  int count = SPECPDL_INDEX ();
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
  DIRENTRY *dp;
#ifdef WINDOWSNT
  Lisp_Object w32_save = Qnil;
#endif

  /* Because of file name handlers, these functions might call
     Ffuncall, and cause a GC.  */
  list = encoded_directory = dirfilename = Qnil;
  GCPRO5 (match, directory, list, dirfilename, encoded_directory);
  dirfilename = Fdirectory_file_name (directory);

  if (!NILP (match))
    {
      CHECK_STRING (match);

      /* MATCH might be a flawed regular expression.  Rather than
         catching and signaling our own errors, we just call
         compile_pattern to do the work for us.  */
      /* Pass 1 for the MULTIBYTE arg
         because we do make multibyte strings if the contents warrant.  */
# ifdef WINDOWSNT
      /* Windows users want case-insensitive wildcards.  */
      bufp = compile_pattern (match, 0,
                              buffer_defaults.case_canon_table, 0, 1);
# else  /* !WINDOWSNT */
      bufp = compile_pattern (match, 0, Qnil, 0, 1);
# endif  /* !WINDOWSNT */
    }

  /* Note: ENCODE_FILE and DECODE_FILE can GC because they can run
     run_pre_post_conversion_on_str which calls Lisp directly and
     indirectly.  */
  if (STRING_MULTIBYTE (dirfilename))
    dirfilename = ENCODE_FILE (dirfilename);
  encoded_directory = (STRING_MULTIBYTE (directory)
                       ? ENCODE_FILE (directory) : directory);

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

  BLOCK_INPUT;
  d = opendir (SSDATA (dirfilename));
  UNBLOCK_INPUT;
  if (d == NULL)
    report_file_error ("Opening directory", Fcons (directory, Qnil));

  /* 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,
                         make_save_value (d, 0));

#ifdef WINDOWSNT
  if (attrs)
    {
      extern int is_slow_fs (const char *);

      /* Do this only once to avoid doing it (in w32.c:stat) for each
         file in the directory, when we call Ffile_attributes below.  */
      record_unwind_protect (directory_files_internal_w32_unwind,
                             Vw32_get_true_file_attributes);
      w32_save = Vw32_get_true_file_attributes;
      if (EQ (Vw32_get_true_file_attributes, Qlocal))
        {
          /* w32.c:stat will notice these bindings and avoid calling
             GetDriveType for each file.  */
          if (is_slow_fs (SDATA (dirfilename)))
            Vw32_get_true_file_attributes = Qnil;
          else
            Vw32_get_true_file_attributes = Qt;
        }
    }
#endif

  directory_nbytes = SBYTES (directory);
  re_match_object = Qt;

  /* Decide whether we need to add a directory separator.  */
  if (directory_nbytes == 0
      || !IS_ANY_SEP (SREF (directory, directory_nbytes - 1)))
    needsep = 1;

  /* Loop reading blocks until EOF or error.  */
  for (;;)
    {
      errno = 0;
      dp = readdir (d);

      if (dp == NULL && (0
#ifdef EAGAIN
                         || errno == EAGAIN
#endif
#ifdef EINTR
                         || errno == EINTR
#endif
                         ))
        { QUIT; continue; }

      if (dp == NULL)
        break;

      if (DIRENTRY_NONEMPTY (dp))
        {
          int len;
          int wanted = 0;
          Lisp_Object name, finalname;
          struct gcpro gcpro1, gcpro2;

          len = NAMLEN (dp);
          name = finalname = make_unibyte_string (dp->d_name, len);
          GCPRO2 (finalname, name);

          /* Note: DECODE_FILE can GC; it should protect its argument,
             though.  */
          name = DECODE_FILE (name);
          len = SBYTES (name);

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

          if (NILP (match)
              || (0 <= re_search (bufp, SSDATA (name), len, 0, len, 0)))
            wanted = 1;

          immediate_quit = 0;

          if (wanted)
            {
              if (!NILP (full))
                {
                  Lisp_Object fullname;
                  int nbytes = len + directory_nbytes + needsep;
                  int nchars;

                  fullname = make_uninit_multibyte_string (nbytes, nbytes);
                  memcpy (SDATA (fullname), SDATA (directory),
                          directory_nbytes);

                  if (needsep)
                    SSET (fullname, directory_nbytes, DIRECTORY_SEP);

                  memcpy (SDATA (fullname) + directory_nbytes + needsep,
                          SDATA (name), len);

                  nchars = chars_in_text (SDATA (fullname), nbytes);

                  /* Some bug somewhere.  */
                  if (nchars > nbytes)
                    abort ();

                  STRING_SET_CHARS (fullname, nchars);
                  if (nchars == nbytes)
                    STRING_SET_UNIBYTE (fullname);

                  finalname = fullname;
                }
              else
                finalname = name;

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

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

                  /* Both Fexpand_file_name and Ffile_attributes can GC.  */
                  decoded_fullname = Fexpand_file_name (name, directory);
                  fileattrs = Ffile_attributes (decoded_fullname, id_format);

                  list = Fcons (Fcons (finalname, fileattrs), list);
                  UNGCPRO;
                }
              else
                list = Fcons (finalname, list);
            }

          UNGCPRO;
        }
    }

  BLOCK_INPUT;
  closedir (d);
  UNBLOCK_INPUT;
#ifdef WINDOWSNT
  if (attrs)
    Vw32_get_true_file_attributes = w32_save;
#endif

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

  if (NILP (nosort))
    list = Fsort (Fnreverse (list),
                  attrs ? Qfile_attributes_lessp : Qstring_lessp);

  RETURN_UNGCPRO (list);
}


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

  /* 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))
    return call5 (handler, Qdirectory_files, directory,
                  full, match, nosort);

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

DEFUN ("directory-files-and-attributes", Fdirectory_files_and_attributes,
       Sdirectory_files_and_attributes, 1, 5, 0,
       doc: /* Return a list of names of files and their attributes in DIRECTORY.
There are four optional arguments:
If FULL is non-nil, return absolute file names.  Otherwise return names
 that are relative to the specified directory.
If MATCH is non-nil, mention only file names that match the regexp MATCH.
If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
 NOSORT is useful if you plan to sort the result yourself.
ID-FORMAT specifies the preferred format of attributes uid and gid, see
`file-attributes' for further documentation.
On MS-Windows, performance depends on `w32-get-true-file-attributes',
which see.  */)
  (Lisp_Object directory, Lisp_Object full, Lisp_Object match, Lisp_Object nosort, Lisp_Object id_format)
{
  Lisp_Object handler;
  directory = Fexpand_file_name (directory, Qnil);

  /* 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))
    return call6 (handler, Qdirectory_files_and_attributes,
                  directory, full, match, nosort, id_format);

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

\f
Lisp_Object file_name_completion (Lisp_Object file, Lisp_Object dirname, int all_flag, int ver_flag, Lisp_Object predicate);

DEFUN ("file-name-completion", Ffile_name_completion, Sfile_name_completion,
       2, 3, 0,
       doc: /* Complete file name FILE in directory DIRECTORY.
Returns the longest string
common to all file names in DIRECTORY that start with FILE.
If there is only one and FILE matches it exactly, returns t.
Returns nil if DIRECTORY contains no name starting with FILE.

If PREDICATE is non-nil, call PREDICATE with each possible
completion (in absolute form) and ignore it if PREDICATE returns nil.

This function ignores some of the possible completions as
determined by the variable `completion-ignored-extensions', which see.  */)
  (Lisp_Object file, Lisp_Object directory, Lisp_Object predicate)
{
  Lisp_Object handler;

  /* If the directory name has special constructs in it,
     call the corresponding file handler.  */
  handler = Ffind_file_name_handler (directory, Qfile_name_completion);
  if (!NILP (handler))
    return call4 (handler, Qfile_name_completion, file, directory, predicate);

  /* 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))
    return call4 (handler, Qfile_name_completion, file, directory, predicate);

  return file_name_completion (file, directory, 0, 0, predicate);
}

DEFUN ("file-name-all-completions", Ffile_name_all_completions,
       Sfile_name_all_completions, 2, 2, 0,
       doc: /* Return a list of all completions of file name FILE in directory DIRECTORY.
These are all file names in directory DIRECTORY which begin with FILE.  */)
  (Lisp_Object file, Lisp_Object directory)
{
  Lisp_Object handler;

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

  /* 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))
    return call3 (handler, Qfile_name_all_completions, file, directory);

  return file_name_completion (file, directory, 1, 0, Qnil);
}

static int file_name_completion_stat (Lisp_Object dirname, DIRENTRY *dp, struct stat *st_addr);
Lisp_Object Qdefault_directory;

Lisp_Object
file_name_completion (Lisp_Object file, Lisp_Object dirname, int all_flag, int ver_flag, Lisp_Object predicate)
{
  DIR *d;
  int bestmatchsize = 0;
  int matchcount = 0;
  /* If ALL_FLAG is 1, BESTMATCH is the list of all matches, decoded.
     If ALL_FLAG is 0, BESTMATCH is either nil
     or the best match so far, not decoded.  */
  Lisp_Object bestmatch, tem, elt, name;
  Lisp_Object encoded_file;
  Lisp_Object encoded_dir;
  struct stat st;
  int directoryp;
  /* If includeall is zero, exclude files in completion-ignored-extensions as
     well as "." and "..".  Until shown otherwise, assume we can't exclude
     anything.  */
  int includeall = 1;
  int count = SPECPDL_INDEX ();
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;

  elt = Qnil;

  CHECK_STRING (file);

#ifdef FILE_SYSTEM_CASE
  file = FILE_SYSTEM_CASE (file);
#endif
  bestmatch = Qnil;
  encoded_file = encoded_dir = Qnil;
  GCPRO5 (file, dirname, bestmatch, encoded_file, encoded_dir);
  dirname = Fexpand_file_name (dirname, Qnil);
  specbind (Qdefault_directory, dirname);

  /* 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.  */
  /* Actually, this is not quite true any more: we do most of the completion
     work with decoded file names, but we still do some filtering based
     on the encoded file name.  */
  encoded_file = STRING_MULTIBYTE (file) ? ENCODE_FILE (file) : file;

  encoded_dir = ENCODE_FILE (dirname);

  BLOCK_INPUT;
  d = opendir (SSDATA (Fdirectory_file_name (encoded_dir)));
  UNBLOCK_INPUT;
  if (!d)
    report_file_error ("Opening directory", Fcons (dirname, Qnil));

  record_unwind_protect (directory_files_internal_unwind,
                         make_save_value (d, 0));

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

      errno = 0;
      dp = readdir (d);
      if (dp == NULL && (0
# ifdef EAGAIN
                         || errno == EAGAIN
# endif
# ifdef EINTR
                         || errno == EINTR
# endif
                         ))
        { QUIT; continue; }

      if (!dp) break;

      len = NAMLEN (dp);

      QUIT;
      if (! DIRENTRY_NONEMPTY (dp)
          || len < SCHARS (encoded_file)
          || 0 <= scmp (dp->d_name, SSDATA (encoded_file),
                        SCHARS (encoded_file)))
        continue;

      if (file_name_completion_stat (encoded_dir, dp, &st) < 0)
        continue;

      directoryp = ((st.st_mode & S_IFMT) == S_IFDIR);
      tem = Qnil;
      /* If all_flag is set, always include all.
         It would not actually be helpful to the user to ignore any possible
         completions when making a list of them.  */
      if (!all_flag)
        {
          int skip;

#if 0 /* FIXME: The `scmp' call compares an encoded and a decoded string. */
          /* If this entry matches the current bestmatch, the only
             thing it can do is increase matchcount, so don't bother
             investigating it any further.  */
          if (!completion_ignore_case
              /* The return result depends on whether it's the sole match.  */
              && matchcount > 1
              && !includeall /* This match may allow includeall to 0.  */
              && len >= bestmatchsize
              && 0 > scmp (dp->d_name, SSDATA (bestmatch), bestmatchsize))
            continue;
#endif

          if (directoryp)
            {
#ifndef TRIVIAL_DIRECTORY_ENTRY
#define TRIVIAL_DIRECTORY_ENTRY(n) (!strcmp (n, ".") || !strcmp (n, ".."))
#endif
              /* "." and ".." are never interesting as completions, and are
                 actually in the way in a directory with only one file.  */
              if (TRIVIAL_DIRECTORY_ENTRY (dp->d_name))
                canexclude = 1;
              else if (len > SCHARS (encoded_file))
                /* Ignore directories if they match an element of
                   completion-ignored-extensions which ends in a slash.  */
                for (tem = Vcompletion_ignored_extensions;
                     CONSP (tem); tem = XCDR (tem))
                  {
                    int elt_len;
                    char *p1;

                    elt = XCAR (tem);
                    if (!STRINGP (elt))
                      continue;
                    /* Need to encode ELT, since scmp compares unibyte
                       strings only.  */
                    elt = ENCODE_FILE (elt);
                    elt_len = SCHARS (elt) - 1; /* -1 for trailing / */
                    if (elt_len <= 0)
                      continue;
                    p1 = SSDATA (elt);
                    if (p1[elt_len] != '/')
                      continue;
                    skip = len - elt_len;
                    if (skip < 0)
                      continue;

                    if (0 <= scmp (dp->d_name + skip, p1, elt_len))
                      continue;
                    break;
                  }
            }
          else
            {
              /* Compare extensions-to-be-ignored against end of this file name */
              /* if name is not an exact match against specified string */
              if (len > SCHARS (encoded_file))
                /* and exit this for loop if a match is found */
                for (tem = Vcompletion_ignored_extensions;
                     CONSP (tem); tem = XCDR (tem))
                  {
                    elt = XCAR (tem);
                    if (!STRINGP (elt)) continue;
                    /* Need to encode ELT, since scmp compares unibyte
                       strings only.  */
                    elt = ENCODE_FILE (elt);
                    skip = len - SCHARS (elt);
                    if (skip < 0) continue;

                    if (0 <= scmp (dp->d_name + skip,
                                   SSDATA (elt),
                                   SCHARS (elt)))
                      continue;
                    break;
                  }
            }

          /* If an ignored-extensions match was found,
             don't process this name as a completion.  */
          if (CONSP (tem))
            canexclude = 1;

          if (!includeall && canexclude)
            /* We're not including all files and this file can be excluded.  */
            continue;

          if (includeall && !canexclude)
            { /* If we have one non-excludable file, we want to exclude the
                 excudable files.  */
              includeall = 0;
              /* Throw away any previous excludable match found.  */
              bestmatch = Qnil;
              bestmatchsize = 0;
              matchcount = 0;
            }
        }
      /* FIXME: If we move this `decode' earlier we can eliminate
         the repeated ENCODE_FILE on Vcompletion_ignored_extensions.  */
      name = make_unibyte_string (dp->d_name, len);
      name = DECODE_FILE (name);

      {
        Lisp_Object regexps;
        Lisp_Object zero;
        XSETFASTINT (zero, 0);

        /* Ignore this element if it fails to match all the regexps.  */
        if (completion_ignore_case)
          {
            for (regexps = Vcompletion_regexp_list; CONSP (regexps);
                 regexps = XCDR (regexps))
              if (fast_string_match_ignore_case (XCAR (regexps), name) < 0)
                break;
          }
        else
          {
            for (regexps = Vcompletion_regexp_list; CONSP (regexps);
                 regexps = XCDR (regexps))
              if (fast_string_match (XCAR (regexps), name) < 0)
                break;
          }

        if (CONSP (regexps))
          continue;
      }

      /* This is a possible completion */
      if (directoryp)
        /* This completion is a directory; make it end with '/'.  */
        name = Ffile_name_as_directory (name);

      /* Test the predicate, if any.  */
      if (!NILP (predicate))
        {
          Lisp_Object val;
          struct gcpro gcpro1;

          GCPRO1 (name);
          val = call1 (predicate, name);
          UNGCPRO;

          if (NILP (val))
            continue;
        }

      /* Suitably record this match.  */

      matchcount++;

      if (all_flag)
        bestmatch = Fcons (name, bestmatch);
      else if (NILP (bestmatch))
        {
          bestmatch = name;
          bestmatchsize = SCHARS (name);
        }
      else
        {
          Lisp_Object zero = make_number (0);
          /* FIXME: This is a copy of the code in Ftry_completion.  */
          int compare = min (bestmatchsize, SCHARS (name));
          Lisp_Object tem
            = Fcompare_strings (bestmatch, zero,
                                make_number (compare),
                                name, zero,
                                make_number (compare),
                                completion_ignore_case ? Qt : Qnil);
          int matchsize
            = (EQ (tem, Qt)     ? compare
               : XINT (tem) < 0 ? - XINT (tem) - 1
               :                  XINT (tem) - 1);

          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.  */
              /* This tests that the current file is an exact match
                 but BESTMATCH is not (it is too long).  */
              if ((matchsize == SCHARS (name)
                   && matchsize + !!directoryp < SCHARS (bestmatch))
                  ||
                  /* If there is no exact match ignoring case,
                     prefer a match that does not change the case
                     of the input.  */
                  /* 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.  */
                  (((matchsize == SCHARS (name))
                    ==
                    (matchsize + !!directoryp == SCHARS (bestmatch)))
                   && (tem = Fcompare_strings (name, zero,
                                               make_number (SCHARS (file)),
                                               file, zero,
                                               Qnil,
                                               Qnil),
                       EQ (Qt, tem))
                   && (tem = Fcompare_strings (bestmatch, zero,
                                               make_number (SCHARS (file)),
                                               file, zero,
                                               Qnil,
                                               Qnil),
                       ! EQ (Qt, tem))))
                bestmatch = name;
            }
          bestmatchsize = matchsize;

          /* If the best completion so far is reduced to the string
             we're trying to complete, then we already know there's no
             other completion, so there's no point looking any further.  */
          if (matchsize <= SCHARS (file)
              && !includeall /* A future match may allow includeall to 0.  */
              /* If completion-ignore-case is non-nil, don't
                 short-circuit because we want to find the best
                 possible match *including* case differences.  */
              && (!completion_ignore_case || matchsize == 0)
              /* The return value depends on whether it's the sole match.  */
              && matchcount > 1)
            break;

        }
    }

  UNGCPRO;
  /* This closes the directory.  */
  bestmatch = unbind_to (count, bestmatch);

  if (all_flag || NILP (bestmatch))
    return bestmatch;
  /* Return t if the supplied string is an exact match (counting case);
     it does not require any change to be made.  */
  if (matchcount == 1 && !NILP (Fequal (bestmatch, file)))
    return Qt;
  bestmatch = Fsubstring (bestmatch, make_number (0),
                          make_number (bestmatchsize));
  return bestmatch;
}

/* Compare exactly LEN chars of strings at S1 and S2,
   ignoring case if appropriate.
   Return -1 if strings match,
   else number of chars that match at the beginning.  */

static int
scmp (const char *s1, const char *s2, int len)
{
  register int l = len;

  if (completion_ignore_case)
    {
      while (l
             && (DOWNCASE ((unsigned char) *s1++)
                 == DOWNCASE ((unsigned char) *s2++)))
        l--;
    }
  else
    {
      while (l && *s1++ == *s2++)
        l--;
    }
  if (l == 0)
    return -1;
  else
    return len - l;
}

static int
file_name_completion_stat (Lisp_Object dirname, DIRENTRY *dp, struct stat *st_addr)
{
  int len = NAMLEN (dp);
  int pos = SCHARS (dirname);
  int value;
  char *fullname = (char *) alloca (len + pos + 2);

#ifdef MSDOS
  /* 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 /* MSDOS */

  memcpy (fullname, SDATA (dirname), pos);
  if (!IS_DIRECTORY_SEP (fullname[pos - 1]))
    fullname[pos++] = DIRECTORY_SEP;

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

#ifdef S_IFLNK
  /* 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;
#else
  value = stat (fullname, st_addr);
#ifdef MSDOS
  _djstat_flags = save_djstat_flags;
#endif /* MSDOS */
  return value;
#endif /* S_IFLNK */
}
\f
Lisp_Object
make_time (time_t time)
{
  return Fcons (make_number (time >> 16),
                Fcons (make_number (time & 0177777), Qnil));
}

static char *
stat_uname (struct stat *st)
{
#ifdef WINDOWSNT
  return st->st_uname;
#else
  struct passwd *pw = (struct passwd *) getpwuid (st->st_uid);

  if (pw)
    return pw->pw_name;
  else
    return NULL;
#endif
}

static char *
stat_gname (struct stat *st)
{
#ifdef WINDOWSNT
  return st->st_gname;
#else
  struct group *gr = (struct group *) getgrgid (st->st_gid);

  if (gr)
    return gr->gr_name;
  else
    return NULL;
#endif
}

DEFUN ("file-attributes", Ffile_attributes, Sfile_attributes, 1, 2, 0,
       doc: /* Return a list of attributes of file FILENAME.
Value is nil if specified file cannot be opened.

ID-FORMAT specifies the preferred format of attributes uid and gid (see
below) - valid values are 'string and 'integer.  The latter is the
default, but we plan to change that, so you should specify a non-nil value
for ID-FORMAT if you use the returned uid or gid.

Elements of the attribute list are:
 0. t for directory, string (name linked to) for symbolic link, or nil.
 1. Number of links to file.
 2. File uid as a string or a number.  If a string value cannot be
  looked up, a numeric value, either an integer or a float, is returned.
 3. File gid, likewise.
 4. Last access time, as a list of two integers.
  First integer has high-order 16 bits of time, second has low 16 bits.
  (See a note below about access time on FAT-based filesystems.)
 5. Last modification time, likewise.  This is the time of the last
  change to the file's contents.
 6. Last status change time, likewise.  This is the time of last change
  to the file's attributes: owner and group, access mode bits, etc.
 7. Size in bytes.
  This is a floating point number if the size is too large for an integer.
 8. File modes, as a string of ten letters or dashes as in ls -l.
 9. t if file's gid would change if file were deleted and recreated.
10. inode number.  If inode number is larger than what Emacs integer
  can hold, but still fits into a 32-bit number, this is a cons cell
  containing two integers: first the high part, then the low 16 bits.
  If the inode number is wider than 32 bits, this is of the form
  (HIGH MIDDLE . LOW): first the high 24 bits, then middle 24 bits,
  and finally the low 16 bits.
11. Filesystem device number.  If it is larger than what the Emacs
  integer can hold, this is a cons cell, similar to the inode number.

On most filesystems, the combination of the inode and the device
number uniquely identifies the file.

On MS-Windows, performance depends on `w32-get-true-file-attributes',
which see.

On some FAT-based filesystems, only the date of last access is recorded,
so last access time will always be midnight of that day.  */)
  (Lisp_Object filename, Lisp_Object id_format)
{
  Lisp_Object values[12];
  Lisp_Object encoded;
  struct stat s;
#ifdef BSD4_2
  Lisp_Object dirname;
  struct stat sdir;
#endif /* BSD4_2 */
  char modes[10];
  Lisp_Object handler;
  struct gcpro gcpro1;
  char *uname = NULL, *gname = NULL;

  filename = Fexpand_file_name (filename, Qnil);

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
  handler = Ffind_file_name_handler (filename, Qfile_attributes);
  if (!NILP (handler))
    { /* Only pass the extra arg if it is used to help backward compatibility
         with old file handlers which do not implement the new arg.  --Stef  */
      if (NILP (id_format))
        return call2 (handler, Qfile_attributes, filename);
      else
        return call3 (handler, Qfile_attributes, filename, id_format);
    }

  GCPRO1 (filename);
  encoded = ENCODE_FILE (filename);
  UNGCPRO;

  if (lstat (SSDATA (encoded), &s) < 0)
    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);

  if (!(NILP (id_format) || EQ (id_format, Qinteger)))
    {
      BLOCK_INPUT;
      uname = stat_uname (&s);
      gname = stat_gname (&s);
      UNBLOCK_INPUT;
    }
  if (uname)
    values[2] = DECODE_SYSTEM (build_string (uname));
  else
    values[2] = make_fixnum_or_float (s.st_uid);
  if (gname)
    values[3] = DECODE_SYSTEM (build_string (gname));
  else
    values[3] = make_fixnum_or_float (s.st_gid);

  values[4] = make_time (s.st_atime);
  values[5] = make_time (s.st_mtime);
  values[6] = make_time (s.st_ctime);
  values[7] = make_fixnum_or_float (s.st_size);
  /* If the size is negative, and its type is long, convert it back to
     positive.  */
  if (s.st_size < 0 && sizeof (s.st_size) == sizeof (long))
    values[7] = make_float ((double) ((unsigned long) s.st_size));

  filemodestring (&s, modes);
  values[8] = make_string (modes, 10);
#ifdef BSD4_2 /* file gid will be dir gid */
  dirname = Ffile_name_directory (filename);
  if (! NILP (dirname))
    encoded = ENCODE_FILE (dirname);
  if (! NILP (dirname) && stat (SDATA (encoded), &sdir) == 0)
    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  /* not BSD4_2 */
  if (!FIXNUM_OVERFLOW_P (s.st_ino))
    /* Keep the most common cases as integers.  */
    values[10] = make_number (s.st_ino);
  else if (!FIXNUM_OVERFLOW_P (s.st_ino >> 16))
    /* To allow inode numbers larger than VALBITS, separate the bottom
       16 bits.  */
    values[10] = Fcons (make_number ((EMACS_INT)(s.st_ino >> 16)),
                        make_number ((EMACS_INT)(s.st_ino & 0xffff)));
  else
    {
      /* To allow inode numbers beyond 32 bits, separate into 2 24-bit
         high parts and a 16-bit bottom part.
         The code on the next line avoids a compiler warning on
         systems where st_ino is 32 bit wide. (bug#766).  */
      EMACS_INT high_ino = s.st_ino >> 31 >> 1;
      EMACS_INT low_ino  = s.st_ino & 0xffffffff;

      values[10] = Fcons (make_number (high_ino >> 8),
                          Fcons (make_number (((high_ino & 0xff) << 16)
                                              + (low_ino >> 16)),
                                 make_number (low_ino & 0xffff)));
    }

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

  return Flist (sizeof(values) / sizeof(values[0]), values);
}

DEFUN ("file-attributes-lessp", Ffile_attributes_lessp, Sfile_attributes_lessp, 2, 2, 0,
       doc: /* Return t if first arg file attributes list is less than second.
Comparison is in lexicographic order and case is significant.  */)
  (Lisp_Object f1, Lisp_Object f2)
{
  return Fstring_lessp (Fcar (f1), Fcar (f2));
}
\f
void
syms_of_dired (void)
{
  Qdirectory_files = intern_c_string ("directory-files");
  Qdirectory_files_and_attributes = intern_c_string ("directory-files-and-attributes");
  Qfile_name_completion = intern_c_string ("file-name-completion");
  Qfile_name_all_completions = intern_c_string ("file-name-all-completions");
  Qfile_attributes = intern_c_string ("file-attributes");
  Qfile_attributes_lessp = intern_c_string ("file-attributes-lessp");
  Qdefault_directory = intern_c_string ("default-directory");

  staticpro (&Qdirectory_files);
  staticpro (&Qdirectory_files_and_attributes);
  staticpro (&Qfile_name_completion);
  staticpro (&Qfile_name_all_completions);
  staticpro (&Qfile_attributes);
  staticpro (&Qfile_attributes_lessp);
  staticpro (&Qdefault_directory);

  defsubr (&Sdirectory_files);
  defsubr (&Sdirectory_files_and_attributes);
  defsubr (&Sfile_name_completion);
  defsubr (&Sfile_name_all_completions);
  defsubr (&Sfile_attributes);
  defsubr (&Sfile_attributes_lessp);

  DEFVAR_LISP ("completion-ignored-extensions", Vcompletion_ignored_extensions,
               doc: /* Completion ignores file names ending in any string in this list.
It does not ignore them if all possible completions end in one of
these strings or when displaying a list of completions.
It ignores directory names if they match any string in this list which
ends in a slash.  */);
  Vcompletion_ignored_extensions = Qnil;
}