| blob | 4fddb5d560029af06b82a94fcd9c2d6d9bce8963 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
7 ;; Maintainer: FSF
8 ;; Keywords: files
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; This is a major mode for directory browsing and editing. It is
28 ;; documented in the Emacs manual.
30 ;; Rewritten in 1990/1991 to add tree features, file marking and
31 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
32 ;; Finished up by rms in 1992.
34 ;;; Code:
38 ;;; Customizable variables
41 "Directory editing."
46 "Handling marks in Dired."
51 ;;;###autoload
53 "*Switches passed to `ls' for Dired. MUST contain the `l' option.
54 May contain all other options that don't contradict `-l';
55 may contain even `F', `b', `i' and `s'. See also the variable
56 `dired-ls-F-marks-symlinks' concerning the `F' switch.
57 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
58 some of the `ls' switches are not supported; see the doc string of
59 `insert-directory' in `ls-lisp.el' for more details."
64 "If non-nil, switches passed to `ls' for inserting subdirectories.
67 ; Don't use absolute file names as /bin should be in any PATH and people
68 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
69 ; usually not in PATH.
71 ;;;###autoload
74 "chown"
76 "/usr/sbin/chown"
89 ;;;###autoload
91 "*Informs Dired about how `ls -lF' marks symbolic links.
92 Set this to t if `ls' (or whatever program is specified by
93 `insert-directory-program') with `-lF' marks the symbolic link
94 itself with a trailing @ (usually the case under Ultrix).
96 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
97 nil (the default), if it gives `bar@ -> foo', set it to t.
99 Dired checks if there is really a @ appended. Thus, if you have a
100 marking `ls' program on one host and a non-marking on another host, and
101 don't care about symbolic links which really end in a @, you can
102 always set this variable to t."
106 ;;;###autoload
108 "*Regexp of files to skip when finding first file of a directory.
109 A value of nil means move to the subdir line.
110 A value of t means move to first file."
113 regexp)
116 ;;;###autoload
118 ;; Use t as default so that moved files "take their markers with them".
119 "*Controls marking of renamed files.
120 If t, files keep their previous marks when they are renamed.
121 If a character, renamed files (whether previously marked or not)
122 are afterward marked with that character."
127 ;;;###autoload
129 "*Controls marking of copied files.
130 If t, copied files are marked if and as the corresponding original files were.
131 If a character, copied files are unconditionally marked with that character."
136 ;;;###autoload
138 "*Controls marking of newly made hard links.
139 If t, they are marked if and as the files linked to were marked.
140 If a character, new links are unconditionally marked with that character."
145 ;;;###autoload
147 "*Controls marking of newly made symbolic links.
148 If t, they are marked if and as the files linked to were marked.
149 If a character, new links are unconditionally marked with that character."
154 ;;;###autoload
156 "*If non-nil, Dired tries to guess a default target directory.
157 This means: if there is a dired buffer displayed in the next window,
158 use its current subdir, instead of the current subdir of this dired buffer.
160 The target is used in the prompt for file copy, rename etc."
164 ;;;###autoload
166 "*If non-nil, Dired preserves the last-modified time in a file copy.
167 \(This works on only some systems.)"
171 ; These variables were deleted and the replacements are on files.el.
172 ; We leave aliases behind for back-compatibility.
176 ;;; Hook variables
179 "Run after loading Dired.
180 You can customize key bindings or load extensions with this."
185 "Run at the very end of `dired-mode'."
190 "This hook is run before a dired buffer is read in (created or reverted)."
195 "Hook run after each time a file or directory is read by Dired.
196 After each listing of a file or directory, this hook is run
197 with the buffer narrowed to the listing."
200 ;; Note this can't simply be run inside function `dired-ls' as the hook
201 ;; functions probably depend on the dired-subdir-alist to be OK.
207 "The functions to call when a drop in `dired-mode' is made.
208 See `dnd-protocol-alist' for more information. When nil, behave
209 as in other buffers. Changing this option is effective only for
210 new dired buffers."
216 ;; Internal variables
219 ;; so that you can write things like
220 ;; (let ((dired-marker-char ?X))
221 ;; ;; great code using X markers ...
222 ;; )
223 ;; For example, commands operating on two sets of files, A and B.
224 ;; Or marking files with digits 0-9. This could implicate
225 ;; concentric sets or an order for the marked files.
226 ;; The code depends on dynamic scoping on the marker char.
227 "In Dired, the current mark character.
234 ;; I see no reason ever to make this nil -- rms.
235 ;; (> baud-rate search-slow-speed)
242 ;;;###autoload
244 "The directory name or wildcard spec that this dired directory lists.
245 Local to each dired buffer. May be a list, in which case the car is the
246 directory name and the cdr is the list of files to mention.
255 ;; These regexps must be tested at beginning-of-line, but are also
256 ;; used to search for next matches, so neither omitting "^" nor
257 ;; replacing "^" by "\n" (to make it slightly faster) will work.
260 ;; "Regexp matching a marked line.
261 ;; Important: the match ends just after the marker."
263 ;; The [^:] part after "d" and "l" is to avoid confusion with the
264 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
272 "-[-r][-w].[-r][-w][xs][-r][-w]."
278 ;; The subdirectory names in the next two lists are expanded.
280 "Association list of subdirectories and their buffer positions.
281 Each subdirectory has an element: (DIRNAME . STARTMARKER).
282 The order of elements is the reverse of the order in the buffer.
286 "Keeps track of which switches to use for inserted subdirectories.
294 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
295 Subexpression 1 is the subdirectory proper, no trailing colon.
296 The match starts at the beginning of the line and ends after the end
301 "Faces used by Dired."
307 "Face used for directory headers."
315 "Face used for dired marks."
323 "Face used for marked files."
331 "Face used for flagged files."
338 ;; Inherit from font-lock-warning-face since with min-colors 8
339 ;; font-lock-comment-face is not colored any more.
341 "Face used to highlight a part of a buffer that needs user attention."
349 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
350 ;; font-lock-comment-face is not colored any more.
352 "Face used to highlight permissions of group- and world-writable files."
360 "Face used for subdirectories."
368 "Face used for symbolic links."
376 "Face used for files suffixed with `completion-ignored-extensions'."
384 ;;
385 ;; Directory headers.
387 ;;
388 ;; Dired marks.
390 ;;
391 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
392 ;; file name itself. We search for Dired defined regexps, and then use the
393 ;; Dired defined function `dired-move-to-filename' before searching for the
394 ;; simple regexp ".+". It is that regexp which matches the file name.
395 ;;
396 ;; Marked files.
399 ;;
400 ;; Flagged files.
403 ;; People who are paranoid about security would consider this more
404 ;; important than other things such as whether it is a directory.
405 ;; But we don't want to encourage paranoia, so our default
406 ;; should be what's most useful for non-paranoids. -- rms.
407 ;;; ;;
408 ;;; ;; Files that are group or world writable.
409 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
410 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
411 ;;; '(1 dired-warning-face)
412 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
413 ;; However, we don't need to highlight the file name, only the
414 ;; permissions, to win generally. -- fx.
415 ;; Fixme: we could also put text properties on the permission
416 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
423 ;;
424 ;; Subdirectories.
427 ;;
428 ;; Symbolic links.
431 ;;
432 ;; Files suffixed with `completion-ignored-extensions'.
434 ;; It is quicker to first find just an extension, then go back to the
435 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
438 ;;
439 ;; Files suffixed with `completion-ignored-extensions'
440 ;; plus a character put in by -F.
446 ;; If the last character is not part of the filename,
447 ;; move back to the start of the filename
448 ;; so it can be fontified.
449 ;; Otherwise, leave point at the end of the line;
450 ;; that way, nothing is fontified.
454 )
458 \f
459 ;;; Macros must be defined before they are used, for the byte compiler.
462 "Mark all files for which PREDICATE evals to non-nil.
463 PREDICATE is evaluated on each line, with point at beginning of line.
464 MSG is a noun phrase for the type of files being marked.
465 It should end with a noun that can be pluralized by adding `s'.
466 Return value is the number of files marked, or nil if none were marked."
480 count
481 ,msg
489 distinguish-one-marked)
490 "Eval BODY with point on each marked line. Return a list of BODY's results.
491 If no marked file could be found, execute BODY on the current line.
492 ARG, if non-nil, specifies the files to use instead of the marked files.
493 If ARG is an integer, use the next ARG (or previous -ARG, if
494 ARG<0) files. In that case, point is dragged along. This is
495 so that commands on the next ARG (instead of the marked) files
496 can be chained easily.
497 For any other non-nil value of ARG, use the current file.
498 If optional third arg SHOW-PROGRESS evaluates to non-nil,
499 redisplay the dired buffer after each file is processed.
500 No guarantee is made about the position on the marked line.
501 BODY must ensure this itself if it depends on this.
502 Search starts at the beginning of the buffer, thus the car of the list
503 corresponds to the line nearest to the buffer's bottom. This
504 is also true for (positive and negative) integer values of ARG.
505 BODY should not be too long as it is expanded four times.
507 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
508 return (t FILENAME) instead of (FILENAME)."
509 ;;
510 ;;Warning: BODY must not add new lines before point - this may cause an
511 ;;endless loop.
512 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
519 ,arg
525 results))
526 ;; non-nil, non-integer ARG means use current file:
531 ;; remember position of next marked file before BODY
532 ;; can insert lines before the just found file,
533 ;; confusing us by finding the same marked file again
534 ;; and again and...
542 ;; move after last match
551 results
553 ;; save-excursion loses, again
557 "Return the marked files' names as list of strings.
558 The list is in the same order as the buffer, that is, the car is the
559 first marked file.
560 Values returned are normally absolute file names.
561 Optional arg LOCALP as in `dired-get-filename'.
562 Optional second argument ARG, if non-nil, specifies files near
563 point instead of marked files. It usually comes from the prefix
564 argument.
565 If ARG is an integer, use the next ARG files.
566 Any other non-nil value means to use the current file instead.
567 Optional third argument FILTER, if non-nil, is a function to select
568 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
570 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
571 return (t FILENAME) instead of (FILENAME).
572 Don't use that together with FILTER."
577 arg nil distinguish-one-marked)))
578 result)
581 all-of-them
586 result)))
587 \f
588 ;; The dired command
591 ;; For use in interactive.
596 dired-listing-switches))
597 ;; If a dialog is about to be used, call read-directory-name so
598 ;; the dialog code knows we want directories. Some dialogs can
599 ;; only select directories or files when popped up, not both.
602 nil default-directory nil)
611 ;; We need a mix of read-file-name and
612 ;; read-directory-name so that completion to directories
613 ;; is preferred, but if the user wants to enter a global
614 ;; pattern, he can still use completion on filenames to
615 ;; help him write the pattern.
616 ;; Essentially, we want to use
617 ;; (completion-table-with-predicate
618 ;; 'read-file-name-internal 'file-directory-p nil)
619 ;; but that doesn't work because read-file-name-internal
620 ;; does not obey its `predicate' argument.
626 ;; Hack! Faster than file-directory-p!
637 nil default-directory nil))))))))
639 ;;;###autoload (define-key ctl-x-map "d" 'dired)
640 ;;;###autoload
643 Optional second argument SWITCHES specifies the `ls' options used.
644 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
645 Dired displays a list of files in DIRNAME (which may also have
646 shell wildcards appended to select certain files). If DIRNAME is a cons,
647 its first element is taken as the directory name and the rest as an explicit
648 list of files to make directory entries for.
650 You can move around in it with the usual commands.
655 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
656 ;; Cannot use (interactive "D") because of wildcards.
660 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
661 ;;;###autoload
667 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
668 ;;;###autoload
674 ;;;###autoload
676 "Like `dired' but returns the dired buffer as value, does not select it."
678 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
679 ;; some shells make:
690 ;; If the argument was syntactically a directory name not a file name,
691 ;; or if it happens to name a file that is a directory,
692 ;; convert it syntactically to a directory name.
693 ;; The reason for checking initially-was-dirname
694 ;; and not just file-directory-p
695 ;; is that file-directory-p is slow over ftp.
703 ;; The following is an internal dired function. It returns non-nil if
704 ;; the directory visited by the current dired buffer has changed on
705 ;; disk. DIRNAME should be the directory name of that directory.
714 "Return non-nil if current dired buffer needs updating.
715 If NOCONFIRM is non-nil, then this function always returns nil
716 for a remote directory. This feature is used by Auto Revert Mode."
722 ;; Do not auto-revert when the dired buffer can be currently
723 ;; written by the user as in `wdired-mode'.
724 buffer-read-only
728 ;; If there is an existing dired buffer for DIRNAME, just leave
729 ;; buffer as it is (don't even call dired-revert).
730 ;; This saves time especially for deep trees or with ange-ftp.
731 ;; The user can type `g' easily, and it is more consistent with find-file.
732 ;; But if SWITCHES are given they are probably different from the
733 ;; buffer's old value, so call dired-sort-other, which does
734 ;; revert the buffer.
735 ;; A pity we can't possibly do "Directory has changed - refresh? "
736 ;; like find-file does.
737 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
738 ;; see there.
740 buffer
741 ;; note that buffer already is in dired-mode, if found
742 new-buffer-p
747 ;; Look for an existing buffer.
752 ;; We don't want default-major-mode to run hooks and set auto-fill
753 ;; or whatever, now that dired-mode does not
754 ;; kill-all-local-variables any longer.
759 ;; file list may have changed
761 ;; this calls dired-revert
763 ;; If directory has changed on disk, offer to revert.
768 ;; Else a new buffer
770 ;; We can do this unconditionally
771 ;; because dired-noselect ensures that the name
772 ;; is passed in directory name syntax
773 ;; if it was the name of a directory at all.
778 ;; default-directory and dired-actual-switches are set now
779 ;; (buffer-local), so we can call dired-readin:
784 ;; dired-readin can fail if parent directories are inaccessible.
785 ;; Don't leave an empty buffer around in that case.
790 buffer))
793 ;; Enlarged by dired-advertise
794 ;; Queried by function dired-buffers-for-dir. When this detects a
795 ;; killed buffer, it is removed from this list.
799 ;; This differs from dired-buffers-for-dir in that it does not consider
800 ;; subdirs of default-directory and searches for the first match only.
801 ;; Also, the major mode must be MODE.
811 dired-directory ;; nil during find-alternate-file
816 dired-directory))))
818 blist nil)
820 found))
822 \f
823 ;; Read in a new dired buffer
826 "Read in a new dired buffer.
827 Differs from `dired-insert-subdir' in that it accepts
828 wildcards, erases the buffer, and builds the subdir-alist anew
829 \(including making it buffer-local and clearing it first)."
831 ;; default-directory and dired-actual-switches must be buffer-local
832 ;; and initialized by now.
839 ;; This hook which may want to modify dired-actual-switches
840 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
841 ;; where ls won't understand -Al switches.
849 ;; Don't make undo entries for readin.
855 ;; Must first make alist buffer local and set it to nil because
856 ;; dired-build-subdir-alist will call dired-clear-alist first
863 ;; No need to narrow since the whole buffer contains just
864 ;; dired-readin's output, nothing else. The hook can
865 ;; successfully use dired functions (e.g. dired-get-filename)
866 ;; as the subdir-alist has been built in dired-readin.
869 ;; Subroutines of dired-readin
872 ;; Insert listing for the specified dir (and maybe file list)
873 ;; already in dired-directory, assuming a clean buffer.
879 file-list nil))
883 ;; If we are reading a whole single directory...
888 ;; Else treat it as a wildcard spec
889 ;; unless we have an explicit list of files.
894 "Align the fields of a file to the ones of surrounding lines.
895 BEG..END is the line where the file info is located."
896 ;; Some versions of ls try to adjust the size of each field so as to just
897 ;; hold the largest element ("largest" in the current invocation, of
898 ;; course). So when a single line is output, the size of each field is
899 ;; just big enough for that one output. Thus when dired refreshes one
900 ;; line, the alignment if this line w.r.t the rest is messed up because
901 ;; the fields of that one line will generally be smaller.
902 ;;
903 ;; To work around this problem, we here add spaces to try and
904 ;; re-align the fields as needed. Since this is purely aesthetic,
905 ;; it is of utmost importance that it doesn't mess up anything like
906 ;; `dired-move-to-filename'. To this end, we limit ourselves to
907 ;; adding spaces only, and to only add them at places where there
908 ;; was already at least one space. This way, as long as
909 ;; `directory-listing-before-filename-regexp' always matches spaces
910 ;; with "*" or "+", we know we haven't made anything worse. There
911 ;; is one spot where the exact number of spaces is important, which
912 ;; is just before the actual filename, so we refrain from adding
913 ;; spaces there (and within the filename as well, of course).
916 ;; Check the there is indeed a file, and that there is anoter adjacent
917 ;; file with which to align, and that additional spaces are needed to
918 ;; align the filenames.
931 ;; Make sure there is some work left to do.
933 ;; If we've only looked at the line above, check to see if the line
934 ;; below exists as well and if so, align with the shorter one.
943 ;; Keep positions uptodate when we insert stuff.
946 ;; Main loop.
950 ;; Don't touch anything just before (and after) the
951 ;; beginning of the filename.
953 ;; We're now just in front of a field, with a space behind us.
955 ;; Nums are right-aligned.
957 ;; Let's look at the other line, in the same column: we
958 ;; should be either near the end of the previous field, or
959 ;; in the space between that field and the next.
960 ;; [ Of course, it's also possible that we're already within
961 ;; the next field or even past it, but that's unlikely since
962 ;; other-col > file-col. ]
963 ;; Let's find the distance to the alignment-point (either
964 ;; the beginning or the end of the next field, depending on
965 ;; whether this field is left or right aligned).
975 ;; Now, the number of spaces to insert is align-pt-offset
976 ;; minus the distance to the equivalent point on the
977 ;; current line.
980 align-pt-offset
990 ;; Let's just make really sure we did not mess up.
993 ;; Damn! We messed up: let's revert the change.
995 ;; Now skip to next field.
1001 "Insert a directory listing of DIR, Dired style.
1002 Use SWITCHES to make the listings.
1003 If FILE-LIST is non-nil, list only those files.
1004 Otherwise, if WILDCARD is non-nil, expand wildcards;
1005 in that case, DIR should be a file name that uses wildcards.
1006 In other cases, DIR should be a directory name or a directory filename.
1007 If HDR is non-nil, insert a header line with the directory name."
1010 end)
1013 ;; We used to specify the C locale here, to force English month names;
1014 ;; but this should not be necessary any more,
1015 ;; with the new value of `directory-listing-before-filename-regexp'.
1020 ;; Re-align fields, if necessary.
1023 ;; Quote certain characters, unless ls quoted them for us.
1032 nil t))
1038 nil t))
1041 ;; If we used --dired and it worked, the lines are already indented.
1042 ;; Otherwise, indent them.
1048 ;; Insert text at the beginning to standardize things.
1054 ;; Note that dired-build-subdir-alist will replace the name
1055 ;; by its expansion, so it does not matter whether what we insert
1056 ;; here is fully expanded, but it should be absolute.
1059 ;; Insert "wildcard" line where "total" line would be for a full dir.
1063 "Make the file names highlight when the mouse is on them."
1075 dired-filename t
1079 \f
1080 ;; Reverting a dired buffer
1083 "Reread the dired buffer.
1084 Must also be called after `dired-actual-switches' have changed.
1085 Should not fail even on completely garbaged buffers.
1086 Preserves old cursor, marks/flags, hidden-p."
1099 ;; treat top level dir extra (it may contain wildcards)
1102 ;; Run dired-after-readin-hook just once, below.
1107 ;; ... run the hook for the whole buffer, and only after markers
1108 ;; have been reinserted (else omitting in dired-x would omit marked files)
1118 ;; outside of the let scope
1119 ;;; Might as well not override the user if the user changed this.
1120 ;;; (setq buffer-read-only t)
1121 )
1123 ;; Subroutines of dired-revert
1124 ;; Some of these are also used when inserting subdirs.
1127 "Return alist of files and their marks, from BEG to END."
1138 alist))
1141 "Mark all files remembered in ALIST.
1142 Each element of ALIST looks like (FILE . MARKERCHAR)."
1156 "Return a list of names of subdirs currently hidden."
1166 result))
1169 "Try to insert all subdirs that were displayed before.
1170 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1184 "Remove directory DIR from any directory cache."
1188 \f
1189 ;; dired mode key bindings and initialization
1192 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1193 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1198 ;; Commands to mark or flag certain categories of files
1202 ;; Upper case keys (except !) for operating on the marked files
1221 ;; Comparison commands
1224 ;; Tree Dired commands
1230 ;; move to marked files
1233 ;; Make all regexp commands share a `%' prefix:
1234 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1235 ;; but that seems to serve little purpose, and copy-keymap
1236 ;; does a better job without it.
1249 ;; Commands for marking and unmarking.
1266 ;; Lower keys for commands not operating on all the marked files
1292 ;; moving
1300 (define-key map [up] 'dired-previous-line)
1301 ;; hiding
1302 (define-key map "$" 'dired-hide-subdir)
1303 (define-key map "\M-$" 'dired-hide-all)
1304 ;; isearch
1305 (define-key map (kbd "M-s a C-s") 'dired-do-isearch)
1306 (define-key map (kbd "M-s a M-C-s") 'dired-do-isearch-regexp)
1307 (define-key map (kbd "M-s f C-s") 'dired-isearch-filenames)
1308 (define-key map (kbd "M-s f M-C-s") 'dired-isearch-filenames-regexp)
1309 ;; misc
1310 (define-key map "\C-x\C-q" 'dired-toggle-read-only)
1311 (define-key map "?" 'dired-summary)
1313 (define-key map [remap undo] 'dired-undo)
1314 (define-key map [remap advertised-undo] 'dired-undo)
1315 ;; thumbnail manipulation (image-dired)
1316 (define-key map "\C-td" 'image-dired-display-thumbs)
1317 (define-key map "\C-tt" 'image-dired-tag-files)
1318 (define-key map "\C-tr" 'image-dired-delete-tag)
1319 (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1320 (define-key map "\C-ti" 'image-dired-dired-display-image)
1321 (define-key map "\C-tx" 'image-dired-dired-display-external)
1322 (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1323 (define-key map "\C-t." 'image-dired-display-thumb)
1324 (define-key map "\C-tc" 'image-dired-dired-comment-files)
1325 (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1326 (define-key map "\C-t\C-t" 'image-dired-dired-insert-marked-thumbs)
1327 (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1328 ;; encryption and decryption (epa-dired)
1329 (define-key map ":d" 'epa-dired-do-decrypt)
1330 (define-key map ":v" 'epa-dired-do-verify)
1331 (define-key map ":s" 'epa-dired-do-sign)
1332 (define-key map ":e" 'epa-dired-do-encrypt)
1334 ;; Make menu bar items.
1336 ;; No need to fo this, now that top-level items are fewer.
1337 ;;;;
1338 ;; Get rid of the Edit menu bar item to save space.
1339 ;(define-key map [menu-bar edit] 'undefined)
1341 (define-key map [menu-bar subdir]
1342 (cons "Subdir" (make-sparse-keymap "Subdir")))
1344 (define-key map [menu-bar subdir hide-all]
1345 '(menu-item "Hide All" dired-hide-all
1346 :help "Hide all subdirectories, leave only header lines"))
1347 (define-key map [menu-bar subdir hide-subdir]
1348 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1349 :help "Hide or unhide current directory listing"))
1350 (define-key map [menu-bar subdir tree-down]
1351 '(menu-item "Tree Down" dired-tree-down
1352 :help "Go to first subdirectory header down the tree"))
1353 (define-key map [menu-bar subdir tree-up]
1354 '(menu-item "Tree Up" dired-tree-up
1355 :help "Go to first subdirectory header up the tree"))
1356 (define-key map [menu-bar subdir up]
1357 '(menu-item "Up Directory" dired-up-directory
1358 :help "Edit the parent directory"))
1359 (define-key map [menu-bar subdir prev-subdir]
1360 '(menu-item "Prev Subdir" dired-prev-subdir
1361 :help "Go to previous subdirectory header line"))
1362 (define-key map [menu-bar subdir next-subdir]
1363 '(menu-item "Next Subdir" dired-next-subdir
1364 :help "Go to next subdirectory header line"))
1365 (define-key map [menu-bar subdir prev-dirline]
1366 '(menu-item "Prev Dirline" dired-prev-dirline
1367 :help "Move to next directory-file line"))
1368 (define-key map [menu-bar subdir next-dirline]
1369 '(menu-item "Next Dirline" dired-next-dirline
1370 :help "Move to previous directory-file line"))
1371 (define-key map [menu-bar subdir insert]
1372 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1373 :help "Insert contents of subdirectory"))
1375 (define-key map [menu-bar immediate]
1376 (cons "Immediate" (make-sparse-keymap "Immediate")))
1378 (define-key map
1379 [menu-bar immediate epa-dired-do-decrypt]
1380 '(menu-item "Decrypt" epa-dired-do-decrypt
1381 :help "Decrypt file at cursor"))
1383 (define-key map
1384 [menu-bar immediate epa-dired-do-verify]
1385 '(menu-item "Verify" epa-dired-do-verify
1386 :help "Verify digital signature of file at cursor"))
1388 (define-key map
1389 [menu-bar immediate epa-dired-do-sign]
1390 '(menu-item "Sign" epa-dired-do-sign
1391 :help "Create digital signature of file at cursor"))
1393 (define-key map
1394 [menu-bar immediate epa-dired-do-encrypt]
1395 '(menu-item "Encrypt" epa-dired-do-encrypt
1396 :help "Encrypt file at cursor"))
1398 (define-key map [menu-bar immediate dashes-4]
1399 '("--"))
1401 (define-key map
1402 [menu-bar immediate image-dired-dired-display-external]
1403 '(menu-item "Display Image Externally" image-dired-dired-display-external
1404 :help "Display image in external viewer"))
1405 (define-key map
1406 [menu-bar immediate image-dired-dired-display-image]
1407 '(menu-item "Display Image" image-dired-dired-display-image
1408 :help "Display sized image in a separate window"))
1410 (define-key map [menu-bar immediate dashes-4]
1411 '("--"))
1413 (define-key map [menu-bar immediate revert-buffer]
1414 '(menu-item "Refresh" revert-buffer
1415 :help "Update contents of shown directories"))
1417 (define-key map [menu-bar immediate dashes]
1418 '("--"))
1420 (define-key map [menu-bar immediate isearch-filenames-regexp]
1421 '(menu-item "Isearch Regexp in File Names..." dired-isearch-filenames-regexp
1422 :help "Incrementally search for regexp in file names only"))
1423 (define-key map [menu-bar immediate isearch-filenames]
1424 '(menu-item "Isearch in File Names..." dired-isearch-filenames
1425 :help "Incrementally search for string in file names only."))
1426 (define-key map [menu-bar immediate compare-directories]
1427 '(menu-item "Compare Directories..." dired-compare-directories
1428 :help "Mark files with different attributes in two dired buffers"))
1429 (define-key map [menu-bar immediate backup-diff]
1430 '(menu-item "Compare with Backup" dired-backup-diff
1431 :help "Diff file at cursor with its latest backup"))
1432 (define-key map [menu-bar immediate diff]
1433 '(menu-item "Diff..." dired-diff
1434 :help "Compare file at cursor with another file"))
1435 (define-key map [menu-bar immediate view]
1436 '(menu-item "View This File" dired-view-file
1437 :help "Examine file at cursor in read-only mode"))
1438 (define-key map [menu-bar immediate display]
1439 '(menu-item "Display in Other Window" dired-display-file
1440 :help "Display file at cursor in other window"))
1441 (define-key map [menu-bar immediate find-file-other-window]
1442 '(menu-item "Find in Other Window" dired-find-file-other-window
1443 :help "Edit file at cursor in other window"))
1444 (define-key map [menu-bar immediate find-file]
1445 '(menu-item "Find This File" dired-find-file
1446 :help "Edit file at cursor"))
1447 (define-key map [menu-bar immediate create-directory]
1448 '(menu-item "Create Directory..." dired-create-directory
1449 :help "Create a directory"))
1450 (define-key map [menu-bar immediate wdired-mode]
1451 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1452 :help "Put a dired buffer in a mode in which filenames are editable"
1453 :keys "C-x C-q"
1454 :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1456 (define-key map [menu-bar regexp]
1457 (cons "Regexp" (make-sparse-keymap "Regexp")))
1459 (define-key map
1460 [menu-bar regexp image-dired-mark-tagged-files]
1461 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1462 :help "Mark files whose image tags matches regexp"))
1464 (define-key map [menu-bar regexp dashes-1]
1465 '("--"))
1467 (define-key map [menu-bar regexp downcase]
1468 '(menu-item "Downcase" dired-downcase
1469 ;; When running on plain MS-DOS, there's only one
1470 ;; letter-case for file names.
1471 :enable (or (not (fboundp 'msdos-long-file-names))
1472 (msdos-long-file-names))
1473 :help "Rename marked files to lower-case name"))
1474 (define-key map [menu-bar regexp upcase]
1475 '(menu-item "Upcase" dired-upcase
1476 :enable (or (not (fboundp 'msdos-long-file-names))
1477 (msdos-long-file-names))
1478 :help "Rename marked files to upper-case name"))
1479 (define-key map [menu-bar regexp hardlink]
1480 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1481 :help "Make hard links for files matching regexp"))
1482 (define-key map [menu-bar regexp symlink]
1483 '(menu-item "Symlink..." dired-do-symlink-regexp
1484 :visible (fboundp 'make-symbolic-link)
1485 :help "Make symbolic links for files matching regexp"))
1486 (define-key map [menu-bar regexp rename]
1487 '(menu-item "Rename..." dired-do-rename-regexp
1488 :help "Rename marked files matching regexp"))
1489 (define-key map [menu-bar regexp copy]
1490 '(menu-item "Copy..." dired-do-copy-regexp
1491 :help "Copy marked files matching regexp"))
1492 (define-key map [menu-bar regexp flag]
1493 '(menu-item "Flag..." dired-flag-files-regexp
1494 :help "Flag files matching regexp for deletion"))
1495 (define-key map [menu-bar regexp mark]
1496 '(menu-item "Mark..." dired-mark-files-regexp
1497 :help "Mark files matching regexp for future operations"))
1498 (define-key map [menu-bar regexp mark-cont]
1499 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1500 :help "Mark files whose contents matches regexp"))
1502 (define-key map [menu-bar mark]
1503 (cons "Mark" (make-sparse-keymap "Mark")))
1505 (define-key map [menu-bar mark prev]
1506 '(menu-item "Previous Marked" dired-prev-marked-file
1507 :help "Move to previous marked file"))
1508 (define-key map [menu-bar mark next]
1509 '(menu-item "Next Marked" dired-next-marked-file
1510 :help "Move to next marked file"))
1511 (define-key map [menu-bar mark marks]
1512 '(menu-item "Change Marks..." dired-change-marks
1513 :help "Replace marker with another character"))
1514 (define-key map [menu-bar mark unmark-all]
1515 '(menu-item "Unmark All" dired-unmark-all-marks))
1516 (define-key map [menu-bar mark symlinks]
1517 '(menu-item "Mark Symlinks" dired-mark-symlinks
1518 :visible (fboundp 'make-symbolic-link)
1519 :help "Mark all symbolic links"))
1520 (define-key map [menu-bar mark directories]
1521 '(menu-item "Mark Directories" dired-mark-directories
1522 :help "Mark all directories except `.' and `..'"))
1523 (define-key map [menu-bar mark directory]
1524 '(menu-item "Mark Old Backups" dired-clean-directory
1525 :help "Flag old numbered backups for deletion"))
1526 (define-key map [menu-bar mark executables]
1527 '(menu-item "Mark Executables" dired-mark-executables
1528 :help "Mark all executable files"))
1529 (define-key map [menu-bar mark garbage-files]
1530 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1531 :help "Flag unneeded files for deletion"))
1532 (define-key map [menu-bar mark backup-files]
1533 '(menu-item "Flag Backup Files" dired-flag-backup-files
1534 :help "Flag all backup files for deletion"))
1535 (define-key map [menu-bar mark auto-save-files]
1536 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1537 :help "Flag auto-save files for deletion"))
1538 (define-key map [menu-bar mark deletion]
1539 '(menu-item "Flag" dired-flag-file-deletion
1540 :help "Flag current line's file for deletion"))
1541 (define-key map [menu-bar mark unmark]
1542 '(menu-item "Unmark" dired-unmark
1543 :help "Unmark or unflag current line's file"))
1544 (define-key map [menu-bar mark mark]
1545 '(menu-item "Mark" dired-mark
1546 :help "Mark current line's file for future operations"))
1547 (define-key map [menu-bar mark toggle-marks]
1548 '(menu-item "Toggle Marks" dired-toggle-marks
1549 :help "Mark unmarked files, unmark marked ones"))
1551 (define-key map [menu-bar operate]
1552 (cons "Operate" (make-sparse-keymap "Operate")))
1554 (define-key map
1555 [menu-bar operate image-dired-delete-tag]
1556 '(menu-item "Delete Image Tag..." image-dired-delete-tag
1557 :help "Delete image tag from current or marked files"))
1558 (define-key map
1559 [menu-bar operate image-dired-tag-files]
1560 '(menu-item "Add Image Tags..." image-dired-tag-files
1561 :help "Add image tags to current or marked files"))
1562 (define-key map
1563 [menu-bar operate image-dired-dired-comment-files]
1564 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1565 :help "Add image comment to current or marked files"))
1566 (define-key map
1567 [menu-bar operate image-dired-display-thumbs]
1568 '(menu-item "Display image thumbnails" image-dired-display-thumbs
1569 :help "Display image thumbnails for current or marked image files"))
1571 (define-key map [menu-bar operate dashes-3]
1572 '("--"))
1574 (define-key map [menu-bar operate query-replace]
1575 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1576 :help "Replace regexp in marked files"))
1577 (define-key map [menu-bar operate search]
1578 '(menu-item "Search Files..." dired-do-search
1579 :help "Search marked files for regexp"))
1580 (define-key map [menu-bar operate isearch-regexp]
1581 '(menu-item "Isearch Regexp Files..." dired-do-isearch-regexp
1582 :help "Incrementally search marked files for regexp"))
1583 (define-key map [menu-bar operate isearch]
1584 '(menu-item "Isearch Files..." dired-do-isearch
1585 :help "Incrementally search marked files for string"))
1586 (define-key map [menu-bar operate chown]
1587 '(menu-item "Change Owner..." dired-do-chown
1588 :visible (not (memq system-type '(ms-dos windows-nt)))
1589 :help "Change the owner of marked files"))
1590 (define-key map [menu-bar operate chgrp]
1591 '(menu-item "Change Group..." dired-do-chgrp
1592 :visible (not (memq system-type '(ms-dos windows-nt)))
1593 :help "Change the group of marked files"))
1594 (define-key map [menu-bar operate chmod]
1595 '(menu-item "Change Mode..." dired-do-chmod
1596 :help "Change mode (attributes) of marked files"))
1597 (define-key map [menu-bar operate touch]
1598 '(menu-item "Change Timestamp..." dired-do-touch
1599 :help "Change timestamp of marked files"))
1600 (define-key map [menu-bar operate load]
1601 '(menu-item "Load" dired-do-load
1602 :help "Load marked Emacs Lisp files"))
1603 (define-key map [menu-bar operate compile]
1604 '(menu-item "Byte-compile" dired-do-byte-compile
1605 :help "Byte-compile marked Emacs Lisp files"))
1606 (define-key map [menu-bar operate compress]
1607 '(menu-item "Compress" dired-do-compress
1608 :help "Compress/uncompress marked files"))
1609 (define-key map [menu-bar operate print]
1610 '(menu-item "Print..." dired-do-print
1611 :help "Ask for print command and print marked files"))
1612 (define-key map [menu-bar operate hardlink]
1613 '(menu-item "Hardlink to..." dired-do-hardlink
1614 :help "Make hard links for current or marked files"))
1615 (define-key map [menu-bar operate symlink]
1616 '(menu-item "Symlink to..." dired-do-symlink
1617 :visible (fboundp 'make-symbolic-link)
1618 :help "Make symbolic links for current or marked files"))
1619 (define-key map [menu-bar operate command]
1620 '(menu-item "Shell Command..." dired-do-shell-command
1621 :help "Run a shell command on each of marked files"))
1622 (define-key map [menu-bar operate delete]
1623 '(menu-item "Delete" dired-do-delete
1624 :help "Delete current file or all marked files"))
1625 (define-key map [menu-bar operate rename]
1626 '(menu-item "Rename to..." dired-do-rename
1627 :help "Rename current file or move marked files"))
1628 (define-key map [menu-bar operate copy]
1629 '(menu-item "Copy to..." dired-do-copy
1630 :help "Copy current file or all marked files"))
1632 map)
1633 "Local keymap for `dired-mode' buffers.")
1634 \f
1635 ;; Dired mode is suitable only for specially formatted data.
1636 (put 'dired-mode 'mode-class 'special)
1638 ;; Autoload cookie needed by desktop.el
1639 ;;;###autoload
1640 (defun dired-mode (&optional dirname switches)
1641 "\
1644 \(optionally) its subdirectories, in the format of `ls -lR'.
1647 compress, load or byte-compile them, change their file attributes
1650 by file or all files matching certain criteria.
1652 Letters no longer insert themselves. Digits are prefix arguments.
1655 Most commands operate on the marked files and use the current file
1656 if no files are marked. Use a numeric prefix argument to operate on
1657 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1658 to operate on the current file only. Prefix arguments override marks.
1660 to see why something went wrong.
1665 (or dired it in another buffer, if it is a directory).
1672 This retains all marks and hides subdirs again that were hidden before.
1673 SPC and DEL can be used to move down and up by lines.
1676 to read the
1678 to relist a single or the marked files or a
1680 again for the directory tree.
1683 for more info):
1685 `dired-listing-switches'
1686 `dired-trivial-filenames'
1687 `dired-shrink-to-fit'
1688 `dired-marker-char'
1689 `dired-del-marker'
1690 `dired-keep-marker-rename'
1691 `dired-keep-marker-copy'
1692 `dired-keep-marker-hardlink'
1693 `dired-keep-marker-symlink'
1697 `dired-before-readin-hook'
1698 `dired-after-readin-hook'
1699 `dired-mode-hook'
1700 `dired-load-hook'
1702 Keybindings:
1704 ;; Not to be called interactively (e.g. dired-directory will be set
1705 ;; to default-directory, which is wrong with wildcards).
1706 (kill-all-local-variables)
1707 (use-local-map dired-mode-map)
1708 (dired-advertise) ; default-directory is already set
1709 (setq major-mode 'dired-mode
1710 mode-name "Dired"
1711 ;; case-fold-search nil
1712 buffer-read-only t
1713 selective-display t ; for subdirectory hiding
1714 mode-line-buffer-identification
1715 (propertized-buffer-identification "%17b"))
1716 (set (make-local-variable 'revert-buffer-function)
1717 (function dired-revert))
1718 (set (make-local-variable 'buffer-stale-function)
1719 (function dired-buffer-stale-p))
1720 (set (make-local-variable 'page-delimiter)
1722 (set (make-local-variable 'dired-directory)
1723 (or dirname default-directory))
1724 ;; list-buffers uses this to display the dir being edited in this buffer.
1725 (set (make-local-variable 'list-buffers-directory)
1726 (expand-file-name (if (listp dired-directory)
1727 (car dired-directory)
1728 dired-directory)))
1729 (set (make-local-variable 'dired-actual-switches)
1730 (or switches dired-listing-switches))
1731 (set (make-local-variable 'font-lock-defaults)
1732 '(dired-font-lock-keywords t nil nil beginning-of-line))
1733 (set (make-local-variable 'desktop-save-buffer)
1734 'dired-desktop-buffer-misc-data)
1735 (setq dired-switches-alist nil)
1736 (dired-sort-other dired-actual-switches t)
1737 (when (featurep 'dnd)
1738 (set (make-local-variable 'dnd-protocol-alist)
1739 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1740 (add-hook 'isearch-mode-hook 'dired-isearch-filenames-setup nil t)
1741 (run-mode-hooks 'dired-mode-hook))
1742 \f
1743 ;; Idiosyncratic dired commands that don't deal with marks.
1745 (defun dired-summary ()
1746 "Summarize basic Dired commands and show recent dired errors."
1747 (interactive)
1748 (dired-why)
1749 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1750 (message
1751 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1753 (defun dired-undo ()
1754 "Undo in a dired buffer.
1755 This doesn't recover lost files, it just undoes changes in the buffer itself.
1756 You can use it to recover marks, killed lines or subdirs."
1757 (interactive)
1758 (let ((inhibit-read-only t))
1759 (undo))
1760 (dired-build-subdir-alist)
1761 (message "Change in dired buffer undone.
1762 Actual changes in files cannot be undone by Emacs."))
1764 (defun dired-toggle-read-only ()
1765 "Edit dired buffer with Wdired, or set it read-only.
1766 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1767 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1768 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1769 (interactive)
1770 (if (eq major-mode 'dired-mode)
1771 (wdired-change-to-wdired-mode)
1772 (toggle-read-only)))
1774 (defun dired-next-line (arg)
1775 "Move down lines then position at filename.
1776 Optional prefix ARG says how many lines to move; default is one line."
1777 (interactive "p")
1778 (forward-line arg)
1779 (dired-move-to-filename))
1781 (defun dired-previous-line (arg)
1782 "Move up lines then position at filename.
1783 Optional prefix ARG says how many lines to move; default is one line."
1784 (interactive "p")
1785 (forward-line (- arg))
1786 (dired-move-to-filename))
1788 (defun dired-next-dirline (arg &optional opoint)
1789 "Goto ARG'th next directory file line."
1790 (interactive "p")
1791 (or opoint (setq opoint (point)))
1792 (if (if (> arg 0)
1793 (re-search-forward dired-re-dir nil t arg)
1794 (beginning-of-line)
1795 (re-search-backward dired-re-dir nil t (- arg)))
1796 (dired-move-to-filename) ; user may type `i' or `f'
1797 (goto-char opoint)
1798 (error "No more subdirectories")))
1800 (defun dired-prev-dirline (arg)
1801 "Goto ARG'th previous directory file line."
1802 (interactive "p")
1803 (dired-next-dirline (- arg)))
1805 (defun dired-up-directory (&optional other-window)
1806 "Run Dired on parent directory of current directory.
1807 Find the parent directory either in this buffer or another buffer.
1808 Creates a buffer if necessary."
1809 (interactive "P")
1810 (let* ((dir (dired-current-directory))
1811 (up (file-name-directory (directory-file-name dir))))
1812 (or (dired-goto-file (directory-file-name dir))
1813 ;; Only try dired-goto-subdir if buffer has more than one dir.
1814 (and (cdr dired-subdir-alist)
1815 (dired-goto-subdir up))
1816 (progn
1817 (if other-window
1818 (dired-other-window up)
1819 (dired up))
1820 (dired-goto-file dir)))))
1822 (defun dired-get-file-for-visit ()
1823 "Get the current line's file name, with an error if file does not exist."
1824 (interactive)
1825 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1826 (let ((raw (dired-get-filename nil t))
1827 file-name)
1828 (if (null raw)
1829 (error "No file on this line"))
1830 (setq file-name (file-name-sans-versions raw t))
1831 (if (file-exists-p file-name)
1832 file-name
1833 (if (file-symlink-p file-name)
1834 (error "File is a symlink to a nonexistent target")
1835 (error "File no longer exists; type `g' to update dired buffer")))))
1837 ;; Force `f' rather than `e' in the mode doc:
1838 (defalias 'dired-advertised-find-file 'dired-find-file)
1839 (defun dired-find-file ()
1840 "In Dired, visit the file or directory named on this line."
1841 (interactive)
1842 ;; Bind `find-file-run-dired' so that the command works on directories
1843 ;; too, independent of the user's setting.
1844 (let ((find-file-run-dired t))
1845 (find-file (dired-get-file-for-visit))))
1847 (defun dired-find-alternate-file ()
1848 "In Dired, visit this file or directory instead of the dired buffer."
1849 (interactive)
1850 (set-buffer-modified-p nil)
1851 (find-alternate-file (dired-get-file-for-visit)))
1852 ;; Don't override the setting from .emacs.
1853 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1855 (defun dired-mouse-find-file-other-window (event)
1856 "In Dired, visit the file or directory name you click on."
1857 (interactive "e")
1858 (let (window pos file)
1859 (save-excursion
1860 (setq window (posn-window (event-end event))
1861 pos (posn-point (event-end event)))
1862 (if (not (windowp window))
1863 (error "No file chosen"))
1864 (set-buffer (window-buffer window))
1865 (goto-char pos)
1866 (setq file (dired-get-file-for-visit)))
1867 (if (file-directory-p file)
1868 (or (and (cdr dired-subdir-alist)
1869 (dired-goto-subdir file))
1870 (progn
1871 (select-window window)
1872 (dired-other-window file)))
1873 (select-window window)
1874 (find-file-other-window (file-name-sans-versions file t)))))
1876 (defun dired-view-file ()
1877 "In Dired, examine a file in view mode, returning to Dired when done.
1878 When file is a directory, show it in this buffer if it is inserted.
1879 Otherwise, display it in another buffer."
1880 (interactive)
1881 (let ((file (dired-get-file-for-visit)))
1882 (if (file-directory-p file)
1883 (or (and (cdr dired-subdir-alist)
1884 (dired-goto-subdir file))
1885 (dired file))
1886 (view-file file))))
1888 (defun dired-find-file-other-window ()
1889 "In Dired, visit this file or directory in another window."
1890 (interactive)
1891 (find-file-other-window (dired-get-file-for-visit)))
1893 (defun dired-display-file ()
1894 "In Dired, display this file or directory in another window."
1895 (interactive)
1896 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1897 \f
1898 ;;; Functions for extracting and manipulating file names in Dired buffers.
1900 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1901 "In Dired, return name of file mentioned on this line.
1902 Value returned normally includes the directory name.
1903 Optional arg LOCALP with value `no-dir' means don't include directory
1904 name in result. A value of `verbatim' means to return the name exactly as
1905 it occurs in the buffer, and a value of t means construct name relative to
1906 `default-directory', which still may contain slashes if in a subdirectory.
1907 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1908 regular filenames and return nil if no filename on this line.
1909 Otherwise, an error occurs in these cases."
1910 (let (case-fold-search file p1 p2 already-absolute)
1911 (save-excursion
1912 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1913 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1914 ;; nil if no file on this line, but no-error-if-not-filep is t:
1915 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1916 (progn
1917 ;; Get rid of the mouse-face property that file names have.
1918 (set-text-properties 0 (length file) nil file)
1919 ;; Unquote names quoted by ls or by dired-insert-directory.
1920 (while (string-match
1922 (setq file (replace-match
1924 nil t file 1)))
1925 ;; The above `read' will return a unibyte string if FILE
1926 ;; contains eight-bit-control/graphic characters.
1927 (if (and enable-multibyte-characters
1928 (not (multibyte-string-p file)))
1929 (setq file (string-to-multibyte file)))))
1930 (and file (file-name-absolute-p file)
1931 ;; A relative file name can start with ~.
1932 ;; Don't treat it as absolute in this context.
1933 (not (eq (aref file 0) ?~))
1934 (setq already-absolute t))
1935 (cond
1936 ((null file)
1937 nil)
1938 ((eq localp 'verbatim)
1939 file)
1940 ((and (not no-error-if-not-filep)
1941 (member file '("." "..")))
1942 (error "Cannot operate on `.' or `..'"))
1943 ((and (eq localp 'no-dir) already-absolute)
1944 (file-name-nondirectory file))
1945 (already-absolute
1946 (let ((handler (find-file-name-handler file nil)))
1947 ;; check for safe-magic property so that we won't
1948 ;; put /: for names that don't really need them.
1949 ;; For instance, .gz files when auto-compression-mode is on.
1950 (if (and handler (not (get handler 'safe-magic)))
1951 (concat "/:" file)
1952 file)))
1953 ((eq localp 'no-dir)
1954 file)
1955 ((equal (dired-current-directory) "/")
1956 (setq file (concat (dired-current-directory localp) file))
1957 (let ((handler (find-file-name-handler file nil)))
1958 ;; check for safe-magic property so that we won't
1959 ;; put /: for names that don't really need them.
1960 ;; For instance, .gz files when auto-compression-mode is on.
1961 (if (and handler (not (get handler 'safe-magic)))
1962 (concat "/:" file)
1963 file)))
1964 (t
1965 (concat (dired-current-directory localp) file)))))
1967 (defun dired-string-replace-match (regexp string newtext
1968 &optional literal global)
1969 "Replace first match of REGEXP in STRING with NEWTEXT.
1970 If it does not match, nil is returned instead of the new string.
1971 Optional arg LITERAL means to take NEWTEXT literally.
1972 Optional arg GLOBAL means to replace all matches."
1973 (if global
1974 (let ((start 0) ret)
1975 (while (string-match regexp string start)
1976 (let ((from-end (- (length string) (match-end 0))))
1977 (setq ret (setq string (replace-match newtext t literal string)))
1978 (setq start (- (length string) from-end))))
1979 ret)
1980 (if (not (string-match regexp string 0))
1981 nil
1982 (replace-match newtext t literal string))))
1984 (defun dired-make-absolute (file &optional dir)
1985 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1986 ;; We can't always use expand-file-name as this would get rid of `.'
1987 ;; or expand in / instead default-directory if DIR=="".
1988 ;; This should be good enough for ange-ftp.
1989 ;; It should be reasonably fast, though, as it is called in
1990 ;; dired-get-filename.
1991 (concat (or dir default-directory) file))
1993 (defun dired-make-relative (file &optional dir ignore)
1994 "Convert FILE (an absolute file name) to a name relative to DIR.
1995 If this is impossible, return FILE unchanged.
1996 DIR must be a directory name, not a file name."
1997 (or dir (setq dir default-directory))
1998 ;; This case comes into play if default-directory is set to
1999 ;; use ~.
2000 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
2001 (setq dir (expand-file-name dir)))
2002 (if (string-match (concat "^" (regexp-quote dir)) file)
2003 (substring file (match-end 0))
2004 ;;; (or no-error
2005 ;;; (error "%s: not in directory tree growing at %s" file dir))
2006 file))
2007 \f
2008 ;;; Functions for finding the file name in a dired buffer line.
2010 (defvar dired-permission-flags-regexp
2012 "Regular expression to match the permission flags in `ls -l'.")
2014 ;; Move to first char of filename on this line.
2015 ;; Returns position (point) or nil if no filename on this line."
2016 (defun dired-move-to-filename (&optional raise-error eol)
2017 "Move to the beginning of the filename on the current line.
2018 Return the position of the beginning of the filename, or nil if none found."
2019 ;; This is the UNIX version.
2020 (or eol (setq eol (line-end-position)))
2021 (beginning-of-line)
2022 ;; First try assuming `ls --dired' was used.
2023 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
2024 (cond
2025 ((and change (< change eol))
2026 (goto-char change))
2027 ((re-search-forward directory-listing-before-filename-regexp eol t)
2028 (goto-char (match-end 0)))
2029 ((re-search-forward dired-permission-flags-regexp eol t)
2030 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2031 (if raise-error
2032 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
2033 (beginning-of-line)
2034 nil)
2035 (raise-error
2036 (error "No file on this line")))))
2038 (defun dired-move-to-end-of-filename (&optional no-error)
2039 ;; Assumes point is at beginning of filename,
2040 ;; thus the rwx bit re-search-backward below will succeed in *this*
2041 ;; line if at all. So, it should be called only after
2042 ;; (dired-move-to-filename t).
2043 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2044 ;; This is the UNIX version.
2045 (if (get-text-property (point) 'dired-filename)
2046 (goto-char (next-single-property-change (point) 'dired-filename))
2047 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
2048 ;; case-fold-search is nil now, so we can test for capital F:
2049 (setq used-F (string-match "F" dired-actual-switches)
2050 opoint (point)
2051 eol (save-excursion (end-of-line) (point))
2052 hidden (and selective-display
2054 (if hidden
2055 nil
2056 (save-excursion ;; Find out what kind of file this is:
2057 ;; Restrict perm bits to be non-blank,
2058 ;; otherwise this matches one char to early (looking backward):
2059 ;; "l---------" (some systems make symlinks that way)
2060 ;; "----------" (plain file with zero perms)
2061 (if (re-search-backward
2062 dired-permission-flags-regexp nil t)
2063 (setq file-type (char-after (match-beginning 1))
2064 symlink (eq file-type ?l)
2065 ;; Only with -F we need to know whether it's an executable
2066 executable (and
2067 used-F
2068 (string-match
2069 "[xst]" ;; execute bit set anywhere?
2070 (concat
2071 (match-string 2)
2072 (match-string 3)
2073 (match-string 4)))))
2074 (or no-error (error "No file on this line"))))
2075 ;; Move point to end of name:
2076 (if symlink
2077 (if (search-forward " -> " eol t)
2078 (progn
2079 (forward-char -4)
2080 (and used-F
2081 dired-ls-F-marks-symlinks
2082 (eq (preceding-char) ?@) ;; did ls really mark the link?
2083 (forward-char -1))))
2084 (goto-char eol) ;; else not a symbolic link
2085 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2086 ;; one trailing character. (Executable bits on symlinks ain't mean
2087 ;; a thing, even to ls, but we know it's not a symlink.)
2088 (and used-F
2089 (or (memq file-type '(?d ?s ?p))
2090 executable)
2091 (forward-char -1))))
2092 (or no-error
2093 (not (eq opoint (point)))
2094 (error "%s" (if hidden
2095 (substitute-command-keys
2097 "No file on this line")))
2098 (if (eq opoint (point))
2099 nil
2100 (point)))))
2102 \f
2103 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2105 (defun dired-copy-filename-as-kill (&optional arg)
2106 "Copy names of marked (or next ARG) files into the kill ring.
2107 The names are separated by a space.
2108 With a zero prefix arg, use the absolute file name of each marked file.
2110 `default-directory'. (This still may contain slashes if in a subdirectory.)
2112 If on a subdir headerline, use absolute subdirname instead;
2113 prefix arg and marked files are ignored in this case.
2116 (interactive "P")
2117 (let ((string
2118 (or (dired-get-subdir)
2119 (mapconcat (function identity)
2120 (if arg
2121 (cond ((zerop (prefix-numeric-value arg))
2122 (dired-get-marked-files))
2123 ((consp arg)
2124 (dired-get-marked-files t))
2125 (t
2126 (dired-get-marked-files
2127 'no-dir (prefix-numeric-value arg))))
2128 (dired-get-marked-files 'no-dir))
2129 " "))))
2130 (if (eq last-command 'kill-region)
2131 (kill-append string nil)
2132 (kill-new string))
2133 (message "%s" string)))
2135 \f
2136 ;; Keeping Dired buffers in sync with the filesystem and with each other
2138 (defun dired-buffers-for-dir (dir &optional file)
2139 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2140 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2141 ;; matches FILE.
2142 ;; The list is in reverse order of buffer creation, most recent last.
2143 ;; As a side effect, killed dired buffers for DIR are removed from
2144 ;; dired-buffers.
2145 (setq dir (file-name-as-directory dir))
2146 (let ((alist dired-buffers) result elt buf)
2147 (while alist
2148 (setq elt (car alist)
2149 buf (cdr elt))
2150 (if (buffer-name buf)
2151 (if (dired-in-this-tree dir (car elt))
2152 (with-current-buffer buf
2153 (and (assoc dir dired-subdir-alist)
2154 (or (null file)
2155 (let ((wildcards
2156 (file-name-nondirectory dired-directory)))
2157 (or (= 0 (length wildcards))
2158 (string-match (dired-glob-regexp wildcards)
2159 file))))
2160 (setq result (cons buf result)))))
2161 ;; else buffer is killed - clean up:
2162 (setq dired-buffers (delq elt dired-buffers)))
2163 (setq alist (cdr alist)))
2164 result))
2166 (defun dired-glob-regexp (pattern)
2167 "Convert glob-pattern PATTERN to a regular expression."
2168 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2169 regexp)
2170 (while (string-match "[[?*]" pattern matched-in-pattern)
2171 (let ((op-end (match-end 0))
2172 (next-op (aref pattern (match-beginning 0))))
2173 (setq regexp (concat regexp
2174 (regexp-quote
2175 (substring pattern matched-in-pattern
2176 (match-beginning 0)))))
2177 (cond ((= next-op ??)
2178 (setq regexp (concat regexp "."))
2179 (setq matched-in-pattern op-end))
2180 ((= next-op ?\[)
2181 ;; Fails to handle ^ yet ????
2182 (let* ((set-start (match-beginning 0))
2183 (set-cont
2184 (if (= (aref pattern (1+ set-start)) ?^)
2185 (+ 3 set-start)
2186 (+ 2 set-start)))
2187 (set-end (string-match "]" pattern set-cont))
2188 (set (substring pattern set-start (1+ set-end))))
2189 (setq regexp (concat regexp set))
2190 (setq matched-in-pattern (1+ set-end))))
2191 ((= next-op ?*)
2192 (setq regexp (concat regexp ".*"))
2193 (setq matched-in-pattern op-end)))))
2195 regexp
2196 (regexp-quote
2197 (substring pattern matched-in-pattern))
2202 (defun dired-advertise ()
2203 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2204 ;; With wildcards we actually advertise too much.
2205 (let ((expanded-default (expand-file-name default-directory)))
2206 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2207 t ; we have already advertised ourselves
2208 (setq dired-buffers
2209 (cons (cons expanded-default (current-buffer))
2210 dired-buffers)))))
2212 (defun dired-unadvertise (dir)
2213 ;; Remove DIR from the buffer alist in variable dired-buffers.
2214 ;; This has the effect of removing any buffer whose main directory is DIR.
2215 ;; It does not affect buffers in which DIR is a subdir.
2216 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2217 (setq dired-buffers
2218 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2219 \f
2220 ;; Tree Dired
2222 ;;; utility functions
2224 (defun dired-in-this-tree (file dir)
2225 ;;"Is FILE part of the directory tree starting at DIR?"
2226 (let (case-fold-search)
2227 (string-match (concat "^" (regexp-quote dir)) file)))
2229 (defun dired-normalize-subdir (dir)
2230 ;; Prepend default-directory to DIR if relative file name.
2231 ;; dired-get-filename must be able to make a valid file name from a
2232 ;; file and its directory DIR.
2233 (file-name-as-directory
2234 (if (file-name-absolute-p dir)
2235 dir
2236 (expand-file-name dir default-directory))))
2238 (defun dired-get-subdir ()
2239 ;;"Return the subdir name on this line, or nil if not on a headerline."
2240 ;; Look up in the alist whether this is a headerline.
2241 (save-excursion
2242 (let ((cur-dir (dired-current-directory)))
2243 (beginning-of-line) ; alist stores b-o-l positions
2244 (and (zerop (- (point)
2245 (dired-get-subdir-min (assoc cur-dir
2246 dired-subdir-alist))))
2247 cur-dir))))
2249 ;(defun dired-get-subdir-min (elt)
2250 ; (cdr elt))
2251 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2252 (defalias 'dired-get-subdir-min 'cdr)
2254 (defun dired-get-subdir-max (elt)
2255 (save-excursion
2256 (goto-char (dired-get-subdir-min elt))
2257 (dired-subdir-max)))
2259 (defun dired-clear-alist ()
2260 (while dired-subdir-alist
2261 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2262 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2264 (defun dired-subdir-index (dir)
2265 ;; Return an index into alist for use with nth
2266 ;; for the sake of subdir moving commands.
2267 (let (found (index 0) (alist dired-subdir-alist))
2268 (while alist
2269 (if (string= dir (car (car alist)))
2270 (setq alist nil found t)
2271 (setq alist (cdr alist) index (1+ index))))
2272 (if found index nil)))
2274 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2275 "Go to next subdirectory, regardless of level."
2276 ;; Use 0 arg to go to this directory's header line.
2277 ;; NO-SKIP prevents moving to end of header line, returning whatever
2278 ;; position was found in dired-subdir-alist.
2279 (interactive "p")
2280 (let ((this-dir (dired-current-directory))
2281 pos index)
2282 ;; nth with negative arg does not return nil but the first element
2283 (setq index (- (dired-subdir-index this-dir) arg))
2284 (setq pos (if (>= index 0)
2285 (dired-get-subdir-min (nth index dired-subdir-alist))))
2286 (if pos
2287 (progn
2288 (goto-char pos)
2290 (point))
2291 (if no-error-if-not-found
2292 nil ; return nil if not found
2293 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2295 (defun dired-build-subdir-alist (&optional switches)
2296 "Build `dired-subdir-alist' by parsing the buffer.
2297 Returns the new value of the alist.
2298 If optional arg SWITCHES is non-nil, use its value
2299 instead of `dired-actual-switches'."
2300 (interactive)
2301 (dired-clear-alist)
2302 (save-excursion
2303 (let* ((count 0)
2304 (inhibit-read-only t)
2305 (buffer-undo-list t)
2306 (switches (or switches dired-actual-switches))
2307 new-dir-name
2308 (R-ftp-base-dir-regex
2309 ;; Used to expand subdirectory names correctly in recursive
2310 ;; ange-ftp listings.
2311 (and (string-match "R" switches)
2314 (goto-char (point-min))
2315 (setq dired-subdir-alist nil)
2316 (while (re-search-forward dired-subdir-regexp nil t)
2317 ;; Avoid taking a file name ending in a colon
2318 ;; as a subdir name.
2319 (unless (save-excursion
2320 (goto-char (match-beginning 0))
2321 (beginning-of-line)
2322 (forward-char 2)
2323 (save-match-data (looking-at dired-re-perms)))
2324 (save-excursion
2325 (goto-char (match-beginning 1))
2326 (setq new-dir-name
2327 (buffer-substring-no-properties (point) (match-end 1))
2328 new-dir-name
2329 (save-match-data
2330 (if (and R-ftp-base-dir-regex
2331 (not (string= new-dir-name default-directory))
2332 (string-match R-ftp-base-dir-regex new-dir-name))
2333 (concat default-directory
2334 (substring new-dir-name (match-end 0)))
2335 (expand-file-name new-dir-name))))
2336 (delete-region (point) (match-end 1))
2337 (insert new-dir-name))
2338 (setq count (1+ count))
2339 (dired-alist-add-1 new-dir-name
2340 ;; Place a sub directory boundary between lines.
2341 (save-excursion
2342 (goto-char (match-beginning 0))
2343 (beginning-of-line)
2344 (point-marker)))))
2345 (if (and (> count 1) (interactive-p))
2346 (message "Buffer includes %d directories" count)))
2347 ;; We don't need to sort it because it is in buffer order per
2348 ;; constructionem. Return new alist:
2349 dired-subdir-alist))
2351 (defun dired-alist-add-1 (dir new-marker)
2352 ;; Add new DIR at NEW-MARKER. Don't sort.
2353 (setq dired-subdir-alist
2354 (cons (cons (dired-normalize-subdir dir) new-marker)
2355 dired-subdir-alist)))
2357 (defun dired-goto-next-nontrivial-file ()
2358 ;; Position point on first nontrivial file after point.
2359 (dired-goto-next-file);; so there is a file to compare with
2360 (if (stringp dired-trivial-filenames)
2361 (while (and (not (eobp))
2362 (string-match dired-trivial-filenames
2363 (file-name-nondirectory
2364 (or (dired-get-filename nil t) ""))))
2365 (forward-line 1)
2366 (dired-move-to-filename))))
2368 (defun dired-goto-next-file ()
2369 (let ((max (1- (dired-subdir-max))))
2370 (while (and (not (dired-move-to-filename)) (< (point) max))
2371 (forward-line 1))))
2373 (defun dired-goto-file (file)
2374 "Go to line describing file FILE in this dired buffer."
2375 ;; Return value of point on success, else nil.
2376 ;; FILE must be an absolute file name.
2379 ;; it in the buffer.
2380 (interactive
2381 (prog1 ; let push-mark display its message
2382 (list (expand-file-name
2383 (read-file-name "Goto file: "
2384 (dired-current-directory))))
2385 (push-mark)))
2386 (setq file (directory-file-name file)) ; does no harm if no directory
2387 (let (found case-fold-search dir)
2388 (setq dir (or (file-name-directory file)
2389 (error "File name `%s' is not absolute" file)))
2390 (save-excursion
2391 ;; The hair here is to get the result of dired-goto-subdir
2392 ;; without really calling it if we don't have any subdirs.
2393 (if (if (string= dir (expand-file-name default-directory))
2394 (goto-char (point-min))
2395 (and (cdr dired-subdir-alist)
2396 (dired-goto-subdir dir)))
2397 (let ((base (file-name-nondirectory file))
2398 search-string
2399 (boundary (dired-subdir-max)))
2400 (setq search-string
2402 (setq search-string
2404 (while (and (not found)
2405 ;; filenames are preceded by SPC, this makes
2406 ;; the search faster (e.g. for the filename "-"!).
2407 (search-forward (concat " " search-string)
2408 boundary 'move))
2409 ;; Match could have BASE just as initial substring or
2410 ;; or in permission bits or date or
2411 ;; not be a proper filename at all:
2412 (if (equal base (dired-get-filename 'no-dir t))
2413 ;; Must move to filename since an (actually
2414 ;; correct) match could have been elsewhere on the
2415 ;; ;; line (e.g. "-" would match somewhere in the
2416 ;; permission bits).
2417 (setq found (dired-move-to-filename))
2418 ;; If this isn't the right line, move forward to avoid
2419 ;; trying this line again.
2420 (forward-line 1))))))
2421 (and found
2422 ;; return value of point (i.e., FOUND):
2423 (goto-char found))))
2425 (defun dired-initial-position (dirname)
2426 ;; Where point should go in a new listing of DIRNAME.
2427 ;; Point assumed at beginning of new subdir line.
2428 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2429 (end-of-line)
2430 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2431 \f
2432 ;; These are hooks which make tree dired work.
2433 ;; They are in this file because other parts of dired need to call them.
2434 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2436 ;; This function is called for each retrieved filename.
2437 ;; It could stand to be faster, though it's mostly function call
2438 ;; overhead. Avoiding the function call seems to save about 10% in
2439 ;; dired-get-filename. Make it a defsubst?
2440 (defun dired-current-directory (&optional localp)
2441 "Return the name of the subdirectory to which this line belongs.
2442 This returns a string with trailing slash, like `default-directory'.
2443 Optional argument means return a file name relative to `default-directory'."
2444 (let ((here (point))
2445 (alist (or dired-subdir-alist
2446 ;; probably because called in a non-dired buffer
2447 (error "No subdir-alist in %s" (current-buffer))))
2448 elt dir)
2449 (while alist
2450 (setq elt (car alist)
2451 dir (car elt)
2452 ;; use `<=' (not `<') as subdir line is part of subdir
2453 alist (if (<= (dired-get-subdir-min elt) here)
2454 nil ; found
2455 (cdr alist))))
2456 (if localp
2457 (dired-make-relative dir default-directory)
2458 dir)))
2460 ;; Subdirs start at the beginning of their header lines and end just
2461 ;; before the beginning of the next header line (or end of buffer).
2463 (defun dired-subdir-max ()
2464 (save-excursion
2465 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2466 (point-max)
2467 (point))))
2468 \f
2469 ;; Deleting files
2471 (defcustom dired-recursive-deletes 'top
2472 "*Decide whether recursive deletes are allowed.
2473 A value of nil means no recursive deletes.
2474 `always' means delete recursively without asking. This is DANGEROUS!
2475 `top' means ask for each directory at top level, but delete its subdirectories
2476 without asking.
2477 Anything else means ask for each directory."
2478 :type '(choice :tag "Delete non-empty directories"
2479 (const :tag "Yes" always)
2480 (const :tag "No--only delete empty directories" nil)
2481 (const :tag "Confirm for each directory" t)
2482 (const :tag "Confirm for each top directory only" top))
2483 :group 'dired)
2485 ;; Match anything but `.' and `..'.
2488 ;; Delete file, possibly delete a directory and all its files.
2489 ;; This function is usefull outside of dired. One could change it's name
2490 ;; to e.g. recursive-delete-file and put it somewhere else.
2491 (defun dired-delete-file (file &optional recursive) "\
2492 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2493 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2494 nil, do not delete.
2495 `always', delete recursively without asking.
2496 `top', ask for each directory at top level.
2497 Anything else, ask for each sub-directory."
2498 (let (files)
2499 ;; This test is equivalent to
2500 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2501 ;; but more efficient
2502 (if (not (eq t (car (file-attributes file))))
2503 (delete-file file)
2504 (when (and recursive
2505 (setq files
2506 (directory-files file t dired-re-no-dot)) ; Not empty.
2507 (or (eq recursive 'always)
2508 (yes-or-no-p (format "Recursive delete of %s? "
2509 (dired-make-relative file)))))
2510 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2511 (while files ; Recursively delete (possibly asking).
2512 (dired-delete-file (car files) recursive)
2513 (setq files (cdr files))))
2514 (delete-directory file))))
2516 (defun dired-do-flagged-delete (&optional nomessage)
2517 "In Dired, delete the files flagged for deletion.
2518 If NOMESSAGE is non-nil, we don't display any message
2519 if there are no flagged files.
2520 `dired-recursive-deletes' controls whether deletion of
2521 non-empty directories is allowed."
2522 (interactive)
2523 (let* ((dired-marker-char dired-del-marker)
2524 (regexp (dired-marker-regexp))
2525 case-fold-search)
2526 (if (save-excursion (goto-char (point-min))
2527 (re-search-forward regexp nil t))
2528 (dired-internal-do-deletions
2529 ;; this can't move point since ARG is nil
2530 (dired-map-over-marks (cons (dired-get-filename) (point))
2531 nil)
2532 nil)
2533 (or nomessage
2534 (message "(No deletions requested)")))))
2536 (defun dired-do-delete (&optional arg)
2537 "Delete all marked (or next ARG) files.
2538 `dired-recursive-deletes' controls whether deletion of
2539 non-empty directories is allowed."
2540 ;; This is more consistent with the file marking feature than
2541 ;; dired-do-flagged-delete.
2542 (interactive "P")
2543 (dired-internal-do-deletions
2544 ;; this may move point if ARG is an integer
2545 (dired-map-over-marks (cons (dired-get-filename) (point))
2546 arg)
2547 arg))
2549 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2551 (defun dired-internal-do-deletions (l arg)
2552 ;; L is an alist of files to delete, with their buffer positions.
2553 ;; ARG is the prefix arg.
2554 ;; Filenames are absolute.
2555 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2556 ;; That way as changes are made in the buffer they do not shift the
2557 ;; lines still to be changed, so the (point) values in L stay valid.
2558 ;; Also, for subdirs in natural order, a subdir's files are deleted
2559 ;; before the subdir itself - the other way around would not work.
2560 (let ((files (mapcar (function car) l))
2561 (count (length l))
2562 (succ 0))
2563 ;; canonicalize file list for pop up
2564 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2565 (if (dired-mark-pop-up
2566 " *Deletions*" 'delete files dired-deletion-confirmer
2567 (format "Delete %s " (dired-mark-prompt arg files)))
2568 (save-excursion
2569 (let (failures);; files better be in reverse order for this loop!
2570 (while l
2571 (goto-char (cdr (car l)))
2572 (let ((inhibit-read-only t))
2573 (condition-case err
2574 (let ((fn (car (car l))))
2575 (dired-delete-file fn dired-recursive-deletes)
2576 ;; if we get here, removing worked
2577 (setq succ (1+ succ))
2578 (message "%s of %s deletions" succ count)
2579 (dired-fun-in-all-buffers
2580 (file-name-directory fn) (file-name-nondirectory fn)
2581 (function dired-delete-entry) fn))
2582 (error;; catch errors from failed deletions
2584 (setq failures (cons (car (car l)) failures)))))
2585 (setq l (cdr l)))
2586 (if (not failures)
2587 (message "%d deletion%s done" count (dired-plural-s count))
2588 (dired-log-summary
2589 (format "%d of %d deletion%s failed"
2590 (length failures) count
2591 (dired-plural-s count))
2592 failures))))
2593 (message "(No deletions performed)")))
2594 (dired-move-to-filename))
2596 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2597 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2598 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2599 ;; (FILE does not include a directory component.)
2600 ;; FILE may be nil, in which case ignore it.
2601 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2602 (let (success-list)
2603 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2604 file))
2605 (with-current-buffer buf
2606 (if (apply fun args)
2607 (setq success-list (cons (buffer-name buf) success-list)))))
2608 success-list))
2610 ;; Delete the entry for FILE from
2611 (defun dired-delete-entry (file)
2612 (save-excursion
2613 (and (dired-goto-file file)
2614 (let ((inhibit-read-only t))
2615 (delete-region (progn (beginning-of-line) (point))
2616 (save-excursion (forward-line 1) (point))))))
2617 (dired-clean-up-after-deletion file))
2619 ;; This is a separate function for the sake of dired-x.el.
2620 (defun dired-clean-up-after-deletion (fn)
2621 ;; Clean up after a deleted file or directory FN.
2622 (save-excursion (and (cdr dired-subdir-alist)
2623 (dired-goto-subdir fn)
2624 (dired-kill-subdir))))
2625 \f
2626 ;; Confirmation
2628 (defun dired-marker-regexp ()
2629 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2631 (defun dired-plural-s (count)
2632 (if (= 1 count) "" "s"))
2634 (defun dired-mark-prompt (arg files)
2635 "Return a string for use in a prompt, either the current file
2636 name, or the marker and a count of marked files."
2637 ;; distinguish-one-marked can cause the first element to be just t.
2638 (if (eq (car files) t) (setq files (cdr files)))
2639 (let ((count (length files)))
2640 (if (= count 1)
2641 (car files)
2642 ;; more than 1 file:
2643 (if (integerp arg)
2644 ;; abs(arg) = count
2645 ;; Perhaps this is nicer, but it also takes more screen space:
2646 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2647 ;; count)
2648 (format "[next %d files]" arg)
2649 (format "%c [%d files]" dired-marker-char count)))))
2651 (defun dired-pop-to-buffer (buf)
2652 ;; Pop up buffer BUF.
2653 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2654 (if (not dired-shrink-to-fit)
2655 (pop-to-buffer (get-buffer-create buf))
2656 ;; let window shrink to fit:
2657 (let ((window (selected-window))
2658 target-lines w2)
2659 (cond ;; if split-height-threshold is enabled, use the largest window
2660 ((and (> (window-height (setq w2 (get-largest-window)))
2661 split-height-threshold)
2662 (window-full-width-p w2))
2663 (setq window w2))
2664 ;; if the least-recently-used window is big enough, use it
2665 ((and (> (window-height (setq w2 (get-lru-window)))
2666 (* 2 window-min-height))
2667 (window-full-width-p w2))
2668 (setq window w2)))
2669 (save-excursion
2670 (set-buffer buf)
2671 (goto-char (point-max))
2673 (setq target-lines (count-lines (point-min) (point)))
2674 ;; Don't forget to count the last line.
2675 (if (not (bolp))
2676 (setq target-lines (1+ target-lines))))
2677 (if (<= (window-height window) (* 2 window-min-height))
2678 ;; At this point, every window on the frame is too small to split.
2679 (setq w2 (display-buffer buf))
2680 (setq w2 (split-window window
2681 (max window-min-height
2682 (- (window-height window)
2683 (1+ (max window-min-height target-lines)))))))
2684 (set-window-buffer w2 buf)
2685 (if (< (1- (window-height w2)) target-lines)
2686 (progn
2687 (select-window w2)
2688 (enlarge-window (- target-lines (1- (window-height w2))))))
2689 (set-window-start w2 1)
2690 )))
2692 (defcustom dired-no-confirm nil
2693 "A list of symbols for commands Dired should not confirm.
2694 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2695 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2696 `touch' and `uncompress'."
2697 :group 'dired
2698 :type '(set (const byte-compile) (const chgrp)
2699 (const chmod) (const chown) (const compress)
2700 (const copy) (const delete) (const hardlink)
2701 (const load) (const move) (const print)
2702 (const shell) (const symlink) (const touch)
2703 (const uncompress)))
2705 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2706 "Return FUNCTION's result on ARGS after showing which files are marked.
2707 Displays the file names in a buffer named BUFNAME;
2709 This uses function `dired-pop-to-buffer' to do that.
2711 FUNCTION should not manipulate files, just read input
2712 (an argument or confirmation).
2713 The window is not shown if there is just one file or
2714 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2715 FILES is the list of marked files. It can also be (t FILENAME)
2716 in the case of one marked file, to distinguish that from using
2717 just the current file."
2718 (or bufname (setq bufname " *Marked Files*"))
2719 (if (or (eq dired-no-confirm t)
2720 (memq op-symbol dired-no-confirm)
2721 ;; If FILES defaulted to the current line's file.
2722 (= (length files) 1))
2723 (apply function args)
2724 (with-current-buffer (get-buffer-create bufname)
2725 (erase-buffer)
2726 ;; Handle (t FILE) just like (FILE), here.
2727 ;; That value is used (only in some cases), to mean
2728 ;; just one file that was marked, rather than the current line file.
2729 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2730 (remove-text-properties (point-min) (point-max)
2731 '(mouse-face nil help-echo nil)))
2732 (save-window-excursion
2733 (dired-pop-to-buffer bufname)
2734 (apply function args))))
2736 (defun dired-format-columns-of-files (files)
2737 (let ((beg (point)))
2738 (completion--insert-strings files)
2739 (put-text-property beg (point) 'mouse-face nil)))
2740 \f
2741 ;; Commands to mark or flag file(s) at or near current line.
2743 (defun dired-repeat-over-lines (arg function)
2744 ;; This version skips non-file lines.
2745 (let ((pos (make-marker)))
2746 (beginning-of-line)
2747 (while (and (> arg 0) (not (eobp)))
2748 (setq arg (1- arg))
2749 (beginning-of-line)
2750 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2751 (save-excursion
2752 (forward-line 1)
2753 (move-marker pos (1+ (point))))
2754 (save-excursion (funcall function))
2755 ;; Advance to the next line--actually, to the line that *was* next.
2756 ;; (If FUNCTION inserted some new lines in between, skip them.)
2757 (goto-char pos))
2758 (while (and (< arg 0) (not (bobp)))
2759 (setq arg (1+ arg))
2760 (forward-line -1)
2761 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2762 (beginning-of-line)
2763 (save-excursion (funcall function)))
2764 (move-marker pos nil)
2765 (dired-move-to-filename)))
2767 (defun dired-between-files ()
2768 ;; This used to be a regexp match of the `total ...' line output by
2769 ;; ls, which is slightly faster, but that is not very robust; notably,
2770 ;; it fails for non-english locales.
2771 (save-excursion (not (dired-move-to-filename))))
2773 (defun dired-next-marked-file (arg &optional wrap opoint)
2774 "Move to the next marked file, wrapping around the end of the buffer."
2776 (or opoint (setq opoint (point)));; return to where interactively started
2777 (if (if (> arg 0)
2778 (re-search-forward dired-re-mark nil t arg)
2779 (beginning-of-line)
2780 (re-search-backward dired-re-mark nil t (- arg)))
2781 (dired-move-to-filename)
2782 (if (null wrap)
2783 (progn
2784 (goto-char opoint)
2785 (error "No next marked file"))
2786 (message "(Wraparound for next marked file)")
2787 (goto-char (if (> arg 0) (point-min) (point-max)))
2788 (dired-next-marked-file arg nil opoint))))
2790 (defun dired-prev-marked-file (arg &optional wrap)
2791 "Move to the previous marked file, wrapping around the end of the buffer."
2793 (dired-next-marked-file (- arg) wrap))
2795 (defun dired-file-marker (file)
2796 ;; Return FILE's marker, or nil if unmarked.
2797 (save-excursion
2798 (and (dired-goto-file file)
2799 (progn
2800 (beginning-of-line)
2802 (following-char))))))
2804 (defun dired-mark-files-in-region (start end)
2805 (let ((inhibit-read-only t))
2806 (if (> start end)
2807 (error "start > end"))
2808 (goto-char start) ; assumed at beginning of line
2809 (while (< (point) end)
2810 ;; Skip subdir line and following garbage like the `total' line:
2811 (while (and (< (point) end) (dired-between-files))
2812 (forward-line 1))
2813 (if (and (not (looking-at dired-re-dot))
2814 (dired-get-filename nil t))
2815 (progn
2816 (delete-char 1)
2817 (insert dired-marker-char)))
2818 (forward-line 1))))
2820 (defun dired-mark (arg)
2821 "Mark the current (or next ARG) files.
2822 If on a subdir headerline, mark all its files except `.' and `..'.
2826 this subdir."
2827 (interactive "P")
2828 (if (dired-get-subdir)
2829 (save-excursion (dired-mark-subdir-files))
2830 (let ((inhibit-read-only t))
2831 (dired-repeat-over-lines
2832 (prefix-numeric-value arg)
2833 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2835 (defun dired-unmark (arg)
2836 "Unmark the current (or next ARG) files.
2837 If looking at a subdir, unmark all its files except `.' and `..'."
2838 (interactive "P")
2840 (dired-mark arg)))
2842 (defun dired-flag-file-deletion (arg)
2843 "In Dired, flag the current line's file for deletion.
2844 With prefix arg, repeat over several lines.
2846 If on a subdir headerline, mark all its files except `.' and `..'."
2847 (interactive "P")
2848 (let ((dired-marker-char dired-del-marker))
2849 (dired-mark arg)))
2851 (defun dired-unmark-backward (arg)
2852 "In Dired, move up lines and remove deletion flag there.
2853 Optional prefix ARG says how many lines to unflag; default is one line."
2854 (interactive "p")
2855 (dired-unmark (- arg)))
2857 (defun dired-toggle-marks ()
2858 "Toggle marks: marked files become unmarked, and vice versa.
2859 Files marked with other flags (such as `D') are not affected.
2860 `.' and `..' are never toggled.
2861 As always, hidden subdirs are not affected."
2862 (interactive)
2863 (save-excursion
2864 (goto-char (point-min))
2865 (let ((inhibit-read-only t))
2866 (while (not (eobp))
2867 (or (dired-between-files)
2868 (looking-at dired-re-dot)
2869 ;; use subst instead of insdel because it does not move
2870 ;; the gap and thus should be faster and because
2871 ;; other characters are left alone automatically
2872 (apply 'subst-char-in-region
2873 (point) (1+ (point))
2877 (forward-line 1)))))
2878 \f
2879 ;;; Commands to mark or flag files based on their characteristics or names.
2881 (defvar dired-regexp-history nil
2882 "History list of regular expressions used in Dired commands.")
2884 (defun dired-read-regexp (prompt)
2885 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2887 (defun dired-mark-files-regexp (regexp &optional marker-char)
2888 "Mark all files matching REGEXP for use in later commands.
2889 A prefix argument means to unmark them instead.
2890 `.' and `..' are never marked.
2893 object files--just `.o' will mark more than you might think."
2894 (interactive
2895 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2896 " files (regexp): "))
2898 (let ((dired-marker-char (or marker-char dired-marker-char)))
2899 (dired-mark-if
2900 (and (not (looking-at dired-re-dot))
2901 (not (eolp)) ; empty line
2902 (let ((fn (dired-get-filename nil t)))
2903 (and fn (string-match regexp (file-name-nondirectory fn)))))
2904 "matching file")))
2906 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2907 "Mark all files with contents containing REGEXP for use in later commands.
2908 A prefix argument means to unmark them instead.
2909 `.' and `..' are never marked."
2910 (interactive
2911 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2912 " files containing (regexp): "))
2914 (let ((dired-marker-char (or marker-char dired-marker-char)))
2915 (dired-mark-if
2916 (and (not (looking-at dired-re-dot))
2917 (not (eolp)) ; empty line
2918 (let ((fn (dired-get-filename nil t)))
2919 (when (and fn (file-readable-p fn)
2920 (not (file-directory-p fn)))
2921 (let ((prebuf (get-file-buffer fn)))
2922 (message "Checking %s" fn)
2923 ;; For now we do it inside emacs
2924 ;; Grep might be better if there are a lot of files
2925 (if prebuf
2926 (with-current-buffer prebuf
2927 (save-excursion
2928 (goto-char (point-min))
2929 (re-search-forward regexp nil t)))
2930 (with-temp-buffer
2931 (insert-file-contents fn)
2932 (goto-char (point-min))
2933 (re-search-forward regexp nil t))))
2934 )))
2935 "matching file")))
2937 (defun dired-flag-files-regexp (regexp)
2938 "In Dired, flag all files containing the specified REGEXP for deletion.
2939 The match is against the non-directory part of the filename. Use `^'
2940 and `$' to anchor matches. Exclude subdirs by hiding them.
2941 `.' and `..' are never flagged."
2942 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2943 (dired-mark-files-regexp regexp dired-del-marker))
2945 (defun dired-mark-symlinks (unflag-p)
2946 "Mark all symbolic links.
2947 With prefix argument, unflag all those files."
2948 (interactive "P")
2950 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2952 (defun dired-mark-directories (unflag-p)
2953 "Mark all directory file lines except `.' and `..'.
2954 With prefix argument, unflag all those files."
2955 (interactive "P")
2957 (dired-mark-if (and (looking-at dired-re-dir)
2958 (not (looking-at dired-re-dot)))
2959 "directory file")))
2961 (defun dired-mark-executables (unflag-p)
2962 "Mark all executable files.
2963 With prefix argument, unflag all those files."
2964 (interactive "P")
2966 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2968 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2969 ;; files for which PREDICATE returns non-nil.
2971 (defun dired-flag-auto-save-files (&optional unflag-p)
2972 "Flag for deletion files whose names suggest they are auto save files.
2973 A prefix argument says to unflag those files instead."
2974 (interactive "P")
2976 (dired-mark-if
2977 ;; It is less than general to check for # here,
2978 ;; but it's the only way this runs fast enough.
2979 (and (save-excursion (end-of-line)
2980 (or
2981 (eq (preceding-char) ?#)
2982 ;; Handle executables in case of -F option.
2983 ;; We need not worry about the other kinds
2984 ;; of markings that -F makes, since they won't
2985 ;; appear on real auto-save files.
2986 (if (eq (preceding-char) ?*)
2987 (progn
2988 (forward-char -1)
2989 (eq (preceding-char) ?#)))))
2990 (not (looking-at dired-re-dir))
2991 (let ((fn (dired-get-filename t t)))
2992 (if fn (auto-save-file-name-p
2993 (file-name-nondirectory fn)))))
2994 "auto save file")))
2996 (defcustom dired-garbage-files-regexp
2997 ;; `log' here is dubious, since it's typically used for useful log
2998 ;; files, not just TeX stuff. -- fx
2999 (concat (regexp-opt
3000 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
3003 :type 'regexp
3004 :group 'dired)
3006 (defun dired-flag-garbage-files ()
3007 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3008 (interactive)
3009 (dired-flag-files-regexp dired-garbage-files-regexp))
3011 (defun dired-flag-backup-files (&optional unflag-p)
3012 "Flag all backup files (names ending with `~') for deletion.
3013 With prefix argument, unflag these files."
3014 (interactive "P")
3015 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
3016 (dired-mark-if
3017 ;; Don't call backup-file-name-p unless the last character looks like
3018 ;; it might be the end of a backup file name. This isn't very general,
3019 ;; but it's the only way this runs fast enough.
3020 (and (save-excursion (end-of-line)
3021 ;; Handle executables in case of -F option.
3022 ;; We need not worry about the other kinds
3023 ;; of markings that -F makes, since they won't
3024 ;; appear on real backup files.
3025 (if (eq (preceding-char) ?*)
3026 (forward-char -1))
3027 (eq (preceding-char) ?~))
3028 (not (looking-at dired-re-dir))
3029 (let ((fn (dired-get-filename t t)))
3030 (if fn (backup-file-name-p fn))))
3031 "backup file")))
3033 (defun dired-change-marks (&optional old new)
3034 "Change all OLD marks to NEW marks.
3035 OLD and NEW are both characters used to mark files."
3036 (interactive
3037 (let* ((cursor-in-echo-area t)
3038 (old (progn (message "Change (old mark): ") (read-char)))
3039 (new (progn (message "Change %c marks to (new mark): " old)
3040 (read-char))))
3041 (list old new)))
3043 (ding)
3045 (inhibit-read-only t))
3046 (save-excursion
3047 (goto-char (point-min))
3048 (while (search-forward string nil t)
3049 (if (if (= old ?\s)
3050 (save-match-data
3051 (dired-get-filename 'no-dir t))
3052 t)
3053 (subst-char-in-region (match-beginning 0)
3054 (match-end 0) old new)))))))
3056 (defun dired-unmark-all-marks ()
3057 "Remove all marks from all files in the dired buffer."
3058 (interactive)
3061 (defun dired-unmark-all-files (mark &optional arg)
3062 "Remove a specific mark (or any mark) from every file.
3063 After this command, type the mark character to remove,
3064 or type RET to remove all marks.
3065 With prefix arg, query for each marked file.
3068 (save-excursion
3069 (let* ((count 0)
3070 (inhibit-read-only t) case-fold-search query
3072 (help-form "\
3073 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3074 `!' to unmark all remaining files with no more questions."))
3075 (goto-char (point-min))
3077 (re-search-forward dired-re-mark nil t)
3078 (search-forward string nil t))
3079 (if (or (not arg)
3080 (let ((file (dired-get-filename t t)))
3081 (and file
3082 (dired-query 'query "Unmark file `%s'? "
3083 file))))
3084 (progn (subst-char-in-region (1- (point)) (point)
3085 (preceding-char) ?\s)
3086 (setq count (1+ count)))))
3087 (message (if (= count 1) "1 mark removed"
3088 "%d marks removed")
3089 count))))
3090 \f
3091 ;; Logging failures operating on files, and showing the results.
3093 (defvar dired-log-buffer "*Dired log*")
3095 (defun dired-why ()
3096 "Pop up a buffer with error log output from Dired.
3097 A group of errors from a single command ends with a formfeed.
3099 (interactive)
3100 (if (get-buffer dired-log-buffer)
3101 (let ((owindow (selected-window))
3102 (window (display-buffer (get-buffer dired-log-buffer))))
3103 (unwind-protect
3104 (progn
3105 (select-window window)
3106 (goto-char (point-max))
3107 (forward-line -1)
3108 (backward-page 1)
3109 (recenter 0))
3110 (select-window owindow)))))
3112 (defun dired-log (log &rest args)
3113 ;; Log a message or the contents of a buffer.
3114 ;; If LOG is a string and there are more args, it is formatted with
3116 ;; End each bunch of errors with (dired-log t):
3117 ;; this inserts the current time and buffer at the start of the page,
3119 (let ((obuf (current-buffer)))
3120 (with-current-buffer (get-buffer-create dired-log-buffer)
3121 (goto-char (point-max))
3122 (let ((inhibit-read-only t))
3123 (cond ((stringp log)
3124 (insert (if args
3125 (apply (function format) log args)
3126 log)))
3127 ((bufferp log)
3128 (insert-buffer-substring log))
3129 ((eq t log)
3130 (backward-page 1)
3131 (unless (bolp)
3133 (insert (current-time-string)
3135 (goto-char (point-max))
3138 (defun dired-log-summary (string failures)
3139 "State a summary of a command's failures, in echo area and log buffer.
3140 STRING is an overall summary of the failures.
3141 FAILURES is a list of file names that we failed to operate on,
3142 or nil if file names are not applicable."
3143 (if (= (length failures) 1)
3144 (message "%s"
3145 (with-current-buffer dired-log-buffer
3146 (goto-char (point-max))
3147 (backward-page 1)
3148 (if (eolp) (forward-line 1))
3149 (buffer-substring (point) (point-max))))
3150 (message (if failures "%s--type ? for details (%s)"
3151 "%s--type ? for details")
3152 string failures))
3153 ;; Log a summary describing a bunch of errors.
3155 (dired-log t))
3156 \f
3157 ;;; Sorting
3159 ;; Most ls can only sort by name or by date (with -t), nothing else.
3160 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3161 ;; So anything that does not contain these is sort "by name".
3163 (defvar dired-ls-sorting-switches "SXU"
3166 This indicates to Dired which option switches to watch out for because they
3167 will change the sorting order behavior of `ls'.
3169 To change the default sorting order \(e.g. add a `-v' option\), see the
3170 variable `dired-listing-switches'. To temporarily override the listing
3173 (defvar dired-sort-by-date-regexp
3174 (concat "^-[^" dired-ls-sorting-switches
3175 "]*t[^" dired-ls-sorting-switches "]*$")
3176 "Regexp recognized by Dired to set `by date' mode.")
3178 (defvar dired-sort-by-name-regexp
3179 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3180 "Regexp recognized by Dired to set `by name' mode.")
3182 (defvar dired-sort-inhibit nil
3183 "Non-nil means the Dired sort command is disabled.
3184 The idea is to set this buffer-locally in special dired buffers.")
3186 (defun dired-sort-set-modeline ()
3187 ;; Set modeline display according to dired-actual-switches.
3188 ;; Modeline display of "by name" or "by date" guarantees the user a
3189 ;; match with the corresponding regexps. Non-matching switches are
3190 ;; shown literally.
3191 (when (eq major-mode 'dired-mode)
3192 (setq mode-name
3193 (let (case-fold-search)
3194 (cond ((string-match
3195 dired-sort-by-name-regexp dired-actual-switches)
3196 "Dired by name")
3197 ((string-match
3198 dired-sort-by-date-regexp dired-actual-switches)
3199 "Dired by date")
3200 (t
3201 (concat "Dired " dired-actual-switches)))))
3202 (force-mode-line-update)))
3204 (defun dired-sort-toggle-or-edit (&optional arg)
3205 "Toggle between sort by date/name and refresh the dired buffer.
3206 With a prefix argument you can edit the current listing switches instead."
3207 (interactive "P")
3208 (when dired-sort-inhibit
3209 (error "Cannot sort this dired buffer"))
3210 (if arg
3211 (dired-sort-other
3212 (read-string "ls switches (must contain -l): " dired-actual-switches))
3213 (dired-sort-toggle)))
3215 (defun dired-sort-toggle ()
3216 ;; Toggle between sort by date/name. Reverts the buffer.
3217 (setq dired-actual-switches
3218 (let (case-fold-search)
3219 (if (string-match " " dired-actual-switches)
3220 ;; New toggle scheme: add/remove a trailing " -t"
3222 (substring dired-actual-switches 0 (match-beginning 0))
3223 (concat dired-actual-switches " -t"))
3224 ;; old toggle scheme: look for some 't' switch and add/remove it
3225 (concat
3226 "-l"
3227 (dired-replace-in-string (concat "[-lt"
3228 dired-ls-sorting-switches "]")
3229 ""
3230 dired-actual-switches)
3231 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3232 dired-actual-switches)
3233 ""
3234 "t")))))
3235 (dired-sort-set-modeline)
3236 (revert-buffer))
3238 ;; Some user code loads dired especially for this.
3239 ;; Don't do that--use replace-regexp-in-string instead.
3240 (defun dired-replace-in-string (regexp newtext string)
3241 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3243 (let ((result "") (start 0) mb me)
3244 (while (string-match regexp string start)
3245 (setq mb (match-beginning 0)
3246 me (match-end 0)
3247 result (concat result (substring string start mb) newtext)
3248 start me))
3249 (concat result (substring string start))))
3251 (defun dired-sort-other (switches &optional no-revert)
3252 "Specify new `ls' SWITCHES for current dired buffer.
3253 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3254 set the minor mode accordingly, others appear literally in the mode line.
3255 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3256 (dired-sort-R-check switches)
3257 (setq dired-actual-switches switches)
3258 (dired-sort-set-modeline)
3259 (or no-revert (revert-buffer)))
3261 (defvar dired-subdir-alist-pre-R nil
3262 "Value of `dired-subdir-alist' before -R switch added.")
3263 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3265 (defun dired-sort-R-check (switches)
3266 "Additional processing of -R in ls option string SWITCHES.
3267 Saves `dired-subdir-alist' when R is set and restores saved value
3268 minus any directories explicitly deleted when R is cleared.
3269 To be called first in body of `dired-sort-other', etc."
3270 (cond
3271 ((and (string-match "R" switches)
3272 (not (string-match "R" dired-actual-switches)))
3273 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3274 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3275 ((and (string-match "R" dired-actual-switches)
3276 (not (string-match "R" switches)))
3277 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3278 ;; that are still present:
3279 (setq dired-subdir-alist
3280 (if dired-subdir-alist-pre-R
3281 (let (subdirs)
3282 (while dired-subdir-alist-pre-R
3283 (if (assoc (caar dired-subdir-alist-pre-R)
3284 dired-subdir-alist)
3285 ;; subdir still present...
3286 (setq subdirs
3287 (cons (car dired-subdir-alist-pre-R)
3288 subdirs)))
3289 (setq dired-subdir-alist-pre-R
3290 (cdr dired-subdir-alist-pre-R)))
3291 (reverse subdirs))
3292 ;; No pre-R subdir alist, so revert to main directory
3293 ;; listing:
3294 (list (car (reverse dired-subdir-alist))))))))
3295 \f
3297 ;;;; Drag and drop support
3299 (defcustom dired-recursive-copies 'top
3300 "*Decide whether recursive copies are allowed.
3301 A value of nil means no recursive copies.
3302 `always' means copy recursively without asking.
3303 `top' means ask for each directory at top level.
3304 Anything else means ask for each directory."
3305 :type '(choice :tag "Copy directories"
3306 (const :tag "No recursive copies" nil)
3307 (const :tag "Ask for each directory" t)
3308 (const :tag "Ask for each top directory only" top)
3309 (const :tag "Copy directories without asking" always))
3310 :group 'dired)
3312 (defun dired-dnd-popup-notice ()
3313 (message-box
3316 (declare-function x-popup-menu "xmenu.c" (position menu))
3318 (defun dired-dnd-do-ask-action (uri)
3319 ;; No need to get actions and descriptions from the source,
3320 ;; we only have three actions anyway.
3321 (let ((action (x-popup-menu
3322 t
3323 (list "What action?"
3324 (cons ""
3325 '(("Copy here" . copy)
3326 ("Move here" . move)
3327 ("Link here" . link)
3328 "--"
3329 ("Cancel" . nil)))))))
3330 (if action
3331 (dired-dnd-handle-local-file uri action)
3332 nil)))
3334 (declare-function dired-relist-entry "dired-aux" (file))
3335 (declare-function make-symbolic-link "fileio.c")
3337 ;; Only used when (featurep 'dnd).
3338 (declare-function dnd-get-local-file-name "dnd" (uri &optional must-exist))
3339 (declare-function dnd-get-local-file-uri "dnd" (uri))
3341 (defun dired-dnd-handle-local-file (uri action)
3342 "Copy, move or link a file to the dired directory.
3343 URI is the file to handle, ACTION is one of copy, move, link or ask.
3344 Ask means pop up a menu for the user to select one of copy, move or link."
3345 (require 'dired-aux)
3346 (let* ((from (dnd-get-local-file-name uri t))
3347 (to (when from
3348 (concat (dired-current-directory)
3349 (file-name-nondirectory from)))))
3350 (when from
3351 (cond ((eq action 'ask)
3352 (dired-dnd-do-ask-action uri))
3353 ;; If copying a directory and dired-recursive-copies is
3354 ;; nil, dired-copy-file fails. Pop up a notice.
3355 ((and (memq action '(copy private))
3356 (file-directory-p from)
3357 (not dired-recursive-copies))
3358 (dired-dnd-popup-notice))
3359 ((memq action '(copy private move link))
3360 (let ((overwrite (and (file-exists-p to)
3361 (y-or-n-p
3362 (format "Overwrite existing file `%s'? " to))))
3363 ;; Binding dired-overwrite-confirmed to nil makes
3364 ;; dired-handle-overwrite a no-op. We instead use
3365 ;; y-or-n-p, which pops a graphical menu.
3366 dired-overwrite-confirmed backup-file)
3367 (when (and overwrite
3368 ;; d-b-o is defined in dired-aux.
3369 (boundp 'dired-backup-overwrite)
3370 dired-backup-overwrite
3371 (setq backup-file
3372 (car (find-backup-file-name to)))
3373 (or (eq dired-backup-overwrite 'always)
3374 (y-or-n-p
3375 (format
3376 "Make backup for existing file `%s'? " to))))
3377 (rename-file to backup-file 0)
3378 (dired-relist-entry backup-file))
3379 (cond ((memq action '(copy private))
3380 (dired-copy-file from to overwrite))
3381 ((eq action 'move)
3382 (dired-rename-file from to overwrite))
3383 ((eq action 'link)
3384 (make-symbolic-link from to overwrite)))
3385 (dired-relist-entry to)
3386 action))))))
3388 (defun dired-dnd-handle-file (uri action)
3389 "Copy, move or link a file to the dired directory if it is a local file.
3390 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3391 ACTION is one of copy, move, link or ask.
3392 Ask means pop up a menu for the user to select one of copy, move or link."
3393 (let ((local-file (dnd-get-local-file-uri uri)))
3394 (if local-file (dired-dnd-handle-local-file local-file action)
3395 nil)))
3396 \f
3398 ;;;; Desktop support
3400 (eval-when-compile (require 'desktop))
3402 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3403 "Auxiliary information to be saved in desktop file."
3404 (cons
3405 ;; Value of `dired-directory'.
3406 (if (consp dired-directory)
3407 ;; Directory name followed by list of files.
3408 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3409 (cdr dired-directory))
3410 ;; Directory name, optionally with shell wildcard.
3411 (desktop-file-name dired-directory desktop-dirname))
3412 ;; Subdirectories in `dired-subdir-alist'.
3413 (cdr
3414 (nreverse
3415 (mapcar
3416 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3417 dired-subdir-alist)))))
3419 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3420 desktop-buffer-name
3421 desktop-buffer-misc)
3422 "Restore a dired buffer specified in a desktop file."
3423 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3424 ;; This value is a directory name, optionally with shell wildcard or
3425 ;; a directory name followed by list of files.
3426 (let* ((dired-dir (car desktop-buffer-misc))
3427 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3428 (if (file-directory-p (file-name-directory dir))
3429 (progn
3430 (dired dired-dir)
3431 ;; The following elements of `desktop-buffer-misc' are the keys
3432 ;; from `dired-subdir-alist'.
3433 (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3434 (current-buffer))
3435 (message "Desktop: Directory %s no longer exists." dir)
3436 (when desktop-missing-file-warning (sit-for 1))
3437 nil)))
3439 (add-to-list 'desktop-buffer-mode-handlers
3440 '(dired-mode . dired-restore-desktop-buffer))
3442 \f
3443 (provide 'dired)
3445 (run-hooks 'dired-load-hook) ; for your customizations
3447 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3448 ;;; dired.el ends here