em-ls.el 31.4 KB
Newer Older
1
;;; em-ls.el --- implementation of ls in Lisp  -*- lexical-binding:t -*-
Gerd Moellmann's avatar
Gerd Moellmann committed
2

3
;; Copyright (C) 1999-2013 Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
4

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

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

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

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

22 23 24 25
;;; Commentary:

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

27 28
;;; Code:

29
(require 'cl-lib)
30 31
(require 'esh-util)
(require 'esh-opt)
Glenn Morris's avatar
Glenn Morris committed
32
(eval-when-compile (require 'eshell))
Gerd Moellmann's avatar
Gerd Moellmann committed
33

34
;;;###autoload
35 36
(progn
(defgroup eshell-ls nil
Gerd Moellmann's avatar
Gerd Moellmann committed
37 38 39 40 41 42
  "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"
43
  :group 'eshell-module))
Gerd Moellmann's avatar
Gerd Moellmann committed
44 45 46

;;; User Variables:

47 48 49 50
(defcustom eshell-ls-date-format "%Y-%m-%d"
  "How to display time information in `eshell-ls-file'.
This is passed to `format-time-string' as a format string.
To display the date using the current locale, use \"%b \%e\"."
51
  :version "24.1"
52
  :type 'string)
53

John Wiegley's avatar
John Wiegley committed
54
(defcustom eshell-ls-initial-args nil
Glenn Morris's avatar
Glenn Morris committed
55
  "If non-nil, this list of args is included before any call to `ls'.
John Wiegley's avatar
John Wiegley committed
56
This is useful for enabling human-readable format (-h), for example."
57
  :type '(repeat :tag "Arguments" string))
John Wiegley's avatar
John Wiegley committed
58

59
(defcustom eshell-ls-dired-initial-args nil
Glenn Morris's avatar
Glenn Morris committed
60
  "If non-nil, args is included before any call to `ls' in Dired.
61
This is useful for enabling human-readable format (-h), for example."
62
  :type '(repeat :tag "Arguments" string))
63

Gerd Moellmann's avatar
Gerd Moellmann committed
64
(defcustom eshell-ls-use-in-dired nil
65 66
  "If non-nil, use `eshell-ls' to read directories in Dired.
Changing this without using customize has no effect."
Gerd Moellmann's avatar
Gerd Moellmann committed
67 68
  :set (lambda (symbol value)
	 (if value
69 70 71 72 73
             (advice-add 'insert-directory :around
                         #'eshell-ls--insert-directory)
           (advice-remove 'insert-directory
                          #'eshell-ls--insert-directory))
         (set symbol value))
Gerd Moellmann's avatar
Gerd Moellmann committed
74
  :type 'boolean
75 76 77 78 79
  :require 'em-ls)
(add-hook 'eshell-ls-unload-hook
          (lambda () (advice-remove 'insert-directory
                               #'eshell-ls--insert-directory)))

Gerd Moellmann's avatar
Gerd Moellmann committed
80 81

(defcustom eshell-ls-default-blocksize 1024
Glenn Morris's avatar
Glenn Morris committed
82
  "The default blocksize to use when display file sizes with -s."
83
  :type 'integer)
Gerd Moellmann's avatar
Gerd Moellmann committed
84

John Wiegley's avatar
John Wiegley committed
85
(defcustom eshell-ls-exclude-regexp nil
Glenn Morris's avatar
Glenn Morris committed
86
  "Unless -a is specified, files matching this regexp will not be shown."
87
  :type '(choice regexp (const nil)))
Gerd Moellmann's avatar
Gerd Moellmann committed
88

John Wiegley's avatar
John Wiegley committed
89
(defcustom eshell-ls-exclude-hidden t
Glenn Morris's avatar
Glenn Morris committed
90
  "Unless -a is specified, files beginning with . will not be shown.
John Wiegley's avatar
John Wiegley committed
91 92
Using this boolean, instead of `eshell-ls-exclude-regexp', is both
faster and conserves more memory."
93
  :type 'boolean)
John Wiegley's avatar
John Wiegley committed
94

Gerd Moellmann's avatar
Gerd Moellmann committed
95
(defcustom eshell-ls-use-colors t
Glenn Morris's avatar
Glenn Morris committed
96
  "If non-nil, use colors in file listings."
97
  :type 'boolean)
Gerd Moellmann's avatar
Gerd Moellmann committed
98

99
(defface eshell-ls-directory
100 101 102
  '((((class color) (background light)) (:foreground "Blue" :weight bold))
    (((class color) (background dark)) (:foreground "SkyBlue" :weight bold))
    (t (:weight bold)))
103
  "The face used for highlighting directories.")
104 105
(define-obsolete-face-alias 'eshell-ls-directory-face
  'eshell-ls-directory "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
106

107
(defface eshell-ls-symlink
108 109
  '((((class color) (background light)) (:foreground "Dark Cyan" :weight bold))
    (((class color) (background dark)) (:foreground "Cyan" :weight bold)))
110
  "The face used for highlighting symbolic links.")
111
(define-obsolete-face-alias 'eshell-ls-symlink-face 'eshell-ls-symlink "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
112

113
(defface eshell-ls-executable
114 115
  '((((class color) (background light)) (:foreground "ForestGreen" :weight bold))
    (((class color) (background dark)) (:foreground "Green" :weight bold)))
116
  "The face used for highlighting executables (not directories, though).")
117 118
(define-obsolete-face-alias 'eshell-ls-executable-face
  'eshell-ls-executable "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
119

120
(defface eshell-ls-readonly
Gerd Moellmann's avatar
Gerd Moellmann committed
121 122
  '((((class color) (background light)) (:foreground "Brown"))
    (((class color) (background dark)) (:foreground "Pink")))
123
  "The face used for highlighting read-only files.")
124
(define-obsolete-face-alias 'eshell-ls-readonly-face 'eshell-ls-readonly "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
125

126
(defface eshell-ls-unreadable
Gerd Moellmann's avatar
Gerd Moellmann committed
127 128
  '((((class color) (background light)) (:foreground "Grey30"))
    (((class color) (background dark)) (:foreground "DarkGrey")))
129
  "The face used for highlighting unreadable files.")
130 131
(define-obsolete-face-alias 'eshell-ls-unreadable-face
  'eshell-ls-unreadable "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
132

133
(defface eshell-ls-special
134 135
  '((((class color) (background light)) (:foreground "Magenta" :weight bold))
    (((class color) (background dark)) (:foreground "Magenta" :weight bold)))
136
  "The face used for highlighting non-regular files.")
137
(define-obsolete-face-alias 'eshell-ls-special-face 'eshell-ls-special "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
138

139
(defface eshell-ls-missing
140 141
  '((((class color) (background light)) (:foreground "Red" :weight bold))
    (((class color) (background dark)) (:foreground "Red" :weight bold)))
142
  "The face used for highlighting non-existent file names.")
143
(define-obsolete-face-alias 'eshell-ls-missing-face 'eshell-ls-missing "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
144 145 146

(defcustom eshell-ls-archive-regexp
  (concat "\\.\\(t\\(a[rz]\\|gz\\)\\|arj\\|lzh\\|"
147
	  "zip\\|[zZ]\\|gz\\|bz2\\|xz\\|deb\\|rpm\\)\\'")
Glenn Morris's avatar
Glenn Morris committed
148
  "A regular expression that matches names of file archives.
Gerd Moellmann's avatar
Gerd Moellmann committed
149 150
This typically includes both traditional archives and compressed
files."
151
  :version "24.1"			; added xz
152
  :type 'regexp)
Gerd Moellmann's avatar
Gerd Moellmann committed
153

154
(defface eshell-ls-archive
155 156
  '((((class color) (background light)) (:foreground "Orchid" :weight bold))
    (((class color) (background dark)) (:foreground "Orchid" :weight bold)))
157
  "The face used for highlighting archived and compressed file names.")
158
(define-obsolete-face-alias 'eshell-ls-archive-face 'eshell-ls-archive "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
159 160 161

(defcustom eshell-ls-backup-regexp
  "\\(\\`\\.?#\\|\\(\\.bak\\|~\\)\\'\\)"
Glenn Morris's avatar
Glenn Morris committed
162
  "A regular expression that matches names of backup files."
163
  :type 'regexp)
Gerd Moellmann's avatar
Gerd Moellmann committed
164

165
(defface eshell-ls-backup
Gerd Moellmann's avatar
Gerd Moellmann committed
166 167
  '((((class color) (background light)) (:foreground "OrangeRed"))
    (((class color) (background dark)) (:foreground "LightSalmon")))
168
  "The face used for highlighting backup file names.")
169
(define-obsolete-face-alias 'eshell-ls-backup-face 'eshell-ls-backup "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
170 171

(defcustom eshell-ls-product-regexp
172
  "\\.\\(elc\\|o\\(bj\\)?\\|a\\|lib\\|res\\)\\'"
Glenn Morris's avatar
Glenn Morris committed
173
  "A regular expression that matches names of product files.
Gerd Moellmann's avatar
Gerd Moellmann committed
174 175
Products are files that get generated from a source file, and hence
ought to be recreatable if they are deleted."
176
  :type 'regexp)
Gerd Moellmann's avatar
Gerd Moellmann committed
177

178
(defface eshell-ls-product
Gerd Moellmann's avatar
Gerd Moellmann committed
179 180
  '((((class color) (background light)) (:foreground "OrangeRed"))
    (((class color) (background dark)) (:foreground "LightSalmon")))
181
  "The face used for highlighting files that are build products.")
182
(define-obsolete-face-alias 'eshell-ls-product-face 'eshell-ls-product "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
183 184 185

(defcustom eshell-ls-clutter-regexp
  "\\(^texput\\.log\\|^core\\)\\'"
Glenn Morris's avatar
Glenn Morris committed
186
  "A regular expression that matches names of junk files.
Gerd Moellmann's avatar
Gerd Moellmann committed
187 188
These are mainly files that get created for various reasons, but don't
really need to stick around for very long."
189
  :type 'regexp)
Gerd Moellmann's avatar
Gerd Moellmann committed
190

191
(defface eshell-ls-clutter
192 193
  '((((class color) (background light)) (:foreground "OrangeRed" :weight bold))
    (((class color) (background dark)) (:foreground "OrangeRed" :weight bold)))
194
  "The face used for highlighting junk file names.")
195
(define-obsolete-face-alias 'eshell-ls-clutter-face 'eshell-ls-clutter "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
196 197 198 199 200 201 202

(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)
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
  "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
225 226

(defcustom eshell-ls-highlight-alist nil
Glenn Morris's avatar
Glenn Morris committed
227
  "This alist correlates test functions to color.
Gerd Moellmann's avatar
Gerd Moellmann committed
228 229 230 231 232 233 234
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."
235
  :type '(repeat (cons function face)))
Gerd Moellmann's avatar
Gerd Moellmann committed
236

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
(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-almost-all)
(defvar show-recursive)
(defvar show-size)
(defvar sort-method)
(defvar ange-cache)
(defvar dired-flag)

Gerd Moellmann's avatar
Gerd Moellmann committed
256 257
;;; Functions:

258 259
(defun eshell-ls--insert-directory
  (orig-fun file switches &optional wildcard full-directory-p)
Gerd Moellmann's avatar
Gerd Moellmann committed
260 261 262 263 264 265 266 267 268 269
  "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."
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
  (if (not eshell-ls-use-in-dired)
      (funcall orig-fun file switches wildcard full-directory-p)
    (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
              eshell-current-subjob-p
              font-lock-mode)
          ;; use the fancy highlighting in `eshell-ls' rather than font-lock
          (when (and eshell-ls-use-colors
                     (featurep 'font-lock))
            (font-lock-mode -1)
            (setq font-lock-defaults nil)
            (if (boundp 'font-lock-buffers)
                (set 'font-lock-buffers
                     (delq (current-buffer)
                           (symbol-value 'font-lock-buffers)))))
          (let ((insert-func 'insert)
                (error-func 'insert)
                (flush-func 'ignore)
                eshell-ls-dired-initial-args)
            (eshell-do-ls (append switches (list file)))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
295 296 297 298 299 300

(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))
301
    (apply 'eshell-do-ls args)))
Gerd Moellmann's avatar
Gerd Moellmann committed
302

303 304
(put 'eshell/ls 'eshell-no-numeric-conversions t)

Glenn Morris's avatar
Glenn Morris committed
305 306
(declare-function eshell-glob-regexp "em-glob" (pattern))

Gerd Moellmann's avatar
Gerd Moellmann committed
307 308 309
(defun eshell-do-ls (&rest args)
  "Implementation of \"ls\" in Lisp, passing ARGS."
  (funcall flush-func -1)
Aidan Gauland's avatar
Aidan Gauland committed
310
  ;; Process the command arguments, and begin listing files.
Gerd Moellmann's avatar
Gerd Moellmann committed
311
  (eshell-eval-using-options
John Wiegley's avatar
John Wiegley committed
312 313 314
   "ls" (if eshell-ls-initial-args
	    (list eshell-ls-initial-args args)
	  args)
315
   `((?a "all" nil show-all
Aidan Gauland's avatar
Aidan Gauland committed
316 317 318
	 "do not ignore entries starting with .")
     (?A "almost-all" nil show-almost-all
	 "do not list implied . and ..")
Gerd Moellmann's avatar
Gerd Moellmann committed
319
     (?c nil by-ctime sort-method
320
	 "sort by last status change time")
Gerd Moellmann's avatar
Gerd Moellmann committed
321 322 323
     (?d "directory" nil dir-literal
	 "list directory entries instead of contents")
     (?k "kilobytes" 1024 block-size
324
	 "using 1024 as the block size")
Gerd Moellmann's avatar
Gerd Moellmann committed
325 326
     (?h "human-readable" 1024 human-readable
	 "print sizes in human readable format")
327 328
     (?H "si" 1000 human-readable
	 "likewise, but use powers of 1000 not 1024")
Gerd Moellmann's avatar
Gerd Moellmann committed
329 330 331 332 333 334 335 336 337 338 339 340 341 342
     (?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")
343 344
     (?x nil by-lines listing-style
	 "list entries by lines instead of by columns")
345 346
     (?C nil by-columns listing-style
	 "list entries by columns")
347
     (?L "dereference" nil dereference-links
348 349 350 351 352 353 354
	 "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
355 356 357 358
     (?X nil by-extension sort-method
	 "sort alphabetically by entry extension")
     (?1 nil single-column listing-style
	 "list one file per line")
359 360
     (nil "dired" nil dired-flag
	  "Here for compatibility with GNU ls.")
Gerd Moellmann's avatar
Gerd Moellmann committed
361
     (nil "help" nil nil
362
	  "show this usage display")
Gerd Moellmann's avatar
Gerd Moellmann committed
363 364 365
     :external "ls"
     :usage "[OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
366
Sort entries alphabetically across.")
Gerd Moellmann's avatar
Gerd Moellmann committed
367 368 369 370 371 372 373
   ;; 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 ".")))
374
   (let ((eshell-ls-exclude-regexp eshell-ls-exclude-regexp) ange-cache)
375
     (when ignore-pattern
Gerd Moellmann's avatar
Gerd Moellmann committed
376 377 378 379
       (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
380 381
       (setq eshell-ls-exclude-regexp
	     (if eshell-ls-exclude-regexp
Gerd Moellmann's avatar
Gerd Moellmann committed
382
		 (concat "\\(" eshell-ls-exclude-regexp "\\|"
John Wiegley's avatar
John Wiegley committed
383 384
			 (eshell-glob-regexp ignore-pattern) "\\)")
	       (eshell-glob-regexp ignore-pattern))))
Gerd Moellmann's avatar
Gerd Moellmann committed
385 386
     ;; list the files!
     (eshell-ls-entries
387 388 389 390 391 392 393
      (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
394
	      args)
Gerd Moellmann's avatar
Gerd Moellmann committed
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
      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
426
	    (eshell-file-attributes
Gerd Moellmann's avatar
Gerd Moellmann committed
427 428 429 430 431 432 433 434 435 436 437
	     (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)))
438
	(cl-assert (eq listing-style 'long-listing))
Gerd Moellmann's avatar
Gerd Moellmann committed
439 440 441 442 443 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
	(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
469 470 471
		 (if numeric-uid-gid
		     "%s%4d %-8s %-8s "
		   "%s%4d %-14s %-8s ")
Gerd Moellmann's avatar
Gerd Moellmann committed
472 473
		 (or (nth 8 attrs) "??????????")
		 (or (nth 1 attrs) 0)
474
		 (or (let ((user (nth 2 attrs)))
475 476
		       (and (stringp user)
			    (eshell-substring user 14)))
Gerd Moellmann's avatar
Gerd Moellmann committed
477 478
		     (nth 2 attrs)
		     "")
479
		 (or (let ((group (nth 3 attrs)))
480 481
		       (and (stringp group)
			    (eshell-substring group 8)))
Gerd Moellmann's avatar
Gerd Moellmann committed
482 483 484 485
		     (nth 3 attrs)
		     ""))
		(let* ((str (eshell-ls-printable-size (nth 7 attrs)))
		       (len (length str)))
486 487 488
		  ;; 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
489 490
		    str))
		" " (format-time-string
491
		     (concat
492
		      eshell-ls-date-format " "
493 494 495 496 497 498 499 500 501 502 503
		      (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
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
	  (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
524
	(let ((entries (eshell-directory-files-and-attributes
525
			dir nil (and (not (or show-all show-almost-all))
526
				     eshell-ls-exclude-hidden
527 528 529 530 531 532
				     "\\`[^.]") 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))))
Aidan Gauland's avatar
Aidan Gauland committed
533 534 535
          (when (and show-almost-all
                     (not show-all))
            (setq entries
536
                  (cl-remove-if
Aidan Gauland's avatar
Aidan Gauland committed
537
                   (lambda (entry)
538
                     (member (car entry) '("." "..")))
Aidan Gauland's avatar
Aidan Gauland committed
539
                   entries)))
540
	  (when (and (not (or show-all show-almost-all))
Aidan Gauland's avatar
Aidan Gauland committed
541
                     eshell-ls-exclude-regexp)
John Wiegley's avatar
John Wiegley committed
542 543
	    (while (and entries (string-match eshell-ls-exclude-regexp
					      (caar entries)))
Gerd Moellmann's avatar
Gerd Moellmann committed
544 545 546 547 548 549 550 551 552
	      (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)
553
	      (dolist (e entries)
Gerd Moellmann's avatar
Gerd Moellmann committed
554 555 556 557 558
		(if (nth 7 (cdr e))
		    (setq total (+ total (nth 7 (cdr e)))
			  size-width
			  (max size-width
			       (length (eshell-ls-printable-size
559 560 561 562 563
					(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
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
	      (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)
603
		      (eshell-ls-compare-entries l r 4 'time-less-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
604
		     ((eq sort-method 'by-mtime)
605
		      (eshell-ls-compare-entries l r 5 'time-less-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
606
		     ((eq sort-method 'by-ctime)
607
		      (eshell-ls-compare-entries l r 6 'time-less-p))
608 609
		     ((eq sort-method 'by-size)
		      (eshell-ls-compare-entries l r 7 '<))
Gerd Moellmann's avatar
Gerd Moellmann committed
610 611 612 613 614 615 616 617 618 619 620 621 622 623
		     ((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)))))
624
		     (t
625 626
		      (string-lessp (directory-file-name (car l))
				    (directory-file-name (car r)))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
627 628 629 630 631 632 633 634
	       (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)."
635 636 637 638 639 640 641 642
  ;; 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)))
643
      (dolist (file files)
Gerd Moellmann's avatar
Gerd Moellmann committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
	(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))
668
	(dolist (file files)
Gerd Moellmann's avatar
Gerd Moellmann committed
669 670 671 672 673 674 675 676 677 678 679 680
	  (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)
681
		(cl-assert (eq listing-style 'by-lines))
Gerd Moellmann's avatar
Gerd Moellmann committed
682 683 684 685 686 687
		(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)
688
	(dolist (file display-files)
Gerd Moellmann's avatar
Gerd Moellmann committed
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
	  (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)
712
  "Output PATH's directory ENTRIES.
Gerd Moellmann's avatar
Gerd Moellmann committed
713 714 715 716 717 718 719 720 721 722
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))
723
    (dolist (entry entries)
Gerd Moellmann's avatar
Gerd Moellmann committed
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
      (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)))
749
    (dolist (dir (eshell-ls-sort-entries dirs))
Gerd Moellmann's avatar
Gerd Moellmann committed
750 751 752
      (if (and need-return (not dir-literal))
	  (funcall insert-func "\n"))
      (eshell-ls-dir dir show-names
John Wiegley's avatar
John Wiegley committed
753 754
		     (unless (file-name-absolute-p (car dir)) root-dir)
		     size-width)
Gerd Moellmann's avatar
Gerd Moellmann committed
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 870 871
      (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)
872
  "Return FILE, possibly decorated."
873 874 875 876
  (if eshell-ls-use-colors
      (let ((face
	     (cond
	      ((not (cdr file))
877
	       'eshell-ls-missing)
878 879

	      ((stringp (cadr file))
880
	       'eshell-ls-symlink)
881 882

	      ((eq (cadr file) t)
883
	       'eshell-ls-directory)
884 885

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

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

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

	      ((string-match eshell-ls-archive-regexp (car file))
898
	       'eshell-ls-archive)
899 900

	      ((string-match eshell-ls-backup-regexp (car file))
901
	       'eshell-ls-backup)
902 903

	      ((string-match eshell-ls-product-regexp (car file))
904
	       'eshell-ls-product)
905 906

	      ((string-match eshell-ls-clutter-regexp (car file))
907
	       'eshell-ls-clutter)
908 909 910

	      ((not (eshell-ls-applicable (cdr file) 2
					  'file-writable-p (car file)))
911
	       'eshell-ls-readonly)
912 913 914 915 916 917 918 919 920 921 922 923 924
	      (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
925

926
(provide 'em-ls)
Gerd Moellmann's avatar
Gerd Moellmann committed
927

928 929 930 931
;; Local Variables:
;; generated-autoload-file: "esh-groups.el"
;; End:

Gerd Moellmann's avatar
Gerd Moellmann committed
932
;;; em-ls.el ends here