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

3
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2008, 2009, 2010  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
;; This file is part of GNU Emacs.

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

;; 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
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Gerd Moellmann's avatar
Gerd Moellmann committed
22

23 24 25 26
;;; Commentary:

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

28 29
;;; Code:

30 31 32
(eval-when-compile
  (require 'cl)
  (require 'eshell))
33 34
(require 'esh-util)
(require 'esh-opt)
Gerd Moellmann's avatar
Gerd Moellmann committed
35

36 37
;;;###autoload
(eshell-defgroup eshell-ls nil
Gerd Moellmann's avatar
Gerd Moellmann committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
  "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
61 62 63 64 65 66
(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)

67
(defcustom eshell-ls-dired-initial-args nil
68
  "*If non-nil, args is included before any call to `ls' in Dired.
69 70 71 72
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
73
(defcustom eshell-ls-use-in-dired nil
74
  "*If non-nil, use `eshell-ls' to read directories in Dired."
Gerd Moellmann's avatar
Gerd Moellmann committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
  :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
93
(defcustom eshell-ls-exclude-regexp nil
Gerd Moellmann's avatar
Gerd Moellmann committed
94
  "*Unless -a is specified, files matching this regexp will not be shown."
95
  :type '(choice regexp (const nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
96 97
  :group 'eshell-ls)

John Wiegley's avatar
John Wiegley committed
98 99 100 101 102 103 104
(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
105 106 107 108 109
(defcustom eshell-ls-use-colors t
  "*If non-nil, use colors in file listings."
  :type 'boolean
  :group 'eshell-ls)

110
(defface eshell-ls-directory
111 112 113
  '((((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
114 115
  "*The face used for highlight directories."
  :group 'eshell-ls)
116 117
(define-obsolete-face-alias 'eshell-ls-directory-face
  'eshell-ls-directory "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
118

119
(defface eshell-ls-symlink
120 121
  '((((class color) (background light)) (:foreground "Dark Cyan" :weight bold))
    (((class color) (background dark)) (:foreground "Cyan" :weight bold)))
Gerd Moellmann's avatar
Gerd Moellmann committed
122 123
  "*The face used for highlight symbolic links."
  :group 'eshell-ls)
124
(define-obsolete-face-alias 'eshell-ls-symlink-face 'eshell-ls-symlink "22.1")
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
(define-obsolete-face-alias 'eshell-ls-executable-face
  'eshell-ls-executable "22.1")
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
(define-obsolete-face-alias 'eshell-ls-readonly-face 'eshell-ls-readonly "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
140

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

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

156
(defface eshell-ls-missing
157 158
  '((((class color) (background light)) (:foreground "Red" :weight bold))
    (((class color) (background dark)) (:foreground "Red" :weight bold)))
159
  "*The face used for highlighting non-existent file names."
Gerd Moellmann's avatar
Gerd Moellmann committed
160
  :group 'eshell-ls)
161
(define-obsolete-face-alias 'eshell-ls-missing-face 'eshell-ls-missing "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
162 163 164

(defcustom eshell-ls-archive-regexp
  (concat "\\.\\(t\\(a[rz]\\|gz\\)\\|arj\\|lzh\\|"
165
	  "zip\\|[zZ]\\|gz\\|bz2\\|xz\\|deb\\|rpm\\)\\'")
Gerd Moellmann's avatar
Gerd Moellmann committed
166 167 168
  "*A regular expression that matches names of file archives.
This typically includes both traditional archives and compressed
files."
169
  :version "24.1"			; added xz
Gerd Moellmann's avatar
Gerd Moellmann committed
170 171 172
  :type 'regexp
  :group 'eshell-ls)

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

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

186
(defface eshell-ls-backup
Gerd Moellmann's avatar
Gerd Moellmann committed
187 188 189 190
  '((((class color) (background light)) (:foreground "OrangeRed"))
    (((class color) (background dark)) (:foreground "LightSalmon")))
  "*The face used for highlighting backup file names."
  :group 'eshell-ls)
191
(define-obsolete-face-alias 'eshell-ls-backup-face 'eshell-ls-backup "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
192 193

(defcustom eshell-ls-product-regexp
194
  "\\.\\(elc\\|o\\(bj\\)?\\|a\\|lib\\|res\\)\\'"
Gerd Moellmann's avatar
Gerd Moellmann committed
195 196 197 198 199 200
  "*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)

201
(defface eshell-ls-product
Gerd Moellmann's avatar
Gerd Moellmann committed
202 203 204 205
  '((((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)
206
(define-obsolete-face-alias 'eshell-ls-product-face 'eshell-ls-product "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
207 208 209 210 211 212 213 214 215

(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)

216
(defface eshell-ls-clutter
217 218
  '((((class color) (background light)) (:foreground "OrangeRed" :weight bold))
    (((class color) (background dark)) (:foreground "OrangeRed" :weight bold)))
Gerd Moellmann's avatar
Gerd Moellmann committed
219 220
  "*The face used for highlighting junk file names."
  :group 'eshell-ls)
221
(define-obsolete-face-alias 'eshell-ls-clutter-face 'eshell-ls-clutter "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
222 223 224 225 226 227 228

(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)
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
  "Test whether, for ATTRS, the user can do what corresponds to INDEX.
ATTRS is a string of file modes.  See `file-attributes'.
If we cannot determine the answer using ATTRS (e.g., if we need
to know what group the user is in), compute the return value by
calling FUNC with FILE as an argument."
  `(let ((owner (nth 2 ,attrs))
	 (modes (nth 8 ,attrs)))
     (cond ((cond ((numberp owner)
		   (= owner (user-uid)))
		  ((stringp owner)
		   (or (string-equal owner (user-login-name))
		       (member owner (eshell-current-ange-uids)))))
	    ;; The user owns this file.
	    (not (eq (aref modes ,index) ?-)))
	   ((eq (aref modes (+ ,index 3))
		(aref modes (+ ,index 6)))
	    ;; If the "group" and "other" fields give identical
	    ;; results, use that.
	    (not (eq (aref modes (+ ,index 3)) ?-)))
	   (t
	    ;; Otherwise call FUNC.
	    (,(eval func) ,file)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
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 281 282 283 284

(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
285 286
	    eshell-current-subjob-p
	    font-lock-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
287 288 289 290
	;; use the fancy highlighting in `eshell-ls' rather than font-lock
	(when (and eshell-ls-use-colors
		   (featurep 'font-lock))
	  (font-lock-mode -1)
291
	  (setq font-lock-defaults nil)
Gerd Moellmann's avatar
Gerd Moellmann committed
292 293 294 295 296 297
	  (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
298
	      (flush-func 'ignore)
299
	      eshell-ls-dired-initial-args)
Gerd Moellmann's avatar
Gerd Moellmann committed
300 301 302 303 304 305 306 307 308
	  (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)))

309 310
(put 'eshell/ls 'eshell-no-numeric-conversions t)

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
(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)
(defvar sort-method)
(defvar ange-cache)
(defvar dired-flag)
Gerd Moellmann's avatar
Gerd Moellmann committed
328 329 330 331 332 333

(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
334 335 336
   "ls" (if eshell-ls-initial-args
	    (list eshell-ls-initial-args args)
	  args)
337 338
   `((?a "all" nil show-all
	 "show all files in directory")
Gerd Moellmann's avatar
Gerd Moellmann committed
339
     (?c nil by-ctime sort-method
340
	 "sort by last status change time")
Gerd Moellmann's avatar
Gerd Moellmann committed
341 342 343
     (?d "directory" nil dir-literal
	 "list directory entries instead of contents")
     (?k "kilobytes" 1024 block-size
344
	 "using 1024 as the block size")
Gerd Moellmann's avatar
Gerd Moellmann committed
345 346
     (?h "human-readable" 1024 human-readable
	 "print sizes in human readable format")
347 348
     (?H "si" 1000 human-readable
	 "likewise, but use powers of 1000 not 1024")
Gerd Moellmann's avatar
Gerd Moellmann committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362
     (?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")
363 364
     (?x nil by-lines listing-style
	 "list entries by lines instead of by columns")
365 366
     (?C nil by-columns listing-style
	 "list entries by columns")
367
     (?L "dereference" nil dereference-links
368 369 370 371 372 373 374
	 "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
375 376 377 378
     (?X nil by-extension sort-method
	 "sort alphabetically by entry extension")
     (?1 nil single-column listing-style
	 "list one file per line")
379 380
     (nil "dired" nil dired-flag
	  "Here for compatibility with GNU ls.")
Gerd Moellmann's avatar
Gerd Moellmann committed
381
     (nil "help" nil nil
382
	  "show this usage display")
Gerd Moellmann's avatar
Gerd Moellmann committed
383 384 385
     :external "ls"
     :usage "[OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
386
Sort entries alphabetically across.")
Gerd Moellmann's avatar
Gerd Moellmann committed
387 388 389 390 391 392 393
   ;; 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 ".")))
394
   (let ((eshell-ls-exclude-regexp eshell-ls-exclude-regexp) ange-cache)
395
     (when ignore-pattern
Gerd Moellmann's avatar
Gerd Moellmann committed
396 397 398 399
       (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
400 401
       (setq eshell-ls-exclude-regexp
	     (if eshell-ls-exclude-regexp
Gerd Moellmann's avatar
Gerd Moellmann committed
402
		 (concat "\\(" eshell-ls-exclude-regexp "\\|"
John Wiegley's avatar
John Wiegley committed
403 404
			 (eshell-glob-regexp ignore-pattern) "\\)")
	       (eshell-glob-regexp ignore-pattern))))
Gerd Moellmann's avatar
Gerd Moellmann committed
405 406
     ;; list the files!
     (eshell-ls-entries
407 408 409 410 411 412 413
      (mapcar (lambda (arg)
		(cons (if (and (eshell-under-windows-p)
			       (file-name-absolute-p arg))
			  (expand-file-name arg)
			arg)
		      (eshell-file-attributes
		       arg (if numeric-uid-gid 'integer 'string))))
John Wiegley's avatar
John Wiegley committed
414
	      args)
Gerd Moellmann's avatar
Gerd Moellmann committed
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 443 444 445
      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
446
	    (eshell-file-attributes
Gerd Moellmann's avatar
Gerd Moellmann committed
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 486 487 488
	     (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
489 490 491
		 (if numeric-uid-gid
		     "%s%4d %-8s %-8s "
		   "%s%4d %-14s %-8s ")
Gerd Moellmann's avatar
Gerd Moellmann committed
492 493
		 (or (nth 8 attrs) "??????????")
		 (or (nth 1 attrs) 0)
494
		 (or (let ((user (nth 2 attrs)))
495 496
		       (and (stringp user)
			    (eshell-substring user 14)))
Gerd Moellmann's avatar
Gerd Moellmann committed
497 498
		     (nth 2 attrs)
		     "")
499
		 (or (let ((group (nth 3 attrs)))
500 501
		       (and (stringp group)
			    (eshell-substring group 8)))
Gerd Moellmann's avatar
Gerd Moellmann committed
502 503 504 505
		     (nth 3 attrs)
		     ""))
		(let* ((str (eshell-ls-printable-size (nth 7 attrs)))
		       (len (length str)))
506 507 508
		  ;; Let file sizes shorter than 9 align neatly.
		  (if (< len (or size-width 8))
		      (concat (make-string (- (or size-width 8) len) ? ) str)
Gerd Moellmann's avatar
Gerd Moellmann committed
509 510
		    str))
		" " (format-time-string
511 512 513 514 515 516 517 518 519 520 521 522 523
		     (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
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
	  (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
544
	(let ((entries (eshell-directory-files-and-attributes
545 546
			dir nil (and (not show-all)
				     eshell-ls-exclude-hidden
547 548 549 550 551 552
				     "\\`[^.]") t
				     ;; Asking for UID and GID as
				     ;; strings saves another syscall
				     ;; later when we are going to
				     ;; display user and group names.
				     (if numeric-uid-gid 'integer 'string))))
John Wiegley's avatar
John Wiegley committed
553 554 555
	  (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
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
	      (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
571 572 573 574 575
					(nth 7 (cdr e))
					(not
					 ;; If we are under -l, count length
					 ;; of sizes in bytes, not in blocks.
					 (eq listing-style 'long-listing))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
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 608 609 610 611 612 613 614
	      (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
615
		      (eshell-ls-compare-entries l r 4 'eshell-time-less-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
616
		     ((eq sort-method 'by-mtime)
John Wiegley's avatar
John Wiegley committed
617
		      (eshell-ls-compare-entries l r 5 'eshell-time-less-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
618
		     ((eq sort-method 'by-ctime)
John Wiegley's avatar
John Wiegley committed
619
		      (eshell-ls-compare-entries l r 6 'eshell-time-less-p))
620 621
		     ((eq sort-method 'by-size)
		      (eshell-ls-compare-entries l r 7 '<))
Gerd Moellmann's avatar
Gerd Moellmann committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635
		     ((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)))))
636
		     (t
637 638
		      (string-lessp (directory-file-name (car l))
				    (directory-file-name (car r)))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
639 640 641 642 643 644 645 646
	       (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)."
647 648 649 650 651 652 653 654
  ;; Mimic behavior of coreutils ls, which lists a single file per
  ;; line when output is not a tty.  Exceptions: if -x was supplied,
  ;; or if we are the _last_ command in a pipeline.
  ;; FIXME Not really the same since not testing output destination.
  (if (or (and eshell-in-pipeline-p
	       (not (eq eshell-in-pipeline-p 'last))
	       (not (eq listing-style 'by-lines)))
	  (memq listing-style '(long-listing single-column)))
Gerd Moellmann's avatar
Gerd Moellmann committed
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
      (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)
724
  "Output PATH's directory ENTRIES.
Gerd Moellmann's avatar
Gerd Moellmann committed
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 751 752 753 754 755 756 757 758 759 760 761 762 763 764
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
765 766
		     (unless (file-name-absolute-p (car dir)) root-dir)
		     size-width)
Gerd Moellmann's avatar
Gerd Moellmann committed
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 870 871 872 873 874 875 876 877 878 879 880 881 882 883
      (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)
884
  "Return FILE, possibly decorated."
885 886 887 888
  (if eshell-ls-use-colors
      (let ((face
	     (cond
	      ((not (cdr file))
889
	       'eshell-ls-missing)
890 891

	      ((stringp (cadr file))
892
	       'eshell-ls-symlink)
893 894

	      ((eq (cadr file) t)
895
	       'eshell-ls-directory)
896 897

	      ((not (eshell-ls-filetype-p (cdr file) ?-))
898
	       'eshell-ls-special)
899 900 901 902

	      ((and (/= (user-uid) 0) ; root can execute anything
		    (eshell-ls-applicable (cdr file) 3
					  'file-executable-p (car file)))
903
	       'eshell-ls-executable)
904 905 906

	      ((not (eshell-ls-applicable (cdr file) 1
					  'file-readable-p (car file)))
907
	       'eshell-ls-unreadable)
908 909

	      ((string-match eshell-ls-archive-regexp (car file))
910
	       'eshell-ls-archive)
911 912

	      ((string-match eshell-ls-backup-regexp (car file))
913
	       'eshell-ls-backup)
914 915

	      ((string-match eshell-ls-product-regexp (car file))
916
	       'eshell-ls-product)
917 918

	      ((string-match eshell-ls-clutter-regexp (car file))
919
	       'eshell-ls-clutter)
920 921 922

	      ((not (eshell-ls-applicable (cdr file) 2
					  'file-writable-p (car file)))
923
	       'eshell-ls-readonly)
924 925 926 927 928 929 930 931 932 933 934 935 936
	      (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
937

938
(provide 'em-ls)
Gerd Moellmann's avatar
Gerd Moellmann committed
939

940 941 942 943
;; Local Variables:
;; generated-autoload-file: "esh-groups.el"
;; End:

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