lisp/ls-lisp.el

   1 ;;; ls-lisp.el --- emulate insert-directory completely in Emacs Lisp
   2
   3 ;; Copyright (C) 1992, 1994, 2000-2015 Free Software Foundation, Inc.
   4
   5 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
   6 ;; Modified by: Francis J. Wright <F.J.Wright@maths.qmw.ac.uk>
   7 ;; Maintainer: emacs-devel@gnu.org
   8 ;; Keywords: unix, dired
   9 ;; Package: emacs
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software: you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation, either version 3 of the License, or
  16 ;; (at your option) any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  25
  26 ;;; Commentary:
  27
  28 ;; OVERVIEW ==========================================================
  29
  30 ;; This file advises the function `insert-directory' to implement it
  31 ;; directly from Emacs lisp, without running ls in a subprocess.
  32 ;; This is useful if you don't have ls installed (ie, on MS Windows).
  33
  34 ;; This function can use regexps instead of shell wildcards.  If you
  35 ;; enter regexps remember to double each $ sign.  For example, to
  36 ;; include files *.el, enter `.*\.el$$', resulting in the regexp
  37 ;; `.*\.el$'.
  38
  39 ;; RESTRICTIONS ======================================================
  40
  41 ;; * A few obscure ls switches are still ignored: see the docstring of
  42 ;; `insert-directory'.
  43
  44 ;; TO DO =============================================================
  45
  46 ;; Complete handling of F switch (if/when possible).
  47
  48 ;; FJW: May be able to sort much faster by consing the sort key onto
  49 ;; the front of each list element, sorting and then stripping the key
  50 ;; off again!
  51
  52 ;;; History:
  53
  54 ;; Written originally by Sebastian Kremer <sk@thp.uni-koeln.de>
  55 ;; Revised by Andrew Innes and Geoff Volker (and maybe others).
  56
  57 ;; Modified by Francis J. Wright <F.J.Wright@maths.qmw.ac.uk>, mainly
  58 ;; to support many more ls options, "platform emulation" and more
  59 ;; robust sorting.
  60
  61 ;;; Code:
  62
  63 (defgroup ls-lisp nil
  64   "Emulate the ls program completely in Emacs Lisp."
  65   :version "21.1"
  66   :group 'dired)
  67
  68 (defun ls-lisp-set-options ()
  69   "Reset the ls-lisp options that depend on `ls-lisp-emulation'."
  70   (mapc 'custom-reevaluate-setting
  71         '(ls-lisp-ignore-case ls-lisp-dirs-first ls-lisp-verbosity)))
  72
  73 (defcustom ls-lisp-emulation
  74   (cond ;; ((eq system-type 'windows-nt) 'MS-Windows)
  75         ((memq system-type '(hpux usg-unix-v irix berkeley-unix))
  76          'UNIX))        ; very similar to GNU
  77   ;; Anything else defaults to nil, meaning GNU.
  78   "Platform to emulate: GNU (default), MacOS, MS-Windows, UNIX.
  79 Corresponding value is one of: nil, `MacOS', `MS-Windows', `UNIX'.
  80 Set this to your preferred value; it need not match the actual platform
  81 you are using.
  82
  83 This variable does not affect the behavior of ls-lisp directly.
  84 Rather, it controls the default values for some variables that do:
  85 `ls-lisp-ignore-case', `ls-lisp-dirs-first', and `ls-lisp-verbosity'.
  86
  87 If you change this variable directly (without using customize)
  88 after loading `ls-lisp', you should use `ls-lisp-set-options' to
  89 update the dependent variables."
  90   :type '(choice (const :tag "GNU" nil)
  91                  (const MacOS)
  92                  (const MS-Windows)
  93                  (const UNIX))
  94   :initialize 'custom-initialize-default
  95   :set (lambda (symbol value)
  96          (unless (equal value (eval symbol))
  97            (custom-set-default symbol value)
  98            (ls-lisp-set-options)))
  99   :group 'ls-lisp)
 100
 101 ;; Only made an obsolete alias in 23.3.  Before that, the initial
 102 ;; value was set according to:
 103 ;;  (or (memq ls-lisp-emulation '(MS-Windows MacOS))
 104 ;;      (and (boundp 'ls-lisp-dired-ignore-case) ls-lisp-dired-ignore-case))
 105 ;; Which isn't the right thing to do.
 106 (define-obsolete-variable-alias 'ls-lisp-dired-ignore-case
 107   'ls-lisp-ignore-case "21.1")
 108
 109 (defcustom ls-lisp-ignore-case
 110   (memq ls-lisp-emulation '(MS-Windows MacOS))
 111   "Non-nil causes ls-lisp alphabetic sorting to ignore case."
 112   :set-after '(ls-lisp-emulation)
 113   :type 'boolean
 114   :group 'ls-lisp)
 115
 116 (defcustom ls-lisp-use-string-collate
 117   (cond ((memq ls-lisp-emulation '(MacOS UNIX)) nil)
 118         (t t))          ; GNU/Linux or MS-Windows emulate GNU ls
 119   "Non-nil causes ls-lisp to sort files in locale-dependent collation order.
 120
 121 A value of nil means use ordinary string comparison (see `compare-strings')
 122 for sorting files.  A non-nil value uses `string-collate-lessp' instead,
 123 which more closely emulates what GNU `ls' does.
 124
 125 On GNU/Linux systems, if the locale's codeset specifies UTF-8, as
 126 in \"en_US.UTF-8\", the collation order follows the Unicode
 127 Collation Algorithm (UCA), which places together file names that
 128 differ only in punctuation characters.  On MS-Windows, customize
 129 the option `ls-lisp-UCA-like-collation' to a non-nil value to get
 130 similar behavior."
 131   :version "25.1"
 132   :set-after '(ls-lisp-emulation)
 133   :type 'boolean
 134   :group 'ls-lisp)
 135
 136 (defcustom ls-lisp-UCA-like-collation t
 137   "Non-nil means force ls-lisp use a collation order compatible with UCA.
 138
 139 UCA is the Unicode Collation Algorithm.  GNU/Linux systems automatically
 140 follow it in their string-collation routines if the locale specifies
 141 UTF-8 as its codeset.  On MS-Windows, customize this option to a non-nil
 142 value to get similar behavior.
 143
 144 When this option is non-nil, and `ls-lisp-use-string-collate' is also
 145 non-nil, the collation order produced on MS-Windows will ignore
 146 punctuation and symbol characters, which will, for example, place
 147 `.foo' near `foo'.  See the documentation of `string-collate-lessp'
 148 and `w32-collate-ignore-punctuation' for more details.
 149
 150 This option is ignored on platforms other than MS-Windows; to
 151 control the collation ordering of the file names on those other
 152 systems, set your locale instead."
 153   :version "25.1"
 154   :type 'boolean
 155   :group 'ls-lisp)
 156
 157 (defcustom ls-lisp-dirs-first (eq ls-lisp-emulation 'MS-Windows)
 158   "Non-nil causes ls-lisp to sort directories first in any ordering.
 159 \(Or last if it is reversed.)  Follows Microsoft Windows Explorer."
 160   ;; Functionality suggested by Chris McMahan <cmcmahan@one.net>
 161   :set-after '(ls-lisp-emulation)
 162   :type 'boolean
 163   :group 'ls-lisp)
 164
 165 (defcustom ls-lisp-verbosity
 166   (cond ((eq ls-lisp-emulation 'MacOS) nil)
 167         ((eq ls-lisp-emulation 'MS-Windows)
 168          (if (and (fboundp 'w32-using-nt) (w32-using-nt))
 169              '(links)))                 ; distinguish NT/2K from 9x
 170         ((eq ls-lisp-emulation 'UNIX) '(links uid)) ; UNIX ls
 171         (t '(links uid gid)))           ; GNU ls
 172   "A list of optional file attributes that ls-lisp should display.
 173 It should contain none or more of the symbols: links, uid, gid.
 174 A value of nil (or an empty list) means display none of them.
 175
 176 Concepts come from UNIX: `links' means count of names associated with
 177 the file; `uid' means user (owner) identifier; `gid' means group
 178 identifier.
 179
 180 If emulation is MacOS then default is nil;
 181 if emulation is MS-Windows then default is `(links)' if platform is
 182 Windows NT/2K, nil otherwise;
 183 if emulation is UNIX then default is `(links uid)';
 184 if emulation is GNU then default is `(links uid gid)'."
 185   :set-after '(ls-lisp-emulation)
 186   ;; Functionality suggested by Howard Melman <howard@silverstream.com>
 187   :type '(set (const :tag "Show Link Count" links)
 188               (const :tag "Show User" uid)
 189               (const :tag "Show Group" gid))
 190   :group 'ls-lisp)
 191
 192 (defcustom ls-lisp-use-insert-directory-program
 193   (not (memq system-type '(ms-dos windows-nt)))
 194   "Non-nil causes ls-lisp to revert back to using `insert-directory-program'.
 195 This is useful on platforms where ls-lisp is dumped into Emacs, such as
 196 Microsoft Windows, but you would still like to use a program to list
 197 the contents of a directory."
 198   :type 'boolean
 199   :group 'ls-lisp)
 200
 201 ;;; Autoloaded because it is let-bound in `recover-session', `mail-recover-1'.
 202 ;;;###autoload
 203 (defcustom ls-lisp-support-shell-wildcards t
 204   "Non-nil means ls-lisp treats file patterns as shell wildcards.
 205 Otherwise they are treated as Emacs regexps (for backward compatibility)."
 206   :type 'boolean
 207   :group 'ls-lisp)
 208
 209 (defcustom ls-lisp-format-time-list
 210   '("%b %e %H:%M"
 211     "%b %e  %Y")
 212   "List of `format-time-string' specs to display file time stamps.
 213 These specs are used ONLY if a valid locale can not be determined.
 214
 215 If `ls-lisp-use-localized-time-format' is non-nil, these specs are used
 216 regardless of whether the locale can be determined.
 217
 218 Syntax:  (EARLY-TIME-FORMAT OLD-TIME-FORMAT)
 219
 220 The EARLY-TIME-FORMAT is used if file has been modified within the
 221 current year.  The OLD-TIME-FORMAT is used for older files.  To use ISO
 222 8601 dates, you could set:
 223
 224 \(setq ls-lisp-format-time-list
 225        '(\"%Y-%m-%d %H:%M\"
 226          \"%Y-%m-%d      \"))"
 227   :type '(list (string :tag "Early time format")
 228                (string :tag "Old time format"))
 229   :group 'ls-lisp)
 230
 231 (defcustom ls-lisp-use-localized-time-format nil
 232   "Non-nil means to always use `ls-lisp-format-time-list' for time stamps.
 233 This applies even if a valid locale is specified.
 234
 235 WARNING: Using localized date/time format might cause Dired columns
 236 to fail to line up, e.g. if month names are not all of the same length."
 237   :type 'boolean
 238   :group 'ls-lisp)
 239
 240 (defvar ls-lisp-uid-d-fmt " %d"
 241   "Format to display integer UIDs.")
 242 (defvar ls-lisp-uid-s-fmt " %s"
 243   "Format to display user names.")
 244 (defvar ls-lisp-gid-d-fmt " %d"
 245   "Format to display integer GIDs.")
 246 (defvar ls-lisp-gid-s-fmt " %s"
 247   "Format to display user group names.")
 248 (defvar ls-lisp-filesize-d-fmt "%d"
 249   "Format to display integer file sizes.")
 250 (defvar ls-lisp-filesize-f-fmt "%.0f"
 251   "Format to display float file sizes.")
 252 (defvar ls-lisp-filesize-b-fmt "%.0f"
 253   "Format to display file sizes in blocks (for the -s switch).")
 254 \f
 255 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 256
 257 (defun ls-lisp--insert-directory (orig-fun file switches &optional wildcard full-directory-p)
 258   "Insert directory listing for FILE, formatted according to SWITCHES.
 259 Leaves point after the inserted text.
 260 SWITCHES may be a string of options, or a list of strings.
 261 Optional third arg WILDCARD means treat FILE as shell wildcard.
 262 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
 263 switches do not contain `d', so that a full listing is expected.
 264
 265 This version of the function comes from `ls-lisp.el'.
 266 If the value of `ls-lisp-use-insert-directory-program' is non-nil then
 267 this advice just delegates the work to ORIG-FUN (the normal `insert-directory'
 268 function from `files.el').
 269 But if the value of `ls-lisp-use-insert-directory-program' is nil
 270 then it runs a Lisp emulation.
 271
 272 The Lisp emulation does not run any external programs or shells.  It
 273 supports ordinary shell wildcards if `ls-lisp-support-shell-wildcards'
 274 is non-nil; otherwise, it interprets wildcards as regular expressions
 275 to match file names.  It does not support all `ls' switches -- those
 276 that work are: A a B C c F G g h i n R r S s t U u v X.  The l switch
 277 is assumed to be always present and cannot be turned off."
 278   (if ls-lisp-use-insert-directory-program
 279       (funcall orig-fun
 280                file switches wildcard full-directory-p)
 281     ;; We need the directory in order to find the right handler.
 282     (let ((handler (find-file-name-handler (expand-file-name file)
 283                                            'insert-directory))
 284           (orig-file file)
 285           wildcard-regexp)
 286       (if handler
 287           (funcall handler 'insert-directory file switches
 288                    wildcard full-directory-p)
 289         ;; Remove --dired switch
 290         (if (string-match "--dired " switches)
 291             (setq switches (replace-match "" nil nil switches)))
 292         ;; Convert SWITCHES to a list of characters.
 293         (setq switches (delete ?\  (delete ?- (append switches nil))))
 294         ;; Sometimes we get ".../foo*/" as FILE.  While the shell and
 295         ;; `ls' don't mind, we certainly do, because it makes us think
 296         ;; there is no wildcard, only a directory name.
 297         (if (and ls-lisp-support-shell-wildcards
 298                  (string-match "[[?*]" file)
 299                  ;; Prefer an existing file to wildcards, like
 300                  ;; dired-noselect does.
 301                  (not (file-exists-p file)))
 302             (progn
 303               (or (not (eq (aref file (1- (length file))) ?/))
 304                   (setq file (substring file 0 (1- (length file)))))
 305               (setq wildcard t)))
 306         (if wildcard
 307             (setq wildcard-regexp
 308                   (if ls-lisp-support-shell-wildcards
 309                       (wildcard-to-regexp (file-name-nondirectory file))
 310                     (file-name-nondirectory file))
 311                   file (file-name-directory file))
 312           (if (memq ?B switches) (setq wildcard-regexp "[^~]\\'")))
 313         (condition-case err
 314             (ls-lisp-insert-directory
 315              file switches (ls-lisp-time-index switches)
 316              wildcard-regexp full-directory-p)
 317           (invalid-regexp
 318            ;; Maybe they wanted a literal file that just happens to
 319            ;; use characters special to shell wildcards.
 320            (if (equal (cadr err) "Unmatched [ or [^")
 321                (progn
 322                  (setq wildcard-regexp (if (memq ?B switches) "[^~]\\'")
 323                        file (file-relative-name orig-file))
 324                  (ls-lisp-insert-directory
 325                   file switches (ls-lisp-time-index switches)
 326                   nil full-directory-p))
 327              (signal (car err) (cdr err)))))
 328         ;; Try to insert the amount of free space.
 329         (save-excursion
 330           (goto-char (point-min))
 331           ;; First find the line to put it on.
 332           (when (re-search-forward "^total" nil t)
 333             (let ((available (get-free-disk-space ".")))
 334               (when available
 335                 ;; Replace "total" with "total used", to avoid confusion.
 336                 (replace-match "total used in directory")
 337                 (end-of-line)
 338                 (insert " available " available)))))))))
 339 (advice-add 'insert-directory :around #'ls-lisp--insert-directory)
 340
 341 (defun ls-lisp-insert-directory
 342   (file switches time-index wildcard-regexp full-directory-p)
 343   "Insert directory listing for FILE, formatted according to SWITCHES.
 344 Leaves point after the inserted text.  This is an internal function
 345 optionally called by the `ls-lisp.el' version of `insert-directory'.
 346 It is called recursively if the -R switch is used.
 347 SWITCHES is a *list* of characters.  TIME-INDEX is the time index into
 348 file-attributes according to SWITCHES.  WILDCARD-REGEXP is nil or an *Emacs
 349 regexp*.  FULL-DIRECTORY-P means file is a directory and SWITCHES does
 350 not contain `d', so that a full listing is expected."
 351   (if (or wildcard-regexp full-directory-p)
 352       (let* ((dir (file-name-as-directory file))
 353              (default-directory dir)    ; so that file-attributes works
 354              (file-alist
 355               (directory-files-and-attributes dir nil wildcard-regexp t
 356                                               (if (memq ?n switches)
 357                                                   'integer
 358                                                 'string)))
 359              (sum 0)
 360              (max-uid-len 0)
 361              (max-gid-len 0)
 362              (max-file-size 0)
 363              ;; do all bindings here for speed
 364              total-line files elt short file-size attr
 365              fuid fgid uid-len gid-len)
 366         (setq file-alist (ls-lisp-sanitize file-alist))
 367         (cond ((memq ?A switches)
 368                (setq file-alist
 369                      (ls-lisp-delete-matching "^\\.\\.?$" file-alist)))
 370               ((not (memq ?a switches))
 371                ;; if neither -A  nor -a, flush . files
 372                (setq file-alist
 373                      (ls-lisp-delete-matching "^\\." file-alist))))
 374         (setq file-alist
 375               (ls-lisp-handle-switches file-alist switches))
 376         (if (memq ?C switches)          ; column (-C) format
 377             (ls-lisp-column-format file-alist)
 378           (setq total-line (cons (point) (car-safe file-alist)))
 379           ;; Find the appropriate format for displaying uid, gid, and
 380           ;; file size, by finding the longest strings among all the
 381           ;; files we are about to display.
 382           (dolist (elt file-alist)
 383             (setq attr (cdr elt)
 384                   fuid (nth 2 attr)
 385                   uid-len (if (stringp fuid) (string-width fuid)
 386                             (length (format "%d" fuid)))
 387                   fgid (nth 3 attr)
 388                   gid-len (if (stringp fgid) (string-width fgid)
 389                             (length (format "%d" fgid)))
 390                   file-size (nth 7 attr))
 391             (if (> uid-len max-uid-len)
 392                 (setq max-uid-len uid-len))
 393             (if (> gid-len max-gid-len)
 394                 (setq max-gid-len gid-len))
 395             (if (> file-size max-file-size)
 396                 (setq max-file-size file-size)))
 397           (setq ls-lisp-uid-d-fmt (format " %%-%dd" max-uid-len))
 398           (setq ls-lisp-uid-s-fmt (format " %%-%ds" max-uid-len))
 399           (setq ls-lisp-gid-d-fmt (format " %%-%dd" max-gid-len))
 400           (setq ls-lisp-gid-s-fmt (format " %%-%ds" max-gid-len))
 401           (setq ls-lisp-filesize-d-fmt
 402                 (format " %%%dd" (length (format "%.0f" max-file-size))))
 403           (setq ls-lisp-filesize-f-fmt
 404                 (format " %%%d.0f" (length (format "%.0f" max-file-size))))
 405           (if (memq ?s switches)
 406               (setq ls-lisp-filesize-b-fmt
 407                     (format "%%%d.0f "
 408                             (length (format "%.0f"
 409                                             (fceiling
 410                                              (/ max-file-size 1024.0)))))))
 411           (setq files file-alist)
 412           (while files                  ; long (-l) format
 413             (setq elt (car files)
 414                   files (cdr files)
 415                   short (car elt)
 416                   attr (cdr elt)
 417                   file-size (nth 7 attr))
 418             (and attr
 419                  (setq sum (+ file-size
 420                               ;; Even if neither SUM nor file's size
 421                               ;; overflow, their sum could.
 422                               (if (or (< sum (- 134217727 file-size))
 423                                       (floatp sum)
 424                                       (floatp file-size))
 425                                   sum
 426                                 (float sum))))
 427                  (insert (ls-lisp-format short attr file-size
 428                                          switches time-index))))
 429           ;; Insert total size of all files:
 430           (save-excursion
 431             (goto-char (car total-line))
 432             (or (cdr total-line)
 433                 ;; Shell says ``No match'' if no files match
 434                 ;; the wildcard; let's say something similar.
 435                 (insert "(No match)\n"))
 436             (insert (format "total %.0f\n" (fceiling (/ sum 1024.0))))))
 437         ;; dired-insert-directory expects to find point after the
 438         ;; text.  But if the listing is empty, as e.g. in empty
 439         ;; directories with -a removed from switches, point will be
 440         ;; before the inserted text, and dired-insert-directory will
 441         ;; not indent the listing correctly.  Going to the end of the
 442         ;; buffer fixes that.
 443         (unless files (goto-char (point-max)))
 444         (if (memq ?R switches)
 445             ;; List the contents of all directories recursively.
 446             ;; cadr of each element of `file-alist' is t for
 447             ;; directory, string (name linked to) for symbolic
 448             ;; link, or nil.
 449             (while file-alist
 450               (setq elt (car file-alist)
 451                     file-alist (cdr file-alist))
 452               (when (and (eq (cadr elt) t) ; directory
 453                          ;; Under -F, we have already decorated all
 454                          ;; directories, including "." and "..", with
 455                          ;; a /, so allow for that as well.
 456                          (not (string-match "\\`\\.\\.?/?\\'" (car elt))))
 457                 (setq elt (expand-file-name (car elt) dir))
 458                 (insert "\n" elt ":\n")
 459                 (ls-lisp-insert-directory
 460                  elt switches time-index wildcard-regexp full-directory-p)))))
 461     ;; If not full-directory-p, FILE *must not* end in /, as
 462     ;; file-attributes will not recognize a symlink to a directory,
 463     ;; so must make it a relative filename as ls does:
 464     (if (file-name-absolute-p file) (setq file (expand-file-name file)))
 465     (if (eq (aref file (1- (length file))) ?/)
 466         (setq file (substring file 0 -1)))
 467     (let ((fattr (file-attributes file 'string)))
 468       (if fattr
 469           (insert (ls-lisp-format
 470                    (if (memq ?F switches)
 471                        (ls-lisp-classify-file file fattr)
 472                      file)
 473                    fattr (nth 7 fattr)
 474                                   switches time-index))
 475         (message "%s: doesn't exist or is inaccessible" file)
 476         (ding) (sit-for 2)))))          ; to show user the message!
 477
 478 (defun ls-lisp-sanitize (file-alist)
 479   "Sanitize the elements in FILE-ALIST.
 480 Fixes any elements in the alist for directory entries whose file
 481 attributes are nil (meaning that `file-attributes' failed for
 482 them).  This is known to happen for some network shares, in
 483 particular for the \"..\" directory entry.
 484
 485 If the \"..\" directory entry has nil attributes, the attributes
 486 are copied from the \".\" entry, if they are non-nil.  Otherwise,
 487 the offending element is removed from the list, as are any
 488 elements for other directory entries with nil attributes."
 489   (if (and (null (cdr (assoc ".." file-alist)))
 490            (cdr (assoc "." file-alist)))
 491       (setcdr (assoc ".." file-alist) (cdr (assoc "." file-alist))))
 492   (rassq-delete-all nil file-alist))
 493
 494 (defun ls-lisp-column-format (file-alist)
 495   "Insert the file names (only) in FILE-ALIST into the current buffer.
 496 Format in columns, sorted vertically, following GNU ls -C.
 497 Responds to the window width as ls should but may not!"
 498   (let (files fmt ncols collen (nfiles 0) (colwid 0))
 499     ;; Count number of files as `nfiles', build list of filenames as
 500     ;; `files', and find maximum filename length as `colwid':
 501     (let (file len)
 502       (while file-alist
 503         (setq nfiles (1+ nfiles)
 504               file (caar file-alist)
 505               files (cons file files)
 506               file-alist (cdr file-alist)
 507               len (length file))
 508         (if (> len colwid) (setq colwid len))))
 509     (setq files (nreverse files)
 510           colwid (+ 2 colwid)           ; 2 character column gap
 511           fmt (format "%%-%ds" colwid)  ; print format
 512           ncols (/ (window-width) colwid) ; no of columns
 513           collen (/ nfiles ncols))      ; floor of column length
 514     (if (> nfiles (* collen ncols)) (setq collen (1+ collen)))
 515     ;; Output the file names in columns, sorted vertically:
 516     (let ((i 0) j)
 517       (while (< i collen)
 518         (setq j i)
 519         (while (< j nfiles)
 520           (insert (format fmt (nth j files)))
 521           (setq j (+ j collen)))
 522         ;; FJW: This is completely unnecessary, but I don't like
 523         ;; trailing white space...
 524         (delete-region (point) (progn (skip-chars-backward " \t") (point)))
 525         (insert ?\n)
 526         (setq i (1+ i))))))
 527
 528 (defun ls-lisp-delete-matching (regexp list)
 529   "Delete all elements matching REGEXP from LIST, return new list."
 530   ;; Should perhaps use setcdr for efficiency.
 531   (let (result)
 532     (while list
 533       (or (string-match regexp (caar list))
 534           (setq result (cons (car list) result)))
 535       (setq list (cdr list)))
 536     result))
 537
 538 (defsubst ls-lisp-string-lessp (s1 s2)
 539   "Return t if string S1 should sort before string S2.
 540 Case is significant if `ls-lisp-ignore-case' is nil.
 541 Uses `string-collate-lessp' if `ls-lisp-use-string-collate' is non-nil,
 542 `compare-strings' otherwise.
 543 On GNU/Linux systems, if the locale specifies UTF-8 as the codeset,
 544 the sorting order will place together file names that differ only
 545 by punctuation characters, like `.emacs' and `emacs'.  To have a
 546 similar behavior on MS-Windows, customize `ls-lisp-UCA-like-collation'
 547 to a non-nil value."
 548   (let ((w32-collate-ignore-punctuation ls-lisp-UCA-like-collation))
 549     (if ls-lisp-use-string-collate
 550         (string-collate-lessp s1 s2 nil ls-lisp-ignore-case)
 551       (let ((u (compare-strings s1 0 nil s2 0 nil ls-lisp-ignore-case)))
 552         (and (numberp u) (< u 0))))))
 553
 554 (defun ls-lisp-version-lessp (s1 s2)
 555   "Return t if versioned string S1 should sort before versioned string S2.
 556
 557 Case is significant if `ls-lisp-ignore-case' is nil.
 558 This is the same as string-lessp (with the exception of case
 559 insensitivity), but sequences of digits are compared numerically,
 560 as a whole, in the same manner as the `strverscmp' function available
 561 in some standard C libraries does."
 562   (let ((i1 0)
 563         (i2 0)
 564         (len1 (length s1))
 565         (len2 (length s2))
 566         (val 0)
 567         ni1 ni2 e1 e2 found-2-numbers-p)
 568     (while (and (< i1 len1) (< i2 len2) (zerop val))
 569       (unless found-2-numbers-p
 570         (setq ni1 (string-match "[0-9]+" s1 i1)
 571               e1 (match-end 0))
 572         (setq ni2 (string-match "[0-9]+" s2 i2)
 573               e2 (match-end 0)))
 574       (cond
 575        ((and ni1 ni2)
 576         (cond
 577          ((and (> ni1 i1) (> ni2 i2))
 578           ;; Compare non-numerical part as strings.
 579           (setq val (compare-strings s1 i1 ni1 s2 i2 ni2 ls-lisp-ignore-case)
 580                 i1 ni1
 581                 i2 ni2
 582                 found-2-numbers-p t))
 583          ((and (= ni1 i1) (= ni2 i2))
 584           (setq found-2-numbers-p nil)
 585           ;; Compare numerical parts as integral and/or fractional parts.
 586           (let* ((sub1 (substring s1 ni1 e1))
 587                  (sub2 (substring s2 ni2 e2))
 588                  ;; "Fraction" is a numerical sequence with leading zeros.
 589                  (fr1 (string-match "\\`0+" sub1))
 590                  (fr2 (string-match "\\`0+" sub2)))
 591             (cond
 592              ((and fr1 fr2)     ; two fractions, the shortest wins
 593               (setq val (- val (- (length sub1) (length sub2)))))
 594              (fr1               ; a fraction is always less than an integral
 595               (setq val (- ni1)))
 596              (fr2
 597               (setq val ni2)))
 598             (if (zerop val)     ; fall back on numerical comparison
 599                 (setq val (- (string-to-number sub1)
 600                              (string-to-number sub2))))
 601             (setq i1 e1
 602                   i2 e2)))
 603          (t
 604           (setq val (compare-strings s1 i1 nil s2 i2 nil ls-lisp-ignore-case)
 605                 i1 len1
 606                 i2 len2))))
 607        (t (setq val (compare-strings s1 i1 nil s2 i2 nil ls-lisp-ignore-case)
 608                 i1 len1
 609                 i2 len2)))
 610       (and (eq val t) (setq val 0)))
 611     (if (zerop val)
 612         (setq val (- len1 len2)))
 613     (< val 0)))
 614
 615 (defun ls-lisp-handle-switches (file-alist switches)
 616   "Return new FILE-ALIST sorted according to SWITCHES.
 617 SWITCHES is a list of characters.  Default sorting is alphabetic."
 618   ;; FILE-ALIST's elements are (FILE . FILE-ATTRIBUTES).
 619   (or (memq ?U switches)                ; unsorted
 620       ;; Catch and ignore unexpected sorting errors
 621       (condition-case err
 622           (setq file-alist
 623                 (let (index)
 624                   ;; Copy file-alist in case of error
 625                   (sort (copy-sequence file-alist) ; modifies its argument!
 626                         (cond ((memq ?S switches)
 627                                (lambda (x y) ; sorted on size
 628                                  ;; 7th file attribute is file size
 629                                  ;; Make largest file come first
 630                                  (< (nth 7 (cdr y))
 631                                     (nth 7 (cdr x)))))
 632                               ((setq index (ls-lisp-time-index switches))
 633                                (lambda (x y) ; sorted on time
 634                                  (time-less-p (nth index (cdr y))
 635                                               (nth index (cdr x)))))
 636                               ((memq ?X switches)
 637                                (lambda (x y) ; sorted on extension
 638                                  (ls-lisp-string-lessp
 639                                   (ls-lisp-extension (car x))
 640                                   (ls-lisp-extension (car y)))))
 641                               ((memq ?v switches)
 642                                (lambda (x y) ; sorted by version number
 643                                  (ls-lisp-version-lessp (car x) (car y))))
 644                               (t
 645                                (lambda (x y) ; sorted alphabetically
 646                                  (ls-lisp-string-lessp (car x) (car y))))))))
 647         (error (message "Unsorted (ls-lisp sorting error) - %s"
 648                         (error-message-string err))
 649                (ding) (sit-for 2))))    ; to show user the message!
 650   (if (memq ?F switches)                ; classify switch
 651       (setq file-alist (mapcar 'ls-lisp-classify file-alist)))
 652   (if ls-lisp-dirs-first
 653   ;; Re-sort directories first, without otherwise changing the
 654   ;; ordering, and reverse whole list.  cadr of each element of
 655   ;; `file-alist' is t for directory, string (name linked to) for
 656   ;; symbolic link, or nil.
 657       (let (el dirs files)
 658         (while file-alist
 659           (if (or (eq (cadr (setq el (car file-alist))) t) ; directory
 660                   (and (stringp (cadr el))
 661                        (file-directory-p (cadr el)))) ; symlink to a directory
 662               (setq dirs (cons el dirs))
 663             (setq files (cons el files)))
 664           (setq file-alist (cdr file-alist)))
 665         (setq file-alist
 666               (if (memq ?U switches)    ; unsorted order is reversed
 667                   (nconc dirs files)
 668                 (nconc files dirs)
 669                 ))))
 670   ;; Finally reverse file alist if necessary.
 671   ;; (eq below MUST compare `(not (memq ...))' to force comparison of
 672   ;; t or nil, rather than list tails!)
 673   (if (eq (eq (not (memq ?U switches))  ; unsorted order is reversed
 674               (not (memq ?r switches))) ; reversed sort order requested
 675           ls-lisp-dirs-first)           ; already reversed
 676       (nreverse file-alist)
 677     file-alist))
 678
 679 (defun ls-lisp-classify-file (filename fattr)
 680   "Append a character to FILENAME indicating the file type.
 681
 682 FATTR is the file attributes returned by `file-attributes' for the file.
 683 The file type indicators are `/' for directories, `@' for symbolic
 684 links, `|' for FIFOs, `=' for sockets, `*' for regular files that
 685 are executable, and nothing for other types of files."
 686   (let* ((type (car fattr))
 687          (modestr (nth 8 fattr))
 688          (typestr (substring modestr 0 1)))
 689     (cond
 690      (type
 691       (concat filename (if (eq type t) "/" "@")))
 692      ((string-match "x" modestr)
 693       (concat filename "*"))
 694      ((string= "p" typestr)
 695       (concat filename "|"))
 696      ((string= "s" typestr)
 697       (concat filename "="))
 698      (t filename))))
 699
 700 (defun ls-lisp-classify (filedata)
 701   "Append a character to file name in FILEDATA indicating the file type.
 702
 703 FILEDATA has the form (FILENAME . ATTRIBUTES), where ATTRIBUTES is the
 704 structure returned by `file-attributes' for that file.
 705
 706 The file type indicators are `/' for directories, `@' for symbolic
 707 links, `|' for FIFOs, `=' for sockets, `*' for regular files that
 708 are executable, and nothing for other types of files."
 709   (let ((file-name (car filedata))
 710         (fattr (cdr filedata)))
 711     (setq file-name (propertize file-name 'dired-filename t))
 712     (cons (ls-lisp-classify-file file-name fattr) fattr)))
 713
 714 (defun ls-lisp-extension (filename)
 715   "Return extension of FILENAME (ignoring any version extension)
 716 FOLLOWED by null and full filename, SOLELY for full alpha sort."
 717   ;; Force extension sort order: `no ext' then `null ext' then `ext'
 718   ;; to agree with GNU ls.
 719   (concat
 720    (let* ((i (length filename)) end)
 721      (if (= (aref filename (1- i)) ?.) ; null extension
 722          "\0"
 723        (while (and (>= (setq i (1- i)) 0)
 724                    (/= (aref filename i) ?.)))
 725        (if (< i 0) "\0\0"               ; no extension
 726          (if (/= (aref filename (1+ i)) ?~)
 727              (substring filename (1+ i))
 728            ;; version extension found -- ignore it
 729            (setq end i)
 730            (while (and (>= (setq i (1- i)) 0)
 731                        (/= (aref filename i) ?.)))
 732            (if (< i 0) "\0\0"   ; no extension
 733              (substring filename (1+ i) end))))
 734        )) "\0" filename))
 735
 736 (defun ls-lisp-format (file-name file-attr file-size switches time-index)
 737   "Format one line of long ls output for file FILE-NAME.
 738 FILE-ATTR and FILE-SIZE give the file's attributes and size.
 739 SWITCHES and TIME-INDEX give the full switch list and time data."
 740   (let ((file-type (nth 0 file-attr))
 741         ;; t for directory, string (name linked to)
 742         ;; for symbolic link, or nil.
 743         (drwxrwxrwx (nth 8 file-attr))) ; attribute string ("drwxrwxrwx")
 744     (concat (if (memq ?i switches)      ; inode number
 745                 (let ((inode (nth 10 file-attr)))
 746                   (if (consp inode)
 747                       (if (consp (cdr inode))
 748                           ;; 2^(24+16) = 1099511627776.0, but
 749                           ;; multiplying by it and then adding the
 750                           ;; other members of the cons cell in one go
 751                           ;; loses precision, since a double does not
 752                           ;; have enough significant digits to hold a
 753                           ;; full 64-bit value.  So below we split
 754                           ;; 1099511627776 into high 13 and low 5
 755                           ;; digits and compute in two parts.
 756                           (let ((p1 (* (car inode) 10995116.0))
 757                                 (p2 (+ (* (car inode) 27776.0)
 758                                        (* (cadr inode) 65536.0)
 759                                        (cddr inode))))
 760                             (format " %13.0f%05.0f "
 761                                     ;; Use floor to emulate integer
 762                                     ;; division.
 763                                     (+ p1 (floor p2 100000.0))
 764                                     (mod p2 100000.0)))
 765                         (format " %18.0f "
 766                                 (+ (* (car inode) 65536.0)
 767                                    (cdr inode))))
 768                     (format " %18d " inode))))
 769             ;; nil is treated like "" in concat
 770             (if (memq ?s switches)      ; size in K, rounded up
 771                 ;; In GNU ls, -h affects the size in blocks, displayed
 772                 ;; by -s, as well.
 773                 (if (memq ?h switches)
 774                     (format "%6s "
 775                             (file-size-human-readable
 776                              ;; We use 1K as "block size", although
 777                              ;; most Windows volumes use 4KB to 8KB
 778                              ;; clusters, and exFAT will usually have
 779                              ;; clusters of 32KB or even 128KB.  See
 780                              ;; KB article 140365 for the details.
 781                              (* 1024.0 (fceiling (/ file-size 1024.0)))))
 782                   (format ls-lisp-filesize-b-fmt
 783                           (fceiling (/ file-size 1024.0)))))
 784             drwxrwxrwx                  ; attribute string
 785             (if (memq 'links ls-lisp-verbosity)
 786                 (format "%3d" (nth 1 file-attr))) ; link count
 787             ;; Numeric uid/gid are more confusing than helpful;
 788             ;; Emacs should be able to make strings of them.
 789             ;; They tend to be bogus on non-UNIX platforms anyway so
 790             ;; optionally hide them.
 791             (if (memq 'uid ls-lisp-verbosity)
 792                 ;; uid can be a string or an integer
 793                 (let ((uid (nth 2 file-attr)))
 794                   (format (if (stringp uid)
 795                               ls-lisp-uid-s-fmt
 796                             ls-lisp-uid-d-fmt)
 797                           uid)))
 798             (if (not (memq ?G switches)) ; GNU ls -- shows group by default
 799                 (if (or (memq ?g switches) ; UNIX ls -- no group by default
 800                         (memq 'gid ls-lisp-verbosity))
 801                     (let ((gid (nth 3 file-attr)))
 802                       (format (if (stringp gid)
 803                                   ls-lisp-gid-s-fmt
 804                                 ls-lisp-gid-d-fmt)
 805                               gid))))
 806             (ls-lisp-format-file-size file-size (memq ?h switches))
 807             " "
 808             (ls-lisp-format-time file-attr time-index)
 809             " "
 810             (if (not (memq ?F switches)) ; ls-lisp-classify already did that
 811                 (propertize file-name 'dired-filename t)
 812               file-name)
 813             (if (stringp file-type)     ; is a symbolic link
 814                 (concat " -> " file-type))
 815             "\n"
 816             )))
 817
 818 (defun ls-lisp-time-index (switches)
 819   "Return time index into file-attributes according to ls SWITCHES list.
 820 Return nil if no time switch found."
 821   ;; FJW: Default of nil is IMPORTANT and used in `ls-lisp-handle-switches'!
 822   (cond ((memq ?c switches) 6)          ; last mode change
 823         ((memq ?t switches) 5)          ; last modtime
 824         ((memq ?u switches) 4)))        ; last access
 825
 826 (defun ls-lisp-format-time (file-attr time-index)
 827   "Format time for file with attributes FILE-ATTR according to TIME-INDEX.
 828 Use the same method as ls to decide whether to show time-of-day or year,
 829 depending on distance between file date and the current time.
 830 All ls time options, namely c, t and u, are handled."
 831   (let* ((time (nth (or time-index 5) file-attr)) ; default is last modtime
 832          (diff (- (float-time time) (float-time)))
 833          ;; Consider a time to be recent if it is within the past six
 834          ;; months.  A Gregorian year has 365.2425 * 24 * 60 * 60 ==
 835          ;; 31556952 seconds on the average, and half of that is 15778476.
 836          ;; Write the constant explicitly to avoid roundoff error.
 837          (past-cutoff -15778476)) ; half a Gregorian year
 838     (condition-case nil
 839         ;; Use traditional time format in the C or POSIX locale,
 840         ;; ISO-style time format otherwise, so columns line up.
 841         (let ((locale system-time-locale))
 842           (if (not locale)
 843               (let ((vars '("LC_ALL" "LC_TIME" "LANG")))
 844                 (while (and vars (not (setq locale (getenv (car vars)))))
 845                   (setq vars (cdr vars)))))
 846           (if (member locale '("C" "POSIX"))
 847               (setq locale nil))
 848           (format-time-string
 849            (if (and (<= past-cutoff diff) (<= diff 0))
 850                (if (and locale (not ls-lisp-use-localized-time-format))
 851                    "%m-%d %H:%M"
 852                  (nth 0 ls-lisp-format-time-list))
 853              (if (and locale (not ls-lisp-use-localized-time-format))
 854                  "%Y-%m-%d "
 855                (nth 1 ls-lisp-format-time-list)))
 856            time))
 857       (error "Unk  0  0000"))))
 858
 859 (defun ls-lisp-format-file-size (file-size human-readable)
 860   (if (not human-readable)
 861       (format (if (floatp file-size)
 862                   ls-lisp-filesize-f-fmt
 863                 ls-lisp-filesize-d-fmt)
 864               file-size)
 865     (format " %6s" (file-size-human-readable file-size))))
 866
 867 (provide 'ls-lisp)
 868
 869 ;;; ls-lisp.el ends here