| blob | fc13c7281c113e3823a3eddc1014d7676cc01141 |
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, 2009
5 ;; Free Software Foundation, Inc.
7 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
8 ;; Maintainer: FSF
9 ;; Keywords: files
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This is a major mode for directory browsing and editing. It is
29 ;; documented in the Emacs manual.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
39 ;;; Customizable variables
42 "Directory editing."
47 "Handling marks in Dired."
52 ;;;###autoload
54 "Switches passed to `ls' for Dired. MUST contain the `l' option.
55 May contain all other options that don't contradict `-l';
56 may contain even `F', `b', `i' and `s'. See also the variable
57 `dired-ls-F-marks-symlinks' concerning the `F' switch.
58 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
59 some of the `ls' switches are not supported; see the doc string of
60 `insert-directory' in `ls-lisp.el' for more details."
65 "If non-nil, switches passed to `ls' for inserting subdirectories.
68 ; Don't use absolute file names as /bin should be in any PATH and people
69 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
70 ; usually not in PATH.
72 ;;;###autoload
75 "chown"
77 "/usr/sbin/chown"
90 ;;;###autoload
92 "Informs Dired about how `ls -lF' marks symbolic links.
93 Set this to t if `ls' (or whatever program is specified by
94 `insert-directory-program') with `-lF' marks the symbolic link
95 itself with a trailing @ (usually the case under Ultrix).
97 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
98 nil (the default), if it gives `bar@ -> foo', set it to t.
100 Dired checks if there is really a @ appended. Thus, if you have a
101 marking `ls' program on one host and a non-marking on another host, and
102 don't care about symbolic links which really end in a @, you can
103 always set this variable to t."
107 ;;;###autoload
109 "Regexp of files to skip when finding first file of a directory.
110 A value of nil means move to the subdir line.
111 A value of t means move to first file."
114 regexp)
117 ;;;###autoload
119 ;; Use t as default so that moved files "take their markers with them".
120 "Controls marking of renamed files.
121 If t, files keep their previous marks when they are renamed.
122 If a character, renamed files (whether previously marked or not)
123 are afterward marked with that character."
128 ;;;###autoload
130 "Controls marking of copied files.
131 If t, copied files are marked if and as the corresponding original files were.
132 If a character, copied files are unconditionally marked with that character."
137 ;;;###autoload
139 "Controls marking of newly made hard links.
140 If t, they are marked if and as the files linked to were marked.
141 If a character, new links are unconditionally marked with that character."
146 ;;;###autoload
148 "Controls marking of newly made symbolic links.
149 If t, they are marked if and as the files linked to were marked.
150 If a character, new links are unconditionally marked with that character."
155 ;;;###autoload
157 "If non-nil, Dired tries to guess a default target directory.
158 This means: if there is a dired buffer displayed in the next window,
159 use its current subdir, instead of the current subdir of this dired buffer.
161 The target is used in the prompt for file copy, rename etc."
165 ;;;###autoload
167 "If non-nil, Dired preserves the last-modified time in a file copy.
168 \(This works on only some systems.)"
172 ; These variables were deleted and the replacements are on files.el.
173 ; We leave aliases behind for back-compatibility.
177 ;;; Hook variables
180 "Run after loading Dired.
181 You can customize key bindings or load extensions with this."
186 "Run at the very end of `dired-mode'."
191 "This hook is run before a dired buffer is read in (created or reverted)."
196 "Hook run after each time a file or directory is read by Dired.
197 After each listing of a file or directory, this hook is run
198 with the buffer narrowed to the listing."
201 ;; Note this can't simply be run inside function `dired-ls' as the hook
202 ;; functions probably depend on the dired-subdir-alist to be OK.
208 "The functions to call when a drop in `dired-mode' is made.
209 See `dnd-protocol-alist' for more information. When nil, behave
210 as in other buffers. Changing this option is effective only for
211 new dired buffers."
217 ;; Internal variables
220 ;; so that you can write things like
221 ;; (let ((dired-marker-char ?X))
222 ;; ;; great code using X markers ...
223 ;; )
224 ;; For example, commands operating on two sets of files, A and B.
225 ;; Or marking files with digits 0-9. This could implicate
226 ;; concentric sets or an order for the marked files.
227 ;; The code depends on dynamic scoping on the marker char.
228 "In Dired, the current mark character.
235 ;; I see no reason ever to make this nil -- rms.
236 ;; (> baud-rate search-slow-speed)
243 ;;;###autoload
245 "The directory name or wildcard spec that this dired directory lists.
246 Local to each dired buffer. May be a list, in which case the car is the
247 directory name and the cdr is the list of files to mention.
256 ;; These regexps must be tested at beginning-of-line, but are also
257 ;; used to search for next matches, so neither omitting "^" nor
258 ;; replacing "^" by "\n" (to make it slightly faster) will work.
261 ;; "Regexp matching a marked line.
262 ;; Important: the match ends just after the marker."
264 ;; The [^:] part after "d" and "l" is to avoid confusion with the
265 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
273 "-[-r][-w].[-r][-w][xs][-r][-w]."
279 ;; The subdirectory names in the next two lists are expanded.
281 "Association list of subdirectories and their buffer positions.
282 Each subdirectory has an element: (DIRNAME . STARTMARKER).
283 The order of elements is the reverse of the order in the buffer.
287 "Keeps track of which switches to use for inserted subdirectories.
295 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
296 Subexpression 1 is the subdirectory proper, no trailing colon.
297 The match starts at the beginning of the line and ends after the end
302 "Faces used by Dired."
308 "Face used for directory headers."
316 "Face used for dired marks."
324 "Face used for marked files."
332 "Face used for flagged files."
339 ;; Inherit from font-lock-warning-face since with min-colors 8
340 ;; font-lock-comment-face is not colored any more.
342 "Face used to highlight a part of a buffer that needs user attention."
350 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
351 ;; font-lock-comment-face is not colored any more.
353 "Face used to highlight permissions of group- and world-writable files."
361 "Face used for subdirectories."
369 "Face used for symbolic links."
377 "Face used for files suffixed with `completion-ignored-extensions'."
385 ;;
386 ;; Dired marks.
388 ;;
389 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
390 ;; file name itself. We search for Dired defined regexps, and then use the
391 ;; Dired defined function `dired-move-to-filename' before searching for the
392 ;; simple regexp ".+". It is that regexp which matches the file name.
393 ;;
394 ;; Marked files.
397 ;;
398 ;; Flagged files.
401 ;; People who are paranoid about security would consider this more
402 ;; important than other things such as whether it is a directory.
403 ;; But we don't want to encourage paranoia, so our default
404 ;; should be what's most useful for non-paranoids. -- rms.
405 ;;; ;;
406 ;;; ;; Files that are group or world writable.
407 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
408 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
409 ;;; '(1 dired-warning-face)
410 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
411 ;; However, we don't need to highlight the file name, only the
412 ;; permissions, to win generally. -- fx.
413 ;; Fixme: we could also put text properties on the permission
414 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
421 ;;
422 ;; Subdirectories.
425 ;;
426 ;; Symbolic links.
429 ;;
430 ;; Files suffixed with `completion-ignored-extensions'.
432 ;; It is quicker to first find just an extension, then go back to the
433 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
436 ;;
437 ;; Files suffixed with `completion-ignored-extensions'
438 ;; plus a character put in by -F.
444 ;; If the last character is not part of the filename,
445 ;; move back to the start of the filename
446 ;; so it can be fontified.
447 ;; Otherwise, leave point at the end of the line;
448 ;; that way, nothing is fontified.
452 ;;
453 ;; Explicitly put the default face on file names ending in a colon to
454 ;; avoid fontifying them as directory header.
457 ;;
458 ;; Directory headers.
460 )
464 \f
465 ;;; Macros must be defined before they are used, for the byte compiler.
468 "Mark all files for which PREDICATE evals to non-nil.
469 PREDICATE is evaluated on each line, with point at beginning of line.
470 MSG is a noun phrase for the type of files being marked.
471 It should end with a noun that can be pluralized by adding `s'.
472 Return value is the number of files marked, or nil if none were marked."
486 count
487 ,msg
495 distinguish-one-marked)
496 "Eval BODY with point on each marked line. Return a list of BODY's results.
497 If no marked file could be found, execute BODY on the current line.
498 ARG, if non-nil, specifies the files to use instead of the marked files.
499 If ARG is an integer, use the next ARG (or previous -ARG, if
500 ARG<0) files. In that case, point is dragged along. This is
501 so that commands on the next ARG (instead of the marked) files
502 can be chained easily.
503 For any other non-nil value of ARG, use the current file.
504 If optional third arg SHOW-PROGRESS evaluates to non-nil,
505 redisplay the dired buffer after each file is processed.
506 No guarantee is made about the position on the marked line.
507 BODY must ensure this itself if it depends on this.
508 Search starts at the beginning of the buffer, thus the car of the list
509 corresponds to the line nearest to the buffer's bottom. This
510 is also true for (positive and negative) integer values of ARG.
511 BODY should not be too long as it is expanded four times.
513 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
514 return (t FILENAME) instead of (FILENAME)."
515 ;;
516 ;;Warning: BODY must not add new lines before point - this may cause an
517 ;;endless loop.
518 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
525 ,arg
531 results))
532 ;; non-nil, non-integer ARG means use current file:
537 ;; remember position of next marked file before BODY
538 ;; can insert lines before the just found file,
539 ;; confusing us by finding the same marked file again
540 ;; and again and...
548 ;; move after last match
557 results
559 ;; save-excursion loses, again
563 "Return the marked files' names as list of strings.
564 The list is in the same order as the buffer, that is, the car is the
565 first marked file.
566 Values returned are normally absolute file names.
567 Optional arg LOCALP as in `dired-get-filename'.
568 Optional second argument ARG, if non-nil, specifies files near
569 point instead of marked files. It usually comes from the prefix
570 argument.
571 If ARG is an integer, use the next ARG files.
572 Any other non-nil value means to use the current file instead.
573 Optional third argument FILTER, if non-nil, is a function to select
574 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
576 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
577 return (t FILENAME) instead of (FILENAME).
578 Don't use that together with FILTER."
583 arg nil distinguish-one-marked)))
584 result)
587 all-of-them
592 result)))
593 \f
594 ;; The dired command
597 ;; For use in interactive.
601 dired-listing-switches))
602 ;; If a dialog is about to be used, call read-directory-name so
603 ;; the dialog code knows we want directories. Some dialogs can
604 ;; only select directories or files when popped up, not both.
607 nil default-directory nil)
613 nil default-directory nil)))))))
615 ;; We want to switch to a more sophisticated version of
616 ;; dired-read-dir-and-switches like the following, if there is a way
617 ;; to make it more intuitive. See bug#1285.
619 ;; (defun dired-read-dir-and-switches (str)
620 ;; ;; For use in interactive.
621 ;; (reverse
622 ;; (list
623 ;; (if current-prefix-arg
624 ;; (read-string "Dired listing switches: "
625 ;; dired-listing-switches))
626 ;; ;; If a dialog is about to be used, call read-directory-name so
627 ;; ;; the dialog code knows we want directories. Some dialogs can
628 ;; ;; only select directories or files when popped up, not both.
629 ;; (if (next-read-file-uses-dialog-p)
630 ;; (read-directory-name (format "Dired %s(directory): " str)
631 ;; nil default-directory nil)
632 ;; (let ((cie ()))
633 ;; (dolist (ext completion-ignored-extensions)
634 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
635 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
636 ;; (lexical-let* ((default (and buffer-file-name
637 ;; (abbreviate-file-name buffer-file-name)))
638 ;; (cie cie)
639 ;; (completion-table
640 ;; ;; We need a mix of read-file-name and
641 ;; ;; read-directory-name so that completion to directories
642 ;; ;; is preferred, but if the user wants to enter a global
643 ;; ;; pattern, he can still use completion on filenames to
644 ;; ;; help him write the pattern.
645 ;; ;; Essentially, we want to use
646 ;; ;; (completion-table-with-predicate
647 ;; ;; 'read-file-name-internal 'file-directory-p nil)
648 ;; ;; but that doesn't work because read-file-name-internal
649 ;; ;; does not obey its `predicate' argument.
650 ;; (completion-table-in-turn
651 ;; (lambda (str pred action)
652 ;; (let ((read-file-name-predicate
653 ;; (lambda (f)
654 ;; (and (not (member f '("./" "../")))
655 ;; ;; Hack! Faster than file-directory-p!
656 ;; (eq (aref f (1- (length f))) ?/)
657 ;; (not (string-match cie f))))))
658 ;; (complete-with-action
659 ;; action 'read-file-name-internal str nil)))
660 ;; 'read-file-name-internal)))
661 ;; (minibuffer-with-setup-hook
662 ;; (lambda ()
663 ;; (setq minibuffer-default default)
664 ;; (setq minibuffer-completion-table completion-table))
665 ;; (read-file-name (format "Dired %s(directory): " str)
666 ;; nil default-directory nil))))))))
668 ;;;###autoload (define-key ctl-x-map "d" 'dired)
669 ;;;###autoload
672 Optional second argument SWITCHES specifies the `ls' options used.
673 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
674 Dired displays a list of files in DIRNAME (which may also have
675 shell wildcards appended to select certain files). If DIRNAME is a cons,
676 its first element is taken as the directory name and the rest as an explicit
677 list of files to make directory entries for.
679 You can move around in it with the usual commands.
684 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
685 ;; Cannot use (interactive "D") because of wildcards.
689 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
690 ;;;###autoload
696 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
697 ;;;###autoload
703 ;;;###autoload
705 "Like `dired' but returns the dired buffer as value, does not select it."
707 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
708 ;; some shells make:
719 ;; If the argument was syntactically a directory name not a file name,
720 ;; or if it happens to name a file that is a directory,
721 ;; convert it syntactically to a directory name.
722 ;; The reason for checking initially-was-dirname
723 ;; and not just file-directory-p
724 ;; is that file-directory-p is slow over ftp.
732 ;; The following is an internal dired function. It returns non-nil if
733 ;; the directory visited by the current dired buffer has changed on
734 ;; disk. DIRNAME should be the directory name of that directory.
743 "Return non-nil if current dired buffer needs updating.
744 If NOCONFIRM is non-nil, then this function always returns nil
745 for a remote directory. This feature is used by Auto Revert Mode."
751 ;; Do not auto-revert when the dired buffer can be currently
752 ;; written by the user as in `wdired-mode'.
753 buffer-read-only
757 ;; If there is an existing dired buffer for DIRNAME, just leave
758 ;; buffer as it is (don't even call dired-revert).
759 ;; This saves time especially for deep trees or with ange-ftp.
760 ;; The user can type `g' easily, and it is more consistent with find-file.
761 ;; But if SWITCHES are given they are probably different from the
762 ;; buffer's old value, so call dired-sort-other, which does
763 ;; revert the buffer.
764 ;; A pity we can't possibly do "Directory has changed - refresh? "
765 ;; like find-file does.
766 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
767 ;; see there.
769 buffer
770 ;; note that buffer already is in dired-mode, if found
771 new-buffer-p
776 ;; Look for an existing buffer.
781 ;; We don't want default-major-mode to run hooks and set auto-fill
782 ;; or whatever, now that dired-mode does not
783 ;; kill-all-local-variables any longer.
788 ;; file list may have changed
790 ;; this calls dired-revert
792 ;; If directory has changed on disk, offer to revert.
797 ;; Else a new buffer
799 ;; We can do this unconditionally
800 ;; because dired-noselect ensures that the name
801 ;; is passed in directory name syntax
802 ;; if it was the name of a directory at all.
807 ;; default-directory and dired-actual-switches are set now
808 ;; (buffer-local), so we can call dired-readin:
813 ;; dired-readin can fail if parent directories are inaccessible.
814 ;; Don't leave an empty buffer around in that case.
819 buffer))
822 ;; Enlarged by dired-advertise
823 ;; Queried by function dired-buffers-for-dir. When this detects a
824 ;; killed buffer, it is removed from this list.
828 ;; This differs from dired-buffers-for-dir in that it does not consider
829 ;; subdirs of default-directory and searches for the first match only.
830 ;; Also, the major mode must be MODE.
840 dired-directory ;; nil during find-alternate-file
845 dired-directory))))
847 blist nil)
849 found))
851 \f
852 ;; Read in a new dired buffer
855 "Read in a new dired buffer.
856 Differs from `dired-insert-subdir' in that it accepts
857 wildcards, erases the buffer, and builds the subdir-alist anew
858 \(including making it buffer-local and clearing it first)."
860 ;; default-directory and dired-actual-switches must be buffer-local
861 ;; and initialized by now.
863 ;; This makes readin much much faster.
864 ;; In particular, it prevents the font lock hook from running
865 ;; until the directory is all read in.
872 ;; This hook which may want to modify dired-actual-switches
873 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
874 ;; where ls won't understand -Al switches.
882 ;; Don't make undo entries for readin.
888 ;; Must first make alist buffer local and set it to nil because
889 ;; dired-build-subdir-alist will call dired-clear-alist first
896 ;; No need to narrow since the whole buffer contains just
897 ;; dired-readin's output, nothing else. The hook can
898 ;; successfully use dired functions (e.g. dired-get-filename)
899 ;; as the subdir-alist has been built in dired-readin.
902 ;; Subroutines of dired-readin
905 ;; Insert listing for the specified dir (and maybe file list)
906 ;; already in dired-directory, assuming a clean buffer.
912 file-list nil))
916 ;; If we are reading a whole single directory...
921 ;; Else treat it as a wildcard spec
922 ;; unless we have an explicit list of files.
927 "Align the fields of a file to the ones of surrounding lines.
928 BEG..END is the line where the file info is located."
929 ;; Some versions of ls try to adjust the size of each field so as to just
930 ;; hold the largest element ("largest" in the current invocation, of
931 ;; course). So when a single line is output, the size of each field is
932 ;; just big enough for that one output. Thus when dired refreshes one
933 ;; line, the alignment if this line w.r.t the rest is messed up because
934 ;; the fields of that one line will generally be smaller.
935 ;;
936 ;; To work around this problem, we here add spaces to try and
937 ;; re-align the fields as needed. Since this is purely aesthetic,
938 ;; it is of utmost importance that it doesn't mess up anything like
939 ;; `dired-move-to-filename'. To this end, we limit ourselves to
940 ;; adding spaces only, and to only add them at places where there
941 ;; was already at least one space. This way, as long as
942 ;; `directory-listing-before-filename-regexp' always matches spaces
943 ;; with "*" or "+", we know we haven't made anything worse. There
944 ;; is one spot where the exact number of spaces is important, which
945 ;; is just before the actual filename, so we refrain from adding
946 ;; spaces there (and within the filename as well, of course).
949 ;; Check the there is indeed a file, and that there is anoter adjacent
950 ;; file with which to align, and that additional spaces are needed to
951 ;; align the filenames.
964 ;; Make sure there is some work left to do.
966 ;; If we've only looked at the line above, check to see if the line
967 ;; below exists as well and if so, align with the shorter one.
976 ;; Keep positions uptodate when we insert stuff.
979 ;; Main loop.
983 ;; Don't touch anything just before (and after) the
984 ;; beginning of the filename.
986 ;; We're now just in front of a field, with a space behind us.
988 ;; Nums are right-aligned.
990 ;; Let's look at the other line, in the same column: we
991 ;; should be either near the end of the previous field, or
992 ;; in the space between that field and the next.
993 ;; [ Of course, it's also possible that we're already within
994 ;; the next field or even past it, but that's unlikely since
995 ;; other-col > file-col. ]
996 ;; Let's find the distance to the alignment-point (either
997 ;; the beginning or the end of the next field, depending on
998 ;; whether this field is left or right aligned).
1008 ;; Now, the number of spaces to insert is align-pt-offset
1009 ;; minus the distance to the equivalent point on the
1010 ;; current line.
1013 align-pt-offset
1023 ;; Let's just make really sure we did not mess up.
1026 ;; Damn! We messed up: let's revert the change.
1028 ;; Now skip to next field.
1034 "Insert a directory listing of DIR, Dired style.
1035 Use SWITCHES to make the listings.
1036 If FILE-LIST is non-nil, list only those files.
1037 Otherwise, if WILDCARD is non-nil, expand wildcards;
1038 in that case, DIR should be a file name that uses wildcards.
1039 In other cases, DIR should be a directory name or a directory filename.
1040 If HDR is non-nil, insert a header line with the directory name."
1043 end)
1046 ;; We used to specify the C locale here, to force English month names;
1047 ;; but this should not be necessary any more,
1048 ;; with the new value of `directory-listing-before-filename-regexp'.
1053 ;; Re-align fields, if necessary.
1056 ;; Quote certain characters, unless ls quoted them for us.
1065 nil t))
1071 nil t))
1074 ;; If we used --dired and it worked, the lines are already indented.
1075 ;; Otherwise, indent them.
1081 ;; Insert text at the beginning to standardize things.
1087 ;; Note that dired-build-subdir-alist will replace the name
1088 ;; by its expansion, so it does not matter whether what we insert
1089 ;; here is fully expanded, but it should be absolute.
1092 ;; Insert "wildcard" line where "total" line would be for a full dir.
1096 "Make the file names highlight when the mouse is on them."
1108 dired-filename t
1112 \f
1113 ;; Reverting a dired buffer
1116 "Reread the dired buffer.
1117 Must also be called after `dired-actual-switches' have changed.
1118 Should not fail even on completely garbaged buffers.
1119 Preserves old cursor, marks/flags, hidden-p."
1132 ;; treat top level dir extra (it may contain wildcards)
1135 ;; Run dired-after-readin-hook just once, below.
1140 ;; ... run the hook for the whole buffer, and only after markers
1141 ;; have been reinserted (else omitting in dired-x would omit marked files)
1151 ;; outside of the let scope
1152 ;;; Might as well not override the user if the user changed this.
1153 ;;; (setq buffer-read-only t)
1154 )
1156 ;; Subroutines of dired-revert
1157 ;; Some of these are also used when inserting subdirs.
1160 "Return alist of files and their marks, from BEG to END."
1171 alist))
1174 "Mark all files remembered in ALIST.
1175 Each element of ALIST looks like (FILE . MARKERCHAR)."
1189 "Return a list of names of subdirs currently hidden."
1199 result))
1202 "Try to insert all subdirs that were displayed before.
1203 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1217 "Remove directory DIR from any directory cache."
1221 \f
1222 ;; dired mode key bindings and initialization
1225 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1226 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1231 ;; Commands to mark or flag certain categories of files
1235 ;; Upper case keys (except !) for operating on the marked files
1254 ;; Comparison commands
1257 ;; Tree Dired commands
1263 ;; move to marked files
1266 ;; Make all regexp commands share a `%' prefix:
1267 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1268 ;; but that seems to serve little purpose, and copy-keymap
1269 ;; does a better job without it.
1282 ;; Commands for marking and unmarking.
1299 ;; Lower keys for commands not operating on all the marked files
1325 ;; moving
1333 (define-key map [up] 'dired-previous-line)
1334 ;; hiding
1335 (define-key map "$" 'dired-hide-subdir)
1336 (define-key map "\M-$" 'dired-hide-all)
1337 ;; isearch
1338 (define-key map (kbd "M-s a C-s") 'dired-do-isearch)
1339 (define-key map (kbd "M-s a M-C-s") 'dired-do-isearch-regexp)
1340 (define-key map (kbd "M-s f C-s") 'dired-isearch-filenames)
1341 (define-key map (kbd "M-s f M-C-s") 'dired-isearch-filenames-regexp)
1342 ;; misc
1343 (define-key map "\C-x\C-q" 'dired-toggle-read-only)
1344 (define-key map "?" 'dired-summary)
1346 (define-key map [remap undo] 'dired-undo)
1347 (define-key map [remap advertised-undo] 'dired-undo)
1348 ;; thumbnail manipulation (image-dired)
1349 (define-key map "\C-td" 'image-dired-display-thumbs)
1350 (define-key map "\C-tt" 'image-dired-tag-files)
1351 (define-key map "\C-tr" 'image-dired-delete-tag)
1352 (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1353 (define-key map "\C-ti" 'image-dired-dired-display-image)
1354 (define-key map "\C-tx" 'image-dired-dired-display-external)
1355 (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1356 (define-key map "\C-t." 'image-dired-display-thumb)
1357 (define-key map "\C-tc" 'image-dired-dired-comment-files)
1358 (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1359 (define-key map "\C-t\C-t" 'image-dired-dired-insert-marked-thumbs)
1360 (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1361 ;; encryption and decryption (epa-dired)
1362 (define-key map ":d" 'epa-dired-do-decrypt)
1363 (define-key map ":v" 'epa-dired-do-verify)
1364 (define-key map ":s" 'epa-dired-do-sign)
1365 (define-key map ":e" 'epa-dired-do-encrypt)
1367 ;; Make menu bar items.
1369 ;; No need to fo this, now that top-level items are fewer.
1370 ;;;;
1371 ;; Get rid of the Edit menu bar item to save space.
1372 ;(define-key map [menu-bar edit] 'undefined)
1374 (define-key map [menu-bar subdir]
1375 (cons "Subdir" (make-sparse-keymap "Subdir")))
1377 (define-key map [menu-bar subdir hide-all]
1378 '(menu-item "Hide All" dired-hide-all
1379 :help "Hide all subdirectories, leave only header lines"))
1380 (define-key map [menu-bar subdir hide-subdir]
1381 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1382 :help "Hide or unhide current directory listing"))
1383 (define-key map [menu-bar subdir tree-down]
1384 '(menu-item "Tree Down" dired-tree-down
1385 :help "Go to first subdirectory header down the tree"))
1386 (define-key map [menu-bar subdir tree-up]
1387 '(menu-item "Tree Up" dired-tree-up
1388 :help "Go to first subdirectory header up the tree"))
1389 (define-key map [menu-bar subdir up]
1390 '(menu-item "Up Directory" dired-up-directory
1391 :help "Edit the parent directory"))
1392 (define-key map [menu-bar subdir prev-subdir]
1393 '(menu-item "Prev Subdir" dired-prev-subdir
1394 :help "Go to previous subdirectory header line"))
1395 (define-key map [menu-bar subdir next-subdir]
1396 '(menu-item "Next Subdir" dired-next-subdir
1397 :help "Go to next subdirectory header line"))
1398 (define-key map [menu-bar subdir prev-dirline]
1399 '(menu-item "Prev Dirline" dired-prev-dirline
1400 :help "Move to next directory-file line"))
1401 (define-key map [menu-bar subdir next-dirline]
1402 '(menu-item "Next Dirline" dired-next-dirline
1403 :help "Move to previous directory-file line"))
1404 (define-key map [menu-bar subdir insert]
1405 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1406 :help "Insert contents of subdirectory"))
1408 (define-key map [menu-bar immediate]
1409 (cons "Immediate" (make-sparse-keymap "Immediate")))
1411 (define-key map
1412 [menu-bar immediate epa-dired-do-decrypt]
1413 '(menu-item "Decrypt" epa-dired-do-decrypt
1414 :help "Decrypt file at cursor"))
1416 (define-key map
1417 [menu-bar immediate epa-dired-do-verify]
1418 '(menu-item "Verify" epa-dired-do-verify
1419 :help "Verify digital signature of file at cursor"))
1421 (define-key map
1422 [menu-bar immediate epa-dired-do-sign]
1423 '(menu-item "Sign" epa-dired-do-sign
1424 :help "Create digital signature of file at cursor"))
1426 (define-key map
1427 [menu-bar immediate epa-dired-do-encrypt]
1428 '(menu-item "Encrypt" epa-dired-do-encrypt
1429 :help "Encrypt file at cursor"))
1431 (define-key map [menu-bar immediate dashes-4]
1432 '("--"))
1434 (define-key map
1435 [menu-bar immediate image-dired-dired-display-external]
1436 '(menu-item "Display Image Externally" image-dired-dired-display-external
1437 :help "Display image in external viewer"))
1438 (define-key map
1439 [menu-bar immediate image-dired-dired-display-image]
1440 '(menu-item "Display Image" image-dired-dired-display-image
1441 :help "Display sized image in a separate window"))
1443 (define-key map [menu-bar immediate dashes-4]
1444 '("--"))
1446 (define-key map [menu-bar immediate revert-buffer]
1447 '(menu-item "Refresh" revert-buffer
1448 :help "Update contents of shown directories"))
1450 (define-key map [menu-bar immediate dashes]
1451 '("--"))
1453 (define-key map [menu-bar immediate isearch-filenames-regexp]
1454 '(menu-item "Isearch Regexp in File Names..." dired-isearch-filenames-regexp
1455 :help "Incrementally search for regexp in file names only"))
1456 (define-key map [menu-bar immediate isearch-filenames]
1457 '(menu-item "Isearch in File Names..." dired-isearch-filenames
1458 :help "Incrementally search for string in file names only."))
1459 (define-key map [menu-bar immediate compare-directories]
1460 '(menu-item "Compare Directories..." dired-compare-directories
1461 :help "Mark files with different attributes in two dired buffers"))
1462 (define-key map [menu-bar immediate backup-diff]
1463 '(menu-item "Compare with Backup" dired-backup-diff
1464 :help "Diff file at cursor with its latest backup"))
1465 (define-key map [menu-bar immediate diff]
1466 '(menu-item "Diff..." dired-diff
1467 :help "Compare file at cursor with another file"))
1468 (define-key map [menu-bar immediate view]
1469 '(menu-item "View This File" dired-view-file
1470 :help "Examine file at cursor in read-only mode"))
1471 (define-key map [menu-bar immediate display]
1472 '(menu-item "Display in Other Window" dired-display-file
1473 :help "Display file at cursor in other window"))
1474 (define-key map [menu-bar immediate find-file-other-window]
1475 '(menu-item "Find in Other Window" dired-find-file-other-window
1476 :help "Edit file at cursor in other window"))
1477 (define-key map [menu-bar immediate find-file]
1478 '(menu-item "Find This File" dired-find-file
1479 :help "Edit file at cursor"))
1480 (define-key map [menu-bar immediate create-directory]
1481 '(menu-item "Create Directory..." dired-create-directory
1482 :help "Create a directory"))
1483 (define-key map [menu-bar immediate wdired-mode]
1484 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1485 :help "Put a dired buffer in a mode in which filenames are editable"
1486 :keys "C-x C-q"
1487 :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1489 (define-key map [menu-bar regexp]
1490 (cons "Regexp" (make-sparse-keymap "Regexp")))
1492 (define-key map
1493 [menu-bar regexp image-dired-mark-tagged-files]
1494 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1495 :help "Mark files whose image tags matches regexp"))
1497 (define-key map [menu-bar regexp dashes-1]
1498 '("--"))
1500 (define-key map [menu-bar regexp downcase]
1501 '(menu-item "Downcase" dired-downcase
1502 ;; When running on plain MS-DOS, there's only one
1503 ;; letter-case for file names.
1504 :enable (or (not (fboundp 'msdos-long-file-names))
1505 (msdos-long-file-names))
1506 :help "Rename marked files to lower-case name"))
1507 (define-key map [menu-bar regexp upcase]
1508 '(menu-item "Upcase" dired-upcase
1509 :enable (or (not (fboundp 'msdos-long-file-names))
1510 (msdos-long-file-names))
1511 :help "Rename marked files to upper-case name"))
1512 (define-key map [menu-bar regexp hardlink]
1513 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1514 :help "Make hard links for files matching regexp"))
1515 (define-key map [menu-bar regexp symlink]
1516 '(menu-item "Symlink..." dired-do-symlink-regexp
1517 :visible (fboundp 'make-symbolic-link)
1518 :help "Make symbolic links for files matching regexp"))
1519 (define-key map [menu-bar regexp rename]
1520 '(menu-item "Rename..." dired-do-rename-regexp
1521 :help "Rename marked files matching regexp"))
1522 (define-key map [menu-bar regexp copy]
1523 '(menu-item "Copy..." dired-do-copy-regexp
1524 :help "Copy marked files matching regexp"))
1525 (define-key map [menu-bar regexp flag]
1526 '(menu-item "Flag..." dired-flag-files-regexp
1527 :help "Flag files matching regexp for deletion"))
1528 (define-key map [menu-bar regexp mark]
1529 '(menu-item "Mark..." dired-mark-files-regexp
1530 :help "Mark files matching regexp for future operations"))
1531 (define-key map [menu-bar regexp mark-cont]
1532 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1533 :help "Mark files whose contents matches regexp"))
1535 (define-key map [menu-bar mark]
1536 (cons "Mark" (make-sparse-keymap "Mark")))
1538 (define-key map [menu-bar mark prev]
1539 '(menu-item "Previous Marked" dired-prev-marked-file
1540 :help "Move to previous marked file"))
1541 (define-key map [menu-bar mark next]
1542 '(menu-item "Next Marked" dired-next-marked-file
1543 :help "Move to next marked file"))
1544 (define-key map [menu-bar mark marks]
1545 '(menu-item "Change Marks..." dired-change-marks
1546 :help "Replace marker with another character"))
1547 (define-key map [menu-bar mark unmark-all]
1548 '(menu-item "Unmark All" dired-unmark-all-marks))
1549 (define-key map [menu-bar mark symlinks]
1550 '(menu-item "Mark Symlinks" dired-mark-symlinks
1551 :visible (fboundp 'make-symbolic-link)
1552 :help "Mark all symbolic links"))
1553 (define-key map [menu-bar mark directories]
1554 '(menu-item "Mark Directories" dired-mark-directories
1555 :help "Mark all directories except `.' and `..'"))
1556 (define-key map [menu-bar mark directory]
1557 '(menu-item "Mark Old Backups" dired-clean-directory
1558 :help "Flag old numbered backups for deletion"))
1559 (define-key map [menu-bar mark executables]
1560 '(menu-item "Mark Executables" dired-mark-executables
1561 :help "Mark all executable files"))
1562 (define-key map [menu-bar mark garbage-files]
1563 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1564 :help "Flag unneeded files for deletion"))
1565 (define-key map [menu-bar mark backup-files]
1566 '(menu-item "Flag Backup Files" dired-flag-backup-files
1567 :help "Flag all backup files for deletion"))
1568 (define-key map [menu-bar mark auto-save-files]
1569 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1570 :help "Flag auto-save files for deletion"))
1571 (define-key map [menu-bar mark deletion]
1572 '(menu-item "Flag" dired-flag-file-deletion
1573 :help "Flag current line's file for deletion"))
1574 (define-key map [menu-bar mark unmark]
1575 '(menu-item "Unmark" dired-unmark
1576 :help "Unmark or unflag current line's file"))
1577 (define-key map [menu-bar mark mark]
1578 '(menu-item "Mark" dired-mark
1579 :help "Mark current line's file for future operations"))
1580 (define-key map [menu-bar mark toggle-marks]
1581 '(menu-item "Toggle Marks" dired-toggle-marks
1582 :help "Mark unmarked files, unmark marked ones"))
1584 (define-key map [menu-bar operate]
1585 (cons "Operate" (make-sparse-keymap "Operate")))
1587 (define-key map
1588 [menu-bar operate image-dired-delete-tag]
1589 '(menu-item "Delete Image Tag..." image-dired-delete-tag
1590 :help "Delete image tag from current or marked files"))
1591 (define-key map
1592 [menu-bar operate image-dired-tag-files]
1593 '(menu-item "Add Image Tags..." image-dired-tag-files
1594 :help "Add image tags to current or marked files"))
1595 (define-key map
1596 [menu-bar operate image-dired-dired-comment-files]
1597 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1598 :help "Add image comment to current or marked files"))
1599 (define-key map
1600 [menu-bar operate image-dired-display-thumbs]
1601 '(menu-item "Display image thumbnails" image-dired-display-thumbs
1602 :help "Display image thumbnails for current or marked image files"))
1604 (define-key map [menu-bar operate dashes-3]
1605 '("--"))
1607 (define-key map [menu-bar operate query-replace]
1608 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1609 :help "Replace regexp in marked files"))
1610 (define-key map [menu-bar operate search]
1611 '(menu-item "Search Files..." dired-do-search
1612 :help "Search marked files for regexp"))
1613 (define-key map [menu-bar operate isearch-regexp]
1614 '(menu-item "Isearch Regexp Files..." dired-do-isearch-regexp
1615 :help "Incrementally search marked files for regexp"))
1616 (define-key map [menu-bar operate isearch]
1617 '(menu-item "Isearch Files..." dired-do-isearch
1618 :help "Incrementally search marked files for string"))
1619 (define-key map [menu-bar operate chown]
1620 '(menu-item "Change Owner..." dired-do-chown
1621 :visible (not (memq system-type '(ms-dos windows-nt)))
1622 :help "Change the owner of marked files"))
1623 (define-key map [menu-bar operate chgrp]
1624 '(menu-item "Change Group..." dired-do-chgrp
1625 :visible (not (memq system-type '(ms-dos windows-nt)))
1626 :help "Change the group of marked files"))
1627 (define-key map [menu-bar operate chmod]
1628 '(menu-item "Change Mode..." dired-do-chmod
1629 :help "Change mode (attributes) of marked files"))
1630 (define-key map [menu-bar operate touch]
1631 '(menu-item "Change Timestamp..." dired-do-touch
1632 :help "Change timestamp of marked files"))
1633 (define-key map [menu-bar operate load]
1634 '(menu-item "Load" dired-do-load
1635 :help "Load marked Emacs Lisp files"))
1636 (define-key map [menu-bar operate compile]
1637 '(menu-item "Byte-compile" dired-do-byte-compile
1638 :help "Byte-compile marked Emacs Lisp files"))
1639 (define-key map [menu-bar operate compress]
1640 '(menu-item "Compress" dired-do-compress
1641 :help "Compress/uncompress marked files"))
1642 (define-key map [menu-bar operate print]
1643 '(menu-item "Print..." dired-do-print
1644 :help "Ask for print command and print marked files"))
1645 (define-key map [menu-bar operate hardlink]
1646 '(menu-item "Hardlink to..." dired-do-hardlink
1647 :help "Make hard links for current or marked files"))
1648 (define-key map [menu-bar operate symlink]
1649 '(menu-item "Symlink to..." dired-do-symlink
1650 :visible (fboundp 'make-symbolic-link)
1651 :help "Make symbolic links for current or marked files"))
1652 (define-key map [menu-bar operate command]
1653 '(menu-item "Shell Command..." dired-do-shell-command
1654 :help "Run a shell command on each of marked files"))
1655 (define-key map [menu-bar operate delete]
1656 '(menu-item "Delete" dired-do-delete
1657 :help "Delete current file or all marked files"))
1658 (define-key map [menu-bar operate rename]
1659 '(menu-item "Rename to..." dired-do-rename
1660 :help "Rename current file or move marked files"))
1661 (define-key map [menu-bar operate copy]
1662 '(menu-item "Copy to..." dired-do-copy
1663 :help "Copy current file or all marked files"))
1665 map)
1666 "Local keymap for `dired-mode' buffers.")
1667 \f
1668 ;; Dired mode is suitable only for specially formatted data.
1669 (put 'dired-mode 'mode-class 'special)
1671 ;; Autoload cookie needed by desktop.el
1672 ;;;###autoload
1673 (defun dired-mode (&optional dirname switches)
1674 "\
1677 \(optionally) its subdirectories, in the format of `ls -lR'.
1680 compress, load or byte-compile them, change their file attributes
1683 by file or all files matching certain criteria.
1685 Letters no longer insert themselves. Digits are prefix arguments.
1688 Most commands operate on the marked files and use the current file
1689 if no files are marked. Use a numeric prefix argument to operate on
1690 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1691 to operate on the current file only. Prefix arguments override marks.
1693 to see why something went wrong.
1698 (or dired it in another buffer, if it is a directory).
1705 This retains all marks and hides subdirs again that were hidden before.
1706 SPC and DEL can be used to move down and up by lines.
1709 to read the
1711 to relist a single or the marked files or a
1713 again for the directory tree.
1716 for more info):
1718 `dired-listing-switches'
1719 `dired-trivial-filenames'
1720 `dired-shrink-to-fit'
1721 `dired-marker-char'
1722 `dired-del-marker'
1723 `dired-keep-marker-rename'
1724 `dired-keep-marker-copy'
1725 `dired-keep-marker-hardlink'
1726 `dired-keep-marker-symlink'
1730 `dired-before-readin-hook'
1731 `dired-after-readin-hook'
1732 `dired-mode-hook'
1733 `dired-load-hook'
1735 Keybindings:
1737 ;; Not to be called interactively (e.g. dired-directory will be set
1738 ;; to default-directory, which is wrong with wildcards).
1739 (kill-all-local-variables)
1740 (use-local-map dired-mode-map)
1741 (dired-advertise) ; default-directory is already set
1742 (setq major-mode 'dired-mode
1743 mode-name "Dired"
1744 ;; case-fold-search nil
1745 buffer-read-only t
1746 selective-display t ; for subdirectory hiding
1747 mode-line-buffer-identification
1748 (propertized-buffer-identification "%17b"))
1749 (set (make-local-variable 'revert-buffer-function)
1750 (function dired-revert))
1751 (set (make-local-variable 'buffer-stale-function)
1752 (function dired-buffer-stale-p))
1753 (set (make-local-variable 'page-delimiter)
1755 (set (make-local-variable 'dired-directory)
1756 (or dirname default-directory))
1757 ;; list-buffers uses this to display the dir being edited in this buffer.
1758 (set (make-local-variable 'list-buffers-directory)
1759 (expand-file-name (if (listp dired-directory)
1760 (car dired-directory)
1761 dired-directory)))
1762 (set (make-local-variable 'dired-actual-switches)
1763 (or switches dired-listing-switches))
1764 (set (make-local-variable 'font-lock-defaults)
1765 '(dired-font-lock-keywords t nil nil beginning-of-line))
1766 (set (make-local-variable 'desktop-save-buffer)
1767 'dired-desktop-buffer-misc-data)
1768 (setq dired-switches-alist nil)
1769 (dired-sort-other dired-actual-switches t)
1770 (when (featurep 'dnd)
1771 (set (make-local-variable 'dnd-protocol-alist)
1772 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1773 (add-hook 'isearch-mode-hook 'dired-isearch-filenames-setup nil t)
1774 (run-mode-hooks 'dired-mode-hook))
1775 \f
1776 ;; Idiosyncratic dired commands that don't deal with marks.
1778 (defun dired-summary ()
1779 "Summarize basic Dired commands and show recent dired errors."
1780 (interactive)
1781 (dired-why)
1782 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1783 (message
1784 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1786 (defun dired-undo ()
1787 "Undo in a dired buffer.
1788 This doesn't recover lost files, it just undoes changes in the buffer itself.
1789 You can use it to recover marks, killed lines or subdirs."
1790 (interactive)
1791 (let ((inhibit-read-only t))
1792 (undo))
1793 (dired-build-subdir-alist)
1794 (message "Change in dired buffer undone.
1795 Actual changes in files cannot be undone by Emacs."))
1797 (defun dired-toggle-read-only ()
1798 "Edit dired buffer with Wdired, or set it read-only.
1799 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1800 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1801 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1802 (interactive)
1803 (if (eq major-mode 'dired-mode)
1804 (wdired-change-to-wdired-mode)
1805 (toggle-read-only)))
1807 (defun dired-next-line (arg)
1808 "Move down lines then position at filename.
1809 Optional prefix ARG says how many lines to move; default is one line."
1810 (interactive "p")
1811 (forward-line arg)
1812 (dired-move-to-filename))
1814 (defun dired-previous-line (arg)
1815 "Move up lines then position at filename.
1816 Optional prefix ARG says how many lines to move; default is one line."
1817 (interactive "p")
1818 (forward-line (- arg))
1819 (dired-move-to-filename))
1821 (defun dired-next-dirline (arg &optional opoint)
1822 "Goto ARG'th next directory file line."
1823 (interactive "p")
1824 (or opoint (setq opoint (point)))
1825 (if (if (> arg 0)
1826 (re-search-forward dired-re-dir nil t arg)
1827 (beginning-of-line)
1828 (re-search-backward dired-re-dir nil t (- arg)))
1829 (dired-move-to-filename) ; user may type `i' or `f'
1830 (goto-char opoint)
1831 (error "No more subdirectories")))
1833 (defun dired-prev-dirline (arg)
1834 "Goto ARG'th previous directory file line."
1835 (interactive "p")
1836 (dired-next-dirline (- arg)))
1838 (defun dired-up-directory (&optional other-window)
1839 "Run Dired on parent directory of current directory.
1840 Find the parent directory either in this buffer or another buffer.
1841 Creates a buffer if necessary."
1842 (interactive "P")
1843 (let* ((dir (dired-current-directory))
1844 (up (file-name-directory (directory-file-name dir))))
1845 (or (dired-goto-file (directory-file-name dir))
1846 ;; Only try dired-goto-subdir if buffer has more than one dir.
1847 (and (cdr dired-subdir-alist)
1848 (dired-goto-subdir up))
1849 (progn
1850 (if other-window
1851 (dired-other-window up)
1852 (dired up))
1853 (dired-goto-file dir)))))
1855 (defun dired-get-file-for-visit ()
1856 "Get the current line's file name, with an error if file does not exist."
1857 (interactive)
1858 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1859 (let ((raw (dired-get-filename nil t))
1860 file-name)
1861 (if (null raw)
1862 (error "No file on this line"))
1863 (setq file-name (file-name-sans-versions raw t))
1864 (if (file-exists-p file-name)
1865 file-name
1866 (if (file-symlink-p file-name)
1867 (error "File is a symlink to a nonexistent target")
1868 (error "File no longer exists; type `g' to update dired buffer")))))
1870 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1871 (defalias 'dired-advertised-find-file 'dired-find-file)
1872 (defun dired-find-file ()
1873 "In Dired, visit the file or directory named on this line."
1874 (interactive)
1875 ;; Bind `find-file-run-dired' so that the command works on directories
1876 ;; too, independent of the user's setting.
1877 (let ((find-file-run-dired t))
1878 (find-file (dired-get-file-for-visit))))
1880 (defun dired-find-alternate-file ()
1881 "In Dired, visit this file or directory instead of the dired buffer."
1882 (interactive)
1883 (set-buffer-modified-p nil)
1884 (find-alternate-file (dired-get-file-for-visit)))
1885 ;; Don't override the setting from .emacs.
1886 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1888 (defun dired-mouse-find-file-other-window (event)
1889 "In Dired, visit the file or directory name you click on."
1890 (interactive "e")
1891 (let (window pos file)
1892 (save-excursion
1893 (setq window (posn-window (event-end event))
1894 pos (posn-point (event-end event)))
1895 (if (not (windowp window))
1896 (error "No file chosen"))
1897 (set-buffer (window-buffer window))
1898 (goto-char pos)
1899 (setq file (dired-get-file-for-visit)))
1900 (if (file-directory-p file)
1901 (or (and (cdr dired-subdir-alist)
1902 (dired-goto-subdir file))
1903 (progn
1904 (select-window window)
1905 (dired-other-window file)))
1906 (select-window window)
1907 (find-file-other-window (file-name-sans-versions file t)))))
1909 (defun dired-view-file ()
1910 "In Dired, examine a file in view mode, returning to Dired when done.
1911 When file is a directory, show it in this buffer if it is inserted.
1912 Otherwise, display it in another buffer."
1913 (interactive)
1914 (let ((file (dired-get-file-for-visit)))
1915 (if (file-directory-p file)
1916 (or (and (cdr dired-subdir-alist)
1917 (dired-goto-subdir file))
1918 (dired file))
1919 (view-file file))))
1921 (defun dired-find-file-other-window ()
1922 "In Dired, visit this file or directory in another window."
1923 (interactive)
1924 (find-file-other-window (dired-get-file-for-visit)))
1926 (defun dired-display-file ()
1927 "In Dired, display this file or directory in another window."
1928 (interactive)
1929 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1930 \f
1931 ;;; Functions for extracting and manipulating file names in Dired buffers.
1933 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1934 "In Dired, return name of file mentioned on this line.
1935 Value returned normally includes the directory name.
1936 Optional arg LOCALP with value `no-dir' means don't include directory
1937 name in result. A value of `verbatim' means to return the name exactly as
1938 it occurs in the buffer, and a value of t means construct name relative to
1939 `default-directory', which still may contain slashes if in a subdirectory.
1940 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1941 regular filenames and return nil if no filename on this line.
1942 Otherwise, an error occurs in these cases."
1943 (let (case-fold-search file p1 p2 already-absolute)
1944 (save-excursion
1945 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1946 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1947 ;; nil if no file on this line, but no-error-if-not-filep is t:
1948 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1949 (progn
1950 ;; Get rid of the mouse-face property that file names have.
1951 (set-text-properties 0 (length file) nil file)
1952 ;; Unquote names quoted by ls or by dired-insert-directory.
1953 (while (string-match
1955 (setq file (replace-match
1957 nil t file 1)))
1958 ;; The above `read' will return a unibyte string if FILE
1959 ;; contains eight-bit-control/graphic characters.
1960 (if (and enable-multibyte-characters
1961 (not (multibyte-string-p file)))
1962 (setq file (string-to-multibyte file)))))
1963 (and file (file-name-absolute-p file)
1964 ;; A relative file name can start with ~.
1965 ;; Don't treat it as absolute in this context.
1966 (not (eq (aref file 0) ?~))
1967 (setq already-absolute t))
1968 (cond
1969 ((null file)
1970 nil)
1971 ((eq localp 'verbatim)
1972 file)
1973 ((and (not no-error-if-not-filep)
1974 (member file '("." "..")))
1975 (error "Cannot operate on `.' or `..'"))
1976 ((and (eq localp 'no-dir) already-absolute)
1977 (file-name-nondirectory file))
1978 (already-absolute
1979 (let ((handler (find-file-name-handler file nil)))
1980 ;; check for safe-magic property so that we won't
1981 ;; put /: for names that don't really need them.
1982 ;; For instance, .gz files when auto-compression-mode is on.
1983 (if (and handler (not (get handler 'safe-magic)))
1984 (concat "/:" file)
1985 file)))
1986 ((eq localp 'no-dir)
1987 file)
1988 ((equal (dired-current-directory) "/")
1989 (setq file (concat (dired-current-directory localp) file))
1990 (let ((handler (find-file-name-handler file nil)))
1991 ;; check for safe-magic property so that we won't
1992 ;; put /: for names that don't really need them.
1993 ;; For instance, .gz files when auto-compression-mode is on.
1994 (if (and handler (not (get handler 'safe-magic)))
1995 (concat "/:" file)
1996 file)))
1997 (t
1998 (concat (dired-current-directory localp) file)))))
2000 (defun dired-string-replace-match (regexp string newtext
2001 &optional literal global)
2002 "Replace first match of REGEXP in STRING with NEWTEXT.
2003 If it does not match, nil is returned instead of the new string.
2004 Optional arg LITERAL means to take NEWTEXT literally.
2005 Optional arg GLOBAL means to replace all matches."
2006 (if global
2007 (let ((start 0) ret)
2008 (while (string-match regexp string start)
2009 (let ((from-end (- (length string) (match-end 0))))
2010 (setq ret (setq string (replace-match newtext t literal string)))
2011 (setq start (- (length string) from-end))))
2012 ret)
2013 (if (not (string-match regexp string 0))
2014 nil
2015 (replace-match newtext t literal string))))
2017 (defun dired-make-absolute (file &optional dir)
2018 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2019 ;; We can't always use expand-file-name as this would get rid of `.'
2020 ;; or expand in / instead default-directory if DIR=="".
2021 ;; This should be good enough for ange-ftp.
2022 ;; It should be reasonably fast, though, as it is called in
2023 ;; dired-get-filename.
2024 (concat (or dir default-directory) file))
2026 (defun dired-make-relative (file &optional dir ignore)
2027 "Convert FILE (an absolute file name) to a name relative to DIR.
2028 If this is impossible, return FILE unchanged.
2029 DIR must be a directory name, not a file name."
2030 (or dir (setq dir default-directory))
2031 ;; This case comes into play if default-directory is set to
2032 ;; use ~.
2033 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
2034 (setq dir (expand-file-name dir)))
2035 (if (string-match (concat "^" (regexp-quote dir)) file)
2036 (substring file (match-end 0))
2037 ;;; (or no-error
2038 ;;; (error "%s: not in directory tree growing at %s" file dir))
2039 file))
2040 \f
2041 ;;; Functions for finding the file name in a dired buffer line.
2043 (defvar dired-permission-flags-regexp
2045 "Regular expression to match the permission flags in `ls -l'.")
2047 ;; Move to first char of filename on this line.
2048 ;; Returns position (point) or nil if no filename on this line."
2049 (defun dired-move-to-filename (&optional raise-error eol)
2050 "Move to the beginning of the filename on the current line.
2051 Return the position of the beginning of the filename, or nil if none found."
2052 ;; This is the UNIX version.
2053 (or eol (setq eol (line-end-position)))
2054 (beginning-of-line)
2055 ;; First try assuming `ls --dired' was used.
2056 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
2057 (cond
2058 ((and change (< change eol))
2059 (goto-char change))
2060 ((re-search-forward directory-listing-before-filename-regexp eol t)
2061 (goto-char (match-end 0)))
2062 ((re-search-forward dired-permission-flags-regexp eol t)
2063 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2064 (if raise-error
2065 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
2066 (beginning-of-line)
2067 nil)
2068 (raise-error
2069 (error "No file on this line")))))
2071 (defun dired-move-to-end-of-filename (&optional no-error)
2072 ;; Assumes point is at beginning of filename,
2073 ;; thus the rwx bit re-search-backward below will succeed in *this*
2074 ;; line if at all. So, it should be called only after
2075 ;; (dired-move-to-filename t).
2076 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2077 ;; This is the UNIX version.
2078 (if (get-text-property (point) 'dired-filename)
2079 (goto-char (next-single-property-change (point) 'dired-filename))
2080 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
2081 ;; case-fold-search is nil now, so we can test for capital F:
2082 (setq used-F (string-match "F" dired-actual-switches)
2083 opoint (point)
2084 eol (save-excursion (end-of-line) (point))
2085 hidden (and selective-display
2087 (if hidden
2088 nil
2089 (save-excursion ;; Find out what kind of file this is:
2090 ;; Restrict perm bits to be non-blank,
2091 ;; otherwise this matches one char to early (looking backward):
2092 ;; "l---------" (some systems make symlinks that way)
2093 ;; "----------" (plain file with zero perms)
2094 (if (re-search-backward
2095 dired-permission-flags-regexp nil t)
2096 (setq file-type (char-after (match-beginning 1))
2097 symlink (eq file-type ?l)
2098 ;; Only with -F we need to know whether it's an executable
2099 executable (and
2100 used-F
2101 (string-match
2102 "[xst]" ;; execute bit set anywhere?
2103 (concat
2104 (match-string 2)
2105 (match-string 3)
2106 (match-string 4)))))
2107 (or no-error (error "No file on this line"))))
2108 ;; Move point to end of name:
2109 (if symlink
2110 (if (search-forward " -> " eol t)
2111 (progn
2112 (forward-char -4)
2113 (and used-F
2114 dired-ls-F-marks-symlinks
2115 (eq (preceding-char) ?@) ;; did ls really mark the link?
2116 (forward-char -1))))
2117 (goto-char eol) ;; else not a symbolic link
2118 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2119 ;; one trailing character. (Executable bits on symlinks ain't mean
2120 ;; a thing, even to ls, but we know it's not a symlink.)
2121 (and used-F
2122 (or (memq file-type '(?d ?s ?p))
2123 executable)
2124 (forward-char -1))))
2125 (or no-error
2126 (not (eq opoint (point)))
2127 (error "%s" (if hidden
2128 (substitute-command-keys
2130 "No file on this line")))
2131 (if (eq opoint (point))
2132 nil
2133 (point)))))
2135 \f
2136 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2138 (defun dired-copy-filename-as-kill (&optional arg)
2139 "Copy names of marked (or next ARG) files into the kill ring.
2140 The names are separated by a space.
2141 With a zero prefix arg, use the absolute file name of each marked file.
2143 `default-directory'. (This still may contain slashes if in a subdirectory.)
2145 If on a subdir headerline, use absolute subdirname instead;
2146 prefix arg and marked files are ignored in this case.
2149 (interactive "P")
2150 (let ((string
2151 (or (dired-get-subdir)
2152 (mapconcat (function identity)
2153 (if arg
2154 (cond ((zerop (prefix-numeric-value arg))
2155 (dired-get-marked-files))
2156 ((consp arg)
2157 (dired-get-marked-files t))
2158 (t
2159 (dired-get-marked-files
2160 'no-dir (prefix-numeric-value arg))))
2161 (dired-get-marked-files 'no-dir))
2162 " "))))
2163 (if (eq last-command 'kill-region)
2164 (kill-append string nil)
2165 (kill-new string))
2166 (message "%s" string)))
2168 \f
2169 ;; Keeping Dired buffers in sync with the filesystem and with each other
2171 (defun dired-buffers-for-dir (dir &optional file)
2172 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2173 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2174 ;; matches FILE.
2175 ;; The list is in reverse order of buffer creation, most recent last.
2176 ;; As a side effect, killed dired buffers for DIR are removed from
2177 ;; dired-buffers.
2178 (setq dir (file-name-as-directory dir))
2179 (let ((alist dired-buffers) result elt buf)
2180 (while alist
2181 (setq elt (car alist)
2182 buf (cdr elt))
2183 (if (buffer-name buf)
2184 (if (dired-in-this-tree dir (car elt))
2185 (with-current-buffer buf
2186 (and (assoc dir dired-subdir-alist)
2187 (or (null file)
2188 (let ((wildcards
2189 (file-name-nondirectory dired-directory)))
2190 (or (= 0 (length wildcards))
2191 (string-match (dired-glob-regexp wildcards)
2192 file))))
2193 (setq result (cons buf result)))))
2194 ;; else buffer is killed - clean up:
2195 (setq dired-buffers (delq elt dired-buffers)))
2196 (setq alist (cdr alist)))
2197 result))
2199 (defun dired-glob-regexp (pattern)
2200 "Convert glob-pattern PATTERN to a regular expression."
2201 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2202 regexp)
2203 (while (string-match "[[?*]" pattern matched-in-pattern)
2204 (let ((op-end (match-end 0))
2205 (next-op (aref pattern (match-beginning 0))))
2206 (setq regexp (concat regexp
2207 (regexp-quote
2208 (substring pattern matched-in-pattern
2209 (match-beginning 0)))))
2210 (cond ((= next-op ??)
2211 (setq regexp (concat regexp "."))
2212 (setq matched-in-pattern op-end))
2213 ((= next-op ?\[)
2214 ;; Fails to handle ^ yet ????
2215 (let* ((set-start (match-beginning 0))
2216 (set-cont
2217 (if (= (aref pattern (1+ set-start)) ?^)
2218 (+ 3 set-start)
2219 (+ 2 set-start)))
2220 (set-end (string-match "]" pattern set-cont))
2221 (set (substring pattern set-start (1+ set-end))))
2222 (setq regexp (concat regexp set))
2223 (setq matched-in-pattern (1+ set-end))))
2224 ((= next-op ?*)
2225 (setq regexp (concat regexp ".*"))
2226 (setq matched-in-pattern op-end)))))
2228 regexp
2229 (regexp-quote
2230 (substring pattern matched-in-pattern))
2235 (defun dired-advertise ()
2236 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2237 ;; With wildcards we actually advertise too much.
2238 (let ((expanded-default (expand-file-name default-directory)))
2239 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2240 t ; we have already advertised ourselves
2241 (setq dired-buffers
2242 (cons (cons expanded-default (current-buffer))
2243 dired-buffers)))))
2245 (defun dired-unadvertise (dir)
2246 ;; Remove DIR from the buffer alist in variable dired-buffers.
2247 ;; This has the effect of removing any buffer whose main directory is DIR.
2248 ;; It does not affect buffers in which DIR is a subdir.
2249 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2250 (setq dired-buffers
2251 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2252 \f
2253 ;; Tree Dired
2255 ;;; utility functions
2257 (defun dired-in-this-tree (file dir)
2258 ;;"Is FILE part of the directory tree starting at DIR?"
2259 (let (case-fold-search)
2260 (string-match (concat "^" (regexp-quote dir)) file)))
2262 (defun dired-normalize-subdir (dir)
2263 ;; Prepend default-directory to DIR if relative file name.
2264 ;; dired-get-filename must be able to make a valid file name from a
2265 ;; file and its directory DIR.
2266 (file-name-as-directory
2267 (if (file-name-absolute-p dir)
2268 dir
2269 (expand-file-name dir default-directory))))
2271 (defun dired-get-subdir ()
2272 ;;"Return the subdir name on this line, or nil if not on a headerline."
2273 ;; Look up in the alist whether this is a headerline.
2274 (save-excursion
2275 (let ((cur-dir (dired-current-directory)))
2276 (beginning-of-line) ; alist stores b-o-l positions
2277 (and (zerop (- (point)
2278 (dired-get-subdir-min (assoc cur-dir
2279 dired-subdir-alist))))
2280 cur-dir))))
2282 ;(defun dired-get-subdir-min (elt)
2283 ; (cdr elt))
2284 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2285 (defalias 'dired-get-subdir-min 'cdr)
2287 (defun dired-get-subdir-max (elt)
2288 (save-excursion
2289 (goto-char (dired-get-subdir-min elt))
2290 (dired-subdir-max)))
2292 (defun dired-clear-alist ()
2293 (while dired-subdir-alist
2294 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2295 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2297 (defun dired-subdir-index (dir)
2298 ;; Return an index into alist for use with nth
2299 ;; for the sake of subdir moving commands.
2300 (let (found (index 0) (alist dired-subdir-alist))
2301 (while alist
2302 (if (string= dir (car (car alist)))
2303 (setq alist nil found t)
2304 (setq alist (cdr alist) index (1+ index))))
2305 (if found index nil)))
2307 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2308 "Go to next subdirectory, regardless of level."
2309 ;; Use 0 arg to go to this directory's header line.
2310 ;; NO-SKIP prevents moving to end of header line, returning whatever
2311 ;; position was found in dired-subdir-alist.
2312 (interactive "p")
2313 (let ((this-dir (dired-current-directory))
2314 pos index)
2315 ;; nth with negative arg does not return nil but the first element
2316 (setq index (- (dired-subdir-index this-dir) arg))
2317 (setq pos (if (>= index 0)
2318 (dired-get-subdir-min (nth index dired-subdir-alist))))
2319 (if pos
2320 (progn
2321 (goto-char pos)
2323 (point))
2324 (if no-error-if-not-found
2325 nil ; return nil if not found
2326 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2328 (defun dired-build-subdir-alist (&optional switches)
2329 "Build `dired-subdir-alist' by parsing the buffer.
2330 Returns the new value of the alist.
2331 If optional arg SWITCHES is non-nil, use its value
2332 instead of `dired-actual-switches'."
2333 (interactive)
2334 (dired-clear-alist)
2335 (save-excursion
2336 (let* ((count 0)
2337 (inhibit-read-only t)
2338 (buffer-undo-list t)
2339 (switches (or switches dired-actual-switches))
2340 new-dir-name
2341 (R-ftp-base-dir-regex
2342 ;; Used to expand subdirectory names correctly in recursive
2343 ;; ange-ftp listings.
2344 (and (string-match "R" switches)
2347 (goto-char (point-min))
2348 (setq dired-subdir-alist nil)
2349 (while (re-search-forward dired-subdir-regexp nil t)
2350 ;; Avoid taking a file name ending in a colon
2351 ;; as a subdir name.
2352 (unless (save-excursion
2353 (goto-char (match-beginning 0))
2354 (beginning-of-line)
2355 (forward-char 2)
2356 (save-match-data (looking-at dired-re-perms)))
2357 (save-excursion
2358 (goto-char (match-beginning 1))
2359 (setq new-dir-name
2360 (buffer-substring-no-properties (point) (match-end 1))
2361 new-dir-name
2362 (save-match-data
2363 (if (and R-ftp-base-dir-regex
2364 (not (string= new-dir-name default-directory))
2365 (string-match R-ftp-base-dir-regex new-dir-name))
2366 (concat default-directory
2367 (substring new-dir-name (match-end 0)))
2368 (expand-file-name new-dir-name))))
2369 (delete-region (point) (match-end 1))
2370 (insert new-dir-name))
2371 (setq count (1+ count))
2372 (dired-alist-add-1 new-dir-name
2373 ;; Place a sub directory boundary between lines.
2374 (save-excursion
2375 (goto-char (match-beginning 0))
2376 (beginning-of-line)
2377 (point-marker)))))
2378 (if (and (> count 1) (interactive-p))
2379 (message "Buffer includes %d directories" count)))
2380 ;; We don't need to sort it because it is in buffer order per
2381 ;; constructionem. Return new alist:
2382 dired-subdir-alist))
2384 (defun dired-alist-add-1 (dir new-marker)
2385 ;; Add new DIR at NEW-MARKER. Don't sort.
2386 (setq dired-subdir-alist
2387 (cons (cons (dired-normalize-subdir dir) new-marker)
2388 dired-subdir-alist)))
2390 (defun dired-goto-next-nontrivial-file ()
2391 ;; Position point on first nontrivial file after point.
2392 (dired-goto-next-file);; so there is a file to compare with
2393 (if (stringp dired-trivial-filenames)
2394 (while (and (not (eobp))
2395 (string-match dired-trivial-filenames
2396 (file-name-nondirectory
2397 (or (dired-get-filename nil t) ""))))
2398 (forward-line 1)
2399 (dired-move-to-filename))))
2401 (defun dired-goto-next-file ()
2402 (let ((max (1- (dired-subdir-max))))
2403 (while (and (not (dired-move-to-filename)) (< (point) max))
2404 (forward-line 1))))
2406 (defun dired-goto-file (file)
2407 "Go to line describing file FILE in this dired buffer."
2408 ;; Return value of point on success, else nil.
2409 ;; FILE must be an absolute file name.
2412 ;; it in the buffer.
2413 (interactive
2414 (prog1 ; let push-mark display its message
2415 (list (expand-file-name
2416 (read-file-name "Goto file: "
2417 (dired-current-directory))))
2418 (push-mark)))
2419 (setq file (directory-file-name file)) ; does no harm if no directory
2420 (let (found case-fold-search dir)
2421 (setq dir (or (file-name-directory file)
2422 (error "File name `%s' is not absolute" file)))
2423 (save-excursion
2424 ;; The hair here is to get the result of dired-goto-subdir
2425 ;; without really calling it if we don't have any subdirs.
2426 (if (if (string= dir (expand-file-name default-directory))
2427 (goto-char (point-min))
2428 (and (cdr dired-subdir-alist)
2429 (dired-goto-subdir dir)))
2430 (let ((base (file-name-nondirectory file))
2431 search-string
2432 (boundary (dired-subdir-max)))
2433 (setq search-string
2435 (setq search-string
2437 (while (and (not found)
2438 ;; filenames are preceded by SPC, this makes
2439 ;; the search faster (e.g. for the filename "-"!).
2440 (search-forward (concat " " search-string)
2441 boundary 'move))
2442 ;; Match could have BASE just as initial substring or
2443 ;; or in permission bits or date or
2444 ;; not be a proper filename at all:
2445 (if (equal base (dired-get-filename 'no-dir t))
2446 ;; Must move to filename since an (actually
2447 ;; correct) match could have been elsewhere on the
2448 ;; ;; line (e.g. "-" would match somewhere in the
2449 ;; permission bits).
2450 (setq found (dired-move-to-filename))
2451 ;; If this isn't the right line, move forward to avoid
2452 ;; trying this line again.
2453 (forward-line 1))))))
2454 (and found
2455 ;; return value of point (i.e., FOUND):
2456 (goto-char found))))
2458 (defun dired-initial-position (dirname)
2459 ;; Where point should go in a new listing of DIRNAME.
2460 ;; Point assumed at beginning of new subdir line.
2461 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2462 (end-of-line)
2463 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2464 \f
2465 ;; These are hooks which make tree dired work.
2466 ;; They are in this file because other parts of dired need to call them.
2467 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2469 ;; This function is called for each retrieved filename.
2470 ;; It could stand to be faster, though it's mostly function call
2471 ;; overhead. Avoiding the function call seems to save about 10% in
2472 ;; dired-get-filename. Make it a defsubst?
2473 (defun dired-current-directory (&optional localp)
2474 "Return the name of the subdirectory to which this line belongs.
2475 This returns a string with trailing slash, like `default-directory'.
2476 Optional argument means return a file name relative to `default-directory'."
2477 (let ((here (point))
2478 (alist (or dired-subdir-alist
2479 ;; probably because called in a non-dired buffer
2480 (error "No subdir-alist in %s" (current-buffer))))
2481 elt dir)
2482 (while alist
2483 (setq elt (car alist)
2484 dir (car elt)
2485 ;; use `<=' (not `<') as subdir line is part of subdir
2486 alist (if (<= (dired-get-subdir-min elt) here)
2487 nil ; found
2488 (cdr alist))))
2489 (if localp
2490 (dired-make-relative dir default-directory)
2491 dir)))
2493 ;; Subdirs start at the beginning of their header lines and end just
2494 ;; before the beginning of the next header line (or end of buffer).
2496 (defun dired-subdir-max ()
2497 (save-excursion
2498 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2499 (point-max)
2500 (point))))
2501 \f
2502 ;; Deleting files
2504 (defcustom dired-recursive-deletes 'top
2505 "Decide whether recursive deletes are allowed.
2506 A value of nil means no recursive deletes.
2507 `always' means delete recursively without asking. This is DANGEROUS!
2508 `top' means ask for each directory at top level, but delete its subdirectories
2509 without asking.
2510 Anything else means ask for each directory."
2511 :type '(choice :tag "Delete non-empty directories"
2512 (const :tag "Yes" always)
2513 (const :tag "No--only delete empty directories" nil)
2514 (const :tag "Confirm for each directory" t)
2515 (const :tag "Confirm for each top directory only" top))
2516 :group 'dired)
2518 ;; Match anything but `.' and `..'.
2521 ;; Delete file, possibly delete a directory and all its files.
2522 ;; This function is usefull outside of dired. One could change it's name
2523 ;; to e.g. recursive-delete-file and put it somewhere else.
2524 (defun dired-delete-file (file &optional recursive) "\
2525 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2526 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2527 nil, do not delete.
2528 `always', delete recursively without asking.
2529 `top', ask for each directory at top level.
2530 Anything else, ask for each sub-directory."
2531 (let (files)
2532 ;; This test is equivalent to
2533 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2534 ;; but more efficient
2535 (if (not (eq t (car (file-attributes file))))
2536 (delete-file file)
2537 (when (and recursive
2538 (setq files
2539 (directory-files file t dired-re-no-dot)) ; Not empty.
2540 (or (eq recursive 'always)
2541 (yes-or-no-p (format "Recursive delete of %s? "
2542 (dired-make-relative file)))))
2543 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2544 (while files ; Recursively delete (possibly asking).
2545 (dired-delete-file (car files) recursive)
2546 (setq files (cdr files))))
2547 (delete-directory file))))
2549 (defun dired-do-flagged-delete (&optional nomessage)
2550 "In Dired, delete the files flagged for deletion.
2551 If NOMESSAGE is non-nil, we don't display any message
2552 if there are no flagged files.
2553 `dired-recursive-deletes' controls whether deletion of
2554 non-empty directories is allowed."
2555 (interactive)
2556 (let* ((dired-marker-char dired-del-marker)
2557 (regexp (dired-marker-regexp))
2558 case-fold-search)
2559 (if (save-excursion (goto-char (point-min))
2560 (re-search-forward regexp nil t))
2561 (dired-internal-do-deletions
2562 ;; this can't move point since ARG is nil
2563 (dired-map-over-marks (cons (dired-get-filename) (point))
2564 nil)
2565 nil)
2566 (or nomessage
2567 (message "(No deletions requested)")))))
2569 (defun dired-do-delete (&optional arg)
2570 "Delete all marked (or next ARG) files.
2571 `dired-recursive-deletes' controls whether deletion of
2572 non-empty directories is allowed."
2573 ;; This is more consistent with the file marking feature than
2574 ;; dired-do-flagged-delete.
2575 (interactive "P")
2576 (dired-internal-do-deletions
2577 ;; this may move point if ARG is an integer
2578 (dired-map-over-marks (cons (dired-get-filename) (point))
2579 arg)
2580 arg))
2582 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2584 (defun dired-internal-do-deletions (l arg)
2585 ;; L is an alist of files to delete, with their buffer positions.
2586 ;; ARG is the prefix arg.
2587 ;; Filenames are absolute.
2588 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2589 ;; That way as changes are made in the buffer they do not shift the
2590 ;; lines still to be changed, so the (point) values in L stay valid.
2591 ;; Also, for subdirs in natural order, a subdir's files are deleted
2592 ;; before the subdir itself - the other way around would not work.
2593 (let ((files (mapcar (function car) l))
2594 (count (length l))
2595 (succ 0))
2596 ;; canonicalize file list for pop up
2597 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2598 (if (dired-mark-pop-up
2599 " *Deletions*" 'delete files dired-deletion-confirmer
2600 (format "Delete %s " (dired-mark-prompt arg files)))
2601 (save-excursion
2602 (let (failures);; files better be in reverse order for this loop!
2603 (while l
2604 (goto-char (cdr (car l)))
2605 (let ((inhibit-read-only t))
2606 (condition-case err
2607 (let ((fn (car (car l))))
2608 (dired-delete-file fn dired-recursive-deletes)
2609 ;; if we get here, removing worked
2610 (setq succ (1+ succ))
2611 (message "%s of %s deletions" succ count)
2612 (dired-fun-in-all-buffers
2613 (file-name-directory fn) (file-name-nondirectory fn)
2614 (function dired-delete-entry) fn))
2615 (error;; catch errors from failed deletions
2617 (setq failures (cons (car (car l)) failures)))))
2618 (setq l (cdr l)))
2619 (if (not failures)
2620 (message "%d deletion%s done" count (dired-plural-s count))
2621 (dired-log-summary
2622 (format "%d of %d deletion%s failed"
2623 (length failures) count
2624 (dired-plural-s count))
2625 failures))))
2626 (message "(No deletions performed)")))
2627 (dired-move-to-filename))
2629 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2630 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2631 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2632 ;; (FILE does not include a directory component.)
2633 ;; FILE may be nil, in which case ignore it.
2634 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2635 (let (success-list)
2636 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2637 file))
2638 (with-current-buffer buf
2639 (if (apply fun args)
2640 (setq success-list (cons (buffer-name buf) success-list)))))
2641 success-list))
2643 ;; Delete the entry for FILE from
2644 (defun dired-delete-entry (file)
2645 (save-excursion
2646 (and (dired-goto-file file)
2647 (let ((inhibit-read-only t))
2648 (delete-region (progn (beginning-of-line) (point))
2649 (save-excursion (forward-line 1) (point))))))
2650 (dired-clean-up-after-deletion file))
2652 ;; This is a separate function for the sake of dired-x.el.
2653 (defun dired-clean-up-after-deletion (fn)
2654 ;; Clean up after a deleted file or directory FN.
2655 (save-excursion (and (cdr dired-subdir-alist)
2656 (dired-goto-subdir fn)
2657 (dired-kill-subdir))))
2658 \f
2659 ;; Confirmation
2661 (defun dired-marker-regexp ()
2662 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2664 (defun dired-plural-s (count)
2665 (if (= 1 count) "" "s"))
2667 (defun dired-mark-prompt (arg files)
2668 "Return a string for use in a prompt, either the current file
2669 name, or the marker and a count of marked files."
2670 ;; distinguish-one-marked can cause the first element to be just t.
2671 (if (eq (car files) t) (setq files (cdr files)))
2672 (let ((count (length files)))
2673 (if (= count 1)
2674 (car files)
2675 ;; more than 1 file:
2676 (if (integerp arg)
2677 ;; abs(arg) = count
2678 ;; Perhaps this is nicer, but it also takes more screen space:
2679 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2680 ;; count)
2681 (format "[next %d files]" arg)
2682 (format "%c [%d files]" dired-marker-char count)))))
2684 (defun dired-pop-to-buffer (buf)
2685 "Pop up buffer BUF in a way suitable for Dired."
2686 ;; Don't split window horizontally. (Bug#1806)
2687 (let (split-width-threshold)
2688 (pop-to-buffer (get-buffer-create buf)))
2689 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2690 (when dired-shrink-to-fit
2691 ;; Try to not delete window when we want to display less than
2692 ;; `window-min-height' lines.
2693 (fit-window-to-buffer (get-buffer-window buf) nil 1)))
2695 (defcustom dired-no-confirm nil
2696 "A list of symbols for commands Dired should not confirm.
2697 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2698 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2699 `touch' and `uncompress'."
2700 :group 'dired
2701 :type '(set (const byte-compile) (const chgrp)
2702 (const chmod) (const chown) (const compress)
2703 (const copy) (const delete) (const hardlink)
2704 (const load) (const move) (const print)
2705 (const shell) (const symlink) (const touch)
2706 (const uncompress)))
2708 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2709 "Return FUNCTION's result on ARGS after showing which files are marked.
2710 Displays the file names in a buffer named BUFNAME;
2712 This uses function `dired-pop-to-buffer' to do that.
2714 FUNCTION should not manipulate files, just read input
2715 (an argument or confirmation).
2716 The window is not shown if there is just one file or
2717 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2718 FILES is the list of marked files. It can also be (t FILENAME)
2719 in the case of one marked file, to distinguish that from using
2720 just the current file."
2721 (or bufname (setq bufname " *Marked Files*"))
2722 (if (or (eq dired-no-confirm t)
2723 (memq op-symbol dired-no-confirm)
2724 ;; If FILES defaulted to the current line's file.
2725 (= (length files) 1))
2726 (apply function args)
2727 (with-current-buffer (get-buffer-create bufname)
2728 (erase-buffer)
2729 ;; Handle (t FILE) just like (FILE), here.
2730 ;; That value is used (only in some cases), to mean
2731 ;; just one file that was marked, rather than the current line file.
2732 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2733 (remove-text-properties (point-min) (point-max)
2734 '(mouse-face nil help-echo nil)))
2735 (save-window-excursion
2736 (dired-pop-to-buffer bufname)
2737 (apply function args))))
2739 (defun dired-format-columns-of-files (files)
2740 (let ((beg (point)))
2741 (completion--insert-strings files)
2742 (put-text-property beg (point) 'mouse-face nil)))
2743 \f
2744 ;; Commands to mark or flag file(s) at or near current line.
2746 (defun dired-repeat-over-lines (arg function)
2747 ;; This version skips non-file lines.
2748 (let ((pos (make-marker)))
2749 (beginning-of-line)
2750 (while (and (> arg 0) (not (eobp)))
2751 (setq arg (1- arg))
2752 (beginning-of-line)
2753 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2754 (save-excursion
2755 (forward-line 1)
2756 (move-marker pos (1+ (point))))
2757 (save-excursion (funcall function))
2758 ;; Advance to the next line--actually, to the line that *was* next.
2759 ;; (If FUNCTION inserted some new lines in between, skip them.)
2760 (goto-char pos))
2761 (while (and (< arg 0) (not (bobp)))
2762 (setq arg (1+ arg))
2763 (forward-line -1)
2764 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2765 (beginning-of-line)
2766 (save-excursion (funcall function)))
2767 (move-marker pos nil)
2768 (dired-move-to-filename)))
2770 (defun dired-between-files ()
2771 ;; This used to be a regexp match of the `total ...' line output by
2772 ;; ls, which is slightly faster, but that is not very robust; notably,
2773 ;; it fails for non-english locales.
2774 (save-excursion (not (dired-move-to-filename))))
2776 (defun dired-next-marked-file (arg &optional wrap opoint)
2777 "Move to the next marked file, wrapping around the end of the buffer."
2779 (or opoint (setq opoint (point)));; return to where interactively started
2780 (if (if (> arg 0)
2781 (re-search-forward dired-re-mark nil t arg)
2782 (beginning-of-line)
2783 (re-search-backward dired-re-mark nil t (- arg)))
2784 (dired-move-to-filename)
2785 (if (null wrap)
2786 (progn
2787 (goto-char opoint)
2788 (error "No next marked file"))
2789 (message "(Wraparound for next marked file)")
2790 (goto-char (if (> arg 0) (point-min) (point-max)))
2791 (dired-next-marked-file arg nil opoint))))
2793 (defun dired-prev-marked-file (arg &optional wrap)
2794 "Move to the previous marked file, wrapping around the end of the buffer."
2796 (dired-next-marked-file (- arg) wrap))
2798 (defun dired-file-marker (file)
2799 ;; Return FILE's marker, or nil if unmarked.
2800 (save-excursion
2801 (and (dired-goto-file file)
2802 (progn
2803 (beginning-of-line)
2805 (following-char))))))
2807 (defun dired-mark-files-in-region (start end)
2808 (let ((inhibit-read-only t))
2809 (if (> start end)
2810 (error "start > end"))
2811 (goto-char start) ; assumed at beginning of line
2812 (while (< (point) end)
2813 ;; Skip subdir line and following garbage like the `total' line:
2814 (while (and (< (point) end) (dired-between-files))
2815 (forward-line 1))
2816 (if (and (not (looking-at dired-re-dot))
2817 (dired-get-filename nil t))
2818 (progn
2819 (delete-char 1)
2820 (insert dired-marker-char)))
2821 (forward-line 1))))
2823 (defun dired-mark (arg)
2824 "Mark the current (or next ARG) files.
2825 If on a subdir headerline, mark all its files except `.' and `..'.
2829 this subdir."
2830 (interactive "P")
2831 (if (dired-get-subdir)
2832 (save-excursion (dired-mark-subdir-files))
2833 (let ((inhibit-read-only t))
2834 (dired-repeat-over-lines
2835 (prefix-numeric-value arg)
2836 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2838 (defun dired-unmark (arg)
2839 "Unmark the current (or next ARG) files.
2840 If looking at a subdir, unmark all its files except `.' and `..'."
2841 (interactive "P")
2843 (dired-mark arg)))
2845 (defun dired-flag-file-deletion (arg)
2846 "In Dired, flag the current line's file for deletion.
2847 With prefix arg, repeat over several lines.
2849 If on a subdir headerline, mark all its files except `.' and `..'."
2850 (interactive "P")
2851 (let ((dired-marker-char dired-del-marker))
2852 (dired-mark arg)))
2854 (defun dired-unmark-backward (arg)
2855 "In Dired, move up lines and remove deletion flag there.
2856 Optional prefix ARG says how many lines to unflag; default is one line."
2857 (interactive "p")
2858 (dired-unmark (- arg)))
2860 (defun dired-toggle-marks ()
2861 "Toggle marks: marked files become unmarked, and vice versa.
2862 Files marked with other flags (such as `D') are not affected.
2863 `.' and `..' are never toggled.
2864 As always, hidden subdirs are not affected."
2865 (interactive)
2866 (save-excursion
2867 (goto-char (point-min))
2868 (let ((inhibit-read-only t))
2869 (while (not (eobp))
2870 (or (dired-between-files)
2871 (looking-at dired-re-dot)
2872 ;; use subst instead of insdel because it does not move
2873 ;; the gap and thus should be faster and because
2874 ;; other characters are left alone automatically
2875 (apply 'subst-char-in-region
2876 (point) (1+ (point))
2880 (forward-line 1)))))
2881 \f
2882 ;;; Commands to mark or flag files based on their characteristics or names.
2884 (defvar dired-regexp-history nil
2885 "History list of regular expressions used in Dired commands.")
2887 (defun dired-read-regexp (prompt)
2888 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2890 (defun dired-mark-files-regexp (regexp &optional marker-char)
2891 "Mark all files matching REGEXP for use in later commands.
2892 A prefix argument means to unmark them instead.
2893 `.' and `..' are never marked.
2896 object files--just `.o' will mark more than you might think."
2897 (interactive
2898 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2899 " files (regexp): "))
2901 (let ((dired-marker-char (or marker-char dired-marker-char)))
2902 (dired-mark-if
2903 (and (not (looking-at dired-re-dot))
2904 (not (eolp)) ; empty line
2905 (let ((fn (dired-get-filename nil t)))
2906 (and fn (string-match regexp (file-name-nondirectory fn)))))
2907 "matching file")))
2909 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2910 "Mark all files with contents containing REGEXP for use in later commands.
2911 A prefix argument means to unmark them instead.
2912 `.' and `..' are never marked."
2913 (interactive
2914 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2915 " files containing (regexp): "))
2917 (let ((dired-marker-char (or marker-char dired-marker-char)))
2918 (dired-mark-if
2919 (and (not (looking-at dired-re-dot))
2920 (not (eolp)) ; empty line
2921 (let ((fn (dired-get-filename nil t)))
2922 (when (and fn (file-readable-p fn)
2923 (not (file-directory-p fn)))
2924 (let ((prebuf (get-file-buffer fn)))
2925 (message "Checking %s" fn)
2926 ;; For now we do it inside emacs
2927 ;; Grep might be better if there are a lot of files
2928 (if prebuf
2929 (with-current-buffer prebuf
2930 (save-excursion
2931 (goto-char (point-min))
2932 (re-search-forward regexp nil t)))
2933 (with-temp-buffer
2934 (insert-file-contents fn)
2935 (goto-char (point-min))
2936 (re-search-forward regexp nil t))))
2937 )))
2938 "matching file")))
2940 (defun dired-flag-files-regexp (regexp)
2941 "In Dired, flag all files containing the specified REGEXP for deletion.
2942 The match is against the non-directory part of the filename. Use `^'
2943 and `$' to anchor matches. Exclude subdirs by hiding them.
2944 `.' and `..' are never flagged."
2945 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2946 (dired-mark-files-regexp regexp dired-del-marker))
2948 (defun dired-mark-symlinks (unflag-p)
2949 "Mark all symbolic links.
2950 With prefix argument, unflag all those files."
2951 (interactive "P")
2953 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2955 (defun dired-mark-directories (unflag-p)
2956 "Mark all directory file lines except `.' and `..'.
2957 With prefix argument, unflag all those files."
2958 (interactive "P")
2960 (dired-mark-if (and (looking-at dired-re-dir)
2961 (not (looking-at dired-re-dot)))
2962 "directory file")))
2964 (defun dired-mark-executables (unflag-p)
2965 "Mark all executable files.
2966 With prefix argument, unflag all those files."
2967 (interactive "P")
2969 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2971 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2972 ;; files for which PREDICATE returns non-nil.
2974 (defun dired-flag-auto-save-files (&optional unflag-p)
2975 "Flag for deletion files whose names suggest they are auto save files.
2976 A prefix argument says to unflag those files instead."
2977 (interactive "P")
2979 (dired-mark-if
2980 ;; It is less than general to check for # here,
2981 ;; but it's the only way this runs fast enough.
2982 (and (save-excursion (end-of-line)
2983 (or
2984 (eq (preceding-char) ?#)
2985 ;; Handle executables in case of -F option.
2986 ;; We need not worry about the other kinds
2987 ;; of markings that -F makes, since they won't
2988 ;; appear on real auto-save files.
2989 (if (eq (preceding-char) ?*)
2990 (progn
2991 (forward-char -1)
2992 (eq (preceding-char) ?#)))))
2993 (not (looking-at dired-re-dir))
2994 (let ((fn (dired-get-filename t t)))
2995 (if fn (auto-save-file-name-p
2996 (file-name-nondirectory fn)))))
2997 "auto save file")))
2999 (defcustom dired-garbage-files-regexp
3000 ;; `log' here is dubious, since it's typically used for useful log
3001 ;; files, not just TeX stuff. -- fx
3002 (concat (regexp-opt
3003 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
3006 :type 'regexp
3007 :group 'dired)
3009 (defun dired-flag-garbage-files ()
3010 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3011 (interactive)
3012 (dired-flag-files-regexp dired-garbage-files-regexp))
3014 (defun dired-flag-backup-files (&optional unflag-p)
3015 "Flag all backup files (names ending with `~') for deletion.
3016 With prefix argument, unflag these files."
3017 (interactive "P")
3018 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
3019 (dired-mark-if
3020 ;; Don't call backup-file-name-p unless the last character looks like
3021 ;; it might be the end of a backup file name. This isn't very general,
3022 ;; but it's the only way this runs fast enough.
3023 (and (save-excursion (end-of-line)
3024 ;; Handle executables in case of -F option.
3025 ;; We need not worry about the other kinds
3026 ;; of markings that -F makes, since they won't
3027 ;; appear on real backup files.
3028 (if (eq (preceding-char) ?*)
3029 (forward-char -1))
3030 (eq (preceding-char) ?~))
3031 (not (looking-at dired-re-dir))
3032 (let ((fn (dired-get-filename t t)))
3033 (if fn (backup-file-name-p fn))))
3034 "backup file")))
3036 (defun dired-change-marks (&optional old new)
3037 "Change all OLD marks to NEW marks.
3038 OLD and NEW are both characters used to mark files."
3039 (interactive
3040 (let* ((cursor-in-echo-area t)
3041 (old (progn (message "Change (old mark): ") (read-char)))
3042 (new (progn (message "Change %c marks to (new mark): " old)
3043 (read-char))))
3044 (list old new)))
3046 (ding)
3048 (inhibit-read-only t))
3049 (save-excursion
3050 (goto-char (point-min))
3051 (while (search-forward string nil t)
3052 (if (if (= old ?\s)
3053 (save-match-data
3054 (dired-get-filename 'no-dir t))
3055 t)
3056 (subst-char-in-region (match-beginning 0)
3057 (match-end 0) old new)))))))
3059 (defun dired-unmark-all-marks ()
3060 "Remove all marks from all files in the dired buffer."
3061 (interactive)
3064 (defun dired-unmark-all-files (mark &optional arg)
3065 "Remove a specific mark (or any mark) from every file.
3066 After this command, type the mark character to remove,
3067 or type RET to remove all marks.
3068 With prefix arg, query for each marked file.
3071 (save-excursion
3072 (let* ((count 0)
3073 (inhibit-read-only t) case-fold-search query
3075 (help-form "\
3076 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3077 `!' to unmark all remaining files with no more questions."))
3078 (goto-char (point-min))
3080 (re-search-forward dired-re-mark nil t)
3081 (search-forward string nil t))
3082 (if (or (not arg)
3083 (let ((file (dired-get-filename t t)))
3084 (and file
3085 (dired-query 'query "Unmark file `%s'? "
3086 file))))
3087 (progn (subst-char-in-region (1- (point)) (point)
3088 (preceding-char) ?\s)
3089 (setq count (1+ count)))))
3090 (message (if (= count 1) "1 mark removed"
3091 "%d marks removed")
3092 count))))
3093 \f
3094 ;; Logging failures operating on files, and showing the results.
3096 (defvar dired-log-buffer "*Dired log*")
3098 (defun dired-why ()
3099 "Pop up a buffer with error log output from Dired.
3100 A group of errors from a single command ends with a formfeed.
3102 (interactive)
3103 (if (get-buffer dired-log-buffer)
3104 (let ((owindow (selected-window))
3105 (window (display-buffer (get-buffer dired-log-buffer))))
3106 (unwind-protect
3107 (progn
3108 (select-window window)
3109 (goto-char (point-max))
3110 (forward-line -1)
3111 (backward-page 1)
3112 (recenter 0))
3113 (select-window owindow)))))
3115 (defun dired-log (log &rest args)
3116 ;; Log a message or the contents of a buffer.
3117 ;; If LOG is a string and there are more args, it is formatted with
3119 ;; End each bunch of errors with (dired-log t):
3120 ;; this inserts the current time and buffer at the start of the page,
3122 (let ((obuf (current-buffer)))
3123 (with-current-buffer (get-buffer-create dired-log-buffer)
3124 (goto-char (point-max))
3125 (let ((inhibit-read-only t))
3126 (cond ((stringp log)
3127 (insert (if args
3128 (apply (function format) log args)
3129 log)))
3130 ((bufferp log)
3131 (insert-buffer-substring log))
3132 ((eq t log)
3133 (backward-page 1)
3134 (unless (bolp)
3136 (insert (current-time-string)
3138 (goto-char (point-max))
3141 (defun dired-log-summary (string failures)
3142 "State a summary of a command's failures, in echo area and log buffer.
3143 STRING is an overall summary of the failures.
3144 FAILURES is a list of file names that we failed to operate on,
3145 or nil if file names are not applicable."
3146 (if (= (length failures) 1)
3147 (message "%s"
3148 (with-current-buffer dired-log-buffer
3149 (goto-char (point-max))
3150 (backward-page 1)
3151 (if (eolp) (forward-line 1))
3152 (buffer-substring (point) (point-max))))
3153 (message (if failures "%s--type ? for details (%s)"
3154 "%s--type ? for details")
3155 string failures))
3156 ;; Log a summary describing a bunch of errors.
3158 (dired-log t))
3159 \f
3160 ;;; Sorting
3162 ;; Most ls can only sort by name or by date (with -t), nothing else.
3163 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3164 ;; So anything that does not contain these is sort "by name".
3166 (defvar dired-ls-sorting-switches "SXU"
3169 This indicates to Dired which option switches to watch out for because they
3170 will change the sorting order behavior of `ls'.
3172 To change the default sorting order \(e.g. add a `-v' option\), see the
3173 variable `dired-listing-switches'. To temporarily override the listing
3176 (defvar dired-sort-by-date-regexp
3177 (concat "^-[^" dired-ls-sorting-switches
3178 "]*t[^" dired-ls-sorting-switches "]*$")
3179 "Regexp recognized by Dired to set `by date' mode.")
3181 (defvar dired-sort-by-name-regexp
3182 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3183 "Regexp recognized by Dired to set `by name' mode.")
3185 (defvar dired-sort-inhibit nil
3186 "Non-nil means the Dired sort command is disabled.
3187 The idea is to set this buffer-locally in special dired buffers.")
3189 (defun dired-sort-set-modeline ()
3190 ;; Set modeline display according to dired-actual-switches.
3191 ;; Modeline display of "by name" or "by date" guarantees the user a
3192 ;; match with the corresponding regexps. Non-matching switches are
3193 ;; shown literally.
3194 (when (eq major-mode 'dired-mode)
3195 (setq mode-name
3196 (let (case-fold-search)
3197 (cond ((string-match
3198 dired-sort-by-name-regexp dired-actual-switches)
3199 "Dired by name")
3200 ((string-match
3201 dired-sort-by-date-regexp dired-actual-switches)
3202 "Dired by date")
3203 (t
3204 (concat "Dired " dired-actual-switches)))))
3205 (force-mode-line-update)))
3207 (defun dired-sort-toggle-or-edit (&optional arg)
3208 "Toggle between sort by date/name and refresh the dired buffer.
3209 With a prefix argument you can edit the current listing switches instead."
3210 (interactive "P")
3211 (when dired-sort-inhibit
3212 (error "Cannot sort this dired buffer"))
3213 (if arg
3214 (dired-sort-other
3215 (read-string "ls switches (must contain -l): " dired-actual-switches))
3216 (dired-sort-toggle)))
3218 (defun dired-sort-toggle ()
3219 ;; Toggle between sort by date/name. Reverts the buffer.
3220 (setq dired-actual-switches
3221 (let (case-fold-search)
3222 (if (string-match " " dired-actual-switches)
3223 ;; New toggle scheme: add/remove a trailing " -t"
3225 (substring dired-actual-switches 0 (match-beginning 0))
3226 (concat dired-actual-switches " -t"))
3227 ;; old toggle scheme: look for some 't' switch and add/remove it
3228 (concat
3229 "-l"
3230 (dired-replace-in-string (concat "[-lt"
3231 dired-ls-sorting-switches "]")
3232 ""
3233 dired-actual-switches)
3234 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3235 dired-actual-switches)
3236 ""
3237 "t")))))
3238 (dired-sort-set-modeline)
3239 (revert-buffer))
3241 ;; Some user code loads dired especially for this.
3242 ;; Don't do that--use replace-regexp-in-string instead.
3243 (defun dired-replace-in-string (regexp newtext string)
3244 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3246 (let ((result "") (start 0) mb me)
3247 (while (string-match regexp string start)
3248 (setq mb (match-beginning 0)
3249 me (match-end 0)
3250 result (concat result (substring string start mb) newtext)
3251 start me))
3252 (concat result (substring string start))))
3254 (defun dired-sort-other (switches &optional no-revert)
3255 "Specify new `ls' SWITCHES for current dired buffer.
3256 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3257 set the minor mode accordingly, others appear literally in the mode line.
3258 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3259 (dired-sort-R-check switches)
3260 (setq dired-actual-switches switches)
3261 (dired-sort-set-modeline)
3262 (or no-revert (revert-buffer)))
3264 (defvar dired-subdir-alist-pre-R nil
3265 "Value of `dired-subdir-alist' before -R switch added.")
3266 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3268 (defun dired-sort-R-check (switches)
3269 "Additional processing of -R in ls option string SWITCHES.
3270 Saves `dired-subdir-alist' when R is set and restores saved value
3271 minus any directories explicitly deleted when R is cleared.
3272 To be called first in body of `dired-sort-other', etc."
3273 (cond
3274 ((and (string-match "R" switches)
3275 (not (string-match "R" dired-actual-switches)))
3276 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3277 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3278 ((and (string-match "R" dired-actual-switches)
3279 (not (string-match "R" switches)))
3280 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3281 ;; that are still present:
3282 (setq dired-subdir-alist
3283 (if dired-subdir-alist-pre-R
3284 (let (subdirs)
3285 (while dired-subdir-alist-pre-R
3286 (if (assoc (caar dired-subdir-alist-pre-R)
3287 dired-subdir-alist)
3288 ;; subdir still present...
3289 (setq subdirs
3290 (cons (car dired-subdir-alist-pre-R)
3291 subdirs)))
3292 (setq dired-subdir-alist-pre-R
3293 (cdr dired-subdir-alist-pre-R)))
3294 (reverse subdirs))
3295 ;; No pre-R subdir alist, so revert to main directory
3296 ;; listing:
3297 (list (car (reverse dired-subdir-alist))))))))
3298 \f
3300 ;;;; Drag and drop support
3302 (defcustom dired-recursive-copies 'top
3303 "Decide whether recursive copies are allowed.
3304 A value of nil means no recursive copies.
3305 `always' means copy recursively without asking.
3306 `top' means ask for each directory at top level.
3307 Anything else means ask for each directory."
3308 :type '(choice :tag "Copy directories"
3309 (const :tag "No recursive copies" nil)
3310 (const :tag "Ask for each directory" t)
3311 (const :tag "Ask for each top directory only" top)
3312 (const :tag "Copy directories without asking" always))
3313 :group 'dired)
3315 (defun dired-dnd-popup-notice ()
3316 (message-box
3319 (declare-function x-popup-menu "xmenu.c" (position menu))
3321 (defun dired-dnd-do-ask-action (uri)
3322 ;; No need to get actions and descriptions from the source,
3323 ;; we only have three actions anyway.
3324 (let ((action (x-popup-menu
3325 t
3326 (list "What action?"
3327 (cons ""
3328 '(("Copy here" . copy)
3329 ("Move here" . move)
3330 ("Link here" . link)
3331 "--"
3332 ("Cancel" . nil)))))))
3333 (if action
3334 (dired-dnd-handle-local-file uri action)
3335 nil)))
3337 (declare-function dired-relist-entry "dired-aux" (file))
3338 (declare-function make-symbolic-link "fileio.c")
3340 ;; Only used when (featurep 'dnd).
3341 (declare-function dnd-get-local-file-name "dnd" (uri &optional must-exist))
3342 (declare-function dnd-get-local-file-uri "dnd" (uri))
3344 (defun dired-dnd-handle-local-file (uri action)
3345 "Copy, move or link a file to the dired directory.
3346 URI is the file to handle, ACTION is one of copy, move, link or ask.
3347 Ask means pop up a menu for the user to select one of copy, move or link."
3348 (require 'dired-aux)
3349 (let* ((from (dnd-get-local-file-name uri t))
3350 (to (when from
3351 (concat (dired-current-directory)
3352 (file-name-nondirectory from)))))
3353 (when from
3354 (cond ((eq action 'ask)
3355 (dired-dnd-do-ask-action uri))
3356 ;; If copying a directory and dired-recursive-copies is
3357 ;; nil, dired-copy-file fails. Pop up a notice.
3358 ((and (memq action '(copy private))
3359 (file-directory-p from)
3360 (not dired-recursive-copies))
3361 (dired-dnd-popup-notice))
3362 ((memq action '(copy private move link))
3363 (let ((overwrite (and (file-exists-p to)
3364 (y-or-n-p
3365 (format "Overwrite existing file `%s'? " to))))
3366 ;; Binding dired-overwrite-confirmed to nil makes
3367 ;; dired-handle-overwrite a no-op. We instead use
3368 ;; y-or-n-p, which pops a graphical menu.
3369 dired-overwrite-confirmed backup-file)
3370 (when (and overwrite
3371 ;; d-b-o is defined in dired-aux.
3372 (boundp 'dired-backup-overwrite)
3373 dired-backup-overwrite
3374 (setq backup-file
3375 (car (find-backup-file-name to)))
3376 (or (eq dired-backup-overwrite 'always)
3377 (y-or-n-p
3378 (format
3379 "Make backup for existing file `%s'? " to))))
3380 (rename-file to backup-file 0)
3381 (dired-relist-entry backup-file))
3382 (cond ((memq action '(copy private))
3383 (dired-copy-file from to overwrite))
3384 ((eq action 'move)
3385 (dired-rename-file from to overwrite))
3386 ((eq action 'link)
3387 (make-symbolic-link from to overwrite)))
3388 (dired-relist-entry to)
3389 action))))))
3391 (defun dired-dnd-handle-file (uri action)
3392 "Copy, move or link a file to the dired directory if it is a local file.
3393 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3394 ACTION is one of copy, move, link or ask.
3395 Ask means pop up a menu for the user to select one of copy, move or link."
3396 (let ((local-file (dnd-get-local-file-uri uri)))
3397 (if local-file (dired-dnd-handle-local-file local-file action)
3398 nil)))
3399 \f
3401 ;;;; Desktop support
3403 (eval-when-compile (require 'desktop))
3405 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3406 "Auxiliary information to be saved in desktop file."
3407 (cons
3408 ;; Value of `dired-directory'.
3409 (if (consp dired-directory)
3410 ;; Directory name followed by list of files.
3411 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3412 (cdr dired-directory))
3413 ;; Directory name, optionally with shell wildcard.
3414 (desktop-file-name dired-directory desktop-dirname))
3415 ;; Subdirectories in `dired-subdir-alist'.
3416 (cdr
3417 (nreverse
3418 (mapcar
3419 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3420 dired-subdir-alist)))))
3422 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3423 desktop-buffer-name
3424 desktop-buffer-misc)
3425 "Restore a dired buffer specified in a desktop file."
3426 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3427 ;; This value is a directory name, optionally with shell wildcard or
3428 ;; a directory name followed by list of files.
3429 (let* ((dired-dir (car desktop-buffer-misc))
3430 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3431 (if (file-directory-p (file-name-directory dir))
3432 (progn
3433 (dired dired-dir)
3434 ;; The following elements of `desktop-buffer-misc' are the keys
3435 ;; from `dired-subdir-alist'.
3436 (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3437 (current-buffer))
3438 (message "Desktop: Directory %s no longer exists." dir)
3439 (when desktop-missing-file-warning (sit-for 1))
3440 nil)))
3442 (add-to-list 'desktop-buffer-mode-handlers
3443 '(dired-mode . dired-restore-desktop-buffer))
3445 \f
3446 (provide 'dired)
3448 (run-hooks 'dired-load-hook) ; for your customizations
3450 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3451 ;;; dired.el ends here