| blob | 70ce1718eaaddf101fedd1a389aba23bb07a8c07 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
7 ;; Maintainer: FSF
8 ;; Keywords: files
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;; This is a major mode for directory browsing and editing. It is
30 ;; documented in the Emacs manual.
32 ;; Rewritten in 1990/1991 to add tree features, file marking and
33 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
34 ;; Finished up by rms in 1992.
36 ;;; Code:
38 ;;; Customizable variables
41 "Directory editing."
46 "Handling marks in Dired."
51 ;;;###autoload
53 "*Switches passed to `ls' for Dired. MUST contain the `l' option.
54 May contain all other options that don't contradict `-l';
55 may contain even `F', `b', `i' and `s'. See also the variable
56 `dired-ls-F-marks-symlinks' concerning the `F' switch.
57 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
58 some of the `ls' switches are not supported; see the doc string of
59 `insert-directory' in `ls-lisp.el' for more details."
64 "If non-nil, switches passed to `ls' for inserting subdirectories.
67 ; Don't use absolute file names as /bin should be in any PATH and people
68 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
69 ; usually not in PATH.
71 ;;;###autoload
74 "chown"
76 "/usr/sbin/chown"
89 ;;;###autoload
91 "*Informs Dired about how `ls -lF' marks symbolic links.
92 Set this to t if `ls' (or whatever program is specified by
93 `insert-directory-program') with `-lF' marks the symbolic link
94 itself with a trailing @ (usually the case under Ultrix).
96 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
97 nil (the default), if it gives `bar@ -> foo', set it to t.
99 Dired checks if there is really a @ appended. Thus, if you have a
100 marking `ls' program on one host and a non-marking on another host, and
101 don't care about symbolic links which really end in a @, you can
102 always set this variable to t."
106 ;;;###autoload
108 "*Regexp of files to skip when finding first file of a directory.
109 A value of nil means move to the subdir line.
110 A value of t means move to first file."
113 regexp)
116 ;;;###autoload
118 ;; Use t as default so that moved files "take their markers with them".
119 "*Controls marking of renamed files.
120 If t, files keep their previous marks when they are renamed.
121 If a character, renamed files (whether previously marked or not)
122 are afterward marked with that character."
127 ;;;###autoload
129 "*Controls marking of copied files.
130 If t, copied files are marked if and as the corresponding original files were.
131 If a character, copied files are unconditionally marked with that character."
136 ;;;###autoload
138 "*Controls marking of newly made hard links.
139 If t, they are marked if and as the files linked to were marked.
140 If a character, new links are unconditionally marked with that character."
145 ;;;###autoload
147 "*Controls marking of newly made symbolic links.
148 If t, they are marked if and as the files linked to were marked.
149 If a character, new links are unconditionally marked with that character."
154 ;;;###autoload
156 "*If non-nil, Dired tries to guess a default target directory.
157 This means: if there is a dired buffer displayed in the next window,
158 use its current subdir, instead of the current subdir of this dired buffer.
160 The target is used in the prompt for file copy, rename etc."
164 ;;;###autoload
166 "*If non-nil, Dired preserves the last-modified time in a file copy.
167 \(This works on only some systems.)"
171 ; These variables were deleted and the replacements are on files.el.
172 ; We leave aliases behind for back-compatibility.
176 ;;; Hook variables
179 "Run after loading Dired.
180 You can customize key bindings or load extensions with this."
185 "Run at the very end of `dired-mode'."
190 "This hook is run before a dired buffer is read in (created or reverted)."
195 "Hook run after each time a file or directory is read by Dired.
196 After each listing of a file or directory, this hook is run
197 with the buffer narrowed to the listing."
200 ;; Note this can't simply be run inside function `dired-ls' as the hook
201 ;; functions probably depend on the dired-subdir-alist to be OK.
207 "The functions to call when a drop in `dired-mode' is made.
208 See `dnd-protocol-alist' for more information. When nil, behave
209 as in other buffers. Changing this option is effective only for
210 new dired buffers."
216 ;; Internal variables
219 ;; so that you can write things like
220 ;; (let ((dired-marker-char ?X))
221 ;; ;; great code using X markers ...
222 ;; )
223 ;; For example, commands operating on two sets of files, A and B.
224 ;; Or marking files with digits 0-9. This could implicate
225 ;; concentric sets or an order for the marked files.
226 ;; The code depends on dynamic scoping on the marker char.
227 "In Dired, the current mark character.
234 ;; I see no reason ever to make this nil -- rms.
235 ;; (> baud-rate search-slow-speed)
242 ;;;###autoload
244 "The directory name or wildcard spec that this dired directory lists.
245 Local to each dired buffer. May be a list, in which case the car is the
246 directory name and the cdr is the list of files to mention.
255 ;; These regexps must be tested at beginning-of-line, but are also
256 ;; used to search for next matches, so neither omitting "^" nor
257 ;; replacing "^" by "\n" (to make it slightly faster) will work.
260 ;; "Regexp matching a marked line.
261 ;; Important: the match ends just after the marker."
263 ;; The [^:] part after "d" and "l" is to avoid confusion with the
264 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
272 "-[-r][-w].[-r][-w][xs][-r][-w]."
278 ;; The subdirectory names in the next two lists are expanded.
280 "Association list of subdirectories and their buffer positions.
281 Each subdirectory has an element: (DIRNAME . STARTMARKER).
282 The order of elements is the reverse of the order in the buffer.
286 "Keeps track of which switches to use for inserted subdirectories.
294 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
295 Subexpression 1 is the subdirectory proper, no trailing colon.
296 The match starts at the beginning of the line and ends after the end
301 "Faces used by Dired."
307 "Face used for directory headers."
315 "Face used for dired marks."
323 "Face used for marked files."
331 "Face used for flagged files."
338 ;; Inherit from font-lock-warning-face since with min-colors 8
339 ;; font-lock-comment-face is not colored any more.
341 "Face used to highlight a part of a buffer that needs user attention."
350 "Face used to highlight permissions of group- and world-writable files."
358 "Face used for subdirectories."
366 "Face used for symbolic links."
374 "Face used for files suffixed with `completion-ignored-extensions'."
382 ;;
383 ;; Directory headers.
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 )
456 \f
457 ;;; Macros must be defined before they are used, for the byte compiler.
460 "Mark all files for which PREDICATE evals to non-nil.
461 PREDICATE is evaluated on each line, with point at beginning of line.
462 MSG is a noun phrase for the type of files being marked.
463 It should end with a noun that can be pluralized by adding `s'.
464 Return value is the number of files marked, or nil if none were marked."
478 count
479 ,msg
487 distinguish-one-marked)
488 "Eval BODY with point on each marked line. Return a list of BODY's results.
489 If no marked file could be found, execute BODY on the current line.
490 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
491 files instead of the marked files.
492 In that case point is dragged along. This is so that commands on
493 the next ARG (instead of the marked) files can be chained easily.
494 If ARG is otherwise non-nil, use current file instead.
495 If optional third arg SHOW-PROGRESS evaluates to non-nil,
496 redisplay the dired buffer after each file is processed.
497 No guarantee is made about the position on the marked line.
498 BODY must ensure this itself if it depends on this.
499 Search starts at the beginning of the buffer, thus the car of the list
500 corresponds to the line nearest to the buffer's bottom. This
501 is also true for (positive and negative) integer values of ARG.
502 BODY should not be too long as it is expanded four times.
504 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
505 return (t FILENAME) instead of (FILENAME)."
506 ;;
507 ;;Warning: BODY must not add new lines before point - this may cause an
508 ;;endless loop.
509 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
516 ,arg
522 results))
523 ;; non-nil, non-integer ARG means use current file:
528 ;; remember position of next marked file before BODY
529 ;; can insert lines before the just found file,
530 ;; confusing us by finding the same marked file again
531 ;; and again and...
539 ;; move after last match
548 results
550 ;; save-excursion loses, again
554 "Return the marked files' names as list of strings.
555 The list is in the same order as the buffer, that is, the car is the
556 first marked file.
557 Values returned are normally absolute file names.
558 Optional arg LOCALP as in `dired-get-filename'.
559 Optional second argument ARG specifies files near point
560 instead of marked files. If ARG is an integer, use the next ARG files.
561 If ARG is otherwise non-nil, use file. Usually ARG comes from
562 the command's prefix arg.
563 Optional third argument FILTER, if non-nil, is a function to select
564 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
566 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
567 return (t FILENAME) instead of (FILENAME).
568 Don't use that together with FILTER."
573 arg nil distinguish-one-marked)))
574 result)
577 all-of-them
582 result)))
583 \f
584 ;; The dired command
587 ;; For use in interactive.
591 dired-listing-switches))
592 ;; If a dialog is about to be used, call read-directory-name so
593 ;; the dialog code knows we want directories. Some dialogs can
594 ;; only select directories or files when popped up, not both.
597 nil default-directory nil)
603 nil default-directory nil)))))))
605 ;;;###autoload (define-key ctl-x-map "d" 'dired)
606 ;;;###autoload
609 Optional second argument SWITCHES specifies the `ls' options used.
610 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
611 Dired displays a list of files in DIRNAME (which may also have
612 shell wildcards appended to select certain files). If DIRNAME is a cons,
613 its first element is taken as the directory name and the rest as an explicit
614 list of files to make directory entries for.
616 You can move around in it with the usual commands.
621 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
622 ;; Cannot use (interactive "D") because of wildcards.
626 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
627 ;;;###autoload
633 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
634 ;;;###autoload
640 ;;;###autoload
642 "Like `dired' but returns the dired buffer as value, does not select it."
644 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
645 ;; some shells make:
656 ;; If the argument was syntactically a directory name not a file name,
657 ;; or if it happens to name a file that is a directory,
658 ;; convert it syntactically to a directory name.
659 ;; The reason for checking initially-was-dirname
660 ;; and not just file-directory-p
661 ;; is that file-directory-p is slow over ftp.
669 ;; The following is an internal dired function. It returns non-nil if
670 ;; the directory visited by the current dired buffer has changed on
671 ;; disk. DIRNAME should be the directory name of that directory.
680 "Return non-nil if current dired buffer needs updating.
681 If NOCONFIRM is non-nil, then this function always returns nil
682 for a remote directory. This feature is used by Auto Revert Mode."
690 ;; Separate function from dired-noselect for the sake of dired-vms.el.
692 ;; If there is an existing dired buffer for DIRNAME, just leave
693 ;; buffer as it is (don't even call dired-revert).
694 ;; This saves time especially for deep trees or with ange-ftp.
695 ;; The user can type `g' easily, and it is more consistent with find-file.
696 ;; But if SWITCHES are given they are probably different from the
697 ;; buffer's old value, so call dired-sort-other, which does
698 ;; revert the buffer.
699 ;; A pity we can't possibly do "Directory has changed - refresh? "
700 ;; like find-file does.
701 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
702 ;; see there.
704 buffer
705 ;; note that buffer already is in dired-mode, if found
706 new-buffer-p
711 ;; Look for an existing buffer.
716 ;; We don't want default-major-mode to run hooks and set auto-fill
717 ;; or whatever, now that dired-mode does not
718 ;; kill-all-local-variables any longer.
723 ;; file list may have changed
725 ;; this calls dired-revert
727 ;; If directory has changed on disk, offer to revert.
732 ;; Else a new buffer
734 ;; We can do this unconditionally
735 ;; because dired-noselect ensures that the name
736 ;; is passed in directory name syntax
737 ;; if it was the name of a directory at all.
742 ;; default-directory and dired-actual-switches are set now
743 ;; (buffer-local), so we can call dired-readin:
748 ;; dired-readin can fail if parent directories are inaccessible.
749 ;; Don't leave an empty buffer around in that case.
754 buffer))
757 ;; Enlarged by dired-advertise
758 ;; Queried by function dired-buffers-for-dir. When this detects a
759 ;; killed buffer, it is removed from this list.
763 ;; This differs from dired-buffers-for-dir in that it does not consider
764 ;; subdirs of default-directory and searches for the first match only.
765 ;; Also, the major mode must be MODE.
775 dired-directory ;; nil during find-alternate-file
780 dired-directory))))
782 blist nil)
784 found))
786 \f
787 ;; Read in a new dired buffer
790 "Read in a new dired buffer.
791 Differs from `dired-insert-subdir' in that it accepts
792 wildcards, erases the buffer, and builds the subdir-alist anew
793 \(including making it buffer-local and clearing it first)."
795 ;; default-directory and dired-actual-switches must be buffer-local
796 ;; and initialized by now.
803 ;; This hook which may want to modify dired-actual-switches
804 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
805 ;; where ls won't understand -Al switches.
813 ;; Don't make undo entries for readin.
819 ;; Must first make alist buffer local and set it to nil because
820 ;; dired-build-subdir-alist will call dired-clear-alist first
827 ;; No need to narrow since the whole buffer contains just
828 ;; dired-readin's output, nothing else. The hook can
829 ;; successfully use dired functions (e.g. dired-get-filename)
830 ;; as the subdir-alist has been built in dired-readin.
833 ;; Subroutines of dired-readin
836 ;; Insert listing for the specified dir (and maybe file list)
837 ;; already in dired-directory, assuming a clean buffer.
843 file-list nil))
847 ;; If we are reading a whole single directory...
852 ;; Else treat it as a wildcard spec
853 ;; unless we have an explicit list of files.
858 "Align the fields of a file to the ones of surrounding lines.
859 BEG..END is the line where the file info is located."
860 ;; Some versions of ls try to adjust the size of each field so as to just
861 ;; hold the largest element ("largest" in the current invocation, of
862 ;; course). So when a single line is output, the size of each field is
863 ;; just big enough for that one output. Thus when dired refreshes one
864 ;; line, the alignment if this line w.r.t the rest is messed up because
865 ;; the fields of that one line will generally be smaller.
866 ;;
867 ;; To work around this problem, we here add spaces to try and
868 ;; re-align the fields as needed. Since this is purely aesthetic,
869 ;; it is of utmost importance that it doesn't mess up anything like
870 ;; `dired-move-to-filename'. To this end, we limit ourselves to
871 ;; adding spaces only, and to only add them at places where there
872 ;; was already at least one space. This way, as long as
873 ;; `directory-listing-before-filename-regexp' always matches spaces
874 ;; with "*" or "+", we know we haven't made anything worse. There
875 ;; is one spot where the exact number of spaces is important, which
876 ;; is just before the actual filename, so we refrain from adding
877 ;; spaces there (and within the filename as well, of course).
880 ;; Check the there is indeed a file, and that there is anoter adjacent
881 ;; file with which to align, and that additional spaces are needed to
882 ;; align the filenames.
895 ;; Make sure there is some work left to do.
897 ;; If we've only looked at the line above, check to see if the line
898 ;; below exists as well and if so, align with the shorter one.
907 ;; Keep positions uptodate when we insert stuff.
910 ;; Main loop.
914 ;; Don't touch anything just before (and after) the
915 ;; beginning of the filename.
917 ;; We're now just in front of a field, with a space behind us.
919 ;; Nums are right-aligned.
921 ;; Let's look at the other line, in the same column: we
922 ;; should be either near the end of the previous field, or
923 ;; in the space between that field and the next.
924 ;; [ Of course, it's also possible that we're already within
925 ;; the next field or even past it, but that's unlikely since
926 ;; other-col > file-col. ]
927 ;; Let's find the distance to the alignment-point (either
928 ;; the beginning or the end of the next field, depending on
929 ;; whether this field is left or right aligned).
939 ;; Now, the number of spaces to insert is align-pt-offset
940 ;; minus the distance to the equivalent point on the
941 ;; current line.
944 align-pt-offset
954 ;; Let's just make really sure we did not mess up.
957 ;; Damn! We messed up: let's revert the change.
959 ;; Now skip to next field.
965 "Insert a directory listing of DIR, Dired style.
966 Use SWITCHES to make the listings.
967 If FILE-LIST is non-nil, list only those files.
968 Otherwise, if WILDCARD is non-nil, expand wildcards;
969 in that case, DIR should be a file name that uses wildcards.
970 In other cases, DIR should be a directory name or a directory filename.
971 If HDR is non-nil, insert a header line with the directory name."
974 end)
977 ;; We used to specify the C locale here, to force English month names;
978 ;; but this should not be necessary any more,
979 ;; with the new value of `directory-listing-before-filename-regexp'.
984 ;; Re-align fields, if necessary.
987 ;; Quote certain characters, unless ls quoted them for us.
996 nil t))
1002 nil t))
1005 ;; If we used --dired and it worked, the lines are already indented.
1006 ;; Otherwise, indent them.
1012 ;; Insert text at the beginning to standardize things.
1016 ;; Note that dired-build-subdir-alist will replace the name
1017 ;; by its expansion, so it does not matter whether what we insert
1018 ;; here is fully expanded, but it should be absolute.
1021 ;; Insert "wildcard" line where "total" line would be for a full dir.
1025 "Make the file names highlight when the mouse is on them."
1040 \f
1041 ;; Reverting a dired buffer
1044 "Reread the dired buffer.
1045 Must also be called after `dired-actual-switches' have changed.
1046 Should not fail even on completely garbaged buffers.
1047 Preserves old cursor, marks/flags, hidden-p."
1056 buffer-read-only)
1060 ;; treat top level dir extra (it may contain wildcards)
1063 ;; Run dired-after-readin-hook just once, below.
1068 ;; ... run the hook for the whole buffer, and only after markers
1069 ;; have been reinserted (else omitting in dired-x would omit marked files)
1079 ;; outside of the let scope
1080 ;;; Might as well not override the user if the user changed this.
1081 ;;; (setq buffer-read-only t)
1082 )
1084 ;; Subroutines of dired-revert
1085 ;; Some of these are also used when inserting subdirs.
1088 "Return alist of files and their marks, from BEG to END."
1099 alist))
1102 "Mark all files remembered in ALIST.
1103 Each element of ALIST looks like (FILE . MARKERCHAR)."
1117 "Return a list of names of subdirs currently hidden."
1127 result))
1130 "Try to insert all subdirs that were displayed before.
1131 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1145 "Remove directory DIR from any directory cache."
1149 \f
1150 ;; dired mode key bindings and initialization
1153 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1154 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1159 ;; Commands to mark or flag certain categories of files
1164 ;; Upper case keys (except !) for operating on the marked files
1182 ;; Comparison commands
1185 ;; Tree Dired commands
1191 ;; move to marked files
1194 ;; Make all regexp commands share a `%' prefix:
1195 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1196 ;; but that seems to serve little purpose, and copy-keymap
1197 ;; does a better job without it.
1209 ;; Commands for marking and unmarking.
1226 ;; Lower keys for commands not operating on all the marked files
1252 ;; moving
1260 (define-key map [up] 'dired-previous-line)
1261 ;; hiding
1262 (define-key map "$" 'dired-hide-subdir)
1263 (define-key map "\M-$" 'dired-hide-all)
1264 ;; misc
1265 (define-key map "\C-x\C-q" 'dired-toggle-read-only)
1266 (define-key map "?" 'dired-summary)
1268 (define-key map [remap undo] 'dired-undo)
1269 (define-key map [remap advertised-undo] 'dired-undo)
1270 ;; thumbnail manipulation (image-dired)
1271 (define-key map "\C-td" 'image-dired-display-thumbs)
1272 (define-key map "\C-tt" 'image-dired-tag-files)
1273 (define-key map "\C-tr" 'image-dired-delete-tag)
1274 (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1275 (define-key map "\C-ti" 'image-dired-dired-display-image)
1276 (define-key map "\C-tx" 'image-dired-dired-display-external)
1277 (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1278 (define-key map "\C-t." 'image-dired-display-thumb)
1279 (define-key map "\C-tc" 'image-dired-dired-comment-files)
1280 (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1281 (define-key map "\C-t\C-t" 'image-dired-dired-insert-marked-thumbs)
1282 (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1284 ;; Make menu bar items.
1286 ;; No need to fo this, now that top-level items are fewer.
1287 ;;;;
1288 ;; Get rid of the Edit menu bar item to save space.
1289 ;(define-key map [menu-bar edit] 'undefined)
1291 (define-key map [menu-bar subdir]
1292 (cons "Subdir" (make-sparse-keymap "Subdir")))
1294 (define-key map [menu-bar subdir hide-all]
1295 '(menu-item "Hide All" dired-hide-all
1296 :help "Hide all subdirectories, leave only header lines"))
1297 (define-key map [menu-bar subdir hide-subdir]
1298 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1299 :help "Hide or unhide current directory listing"))
1300 (define-key map [menu-bar subdir tree-down]
1301 '(menu-item "Tree Down" dired-tree-down
1302 :help "Go to first subdirectory header down the tree"))
1303 (define-key map [menu-bar subdir tree-up]
1304 '(menu-item "Tree Up" dired-tree-up
1305 :help "Go to first subdirectory header up the tree"))
1306 (define-key map [menu-bar subdir up]
1307 '(menu-item "Up Directory" dired-up-directory
1308 :help "Edit the parent directory"))
1309 (define-key map [menu-bar subdir prev-subdir]
1310 '(menu-item "Prev Subdir" dired-prev-subdir
1311 :help "Go to previous subdirectory header line"))
1312 (define-key map [menu-bar subdir next-subdir]
1313 '(menu-item "Next Subdir" dired-next-subdir
1314 :help "Go to next subdirectory header line"))
1315 (define-key map [menu-bar subdir prev-dirline]
1316 '(menu-item "Prev Dirline" dired-prev-dirline
1317 :help "Move to next directory-file line"))
1318 (define-key map [menu-bar subdir next-dirline]
1319 '(menu-item "Next Dirline" dired-next-dirline
1320 :help "Move to previous directory-file line"))
1321 (define-key map [menu-bar subdir insert]
1322 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1323 :help "Insert contents of subdirectory"))
1325 (define-key map [menu-bar immediate]
1326 (cons "Immediate" (make-sparse-keymap "Immediate")))
1328 (define-key map
1329 [menu-bar immediate image-dired-dired-display-external]
1330 '(menu-item "Display Image Externally" image-dired-dired-display-external
1331 :help "Display image in external viewer"))
1332 (define-key map
1333 [menu-bar immediate image-dired-dired-display-image]
1334 '(menu-item "Display Image" image-dired-dired-display-image
1335 :help "Display sized image in a separate window"))
1337 (define-key map [menu-bar immediate dashes-4]
1338 '("--"))
1340 (define-key map [menu-bar immediate revert-buffer]
1341 '(menu-item "Refresh" revert-buffer
1342 :help "Update contents of shown directories"))
1344 (define-key map [menu-bar immediate dashes]
1345 '("--"))
1347 (define-key map [menu-bar immediate compare-directories]
1348 '(menu-item "Compare Directories..." dired-compare-directories
1349 :help "Mark files with different attributes in two dired buffers"))
1350 (define-key map [menu-bar immediate backup-diff]
1351 '(menu-item "Compare with Backup" dired-backup-diff
1352 :help "Diff file at cursor with its latest backup"))
1353 (define-key map [menu-bar immediate diff]
1354 '(menu-item "Diff..." dired-diff
1355 :help "Compare file at cursor with another file"))
1356 (define-key map [menu-bar immediate view]
1357 '(menu-item "View This File" dired-view-file
1358 :help "Examine file at cursor in read-only mode"))
1359 (define-key map [menu-bar immediate display]
1360 '(menu-item "Display in Other Window" dired-display-file
1361 :help "Display file at cursor in other window"))
1362 (define-key map [menu-bar immediate find-file-other-window]
1363 '(menu-item "Find in Other Window" dired-find-file-other-window
1364 :help "Edit file at cursor in other window"))
1365 (define-key map [menu-bar immediate find-file]
1366 '(menu-item "Find This File" dired-find-file
1367 :help "Edit file at cursor"))
1368 (define-key map [menu-bar immediate create-directory]
1369 '(menu-item "Create Directory..." dired-create-directory))
1370 (define-key map [menu-bar immediate wdired-mode]
1371 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1372 :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1374 (define-key map [menu-bar regexp]
1375 (cons "Regexp" (make-sparse-keymap "Regexp")))
1377 (define-key map
1378 [menu-bar regexp image-dired-mark-tagged-files]
1379 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1380 :help "Mark files whose image tags matches regexp"))
1382 (define-key map [menu-bar regexp dashes-1]
1383 '("--"))
1385 (define-key map [menu-bar regexp downcase]
1386 '(menu-item "Downcase" dired-downcase
1387 ;; When running on plain MS-DOS, there's only one
1388 ;; letter-case for file names.
1389 :enable (or (not (fboundp 'msdos-long-file-names))
1390 (msdos-long-file-names))
1391 :help "Rename marked files to lower-case name"))
1392 (define-key map [menu-bar regexp upcase]
1393 '(menu-item "Upcase" dired-upcase
1394 :enable (or (not (fboundp 'msdos-long-file-names))
1395 (msdos-long-file-names))
1396 :help "Rename marked files to upper-case name"))
1397 (define-key map [menu-bar regexp hardlink]
1398 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1399 :help "Make hard links for files matching regexp"))
1400 (define-key map [menu-bar regexp symlink]
1401 '(menu-item "Symlink..." dired-do-symlink-regexp
1402 :visible (fboundp 'make-symbolic-link)
1403 :help "Make symbolic links for files matching regexp"))
1404 (define-key map [menu-bar regexp rename]
1405 '(menu-item "Rename..." dired-do-rename-regexp
1406 :help "Rename marked files matching regexp"))
1407 (define-key map [menu-bar regexp copy]
1408 '(menu-item "Copy..." dired-do-copy-regexp
1409 :help "Copy marked files matching regexp"))
1410 (define-key map [menu-bar regexp flag]
1411 '(menu-item "Flag..." dired-flag-files-regexp
1412 :help "Flag files matching regexp for deletion"))
1413 (define-key map [menu-bar regexp mark]
1414 '(menu-item "Mark..." dired-mark-files-regexp
1415 :help "Mark files matching regexp for future operations"))
1416 (define-key map [menu-bar regexp mark-cont]
1417 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1418 :help "Mark files whose contents matches regexp"))
1420 (define-key map [menu-bar mark]
1421 (cons "Mark" (make-sparse-keymap "Mark")))
1423 (define-key map [menu-bar mark prev]
1424 '(menu-item "Previous Marked" dired-prev-marked-file
1425 :help "Move to previous marked file"))
1426 (define-key map [menu-bar mark next]
1427 '(menu-item "Next Marked" dired-next-marked-file
1428 :help "Move to next marked file"))
1429 (define-key map [menu-bar mark marks]
1430 '(menu-item "Change Marks..." dired-change-marks
1431 :help "Replace marker with another character"))
1432 (define-key map [menu-bar mark unmark-all]
1433 '(menu-item "Unmark All" dired-unmark-all-marks))
1434 (define-key map [menu-bar mark symlinks]
1435 '(menu-item "Mark Symlinks" dired-mark-symlinks
1436 :visible (fboundp 'make-symbolic-link)
1437 :help "Mark all symbolic links"))
1438 (define-key map [menu-bar mark directories]
1439 '(menu-item "Mark Directories" dired-mark-directories
1440 :help "Mark all directories except `.' and `..'"))
1441 (define-key map [menu-bar mark directory]
1442 '(menu-item "Mark Old Backups" dired-clean-directory
1443 :help "Flag old numbered backups for deletion"))
1444 (define-key map [menu-bar mark executables]
1445 '(menu-item "Mark Executables" dired-mark-executables
1446 :help "Mark all executable files"))
1447 (define-key map [menu-bar mark garbage-files]
1448 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1449 :help "Flag unneeded files for deletion"))
1450 (define-key map [menu-bar mark backup-files]
1451 '(menu-item "Flag Backup Files" dired-flag-backup-files
1452 :help "Flag all backup files for deletion"))
1453 (define-key map [menu-bar mark auto-save-files]
1454 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1455 :help "Flag auto-save files for deletion"))
1456 (define-key map [menu-bar mark deletion]
1457 '(menu-item "Flag" dired-flag-file-deletion
1458 :help "Flag current line's file for deletion"))
1459 (define-key map [menu-bar mark unmark]
1460 '(menu-item "Unmark" dired-unmark
1461 :help "Unmark or unflag current line's file"))
1462 (define-key map [menu-bar mark mark]
1463 '(menu-item "Mark" dired-mark
1464 :help "Mark current line's file for future operations"))
1465 (define-key map [menu-bar mark toggle-marks]
1466 '(menu-item "Toggle Marks" dired-toggle-marks
1467 :help "Mark unmarked files, unmark marked ones"))
1469 (define-key map [menu-bar operate]
1470 (cons "Operate" (make-sparse-keymap "Operate")))
1472 (define-key map
1473 [menu-bar operate image-dired-delete-tag]
1474 '(menu-item "Delete Image Tag..." image-dired-delete-tag
1475 :help "Delete image tag from current or marked files"))
1476 (define-key map
1477 [menu-bar operate image-dired-tag-files]
1478 '(menu-item "Add Image Tags..." image-dired-tag-files
1479 :help "Add image tags to current or marked files"))
1480 (define-key map
1481 [menu-bar operate image-dired-dired-comment-files]
1482 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1483 :help "Add image comment to current or marked files"))
1484 (define-key map
1485 [menu-bar operate image-dired-display-thumbs]
1486 '(menu-item "Display Image-Dired" image-dired-display-thumbs
1487 :help "Display image-dired for current or marked image files"))
1489 (define-key map [menu-bar operate dashes-3]
1490 '("--"))
1492 (define-key map [menu-bar operate query-replace]
1493 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1494 :help "Replace regexp in marked files"))
1495 (define-key map [menu-bar operate search]
1496 '(menu-item "Search Files..." dired-do-search
1497 :help "Search marked files for regexp"))
1498 (define-key map [menu-bar operate chown]
1499 '(menu-item "Change Owner..." dired-do-chown
1500 :visible (not (memq system-type '(ms-dos windows-nt)))
1501 :help "Change the owner of marked files"))
1502 (define-key map [menu-bar operate chgrp]
1503 '(menu-item "Change Group..." dired-do-chgrp
1504 :visible (not (memq system-type '(ms-dos windows-nt)))
1505 :help "Change the group of marked files"))
1506 (define-key map [menu-bar operate chmod]
1507 '(menu-item "Change Mode..." dired-do-chmod
1508 :help "Change mode (attributes) of marked files"))
1509 (define-key map [menu-bar operate touch]
1510 '(menu-item "Change Timestamp..." dired-do-touch
1511 :help "Change timestamp of marked files"))
1512 (define-key map [menu-bar operate load]
1513 '(menu-item "Load" dired-do-load
1514 :help "Load marked Emacs Lisp files"))
1515 (define-key map [menu-bar operate compile]
1516 '(menu-item "Byte-compile" dired-do-byte-compile
1517 :help "Byte-compile marked Emacs Lisp files"))
1518 (define-key map [menu-bar operate compress]
1519 '(menu-item "Compress" dired-do-compress
1520 :help "Compress/uncompress marked files"))
1521 (define-key map [menu-bar operate print]
1522 '(menu-item "Print..." dired-do-print
1523 :help "Ask for print command and print marked files"))
1524 (define-key map [menu-bar operate hardlink]
1525 '(menu-item "Hardlink to..." dired-do-hardlink
1526 :help "Make hard links for current or marked files"))
1527 (define-key map [menu-bar operate symlink]
1528 '(menu-item "Symlink to..." dired-do-symlink
1529 :visible (fboundp 'make-symbolic-link)
1530 :help "Make symbolic links for current or marked files"))
1531 (define-key map [menu-bar operate command]
1532 '(menu-item "Shell Command..." dired-do-shell-command
1533 :help "Run a shell command on each of marked files"))
1534 (define-key map [menu-bar operate delete]
1535 '(menu-item "Delete" dired-do-delete
1536 :help "Delete current file or all marked files"))
1537 (define-key map [menu-bar operate rename]
1538 '(menu-item "Rename to..." dired-do-rename
1539 :help "Rename current file or move marked files"))
1540 (define-key map [menu-bar operate copy]
1541 '(menu-item "Copy to..." dired-do-copy
1542 :help "Copy current file or all marked files"))
1544 map)
1545 "Local keymap for `dired-mode' buffers.")
1546 \f
1547 ;; Dired mode is suitable only for specially formatted data.
1548 (put 'dired-mode 'mode-class 'special)
1550 ;; Autoload cookie needed by desktop.el
1551 ;;;###autoload
1552 (defun dired-mode (&optional dirname switches)
1553 "\
1556 \(optionally) its subdirectories, in the format of `ls -lR'.
1559 compress, load or byte-compile them, change their file attributes
1562 by file or all files matching certain criteria.
1564 Letters no longer insert themselves. Digits are prefix arguments.
1567 Most commands operate on the marked files and use the current file
1568 if no files are marked. Use a numeric prefix argument to operate on
1569 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1570 to operate on the current file only. Prefix arguments override marks.
1572 to see why something went wrong.
1577 (or dired it in another buffer, if it is a directory).
1584 This retains all marks and hides subdirs again that were hidden before.
1585 SPC and DEL can be used to move down and up by lines.
1588 to read the
1590 to relist a single or the marked files or a
1592 again for the directory tree.
1595 for more info):
1597 `dired-listing-switches'
1598 `dired-trivial-filenames'
1599 `dired-shrink-to-fit'
1600 `dired-marker-char'
1601 `dired-del-marker'
1602 `dired-keep-marker-rename'
1603 `dired-keep-marker-copy'
1604 `dired-keep-marker-hardlink'
1605 `dired-keep-marker-symlink'
1609 `dired-before-readin-hook'
1610 `dired-after-readin-hook'
1611 `dired-mode-hook'
1612 `dired-load-hook'
1614 Keybindings:
1616 ;; Not to be called interactively (e.g. dired-directory will be set
1617 ;; to default-directory, which is wrong with wildcards).
1618 (kill-all-local-variables)
1619 (use-local-map dired-mode-map)
1620 (dired-advertise) ; default-directory is already set
1621 (setq major-mode 'dired-mode
1622 mode-name "Dired"
1623 ;; case-fold-search nil
1624 buffer-read-only t
1625 selective-display t ; for subdirectory hiding
1626 mode-line-buffer-identification
1627 (propertized-buffer-identification "%17b"))
1628 (set (make-local-variable 'revert-buffer-function)
1629 (function dired-revert))
1630 (set (make-local-variable 'buffer-stale-function)
1631 (function dired-buffer-stale-p))
1632 (set (make-local-variable 'page-delimiter)
1634 (set (make-local-variable 'dired-directory)
1635 (or dirname default-directory))
1636 ;; list-buffers uses this to display the dir being edited in this buffer.
1637 (set (make-local-variable 'list-buffers-directory)
1638 (expand-file-name (if (listp dired-directory)
1639 (car dired-directory)
1640 dired-directory)))
1641 (set (make-local-variable 'dired-actual-switches)
1642 (or switches dired-listing-switches))
1643 (set (make-local-variable 'font-lock-defaults)
1644 '(dired-font-lock-keywords t nil nil beginning-of-line))
1645 (set (make-local-variable 'desktop-save-buffer)
1646 'dired-desktop-buffer-misc-data)
1647 (setq dired-switches-alist nil)
1648 (dired-sort-other dired-actual-switches t)
1649 (when (featurep 'dnd)
1650 (set (make-local-variable 'dnd-protocol-alist)
1651 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1652 (run-mode-hooks 'dired-mode-hook))
1653 \f
1654 ;; Idiosyncratic dired commands that don't deal with marks.
1656 (defun dired-summary ()
1657 "Summarize basic Dired commands and show recent dired errors."
1658 (interactive)
1659 (dired-why)
1660 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1661 (message
1662 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1664 (defun dired-undo ()
1665 "Undo in a dired buffer.
1666 This doesn't recover lost files, it just undoes changes in the buffer itself.
1667 You can use it to recover marks, killed lines or subdirs."
1668 (interactive)
1669 (let (buffer-read-only)
1670 (undo))
1671 (dired-build-subdir-alist)
1672 (message "Change in dired buffer undone.
1673 Actual changes in files cannot be undone by Emacs."))
1675 (defun dired-toggle-read-only ()
1676 "Edit dired buffer with Wdired, or set it read-only.
1677 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1678 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1679 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1680 (interactive)
1681 (if (eq major-mode 'dired-mode)
1682 (wdired-change-to-wdired-mode)
1683 (toggle-read-only)))
1685 (defun dired-next-line (arg)
1686 "Move down lines then position at filename.
1687 Optional prefix ARG says how many lines to move; default is one line."
1688 (interactive "p")
1689 (forward-line arg)
1690 (dired-move-to-filename))
1692 (defun dired-previous-line (arg)
1693 "Move up lines then position at filename.
1694 Optional prefix ARG says how many lines to move; default is one line."
1695 (interactive "p")
1696 (forward-line (- arg))
1697 (dired-move-to-filename))
1699 (defun dired-next-dirline (arg &optional opoint)
1700 "Goto ARG'th next directory file line."
1701 (interactive "p")
1702 (or opoint (setq opoint (point)))
1703 (if (if (> arg 0)
1704 (re-search-forward dired-re-dir nil t arg)
1705 (beginning-of-line)
1706 (re-search-backward dired-re-dir nil t (- arg)))
1707 (dired-move-to-filename) ; user may type `i' or `f'
1708 (goto-char opoint)
1709 (error "No more subdirectories")))
1711 (defun dired-prev-dirline (arg)
1712 "Goto ARG'th previous directory file line."
1713 (interactive "p")
1714 (dired-next-dirline (- arg)))
1716 (defun dired-up-directory (&optional other-window)
1717 "Run Dired on parent directory of current directory.
1718 Find the parent directory either in this buffer or another buffer.
1719 Creates a buffer if necessary."
1720 (interactive "P")
1721 (let* ((dir (dired-current-directory))
1722 (up (file-name-directory (directory-file-name dir))))
1723 (or (dired-goto-file (directory-file-name dir))
1724 ;; Only try dired-goto-subdir if buffer has more than one dir.
1725 (and (cdr dired-subdir-alist)
1726 (dired-goto-subdir up))
1727 (progn
1728 (if other-window
1729 (dired-other-window up)
1730 (dired up))
1731 (dired-goto-file dir)))))
1733 (defun dired-get-file-for-visit ()
1734 "Get the current line's file name, with an error if file does not exist."
1735 (interactive)
1736 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1737 (let ((raw (dired-get-filename nil t))
1738 file-name)
1739 (if (null raw)
1740 (error "No file on this line"))
1741 (setq file-name (file-name-sans-versions raw t))
1742 (if (file-exists-p file-name)
1743 file-name
1744 (if (file-symlink-p file-name)
1745 (error "File is a symlink to a nonexistent target")
1746 (error "File no longer exists; type `g' to update dired buffer")))))
1748 ;; Force `f' rather than `e' in the mode doc:
1749 (defalias 'dired-advertised-find-file 'dired-find-file)
1750 (defun dired-find-file ()
1751 "In Dired, visit the file or directory named on this line."
1752 (interactive)
1753 ;; Bind `find-file-run-dired' so that the command works on directories
1754 ;; too, independent of the user's setting.
1755 (let ((find-file-run-dired t))
1756 (find-file (dired-get-file-for-visit))))
1758 (defun dired-find-alternate-file ()
1759 "In Dired, visit this file or directory instead of the dired buffer."
1760 (interactive)
1761 (set-buffer-modified-p nil)
1762 (find-alternate-file (dired-get-file-for-visit)))
1763 ;; Don't override the setting from .emacs.
1764 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1766 (defun dired-mouse-find-file-other-window (event)
1767 "In Dired, visit the file or directory name you click on."
1768 (interactive "e")
1769 (let (window pos file)
1770 (save-excursion
1771 (setq window (posn-window (event-end event))
1772 pos (posn-point (event-end event)))
1773 (if (not (windowp window))
1774 (error "No file chosen"))
1775 (set-buffer (window-buffer window))
1776 (goto-char pos)
1777 (setq file (dired-get-file-for-visit)))
1778 (if (file-directory-p file)
1779 (or (and (cdr dired-subdir-alist)
1780 (dired-goto-subdir file))
1781 (progn
1782 (select-window window)
1783 (dired-other-window file)))
1784 (select-window window)
1785 (find-file-other-window (file-name-sans-versions file t)))))
1787 (defun dired-view-file ()
1788 "In Dired, examine a file in view mode, returning to Dired when done.
1789 When file is a directory, show it in this buffer if it is inserted.
1790 Otherwise, display it in another buffer."
1791 (interactive)
1792 (let ((file (dired-get-file-for-visit)))
1793 (if (file-directory-p file)
1794 (or (and (cdr dired-subdir-alist)
1795 (dired-goto-subdir file))
1796 (dired file))
1797 (view-file file))))
1799 (defun dired-find-file-other-window ()
1800 "In Dired, visit this file or directory in another window."
1801 (interactive)
1802 (find-file-other-window (dired-get-file-for-visit)))
1804 (defun dired-display-file ()
1805 "In Dired, display this file or directory in another window."
1806 (interactive)
1807 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1808 \f
1809 ;;; Functions for extracting and manipulating file names in Dired buffers.
1811 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1812 "In Dired, return name of file mentioned on this line.
1813 Value returned normally includes the directory name.
1814 Optional arg LOCALP with value `no-dir' means don't include directory
1815 name in result. A value of `verbatim' means to return the name exactly as
1816 it occurs in the buffer, and a value of t means construct name relative to
1817 `default-directory', which still may contain slashes if in a subdirectory.
1818 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1819 regular filenames and return nil if no filename on this line.
1820 Otherwise, an error occurs in these cases."
1821 (let (case-fold-search file p1 p2 already-absolute)
1822 (save-excursion
1823 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1824 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1825 ;; nil if no file on this line, but no-error-if-not-filep is t:
1826 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1827 (progn
1828 ;; Get rid of the mouse-face property that file names have.
1829 (set-text-properties 0 (length file) nil file)
1830 ;; Unquote names quoted by ls or by dired-insert-directory.
1831 ;; Using read to unquote is much faster than substituting
1833 (setq file
1834 (read
1836 ;; Some ls -b don't escape quotes, argh!
1837 ;; This is not needed for GNU ls, though.
1838 (or (dired-string-replace-match
1840 file)
1842 ;; The above `read' will return a unibyte string if FILE
1843 ;; contains eight-bit-control/graphic characters.
1844 (if (and enable-multibyte-characters
1845 (not (multibyte-string-p file)))
1846 (setq file (string-to-multibyte file)))))
1847 (and file (file-name-absolute-p file)
1848 ;; A relative file name can start with ~.
1849 ;; Don't treat it as absolute in this context.
1850 (not (eq (aref file 0) ?~))
1851 (setq already-absolute t))
1852 (cond
1853 ((null file)
1854 nil)
1855 ((eq localp 'verbatim)
1856 file)
1857 ((and (not no-error-if-not-filep)
1858 (member file '("." "..")))
1859 (error "Cannot operate on `.' or `..'"))
1860 ((and (eq localp 'no-dir) already-absolute)
1861 (file-name-nondirectory file))
1862 (already-absolute
1863 (let ((handler (find-file-name-handler file nil)))
1864 ;; check for safe-magic property so that we won't
1865 ;; put /: for names that don't really need them.
1866 ;; For instance, .gz files when auto-compression-mode is on.
1867 (if (and handler (not (get handler 'safe-magic)))
1868 (concat "/:" file)
1869 file)))
1870 ((eq localp 'no-dir)
1871 file)
1872 ((equal (dired-current-directory) "/")
1873 (setq file (concat (dired-current-directory localp) file))
1874 (let ((handler (find-file-name-handler file nil)))
1875 ;; check for safe-magic property so that we won't
1876 ;; put /: for names that don't really need them.
1877 ;; For instance, .gz files when auto-compression-mode is on.
1878 (if (and handler (not (get handler 'safe-magic)))
1879 (concat "/:" file)
1880 file)))
1881 (t
1882 (concat (dired-current-directory localp) file)))))
1884 (defun dired-string-replace-match (regexp string newtext
1885 &optional literal global)
1886 "Replace first match of REGEXP in STRING with NEWTEXT.
1887 If it does not match, nil is returned instead of the new string.
1888 Optional arg LITERAL means to take NEWTEXT literally.
1889 Optional arg GLOBAL means to replace all matches."
1890 (if global
1891 (let ((start 0) ret)
1892 (while (string-match regexp string start)
1893 (let ((from-end (- (length string) (match-end 0))))
1894 (setq ret (setq string (replace-match newtext t literal string)))
1895 (setq start (- (length string) from-end))))
1896 ret)
1897 (if (not (string-match regexp string 0))
1898 nil
1899 (replace-match newtext t literal string))))
1901 (defun dired-make-absolute (file &optional dir)
1902 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1903 ;; We can't always use expand-file-name as this would get rid of `.'
1904 ;; or expand in / instead default-directory if DIR=="".
1905 ;; This should be good enough for ange-ftp, but might easily be
1906 ;; redefined (for VMS?).
1907 ;; It should be reasonably fast, though, as it is called in
1908 ;; dired-get-filename.
1909 (concat (or dir default-directory) file))
1911 (defun dired-make-relative (file &optional dir ignore)
1912 "Convert FILE (an absolute file name) to a name relative to DIR.
1913 If this is impossible, return FILE unchanged.
1914 DIR must be a directory name, not a file name."
1915 (or dir (setq dir default-directory))
1916 ;; This case comes into play if default-directory is set to
1917 ;; use ~.
1918 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1919 (setq dir (expand-file-name dir)))
1920 (if (string-match (concat "^" (regexp-quote dir)) file)
1921 (substring file (match-end 0))
1922 ;;; (or no-error
1923 ;;; (error "%s: not in directory tree growing at %s" file dir))
1924 file))
1925 \f
1926 ;;; Functions for finding the file name in a dired buffer line.
1928 (defvar dired-permission-flags-regexp
1930 "Regular expression to match the permission flags in `ls -l'.")
1932 ;; Move to first char of filename on this line.
1933 ;; Returns position (point) or nil if no filename on this line."
1934 (defun dired-move-to-filename (&optional raise-error eol)
1935 "Move to the beginning of the filename on the current line.
1936 Return the position of the beginning of the filename, or nil if none found."
1937 ;; This is the UNIX version.
1938 (or eol (setq eol (line-end-position)))
1939 (beginning-of-line)
1940 ;; First try assuming `ls --dired' was used.
1941 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1942 (cond
1943 ((and change (< change eol))
1944 (goto-char change))
1945 ((re-search-forward directory-listing-before-filename-regexp eol t)
1946 (goto-char (match-end 0)))
1947 ((re-search-forward dired-permission-flags-regexp eol t)
1948 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1949 (if raise-error
1950 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
1951 (beginning-of-line)
1952 nil)
1953 (raise-error
1954 (error "No file on this line")))))
1956 (defun dired-move-to-end-of-filename (&optional no-error)
1957 ;; Assumes point is at beginning of filename,
1958 ;; thus the rwx bit re-search-backward below will succeed in *this*
1959 ;; line if at all. So, it should be called only after
1960 ;; (dired-move-to-filename t).
1961 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1962 ;; This is the UNIX version.
1963 (if (get-text-property (point) 'dired-filename)
1964 (goto-char (next-single-property-change (point) 'dired-filename))
1965 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1966 ;; case-fold-search is nil now, so we can test for capital F:
1967 (setq used-F (string-match "F" dired-actual-switches)
1968 opoint (point)
1969 eol (save-excursion (end-of-line) (point))
1970 hidden (and selective-display
1972 (if hidden
1973 nil
1974 (save-excursion ;; Find out what kind of file this is:
1975 ;; Restrict perm bits to be non-blank,
1976 ;; otherwise this matches one char to early (looking backward):
1977 ;; "l---------" (some systems make symlinks that way)
1978 ;; "----------" (plain file with zero perms)
1979 (if (re-search-backward
1980 dired-permission-flags-regexp nil t)
1981 (setq file-type (char-after (match-beginning 1))
1982 symlink (eq file-type ?l)
1983 ;; Only with -F we need to know whether it's an executable
1984 executable (and
1985 used-F
1986 (string-match
1987 "[xst]" ;; execute bit set anywhere?
1988 (concat
1989 (match-string 2)
1990 (match-string 3)
1991 (match-string 4)))))
1992 (or no-error (error "No file on this line"))))
1993 ;; Move point to end of name:
1994 (if symlink
1995 (if (search-forward " -> " eol t)
1996 (progn
1997 (forward-char -4)
1998 (and used-F
1999 dired-ls-F-marks-symlinks
2000 (eq (preceding-char) ?@) ;; did ls really mark the link?
2001 (forward-char -1))))
2002 (goto-char eol) ;; else not a symbolic link
2003 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2004 ;; one trailing character. (Executable bits on symlinks ain't mean
2005 ;; a thing, even to ls, but we know it's not a symlink.)
2006 (and used-F
2007 (or (memq file-type '(?d ?s ?p))
2008 executable)
2009 (forward-char -1))))
2010 (or no-error
2011 (not (eq opoint (point)))
2012 (error "%s" (if hidden
2013 (substitute-command-keys
2015 "No file on this line")))
2016 (if (eq opoint (point))
2017 nil
2018 (point)))))
2020 \f
2021 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2023 (defun dired-copy-filename-as-kill (&optional arg)
2024 "Copy names of marked (or next ARG) files into the kill ring.
2025 The names are separated by a space.
2026 With a zero prefix arg, use the absolute file name of each marked file.
2028 `default-directory'. (This still may contain slashes if in a subdirectory.)
2030 If on a subdir headerline, use absolute subdirname instead;
2031 prefix arg and marked files are ignored in this case.
2034 (interactive "P")
2035 (let ((string
2036 (or (dired-get-subdir)
2037 (mapconcat (function identity)
2038 (if arg
2039 (cond ((zerop (prefix-numeric-value arg))
2040 (dired-get-marked-files))
2041 ((consp arg)
2042 (dired-get-marked-files t))
2043 (t
2044 (dired-get-marked-files
2045 'no-dir (prefix-numeric-value arg))))
2046 (dired-get-marked-files 'no-dir))
2047 " "))))
2048 (if (eq last-command 'kill-region)
2049 (kill-append string nil)
2050 (kill-new string))
2051 (message "%s" string)))
2053 \f
2054 ;; Keeping Dired buffers in sync with the filesystem and with each other
2056 (defun dired-buffers-for-dir (dir &optional file)
2057 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2058 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2059 ;; matches FILE.
2060 ;; The list is in reverse order of buffer creation, most recent last.
2061 ;; As a side effect, killed dired buffers for DIR are removed from
2062 ;; dired-buffers.
2063 (setq dir (file-name-as-directory dir))
2064 (let ((alist dired-buffers) result elt buf)
2065 (while alist
2066 (setq elt (car alist)
2067 buf (cdr elt))
2068 (if (buffer-name buf)
2069 (if (dired-in-this-tree dir (car elt))
2070 (with-current-buffer buf
2071 (and (assoc dir dired-subdir-alist)
2072 (or (null file)
2073 (let ((wildcards
2074 (file-name-nondirectory dired-directory)))
2075 (or (= 0 (length wildcards))
2076 (string-match (dired-glob-regexp wildcards)
2077 file))))
2078 (setq result (cons buf result)))))
2079 ;; else buffer is killed - clean up:
2080 (setq dired-buffers (delq elt dired-buffers)))
2081 (setq alist (cdr alist)))
2082 result))
2084 (defun dired-glob-regexp (pattern)
2085 "Convert glob-pattern PATTERN to a regular expression."
2086 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2087 regexp)
2088 (while (string-match "[[?*]" pattern matched-in-pattern)
2089 (let ((op-end (match-end 0))
2090 (next-op (aref pattern (match-beginning 0))))
2091 (setq regexp (concat regexp
2092 (regexp-quote
2093 (substring pattern matched-in-pattern
2094 (match-beginning 0)))))
2095 (cond ((= next-op ??)
2096 (setq regexp (concat regexp "."))
2097 (setq matched-in-pattern op-end))
2098 ((= next-op ?\[)
2099 ;; Fails to handle ^ yet ????
2100 (let* ((set-start (match-beginning 0))
2101 (set-cont
2102 (if (= (aref pattern (1+ set-start)) ?^)
2103 (+ 3 set-start)
2104 (+ 2 set-start)))
2105 (set-end (string-match "]" pattern set-cont))
2106 (set (substring pattern set-start (1+ set-end))))
2107 (setq regexp (concat regexp set))
2108 (setq matched-in-pattern (1+ set-end))))
2109 ((= next-op ?*)
2110 (setq regexp (concat regexp ".*"))
2111 (setq matched-in-pattern op-end)))))
2113 regexp
2114 (regexp-quote
2115 (substring pattern matched-in-pattern))
2120 (defun dired-advertise ()
2121 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2122 ;; With wildcards we actually advertise too much.
2123 (let ((expanded-default (expand-file-name default-directory)))
2124 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2125 t ; we have already advertised ourselves
2126 (setq dired-buffers
2127 (cons (cons expanded-default (current-buffer))
2128 dired-buffers)))))
2130 (defun dired-unadvertise (dir)
2131 ;; Remove DIR from the buffer alist in variable dired-buffers.
2132 ;; This has the effect of removing any buffer whose main directory is DIR.
2133 ;; It does not affect buffers in which DIR is a subdir.
2134 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2135 (setq dired-buffers
2136 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2137 \f
2138 ;; Tree Dired
2140 ;;; utility functions
2142 (defun dired-in-this-tree (file dir)
2143 ;;"Is FILE part of the directory tree starting at DIR?"
2144 (let (case-fold-search)
2145 (string-match (concat "^" (regexp-quote dir)) file)))
2147 (defun dired-normalize-subdir (dir)
2148 ;; Prepend default-directory to DIR if relative file name.
2149 ;; dired-get-filename must be able to make a valid file name from a
2150 ;; file and its directory DIR.
2151 (file-name-as-directory
2152 (if (file-name-absolute-p dir)
2153 dir
2154 (expand-file-name dir default-directory))))
2156 (defun dired-get-subdir ()
2157 ;;"Return the subdir name on this line, or nil if not on a headerline."
2158 ;; Look up in the alist whether this is a headerline.
2159 (save-excursion
2160 (let ((cur-dir (dired-current-directory)))
2161 (beginning-of-line) ; alist stores b-o-l positions
2162 (and (zerop (- (point)
2163 (dired-get-subdir-min (assoc cur-dir
2164 dired-subdir-alist))))
2165 cur-dir))))
2167 ;(defun dired-get-subdir-min (elt)
2168 ; (cdr elt))
2169 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2170 (defalias 'dired-get-subdir-min 'cdr)
2172 (defun dired-get-subdir-max (elt)
2173 (save-excursion
2174 (goto-char (dired-get-subdir-min elt))
2175 (dired-subdir-max)))
2177 (defun dired-clear-alist ()
2178 (while dired-subdir-alist
2179 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2180 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2182 (defun dired-subdir-index (dir)
2183 ;; Return an index into alist for use with nth
2184 ;; for the sake of subdir moving commands.
2185 (let (found (index 0) (alist dired-subdir-alist))
2186 (while alist
2187 (if (string= dir (car (car alist)))
2188 (setq alist nil found t)
2189 (setq alist (cdr alist) index (1+ index))))
2190 (if found index nil)))
2192 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2193 "Go to next subdirectory, regardless of level."
2194 ;; Use 0 arg to go to this directory's header line.
2195 ;; NO-SKIP prevents moving to end of header line, returning whatever
2196 ;; position was found in dired-subdir-alist.
2197 (interactive "p")
2198 (let ((this-dir (dired-current-directory))
2199 pos index)
2200 ;; nth with negative arg does not return nil but the first element
2201 (setq index (- (dired-subdir-index this-dir) arg))
2202 (setq pos (if (>= index 0)
2203 (dired-get-subdir-min (nth index dired-subdir-alist))))
2204 (if pos
2205 (progn
2206 (goto-char pos)
2208 (point))
2209 (if no-error-if-not-found
2210 nil ; return nil if not found
2211 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2213 (defun dired-build-subdir-alist (&optional switches)
2214 "Build `dired-subdir-alist' by parsing the buffer.
2215 Returns the new value of the alist.
2216 If optional arg SWITCHES is non-nil, use its value
2217 instead of `dired-actual-switches'."
2218 (interactive)
2219 (dired-clear-alist)
2220 (save-excursion
2221 (let* ((count 0)
2222 (buffer-read-only nil)
2223 (buffer-undo-list t)
2224 (switches (or switches dired-actual-switches))
2225 new-dir-name
2226 (R-ftp-base-dir-regex
2227 ;; Used to expand subdirectory names correctly in recursive
2228 ;; ange-ftp listings.
2229 (and (string-match "R" switches)
2232 (goto-char (point-min))
2233 (setq dired-subdir-alist nil)
2234 (while (re-search-forward dired-subdir-regexp nil t)
2235 ;; Avoid taking a file name ending in a colon
2236 ;; as a subdir name.
2237 (unless (save-excursion
2238 (goto-char (match-beginning 0))
2239 (beginning-of-line)
2240 (forward-char 2)
2241 (save-match-data (looking-at dired-re-perms)))
2242 (save-excursion
2243 (goto-char (match-beginning 1))
2244 (setq new-dir-name
2245 (buffer-substring-no-properties (point) (match-end 1))
2246 new-dir-name
2247 (save-match-data
2248 (if (and R-ftp-base-dir-regex
2249 (not (string= new-dir-name default-directory))
2250 (string-match R-ftp-base-dir-regex new-dir-name))
2251 (concat default-directory
2252 (substring new-dir-name (match-end 0)))
2253 (expand-file-name new-dir-name))))
2254 (delete-region (point) (match-end 1))
2255 (insert new-dir-name))
2256 (setq count (1+ count))
2257 (dired-alist-add-1 new-dir-name
2258 ;; Place a sub directory boundary between lines.
2259 (save-excursion
2260 (goto-char (match-beginning 0))
2261 (beginning-of-line)
2262 (point-marker)))))
2263 (if (and (> count 1) (interactive-p))
2264 (message "Buffer includes %d directories" count)))
2265 ;; We don't need to sort it because it is in buffer order per
2266 ;; constructionem. Return new alist:
2267 dired-subdir-alist))
2269 (defun dired-alist-add-1 (dir new-marker)
2270 ;; Add new DIR at NEW-MARKER. Don't sort.
2271 (setq dired-subdir-alist
2272 (cons (cons (dired-normalize-subdir dir) new-marker)
2273 dired-subdir-alist)))
2275 (defun dired-goto-next-nontrivial-file ()
2276 ;; Position point on first nontrivial file after point.
2277 (dired-goto-next-file);; so there is a file to compare with
2278 (if (stringp dired-trivial-filenames)
2279 (while (and (not (eobp))
2280 (string-match dired-trivial-filenames
2281 (file-name-nondirectory
2282 (or (dired-get-filename nil t) ""))))
2283 (forward-line 1)
2284 (dired-move-to-filename))))
2286 (defun dired-goto-next-file ()
2287 (let ((max (1- (dired-subdir-max))))
2288 (while (and (not (dired-move-to-filename)) (< (point) max))
2289 (forward-line 1))))
2291 (defun dired-goto-file (file)
2292 "Go to line describing file FILE in this dired buffer."
2293 ;; Return value of point on success, else nil.
2294 ;; FILE must be an absolute file name.
2297 ;; it in the buffer.
2298 (interactive
2299 (prog1 ; let push-mark display its message
2300 (list (expand-file-name
2301 (read-file-name "Goto file: "
2302 (dired-current-directory))))
2303 (push-mark)))
2304 (setq file (directory-file-name file)) ; does no harm if no directory
2305 (let (found case-fold-search dir)
2306 (setq dir (or (file-name-directory file)
2307 (error "File name `%s' is not absolute" file)))
2308 (save-excursion
2309 ;; The hair here is to get the result of dired-goto-subdir
2310 ;; without really calling it if we don't have any subdirs.
2311 (if (if (string= dir (expand-file-name default-directory))
2312 (goto-char (point-min))
2313 (and (cdr dired-subdir-alist)
2314 (dired-goto-subdir dir)))
2315 (let ((base (file-name-nondirectory file))
2316 search-string
2317 (boundary (dired-subdir-max)))
2318 (setq search-string
2320 (setq search-string
2322 (while (and (not found)
2323 ;; filenames are preceded by SPC, this makes
2324 ;; the search faster (e.g. for the filename "-"!).
2325 (search-forward (concat " " search-string)
2326 boundary 'move))
2327 ;; Match could have BASE just as initial substring or
2328 ;; or in permission bits or date or
2329 ;; not be a proper filename at all:
2330 (if (equal base (dired-get-filename 'no-dir t))
2331 ;; Must move to filename since an (actually
2332 ;; correct) match could have been elsewhere on the
2333 ;; ;; line (e.g. "-" would match somewhere in the
2334 ;; permission bits).
2335 (setq found (dired-move-to-filename))
2336 ;; If this isn't the right line, move forward to avoid
2337 ;; trying this line again.
2338 (forward-line 1))))))
2339 (and found
2340 ;; return value of point (i.e., FOUND):
2341 (goto-char found))))
2343 (defun dired-initial-position (dirname)
2344 ;; Where point should go in a new listing of DIRNAME.
2345 ;; Point assumed at beginning of new subdir line.
2346 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2347 (end-of-line)
2348 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2349 \f
2350 ;; These are hooks which make tree dired work.
2351 ;; They are in this file because other parts of dired need to call them.
2352 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2354 ;; This function is called for each retrieved filename.
2355 ;; It could stand to be faster, though it's mostly function call
2356 ;; overhead. Avoiding the function call seems to save about 10% in
2357 ;; dired-get-filename. Make it a defsubst?
2358 (defun dired-current-directory (&optional localp)
2359 "Return the name of the subdirectory to which this line belongs.
2360 This returns a string with trailing slash, like `default-directory'.
2361 Optional argument means return a file name relative to `default-directory'."
2362 (let ((here (point))
2363 (alist (or dired-subdir-alist
2364 ;; probably because called in a non-dired buffer
2365 (error "No subdir-alist in %s" (current-buffer))))
2366 elt dir)
2367 (while alist
2368 (setq elt (car alist)
2369 dir (car elt)
2370 ;; use `<=' (not `<') as subdir line is part of subdir
2371 alist (if (<= (dired-get-subdir-min elt) here)
2372 nil ; found
2373 (cdr alist))))
2374 (if localp
2375 (dired-make-relative dir default-directory)
2376 dir)))
2378 ;; Subdirs start at the beginning of their header lines and end just
2379 ;; before the beginning of the next header line (or end of buffer).
2381 (defun dired-subdir-max ()
2382 (save-excursion
2383 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2384 (point-max)
2385 (point))))
2386 \f
2387 ;; Deleting files
2389 (defcustom dired-recursive-deletes 'top
2390 "*Decide whether recursive deletes are allowed.
2391 A value of nil means no recursive deletes.
2392 `always' means delete recursively without asking. This is DANGEROUS!
2393 `top' means ask for each directory at top level, but delete its subdirectories
2394 without asking.
2395 Anything else means ask for each directory."
2396 :type '(choice :tag "Delete non-empty directories"
2397 (const :tag "Yes" always)
2398 (const :tag "No--only delete empty directories" nil)
2399 (const :tag "Confirm for each directory" t)
2400 (const :tag "Confirm for each top directory only" top))
2401 :group 'dired)
2403 ;; Match anything but `.' and `..'.
2406 ;; Delete file, possibly delete a directory and all its files.
2407 ;; This function is usefull outside of dired. One could change it's name
2408 ;; to e.g. recursive-delete-file and put it somewhere else.
2409 (defun dired-delete-file (file &optional recursive) "\
2410 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2411 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2412 nil, do not delete.
2413 `always', delete recursively without asking.
2414 `top', ask for each directory at top level.
2415 Anything else, ask for each sub-directory."
2416 (let (files)
2417 ;; This test is equivalent to
2418 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2419 ;; but more efficient
2420 (if (not (eq t (car (file-attributes file))))
2421 (delete-file file)
2422 (when (and recursive
2423 (setq files
2424 (directory-files file t dired-re-no-dot)) ; Not empty.
2425 (or (eq recursive 'always)
2426 (yes-or-no-p (format "Recursive delete of %s? "
2427 (dired-make-relative file)))))
2428 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2429 (while files ; Recursively delete (possibly asking).
2430 (dired-delete-file (car files) recursive)
2431 (setq files (cdr files))))
2432 (delete-directory file))))
2434 (defun dired-do-flagged-delete (&optional nomessage)
2435 "In Dired, delete the files flagged for deletion.
2436 If NOMESSAGE is non-nil, we don't display any message
2437 if there are no flagged files.
2438 `dired-recursive-deletes' controls whether deletion of
2439 non-empty directories is allowed."
2440 (interactive)
2441 (let* ((dired-marker-char dired-del-marker)
2442 (regexp (dired-marker-regexp))
2443 case-fold-search)
2444 (if (save-excursion (goto-char (point-min))
2445 (re-search-forward regexp nil t))
2446 (dired-internal-do-deletions
2447 ;; this can't move point since ARG is nil
2448 (dired-map-over-marks (cons (dired-get-filename) (point))
2449 nil)
2450 nil)
2451 (or nomessage
2452 (message "(No deletions requested)")))))
2454 (defun dired-do-delete (&optional arg)
2455 "Delete all marked (or next ARG) files.
2456 `dired-recursive-deletes' controls whether deletion of
2457 non-empty directories is allowed."
2458 ;; This is more consistent with the file marking feature than
2459 ;; dired-do-flagged-delete.
2460 (interactive "P")
2461 (dired-internal-do-deletions
2462 ;; this may move point if ARG is an integer
2463 (dired-map-over-marks (cons (dired-get-filename) (point))
2464 arg)
2465 arg))
2467 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2469 (defun dired-internal-do-deletions (l arg)
2470 ;; L is an alist of files to delete, with their buffer positions.
2471 ;; ARG is the prefix arg.
2472 ;; Filenames are absolute (VMS needs this for logical search paths).
2473 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2474 ;; That way as changes are made in the buffer they do not shift the
2475 ;; lines still to be changed, so the (point) values in L stay valid.
2476 ;; Also, for subdirs in natural order, a subdir's files are deleted
2477 ;; before the subdir itself - the other way around would not work.
2478 (let ((files (mapcar (function car) l))
2479 (count (length l))
2480 (succ 0))
2481 ;; canonicalize file list for pop up
2482 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2483 (if (dired-mark-pop-up
2484 " *Deletions*" 'delete files dired-deletion-confirmer
2485 (format "Delete %s " (dired-mark-prompt arg files)))
2486 (save-excursion
2487 (let (failures);; files better be in reverse order for this loop!
2488 (while l
2489 (goto-char (cdr (car l)))
2490 (let (buffer-read-only)
2491 (condition-case err
2492 (let ((fn (car (car l))))
2493 (dired-delete-file fn dired-recursive-deletes)
2494 ;; if we get here, removing worked
2495 (setq succ (1+ succ))
2496 (message "%s of %s deletions" succ count)
2497 (dired-fun-in-all-buffers
2498 (file-name-directory fn) (file-name-nondirectory fn)
2499 (function dired-delete-entry) fn))
2500 (error;; catch errors from failed deletions
2502 (setq failures (cons (car (car l)) failures)))))
2503 (setq l (cdr l)))
2504 (if (not failures)
2505 (message "%d deletion%s done" count (dired-plural-s count))
2506 (dired-log-summary
2507 (format "%d of %d deletion%s failed"
2508 (length failures) count
2509 (dired-plural-s count))
2510 failures))))
2511 (message "(No deletions performed)")))
2512 (dired-move-to-filename))
2514 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2515 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2516 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2517 ;; (FILE does not include a directory component.)
2518 ;; FILE may be nil, in which case ignore it.
2519 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2520 (let (success-list)
2521 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2522 file))
2523 (with-current-buffer buf
2524 (if (apply fun args)
2525 (setq success-list (cons (buffer-name buf) success-list)))))
2526 success-list))
2528 ;; Delete the entry for FILE from
2529 (defun dired-delete-entry (file)
2530 (save-excursion
2531 (and (dired-goto-file file)
2532 (let (buffer-read-only)
2533 (delete-region (progn (beginning-of-line) (point))
2534 (save-excursion (forward-line 1) (point))))))
2535 (dired-clean-up-after-deletion file))
2537 ;; This is a separate function for the sake of dired-x.el.
2538 (defun dired-clean-up-after-deletion (fn)
2539 ;; Clean up after a deleted file or directory FN.
2540 (save-excursion (and (cdr dired-subdir-alist)
2541 (dired-goto-subdir fn)
2542 (dired-kill-subdir))))
2543 \f
2544 ;; Confirmation
2546 (defun dired-marker-regexp ()
2547 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2549 (defun dired-plural-s (count)
2550 (if (= 1 count) "" "s"))
2552 (defun dired-mark-prompt (arg files)
2553 "Return a string for use in a prompt, either the current file
2554 name, or the marker and a count of marked files."
2555 ;; distinguish-one-marked can cause the first element to be just t.
2556 (if (eq (car files) t) (setq files (cdr files)))
2557 (let ((count (length files)))
2558 (if (= count 1)
2559 (car files)
2560 ;; more than 1 file:
2561 (if (integerp arg)
2562 ;; abs(arg) = count
2563 ;; Perhaps this is nicer, but it also takes more screen space:
2564 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2565 ;; count)
2566 (format "[next %d files]" arg)
2567 (format "%c [%d files]" dired-marker-char count)))))
2569 (defun dired-pop-to-buffer (buf)
2570 ;; Pop up buffer BUF.
2571 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2572 (if (not dired-shrink-to-fit)
2573 (pop-to-buffer (get-buffer-create buf))
2574 ;; let window shrink to fit:
2575 (let ((window (selected-window))
2576 target-lines w2)
2577 (cond ;; if split-height-threshold is enabled, use the largest window
2578 ((and (> (window-height (setq w2 (get-largest-window)))
2579 split-height-threshold)
2580 (window-full-width-p w2))
2581 (setq window w2))
2582 ;; if the least-recently-used window is big enough, use it
2583 ((and (> (window-height (setq w2 (get-lru-window)))
2584 (* 2 window-min-height))
2585 (window-full-width-p w2))
2586 (setq window w2)))
2587 (save-excursion
2588 (set-buffer buf)
2589 (goto-char (point-max))
2591 (setq target-lines (count-lines (point-min) (point)))
2592 ;; Don't forget to count the last line.
2593 (if (not (bolp))
2594 (setq target-lines (1+ target-lines))))
2595 (if (<= (window-height window) (* 2 window-min-height))
2596 ;; At this point, every window on the frame is too small to split.
2597 (setq w2 (display-buffer buf))
2598 (setq w2 (split-window window
2599 (max window-min-height
2600 (- (window-height window)
2601 (1+ (max window-min-height target-lines)))))))
2602 (set-window-buffer w2 buf)
2603 (if (< (1- (window-height w2)) target-lines)
2604 (progn
2605 (select-window w2)
2606 (enlarge-window (- target-lines (1- (window-height w2))))))
2607 (set-window-start w2 1)
2608 )))
2610 (defcustom dired-no-confirm nil
2611 "A list of symbols for commands Dired should not confirm.
2612 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2613 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2614 `touch' and `uncompress'."
2615 :group 'dired
2616 :type '(set (const byte-compile) (const chgrp)
2617 (const chmod) (const chown) (const compress)
2618 (const copy) (const delete) (const hardlink)
2619 (const load) (const move) (const print)
2620 (const shell) (const symlink) (const touch)
2621 (const uncompress)))
2623 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2624 "Return FUNCTION's result on ARGS after showing which files are marked.
2625 Displays the file names in a buffer named BUFNAME;
2627 This uses function `dired-pop-to-buffer' to do that.
2629 FUNCTION should not manipulate files, just read input
2630 (an argument or confirmation).
2631 The window is not shown if there is just one file or
2632 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2633 FILES is the list of marked files. It can also be (t FILENAME)
2634 in the case of one marked file, to distinguish that from using
2635 just the current file."
2636 (or bufname (setq bufname " *Marked Files*"))
2637 (if (or (eq dired-no-confirm t)
2638 (memq op-symbol dired-no-confirm)
2639 ;; If FILES defaulted to the current line's file.
2640 (= (length files) 1))
2641 (apply function args)
2642 (with-current-buffer (get-buffer-create bufname)
2643 (erase-buffer)
2644 ;; Handle (t FILE) just like (FILE), here.
2645 ;; That value is used (only in some cases), to mean
2646 ;; just one file that was marked, rather than the current line file.
2647 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2648 (remove-text-properties (point-min) (point-max)
2649 '(mouse-face nil help-echo nil)))
2650 (save-window-excursion
2651 (dired-pop-to-buffer bufname)
2652 (apply function args))))
2654 (defun dired-format-columns-of-files (files)
2655 ;; Files should be in forward order for this loop.
2656 ;; i.e., (car files) = first file in buffer.
2657 ;; Returns the number of lines used.
2658 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2659 (width (- (window-width (selected-window)) 2))
2660 (columns (max 1 (/ width maxlen)))
2661 (nfiles (length files))
2662 (rows (+ (/ nfiles columns)
2663 (if (zerop (% nfiles columns)) 0 1)))
2664 (i 0)
2665 (j 0))
2666 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2667 (make-list (- (* columns rows) nfiles) "")))
2668 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2669 (while (< j rows)
2670 (while (< i columns)
2671 (indent-to (* i maxlen))
2672 (insert (car files))
2673 (setq files (nthcdr rows files)
2674 i (1+ i)))
2676 (setq i 0
2677 j (1+ j)
2678 files (cdr files)))
2679 rows))
2680 \f
2681 ;; Commands to mark or flag file(s) at or near current line.
2683 (defun dired-repeat-over-lines (arg function)
2684 ;; This version skips non-file lines.
2685 (let ((pos (make-marker)))
2686 (beginning-of-line)
2687 (while (and (> arg 0) (not (eobp)))
2688 (setq arg (1- arg))
2689 (beginning-of-line)
2690 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2691 (save-excursion
2692 (forward-line 1)
2693 (move-marker pos (1+ (point))))
2694 (save-excursion (funcall function))
2695 ;; Advance to the next line--actually, to the line that *was* next.
2696 ;; (If FUNCTION inserted some new lines in between, skip them.)
2697 (goto-char pos))
2698 (while (and (< arg 0) (not (bobp)))
2699 (setq arg (1+ arg))
2700 (forward-line -1)
2701 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2702 (beginning-of-line)
2703 (save-excursion (funcall function)))
2704 (move-marker pos nil)
2705 (dired-move-to-filename)))
2707 (defun dired-between-files ()
2708 ;; This used to be a regexp match of the `total ...' line output by
2709 ;; ls, which is slightly faster, but that is not very robust; notably,
2710 ;; it fails for non-english locales.
2711 (save-excursion (not (dired-move-to-filename))))
2713 (defun dired-next-marked-file (arg &optional wrap opoint)
2714 "Move to the next marked file, wrapping around the end of the buffer."
2716 (or opoint (setq opoint (point)));; return to where interactively started
2717 (if (if (> arg 0)
2718 (re-search-forward dired-re-mark nil t arg)
2719 (beginning-of-line)
2720 (re-search-backward dired-re-mark nil t (- arg)))
2721 (dired-move-to-filename)
2722 (if (null wrap)
2723 (progn
2724 (goto-char opoint)
2725 (error "No next marked file"))
2726 (message "(Wraparound for next marked file)")
2727 (goto-char (if (> arg 0) (point-min) (point-max)))
2728 (dired-next-marked-file arg nil opoint))))
2730 (defun dired-prev-marked-file (arg &optional wrap)
2731 "Move to the previous marked file, wrapping around the end of the buffer."
2733 (dired-next-marked-file (- arg) wrap))
2735 (defun dired-file-marker (file)
2736 ;; Return FILE's marker, or nil if unmarked.
2737 (save-excursion
2738 (and (dired-goto-file file)
2739 (progn
2740 (beginning-of-line)
2742 (following-char))))))
2744 (defun dired-mark-files-in-region (start end)
2745 (let (buffer-read-only)
2746 (if (> start end)
2747 (error "start > end"))
2748 (goto-char start) ; assumed at beginning of line
2749 (while (< (point) end)
2750 ;; Skip subdir line and following garbage like the `total' line:
2751 (while (and (< (point) end) (dired-between-files))
2752 (forward-line 1))
2753 (if (and (not (looking-at dired-re-dot))
2754 (dired-get-filename nil t))
2755 (progn
2756 (delete-char 1)
2757 (insert dired-marker-char)))
2758 (forward-line 1))))
2760 (defun dired-mark (arg)
2761 "Mark the current (or next ARG) files.
2762 If on a subdir headerline, mark all its files except `.' and `..'.
2766 this subdir."
2767 (interactive "P")
2768 (if (dired-get-subdir)
2769 (save-excursion (dired-mark-subdir-files))
2770 (let (buffer-read-only)
2771 (dired-repeat-over-lines
2772 (prefix-numeric-value arg)
2773 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2775 (defun dired-unmark (arg)
2776 "Unmark the current (or next ARG) files.
2777 If looking at a subdir, unmark all its files except `.' and `..'."
2778 (interactive "P")
2780 (dired-mark arg)))
2782 (defun dired-flag-file-deletion (arg)
2783 "In Dired, flag the current line's file for deletion.
2784 With prefix arg, repeat over several lines.
2786 If on a subdir headerline, mark all its files except `.' and `..'."
2787 (interactive "P")
2788 (let ((dired-marker-char dired-del-marker))
2789 (dired-mark arg)))
2791 (defun dired-unmark-backward (arg)
2792 "In Dired, move up lines and remove deletion flag there.
2793 Optional prefix ARG says how many lines to unflag; default is one line."
2794 (interactive "p")
2795 (dired-unmark (- arg)))
2797 (defun dired-toggle-marks ()
2798 "Toggle marks: marked files become unmarked, and vice versa.
2799 Files marked with other flags (such as `D') are not affected.
2800 `.' and `..' are never toggled.
2801 As always, hidden subdirs are not affected."
2802 (interactive)
2803 (save-excursion
2804 (goto-char (point-min))
2805 (let (buffer-read-only)
2806 (while (not (eobp))
2807 (or (dired-between-files)
2808 (looking-at dired-re-dot)
2809 ;; use subst instead of insdel because it does not move
2810 ;; the gap and thus should be faster and because
2811 ;; other characters are left alone automatically
2812 (apply 'subst-char-in-region
2813 (point) (1+ (point))
2817 (forward-line 1)))))
2818 \f
2819 ;;; Commands to mark or flag files based on their characteristics or names.
2821 (defvar dired-regexp-history nil
2822 "History list of regular expressions used in Dired commands.")
2824 (defun dired-read-regexp (prompt)
2825 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2827 (defun dired-mark-files-regexp (regexp &optional marker-char)
2828 "Mark all files matching REGEXP for use in later commands.
2829 A prefix argument means to unmark them instead.
2830 `.' and `..' are never marked.
2833 object files--just `.o' will mark more than you might think."
2834 (interactive
2835 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2836 " files (regexp): "))
2838 (let ((dired-marker-char (or marker-char dired-marker-char)))
2839 (dired-mark-if
2840 (and (not (looking-at dired-re-dot))
2841 (not (eolp)) ; empty line
2842 (let ((fn (dired-get-filename nil t)))
2843 (and fn (string-match regexp (file-name-nondirectory fn)))))
2844 "matching file")))
2846 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2847 "Mark all files with contents containing REGEXP for use in later commands.
2848 A prefix argument means to unmark them instead.
2849 `.' and `..' are never marked."
2850 (interactive
2851 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2852 " files containing (regexp): "))
2854 (let ((dired-marker-char (or marker-char dired-marker-char)))
2855 (dired-mark-if
2856 (and (not (looking-at dired-re-dot))
2857 (not (eolp)) ; empty line
2858 (let ((fn (dired-get-filename nil t)))
2859 (when (and fn (file-readable-p fn)
2860 (not (file-directory-p fn)))
2861 (let ((prebuf (get-file-buffer fn)))
2862 (message "Checking %s" fn)
2863 ;; For now we do it inside emacs
2864 ;; Grep might be better if there are a lot of files
2865 (if prebuf
2866 (with-current-buffer prebuf
2867 (save-excursion
2868 (goto-char (point-min))
2869 (re-search-forward regexp nil t)))
2870 (with-temp-buffer
2871 (insert-file-contents fn)
2872 (goto-char (point-min))
2873 (re-search-forward regexp nil t))))
2874 )))
2875 "matching file")))
2877 (defun dired-flag-files-regexp (regexp)
2878 "In Dired, flag all files containing the specified REGEXP for deletion.
2879 The match is against the non-directory part of the filename. Use `^'
2880 and `$' to anchor matches. Exclude subdirs by hiding them.
2881 `.' and `..' are never flagged."
2882 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2883 (dired-mark-files-regexp regexp dired-del-marker))
2885 (defun dired-mark-symlinks (unflag-p)
2886 "Mark all symbolic links.
2887 With prefix argument, unflag all those files."
2888 (interactive "P")
2890 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2892 (defun dired-mark-directories (unflag-p)
2893 "Mark all directory file lines except `.' and `..'.
2894 With prefix argument, unflag all those files."
2895 (interactive "P")
2897 (dired-mark-if (and (looking-at dired-re-dir)
2898 (not (looking-at dired-re-dot)))
2899 "directory file")))
2901 (defun dired-mark-executables (unflag-p)
2902 "Mark all executable files.
2903 With prefix argument, unflag all those files."
2904 (interactive "P")
2906 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2908 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2909 ;; files for which PREDICATE returns non-nil.
2911 (defun dired-flag-auto-save-files (&optional unflag-p)
2912 "Flag for deletion files whose names suggest they are auto save files.
2913 A prefix argument says to unflag those files instead."
2914 (interactive "P")
2916 (dired-mark-if
2917 ;; It is less than general to check for # here,
2918 ;; but it's the only way this runs fast enough.
2919 (and (save-excursion (end-of-line)
2920 (or
2921 (eq (preceding-char) ?#)
2922 ;; Handle executables in case of -F option.
2923 ;; We need not worry about the other kinds
2924 ;; of markings that -F makes, since they won't
2925 ;; appear on real auto-save files.
2926 (if (eq (preceding-char) ?*)
2927 (progn
2928 (forward-char -1)
2929 (eq (preceding-char) ?#)))))
2930 (not (looking-at dired-re-dir))
2931 (let ((fn (dired-get-filename t t)))
2932 (if fn (auto-save-file-name-p
2933 (file-name-nondirectory fn)))))
2934 "auto save file")))
2936 (defcustom dired-garbage-files-regexp
2937 ;; `log' here is dubious, since it's typically used for useful log
2938 ;; files, not just TeX stuff. -- fx
2939 (concat (regexp-opt
2940 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2943 :type 'regexp
2944 :group 'dired)
2946 (defun dired-flag-garbage-files ()
2947 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2948 (interactive)
2949 (dired-flag-files-regexp dired-garbage-files-regexp))
2951 (defun dired-flag-backup-files (&optional unflag-p)
2952 "Flag all backup files (names ending with `~') for deletion.
2953 With prefix argument, unflag these files."
2954 (interactive "P")
2955 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
2956 (dired-mark-if
2957 ;; Don't call backup-file-name-p unless the last character looks like
2958 ;; it might be the end of a backup file name. This isn't very general,
2959 ;; but it's the only way this runs fast enough.
2960 (and (save-excursion (end-of-line)
2961 ;; Handle executables in case of -F option.
2962 ;; We need not worry about the other kinds
2963 ;; of markings that -F makes, since they won't
2964 ;; appear on real backup files.
2965 (if (eq (preceding-char) ?*)
2966 (forward-char -1))
2967 (eq (preceding-char) ?~))
2968 (not (looking-at dired-re-dir))
2969 (let ((fn (dired-get-filename t t)))
2970 (if fn (backup-file-name-p fn))))
2971 "backup file")))
2973 (defun dired-change-marks (&optional old new)
2974 "Change all OLD marks to NEW marks.
2975 OLD and NEW are both characters used to mark files."
2976 (interactive
2977 (let* ((cursor-in-echo-area t)
2978 (old (progn (message "Change (old mark): ") (read-char)))
2979 (new (progn (message "Change %c marks to (new mark): " old)
2980 (read-char))))
2981 (list old new)))
2983 (ding)
2985 (buffer-read-only))
2986 (save-excursion
2987 (goto-char (point-min))
2988 (while (search-forward string nil t)
2989 (if (if (= old ?\s)
2990 (save-match-data
2991 (dired-get-filename 'no-dir t))
2992 t)
2993 (subst-char-in-region (match-beginning 0)
2994 (match-end 0) old new)))))))
2996 (defun dired-unmark-all-marks ()
2997 "Remove all marks from all files in the dired buffer."
2998 (interactive)
3001 (defun dired-unmark-all-files (mark &optional arg)
3002 "Remove a specific mark (or any mark) from every file.
3003 After this command, type the mark character to remove,
3004 or type RET to remove all marks.
3005 With prefix arg, query for each marked file.
3008 (save-excursion
3009 (let* ((count 0)
3010 buffer-read-only case-fold-search query
3012 (help-form "\
3013 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3014 `!' to unmark all remaining files with no more questions."))
3015 (goto-char (point-min))
3017 (re-search-forward dired-re-mark nil t)
3018 (search-forward string nil t))
3019 (if (or (not arg)
3020 (let ((file (dired-get-filename t t)))
3021 (and file
3022 (dired-query 'query "Unmark file `%s'? "
3023 file))))
3024 (progn (subst-char-in-region (1- (point)) (point)
3025 (preceding-char) ?\s)
3026 (setq count (1+ count)))))
3027 (message (if (= count 1) "1 mark removed"
3028 "%d marks removed")
3029 count))))
3030 \f
3031 ;; Logging failures operating on files, and showing the results.
3033 (defvar dired-log-buffer "*Dired log*")
3035 (defun dired-why ()
3036 "Pop up a buffer with error log output from Dired.
3037 A group of errors from a single command ends with a formfeed.
3039 (interactive)
3040 (if (get-buffer dired-log-buffer)
3041 (let ((owindow (selected-window))
3042 (window (display-buffer (get-buffer dired-log-buffer))))
3043 (unwind-protect
3044 (progn
3045 (select-window window)
3046 (goto-char (point-max))
3047 (forward-line -1)
3048 (backward-page 1)
3049 (recenter 0))
3050 (select-window owindow)))))
3052 (defun dired-log (log &rest args)
3053 ;; Log a message or the contents of a buffer.
3054 ;; If LOG is a string and there are more args, it is formatted with
3056 ;; End each bunch of errors with (dired-log t):
3057 ;; this inserts the current time and buffer at the start of the page,
3059 (let ((obuf (current-buffer)))
3060 (with-current-buffer (get-buffer-create dired-log-buffer)
3061 (goto-char (point-max))
3062 (let ((inhibit-read-only t))
3063 (cond ((stringp log)
3064 (insert (if args
3065 (apply (function format) log args)
3066 log)))
3067 ((bufferp log)
3068 (insert-buffer-substring log))
3069 ((eq t log)
3070 (backward-page 1)
3071 (unless (bolp)
3073 (insert (current-time-string)
3075 (goto-char (point-max))
3078 (defun dired-log-summary (string failures)
3079 "State a summary of a command's failures, in echo area and log buffer.
3080 STRING is an overall summary of the failures.
3081 FAILURES is a list of file names that we failed to operate on,
3082 or nil if file names are not applicable."
3083 (if (= (length failures) 1)
3084 (message "%s"
3085 (with-current-buffer dired-log-buffer
3086 (goto-char (point-max))
3087 (backward-page 1)
3088 (if (eolp) (forward-line 1))
3089 (buffer-substring (point) (point-max))))
3090 (message (if failures "%s--type ? for details (%s)"
3091 "%s--type ? for details")
3092 string failures))
3093 ;; Log a summary describing a bunch of errors.
3095 (dired-log t))
3096 \f
3097 ;;; Sorting
3099 ;; Most ls can only sort by name or by date (with -t), nothing else.
3100 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3101 ;; So anything that does not contain these is sort "by name".
3103 (defvar dired-ls-sorting-switches "SXU"
3106 This indicates to Dired which option switches to watch out for because they
3107 will change the sorting order behavior of `ls'.
3109 To change the default sorting order \(e.g. add a `-v' option\), see the
3110 variable `dired-listing-switches'. To temporarily override the listing
3113 (defvar dired-sort-by-date-regexp
3114 (concat "^-[^" dired-ls-sorting-switches
3115 "]*t[^" dired-ls-sorting-switches "]*$")
3116 "Regexp recognized by Dired to set `by date' mode.")
3118 (defvar dired-sort-by-name-regexp
3119 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3120 "Regexp recognized by Dired to set `by name' mode.")
3122 (defvar dired-sort-inhibit nil
3123 "Non-nil means the Dired sort command is disabled.
3124 The idea is to set this buffer-locally in special dired buffers.")
3126 (defun dired-sort-set-modeline ()
3127 ;; Set modeline display according to dired-actual-switches.
3128 ;; Modeline display of "by name" or "by date" guarantees the user a
3129 ;; match with the corresponding regexps. Non-matching switches are
3130 ;; shown literally.
3131 (when (eq major-mode 'dired-mode)
3132 (setq mode-name
3133 (let (case-fold-search)
3134 (cond ((string-match
3135 dired-sort-by-name-regexp dired-actual-switches)
3136 "Dired by name")
3137 ((string-match
3138 dired-sort-by-date-regexp dired-actual-switches)
3139 "Dired by date")
3140 (t
3141 (concat "Dired " dired-actual-switches)))))
3142 (force-mode-line-update)))
3144 (defun dired-sort-toggle-or-edit (&optional arg)
3145 "Toggle between sort by date/name and refresh the dired buffer.
3146 With a prefix argument you can edit the current listing switches instead."
3147 (interactive "P")
3148 (when dired-sort-inhibit
3149 (error "Cannot sort this dired buffer"))
3150 (if arg
3151 (dired-sort-other
3152 (read-string "ls switches (must contain -l): " dired-actual-switches))
3153 (dired-sort-toggle)))
3155 (defun dired-sort-toggle ()
3156 ;; Toggle between sort by date/name. Reverts the buffer.
3157 (setq dired-actual-switches
3158 (let (case-fold-search)
3159 (if (string-match " " dired-actual-switches)
3160 ;; New toggle scheme: add/remove a trailing " -t"
3162 (substring dired-actual-switches 0 (match-beginning 0))
3163 (concat dired-actual-switches " -t"))
3164 ;; old toggle scheme: look for some 't' switch and add/remove it
3165 (concat
3166 "-l"
3167 (dired-replace-in-string (concat "[-lt"
3168 dired-ls-sorting-switches "]")
3169 ""
3170 dired-actual-switches)
3171 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3172 dired-actual-switches)
3173 ""
3174 "t")))))
3175 (dired-sort-set-modeline)
3176 (revert-buffer))
3178 ;; Some user code loads dired especially for this.
3179 ;; Don't do that--use replace-regexp-in-string instead.
3180 (defun dired-replace-in-string (regexp newtext string)
3181 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3183 (let ((result "") (start 0) mb me)
3184 (while (string-match regexp string start)
3185 (setq mb (match-beginning 0)
3186 me (match-end 0)
3187 result (concat result (substring string start mb) newtext)
3188 start me))
3189 (concat result (substring string start))))
3191 (defun dired-sort-other (switches &optional no-revert)
3192 "Specify new `ls' SWITCHES for current dired buffer.
3193 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3194 set the minor mode accordingly, others appear literally in the mode line.
3195 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3196 (dired-sort-R-check switches)
3197 (setq dired-actual-switches switches)
3198 (dired-sort-set-modeline)
3199 (or no-revert (revert-buffer)))
3201 (defvar dired-subdir-alist-pre-R nil
3202 "Value of `dired-subdir-alist' before -R switch added.")
3203 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3205 (defun dired-sort-R-check (switches)
3206 "Additional processing of -R in ls option string SWITCHES.
3207 Saves `dired-subdir-alist' when R is set and restores saved value
3208 minus any directories explicitly deleted when R is cleared.
3209 To be called first in body of `dired-sort-other', etc."
3210 (cond
3211 ((and (string-match "R" switches)
3212 (not (string-match "R" dired-actual-switches)))
3213 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3214 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3215 ((and (string-match "R" dired-actual-switches)
3216 (not (string-match "R" switches)))
3217 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3218 ;; that are still present:
3219 (setq dired-subdir-alist
3220 (if dired-subdir-alist-pre-R
3221 (let (subdirs)
3222 (while dired-subdir-alist-pre-R
3223 (if (assoc (caar dired-subdir-alist-pre-R)
3224 dired-subdir-alist)
3225 ;; subdir still present...
3226 (setq subdirs
3227 (cons (car dired-subdir-alist-pre-R)
3228 subdirs)))
3229 (setq dired-subdir-alist-pre-R
3230 (cdr dired-subdir-alist-pre-R)))
3231 (reverse subdirs))
3232 ;; No pre-R subdir alist, so revert to main directory
3233 ;; listing:
3234 (list (car (reverse dired-subdir-alist))))))))
3235 \f
3237 ;;;; Drag and drop support
3239 (defcustom dired-recursive-copies 'top
3240 "*Decide whether recursive copies are allowed.
3241 A value of nil means no recursive copies.
3242 `always' means copy recursively without asking.
3243 `top' means ask for each directory at top level.
3244 Anything else means ask for each directory."
3245 :type '(choice :tag "Copy directories"
3246 (const :tag "No recursive copies" nil)
3247 (const :tag "Ask for each directory" t)
3248 (const :tag "Ask for each top directory only" top)
3249 (const :tag "Copy directories without asking" always))
3250 :group 'dired)
3252 (defun dired-dnd-popup-notice ()
3253 (message-box
3257 (defun dired-dnd-do-ask-action (uri)
3258 ;; No need to get actions and descriptions from the source,
3259 ;; we only have three actions anyway.
3260 (let ((action (x-popup-menu
3261 t
3262 (list "What action?"
3263 (cons ""
3264 '(("Copy here" . copy)
3265 ("Move here" . move)
3266 ("Link here" . link)
3267 "--"
3268 ("Cancel" . nil)))))))
3269 (if action
3270 (dired-dnd-handle-local-file uri action)
3271 nil)))
3273 (declare-function dired-relist-entry "dired-aux" (file))
3274 (declare-function make-symbolic-link "fileio.c")
3276 (defun dired-dnd-handle-local-file (uri action)
3277 "Copy, move or link a file to the dired directory.
3278 URI is the file to handle, ACTION is one of copy, move, link or ask.
3279 Ask means pop up a menu for the user to select one of copy, move or link."
3280 (require 'dired-aux)
3281 (let* ((from (dnd-get-local-file-name uri t))
3282 (to (if from (concat (dired-current-directory)
3283 (file-name-nondirectory from))
3284 nil)))
3285 (if from
3286 (cond ((or (eq action 'copy)
3287 (eq action 'private)) ; Treat private as copy.
3289 ;; If copying a directory and dired-recursive-copies is nil,
3290 ;; dired-copy-file silently fails. Pop up a notice.
3291 (if (and (file-directory-p from)
3292 (not dired-recursive-copies))
3293 (dired-dnd-popup-notice)
3294 (progn
3295 (dired-copy-file from to 1)
3296 (dired-relist-entry to)
3297 action)))
3299 ((eq action 'move)
3300 (dired-rename-file from to 1)
3301 (dired-relist-entry to)
3302 action)
3304 ((eq action 'link)
3305 (make-symbolic-link from to 1)
3306 (dired-relist-entry to)
3307 action)
3309 ((eq action 'ask)
3310 (dired-dnd-do-ask-action uri))
3312 (t nil)))))
3314 (defun dired-dnd-handle-file (uri action)
3315 "Copy, move or link a file to the dired directory if it is a local file.
3316 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3317 ACTION is one of copy, move, link or ask.
3318 Ask means pop up a menu for the user to select one of copy, move or link."
3319 (let ((local-file (dnd-get-local-file-uri uri)))
3320 (if local-file (dired-dnd-handle-local-file local-file action)
3321 nil)))
3322 \f
3324 ;;;; Desktop support
3326 (eval-when-compile (require 'desktop))
3328 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3329 "Auxiliary information to be saved in desktop file."
3330 (cons
3331 ;; Value of `dired-directory'.
3332 (if (consp dired-directory)
3333 ;; Directory name followed by list of files.
3334 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3335 (cdr dired-directory))
3336 ;; Directory name, optionally with shell wildcard.
3337 (desktop-file-name dired-directory desktop-dirname))
3338 ;; Subdirectories in `dired-subdir-alist'.
3339 (cdr
3340 (nreverse
3341 (mapcar
3342 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3343 dired-subdir-alist)))))
3345 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3346 desktop-buffer-name
3347 desktop-buffer-misc)
3348 "Restore a dired buffer specified in a desktop file."
3349 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3350 ;; This value is a directory name, optionally with shell wildcard or
3351 ;; a directory name followed by list of files.
3352 (let* ((dired-dir (car desktop-buffer-misc))
3353 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3354 (if (file-directory-p (file-name-directory dir))
3355 (progn
3356 (dired dired-dir)
3357 ;; The following elements of `desktop-buffer-misc' are the keys
3358 ;; from `dired-subdir-alist'.
3359 (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3360 (current-buffer))
3361 (message "Desktop: Directory %s no longer exists." dir)
3362 (when desktop-missing-file-warning (sit-for 1))
3363 nil)))
3365 (add-to-list 'desktop-buffer-mode-handlers
3366 '(dired-mode . dired-restore-desktop-buffer))
3368 \f
3369 (if (eq system-type 'vax-vms)
3370 (load "dired-vms"))
3372 (provide 'dired)
3374 (run-hooks 'dired-load-hook) ; for your customizations
3376 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3377 ;;; dired.el ends here