Fix last fix.
[bpt/emacs.git] / lisp / eshell / em-ls.el
CommitLineData
60370d40 1;;; em-ls.el --- implementation of ls in Lisp
affbf647 2
f2e3589a 3;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
8b72699e 4;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
affbf647 5
7de5b421
GM
6;; Author: John Wiegley <johnw@gnu.org>
7
affbf647
GM
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
e0085d62 12;; the Free Software Foundation; either version 3, or (at your option)
affbf647
GM
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
21;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56
LK
22;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23;; Boston, MA 02110-1301, USA.
affbf647 24
dbba8a04
GM
25;;; Commentary:
26
27;; Most of the command switches recognized by GNU's ls utility are
28;; supported ([(fileutils)ls invocation]).
affbf647 29
dbba8a04
GM
30;;; Code:
31
32(eval-when-compile (require 'eshell))
33(require 'esh-util)
34(require 'esh-opt)
affbf647
GM
35
36(defgroup eshell-ls nil
37 "This module implements the \"ls\" utility fully in Lisp. If it is
38passed any unrecognized command switches, it will revert to the
39operating system's version. This version of \"ls\" uses text
40properties to colorize its output based on the setting of
41`eshell-ls-use-colors'."
42 :tag "Implementation of `ls' in Lisp"
43 :group 'eshell-module)
44
affbf647
GM
45;;; User Variables:
46
47(defvar eshell-ls-orig-insert-directory
48 (symbol-function 'insert-directory)
49 "Preserve the original definition of `insert-directory'.")
50
51(defcustom eshell-ls-unload-hook
52 (list
53 (function
54 (lambda ()
55 (fset 'insert-directory eshell-ls-orig-insert-directory))))
56 "*When unloading `eshell-ls', restore the definition of `insert-directory'."
57 :type 'hook
58 :group 'eshell-ls)
59
dace60cf
JW
60(defcustom eshell-ls-initial-args nil
61 "*If non-nil, this list of args is included before any call to `ls'.
62This is useful for enabling human-readable format (-h), for example."
63 :type '(repeat :tag "Arguments" string)
64 :group 'eshell-ls)
65
ef94bd99 66(defcustom eshell-ls-dired-initial-args nil
3eed132b 67 "*If non-nil, args is included before any call to `ls' in Dired.
ef94bd99
JW
68This is useful for enabling human-readable format (-h), for example."
69 :type '(repeat :tag "Arguments" string)
70 :group 'eshell-ls)
71
affbf647 72(defcustom eshell-ls-use-in-dired nil
3eed132b 73 "*If non-nil, use `eshell-ls' to read directories in Dired."
affbf647
GM
74 :set (lambda (symbol value)
75 (if value
76 (unless (and (boundp 'eshell-ls-use-in-dired)
77 eshell-ls-use-in-dired)
78 (fset 'insert-directory 'eshell-ls-insert-directory))
79 (when (and (boundp 'eshell-ls-insert-directory)
80 eshell-ls-use-in-dired)
81 (fset 'insert-directory eshell-ls-orig-insert-directory)))
82 (setq eshell-ls-use-in-dired value))
83 :type 'boolean
84 :require 'em-ls
85 :group 'eshell-ls)
86
87(defcustom eshell-ls-default-blocksize 1024
88 "*The default blocksize to use when display file sizes with -s."
89 :type 'integer
90 :group 'eshell-ls)
91
dace60cf 92(defcustom eshell-ls-exclude-regexp nil
affbf647 93 "*Unless -a is specified, files matching this regexp will not be shown."
762fe76e 94 :type '(choice regexp (const nil))
affbf647
GM
95 :group 'eshell-ls)
96
dace60cf
JW
97(defcustom eshell-ls-exclude-hidden t
98 "*Unless -a is specified, files beginning with . will not be shown.
99Using this boolean, instead of `eshell-ls-exclude-regexp', is both
100faster and conserves more memory."
101 :type 'boolean
102 :group 'eshell-ls)
103
affbf647
GM
104(defcustom eshell-ls-use-colors t
105 "*If non-nil, use colors in file listings."
106 :type 'boolean
107 :group 'eshell-ls)
108
958e6876 109(defface eshell-ls-directory
1fd714a4
RS
110 '((((class color) (background light)) (:foreground "Blue" :weight bold))
111 (((class color) (background dark)) (:foreground "SkyBlue" :weight bold))
112 (t (:weight bold)))
affbf647
GM
113 "*The face used for highlight directories."
114 :group 'eshell-ls)
958e6876
MB
115;; backward-compatibility alias
116(put 'eshell-ls-directory-face 'face-alias 'eshell-ls-directory)
affbf647 117
958e6876 118(defface eshell-ls-symlink
1fd714a4
RS
119 '((((class color) (background light)) (:foreground "Dark Cyan" :weight bold))
120 (((class color) (background dark)) (:foreground "Cyan" :weight bold)))
affbf647
GM
121 "*The face used for highlight symbolic links."
122 :group 'eshell-ls)
958e6876
MB
123;; backward-compatibility alias
124(put 'eshell-ls-symlink-face 'face-alias 'eshell-ls-symlink)
affbf647 125
958e6876 126(defface eshell-ls-executable
1fd714a4
RS
127 '((((class color) (background light)) (:foreground "ForestGreen" :weight bold))
128 (((class color) (background dark)) (:foreground "Green" :weight bold)))
affbf647
GM
129 "*The face used for highlighting executables (not directories, though)."
130 :group 'eshell-ls)
958e6876
MB
131;; backward-compatibility alias
132(put 'eshell-ls-executable-face 'face-alias 'eshell-ls-executable)
affbf647 133
958e6876 134(defface eshell-ls-readonly
affbf647
GM
135 '((((class color) (background light)) (:foreground "Brown"))
136 (((class color) (background dark)) (:foreground "Pink")))
137 "*The face used for highlighting read-only files."
138 :group 'eshell-ls)
958e6876
MB
139;; backward-compatibility alias
140(put 'eshell-ls-readonly-face 'face-alias 'eshell-ls-readonly)
affbf647 141
958e6876 142(defface eshell-ls-unreadable
affbf647
GM
143 '((((class color) (background light)) (:foreground "Grey30"))
144 (((class color) (background dark)) (:foreground "DarkGrey")))
145 "*The face used for highlighting unreadable files."
146 :group 'eshell-ls)
958e6876
MB
147;; backward-compatibility alias
148(put 'eshell-ls-unreadable-face 'face-alias 'eshell-ls-unreadable)
affbf647 149
958e6876 150(defface eshell-ls-special
1fd714a4
RS
151 '((((class color) (background light)) (:foreground "Magenta" :weight bold))
152 (((class color) (background dark)) (:foreground "Magenta" :weight bold)))
affbf647
GM
153 "*The face used for highlighting non-regular files."
154 :group 'eshell-ls)
958e6876
MB
155;; backward-compatibility alias
156(put 'eshell-ls-special-face 'face-alias 'eshell-ls-special)
affbf647 157
958e6876 158(defface eshell-ls-missing
1fd714a4
RS
159 '((((class color) (background light)) (:foreground "Red" :weight bold))
160 (((class color) (background dark)) (:foreground "Red" :weight bold)))
3eed132b 161 "*The face used for highlighting non-existent file names."
affbf647 162 :group 'eshell-ls)
958e6876
MB
163;; backward-compatibility alias
164(put 'eshell-ls-missing-face 'face-alias 'eshell-ls-missing)
affbf647
GM
165
166(defcustom eshell-ls-archive-regexp
167 (concat "\\.\\(t\\(a[rz]\\|gz\\)\\|arj\\|lzh\\|"
168 "zip\\|[zZ]\\|gz\\|bz2\\|deb\\|rpm\\)\\'")
169 "*A regular expression that matches names of file archives.
170This typically includes both traditional archives and compressed
171files."
172 :type 'regexp
173 :group 'eshell-ls)
174
958e6876 175(defface eshell-ls-archive
1fd714a4
RS
176 '((((class color) (background light)) (:foreground "Orchid" :weight bold))
177 (((class color) (background dark)) (:foreground "Orchid" :weight bold)))
affbf647
GM
178 "*The face used for highlighting archived and compressed file names."
179 :group 'eshell-ls)
958e6876
MB
180;; backward-compatibility alias
181(put 'eshell-ls-archive-face 'face-alias 'eshell-ls-archive)
affbf647
GM
182
183(defcustom eshell-ls-backup-regexp
184 "\\(\\`\\.?#\\|\\(\\.bak\\|~\\)\\'\\)"
185 "*A regular expression that matches names of backup files."
186 :type 'regexp
187 :group 'eshell-ls)
188
958e6876 189(defface eshell-ls-backup
affbf647
GM
190 '((((class color) (background light)) (:foreground "OrangeRed"))
191 (((class color) (background dark)) (:foreground "LightSalmon")))
192 "*The face used for highlighting backup file names."
193 :group 'eshell-ls)
958e6876
MB
194;; backward-compatibility alias
195(put 'eshell-ls-backup-face 'face-alias 'eshell-ls-backup)
affbf647
GM
196
197(defcustom eshell-ls-product-regexp
087f110d 198 "\\.\\(elc\\|o\\(bj\\)?\\|a\\|lib\\|res\\)\\'"
affbf647
GM
199 "*A regular expression that matches names of product files.
200Products are files that get generated from a source file, and hence
201ought to be recreatable if they are deleted."
202 :type 'regexp
203 :group 'eshell-ls)
204
958e6876 205(defface eshell-ls-product
affbf647
GM
206 '((((class color) (background light)) (:foreground "OrangeRed"))
207 (((class color) (background dark)) (:foreground "LightSalmon")))
208 "*The face used for highlighting files that are build products."
209 :group 'eshell-ls)
958e6876
MB
210;; backward-compatibility alias
211(put 'eshell-ls-product-face 'face-alias 'eshell-ls-product)
affbf647
GM
212
213(defcustom eshell-ls-clutter-regexp
214 "\\(^texput\\.log\\|^core\\)\\'"
215 "*A regular expression that matches names of junk files.
216These are mainly files that get created for various reasons, but don't
217really need to stick around for very long."
218 :type 'regexp
219 :group 'eshell-ls)
220
958e6876 221(defface eshell-ls-clutter
1fd714a4
RS
222 '((((class color) (background light)) (:foreground "OrangeRed" :weight bold))
223 (((class color) (background dark)) (:foreground "OrangeRed" :weight bold)))
affbf647
GM
224 "*The face used for highlighting junk file names."
225 :group 'eshell-ls)
958e6876
MB
226;; backward-compatibility alias
227(put 'eshell-ls-clutter-face 'face-alias 'eshell-ls-clutter)
affbf647
GM
228
229(defsubst eshell-ls-filetype-p (attrs type)
230 "Test whether ATTRS specifies a directory."
231 (if (nth 8 attrs)
232 (eq (aref (nth 8 attrs) 0) type)))
233
234(defmacro eshell-ls-applicable (attrs index func file)
235 "Test whether, for ATTRS, the user UID can do what corresponds to INDEX.
236This is really just for efficiency, to avoid having to stat the file
237yet again."
8c6b1d83
JW
238 `(if (numberp (nth 2 ,attrs))
239 (if (= (user-uid) (nth 2 ,attrs))
dace60cf
JW
240 (not (eq (aref (nth 8 ,attrs) ,index) ?-))
241 (,(eval func) ,file))
8c6b1d83 242 (not (eq (aref (nth 8 ,attrs)
dace60cf
JW
243 (+ ,index (if (member (nth 2 ,attrs)
244 (eshell-current-ange-uids))
245 0 6)))
246 ?-))))
affbf647
GM
247
248(defcustom eshell-ls-highlight-alist nil
249 "*This alist correlates test functions to color.
250The format of the members of this alist is
251
252 (TEST-SEXP . FACE)
253
254If TEST-SEXP evals to non-nil, that face will be used to highlight the
255name of the file. The first match wins. `file' and `attrs' are in
256scope during the evaluation of TEST-SEXP."
257 :type '(repeat (cons function face))
258 :group 'eshell-ls)
259
260;;; Functions:
261
262(defun eshell-ls-insert-directory
263 (file switches &optional wildcard full-directory-p)
264 "Insert directory listing for FILE, formatted according to SWITCHES.
265Leaves point after the inserted text.
266SWITCHES may be a string of options, or a list of strings.
267Optional third arg WILDCARD means treat FILE as shell wildcard.
268Optional fourth arg FULL-DIRECTORY-P means file is a directory and
269switches do not contain `d', so that a full listing is expected.
270
271This version of the function uses `eshell/ls'. If any of the switches
272passed are not recognized, the operating system's version will be used
273instead."
274 (let ((handler (find-file-name-handler file 'insert-directory)))
275 (if handler
276 (funcall handler 'insert-directory file switches
277 wildcard full-directory-p)
278 (if (stringp switches)
279 (setq switches (split-string switches)))
280 (let (eshell-current-handles
73f99a66
JW
281 eshell-current-subjob-p
282 font-lock-mode)
affbf647
GM
283 ;; use the fancy highlighting in `eshell-ls' rather than font-lock
284 (when (and eshell-ls-use-colors
285 (featurep 'font-lock))
286 (font-lock-mode -1)
6c9e58c4 287 (setq font-lock-defaults nil)
affbf647
GM
288 (if (boundp 'font-lock-buffers)
289 (set 'font-lock-buffers
290 (delq (current-buffer)
291 (symbol-value 'font-lock-buffers)))))
292 (let ((insert-func 'insert)
293 (error-func 'insert)
dace60cf 294 (flush-func 'ignore)
ef94bd99 295 eshell-ls-dired-initial-args)
affbf647
GM
296 (eshell-do-ls (append switches (list file))))))))
297
298(defsubst eshell/ls (&rest args)
299 "An alias version of `eshell-do-ls'."
300 (let ((insert-func 'eshell-buffered-print)
301 (error-func 'eshell-error)
302 (flush-func 'eshell-flush))
303 (eshell-do-ls args)))
304
127fd3c2
JW
305(put 'eshell/ls 'eshell-no-numeric-conversions t)
306
affbf647
GM
307(eval-when-compile
308 (defvar block-size)
309 (defvar dereference-links)
310 (defvar dir-literal)
311 (defvar error-func)
312 (defvar flush-func)
313 (defvar human-readable)
314 (defvar ignore-pattern)
315 (defvar insert-func)
316 (defvar listing-style)
317 (defvar numeric-uid-gid)
318 (defvar reverse-list)
319 (defvar show-all)
320 (defvar show-recursive)
321 (defvar show-size)
8c6b1d83 322 (defvar sort-method)
73f99a66
JW
323 (defvar ange-cache)
324 (defvar dired-flag))
affbf647
GM
325
326(defun eshell-do-ls (&rest args)
327 "Implementation of \"ls\" in Lisp, passing ARGS."
328 (funcall flush-func -1)
329 ;; process the command arguments, and begin listing files
330 (eshell-eval-using-options
dace60cf
JW
331 "ls" (if eshell-ls-initial-args
332 (list eshell-ls-initial-args args)
333 args)
7f09df7a
JW
334 `((?a "all" nil show-all
335 "show all files in directory")
affbf647 336 (?c nil by-ctime sort-method
73f99a66 337 "sort by last status change time")
affbf647
GM
338 (?d "directory" nil dir-literal
339 "list directory entries instead of contents")
340 (?k "kilobytes" 1024 block-size
7f09df7a 341 "using 1024 as the block size")
affbf647
GM
342 (?h "human-readable" 1024 human-readable
343 "print sizes in human readable format")
7f09df7a
JW
344 (?H "si" 1000 human-readable
345 "likewise, but use powers of 1000 not 1024")
affbf647
GM
346 (?I "ignore" t ignore-pattern
347 "do not list implied entries matching pattern")
348 (?l nil long-listing listing-style
349 "use a long listing format")
350 (?n "numeric-uid-gid" nil numeric-uid-gid
351 "list numeric UIDs and GIDs instead of names")
352 (?r "reverse" nil reverse-list
353 "reverse order while sorting")
354 (?s "size" nil show-size
355 "print size of each file, in blocks")
356 (?t nil by-mtime sort-method
357 "sort by modification time")
358 (?u nil by-atime sort-method
359 "sort by last access time")
70a06174
JW
360 (?x nil by-lines listing-style
361 "list entries by lines instead of by columns")
7f09df7a
JW
362 (?C nil by-columns listing-style
363 "list entries by columns")
364 (?L "deference" nil dereference-links
365 "list entries pointed to by symbolic links")
366 (?R "recursive" nil show-recursive
367 "list subdirectories recursively")
368 (?S nil by-size sort-method
369 "sort by file size")
370 (?U nil unsorted sort-method
371 "do not sort; list entries in directory order")
affbf647
GM
372 (?X nil by-extension sort-method
373 "sort alphabetically by entry extension")
374 (?1 nil single-column listing-style
375 "list one file per line")
73f99a66
JW
376 (nil "dired" nil dired-flag
377 "Here for compatibility with GNU ls.")
affbf647 378 (nil "help" nil nil
7f09df7a 379 "show this usage display")
affbf647
GM
380 :external "ls"
381 :usage "[OPTION]... [FILE]...
382List information about the FILEs (the current directory by default).
7f09df7a 383Sort entries alphabetically across.")
affbf647
GM
384 ;; setup some defaults, based on what the user selected
385 (unless block-size
386 (setq block-size eshell-ls-default-blocksize))
387 (unless listing-style
388 (setq listing-style 'by-columns))
389 (unless args
390 (setq args (list ".")))
8c6b1d83 391 (let ((eshell-ls-exclude-regexp eshell-ls-exclude-regexp) ange-cache)
7f09df7a 392 (when ignore-pattern
affbf647
GM
393 (unless (eshell-using-module 'eshell-glob)
394 (error (concat "-I option requires that `eshell-glob'"
395 " be a member of `eshell-modules-list'")))
396 (set-text-properties 0 (length ignore-pattern) nil ignore-pattern)
dace60cf
JW
397 (setq eshell-ls-exclude-regexp
398 (if eshell-ls-exclude-regexp
affbf647 399 (concat "\\(" eshell-ls-exclude-regexp "\\|"
dace60cf
JW
400 (eshell-glob-regexp ignore-pattern) "\\)")
401 (eshell-glob-regexp ignore-pattern))))
affbf647
GM
402 ;; list the files!
403 (eshell-ls-entries
404 (mapcar (function
405 (lambda (arg)
406 (cons (if (and (eshell-under-windows-p)
407 (file-name-absolute-p arg))
408 (expand-file-name arg)
409 arg)
dace60cf
JW
410 (eshell-file-attributes arg))))
411 args)
affbf647
GM
412 t (expand-file-name default-directory)))
413 (funcall flush-func)))
414
415(defsubst eshell-ls-printable-size (filesize &optional by-blocksize)
416 "Return a printable FILESIZE."
417 (eshell-printable-size filesize human-readable
418 (and by-blocksize block-size)
419 eshell-ls-use-colors))
420
421(defsubst eshell-ls-size-string (attrs size-width)
422 "Return the size string for ATTRS length, using SIZE-WIDTH."
423 (let* ((str (eshell-ls-printable-size (nth 7 attrs) t))
424 (len (length str)))
425 (if (< len size-width)
426 (concat (make-string (- size-width len) ? ) str)
427 str)))
428
429(defun eshell-ls-annotate (fileinfo)
430 "Given a FILEINFO object, return a resolved, decorated FILEINFO.
431This means resolving any symbolic links, determining what face the
432name should be displayed as, etc. Think of it as cooking a FILEINFO."
433 (if (not (and (stringp (cadr fileinfo))
434 (or dereference-links
435 (eq listing-style 'long-listing))))
436 (setcar fileinfo (eshell-ls-decorated-name fileinfo))
437 (let (dir attr)
438 (unless (file-name-absolute-p (cadr fileinfo))
439 (setq dir (file-truename
440 (file-name-directory
441 (expand-file-name (car fileinfo))))))
442 (setq attr
8c6b1d83 443 (eshell-file-attributes
affbf647
GM
444 (let ((target (if dir
445 (expand-file-name (cadr fileinfo) dir)
446 (cadr fileinfo))))
447 (if dereference-links
448 (file-truename target)
449 target))))
450 (if (or dereference-links
451 (string-match "^\\.\\.?$" (car fileinfo)))
452 (progn
453 (setcdr fileinfo attr)
454 (setcar fileinfo (eshell-ls-decorated-name fileinfo)))
455 (assert (eq listing-style 'long-listing))
456 (setcar fileinfo
457 (concat (eshell-ls-decorated-name fileinfo) " -> "
458 (eshell-ls-decorated-name
459 (cons (cadr fileinfo) attr)))))))
460 fileinfo)
461
462(defun eshell-ls-file (fileinfo &optional size-width copy-fileinfo)
463 "Output FILE in long format.
464FILE may be a string, or a cons cell whose car is the filename and
465whose cdr is the list of file attributes."
466 (if (not (cdr fileinfo))
467 (funcall error-func (format "%s: No such file or directory\n"
468 (car fileinfo)))
469 (setq fileinfo
470 (eshell-ls-annotate (if copy-fileinfo
471 (cons (car fileinfo)
472 (cdr fileinfo))
473 fileinfo)))
474 (let ((file (car fileinfo))
475 (attrs (cdr fileinfo)))
476 (if (not (eq listing-style 'long-listing))
477 (if show-size
478 (funcall insert-func (eshell-ls-size-string attrs size-width)
479 " " file "\n")
480 (funcall insert-func file "\n"))
481 (let ((line
482 (concat
483 (if show-size
484 (concat (eshell-ls-size-string attrs size-width) " "))
485 (format
7f09df7a 486 "%s%4d %-8s %-8s "
affbf647
GM
487 (or (nth 8 attrs) "??????????")
488 (or (nth 1 attrs) 0)
8c6b1d83
JW
489 (or (let ((user (nth 2 attrs)))
490 (and (not numeric-uid-gid)
491 user
492 (eshell-substring
493 (if (numberp user)
494 (user-login-name user)
495 user) 8)))
affbf647
GM
496 (nth 2 attrs)
497 "")
8c6b1d83
JW
498 (or (let ((group (nth 3 attrs)))
499 (and (not numeric-uid-gid)
500 group
501 (eshell-substring
502 (if (numberp group)
503 (eshell-group-name group)
504 group) 8)))
affbf647
GM
505 (nth 3 attrs)
506 ""))
507 (let* ((str (eshell-ls-printable-size (nth 7 attrs)))
508 (len (length str)))
572ccdc0
JW
509 (if (< len (or size-width 4))
510 (concat (make-string (- (or size-width 4) len) ? ) str)
affbf647
GM
511 str))
512 " " (format-time-string
7f09df7a
JW
513 (concat
514 "%b %e "
515 (if (= (nth 5 (decode-time (current-time)))
516 (nth 5 (decode-time
517 (nth (cond
518 ((eq sort-method 'by-atime) 4)
519 ((eq sort-method 'by-ctime) 6)
520 (t 5)) attrs))))
521 "%H:%M"
522 " %Y")) (nth (cond
523 ((eq sort-method 'by-atime) 4)
524 ((eq sort-method 'by-ctime) 6)
525 (t 5)) attrs)) " ")))
affbf647
GM
526 (funcall insert-func line file "\n"))))))
527
528(defun eshell-ls-dir (dirinfo &optional insert-name root-dir size-width)
529 "Output the entries in DIRINFO.
530If INSERT-NAME is non-nil, the name of DIRINFO will be output. If
531ROOT-DIR is also non-nil, and a directory name, DIRINFO will be output
532relative to that directory."
533 (let ((dir (car dirinfo)))
534 (if (not (cdr dirinfo))
535 (funcall error-func (format "%s: No such file or directory\n" dir))
536 (if dir-literal
537 (eshell-ls-file dirinfo size-width)
538 (if insert-name
539 (funcall insert-func
540 (eshell-ls-decorated-name
541 (cons (concat
542 (if root-dir
543 (file-relative-name dir root-dir)
544 (expand-file-name dir)))
545 (cdr dirinfo))) ":\n"))
dace60cf 546 (let ((entries (eshell-directory-files-and-attributes
7f09df7a
JW
547 dir nil (and (not show-all)
548 eshell-ls-exclude-hidden
549 "\\`[^.]") t)))
dace60cf
JW
550 (when (and (not show-all) eshell-ls-exclude-regexp)
551 (while (and entries (string-match eshell-ls-exclude-regexp
552 (caar entries)))
affbf647
GM
553 (setq entries (cdr entries)))
554 (let ((e entries))
555 (while (cdr e)
556 (if (string-match eshell-ls-exclude-regexp (car (cadr e)))
557 (setcdr e (cddr e))
558 (setq e (cdr e))))))
559 (when (or (eq listing-style 'long-listing) show-size)
560 (let ((total 0.0))
561 (setq size-width 0)
562 (eshell-for e entries
563 (if (nth 7 (cdr e))
564 (setq total (+ total (nth 7 (cdr e)))
565 size-width
566 (max size-width
567 (length (eshell-ls-printable-size
568 (nth 7 (cdr e)) t))))))
569 (funcall insert-func "total "
570 (eshell-ls-printable-size total t) "\n")))
571 (let ((default-directory (expand-file-name dir)))
572 (if show-recursive
573 (eshell-ls-entries
574 (let ((e entries) (good-entries (list t)))
575 (while e
576 (unless (let ((len (length (caar e))))
577 (and (eq (aref (caar e) 0) ?.)
578 (or (= len 1)
579 (and (= len 2)
580 (eq (aref (caar e) 1) ?.)))))
581 (nconc good-entries (list (car e))))
582 (setq e (cdr e)))
583 (cdr good-entries))
584 nil root-dir)
585 (eshell-ls-files (eshell-ls-sort-entries entries)
586 size-width))))))))
587
588(defsubst eshell-ls-compare-entries (l r inx func)
589 "Compare the time of two files, L and R, the attribute indexed by INX."
590 (let ((lt (nth inx (cdr l)))
591 (rt (nth inx (cdr r))))
592 (if (equal lt rt)
593 (string-lessp (directory-file-name (car l))
594 (directory-file-name (car r)))
595 (funcall func rt lt))))
596
597(defun eshell-ls-sort-entries (entries)
598 "Sort the given ENTRIES, which may be files, directories or both.
599In Eshell's implementation of ls, ENTRIES is always reversed."
600 (if (eq sort-method 'unsorted)
601 (nreverse entries)
602 (sort entries
603 (function
604 (lambda (l r)
605 (let ((result
606 (cond
607 ((eq sort-method 'by-atime)
dace60cf 608 (eshell-ls-compare-entries l r 4 'eshell-time-less-p))
affbf647 609 ((eq sort-method 'by-mtime)
dace60cf 610 (eshell-ls-compare-entries l r 5 'eshell-time-less-p))
affbf647 611 ((eq sort-method 'by-ctime)
dace60cf 612 (eshell-ls-compare-entries l r 6 'eshell-time-less-p))
7f09df7a
JW
613 ((eq sort-method 'by-size)
614 (eshell-ls-compare-entries l r 7 '<))
affbf647
GM
615 ((eq sort-method 'by-extension)
616 (let ((lx (file-name-extension
617 (directory-file-name (car l))))
618 (rx (file-name-extension
619 (directory-file-name (car r)))))
620 (cond
621 ((or (and (not lx) (not rx))
622 (equal lx rx))
623 (string-lessp (directory-file-name (car l))
624 (directory-file-name (car r))))
625 ((not lx) t)
626 ((not rx) nil)
627 (t
628 (string-lessp lx rx)))))
70a06174 629 (t
7f09df7a
JW
630 (string-lessp (directory-file-name (car l))
631 (directory-file-name (car r)))))))
affbf647
GM
632 (if reverse-list
633 (not result)
634 result)))))))
635
636(defun eshell-ls-files (files &optional size-width copy-fileinfo)
637 "Output a list of FILES.
638Each member of FILES is either a string or a cons cell of the form
639\(FILE . ATTRS)."
640 (if (memq listing-style '(long-listing single-column))
641 (eshell-for file files
642 (if file
643 (eshell-ls-file file size-width copy-fileinfo)))
644 (let ((f files)
645 last-f
646 display-files
647 ignore)
648 (while f
649 (if (cdar f)
650 (setq last-f f
651 f (cdr f))
652 (unless ignore
653 (funcall error-func
654 (format "%s: No such file or directory\n" (caar f))))
655 (if (eq f files)
656 (setq files (cdr files)
657 f files)
658 (if (not (cdr f))
659 (progn
660 (setcdr last-f nil)
661 (setq f nil))
662 (setcar f (cadr f))
663 (setcdr f (cddr f))))))
664 (if (not show-size)
665 (setq display-files (mapcar 'eshell-ls-annotate files))
666 (eshell-for file files
667 (let* ((str (eshell-ls-printable-size (nth 7 (cdr file)) t))
668 (len (length str)))
669 (if (< len size-width)
670 (setq str (concat (make-string (- size-width len) ? ) str)))
671 (setq file (eshell-ls-annotate file)
672 display-files (cons (cons (concat str " " (car file))
673 (cdr file))
674 display-files))))
675 (setq display-files (nreverse display-files)))
676 (let* ((col-vals
677 (if (eq listing-style 'by-columns)
678 (eshell-ls-find-column-lengths display-files)
679 (assert (eq listing-style 'by-lines))
680 (eshell-ls-find-column-widths display-files)))
681 (col-widths (car col-vals))
682 (display-files (cdr col-vals))
683 (columns (length col-widths))
684 (col-index 1)
685 need-return)
686 (eshell-for file display-files
687 (let ((name
688 (if (car file)
689 (if show-size
690 (concat (substring (car file) 0 size-width)
691 (eshell-ls-decorated-name
692 (cons (substring (car file) size-width)
693 (cdr file))))
694 (eshell-ls-decorated-name file))
695 "")))
696 (if (< col-index columns)
697 (setq need-return
698 (concat need-return name
699 (make-string
700 (max 0 (- (aref col-widths
701 (1- col-index))
702 (length name))) ? ))
703 col-index (1+ col-index))
704 (funcall insert-func need-return name "\n")
705 (setq col-index 1 need-return nil))))
706 (if need-return
707 (funcall insert-func need-return "\n"))))))
708
709(defun eshell-ls-entries (entries &optional separate root-dir)
710 "Output PATH's directory ENTRIES, formatted according to OPTIONS.
711Each member of ENTRIES may either be a string or a cons cell, the car
712of which is the file name, and the cdr of which is the list of
713attributes.
714If SEPARATE is non-nil, directories name will be entirely separated
715from the filenames. This is the normal behavior, except when doing a
716recursive listing.
717ROOT-DIR, if non-nil, specifies the root directory of the listing, to
718which non-absolute directory names will be made relative if ever they
719need to be printed."
720 (let (dirs files show-names need-return (size-width 0))
721 (eshell-for entry entries
722 (if (and (not dir-literal)
723 (or (eshell-ls-filetype-p (cdr entry) ?d)
724 (and (eshell-ls-filetype-p (cdr entry) ?l)
725 (file-directory-p (car entry)))))
726 (progn
727 (unless separate
728 (setq files (cons entry files)
729 size-width
730 (if show-size
731 (max size-width
732 (length (eshell-ls-printable-size
733 (nth 7 (cdr entry)) t))))))
734 (setq dirs (cons entry dirs)))
735 (setq files (cons entry files)
736 size-width
737 (if show-size
738 (max size-width
739 (length (eshell-ls-printable-size
740 (nth 7 (cdr entry)) t)))))))
741 (when files
742 (eshell-ls-files (eshell-ls-sort-entries files)
743 size-width show-recursive)
744 (setq need-return t))
745 (setq show-names (or show-recursive
746 (> (+ (length files) (length dirs)) 1)))
747 (eshell-for dir (eshell-ls-sort-entries dirs)
748 (if (and need-return (not dir-literal))
749 (funcall insert-func "\n"))
750 (eshell-ls-dir dir show-names
dace60cf
JW
751 (unless (file-name-absolute-p (car dir)) root-dir)
752 size-width)
affbf647
GM
753 (setq need-return t))))
754
755(defun eshell-ls-find-column-widths (files)
756 "Find the best fitting column widths for FILES.
757It will be returned as a vector, whose length is the number of columns
758to use, and each member of which is the width of that column
759\(including spacing)."
760 (let* ((numcols 0)
761 (width 0)
762 (widths
763 (mapcar
764 (function
765 (lambda (file)
766 (+ 2 (length (car file)))))
767 files))
768 ;; must account for the added space...
769 (max-width (+ (window-width) 2))
770 (best-width 0)
771 col-widths)
772
773 ;; determine the largest number of columns in the first row
774 (let ((w widths))
775 (while (and w (< width max-width))
776 (setq width (+ width (car w))
777 numcols (1+ numcols)
778 w (cdr w))))
779
780 ;; refine it based on the following rows
781 (while (> numcols 0)
782 (let ((i 0)
783 (colw (make-vector numcols 0))
784 (w widths))
785 (while w
786 (if (= i numcols)
787 (setq i 0))
788 (aset colw i (max (aref colw i) (car w)))
789 (setq w (cdr w) i (1+ i)))
790 (setq i 0 width 0)
791 (while (< i numcols)
792 (setq width (+ width (aref colw i))
793 i (1+ i)))
794 (if (and (< width max-width)
795 (> width best-width))
796 (setq col-widths colw
797 best-width width)))
798 (setq numcols (1- numcols)))
799
800 (cons (or col-widths (vector max-width)) files)))
801
802(defun eshell-ls-find-column-lengths (files)
803 "Find the best fitting column lengths for FILES.
804It will be returned as a vector, whose length is the number of columns
805to use, and each member of which is the width of that column
806\(including spacing)."
807 (let* ((numcols 1)
808 (width 0)
809 (widths
810 (mapcar
811 (function
812 (lambda (file)
813 (+ 2 (length (car file)))))
814 files))
815 (max-width (+ (window-width) 2))
816 col-widths
817 colw)
818
819 ;; refine it based on the following rows
820 (while numcols
821 (let* ((rows (ceiling (/ (length widths)
822 (float numcols))))
823 (w widths)
824 (len (* rows numcols))
825 (index 0)
826 (i 0))
827 (setq width 0)
828 (unless (or (= rows 0)
829 (<= (/ (length widths) (float rows))
830 (float (1- numcols))))
831 (setq colw (make-vector numcols 0))
832 (while (> len 0)
833 (if (= i numcols)
834 (setq i 0 index (1+ index)))
835 (aset colw i
836 (max (aref colw i)
837 (or (nth (+ (* i rows) index) w) 0)))
838 (setq len (1- len) i (1+ i)))
839 (setq i 0)
840 (while (< i numcols)
841 (setq width (+ width (aref colw i))
842 i (1+ i))))
843 (if (>= width max-width)
844 (setq numcols nil)
845 (if colw
846 (setq col-widths colw))
847 (if (>= numcols (length widths))
848 (setq numcols nil)
849 (setq numcols (1+ numcols))))))
850
851 (if (not col-widths)
852 (cons (vector max-width) files)
853 (setq numcols (length col-widths))
854 (let* ((rows (ceiling (/ (length widths)
855 (float numcols))))
856 (len (* rows numcols))
857 (newfiles (make-list len nil))
858 (index 0)
859 (i 0)
860 (j 0))
861 (while (< j len)
862 (if (= i numcols)
863 (setq i 0 index (1+ index)))
864 (setcar (nthcdr j newfiles)
865 (nth (+ (* i rows) index) files))
866 (setq j (1+ j) i (1+ i)))
867 (cons col-widths newfiles)))))
868
869(defun eshell-ls-decorated-name (file)
3eed132b 870 "Return FILE, possibly decorated."
7f09df7a
JW
871 (if eshell-ls-use-colors
872 (let ((face
873 (cond
874 ((not (cdr file))
958e6876 875 'eshell-ls-missing)
7f09df7a
JW
876
877 ((stringp (cadr file))
958e6876 878 'eshell-ls-symlink)
7f09df7a
JW
879
880 ((eq (cadr file) t)
958e6876 881 'eshell-ls-directory)
7f09df7a
JW
882
883 ((not (eshell-ls-filetype-p (cdr file) ?-))
958e6876 884 'eshell-ls-special)
7f09df7a
JW
885
886 ((and (/= (user-uid) 0) ; root can execute anything
887 (eshell-ls-applicable (cdr file) 3
888 'file-executable-p (car file)))
958e6876 889 'eshell-ls-executable)
7f09df7a
JW
890
891 ((not (eshell-ls-applicable (cdr file) 1
892 'file-readable-p (car file)))
958e6876 893 'eshell-ls-unreadable)
7f09df7a
JW
894
895 ((string-match eshell-ls-archive-regexp (car file))
958e6876 896 'eshell-ls-archive)
7f09df7a
JW
897
898 ((string-match eshell-ls-backup-regexp (car file))
958e6876 899 'eshell-ls-backup)
7f09df7a
JW
900
901 ((string-match eshell-ls-product-regexp (car file))
958e6876 902 'eshell-ls-product)
7f09df7a
JW
903
904 ((string-match eshell-ls-clutter-regexp (car file))
958e6876 905 'eshell-ls-clutter)
7f09df7a
JW
906
907 ((not (eshell-ls-applicable (cdr file) 2
908 'file-writable-p (car file)))
958e6876 909 'eshell-ls-readonly)
7f09df7a
JW
910 (eshell-ls-highlight-alist
911 (let ((tests eshell-ls-highlight-alist)
912 value)
913 (while tests
914 (if (funcall (caar tests) (car file) (cdr file))
915 (setq value (cdar tests) tests nil)
916 (setq tests (cdr tests))))
917 value)))))
918 (if face
919 (add-text-properties 0 (length (car file))
920 (list 'face face)
921 (car file)))))
922 (car file))
affbf647 923
dbba8a04 924(provide 'em-ls)
affbf647 925
cbee283d 926;; arch-tag: 9295181c-0cb2-499c-999b-89f5359842cb
affbf647 927;;; em-ls.el ends here