X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/5df4f04cd32af723742c81095b38ae83b3c2b462..16e80fc942632c5f8989c98185e1a8fe38552981:/lisp/ls-lisp.el diff --git a/lisp/ls-lisp.el b/lisp/ls-lisp.el index ed7b5640e2..2ff0a3a230 100644 --- a/lisp/ls-lisp.el +++ b/lisp/ls-lisp.el @@ -1,12 +1,12 @@ ;;; ls-lisp.el --- emulate insert-directory completely in Emacs Lisp -;; Copyright (C) 1992, 1994, 2000, 2001, 2002, 2003, 2004, -;; 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. +;; Copyright (C) 1992, 1994, 2000-2014 Free Software Foundation, Inc. ;; Author: Sebastian Kremer ;; Modified by: Francis J. Wright -;; Maintainer: FSF +;; Maintainer: emacs-devel@gnu.org ;; Keywords: unix, dired +;; Package: emacs ;; This file is part of GNU Emacs. @@ -27,11 +27,9 @@ ;; OVERVIEW ========================================================== -;; This file redefines the function `insert-directory' to implement it -;; directly from Emacs lisp, without running ls in a subprocess. It -;; is useful if you cannot afford to fork Emacs on a real memory UNIX, -;; or other non-UNIX platforms if you don't have the ls -;; program, or if you want a different format from what ls offers. +;; This file advises the function `insert-directory' to implement it +;; directly from Emacs lisp, without running ls in a subprocess. +;; This is useful if you don't have ls installed (ie, on MS Windows). ;; This function can use regexps instead of shell wildcards. If you ;; enter regexps remember to double each $ sign. For example, to @@ -62,28 +60,42 @@ ;;; Code: -(eval-when-compile (require 'cl)) - (defgroup ls-lisp nil "Emulate the ls program completely in Emacs Lisp." :version "21.1" :group 'dired) +(defun ls-lisp-set-options () + "Reset the ls-lisp options that depend on `ls-lisp-emulation'." + (mapc 'custom-reevaluate-setting + '(ls-lisp-ignore-case ls-lisp-dirs-first ls-lisp-verbosity))) + (defcustom ls-lisp-emulation (cond ;; ((eq system-type 'windows-nt) 'MS-Windows) - ((memq system-type - '(hpux usg-unix-v irix berkeley-unix)) - 'UNIX)) ; very similar to GNU + ((memq system-type '(hpux usg-unix-v irix berkeley-unix)) + 'UNIX)) ; very similar to GNU ;; Anything else defaults to nil, meaning GNU. "Platform to emulate: GNU (default), MacOS, MS-Windows, UNIX. -Corresponding value is one of the atoms: nil, MacOS, MS-Windows, UNIX. -Sets default values for: `ls-lisp-ignore-case', `ls-lisp-dirs-first', -`ls-lisp-verbosity'. Need not match actual platform. Changing this -option will have no effect until you restart Emacs." +Corresponding value is one of: nil, `MacOS', `MS-Windows', `UNIX'. +Set this to your preferred value; it need not match the actual platform +you are using. + +This variable does not affect the behavior of ls-lisp directly. +Rather, it controls the default values for some variables that do: +`ls-lisp-ignore-case', `ls-lisp-dirs-first', and `ls-lisp-verbosity'. + +If you change this variable directly (without using customize) +after loading `ls-lisp', you should use `ls-lisp-set-options' to +update the dependent variables." :type '(choice (const :tag "GNU" nil) (const MacOS) (const MS-Windows) (const UNIX)) + :initialize 'custom-initialize-default + :set (lambda (symbol value) + (unless (equal value (eval symbol)) + (custom-set-default symbol value) + (ls-lisp-set-options))) :group 'ls-lisp) ;; Only made an obsolete alias in 23.3. Before that, the initial @@ -97,6 +109,7 @@ option will have no effect until you restart Emacs." (defcustom ls-lisp-ignore-case (memq ls-lisp-emulation '(MS-Windows MacOS)) "Non-nil causes ls-lisp alphabetic sorting to ignore case." + :set-after '(ls-lisp-emulation) :type 'boolean :group 'ls-lisp) @@ -104,6 +117,7 @@ option will have no effect until you restart Emacs." "Non-nil causes ls-lisp to sort directories first in any ordering. \(Or last if it is reversed.) Follows Microsoft Windows Explorer." ;; Functionality suggested by Chris McMahan + :set-after '(ls-lisp-emulation) :type 'boolean :group 'ls-lisp) @@ -119,14 +133,15 @@ It should contain none or more of the symbols: links, uid, gid. 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 +the file; `uid' means user (owner) identifier; `gid' means group identifier. -If emulation is MacOS then default is nil\; +If emulation is MacOS then default is nil; if emulation is MS-Windows then default is `(links)' if platform is -Windows NT/2K, nil otherwise\; -if emulation is UNIX then default is `(links uid)'\; +Windows NT/2K, nil otherwise; +if emulation is UNIX then default is `(links uid)'; if emulation is GNU then default is `(links uid gid)'." + :set-after '(ls-lisp-emulation) ;; Functionality suggested by Howard Melman :type '(set (const :tag "Show Link Count" links) (const :tag "Show User" uid) @@ -162,7 +177,7 @@ regardless of whether the locale can be determined. Syntax: (EARLY-TIME-FORMAT OLD-TIME-FORMAT) The EARLY-TIME-FORMAT is used if file has been modified within the -current year. The OLD-TIME-FORMAT is used for older files. To use ISO +current year. The OLD-TIME-FORMAT is used for older files. To use ISO 8601 dates, you could set: \(setq ls-lisp-format-time-list @@ -173,17 +188,14 @@ current year. The OLD-TIME-FORMAT is used for older files. To use ISO :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. + "Non-nil means to always use `ls-lisp-format-time-list' for time stamps. +This applies 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." +to fail to line 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" @@ -196,15 +208,12 @@ to fail to lign up, e.g. if month names are not all of the same length." "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))) - +(defvar ls-lisp-filesize-b-fmt "%.0f" + "Format to display file sizes in blocks (for the -s switch).") ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(defun insert-directory (file switches &optional wildcard full-directory-p) +(defun ls-lisp--insert-directory (orig-fun file switches &optional wildcard full-directory-p) "Insert directory listing for FILE, formatted according to SWITCHES. Leaves point after the inserted text. SWITCHES may be a string of options, or a list of strings. @@ -214,12 +223,10 @@ switches do not contain `d', so that a full listing is expected. This version of the function comes from `ls-lisp.el'. If the value of `ls-lisp-use-insert-directory-program' is non-nil then -it works exactly like the version from `files.el' and runs a directory -listing program whose name is in the variable -`insert-directory-program'; if also WILDCARD is non-nil then it runs -the shell specified by `shell-file-name'. If the value of -`ls-lisp-use-insert-directory-program' is nil then it runs a Lisp -emulation. +this advice just delegates the work to ORIG-FUN (the normal `insert-directory' +function from `files.el'). +But if the value of `ls-lisp-use-insert-directory-program' is nil +then it runs a Lisp emulation. The Lisp emulation does not run any external programs or shells. It supports ordinary shell wildcards if `ls-lisp-support-shell-wildcards' @@ -228,7 +235,7 @@ to match file names. It does not support all `ls' switches -- those that work are: A a B C c F G g h i n R r S s t U u X. The l switch is assumed to be always present and cannot be turned off." (if ls-lisp-use-insert-directory-program - (funcall original-insert-directory + (funcall orig-fun 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) @@ -288,6 +295,7 @@ is assumed to be always present and cannot be turned off." (replace-match "total used in directory") (end-of-line) (insert " available " available))))))))) +(advice-add 'insert-directory :around #'ls-lisp--insert-directory) (defun ls-lisp-insert-directory (file switches time-index wildcard-regexp full-directory-p) @@ -307,14 +315,14 @@ not contain `d', so that a full listing is expected." (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 attr fuid fgid uid-len gid-len) + (setq file-alist (ls-lisp-sanitize file-alist)) (cond ((memq ?A switches) (setq file-alist (ls-lisp-delete-matching "^\\.\\.?$" file-alist))) @@ -350,17 +358,15 @@ not contain `d', so that a full listing is expected." (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))))) + (format " %%%dd" (length (format "%.0f" max-file-size)))) (setq ls-lisp-filesize-f-fmt - (format " %%%d.0f" - (if (memq ?s switches) + (format " %%%d.0f" (length (format "%.0f" max-file-size)))) + (if (memq ?s switches) + (setq ls-lisp-filesize-b-fmt + (format "%%%d.0f " (length (format "%.0f" - (fceiling (/ max-file-size 1024.0)))) - (length (format "%.0f" max-file-size))))) + (fceiling + (/ max-file-size 1024.0))))))) (setq files file-alist) (while files ; long (-l) format (setq elt (car files) @@ -378,7 +384,7 @@ not contain `d', so that a full listing is expected." sum (float sum)))) (insert (ls-lisp-format short attr file-size - switches time-index now)))) + switches time-index)))) ;; Insert total size of all files: (save-excursion (goto-char (car total-line)) @@ -387,6 +393,13 @@ not contain `d', so that a full listing is expected." ;; the wildcard; let's say something similar. (insert "(No match)\n")) (insert (format "total %.0f\n" (fceiling (/ sum 1024.0)))))) + ;; dired-insert-directory expects to find point after the + ;; text. But if the listing is empty, as e.g. in empty + ;; directories with -a removed from switches, point will be + ;; before the inserted text, and dired-insert-directory will + ;; not indent the listing correctly. Going to the end of the + ;; buffer fixes that. + (unless files (goto-char (point-max))) (if (memq ?R switches) ;; List the contents of all directories recursively. ;; cadr of each element of `file-alist' is t for @@ -417,10 +430,26 @@ not contain `d', so that a full listing is expected." (ls-lisp-classify-file file fattr) file) fattr (nth 7 fattr) - switches time-index (current-time))) + switches time-index)) (message "%s: doesn't exist or is inaccessible" file) (ding) (sit-for 2))))) ; to show user the message! +(defun ls-lisp-sanitize (file-alist) + "Sanitize the elements in FILE-ALIST. +Fixes any elements in the alist for directory entries whose file +attributes are nil (meaning that `file-attributes' failed for +them). This is known to happen for some network shares, in +particular for the \"..\" directory entry. + +If the \"..\" directory entry has nil attributes, the attributes +are copied from the \".\" entry, if they are non-nil. Otherwise, +the offending element is removed from the list, as are any +elements for other directory entries with nil attributes." + (if (and (null (cdr (assoc ".." file-alist))) + (cdr (assoc "." file-alist))) + (setcdr (assoc ".." file-alist) (cdr (assoc "." file-alist)))) + (rassq-delete-all nil file-alist)) + (defun ls-lisp-column-format (file-alist) "Insert the file names (only) in FILE-ALIST into the current buffer. Format in columns, sorted vertically, following GNU ls -C. @@ -491,8 +520,8 @@ SWITCHES is a list of characters. Default sorting is alphabetic." (nth 7 (cdr x))))) ((setq index (ls-lisp-time-index switches)) (lambda (x y) ; sorted on time - (ls-lisp-time-lessp (nth index (cdr y)) - (nth index (cdr x))))) + (time-less-p (nth index (cdr y)) + (nth index (cdr x))))) ((memq ?X switches) (lambda (x y) ; sorted on extension (ls-lisp-string-lessp @@ -590,18 +619,10 @@ FOLLOWED by null and full filename, SOLELY for full alpha sort." (substring filename (1+ i) end)))) )) "\0" filename)) -;; From Roland McGrath. Can use this to sort on time. -(defun ls-lisp-time-lessp (time0 time1) - "Return t if time TIME0 is earlier than time TIME1." - (let ((hi0 (car time0)) (hi1 (car time1))) - (or (< hi0 hi1) - (and (= hi0 hi1) - (< (cadr time0) (cadr time1)))))) - -(defun ls-lisp-format (file-name file-attr file-size switches time-index now) +(defun ls-lisp-format (file-name file-attr file-size switches time-index) "Format one line of long ls output for file FILE-NAME. FILE-ATTR and FILE-SIZE give the file's attributes and size. -SWITCHES, TIME-INDEX and NOW give the full switch list and time data." +SWITCHES and TIME-INDEX give the full switch list and time data." (let ((file-type (nth 0 file-attr)) ;; t for directory, string (name linked to) ;; for symbolic link, or nil. @@ -632,9 +653,20 @@ SWITCHES, TIME-INDEX and NOW give the full switch list and time data." (cdr inode)))) (format " %18d " inode)))) ;; nil is treated like "" in concat - (if (memq ?s switches) ; size in K - (format ls-lisp-filesize-f-fmt - (fceiling (/ file-size 1024.0)))) + (if (memq ?s switches) ; size in K, rounded up + ;; In GNU ls, -h affects the size in blocks, displayed + ;; by -s, as well. + (if (memq ?h switches) + (format "%6s " + (file-size-human-readable + ;; We use 1K as "block size", although + ;; most Windows volumes use 4KB to 8KB + ;; clusters, and exFAT will usually have + ;; clusters of 32KB or even 128KB. See + ;; KB article 140365 for the details. + (* 1024.0 (fceiling (/ file-size 1024.0))))) + (format ls-lisp-filesize-b-fmt + (fceiling (/ file-size 1024.0))))) drwxrwxrwx ; attribute string (if (memq 'links ls-lisp-verbosity) (format "%3d" (nth 1 file-attr))) ; link count @@ -659,7 +691,7 @@ SWITCHES, TIME-INDEX and NOW give the full switch list and time data." gid)))) (ls-lisp-format-file-size file-size (memq ?h switches)) " " - (ls-lisp-format-time file-attr time-index now) + (ls-lisp-format-time file-attr time-index) " " (if (not (memq ?F switches)) ; ls-lisp-classify already did that (propertize file-name 'dired-filename t) @@ -677,20 +709,13 @@ Return nil if no time switch found." ((memq ?t switches) 5) ; last modtime ((memq ?u switches) 4))) ; last access -(defun ls-lisp-time-to-seconds (time) - "Convert TIME to a floating point number." - (+ (* (car time) 65536.0) - (cadr time) - (/ (or (nth 2 time) 0) 1000000.0))) - -(defun ls-lisp-format-time (file-attr time-index now) +(defun ls-lisp-format-time (file-attr time-index) "Format time for file with attributes FILE-ATTR according to TIME-INDEX. Use the same method as ls to decide whether to show time-of-day or year, -depending on distance between file date and NOW. +depending on distance between file date and the current time. All ls time options, namely c, t and u, are handled." (let* ((time (nth (or time-index 5) file-attr)) ; default is last modtime - (diff (- (ls-lisp-time-to-seconds time) - (ls-lisp-time-to-seconds now))) + (diff (- (float-time time) (float-time))) ;; Consider a time to be recent if it is within the past six ;; months. A Gregorian year has 365.2425 * 24 * 60 * 60 == ;; 31556952 seconds on the average, and half of that is 15778476. @@ -723,15 +748,8 @@ All ls time options, namely c, t and u, are handled." 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))))))) + (format " %6s" (file-size-human-readable file-size)))) (provide 'ls-lisp) -;; arch-tag: e55f399b-05ec-425c-a6d5-f5e349c35ab4 ;;; ls-lisp.el ends here