em-ls.el 30.3 KB
Newer Older
1
;;; em-ls.el --- implementation of ls in Lisp
Gerd Moellmann's avatar
Gerd Moellmann committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
5

Gerd Moellmann's avatar
Gerd Moellmann committed
6 7
;; Author: John Wiegley <johnw@gnu.org>

Gerd Moellmann's avatar
Gerd Moellmann committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
12
;; the Free Software Foundation; either version 3, or (at your option)
Gerd Moellmann's avatar
Gerd Moellmann committed
13 14 15 16 17 18 19 20 21
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
22 23
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Gerd Moellmann's avatar
Gerd Moellmann committed
24

25 26 27 28
;;; Commentary:

;; Most of the command switches recognized by GNU's ls utility are
;; supported ([(fileutils)ls invocation]).
Gerd Moellmann's avatar
Gerd Moellmann committed
29

30 31 32 33 34
;;; Code:

(eval-when-compile (require 'eshell))
(require 'esh-util)
(require 'esh-opt)
Gerd Moellmann's avatar
Gerd Moellmann committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

(defgroup eshell-ls nil
  "This module implements the \"ls\" utility fully in Lisp.  If it is
passed any unrecognized command switches, it will revert to the
operating system's version.  This version of \"ls\" uses text
properties to colorize its output based on the setting of
`eshell-ls-use-colors'."
  :tag "Implementation of `ls' in Lisp"
  :group 'eshell-module)

;;; User Variables:

(defvar eshell-ls-orig-insert-directory
  (symbol-function 'insert-directory)
  "Preserve the original definition of `insert-directory'.")

(defcustom eshell-ls-unload-hook
  (list
   (function
    (lambda ()
      (fset 'insert-directory eshell-ls-orig-insert-directory))))
  "*When unloading `eshell-ls', restore the definition of `insert-directory'."
  :type 'hook
  :group 'eshell-ls)

John Wiegley's avatar
John Wiegley committed
60 61 62 63 64 65
(defcustom eshell-ls-initial-args nil
  "*If non-nil, this list of args is included before any call to `ls'.
This is useful for enabling human-readable format (-h), for example."
  :type '(repeat :tag "Arguments" string)
  :group 'eshell-ls)

66
(defcustom eshell-ls-dired-initial-args nil
67
  "*If non-nil, args is included before any call to `ls' in Dired.
68 69 70 71
This is useful for enabling human-readable format (-h), for example."
  :type '(repeat :tag "Arguments" string)
  :group 'eshell-ls)

Gerd Moellmann's avatar
Gerd Moellmann committed
72
(defcustom eshell-ls-use-in-dired nil
73
  "*If non-nil, use `eshell-ls' to read directories in Dired."
Gerd Moellmann's avatar
Gerd Moellmann committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
  :set (lambda (symbol value)
	 (if value
	     (unless (and (boundp 'eshell-ls-use-in-dired)
			  eshell-ls-use-in-dired)
	       (fset 'insert-directory 'eshell-ls-insert-directory))
	   (when (and (boundp 'eshell-ls-insert-directory)
		      eshell-ls-use-in-dired)
	     (fset 'insert-directory eshell-ls-orig-insert-directory)))
	 (setq eshell-ls-use-in-dired value))
  :type 'boolean
  :require 'em-ls
  :group 'eshell-ls)

(defcustom eshell-ls-default-blocksize 1024
  "*The default blocksize to use when display file sizes with -s."
  :type 'integer
  :group 'eshell-ls)

John Wiegley's avatar
John Wiegley committed
92
(defcustom eshell-ls-exclude-regexp nil
Gerd Moellmann's avatar
Gerd Moellmann committed
93
  "*Unless -a is specified, files matching this regexp will not be shown."
94
  :type '(choice regexp (const nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
95 96
  :group 'eshell-ls)

John Wiegley's avatar
John Wiegley committed
97 98 99 100 101 102 103
(defcustom eshell-ls-exclude-hidden t
  "*Unless -a is specified, files beginning with . will not be shown.
Using this boolean, instead of `eshell-ls-exclude-regexp', is both
faster and conserves more memory."
  :type 'boolean
  :group 'eshell-ls)

Gerd Moellmann's avatar
Gerd Moellmann committed
104 105 106 107 108
(defcustom eshell-ls-use-colors t
  "*If non-nil, use colors in file listings."
  :type 'boolean
  :group 'eshell-ls)

109
(defface eshell-ls-directory
110 111 112
  '((((class color) (background light)) (:foreground "Blue" :weight bold))
    (((class color) (background dark)) (:foreground "SkyBlue" :weight bold))
    (t (:weight bold)))
Gerd Moellmann's avatar
Gerd Moellmann committed
113 114
  "*The face used for highlight directories."
  :group 'eshell-ls)
115 116
;; backward-compatibility alias
(put 'eshell-ls-directory-face 'face-alias 'eshell-ls-directory)
Gerd Moellmann's avatar
Gerd Moellmann committed
117

118
(defface eshell-ls-symlink
119 120
  '((((class color) (background light)) (:foreground "Dark Cyan" :weight bold))
    (((class color) (background dark)) (:foreground "Cyan" :weight bold)))
Gerd Moellmann's avatar
Gerd Moellmann committed
121 122
  "*The face used for highlight symbolic links."
  :group 'eshell-ls)
123 124
;; backward-compatibility alias
(put 'eshell-ls-symlink-face 'face-alias 'eshell-ls-symlink)
Gerd Moellmann's avatar
Gerd Moellmann committed
125

126
(defface eshell-ls-executable
127 128
  '((((class color) (background light)) (:foreground "ForestGreen" :weight bold))
    (((class color) (background dark)) (:foreground "Green" :weight bold)))
Gerd Moellmann's avatar
Gerd Moellmann committed
129 130
  "*The face used for highlighting executables (not directories, though)."
  :group 'eshell-ls)
131 132
;; backward-compatibility alias
(put 'eshell-ls-executable-face 'face-alias 'eshell-ls-executable)
Gerd Moellmann's avatar
Gerd Moellmann committed
133

134
(defface eshell-ls-readonly
Gerd Moellmann's avatar
Gerd Moellmann committed
135 136 137 138
  '((((class color) (background light)) (:foreground "Brown"))
    (((class color) (background dark)) (:foreground "Pink")))
  "*The face used for highlighting read-only files."
  :group 'eshell-ls)
139 140
;; backward-compatibility alias
(put 'eshell-ls-readonly-face 'face-alias 'eshell-ls-readonly)
Gerd Moellmann's avatar
Gerd Moellmann committed
141

142
(defface eshell-ls-unreadable
Gerd Moellmann's avatar
Gerd Moellmann committed
143 144 145 146
  '((((class color) (background light)) (:foreground "Grey30"))
    (((class color) (background dark)) (:foreground "DarkGrey")))
  "*The face used for highlighting unreadable files."
  :group 'eshell-ls)
147 148
;; backward-compatibility alias
(put 'eshell-ls-unreadable-face 'face-alias 'eshell-ls-unreadable)
Gerd Moellmann's avatar
Gerd Moellmann committed
149

150
(defface eshell-ls-special
151 152
  '((((class color) (background light)) (:foreground "Magenta" :weight bold))
    (((class color) (background dark)) (:foreground "Magenta" :weight bold)))
Gerd Moellmann's avatar
Gerd Moellmann committed
153 154
  "*The face used for highlighting non-regular files."
  :group 'eshell-ls)
155 156
;; backward-compatibility alias
(put 'eshell-ls-special-face 'face-alias 'eshell-ls-special)
Gerd Moellmann's avatar
Gerd Moellmann committed
157

158
(defface eshell-ls-missing
159 160
  '((((class color) (background light)) (:foreground "Red" :weight bold))
    (((class color) (background dark)) (:foreground "Red" :weight bold)))
161
  "*The face used for highlighting non-existent file names."
Gerd Moellmann's avatar
Gerd Moellmann committed
162
  :group 'eshell-ls)
163 164
;; backward-compatibility alias
(put 'eshell-ls-missing-face 'face-alias 'eshell-ls-missing)
Gerd Moellmann's avatar
Gerd Moellmann committed
165 166 167 168 169 170 171 172 173 174

(defcustom eshell-ls-archive-regexp
  (concat "\\.\\(t\\(a[rz]\\|gz\\)\\|arj\\|lzh\\|"
	  "zip\\|[zZ]\\|gz\\|bz2\\|deb\\|rpm\\)\\'")
  "*A regular expression that matches names of file archives.
This typically includes both traditional archives and compressed
files."
  :type 'regexp
  :group 'eshell-ls)

175
(defface eshell-ls-archive
176 177
  '((((class color) (background light)) (:foreground "Orchid" :weight bold))
    (((class color) (background dark)) (:foreground "Orchid" :weight bold)))
Gerd Moellmann's avatar
Gerd Moellmann committed
178 179
  "*The face used for highlighting archived and compressed file names."
  :group 'eshell-ls)
180 181
;; backward-compatibility alias
(put 'eshell-ls-archive-face 'face-alias 'eshell-ls-archive)
Gerd Moellmann's avatar
Gerd Moellmann committed
182 183 184 185 186 187 188

(defcustom eshell-ls-backup-regexp
  "\\(\\`\\.?#\\|\\(\\.bak\\|~\\)\\'\\)"
  "*A regular expression that matches names of backup files."
  :type 'regexp
  :group 'eshell-ls)

189
(defface eshell-ls-backup
Gerd Moellmann's avatar
Gerd Moellmann committed
190 191 192 193
  '((((class color) (background light)) (:foreground "OrangeRed"))
    (((class color) (background dark)) (:foreground "LightSalmon")))
  "*The face used for highlighting backup file names."
  :group 'eshell-ls)
194 195
;; backward-compatibility alias
(put 'eshell-ls-backup-face 'face-alias 'eshell-ls-backup)
Gerd Moellmann's avatar
Gerd Moellmann committed
196 197

(defcustom eshell-ls-product-regexp
198
  "\\.\\(elc\\|o\\(bj\\)?\\|a\\|lib\\|res\\)\\'"
Gerd Moellmann's avatar
Gerd Moellmann committed
199 200 201 202 203 204
  "*A regular expression that matches names of product files.
Products are files that get generated from a source file, and hence
ought to be recreatable if they are deleted."
  :type 'regexp
  :group 'eshell-ls)

205
(defface eshell-ls-product
Gerd Moellmann's avatar
Gerd Moellmann committed
206 207 208 209
  '((((class color) (background light)) (:foreground "OrangeRed"))
    (((class color) (background dark)) (:foreground "LightSalmon")))
  "*The face used for highlighting files that are build products."
  :group 'eshell-ls)
210 211
;; backward-compatibility alias
(put 'eshell-ls-product-face 'face-alias 'eshell-ls-product)
Gerd Moellmann's avatar
Gerd Moellmann committed
212 213 214 215 216 217 218 219 220

(defcustom eshell-ls-clutter-regexp
  "\\(^texput\\.log\\|^core\\)\\'"
  "*A regular expression that matches names of junk files.
These are mainly files that get created for various reasons, but don't
really need to stick around for very long."
  :type 'regexp
  :group 'eshell-ls)

221
(defface eshell-ls-clutter
222 223
  '((((class color) (background light)) (:foreground "OrangeRed" :weight bold))
    (((class color) (background dark)) (:foreground "OrangeRed" :weight bold)))
Gerd Moellmann's avatar
Gerd Moellmann committed
224 225
  "*The face used for highlighting junk file names."
  :group 'eshell-ls)
226 227
;; backward-compatibility alias
(put 'eshell-ls-clutter-face 'face-alias 'eshell-ls-clutter)
Gerd Moellmann's avatar
Gerd Moellmann committed
228 229 230 231 232 233 234 235 236 237

(defsubst eshell-ls-filetype-p (attrs type)
  "Test whether ATTRS specifies a directory."
  (if (nth 8 attrs)
      (eq (aref (nth 8 attrs) 0) type)))

(defmacro eshell-ls-applicable (attrs index func file)
  "Test whether, for ATTRS, the user UID can do what corresponds to INDEX.
This is really just for efficiency, to avoid having to stat the file
yet again."
238 239
  `(if (numberp (nth 2 ,attrs))
       (if (= (user-uid) (nth 2 ,attrs))
John Wiegley's avatar
John Wiegley committed
240 241
	   (not (eq (aref (nth 8 ,attrs) ,index) ?-))
	 (,(eval func) ,file))
242
     (not (eq (aref (nth 8 ,attrs)
John Wiegley's avatar
John Wiegley committed
243 244 245 246
		    (+ ,index (if (member (nth 2 ,attrs)
					  (eshell-current-ange-uids))
				  0 6)))
	      ?-))))
Gerd Moellmann's avatar
Gerd Moellmann committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280

(defcustom eshell-ls-highlight-alist nil
  "*This alist correlates test functions to color.
The format of the members of this alist is

  (TEST-SEXP . FACE)

If TEST-SEXP evals to non-nil, that face will be used to highlight the
name of the file.  The first match wins.  `file' and `attrs' are in
scope during the evaluation of TEST-SEXP."
  :type '(repeat (cons function face))
  :group 'eshell-ls)

;;; Functions:

(defun eshell-ls-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 uses `eshell/ls'.  If any of the switches
passed are not recognized, the operating system's version will be used
instead."
  (let ((handler (find-file-name-handler file 'insert-directory)))
    (if handler
	(funcall handler 'insert-directory file switches
		 wildcard full-directory-p)
      (if (stringp switches)
	  (setq switches (split-string switches)))
      (let (eshell-current-handles
281 282
	    eshell-current-subjob-p
	    font-lock-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
283 284 285 286
	;; use the fancy highlighting in `eshell-ls' rather than font-lock
	(when (and eshell-ls-use-colors
		   (featurep 'font-lock))
	  (font-lock-mode -1)
287
	  (setq font-lock-defaults nil)
Gerd Moellmann's avatar
Gerd Moellmann committed
288 289 290 291 292 293
	  (if (boundp 'font-lock-buffers)
	      (set 'font-lock-buffers
		   (delq (current-buffer)
			 (symbol-value 'font-lock-buffers)))))
	(let ((insert-func 'insert)
	      (error-func 'insert)
John Wiegley's avatar
John Wiegley committed
294
	      (flush-func 'ignore)
295
	      eshell-ls-dired-initial-args)
Gerd Moellmann's avatar
Gerd Moellmann committed
296 297 298 299 300 301 302 303 304
	  (eshell-do-ls (append switches (list file))))))))

(defsubst eshell/ls (&rest args)
  "An alias version of `eshell-do-ls'."
  (let ((insert-func 'eshell-buffered-print)
	(error-func 'eshell-error)
	(flush-func 'eshell-flush))
    (eshell-do-ls args)))

305 306
(put 'eshell/ls 'eshell-no-numeric-conversions t)

Gerd Moellmann's avatar
Gerd Moellmann committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
(eval-when-compile
  (defvar block-size)
  (defvar dereference-links)
  (defvar dir-literal)
  (defvar error-func)
  (defvar flush-func)
  (defvar human-readable)
  (defvar ignore-pattern)
  (defvar insert-func)
  (defvar listing-style)
  (defvar numeric-uid-gid)
  (defvar reverse-list)
  (defvar show-all)
  (defvar show-recursive)
  (defvar show-size)
322
  (defvar sort-method)
323 324
  (defvar ange-cache)
  (defvar dired-flag))
Gerd Moellmann's avatar
Gerd Moellmann committed
325 326 327 328 329 330

(defun eshell-do-ls (&rest args)
  "Implementation of \"ls\" in Lisp, passing ARGS."
  (funcall flush-func -1)
  ;; process the command arguments, and begin listing files
  (eshell-eval-using-options
John Wiegley's avatar
John Wiegley committed
331 332 333
   "ls" (if eshell-ls-initial-args
	    (list eshell-ls-initial-args args)
	  args)
334 335
   `((?a "all" nil show-all
	 "show all files in directory")
Gerd Moellmann's avatar
Gerd Moellmann committed
336
     (?c nil by-ctime sort-method
337
	 "sort by last status change time")
Gerd Moellmann's avatar
Gerd Moellmann committed
338 339 340
     (?d "directory" nil dir-literal
	 "list directory entries instead of contents")
     (?k "kilobytes" 1024 block-size
341
	 "using 1024 as the block size")
Gerd Moellmann's avatar
Gerd Moellmann committed
342 343
     (?h "human-readable" 1024 human-readable
	 "print sizes in human readable format")
344 345
     (?H "si" 1000 human-readable
	 "likewise, but use powers of 1000 not 1024")
Gerd Moellmann's avatar
Gerd Moellmann committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359
     (?I "ignore" t ignore-pattern
	 "do not list implied entries matching pattern")
     (?l nil long-listing listing-style
	 "use a long listing format")
     (?n "numeric-uid-gid" nil numeric-uid-gid
	 "list numeric UIDs and GIDs instead of names")
     (?r "reverse" nil reverse-list
	 "reverse order while sorting")
     (?s "size" nil show-size
	 "print size of each file, in blocks")
     (?t nil by-mtime sort-method
	 "sort by modification time")
     (?u nil by-atime sort-method
	 "sort by last access time")
360 361
     (?x nil by-lines listing-style
	 "list entries by lines instead of by columns")
362 363 364 365 366 367 368 369 370 371
     (?C nil by-columns listing-style
	 "list entries by columns")
     (?L "deference" nil dereference-links
	 "list entries pointed to by symbolic links")
     (?R "recursive" nil show-recursive
	 "list subdirectories recursively")
     (?S nil by-size sort-method
	 "sort by file size")
     (?U nil unsorted sort-method
	 "do not sort; list entries in directory order")
Gerd Moellmann's avatar
Gerd Moellmann committed
372 373 374 375
     (?X nil by-extension sort-method
	 "sort alphabetically by entry extension")
     (?1 nil single-column listing-style
	 "list one file per line")
376 377
     (nil "dired" nil dired-flag
	  "Here for compatibility with GNU ls.")
Gerd Moellmann's avatar
Gerd Moellmann committed
378
     (nil "help" nil nil
379
	  "show this usage display")
Gerd Moellmann's avatar
Gerd Moellmann committed
380 381 382
     :external "ls"
     :usage "[OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
383
Sort entries alphabetically across.")
Gerd Moellmann's avatar
Gerd Moellmann committed
384 385 386 387 388 389 390
   ;; setup some defaults, based on what the user selected
   (unless block-size
     (setq block-size eshell-ls-default-blocksize))
   (unless listing-style
     (setq listing-style 'by-columns))
   (unless args
     (setq args (list ".")))
391
   (let ((eshell-ls-exclude-regexp eshell-ls-exclude-regexp) ange-cache)
392
     (when ignore-pattern
Gerd Moellmann's avatar
Gerd Moellmann committed
393 394 395 396
       (unless (eshell-using-module 'eshell-glob)
	 (error (concat "-I option requires that `eshell-glob'"
			" be a member of `eshell-modules-list'")))
       (set-text-properties 0 (length ignore-pattern) nil ignore-pattern)
John Wiegley's avatar
John Wiegley committed
397 398
       (setq eshell-ls-exclude-regexp
	     (if eshell-ls-exclude-regexp
Gerd Moellmann's avatar
Gerd Moellmann committed
399
		 (concat "\\(" eshell-ls-exclude-regexp "\\|"
John Wiegley's avatar
John Wiegley committed
400 401
			 (eshell-glob-regexp ignore-pattern) "\\)")
	       (eshell-glob-regexp ignore-pattern))))
Gerd Moellmann's avatar
Gerd Moellmann committed
402 403 404 405 406 407 408 409
     ;; list the files!
     (eshell-ls-entries
      (mapcar (function
	       (lambda (arg)
		 (cons (if (and (eshell-under-windows-p)
				(file-name-absolute-p arg))
			   (expand-file-name arg)
			 arg)
John Wiegley's avatar
John Wiegley committed
410 411
		       (eshell-file-attributes arg))))
	      args)
Gerd Moellmann's avatar
Gerd Moellmann committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
      t (expand-file-name default-directory)))
   (funcall flush-func)))

(defsubst eshell-ls-printable-size (filesize &optional by-blocksize)
  "Return a printable FILESIZE."
  (eshell-printable-size filesize human-readable
			 (and by-blocksize block-size)
			 eshell-ls-use-colors))

(defsubst eshell-ls-size-string (attrs size-width)
  "Return the size string for ATTRS length, using SIZE-WIDTH."
  (let* ((str (eshell-ls-printable-size (nth 7 attrs) t))
	 (len (length str)))
    (if (< len size-width)
	(concat (make-string (- size-width len) ? ) str)
      str)))

(defun eshell-ls-annotate (fileinfo)
  "Given a FILEINFO object, return a resolved, decorated FILEINFO.
This means resolving any symbolic links, determining what face the
name should be displayed as, etc.  Think of it as cooking a FILEINFO."
  (if (not (and (stringp (cadr fileinfo))
		(or dereference-links
		    (eq listing-style 'long-listing))))
      (setcar fileinfo (eshell-ls-decorated-name fileinfo))
    (let (dir attr)
      (unless (file-name-absolute-p (cadr fileinfo))
	(setq dir (file-truename
		   (file-name-directory
		    (expand-file-name (car fileinfo))))))
      (setq attr
443
	    (eshell-file-attributes
Gerd Moellmann's avatar
Gerd Moellmann committed
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
	     (let ((target (if dir
			       (expand-file-name (cadr fileinfo) dir)
			     (cadr fileinfo))))
	       (if dereference-links
		   (file-truename target)
		 target))))
      (if (or dereference-links
	      (string-match "^\\.\\.?$" (car fileinfo)))
	  (progn
	    (setcdr fileinfo attr)
	    (setcar fileinfo (eshell-ls-decorated-name fileinfo)))
	(assert (eq listing-style 'long-listing))
	(setcar fileinfo
		(concat (eshell-ls-decorated-name fileinfo) " -> "
			(eshell-ls-decorated-name
			 (cons (cadr fileinfo) attr)))))))
  fileinfo)

(defun eshell-ls-file (fileinfo &optional size-width copy-fileinfo)
  "Output FILE in long format.
FILE may be a string, or a cons cell whose car is the filename and
whose cdr is the list of file attributes."
  (if (not (cdr fileinfo))
      (funcall error-func (format "%s: No such file or directory\n"
				  (car fileinfo)))
    (setq fileinfo
	  (eshell-ls-annotate (if copy-fileinfo
				  (cons (car fileinfo)
					(cdr fileinfo))
				fileinfo)))
    (let ((file (car fileinfo))
	  (attrs (cdr fileinfo)))
      (if (not (eq listing-style 'long-listing))
	  (if show-size
	      (funcall insert-func (eshell-ls-size-string attrs size-width)
		       " " file "\n")
	    (funcall insert-func file "\n"))
	(let ((line
	       (concat
		(if show-size
		    (concat (eshell-ls-size-string attrs size-width) " "))
		(format
486
		 "%s%4d %-8s %-8s "
Gerd Moellmann's avatar
Gerd Moellmann committed
487 488
		 (or (nth 8 attrs) "??????????")
		 (or (nth 1 attrs) 0)
489 490 491 492 493 494 495
		 (or (let ((user (nth 2 attrs)))
		       (and (not numeric-uid-gid)
			    user
			    (eshell-substring
			     (if (numberp user)
				 (user-login-name user)
			       user) 8)))
Gerd Moellmann's avatar
Gerd Moellmann committed
496 497
		     (nth 2 attrs)
		     "")
498 499 500 501 502 503 504
		 (or (let ((group (nth 3 attrs)))
		       (and (not numeric-uid-gid)
			    group
			    (eshell-substring
			     (if (numberp group)
				 (eshell-group-name group)
			       group) 8)))
Gerd Moellmann's avatar
Gerd Moellmann committed
505 506 507 508
		     (nth 3 attrs)
		     ""))
		(let* ((str (eshell-ls-printable-size (nth 7 attrs)))
		       (len (length str)))
509 510
		  (if (< len (or size-width 4))
		      (concat (make-string (- (or size-width 4) len) ? ) str)
Gerd Moellmann's avatar
Gerd Moellmann committed
511 512
		    str))
		" " (format-time-string
513 514 515 516 517 518 519 520 521 522 523 524 525
		     (concat
		      "%b %e "
		      (if (= (nth 5 (decode-time (current-time)))
			     (nth 5 (decode-time
				     (nth (cond
					   ((eq sort-method 'by-atime) 4)
					   ((eq sort-method 'by-ctime) 6)
					   (t 5)) attrs))))
			  "%H:%M"
			" %Y")) (nth (cond
			((eq sort-method 'by-atime) 4)
			((eq sort-method 'by-ctime) 6)
			(t 5)) attrs)) " ")))
Gerd Moellmann's avatar
Gerd Moellmann committed
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
	  (funcall insert-func line file "\n"))))))

(defun eshell-ls-dir (dirinfo &optional insert-name root-dir size-width)
  "Output the entries in DIRINFO.
If INSERT-NAME is non-nil, the name of DIRINFO will be output.  If
ROOT-DIR is also non-nil, and a directory name, DIRINFO will be output
relative to that directory."
  (let ((dir (car dirinfo)))
    (if (not (cdr dirinfo))
	(funcall error-func (format "%s: No such file or directory\n" dir))
      (if dir-literal
	  (eshell-ls-file dirinfo size-width)
	(if insert-name
	    (funcall insert-func
		     (eshell-ls-decorated-name
		      (cons (concat
			     (if root-dir
				 (file-relative-name dir root-dir)
			       (expand-file-name dir)))
			    (cdr dirinfo))) ":\n"))
John Wiegley's avatar
John Wiegley committed
546
	(let ((entries (eshell-directory-files-and-attributes
547 548 549
			dir nil (and (not show-all)
				     eshell-ls-exclude-hidden
				     "\\`[^.]") t)))
John Wiegley's avatar
John Wiegley committed
550 551 552
	  (when (and (not show-all) eshell-ls-exclude-regexp)
	    (while (and entries (string-match eshell-ls-exclude-regexp
					      (caar entries)))
Gerd Moellmann's avatar
Gerd Moellmann committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
	      (setq entries (cdr entries)))
	    (let ((e entries))
	      (while (cdr e)
		(if (string-match eshell-ls-exclude-regexp (car (cadr e)))
		    (setcdr e (cddr e))
		  (setq e (cdr e))))))
	  (when (or (eq listing-style 'long-listing) show-size)
	    (let ((total 0.0))
	      (setq size-width 0)
	      (eshell-for e entries
		(if (nth 7 (cdr e))
		    (setq total (+ total (nth 7 (cdr e)))
			  size-width
			  (max size-width
			       (length (eshell-ls-printable-size
					(nth 7 (cdr e)) t))))))
	      (funcall insert-func "total "
		       (eshell-ls-printable-size total t) "\n")))
	  (let ((default-directory (expand-file-name dir)))
	    (if show-recursive
		(eshell-ls-entries
		 (let ((e entries) (good-entries (list t)))
		   (while e
		     (unless (let ((len (length (caar e))))
			       (and (eq (aref (caar e) 0) ?.)
				    (or (= len 1)
					(and (= len 2)
					     (eq (aref (caar e) 1) ?.)))))
		       (nconc good-entries (list (car e))))
		     (setq e (cdr e)))
		   (cdr good-entries))
		 nil root-dir)
	      (eshell-ls-files (eshell-ls-sort-entries entries)
			       size-width))))))))

(defsubst eshell-ls-compare-entries (l r inx func)
  "Compare the time of two files, L and R, the attribute indexed by INX."
  (let ((lt (nth inx (cdr l)))
	(rt (nth inx (cdr r))))
    (if (equal lt rt)
	(string-lessp (directory-file-name (car l))
		      (directory-file-name (car r)))
      (funcall func rt lt))))

(defun eshell-ls-sort-entries (entries)
  "Sort the given ENTRIES, which may be files, directories or both.
In Eshell's implementation of ls, ENTRIES is always reversed."
  (if (eq sort-method 'unsorted)
      (nreverse entries)
    (sort entries
	  (function
	   (lambda (l r)
	     (let ((result
		    (cond
		     ((eq sort-method 'by-atime)
John Wiegley's avatar
John Wiegley committed
608
		      (eshell-ls-compare-entries l r 4 'eshell-time-less-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
609
		     ((eq sort-method 'by-mtime)
John Wiegley's avatar
John Wiegley committed
610
		      (eshell-ls-compare-entries l r 5 'eshell-time-less-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
611
		     ((eq sort-method 'by-ctime)
John Wiegley's avatar
John Wiegley committed
612
		      (eshell-ls-compare-entries l r 6 'eshell-time-less-p))
613 614
		     ((eq sort-method 'by-size)
		      (eshell-ls-compare-entries l r 7 '<))
Gerd Moellmann's avatar
Gerd Moellmann committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628
		     ((eq sort-method 'by-extension)
		      (let ((lx (file-name-extension
				 (directory-file-name (car l))))
			    (rx (file-name-extension
				 (directory-file-name (car r)))))
			(cond
			 ((or (and (not lx) (not rx))
			      (equal lx rx))
			  (string-lessp (directory-file-name (car l))
					(directory-file-name (car r))))
			 ((not lx) t)
			 ((not rx) nil)
			 (t
			  (string-lessp lx rx)))))
629
		     (t
630 631
		      (string-lessp (directory-file-name (car l))
				    (directory-file-name (car r)))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
	       (if reverse-list
		   (not result)
		 result)))))))

(defun eshell-ls-files (files &optional size-width copy-fileinfo)
  "Output a list of FILES.
Each member of FILES is either a string or a cons cell of the form
\(FILE .  ATTRS)."
  (if (memq listing-style '(long-listing single-column))
      (eshell-for file files
	(if file
	    (eshell-ls-file file size-width copy-fileinfo)))
    (let ((f files)
	  last-f
	  display-files
	  ignore)
      (while f
	(if (cdar f)
	    (setq last-f f
		  f (cdr f))
	  (unless ignore
	    (funcall error-func
		     (format "%s: No such file or directory\n" (caar f))))
	  (if (eq f files)
	      (setq files (cdr files)
		    f files)
	    (if (not (cdr f))
		(progn
		  (setcdr last-f nil)
		  (setq f nil))
	      (setcar f (cadr f))
	      (setcdr f (cddr f))))))
      (if (not show-size)
	  (setq display-files (mapcar 'eshell-ls-annotate files))
	(eshell-for file files
	  (let* ((str (eshell-ls-printable-size (nth 7 (cdr file)) t))
		 (len (length str)))
	    (if (< len size-width)
		(setq str (concat (make-string (- size-width len) ? ) str)))
	    (setq file (eshell-ls-annotate file)
		  display-files (cons (cons (concat str " " (car file))
					    (cdr file))
				      display-files))))
	(setq display-files (nreverse display-files)))
      (let* ((col-vals
	      (if (eq listing-style 'by-columns)
		  (eshell-ls-find-column-lengths display-files)
		(assert (eq listing-style 'by-lines))
		(eshell-ls-find-column-widths display-files)))
	     (col-widths (car col-vals))
	     (display-files (cdr col-vals))
	     (columns (length col-widths))
	     (col-index 1)
	     need-return)
	(eshell-for file display-files
	  (let ((name
		 (if (car file)
		     (if show-size
			 (concat (substring (car file) 0 size-width)
				 (eshell-ls-decorated-name
				  (cons (substring (car file) size-width)
					(cdr file))))
		       (eshell-ls-decorated-name file))
		   "")))
	    (if (< col-index columns)
		(setq need-return
		      (concat need-return name
			      (make-string
			       (max 0 (- (aref col-widths
					       (1- col-index))
					 (length name))) ? ))
		      col-index (1+ col-index))
	      (funcall insert-func need-return name "\n")
	      (setq col-index 1 need-return nil))))
	(if need-return
	    (funcall insert-func need-return "\n"))))))

(defun eshell-ls-entries (entries &optional separate root-dir)
  "Output PATH's directory ENTRIES, formatted according to OPTIONS.
Each member of ENTRIES may either be a string or a cons cell, the car
of which is the file name, and the cdr of which is the list of
attributes.
If SEPARATE is non-nil, directories name will be entirely separated
from the filenames.  This is the normal behavior, except when doing a
recursive listing.
ROOT-DIR, if non-nil, specifies the root directory of the listing, to
which non-absolute directory names will be made relative if ever they
need to be printed."
  (let (dirs files show-names need-return (size-width 0))
    (eshell-for entry entries
      (if (and (not dir-literal)
	       (or (eshell-ls-filetype-p (cdr entry) ?d)
		   (and (eshell-ls-filetype-p (cdr entry) ?l)
			(file-directory-p (car entry)))))
	  (progn
	    (unless separate
	      (setq files (cons entry files)
		    size-width
		    (if show-size
			(max size-width
			     (length (eshell-ls-printable-size
				      (nth 7 (cdr entry)) t))))))
	    (setq dirs (cons entry dirs)))
	(setq files (cons entry files)
	      size-width
	      (if show-size
		  (max size-width
		       (length (eshell-ls-printable-size
				(nth 7 (cdr entry)) t)))))))
    (when files
      (eshell-ls-files (eshell-ls-sort-entries files)
		       size-width show-recursive)
      (setq need-return t))
    (setq show-names (or show-recursive
			 (> (+ (length files) (length dirs)) 1)))
    (eshell-for dir (eshell-ls-sort-entries dirs)
      (if (and need-return (not dir-literal))
	  (funcall insert-func "\n"))
      (eshell-ls-dir dir show-names
John Wiegley's avatar
John Wiegley committed
751 752
		     (unless (file-name-absolute-p (car dir)) root-dir)
		     size-width)
Gerd Moellmann's avatar
Gerd Moellmann committed
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
      (setq need-return t))))

(defun eshell-ls-find-column-widths (files)
  "Find the best fitting column widths for FILES.
It will be returned as a vector, whose length is the number of columns
to use, and each member of which is the width of that column
\(including spacing)."
  (let* ((numcols 0)
	 (width 0)
	 (widths
	  (mapcar
	   (function
	    (lambda (file)
	      (+ 2 (length (car file)))))
	   files))
	 ;; must account for the added space...
	 (max-width (+ (window-width) 2))
	 (best-width 0)
	 col-widths)

    ;; determine the largest number of columns in the first row
    (let ((w widths))
      (while (and w (< width max-width))
	(setq width (+ width (car w))
	      numcols (1+ numcols)
	      w (cdr w))))

    ;; refine it based on the following rows
    (while (> numcols 0)
      (let ((i 0)
	    (colw (make-vector numcols 0))
	    (w widths))
	(while w
	  (if (= i numcols)
	      (setq i 0))
	  (aset colw i (max (aref colw i) (car w)))
	  (setq w (cdr w) i (1+ i)))
	(setq i 0 width 0)
	(while (< i numcols)
	  (setq width (+ width (aref colw i))
		i (1+ i)))
	(if (and (< width max-width)
		 (> width best-width))
	    (setq col-widths colw
		  best-width width)))
      (setq numcols (1- numcols)))

    (cons (or col-widths (vector max-width)) files)))

(defun eshell-ls-find-column-lengths (files)
  "Find the best fitting column lengths for FILES.
It will be returned as a vector, whose length is the number of columns
to use, and each member of which is the width of that column
\(including spacing)."
  (let* ((numcols 1)
	 (width 0)
	 (widths
	  (mapcar
	   (function
	    (lambda (file)
	      (+ 2 (length (car file)))))
	   files))
	 (max-width (+ (window-width) 2))
	 col-widths
	 colw)

    ;; refine it based on the following rows
    (while numcols
      (let* ((rows (ceiling (/ (length widths)
			       (float numcols))))
	     (w widths)
	     (len (* rows numcols))
	     (index 0)
	     (i 0))
	(setq width 0)
	(unless (or (= rows 0)
		    (<= (/ (length widths) (float rows))
			(float (1- numcols))))
	  (setq colw (make-vector numcols 0))
	  (while (> len 0)
	    (if (= i numcols)
		(setq i 0 index (1+ index)))
	    (aset colw i
		  (max (aref colw i)
		       (or (nth (+ (* i rows) index) w) 0)))
	    (setq len (1- len) i (1+ i)))
	  (setq i 0)
	  (while (< i numcols)
	    (setq width (+ width (aref colw i))
		  i (1+ i))))
	(if (>= width max-width)
	    (setq numcols nil)
	  (if colw
	      (setq col-widths colw))
	  (if (>= numcols (length widths))
	      (setq numcols nil)
	    (setq numcols (1+ numcols))))))

    (if (not col-widths)
	(cons (vector max-width) files)
      (setq numcols (length col-widths))
      (let* ((rows (ceiling (/ (length widths)
			       (float numcols))))
	     (len (* rows numcols))
	     (newfiles (make-list len nil))
	     (index 0)
	     (i 0)
	     (j 0))
	(while (< j len)
	  (if (= i numcols)
	      (setq i 0 index (1+ index)))
	  (setcar (nthcdr j newfiles)
		  (nth (+ (* i rows) index) files))
	  (setq j (1+ j) i (1+ i)))
	(cons col-widths newfiles)))))

(defun eshell-ls-decorated-name (file)
870
  "Return FILE, possibly decorated."
871 872 873 874
  (if eshell-ls-use-colors
      (let ((face
	     (cond
	      ((not (cdr file))
875
	       'eshell-ls-missing)
876 877

	      ((stringp (cadr file))
878
	       'eshell-ls-symlink)
879 880

	      ((eq (cadr file) t)
881
	       'eshell-ls-directory)
882 883

	      ((not (eshell-ls-filetype-p (cdr file) ?-))
884
	       'eshell-ls-special)
885 886 887 888

	      ((and (/= (user-uid) 0) ; root can execute anything
		    (eshell-ls-applicable (cdr file) 3
					  'file-executable-p (car file)))
889
	       'eshell-ls-executable)
890 891 892

	      ((not (eshell-ls-applicable (cdr file) 1
					  'file-readable-p (car file)))
893
	       'eshell-ls-unreadable)
894 895

	      ((string-match eshell-ls-archive-regexp (car file))
896
	       'eshell-ls-archive)
897 898

	      ((string-match eshell-ls-backup-regexp (car file))
899
	       'eshell-ls-backup)
900 901

	      ((string-match eshell-ls-product-regexp (car file))
902
	       'eshell-ls-product)
903 904

	      ((string-match eshell-ls-clutter-regexp (car file))
905
	       'eshell-ls-clutter)
906 907 908

	      ((not (eshell-ls-applicable (cdr file) 2
					  'file-writable-p (car file)))
909
	       'eshell-ls-readonly)
910 911 912 913 914 915 916 917 918 919 920 921 922
	      (eshell-ls-highlight-alist
	       (let ((tests eshell-ls-highlight-alist)
		     value)
		 (while tests
		   (if (funcall (caar tests) (car file) (cdr file))
		       (setq value (cdar tests) tests nil)
		     (setq tests (cdr tests))))
		 value)))))
	(if face
	    (add-text-properties 0 (length (car file))
				 (list 'face face)
				 (car file)))))
  (car file))
Gerd Moellmann's avatar
Gerd Moellmann committed
923

924
(provide 'em-ls)
Gerd Moellmann's avatar
Gerd Moellmann committed
925

926
;; arch-tag: 9295181c-0cb2-499c-999b-89f5359842cb
Gerd Moellmann's avatar
Gerd Moellmann committed
927
;;; em-ls.el ends here