| blob | f23c109af1c0a66536e5c7d591837d834dcacafc |
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 ;; Dired marks.
387 ;;
388 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
389 ;; file name itself. We search for Dired defined regexps, and then use the
390 ;; Dired defined function `dired-move-to-filename' before searching for the
391 ;; simple regexp ".+". It is that regexp which matches the file name.
392 ;;
393 ;; Marked files.
396 ;;
397 ;; Flagged files.
400 ;; People who are paranoid about security would consider this more
401 ;; important than other things such as whether it is a directory.
402 ;; But we don't want to encourage paranoia, so our default
403 ;; should be what's most useful for non-paranoids. -- rms.
404 ;;; ;;
405 ;;; ;; Files that are group or world writable.
406 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
407 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
408 ;;; '(1 dired-warning-face)
409 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
410 ;; However, we don't need to highlight the file name, only the
411 ;; permissions, to win generally. -- fx.
412 ;; Fixme: we could also put text properties on the permission
413 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
420 ;;
421 ;; Subdirectories.
424 ;;
425 ;; Symbolic links.
428 ;;
429 ;; Files suffixed with `completion-ignored-extensions'.
431 ;; It is quicker to first find just an extension, then go back to the
432 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
435 ;;
436 ;; Files suffixed with `completion-ignored-extensions'
437 ;; plus a character put in by -F.
443 ;; If the last character is not part of the filename,
444 ;; move back to the start of the filename
445 ;; so it can be fontified.
446 ;; Otherwise, leave point at the end of the line;
447 ;; that way, nothing is fontified.
451 ;;
452 ;; Explicitly put the default face on file names ending in a colon to
453 ;; avoid fontifying them as directory header.
456 ;;
457 ;; Directory headers.
459 )
463 \f
464 ;;; Macros must be defined before they are used, for the byte compiler.
467 "Mark all files for which PREDICATE evals to non-nil.
468 PREDICATE is evaluated on each line, with point at beginning of line.
469 MSG is a noun phrase for the type of files being marked.
470 It should end with a noun that can be pluralized by adding `s'.
471 Return value is the number of files marked, or nil if none were marked."
485 count
486 ,msg
494 distinguish-one-marked)
495 "Eval BODY with point on each marked line. Return a list of BODY's results.
496 If no marked file could be found, execute BODY on the current line.
497 ARG, if non-nil, specifies the files to use instead of the marked files.
498 If ARG is an integer, use the next ARG (or previous -ARG, if
499 ARG<0) files. In that case, point is dragged along. This is
500 so that commands on the next ARG (instead of the marked) files
501 can be chained easily.
502 For any other non-nil value of ARG, use the current file.
503 If optional third arg SHOW-PROGRESS evaluates to non-nil,
504 redisplay the dired buffer after each file is processed.
505 No guarantee is made about the position on the marked line.
506 BODY must ensure this itself if it depends on this.
507 Search starts at the beginning of the buffer, thus the car of the list
508 corresponds to the line nearest to the buffer's bottom. This
509 is also true for (positive and negative) integer values of ARG.
510 BODY should not be too long as it is expanded four times.
512 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
513 return (t FILENAME) instead of (FILENAME)."
514 ;;
515 ;;Warning: BODY must not add new lines before point - this may cause an
516 ;;endless loop.
517 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
524 ,arg
530 results))
531 ;; non-nil, non-integer ARG means use current file:
536 ;; remember position of next marked file before BODY
537 ;; can insert lines before the just found file,
538 ;; confusing us by finding the same marked file again
539 ;; and again and...
547 ;; move after last match
556 results
558 ;; save-excursion loses, again
562 "Return the marked files' names as list of strings.
563 The list is in the same order as the buffer, that is, the car is the
564 first marked file.
565 Values returned are normally absolute file names.
566 Optional arg LOCALP as in `dired-get-filename'.
567 Optional second argument ARG, if non-nil, specifies files near
568 point instead of marked files. It usually comes from the prefix
569 argument.
570 If ARG is an integer, use the next ARG files.
571 Any other non-nil value means to use the current file instead.
572 Optional third argument FILTER, if non-nil, is a function to select
573 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
575 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
576 return (t FILENAME) instead of (FILENAME).
577 Don't use that together with FILTER."
582 arg nil distinguish-one-marked)))
583 result)
586 all-of-them
591 result)))
592 \f
593 ;; The dired command
596 ;; For use in interactive.
600 dired-listing-switches))
601 ;; If a dialog is about to be used, call read-directory-name so
602 ;; the dialog code knows we want directories. Some dialogs can
603 ;; only select directories or files when popped up, not both.
606 nil default-directory nil)
612 nil default-directory nil)))))))
614 ;; We want to switch to a more sophisticated version of
615 ;; dired-read-dir-and-switches like the following, if there is a way
616 ;; to make it more intuitive. See bug#1285.
618 ;; (defun dired-read-dir-and-switches (str)
619 ;; ;; For use in interactive.
620 ;; (reverse
621 ;; (list
622 ;; (if current-prefix-arg
623 ;; (read-string "Dired listing switches: "
624 ;; dired-listing-switches))
625 ;; ;; If a dialog is about to be used, call read-directory-name so
626 ;; ;; the dialog code knows we want directories. Some dialogs can
627 ;; ;; only select directories or files when popped up, not both.
628 ;; (if (next-read-file-uses-dialog-p)
629 ;; (read-directory-name (format "Dired %s(directory): " str)
630 ;; nil default-directory nil)
631 ;; (let ((cie ()))
632 ;; (dolist (ext completion-ignored-extensions)
633 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
634 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
635 ;; (lexical-let* ((default (and buffer-file-name
636 ;; (abbreviate-file-name buffer-file-name)))
637 ;; (cie cie)
638 ;; (completion-table
639 ;; ;; We need a mix of read-file-name and
640 ;; ;; read-directory-name so that completion to directories
641 ;; ;; is preferred, but if the user wants to enter a global
642 ;; ;; pattern, he can still use completion on filenames to
643 ;; ;; help him write the pattern.
644 ;; ;; Essentially, we want to use
645 ;; ;; (completion-table-with-predicate
646 ;; ;; 'read-file-name-internal 'file-directory-p nil)
647 ;; ;; but that doesn't work because read-file-name-internal
648 ;; ;; does not obey its `predicate' argument.
649 ;; (completion-table-in-turn
650 ;; (lambda (str pred action)
651 ;; (let ((read-file-name-predicate
652 ;; (lambda (f)
653 ;; (and (not (member f '("./" "../")))
654 ;; ;; Hack! Faster than file-directory-p!
655 ;; (eq (aref f (1- (length f))) ?/)
656 ;; (not (string-match cie f))))))
657 ;; (complete-with-action
658 ;; action 'read-file-name-internal str nil)))
659 ;; 'read-file-name-internal)))
660 ;; (minibuffer-with-setup-hook
661 ;; (lambda ()
662 ;; (setq minibuffer-default default)
663 ;; (setq minibuffer-completion-table completion-table))
664 ;; (read-file-name (format "Dired %s(directory): " str)
665 ;; nil default-directory nil))))))))
667 ;;;###autoload (define-key ctl-x-map "d" 'dired)
668 ;;;###autoload
671 Optional second argument SWITCHES specifies the `ls' options used.
672 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
673 Dired displays a list of files in DIRNAME (which may also have
674 shell wildcards appended to select certain files). If DIRNAME is a cons,
675 its first element is taken as the directory name and the rest as an explicit
676 list of files to make directory entries for.
678 You can move around in it with the usual commands.
683 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
684 ;; Cannot use (interactive "D") because of wildcards.
688 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
689 ;;;###autoload
695 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
696 ;;;###autoload
702 ;;;###autoload
704 "Like `dired' but returns the dired buffer as value, does not select it."
706 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
707 ;; some shells make:
718 ;; If the argument was syntactically a directory name not a file name,
719 ;; or if it happens to name a file that is a directory,
720 ;; convert it syntactically to a directory name.
721 ;; The reason for checking initially-was-dirname
722 ;; and not just file-directory-p
723 ;; is that file-directory-p is slow over ftp.
731 ;; The following is an internal dired function. It returns non-nil if
732 ;; the directory visited by the current dired buffer has changed on
733 ;; disk. DIRNAME should be the directory name of that directory.
742 "Return non-nil if current dired buffer needs updating.
743 If NOCONFIRM is non-nil, then this function always returns nil
744 for a remote directory. This feature is used by Auto Revert Mode."
750 ;; Do not auto-revert when the dired buffer can be currently
751 ;; written by the user as in `wdired-mode'.
752 buffer-read-only
756 ;; If there is an existing dired buffer for DIRNAME, just leave
757 ;; buffer as it is (don't even call dired-revert).
758 ;; This saves time especially for deep trees or with ange-ftp.
759 ;; The user can type `g' easily, and it is more consistent with find-file.
760 ;; But if SWITCHES are given they are probably different from the
761 ;; buffer's old value, so call dired-sort-other, which does
762 ;; revert the buffer.
763 ;; A pity we can't possibly do "Directory has changed - refresh? "
764 ;; like find-file does.
765 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
766 ;; see there.
768 buffer
769 ;; note that buffer already is in dired-mode, if found
770 new-buffer-p
775 ;; Look for an existing buffer.
780 ;; We don't want default-major-mode to run hooks and set auto-fill
781 ;; or whatever, now that dired-mode does not
782 ;; kill-all-local-variables any longer.
787 ;; file list may have changed
789 ;; this calls dired-revert
791 ;; If directory has changed on disk, offer to revert.
796 ;; Else a new buffer
798 ;; We can do this unconditionally
799 ;; because dired-noselect ensures that the name
800 ;; is passed in directory name syntax
801 ;; if it was the name of a directory at all.
806 ;; default-directory and dired-actual-switches are set now
807 ;; (buffer-local), so we can call dired-readin:
812 ;; dired-readin can fail if parent directories are inaccessible.
813 ;; Don't leave an empty buffer around in that case.
818 buffer))
821 ;; Enlarged by dired-advertise
822 ;; Queried by function dired-buffers-for-dir. When this detects a
823 ;; killed buffer, it is removed from this list.
827 ;; This differs from dired-buffers-for-dir in that it does not consider
828 ;; subdirs of default-directory and searches for the first match only.
829 ;; Also, the major mode must be MODE.
839 dired-directory ;; nil during find-alternate-file
844 dired-directory))))
846 blist nil)
848 found))
850 \f
851 ;; Read in a new dired buffer
854 "Read in a new dired buffer.
855 Differs from `dired-insert-subdir' in that it accepts
856 wildcards, erases the buffer, and builds the subdir-alist anew
857 \(including making it buffer-local and clearing it first)."
859 ;; default-directory and dired-actual-switches must be buffer-local
860 ;; and initialized by now.
862 ;; This makes readin much much faster.
863 ;; In particular, it prevents the font lock hook from running
864 ;; until the directory is all read in.
871 ;; This hook which may want to modify dired-actual-switches
872 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
873 ;; where ls won't understand -Al switches.
881 ;; Don't make undo entries for readin.
887 ;; Must first make alist buffer local and set it to nil because
888 ;; dired-build-subdir-alist will call dired-clear-alist first
895 ;; No need to narrow since the whole buffer contains just
896 ;; dired-readin's output, nothing else. The hook can
897 ;; successfully use dired functions (e.g. dired-get-filename)
898 ;; as the subdir-alist has been built in dired-readin.
901 ;; Subroutines of dired-readin
904 ;; Insert listing for the specified dir (and maybe file list)
905 ;; already in dired-directory, assuming a clean buffer.
911 file-list nil))
915 ;; If we are reading a whole single directory...
920 ;; Else treat it as a wildcard spec
921 ;; unless we have an explicit list of files.
926 "Align the fields of a file to the ones of surrounding lines.
927 BEG..END is the line where the file info is located."
928 ;; Some versions of ls try to adjust the size of each field so as to just
929 ;; hold the largest element ("largest" in the current invocation, of
930 ;; course). So when a single line is output, the size of each field is
931 ;; just big enough for that one output. Thus when dired refreshes one
932 ;; line, the alignment if this line w.r.t the rest is messed up because
933 ;; the fields of that one line will generally be smaller.
934 ;;
935 ;; To work around this problem, we here add spaces to try and
936 ;; re-align the fields as needed. Since this is purely aesthetic,
937 ;; it is of utmost importance that it doesn't mess up anything like
938 ;; `dired-move-to-filename'. To this end, we limit ourselves to
939 ;; adding spaces only, and to only add them at places where there
940 ;; was already at least one space. This way, as long as
941 ;; `directory-listing-before-filename-regexp' always matches spaces
942 ;; with "*" or "+", we know we haven't made anything worse. There
943 ;; is one spot where the exact number of spaces is important, which
944 ;; is just before the actual filename, so we refrain from adding
945 ;; spaces there (and within the filename as well, of course).
948 ;; Check the there is indeed a file, and that there is anoter adjacent
949 ;; file with which to align, and that additional spaces are needed to
950 ;; align the filenames.
963 ;; Make sure there is some work left to do.
965 ;; If we've only looked at the line above, check to see if the line
966 ;; below exists as well and if so, align with the shorter one.
975 ;; Keep positions uptodate when we insert stuff.
978 ;; Main loop.
982 ;; Don't touch anything just before (and after) the
983 ;; beginning of the filename.
985 ;; We're now just in front of a field, with a space behind us.
987 ;; Nums are right-aligned.
989 ;; Let's look at the other line, in the same column: we
990 ;; should be either near the end of the previous field, or
991 ;; in the space between that field and the next.
992 ;; [ Of course, it's also possible that we're already within
993 ;; the next field or even past it, but that's unlikely since
994 ;; other-col > file-col. ]
995 ;; Let's find the distance to the alignment-point (either
996 ;; the beginning or the end of the next field, depending on
997 ;; whether this field is left or right aligned).
1007 ;; Now, the number of spaces to insert is align-pt-offset
1008 ;; minus the distance to the equivalent point on the
1009 ;; current line.
1012 align-pt-offset
1022 ;; Let's just make really sure we did not mess up.
1025 ;; Damn! We messed up: let's revert the change.
1027 ;; Now skip to next field.
1033 "Insert a directory listing of DIR, Dired style.
1034 Use SWITCHES to make the listings.
1035 If FILE-LIST is non-nil, list only those files.
1036 Otherwise, if WILDCARD is non-nil, expand wildcards;
1037 in that case, DIR should be a file name that uses wildcards.
1038 In other cases, DIR should be a directory name or a directory filename.
1039 If HDR is non-nil, insert a header line with the directory name."
1042 end)
1045 ;; We used to specify the C locale here, to force English month names;
1046 ;; but this should not be necessary any more,
1047 ;; with the new value of `directory-listing-before-filename-regexp'.
1052 ;; Re-align fields, if necessary.
1055 ;; Quote certain characters, unless ls quoted them for us.
1064 nil t))
1070 nil t))
1073 ;; If we used --dired and it worked, the lines are already indented.
1074 ;; Otherwise, indent them.
1080 ;; Insert text at the beginning to standardize things.
1086 ;; Note that dired-build-subdir-alist will replace the name
1087 ;; by its expansion, so it does not matter whether what we insert
1088 ;; here is fully expanded, but it should be absolute.
1091 ;; Insert "wildcard" line where "total" line would be for a full dir.
1095 "Make the file names highlight when the mouse is on them."
1107 dired-filename t
1111 \f
1112 ;; Reverting a dired buffer
1115 "Reread the dired buffer.
1116 Must also be called after `dired-actual-switches' have changed.
1117 Should not fail even on completely garbaged buffers.
1118 Preserves old cursor, marks/flags, hidden-p."
1131 ;; treat top level dir extra (it may contain wildcards)
1134 ;; Run dired-after-readin-hook just once, below.
1139 ;; ... run the hook for the whole buffer, and only after markers
1140 ;; have been reinserted (else omitting in dired-x would omit marked files)
1150 ;; outside of the let scope
1151 ;;; Might as well not override the user if the user changed this.
1152 ;;; (setq buffer-read-only t)
1153 )
1155 ;; Subroutines of dired-revert
1156 ;; Some of these are also used when inserting subdirs.
1159 "Return alist of files and their marks, from BEG to END."
1170 alist))
1173 "Mark all files remembered in ALIST.
1174 Each element of ALIST looks like (FILE . MARKERCHAR)."
1188 "Return a list of names of subdirs currently hidden."
1198 result))
1201 "Try to insert all subdirs that were displayed before.
1202 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1216 "Remove directory DIR from any directory cache."
1220 \f
1221 ;; dired mode key bindings and initialization
1224 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1225 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1230 ;; Commands to mark or flag certain categories of files
1234 ;; Upper case keys (except !) for operating on the marked files
1253 ;; Comparison commands
1256 ;; Tree Dired commands
1262 ;; move to marked files
1265 ;; Make all regexp commands share a `%' prefix:
1266 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1267 ;; but that seems to serve little purpose, and copy-keymap
1268 ;; does a better job without it.
1281 ;; Commands for marking and unmarking.
1298 ;; Lower keys for commands not operating on all the marked files
1324 ;; moving
1332 (define-key map [up] 'dired-previous-line)
1333 ;; hiding
1334 (define-key map "$" 'dired-hide-subdir)
1335 (define-key map "\M-$" 'dired-hide-all)
1336 ;; isearch
1337 (define-key map (kbd "M-s a C-s") 'dired-do-isearch)
1338 (define-key map (kbd "M-s a M-C-s") 'dired-do-isearch-regexp)
1339 (define-key map (kbd "M-s f C-s") 'dired-isearch-filenames)
1340 (define-key map (kbd "M-s f M-C-s") 'dired-isearch-filenames-regexp)
1341 ;; misc
1342 (define-key map "\C-x\C-q" 'dired-toggle-read-only)
1343 (define-key map "?" 'dired-summary)
1345 (define-key map [remap undo] 'dired-undo)
1346 (define-key map [remap advertised-undo] 'dired-undo)
1347 ;; thumbnail manipulation (image-dired)
1348 (define-key map "\C-td" 'image-dired-display-thumbs)
1349 (define-key map "\C-tt" 'image-dired-tag-files)
1350 (define-key map "\C-tr" 'image-dired-delete-tag)
1351 (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1352 (define-key map "\C-ti" 'image-dired-dired-display-image)
1353 (define-key map "\C-tx" 'image-dired-dired-display-external)
1354 (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1355 (define-key map "\C-t." 'image-dired-display-thumb)
1356 (define-key map "\C-tc" 'image-dired-dired-comment-files)
1357 (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1358 (define-key map "\C-t\C-t" 'image-dired-dired-insert-marked-thumbs)
1359 (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1360 ;; encryption and decryption (epa-dired)
1361 (define-key map ":d" 'epa-dired-do-decrypt)
1362 (define-key map ":v" 'epa-dired-do-verify)
1363 (define-key map ":s" 'epa-dired-do-sign)
1364 (define-key map ":e" 'epa-dired-do-encrypt)
1366 ;; Make menu bar items.
1368 ;; No need to fo this, now that top-level items are fewer.
1369 ;;;;
1370 ;; Get rid of the Edit menu bar item to save space.
1371 ;(define-key map [menu-bar edit] 'undefined)
1373 (define-key map [menu-bar subdir]
1374 (cons "Subdir" (make-sparse-keymap "Subdir")))
1376 (define-key map [menu-bar subdir hide-all]
1377 '(menu-item "Hide All" dired-hide-all
1378 :help "Hide all subdirectories, leave only header lines"))
1379 (define-key map [menu-bar subdir hide-subdir]
1380 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1381 :help "Hide or unhide current directory listing"))
1382 (define-key map [menu-bar subdir tree-down]
1383 '(menu-item "Tree Down" dired-tree-down
1384 :help "Go to first subdirectory header down the tree"))
1385 (define-key map [menu-bar subdir tree-up]
1386 '(menu-item "Tree Up" dired-tree-up
1387 :help "Go to first subdirectory header up the tree"))
1388 (define-key map [menu-bar subdir up]
1389 '(menu-item "Up Directory" dired-up-directory
1390 :help "Edit the parent directory"))
1391 (define-key map [menu-bar subdir prev-subdir]
1392 '(menu-item "Prev Subdir" dired-prev-subdir
1393 :help "Go to previous subdirectory header line"))
1394 (define-key map [menu-bar subdir next-subdir]
1395 '(menu-item "Next Subdir" dired-next-subdir
1396 :help "Go to next subdirectory header line"))
1397 (define-key map [menu-bar subdir prev-dirline]
1398 '(menu-item "Prev Dirline" dired-prev-dirline
1399 :help "Move to next directory-file line"))
1400 (define-key map [menu-bar subdir next-dirline]
1401 '(menu-item "Next Dirline" dired-next-dirline
1402 :help "Move to previous directory-file line"))
1403 (define-key map [menu-bar subdir insert]
1404 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1405 :help "Insert contents of subdirectory"))
1407 (define-key map [menu-bar immediate]
1408 (cons "Immediate" (make-sparse-keymap "Immediate")))
1410 (define-key map
1411 [menu-bar immediate epa-dired-do-decrypt]
1412 '(menu-item "Decrypt" epa-dired-do-decrypt
1413 :help "Decrypt file at cursor"))
1415 (define-key map
1416 [menu-bar immediate epa-dired-do-verify]
1417 '(menu-item "Verify" epa-dired-do-verify
1418 :help "Verify digital signature of file at cursor"))
1420 (define-key map
1421 [menu-bar immediate epa-dired-do-sign]
1422 '(menu-item "Sign" epa-dired-do-sign
1423 :help "Create digital signature of file at cursor"))
1425 (define-key map
1426 [menu-bar immediate epa-dired-do-encrypt]
1427 '(menu-item "Encrypt" epa-dired-do-encrypt
1428 :help "Encrypt file at cursor"))
1430 (define-key map [menu-bar immediate dashes-4]
1431 '("--"))
1433 (define-key map
1434 [menu-bar immediate image-dired-dired-display-external]
1435 '(menu-item "Display Image Externally" image-dired-dired-display-external
1436 :help "Display image in external viewer"))
1437 (define-key map
1438 [menu-bar immediate image-dired-dired-display-image]
1439 '(menu-item "Display Image" image-dired-dired-display-image
1440 :help "Display sized image in a separate window"))
1442 (define-key map [menu-bar immediate dashes-4]
1443 '("--"))
1445 (define-key map [menu-bar immediate revert-buffer]
1446 '(menu-item "Refresh" revert-buffer
1447 :help "Update contents of shown directories"))
1449 (define-key map [menu-bar immediate dashes]
1450 '("--"))
1452 (define-key map [menu-bar immediate isearch-filenames-regexp]
1453 '(menu-item "Isearch Regexp in File Names..." dired-isearch-filenames-regexp
1454 :help "Incrementally search for regexp in file names only"))
1455 (define-key map [menu-bar immediate isearch-filenames]
1456 '(menu-item "Isearch in File Names..." dired-isearch-filenames
1457 :help "Incrementally search for string in file names only."))
1458 (define-key map [menu-bar immediate compare-directories]
1459 '(menu-item "Compare Directories..." dired-compare-directories
1460 :help "Mark files with different attributes in two dired buffers"))
1461 (define-key map [menu-bar immediate backup-diff]
1462 '(menu-item "Compare with Backup" dired-backup-diff
1463 :help "Diff file at cursor with its latest backup"))
1464 (define-key map [menu-bar immediate diff]
1465 '(menu-item "Diff..." dired-diff
1466 :help "Compare file at cursor with another file"))
1467 (define-key map [menu-bar immediate view]
1468 '(menu-item "View This File" dired-view-file
1469 :help "Examine file at cursor in read-only mode"))
1470 (define-key map [menu-bar immediate display]
1471 '(menu-item "Display in Other Window" dired-display-file
1472 :help "Display file at cursor in other window"))
1473 (define-key map [menu-bar immediate find-file-other-window]
1474 '(menu-item "Find in Other Window" dired-find-file-other-window
1475 :help "Edit file at cursor in other window"))
1476 (define-key map [menu-bar immediate find-file]
1477 '(menu-item "Find This File" dired-find-file
1478 :help "Edit file at cursor"))
1479 (define-key map [menu-bar immediate create-directory]
1480 '(menu-item "Create Directory..." dired-create-directory
1481 :help "Create a directory"))
1482 (define-key map [menu-bar immediate wdired-mode]
1483 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1484 :help "Put a dired buffer in a mode in which filenames are editable"
1485 :keys "C-x C-q"
1486 :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1488 (define-key map [menu-bar regexp]
1489 (cons "Regexp" (make-sparse-keymap "Regexp")))
1491 (define-key map
1492 [menu-bar regexp image-dired-mark-tagged-files]
1493 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1494 :help "Mark files whose image tags matches regexp"))
1496 (define-key map [menu-bar regexp dashes-1]
1497 '("--"))
1499 (define-key map [menu-bar regexp downcase]
1500 '(menu-item "Downcase" dired-downcase
1501 ;; When running on plain MS-DOS, there's only one
1502 ;; letter-case for file names.
1503 :enable (or (not (fboundp 'msdos-long-file-names))
1504 (msdos-long-file-names))
1505 :help "Rename marked files to lower-case name"))
1506 (define-key map [menu-bar regexp upcase]
1507 '(menu-item "Upcase" dired-upcase
1508 :enable (or (not (fboundp 'msdos-long-file-names))
1509 (msdos-long-file-names))
1510 :help "Rename marked files to upper-case name"))
1511 (define-key map [menu-bar regexp hardlink]
1512 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1513 :help "Make hard links for files matching regexp"))
1514 (define-key map [menu-bar regexp symlink]
1515 '(menu-item "Symlink..." dired-do-symlink-regexp
1516 :visible (fboundp 'make-symbolic-link)
1517 :help "Make symbolic links for files matching regexp"))
1518 (define-key map [menu-bar regexp rename]
1519 '(menu-item "Rename..." dired-do-rename-regexp
1520 :help "Rename marked files matching regexp"))
1521 (define-key map [menu-bar regexp copy]
1522 '(menu-item "Copy..." dired-do-copy-regexp
1523 :help "Copy marked files matching regexp"))
1524 (define-key map [menu-bar regexp flag]
1525 '(menu-item "Flag..." dired-flag-files-regexp
1526 :help "Flag files matching regexp for deletion"))
1527 (define-key map [menu-bar regexp mark]
1528 '(menu-item "Mark..." dired-mark-files-regexp
1529 :help "Mark files matching regexp for future operations"))
1530 (define-key map [menu-bar regexp mark-cont]
1531 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1532 :help "Mark files whose contents matches regexp"))
1534 (define-key map [menu-bar mark]
1535 (cons "Mark" (make-sparse-keymap "Mark")))
1537 (define-key map [menu-bar mark prev]
1538 '(menu-item "Previous Marked" dired-prev-marked-file
1539 :help "Move to previous marked file"))
1540 (define-key map [menu-bar mark next]
1541 '(menu-item "Next Marked" dired-next-marked-file
1542 :help "Move to next marked file"))
1543 (define-key map [menu-bar mark marks]
1544 '(menu-item "Change Marks..." dired-change-marks
1545 :help "Replace marker with another character"))
1546 (define-key map [menu-bar mark unmark-all]
1547 '(menu-item "Unmark All" dired-unmark-all-marks))
1548 (define-key map [menu-bar mark symlinks]
1549 '(menu-item "Mark Symlinks" dired-mark-symlinks
1550 :visible (fboundp 'make-symbolic-link)
1551 :help "Mark all symbolic links"))
1552 (define-key map [menu-bar mark directories]
1553 '(menu-item "Mark Directories" dired-mark-directories
1554 :help "Mark all directories except `.' and `..'"))
1555 (define-key map [menu-bar mark directory]
1556 '(menu-item "Mark Old Backups" dired-clean-directory
1557 :help "Flag old numbered backups for deletion"))
1558 (define-key map [menu-bar mark executables]
1559 '(menu-item "Mark Executables" dired-mark-executables
1560 :help "Mark all executable files"))
1561 (define-key map [menu-bar mark garbage-files]
1562 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1563 :help "Flag unneeded files for deletion"))
1564 (define-key map [menu-bar mark backup-files]
1565 '(menu-item "Flag Backup Files" dired-flag-backup-files
1566 :help "Flag all backup files for deletion"))
1567 (define-key map [menu-bar mark auto-save-files]
1568 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1569 :help "Flag auto-save files for deletion"))
1570 (define-key map [menu-bar mark deletion]
1571 '(menu-item "Flag" dired-flag-file-deletion
1572 :help "Flag current line's file for deletion"))
1573 (define-key map [menu-bar mark unmark]
1574 '(menu-item "Unmark" dired-unmark
1575 :help "Unmark or unflag current line's file"))
1576 (define-key map [menu-bar mark mark]
1577 '(menu-item "Mark" dired-mark
1578 :help "Mark current line's file for future operations"))
1579 (define-key map [menu-bar mark toggle-marks]
1580 '(menu-item "Toggle Marks" dired-toggle-marks
1581 :help "Mark unmarked files, unmark marked ones"))
1583 (define-key map [menu-bar operate]
1584 (cons "Operate" (make-sparse-keymap "Operate")))
1586 (define-key map
1587 [menu-bar operate image-dired-delete-tag]
1588 '(menu-item "Delete Image Tag..." image-dired-delete-tag
1589 :help "Delete image tag from current or marked files"))
1590 (define-key map
1591 [menu-bar operate image-dired-tag-files]
1592 '(menu-item "Add Image Tags..." image-dired-tag-files
1593 :help "Add image tags to current or marked files"))
1594 (define-key map
1595 [menu-bar operate image-dired-dired-comment-files]
1596 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1597 :help "Add image comment to current or marked files"))
1598 (define-key map
1599 [menu-bar operate image-dired-display-thumbs]
1600 '(menu-item "Display image thumbnails" image-dired-display-thumbs
1601 :help "Display image thumbnails for current or marked image files"))
1603 (define-key map [menu-bar operate dashes-3]
1604 '("--"))
1606 (define-key map [menu-bar operate query-replace]
1607 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1608 :help "Replace regexp in marked files"))
1609 (define-key map [menu-bar operate search]
1610 '(menu-item "Search Files..." dired-do-search
1611 :help "Search marked files for regexp"))
1612 (define-key map [menu-bar operate isearch-regexp]
1613 '(menu-item "Isearch Regexp Files..." dired-do-isearch-regexp
1614 :help "Incrementally search marked files for regexp"))
1615 (define-key map [menu-bar operate isearch]
1616 '(menu-item "Isearch Files..." dired-do-isearch
1617 :help "Incrementally search marked files for string"))
1618 (define-key map [menu-bar operate chown]
1619 '(menu-item "Change Owner..." dired-do-chown
1620 :visible (not (memq system-type '(ms-dos windows-nt)))
1621 :help "Change the owner of marked files"))
1622 (define-key map [menu-bar operate chgrp]
1623 '(menu-item "Change Group..." dired-do-chgrp
1624 :visible (not (memq system-type '(ms-dos windows-nt)))
1625 :help "Change the group of marked files"))
1626 (define-key map [menu-bar operate chmod]
1627 '(menu-item "Change Mode..." dired-do-chmod
1628 :help "Change mode (attributes) of marked files"))
1629 (define-key map [menu-bar operate touch]
1630 '(menu-item "Change Timestamp..." dired-do-touch
1631 :help "Change timestamp of marked files"))
1632 (define-key map [menu-bar operate load]
1633 '(menu-item "Load" dired-do-load
1634 :help "Load marked Emacs Lisp files"))
1635 (define-key map [menu-bar operate compile]
1636 '(menu-item "Byte-compile" dired-do-byte-compile
1637 :help "Byte-compile marked Emacs Lisp files"))
1638 (define-key map [menu-bar operate compress]
1639 '(menu-item "Compress" dired-do-compress
1640 :help "Compress/uncompress marked files"))
1641 (define-key map [menu-bar operate print]
1642 '(menu-item "Print..." dired-do-print
1643 :help "Ask for print command and print marked files"))
1644 (define-key map [menu-bar operate hardlink]
1645 '(menu-item "Hardlink to..." dired-do-hardlink
1646 :help "Make hard links for current or marked files"))
1647 (define-key map [menu-bar operate symlink]
1648 '(menu-item "Symlink to..." dired-do-symlink
1649 :visible (fboundp 'make-symbolic-link)
1650 :help "Make symbolic links for current or marked files"))
1651 (define-key map [menu-bar operate command]
1652 '(menu-item "Shell Command..." dired-do-shell-command
1653 :help "Run a shell command on each of marked files"))
1654 (define-key map [menu-bar operate delete]
1655 '(menu-item "Delete" dired-do-delete
1656 :help "Delete current file or all marked files"))
1657 (define-key map [menu-bar operate rename]
1658 '(menu-item "Rename to..." dired-do-rename
1659 :help "Rename current file or move marked files"))
1660 (define-key map [menu-bar operate copy]
1661 '(menu-item "Copy to..." dired-do-copy
1662 :help "Copy current file or all marked files"))
1664 map)
1665 "Local keymap for `dired-mode' buffers.")
1666 \f
1667 ;; Dired mode is suitable only for specially formatted data.
1668 (put 'dired-mode 'mode-class 'special)
1670 ;; Autoload cookie needed by desktop.el
1671 ;;;###autoload
1672 (defun dired-mode (&optional dirname switches)
1673 "\
1676 \(optionally) its subdirectories, in the format of `ls -lR'.
1679 compress, load or byte-compile them, change their file attributes
1682 by file or all files matching certain criteria.
1684 Letters no longer insert themselves. Digits are prefix arguments.
1687 Most commands operate on the marked files and use the current file
1688 if no files are marked. Use a numeric prefix argument to operate on
1689 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1690 to operate on the current file only. Prefix arguments override marks.
1692 to see why something went wrong.
1697 (or dired it in another buffer, if it is a directory).
1704 This retains all marks and hides subdirs again that were hidden before.
1705 SPC and DEL can be used to move down and up by lines.
1708 to read the
1710 to relist a single or the marked files or a
1712 again for the directory tree.
1715 for more info):
1717 `dired-listing-switches'
1718 `dired-trivial-filenames'
1719 `dired-shrink-to-fit'
1720 `dired-marker-char'
1721 `dired-del-marker'
1722 `dired-keep-marker-rename'
1723 `dired-keep-marker-copy'
1724 `dired-keep-marker-hardlink'
1725 `dired-keep-marker-symlink'
1729 `dired-before-readin-hook'
1730 `dired-after-readin-hook'
1731 `dired-mode-hook'
1732 `dired-load-hook'
1734 Keybindings:
1736 ;; Not to be called interactively (e.g. dired-directory will be set
1737 ;; to default-directory, which is wrong with wildcards).
1738 (kill-all-local-variables)
1739 (use-local-map dired-mode-map)
1740 (dired-advertise) ; default-directory is already set
1741 (setq major-mode 'dired-mode
1742 mode-name "Dired"
1743 ;; case-fold-search nil
1744 buffer-read-only t
1745 selective-display t ; for subdirectory hiding
1746 mode-line-buffer-identification
1747 (propertized-buffer-identification "%17b"))
1748 (set (make-local-variable 'revert-buffer-function)
1749 (function dired-revert))
1750 (set (make-local-variable 'buffer-stale-function)
1751 (function dired-buffer-stale-p))
1752 (set (make-local-variable 'page-delimiter)
1754 (set (make-local-variable 'dired-directory)
1755 (or dirname default-directory))
1756 ;; list-buffers uses this to display the dir being edited in this buffer.
1757 (set (make-local-variable 'list-buffers-directory)
1758 (expand-file-name (if (listp dired-directory)
1759 (car dired-directory)
1760 dired-directory)))
1761 (set (make-local-variable 'dired-actual-switches)
1762 (or switches dired-listing-switches))
1763 (set (make-local-variable 'font-lock-defaults)
1764 '(dired-font-lock-keywords t nil nil beginning-of-line))
1765 (set (make-local-variable 'desktop-save-buffer)
1766 'dired-desktop-buffer-misc-data)
1767 (setq dired-switches-alist nil)
1768 (dired-sort-other dired-actual-switches t)
1769 (when (featurep 'dnd)
1770 (set (make-local-variable 'dnd-protocol-alist)
1771 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1772 (add-hook 'isearch-mode-hook 'dired-isearch-filenames-setup nil t)
1773 (run-mode-hooks 'dired-mode-hook))
1774 \f
1775 ;; Idiosyncratic dired commands that don't deal with marks.
1777 (defun dired-summary ()
1778 "Summarize basic Dired commands and show recent dired errors."
1779 (interactive)
1780 (dired-why)
1781 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1782 (message
1783 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1785 (defun dired-undo ()
1786 "Undo in a dired buffer.
1787 This doesn't recover lost files, it just undoes changes in the buffer itself.
1788 You can use it to recover marks, killed lines or subdirs."
1789 (interactive)
1790 (let ((inhibit-read-only t))
1791 (undo))
1792 (dired-build-subdir-alist)
1793 (message "Change in dired buffer undone.
1794 Actual changes in files cannot be undone by Emacs."))
1796 (defun dired-toggle-read-only ()
1797 "Edit dired buffer with Wdired, or set it read-only.
1798 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1799 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1800 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1801 (interactive)
1802 (if (eq major-mode 'dired-mode)
1803 (wdired-change-to-wdired-mode)
1804 (toggle-read-only)))
1806 (defun dired-next-line (arg)
1807 "Move down lines then position at filename.
1808 Optional prefix ARG says how many lines to move; default is one line."
1809 (interactive "p")
1810 (forward-line arg)
1811 (dired-move-to-filename))
1813 (defun dired-previous-line (arg)
1814 "Move up lines then position at filename.
1815 Optional prefix ARG says how many lines to move; default is one line."
1816 (interactive "p")
1817 (forward-line (- arg))
1818 (dired-move-to-filename))
1820 (defun dired-next-dirline (arg &optional opoint)
1821 "Goto ARG'th next directory file line."
1822 (interactive "p")
1823 (or opoint (setq opoint (point)))
1824 (if (if (> arg 0)
1825 (re-search-forward dired-re-dir nil t arg)
1826 (beginning-of-line)
1827 (re-search-backward dired-re-dir nil t (- arg)))
1828 (dired-move-to-filename) ; user may type `i' or `f'
1829 (goto-char opoint)
1830 (error "No more subdirectories")))
1832 (defun dired-prev-dirline (arg)
1833 "Goto ARG'th previous directory file line."
1834 (interactive "p")
1835 (dired-next-dirline (- arg)))
1837 (defun dired-up-directory (&optional other-window)
1838 "Run Dired on parent directory of current directory.
1839 Find the parent directory either in this buffer or another buffer.
1840 Creates a buffer if necessary."
1841 (interactive "P")
1842 (let* ((dir (dired-current-directory))
1843 (up (file-name-directory (directory-file-name dir))))
1844 (or (dired-goto-file (directory-file-name dir))
1845 ;; Only try dired-goto-subdir if buffer has more than one dir.
1846 (and (cdr dired-subdir-alist)
1847 (dired-goto-subdir up))
1848 (progn
1849 (if other-window
1850 (dired-other-window up)
1851 (dired up))
1852 (dired-goto-file dir)))))
1854 (defun dired-get-file-for-visit ()
1855 "Get the current line's file name, with an error if file does not exist."
1856 (interactive)
1857 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1858 (let ((raw (dired-get-filename nil t))
1859 file-name)
1860 (if (null raw)
1861 (error "No file on this line"))
1862 (setq file-name (file-name-sans-versions raw t))
1863 (if (file-exists-p file-name)
1864 file-name
1865 (if (file-symlink-p file-name)
1866 (error "File is a symlink to a nonexistent target")
1867 (error "File no longer exists; type `g' to update dired buffer")))))
1869 ;; Force `f' rather than `e' in the mode doc:
1870 (defalias 'dired-advertised-find-file 'dired-find-file)
1871 (defun dired-find-file ()
1872 "In Dired, visit the file or directory named on this line."
1873 (interactive)
1874 ;; Bind `find-file-run-dired' so that the command works on directories
1875 ;; too, independent of the user's setting.
1876 (let ((find-file-run-dired t))
1877 (find-file (dired-get-file-for-visit))))
1879 (defun dired-find-alternate-file ()
1880 "In Dired, visit this file or directory instead of the dired buffer."
1881 (interactive)
1882 (set-buffer-modified-p nil)
1883 (find-alternate-file (dired-get-file-for-visit)))
1884 ;; Don't override the setting from .emacs.
1885 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1887 (defun dired-mouse-find-file-other-window (event)
1888 "In Dired, visit the file or directory name you click on."
1889 (interactive "e")
1890 (let (window pos file)
1891 (save-excursion
1892 (setq window (posn-window (event-end event))
1893 pos (posn-point (event-end event)))
1894 (if (not (windowp window))
1895 (error "No file chosen"))
1896 (set-buffer (window-buffer window))
1897 (goto-char pos)
1898 (setq file (dired-get-file-for-visit)))
1899 (if (file-directory-p file)
1900 (or (and (cdr dired-subdir-alist)
1901 (dired-goto-subdir file))
1902 (progn
1903 (select-window window)
1904 (dired-other-window file)))
1905 (select-window window)
1906 (find-file-other-window (file-name-sans-versions file t)))))
1908 (defun dired-view-file ()
1909 "In Dired, examine a file in view mode, returning to Dired when done.
1910 When file is a directory, show it in this buffer if it is inserted.
1911 Otherwise, display it in another buffer."
1912 (interactive)
1913 (let ((file (dired-get-file-for-visit)))
1914 (if (file-directory-p file)
1915 (or (and (cdr dired-subdir-alist)
1916 (dired-goto-subdir file))
1917 (dired file))
1918 (view-file file))))
1920 (defun dired-find-file-other-window ()
1921 "In Dired, visit this file or directory in another window."
1922 (interactive)
1923 (find-file-other-window (dired-get-file-for-visit)))
1925 (defun dired-display-file ()
1926 "In Dired, display this file or directory in another window."
1927 (interactive)
1928 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1929 \f
1930 ;;; Functions for extracting and manipulating file names in Dired buffers.
1932 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1933 "In Dired, return name of file mentioned on this line.
1934 Value returned normally includes the directory name.
1935 Optional arg LOCALP with value `no-dir' means don't include directory
1936 name in result. A value of `verbatim' means to return the name exactly as
1937 it occurs in the buffer, and a value of t means construct name relative to
1938 `default-directory', which still may contain slashes if in a subdirectory.
1939 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1940 regular filenames and return nil if no filename on this line.
1941 Otherwise, an error occurs in these cases."
1942 (let (case-fold-search file p1 p2 already-absolute)
1943 (save-excursion
1944 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1945 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1946 ;; nil if no file on this line, but no-error-if-not-filep is t:
1947 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1948 (progn
1949 ;; Get rid of the mouse-face property that file names have.
1950 (set-text-properties 0 (length file) nil file)
1951 ;; Unquote names quoted by ls or by dired-insert-directory.
1952 (while (string-match
1954 (setq file (replace-match
1956 nil t file 1)))
1957 ;; The above `read' will return a unibyte string if FILE
1958 ;; contains eight-bit-control/graphic characters.
1959 (if (and enable-multibyte-characters
1960 (not (multibyte-string-p file)))
1961 (setq file (string-to-multibyte file)))))
1962 (and file (file-name-absolute-p file)
1963 ;; A relative file name can start with ~.
1964 ;; Don't treat it as absolute in this context.
1965 (not (eq (aref file 0) ?~))
1966 (setq already-absolute t))
1967 (cond
1968 ((null file)
1969 nil)
1970 ((eq localp 'verbatim)
1971 file)
1972 ((and (not no-error-if-not-filep)
1973 (member file '("." "..")))
1974 (error "Cannot operate on `.' or `..'"))
1975 ((and (eq localp 'no-dir) already-absolute)
1976 (file-name-nondirectory file))
1977 (already-absolute
1978 (let ((handler (find-file-name-handler file nil)))
1979 ;; check for safe-magic property so that we won't
1980 ;; put /: for names that don't really need them.
1981 ;; For instance, .gz files when auto-compression-mode is on.
1982 (if (and handler (not (get handler 'safe-magic)))
1983 (concat "/:" file)
1984 file)))
1985 ((eq localp 'no-dir)
1986 file)
1987 ((equal (dired-current-directory) "/")
1988 (setq file (concat (dired-current-directory localp) file))
1989 (let ((handler (find-file-name-handler file nil)))
1990 ;; check for safe-magic property so that we won't
1991 ;; put /: for names that don't really need them.
1992 ;; For instance, .gz files when auto-compression-mode is on.
1993 (if (and handler (not (get handler 'safe-magic)))
1994 (concat "/:" file)
1995 file)))
1996 (t
1997 (concat (dired-current-directory localp) file)))))
1999 (defun dired-string-replace-match (regexp string newtext
2000 &optional literal global)
2001 "Replace first match of REGEXP in STRING with NEWTEXT.
2002 If it does not match, nil is returned instead of the new string.
2003 Optional arg LITERAL means to take NEWTEXT literally.
2004 Optional arg GLOBAL means to replace all matches."
2005 (if global
2006 (let ((start 0) ret)
2007 (while (string-match regexp string start)
2008 (let ((from-end (- (length string) (match-end 0))))
2009 (setq ret (setq string (replace-match newtext t literal string)))
2010 (setq start (- (length string) from-end))))
2011 ret)
2012 (if (not (string-match regexp string 0))
2013 nil
2014 (replace-match newtext t literal string))))
2016 (defun dired-make-absolute (file &optional dir)
2017 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2018 ;; We can't always use expand-file-name as this would get rid of `.'
2019 ;; or expand in / instead default-directory if DIR=="".
2020 ;; This should be good enough for ange-ftp.
2021 ;; It should be reasonably fast, though, as it is called in
2022 ;; dired-get-filename.
2023 (concat (or dir default-directory) file))
2025 (defun dired-make-relative (file &optional dir ignore)
2026 "Convert FILE (an absolute file name) to a name relative to DIR.
2027 If this is impossible, return FILE unchanged.
2028 DIR must be a directory name, not a file name."
2029 (or dir (setq dir default-directory))
2030 ;; This case comes into play if default-directory is set to
2031 ;; use ~.
2032 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
2033 (setq dir (expand-file-name dir)))
2034 (if (string-match (concat "^" (regexp-quote dir)) file)
2035 (substring file (match-end 0))
2036 ;;; (or no-error
2037 ;;; (error "%s: not in directory tree growing at %s" file dir))
2038 file))
2039 \f
2040 ;;; Functions for finding the file name in a dired buffer line.
2042 (defvar dired-permission-flags-regexp
2044 "Regular expression to match the permission flags in `ls -l'.")
2046 ;; Move to first char of filename on this line.
2047 ;; Returns position (point) or nil if no filename on this line."
2048 (defun dired-move-to-filename (&optional raise-error eol)
2049 "Move to the beginning of the filename on the current line.
2050 Return the position of the beginning of the filename, or nil if none found."
2051 ;; This is the UNIX version.
2052 (or eol (setq eol (line-end-position)))
2053 (beginning-of-line)
2054 ;; First try assuming `ls --dired' was used.
2055 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
2056 (cond
2057 ((and change (< change eol))
2058 (goto-char change))
2059 ((re-search-forward directory-listing-before-filename-regexp eol t)
2060 (goto-char (match-end 0)))
2061 ((re-search-forward dired-permission-flags-regexp eol t)
2062 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2063 (if raise-error
2064 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
2065 (beginning-of-line)
2066 nil)
2067 (raise-error
2068 (error "No file on this line")))))
2070 (defun dired-move-to-end-of-filename (&optional no-error)
2071 ;; Assumes point is at beginning of filename,
2072 ;; thus the rwx bit re-search-backward below will succeed in *this*
2073 ;; line if at all. So, it should be called only after
2074 ;; (dired-move-to-filename t).
2075 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2076 ;; This is the UNIX version.
2077 (if (get-text-property (point) 'dired-filename)
2078 (goto-char (next-single-property-change (point) 'dired-filename))
2079 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
2080 ;; case-fold-search is nil now, so we can test for capital F:
2081 (setq used-F (string-match "F" dired-actual-switches)
2082 opoint (point)
2083 eol (save-excursion (end-of-line) (point))
2084 hidden (and selective-display
2086 (if hidden
2087 nil
2088 (save-excursion ;; Find out what kind of file this is:
2089 ;; Restrict perm bits to be non-blank,
2090 ;; otherwise this matches one char to early (looking backward):
2091 ;; "l---------" (some systems make symlinks that way)
2092 ;; "----------" (plain file with zero perms)
2093 (if (re-search-backward
2094 dired-permission-flags-regexp nil t)
2095 (setq file-type (char-after (match-beginning 1))
2096 symlink (eq file-type ?l)
2097 ;; Only with -F we need to know whether it's an executable
2098 executable (and
2099 used-F
2100 (string-match
2101 "[xst]" ;; execute bit set anywhere?
2102 (concat
2103 (match-string 2)
2104 (match-string 3)
2105 (match-string 4)))))
2106 (or no-error (error "No file on this line"))))
2107 ;; Move point to end of name:
2108 (if symlink
2109 (if (search-forward " -> " eol t)
2110 (progn
2111 (forward-char -4)
2112 (and used-F
2113 dired-ls-F-marks-symlinks
2114 (eq (preceding-char) ?@) ;; did ls really mark the link?
2115 (forward-char -1))))
2116 (goto-char eol) ;; else not a symbolic link
2117 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2118 ;; one trailing character. (Executable bits on symlinks ain't mean
2119 ;; a thing, even to ls, but we know it's not a symlink.)
2120 (and used-F
2121 (or (memq file-type '(?d ?s ?p))
2122 executable)
2123 (forward-char -1))))
2124 (or no-error
2125 (not (eq opoint (point)))
2126 (error "%s" (if hidden
2127 (substitute-command-keys
2129 "No file on this line")))
2130 (if (eq opoint (point))
2131 nil
2132 (point)))))
2134 \f
2135 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2137 (defun dired-copy-filename-as-kill (&optional arg)
2138 "Copy names of marked (or next ARG) files into the kill ring.
2139 The names are separated by a space.
2140 With a zero prefix arg, use the absolute file name of each marked file.
2142 `default-directory'. (This still may contain slashes if in a subdirectory.)
2144 If on a subdir headerline, use absolute subdirname instead;
2145 prefix arg and marked files are ignored in this case.
2148 (interactive "P")
2149 (let ((string
2150 (or (dired-get-subdir)
2151 (mapconcat (function identity)
2152 (if arg
2153 (cond ((zerop (prefix-numeric-value arg))
2154 (dired-get-marked-files))
2155 ((consp arg)
2156 (dired-get-marked-files t))
2157 (t
2158 (dired-get-marked-files
2159 'no-dir (prefix-numeric-value arg))))
2160 (dired-get-marked-files 'no-dir))
2161 " "))))
2162 (if (eq last-command 'kill-region)
2163 (kill-append string nil)
2164 (kill-new string))
2165 (message "%s" string)))
2167 \f
2168 ;; Keeping Dired buffers in sync with the filesystem and with each other
2170 (defun dired-buffers-for-dir (dir &optional file)
2171 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2172 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2173 ;; matches FILE.
2174 ;; The list is in reverse order of buffer creation, most recent last.
2175 ;; As a side effect, killed dired buffers for DIR are removed from
2176 ;; dired-buffers.
2177 (setq dir (file-name-as-directory dir))
2178 (let ((alist dired-buffers) result elt buf)
2179 (while alist
2180 (setq elt (car alist)
2181 buf (cdr elt))
2182 (if (buffer-name buf)
2183 (if (dired-in-this-tree dir (car elt))
2184 (with-current-buffer buf
2185 (and (assoc dir dired-subdir-alist)
2186 (or (null file)
2187 (let ((wildcards
2188 (file-name-nondirectory dired-directory)))
2189 (or (= 0 (length wildcards))
2190 (string-match (dired-glob-regexp wildcards)
2191 file))))
2192 (setq result (cons buf result)))))
2193 ;; else buffer is killed - clean up:
2194 (setq dired-buffers (delq elt dired-buffers)))
2195 (setq alist (cdr alist)))
2196 result))
2198 (defun dired-glob-regexp (pattern)
2199 "Convert glob-pattern PATTERN to a regular expression."
2200 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2201 regexp)
2202 (while (string-match "[[?*]" pattern matched-in-pattern)
2203 (let ((op-end (match-end 0))
2204 (next-op (aref pattern (match-beginning 0))))
2205 (setq regexp (concat regexp
2206 (regexp-quote
2207 (substring pattern matched-in-pattern
2208 (match-beginning 0)))))
2209 (cond ((= next-op ??)
2210 (setq regexp (concat regexp "."))
2211 (setq matched-in-pattern op-end))
2212 ((= next-op ?\[)
2213 ;; Fails to handle ^ yet ????
2214 (let* ((set-start (match-beginning 0))
2215 (set-cont
2216 (if (= (aref pattern (1+ set-start)) ?^)
2217 (+ 3 set-start)
2218 (+ 2 set-start)))
2219 (set-end (string-match "]" pattern set-cont))
2220 (set (substring pattern set-start (1+ set-end))))
2221 (setq regexp (concat regexp set))
2222 (setq matched-in-pattern (1+ set-end))))
2223 ((= next-op ?*)
2224 (setq regexp (concat regexp ".*"))
2225 (setq matched-in-pattern op-end)))))
2227 regexp
2228 (regexp-quote
2229 (substring pattern matched-in-pattern))
2234 (defun dired-advertise ()
2235 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2236 ;; With wildcards we actually advertise too much.
2237 (let ((expanded-default (expand-file-name default-directory)))
2238 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2239 t ; we have already advertised ourselves
2240 (setq dired-buffers
2241 (cons (cons expanded-default (current-buffer))
2242 dired-buffers)))))
2244 (defun dired-unadvertise (dir)
2245 ;; Remove DIR from the buffer alist in variable dired-buffers.
2246 ;; This has the effect of removing any buffer whose main directory is DIR.
2247 ;; It does not affect buffers in which DIR is a subdir.
2248 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2249 (setq dired-buffers
2250 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2251 \f
2252 ;; Tree Dired
2254 ;;; utility functions
2256 (defun dired-in-this-tree (file dir)
2257 ;;"Is FILE part of the directory tree starting at DIR?"
2258 (let (case-fold-search)
2259 (string-match (concat "^" (regexp-quote dir)) file)))
2261 (defun dired-normalize-subdir (dir)
2262 ;; Prepend default-directory to DIR if relative file name.
2263 ;; dired-get-filename must be able to make a valid file name from a
2264 ;; file and its directory DIR.
2265 (file-name-as-directory
2266 (if (file-name-absolute-p dir)
2267 dir
2268 (expand-file-name dir default-directory))))
2270 (defun dired-get-subdir ()
2271 ;;"Return the subdir name on this line, or nil if not on a headerline."
2272 ;; Look up in the alist whether this is a headerline.
2273 (save-excursion
2274 (let ((cur-dir (dired-current-directory)))
2275 (beginning-of-line) ; alist stores b-o-l positions
2276 (and (zerop (- (point)
2277 (dired-get-subdir-min (assoc cur-dir
2278 dired-subdir-alist))))
2279 cur-dir))))
2281 ;(defun dired-get-subdir-min (elt)
2282 ; (cdr elt))
2283 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2284 (defalias 'dired-get-subdir-min 'cdr)
2286 (defun dired-get-subdir-max (elt)
2287 (save-excursion
2288 (goto-char (dired-get-subdir-min elt))
2289 (dired-subdir-max)))
2291 (defun dired-clear-alist ()
2292 (while dired-subdir-alist
2293 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2294 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2296 (defun dired-subdir-index (dir)
2297 ;; Return an index into alist for use with nth
2298 ;; for the sake of subdir moving commands.
2299 (let (found (index 0) (alist dired-subdir-alist))
2300 (while alist
2301 (if (string= dir (car (car alist)))
2302 (setq alist nil found t)
2303 (setq alist (cdr alist) index (1+ index))))
2304 (if found index nil)))
2306 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2307 "Go to next subdirectory, regardless of level."
2308 ;; Use 0 arg to go to this directory's header line.
2309 ;; NO-SKIP prevents moving to end of header line, returning whatever
2310 ;; position was found in dired-subdir-alist.
2311 (interactive "p")
2312 (let ((this-dir (dired-current-directory))
2313 pos index)
2314 ;; nth with negative arg does not return nil but the first element
2315 (setq index (- (dired-subdir-index this-dir) arg))
2316 (setq pos (if (>= index 0)
2317 (dired-get-subdir-min (nth index dired-subdir-alist))))
2318 (if pos
2319 (progn
2320 (goto-char pos)
2322 (point))
2323 (if no-error-if-not-found
2324 nil ; return nil if not found
2325 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2327 (defun dired-build-subdir-alist (&optional switches)
2328 "Build `dired-subdir-alist' by parsing the buffer.
2329 Returns the new value of the alist.
2330 If optional arg SWITCHES is non-nil, use its value
2331 instead of `dired-actual-switches'."
2332 (interactive)
2333 (dired-clear-alist)
2334 (save-excursion
2335 (let* ((count 0)
2336 (inhibit-read-only t)
2337 (buffer-undo-list t)
2338 (switches (or switches dired-actual-switches))
2339 new-dir-name
2340 (R-ftp-base-dir-regex
2341 ;; Used to expand subdirectory names correctly in recursive
2342 ;; ange-ftp listings.
2343 (and (string-match "R" switches)
2346 (goto-char (point-min))
2347 (setq dired-subdir-alist nil)
2348 (while (re-search-forward dired-subdir-regexp nil t)
2349 ;; Avoid taking a file name ending in a colon
2350 ;; as a subdir name.
2351 (unless (save-excursion
2352 (goto-char (match-beginning 0))
2353 (beginning-of-line)
2354 (forward-char 2)
2355 (save-match-data (looking-at dired-re-perms)))
2356 (save-excursion
2357 (goto-char (match-beginning 1))
2358 (setq new-dir-name
2359 (buffer-substring-no-properties (point) (match-end 1))
2360 new-dir-name
2361 (save-match-data
2362 (if (and R-ftp-base-dir-regex
2363 (not (string= new-dir-name default-directory))
2364 (string-match R-ftp-base-dir-regex new-dir-name))
2365 (concat default-directory
2366 (substring new-dir-name (match-end 0)))
2367 (expand-file-name new-dir-name))))
2368 (delete-region (point) (match-end 1))
2369 (insert new-dir-name))
2370 (setq count (1+ count))
2371 (dired-alist-add-1 new-dir-name
2372 ;; Place a sub directory boundary between lines.
2373 (save-excursion
2374 (goto-char (match-beginning 0))
2375 (beginning-of-line)
2376 (point-marker)))))
2377 (if (and (> count 1) (interactive-p))
2378 (message "Buffer includes %d directories" count)))
2379 ;; We don't need to sort it because it is in buffer order per
2380 ;; constructionem. Return new alist:
2381 dired-subdir-alist))
2383 (defun dired-alist-add-1 (dir new-marker)
2384 ;; Add new DIR at NEW-MARKER. Don't sort.
2385 (setq dired-subdir-alist
2386 (cons (cons (dired-normalize-subdir dir) new-marker)
2387 dired-subdir-alist)))
2389 (defun dired-goto-next-nontrivial-file ()
2390 ;; Position point on first nontrivial file after point.
2391 (dired-goto-next-file);; so there is a file to compare with
2392 (if (stringp dired-trivial-filenames)
2393 (while (and (not (eobp))
2394 (string-match dired-trivial-filenames
2395 (file-name-nondirectory
2396 (or (dired-get-filename nil t) ""))))
2397 (forward-line 1)
2398 (dired-move-to-filename))))
2400 (defun dired-goto-next-file ()
2401 (let ((max (1- (dired-subdir-max))))
2402 (while (and (not (dired-move-to-filename)) (< (point) max))
2403 (forward-line 1))))
2405 (defun dired-goto-file (file)
2406 "Go to line describing file FILE in this dired buffer."
2407 ;; Return value of point on success, else nil.
2408 ;; FILE must be an absolute file name.
2411 ;; it in the buffer.
2412 (interactive
2413 (prog1 ; let push-mark display its message
2414 (list (expand-file-name
2415 (read-file-name "Goto file: "
2416 (dired-current-directory))))
2417 (push-mark)))
2418 (setq file (directory-file-name file)) ; does no harm if no directory
2419 (let (found case-fold-search dir)
2420 (setq dir (or (file-name-directory file)
2421 (error "File name `%s' is not absolute" file)))
2422 (save-excursion
2423 ;; The hair here is to get the result of dired-goto-subdir
2424 ;; without really calling it if we don't have any subdirs.
2425 (if (if (string= dir (expand-file-name default-directory))
2426 (goto-char (point-min))
2427 (and (cdr dired-subdir-alist)
2428 (dired-goto-subdir dir)))
2429 (let ((base (file-name-nondirectory file))
2430 search-string
2431 (boundary (dired-subdir-max)))
2432 (setq search-string
2434 (setq search-string
2436 (while (and (not found)
2437 ;; filenames are preceded by SPC, this makes
2438 ;; the search faster (e.g. for the filename "-"!).
2439 (search-forward (concat " " search-string)
2440 boundary 'move))
2441 ;; Match could have BASE just as initial substring or
2442 ;; or in permission bits or date or
2443 ;; not be a proper filename at all:
2444 (if (equal base (dired-get-filename 'no-dir t))
2445 ;; Must move to filename since an (actually
2446 ;; correct) match could have been elsewhere on the
2447 ;; ;; line (e.g. "-" would match somewhere in the
2448 ;; permission bits).
2449 (setq found (dired-move-to-filename))
2450 ;; If this isn't the right line, move forward to avoid
2451 ;; trying this line again.
2452 (forward-line 1))))))
2453 (and found
2454 ;; return value of point (i.e., FOUND):
2455 (goto-char found))))
2457 (defun dired-initial-position (dirname)
2458 ;; Where point should go in a new listing of DIRNAME.
2459 ;; Point assumed at beginning of new subdir line.
2460 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2461 (end-of-line)
2462 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2463 \f
2464 ;; These are hooks which make tree dired work.
2465 ;; They are in this file because other parts of dired need to call them.
2466 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2468 ;; This function is called for each retrieved filename.
2469 ;; It could stand to be faster, though it's mostly function call
2470 ;; overhead. Avoiding the function call seems to save about 10% in
2471 ;; dired-get-filename. Make it a defsubst?
2472 (defun dired-current-directory (&optional localp)
2473 "Return the name of the subdirectory to which this line belongs.
2474 This returns a string with trailing slash, like `default-directory'.
2475 Optional argument means return a file name relative to `default-directory'."
2476 (let ((here (point))
2477 (alist (or dired-subdir-alist
2478 ;; probably because called in a non-dired buffer
2479 (error "No subdir-alist in %s" (current-buffer))))
2480 elt dir)
2481 (while alist
2482 (setq elt (car alist)
2483 dir (car elt)
2484 ;; use `<=' (not `<') as subdir line is part of subdir
2485 alist (if (<= (dired-get-subdir-min elt) here)
2486 nil ; found
2487 (cdr alist))))
2488 (if localp
2489 (dired-make-relative dir default-directory)
2490 dir)))
2492 ;; Subdirs start at the beginning of their header lines and end just
2493 ;; before the beginning of the next header line (or end of buffer).
2495 (defun dired-subdir-max ()
2496 (save-excursion
2497 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2498 (point-max)
2499 (point))))
2500 \f
2501 ;; Deleting files
2503 (defcustom dired-recursive-deletes 'top
2504 "Decide whether recursive deletes are allowed.
2505 A value of nil means no recursive deletes.
2506 `always' means delete recursively without asking. This is DANGEROUS!
2507 `top' means ask for each directory at top level, but delete its subdirectories
2508 without asking.
2509 Anything else means ask for each directory."
2510 :type '(choice :tag "Delete non-empty directories"
2511 (const :tag "Yes" always)
2512 (const :tag "No--only delete empty directories" nil)
2513 (const :tag "Confirm for each directory" t)
2514 (const :tag "Confirm for each top directory only" top))
2515 :group 'dired)
2517 ;; Match anything but `.' and `..'.
2520 ;; Delete file, possibly delete a directory and all its files.
2521 ;; This function is usefull outside of dired. One could change it's name
2522 ;; to e.g. recursive-delete-file and put it somewhere else.
2523 (defun dired-delete-file (file &optional recursive) "\
2524 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2525 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2526 nil, do not delete.
2527 `always', delete recursively without asking.
2528 `top', ask for each directory at top level.
2529 Anything else, ask for each sub-directory."
2530 (let (files)
2531 ;; This test is equivalent to
2532 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2533 ;; but more efficient
2534 (if (not (eq t (car (file-attributes file))))
2535 (delete-file file)
2536 (when (and recursive
2537 (setq files
2538 (directory-files file t dired-re-no-dot)) ; Not empty.
2539 (or (eq recursive 'always)
2540 (yes-or-no-p (format "Recursive delete of %s? "
2541 (dired-make-relative file)))))
2542 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2543 (while files ; Recursively delete (possibly asking).
2544 (dired-delete-file (car files) recursive)
2545 (setq files (cdr files))))
2546 (delete-directory file))))
2548 (defun dired-do-flagged-delete (&optional nomessage)
2549 "In Dired, delete the files flagged for deletion.
2550 If NOMESSAGE is non-nil, we don't display any message
2551 if there are no flagged files.
2552 `dired-recursive-deletes' controls whether deletion of
2553 non-empty directories is allowed."
2554 (interactive)
2555 (let* ((dired-marker-char dired-del-marker)
2556 (regexp (dired-marker-regexp))
2557 case-fold-search)
2558 (if (save-excursion (goto-char (point-min))
2559 (re-search-forward regexp nil t))
2560 (dired-internal-do-deletions
2561 ;; this can't move point since ARG is nil
2562 (dired-map-over-marks (cons (dired-get-filename) (point))
2563 nil)
2564 nil)
2565 (or nomessage
2566 (message "(No deletions requested)")))))
2568 (defun dired-do-delete (&optional arg)
2569 "Delete all marked (or next ARG) files.
2570 `dired-recursive-deletes' controls whether deletion of
2571 non-empty directories is allowed."
2572 ;; This is more consistent with the file marking feature than
2573 ;; dired-do-flagged-delete.
2574 (interactive "P")
2575 (dired-internal-do-deletions
2576 ;; this may move point if ARG is an integer
2577 (dired-map-over-marks (cons (dired-get-filename) (point))
2578 arg)
2579 arg))
2581 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2583 (defun dired-internal-do-deletions (l arg)
2584 ;; L is an alist of files to delete, with their buffer positions.
2585 ;; ARG is the prefix arg.
2586 ;; Filenames are absolute.
2587 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2588 ;; That way as changes are made in the buffer they do not shift the
2589 ;; lines still to be changed, so the (point) values in L stay valid.
2590 ;; Also, for subdirs in natural order, a subdir's files are deleted
2591 ;; before the subdir itself - the other way around would not work.
2592 (let ((files (mapcar (function car) l))
2593 (count (length l))
2594 (succ 0))
2595 ;; canonicalize file list for pop up
2596 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2597 (if (dired-mark-pop-up
2598 " *Deletions*" 'delete files dired-deletion-confirmer
2599 (format "Delete %s " (dired-mark-prompt arg files)))
2600 (save-excursion
2601 (let (failures);; files better be in reverse order for this loop!
2602 (while l
2603 (goto-char (cdr (car l)))
2604 (let ((inhibit-read-only t))
2605 (condition-case err
2606 (let ((fn (car (car l))))
2607 (dired-delete-file fn dired-recursive-deletes)
2608 ;; if we get here, removing worked
2609 (setq succ (1+ succ))
2610 (message "%s of %s deletions" succ count)
2611 (dired-fun-in-all-buffers
2612 (file-name-directory fn) (file-name-nondirectory fn)
2613 (function dired-delete-entry) fn))
2614 (error;; catch errors from failed deletions
2616 (setq failures (cons (car (car l)) failures)))))
2617 (setq l (cdr l)))
2618 (if (not failures)
2619 (message "%d deletion%s done" count (dired-plural-s count))
2620 (dired-log-summary
2621 (format "%d of %d deletion%s failed"
2622 (length failures) count
2623 (dired-plural-s count))
2624 failures))))
2625 (message "(No deletions performed)")))
2626 (dired-move-to-filename))
2628 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2629 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2630 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2631 ;; (FILE does not include a directory component.)
2632 ;; FILE may be nil, in which case ignore it.
2633 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2634 (let (success-list)
2635 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2636 file))
2637 (with-current-buffer buf
2638 (if (apply fun args)
2639 (setq success-list (cons (buffer-name buf) success-list)))))
2640 success-list))
2642 ;; Delete the entry for FILE from
2643 (defun dired-delete-entry (file)
2644 (save-excursion
2645 (and (dired-goto-file file)
2646 (let ((inhibit-read-only t))
2647 (delete-region (progn (beginning-of-line) (point))
2648 (save-excursion (forward-line 1) (point))))))
2649 (dired-clean-up-after-deletion file))
2651 ;; This is a separate function for the sake of dired-x.el.
2652 (defun dired-clean-up-after-deletion (fn)
2653 ;; Clean up after a deleted file or directory FN.
2654 (save-excursion (and (cdr dired-subdir-alist)
2655 (dired-goto-subdir fn)
2656 (dired-kill-subdir))))
2657 \f
2658 ;; Confirmation
2660 (defun dired-marker-regexp ()
2661 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2663 (defun dired-plural-s (count)
2664 (if (= 1 count) "" "s"))
2666 (defun dired-mark-prompt (arg files)
2667 "Return a string for use in a prompt, either the current file
2668 name, or the marker and a count of marked files."
2669 ;; distinguish-one-marked can cause the first element to be just t.
2670 (if (eq (car files) t) (setq files (cdr files)))
2671 (let ((count (length files)))
2672 (if (= count 1)
2673 (car files)
2674 ;; more than 1 file:
2675 (if (integerp arg)
2676 ;; abs(arg) = count
2677 ;; Perhaps this is nicer, but it also takes more screen space:
2678 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2679 ;; count)
2680 (format "[next %d files]" arg)
2681 (format "%c [%d files]" dired-marker-char count)))))
2683 (defun dired-pop-to-buffer (buf)
2684 ;; Pop up buffer BUF.
2685 (pop-to-buffer (get-buffer-create buf))
2686 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2687 (when dired-shrink-to-fit
2688 ;; Try to not delete window when we want to display less than
2689 ;; `window-min-height' lines.
2690 (fit-window-to-buffer (get-buffer-window buf) nil 1)))
2692 (defcustom dired-no-confirm nil
2693 "A list of symbols for commands Dired should not confirm.
2694 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2695 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2696 `touch' and `uncompress'."
2697 :group 'dired
2698 :type '(set (const byte-compile) (const chgrp)
2699 (const chmod) (const chown) (const compress)
2700 (const copy) (const delete) (const hardlink)
2701 (const load) (const move) (const print)
2702 (const shell) (const symlink) (const touch)
2703 (const uncompress)))
2705 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2706 "Return FUNCTION's result on ARGS after showing which files are marked.
2707 Displays the file names in a buffer named BUFNAME;
2709 This uses function `dired-pop-to-buffer' to do that.
2711 FUNCTION should not manipulate files, just read input
2712 (an argument or confirmation).
2713 The window is not shown if there is just one file or
2714 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2715 FILES is the list of marked files. It can also be (t FILENAME)
2716 in the case of one marked file, to distinguish that from using
2717 just the current file."
2718 (or bufname (setq bufname " *Marked Files*"))
2719 (if (or (eq dired-no-confirm t)
2720 (memq op-symbol dired-no-confirm)
2721 ;; If FILES defaulted to the current line's file.
2722 (= (length files) 1))
2723 (apply function args)
2724 (with-current-buffer (get-buffer-create bufname)
2725 (erase-buffer)
2726 ;; Handle (t FILE) just like (FILE), here.
2727 ;; That value is used (only in some cases), to mean
2728 ;; just one file that was marked, rather than the current line file.
2729 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2730 (remove-text-properties (point-min) (point-max)
2731 '(mouse-face nil help-echo nil)))
2732 (save-window-excursion
2733 (dired-pop-to-buffer bufname)
2734 (apply function args))))
2736 (defun dired-format-columns-of-files (files)
2737 (let ((beg (point)))
2738 (completion--insert-strings files)
2739 (put-text-property beg (point) 'mouse-face nil)))
2740 \f
2741 ;; Commands to mark or flag file(s) at or near current line.
2743 (defun dired-repeat-over-lines (arg function)
2744 ;; This version skips non-file lines.
2745 (let ((pos (make-marker)))
2746 (beginning-of-line)
2747 (while (and (> arg 0) (not (eobp)))
2748 (setq arg (1- arg))
2749 (beginning-of-line)
2750 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2751 (save-excursion
2752 (forward-line 1)
2753 (move-marker pos (1+ (point))))
2754 (save-excursion (funcall function))
2755 ;; Advance to the next line--actually, to the line that *was* next.
2756 ;; (If FUNCTION inserted some new lines in between, skip them.)
2757 (goto-char pos))
2758 (while (and (< arg 0) (not (bobp)))
2759 (setq arg (1+ arg))
2760 (forward-line -1)
2761 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2762 (beginning-of-line)
2763 (save-excursion (funcall function)))
2764 (move-marker pos nil)
2765 (dired-move-to-filename)))
2767 (defun dired-between-files ()
2768 ;; This used to be a regexp match of the `total ...' line output by
2769 ;; ls, which is slightly faster, but that is not very robust; notably,
2770 ;; it fails for non-english locales.
2771 (save-excursion (not (dired-move-to-filename))))
2773 (defun dired-next-marked-file (arg &optional wrap opoint)
2774 "Move to the next marked file, wrapping around the end of the buffer."
2776 (or opoint (setq opoint (point)));; return to where interactively started
2777 (if (if (> arg 0)
2778 (re-search-forward dired-re-mark nil t arg)
2779 (beginning-of-line)
2780 (re-search-backward dired-re-mark nil t (- arg)))
2781 (dired-move-to-filename)
2782 (if (null wrap)
2783 (progn
2784 (goto-char opoint)
2785 (error "No next marked file"))
2786 (message "(Wraparound for next marked file)")
2787 (goto-char (if (> arg 0) (point-min) (point-max)))
2788 (dired-next-marked-file arg nil opoint))))
2790 (defun dired-prev-marked-file (arg &optional wrap)
2791 "Move to the previous marked file, wrapping around the end of the buffer."
2793 (dired-next-marked-file (- arg) wrap))
2795 (defun dired-file-marker (file)
2796 ;; Return FILE's marker, or nil if unmarked.
2797 (save-excursion
2798 (and (dired-goto-file file)
2799 (progn
2800 (beginning-of-line)
2802 (following-char))))))
2804 (defun dired-mark-files-in-region (start end)
2805 (let ((inhibit-read-only t))
2806 (if (> start end)
2807 (error "start > end"))
2808 (goto-char start) ; assumed at beginning of line
2809 (while (< (point) end)
2810 ;; Skip subdir line and following garbage like the `total' line:
2811 (while (and (< (point) end) (dired-between-files))
2812 (forward-line 1))
2813 (if (and (not (looking-at dired-re-dot))
2814 (dired-get-filename nil t))
2815 (progn
2816 (delete-char 1)
2817 (insert dired-marker-char)))
2818 (forward-line 1))))
2820 (defun dired-mark (arg)
2821 "Mark the current (or next ARG) files.
2822 If on a subdir headerline, mark all its files except `.' and `..'.
2826 this subdir."
2827 (interactive "P")
2828 (if (dired-get-subdir)
2829 (save-excursion (dired-mark-subdir-files))
2830 (let ((inhibit-read-only t))
2831 (dired-repeat-over-lines
2832 (prefix-numeric-value arg)
2833 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2835 (defun dired-unmark (arg)
2836 "Unmark the current (or next ARG) files.
2837 If looking at a subdir, unmark all its files except `.' and `..'."
2838 (interactive "P")
2840 (dired-mark arg)))
2842 (defun dired-flag-file-deletion (arg)
2843 "In Dired, flag the current line's file for deletion.
2844 With prefix arg, repeat over several lines.
2846 If on a subdir headerline, mark all its files except `.' and `..'."
2847 (interactive "P")
2848 (let ((dired-marker-char dired-del-marker))
2849 (dired-mark arg)))
2851 (defun dired-unmark-backward (arg)
2852 "In Dired, move up lines and remove deletion flag there.
2853 Optional prefix ARG says how many lines to unflag; default is one line."
2854 (interactive "p")
2855 (dired-unmark (- arg)))
2857 (defun dired-toggle-marks ()
2858 "Toggle marks: marked files become unmarked, and vice versa.
2859 Files marked with other flags (such as `D') are not affected.
2860 `.' and `..' are never toggled.
2861 As always, hidden subdirs are not affected."
2862 (interactive)
2863 (save-excursion
2864 (goto-char (point-min))
2865 (let ((inhibit-read-only t))
2866 (while (not (eobp))
2867 (or (dired-between-files)
2868 (looking-at dired-re-dot)
2869 ;; use subst instead of insdel because it does not move
2870 ;; the gap and thus should be faster and because
2871 ;; other characters are left alone automatically
2872 (apply 'subst-char-in-region
2873 (point) (1+ (point))
2877 (forward-line 1)))))
2878 \f
2879 ;;; Commands to mark or flag files based on their characteristics or names.
2881 (defvar dired-regexp-history nil
2882 "History list of regular expressions used in Dired commands.")
2884 (defun dired-read-regexp (prompt)
2885 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2887 (defun dired-mark-files-regexp (regexp &optional marker-char)
2888 "Mark all files matching REGEXP for use in later commands.
2889 A prefix argument means to unmark them instead.
2890 `.' and `..' are never marked.
2893 object files--just `.o' will mark more than you might think."
2894 (interactive
2895 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2896 " files (regexp): "))
2898 (let ((dired-marker-char (or marker-char dired-marker-char)))
2899 (dired-mark-if
2900 (and (not (looking-at dired-re-dot))
2901 (not (eolp)) ; empty line
2902 (let ((fn (dired-get-filename nil t)))
2903 (and fn (string-match regexp (file-name-nondirectory fn)))))
2904 "matching file")))
2906 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2907 "Mark all files with contents containing REGEXP for use in later commands.
2908 A prefix argument means to unmark them instead.
2909 `.' and `..' are never marked."
2910 (interactive
2911 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2912 " files containing (regexp): "))
2914 (let ((dired-marker-char (or marker-char dired-marker-char)))
2915 (dired-mark-if
2916 (and (not (looking-at dired-re-dot))
2917 (not (eolp)) ; empty line
2918 (let ((fn (dired-get-filename nil t)))
2919 (when (and fn (file-readable-p fn)
2920 (not (file-directory-p fn)))
2921 (let ((prebuf (get-file-buffer fn)))
2922 (message "Checking %s" fn)
2923 ;; For now we do it inside emacs
2924 ;; Grep might be better if there are a lot of files
2925 (if prebuf
2926 (with-current-buffer prebuf
2927 (save-excursion
2928 (goto-char (point-min))
2929 (re-search-forward regexp nil t)))
2930 (with-temp-buffer
2931 (insert-file-contents fn)
2932 (goto-char (point-min))
2933 (re-search-forward regexp nil t))))
2934 )))
2935 "matching file")))
2937 (defun dired-flag-files-regexp (regexp)
2938 "In Dired, flag all files containing the specified REGEXP for deletion.
2939 The match is against the non-directory part of the filename. Use `^'
2940 and `$' to anchor matches. Exclude subdirs by hiding them.
2941 `.' and `..' are never flagged."
2942 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2943 (dired-mark-files-regexp regexp dired-del-marker))
2945 (defun dired-mark-symlinks (unflag-p)
2946 "Mark all symbolic links.
2947 With prefix argument, unflag all those files."
2948 (interactive "P")
2950 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2952 (defun dired-mark-directories (unflag-p)
2953 "Mark all directory file lines except `.' and `..'.
2954 With prefix argument, unflag all those files."
2955 (interactive "P")
2957 (dired-mark-if (and (looking-at dired-re-dir)
2958 (not (looking-at dired-re-dot)))
2959 "directory file")))
2961 (defun dired-mark-executables (unflag-p)
2962 "Mark all executable files.
2963 With prefix argument, unflag all those files."
2964 (interactive "P")
2966 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2968 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2969 ;; files for which PREDICATE returns non-nil.
2971 (defun dired-flag-auto-save-files (&optional unflag-p)
2972 "Flag for deletion files whose names suggest they are auto save files.
2973 A prefix argument says to unflag those files instead."
2974 (interactive "P")
2976 (dired-mark-if
2977 ;; It is less than general to check for # here,
2978 ;; but it's the only way this runs fast enough.
2979 (and (save-excursion (end-of-line)
2980 (or
2981 (eq (preceding-char) ?#)
2982 ;; Handle executables in case of -F option.
2983 ;; We need not worry about the other kinds
2984 ;; of markings that -F makes, since they won't
2985 ;; appear on real auto-save files.
2986 (if (eq (preceding-char) ?*)
2987 (progn
2988 (forward-char -1)
2989 (eq (preceding-char) ?#)))))
2990 (not (looking-at dired-re-dir))
2991 (let ((fn (dired-get-filename t t)))
2992 (if fn (auto-save-file-name-p
2993 (file-name-nondirectory fn)))))
2994 "auto save file")))
2996 (defcustom dired-garbage-files-regexp
2997 ;; `log' here is dubious, since it's typically used for useful log
2998 ;; files, not just TeX stuff. -- fx
2999 (concat (regexp-opt
3000 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
3003 :type 'regexp
3004 :group 'dired)
3006 (defun dired-flag-garbage-files ()
3007 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3008 (interactive)
3009 (dired-flag-files-regexp dired-garbage-files-regexp))
3011 (defun dired-flag-backup-files (&optional unflag-p)
3012 "Flag all backup files (names ending with `~') for deletion.
3013 With prefix argument, unflag these files."
3014 (interactive "P")
3015 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
3016 (dired-mark-if
3017 ;; Don't call backup-file-name-p unless the last character looks like
3018 ;; it might be the end of a backup file name. This isn't very general,
3019 ;; but it's the only way this runs fast enough.
3020 (and (save-excursion (end-of-line)
3021 ;; Handle executables in case of -F option.
3022 ;; We need not worry about the other kinds
3023 ;; of markings that -F makes, since they won't
3024 ;; appear on real backup files.
3025 (if (eq (preceding-char) ?*)
3026 (forward-char -1))
3027 (eq (preceding-char) ?~))
3028 (not (looking-at dired-re-dir))
3029 (let ((fn (dired-get-filename t t)))
3030 (if fn (backup-file-name-p fn))))
3031 "backup file")))
3033 (defun dired-change-marks (&optional old new)
3034 "Change all OLD marks to NEW marks.
3035 OLD and NEW are both characters used to mark files."
3036 (interactive
3037 (let* ((cursor-in-echo-area t)
3038 (old (progn (message "Change (old mark): ") (read-char)))
3039 (new (progn (message "Change %c marks to (new mark): " old)
3040 (read-char))))
3041 (list old new)))
3043 (ding)
3045 (inhibit-read-only t))
3046 (save-excursion
3047 (goto-char (point-min))
3048 (while (search-forward string nil t)
3049 (if (if (= old ?\s)
3050 (save-match-data
3051 (dired-get-filename 'no-dir t))
3052 t)
3053 (subst-char-in-region (match-beginning 0)
3054 (match-end 0) old new)))))))
3056 (defun dired-unmark-all-marks ()
3057 "Remove all marks from all files in the dired buffer."
3058 (interactive)
3061 (defun dired-unmark-all-files (mark &optional arg)
3062 "Remove a specific mark (or any mark) from every file.
3063 After this command, type the mark character to remove,
3064 or type RET to remove all marks.
3065 With prefix arg, query for each marked file.
3068 (save-excursion
3069 (let* ((count 0)
3070 (inhibit-read-only t) case-fold-search query
3072 (help-form "\
3073 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3074 `!' to unmark all remaining files with no more questions."))
3075 (goto-char (point-min))
3077 (re-search-forward dired-re-mark nil t)
3078 (search-forward string nil t))
3079 (if (or (not arg)
3080 (let ((file (dired-get-filename t t)))
3081 (and file
3082 (dired-query 'query "Unmark file `%s'? "
3083 file))))
3084 (progn (subst-char-in-region (1- (point)) (point)
3085 (preceding-char) ?\s)
3086 (setq count (1+ count)))))
3087 (message (if (= count 1) "1 mark removed"
3088 "%d marks removed")
3089 count))))
3090 \f
3091 ;; Logging failures operating on files, and showing the results.
3093 (defvar dired-log-buffer "*Dired log*")
3095 (defun dired-why ()
3096 "Pop up a buffer with error log output from Dired.
3097 A group of errors from a single command ends with a formfeed.
3099 (interactive)
3100 (if (get-buffer dired-log-buffer)
3101 (let ((owindow (selected-window))
3102 (window (display-buffer (get-buffer dired-log-buffer))))
3103 (unwind-protect
3104 (progn
3105 (select-window window)
3106 (goto-char (point-max))
3107 (forward-line -1)
3108 (backward-page 1)
3109 (recenter 0))
3110 (select-window owindow)))))
3112 (defun dired-log (log &rest args)
3113 ;; Log a message or the contents of a buffer.
3114 ;; If LOG is a string and there are more args, it is formatted with
3116 ;; End each bunch of errors with (dired-log t):
3117 ;; this inserts the current time and buffer at the start of the page,
3119 (let ((obuf (current-buffer)))
3120 (with-current-buffer (get-buffer-create dired-log-buffer)
3121 (goto-char (point-max))
3122 (let ((inhibit-read-only t))
3123 (cond ((stringp log)
3124 (insert (if args
3125 (apply (function format) log args)
3126 log)))
3127 ((bufferp log)
3128 (insert-buffer-substring log))
3129 ((eq t log)
3130 (backward-page 1)
3131 (unless (bolp)
3133 (insert (current-time-string)
3135 (goto-char (point-max))
3138 (defun dired-log-summary (string failures)
3139 "State a summary of a command's failures, in echo area and log buffer.
3140 STRING is an overall summary of the failures.
3141 FAILURES is a list of file names that we failed to operate on,
3142 or nil if file names are not applicable."
3143 (if (= (length failures) 1)
3144 (message "%s"
3145 (with-current-buffer dired-log-buffer
3146 (goto-char (point-max))
3147 (backward-page 1)
3148 (if (eolp) (forward-line 1))
3149 (buffer-substring (point) (point-max))))
3150 (message (if failures "%s--type ? for details (%s)"
3151 "%s--type ? for details")
3152 string failures))
3153 ;; Log a summary describing a bunch of errors.
3155 (dired-log t))
3156 \f
3157 ;;; Sorting
3159 ;; Most ls can only sort by name or by date (with -t), nothing else.
3160 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3161 ;; So anything that does not contain these is sort "by name".
3163 (defvar dired-ls-sorting-switches "SXU"
3166 This indicates to Dired which option switches to watch out for because they
3167 will change the sorting order behavior of `ls'.
3169 To change the default sorting order \(e.g. add a `-v' option\), see the
3170 variable `dired-listing-switches'. To temporarily override the listing
3173 (defvar dired-sort-by-date-regexp
3174 (concat "^-[^" dired-ls-sorting-switches
3175 "]*t[^" dired-ls-sorting-switches "]*$")
3176 "Regexp recognized by Dired to set `by date' mode.")
3178 (defvar dired-sort-by-name-regexp
3179 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3180 "Regexp recognized by Dired to set `by name' mode.")
3182 (defvar dired-sort-inhibit nil
3183 "Non-nil means the Dired sort command is disabled.
3184 The idea is to set this buffer-locally in special dired buffers.")
3186 (defun dired-sort-set-modeline ()
3187 ;; Set modeline display according to dired-actual-switches.
3188 ;; Modeline display of "by name" or "by date" guarantees the user a
3189 ;; match with the corresponding regexps. Non-matching switches are
3190 ;; shown literally.
3191 (when (eq major-mode 'dired-mode)
3192 (setq mode-name
3193 (let (case-fold-search)
3194 (cond ((string-match
3195 dired-sort-by-name-regexp dired-actual-switches)
3196 "Dired by name")
3197 ((string-match
3198 dired-sort-by-date-regexp dired-actual-switches)
3199 "Dired by date")
3200 (t
3201 (concat "Dired " dired-actual-switches)))))
3202 (force-mode-line-update)))
3204 (defun dired-sort-toggle-or-edit (&optional arg)
3205 "Toggle between sort by date/name and refresh the dired buffer.
3206 With a prefix argument you can edit the current listing switches instead."
3207 (interactive "P")
3208 (when dired-sort-inhibit
3209 (error "Cannot sort this dired buffer"))
3210 (if arg
3211 (dired-sort-other
3212 (read-string "ls switches (must contain -l): " dired-actual-switches))
3213 (dired-sort-toggle)))
3215 (defun dired-sort-toggle ()
3216 ;; Toggle between sort by date/name. Reverts the buffer.
3217 (setq dired-actual-switches
3218 (let (case-fold-search)
3219 (if (string-match " " dired-actual-switches)
3220 ;; New toggle scheme: add/remove a trailing " -t"
3222 (substring dired-actual-switches 0 (match-beginning 0))
3223 (concat dired-actual-switches " -t"))
3224 ;; old toggle scheme: look for some 't' switch and add/remove it
3225 (concat
3226 "-l"
3227 (dired-replace-in-string (concat "[-lt"
3228 dired-ls-sorting-switches "]")
3229 ""
3230 dired-actual-switches)
3231 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3232 dired-actual-switches)
3233 ""
3234 "t")))))
3235 (dired-sort-set-modeline)
3236 (revert-buffer))
3238 ;; Some user code loads dired especially for this.
3239 ;; Don't do that--use replace-regexp-in-string instead.
3240 (defun dired-replace-in-string (regexp newtext string)
3241 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3243 (let ((result "") (start 0) mb me)
3244 (while (string-match regexp string start)
3245 (setq mb (match-beginning 0)
3246 me (match-end 0)
3247 result (concat result (substring string start mb) newtext)
3248 start me))
3249 (concat result (substring string start))))
3251 (defun dired-sort-other (switches &optional no-revert)
3252 "Specify new `ls' SWITCHES for current dired buffer.
3253 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3254 set the minor mode accordingly, others appear literally in the mode line.
3255 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3256 (dired-sort-R-check switches)
3257 (setq dired-actual-switches switches)
3258 (dired-sort-set-modeline)
3259 (or no-revert (revert-buffer)))
3261 (defvar dired-subdir-alist-pre-R nil
3262 "Value of `dired-subdir-alist' before -R switch added.")
3263 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3265 (defun dired-sort-R-check (switches)
3266 "Additional processing of -R in ls option string SWITCHES.
3267 Saves `dired-subdir-alist' when R is set and restores saved value
3268 minus any directories explicitly deleted when R is cleared.
3269 To be called first in body of `dired-sort-other', etc."
3270 (cond
3271 ((and (string-match "R" switches)
3272 (not (string-match "R" dired-actual-switches)))
3273 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3274 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3275 ((and (string-match "R" dired-actual-switches)
3276 (not (string-match "R" switches)))
3277 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3278 ;; that are still present:
3279 (setq dired-subdir-alist
3280 (if dired-subdir-alist-pre-R
3281 (let (subdirs)
3282 (while dired-subdir-alist-pre-R
3283 (if (assoc (caar dired-subdir-alist-pre-R)
3284 dired-subdir-alist)
3285 ;; subdir still present...
3286 (setq subdirs
3287 (cons (car dired-subdir-alist-pre-R)
3288 subdirs)))
3289 (setq dired-subdir-alist-pre-R
3290 (cdr dired-subdir-alist-pre-R)))
3291 (reverse subdirs))
3292 ;; No pre-R subdir alist, so revert to main directory
3293 ;; listing:
3294 (list (car (reverse dired-subdir-alist))))))))
3295 \f
3297 ;;;; Drag and drop support
3299 (defcustom dired-recursive-copies 'top
3300 "Decide whether recursive copies are allowed.
3301 A value of nil means no recursive copies.
3302 `always' means copy recursively without asking.
3303 `top' means ask for each directory at top level.
3304 Anything else means ask for each directory."
3305 :type '(choice :tag "Copy directories"
3306 (const :tag "No recursive copies" nil)
3307 (const :tag "Ask for each directory" t)
3308 (const :tag "Ask for each top directory only" top)
3309 (const :tag "Copy directories without asking" always))
3310 :group 'dired)
3312 (defun dired-dnd-popup-notice ()
3313 (message-box
3316 (declare-function x-popup-menu "xmenu.c" (position menu))
3318 (defun dired-dnd-do-ask-action (uri)
3319 ;; No need to get actions and descriptions from the source,
3320 ;; we only have three actions anyway.
3321 (let ((action (x-popup-menu
3322 t
3323 (list "What action?"
3324 (cons ""
3325 '(("Copy here" . copy)
3326 ("Move here" . move)
3327 ("Link here" . link)
3328 "--"
3329 ("Cancel" . nil)))))))
3330 (if action
3331 (dired-dnd-handle-local-file uri action)
3332 nil)))
3334 (declare-function dired-relist-entry "dired-aux" (file))
3335 (declare-function make-symbolic-link "fileio.c")
3337 ;; Only used when (featurep 'dnd).
3338 (declare-function dnd-get-local-file-name "dnd" (uri &optional must-exist))
3339 (declare-function dnd-get-local-file-uri "dnd" (uri))
3341 (defun dired-dnd-handle-local-file (uri action)
3342 "Copy, move or link a file to the dired directory.
3343 URI is the file to handle, ACTION is one of copy, move, link or ask.
3344 Ask means pop up a menu for the user to select one of copy, move or link."
3345 (require 'dired-aux)
3346 (let* ((from (dnd-get-local-file-name uri t))
3347 (to (when from
3348 (concat (dired-current-directory)
3349 (file-name-nondirectory from)))))
3350 (when from
3351 (cond ((eq action 'ask)
3352 (dired-dnd-do-ask-action uri))
3353 ;; If copying a directory and dired-recursive-copies is
3354 ;; nil, dired-copy-file fails. Pop up a notice.
3355 ((and (memq action '(copy private))
3356 (file-directory-p from)
3357 (not dired-recursive-copies))
3358 (dired-dnd-popup-notice))
3359 ((memq action '(copy private move link))
3360 (let ((overwrite (and (file-exists-p to)
3361 (y-or-n-p
3362 (format "Overwrite existing file `%s'? " to))))
3363 ;; Binding dired-overwrite-confirmed to nil makes
3364 ;; dired-handle-overwrite a no-op. We instead use
3365 ;; y-or-n-p, which pops a graphical menu.
3366 dired-overwrite-confirmed backup-file)
3367 (when (and overwrite
3368 ;; d-b-o is defined in dired-aux.
3369 (boundp 'dired-backup-overwrite)
3370 dired-backup-overwrite
3371 (setq backup-file
3372 (car (find-backup-file-name to)))
3373 (or (eq dired-backup-overwrite 'always)
3374 (y-or-n-p
3375 (format
3376 "Make backup for existing file `%s'? " to))))
3377 (rename-file to backup-file 0)
3378 (dired-relist-entry backup-file))
3379 (cond ((memq action '(copy private))
3380 (dired-copy-file from to overwrite))
3381 ((eq action 'move)
3382 (dired-rename-file from to overwrite))
3383 ((eq action 'link)
3384 (make-symbolic-link from to overwrite)))
3385 (dired-relist-entry to)
3386 action))))))
3388 (defun dired-dnd-handle-file (uri action)
3389 "Copy, move or link a file to the dired directory if it is a local file.
3390 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3391 ACTION is one of copy, move, link or ask.
3392 Ask means pop up a menu for the user to select one of copy, move or link."
3393 (let ((local-file (dnd-get-local-file-uri uri)))
3394 (if local-file (dired-dnd-handle-local-file local-file action)
3395 nil)))
3396 \f
3398 ;;;; Desktop support
3400 (eval-when-compile (require 'desktop))
3402 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3403 "Auxiliary information to be saved in desktop file."
3404 (cons
3405 ;; Value of `dired-directory'.
3406 (if (consp dired-directory)
3407 ;; Directory name followed by list of files.
3408 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3409 (cdr dired-directory))
3410 ;; Directory name, optionally with shell wildcard.
3411 (desktop-file-name dired-directory desktop-dirname))
3412 ;; Subdirectories in `dired-subdir-alist'.
3413 (cdr
3414 (nreverse
3415 (mapcar
3416 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3417 dired-subdir-alist)))))
3419 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3420 desktop-buffer-name
3421 desktop-buffer-misc)
3422 "Restore a dired buffer specified in a desktop file."
3423 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3424 ;; This value is a directory name, optionally with shell wildcard or
3425 ;; a directory name followed by list of files.
3426 (let* ((dired-dir (car desktop-buffer-misc))
3427 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3428 (if (file-directory-p (file-name-directory dir))
3429 (progn
3430 (dired dired-dir)
3431 ;; The following elements of `desktop-buffer-misc' are the keys
3432 ;; from `dired-subdir-alist'.
3433 (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3434 (current-buffer))
3435 (message "Desktop: Directory %s no longer exists." dir)
3436 (when desktop-missing-file-warning (sit-for 1))
3437 nil)))
3439 (add-to-list 'desktop-buffer-mode-handlers
3440 '(dired-mode . dired-restore-desktop-buffer))
3442 \f
3443 (provide 'dired)
3445 (run-hooks 'dired-load-hook) ; for your customizations
3447 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3448 ;;; dired.el ends here