(Fread_file_name): Correct handling of dollars in file
[bpt/emacs.git] / lisp / dired-x.el
1 ;;; dired-x.el --- Sebastian Kremer's Extra DIRED hacked up for GNU Emacs19
2
3 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
4 ;; Lawrence R. Dodd <dodd@roebling.poly.edu>
5 ;; Maintainer: Lawrence R. Dodd <dodd@roebling.poly.edu>
6 ;; Version: 2.37+
7 ;; Date: 1994/08/18 19:27:42
8 ;; Keywords: dired extensions
9
10 ;; Copyright (C) 1993, 1994, 1997 Free Software Foundation, Inc.
11
12 ;; This file is part of GNU Emacs.
13
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; any later version.
18
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
28
29 ;;; Commentary:
30
31 ;; This is Sebastian Kremer's excellent dired-x.el (Dired Extra), version
32 ;; 1.191, hacked up for GNU Emacs 19. Redundant or conflicting material
33 ;; has been removed or renamed in order to work properly with dired of
34 ;; GNU Emacs 19. All suggestions or comments are most welcomed.
35
36 ;;
37 ;; Please, PLEASE, *PLEASE* see the info pages.
38 ;;
39
40 ;; BUGS: Type M-x dired-x-submit-report and a report will be generated.
41
42 ;; INSTALLATION: In your ~/.emacs,
43 ;;
44 ;; (add-hook 'dired-load-hook
45 ;; (function (lambda ()
46 ;; (load "dired-x")
47 ;; ;; Set global variables here. For example:
48 ;; ;; (setq dired-guess-shell-gnutar "gtar")
49 ;; )))
50 ;; (add-hook 'dired-mode-hook
51 ;; (function (lambda ()
52 ;; ;; Set buffer-local variables here. For example:
53 ;; ;; (setq dired-omit-files-p t)
54 ;; )))
55 ;;
56 ;; At load time dired-x.el will install itself, redefine some functions, and
57 ;; bind some dired keys. *Please* see the info pages for more details.
58
59 ;; CAUTION: If you are using a version of GNU Emacs earlier than 19.20 than
60 ;; you may have to edit dired.el. The copy of dired.el in GNU Emacs versions
61 ;; earlier than 19.20 incorrectly had the call to run-hooks *before* the call
62 ;; to provide. In such a case, it is possible that byte-compiling and/or
63 ;; loading dired can cause an infinite loop. To prevent this, make sure the
64 ;; line of code
65 ;;
66 ;; (run-hooks 'dired-load-hook)
67 ;;
68 ;; is the *last* executable line in the file dired.el. That is, make sure it
69 ;; comes *after* the line
70 ;;
71 ;; (provide 'dired)
72 ;;
73 ;; *Please* see the info pages for more details.
74
75 ;; User defined variables:
76 ;;
77 ;; dired-bind-vm
78 ;; dired-vm-read-only-folders
79 ;; dired-bind-jump
80 ;; dired-bind-info
81 ;; dired-bind-man
82 ;; dired-x-hands-off-my-keys
83 ;; dired-find-subdir
84 ;; dired-enable-local-variables
85 ;; dired-local-variables-file
86 ;; dired-guess-shell-gnutar
87 ;; dired-guess-shell-gzip-quiet
88 ;; dired-guess-shell-znew-switches
89 ;; dired-guess-shell-alist-user
90 ;; dired-clean-up-buffers-too
91 ;; dired-omit-files-p
92 ;; dired-omit-files
93 ;; dired-omit-extensions
94 ;; dired-omit-size-limit
95 ;;
96 ;; To find out more about these variables, load this file, put your cursor at
97 ;; the end of any of the variable names, and hit C-h v [RET]. *Please* see
98 ;; the info pages for more details.
99
100 ;; When loaded this code redefines the following functions of GNU Emacs
101 ;;
102 ;; Function Found in this file of GNU Emacs
103 ;; -------- -------------------------------
104 ;; dired-clean-up-after-deletion ../lisp/dired.el
105 ;; dired-find-buffer-nocreate ../lisp/dired.el
106 ;; dired-initial-position ../lisp/dired.el
107 ;;
108 ;; dired-add-entry ../lisp/dired-aux.el
109 ;; dired-read-shell-command ../lisp/dired-aux.el
110 ;;
111 ;; One drawback is that dired-x.el will load dired-aux.el as soon as dired is
112 ;; loaded. Thus, the advantage of separating out non-essential dired stuff
113 ;; into dired-aux.el and only loading when necessary will be lost. Please
114 ;; note also that some of the comments in dired.el and dired-aux.el are
115 ;; Kremer's that referred to the old dired-x.el. This now should be referring
116 ;; to this program. (This is also a good reason to call this dired-x.el
117 ;; instead of dired-x19.el.)
118
119 \f
120 ;;; Code:
121
122 ;; LOAD.
123
124 ;; This is a no-op if dired-x is being loaded via `dired-load-hook'. It is
125 ;; here in case the user has autoloaded dired-x via the dired-jump key binding
126 ;; (instead of autoloading to dired as is suggested in the info-pages).
127
128 (require 'dired)
129
130 ;; We will redefine some functions and also need some macros so we need to
131 ;; load dired stuff of GNU Emacs.
132
133 (require 'dired-aux)
134
135 ;;; User-defined variables.
136
137 (defgroup dired-x nil
138 "Extended directory editing (dired-x)."
139 :group 'dired)
140
141 (defgroup dired-keys nil
142 "Dired keys customizations."
143 :prefix "dired-"
144 :group 'dired-x)
145
146 (defcustom dired-bind-vm nil
147 "*t says \"V\" in dired-mode will `dired-vm', otherwise \"V\" is `dired-rmail'.
148 Also, RMAIL files contain -*- rmail -*- at the top so \"f\",
149 `dired-advertised-find-file', will run rmail."
150 :type 'boolean
151 :group 'dired-keys)
152
153 (defcustom dired-bind-jump t
154 "*t says bind `dired-jump' to C-x C-j, otherwise do not."
155 :type 'boolean
156 :group 'dired-keys)
157
158 (defcustom dired-bind-man t
159 "*t says bind `dired-man' to \"N\" in dired-mode, otherwise do not."
160 :type 'boolean
161 :group 'dired-keys)
162
163 (defcustom dired-bind-info t
164 "*t says bind `dired-info' to \"I\" in dired-mode, otherwise do not."
165 :type 'boolean
166 :group 'dired-keys)
167
168 (defcustom dired-vm-read-only-folders nil
169 "*If t, \\[dired-vm] will visit all folders read-only.
170 If neither nil nor t, e.g. the symbol `if-file-read-only', only
171 files not writable by you are visited read-only.
172
173 Read-only folders only work in VM 5, not in VM 4."
174 :type '(choice (const :tag "off" nil)
175 (const :tag "on" t)
176 (other :tag "non-writable only" if-file-read-only))
177 :group 'dired-x)
178
179 (defcustom dired-omit-files-p nil
180 "*If non-nil, \"uninteresting\" files are not listed (buffer-local).
181 Use \\[dired-omit-toggle] to toggle its value.
182 Uninteresting files are those whose filenames match regexp `dired-omit-files',
183 plus those ending with extensions in `dired-omit-extensions'."
184 :type 'boolean
185 :group 'dired-x)
186 (make-variable-buffer-local 'dired-omit-files-p)
187
188 (defcustom dired-omit-files "^\\.?#\\|^\\.$\\|^\\.\\.$"
189 "*Filenames matching this regexp will not be displayed.
190 This only has effect when `dired-omit-files-p' is t. See interactive function
191 `dired-omit-toggle' \(\\[dired-omit-toggle]\) and variable
192 `dired-omit-extensions'. The default is to omit `.', `..', auto-save
193 files and lock files."
194 :type 'regexp
195 :group 'dired-x)
196
197 (defcustom dired-find-subdir nil ; t is pretty near to DWIM...
198 "*If non-nil, Dired always finds a directory in a buffer of its own.
199 If nil, Dired finds the directory as a subdirectory in some other buffer
200 if it is present as one.
201
202 If there are several Dired buffers for a directory, the most recently
203 used is chosen.
204
205 Dired avoids switching to the current buffer, so that if you have
206 a normal and a wildcard buffer for the same directory, C-x d RET will
207 toggle between those two."
208 :type 'boolean
209 :group 'dired-x)
210
211 (defcustom dired-omit-size-limit 30000
212 "*Maximum size for the \"omitting\" feature.
213 If nil, there is no maximum size."
214 :type '(choice (const :tag "no maximum" nil) integer)
215 :group 'dired-x)
216
217 (defcustom dired-enable-local-variables t
218 "*Control use of local-variables lists in dired.
219 The value can be t, nil or something else.
220 A value of t means local-variables lists are obeyed;
221 nil means they are ignored; anything else means query.
222
223 This temporarily overrides the value of `enable-local-variables' when listing
224 a directory. See also `dired-local-variables-file'."
225 :type 'boolean
226 :group 'dired-x)
227
228 (defcustom dired-guess-shell-gnutar nil
229 "*If non-nil, name of GNU tar executable (e.g., \"tar\" or \"gtar\") and `z'
230 switch will be used for compressed or gzip'ed tar files. If no GNU tar, set
231 to nil: a pipe using `zcat' or `gunzip -c' will be used."
232 :type 'boolean
233 :group 'dired-x)
234
235 (defcustom dired-guess-shell-gzip-quiet t
236 "*non-nil says pass -q to gzip overriding verbose GZIP environment."
237 :type 'boolean
238 :group 'dired-x)
239
240 (defcustom dired-guess-shell-znew-switches nil
241 "*If non-nil, then string of switches passed to `znew', example: \"-K\""
242 :type 'boolean
243 :group 'dired-x)
244
245 (defcustom dired-clean-up-buffers-too t
246 "*t says offer to kill buffers visiting files and dirs deleted in dired."
247 :type 'boolean
248 :group 'dired-x)
249
250 ;;; KEY BINDINGS.
251
252 (define-key dired-mode-map "\M-o" 'dired-omit-toggle)
253 (define-key dired-mode-map "\M-(" 'dired-mark-sexp)
254 (define-key dired-mode-map "*(" 'dired-mark-sexp)
255 (define-key dired-mode-map "*." 'dired-mark-extension)
256 (define-key dired-mode-map "\M-!" 'dired-smart-shell-command)
257 (define-key dired-mode-map "w" 'dired-copy-filename-as-kill)
258 (define-key dired-mode-map "\M-g" 'dired-goto-file)
259 (define-key dired-mode-map "\M-G" 'dired-goto-subdir)
260 (define-key dired-mode-map "F" 'dired-do-find-marked-files)
261 (define-key dired-mode-map "Y" 'dired-do-relsymlink)
262 (define-key dired-mode-map "%Y" 'dired-do-relsymlink-regexp)
263 (define-key dired-mode-map "V" 'dired-do-run-mail)
264
265 (if dired-bind-man
266 (define-key dired-mode-map "N" 'dired-man))
267
268 (if dired-bind-info
269 (define-key dired-mode-map "I" 'dired-info))
270
271 ;;; GLOBAL BINDING.
272 (if dired-bind-jump
273 (progn
274 (define-key global-map "\C-x\C-j" 'dired-jump)
275 (define-key global-map "\C-x4\C-j" 'dired-jump-other-window)))
276
277 \f
278 ;;; Install into appropriate hooks.
279
280 (add-hook 'dired-mode-hook 'dired-extra-startup)
281 (add-hook 'dired-after-readin-hook 'dired-omit-expunge)
282
283 (defun dired-extra-startup ()
284 "Automatically put on dired-mode-hook to get extra dired features:
285 \\<dired-mode-map>
286
287 \\[dired-do-run-mail]\t-- run mail on folder (see `dired-bind-vm')
288 \\[dired-info]\t-- run info on file
289 \\[dired-man]\t-- run man on file
290 \\[dired-do-find-marked-files]\t-- visit all marked files simultaneously
291 \\[dired-omit-toggle]\t-- toggle omitting of files
292 \\[dired-mark-sexp]\t-- mark by lisp expression
293 \\[dired-copy-filename-as-kill]\t-- copy the file or subdir names into the kill ring.
294 \t You can feed it to other commands using \\[yank].
295
296 For more features, see variables
297
298 dired-bind-vm
299 dired-bind-jump
300 dired-bind-info
301 dired-bind-man
302 dired-vm-read-only-folders
303 dired-omit-files-p
304 dired-omit-files
305 dired-omit-extensions
306 dired-omit-size-limit
307 dired-find-subdir
308 dired-enable-local-variables
309 dired-local-variables-file
310 dired-guess-shell-gnutar
311 dired-guess-shell-gzip-quiet
312 dired-guess-shell-znew-switches
313 dired-guess-shell-alist-user
314 dired-clean-up-buffers-too
315
316 See also functions
317
318 dired-flag-extension
319 dired-virtual
320 dired-jump
321 dired-man
322 dired-vm
323 dired-rmail
324 dired-info
325 dired-do-find-marked-files
326 "
327 (interactive)
328
329 ;; These must be done in each new dired buffer.
330 (dired-hack-local-variables)
331 (dired-omit-startup))
332
333 \f
334 ;;; BUFFER CLEANING.
335
336 ;; REDEFINE.
337 (defun dired-clean-up-after-deletion (fn)
338
339 ;; Clean up after a deleted file or directory FN.
340 ;; Remove expanded subdir of deleted dir, if any.
341 (save-excursion (and (cdr dired-subdir-alist)
342 (dired-goto-subdir fn)
343 (dired-kill-subdir)))
344
345 ;; Offer to kill buffer of deleted file FN.
346 (if dired-clean-up-buffers-too
347 (progn
348 (let ((buf (get-file-buffer fn)))
349 (and buf
350 (funcall (function y-or-n-p)
351 (format "Kill buffer of %s, too? "
352 (file-name-nondirectory fn)))
353 (save-excursion ; you never know where kill-buffer leaves you
354 (kill-buffer buf))))
355 (let ((buf-list (dired-buffers-for-dir (expand-file-name fn)))
356 (buf nil))
357 (and buf-list
358 (y-or-n-p (format "Kill dired buffer%s of %s, too? "
359 (dired-plural-s (length buf-list))
360 (file-name-nondirectory fn)))
361 (while buf-list
362 (save-excursion (kill-buffer (car buf-list)))
363 (setq buf-list (cdr buf-list)))))))
364 ;; Anything else?
365 )
366
367 \f
368 ;;; EXTENSION MARKING FUNCTIONS.
369
370 ;;; Mark files with some extension.
371 (defun dired-mark-extension (extension &optional marker-char)
372 "Mark all files with a certain extension for use in later commands.
373 A `.' is not automatically prepended to the string entered."
374 ;; EXTENSION may also be a list of extensions instead of a single one.
375 ;; Optional MARKER-CHAR is marker to use.
376 (interactive "sMarking extension: \nP")
377 (or (listp extension)
378 (setq extension (list extension)))
379 (dired-mark-files-regexp
380 (concat ".";; don't match names with nothing but an extension
381 "\\("
382 (mapconcat 'regexp-quote extension "\\|")
383 "\\)$")
384 marker-char))
385
386 (defun dired-flag-extension (extension)
387 "In dired, flag all files with a certain extension for deletion.
388 A `.' is *not* automatically prepended to the string entered."
389 (interactive "sFlagging extension: ")
390 (dired-mark-extension extension dired-del-marker))
391
392 ;;; Define some unpopular file extensions. Used for cleaning and omitting.
393
394 (defvar dired-patch-unclean-extensions
395 '(".rej" ".orig")
396 "List of extensions of dispensable files created by the `patch' program.")
397
398 (defvar dired-tex-unclean-extensions
399 '(".toc" ".log" ".aux");; these are already in completion-ignored-extensions
400 "List of extensions of dispensable files created by TeX.")
401
402 (defvar dired-latex-unclean-extensions
403 '(".idx" ".lof" ".lot" ".glo")
404 "List of extensions of dispensable files created by LaTeX.")
405
406 (defvar dired-bibtex-unclean-extensions
407 '(".blg" ".bbl")
408 "List of extensions of dispensable files created by BibTeX.")
409
410 (defvar dired-texinfo-unclean-extensions
411 '(".cp" ".cps" ".fn" ".fns" ".ky" ".kys" ".pg" ".pgs"
412 ".tp" ".tps" ".vr" ".vrs")
413 "List of extensions of dispensable files created by texinfo.")
414
415 (defun dired-clean-patch ()
416 "Flag dispensable files created by patch for deletion.
417 See variable `dired-patch-unclean-extensions'."
418 (interactive)
419 (dired-flag-extension dired-patch-unclean-extensions))
420
421 (defun dired-clean-tex ()
422 "Flag dispensable files created by [La]TeX etc. for deletion.
423 See variables `dired-texinfo-unclean-extensions',
424 `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions' and
425 `dired-texinfo-unclean-extensions'."
426 (interactive)
427 (dired-flag-extension (append dired-texinfo-unclean-extensions
428 dired-latex-unclean-extensions
429 dired-bibtex-unclean-extensions
430 dired-tex-unclean-extensions)))
431
432 (defun dired-very-clean-tex ()
433 "Flag dispensable files created by [La]TeX *and* \".dvi\" for deletion.
434 See variables `dired-texinfo-unclean-extensions',
435 `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions' and
436 `dired-texinfo-unclean-extensions'."
437 (interactive)
438 (dired-flag-extension (append dired-texinfo-unclean-extensions
439 dired-latex-unclean-extensions
440 dired-bibtex-unclean-extensions
441 dired-tex-unclean-extensions
442 (list ".dvi"))))
443 \f
444 ;;; JUMP.
445
446 ;;;###autoload
447 (defun dired-jump (&optional other-window)
448 "Jump to dired buffer corresponding to current buffer.
449 If in a file, dired the current directory and move to file's line.
450 If in dired already, pop up a level and goto old directory's line.
451 In case the proper dired file line cannot be found, refresh the dired
452 buffer and try again."
453 (interactive "P")
454 (let* ((file buffer-file-name)
455 (dir (if file (file-name-directory file) default-directory)))
456 (if (eq major-mode 'dired-mode)
457 (progn
458 (setq dir (dired-current-directory))
459 (dired-up-directory other-window)
460 (or (dired-goto-file dir)
461 ;; refresh and try again
462 (progn
463 (dired-insert-subdir (file-name-directory dir))
464 (dired-goto-file dir))))
465 (if other-window
466 (dired-other-window dir)
467 (dired dir))
468 (if file
469 (or (dired-goto-file file)
470 ;; refresh and try again
471 (progn
472 (dired-insert-subdir (file-name-directory file))
473 (dired-goto-file file))
474 ;; Toggle omitting, if it is on, and try again.
475 (if dired-omit-files-p
476 (progn
477 (dired-omit-toggle)
478 (dired-goto-file file))))))))
479
480 (defun dired-jump-other-window ()
481 "Like \\[dired-jump] (dired-jump) but in other window."
482 (interactive)
483 (dired-jump t))
484 \f
485 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
486
487 (defun dired-copy-filename-as-kill (&optional arg)
488 "Copy names of marked (or next ARG) files into the kill ring.
489 The names are separated by a space.
490 With a zero prefix arg, use the complete pathname of each marked file.
491 With \\[universal-argument], use the relative pathname of each marked file.
492
493 If on a subdir headerline, use subdirname instead; prefix arg is ignored
494 in this case.
495
496 You can then feed the file name(s) to other commands with \\[yank]."
497 (interactive "P")
498 (let ((string
499 (or (dired-get-subdir)
500 (mapconcat (function identity)
501 (if arg
502 (cond ((zerop (prefix-numeric-value arg))
503 (dired-get-marked-files))
504 ((integerp arg)
505 (dired-get-marked-files 'no-dir arg))
506 (t ; else a raw arg
507 (dired-get-marked-files t)))
508 (dired-get-marked-files 'no-dir))
509 " "))))
510 (kill-new string)
511 (message "%s" string)))
512
513 \f
514 ;;; OMITTING.
515
516 ;;; Enhanced omitting of lines from directory listings.
517 ;;; Marked files are never omitted.
518
519 ;; should probably get rid of this and always use 'no-dir.
520 ;; sk 28-Aug-1991 09:37
521 (defvar dired-omit-localp 'no-dir
522 "The LOCALP argument dired-omit-expunge passes to dired-get-filename.
523 If it is 'no-dir, omitting is much faster, but you can only match
524 against the basename of the file. Set it to nil if you need to match the
525 whole pathname.")
526
527 ;; \017=^O for Omit - other packages can chose other control characters.
528 (defvar dired-omit-marker-char ?\017
529 "Temporary marker used by by dired-omit.
530 Should never be used as marker by the user or other packages.")
531
532 (defun dired-omit-startup ()
533 (or (assq 'dired-omit-files-p minor-mode-alist)
534 (setq minor-mode-alist
535 (append '((dired-omit-files-p " Omit")) minor-mode-alist))))
536
537 (defun dired-omit-toggle (&optional flag)
538 "Toggle omitting files matching `dired-omit-files' and `dired-omit-extensions'.
539 With an arg, and if omitting was off, don't toggle and just mark the
540 files but don't actually omit them.
541 With an arg, and if omitting was on, turn it off but don't refresh the buffer."
542 (interactive "P")
543 (if flag
544 (if dired-omit-files-p
545 (setq dired-omit-files-p (not dired-omit-files-p))
546 (dired-mark-unmarked-files (dired-omit-regexp) nil nil
547 dired-omit-localp))
548 ;; no FLAG
549 (setq dired-omit-files-p (not dired-omit-files-p))
550 (if (not dired-omit-files-p)
551 (revert-buffer)
552 ;; this will mention how many were omitted:
553 (let ((dired-omit-size-limit nil))
554 (dired-omit-expunge)))))
555
556 (defvar dired-omit-extensions
557 (append completion-ignored-extensions
558 dired-latex-unclean-extensions
559 dired-bibtex-unclean-extensions
560 dired-texinfo-unclean-extensions)
561 "If non-nil, a list of extensions \(strings\) to omit from Dired listings.
562 Defaults to elements of `completion-ignored-extensions',
563 `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions', and
564 `dired-texinfo-unclean-extensions'.
565
566 See interactive function `dired-omit-toggle' \(\\[dired-omit-toggle]\) and
567 variables `dired-omit-files-p' and `dired-omit-files'.")
568
569 (defun dired-omit-expunge (&optional regexp)
570 "Erases all unmarked files matching REGEXP.
571 Does nothing if global variable `dired-omit-files-p' is nil, or if called
572 non-interactively and buffer is bigger than `dired-omit-size-limit'.
573 If REGEXP is nil or not specified, uses `dired-omit-files', and also omits
574 filenames ending in `dired-omit-extensions'.
575 If REGEXP is the empty string, this function is a no-op.
576
577 This functions works by temporarily binding `dired-marker-char' to
578 `dired-omit-marker-char' and calling `dired-do-kill-lines'."
579 (interactive "sOmit files (regexp): ")
580 (if (and dired-omit-files-p
581 (or (interactive-p)
582 (not dired-omit-size-limit)
583 (< (buffer-size) dired-omit-size-limit)
584 (progn
585 (message "Not omitting: directory larger than %d characters."
586 dired-omit-size-limit)
587 (setq dired-omit-files-p nil)
588 nil)))
589 (let ((omit-re (or regexp (dired-omit-regexp)))
590 (old-modified-p (buffer-modified-p))
591 count)
592 (or (string= omit-re "")
593 (let ((dired-marker-char dired-omit-marker-char))
594 (message "Omitting...")
595 (if (dired-mark-unmarked-files omit-re nil nil dired-omit-localp)
596 (progn
597 (setq count (dired-do-kill-lines nil "Omitted %d line%s."))
598 (force-mode-line-update))
599 (message "(Nothing to omit)"))))
600 ;; Try to preserve modified state of buffer. So `%*' doesn't appear
601 ;; in mode-line of omitted buffers.
602 (set-buffer-modified-p (and old-modified-p
603 (save-excursion
604 (goto-char (point-min))
605 (re-search-forward dired-re-mark nil t))))
606 count)))
607
608 (defun dired-omit-regexp ()
609 (concat (if dired-omit-files (concat "\\(" dired-omit-files "\\)") "")
610 (if (and dired-omit-files dired-omit-extensions) "\\|" "")
611 (if dired-omit-extensions
612 (concat ".";; a non-extension part should exist
613 "\\("
614 (mapconcat 'regexp-quote dired-omit-extensions "\\|")
615 "\\)$")
616 "")))
617
618 ;; Returns t if any work was done, nil otherwise.
619 (defun dired-mark-unmarked-files (regexp msg &optional unflag-p localp)
620 "Marks unmarked files matching REGEXP, displaying MSG.
621 REGEXP is matched against the complete pathname.
622 Does not re-mark files which already have a mark.
623 With prefix argument, unflag all those files.
624 Second optional argument LOCALP is as in `dired-get-filename'."
625 (interactive "P")
626 (let ((dired-marker-char (if unflag-p ?\ dired-marker-char)))
627 (dired-mark-if
628 (and
629 ;; not already marked
630 (looking-at " ")
631 ;; uninteresting
632 (let ((fn (dired-get-filename localp t)))
633 (and fn (string-match regexp fn))))
634 msg)))
635
636 ;;; REDEFINE.
637 (defun dired-omit-new-add-entry (filename &optional marker-char relative)
638 ;; This redefines dired-aux.el's dired-add-entry to avoid calling ls for
639 ;; files that are going to be omitted anyway.
640 (if dired-omit-files-p
641 ;; perhaps return t without calling ls
642 (let ((omit-re (dired-omit-regexp)))
643 (if (or (string= omit-re "")
644 (not
645 (string-match omit-re
646 (cond
647 ((eq 'no-dir dired-omit-localp)
648 filename)
649 ((eq t dired-omit-localp)
650 (dired-make-relative filename))
651 (t
652 (dired-make-absolute
653 filename
654 (file-name-directory filename)))))))
655 ;; if it didn't match, go ahead and add the entry
656 (dired-omit-old-add-entry filename marker-char relative)
657 ;; dired-add-entry returns t for success, perhaps we should
658 ;; return file-exists-p
659 t))
660 ;; omitting is not turned on at all
661 (dired-omit-old-add-entry filename marker-char relative)))
662
663 ;;; REDEFINE.
664 ;;; Redefine dired-aux.el's version of `dired-add-entry'
665 ;;; Save old defun if not already done:
666 (or (fboundp 'dired-omit-old-add-entry)
667 (fset 'dired-omit-old-add-entry (symbol-function 'dired-add-entry)))
668 ;; Redefine it.
669 (fset 'dired-add-entry 'dired-omit-new-add-entry)
670
671 \f
672 ;;; VIRTUAL DIRED MODE.
673
674 ;;; For browsing `ls -lR' listings in a dired-like fashion.
675
676 (fset 'virtual-dired 'dired-virtual)
677 (defun dired-virtual (dirname &optional switches)
678 "Put this buffer into Virtual Dired mode.
679
680 In Virtual Dired mode, all commands that do not actually consult the
681 filesystem will work.
682
683 This is useful if you want to peruse and move around in an ls -lR
684 output file, for example one you got from an ftp server. With
685 ange-ftp, you can even dired a directory containing an ls-lR file,
686 visit that file and turn on virtual dired mode. But don't try to save
687 this file, as dired-virtual indents the listing and thus changes the
688 buffer.
689
690 If you have save a Dired buffer in a file you can use \\[dired-virtual] to
691 resume it in a later session.
692
693 Type \\<dired-mode-map>\\[revert-buffer] in the
694 Virtual Dired buffer and answer `y' to convert the virtual to a real
695 dired buffer again. You don't have to do this, though: you can relist
696 single subdirs using \\[dired-do-redisplay].
697 "
698
699 ;; DIRNAME is the top level directory of the buffer. It will become
700 ;; its `default-directory'. If nil, the old value of
701 ;; default-directory is used.
702
703 ;; Optional SWITCHES are the ls switches to use.
704
705 ;; Shell wildcards will be used if there already is a `wildcard'
706 ;; line in the buffer (thus it is a saved Dired buffer), but there
707 ;; is no other way to get wildcards. Insert a `wildcard' line by
708 ;; hand if you want them.
709
710 (interactive
711 (list (read-string "Virtual Dired directory: " (dired-virtual-guess-dir))))
712 (goto-char (point-min))
713 (or (looking-at " ")
714 ;; if not already indented, do it now:
715 (indent-region (point-min) (point-max) 2))
716 (or dirname (setq dirname default-directory))
717 (setq dirname (expand-file-name (file-name-as-directory dirname)))
718 (setq default-directory dirname) ; contains no wildcards
719 (let ((wildcard (save-excursion
720 (goto-char (point-min))
721 (forward-line 1)
722 (and (looking-at "^ wildcard ")
723 (buffer-substring (match-end 0)
724 (progn (end-of-line) (point)))))))
725 (if wildcard
726 (setq dirname (expand-file-name wildcard default-directory))))
727 ;; If raw ls listing (not a saved old dired buffer), give it a
728 ;; decent subdir headerline:
729 (goto-char (point-min))
730 (or (looking-at dired-subdir-regexp)
731 (dired-insert-headerline default-directory))
732 (dired-mode dirname (or switches dired-listing-switches))
733 (setq mode-name "Virtual Dired"
734 revert-buffer-function 'dired-virtual-revert)
735 (set (make-local-variable 'dired-subdir-alist) nil)
736 (dired-build-subdir-alist)
737 (goto-char (point-min))
738 (dired-initial-position dirname))
739
740 (defun dired-virtual-guess-dir ()
741
742 ;; Guess and return appropriate working directory of this buffer,
743 ;; assumed to be in Dired or ls -lR format.
744 ;; The guess is based upon buffer contents.
745 ;; If nothing could be guessed, returns nil.
746
747 (let ((regexp "^\\( \\)?\\([^ \n\r]*\\)\\(:\\)[\n\r]")
748 (subexpr 2))
749 (goto-char (point-min))
750 (cond ((looking-at regexp)
751 ;; If a saved dired buffer, look to which dir and
752 ;; perhaps wildcard it belongs:
753 (let ((dir (buffer-substring (match-beginning subexpr)
754 (match-end subexpr))))
755 (file-name-as-directory dir)))
756 ;; Else no match for headerline found. It's a raw ls listing.
757 ;; In raw ls listings the directory does not have a headerline
758 ;; try parent of first subdir, if any
759 ((re-search-forward regexp nil t)
760 (file-name-directory
761 (directory-file-name
762 (file-name-as-directory
763 (buffer-substring (match-beginning subexpr)
764 (match-end subexpr))))))
765 (t ; if all else fails
766 nil))))
767
768
769 (defun dired-virtual-revert (&optional arg noconfirm)
770 (if (not
771 (y-or-n-p "Cannot revert a Virtual Dired buffer - switch to Real Dired mode? "))
772 (error "Cannot revert a Virtual Dired buffer.")
773 (setq mode-name "Dired"
774 revert-buffer-function 'dired-revert)
775 (revert-buffer)))
776
777 ;; A zero-arg version of dired-virtual.
778 ;; You need my modified version of set-auto-mode for the
779 ;; `buffer-contents-mode-alist'.
780 ;; Or you use infer-mode.el and infer-mode-alist, same syntax.
781 (defun dired-virtual-mode ()
782 "Put current buffer into virtual dired mode (see `dired-virtual').
783 Useful on `buffer-contents-mode-alist' (which see) with the regexp
784
785 \"^ \\(/[^ /]+\\)/?+:$\"
786
787 to put saved dired buffers automatically into virtual dired mode.
788
789 Also useful for `auto-mode-alist' (which see) like this:
790
791 \(setq auto-mode-alist (cons '(\"[^/]\\.dired\\'\" . dired-virtual-mode)
792 auto-mode-alist)\)"
793 (interactive)
794 (dired-virtual (dired-virtual-guess-dir)))
795
796 \f
797 ;;; SMART SHELL.
798
799 ;;; An Emacs buffer can have but one working directory, stored in the
800 ;;; buffer-local variable `default-directory'. A Dired buffer may have
801 ;;; several subdirectories inserted, but still has but one working directory:
802 ;;; that of the top level Dired directory in that buffer. For some commands
803 ;;; it is appropriate that they use the current Dired directory instead of
804 ;;; `default-directory', e.g., `find-file' and `compile'. This is a general
805 ;;; mechanism is provided for special handling of the working directory in
806 ;;; special major modes.
807
808 ;; It's easier to add to this alist than redefine function
809 ;; default-directory while keeping the old information.
810 (defconst default-directory-alist
811 '((dired-mode . (if (fboundp 'dired-current-directory)
812 (dired-current-directory)
813 default-directory)))
814 "Alist of major modes and their opinion on default-directory, as a
815 lisp expression to evaluate. A resulting value of nil is ignored in
816 favor of default-directory.")
817
818 (defun default-directory ()
819 "Usage like variable `default-directory', but knows about the special
820 cases in variable `default-directory-alist' (which see)."
821 (or (eval (cdr (assq major-mode default-directory-alist)))
822 default-directory))
823
824 (defun dired-smart-shell-command (cmd &optional insert)
825 "Like function `shell-command', but in the current Tree Dired directory."
826 (interactive "sShell command: \nP")
827 (let ((default-directory (default-directory)))
828 (shell-command cmd insert)))
829
830 \f
831 ;;; LOCAL VARIABLES FOR DIRED BUFFERS.
832
833 ;;; Brief Description:
834 ;;;
835 ;;; * `dired-extra-startup' is part of the `dired-mode-hook'.
836 ;;;
837 ;;; * `dired-extra-startup' calls `dired-hack-local-variables'
838 ;;;
839 ;;; * `dired-hack-local-variables' checks the value of
840 ;;; `dired-local-variables-file'
841 ;;;
842 ;;; * Check if `dired-local-variables-file' is a non-nil string and is a
843 ;;; filename found in the directory of the Dired Buffer being created.
844 ;;;
845 ;;; * If `dired-local-variables-file' satisfies the above, then temporarily
846 ;;; include it in the Dired Buffer at the bottom.
847 ;;;
848 ;;; * Set `enable-local-variables' temporarily to the user variable
849 ;;; `dired-enable-local-variables' and run `hack-local-variables' on the
850 ;;; Dired Buffer.
851
852 (defvar dired-local-variables-file (convert-standard-filename ".dired")
853 "Filename, as string, containing local dired buffer variables to be hacked.
854 If this file found in current directory, then it will be inserted into dired
855 buffer and `hack-local-variables' will be run. See Emacs Info pages for more
856 information on local variables. See also `dired-enable-local-variables'.")
857
858 (defun dired-hack-local-variables ()
859 "Evaluate local variables in `dired-local-variables-file' for dired buffer."
860 (if (and dired-local-variables-file
861 (stringp dired-local-variables-file)
862 (file-exists-p dired-local-variables-file))
863 (let ((opoint (point-max))
864 buffer-read-only
865 ;; In case user has `enable-local-variables' set to nil we
866 ;; override it locally with dired's variable.
867 (enable-local-variables dired-enable-local-variables))
868 ;; Insert 'em.
869 (save-excursion
870 (goto-char opoint)
871 (insert "\^L\n")
872 (insert-file-contents dired-local-variables-file))
873 ;; Hack 'em.
874 (let ((buffer-file-name dired-local-variables-file))
875 (hack-local-variables))
876 ;; Make sure that the modeline shows the proper information.
877 (dired-sort-set-modeline)
878 ;; Delete this stuff: `eobp' is used to find last subdir by dired.el.
879 (delete-region opoint (point-max)))))
880
881 (defun dired-omit-here-always ()
882 "Creates `dired-local-variables-file' for omitting and reverts directory.
883 Sets dired-omit-file-p to t in a local variables file that is readable by
884 dired."
885 (interactive)
886 (if (file-exists-p dired-local-variables-file)
887 (message "File `./%s' already exists." dired-local-variables-file)
888
889 ;; Create `dired-local-variables-file'.
890 (save-excursion
891 (set-buffer (get-buffer-create " *dot-dired*"))
892 (erase-buffer)
893 (insert "Local Variables:\ndired-omit-files-p: t\nEnd:\n")
894 (write-file dired-local-variables-file)
895 (kill-buffer (current-buffer)))
896
897 ;; Run extra-hooks and revert directory.
898 (dired-extra-startup)
899 (dired-revert)))
900
901 \f
902 ;;; GUESS SHELL COMMAND.
903
904 ;;; Brief Description:
905 ;;;
906 ;;; `dired-do-shell-command' is bound to `!' by dired.el.
907 ;;;
908 ;;; * Redefine `dired-do-shell-command' so it calls
909 ;;; `dired-guess-shell-command'.
910 ;;;
911 ;;; * `dired-guess-shell-command' calls `dired-guess-default' with list of
912 ;;; marked files.
913 ;;;
914 ;;; * Parse `dired-guess-shell-alist-user' and
915 ;;; `dired-guess-shell-alist-default' (in that order) for the first REGEXP
916 ;;; that matches the first file in the file list.
917 ;;;
918 ;;; * If the REGEXP matches all the entries of the file list then evaluate
919 ;;; COMMAND, which is either a string or a Lisp expression returning a
920 ;;; string. COMMAND may be a list of commands.
921 ;;;
922 ;;; * Return this command to `dired-guess-shell-command' which prompts user
923 ;;; with it. The list of commands is temporarily put into the history list.
924 ;;; If a command is used successfully then it is stored permanently in
925 ;;; `dired-shell-command-history'.
926
927 ;;; Guess what shell command to apply to a file.
928 (defvar dired-shell-command-history nil
929 "History list for commands that read dired-shell commands.")
930
931 ;;; Default list of shell commands.
932
933 ;;; NOTE: Use `gunzip -c' instead of `zcat' on `.gz' files. Some do not
934 ;;; install GNU zip's version of zcat.
935
936 (defvar dired-guess-shell-alist-default
937 (list
938 (list "\\.tar$" '(if dired-guess-shell-gnutar
939 (concat dired-guess-shell-gnutar " xvf")
940 "tar xvf"))
941
942 ;; REGEXPS for compressed archives must come before the .Z rule to
943 ;; be recognized:
944 (list "\\.tar\\.Z$"
945 ;; Untar it.
946 '(if dired-guess-shell-gnutar
947 (concat dired-guess-shell-gnutar " zxvf")
948 (concat "zcat * | tar xvf -"))
949 ;; Optional conversion to gzip format.
950 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
951 " " dired-guess-shell-znew-switches))
952
953 ;; gzip'ed archives
954 (list "\\.t\\(ar\\.\\)?gz$"
955 '(if dired-guess-shell-gnutar
956 (concat dired-guess-shell-gnutar " zxvf")
957 (concat "gunzip -qc * | tar xvf -"))
958 ;; Optional decompression.
959 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q" "")))
960
961 '("\\.shar.Z$" "zcat * | unshar")
962 '("\\.shar.g?z$" "gunzip -qc * | unshar")
963
964 '("\\.e?ps$" "ghostview" "xv" "lpr")
965 (list "\\.e?ps.g?z$" "gunzip -qc * | ghostview -"
966 ;; Optional decompression.
967 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
968 (list "\\.e?ps.Z$" "zcat * | ghostview -"
969 ;; Optional conversion to gzip format.
970 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
971 " " dired-guess-shell-znew-switches))
972 '("\\.patch$" "cat * | patch")
973 '("\\.patch.g?z$" "gunzip -qc * | patch")
974 (list "\\.patch.Z$" "zcat * | patch"
975 ;; Optional conversion to gzip format.
976 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
977 " " dired-guess-shell-znew-switches))
978
979 '("\\.dvi$" "xdvi" "dvips") ; preview and printing
980 '("\\.au$" "play") ; play Sun audiofiles
981 '("\\.mpg$" "mpeg_play")
982 '("\\.uu$" "uudecode") ; for uudecoded files
983 '("\\.hqx$" "mcvert")
984 '("\\.sh$" "sh") ; execute shell scripts
985 '("\\.xbm$" "bitmap") ; view X11 bitmaps
986 '("\\.gp$" "gnuplot")
987 '("\\.p[bgpn]m$" "xv")
988 '("\\.gif$" "xv") ; view gif pictures
989 '("\\.tif$" "xv")
990 '("\\.jpg$" "xv")
991 '("\\.fig$" "xfig") ; edit fig pictures
992 '("\\.out$" "xgraph") ; for plotting purposes.
993 '("\\.tex$" "latex" "tex")
994 '("\\.texi\\(nfo\\)?$" "makeinfo" "texi2dvi")
995 '("\\.pdf$" "acroread") ; edit PDF files
996
997 ;; Some other popular archivers.
998 '("\\.zoo$" "zoo x//")
999 '("\\.zip$" "unzip")
1000 '("\\.lzh$" "lharc x")
1001 '("\\.arc$" "arc x")
1002 '("\\.shar$" "unshar")
1003
1004 ;; Compression.
1005 (list "\\.g?z$" '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1006 (list "\\.Z$" "uncompress"
1007 ;; Optional conversion to gzip format.
1008 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1009 " " dired-guess-shell-znew-switches))
1010 )
1011
1012 "Default alist used for shell command guessing.
1013 See `dired-guess-shell-alist-user'")
1014
1015 (defvar dired-guess-shell-alist-user nil
1016 "User-defined alist of rules for suggested commands. These rules take
1017 precedence over the predefined rules in the variable
1018 `dired-guess-shell-alist-default' (to which they are prepended).
1019
1020 Each element of this list looks like
1021
1022 \(REGEXP COMMAND...\)
1023
1024 where each COMMAND can either be a string or a lisp expression that evaluates
1025 to a string. If several COMMANDs are given, the first one will be the default
1026 and the rest will be added temporarily to the history and can be retrieved
1027 with \\[previous-history-element] (M-p) .
1028
1029 You can set this variable in your ~/.emacs. For example, to add rules for
1030 `.foo' and `.bar' files, write
1031
1032 \(setq dired-guess-shell-alist-user
1033 (list (list \"\\\\.foo$\" \"FOO-COMMAND\");; fixed rule
1034 ;; possibly more rules ...
1035 (list \"\\\\.bar$\";; rule with condition test
1036 '(if condition
1037 \"BAR-COMMAND-1\"
1038 \"BAR-COMMAND-2\")))\)
1039 ")
1040
1041 (defun dired-guess-default (files)
1042
1043 ;; Guess a shell commands for FILES. Return command or list of commands.
1044 ;; See `dired-guess-shell-alist-user'.
1045
1046 (let* ((case-fold-search nil) ; case-sensitive matching
1047 ;; Prepend the user's alist to the default alist.
1048 (alist (append dired-guess-shell-alist-user
1049 dired-guess-shell-alist-default))
1050 (file (car files))
1051 (flist (cdr files))
1052 elt regexp cmds)
1053
1054 ;; Find the first match in the alist for first file in FILES.
1055 (while alist
1056 (setq elt (car alist)
1057 regexp (car elt)
1058 alist (cdr alist))
1059 (if (string-match regexp file)
1060 (setq cmds (cdr elt)
1061 alist nil)))
1062
1063 ;; If more than one file, see if all of FILES match regular expression.
1064 (while (and flist
1065 (string-match regexp (car flist)))
1066 (setq flist (cdr flist)))
1067
1068 ;; If flist is still non-nil, then do not guess since this means that not
1069 ;; all the files in FILES were matched by the regexp.
1070 (setq cmds (and (not flist) cmds))
1071
1072 ;; Return commands or nil if flist is still non-nil.
1073 ;; Evaluate the commands in order that any logical testing will be done.
1074 (cond ((not (cdr cmds))
1075 (eval (car cmds))) ; single command
1076 (t
1077 (mapcar (function eval) cmds)))))
1078
1079 (defun dired-guess-shell-command (prompt files)
1080
1081 ;; Ask user with PROMPT for a shell command, guessing a default from FILES.
1082
1083 (let ((default (dired-guess-default files))
1084 default-list old-history val (failed t))
1085
1086 (if (null default)
1087 ;; Nothing to guess
1088 (read-from-minibuffer prompt nil nil nil 'dired-shell-command-history)
1089
1090 ;; Save current history list
1091 (setq old-history dired-shell-command-history)
1092
1093 (if (listp default)
1094
1095 ;; More than one guess
1096 (setq default-list default
1097 default (car default)
1098 prompt (concat
1099 prompt
1100 (format "{%d guesses} " (length default-list))))
1101
1102 ;; Just one guess
1103 (setq default-list (list default)))
1104
1105 ;; Push all guesses onto history so that they can be retrieved with M-p
1106 ;; and put the first guess in the prompt but not in the initial value.
1107 (setq dired-shell-command-history
1108 (append default-list dired-shell-command-history)
1109 prompt (concat prompt (format "[%s] " default)))
1110
1111 ;; The unwind-protect returns VAL, and we too.
1112 (unwind-protect
1113 ;; BODYFORM
1114 (progn
1115 (setq val (read-from-minibuffer prompt nil nil nil
1116 'dired-shell-command-history)
1117 failed nil)
1118 ;; If we got a return, then use default.
1119 (if (equal val "")
1120 (setq val default))
1121 val)
1122
1123 ;; UNWINDFORMS
1124 ;; Undo pushing onto the history list so that an aborted
1125 ;; command doesn't get the default in the next command.
1126 (setq dired-shell-command-history old-history)
1127 (if (not failed)
1128 (or (equal val (car-safe dired-shell-command-history))
1129 (setq dired-shell-command-history
1130 (cons val dired-shell-command-history))))))))
1131
1132
1133 ;;; REDEFINE.
1134 ;;; Redefine dired-aux.el's version:
1135 (defun dired-read-shell-command (prompt arg files)
1136 ;; "Read a dired shell command prompting with PROMPT (using read-string).
1137 ;;ARG is the prefix arg and may be used to indicate in the prompt which
1138 ;; files are affected.
1139 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
1140 (dired-mark-pop-up
1141 nil 'shell files
1142 'dired-guess-shell-command
1143 (format prompt (dired-mark-prompt arg files)) ; PROMPT
1144 files)) ; FILES
1145
1146 \f
1147 ;;; RELATIVE SYMBOLIC LINKS.
1148
1149 (defvar dired-keep-marker-relsymlink ?S
1150 "See variable `dired-keep-marker-move'.")
1151
1152 (defun dired-make-relative-symlink (file1 file2 &optional ok-if-already-exists)
1153 "Three arguments: FILE1 FILE2 &optional OK-IF-ALREADY-EXISTS
1154 Make a symbolic link (pointing to FILE1) in FILE2.
1155 The link is relative (if possible), for example
1156
1157 \"/vol/tex/bin/foo\" \"/vol/local/bin/foo\"
1158
1159 results in
1160
1161 \"../../tex/bin/foo\" \"/vol/local/bin/foo\"
1162 "
1163 (interactive "FRelSymLink: \nFRelSymLink %s: \np")
1164 (let (name1 name2 len1 len2 (index 0) sub)
1165 (setq file1 (expand-file-name file1)
1166 file2 (expand-file-name file2)
1167 len1 (length file1)
1168 len2 (length file2))
1169 ;; Find common initial pathname components:
1170 (let (next)
1171 (while (and (setq next (string-match "/" file1 index))
1172 (setq next (1+ next))
1173 (< next (min len1 len2))
1174 ;; For the comparison, both substrings must end in
1175 ;; `/', so NEXT is *one plus* the result of the
1176 ;; string-match.
1177 ;; E.g., consider the case of linking "/tmp/a/abc"
1178 ;; to "/tmp/abc" erroneously giving "/tmp/a" instead
1179 ;; of "/tmp/" as common initial component
1180 (string-equal (substring file1 0 next)
1181 (substring file2 0 next)))
1182 (setq index next))
1183 (setq name2 file2
1184 sub (substring file1 0 index)
1185 name1 (substring file1 index)))
1186 (if (string-equal sub "/")
1187 ;; No common initial pathname found
1188 (setq name1 file1)
1189 ;; Else they have a common parent directory
1190 (let ((tem (substring file2 index))
1191 (start 0)
1192 (count 0))
1193 ;; Count number of slashes we must compensate for ...
1194 (while (setq start (string-match "/" tem start))
1195 (setq count (1+ count)
1196 start (1+ start)))
1197 ;; ... and prepend a "../" for each slash found:
1198 (while (> count 0)
1199 (setq count (1- count)
1200 name1 (concat "../" name1)))))
1201 (make-symbolic-link
1202 (directory-file-name name1) ; must not link to foo/
1203 ; (trailing slash!)
1204 name2 ok-if-already-exists)))
1205
1206 (defun dired-do-relsymlink (&optional arg)
1207 "Relative symlink all marked (or next ARG) files into a directory,
1208 or make a relative symbolic link to the current file.
1209 This creates relative symbolic links like
1210
1211 foo -> ../bar/foo
1212
1213 not absolute ones like
1214
1215 foo -> /ugly/path/that/may/change/any/day/bar/foo"
1216 (interactive "P")
1217 (dired-do-create-files 'relsymlink (function dired-make-relative-symlink)
1218 "RelSymLink" arg dired-keep-marker-relsymlink))
1219
1220 (defun dired-do-relsymlink-regexp (regexp newname &optional whole-path)
1221 "RelSymlink all marked files containing REGEXP to NEWNAME.
1222 See functions `dired-do-rename-regexp' and `dired-do-relsymlink'
1223 for more info."
1224 (interactive (dired-mark-read-regexp "RelSymLink"))
1225 (dired-do-create-files-regexp
1226 (function dired-make-relative-symlink)
1227 "RelSymLink" nil regexp newname whole-path dired-keep-marker-relsymlink))
1228
1229 \f
1230 ;;; VISIT ALL MARKED FILES SIMULTANEOUSLY.
1231
1232 ;;; Brief Description:
1233 ;;;
1234 ;;; `dired-do-find-marked-files' is bound to `F' by dired-x.el.
1235 ;;;
1236 ;;; * Use `dired-get-marked-files' to collect the marked files in the current
1237 ;;; Dired Buffer into a list of filenames `FILE-LIST'.
1238 ;;;
1239 ;;; * Pass FILE-LIST to `dired-simultaneous-find-file' all with
1240 ;;; `dired-do-find-marked-files''s prefix argument NOSELECT.
1241 ;;;
1242 ;;; * `dired-simultaneous-find-file' runs through FILE-LIST decrementing the
1243 ;;; list each time.
1244 ;;;
1245 ;;; * If NOSELECT is non-nil then just run `find-file-noselect' on each
1246 ;;; element of FILE-LIST.
1247 ;;;
1248 ;;; * If NOSELECT is nil then calculate the `size' of the window for each file
1249 ;;; by dividing the `window-height' by length of FILE-LIST. Thus, `size' is
1250 ;;; cognizant of the window-configuration.
1251 ;;;
1252 ;;; * If `size' is too small abort, otherwise run `find-file' on each element
1253 ;;; of FILE-LIST giving each a window of height `size'.
1254
1255 (defun dired-do-find-marked-files (&optional noselect)
1256 "Find all marked files displaying all of them simultaneously.
1257 With optional NOSELECT just find files but do not select them.
1258
1259 The current window is split across all files marked, as evenly as possible.
1260 Remaining lines go to bottom-most window. The number of files that can be
1261 displayed this way is restricted by the height of the current window and
1262 `window-min-height'.
1263
1264 To keep dired buffer displayed, type \\[split-window-vertically] first.
1265 To display just marked files, type \\[delete-other-windows] first."
1266
1267 (interactive "P")
1268 (dired-simultaneous-find-file (dired-get-marked-files) noselect))
1269
1270 (defun dired-simultaneous-find-file (file-list noselect)
1271
1272 ;; Visit all files in FILE-LIST and display them simultaneously. The
1273 ;; current window is split across all files in FILE-LIST, as evenly as
1274 ;; possible. Remaining lines go to the bottom-most window. The number of
1275 ;; files that can be displayed this way is restricted by the height of the
1276 ;; current window and the variable `window-min-height'. With non-nil
1277 ;; NOSELECT the files are merely found but not selected.
1278
1279 ;; We don't make this function interactive because it is usually too clumsy
1280 ;; to specify FILE-LIST interactively unless via dired.
1281
1282 (let (size)
1283
1284 (if noselect
1285 ;; Do not select the buffer.
1286 (find-file-noselect (car file-list))
1287
1288 ;; We will have to select the buffer. Calculate and check window size.
1289 (setq size (/ (window-height) (length file-list)))
1290 (or (<= window-min-height size)
1291 (error "Too many files to visit simultaneously. Try C-u prefix."))
1292 (find-file (car file-list)))
1293
1294 ;; Decrement.
1295 (setq file-list (cdr file-list))
1296
1297 (while file-list
1298
1299 (if noselect
1300 ;; Do not select the buffer.
1301 (find-file-noselect (car file-list))
1302
1303 ;; Vertically split off a window of desired size. Upper window will
1304 ;; have SIZE lines. Select lower (larger) window. We split it again.
1305 (select-window (split-window nil size))
1306 (find-file (car file-list)))
1307
1308 ;; Decrement.
1309 (setq file-list (cdr file-list)))))
1310
1311 \f
1312 ;;; MISCELLANEOUS COMMANDS.
1313
1314 ;;; Run man on files.
1315
1316 (defun dired-man ()
1317 "Run man on this file. Display old buffer if buffer name matches filename.
1318 Uses ../lisp/man.el of \\[manual-entry] fame."
1319 (interactive)
1320 (require 'man)
1321 (let ((file (dired-get-filename))
1322 (manual-program "nroff -man -h"))
1323 (Man-getpage-in-background file)))
1324
1325 ;;; Run Info on files.
1326
1327 (defun dired-info ()
1328 "Run info on this file."
1329 (interactive)
1330 (info (dired-get-filename)))
1331
1332 ;;; Run mail on mail folders.
1333
1334 ;;; (and (not (fboundp 'vm-visit-folder))
1335 ;;; (defun vm-visit-folder (file &optional arg)
1336 ;;; nil))
1337
1338 (defun dired-vm (&optional read-only)
1339 "Run VM on this file.
1340 With prefix arg, visit folder read-only (this requires at least VM 5).
1341 See also variable `dired-vm-read-only-folders'."
1342 (interactive "P")
1343 (let ((dir (dired-current-directory))
1344 (fil (dired-get-filename)))
1345 ;; take care to supply 2nd arg only if requested - may still run VM 4!
1346 (cond (read-only (vm-visit-folder fil t))
1347 ((eq t dired-vm-read-only-folders) (vm-visit-folder fil t))
1348 ((null dired-vm-read-only-folders) (vm-visit-folder fil))
1349 (t (vm-visit-folder fil (not (file-writable-p fil)))))
1350 ;; so that pressing `v' inside VM does prompt within current directory:
1351 (set (make-local-variable 'vm-folder-directory) dir)))
1352
1353 (defun dired-rmail ()
1354 "Run RMAIL on this file."
1355 (interactive)
1356 (rmail (dired-get-filename)))
1357
1358 (defun dired-do-run-mail ()
1359 "If `dired-bind-vm' is t, then function `dired-vm', otherwise `dired-rmail'."
1360 (interactive)
1361 (if dired-bind-vm
1362 ;; Read mail folder using vm.
1363 (dired-vm)
1364 ;; Read mail folder using rmail.
1365 (dired-rmail)))
1366
1367 \f
1368 ;;; MISCELLANEOUS INTERNAL FUNCTIONS.
1369
1370 (or (fboundp 'dired-old-find-buffer-nocreate)
1371 (fset 'dired-old-find-buffer-nocreate
1372 (symbol-function 'dired-find-buffer-nocreate)))
1373
1374 ;;; REDEFINE.
1375 ;;; Redefines dired.el's version of `dired-find-buffer-nocreate'
1376 (defun dired-find-buffer-nocreate (dirname &optional mode)
1377 (if (and dired-find-subdir
1378 ;; don't try to find a wildcard as a subdirectory
1379 (string-equal dirname (file-name-directory dirname)))
1380 (let* ((cur-buf (current-buffer))
1381 (buffers (nreverse
1382 (dired-buffers-for-dir (expand-file-name dirname))))
1383 (cur-buf-matches (and (memq cur-buf buffers)
1384 ;; wildcards must match, too:
1385 (equal dired-directory dirname))))
1386 ;; We don't want to switch to the same buffer---
1387 (setq buffers (delq cur-buf buffers));;need setq with delq
1388 (or (car (sort buffers (function dired-buffer-more-recently-used-p)))
1389 ;; ---unless it's the only possibility:
1390 (and cur-buf-matches cur-buf)))
1391 (dired-old-find-buffer-nocreate dirname mode)))
1392
1393 ;; This should be a builtin
1394 (defun dired-buffer-more-recently-used-p (buffer1 buffer2)
1395 "Return t if BUFFER1 is more recently used than BUFFER2."
1396 (if (equal buffer1 buffer2)
1397 nil
1398 (let ((more-recent nil)
1399 (list (buffer-list)))
1400 (while (and list
1401 (not (setq more-recent (equal buffer1 (car list))))
1402 (not (equal buffer2 (car list))))
1403 (setq list (cdr list)))
1404 more-recent)))
1405
1406 ;;; Same thing as `dired-buffers-for-dir' of dired.el? - lrd 11/23/93
1407 ;;; (defun dired-buffers-for-dir-exact (dir)
1408 ;;; ;; Return a list of buffers that dired DIR (a directory or wildcard)
1409 ;;; ;; at top level, or as subdirectory.
1410 ;;; ;; Top level matches must match the wildcard part too, if any.
1411 ;;; ;; The list is in reverse order of buffer creation, most recent last.
1412 ;;; ;; As a side effect, killed dired buffers for DIR are removed from
1413 ;;; ;; dired-buffers.
1414 ;;; (let ((alist dired-buffers) result elt)
1415 ;;; (while alist
1416 ;;; (setq elt (car alist)
1417 ;;; alist (cdr alist))
1418 ;;; (let ((buf (cdr elt)))
1419 ;;; (if (buffer-name buf)
1420 ;;; ;; Top level must match exactly against dired-directory in
1421 ;;; ;; case one of them is a wildcard.
1422 ;;; (if (or (equal dir (save-excursion (set-buffer buf)
1423 ;;; dired-directory))
1424 ;;; (assoc dir (save-excursion (set-buffer buf)
1425 ;;; dired-subdir-alist)))
1426 ;;; (setq result (cons buf result)))
1427 ;;; ;; else buffer is killed - clean up:
1428 ;;; (setq dired-buffers (delq elt dired-buffers)))))
1429 ;;; result))
1430
1431 ;;; REDEFINE.
1432 ;;; Redefines dired.el's version of `dired-initial-position'
1433 (defun dired-initial-position (dirname)
1434 (end-of-line)
1435 (if dired-find-subdir (dired-goto-subdir dirname)) ; new
1436 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1437
1438 \f
1439 ;; Does anyone use this? - lrd 6/29/93.
1440 ;; Apparently people do use it. - lrd 12/22/97.
1441 (defun dired-mark-sexp (predicate &optional unflag-p)
1442 "Mark files for which PREDICATE returns non-nil.
1443 With a prefix arg, unflag those files instead.
1444
1445 PREDICATE is a lisp expression that can refer to the following symbols:
1446
1447 inode [integer] the inode of the file (only for ls -i output)
1448 s [integer] the size of the file for ls -s output
1449 (usually in blocks or, with -k, in KByte)
1450 mode [string] file permission bits, e.g. \"-rw-r--r--\"
1451 nlink [integer] number of links to file
1452 uid [string] owner
1453 gid [string] group (If the gid is not displayed by ls,
1454 this will still be set (to the same as uid))
1455 size [integer] file size in bytes
1456 time [string] the time that ls displays, e.g. \"Feb 12 14:17\"
1457 name [string] the name of the file
1458 sym [string] if file is a symbolic link, the linked-to name, else \"\"
1459
1460 For example, use
1461
1462 (equal 0 size)
1463
1464 to mark all zero length files."
1465 ;; Using sym="" instead of nil avoids the trap of
1466 ;; (string-match "foo" sym) into which a user would soon fall.
1467 ;; Give `equal' instead of `=' in the example, as this works on
1468 ;; integers and strings.
1469 (interactive "xMark if (lisp expr): \nP")
1470 (message "%s" predicate)
1471 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char))
1472 inode s mode nlink uid gid size time name sym)
1473 (dired-mark-if
1474 (save-excursion
1475 (and
1476 ;; Sets vars
1477 ;; inode s mode nlink uid gid size time name sym
1478
1479 ;; according to current file line. Returns t for success, nil if
1480 ;; there is no file line. Upon success, all variables are set, either
1481 ;; to nil or the appropriate value, so they need not be initialized.
1482 ;; Moves point within the current line.
1483 (if (dired-move-to-filename)
1484 (let (pos
1485 (mode-len 10) ; length of mode string
1486 ;; like in dired.el, but with subexpressions \1=inode, \2=s:
1487 (dired-re-inode-size "\\s *\\([0-9]*\\)\\s *\\([0-9]*\\) ?"))
1488 (beginning-of-line)
1489 (forward-char 2)
1490 (if (looking-at dired-re-inode-size)
1491 (progn
1492 (goto-char (match-end 0))
1493 (setq inode (string-to-int (buffer-substring (match-beginning 1)
1494 (match-end 1)))
1495 s (string-to-int (buffer-substring (match-beginning 2)
1496 (match-end 2)))))
1497 (setq inode nil
1498 s nil))
1499 (setq mode (buffer-substring (point) (+ mode-len (point))))
1500 (forward-char mode-len)
1501 (setq nlink (read (current-buffer)))
1502 ;; Karsten Wenger <kw@cis.uni-muenchen.de> fixed uid.
1503 (setq uid (buffer-substring (+ (point) 1) (progn (forward-word 1) (point))))
1504 (re-search-forward "\\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|Jul\\|Aug\\|Sep\\|Oct\\|Nov\\|Dec\\)")
1505 (goto-char (match-beginning 1))
1506 (forward-char -1)
1507 (setq size (string-to-int (buffer-substring (save-excursion
1508 (backward-word 1)
1509 (setq pos (point)))
1510 (point))))
1511 (goto-char pos)
1512 (backward-word 1)
1513 ;; if no gid is displayed, gid will be set to uid
1514 ;; but user will then not reference it anyway in PREDICATE.
1515 (setq gid (buffer-substring (save-excursion (forward-word 1) (point))
1516 (point))
1517 time (buffer-substring (match-beginning 1)
1518 (1- (dired-move-to-filename)))
1519 name (buffer-substring (point)
1520 (or (dired-move-to-end-of-filename t)
1521 (point)))
1522 sym (progn
1523 (if (looking-at " -> ")
1524 (buffer-substring (progn (forward-char 4) (point))
1525 (progn (end-of-line) (point)))
1526 "")))
1527 t)
1528 nil)
1529 (eval predicate)))
1530 (format "'%s file" predicate))))
1531
1532 \f
1533 ;;; FIND FILE AT POINT.
1534
1535 (defvar dired-x-hands-off-my-keys t
1536 "*t means don't bind `dired-x-find-file' over `find-file' on keyboard.
1537 Similarly for `dired-x-find-file-other-window' over `find-file-other-window'.
1538 If you change this variable after dired-x.el is loaded then do
1539 \\[dired-x-bind-find-file].")
1540
1541 ;;; Bind `dired-x-find-file{-other-window}' over wherever
1542 ;;; `find-file{-other-window}' is bound?
1543 (defun dired-x-bind-find-file ()
1544 "Bind `dired-x-find-file' in place of `find-file' \(or reverse\).
1545 Similarly for `dired-x-find-file-other-window' and `find-file-other-window'.
1546 Binding direction based on `dired-x-hands-off-my-keys'.
1547 This function part of `after-init-hook'."
1548 (interactive)
1549 (if (interactive-p)
1550 (setq dired-x-hands-off-my-keys
1551 (not (y-or-n-p "Bind dired-x-find-file over find-file? "))))
1552 (cond ((not dired-x-hands-off-my-keys)
1553 (substitute-key-definition 'find-file
1554 'dired-x-find-file
1555 (current-global-map))
1556 (substitute-key-definition 'find-file-other-window
1557 'dired-x-find-file-other-window
1558 (current-global-map)))
1559 (t
1560 (substitute-key-definition 'dired-x-find-file
1561 'find-file
1562 (current-global-map))
1563 (substitute-key-definition 'dired-x-find-file-other-window
1564 'find-file-other-window
1565 (current-global-map))))
1566 ;; Clear mini-buffer.
1567 (message nil))
1568
1569 ;;; Now call it so binding is correct and put on `after-init-hook' in case
1570 ;;; user changes binding.
1571 (dired-x-bind-find-file)
1572 (add-hook 'after-init-hook 'dired-x-bind-find-file)
1573
1574 (defun dired-x-find-file (filename)
1575 "Edit file FILENAME.
1576 May create a new window, or reuse an existing one.
1577 See the function `display-buffer'.
1578
1579 Identical to `find-file' except when called interactively, with a prefix arg
1580 \(e.g., \\[universal-argument]\), in which case it guesses filename near
1581 point. Useful for editing file mentioned in buffer you are viewing, or to
1582 test if that file exists. Use minibuffer after snatching filename."
1583 (interactive (list (read-filename-at-point "Find file: ")))
1584 (find-file (expand-file-name filename)))
1585
1586 (defun dired-x-find-file-other-window (filename)
1587 "Edit file FILENAME, in another window.
1588 May create a new window, or reuse an existing one.
1589 See the function `display-buffer'.
1590
1591 Identical to `find-file-other-window' except when called interactively, with a
1592 prefix arg \(e.g., \\[universal-argument]\), in which case it guesses filename
1593 near point. Useful for editing file mentioned in buffer you are viewing, or
1594 to test if that file exists. Use minibuffer after snatching filename."
1595 (interactive (list (read-filename-at-point "Find file: ")))
1596 (find-file-other-window (expand-file-name filename)))
1597
1598 ;;; Internal functions.
1599 (defun dired-filename-at-point ()
1600
1601 ;; Get the filename closest to point, but do not change position. Has a
1602 ;; preference for looking backward when not directly on a symbol. Not
1603 ;; perfect - point must be in middle of or end of filename.
1604
1605 (let ((filename-chars ".a-zA-Z0-9---_/:$+")
1606 (bol (save-excursion (beginning-of-line) (point)))
1607 (eol (save-excursion (end-of-line) (point)))
1608 start end filename)
1609
1610 (save-excursion
1611 ;; First see if just past a filename.
1612 (if (not (eobp))
1613 (if (looking-at "[] \t\n[{}()]") ; whitespace or some parens
1614 (progn
1615 (skip-chars-backward " \n\t\r({[]})")
1616 (if (not (bobp))
1617 (backward-char 1)))))
1618
1619 (if (string-match (concat "[" filename-chars "]")
1620 (char-to-string (following-char)))
1621 (progn
1622 (skip-chars-backward filename-chars)
1623 (setq start (point))
1624 (if (string-match "[/~]" (char-to-string (preceding-char)))
1625 (setq start (1- start)))
1626 (skip-chars-forward filename-chars))
1627
1628 (error "No file found around point!"))
1629
1630 ;; Return string.
1631 (expand-file-name (buffer-substring start (point))))))
1632
1633 (defun read-filename-at-point (prompt)
1634 ;;; Returns filename prompting with PROMPT with completion. If
1635 ;;; `current-prefix-arg' is non-nil, uses name at point as guess.
1636 (if current-prefix-arg
1637 (let ((guess (dired-filename-at-point)))
1638 (read-file-name prompt
1639 (file-name-directory guess)
1640 guess
1641 nil (file-name-nondirectory guess)))
1642 (read-file-name prompt default-directory)))
1643
1644 \f
1645 ;;; BUG REPORTS
1646
1647 ;;; This section is provided for reports. It uses Barry A. Warsaw's
1648 ;;; reporter.el which is bundled with GNU Emacs v19.
1649
1650 (defconst dired-x-version "2.37"
1651 "Revision number of dired-x.el -- dired extra for GNU Emacs v19.
1652 Type \\[dired-x-submit-report] to send a bug report. Available via anonymous
1653 ftp in
1654
1655 /roebling.poly.edu:/pub/packages/dired-x.tar.gz")
1656
1657 (defconst dired-x-help-address "dodd@roebling.poly.edu"
1658 "Address(es) accepting submission of reports on dired-x.el.")
1659
1660 (defconst dired-x-maintainer "Larry"
1661 "First name(s) of people accepting submission of reports on dired-x.el.")
1662
1663 (defconst dired-x-file "dired-x.el"
1664 "Name of file containing emacs lisp code.")
1665
1666 (defconst dired-x-variable-list
1667 (list
1668 'dired-bind-vm
1669 'dired-vm-read-only-folders
1670 'dired-bind-jump
1671 'dired-bind-info
1672 'dired-bind-man
1673 'dired-find-subdir
1674 'dired-enable-local-variables
1675 'dired-local-variables-file
1676 'dired-guess-shell-gnutar
1677 'dired-guess-shell-gzip-quiet
1678 'dired-guess-shell-znew-switches
1679 'dired-guess-shell-alist-user
1680 'dired-clean-up-buffers-too
1681 'dired-omit-files-p
1682 'dired-omit-files
1683 'dired-omit-extensions
1684 )
1685 "List of variables to be appended to reports sent by `dired-x-submit-report.'")
1686
1687 (defun dired-x-submit-report ()
1688 "Submit via reporter.el a bug report on program. Send report on `dired-x-file'
1689 version `dired-x-version,' to `dired-x-maintainer' at address `dired-x-help-address'
1690 listing variables `dired-x-variable-list' in the message."
1691 (interactive)
1692
1693 ;; In case we can't find reporter...
1694 (condition-case err
1695 (progn
1696 ;; Get it if we can.
1697 (require 'reporter)
1698
1699 (reporter-submit-bug-report
1700 dired-x-help-address ; address
1701 (concat dired-x-file " (" dired-x-version ")") ; pkgname
1702 dired-x-variable-list ; varlist
1703 nil nil ; pre-/post-hooks
1704 (concat dired-x-maintainer ","))) ; salutation
1705
1706 ;; ...fail gracefully.
1707 (error
1708 (beep)
1709 (message "Sorry, reporter.el not found."))))
1710
1711 \f
1712 ;; As Barry Warsaw would say: "This might be useful..."
1713 (provide 'dired-x)
1714
1715 ;;; dired-x.el ends here