]> code.delx.au - gnu-emacs/blobdiff - lisp/ls-lisp.el
Merge from gnus--devo--0
[gnu-emacs] / lisp / ls-lisp.el
index 5f5a53b0df0d9517fe7490bb7d262a0708b64abf..08d07eb03a790bf64451aca6a3b84e89e2b6decd 100644 (file)
@@ -1,7 +1,7 @@
 ;;; ls-lisp.el --- emulate insert-directory completely in Emacs Lisp
 
-;; Copyright (C) 1992, 1994, 2000, 2002, 2003, 2004,
-;;   2005 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1994, 2000, 2001, 2002, 2003, 2004,
+;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
 
 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
 ;; Modified by: Francis J. Wright <F.J.Wright@maths.qmw.ac.uk>
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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 2, or (at your option)
-;; any later version.
+;; 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
@@ -21,9 +21,7 @@
 ;; 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 the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
@@ -45,8 +43,6 @@
 ;; * A few obscure ls switches are still ignored: see the docstring of
 ;; `insert-directory'.
 
-;; * Generally only numeric uid/gid.
-
 ;; TO DO =============================================================
 
 ;; Complete handling of F switch (if/when possible).
@@ -61,8 +57,8 @@
 ;; Revised by Andrew Innes and Geoff Volker (and maybe others).
 
 ;; Modified by Francis J. Wright <F.J.Wright@maths.qmw.ac.uk>, mainly
-;; to support many more ls options, "platform emulation", hooks for
-;; external symbolic link support and more robust sorting.
+;; to support many more ls options, "platform emulation" and more
+;; robust sorting.
 
 ;;; Code:
 
@@ -77,7 +73,7 @@
   (cond ((eq system-type 'macos) 'MacOS)
        ;; ((eq system-type 'windows-nt) 'MS-Windows)
        ((memq system-type
-              '(hpux dgux usg-unix-v unisoft-unix rtu irix berkeley-unix))
+              '(hpux usg-unix-v unisoft-unix irix berkeley-unix))
         'UNIX))                        ; very similar to GNU
   ;; Anything else defaults to nil, meaning GNU.
   "*Platform to emulate: GNU (default), MacOS, MS-Windows, UNIX.
@@ -115,7 +111,7 @@ option will have no effect until you restart Emacs."
        (t '(links uid gid)))           ; GNU ls
   "*A list of optional file attributes that ls-lisp should display.
 It should contain none or more of the symbols: links, uid, gid.
-nil (or an empty list) means display none of them.
+A value of nil (or an empty list) means display none of them.
 
 Concepts come from UNIX: `links' means count of names associated with
 the file\; `uid' means user (owner) identifier\; `gid' means group
@@ -153,7 +149,10 @@ Otherwise they are treated as Emacs regexps (for backward compatibility)."
   '("%b %e %H:%M"
     "%b %e  %Y")
   "*List of `format-time-string' specs to display file time stamps.
-They are used whenever a locale is not specified to use instead.
+These specs are used ONLY if a valid locale can not be determined.
+
+If `ls-lisp-use-localized-time-format' is non-nil, these specs are used
+regardless of whether the locale can be determined.
 
 Syntax:  (EARLY-TIME-FORMAT OLD-TIME-FORMAT)
 
@@ -168,21 +167,35 @@ current year. The OLD-TIME-FORMAT is used for older files.  To use ISO
               (string :tag "Old time format"))
   :group 'ls-lisp)
 
+(defcustom ls-lisp-use-localized-time-format nil
+  "*Non-nil causes ls-lisp to use `ls-lisp-format-time-list' even if
+a valid locale is specified.
+
+WARNING: Using localized date/time format might cause Dired columns
+to fail to lign up, e.g. if month names are not all of the same length."
+  :type 'boolean
+  :group 'ls-lisp)
+
 (defvar original-insert-directory nil
   "This holds the original function definition of `insert-directory'.")
 
