(elp-instrument-function): Use called-interactively-p.
[emacs.git] / lisp / dired-x.el
blob6b44b73b170f31e6fe96053fcc5d63448ac08864
1 ;;; dired-x.el --- extra Dired functionality -*-byte-compile-dynamic: t;-*-
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
10 ;; Copyright (C) 1993, 1994, 1997, 2001, 2003, 2004 Free Software Foundation, Inc.
12 ;; This file is part of GNU Emacs.
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.
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.
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.
29 ;;; Commentary:
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.
37 ;; Please, PLEASE, *PLEASE* see the info pages.
40 ;; BUGS: Type M-x dired-x-submit-report and a report will be generated.
42 ;; INSTALLATION: In your ~/.emacs,
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 ;; )))
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.
59 ;; *Please* see the info pages for more details.
61 ;; User defined variables:
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
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.
86 ;; When loaded this code redefines the following functions of GNU Emacs
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
94 ;; dired-add-entry ../lisp/dired-aux.el
95 ;; dired-read-shell-command ../lisp/dired-aux.el
98 ;;; Code:
100 ;; LOAD.
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).
106 (require 'dired)
108 ;; We will redefine some functions and also need some macros so we need to
109 ;; load dired stuff of GNU Emacs.
111 (require 'dired-aux)
113 ;;; User-defined variables.
115 (defgroup dired-x nil
116 "Extended directory editing (dired-x)."
117 :group 'dired)
119 (defgroup dired-keys nil
120 "Dired keys customizations."
121 :prefix "dired-"
122 :group 'dired-x)
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)
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)
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)
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)
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.
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)
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)))
170 ;; For backward compatibility
171 (defvaralias 'dired-omit-files-p 'dired-omit-mode)
172 (make-obsolete-variable 'dired-omit-files-p 'dired-omit-mode)
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)
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.
188 If there are several Dired buffers for a directory, the most recently
189 used is chosen.
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)
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)
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.
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)
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)
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)
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)
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)
239 ;;; KEY BINDINGS.
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)
255 (if dired-bind-man
256 (define-key dired-mode-map "N" 'dired-man))
258 (if dired-bind-info
259 (define-key dired-mode-map "I" 'dired-info))
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)))
268 ;;; Install into appropriate hooks.
270 (add-hook 'dired-mode-hook 'dired-extra-startup)
271 (add-hook 'dired-after-readin-hook 'dired-omit-expunge)
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].
285 For more features, see variables
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'
305 See also functions
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)
317 ;; These must be done in each new dired buffer.
318 (dired-hack-local-variables)
319 (dired-omit-startup))
322 ;;; BUFFER CLEANING.
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)))
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?
355 ;;; EXTENSION MARKING FUNCTIONS.
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))
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))
379 ;;; Define some unpopular file extensions. Used for cleaning and omitting.
381 (defvar dired-patch-unclean-extensions
382 '(".rej" ".orig")
383 "List of extensions of dispensable files created by the `patch' program.")
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.")
389 (defvar dired-latex-unclean-extensions
390 '(".idx" ".lof" ".lot" ".glo")
391 "List of extensions of dispensable files created by LaTeX.")
393 (defvar dired-bibtex-unclean-extensions
394 '(".blg" ".bbl")
395 "List of extensions of dispensable files created by BibTeX.")
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.")
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))
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)))
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"))))
431 ;;; JUMP.
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))))))))
467 (defun dired-jump-other-window ()
468 "Like \\[dired-jump] (dired-jump) but in other window."
469 (interactive)
470 (dired-jump t))
472 ;;; OMITTING.
474 ;;; Enhanced omitting of lines from directory listings.
475 ;;; Marked files are never omitted.
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.")
485 ;; \017=^O for Omit - other packages can chose other control characters.
486 (defvar dired-omit-marker-char ?\017
487 "Temporary marker used by by dired-omit.
488 Should never be used as marker by the user or other packages.")
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))))
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))
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'.
514 See interactive function `dired-omit-mode' \(\\[dired-omit-mode]\) and
515 variables `dired-omit-mode' and `dired-omit-files'.")
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.
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)))
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 "")))
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 Second optional argument LOCALP is as in `dired-get-filename'."
573 (interactive "P")
574 (let ((dired-marker-char (if unflag-p ?\ 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)))
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))
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
608 ;; omitting is not turned on at all
609 (dired-omit-old-add-entry filename marker-char relative)))
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)
620 ;;; VIRTUAL DIRED MODE.
622 ;;; For browsing `ls -lR' listings in a dired-like fashion.
624 (fset 'virtual-dired 'dired-virtual)
625 (defun dired-virtual (dirname &optional switches)
626 "Put this buffer into Virtual Dired mode.
628 In Virtual Dired mode, all commands that do not actually consult the
629 filesystem will work.
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.
638 If you have save a Dired buffer in a file you can use \\[dired-virtual] to
639 resume it in a later session.
641 Type \\<dired-mode-map>\\[revert-buffer] in the
642 Virtual Dired buffer and answer `y' to convert the virtual to a real
643 dired buffer again. You don't have to do this, though: you can relist
644 single subdirs using \\[dired-do-redisplay]."
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.
650 ;; Optional SWITCHES are the ls switches to use.
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.
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))
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."
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))))
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)))
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
731 \"^ \\(/[^ /]+\\)/?+:$\"
733 to put saved dired buffers automatically into virtual dired mode.
735 Also useful for `auto-mode-alist' (which see) like this:
737 \(setq auto-mode-alist (cons '(\"[^/]\\.dired\\'\" . dired-virtual-mode)
738 auto-mode-alist)\)"
739 (interactive)
740 (dired-virtual (dired-virtual-guess-dir)))
743 ;;; SMART SHELL.
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.
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'.")
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))
770 (defun dired-smart-shell-command (cmd &optional insert)
771 "Like function `shell-command', but in the current Tree 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)))
779 ;;; LOCAL VARIABLES FOR DIRED BUFFERS.
781 ;;; Brief Description:
783 ;;; * `dired-extra-startup' is part of the `dired-mode-hook'.
785 ;;; * `dired-extra-startup' calls `dired-hack-local-variables'
787 ;;; * `dired-hack-local-variables' checks the value of
788 ;;; `dired-local-variables-file'
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.
793 ;;; * If `dired-local-variables-file' satisfies the above, then temporarily
794 ;;; include it in the Dired Buffer at the bottom.
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.
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 Emacs Info pages for more
804 information on local variables. See also `dired-enable-local-variables'.")
806 (defun dired-hack-local-variables ()
807 "Evaluate local variables in `dired-local-variables-file' for dired buffer."
808 (if (and dired-local-variables-file
809 (stringp dired-local-variables-file)
810 (file-exists-p dired-local-variables-file))
811 (let ((opoint (point-max))
812 buffer-read-only
813 ;; In case user has `enable-local-variables' set to nil we
814 ;; override it locally with dired's variable.
815 (enable-local-variables dired-enable-local-variables))
816 ;; Insert 'em.
817 (save-excursion
818 (goto-char opoint)
819 (insert "\^L\n")
820 (insert-file-contents dired-local-variables-file))
821 ;; Hack 'em.
822 (let ((buffer-file-name dired-local-variables-file))
823 (hack-local-variables))
824 ;; Make sure that the modeline shows the proper information.
825 (dired-sort-set-modeline)
826 ;; Delete this stuff: `eobp' is used to find last subdir by dired.el.
827 (delete-region opoint (point-max)))))
829 (defun dired-omit-here-always ()
830 "Create `dired-local-variables-file' for omitting and reverts directory.
831 Sets dired-omit-file-p to t in a local variables file that is readable by
832 dired."
833 (interactive)
834 (if (file-exists-p dired-local-variables-file)
835 (message "File `./%s' already exists." dired-local-variables-file)
837 ;; Create `dired-local-variables-file'.
838 (save-excursion
839 (set-buffer (get-buffer-create " *dot-dired*"))
840 (erase-buffer)
841 (insert "Local Variables:\ndired-omit-mode: t\nEnd:\n")
842 (write-file dired-local-variables-file)
843 (kill-buffer (current-buffer)))
845 ;; Run extra-hooks and revert directory.
846 (dired-extra-startup)
847 (dired-revert)))
850 ;;; GUESS SHELL COMMAND.
852 ;;; Brief Description:
854 ;;; `dired-do-shell-command' is bound to `!' by dired.el.
856 ;;; * Redefine `dired-do-shell-command' so it calls
857 ;;; `dired-guess-shell-command'.
859 ;;; * `dired-guess-shell-command' calls `dired-guess-default' with list of
860 ;;; marked files.
862 ;;; * Parse `dired-guess-shell-alist-user' and
863 ;;; `dired-guess-shell-alist-default' (in that order) for the first REGEXP
864 ;;; that matches the first file in the file list.
866 ;;; * If the REGEXP matches all the entries of the file list then evaluate
867 ;;; COMMAND, which is either a string or a Lisp expression returning a
868 ;;; string. COMMAND may be a list of commands.
870 ;;; * Return this command to `dired-guess-shell-command' which prompts user
871 ;;; with it. The list of commands is temporarily put into the history list.
872 ;;; If a command is used successfully then it is stored permanently in
873 ;;; `dired-shell-command-history'.
875 ;;; Guess what shell command to apply to a file.
876 (defvar dired-shell-command-history nil
877 "History list for commands that read dired-shell commands.")
879 ;;; Default list of shell commands.
881 ;;; NOTE: Use `gunzip -c' instead of `zcat' on `.gz' files. Some do not
882 ;;; install GNU zip's version of zcat.
884 (defvar dired-guess-shell-alist-default
885 (list
886 (list "\\.tar$"
887 '(if dired-guess-shell-gnutar
888 (concat dired-guess-shell-gnutar " xvf")
889 "tar xvf")
890 ;; Extract files into a separate subdirectory
891 '(if dired-guess-shell-gnutar
892 (concat "mkdir " (file-name-sans-extension file)
893 "; " dired-guess-shell-gnutar " -C "
894 (file-name-sans-extension file) " -xvf")
895 (concat "mkdir " (file-name-sans-extension file)
896 "; tar -C " (file-name-sans-extension file) " -xvf")))
898 ;; REGEXPS for compressed archives must come before the .Z rule to
899 ;; be recognized:
900 (list "\\.tar\\.Z$"
901 ;; Untar it.
902 '(if dired-guess-shell-gnutar
903 (concat dired-guess-shell-gnutar " zxvf")
904 (concat "zcat * | tar xvf -"))
905 ;; Optional conversion to gzip format.
906 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
907 " " dired-guess-shell-znew-switches))
909 ;; gzip'ed archives
910 (list "\\.t\\(ar\\.\\)?gz$"
911 '(if dired-guess-shell-gnutar
912 (concat dired-guess-shell-gnutar " zxvf")
913 (concat "gunzip -qc * | tar xvf -"))
914 ;; Extract files into a separate subdirectory
915 '(if dired-guess-shell-gnutar
916 (concat "mkdir " (file-name-sans-extension file)
917 "; " dired-guess-shell-gnutar " -C "
918 (file-name-sans-extension file) " -zxvf")
919 (concat "mkdir " (file-name-sans-extension file)
920 "; gunzip -qc * | tar -C "
921 (file-name-sans-extension file) " -xvf -"))
922 ;; Optional decompression.
923 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q" "")))
925 ;; bzip2'ed archives
926 (list "\\.t\\(ar\\.bz2\\|bz\\)$"
927 "bunzip2 -c * | tar xvf -"
928 ;; Extract files into a separate subdirectory
929 '(concat "mkdir " (file-name-sans-extension file)
930 "; bunzip2 -c * | tar -C "
931 (file-name-sans-extension file) " -xvf -")
932 ;; Optional decompression.
933 "bunzip2")
935 '("\\.shar\\.Z$" "zcat * | unshar")
936 '("\\.shar\\.g?z$" "gunzip -qc * | unshar")
938 '("\\.e?ps$" "ghostview" "xloadimage" "lpr")
939 (list "\\.e?ps\\.g?z$" "gunzip -qc * | ghostview -"
940 ;; Optional decompression.
941 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
942 (list "\\.e?ps\\.Z$" "zcat * | ghostview -"
943 ;; Optional conversion to gzip format.
944 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
945 " " dired-guess-shell-znew-switches))
947 '("\\.patch$" "cat * | patch")
948 (list "\\.patch\\.g?z$" "gunzip -qc * | patch"
949 ;; Optional decompression.
950 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
951 (list "\\.patch\\.Z$" "zcat * | patch"
952 ;; Optional conversion to gzip format.
953 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
954 " " dired-guess-shell-znew-switches))
956 ;; The following four extensions are useful with dired-man ("N" key)
957 (list "\\.[0-9]$" '(progn (require 'man)
958 (if (Man-support-local-filenames)
959 "man -l"
960 "cat * | tbl | nroff -man -h")))
961 (list "\\.[0-9]\\.g?z$" '(progn (require 'man)
962 (if (Man-support-local-filenames)
963 "man -l"
964 "gunzip -qc * | tbl | nroff -man -h"))
965 ;; Optional decompression.
966 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
967 (list "\\.[0-9]\\.Z$" '(progn (require 'man)
968 (if (Man-support-local-filenames)
969 "man -l"
970 "zcat * | tbl | nroff -man -h"))
971 ;; Optional conversion to gzip format.
972 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
973 " " dired-guess-shell-znew-switches))
974 '("\\.pod$" "perldoc" "pod2man * | nroff -man")
976 '("\\.dvi$" "xdvi" "dvips") ; preview and printing
977 '("\\.au$" "play") ; play Sun audiofiles
978 '("\\.mpg$" "mpeg_play")
979 '("\\.uu$" "uudecode") ; for uudecoded files
980 '("\\.hqx$" "mcvert")
981 '("\\.sh$" "sh") ; execute shell scripts
982 '("\\.xbm$" "bitmap") ; view X11 bitmaps
983 '("\\.gp$" "gnuplot")
984 '("\\.p[bgpn]m$" "xloadimage")
985 '("\\.gif$" "xloadimage") ; view gif pictures
986 '("\\.tif$" "xloadimage")
987 '("\\.png$" "display") ; xloadimage 4.1 doesn't grok PNG
988 '("\\.jpe?g$" "xloadimage")
989 '("\\.fig$" "xfig") ; edit fig pictures
990 '("\\.out$" "xgraph") ; for plotting purposes.
991 '("\\.tex$" "latex" "tex")
992 '("\\.texi\\(nfo\\)?$" "makeinfo" "texi2dvi")
993 '("\\.pdf$" "xpdf") ; edit PDF files
995 ;; Some other popular archivers.
996 (list "\\.zip$" "unzip"
997 ;; Extract files into a separate subdirectory
998 '(concat "unzip" (if dired-guess-shell-gzip-quiet " -q")
999 " -d " (file-name-sans-extension file)))
1000 '("\\.zoo$" "zoo x//")
1001 '("\\.lzh$" "lharc x")
1002 '("\\.arc$" "arc x")
1003 '("\\.shar$" "unshar")
1005 ;; Compression.
1006 (list "\\.g?z$" '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1007 (list "\\.dz$" "dictunzip")
1008 (list "\\.bz2$" "bunzip2")
1009 (list "\\.Z$" "uncompress"
1010 ;; Optional conversion to gzip format.
1011 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1012 " " dired-guess-shell-znew-switches))
1015 "Default alist used for shell command guessing.
1016 See `dired-guess-shell-alist-user'.")
1018 (defcustom dired-guess-shell-alist-user nil
1019 "User-defined alist of rules for suggested commands.
1020 These rules take precedence over the predefined rules in the variable
1021 `dired-guess-shell-alist-default' (to which they are prepended).
1023 Each element of this list looks like
1025 \(REGEXP COMMAND...\)
1027 where each COMMAND can either be a string or a lisp expression that evaluates
1028 to a string. If several COMMANDs are given, the first one will be the default
1029 and the rest will be added temporarily to the history and can be retrieved
1030 with \\[previous-history-element] (M-p) .
1032 You can set this variable in your ~/.emacs. For example, to add rules for
1033 `.foo' and `.bar' files, write
1035 \(setq dired-guess-shell-alist-user
1036 (list (list \"\\\\.foo\\\\'\" \"FOO-COMMAND\");; fixed rule
1037 ;; possibly more rules ...
1038 (list \"\\\\.bar\\\'\";; rule with condition test
1039 '(if condition
1040 \"BAR-COMMAND-1\"
1041 \"BAR-COMMAND-2\")))\)"
1042 :group 'dired-x
1043 :type '(alist :key-type regexp :value-type (repeat sexp)))
1045 (defcustom dired-guess-shell-case-fold-search t
1046 "If non-nil, `dired-guess-shell-alist-default' and
1047 `dired-guess-shell-alist-user' are matched case-insensitively."
1048 :group 'dired-x
1049 :type 'boolean)
1051 (defun dired-guess-default (files)
1052 "Guess a shell commands for FILES. Return command or list of commands.
1053 See `dired-guess-shell-alist-user'."
1055 (let* ((case-fold-search dired-guess-shell-case-fold-search)
1056 ;; Prepend the user's alist to the default alist.
1057 (alist (append dired-guess-shell-alist-user
1058 dired-guess-shell-alist-default))
1059 (file (car files))
1060 (flist (cdr files))
1061 elt regexp cmds)
1063 ;; Find the first match in the alist for first file in FILES.
1064 (while alist
1065 (setq elt (car alist)
1066 regexp (car elt)
1067 alist (cdr alist))
1068 (if (string-match regexp file)
1069 (setq cmds (cdr elt)
1070 alist nil)))
1072 ;; If more than one file, see if all of FILES match regular expression.
1073 (while (and flist
1074 (string-match regexp (car flist)))
1075 (setq flist (cdr flist)))
1077 ;; If flist is still non-nil, then do not guess since this means that not
1078 ;; all the files in FILES were matched by the regexp.
1079 (setq cmds (and (not flist) cmds))
1081 ;; Return commands or nil if flist is still non-nil.
1082 ;; Evaluate the commands in order that any logical testing will be done.
1083 (cond ((not (cdr cmds))
1084 (eval (car cmds))) ; single command
1086 (mapcar (function eval) cmds)))))
1088 (defun dired-guess-shell-command (prompt files)
1089 "Ask user with PROMPT for a shell command, guessing a default from FILES."
1091 (let ((default (dired-guess-default files))
1092 default-list old-history val (failed t))
1094 (if (null default)
1095 ;; Nothing to guess
1096 (read-from-minibuffer prompt nil nil nil 'dired-shell-command-history)
1098 ;; Save current history list
1099 (setq old-history dired-shell-command-history)
1101 (if (listp default)
1103 ;; More than one guess
1104 (setq default-list default
1105 default (car default)
1106 prompt (concat
1107 prompt
1108 (format "{%d guesses} " (length default-list))))
1110 ;; Just one guess
1111 (setq default-list (list default)))
1113 ;; Push all guesses onto history so that they can be retrieved with M-p
1114 ;; and put the first guess in the prompt but not in the initial value.
1115 (setq dired-shell-command-history
1116 (append default-list dired-shell-command-history)
1117 prompt (concat prompt (format "[%s] " default)))
1119 ;; The unwind-protect returns VAL, and we too.
1120 (unwind-protect
1121 ;; BODYFORM
1122 (progn
1123 (setq val (read-from-minibuffer prompt nil nil nil
1124 'dired-shell-command-history)
1125 failed nil)
1126 ;; If we got a return, then use default.
1127 (if (equal val "")
1128 (setq val default))
1129 val)
1131 ;; UNWINDFORMS
1132 ;; Undo pushing onto the history list so that an aborted
1133 ;; command doesn't get the default in the next command.
1134 (setq dired-shell-command-history old-history)
1135 (if (not failed)
1136 (or (equal val (car-safe dired-shell-command-history))
1137 (setq dired-shell-command-history
1138 (cons val dired-shell-command-history))))))))
1141 ;;; REDEFINE.
1142 ;;; Redefine dired-aux.el's version:
1143 (defun dired-read-shell-command (prompt arg files)
1144 "Read a dired shell command prompting with PROMPT (using read-string).
1145 ARG is the prefix arg and may be used to indicate in the prompt which
1146 files are affected.
1147 This is an extra function so that you can redefine it."
1148 (dired-mark-pop-up
1149 nil 'shell files
1150 'dired-guess-shell-command
1151 (format prompt (dired-mark-prompt arg files)) ; PROMPT
1152 files)) ; FILES
1155 ;;; RELATIVE SYMBOLIC LINKS.
1157 (defvar dired-keep-marker-relsymlink ?S
1158 "See variable `dired-keep-marker-move'.")
1160 (defun dired-make-relative-symlink (file1 file2 &optional ok-if-already-exists)
1161 "Make a symbolic link (pointing to FILE1) in FILE2.
1162 The link is relative (if possible), for example
1164 \"/vol/tex/bin/foo\" \"/vol/local/bin/foo\"
1166 results in
1168 \"../../tex/bin/foo\" \"/vol/local/bin/foo\""
1169 (interactive "FRelSymLink: \nFRelSymLink %s: \np")
1170 (let (name1 name2 len1 len2 (index 0) sub)
1171 (setq file1 (expand-file-name file1)
1172 file2 (expand-file-name file2)
1173 len1 (length file1)
1174 len2 (length file2))
1175 ;; Find common initial file name components:
1176 (let (next)
1177 (while (and (setq next (string-match "/" file1 index))
1178 (setq next (1+ next))
1179 (< next (min len1 len2))
1180 ;; For the comparison, both substrings must end in
1181 ;; `/', so NEXT is *one plus* the result of the
1182 ;; string-match.
1183 ;; E.g., consider the case of linking "/tmp/a/abc"
1184 ;; to "/tmp/abc" erroneously giving "/tmp/a" instead
1185 ;; of "/tmp/" as common initial component
1186 (string-equal (substring file1 0 next)
1187 (substring file2 0 next)))
1188 (setq index next))
1189 (setq name2 file2
1190 sub (substring file1 0 index)
1191 name1 (substring file1 index)))
1192 (if (string-equal sub "/")
1193 ;; No common initial file name found
1194 (setq name1 file1)
1195 ;; Else they have a common parent directory
1196 (let ((tem (substring file2 index))
1197 (start 0)
1198 (count 0))
1199 ;; Count number of slashes we must compensate for ...
1200 (while (setq start (string-match "/" tem start))
1201 (setq count (1+ count)
1202 start (1+ start)))
1203 ;; ... and prepend a "../" for each slash found:
1204 (while (> count 0)
1205 (setq count (1- count)
1206 name1 (concat "../" name1)))))
1207 (make-symbolic-link
1208 (directory-file-name name1) ; must not link to foo/
1209 ; (trailing slash!)
1210 name2 ok-if-already-exists)))
1212 (defun dired-do-relsymlink (&optional arg)
1213 "Relative symlink all marked (or next ARG) files into a directory.
1214 Otherwise make a relative symbolic link to the current file.
1215 This creates relative symbolic links like
1217 foo -> ../bar/foo
1219 not absolute ones like
1221 foo -> /ugly/file/name/that/may/change/any/day/bar/foo"
1222 (interactive "P")
1223 (dired-do-create-files 'relsymlink (function dired-make-relative-symlink)
1224 "RelSymLink" arg dired-keep-marker-relsymlink))
1226 (defun dired-do-relsymlink-regexp (regexp newname &optional whole-name)
1227 "RelSymlink all marked files containing REGEXP to NEWNAME.
1228 See functions `dired-do-rename-regexp' and `dired-do-relsymlink'
1229 for more info."
1230 (interactive (dired-mark-read-regexp "RelSymLink"))
1231 (dired-do-create-files-regexp
1232 (function dired-make-relative-symlink)
1233 "RelSymLink" nil regexp newname whole-name dired-keep-marker-relsymlink))
1236 ;;; VISIT ALL MARKED FILES SIMULTANEOUSLY.
1238 ;;; Brief Description:
1240 ;;; `dired-do-find-marked-files' is bound to `F' by dired-x.el.
1242 ;;; * Use `dired-get-marked-files' to collect the marked files in the current
1243 ;;; Dired Buffer into a list of filenames `FILE-LIST'.
1245 ;;; * Pass FILE-LIST to `dired-simultaneous-find-file' all with
1246 ;;; `dired-do-find-marked-files''s prefix argument NOSELECT.
1248 ;;; * `dired-simultaneous-find-file' runs through FILE-LIST decrementing the
1249 ;;; list each time.
1251 ;;; * If NOSELECT is non-nil then just run `find-file-noselect' on each
1252 ;;; element of FILE-LIST.
1254 ;;; * If NOSELECT is nil then calculate the `size' of the window for each file
1255 ;;; by dividing the `window-height' by length of FILE-LIST. Thus, `size' is
1256 ;;; cognizant of the window-configuration.
1258 ;;; * If `size' is too small abort, otherwise run `find-file' on each element
1259 ;;; of FILE-LIST giving each a window of height `size'.
1261 (defun dired-do-find-marked-files (&optional noselect)
1262 "Find all marked files displaying all of them simultaneously.
1263 With optional NOSELECT just find files but do not select them.
1265 The current window is split across all files marked, as evenly as possible.
1266 Remaining lines go to bottom-most window. The number of files that can be
1267 displayed this way is restricted by the height of the current window and
1268 `window-min-height'.
1270 To keep dired buffer displayed, type \\[split-window-vertically] first.
1271 To display just marked files, type \\[delete-other-windows] first."
1273 (interactive "P")
1274 (dired-simultaneous-find-file (dired-get-marked-files) noselect))
1276 (defun dired-simultaneous-find-file (file-list noselect)
1278 "Visit all files in FILE-LIST and display them simultaneously.
1279 The current window is split across all files in FILE-LIST, as evenly as
1280 possible. Remaining lines go to the bottom-most window. The number of
1281 files that can be displayed this way is restricted by the height of the
1282 current window and the variable `window-min-height'. With non-nil
1283 NOSELECT the files are merely found but not selected."
1285 ;; We don't make this function interactive because it is usually too clumsy
1286 ;; to specify FILE-LIST interactively unless via dired.
1288 (let (size)
1290 (if noselect
1291 ;; Do not select the buffer.
1292 (find-file-noselect (car file-list))
1294 ;; We will have to select the buffer. Calculate and check window size.
1295 (setq size (/ (window-height) (length file-list)))
1296 (or (<= window-min-height size)
1297 (error "Too many files to visit simultaneously. Try C-u prefix"))
1298 (find-file (car file-list)))
1300 ;; Decrement.
1301 (setq file-list (cdr file-list))
1303 (while file-list
1305 (if noselect
1306 ;; Do not select the buffer.
1307 (find-file-noselect (car file-list))
1309 ;; Vertically split off a window of desired size. Upper window will
1310 ;; have SIZE lines. Select lower (larger) window. We split it again.
1311 (select-window (split-window nil size))
1312 (find-file (car file-list)))
1314 ;; Decrement.
1315 (setq file-list (cdr file-list)))))
1318 ;;; MISCELLANEOUS COMMANDS.
1320 ;;; Run man on files.
1322 (defun dired-man ()
1323 "Run man on this file. Display old buffer if buffer name matches filename.
1324 Uses ../lisp/man.el of \\[manual-entry] fame."
1325 (interactive)
1326 (require 'man)
1327 (let* ((file (dired-get-filename))
1328 (manual-program (replace-regexp-in-string "\\*" "%s"
1329 (dired-guess-shell-command
1330 "Man command: " (list file)))))
1331 (Man-getpage-in-background file)))
1333 ;;; Run Info on files.
1335 (defun dired-info ()
1336 "Run info on this file."
1337 (interactive)
1338 (info (dired-get-filename)))
1340 ;;; Run mail on mail folders.
1342 ;;; (and (not (fboundp 'vm-visit-folder))
1343 ;;; (defun vm-visit-folder (file &optional arg)
1344 ;;; nil))
1346 (defun dired-vm (&optional read-only)
1347 "Run VM on this file.
1348 With prefix arg, visit folder read-only (this requires at least VM 5).
1349 See also variable `dired-vm-read-only-folders'."
1350 (interactive "P")
1351 (let ((dir (dired-current-directory))
1352 (fil (dired-get-filename)))
1353 ;; take care to supply 2nd arg only if requested - may still run VM 4!
1354 (cond (read-only (vm-visit-folder fil t))
1355 ((eq t dired-vm-read-only-folders) (vm-visit-folder fil t))
1356 ((null dired-vm-read-only-folders) (vm-visit-folder fil))
1357 (t (vm-visit-folder fil (not (file-writable-p fil)))))
1358 ;; so that pressing `v' inside VM does prompt within current directory:
1359 (set (make-local-variable 'vm-folder-directory) dir)))
1361 (defun dired-rmail ()
1362 "Run RMAIL on this file."
1363 (interactive)
1364 (rmail (dired-get-filename)))
1366 (defun dired-do-run-mail ()
1367 "If `dired-bind-vm' is t, then function `dired-vm', otherwise `dired-rmail'."
1368 (interactive)
1369 (if dired-bind-vm
1370 ;; Read mail folder using vm.
1371 (dired-vm)
1372 ;; Read mail folder using rmail.
1373 (dired-rmail)))
1376 ;;; MISCELLANEOUS INTERNAL FUNCTIONS.
1378 (or (fboundp 'dired-old-find-buffer-nocreate)
1379 (fset 'dired-old-find-buffer-nocreate
1380 (symbol-function 'dired-find-buffer-nocreate)))
1382 ;;; REDEFINE.
1383 ;;; Redefines dired.el's version of `dired-find-buffer-nocreate'
1384 (defun dired-find-buffer-nocreate (dirname &optional mode)
1385 (if (and dired-find-subdir
1386 ;; don't try to find a wildcard as a subdirectory
1387 (string-equal dirname (file-name-directory dirname)))
1388 (let* ((cur-buf (current-buffer))
1389 (buffers (nreverse
1390 (dired-buffers-for-dir (expand-file-name dirname))))
1391 (cur-buf-matches (and (memq cur-buf buffers)
1392 ;; wildcards must match, too:
1393 (equal dired-directory dirname))))
1394 ;; We don't want to switch to the same buffer---
1395 (setq buffers (delq cur-buf buffers));;need setq with delq
1396 (or (car (sort buffers (function dired-buffer-more-recently-used-p)))
1397 ;; ---unless it's the only possibility:
1398 (and cur-buf-matches cur-buf)))
1399 (dired-old-find-buffer-nocreate dirname mode)))
1401 ;; This should be a builtin
1402 (defun dired-buffer-more-recently-used-p (buffer1 buffer2)
1403 "Return t if BUFFER1 is more recently used than BUFFER2."
1404 (if (equal buffer1 buffer2)
1406 (let ((more-recent nil)
1407 (list (buffer-list)))
1408 (while (and list
1409 (not (setq more-recent (equal buffer1 (car list))))
1410 (not (equal buffer2 (car list))))
1411 (setq list (cdr list)))
1412 more-recent)))
1414 ;;; Same thing as `dired-buffers-for-dir' of dired.el? - lrd 11/23/93
1415 ;;; (defun dired-buffers-for-dir-exact (dir)
1416 ;;; ;; Return a list of buffers that dired DIR (a directory or wildcard)
1417 ;;; ;; at top level, or as subdirectory.
1418 ;;; ;; Top level matches must match the wildcard part too, if any.
1419 ;;; ;; The list is in reverse order of buffer creation, most recent last.
1420 ;;; ;; As a side effect, killed dired buffers for DIR are removed from
1421 ;;; ;; dired-buffers.
1422 ;;; (let ((alist dired-buffers) result elt)
1423 ;;; (while alist
1424 ;;; (setq elt (car alist)
1425 ;;; alist (cdr alist))
1426 ;;; (let ((buf (cdr elt)))
1427 ;;; (if (buffer-name buf)
1428 ;;; ;; Top level must match exactly against dired-directory in
1429 ;;; ;; case one of them is a wildcard.
1430 ;;; (if (or (equal dir (save-excursion (set-buffer buf)
1431 ;;; dired-directory))
1432 ;;; (assoc dir (save-excursion (set-buffer buf)
1433 ;;; dired-subdir-alist)))
1434 ;;; (setq result (cons buf result)))
1435 ;;; ;; else buffer is killed - clean up:
1436 ;;; (setq dired-buffers (delq elt dired-buffers)))))
1437 ;;; result))
1439 ;;; REDEFINE.
1440 ;;; Redefines dired.el's version of `dired-initial-position'
1441 (defun dired-initial-position (dirname)
1442 "Where point should go in a new listing of DIRNAME.
1443 Point assumed at beginning of new subdir line.
1444 You may redefine this function as you wish, e.g. like in dired-x.el."
1445 (end-of-line)
1446 (if dired-find-subdir (dired-goto-subdir dirname)) ; new
1447 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1450 ;; Does anyone use this? - lrd 6/29/93.
1451 ;; Apparently people do use it. - lrd 12/22/97.
1452 (defun dired-mark-sexp (predicate &optional unflag-p)
1453 "Mark files for which PREDICATE returns non-nil.
1454 With a prefix arg, unflag those files instead.
1456 PREDICATE is a lisp expression that can refer to the following symbols:
1458 inode [integer] the inode of the file (only for ls -i output)
1459 s [integer] the size of the file for ls -s output
1460 (usually in blocks or, with -k, in KByte)
1461 mode [string] file permission bits, e.g. \"-rw-r--r--\"
1462 nlink [integer] number of links to file
1463 uid [string] owner
1464 gid [string] group (If the gid is not displayed by ls,
1465 this will still be set (to the same as uid))
1466 size [integer] file size in bytes
1467 time [string] the time that ls displays, e.g. \"Feb 12 14:17\"
1468 name [string] the name of the file
1469 sym [string] if file is a symbolic link, the linked-to name, else \"\"
1471 For example, use
1473 (equal 0 size)
1475 to mark all zero length files."
1476 ;; Using sym="" instead of nil avoids the trap of
1477 ;; (string-match "foo" sym) into which a user would soon fall.
1478 ;; Give `equal' instead of `=' in the example, as this works on
1479 ;; integers and strings.
1480 (interactive "xMark if (lisp expr): \nP")
1481 (message "%s" predicate)
1482 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char))
1483 inode s mode nlink uid gid size time name sym)
1484 (dired-mark-if
1485 (save-excursion
1486 (and
1487 ;; Sets vars
1488 ;; inode s mode nlink uid gid size time name sym
1490 ;; according to current file line. Returns t for success, nil if
1491 ;; there is no file line. Upon success, all variables are set, either
1492 ;; to nil or the appropriate value, so they need not be initialized.
1493 ;; Moves point within the current line.
1494 (if (dired-move-to-filename)
1495 (let (pos
1496 (mode-len 10) ; length of mode string
1497 ;; like in dired.el, but with subexpressions \1=inode, \2=s:
1498 (dired-re-inode-size "\\s *\\([0-9]*\\)\\s *\\([0-9]*\\) ?"))
1499 (beginning-of-line)
1500 (forward-char 2)
1501 (if (looking-at dired-re-inode-size)
1502 (progn
1503 (goto-char (match-end 0))
1504 (setq inode (string-to-int (buffer-substring (match-beginning 1)
1505 (match-end 1)))
1506 s (string-to-int (buffer-substring (match-beginning 2)
1507 (match-end 2)))))
1508 (setq inode nil
1509 s nil))
1510 (setq mode (buffer-substring (point) (+ mode-len (point))))
1511 (forward-char mode-len)
1512 (setq nlink (read (current-buffer)))
1513 ;; Karsten Wenger <kw@cis.uni-muenchen.de> fixed uid.
1514 (setq uid (buffer-substring (+ (point) 1)
1515 (progn (forward-word 1) (point))))
1516 (re-search-forward dired-move-to-filename-regexp)
1517 (goto-char (match-beginning 1))
1518 (forward-char -1)
1519 (setq size (string-to-int (buffer-substring (save-excursion
1520 (backward-word 1)
1521 (setq pos (point)))
1522 (point))))
1523 (goto-char pos)
1524 (backward-word 1)
1525 ;; if no gid is displayed, gid will be set to uid
1526 ;; but user will then not reference it anyway in PREDICATE.
1527 (setq gid (buffer-substring (save-excursion
1528 (forward-word 1) (point))
1529 (point))
1530 time (buffer-substring (match-beginning 1)
1531 (1- (dired-move-to-filename)))
1532 name (buffer-substring (point)
1534 (dired-move-to-end-of-filename t)
1535 (point)))
1536 sym (progn
1537 (if (looking-at " -> ")
1538 (buffer-substring
1539 (progn (forward-char 4) (point))
1540 (progn (end-of-line) (point)))
1541 "")))
1543 nil)
1544 (eval predicate)))
1545 (format "'%s file" predicate))))
1548 ;;; FIND FILE AT POINT.
1550 (defvar dired-x-hands-off-my-keys t
1551 "*Non-nil means don't bind `dired-x-find-file' over `find-file' on keyboard.
1552 Similarly for `dired-x-find-file-other-window' over `find-file-other-window'.
1553 If you change this variable after dired-x.el is loaded then do
1554 \\[dired-x-bind-find-file].")
1556 ;;; Bind `dired-x-find-file{-other-window}' over wherever
1557 ;;; `find-file{-other-window}' is bound?
1558 (defun dired-x-bind-find-file ()
1559 "Bind `dired-x-find-file' in place of `find-file' \(or reverse\).
1560 Similarly for `dired-x-find-file-other-window' and `find-file-other-window'.
1561 Binding direction based on `dired-x-hands-off-my-keys'.
1562 This function part of `after-init-hook'."
1563 (interactive)
1564 (if (interactive-p)
1565 (setq dired-x-hands-off-my-keys
1566 (not (y-or-n-p "Bind dired-x-find-file over find-file? "))))
1567 (cond ((not dired-x-hands-off-my-keys)
1568 (substitute-key-definition 'find-file
1569 'dired-x-find-file
1570 (current-global-map))
1571 (substitute-key-definition 'find-file-other-window
1572 'dired-x-find-file-other-window
1573 (current-global-map)))
1575 (substitute-key-definition 'dired-x-find-file
1576 'find-file
1577 (current-global-map))
1578 (substitute-key-definition 'dired-x-find-file-other-window
1579 'find-file-other-window
1580 (current-global-map))))
1581 ;; Clear mini-buffer.
1582 (message nil))
1584 ;;; Now call it so binding is correct and put on `after-init-hook' in case
1585 ;;; user changes binding.
1586 (dired-x-bind-find-file)
1587 (add-hook 'after-init-hook 'dired-x-bind-find-file)
1589 (defun dired-x-find-file (filename)
1590 "Edit file FILENAME.
1591 May create a new window, or reuse an existing one.
1592 See the function `display-buffer'.
1594 Identical to `find-file' except when called interactively, with a prefix arg
1595 \(e.g., \\[universal-argument]\), in which case it guesses filename near
1596 point. Useful for editing file mentioned in buffer you are viewing, or to
1597 test if that file exists. Use minibuffer after snatching filename."
1598 (interactive (list (read-filename-at-point "Find file: ")))
1599 (find-file (expand-file-name filename)))
1601 (defun dired-x-find-file-other-window (filename)
1602 "Edit file FILENAME, in another window.
1603 May create a new window, or reuse an existing one.
1604 See the function `display-buffer'.
1606 Identical to `find-file-other-window' except when called interactively, with a
1607 prefix arg \(e.g., \\[universal-argument]\), in which case it guesses filename
1608 near point. Useful for editing file mentioned in buffer you are viewing, or
1609 to test if that file exists. Use minibuffer after snatching filename."
1610 (interactive (list (read-filename-at-point "Find file: ")))
1611 (find-file-other-window (expand-file-name filename)))
1613 ;;; Internal functions.
1615 ;; Fixme: This should probably use `thing-at-point'. -- fx
1616 (defun dired-filename-at-point ()
1617 "Get the filename closest to point, but do not change position.
1618 Has a preference for looking backward when not directly on a symbol. Not
1619 perfect - point must be in middle of or end of filename."
1621 (let ((filename-chars "-.[:alnum:]_/:$+@")
1622 start end filename prefix)
1624 (save-excursion
1625 ;; First see if just past a filename.
1626 (if (not (eobp))
1627 (if (looking-at "[] \t\n[{}()]") ; whitespace or some parens
1628 (progn
1629 (skip-chars-backward " \n\t\r({[]})")
1630 (if (not (bobp))
1631 (backward-char 1)))))
1633 (if (string-match (concat "[" filename-chars "]")
1634 (char-to-string (following-char)))
1635 (progn
1636 (if (re-search-backward (concat "[^" filename-chars "]") nil t)
1637 (forward-char)
1638 (goto-char (point-min)))
1639 (setq start (point))
1640 (setq prefix
1641 (and (string-match
1642 "^\\w+@"
1643 (buffer-substring start (line-beginning-position)))
1644 "/"))
1645 (goto-char start)
1646 (if (string-match "[/~]" (char-to-string (preceding-char)))
1647 (setq start (1- start)))
1648 (re-search-forward (concat "\\=[" filename-chars "]*") nil t))
1650 (error "No file found around point!"))
1652 ;; Return string.
1653 (expand-file-name (concat prefix (buffer-substring start (point)))))))
1655 (defun read-filename-at-point (prompt)
1656 "Return filename prompting with PROMPT with completion.
1657 If `current-prefix-arg' is non-nil, uses name at point as guess."
1658 (if current-prefix-arg
1659 (let ((guess (dired-filename-at-point)))
1660 (read-file-name prompt
1661 (file-name-directory guess)
1662 guess
1663 nil (file-name-nondirectory guess)))
1664 (read-file-name prompt default-directory)))
1666 ;;; BUG REPORTS
1668 ;; Fixme: get rid of this later.
1670 ;;; This section is provided for reports. It uses Barry A. Warsaw's
1671 ;;; reporter.el which is bundled with GNU Emacs v19.
1673 (defconst dired-x-help-address "bug-gnu-emacs@gnu.org"
1674 "Address(es) accepting submission of reports on dired-x.el.")
1676 (defconst dired-x-variable-list
1677 (list
1678 'dired-bind-vm
1679 'dired-vm-read-only-folders
1680 'dired-bind-jump
1681 'dired-bind-info
1682 'dired-bind-man
1683 'dired-find-subdir
1684 'dired-enable-local-variables
1685 'dired-local-variables-file
1686 'dired-guess-shell-gnutar
1687 'dired-guess-shell-gzip-quiet
1688 'dired-guess-shell-znew-switches
1689 'dired-guess-shell-alist-user
1690 'dired-clean-up-buffers-too
1691 'dired-omit-mode
1692 'dired-omit-files
1693 'dired-omit-extensions
1695 "List of variables to be appended to reports sent by `dired-x-submit-report'.")
1697 (defun dired-x-submit-report ()
1698 "Submit via reporter.el a bug report on program.
1699 Send report on `dired-x-file' version `dired-x-version,' to
1700 `dired-x-maintainer' at address `dired-x-help-address' listing
1701 variables `dired-x-variable-list' in the message."
1702 (interactive)
1704 (reporter-submit-bug-report
1705 dired-x-help-address ; address
1706 "dired-x" ; pkgname
1707 dired-x-variable-list ; varlist
1708 nil nil ; pre-/post-hooks
1709 ""))
1712 ;; As Barry Warsaw would say: "This might be useful..."
1713 (provide 'dired-x)
1715 ;;; arch-tag: 71a43ba2-7a00-4793-a028-0613dd7765ae
1716 ;;; dired-x.el ends here