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