1 ;;;; directory.el - emulate insert-directory completely in Emacs Lisp
3 ;; Copyright (C) 1992 by Sebastian Kremer <sk@thp.uni-koeln.de>
5 ;; This program is free software; you can redistribute it and/or modify
6 ;; it under the terms of the GNU General Public License as published by
7 ;; the Free Software Foundation; either version 1, or (at your option)
10 ;; This program is distributed in the hope that it will be useful,
11 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ;; GNU General Public License for more details.
15 ;; You should have received a copy of the GNU General Public License
16 ;; along with this program; if not, write to the Free Software
17 ;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 ;; INSTALLATION =======================================================
21 ;; Put this file into your load-path. To use it, load it
22 ;; with (load "directory").
24 ;; OVERVIEW ===========================================================
26 ;; This file overloads the function insert-directory to implement it
27 ;; directly from Emacs lisp, without running `ls' in a subprocess.
29 ;; It is useful if you cannot afford to fork Emacs on a real memory UNIX,
30 ;; under VMS, or if you don't have the ls program, or if you want
31 ;; different format from what ls offers.
33 ;; This function uses regexps instead of shell
34 ;; wildcards. If you enter regexps remember to double each $ sign.
35 ;; For example, to include files *.el, enter `.*\.el$$',
36 ;; resulting in the regexp `.*\.el$'.
38 ;; RESTRICTIONS =====================================================
40 ;; * many ls switches are ignored, see docstring of `insert-directory'.
42 ;; * Only numeric uid/gid
44 ;; TODO ==============================================================
46 ;; Recognize some more ls switches: R F
48 (defun insert-directory (file &optional switches wildcard full-directory-p)
49 "Insert directory listing for of FILE, formatted according to SWITCHES.
50 Leaves point after the inserted text.
51 Optional third arg WILDCARD means treat FILE as shell wildcard.
52 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
53 switches do not contain `d', so that a full listing is expected.
55 This version of the function comes from `directory.el'.
56 It does not support ordinary shell wildcards; instead, it allows
57 regular expressions to match file names.
59 The switches that work are: A a c i r S s t u"
60 (let (handler (handlers file-name-handler-alist))
62 (while (and (consp handlers) (null handler))
63 (if (and (consp (car handlers))
64 (stringp (car (car handlers)))
65 (string-match (car (car handlers)) file))
66 (setq handler (cdr (car handlers))))
67 (setq handlers (cdr handlers))))
69 (funcall handler 'insert-directory file switches
70 wildcard full-directory-p)
72 (setq wildcard (file-name-nondirectory file) ; actually emacs regexp
73 ;; perhaps convert it from shell to emacs syntax?
74 file (file-name-directory file)))
77 (let* ((dir (file-name-as-directory file))
78 (default-directory dir);; so that file-attributes works
82 (file-list (directory-files dir nil wildcard))
84 ;; do all bindings here for speed
86 (cond ((memq ?A switches)
88 (ls-lisp-delete-matching "^\\.\\.?$" file-list)))
89 ((not (memq ?a switches))
90 ;; if neither -A nor -a, flush . files
92 (ls-lisp-delete-matching "^\\." file-list))))
97 ;; file-attributes("~bogus") bombs
98 (cons x (file-attributes (expand-file-name x)))))
99 ;; inserting the call to directory-files right here
100 ;; seems to stimulate an Emacs bug
101 ;; ILLEGAL DATATYPE (#o37777777727) or #o67
103 (insert "total \007\n") ; filled in afterwards
105 (ls-lisp-handle-switches file-alist switches))
107 (setq elt (car file-alist)
110 file-alist (cdr file-alist)
111 fil (concat dir short)
112 sum (+ sum (nth 7 attr)))
113 (insert (ls-lisp-format short attr switches)))
114 ;; Fill in total size of all files:
116 (search-backward "total \007")
117 (goto-char (match-end 0))
119 (insert (format "%d" (1+ (/ sum 1024))))))
120 ;; if not full-directory-p, FILE *must not* end in /, as
121 ;; file-attributes will not recognize a symlink to a directory
122 ;; must make it a relative filename as ls does:
123 (setq file (file-name-nondirectory file))
124 (insert (ls-lisp-format file (file-attributes file) switches))))))
126 (defun ls-lisp-delete-matching (regexp list)
127 ;; Delete all elements matching REGEXP from LIST, return new list.
128 ;; Should perhaps use setcdr for efficiency.
131 (or (string-match regexp (car list))
132 (setq result (cons (car list) result)))
133 (setq list (cdr list)))
136 (defun ls-lisp-handle-switches (file-alist switches)
137 ;; FILE-ALIST's elements are (FILE . FILE-ATTRIBUTES).
138 ;; Return new alist sorted according to SWITCHES which is a list of
139 ;; characters. Default sorting is alphabetically.
143 (cond ((memq ?S switches) ; sorted on size
146 ;; 7th file attribute is file size
147 ;; Make largest file come first
150 ((memq ?t switches) ; sorted on time
151 (setq index (ls-lisp-time-index switches))
154 (ls-lisp-time-lessp (nth index (cdr y))
155 (nth index (cdr x))))))
156 (t ; sorted alphabetically
159 (string-lessp (car x)
161 (if (memq ?r switches) ; reverse sort order
162 (setq file-alist (nreverse file-alist)))
165 ;; From Roland McGrath. Can use this to sort on time.
166 (defun ls-lisp-time-lessp (time0 time1)
167 (let ((hi0 (car time0))
169 (lo0 (car (cdr time0)))
170 (lo1 (car (cdr time1))))
176 (defun ls-lisp-format (file-name file-attr &optional switches)
177 (let ((file-type (nth 0 file-attr)))
178 (concat (if (memq ?i switches) ; inode number
179 (format "%6d " (nth 10 file-attr)))
180 ;; nil is treated like "" in concat
181 (if (memq ?s switches) ; size in K
182 (format "%4d " (1+ (/ (nth 7 file-attr) 1024))))
183 (nth 8 file-attr) ; permission bits
184 ;; numeric uid/gid are more confusing than helpful
185 ;; Emacs should be able to make strings of them.
186 ;; user-login-name and user-full-name could take an
188 (format " %3d %-8d %-8d %8d "
189 (nth 1 file-attr) ; no. of links
190 (nth 2 file-attr) ; uid
191 (nth 3 file-attr) ; gid
192 (nth 7 file-attr) ; size in bytes
194 (ls-lisp-format-time file-attr switches)
197 (if (stringp file-type) ; is a symbolic link
198 (concat " -> " file-type)
203 (defun ls-lisp-time-index (switches)
204 ;; Return index into file-attributes according to ls SWITCHES.
206 ((memq ?c switches) 6) ; last mode change
207 ((memq ?u switches) 4) ; last access
208 ;; default is last modtime
211 (defun ls-lisp-format-time (file-attr switches)
212 ;; Format time string for file with attributes FILE-ATTR according
213 ;; to SWITCHES (a list of ls option letters of which c and u are recognized).
214 ;; file-attributes's time is in a braindead format
215 ;; Emacs 19 can format it using a new optional argument to
216 ;; current-time-string, for Emacs 18 we just return the faked fixed
217 ;; date "Jan 00 00:00 ".
218 (condition-case error-data
219 (let* ((time (current-time-string
220 (nth (ls-lisp-time-index switches) file-attr)))
221 (date (substring time 4 11)) ; "Apr 30 "
222 (clock (substring time 11 16)) ; "11:27"
223 (year (substring time 19 24)) ; " 1992"
224 (same-year (equal year (substring (current-time-string) 19 24))))
225 (concat date ; has trailing SPC
227 ;; this is not exactly the same test used by ls
228 ;; ls tests if the file is older than 6 months
229 ;; but we can't do time differences easily