+(defvar ls-lisp-uid-d-fmt "-%d"
+  "Format to display integer UIDs.")
+(defvar ls-lisp-uid-s-fmt "-%s"
+  "Format to display user names.")
+(defvar ls-lisp-gid-d-fmt "-%d"
+  "Format to display integer GIDs.")
+(defvar ls-lisp-gid-s-fmt "-%s"
+  "Format to display user group names.")
+(defvar ls-lisp-filesize-d-fmt "%d"
+  "Format to display integer file sizes.")
+(defvar ls-lisp-filesize-f-fmt "%.0f"
+  "Format to display float file sizes.")
+
 ;; Remember the original insert-directory function
 (or (featurep 'ls-lisp)  ; FJW: unless this file is being reloaded!
     (setq original-insert-directory (symbol-function 'insert-directory)))
 
-;; This stub is to allow ls-lisp to parse symbolic links via another
-;; library such as w32-symlinks.el from
-;; http://centaur.maths.qmw.ac.uk/Emacs/:
-(defun ls-lisp-parse-symlink (file-name)
-  "This stub may be redefined to parse FILE-NAME as a symlink.
-It should return nil or the link target as a string."
-  nil)
-
 \f
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
@@ -207,13 +220,14 @@ The Lisp emulation does not run any external programs or shells.  It
 supports ordinary shell wildcards if `ls-lisp-support-shell-wildcards'
 is non-nil; otherwise, it interprets wildcards as regular expressions
 to match file names.  It does not support all `ls' switches -- those
-that work are: A a c i r S s t u U X g G B C R and F partly."
+that work are: A a c i r S s t u U X g G B C R and F partly."
   (if ls-lisp-use-insert-directory-program
       (funcall original-insert-directory
               file switches wildcard full-directory-p)
     ;; We need the directory in order to find the right handler.
     (let ((handler (find-file-name-handler (expand-file-name file)
                                           'insert-directory))
+         (orig-file file)
          wildcard-regexp)
       (if handler
          (funcall handler 'insert-directory file switches
@@ -227,7 +241,10 @@ that work are: A a c i r S s t u U X g G B C R and F partly."
        ;; `ls' don't mind, we certainly do, because it makes us think
        ;; there is no wildcard, only a directory name.
        (if (and ls-lisp-support-shell-wildcards
-                (string-match "[[?*]" file))
+                (string-match "[[?*]" file)
+                ;; Prefer an existing file to wildcards, like
+                ;; dired-noselect does.
+                (not (file-exists-p file)))
            (progn
              (or (not (eq (aref file (1- (length file))) ?/))
                  (setq file (substring file 0 (1- (length file)))))
@@ -239,9 +256,21 @@ that work are: A a c i r S s t u U X g G B C R and F partly."
                    (file-name-nondirectory file))
                  file (file-name-directory file))
          (if (memq ?B switches) (setq wildcard-regexp "[^~]\\'")))
-       (ls-lisp-insert-directory
-        file switches (ls-lisp-time-index switches)
-        wildcard-regexp full-directory-p)
+       (condition-case err
+           (ls-lisp-insert-directory
+            file switches (ls-lisp-time-index switches)
+            wildcard-regexp full-directory-p)
+         (invalid-regexp
+          ;; Maybe they wanted a literal file that just happens to
+          ;; use characters special to shell wildcards.
+          (if (equal (cadr err) "Unmatched [ or [^")
+              (progn
+                (setq wildcard-regexp (if (memq ?B switches) "[^~]\\'")
+                      file (file-relative-name orig-file))
+                (ls-lisp-insert-directory
+                 file switches (ls-lisp-time-index switches)
+                 nil full-directory-p))
+            (signal (car err) (cdr err)))))
        ;; Try to insert the amount of free space.
        (save-excursion
          (goto-char (point-min))
@@ -268,11 +297,18 @@ not contain `d', so that a full listing is expected."
       (let* ((dir (file-name-as-directory file))
             (default-directory dir)    ; so that file-attributes works
             (file-alist
-             (directory-files-and-attributes dir nil wildcard-regexp t 'string))
+             (directory-files-and-attributes dir nil wildcard-regexp t
+                                             (if (memq ?n switches)
+                                                 'integer
+                                               'string)))
             (now (current-time))
             (sum 0)
+            (max-uid-len 0)
+            (max-gid-len 0)
+            (max-file-size 0)
             ;; do all bindings here for speed
-            total-line files elt short file-size fil attr)
+            total-line files elt short file-size fil attr
+            fuid fgid uid-len gid-len)
        (cond ((memq ?A switches)
               (setq file-alist
                     (ls-lisp-delete-matching "^\\.\\.?$" file-alist)))
@@ -285,6 +321,40 @@ not contain `d', so that a full listing is expected."
        (if (memq ?C switches)          ; column (-C) format
            (ls-lisp-column-format file-alist)
          (setq total-line (cons (point) (car-safe file-alist)))
+         ;; Find the appropriate format for displaying uid, gid, and
+         ;; file size, by finding the longest strings among all the
+         ;; files we are about to display.
+         (dolist (elt file-alist)
+           (setq attr (cdr elt)
+                 fuid (nth 2 attr)
+                 uid-len (if (stringp fuid) (string-width fuid)
+                           (length (format "%d" fuid)))
+                 fgid (nth 3 attr)
+                 gid-len (if (stringp fgid) (string-width fgid)
+                           (length (format "%d" fgid)))
+                 file-size (nth 7 attr))
+           (if (> uid-len max-uid-len)
+               (setq max-uid-len uid-len))
+           (if (> gid-len max-gid-len)
+               (setq max-gid-len gid-len))
+           (if (> file-size max-file-size)
+               (setq max-file-size file-size)))
+         (setq ls-lisp-uid-d-fmt (format " %%-%dd" max-uid-len))
+         (setq ls-lisp-uid-s-fmt (format " %%-%ds" max-uid-len))
+         (setq ls-lisp-gid-d-fmt (format " %%-%dd" max-gid-len))
+         (setq ls-lisp-gid-s-fmt (format " %%-%ds" max-gid-len))
+         (setq ls-lisp-filesize-d-fmt
+               (format " %%%dd"
+                       (if (memq ?s switches)
+                           (length (format "%.0f"
+                                           (fceiling (/ max-file-size 1024.0))))
+                         (length (format "%.0f" max-file-size)))))
+         (setq ls-lisp-filesize-f-fmt
+               (format " %%%d.0f"
+                       (if (memq ?s switches)
+                           (length (format "%.0f"
+                                           (fceiling (/ max-file-size 1024.0))))
+                         (length (format "%.0f" max-file-size)))))
          (setq files file-alist)
          (while files                  ; long (-l) format
            (setq elt (car files)
@@ -429,7 +499,9 @@ SWITCHES is a list of characters.  Default sorting is alphabetic."
   ;; symbolic link, or nil.
       (let (el dirs files)
        (while file-alist
-         (if (eq (cadr (setq el (car file-alist))) t) ; directory
+         (if (or (eq (cadr (setq el (car file-alist))) t) ; directory
+                  (and (stringp (cadr el))
+                       (file-directory-p (cadr el)))) ; symlink to a directory
              (setq dirs (cons el dirs))
            (setq files (cons el files)))
          (setq file-alist (cdr file-alist)))
@@ -455,12 +527,11 @@ links, `|' for FIFOs, `=' for sockets, and nothing for regular files.
 \[But FIFOs and sockets are not recognized.]
 FILEDATA has the form (filename . `file-attributes').  Its `cadr' is t
 for directory, string (name linked to) for symbolic link, or nil."
-  (let ((dir (cadr filedata)) (file-name (car filedata)))
-    (cond ((or dir
-              ;; Parsing .lnk files here is perhaps overkill!
-              (setq dir (ls-lisp-parse-symlink file-name)))
+  (let ((file-name (car filedata))
+        (type (cadr filedata)))
+    (cond (type
           (cons
-           (concat file-name (if (eq dir t) "/" "@"))
+           (concat file-name (if (eq type t) "/" "@"))
            (cdr filedata)))
          ((string-match "x" (nth 9 filedata))
           (cons
@@ -506,18 +577,38 @@ SWITCHES, TIME-INDEX and NOW give the full switch list and time data."
        ;; t for directory, string (name linked to)
        ;; for symbolic link, or nil.
        (drwxrwxrwx (nth 8 file-attr))) ; attribute string ("drwxrwxrwx")
-    (and (null file-type)
-        ;; Maybe no kernel support for symlinks, so...
-        (setq file-type (ls-lisp-parse-symlink file-name))
-        (aset drwxrwxrwx 0 ?l)) ; symbolic link - update attribute string
     (concat (if (memq ?i switches)     ; inode number
-               (format " %6d" (nth 10 file-attr)))
+               (let ((inode (nth 10 file-attr)))
+                 (if (consp inode)
+                     (if (consp (cdr inode))
+                         ;; 2^(24+16) = 1099511627776.0, but
+                         ;; multiplying by it and then adding the
+                         ;; other members of the cons cell in one go
+                         ;; loses precision, since a double does not
+                         ;; have enough significant digits to hold a
+                         ;; full 64-bit value.  So below we split
+                         ;; 1099511627776 into high 13 and low 5
+                         ;; digits and compute in two parts.
+                         (let ((p1 (* (car inode) 10995116.0))
+                               (p2 (+ (* (car inode) 27776.0)
+                                      (* (cadr inode) 65536.0)
+                                      (cddr inode))))
+                           (format " %13.0f%05.0f "
+                                   ;; Use floor to emulate integer
+                                   ;; division.
+                                   (+ p1 (floor p2 100000.0))
+                                   (mod p2 100000.0)))
+                       (format " %18.0f "
+                               (+ (* (car inode) 65536.0)
+                                  (cdr inode))))
+                   (format " %18d " inode))))
            ;; nil is treated like "" in concat
            (if (memq ?s switches)      ; size in K
-               (format " %4.0f" (fceiling (/ file-size 1024.0))))
+               (format ls-lisp-filesize-f-fmt
+                       (fceiling (/ file-size 1024.0))))
            drwxrwxrwx                  ; attribute string
            (if (memq 'links ls-lisp-verbosity)
-               (format " %3d" (nth 1 file-attr))) ; link count
+               (format "%3d" (nth 1 file-attr))) ; link count
            ;; Numeric uid/gid are more confusing than helpful;
            ;; Emacs should be able to make strings of them.
            ;; They tend to be bogus on non-UNIX platforms anyway so
@@ -525,12 +616,18 @@ SWITCHES, TIME-INDEX and NOW give the full switch list and time data."
            (if (memq 'uid ls-lisp-verbosity)
                ;; uid can be a sting or an integer
                (let ((uid (nth 2 file-attr)))
-                  (format (if (stringp uid) " %-8s" " %-8d") uid)))
+                  (format (if (stringp uid)
+                             ls-lisp-uid-s-fmt
+                           ls-lisp-uid-d-fmt)
+                         uid)))
            (if (not (memq ?G switches)) ; GNU ls -- shows group by default
                (if (or (memq ?g switches) ; UNIX ls -- no group by default
                        (memq 'gid ls-lisp-verbosity))
                     (let ((gid (nth 3 file-attr)))
-                      (format (if (stringp gid) " %-8s" " %-8d") gid))))
+                      (format (if (stringp gid)
+                                 ls-lisp-gid-s-fmt
+                               ls-lisp-gid-d-fmt)
+                             gid))))
            (ls-lisp-format-file-size file-size (memq ?h switches))
            " "
            (ls-lisp-format-time file-attr time-index now)
@@ -580,21 +677,30 @@ All ls time options, namely c, t and u, are handled."
              (setq locale nil))
          (format-time-string
           (if (and (<= past-cutoff diff) (<= diff 0))
-              (if locale "%m-%d %H:%M" (nth 0 ls-lisp-format-time-list))
-            (if locale "%Y-%m-%d " (nth 1 ls-lisp-format-time-list)))
+              (if (and locale (not ls-lisp-use-localized-time-format))
+                  "%m-%d %H:%M"
+                (nth 0 ls-lisp-format-time-list))
+            (if (and locale (not ls-lisp-use-localized-time-format))
+                "%Y-%m-%d "
+              (nth 1 ls-lisp-format-time-list)))
           time))
       (error "Unk  0  0000"))))
 
 (defun ls-lisp-format-file-size (file-size human-readable)
-  (if (or (not human-readable)
-          (< file-size 1024))
-      (format (if (floatp file-size) " %9.0f" " %9d") file-size)
-    (do ((file-size (/ file-size 1024.0) (/ file-size 1024.0))
-         ;; kilo, mega, giga, tera, peta, exa
-         (post-fixes (list "k" "M" "G" "T" "P" "E") (cdr post-fixes)))
-        ((< file-size 1024) (format " %8.0f%s"  file-size (car post-fixes))))))
+  (if (not human-readable)
+      (format (if (floatp file-size)
+                 ls-lisp-filesize-f-fmt
+               ls-lisp-filesize-d-fmt)
+             file-size)
+    (if (< file-size 1024)
+       (format " %4d" file-size)
+      (do ((file-size (/ file-size 1024.0) (/ file-size 1024.0))
+          ;; kilo, mega, giga, tera, peta, exa
+          (post-fixes (list "k" "M" "G" "T" "P" "E") (cdr post-fixes)))
+         ((< file-size 1024)
+          (format " %3.0f%s"  file-size (car post-fixes)))))))
 
 (provide 'ls-lisp)
 
-;;; arch-tag: e55f399b-05ec-425c-a6d5-f5e349c35ab4
+;; arch-tag: e55f399b-05ec-425c-a6d5-f5e349c35ab4
 ;;; ls-lisp.el ends here