| blob | d53a6831b130af901fb43a2725e5881c29826e1e |
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 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
493 files instead of the marked files.
494 In that case point is dragged along. This is so that commands on
495 the next ARG (instead of the marked) files can be chained easily.
496 If ARG is otherwise non-nil, use current file instead.
497 If optional third arg SHOW-PROGRESS evaluates to non-nil,
498 redisplay the dired buffer after each file is processed.
499 No guarantee is made about the position on the marked line.
500 BODY must ensure this itself if it depends on this.
501 Search starts at the beginning of the buffer, thus the car of the list
502 corresponds to the line nearest to the buffer's bottom. This
503 is also true for (positive and negative) integer values of ARG.
504 BODY should not be too long as it is expanded four times.
506 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
507 return (t FILENAME) instead of (FILENAME)."
508 ;;
509 ;;Warning: BODY must not add new lines before point - this may cause an
510 ;;endless loop.
511 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
518 ,arg
524 results))
525 ;; non-nil, non-integer ARG means use current file:
530 ;; remember position of next marked file before BODY
531 ;; can insert lines before the just found file,
532 ;; confusing us by finding the same marked file again
533 ;; and again and...
541 ;; move after last match
550 results
552 ;; save-excursion loses, again
556 "Return the marked files' names as list of strings.
557 The list is in the same order as the buffer, that is, the car is the
558 first marked file.
559 Values returned are normally absolute file names.
560 Optional arg LOCALP as in `dired-get-filename'.
561 Optional second argument ARG specifies files near point
562 instead of marked files. If ARG is an integer, use the next ARG files.
563 If ARG is otherwise non-nil, use file. Usually ARG comes from
564 the command's prefix arg.
565 Optional third argument FILTER, if non-nil, is a function to select
566 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
568 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
569 return (t FILENAME) instead of (FILENAME).
570 Don't use that together with FILTER."
575 arg nil distinguish-one-marked)))
576 result)
579 all-of-them
584 result)))
585 \f
586 ;; The dired command
589 ;; For use in interactive.
594 dired-listing-switches))
595 ;; If a dialog is about to be used, call read-directory-name so
596 ;; the dialog code knows we want directories. Some dialogs can
597 ;; only select directories or files when popped up, not both.
600 nil default-directory nil)
609 ;; We need a mix of read-file-name and
610 ;; read-directory-name so that completion to directories
611 ;; is preferred, but if the user wants to enter a global
612 ;; pattern, he can still use completion on filenames to
613 ;; help him write the pattern.
614 ;; Essentially, we want to use
615 ;; (completion-table-with-predicate
616 ;; 'read-file-name-internal 'file-directory-p nil)
617 ;; but that doesn't work because read-file-name-internal
618 ;; does not obey its `predicate' argument.
624 ;; Hack! Faster than file-directory-p!
635 nil default-directory nil))))))))
637 ;;;###autoload (define-key ctl-x-map "d" 'dired)
638 ;;;###autoload
641 Optional second argument SWITCHES specifies the `ls' options used.
642 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
643 Dired displays a list of files in DIRNAME (which may also have
644 shell wildcards appended to select certain files). If DIRNAME is a cons,
645 its first element is taken as the directory name and the rest as an explicit
646 list of files to make directory entries for.
648 You can move around in it with the usual commands.
653 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
654 ;; Cannot use (interactive "D") because of wildcards.
658 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
659 ;;;###autoload
665 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
666 ;;;###autoload
672 ;;;###autoload
674 "Like `dired' but returns the dired buffer as value, does not select it."
676 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
677 ;; some shells make:
688 ;; If the argument was syntactically a directory name not a file name,
689 ;; or if it happens to name a file that is a directory,
690 ;; convert it syntactically to a directory name.
691 ;; The reason for checking initially-was-dirname
692 ;; and not just file-directory-p
693 ;; is that file-directory-p is slow over ftp.
701 ;; The following is an internal dired function. It returns non-nil if
702 ;; the directory visited by the current dired buffer has changed on
703 ;; disk. DIRNAME should be the directory name of that directory.
712 "Return non-nil if current dired buffer needs updating.
713 If NOCONFIRM is non-nil, then this function always returns nil
714 for a remote directory. This feature is used by Auto Revert Mode."
722 ;; Separate function from dired-noselect for the sake of dired-vms.el.
724 ;; If there is an existing dired buffer for DIRNAME, just leave
725 ;; buffer as it is (don't even call dired-revert).
726 ;; This saves time especially for deep trees or with ange-ftp.
727 ;; The user can type `g' easily, and it is more consistent with find-file.
728 ;; But if SWITCHES are given they are probably different from the
729 ;; buffer's old value, so call dired-sort-other, which does
730 ;; revert the buffer.
731 ;; A pity we can't possibly do "Directory has changed - refresh? "
732 ;; like find-file does.
733 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
734 ;; see there.
736 buffer
737 ;; note that buffer already is in dired-mode, if found
738 new-buffer-p
743 ;; Look for an existing buffer.
748 ;; We don't want default-major-mode to run hooks and set auto-fill
749 ;; or whatever, now that dired-mode does not
750 ;; kill-all-local-variables any longer.
755 ;; file list may have changed
757 ;; this calls dired-revert
759 ;; If directory has changed on disk, offer to revert.
764 ;; Else a new buffer
766 ;; We can do this unconditionally
767 ;; because dired-noselect ensures that the name
768 ;; is passed in directory name syntax
769 ;; if it was the name of a directory at all.
774 ;; default-directory and dired-actual-switches are set now
775 ;; (buffer-local), so we can call dired-readin:
780 ;; dired-readin can fail if parent directories are inaccessible.
781 ;; Don't leave an empty buffer around in that case.
786 buffer))
789 ;; Enlarged by dired-advertise
790 ;; Queried by function dired-buffers-for-dir. When this detects a
791 ;; killed buffer, it is removed from this list.
795 ;; This differs from dired-buffers-for-dir in that it does not consider
796 ;; subdirs of default-directory and searches for the first match only.
797 ;; Also, the major mode must be MODE.
807 dired-directory ;; nil during find-alternate-file
812 dired-directory))))
814 blist nil)
816 found))
818 \f
819 ;; Read in a new dired buffer
822 "Read in a new dired buffer.
823 Differs from `dired-insert-subdir' in that it accepts
824 wildcards, erases the buffer, and builds the subdir-alist anew
825 \(including making it buffer-local and clearing it first)."
827 ;; default-directory and dired-actual-switches must be buffer-local
828 ;; and initialized by now.
835 ;; This hook which may want to modify dired-actual-switches
836 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
837 ;; where ls won't understand -Al switches.
845 ;; Don't make undo entries for readin.
851 ;; Must first make alist buffer local and set it to nil because
852 ;; dired-build-subdir-alist will call dired-clear-alist first
859 ;; No need to narrow since the whole buffer contains just
860 ;; dired-readin's output, nothing else. The hook can
861 ;; successfully use dired functions (e.g. dired-get-filename)
862 ;; as the subdir-alist has been built in dired-readin.
865 ;; Subroutines of dired-readin
868 ;; Insert listing for the specified dir (and maybe file list)
869 ;; already in dired-directory, assuming a clean buffer.
875 file-list nil))
879 ;; If we are reading a whole single directory...
884 ;; Else treat it as a wildcard spec
885 ;; unless we have an explicit list of files.
890 "Align the fields of a file to the ones of surrounding lines.
891 BEG..END is the line where the file info is located."
892 ;; Some versions of ls try to adjust the size of each field so as to just
893 ;; hold the largest element ("largest" in the current invocation, of
894 ;; course). So when a single line is output, the size of each field is
895 ;; just big enough for that one output. Thus when dired refreshes one
896 ;; line, the alignment if this line w.r.t the rest is messed up because
897 ;; the fields of that one line will generally be smaller.
898 ;;
899 ;; To work around this problem, we here add spaces to try and
900 ;; re-align the fields as needed. Since this is purely aesthetic,
901 ;; it is of utmost importance that it doesn't mess up anything like
902 ;; `dired-move-to-filename'. To this end, we limit ourselves to
903 ;; adding spaces only, and to only add them at places where there
904 ;; was already at least one space. This way, as long as
905 ;; `directory-listing-before-filename-regexp' always matches spaces
906 ;; with "*" or "+", we know we haven't made anything worse. There
907 ;; is one spot where the exact number of spaces is important, which
908 ;; is just before the actual filename, so we refrain from adding
909 ;; spaces there (and within the filename as well, of course).
912 ;; Check the there is indeed a file, and that there is anoter adjacent
913 ;; file with which to align, and that additional spaces are needed to
914 ;; align the filenames.
927 ;; Make sure there is some work left to do.
929 ;; If we've only looked at the line above, check to see if the line
930 ;; below exists as well and if so, align with the shorter one.
939 ;; Keep positions uptodate when we insert stuff.
942 ;; Main loop.
946 ;; Don't touch anything just before (and after) the
947 ;; beginning of the filename.
949 ;; We're now just in front of a field, with a space behind us.
951 ;; Nums are right-aligned.
953 ;; Let's look at the other line, in the same column: we
954 ;; should be either near the end of the previous field, or
955 ;; in the space between that field and the next.
956 ;; [ Of course, it's also possible that we're already within
957 ;; the next field or even past it, but that's unlikely since
958 ;; other-col > file-col. ]
959 ;; Let's find the distance to the alignment-point (either
960 ;; the beginning or the end of the next field, depending on
961 ;; whether this field is left or right aligned).
971 ;; Now, the number of spaces to insert is align-pt-offset
972 ;; minus the distance to the equivalent point on the
973 ;; current line.
976 align-pt-offset
986 ;; Let's just make really sure we did not mess up.
989 ;; Damn! We messed up: let's revert the change.
991 ;; Now skip to next field.
997 "Insert a directory listing of DIR, Dired style.
998 Use SWITCHES to make the listings.
999 If FILE-LIST is non-nil, list only those files.
1000 Otherwise, if WILDCARD is non-nil, expand wildcards;
1001 in that case, DIR should be a file name that uses wildcards.
1002 In other cases, DIR should be a directory name or a directory filename.
1003 If HDR is non-nil, insert a header line with the directory name."
1006 end)
1009 ;; We used to specify the C locale here, to force English month names;
1010 ;; but this should not be necessary any more,
1011 ;; with the new value of `directory-listing-before-filename-regexp'.
1016 ;; Re-align fields, if necessary.
1019 ;; Quote certain characters, unless ls quoted them for us.
1028 nil t))
1034 nil t))
1037 ;; If we used --dired and it worked, the lines are already indented.
1038 ;; Otherwise, indent them.
1044 ;; Insert text at the beginning to standardize things.
1050 ;; Note that dired-build-subdir-alist will replace the name
1051 ;; by its expansion, so it does not matter whether what we insert
1052 ;; here is fully expanded, but it should be absolute.
1055 ;; Insert "wildcard" line where "total" line would be for a full dir.
1059 "Make the file names highlight when the mouse is on them."
1074 \f
1075 ;; Reverting a dired buffer
1078 "Reread the dired buffer.
1079 Must also be called after `dired-actual-switches' have changed.
1080 Should not fail even on completely garbaged buffers.
1081 Preserves old cursor, marks/flags, hidden-p."
1094 ;; treat top level dir extra (it may contain wildcards)
1097 ;; Run dired-after-readin-hook just once, below.
1102 ;; ... run the hook for the whole buffer, and only after markers
1103 ;; have been reinserted (else omitting in dired-x would omit marked files)
1113 ;; outside of the let scope
1114 ;;; Might as well not override the user if the user changed this.
1115 ;;; (setq buffer-read-only t)
1116 )
1118 ;; Subroutines of dired-revert
1119 ;; Some of these are also used when inserting subdirs.
1122 "Return alist of files and their marks, from BEG to END."
1133 alist))
1136 "Mark all files remembered in ALIST.
1137 Each element of ALIST looks like (FILE . MARKERCHAR)."
1151 "Return a list of names of subdirs currently hidden."
1161 result))
1164 "Try to insert all subdirs that were displayed before.
1165 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1179 "Remove directory DIR from any directory cache."
1183 \f
1184 ;; dired mode key bindings and initialization
1187 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1188 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1193 ;; Commands to mark or flag certain categories of files
1198 ;; Upper case keys (except !) for operating on the marked files
1216 ;; Comparison commands
1219 ;; Tree Dired commands
1225 ;; move to marked files
1228 ;; Make all regexp commands share a `%' prefix:
1229 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1230 ;; but that seems to serve little purpose, and copy-keymap
1231 ;; does a better job without it.
1243 ;; Commands for marking and unmarking.
1260 ;; Lower keys for commands not operating on all the marked files
1286 ;; moving
1294 (define-key map [up] 'dired-previous-line)
1295 ;; hiding
1296 (define-key map "$" 'dired-hide-subdir)
1297 (define-key map "\M-$" 'dired-hide-all)
1298 ;; misc
1299 (define-key map "\C-x\C-q" 'dired-toggle-read-only)
1300 (define-key map "?" 'dired-summary)
1302 (define-key map [remap undo] 'dired-undo)
1303 (define-key map [remap advertised-undo] 'dired-undo)
1304 ;; thumbnail manipulation (image-dired)
1305 (define-key map "\C-td" 'image-dired-display-thumbs)
1306 (define-key map "\C-tt" 'image-dired-tag-files)
1307 (define-key map "\C-tr" 'image-dired-delete-tag)
1308 (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1309 (define-key map "\C-ti" 'image-dired-dired-display-image)
1310 (define-key map "\C-tx" 'image-dired-dired-display-external)
1311 (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1312 (define-key map "\C-t." 'image-dired-display-thumb)
1313 (define-key map "\C-tc" 'image-dired-dired-comment-files)
1314 (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1315 (define-key map "\C-t\C-t" 'image-dired-dired-insert-marked-thumbs)
1316 (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1317 ;; encryption and decryption (epa-dired)
1318 (define-key map ":d" 'epa-dired-do-decrypt)
1319 (define-key map ":v" 'epa-dired-do-verify)
1320 (define-key map ":s" 'epa-dired-do-sign)
1321 (define-key map ":e" 'epa-dired-do-encrypt)
1323 ;; Make menu bar items.
1325 ;; No need to fo this, now that top-level items are fewer.
1326 ;;;;
1327 ;; Get rid of the Edit menu bar item to save space.
1328 ;(define-key map [menu-bar edit] 'undefined)
1330 (define-key map [menu-bar subdir]
1331 (cons "Subdir" (make-sparse-keymap "Subdir")))
1333 (define-key map [menu-bar subdir hide-all]
1334 '(menu-item "Hide All" dired-hide-all
1335 :help "Hide all subdirectories, leave only header lines"))
1336 (define-key map [menu-bar subdir hide-subdir]
1337 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1338 :help "Hide or unhide current directory listing"))
1339 (define-key map [menu-bar subdir tree-down]
1340 '(menu-item "Tree Down" dired-tree-down
1341 :help "Go to first subdirectory header down the tree"))
1342 (define-key map [menu-bar subdir tree-up]
1343 '(menu-item "Tree Up" dired-tree-up
1344 :help "Go to first subdirectory header up the tree"))
1345 (define-key map [menu-bar subdir up]
1346 '(menu-item "Up Directory" dired-up-directory
1347 :help "Edit the parent directory"))
1348 (define-key map [menu-bar subdir prev-subdir]
1349 '(menu-item "Prev Subdir" dired-prev-subdir
1350 :help "Go to previous subdirectory header line"))
1351 (define-key map [menu-bar subdir next-subdir]
1352 '(menu-item "Next Subdir" dired-next-subdir
1353 :help "Go to next subdirectory header line"))
1354 (define-key map [menu-bar subdir prev-dirline]
1355 '(menu-item "Prev Dirline" dired-prev-dirline
1356 :help "Move to next directory-file line"))
1357 (define-key map [menu-bar subdir next-dirline]
1358 '(menu-item "Next Dirline" dired-next-dirline
1359 :help "Move to previous directory-file line"))
1360 (define-key map [menu-bar subdir insert]
1361 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1362 :help "Insert contents of subdirectory"))
1364 (define-key map [menu-bar immediate]
1365 (cons "Immediate" (make-sparse-keymap "Immediate")))
1367 (define-key map
1368 [menu-bar immediate epa-dired-do-decrypt]
1369 '(menu-item "Decrypt" epa-dired-do-decrypt
1370 :help "Decrypt file at cursor"))
1372 (define-key map
1373 [menu-bar immediate epa-dired-do-verify]
1374 '(menu-item "Verify" epa-dired-do-verify
1375 :help "Verify digital signature of file at cursor"))
1377 (define-key map
1378 [menu-bar immediate epa-dired-do-sign]
1379 '(menu-item "Sign" epa-dired-do-sign
1380 :help "Create digital signature of file at cursor"))
1382 (define-key map
1383 [menu-bar immediate epa-dired-do-encrypt]
1384 '(menu-item "Encrypt" epa-dired-do-encrypt
1385 :help "Encrypt file at cursor"))
1387 (define-key map [menu-bar immediate dashes-4]
1388 '("--"))
1390 (define-key map
1391 [menu-bar immediate image-dired-dired-display-external]
1392 '(menu-item "Display Image Externally" image-dired-dired-display-external
1393 :help "Display image in external viewer"))
1394 (define-key map
1395 [menu-bar immediate image-dired-dired-display-image]
1396 '(menu-item "Display Image" image-dired-dired-display-image
1397 :help "Display sized image in a separate window"))
1399 (define-key map [menu-bar immediate dashes-4]
1400 '("--"))
1402 (define-key map [menu-bar immediate revert-buffer]
1403 '(menu-item "Refresh" revert-buffer
1404 :help "Update contents of shown directories"))
1406 (define-key map [menu-bar immediate dashes]
1407 '("--"))
1409 (define-key map [menu-bar immediate compare-directories]
1410 '(menu-item "Compare Directories..." dired-compare-directories
1411 :help "Mark files with different attributes in two dired buffers"))
1412 (define-key map [menu-bar immediate backup-diff]
1413 '(menu-item "Compare with Backup" dired-backup-diff
1414 :help "Diff file at cursor with its latest backup"))
1415 (define-key map [menu-bar immediate diff]
1416 '(menu-item "Diff..." dired-diff
1417 :help "Compare file at cursor with another file"))
1418 (define-key map [menu-bar immediate view]
1419 '(menu-item "View This File" dired-view-file
1420 :help "Examine file at cursor in read-only mode"))
1421 (define-key map [menu-bar immediate display]
1422 '(menu-item "Display in Other Window" dired-display-file
1423 :help "Display file at cursor in other window"))
1424 (define-key map [menu-bar immediate find-file-other-window]
1425 '(menu-item "Find in Other Window" dired-find-file-other-window
1426 :help "Edit file at cursor in other window"))
1427 (define-key map [menu-bar immediate find-file]
1428 '(menu-item "Find This File" dired-find-file
1429 :help "Edit file at cursor"))
1430 (define-key map [menu-bar immediate create-directory]
1431 '(menu-item "Create Directory..." dired-create-directory
1432 :help "Create a directory"))
1433 (define-key map [menu-bar immediate wdired-mode]
1434 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1435 :help "Put a dired buffer in a mode in which filenames are editable"
1436 :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1438 (define-key map [menu-bar regexp]
1439 (cons "Regexp" (make-sparse-keymap "Regexp")))
1441 (define-key map
1442 [menu-bar regexp image-dired-mark-tagged-files]
1443 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1444 :help "Mark files whose image tags matches regexp"))
1446 (define-key map [menu-bar regexp dashes-1]
1447 '("--"))
1449 (define-key map [menu-bar regexp downcase]
1450 '(menu-item "Downcase" dired-downcase
1451 ;; When running on plain MS-DOS, there's only one
1452 ;; letter-case for file names.
1453 :enable (or (not (fboundp 'msdos-long-file-names))
1454 (msdos-long-file-names))
1455 :help "Rename marked files to lower-case name"))
1456 (define-key map [menu-bar regexp upcase]
1457 '(menu-item "Upcase" dired-upcase
1458 :enable (or (not (fboundp 'msdos-long-file-names))
1459 (msdos-long-file-names))
1460 :help "Rename marked files to upper-case name"))
1461 (define-key map [menu-bar regexp hardlink]
1462 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1463 :help "Make hard links for files matching regexp"))
1464 (define-key map [menu-bar regexp symlink]
1465 '(menu-item "Symlink..." dired-do-symlink-regexp
1466 :visible (fboundp 'make-symbolic-link)
1467 :help "Make symbolic links for files matching regexp"))
1468 (define-key map [menu-bar regexp rename]
1469 '(menu-item "Rename..." dired-do-rename-regexp
1470 :help "Rename marked files matching regexp"))
1471 (define-key map [menu-bar regexp copy]
1472 '(menu-item "Copy..." dired-do-copy-regexp
1473 :help "Copy marked files matching regexp"))
1474 (define-key map [menu-bar regexp flag]
1475 '(menu-item "Flag..." dired-flag-files-regexp
1476 :help "Flag files matching regexp for deletion"))
1477 (define-key map [menu-bar regexp mark]
1478 '(menu-item "Mark..." dired-mark-files-regexp
1479 :help "Mark files matching regexp for future operations"))
1480 (define-key map [menu-bar regexp mark-cont]
1481 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1482 :help "Mark files whose contents matches regexp"))
1484 (define-key map [menu-bar mark]
1485 (cons "Mark" (make-sparse-keymap "Mark")))
1487 (define-key map [menu-bar mark prev]
1488 '(menu-item "Previous Marked" dired-prev-marked-file
1489 :help "Move to previous marked file"))
1490 (define-key map [menu-bar mark next]
1491 '(menu-item "Next Marked" dired-next-marked-file
1492 :help "Move to next marked file"))
1493 (define-key map [menu-bar mark marks]
1494 '(menu-item "Change Marks..." dired-change-marks
1495 :help "Replace marker with another character"))
1496 (define-key map [menu-bar mark unmark-all]
1497 '(menu-item "Unmark All" dired-unmark-all-marks))
1498 (define-key map [menu-bar mark symlinks]
1499 '(menu-item "Mark Symlinks" dired-mark-symlinks
1500 :visible (fboundp 'make-symbolic-link)
1501 :help "Mark all symbolic links"))
1502 (define-key map [menu-bar mark directories]
1503 '(menu-item "Mark Directories" dired-mark-directories
1504 :help "Mark all directories except `.' and `..'"))
1505 (define-key map [menu-bar mark directory]
1506 '(menu-item "Mark Old Backups" dired-clean-directory
1507 :help "Flag old numbered backups for deletion"))
1508 (define-key map [menu-bar mark executables]
1509 '(menu-item "Mark Executables" dired-mark-executables
1510 :help "Mark all executable files"))
1511 (define-key map [menu-bar mark garbage-files]
1512 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1513 :help "Flag unneeded files for deletion"))
1514 (define-key map [menu-bar mark backup-files]
1515 '(menu-item "Flag Backup Files" dired-flag-backup-files
1516 :help "Flag all backup files for deletion"))
1517 (define-key map [menu-bar mark auto-save-files]
1518 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1519 :help "Flag auto-save files for deletion"))
1520 (define-key map [menu-bar mark deletion]
1521 '(menu-item "Flag" dired-flag-file-deletion
1522 :help "Flag current line's file for deletion"))
1523 (define-key map [menu-bar mark unmark]
1524 '(menu-item "Unmark" dired-unmark
1525 :help "Unmark or unflag current line's file"))
1526 (define-key map [menu-bar mark mark]
1527 '(menu-item "Mark" dired-mark
1528 :help "Mark current line's file for future operations"))
1529 (define-key map [menu-bar mark toggle-marks]
1530 '(menu-item "Toggle Marks" dired-toggle-marks
1531 :help "Mark unmarked files, unmark marked ones"))
1533 (define-key map [menu-bar operate]
1534 (cons "Operate" (make-sparse-keymap "Operate")))
1536 (define-key map
1537 [menu-bar operate image-dired-delete-tag]
1538 '(menu-item "Delete Image Tag..." image-dired-delete-tag
1539 :help "Delete image tag from current or marked files"))
1540 (define-key map
1541 [menu-bar operate image-dired-tag-files]
1542 '(menu-item "Add Image Tags..." image-dired-tag-files
1543 :help "Add image tags to current or marked files"))
1544 (define-key map
1545 [menu-bar operate image-dired-dired-comment-files]
1546 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1547 :help "Add image comment to current or marked files"))
1548 (define-key map
1549 [menu-bar operate image-dired-display-thumbs]
1550 '(menu-item "Display Image-Dired" image-dired-display-thumbs
1551 :help "Display image-dired for current or marked image files"))
1553 (define-key map [menu-bar operate dashes-3]
1554 '("--"))
1556 (define-key map [menu-bar operate query-replace]
1557 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1558 :help "Replace regexp in marked files"))
1559 (define-key map [menu-bar operate search]
1560 '(menu-item "Search Files..." dired-do-search
1561 :help "Search marked files for regexp"))
1562 (define-key map [menu-bar operate chown]
1563 '(menu-item "Change Owner..." dired-do-chown
1564 :visible (not (memq system-type '(ms-dos windows-nt)))
1565 :help "Change the owner of marked files"))
1566 (define-key map [menu-bar operate chgrp]
1567 '(menu-item "Change Group..." dired-do-chgrp
1568 :visible (not (memq system-type '(ms-dos windows-nt)))
1569 :help "Change the group of marked files"))
1570 (define-key map [menu-bar operate chmod]
1571 '(menu-item "Change Mode..." dired-do-chmod
1572 :help "Change mode (attributes) of marked files"))
1573 (define-key map [menu-bar operate touch]
1574 '(menu-item "Change Timestamp..." dired-do-touch
1575 :help "Change timestamp of marked files"))
1576 (define-key map [menu-bar operate load]
1577 '(menu-item "Load" dired-do-load
1578 :help "Load marked Emacs Lisp files"))
1579 (define-key map [menu-bar operate compile]
1580 '(menu-item "Byte-compile" dired-do-byte-compile
1581 :help "Byte-compile marked Emacs Lisp files"))
1582 (define-key map [menu-bar operate compress]
1583 '(menu-item "Compress" dired-do-compress
1584 :help "Compress/uncompress marked files"))
1585 (define-key map [menu-bar operate print]
1586 '(menu-item "Print..." dired-do-print
1587 :help "Ask for print command and print marked files"))
1588 (define-key map [menu-bar operate hardlink]
1589 '(menu-item "Hardlink to..." dired-do-hardlink
1590 :help "Make hard links for current or marked files"))
1591 (define-key map [menu-bar operate symlink]
1592 '(menu-item "Symlink to..." dired-do-symlink
1593 :visible (fboundp 'make-symbolic-link)
1594 :help "Make symbolic links for current or marked files"))
1595 (define-key map [menu-bar operate command]
1596 '(menu-item "Shell Command..." dired-do-shell-command
1597 :help "Run a shell command on each of marked files"))
1598 (define-key map [menu-bar operate delete]
1599 '(menu-item "Delete" dired-do-delete
1600 :help "Delete current file or all marked files"))
1601 (define-key map [menu-bar operate rename]
1602 '(menu-item "Rename to..." dired-do-rename
1603 :help "Rename current file or move marked files"))
1604 (define-key map [menu-bar operate copy]
1605 '(menu-item "Copy to..." dired-do-copy
1606 :help "Copy current file or all marked files"))
1608 map)
1609 "Local keymap for `dired-mode' buffers.")
1610 \f
1611 ;; Dired mode is suitable only for specially formatted data.
1612 (put 'dired-mode 'mode-class 'special)
1614 ;; Autoload cookie needed by desktop.el
1615 ;;;###autoload
1616 (defun dired-mode (&optional dirname switches)
1617 "\
1620 \(optionally) its subdirectories, in the format of `ls -lR'.
1623 compress, load or byte-compile them, change their file attributes
1626 by file or all files matching certain criteria.
1628 Letters no longer insert themselves. Digits are prefix arguments.
1631 Most commands operate on the marked files and use the current file
1632 if no files are marked. Use a numeric prefix argument to operate on
1633 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1634 to operate on the current file only. Prefix arguments override marks.
1636 to see why something went wrong.
1641 (or dired it in another buffer, if it is a directory).
1648 This retains all marks and hides subdirs again that were hidden before.
1649 SPC and DEL can be used to move down and up by lines.
1652 to read the
1654 to relist a single or the marked files or a
1656 again for the directory tree.
1659 for more info):
1661 `dired-listing-switches'
1662 `dired-trivial-filenames'
1663 `dired-shrink-to-fit'
1664 `dired-marker-char'
1665 `dired-del-marker'
1666 `dired-keep-marker-rename'
1667 `dired-keep-marker-copy'
1668 `dired-keep-marker-hardlink'
1669 `dired-keep-marker-symlink'
1673 `dired-before-readin-hook'
1674 `dired-after-readin-hook'
1675 `dired-mode-hook'
1676 `dired-load-hook'
1678 Keybindings:
1680 ;; Not to be called interactively (e.g. dired-directory will be set
1681 ;; to default-directory, which is wrong with wildcards).
1682 (kill-all-local-variables)
1683 (use-local-map dired-mode-map)
1684 (dired-advertise) ; default-directory is already set
1685 (setq major-mode 'dired-mode
1686 mode-name "Dired"
1687 ;; case-fold-search nil
1688 buffer-read-only t
1689 selective-display t ; for subdirectory hiding
1690 mode-line-buffer-identification
1691 (propertized-buffer-identification "%17b"))
1692 (set (make-local-variable 'revert-buffer-function)
1693 (function dired-revert))
1694 (set (make-local-variable 'buffer-stale-function)
1695 (function dired-buffer-stale-p))
1696 (set (make-local-variable 'page-delimiter)
1698 (set (make-local-variable 'dired-directory)
1699 (or dirname default-directory))
1700 ;; list-buffers uses this to display the dir being edited in this buffer.
1701 (set (make-local-variable 'list-buffers-directory)
1702 (expand-file-name (if (listp dired-directory)
1703 (car dired-directory)
1704 dired-directory)))
1705 (set (make-local-variable 'dired-actual-switches)
1706 (or switches dired-listing-switches))
1707 (set (make-local-variable 'font-lock-defaults)
1708 '(dired-font-lock-keywords t nil nil beginning-of-line))
1709 (set (make-local-variable 'desktop-save-buffer)
1710 'dired-desktop-buffer-misc-data)
1711 (setq dired-switches-alist nil)
1712 (dired-sort-other dired-actual-switches t)
1713 (when (featurep 'dnd)
1714 (set (make-local-variable 'dnd-protocol-alist)
1715 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1716 (run-mode-hooks 'dired-mode-hook))
1717 \f
1718 ;; Idiosyncratic dired commands that don't deal with marks.
1720 (defun dired-summary ()
1721 "Summarize basic Dired commands and show recent dired errors."
1722 (interactive)
1723 (dired-why)
1724 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1725 (message
1726 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1728 (defun dired-undo ()
1729 "Undo in a dired buffer.
1730 This doesn't recover lost files, it just undoes changes in the buffer itself.
1731 You can use it to recover marks, killed lines or subdirs."
1732 (interactive)
1733 (let ((inhibit-read-only t))
1734 (undo))
1735 (dired-build-subdir-alist)
1736 (message "Change in dired buffer undone.
1737 Actual changes in files cannot be undone by Emacs."))
1739 (defun dired-toggle-read-only ()
1740 "Edit dired buffer with Wdired, or set it read-only.
1741 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1742 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1743 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1744 (interactive)
1745 (if (eq major-mode 'dired-mode)
1746 (wdired-change-to-wdired-mode)
1747 (toggle-read-only)))
1749 (defun dired-next-line (arg)
1750 "Move down lines then position at filename.
1751 Optional prefix ARG says how many lines to move; default is one line."
1752 (interactive "p")
1753 (forward-line arg)
1754 (dired-move-to-filename))
1756 (defun dired-previous-line (arg)
1757 "Move up lines then position at filename.
1758 Optional prefix ARG says how many lines to move; default is one line."
1759 (interactive "p")
1760 (forward-line (- arg))
1761 (dired-move-to-filename))
1763 (defun dired-next-dirline (arg &optional opoint)
1764 "Goto ARG'th next directory file line."
1765 (interactive "p")
1766 (or opoint (setq opoint (point)))
1767 (if (if (> arg 0)
1768 (re-search-forward dired-re-dir nil t arg)
1769 (beginning-of-line)
1770 (re-search-backward dired-re-dir nil t (- arg)))
1771 (dired-move-to-filename) ; user may type `i' or `f'
1772 (goto-char opoint)
1773 (error "No more subdirectories")))
1775 (defun dired-prev-dirline (arg)
1776 "Goto ARG'th previous directory file line."
1777 (interactive "p")
1778 (dired-next-dirline (- arg)))
1780 (defun dired-up-directory (&optional other-window)
1781 "Run Dired on parent directory of current directory.
1782 Find the parent directory either in this buffer or another buffer.
1783 Creates a buffer if necessary."
1784 (interactive "P")
1785 (let* ((dir (dired-current-directory))
1786 (up (file-name-directory (directory-file-name dir))))
1787 (or (dired-goto-file (directory-file-name dir))
1788 ;; Only try dired-goto-subdir if buffer has more than one dir.
1789 (and (cdr dired-subdir-alist)
1790 (dired-goto-subdir up))
1791 (progn
1792 (if other-window
1793 (dired-other-window up)
1794 (dired up))
1795 (dired-goto-file dir)))))
1797 (defun dired-get-file-for-visit ()
1798 "Get the current line's file name, with an error if file does not exist."
1799 (interactive)
1800 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1801 (let ((raw (dired-get-filename nil t))
1802 file-name)
1803 (if (null raw)
1804 (error "No file on this line"))
1805 (setq file-name (file-name-sans-versions raw t))
1806 (if (file-exists-p file-name)
1807 file-name
1808 (if (file-symlink-p file-name)
1809 (error "File is a symlink to a nonexistent target")
1810 (error "File no longer exists; type `g' to update dired buffer")))))
1812 ;; Force `f' rather than `e' in the mode doc:
1813 (defalias 'dired-advertised-find-file 'dired-find-file)
1814 (defun dired-find-file ()
1815 "In Dired, visit the file or directory named on this line."
1816 (interactive)
1817 ;; Bind `find-file-run-dired' so that the command works on directories
1818 ;; too, independent of the user's setting.
1819 (let ((find-file-run-dired t))
1820 (find-file (dired-get-file-for-visit))))
1822 (defun dired-find-alternate-file ()
1823 "In Dired, visit this file or directory instead of the dired buffer."
1824 (interactive)
1825 (set-buffer-modified-p nil)
1826 (find-alternate-file (dired-get-file-for-visit)))
1827 ;; Don't override the setting from .emacs.
1828 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1830 (defun dired-mouse-find-file-other-window (event)
1831 "In Dired, visit the file or directory name you click on."
1832 (interactive "e")
1833 (let (window pos file)
1834 (save-excursion
1835 (setq window (posn-window (event-end event))
1836 pos (posn-point (event-end event)))
1837 (if (not (windowp window))
1838 (error "No file chosen"))
1839 (set-buffer (window-buffer window))
1840 (goto-char pos)
1841 (setq file (dired-get-file-for-visit)))
1842 (if (file-directory-p file)
1843 (or (and (cdr dired-subdir-alist)
1844 (dired-goto-subdir file))
1845 (progn
1846 (select-window window)
1847 (dired-other-window file)))
1848 (select-window window)
1849 (find-file-other-window (file-name-sans-versions file t)))))
1851 (defun dired-view-file ()
1852 "In Dired, examine a file in view mode, returning to Dired when done.
1853 When file is a directory, show it in this buffer if it is inserted.
1854 Otherwise, display it in another buffer."
1855 (interactive)
1856 (let ((file (dired-get-file-for-visit)))
1857 (if (file-directory-p file)
1858 (or (and (cdr dired-subdir-alist)
1859 (dired-goto-subdir file))
1860 (dired file))
1861 (view-file file))))
1863 (defun dired-find-file-other-window ()
1864 "In Dired, visit this file or directory in another window."
1865 (interactive)
1866 (find-file-other-window (dired-get-file-for-visit)))
1868 (defun dired-display-file ()
1869 "In Dired, display this file or directory in another window."
1870 (interactive)
1871 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1872 \f
1873 ;;; Functions for extracting and manipulating file names in Dired buffers.
1875 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1876 "In Dired, return name of file mentioned on this line.
1877 Value returned normally includes the directory name.
1878 Optional arg LOCALP with value `no-dir' means don't include directory
1879 name in result. A value of `verbatim' means to return the name exactly as
1880 it occurs in the buffer, and a value of t means construct name relative to
1881 `default-directory', which still may contain slashes if in a subdirectory.
1882 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1883 regular filenames and return nil if no filename on this line.
1884 Otherwise, an error occurs in these cases."
1885 (let (case-fold-search file p1 p2 already-absolute)
1886 (save-excursion
1887 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1888 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1889 ;; nil if no file on this line, but no-error-if-not-filep is t:
1890 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1891 (progn
1892 ;; Get rid of the mouse-face property that file names have.
1893 (set-text-properties 0 (length file) nil file)
1894 ;; Unquote names quoted by ls or by dired-insert-directory.
1895 ;; Using read to unquote is much faster than substituting
1897 (setq file
1898 (read
1900 ;; Some ls -b don't escape quotes, argh!
1901 ;; This is not needed for GNU ls, though.
1902 (or (dired-string-replace-match
1904 file)
1906 ;; The above `read' will return a unibyte string if FILE
1907 ;; contains eight-bit-control/graphic characters.
1908 (if (and enable-multibyte-characters
1909 (not (multibyte-string-p file)))
1910 (setq file (string-to-multibyte file)))))
1911 (and file (file-name-absolute-p file)
1912 ;; A relative file name can start with ~.
1913 ;; Don't treat it as absolute in this context.
1914 (not (eq (aref file 0) ?~))
1915 (setq already-absolute t))
1916 (cond
1917 ((null file)
1918 nil)
1919 ((eq localp 'verbatim)
1920 file)
1921 ((and (not no-error-if-not-filep)
1922 (member file '("." "..")))
1923 (error "Cannot operate on `.' or `..'"))
1924 ((and (eq localp 'no-dir) already-absolute)
1925 (file-name-nondirectory file))
1926 (already-absolute
1927 (let ((handler (find-file-name-handler file nil)))
1928 ;; check for safe-magic property so that we won't
1929 ;; put /: for names that don't really need them.
1930 ;; For instance, .gz files when auto-compression-mode is on.
1931 (if (and handler (not (get handler 'safe-magic)))
1932 (concat "/:" file)
1933 file)))
1934 ((eq localp 'no-dir)
1935 file)
1936 ((equal (dired-current-directory) "/")
1937 (setq file (concat (dired-current-directory localp) file))
1938 (let ((handler (find-file-name-handler file nil)))
1939 ;; check for safe-magic property so that we won't
1940 ;; put /: for names that don't really need them.
1941 ;; For instance, .gz files when auto-compression-mode is on.
1942 (if (and handler (not (get handler 'safe-magic)))
1943 (concat "/:" file)
1944 file)))
1945 (t
1946 (concat (dired-current-directory localp) file)))))
1948 (defun dired-string-replace-match (regexp string newtext
1949 &optional literal global)
1950 "Replace first match of REGEXP in STRING with NEWTEXT.
1951 If it does not match, nil is returned instead of the new string.
1952 Optional arg LITERAL means to take NEWTEXT literally.
1953 Optional arg GLOBAL means to replace all matches."
1954 (if global
1955 (let ((start 0) ret)
1956 (while (string-match regexp string start)
1957 (let ((from-end (- (length string) (match-end 0))))
1958 (setq ret (setq string (replace-match newtext t literal string)))
1959 (setq start (- (length string) from-end))))
1960 ret)
1961 (if (not (string-match regexp string 0))
1962 nil
1963 (replace-match newtext t literal string))))
1965 (defun dired-make-absolute (file &optional dir)
1966 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1967 ;; We can't always use expand-file-name as this would get rid of `.'
1968 ;; or expand in / instead default-directory if DIR=="".
1969 ;; This should be good enough for ange-ftp, but might easily be
1970 ;; redefined (for VMS?).
1971 ;; It should be reasonably fast, though, as it is called in
1972 ;; dired-get-filename.
1973 (concat (or dir default-directory) file))
1975 (defun dired-make-relative (file &optional dir ignore)
1976 "Convert FILE (an absolute file name) to a name relative to DIR.
1977 If this is impossible, return FILE unchanged.
1978 DIR must be a directory name, not a file name."
1979 (or dir (setq dir default-directory))
1980 ;; This case comes into play if default-directory is set to
1981 ;; use ~.
1982 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1983 (setq dir (expand-file-name dir)))
1984 (if (string-match (concat "^" (regexp-quote dir)) file)
1985 (substring file (match-end 0))
1986 ;;; (or no-error
1987 ;;; (error "%s: not in directory tree growing at %s" file dir))
1988 file))
1989 \f
1990 ;;; Functions for finding the file name in a dired buffer line.
1992 (defvar dired-permission-flags-regexp
1994 "Regular expression to match the permission flags in `ls -l'.")
1996 ;; Move to first char of filename on this line.
1997 ;; Returns position (point) or nil if no filename on this line."
1998 (defun dired-move-to-filename (&optional raise-error eol)
1999 "Move to the beginning of the filename on the current line.
2000 Return the position of the beginning of the filename, or nil if none found."
2001 ;; This is the UNIX version.
2002 (or eol (setq eol (line-end-position)))
2003 (beginning-of-line)
2004 ;; First try assuming `ls --dired' was used.
2005 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
2006 (cond
2007 ((and change (< change eol))
2008 (goto-char change))
2009 ((re-search-forward directory-listing-before-filename-regexp eol t)
2010 (goto-char (match-end 0)))
2011 ((re-search-forward dired-permission-flags-regexp eol t)
2012 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2013 (if raise-error
2014 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
2015 (beginning-of-line)
2016 nil)
2017 (raise-error
2018 (error "No file on this line")))))
2020 (defun dired-move-to-end-of-filename (&optional no-error)
2021 ;; Assumes point is at beginning of filename,
2022 ;; thus the rwx bit re-search-backward below will succeed in *this*
2023 ;; line if at all. So, it should be called only after
2024 ;; (dired-move-to-filename t).
2025 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2026 ;; This is the UNIX version.
2027 (if (get-text-property (point) 'dired-filename)
2028 (goto-char (next-single-property-change (point) 'dired-filename))
2029 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
2030 ;; case-fold-search is nil now, so we can test for capital F:
2031 (setq used-F (string-match "F" dired-actual-switches)
2032 opoint (point)
2033 eol (save-excursion (end-of-line) (point))
2034 hidden (and selective-display
2036 (if hidden
2037 nil
2038 (save-excursion ;; Find out what kind of file this is:
2039 ;; Restrict perm bits to be non-blank,
2040 ;; otherwise this matches one char to early (looking backward):
2041 ;; "l---------" (some systems make symlinks that way)
2042 ;; "----------" (plain file with zero perms)
2043 (if (re-search-backward
2044 dired-permission-flags-regexp nil t)
2045 (setq file-type (char-after (match-beginning 1))
2046 symlink (eq file-type ?l)
2047 ;; Only with -F we need to know whether it's an executable
2048 executable (and
2049 used-F
2050 (string-match
2051 "[xst]" ;; execute bit set anywhere?
2052 (concat
2053 (match-string 2)
2054 (match-string 3)
2055 (match-string 4)))))
2056 (or no-error (error "No file on this line"))))
2057 ;; Move point to end of name:
2058 (if symlink
2059 (if (search-forward " -> " eol t)
2060 (progn
2061 (forward-char -4)
2062 (and used-F
2063 dired-ls-F-marks-symlinks
2064 (eq (preceding-char) ?@) ;; did ls really mark the link?
2065 (forward-char -1))))
2066 (goto-char eol) ;; else not a symbolic link
2067 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2068 ;; one trailing character. (Executable bits on symlinks ain't mean
2069 ;; a thing, even to ls, but we know it's not a symlink.)
2070 (and used-F
2071 (or (memq file-type '(?d ?s ?p))
2072 executable)
2073 (forward-char -1))))
2074 (or no-error
2075 (not (eq opoint (point)))
2076 (error "%s" (if hidden
2077 (substitute-command-keys
2079 "No file on this line")))
2080 (if (eq opoint (point))
2081 nil
2082 (point)))))
2084 \f
2085 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2087 (defun dired-copy-filename-as-kill (&optional arg)
2088 "Copy names of marked (or next ARG) files into the kill ring.
2089 The names are separated by a space.
2090 With a zero prefix arg, use the absolute file name of each marked file.
2092 `default-directory'. (This still may contain slashes if in a subdirectory.)
2094 If on a subdir headerline, use absolute subdirname instead;
2095 prefix arg and marked files are ignored in this case.
2098 (interactive "P")
2099 (let ((string
2100 (or (dired-get-subdir)
2101 (mapconcat (function identity)
2102 (if arg
2103 (cond ((zerop (prefix-numeric-value arg))
2104 (dired-get-marked-files))
2105 ((consp arg)
2106 (dired-get-marked-files t))
2107 (t
2108 (dired-get-marked-files
2109 'no-dir (prefix-numeric-value arg))))
2110 (dired-get-marked-files 'no-dir))
2111 " "))))
2112 (if (eq last-command 'kill-region)
2113 (kill-append string nil)
2114 (kill-new string))
2115 (message "%s" string)))
2117 \f
2118 ;; Keeping Dired buffers in sync with the filesystem and with each other
2120 (defun dired-buffers-for-dir (dir &optional file)
2121 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2122 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2123 ;; matches FILE.
2124 ;; The list is in reverse order of buffer creation, most recent last.
2125 ;; As a side effect, killed dired buffers for DIR are removed from
2126 ;; dired-buffers.
2127 (setq dir (file-name-as-directory dir))
2128 (let ((alist dired-buffers) result elt buf)
2129 (while alist
2130 (setq elt (car alist)
2131 buf (cdr elt))
2132 (if (buffer-name buf)
2133 (if (dired-in-this-tree dir (car elt))
2134 (with-current-buffer buf
2135 (and (assoc dir dired-subdir-alist)
2136 (or (null file)
2137 (let ((wildcards
2138 (file-name-nondirectory dired-directory)))
2139 (or (= 0 (length wildcards))
2140 (string-match (dired-glob-regexp wildcards)
2141 file))))
2142 (setq result (cons buf result)))))
2143 ;; else buffer is killed - clean up:
2144 (setq dired-buffers (delq elt dired-buffers)))
2145 (setq alist (cdr alist)))
2146 result))
2148 (defun dired-glob-regexp (pattern)
2149 "Convert glob-pattern PATTERN to a regular expression."
2150 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2151 regexp)
2152 (while (string-match "[[?*]" pattern matched-in-pattern)
2153 (let ((op-end (match-end 0))
2154 (next-op (aref pattern (match-beginning 0))))
2155 (setq regexp (concat regexp
2156 (regexp-quote
2157 (substring pattern matched-in-pattern
2158 (match-beginning 0)))))
2159 (cond ((= next-op ??)
2160 (setq regexp (concat regexp "."))
2161 (setq matched-in-pattern op-end))
2162 ((= next-op ?\[)
2163 ;; Fails to handle ^ yet ????
2164 (let* ((set-start (match-beginning 0))
2165 (set-cont
2166 (if (= (aref pattern (1+ set-start)) ?^)
2167 (+ 3 set-start)
2168 (+ 2 set-start)))
2169 (set-end (string-match "]" pattern set-cont))
2170 (set (substring pattern set-start (1+ set-end))))
2171 (setq regexp (concat regexp set))
2172 (setq matched-in-pattern (1+ set-end))))
2173 ((= next-op ?*)
2174 (setq regexp (concat regexp ".*"))
2175 (setq matched-in-pattern op-end)))))
2177 regexp
2178 (regexp-quote
2179 (substring pattern matched-in-pattern))
2184 (defun dired-advertise ()
2185 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2186 ;; With wildcards we actually advertise too much.
2187 (let ((expanded-default (expand-file-name default-directory)))
2188 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2189 t ; we have already advertised ourselves
2190 (setq dired-buffers
2191 (cons (cons expanded-default (current-buffer))
2192 dired-buffers)))))
2194 (defun dired-unadvertise (dir)
2195 ;; Remove DIR from the buffer alist in variable dired-buffers.
2196 ;; This has the effect of removing any buffer whose main directory is DIR.
2197 ;; It does not affect buffers in which DIR is a subdir.
2198 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2199 (setq dired-buffers
2200 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2201 \f
2202 ;; Tree Dired
2204 ;;; utility functions
2206 (defun dired-in-this-tree (file dir)
2207 ;;"Is FILE part of the directory tree starting at DIR?"
2208 (let (case-fold-search)
2209 (string-match (concat "^" (regexp-quote dir)) file)))
2211 (defun dired-normalize-subdir (dir)
2212 ;; Prepend default-directory to DIR if relative file name.
2213 ;; dired-get-filename must be able to make a valid file name from a
2214 ;; file and its directory DIR.
2215 (file-name-as-directory
2216 (if (file-name-absolute-p dir)
2217 dir
2218 (expand-file-name dir default-directory))))
2220 (defun dired-get-subdir ()
2221 ;;"Return the subdir name on this line, or nil if not on a headerline."
2222 ;; Look up in the alist whether this is a headerline.
2223 (save-excursion
2224 (let ((cur-dir (dired-current-directory)))
2225 (beginning-of-line) ; alist stores b-o-l positions
2226 (and (zerop (- (point)
2227 (dired-get-subdir-min (assoc cur-dir
2228 dired-subdir-alist))))
2229 cur-dir))))
2231 ;(defun dired-get-subdir-min (elt)
2232 ; (cdr elt))
2233 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2234 (defalias 'dired-get-subdir-min 'cdr)
2236 (defun dired-get-subdir-max (elt)
2237 (save-excursion
2238 (goto-char (dired-get-subdir-min elt))
2239 (dired-subdir-max)))
2241 (defun dired-clear-alist ()
2242 (while dired-subdir-alist
2243 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2244 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2246 (defun dired-subdir-index (dir)
2247 ;; Return an index into alist for use with nth
2248 ;; for the sake of subdir moving commands.
2249 (let (found (index 0) (alist dired-subdir-alist))
2250 (while alist
2251 (if (string= dir (car (car alist)))
2252 (setq alist nil found t)
2253 (setq alist (cdr alist) index (1+ index))))
2254 (if found index nil)))
2256 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2257 "Go to next subdirectory, regardless of level."
2258 ;; Use 0 arg to go to this directory's header line.
2259 ;; NO-SKIP prevents moving to end of header line, returning whatever
2260 ;; position was found in dired-subdir-alist.
2261 (interactive "p")
2262 (let ((this-dir (dired-current-directory))
2263 pos index)
2264 ;; nth with negative arg does not return nil but the first element
2265 (setq index (- (dired-subdir-index this-dir) arg))
2266 (setq pos (if (>= index 0)
2267 (dired-get-subdir-min (nth index dired-subdir-alist))))
2268 (if pos
2269 (progn
2270 (goto-char pos)
2272 (point))
2273 (if no-error-if-not-found
2274 nil ; return nil if not found
2275 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2277 (defun dired-build-subdir-alist (&optional switches)
2278 "Build `dired-subdir-alist' by parsing the buffer.
2279 Returns the new value of the alist.
2280 If optional arg SWITCHES is non-nil, use its value
2281 instead of `dired-actual-switches'."
2282 (interactive)
2283 (dired-clear-alist)
2284 (save-excursion
2285 (let* ((count 0)
2286 (inhibit-read-only t)
2287 (buffer-undo-list t)
2288 (switches (or switches dired-actual-switches))
2289 new-dir-name
2290 (R-ftp-base-dir-regex
2291 ;; Used to expand subdirectory names correctly in recursive
2292 ;; ange-ftp listings.
2293 (and (string-match "R" switches)
2296 (goto-char (point-min))
2297 (setq dired-subdir-alist nil)
2298 (while (re-search-forward dired-subdir-regexp nil t)
2299 ;; Avoid taking a file name ending in a colon
2300 ;; as a subdir name.
2301 (unless (save-excursion
2302 (goto-char (match-beginning 0))
2303 (beginning-of-line)
2304 (forward-char 2)
2305 (save-match-data (looking-at dired-re-perms)))
2306 (save-excursion
2307 (goto-char (match-beginning 1))
2308 (setq new-dir-name
2309 (buffer-substring-no-properties (point) (match-end 1))
2310 new-dir-name
2311 (save-match-data
2312 (if (and R-ftp-base-dir-regex
2313 (not (string= new-dir-name default-directory))
2314 (string-match R-ftp-base-dir-regex new-dir-name))
2315 (concat default-directory
2316 (substring new-dir-name (match-end 0)))
2317 (expand-file-name new-dir-name))))
2318 (delete-region (point) (match-end 1))
2319 (insert new-dir-name))
2320 (setq count (1+ count))
2321 (dired-alist-add-1 new-dir-name
2322 ;; Place a sub directory boundary between lines.
2323 (save-excursion
2324 (goto-char (match-beginning 0))
2325 (beginning-of-line)
2326 (point-marker)))))
2327 (if (and (> count 1) (interactive-p))
2328 (message "Buffer includes %d directories" count)))
2329 ;; We don't need to sort it because it is in buffer order per
2330 ;; constructionem. Return new alist:
2331 dired-subdir-alist))
2333 (defun dired-alist-add-1 (dir new-marker)
2334 ;; Add new DIR at NEW-MARKER. Don't sort.
2335 (setq dired-subdir-alist
2336 (cons (cons (dired-normalize-subdir dir) new-marker)
2337 dired-subdir-alist)))
2339 (defun dired-goto-next-nontrivial-file ()
2340 ;; Position point on first nontrivial file after point.
2341 (dired-goto-next-file);; so there is a file to compare with
2342 (if (stringp dired-trivial-filenames)
2343 (while (and (not (eobp))
2344 (string-match dired-trivial-filenames
2345 (file-name-nondirectory
2346 (or (dired-get-filename nil t) ""))))
2347 (forward-line 1)
2348 (dired-move-to-filename))))
2350 (defun dired-goto-next-file ()
2351 (let ((max (1- (dired-subdir-max))))
2352 (while (and (not (dired-move-to-filename)) (< (point) max))
2353 (forward-line 1))))
2355 (defun dired-goto-file (file)
2356 "Go to line describing file FILE in this dired buffer."
2357 ;; Return value of point on success, else nil.
2358 ;; FILE must be an absolute file name.
2361 ;; it in the buffer.
2362 (interactive
2363 (prog1 ; let push-mark display its message
2364 (list (expand-file-name
2365 (read-file-name "Goto file: "
2366 (dired-current-directory))))
2367 (push-mark)))
2368 (setq file (directory-file-name file)) ; does no harm if no directory
2369 (let (found case-fold-search dir)
2370 (setq dir (or (file-name-directory file)
2371 (error "File name `%s' is not absolute" file)))
2372 (save-excursion
2373 ;; The hair here is to get the result of dired-goto-subdir
2374 ;; without really calling it if we don't have any subdirs.
2375 (if (if (string= dir (expand-file-name default-directory))
2376 (goto-char (point-min))
2377 (and (cdr dired-subdir-alist)
2378 (dired-goto-subdir dir)))
2379 (let ((base (file-name-nondirectory file))
2380 search-string
2381 (boundary (dired-subdir-max)))
2382 (setq search-string
2384 (setq search-string
2386 (while (and (not found)
2387 ;; filenames are preceded by SPC, this makes
2388 ;; the search faster (e.g. for the filename "-"!).
2389 (search-forward (concat " " search-string)
2390 boundary 'move))
2391 ;; Match could have BASE just as initial substring or
2392 ;; or in permission bits or date or
2393 ;; not be a proper filename at all:
2394 (if (equal base (dired-get-filename 'no-dir t))
2395 ;; Must move to filename since an (actually
2396 ;; correct) match could have been elsewhere on the
2397 ;; ;; line (e.g. "-" would match somewhere in the
2398 ;; permission bits).
2399 (setq found (dired-move-to-filename))
2400 ;; If this isn't the right line, move forward to avoid
2401 ;; trying this line again.
2402 (forward-line 1))))))
2403 (and found
2404 ;; return value of point (i.e., FOUND):
2405 (goto-char found))))
2407 (defun dired-initial-position (dirname)
2408 ;; Where point should go in a new listing of DIRNAME.
2409 ;; Point assumed at beginning of new subdir line.
2410 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2411 (end-of-line)
2412 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2413 \f
2414 ;; These are hooks which make tree dired work.
2415 ;; They are in this file because other parts of dired need to call them.
2416 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2418 ;; This function is called for each retrieved filename.
2419 ;; It could stand to be faster, though it's mostly function call
2420 ;; overhead. Avoiding the function call seems to save about 10% in
2421 ;; dired-get-filename. Make it a defsubst?
2422 (defun dired-current-directory (&optional localp)
2423 "Return the name of the subdirectory to which this line belongs.
2424 This returns a string with trailing slash, like `default-directory'.
2425 Optional argument means return a file name relative to `default-directory'."
2426 (let ((here (point))
2427 (alist (or dired-subdir-alist
2428 ;; probably because called in a non-dired buffer
2429 (error "No subdir-alist in %s" (current-buffer))))
2430 elt dir)
2431 (while alist
2432 (setq elt (car alist)
2433 dir (car elt)
2434 ;; use `<=' (not `<') as subdir line is part of subdir
2435 alist (if (<= (dired-get-subdir-min elt) here)
2436 nil ; found
2437 (cdr alist))))
2438 (if localp
2439 (dired-make-relative dir default-directory)
2440 dir)))
2442 ;; Subdirs start at the beginning of their header lines and end just
2443 ;; before the beginning of the next header line (or end of buffer).
2445 (defun dired-subdir-max ()
2446 (save-excursion
2447 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2448 (point-max)
2449 (point))))
2450 \f
2451 ;; Deleting files
2453 (defcustom dired-recursive-deletes 'top
2454 "*Decide whether recursive deletes are allowed.
2455 A value of nil means no recursive deletes.
2456 `always' means delete recursively without asking. This is DANGEROUS!
2457 `top' means ask for each directory at top level, but delete its subdirectories
2458 without asking.
2459 Anything else means ask for each directory."
2460 :type '(choice :tag "Delete non-empty directories"
2461 (const :tag "Yes" always)
2462 (const :tag "No--only delete empty directories" nil)
2463 (const :tag "Confirm for each directory" t)
2464 (const :tag "Confirm for each top directory only" top))
2465 :group 'dired)
2467 ;; Match anything but `.' and `..'.
2470 ;; Delete file, possibly delete a directory and all its files.
2471 ;; This function is usefull outside of dired. One could change it's name
2472 ;; to e.g. recursive-delete-file and put it somewhere else.
2473 (defun dired-delete-file (file &optional recursive) "\
2474 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2475 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2476 nil, do not delete.
2477 `always', delete recursively without asking.
2478 `top', ask for each directory at top level.
2479 Anything else, ask for each sub-directory."
2480 (let (files)
2481 ;; This test is equivalent to
2482 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2483 ;; but more efficient
2484 (if (not (eq t (car (file-attributes file))))
2485 (delete-file file)
2486 (when (and recursive
2487 (setq files
2488 (directory-files file t dired-re-no-dot)) ; Not empty.
2489 (or (eq recursive 'always)
2490 (yes-or-no-p (format "Recursive delete of %s? "
2491 (dired-make-relative file)))))
2492 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2493 (while files ; Recursively delete (possibly asking).
2494 (dired-delete-file (car files) recursive)
2495 (setq files (cdr files))))
2496 (delete-directory file))))
2498 (defun dired-do-flagged-delete (&optional nomessage)
2499 "In Dired, delete the files flagged for deletion.
2500 If NOMESSAGE is non-nil, we don't display any message
2501 if there are no flagged files.
2502 `dired-recursive-deletes' controls whether deletion of
2503 non-empty directories is allowed."
2504 (interactive)
2505 (let* ((dired-marker-char dired-del-marker)
2506 (regexp (dired-marker-regexp))
2507 case-fold-search)
2508 (if (save-excursion (goto-char (point-min))
2509 (re-search-forward regexp nil t))
2510 (dired-internal-do-deletions
2511 ;; this can't move point since ARG is nil
2512 (dired-map-over-marks (cons (dired-get-filename) (point))
2513 nil)
2514 nil)
2515 (or nomessage
2516 (message "(No deletions requested)")))))
2518 (defun dired-do-delete (&optional arg)
2519 "Delete all marked (or next ARG) files.
2520 `dired-recursive-deletes' controls whether deletion of
2521 non-empty directories is allowed."
2522 ;; This is more consistent with the file marking feature than
2523 ;; dired-do-flagged-delete.
2524 (interactive "P")
2525 (dired-internal-do-deletions
2526 ;; this may move point if ARG is an integer
2527 (dired-map-over-marks (cons (dired-get-filename) (point))
2528 arg)
2529 arg))
2531 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2533 (defun dired-internal-do-deletions (l arg)
2534 ;; L is an alist of files to delete, with their buffer positions.
2535 ;; ARG is the prefix arg.
2536 ;; Filenames are absolute (VMS needs this for logical search paths).
2537 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2538 ;; That way as changes are made in the buffer they do not shift the
2539 ;; lines still to be changed, so the (point) values in L stay valid.
2540 ;; Also, for subdirs in natural order, a subdir's files are deleted
2541 ;; before the subdir itself - the other way around would not work.
2542 (let ((files (mapcar (function car) l))
2543 (count (length l))
2544 (succ 0))
2545 ;; canonicalize file list for pop up
2546 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2547 (if (dired-mark-pop-up
2548 " *Deletions*" 'delete files dired-deletion-confirmer
2549 (format "Delete %s " (dired-mark-prompt arg files)))
2550 (save-excursion
2551 (let (failures);; files better be in reverse order for this loop!
2552 (while l
2553 (goto-char (cdr (car l)))
2554 (let ((inhibit-read-only t))
2555 (condition-case err
2556 (let ((fn (car (car l))))
2557 (dired-delete-file fn dired-recursive-deletes)
2558 ;; if we get here, removing worked
2559 (setq succ (1+ succ))
2560 (message "%s of %s deletions" succ count)
2561 (dired-fun-in-all-buffers
2562 (file-name-directory fn) (file-name-nondirectory fn)
2563 (function dired-delete-entry) fn))
2564 (error;; catch errors from failed deletions
2566 (setq failures (cons (car (car l)) failures)))))
2567 (setq l (cdr l)))
2568 (if (not failures)
2569 (message "%d deletion%s done" count (dired-plural-s count))
2570 (dired-log-summary
2571 (format "%d of %d deletion%s failed"
2572 (length failures) count
2573 (dired-plural-s count))
2574 failures))))
2575 (message "(No deletions performed)")))
2576 (dired-move-to-filename))
2578 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2579 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2580 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2581 ;; (FILE does not include a directory component.)
2582 ;; FILE may be nil, in which case ignore it.
2583 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2584 (let (success-list)
2585 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2586 file))
2587 (with-current-buffer buf
2588 (if (apply fun args)
2589 (setq success-list (cons (buffer-name buf) success-list)))))
2590 success-list))
2592 ;; Delete the entry for FILE from
2593 (defun dired-delete-entry (file)
2594 (save-excursion
2595 (and (dired-goto-file file)
2596 (let ((inhibit-read-only t))
2597 (delete-region (progn (beginning-of-line) (point))
2598 (save-excursion (forward-line 1) (point))))))
2599 (dired-clean-up-after-deletion file))
2601 ;; This is a separate function for the sake of dired-x.el.
2602 (defun dired-clean-up-after-deletion (fn)
2603 ;; Clean up after a deleted file or directory FN.
2604 (save-excursion (and (cdr dired-subdir-alist)
2605 (dired-goto-subdir fn)
2606 (dired-kill-subdir))))
2607 \f
2608 ;; Confirmation
2610 (defun dired-marker-regexp ()
2611 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2613 (defun dired-plural-s (count)
2614 (if (= 1 count) "" "s"))
2616 (defun dired-mark-prompt (arg files)
2617 "Return a string for use in a prompt, either the current file
2618 name, or the marker and a count of marked files."
2619 ;; distinguish-one-marked can cause the first element to be just t.
2620 (if (eq (car files) t) (setq files (cdr files)))
2621 (let ((count (length files)))
2622 (if (= count 1)
2623 (car files)
2624 ;; more than 1 file:
2625 (if (integerp arg)
2626 ;; abs(arg) = count
2627 ;; Perhaps this is nicer, but it also takes more screen space:
2628 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2629 ;; count)
2630 (format "[next %d files]" arg)
2631 (format "%c [%d files]" dired-marker-char count)))))
2633 (defun dired-pop-to-buffer (buf)
2634 ;; Pop up buffer BUF.
2635 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2636 (if (not dired-shrink-to-fit)
2637 (pop-to-buffer (get-buffer-create buf))
2638 ;; let window shrink to fit:
2639 (let ((window (selected-window))
2640 target-lines w2)
2641 (cond ;; if split-height-threshold is enabled, use the largest window
2642 ((and (> (window-height (setq w2 (get-largest-window)))
2643 split-height-threshold)
2644 (window-full-width-p w2))
2645 (setq window w2))
2646 ;; if the least-recently-used window is big enough, use it
2647 ((and (> (window-height (setq w2 (get-lru-window)))
2648 (* 2 window-min-height))
2649 (window-full-width-p w2))
2650 (setq window w2)))
2651 (save-excursion
2652 (set-buffer buf)
2653 (goto-char (point-max))
2655 (setq target-lines (count-lines (point-min) (point)))
2656 ;; Don't forget to count the last line.
2657 (if (not (bolp))
2658 (setq target-lines (1+ target-lines))))
2659 (if (<= (window-height window) (* 2 window-min-height))
2660 ;; At this point, every window on the frame is too small to split.
2661 (setq w2 (display-buffer buf))
2662 (setq w2 (split-window window
2663 (max window-min-height
2664 (- (window-height window)
2665 (1+ (max window-min-height target-lines)))))))
2666 (set-window-buffer w2 buf)
2667 (if (< (1- (window-height w2)) target-lines)
2668 (progn
2669 (select-window w2)
2670 (enlarge-window (- target-lines (1- (window-height w2))))))
2671 (set-window-start w2 1)
2672 )))
2674 (defcustom dired-no-confirm nil
2675 "A list of symbols for commands Dired should not confirm.
2676 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2677 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2678 `touch' and `uncompress'."
2679 :group 'dired
2680 :type '(set (const byte-compile) (const chgrp)
2681 (const chmod) (const chown) (const compress)
2682 (const copy) (const delete) (const hardlink)
2683 (const load) (const move) (const print)
2684 (const shell) (const symlink) (const touch)
2685 (const uncompress)))
2687 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2688 "Return FUNCTION's result on ARGS after showing which files are marked.
2689 Displays the file names in a buffer named BUFNAME;
2691 This uses function `dired-pop-to-buffer' to do that.
2693 FUNCTION should not manipulate files, just read input
2694 (an argument or confirmation).
2695 The window is not shown if there is just one file or
2696 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2697 FILES is the list of marked files. It can also be (t FILENAME)
2698 in the case of one marked file, to distinguish that from using
2699 just the current file."
2700 (or bufname (setq bufname " *Marked Files*"))
2701 (if (or (eq dired-no-confirm t)
2702 (memq op-symbol dired-no-confirm)
2703 ;; If FILES defaulted to the current line's file.
2704 (= (length files) 1))
2705 (apply function args)
2706 (with-current-buffer (get-buffer-create bufname)
2707 (erase-buffer)
2708 ;; Handle (t FILE) just like (FILE), here.
2709 ;; That value is used (only in some cases), to mean
2710 ;; just one file that was marked, rather than the current line file.
2711 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2712 (remove-text-properties (point-min) (point-max)
2713 '(mouse-face nil help-echo nil)))
2714 (save-window-excursion
2715 (dired-pop-to-buffer bufname)
2716 (apply function args))))
2718 (defun dired-format-columns-of-files (files)
2719 (let ((beg (point)))
2720 (completion--insert-strings files)
2721 (put-text-property beg (point) 'mouse-face nil)))
2722 \f
2723 ;; Commands to mark or flag file(s) at or near current line.
2725 (defun dired-repeat-over-lines (arg function)
2726 ;; This version skips non-file lines.
2727 (let ((pos (make-marker)))
2728 (beginning-of-line)
2729 (while (and (> arg 0) (not (eobp)))
2730 (setq arg (1- arg))
2731 (beginning-of-line)
2732 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2733 (save-excursion
2734 (forward-line 1)
2735 (move-marker pos (1+ (point))))
2736 (save-excursion (funcall function))
2737 ;; Advance to the next line--actually, to the line that *was* next.
2738 ;; (If FUNCTION inserted some new lines in between, skip them.)
2739 (goto-char pos))
2740 (while (and (< arg 0) (not (bobp)))
2741 (setq arg (1+ arg))
2742 (forward-line -1)
2743 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2744 (beginning-of-line)
2745 (save-excursion (funcall function)))
2746 (move-marker pos nil)
2747 (dired-move-to-filename)))
2749 (defun dired-between-files ()
2750 ;; This used to be a regexp match of the `total ...' line output by
2751 ;; ls, which is slightly faster, but that is not very robust; notably,
2752 ;; it fails for non-english locales.
2753 (save-excursion (not (dired-move-to-filename))))
2755 (defun dired-next-marked-file (arg &optional wrap opoint)
2756 "Move to the next marked file, wrapping around the end of the buffer."
2758 (or opoint (setq opoint (point)));; return to where interactively started
2759 (if (if (> arg 0)
2760 (re-search-forward dired-re-mark nil t arg)
2761 (beginning-of-line)
2762 (re-search-backward dired-re-mark nil t (- arg)))
2763 (dired-move-to-filename)
2764 (if (null wrap)
2765 (progn
2766 (goto-char opoint)
2767 (error "No next marked file"))
2768 (message "(Wraparound for next marked file)")
2769 (goto-char (if (> arg 0) (point-min) (point-max)))
2770 (dired-next-marked-file arg nil opoint))))
2772 (defun dired-prev-marked-file (arg &optional wrap)
2773 "Move to the previous marked file, wrapping around the end of the buffer."
2775 (dired-next-marked-file (- arg) wrap))
2777 (defun dired-file-marker (file)
2778 ;; Return FILE's marker, or nil if unmarked.
2779 (save-excursion
2780 (and (dired-goto-file file)
2781 (progn
2782 (beginning-of-line)
2784 (following-char))))))
2786 (defun dired-mark-files-in-region (start end)
2787 (let ((inhibit-read-only t))
2788 (if (> start end)
2789 (error "start > end"))
2790 (goto-char start) ; assumed at beginning of line
2791 (while (< (point) end)
2792 ;; Skip subdir line and following garbage like the `total' line:
2793 (while (and (< (point) end) (dired-between-files))
2794 (forward-line 1))
2795 (if (and (not (looking-at dired-re-dot))
2796 (dired-get-filename nil t))
2797 (progn
2798 (delete-char 1)
2799 (insert dired-marker-char)))
2800 (forward-line 1))))
2802 (defun dired-mark (arg)
2803 "Mark the current (or next ARG) files.
2804 If on a subdir headerline, mark all its files except `.' and `..'.
2808 this subdir."
2809 (interactive "P")
2810 (if (dired-get-subdir)
2811 (save-excursion (dired-mark-subdir-files))
2812 (let ((inhibit-read-only t))
2813 (dired-repeat-over-lines
2814 (prefix-numeric-value arg)
2815 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2817 (defun dired-unmark (arg)
2818 "Unmark the current (or next ARG) files.
2819 If looking at a subdir, unmark all its files except `.' and `..'."
2820 (interactive "P")
2822 (dired-mark arg)))
2824 (defun dired-flag-file-deletion (arg)
2825 "In Dired, flag the current line's file for deletion.
2826 With prefix arg, repeat over several lines.
2828 If on a subdir headerline, mark all its files except `.' and `..'."
2829 (interactive "P")
2830 (let ((dired-marker-char dired-del-marker))
2831 (dired-mark arg)))
2833 (defun dired-unmark-backward (arg)
2834 "In Dired, move up lines and remove deletion flag there.
2835 Optional prefix ARG says how many lines to unflag; default is one line."
2836 (interactive "p")
2837 (dired-unmark (- arg)))
2839 (defun dired-toggle-marks ()
2840 "Toggle marks: marked files become unmarked, and vice versa.
2841 Files marked with other flags (such as `D') are not affected.
2842 `.' and `..' are never toggled.
2843 As always, hidden subdirs are not affected."
2844 (interactive)
2845 (save-excursion
2846 (goto-char (point-min))
2847 (let ((inhibit-read-only t))
2848 (while (not (eobp))
2849 (or (dired-between-files)
2850 (looking-at dired-re-dot)
2851 ;; use subst instead of insdel because it does not move
2852 ;; the gap and thus should be faster and because
2853 ;; other characters are left alone automatically
2854 (apply 'subst-char-in-region
2855 (point) (1+ (point))
2859 (forward-line 1)))))
2860 \f
2861 ;;; Commands to mark or flag files based on their characteristics or names.
2863 (defvar dired-regexp-history nil
2864 "History list of regular expressions used in Dired commands.")
2866 (defun dired-read-regexp (prompt)
2867 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2869 (defun dired-mark-files-regexp (regexp &optional marker-char)
2870 "Mark all files matching REGEXP for use in later commands.
2871 A prefix argument means to unmark them instead.
2872 `.' and `..' are never marked.
2875 object files--just `.o' will mark more than you might think."
2876 (interactive
2877 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2878 " files (regexp): "))
2880 (let ((dired-marker-char (or marker-char dired-marker-char)))
2881 (dired-mark-if
2882 (and (not (looking-at dired-re-dot))
2883 (not (eolp)) ; empty line
2884 (let ((fn (dired-get-filename nil t)))
2885 (and fn (string-match regexp (file-name-nondirectory fn)))))
2886 "matching file")))
2888 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2889 "Mark all files with contents containing REGEXP for use in later commands.
2890 A prefix argument means to unmark them instead.
2891 `.' and `..' are never marked."
2892 (interactive
2893 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2894 " files containing (regexp): "))
2896 (let ((dired-marker-char (or marker-char dired-marker-char)))
2897 (dired-mark-if
2898 (and (not (looking-at dired-re-dot))
2899 (not (eolp)) ; empty line
2900 (let ((fn (dired-get-filename nil t)))
2901 (when (and fn (file-readable-p fn)
2902 (not (file-directory-p fn)))
2903 (let ((prebuf (get-file-buffer fn)))
2904 (message "Checking %s" fn)
2905 ;; For now we do it inside emacs
2906 ;; Grep might be better if there are a lot of files
2907 (if prebuf
2908 (with-current-buffer prebuf
2909 (save-excursion
2910 (goto-char (point-min))
2911 (re-search-forward regexp nil t)))
2912 (with-temp-buffer
2913 (insert-file-contents fn)
2914 (goto-char (point-min))
2915 (re-search-forward regexp nil t))))
2916 )))
2917 "matching file")))
2919 (defun dired-flag-files-regexp (regexp)
2920 "In Dired, flag all files containing the specified REGEXP for deletion.
2921 The match is against the non-directory part of the filename. Use `^'
2922 and `$' to anchor matches. Exclude subdirs by hiding them.
2923 `.' and `..' are never flagged."
2924 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2925 (dired-mark-files-regexp regexp dired-del-marker))
2927 (defun dired-mark-symlinks (unflag-p)
2928 "Mark all symbolic links.
2929 With prefix argument, unflag all those files."
2930 (interactive "P")
2932 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2934 (defun dired-mark-directories (unflag-p)
2935 "Mark all directory file lines except `.' and `..'.
2936 With prefix argument, unflag all those files."
2937 (interactive "P")
2939 (dired-mark-if (and (looking-at dired-re-dir)
2940 (not (looking-at dired-re-dot)))
2941 "directory file")))
2943 (defun dired-mark-executables (unflag-p)
2944 "Mark all executable files.
2945 With prefix argument, unflag all those files."
2946 (interactive "P")
2948 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2950 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2951 ;; files for which PREDICATE returns non-nil.
2953 (defun dired-flag-auto-save-files (&optional unflag-p)
2954 "Flag for deletion files whose names suggest they are auto save files.
2955 A prefix argument says to unflag those files instead."
2956 (interactive "P")
2958 (dired-mark-if
2959 ;; It is less than general to check for # here,
2960 ;; but it's the only way this runs fast enough.
2961 (and (save-excursion (end-of-line)
2962 (or
2963 (eq (preceding-char) ?#)
2964 ;; Handle executables in case of -F option.
2965 ;; We need not worry about the other kinds
2966 ;; of markings that -F makes, since they won't
2967 ;; appear on real auto-save files.
2968 (if (eq (preceding-char) ?*)
2969 (progn
2970 (forward-char -1)
2971 (eq (preceding-char) ?#)))))
2972 (not (looking-at dired-re-dir))
2973 (let ((fn (dired-get-filename t t)))
2974 (if fn (auto-save-file-name-p
2975 (file-name-nondirectory fn)))))
2976 "auto save file")))
2978 (defcustom dired-garbage-files-regexp
2979 ;; `log' here is dubious, since it's typically used for useful log
2980 ;; files, not just TeX stuff. -- fx
2981 (concat (regexp-opt
2982 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2985 :type 'regexp
2986 :group 'dired)
2988 (defun dired-flag-garbage-files ()
2989 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2990 (interactive)
2991 (dired-flag-files-regexp dired-garbage-files-regexp))
2993 (defun dired-flag-backup-files (&optional unflag-p)
2994 "Flag all backup files (names ending with `~') for deletion.
2995 With prefix argument, unflag these files."
2996 (interactive "P")
2997 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
2998 (dired-mark-if
2999 ;; Don't call backup-file-name-p unless the last character looks like
3000 ;; it might be the end of a backup file name. This isn't very general,
3001 ;; but it's the only way this runs fast enough.
3002 (and (save-excursion (end-of-line)
3003 ;; Handle executables in case of -F option.
3004 ;; We need not worry about the other kinds
3005 ;; of markings that -F makes, since they won't
3006 ;; appear on real backup files.
3007 (if (eq (preceding-char) ?*)
3008 (forward-char -1))
3009 (eq (preceding-char) ?~))
3010 (not (looking-at dired-re-dir))
3011 (let ((fn (dired-get-filename t t)))
3012 (if fn (backup-file-name-p fn))))
3013 "backup file")))
3015 (defun dired-change-marks (&optional old new)
3016 "Change all OLD marks to NEW marks.
3017 OLD and NEW are both characters used to mark files."
3018 (interactive
3019 (let* ((cursor-in-echo-area t)
3020 (old (progn (message "Change (old mark): ") (read-char)))
3021 (new (progn (message "Change %c marks to (new mark): " old)
3022 (read-char))))
3023 (list old new)))
3025 (ding)
3027 (inhibit-read-only t))
3028 (save-excursion
3029 (goto-char (point-min))
3030 (while (search-forward string nil t)
3031 (if (if (= old ?\s)
3032 (save-match-data
3033 (dired-get-filename 'no-dir t))
3034 t)
3035 (subst-char-in-region (match-beginning 0)
3036 (match-end 0) old new)))))))
3038 (defun dired-unmark-all-marks ()
3039 "Remove all marks from all files in the dired buffer."
3040 (interactive)
3043 (defun dired-unmark-all-files (mark &optional arg)
3044 "Remove a specific mark (or any mark) from every file.
3045 After this command, type the mark character to remove,
3046 or type RET to remove all marks.
3047 With prefix arg, query for each marked file.
3050 (save-excursion
3051 (let* ((count 0)
3052 (inhibit-read-only t) case-fold-search query
3054 (help-form "\
3055 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3056 `!' to unmark all remaining files with no more questions."))
3057 (goto-char (point-min))
3059 (re-search-forward dired-re-mark nil t)
3060 (search-forward string nil t))
3061 (if (or (not arg)
3062 (let ((file (dired-get-filename t t)))
3063 (and file
3064 (dired-query 'query "Unmark file `%s'? "
3065 file))))
3066 (progn (subst-char-in-region (1- (point)) (point)
3067 (preceding-char) ?\s)
3068 (setq count (1+ count)))))
3069 (message (if (= count 1) "1 mark removed"
3070 "%d marks removed")
3071 count))))
3072 \f
3073 ;; Logging failures operating on files, and showing the results.
3075 (defvar dired-log-buffer "*Dired log*")
3077 (defun dired-why ()
3078 "Pop up a buffer with error log output from Dired.
3079 A group of errors from a single command ends with a formfeed.
3081 (interactive)
3082 (if (get-buffer dired-log-buffer)
3083 (let ((owindow (selected-window))
3084 (window (display-buffer (get-buffer dired-log-buffer))))
3085 (unwind-protect
3086 (progn
3087 (select-window window)
3088 (goto-char (point-max))
3089 (forward-line -1)
3090 (backward-page 1)
3091 (recenter 0))
3092 (select-window owindow)))))
3094 (defun dired-log (log &rest args)
3095 ;; Log a message or the contents of a buffer.
3096 ;; If LOG is a string and there are more args, it is formatted with
3098 ;; End each bunch of errors with (dired-log t):
3099 ;; this inserts the current time and buffer at the start of the page,
3101 (let ((obuf (current-buffer)))
3102 (with-current-buffer (get-buffer-create dired-log-buffer)
3103 (goto-char (point-max))
3104 (let ((inhibit-read-only t))
3105 (cond ((stringp log)
3106 (insert (if args
3107 (apply (function format) log args)
3108 log)))
3109 ((bufferp log)
3110 (insert-buffer-substring log))
3111 ((eq t log)
3112 (backward-page 1)
3113 (unless (bolp)
3115 (insert (current-time-string)
3117 (goto-char (point-max))
3120 (defun dired-log-summary (string failures)
3121 "State a summary of a command's failures, in echo area and log buffer.
3122 STRING is an overall summary of the failures.
3123 FAILURES is a list of file names that we failed to operate on,
3124 or nil if file names are not applicable."
3125 (if (= (length failures) 1)
3126 (message "%s"
3127 (with-current-buffer dired-log-buffer
3128 (goto-char (point-max))
3129 (backward-page 1)
3130 (if (eolp) (forward-line 1))
3131 (buffer-substring (point) (point-max))))
3132 (message (if failures "%s--type ? for details (%s)"
3133 "%s--type ? for details")
3134 string failures))
3135 ;; Log a summary describing a bunch of errors.
3137 (dired-log t))
3138 \f
3139 ;;; Sorting
3141 ;; Most ls can only sort by name or by date (with -t), nothing else.
3142 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3143 ;; So anything that does not contain these is sort "by name".
3145 (defvar dired-ls-sorting-switches "SXU"
3148 This indicates to Dired which option switches to watch out for because they
3149 will change the sorting order behavior of `ls'.
3151 To change the default sorting order \(e.g. add a `-v' option\), see the
3152 variable `dired-listing-switches'. To temporarily override the listing
3155 (defvar dired-sort-by-date-regexp
3156 (concat "^-[^" dired-ls-sorting-switches
3157 "]*t[^" dired-ls-sorting-switches "]*$")
3158 "Regexp recognized by Dired to set `by date' mode.")
3160 (defvar dired-sort-by-name-regexp
3161 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3162 "Regexp recognized by Dired to set `by name' mode.")
3164 (defvar dired-sort-inhibit nil
3165 "Non-nil means the Dired sort command is disabled.
3166 The idea is to set this buffer-locally in special dired buffers.")
3168 (defun dired-sort-set-modeline ()
3169 ;; Set modeline display according to dired-actual-switches.
3170 ;; Modeline display of "by name" or "by date" guarantees the user a
3171 ;; match with the corresponding regexps. Non-matching switches are
3172 ;; shown literally.
3173 (when (eq major-mode 'dired-mode)
3174 (setq mode-name
3175 (let (case-fold-search)
3176 (cond ((string-match
3177 dired-sort-by-name-regexp dired-actual-switches)
3178 "Dired by name")
3179 ((string-match
3180 dired-sort-by-date-regexp dired-actual-switches)
3181 "Dired by date")
3182 (t
3183 (concat "Dired " dired-actual-switches)))))
3184 (force-mode-line-update)))
3186 (defun dired-sort-toggle-or-edit (&optional arg)
3187 "Toggle between sort by date/name and refresh the dired buffer.
3188 With a prefix argument you can edit the current listing switches instead."
3189 (interactive "P")
3190 (when dired-sort-inhibit
3191 (error "Cannot sort this dired buffer"))
3192 (if arg
3193 (dired-sort-other
3194 (read-string "ls switches (must contain -l): " dired-actual-switches))
3195 (dired-sort-toggle)))
3197 (defun dired-sort-toggle ()
3198 ;; Toggle between sort by date/name. Reverts the buffer.
3199 (setq dired-actual-switches
3200 (let (case-fold-search)
3201 (if (string-match " " dired-actual-switches)
3202 ;; New toggle scheme: add/remove a trailing " -t"
3204 (substring dired-actual-switches 0 (match-beginning 0))
3205 (concat dired-actual-switches " -t"))
3206 ;; old toggle scheme: look for some 't' switch and add/remove it
3207 (concat
3208 "-l"
3209 (dired-replace-in-string (concat "[-lt"
3210 dired-ls-sorting-switches "]")
3211 ""
3212 dired-actual-switches)
3213 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3214 dired-actual-switches)
3215 ""
3216 "t")))))
3217 (dired-sort-set-modeline)
3218 (revert-buffer))
3220 ;; Some user code loads dired especially for this.
3221 ;; Don't do that--use replace-regexp-in-string instead.
3222 (defun dired-replace-in-string (regexp newtext string)
3223 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3225 (let ((result "") (start 0) mb me)
3226 (while (string-match regexp string start)
3227 (setq mb (match-beginning 0)
3228 me (match-end 0)
3229 result (concat result (substring string start mb) newtext)
3230 start me))
3231 (concat result (substring string start))))
3233 (defun dired-sort-other (switches &optional no-revert)
3234 "Specify new `ls' SWITCHES for current dired buffer.
3235 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3236 set the minor mode accordingly, others appear literally in the mode line.
3237 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3238 (dired-sort-R-check switches)
3239 (setq dired-actual-switches switches)
3240 (dired-sort-set-modeline)
3241 (or no-revert (revert-buffer)))
3243 (defvar dired-subdir-alist-pre-R nil
3244 "Value of `dired-subdir-alist' before -R switch added.")
3245 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3247 (defun dired-sort-R-check (switches)
3248 "Additional processing of -R in ls option string SWITCHES.
3249 Saves `dired-subdir-alist' when R is set and restores saved value
3250 minus any directories explicitly deleted when R is cleared.
3251 To be called first in body of `dired-sort-other', etc."
3252 (cond
3253 ((and (string-match "R" switches)
3254 (not (string-match "R" dired-actual-switches)))
3255 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3256 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3257 ((and (string-match "R" dired-actual-switches)
3258 (not (string-match "R" switches)))
3259 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3260 ;; that are still present:
3261 (setq dired-subdir-alist
3262 (if dired-subdir-alist-pre-R
3263 (let (subdirs)
3264 (while dired-subdir-alist-pre-R
3265 (if (assoc (caar dired-subdir-alist-pre-R)
3266 dired-subdir-alist)
3267 ;; subdir still present...
3268 (setq subdirs
3269 (cons (car dired-subdir-alist-pre-R)
3270 subdirs)))
3271 (setq dired-subdir-alist-pre-R
3272 (cdr dired-subdir-alist-pre-R)))
3273 (reverse subdirs))
3274 ;; No pre-R subdir alist, so revert to main directory
3275 ;; listing:
3276 (list (car (reverse dired-subdir-alist))))))))
3277 \f
3279 ;;;; Drag and drop support
3281 (defcustom dired-recursive-copies 'top
3282 "*Decide whether recursive copies are allowed.
3283 A value of nil means no recursive copies.
3284 `always' means copy recursively without asking.
3285 `top' means ask for each directory at top level.
3286 Anything else means ask for each directory."
3287 :type '(choice :tag "Copy directories"
3288 (const :tag "No recursive copies" nil)
3289 (const :tag "Ask for each directory" t)
3290 (const :tag "Ask for each top directory only" top)
3291 (const :tag "Copy directories without asking" always))
3292 :group 'dired)
3294 (defun dired-dnd-popup-notice ()
3295 (message-box
3299 (defun dired-dnd-do-ask-action (uri)
3300 ;; No need to get actions and descriptions from the source,
3301 ;; we only have three actions anyway.
3302 (let ((action (x-popup-menu
3303 t
3304 (list "What action?"
3305 (cons ""
3306 '(("Copy here" . copy)
3307 ("Move here" . move)
3308 ("Link here" . link)
3309 "--"
3310 ("Cancel" . nil)))))))
3311 (if action
3312 (dired-dnd-handle-local-file uri action)
3313 nil)))
3315 (declare-function dired-relist-entry "dired-aux" (file))
3316 (declare-function make-symbolic-link "fileio.c")
3318 ;; Only used when (featurep 'dnd).
3319 (declare-function dnd-get-local-file-name "dnd" (uri &optional must-exist))
3320 (declare-function dnd-get-local-file-uri "dnd" (uri))
3322 (defun dired-dnd-handle-local-file (uri action)
3323 "Copy, move or link a file to the dired directory.
3324 URI is the file to handle, ACTION is one of copy, move, link or ask.
3325 Ask means pop up a menu for the user to select one of copy, move or link."
3326 (require 'dired-aux)
3327 (let* ((from (dnd-get-local-file-name uri t))
3328 (to (when from
3329 (concat (dired-current-directory)
3330 (file-name-nondirectory from)))))
3331 (when from
3332 (cond ((eq action 'ask)
3333 (dired-dnd-do-ask-action uri))
3334 ;; If copying a directory and dired-recursive-copies is
3335 ;; nil, dired-copy-file fails. Pop up a notice.
3336 ((and (memq action '(copy private))
3337 (file-directory-p from)
3338 (not dired-recursive-copies))
3339 (dired-dnd-popup-notice))
3340 ((memq action '(copy private move link))
3341 (let ((overwrite (and (file-exists-p to)
3342 (y-or-n-p
3343 (format "Overwrite existing file `%s'? " to))))
3344 ;; Binding dired-overwrite-confirmed to nil makes
3345 ;; dired-handle-overwrite a no-op. We instead use
3346 ;; y-or-n-p, which pops a graphical menu.
3347 dired-overwrite-confirmed backup-file)
3348 (when (and overwrite
3349 ;; d-b-o is defined in dired-aux.
3350 (boundp 'dired-backup-overwrite)
3351 dired-backup-overwrite
3352 (setq backup-file
3353 (car (find-backup-file-name to)))
3354 (or (eq dired-backup-overwrite 'always)
3355 (y-or-n-p
3356 (format
3357 "Make backup for existing file `%s'? " to))))
3358 (rename-file to backup-file 0)
3359 (dired-relist-entry backup-file))
3360 (cond ((memq action '(copy private))
3361 (dired-copy-file from to overwrite))
3362 ((eq action 'move)
3363 (dired-rename-file from to overwrite))
3364 ((eq action 'link)
3365 (make-symbolic-link from to overwrite)))
3366 (dired-relist-entry to)
3367 action))))))
3369 (defun dired-dnd-handle-file (uri action)
3370 "Copy, move or link a file to the dired directory if it is a local file.
3371 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3372 ACTION is one of copy, move, link or ask.
3373 Ask means pop up a menu for the user to select one of copy, move or link."
3374 (let ((local-file (dnd-get-local-file-uri uri)))
3375 (if local-file (dired-dnd-handle-local-file local-file action)
3376 nil)))
3377 \f
3379 ;;;; Desktop support
3381 (eval-when-compile (require 'desktop))
3383 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3384 "Auxiliary information to be saved in desktop file."
3385 (cons
3386 ;; Value of `dired-directory'.
3387 (if (consp dired-directory)
3388 ;; Directory name followed by list of files.
3389 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3390 (cdr dired-directory))
3391 ;; Directory name, optionally with shell wildcard.
3392 (desktop-file-name dired-directory desktop-dirname))
3393 ;; Subdirectories in `dired-subdir-alist'.
3394 (cdr
3395 (nreverse
3396 (mapcar
3397 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3398 dired-subdir-alist)))))
3400 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3401 desktop-buffer-name
3402 desktop-buffer-misc)
3403 "Restore a dired buffer specified in a desktop file."
3404 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3405 ;; This value is a directory name, optionally with shell wildcard or
3406 ;; a directory name followed by list of files.
3407 (let* ((dired-dir (car desktop-buffer-misc))
3408 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3409 (if (file-directory-p (file-name-directory dir))
3410 (progn
3411 (dired dired-dir)
3412 ;; The following elements of `desktop-buffer-misc' are the keys
3413 ;; from `dired-subdir-alist'.
3414 (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3415 (current-buffer))
3416 (message "Desktop: Directory %s no longer exists." dir)
3417 (when desktop-missing-file-warning (sit-for 1))
3418 nil)))
3420 (add-to-list 'desktop-buffer-mode-handlers
3421 '(dired-mode . dired-restore-desktop-buffer))
3423 \f
3424 (if (eq system-type 'vax-vms)
3425 (load "dired-vms"))
3427 (provide 'dired)
3429 (run-hooks 'dired-load-hook) ; for your customizations
3431 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3432 ;;; dired.el ends here