(eval-when-compile (require 'cl))
(defgroup ls-lisp nil
"Emulate the ls program completely in Emacs Lisp."
:version "21.1"
:group 'dired)
(defcustom ls-lisp-emulation
(cond ((eq system-type 'macos) 'MacOS)
((memq system-type
'(hpux dgux usg-unix-v unisoft-unix rtu irix berkeley-unix))
'UNIX)) "*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."
:type '(choice (const :tag "GNU" nil)
(const MacOS)
(const MS-Windows)
(const UNIX))
:group 'ls-lisp)
(defcustom ls-lisp-ignore-case
(or (memq ls-lisp-emulation '(MS-Windows MacOS))
(and (boundp 'ls-lisp-dired-ignore-case) ls-lisp-dired-ignore-case))
"*Non-nil causes ls-lisp alphabetic sorting to ignore case."
:type 'boolean
:group 'ls-lisp)
(defcustom ls-lisp-dirs-first (eq ls-lisp-emulation 'MS-Windows)
"*Non-nil causes ls-lisp to sort directories first in any ordering.
\(Or last if it is reversed.) Follows Microsoft Windows Explorer."
:type 'boolean
:group 'ls-lisp)
(defcustom ls-lisp-verbosity
(cond ((eq ls-lisp-emulation 'MacOS) nil)
((eq ls-lisp-emulation 'MS-Windows)
(if (and (fboundp 'w32-using-nt) (w32-using-nt))
'(links))) ((eq ls-lisp-emulation 'UNIX) '(links uid)) (t '(links uid gid))) "*A list of optional file attributes that ls-lisp should display.
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
identifier.
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)'\;
if emulation is GNU then default is `(links uid gid)'."
:type '(set (const :tag "Show Link Count" links)
(const :tag "Show User" uid)
(const :tag "Show Group" gid))
:group 'ls-lisp)
(defcustom ls-lisp-use-insert-directory-program
(not (memq system-type '(macos ms-dos windows-nt)))
"*Non-nil causes ls-lisp to revert back to using `insert-directory-program'.
This is useful on platforms where ls-lisp is dumped into Emacs, such as
Microsoft Windows, but you would still like to use a program to list
the contents of a directory."
:type 'boolean
:group 'ls-lisp)
(defcustom ls-lisp-support-shell-wildcards t
"*Non-nil means ls-lisp treats file patterns as shell wildcards.
Otherwise they are treated as Emacs regexps (for backward compatibility)."
:type 'boolean
:group 'ls-lisp)
(defcustom ls-lisp-format-time-list
'("%b %e %H:%M"
"%b %e %Y")
"*List of `format-time-string' specs to display file time stamps.
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)
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
8601 dates, you could set:
\(setq ls-lisp-format-time-list
'(\"%Y-%m-%d %H:%M\"
\"%Y-%m-%d \"))"
:type '(list (string :tag "Early time format")
(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'.")
(or (featurep 'ls-lisp) (setq original-insert-directory (symbol-function 'insert-directory)))
(defun insert-directory (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.
Optional third arg WILDCARD means treat FILE as shell wildcard.
Optional fourth arg FULL-DIRECTORY-P means file is a directory and
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.
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."
(if ls-lisp-use-insert-directory-program
(funcall original-insert-directory
file switches wildcard full-directory-p)
(let ((handler (find-file-name-handler (expand-file-name file)
'insert-directory))
wildcard-regexp)
(if handler
(funcall handler 'insert-directory file switches
wildcard full-directory-p)
(if (string-match "--dired " switches)
(setq switches (replace-match "" nil nil switches)))
(setq switches (delete ?- (append switches nil)))
(if (and ls-lisp-support-shell-wildcards
(string-match "[[?*]" file))
(progn
(or (not (eq (aref file (1- (length file))) ?/))
(setq file (substring file 0 (1- (length file)))))
(setq wildcard t)))
(if wildcard
(setq wildcard-regexp
(if ls-lisp-support-shell-wildcards
(wildcard-to-regexp (file-name-nondirectory file))
(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)
(save-excursion
(goto-char (point-min))
(when (re-search-forward "^total" nil t)
(let ((available (get-free-disk-space ".")))
(when available
(replace-match "total used in directory")
(end-of-line)
(insert " available " available)))))))))
(defun ls-lisp-insert-directory
(file switches time-index wildcard-regexp full-directory-p)
"Insert directory listing for FILE, formatted according to SWITCHES.
Leaves point after the inserted text. This is an internal function
optionally called by the `ls-lisp.el' version of `insert-directory'.
It is called recursively if the -R switch is used.
SWITCHES is a *list* of characters. TIME-INDEX is the time index into
file-attributes according to SWITCHES. WILDCARD-REGEXP is nil or an *Emacs
regexp*. FULL-DIRECTORY-P means file is a directory and SWITCHES does
not contain `d', so that a full listing is expected."
(if (or wildcard-regexp full-directory-p)
(let* ((dir (file-name-as-directory file))
(default-directory dir) (file-alist
(directory-files-and-attributes dir nil wildcard-regexp t 'string))
(now (current-time))
(sum 0)
total-line files elt short file-size fil attr)
(cond ((memq ?A switches)
(setq file-alist
(ls-lisp-delete-matching "^\\.\\.?$" file-alist)))
((not (memq ?a switches))
(setq file-alist
(ls-lisp-delete-matching "^\\." file-alist))))
(setq file-alist
(ls-lisp-handle-switches file-alist switches))
(if (memq ?C switches) (ls-lisp-column-format file-alist)
(setq total-line (cons (point) (car-safe file-alist)))
(setq files file-alist)
(while files (setq elt (car files)
files (cdr files)
short (car elt)
attr (cdr elt)
file-size (nth 7 attr))
(and attr
(setq sum (+ file-size
(if (or (< sum (- 134217727 file-size))
(floatp sum)
(floatp file-size))
sum
(float sum))))
(insert (ls-lisp-format short attr file-size
switches time-index now))))
(save-excursion
(goto-char (car total-line))
(or (cdr total-line)
(insert "(No match)\n"))
(insert (format "total %.0f\n" (fceiling (/ sum 1024.0))))))
(if (memq ?R switches)
(while file-alist
(setq elt (car file-alist)
file-alist (cdr file-alist))
(when (and (eq (cadr elt) t) (not (string-match "\\`\\.\\.?\\'" (car elt))))
(setq elt (expand-file-name (car elt) dir))
(insert "\n" elt ":\n")
(ls-lisp-insert-directory
elt switches time-index wildcard-regexp full-directory-p)))))
(if (eq (aref file (1- (length file))) ?/)
(setq file (substring file 0 -1)))
(let ((fattr (file-attributes file 'string)))
(if fattr
(insert (ls-lisp-format file fattr (nth 7 fattr)
switches time-index (current-time)))
(message "%s: doesn't exist or is inaccessible" file)
(ding) (sit-for 2)))))
(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.
Responds to the window width as ls should but may not!"
(let (files fmt ncols collen (nfiles 0) (colwid 0))
(let (file len)
(while file-alist
(setq nfiles (1+ nfiles)
file (caar file-alist)
files (cons file files)
file-alist (cdr file-alist)
len (length file))
(if (> len colwid) (setq colwid len))))
(setq files (nreverse files)
colwid (+ 2 colwid) fmt (format "%%-%ds" colwid) ncols (/ (window-width) colwid) collen (/ nfiles ncols)) (if (> nfiles (* collen ncols)) (setq collen (1+ collen)))
(let ((i 0) j)
(while (< i collen)
(setq j i)
(while (< j nfiles)
(insert (format fmt (nth j files)))
(setq j (+ j collen)))
(delete-region (point) (progn (skip-chars-backward " \t") (point)))
(insert ?\n)
(setq i (1+ i))))))
(defun ls-lisp-delete-matching (regexp list)
"Delete all elements matching REGEXP from LIST, return new list."
(let (result)
(while list
(or (string-match regexp (caar list))
(setq result (cons (car list) result)))
(setq list (cdr list)))
result))
(defsubst ls-lisp-string-lessp (s1 s2)
"Return t if string S1 is less than string S2 in lexicographic order.
Case is significant if `ls-lisp-ignore-case' is nil.
Unibyte strings are converted to multibyte for comparison."
(let ((u (compare-strings s1 0 nil s2 0 nil ls-lisp-ignore-case)))
(and (numberp u) (< u 0))))
(defun ls-lisp-handle-switches (file-alist switches)
"Return new FILE-ALIST sorted according to SWITCHES.
SWITCHES is a list of characters. Default sorting is alphabetic."
(or (memq ?U switches) (condition-case err
(setq file-alist
(let (index)
(sort (copy-sequence file-alist) (cond ((memq ?S switches)
(lambda (x y) (< (nth 7 (cdr y))
(nth 7 (cdr x)))))
((setq index (ls-lisp-time-index switches))
(lambda (x y) (ls-lisp-time-lessp (nth index (cdr y))
(nth index (cdr x)))))
((memq ?X switches)
(lambda (x y) (ls-lisp-string-lessp
(ls-lisp-extension (car x))
(ls-lisp-extension (car y)))))
(t
(lambda (x y) (ls-lisp-string-lessp (car x) (car y))))))))
(error (message "Unsorted (ls-lisp sorting error) - %s"
(error-message-string err))
(ding) (sit-for 2)))) (if (memq ?F switches) (setq file-alist (mapcar 'ls-lisp-classify file-alist)))
(if ls-lisp-dirs-first
(let (el dirs files)
(while file-alist
(if (or (eq (cadr (setq el (car file-alist))) t) (and (stringp (cadr el))
(file-directory-p (cadr el)))) (setq dirs (cons el dirs))
(setq files (cons el files)))
(setq file-alist (cdr file-alist)))
(setq file-alist
(if (memq ?U switches) (nconc dirs files)
(nconc files dirs)
))))
(if (eq (eq (not (memq ?U switches)) (not (memq ?r switches))) ls-lisp-dirs-first) (nreverse file-alist)
file-alist))
(defun ls-lisp-classify (filedata)
"Append a character to each file name indicating the file type.
Also, for regular files that are executable, append `*'.
The file type indicators are `/' for directories, `@' for symbolic
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 ((file-name (car filedata))
(type (cadr filedata)))
(cond (type
(cons
(concat file-name (if (eq type t) "/" "@"))
(cdr filedata)))
((string-match "x" (nth 9 filedata))
(cons
(concat file-name "*")
(cdr filedata)))
(t filedata))))
(defun ls-lisp-extension (filename)
"Return extension of FILENAME (ignoring any version extension)
FOLLOWED by null and full filename, SOLELY for full alpha sort."
(concat
(let* ((i (length filename)) end)
(if (= (aref filename (1- i)) ?.) "\0"
(while (and (>= (setq i (1- i)) 0)
(/= (aref filename i) ?.)))
(if (< i 0) "\0\0" (if (/= (aref filename (1+ i)) ?~)
(substring filename (1+ i))
(setq end i)
(while (and (>= (setq i (1- i)) 0)
(/= (aref filename i) ?.)))
(if (< i 0) "\0\0" (substring filename (1+ i) end))))
)) "\0" filename))
(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)
"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."
(let ((file-type (nth 0 file-attr))
(drwxrwxrwx (nth 8 file-attr))) (concat (if (memq ?i switches) (format " %6d" (nth 10 file-attr)))
(if (memq ?s switches) (format " %4.0f" (fceiling (/ file-size 1024.0))))
drwxrwxrwx (if (memq 'links ls-lisp-verbosity)
(format " %3d" (nth 1 file-attr))) (if (memq 'uid ls-lisp-verbosity)
(let ((uid (nth 2 file-attr)))
(format (if (stringp uid) " %-8s" " %-8d") uid)))
(if (not (memq ?G switches)) (if (or (memq ?g switches) (memq 'gid ls-lisp-verbosity))
(let ((gid (nth 3 file-attr)))
(format (if (stringp gid) " %-8s" " %-8d") gid))))
(ls-lisp-format-file-size file-size (memq ?h switches))
" "
(ls-lisp-format-time file-attr time-index now)
" "
(propertize file-name 'dired-filename t)
(if (stringp file-type) (concat " -> " file-type))
"\n"
)))
(defun ls-lisp-time-index (switches)
"Return time index into file-attributes according to ls SWITCHES list.
Return nil if no time switch found."
(cond ((memq ?c switches) 6) ((memq ?t switches) 5) ((memq ?u switches) 4)))
(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)
"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.
All ls time options, namely c, t and u, are handled."
(let* ((time (nth (or time-index 5) file-attr)) (diff (- (ls-lisp-time-to-seconds time)
(ls-lisp-time-to-seconds now)))
(past-cutoff -15778476)) (condition-case nil
(let ((locale system-time-locale))
(if (not locale)
(let ((vars '("LC_ALL" "LC_TIME" "LANG")))
(while (and vars (not (setq locale (getenv (car vars)))))
(setq vars (cdr vars)))))
(if (member locale '("C" "POSIX"))
(setq locale nil))
(format-time-string
(if (and (<= past-cutoff diff) (<= diff 0))
(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))
(post-fixes (list "k" "M" "G" "T" "P" "E") (cdr post-fixes)))
((< file-size 1024) (format " %8.0f%s" file-size (car post-fixes))))))
(provide 'ls-lisp)