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