| blob | 8bdfe1befcef124e8dab682a70cbe3921582f5b3 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97, 2000, 01, 03, 2004
4 ;; 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 2, 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., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, 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' on ls-lisp.el for more details."
63 ; Don't use absolute file names as /bin should be in any PATH and people
64 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
65 ; usually not in PATH.
67 ;;;###autoload
70 "chown"
72 "/usr/sbin/chown"
85 ;;;###autoload
87 "*Informs dired about how `ls -lF' marks symbolic links.
88 Set this to t if `ls' (or whatever program is specified by
89 `insert-directory-program') with `-lF' marks the symbolic link
90 itself with a trailing @ (usually the case under Ultrix).
92 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
93 nil (the default), if it gives `bar@ -> foo', set it to t.
95 Dired checks if there is really a @ appended. Thus, if you have a
96 marking `ls' program on one host and a non-marking on another host, and
97 don't care about symbolic links which really end in a @, you can
98 always set this variable to t."
102 ;;;###autoload
104 "*Regexp of files to skip when finding first file of a directory.
105 A value of nil means move to the subdir line.
106 A value of t means move to first file."
109 regexp)
112 ;;;###autoload
114 ;; Use t as default so that moved files "take their markers with them".
115 "*Controls marking of renamed files.
116 If t, files keep their previous marks when they are renamed.
117 If a character, renamed files (whether previously marked or not)
118 are afterward marked with that character."
123 ;;;###autoload
125 "*Controls marking of copied files.
126 If t, copied files are marked if and as the corresponding original files were.
127 If a character, copied files are unconditionally marked with that character."
132 ;;;###autoload
134 "*Controls marking of newly made hard links.
135 If t, they are marked if and as the files linked to were marked.
136 If a character, new links are unconditionally marked with that character."
141 ;;;###autoload
143 "*Controls marking of newly made symbolic links.
144 If t, they are marked if and as the files linked to were marked.
145 If a character, new links are unconditionally marked with that character."
150 ;;;###autoload
152 "*If non-nil, dired tries to guess a default target directory.
153 This means: if there is a dired buffer displayed in the next window,
154 use its current subdir, instead of the current subdir of this dired buffer.
156 The target is used in the prompt for file copy, rename etc."
160 ;;;###autoload
162 "*If non-nil, Dired preserves the last-modified time in a file copy.
163 \(This works on only some systems.)"
167 ; These variables were deleted and the replacements are on files.el.
168 ; We leave aliases behind for back-compatibility.
172 ;;; Hook variables
175 "Run after loading dired.
176 You can customize key bindings or load extensions with this."
181 "Run at the very end of dired-mode."
186 "This hook is run before a dired buffer is read in (created or reverted)."
191 "Hook run after each time a file or directory is read by Dired.
192 After each listing of a file or directory, this hook is run
193 with the buffer narrowed to the listing."
196 ;; Note this can't simply be run inside function `dired-ls' as the hook
197 ;; functions probably depend on the dired-subdir-alist to be OK.
199 ;; Fixme: This should use mailcap.
205 "Alist specifying how to view special types of files.
206 Each element has the form (REGEXP . SHELL-COMMAND).
207 When the file name matches REGEXP, `dired-view-file'
208 invokes SHELL-COMMAND to view the file, processing it through `format'.
209 Use `%s' in SHELL-COMMAND to specify where to put the file name."
214 ;; Internal variables
217 ;; so that you can write things like
218 ;; (let ((dired-marker-char ?X))
219 ;; ;; great code using X markers ...
220 ;; )
221 ;; For example, commands operating on two sets of files, A and B.
222 ;; Or marking files with digits 0-9. This could implicate
223 ;; concentric sets or an order for the marked files.
224 ;; The code depends on dynamic scoping on the marker char.
225 "In Dired, the current mark character.
232 t
233 ;; I see no reason ever to make this nil -- rms.
234 ;; (> baud-rate search-slow-speed)
241 ;;;###autoload
243 "The directory name or wildcard spec that this Dired directory lists.
244 Local to each dired buffer. May be a list, in which case the car is the
245 directory name and the cdr is the list of files to mention.
254 ;; These regexps must be tested at beginning-of-line, but are also
255 ;; used to search for next matches, so neither omitting "^" nor
256 ;; replacing "^" by "\n" (to make it slightly faster) will work.
259 ;; "Regexp matching a marked line.
260 ;; Important: the match ends just after the marker."
262 ;; The [^:] part after "d" and "l" is to avoid confusion with the
263 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
271 "-[-r][-w].[-r][-w][xs][-r][-w]."
277 ;; The subdirectory names in this list are expanded.
279 "Association list of subdirectories and their buffer positions.
280 Each subdirectory has an element: (DIRNAME . STARTMARKER).
281 The order of elements is the reverse of the order in the buffer.
285 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
286 Subexpression 1 is the subdirectory proper, no trailing colon.
287 The match starts at the beginning of the line and ends after the end
292 "Faces used by dired."
298 "Face used for directory headers."
306 "Face used for dired marks."
314 "Face used for marked files."
322 "Face used for flagged files."
330 "Face used to highlight a part of a buffer that needs user attention."
338 "Face used for subdirectories."
346 "Face used for symbolic links."
354 "Face used for files suffixed with `completion-ignored-extensions'."
362 ;;
363 ;; Directory headers.
365 ;;
366 ;; Dired marks.
368 ;;
369 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
370 ;; file name itself. We search for Dired defined regexps, and then use the
371 ;; Dired defined function `dired-move-to-filename' before searching for the
372 ;; simple regexp ".+". It is that regexp which matches the file name.
373 ;;
374 ;; Marked files.
377 ;;
378 ;; Flagged files.
381 ;; People who are paranoid about security would consider this more
382 ;; important than other things such as whether it is a directory.
383 ;; But we don't want to encourage paranoia, so our default
384 ;; should be what's most useful for non-paranoids. -- rms.
385 ;;; ;;
386 ;;; ;; Files that are group or world writable.
387 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
388 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
389 ;;; '(1 dired-warning-face)
390 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
391 ;; However, we don't need to highlight the file name, only the
392 ;; permissions, to win generally. -- fx.
393 ;; Fixme: we could also put text properties on the permission
394 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
401 ;;
402 ;; Subdirectories.
405 ;;
406 ;; Symbolic links.
409 ;;
410 ;; Files suffixed with `completion-ignored-extensions'.
412 ;; It is quicker to first find just an extension, then go back to the
413 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
417 \f
418 ;;; Macros must be defined before they are used, for the byte compiler.
421 "Mark all files for which PREDICATE evals to non-nil.
422 PREDICATE is evaluated on each line, with point at beginning of line.
423 MSG is a noun phrase for the type of files being marked.
424 It should end with a noun that can be pluralized by adding `s'.
425 Return value is the number of files marked, or nil if none were marked."
439 count
440 ,msg
448 "Eval BODY with point on each marked line. Return a list of BODY's results.
449 If no marked file could be found, execute BODY on the current line.
450 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
451 files instead of the marked files.
452 In that case point is dragged along. This is so that commands on
453 the next ARG (instead of the marked) files can be chained easily.
454 If ARG is otherwise non-nil, use current file instead.
455 If optional third arg SHOW-PROGRESS evaluates to non-nil,
456 redisplay the dired buffer after each file is processed.
457 No guarantee is made about the position on the marked line.
458 BODY must ensure this itself if it depends on this.
459 Search starts at the beginning of the buffer, thus the car of the list
460 corresponds to the line nearest to the buffer's bottom. This
461 is also true for (positive and negative) integer values of ARG.
462 BODY should not be too long as it is expanded four times."
463 ;;
464 ;;Warning: BODY must not add new lines before point - this may cause an
465 ;;endless loop.
466 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
473 ,arg
479 results))
480 ;; non-nil, non-integer ARG means use current file:
485 ;; remember position of next marked file before BODY
486 ;; can insert lines before the just found file,
487 ;; confusing us by finding the same marked file again
488 ;; and again and...
496 ;; move after last match
503 results
505 ;; save-excursion loses, again
509 "Return the marked files' names as list of strings.
510 The list is in the same order as the buffer, that is, the car is the
511 first marked file.
512 Values returned are normally absolute file names.
513 Optional arg LOCALP as in `dired-get-filename'.
514 Optional second argument ARG specifies files near point
515 instead of marked files. If ARG is an integer, use the next ARG files.
516 If ARG is otherwise non-nil, use file. Usually ARG comes from
517 the command's prefix arg.
518 Optional third argument FILTER, if non-nil, is a function to select
519 some of the files--those for which (funcall FILTER FILENAME) is non-nil."
523 result)
529 result)))
530 \f
531 ;; The dired command
534 ;; For use in interactive.
538 dired-listing-switches))
540 nil default-directory nil))))
542 ;;;###autoload (define-key ctl-x-map "d" 'dired)
543 ;;;###autoload
546 Optional second argument SWITCHES specifies the `ls' options used.
547 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
548 Dired displays a list of files in DIRNAME (which may also have
549 shell wildcards appended to select certain files). If DIRNAME is a cons,
550 its first element is taken as the directory name and the rest as an explicit
551 list of files to make directory entries for.
553 You can move around in it with the usual commands.
558 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
559 ;; Cannot use (interactive "D") because of wildcards.
563 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
564 ;;;###autoload
570 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
571 ;;;###autoload
577 ;;;###autoload
579 "Like `dired' but returns the dired buffer as value, does not select it."
581 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
582 ;; some shells make:
593 ;; If the argument was syntactically a directory name not a file name,
594 ;; or if it happens to name a file that is a directory,
595 ;; convert it syntactically to a directory name.
596 ;; The reason for checking initially-was-dirname
597 ;; and not just file-directory-p
598 ;; is that file-directory-p is slow over ftp.
606 ;; The following is an internal dired function. It returns non-nil if
607 ;; the directory visited by the current dired buffer has changed on
608 ;; disk. DIRNAME should be the directory name of that directory.
618 "Return non-nil if current dired buffer needs updating.
619 If NOCONFIRM is non-nil, then this function always returns nil
620 for a remote directory. This feature is used by Auto Revert Mode."
628 ;; Separate function from dired-noselect for the sake of dired-vms.el.
630 ;; If there is an existing dired buffer for DIRNAME, just leave
631 ;; buffer as it is (don't even call dired-revert).
632 ;; This saves time especially for deep trees or with ange-ftp.
633 ;; The user can type `g' easily, and it is more consistent with find-file.
634 ;; But if SWITCHES are given they are probably different from the
635 ;; buffer's old value, so call dired-sort-other, which does
636 ;; revert the buffer.
637 ;; A pity we can't possibly do "Directory has changed - refresh? "
638 ;; like find-file does.
639 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
640 ;; see there.
642 buffer
643 ;; note that buffer already is in dired-mode, if found
644 new-buffer-p
649 ;; Look for an existing buffer.
654 ;; We don't want default-major-mode to run hooks and set auto-fill
655 ;; or whatever, now that dired-mode does not
656 ;; kill-all-local-variables any longer.
661 ;; file list may have changed
663 ;; this calls dired-revert
665 ;; If directory has changed on disk, offer to revert.
670 ;; Else a new buffer
672 ;; We can do this unconditionally
673 ;; because dired-noselect ensures that the name
674 ;; is passed in directory name syntax
675 ;; if it was the name of a directory at all.
680 ;; default-directory and dired-actual-switches are set now
681 ;; (buffer-local), so we can call dired-readin:
686 ;; dired-readin can fail if parent directories are inaccessible.
687 ;; Don't leave an empty buffer around in that case.
692 buffer))
695 ;; Enlarged by dired-advertise
696 ;; Queried by function dired-buffers-for-dir. When this detects a
697 ;; killed buffer, it is removed from this list.
701 ;; This differs from dired-buffers-for-dir in that it does not consider
702 ;; subdirs of default-directory and searches for the first match only.
703 ;; Also, the major mode must be MODE.
713 dired-directory ;; nil during find-alternate-file
718 dired-directory))))
720 blist nil)
722 found))
724 \f
725 ;; Read in a new dired buffer
728 "Read in a new dired buffer.
729 Differs from dired-insert-subdir in that it accepts
730 wildcards, erases the buffer, and builds the subdir-alist anew
731 \(including making it buffer-local and clearing it first)."
733 ;; default-directory and dired-actual-switches must be buffer-local
734 ;; and initialized by now.
741 ;; This hook which may want to modify dired-actual-switches
742 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
743 ;; where ls won't understand -Al switches.
748 ;; Don't make undo entries for readin.
754 ;; Must first make alist buffer local and set it to nil because
755 ;; dired-build-subdir-alist will call dired-clear-alist first
762 ;; No need to narrow since the whole buffer contains just
763 ;; dired-readin's output, nothing else. The hook can
764 ;; successfully use dired functions (e.g. dired-get-filename)
765 ;; as the subdir-alist has been built in dired-readin.
768 ;; Subroutines of dired-readin
771 ;; Insert listing for the specified dir (and maybe file list)
772 ;; already in dired-directory, assuming a clean buffer.
778 file-list nil))
782 ;; If we are reading a whole single directory...
787 ;; Else treat it as a wildcard spec
788 ;; unless we have an explicit list of files.
793 "Insert a directory listing of DIR, Dired style.
794 Use SWITCHES to make the listings.
795 If FILE-LIST is non-nil, list only those files.
796 Otherwise, if WILDCARD is non-nil, expand wildcards;
797 in that case, DIR should be a file name that uses wildcards.
798 In other cases, DIR should be a directory name or a directory filename.
799 If HDR is non-nil, insert a header line with the directory name."
802 end)
805 ;; We used to specify the C locale here, to force English month names;
806 ;; but this should not be necessary any more,
807 ;; with the new value of dired-move-to-filename-regexp.
812 ;; Quote certain characters, unless ls quoted them for us.
821 nil t))
827 nil t))
830 ;; If we used --dired and it worked, the lines are already indented.
831 ;; Otherwise, indent them.
837 ;; Insert text at the beginning to standardize things.
841 ;; Note that dired-build-subdir-alist will replace the name
842 ;; by its expansion, so it does not matter whether what we insert
843 ;; here is fully expanded, but it should be absolute.
846 ;; Insert "wildcard" line where "total" line would be for a full dir.
850 "Make the file names highlight when the mouse is on them."
865 \f
866 ;; Reverting a dired buffer
869 "Reread the dired buffer.
870 Must also be called after dired-actual-switches have changed.
871 Should not fail even on completely garbaged buffers.
872 Preserves old cursor, marks/flags, hidden-p."
880 buffer-read-only)
884 ;; treat top level dir extra (it may contain wildcards)
889 ;; don't run that hook for each subdir...
892 ;; ... run the hook for the whole buffer, and only after markers
893 ;; have been reinserted (else omitting in dired-x would omit marked files)
902 ;; outside of the let scope
903 ;;; Might as well not override the user if the user changed this.
904 ;;; (setq buffer-read-only t)
905 )
907 ;; Subroutines of dired-revert
908 ;; Some of these are also used when inserting subdirs.
911 "Return alist of files and their marks, from BEG to END."
922 alist))
925 "Mark all files remembered in ALIST.
926 Each element of ALIST looks like (FILE . MARKERCHAR)."
940 "Return a list of names of subdirs currently hidden."
950 result))
953 "Try to insert all subdirs that were displayed before.
954 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
968 "Remove directory DIR from any directory cache."
972 \f
973 ;; dired mode key bindings and initialization
976 ;; This looks ugly when substitute-command-keys uses C-d instead d:
977 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
981 ;; Commands to mark or flag certain categories of files
986 ;; Upper case keys (except !) for operating on the marked files
1004 ;; Comparison commands
1007 ;; Tree Dired commands
1013 ;; move to marked files
1016 ;; Make all regexp commands share a `%' prefix:
1017 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1018 ;; but that seems to serve little purpose, and copy-keymap
1019 ;; does a better job without it.
1031 ;; Commands for marking and unmarking.
1048 ;; Lower keys for commands not operating on all the marked files
1074 ;; moving
1082 (define-key map [up] 'dired-previous-line)
1083 ;; hiding
1084 (define-key map "$" 'dired-hide-subdir)
1085 (define-key map "\M-$" 'dired-hide-all)
1086 ;; misc
1087 (define-key map "?" 'dired-summary)
1089 (define-key map "\C-_" 'dired-undo)
1090 (define-key map "\C-xu" 'dired-undo)
1092 ;; Make menu bar items.
1094 ;; No need to fo this, now that top-level items are fewer.
1095 ;;;;
1096 ;; Get rid of the Edit menu bar item to save space.
1097 ;(define-key map [menu-bar edit] 'undefined)
1099 (define-key map [menu-bar subdir]
1100 (cons "Subdir" (make-sparse-keymap "Subdir")))
1102 (define-key map [menu-bar subdir hide-all]
1103 '(menu-item "Hide All" dired-hide-all
1104 :help "Hide all subdirectories, leave only header lines"))
1105 (define-key map [menu-bar subdir hide-subdir]
1106 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1107 :help "Hide or unhide current directory listing"))
1108 (define-key map [menu-bar subdir tree-down]
1109 '(menu-item "Tree Down" dired-tree-down
1110 :help "Go to first subdirectory header down the tree"))
1111 (define-key map [menu-bar subdir tree-up]
1112 '(menu-item "Tree Up" dired-tree-up
1113 :help "Go to first subdirectory header up the tree"))
1114 (define-key map [menu-bar subdir up]
1115 '(menu-item "Up Directory" dired-up-directory
1116 :help "Edit the parent directory"))
1117 (define-key map [menu-bar subdir prev-subdir]
1118 '(menu-item "Prev Subdir" dired-prev-subdir
1119 :help "Go to previous subdirectory header line"))
1120 (define-key map [menu-bar subdir next-subdir]
1121 '(menu-item "Next Subdir" dired-next-subdir
1122 :help "Go to next subdirectory header line"))
1123 (define-key map [menu-bar subdir prev-dirline]
1124 '(menu-item "Prev Dirline" dired-prev-dirline
1125 :help "Move to next directory-file line"))
1126 (define-key map [menu-bar subdir next-dirline]
1127 '(menu-item "Next Dirline" dired-next-dirline
1128 :help "Move to previous directory-file line"))
1129 (define-key map [menu-bar subdir insert]
1130 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1131 :help "Insert contents of subdirectory"))
1133 (define-key map [menu-bar immediate]
1134 (cons "Immediate" (make-sparse-keymap "Immediate")))
1136 (define-key map [menu-bar immediate revert-buffer]
1137 '(menu-item "Refresh" revert-buffer
1138 :help "Update contents of shown directories"))
1140 (define-key map [menu-bar immediate dashes]
1141 '("--"))
1143 (define-key map [menu-bar immediate backup-diff]
1144 '(menu-item "Compare with Backup" dired-backup-diff
1145 :help "Diff file at cursor with its latest backup"))
1146 (define-key map [menu-bar immediate diff]
1147 '(menu-item "Diff..." dired-diff
1148 :help "Compare file at cursor with another file"))
1149 (define-key map [menu-bar immediate view]
1150 '(menu-item "View This File" dired-view-file
1151 :help "Examine file at cursor in read-only mode"))
1152 (define-key map [menu-bar immediate display]
1153 '(menu-item "Display in Other Window" dired-display-file
1154 :help "Display file at cursor in other window"))
1155 (define-key map [menu-bar immediate find-file-other-window]
1156 '(menu-item "Find in Other Window" dired-find-file-other-window
1157 :help "Edit file at cursor in other window"))
1158 (define-key map [menu-bar immediate find-file]
1159 '(menu-item "Find This File" dired-find-file
1160 :help "Edit file at cursor"))
1161 (define-key map [menu-bar immediate create-directory]
1162 '(menu-item "Create Directory..." dired-create-directory))
1163 (define-key map [menu-bar immediate wdired-mode]
1164 '(menu-item "Edit File Names" wdired-change-to-wdired-mode))
1166 (define-key map [menu-bar regexp]
1167 (cons "Regexp" (make-sparse-keymap "Regexp")))
1169 (define-key map [menu-bar regexp downcase]
1170 '(menu-item "Downcase" dired-downcase
1171 ;; When running on plain MS-DOS, there's only one
1172 ;; letter-case for file names.
1173 :enable (or (not (fboundp 'msdos-long-file-names))
1174 (msdos-long-file-names))
1175 :help "Rename marked files to lower-case name"))
1176 (define-key map [menu-bar regexp upcase]
1177 '(menu-item "Upcase" dired-upcase
1178 :enable (or (not (fboundp 'msdos-long-file-names))
1179 (msdos-long-file-names))
1180 :help "Rename marked files to upper-case name"))
1181 (define-key map [menu-bar regexp hardlink]
1182 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1183 :help "Make hard links for files matching regexp"))
1184 (define-key map [menu-bar regexp symlink]
1185 '(menu-item "Symlink..." dired-do-symlink-regexp
1186 :visible (fboundp 'make-symbolic-link)
1187 :help "Make symbolic links for files matching regexp"))
1188 (define-key map [menu-bar regexp rename]
1189 '(menu-item "Rename..." dired-do-rename-regexp
1190 :help "Rename marked files matching regexp"))
1191 (define-key map [menu-bar regexp copy]
1192 '(menu-item "Copy..." dired-do-copy-regexp
1193 :help "Copy marked files matching regexp"))
1194 (define-key map [menu-bar regexp flag]
1195 '(menu-item "Flag..." dired-flag-files-regexp
1196 :help "Flag files matching regexp for deletion"))
1197 (define-key map [menu-bar regexp mark]
1198 '(menu-item "Mark..." dired-mark-files-regexp
1199 :help "Mark files matching regexp for future operations"))
1200 (define-key map [menu-bar regexp mark-cont]
1201 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1202 :help "Mark files whose contents matches regexp"))
1204 (define-key map [menu-bar mark]
1205 (cons "Mark" (make-sparse-keymap "Mark")))
1207 (define-key map [menu-bar mark prev]
1208 '(menu-item "Previous Marked" dired-prev-marked-file
1209 :help "Move to previous marked file"))
1210 (define-key map [menu-bar mark next]
1211 '(menu-item "Next Marked" dired-next-marked-file
1212 :help "Move to next marked file"))
1213 (define-key map [menu-bar mark marks]
1214 '(menu-item "Change Marks..." dired-change-marks
1215 :help "Replace marker with another character"))
1216 (define-key map [menu-bar mark unmark-all]
1217 '(menu-item "Unmark All" dired-unmark-all-marks))
1218 (define-key map [menu-bar mark symlinks]
1219 '(menu-item "Mark Symlinks" dired-mark-symlinks
1220 :visible (fboundp 'make-symbolic-link)
1221 :help "Mark all symbolic links"))
1222 (define-key map [menu-bar mark directories]
1223 '(menu-item "Mark Directories" dired-mark-directories
1224 :help "Mark all directories except `.' and `..'"))
1225 (define-key map [menu-bar mark directory]
1226 '(menu-item "Mark Old Backups" dired-clean-directory
1227 :help "Flag old numbered backups for deletion"))
1228 (define-key map [menu-bar mark executables]
1229 '(menu-item "Mark Executables" dired-mark-executables
1230 :help "Mark all executable files"))
1231 (define-key map [menu-bar mark garbage-files]
1232 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1233 :help "Flag unneeded files for deletion"))
1234 (define-key map [menu-bar mark backup-files]
1235 '(menu-item "Flag Backup Files" dired-flag-backup-files
1236 :help "Flag all backup files for deletion"))
1237 (define-key map [menu-bar mark auto-save-files]
1238 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1239 :help "Flag auto-save files for deletion"))
1240 (define-key map [menu-bar mark deletion]
1241 '(menu-item "Flag" dired-flag-file-deletion
1242 :help "Flag current line's file for deletion"))
1243 (define-key map [menu-bar mark unmark]
1244 '(menu-item "Unmark" dired-unmark
1245 :help "Unmark or unflag current line's file"))
1246 (define-key map [menu-bar mark mark]
1247 '(menu-item "Mark" dired-mark
1248 :help "Mark current line's file for future operations"))
1249 (define-key map [menu-bar mark toggle-marks]
1250 '(menu-item "Toggle Marks" dired-toggle-marks
1251 :help "Mark unmarked files, unmark marked ones"))
1253 (define-key map [menu-bar operate]
1254 (cons "Operate" (make-sparse-keymap "Operate")))
1256 (define-key map [menu-bar operate query-replace]
1257 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1258 :help "Replace regexp in marked files"))
1259 (define-key map [menu-bar operate search]
1260 '(menu-item "Search Files..." dired-do-search
1261 :help "Search marked files for regexp"))
1262 (define-key map [menu-bar operate chown]
1263 '(menu-item "Change Owner..." dired-do-chown
1264 :visible (not (memq system-type '(ms-dos windows-nt)))
1265 :help "Change the owner of marked files"))
1266 (define-key map [menu-bar operate chgrp]
1267 '(menu-item "Change Group..." dired-do-chgrp
1268 :visible (not (memq system-type '(ms-dos windows-nt)))
1269 :help "Change the group of marked files"))
1270 (define-key map [menu-bar operate chmod]
1271 '(menu-item "Change Mode..." dired-do-chmod
1272 :help "Change mode (attributes) of marked files"))
1273 (define-key map [menu-bar operate touch]
1274 '(menu-item "Change Timestamp..." dired-do-touch
1275 :help "Change timestamp of marked files"))
1276 (define-key map [menu-bar operate load]
1277 '(menu-item "Load" dired-do-load
1278 :help "Load marked Emacs Lisp files"))
1279 (define-key map [menu-bar operate compile]
1280 '(menu-item "Byte-compile" dired-do-byte-compile
1281 :help "Byte-compile marked Emacs Lisp files"))
1282 (define-key map [menu-bar operate compress]
1283 '(menu-item "Compress" dired-do-compress
1284 :help "Compress/uncompress marked files"))
1285 (define-key map [menu-bar operate print]
1286 '(menu-item "Print..." dired-do-print
1287 :help "Ask for print command and print marked files"))
1288 (define-key map [menu-bar operate hardlink]
1289 '(menu-item "Hardlink to..." dired-do-hardlink
1290 :help "Make hard links for current or marked files"))
1291 (define-key map [menu-bar operate symlink]
1292 '(menu-item "Symlink to..." dired-do-symlink
1293 :visible (fboundp 'make-symbolic-link)
1294 :help "Make symbolic links for current or marked files"))
1295 (define-key map [menu-bar operate command]
1296 '(menu-item "Shell Command..." dired-do-shell-command
1297 :help "Run a shell command on each of marked files"))
1298 (define-key map [menu-bar operate delete]
1299 '(menu-item "Delete" dired-do-delete
1300 :help "Delete current file or all marked files"))
1301 (define-key map [menu-bar operate rename]
1302 '(menu-item "Rename to..." dired-do-rename
1303 :help "Rename current file or move marked files"))
1304 (define-key map [menu-bar operate copy]
1305 '(menu-item "Copy to..." dired-do-copy
1306 :help "Copy current file or all marked files"))
1308 map)
1309 "Local keymap for `dired-mode' buffers.")
1310 \f
1311 ;; Dired mode is suitable only for specially formatted data.
1312 (put 'dired-mode 'mode-class 'special)
1314 (defun dired-mode (&optional dirname switches)
1315 "\
1318 \(optionally) its subdirectories, in the format of `ls -lR'.
1321 compress, load or byte-compile them, change their file attributes
1324 by file or all files matching certain criteria.
1326 Letters no longer insert themselves. Digits are prefix arguments.
1329 Most commands operate on the marked files and use the current file
1330 if no files are marked. Use a numeric prefix argument to operate on
1331 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1332 to operate on the current file only. Prefix arguments override marks.
1334 to see why something went wrong.
1339 (or dired it in another buffer, if it is a directory).
1346 This retains all marks and hides subdirs again that were hidden before.
1347 SPC and DEL can be used to move down and up by lines.
1350 to read the
1352 to relist a single or the marked files or a
1354 again for the directory tree.
1357 for more info):
1359 dired-listing-switches
1360 dired-trivial-filenames
1361 dired-shrink-to-fit
1362 dired-marker-char
1363 dired-del-marker
1364 dired-keep-marker-rename
1365 dired-keep-marker-copy
1366 dired-keep-marker-hardlink
1367 dired-keep-marker-symlink
1371 dired-before-readin-hook
1372 dired-after-readin-hook
1373 dired-mode-hook
1374 dired-load-hook
1376 Keybindings:
1378 ;; Not to be called interactively (e.g. dired-directory will be set
1379 ;; to default-directory, which is wrong with wildcards).
1380 (kill-all-local-variables)
1381 (use-local-map dired-mode-map)
1382 (dired-advertise) ; default-directory is already set
1383 (setq major-mode 'dired-mode
1384 mode-name "Dired"
1385 ;; case-fold-search nil
1386 buffer-read-only t
1387 selective-display t ; for subdirectory hiding
1388 mode-line-buffer-identification
1389 (propertized-buffer-identification "%17b"))
1390 (set (make-local-variable 'revert-buffer-function)
1391 (function dired-revert))
1392 (set (make-local-variable 'buffer-stale-function)
1393 (function dired-buffer-stale-p))
1394 (set (make-local-variable 'page-delimiter)
1396 (set (make-local-variable 'dired-directory)
1397 (or dirname default-directory))
1398 ;; list-buffers uses this to display the dir being edited in this buffer.
1399 (set (make-local-variable 'list-buffers-directory)
1400 (expand-file-name (if (listp dired-directory)
1401 (car dired-directory)
1402 dired-directory)))
1403 (set (make-local-variable 'dired-actual-switches)
1404 (or switches dired-listing-switches))
1405 (set (make-local-variable 'font-lock-defaults)
1406 '(dired-font-lock-keywords t nil nil beginning-of-line))
1407 (set (make-local-variable 'desktop-save-buffer)
1408 'dired-desktop-buffer-misc-data)
1409 (dired-sort-other dired-actual-switches t)
1410 (run-mode-hooks 'dired-mode-hook)
1411 (when (featurep 'x-dnd)
1412 (make-variable-buffer-local 'x-dnd-test-function)
1413 (make-variable-buffer-local 'x-dnd-protocol-alist)
1414 (setq x-dnd-test-function 'dired-dnd-test-function)
1415 (setq x-dnd-protocol-alist
1416 (append '(("^file:///" . dired-dnd-handle-local-file)
1417 ("^file://" . dired-dnd-handle-file)
1418 ("^file:" . dired-dnd-handle-local-file))
1419 x-dnd-protocol-alist))))
1420 \f
1421 ;; Idiosyncratic dired commands that don't deal with marks.
1423 (defun dired-summary ()
1424 "Summarize basic Dired commands and show recent Dired errors."
1425 (interactive)
1426 (dired-why)
1427 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1428 (message
1429 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1431 (defun dired-undo ()
1432 "Undo in a dired buffer.
1433 This doesn't recover lost files, it just undoes changes in the buffer itself.
1434 You can use it to recover marks, killed lines or subdirs.
1436 parse the buffer again."
1437 (interactive)
1438 (let (buffer-read-only)
1439 (undo)
1440 (message "Change in Dired buffer undone.
1441 Actual changes in files cannot be undone by Emacs.")))
1443 (defun dired-next-line (arg)
1444 "Move down lines then position at filename.
1445 Optional prefix ARG says how many lines to move; default is one line."
1446 (interactive "p")
1447 (next-line arg)
1448 (dired-move-to-filename))
1450 (defun dired-previous-line (arg)
1451 "Move up lines then position at filename.
1452 Optional prefix ARG says how many lines to move; default is one line."
1453 (interactive "p")
1454 (previous-line arg)
1455 (dired-move-to-filename))
1457 (defun dired-next-dirline (arg &optional opoint)
1458 "Goto ARG'th next directory file line."
1459 (interactive "p")
1460 (or opoint (setq opoint (point)))
1461 (if (if (> arg 0)
1462 (re-search-forward dired-re-dir nil t arg)
1463 (beginning-of-line)
1464 (re-search-backward dired-re-dir nil t (- arg)))
1465 (dired-move-to-filename) ; user may type `i' or `f'
1466 (goto-char opoint)
1467 (error "No more subdirectories")))
1469 (defun dired-prev-dirline (arg)
1470 "Goto ARG'th previous directory file line."
1471 (interactive "p")
1472 (dired-next-dirline (- arg)))
1474 (defun dired-up-directory (&optional other-window)
1475 "Run Dired on parent directory of current directory.
1476 Find the parent directory either in this buffer or another buffer.
1477 Creates a buffer if necessary."
1478 (interactive "P")
1479 (let* ((dir (dired-current-directory))
1480 (up (file-name-directory (directory-file-name dir))))
1481 (or (dired-goto-file (directory-file-name dir))
1482 ;; Only try dired-goto-subdir if buffer has more than one dir.
1483 (and (cdr dired-subdir-alist)
1484 (dired-goto-subdir up))
1485 (progn
1486 (if other-window
1487 (dired-other-window up)
1488 (dired up))
1489 (dired-goto-file dir)))))
1491 (defun dired-get-file-for-visit ()
1492 "Get the current line's file name, with an error if file does not exist."
1493 (interactive)
1494 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1495 (let ((raw (dired-get-filename nil t))
1496 file-name)
1497 (if (null raw)
1498 (error "No file on this line"))
1499 (setq file-name (file-name-sans-versions raw t))
1500 (if (file-exists-p file-name)
1501 file-name
1502 (if (file-symlink-p file-name)
1503 (error "File is a symlink to a nonexistent target")
1504 (error "File no longer exists; type `g' to update Dired buffer")))))
1506 ;; Force `f' rather than `e' in the mode doc:
1507 (defalias 'dired-advertised-find-file 'dired-find-file)
1508 (defun dired-find-file ()
1509 "In Dired, visit the file or directory named on this line."
1510 (interactive)
1511 ;; Bind `find-file-run-dired' so that the command works on directories
1512 ;; too, independent of the user's setting.
1513 (let ((find-file-run-dired t))
1514 (find-file (dired-get-file-for-visit))))
1516 (defun dired-find-alternate-file ()
1517 "In Dired, visit this file or directory instead of the dired buffer."
1518 (interactive)
1519 (set-buffer-modified-p nil)
1520 (find-alternate-file (dired-get-file-for-visit)))
1521 ;; Don't override the setting from .emacs.
1522 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1524 (defun dired-mouse-find-file-other-window (event)
1525 "In Dired, visit the file or directory name you click on."
1526 (interactive "e")
1527 (let (window pos file)
1528 (save-excursion
1529 (setq window (posn-window (event-end event))
1530 pos (posn-point (event-end event)))
1531 (if (not (windowp window))
1532 (error "No file chosen"))
1533 (set-buffer (window-buffer window))
1534 (goto-char pos)
1535 (setq file (dired-get-file-for-visit)))
1536 (if (file-directory-p file)
1537 (or (and (cdr dired-subdir-alist)
1538 (dired-goto-subdir file))
1539 (progn
1540 (select-window window)
1541 (dired-other-window file)))
1542 (let (cmd)
1543 ;; Look for some other way to view a certain file.
1544 (dolist (elt dired-view-command-alist)
1545 (if (string-match (car elt) file)
1546 (setq cmd (cdr elt))))
1547 (if cmd
1548 (call-process shell-file-name nil 0 nil
1549 "-c"
1550 (concat (format cmd (shell-quote-argument file))
1551 " &"))
1552 (select-window window)
1553 (find-file-other-window (file-name-sans-versions file t)))))))
1555 (defun dired-view-file ()
1556 "In Dired, examine a file in view mode, returning to dired when done.
1557 When file is a directory, show it in this buffer if it is inserted.
1558 Some kinds of files are displayed using external viewer programs;
1559 see `dired-view-command-alist'. Otherwise, display it in another buffer."
1560 (interactive)
1561 (let ((file (dired-get-file-for-visit)))
1562 (if (file-directory-p file)
1563 (or (and (cdr dired-subdir-alist)
1564 (dired-goto-subdir file))
1565 (dired file))
1566 (let (cmd)
1567 ;; Look for some other way to view a certain file.
1568 (dolist (elt dired-view-command-alist)
1569 (if (string-match (car elt) file)
1570 (setq cmd (cdr elt))))
1571 (if cmd
1572 (call-process shell-file-name nil 0 nil
1573 "-c"
1574 (concat (format cmd (shell-quote-argument file))
1575 " &"))
1576 (view-file file))))))
1578 (defun dired-find-file-other-window ()
1579 "In Dired, visit this file or directory in another window."
1580 (interactive)
1581 (find-file-other-window (dired-get-file-for-visit)))
1583 (defun dired-display-file ()
1584 "In Dired, display this file or directory in another window."
1585 (interactive)
1586 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1587 \f
1588 ;;; Functions for extracting and manipulating file names in Dired buffers.
1590 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1591 "In Dired, return name of file mentioned on this line.
1592 Value returned normally includes the directory name.
1593 Optional arg LOCALP with value `no-dir' means don't include directory
1594 name in result. A value of `verbatim' means to return the name exactly as
1595 it occurs in the buffer, and a value of t means construct name relative to
1596 `default-directory', which still may contain slashes if in a subdirectory.
1597 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1598 regular filenames and return nil if no filename on this line.
1599 Otherwise, an error occurs in these cases."
1600 (let (case-fold-search file p1 p2 already-absolute)
1601 (save-excursion
1602 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1603 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1604 ;; nil if no file on this line, but no-error-if-not-filep is t:
1605 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1606 (progn
1607 ;; Get rid of the mouse-face property that file names have.
1608 (set-text-properties 0 (length file) nil file)
1609 ;; Unquote names quoted by ls or by dired-insert-directory.
1610 ;; Using read to unquote is much faster than substituting
1612 (setq file
1613 (read
1615 ;; Some ls -b don't escape quotes, argh!
1616 ;; This is not needed for GNU ls, though.
1617 (or (dired-string-replace-match
1619 file)
1621 ;; The above `read' will return a unibyte string if FILE
1622 ;; contains eight-bit-control/graphic characters.
1623 (if (and enable-multibyte-characters
1624 (not (multibyte-string-p file)))
1625 (setq file (string-to-multibyte file)))))
1626 (and file (file-name-absolute-p file)
1627 ;; A relative file name can start with ~.
1628 ;; Don't treat it as absolute in this context.
1629 (not (eq (aref file 0) ?~))
1630 (setq already-absolute t))
1631 (cond
1632 ((null file)
1633 nil)
1634 ((eq localp 'verbatim)
1635 file)
1636 ((and (not no-error-if-not-filep)
1637 (save-excursion
1638 (beginning-of-line)
1639 (looking-at dired-re-dot)))
1640 (error "Cannot operate on `.' or `..'"))
1641 ((and (eq localp 'no-dir) already-absolute)
1642 (file-name-nondirectory file))
1643 (already-absolute
1644 (let ((handler (find-file-name-handler file nil)))
1645 ;; check for safe-magic property so that we won't
1646 ;; put /: for names that don't really need them.
1647 ;; For instance, .gz files when auto-compression-mode is on.
1648 (if (and handler (not (get handler 'safe-magic)))
1649 (concat "/:" file)
1650 file)))
1651 ((eq localp 'no-dir)
1652 file)
1653 ((equal (dired-current-directory) "/")
1654 (setq file (concat (dired-current-directory localp) file))
1655 (let ((handler (find-file-name-handler file nil)))
1656 ;; check for safe-magic property so that we won't
1657 ;; put /: for names that don't really need them.
1658 ;; For instance, .gz files when auto-compression-mode is on.
1659 (if (and handler (not (get handler 'safe-magic)))
1660 (concat "/:" file)
1661 file)))
1662 (t
1663 (concat (dired-current-directory localp) file)))))
1665 (defun dired-string-replace-match (regexp string newtext
1666 &optional literal global)
1667 "Replace first match of REGEXP in STRING with NEWTEXT.
1668 If it does not match, nil is returned instead of the new string.
1669 Optional arg LITERAL means to take NEWTEXT literally.
1670 Optional arg GLOBAL means to replace all matches."
1671 (if global
1672 (let ((start 0) ret)
1673 (while (string-match regexp string start)
1674 (let ((from-end (- (length string) (match-end 0))))
1675 (setq ret (setq string (replace-match newtext t literal string)))
1676 (setq start (- (length string) from-end))))
1677 ret)
1678 (if (not (string-match regexp string 0))
1679 nil
1680 (replace-match newtext t literal string))))
1682 (defun dired-make-absolute (file &optional dir)
1683 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1684 ;; We can't always use expand-file-name as this would get rid of `.'
1685 ;; or expand in / instead default-directory if DIR=="".
1686 ;; This should be good enough for ange-ftp, but might easily be
1687 ;; redefined (for VMS?).
1688 ;; It should be reasonably fast, though, as it is called in
1689 ;; dired-get-filename.
1690 (concat (or dir default-directory) file))
1692 (defun dired-make-relative (file &optional dir ignore)
1693 "Convert FILE (an absolute file name) to a name relative to DIR.
1694 If this is impossible, return FILE unchanged.
1695 DIR must be a directory name, not a file name."
1696 (or dir (setq dir default-directory))
1697 ;; This case comes into play if default-directory is set to
1698 ;; use ~.
1699 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1700 (setq dir (expand-file-name dir)))
1701 (if (string-match (concat "^" (regexp-quote dir)) file)
1702 (substring file (match-end 0))
1703 ;;; (or no-error
1704 ;;; (error "%s: not in directory tree growing at %s" file dir))
1705 file))
1706 \f
1707 ;;; Functions for finding the file name in a dired buffer line.
1709 (defvar dired-move-to-filename-regexp
1712 ;; In some locales, month abbreviations are as short as 2 letters,
1713 ;; and they can be followed by ".".
1714 ;; In Breton, a month name can include a quote character.
1716 (s " ")
1717 (yyyy "[0-9][0-9][0-9][0-9]")
1718 (dd "[ 0-3][0-9]")
1719 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
1721 (zone "[-+][0-2][0-9][0-5][0-9]")
1722 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
1727 s "+"
1729 (western-comma (concat month s "+" dd "," s "+" yyyy))
1730 ;; Japanese MS-Windows ls-lisp has one-digit months, and
1731 ;; omits the Kanji characters after month and day-of-month.
1732 (mm "[ 0-1]?[0-9]")
1733 (japanese
1734 (concat mm l "?" s dd l "?" s "+"
1736 ;; The "[0-9]" below requires the previous column to end in a digit.
1737 ;; This avoids recognizing `1 may 1997' as a date in the line:
1738 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
1739 ;; The "[kKMGTPEZY]?" below supports "ls -alh" output.
1740 ;; The ".*" below finds the last match if there are multiple matches.
1741 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
1742 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
1743 (concat ".*[0-9][kKMGTPEZY]?" s
1745 s "+"))
1746 "Regular expression to match up to the file name in a directory listing.
1747 The default value is designed to recognize dates and times
1748 regardless of the language.")
1750 (defvar dired-permission-flags-regexp
1752 "Regular expression to match the permission flags in `ls -l'.")
1754 ;; Move to first char of filename on this line.
1755 ;; Returns position (point) or nil if no filename on this line."
1756 (defun dired-move-to-filename (&optional raise-error eol)
1757 ;; This is the UNIX version.
1758 (or eol (setq eol (line-end-position)))
1759 (beginning-of-line)
1760 ;; First try assuming `ls --dired' was used.
1761 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1762 (cond
1763 ((and change (< change eol))
1764 (goto-char change))
1765 ((re-search-forward dired-move-to-filename-regexp eol t)
1766 (goto-char (match-end 0)))
1767 ((re-search-forward dired-permission-flags-regexp eol t)
1768 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1769 (funcall (if raise-error 'error 'message)
1770 "Unrecognized line! Check dired-move-to-filename-regexp"))
1771 (raise-error
1772 (error "No file on this line")))))
1774 (defun dired-move-to-end-of-filename (&optional no-error)
1775 ;; Assumes point is at beginning of filename,
1776 ;; thus the rwx bit re-search-backward below will succeed in *this*
1777 ;; line if at all. So, it should be called only after
1778 ;; (dired-move-to-filename t).
1779 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1780 ;; This is the UNIX version.
1781 (if (get-text-property (point) 'dired-filename)
1782 (goto-char (next-single-property-change (point) 'dired-filename))
1783 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1784 ;; case-fold-search is nil now, so we can test for capital F:
1785 (setq used-F (string-match "F" dired-actual-switches)
1786 opoint (point)
1787 eol (save-excursion (end-of-line) (point))
1788 hidden (and selective-display
1790 (if hidden
1791 nil
1792 (save-excursion ;; Find out what kind of file this is:
1793 ;; Restrict perm bits to be non-blank,
1794 ;; otherwise this matches one char to early (looking backward):
1795 ;; "l---------" (some systems make symlinks that way)
1796 ;; "----------" (plain file with zero perms)
1797 (if (re-search-backward
1798 dired-permission-flags-regexp nil t)
1799 (setq file-type (char-after (match-beginning 1))
1800 symlink (eq file-type ?l)
1801 ;; Only with -F we need to know whether it's an executable
1802 executable (and
1803 used-F
1804 (string-match
1805 "[xst]" ;; execute bit set anywhere?
1806 (concat
1807 (match-string 2)
1808 (match-string 3)
1809 (match-string 4)))))
1810 (or no-error (error "No file on this line"))))
1811 ;; Move point to end of name:
1812 (if symlink
1813 (if (search-forward " ->" eol t)
1814 (progn
1815 (forward-char -3)
1816 (and used-F
1817 dired-ls-F-marks-symlinks
1818 (eq (preceding-char) ?@) ;; did ls really mark the link?
1819 (forward-char -1))))
1820 (goto-char eol) ;; else not a symbolic link
1821 ;; ls -lF marks dirs, sockets and executables with exactly one
1822 ;; trailing character. (Executable bits on symlinks ain't mean
1823 ;; a thing, even to ls, but we know it's not a symlink.)
1824 (and used-F
1825 (or (memq file-type '(?d ?s))
1826 executable)
1827 (forward-char -1))))
1828 (or no-error
1829 (not (eq opoint (point)))
1830 (error (if hidden
1831 (substitute-command-keys
1833 "No file on this line")))
1834 (if (eq opoint (point))
1835 nil
1836 (point)))))
1838 \f
1839 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
1841 (defun dired-copy-filename-as-kill (&optional arg)
1842 "Copy names of marked (or next ARG) files into the kill ring.
1843 The names are separated by a space.
1844 With a zero prefix arg, use the absolute file name of each marked file.
1847 If on a subdir headerline, use subdirname instead; prefix arg is ignored
1848 in this case.
1851 (interactive "P")
1852 (let ((string
1853 (or (dired-get-subdir)
1854 (mapconcat (function identity)
1855 (if arg
1856 (cond ((zerop (prefix-numeric-value arg))
1857 (dired-get-marked-files))
1858 ((integerp arg)
1859 (dired-get-marked-files 'no-dir arg))
1860 (t ; else a raw arg
1861 (dired-get-marked-files t)))
1862 (dired-get-marked-files 'no-dir))
1863 " "))))
1864 (if (eq last-command 'kill-region)
1865 (kill-append string nil)
1866 (kill-new string))
1867 (message "%s" string)))
1869 \f
1870 ;; Keeping Dired buffers in sync with the filesystem and with each other
1872 (defun dired-buffers-for-dir (dir &optional file)
1873 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1874 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1875 ;; matches FILE.
1876 ;; The list is in reverse order of buffer creation, most recent last.
1877 ;; As a side effect, killed dired buffers for DIR are removed from
1878 ;; dired-buffers.
1879 (setq dir (file-name-as-directory dir))
1880 (let ((alist dired-buffers) result elt buf pattern)
1881 (while alist
1882 (setq elt (car alist)
1883 buf (cdr elt))
1884 (if (buffer-name buf)
1885 (if (dired-in-this-tree dir (car elt))
1886 (with-current-buffer buf
1887 (and (assoc dir dired-subdir-alist)
1888 (or (null file)
1889 (let ((wildcards
1890 (file-name-nondirectory dired-directory)))
1891 (or (= 0 (length wildcards))
1892 (string-match (dired-glob-regexp wildcards)
1893 file))))
1894 (setq result (cons buf result)))))
1895 ;; else buffer is killed - clean up:
1896 (setq dired-buffers (delq elt dired-buffers)))
1897 (setq alist (cdr alist)))
1898 result))
1900 (defun dired-glob-regexp (pattern)
1901 "Convert glob-pattern PATTERN to a regular expression."
1902 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1903 regexp)
1904 (while (string-match "[[?*]" pattern matched-in-pattern)
1905 (let ((op-end (match-end 0))
1906 (next-op (aref pattern (match-beginning 0))))
1907 (setq regexp (concat regexp
1908 (regexp-quote
1909 (substring pattern matched-in-pattern
1910 (match-beginning 0)))))
1911 (cond ((= next-op ??)
1912 (setq regexp (concat regexp "."))
1913 (setq matched-in-pattern op-end))
1914 ((= next-op ?\[)
1915 ;; Fails to handle ^ yet ????
1916 (let* ((set-start (match-beginning 0))
1917 (set-cont
1918 (if (= (aref pattern (1+ set-start)) ?^)
1919 (+ 3 set-start)
1920 (+ 2 set-start)))
1921 (set-end (string-match "]" pattern set-cont))
1922 (set (substring pattern set-start (1+ set-end))))
1923 (setq regexp (concat regexp set))
1924 (setq matched-in-pattern (1+ set-end))))
1925 ((= next-op ?*)
1926 (setq regexp (concat regexp ".*"))
1927 (setq matched-in-pattern op-end)))))
1929 regexp
1930 (regexp-quote
1931 (substring pattern matched-in-pattern))
1936 (defun dired-advertise ()
1937 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1938 ;; With wildcards we actually advertise too much.
1939 (let ((expanded-default (expand-file-name default-directory)))
1940 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1941 t ; we have already advertised ourselves
1942 (setq dired-buffers
1943 (cons (cons expanded-default (current-buffer))
1944 dired-buffers)))))
1946 (defun dired-unadvertise (dir)
1947 ;; Remove DIR from the buffer alist in variable dired-buffers.
1948 ;; This has the effect of removing any buffer whose main directory is DIR.
1949 ;; It does not affect buffers in which DIR is a subdir.
1950 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1951 (setq dired-buffers
1952 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
1953 \f
1954 ;; Tree Dired
1956 ;;; utility functions
1958 (defun dired-in-this-tree (file dir)
1959 ;;"Is FILE part of the directory tree starting at DIR?"
1960 (let (case-fold-search)
1961 (string-match (concat "^" (regexp-quote dir)) file)))
1963 (defun dired-normalize-subdir (dir)
1964 ;; Prepend default-directory to DIR if relative file name.
1965 ;; dired-get-filename must be able to make a valid file name from a
1966 ;; file and its directory DIR.
1967 (file-name-as-directory
1968 (if (file-name-absolute-p dir)
1969 dir
1970 (expand-file-name dir default-directory))))
1972 (defun dired-get-subdir ()
1973 ;;"Return the subdir name on this line, or nil if not on a headerline."
1974 ;; Look up in the alist whether this is a headerline.
1975 (save-excursion
1976 (let ((cur-dir (dired-current-directory)))
1977 (beginning-of-line) ; alist stores b-o-l positions
1978 (and (zerop (- (point)
1979 (dired-get-subdir-min (assoc cur-dir
1980 dired-subdir-alist))))
1981 cur-dir))))
1983 ;(defun dired-get-subdir-min (elt)
1984 ; (cdr elt))
1985 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
1986 (defalias 'dired-get-subdir-min 'cdr)
1988 (defun dired-get-subdir-max (elt)
1989 (save-excursion
1990 (goto-char (dired-get-subdir-min elt))
1991 (dired-subdir-max)))
1993 (defun dired-clear-alist ()
1994 (while dired-subdir-alist
1995 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1996 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1998 (defun dired-subdir-index (dir)
1999 ;; Return an index into alist for use with nth
2000 ;; for the sake of subdir moving commands.
2001 (let (found (index 0) (alist dired-subdir-alist))
2002 (while alist
2003 (if (string= dir (car (car alist)))
2004 (setq alist nil found t)
2005 (setq alist (cdr alist) index (1+ index))))
2006 (if found index nil)))
2008 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2009 "Go to next subdirectory, regardless of level."
2010 ;; Use 0 arg to go to this directory's header line.
2011 ;; NO-SKIP prevents moving to end of header line, returning whatever
2012 ;; position was found in dired-subdir-alist.
2013 (interactive "p")
2014 (let ((this-dir (dired-current-directory))
2015 pos index)
2016 ;; nth with negative arg does not return nil but the first element
2017 (setq index (- (dired-subdir-index this-dir) arg))
2018 (setq pos (if (>= index 0)
2019 (dired-get-subdir-min (nth index dired-subdir-alist))))
2020 (if pos
2021 (progn
2022 (goto-char pos)
2024 (point))
2025 (if no-error-if-not-found
2026 nil ; return nil if not found
2027 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2029 (defun dired-build-subdir-alist (&optional switches)
2030 "Build `dired-subdir-alist' by parsing the buffer.
2031 Returns the new value of the alist.
2032 If optional arg SWITCHES is non-nil, use its value
2033 instead of `dired-actual-switches'."
2034 (interactive)
2035 (dired-clear-alist)
2036 (save-excursion
2037 (let* ((count 0)
2038 (buffer-read-only nil)
2039 (switches (or switches dired-actual-switches))
2040 new-dir-name
2041 (R-ftp-base-dir-regex
2042 ;; Used to expand subdirectory names correctly in recursive
2043 ;; ange-ftp listings.
2044 (and (string-match "R" switches)
2047 (goto-char (point-min))
2048 (setq dired-subdir-alist nil)
2049 (while (and (re-search-forward dired-subdir-regexp nil t)
2050 ;; Avoid taking a file name ending in a colon
2051 ;; as a subdir name.
2052 (not (save-excursion
2053 (goto-char (match-beginning 0))
2054 (beginning-of-line)
2055 (forward-char 2)
2056 (save-match-data (looking-at dired-re-perms)))))
2057 (save-excursion
2058 (goto-char (match-beginning 1))
2059 (setq new-dir-name
2060 (buffer-substring-no-properties (point) (match-end 1))
2061 new-dir-name
2062 (save-match-data
2063 (if (and R-ftp-base-dir-regex
2064 (not (string= new-dir-name default-directory))
2065 (string-match R-ftp-base-dir-regex new-dir-name))
2066 (concat default-directory
2067 (substring new-dir-name (match-end 0)))
2068 (expand-file-name new-dir-name))))
2069 (delete-region (point) (match-end 1))
2070 (insert new-dir-name))
2071 (setq count (1+ count))
2072 (dired-alist-add-1 new-dir-name
2073 ;; Place a sub directory boundary between lines.
2074 (save-excursion
2075 (goto-char (match-beginning 0))
2076 (beginning-of-line)
2077 (point-marker))))
2078 (if (> count 1)
2079 (message "Buffer includes %d directories" count))
2080 ;; We don't need to sort it because it is in buffer order per
2081 ;; constructionem. Return new alist:
2082 dired-subdir-alist)))
2084 (defun dired-alist-add-1 (dir new-marker)
2085 ;; Add new DIR at NEW-MARKER. Don't sort.
2086 (setq dired-subdir-alist
2087 (cons (cons (dired-normalize-subdir dir) new-marker)
2088 dired-subdir-alist)))
2090 (defun dired-goto-next-nontrivial-file ()
2091 ;; Position point on first nontrivial file after point.
2092 (dired-goto-next-file);; so there is a file to compare with
2093 (if (stringp dired-trivial-filenames)
2094 (while (and (not (eobp))
2095 (string-match dired-trivial-filenames
2096 (file-name-nondirectory
2097 (or (dired-get-filename nil t) ""))))
2098 (forward-line 1)
2099 (dired-move-to-filename))))
2101 (defun dired-goto-next-file ()
2102 (let ((max (1- (dired-subdir-max))))
2103 (while (and (not (dired-move-to-filename)) (< (point) max))
2104 (forward-line 1))))
2106 (defun dired-goto-file (file)
2107 "Go to file line of FILE in this dired buffer."
2108 ;; Return value of point on success, else nil.
2109 ;; FILE must be an absolute file name.
2112 ;; it in the buffer.
2113 (interactive
2114 (prog1 ; let push-mark display its message
2115 (list (expand-file-name
2116 (read-file-name "Goto file: "
2117 (dired-current-directory))))
2118 (push-mark)))
2119 (setq file (directory-file-name file)) ; does no harm if no directory
2120 (let (found case-fold-search dir)
2121 (setq dir (or (file-name-directory file)
2122 (error "File name `%s' is not absolute" file)))
2123 (save-excursion
2124 ;; The hair here is to get the result of dired-goto-subdir
2125 ;; without really calling it if we don't have any subdirs.
2126 (if (if (string= dir (expand-file-name default-directory))
2127 (goto-char (point-min))
2128 (and (cdr dired-subdir-alist)
2129 (dired-goto-subdir dir)))
2130 (let ((base (file-name-nondirectory file))
2131 search-string
2132 (boundary (dired-subdir-max)))
2133 (setq search-string
2135 (setq search-string
2137 (while (and (not found)
2138 ;; filenames are preceded by SPC, this makes
2139 ;; the search faster (e.g. for the filename "-"!).
2140 (search-forward (concat " " search-string)
2141 boundary 'move))
2142 ;; Match could have BASE just as initial substring or
2143 ;; or in permission bits or date or
2144 ;; not be a proper filename at all:
2145 (if (equal base (dired-get-filename 'no-dir t))
2146 ;; Must move to filename since an (actually
2147 ;; correct) match could have been elsewhere on the
2148 ;; ;; line (e.g. "-" would match somewhere in the
2149 ;; permission bits).
2150 (setq found (dired-move-to-filename))
2151 ;; If this isn't the right line, move forward to avoid
2152 ;; trying this line again.
2153 (forward-line 1))))))
2154 (and found
2155 ;; return value of point (i.e., FOUND):
2156 (goto-char found))))
2158 (defun dired-initial-position (dirname)
2159 ;; Where point should go in a new listing of DIRNAME.
2160 ;; Point assumed at beginning of new subdir line.
2161 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2162 (end-of-line)
2163 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2164 \f
2165 ;; These are hooks which make tree dired work.
2166 ;; They are in this file because other parts of dired need to call them.
2167 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2169 ;; This function is called for each retrieved filename.
2170 ;; It could stand to be faster, though it's mostly function call
2171 ;; overhead. Avoiding the function call seems to save about 10% in
2172 ;; dired-get-filename. Make it a defsubst?
2173 (defun dired-current-directory (&optional localp)
2174 "Return the name of the subdirectory to which this line belongs.
2175 This returns a string with trailing slash, like `default-directory'.
2176 Optional argument means return a file name relative to `default-directory'."
2177 (let ((here (point))
2178 (alist (or dired-subdir-alist
2179 ;; probably because called in a non-dired buffer
2180 (error "No subdir-alist in %s" (current-buffer))))
2181 elt dir)
2182 (while alist
2183 (setq elt (car alist)
2184 dir (car elt)
2185 ;; use `<=' (not `<') as subdir line is part of subdir
2186 alist (if (<= (dired-get-subdir-min elt) here)
2187 nil ; found
2188 (cdr alist))))
2189 (if localp
2190 (dired-make-relative dir default-directory)
2191 dir)))
2193 ;; Subdirs start at the beginning of their header lines and end just
2194 ;; before the beginning of the next header line (or end of buffer).
2196 (defun dired-subdir-max ()
2197 (save-excursion
2198 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2199 (point-max)
2200 (point))))
2201 \f
2202 ;; Deleting files
2204 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
2205 "*Decide whether recursive deletes are allowed.
2206 nil means no recursive deletes.
2207 `always' means delete recursively without asking. This is DANGEROUS!
2208 `top' means ask for each directory at top level, but delete its subdirectories
2209 without asking.
2210 Anything else means ask for each directory."
2211 :type '(choice :tag "Delete non-empty directories"
2212 (const :tag "Yes" always)
2213 (const :tag "No--only delete empty directories" nil)
2214 (const :tag "Confirm for each directory" t)
2215 (const :tag "Confirm for each top directory only" top))
2216 :group 'dired)
2218 ;; Match anything but `.' and `..'.
2221 ;; Delete file, possibly delete a directory and all its files.
2222 ;; This function is usefull outside of dired. One could change it's name
2223 ;; to e.g. recursive-delete-file and put it somewhere else.
2224 (defun dired-delete-file (file &optional recursive) "\
2225 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2226 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2227 Nil, do not delete.
2228 `always', delete recursively without asking.
2229 `top', ask for each directory at top level.
2230 Anything else, ask for each sub-directory."
2231 (let (files)
2232 ;; This test is equivalent to
2233 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2234 ;; but more efficient
2235 (if (not (eq t (car (file-attributes file))))
2236 (delete-file file)
2237 (when (and recursive
2238 (setq files
2239 (directory-files file t dired-re-no-dot)) ; Not empty.
2240 (or (eq recursive 'always)
2241 (yes-or-no-p (format "Recursive delete of %s "
2242 (dired-make-relative file)))))
2243 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2244 (while files ; Recursively delete (possibly asking).
2245 (dired-delete-file (car files) recursive)
2246 (setq files (cdr files))))
2247 (delete-directory file))))
2249 (defun dired-do-flagged-delete (&optional nomessage)
2250 "In Dired, delete the files flagged for deletion.
2251 If NOMESSAGE is non-nil, we don't display any message
2252 if there are no flagged files."
2253 (interactive)
2254 (let* ((dired-marker-char dired-del-marker)
2255 (regexp (dired-marker-regexp))
2256 case-fold-search)
2257 (if (save-excursion (goto-char (point-min))
2258 (re-search-forward regexp nil t))
2259 (dired-internal-do-deletions
2260 ;; this can't move point since ARG is nil
2261 (dired-map-over-marks (cons (dired-get-filename) (point))
2262 nil)
2263 nil)
2264 (or nomessage
2265 (message "(No deletions requested)")))))
2267 (defun dired-do-delete (&optional arg)
2268 "Delete all marked (or next ARG) files."
2269 ;; This is more consistent with the file marking feature than
2270 ;; dired-do-flagged-delete.
2271 (interactive "P")
2272 (dired-internal-do-deletions
2273 ;; this may move point if ARG is an integer
2274 (dired-map-over-marks (cons (dired-get-filename) (point))
2275 arg)
2276 arg))
2278 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2280 (defun dired-internal-do-deletions (l arg)
2281 ;; L is an alist of files to delete, with their buffer positions.
2282 ;; ARG is the prefix arg.
2283 ;; Filenames are absolute (VMS needs this for logical search paths).
2284 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2285 ;; That way as changes are made in the buffer they do not shift the
2286 ;; lines still to be changed, so the (point) values in L stay valid.
2287 ;; Also, for subdirs in natural order, a subdir's files are deleted
2288 ;; before the subdir itself - the other way around would not work.
2289 (let ((files (mapcar (function car) l))
2290 (count (length l))
2291 (succ 0))
2292 ;; canonicalize file list for pop up
2293 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2294 (if (dired-mark-pop-up
2295 " *Deletions*" 'delete files dired-deletion-confirmer
2296 (format "Delete %s " (dired-mark-prompt arg files)))
2297 (save-excursion
2298 (let (failures);; files better be in reverse order for this loop!
2299 (while l
2300 (goto-char (cdr (car l)))
2301 (let (buffer-read-only)
2302 (condition-case err
2303 (let ((fn (car (car l))))
2304 (dired-delete-file fn dired-recursive-deletes)
2305 ;; if we get here, removing worked
2306 (setq succ (1+ succ))
2307 (message "%s of %s deletions" succ count)
2308 (dired-fun-in-all-buffers
2309 (file-name-directory fn) (file-name-nondirectory fn)
2310 (function dired-delete-entry) fn))
2311 (error;; catch errors from failed deletions
2313 (setq failures (cons (car (car l)) failures)))))
2314 (setq l (cdr l)))
2315 (if (not failures)
2316 (message "%d deletion%s done" count (dired-plural-s count))
2317 (dired-log-summary
2318 (format "%d of %d deletion%s failed"
2319 (length failures) count
2320 (dired-plural-s count))
2321 failures))))
2322 (message "(No deletions performed)")))
2323 (dired-move-to-filename))
2325 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2326 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2327 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2328 ;; (FILE does not include a directory component.)
2329 ;; FILE may be nil, in which case ignore it.
2330 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2331 (let (success-list)
2332 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2333 file))
2334 (with-current-buffer buf
2335 (if (apply fun args)
2336 (setq success-list (cons (buffer-name buf) success-list)))))
2337 success-list))
2339 ;; Delete the entry for FILE from
2340 (defun dired-delete-entry (file)
2341 (save-excursion
2342 (and (dired-goto-file file)
2343 (let (buffer-read-only)
2344 (delete-region (progn (beginning-of-line) (point))
2345 (save-excursion (forward-line 1) (point))))))
2346 (dired-clean-up-after-deletion file))
2348 ;; This is a separate function for the sake of dired-x.el.
2349 (defun dired-clean-up-after-deletion (fn)
2350 ;; Clean up after a deleted file or directory FN.
2351 (save-excursion (and (cdr dired-subdir-alist)
2352 (dired-goto-subdir fn)
2353 (dired-kill-subdir))))
2354 \f
2355 ;; Confirmation
2357 (defun dired-marker-regexp ()
2358 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2360 (defun dired-plural-s (count)
2361 (if (= 1 count) "" "s"))
2363 (defun dired-mark-prompt (arg files)
2364 ;; Return a string for use in a prompt, either the current file
2365 ;; name, or the marker and a count of marked files.
2366 (let ((count (length files)))
2367 (if (= count 1)
2368 (car files)
2369 ;; more than 1 file:
2370 (if (integerp arg)
2371 ;; abs(arg) = count
2372 ;; Perhaps this is nicer, but it also takes more screen space:
2373 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2374 ;; count)
2375 (format "[next %d files]" arg)
2376 (format "%c [%d files]" dired-marker-char count)))))
2378 (defun dired-pop-to-buffer (buf)
2379 ;; Pop up buffer BUF.
2380 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2381 (if (not dired-shrink-to-fit)
2382 (pop-to-buffer (get-buffer-create buf))
2383 ;; let window shrink to fit:
2384 (let ((window (selected-window))
2385 target-lines w2)
2386 (cond ;; if split-height-threshold is enabled, use the largest window
2387 ((and (> (window-height (setq w2 (get-largest-window)))
2388 split-height-threshold)
2389 (= (frame-width) (window-width w2)))
2390 (setq window w2))
2391 ;; if the least-recently-used window is big enough, use it
2392 ((and (> (window-height (setq w2 (get-lru-window)))
2393 (* 2 window-min-height))
2394 (= (frame-width) (window-width w2)))
2395 (setq window w2)))
2396 (save-excursion
2397 (set-buffer buf)
2398 (goto-char (point-max))
2400 (setq target-lines (count-lines (point-min) (point)))
2401 ;; Don't forget to count the last line.
2402 (if (not (bolp))
2403 (setq target-lines (1+ target-lines))))
2404 (if (<= (window-height window) (* 2 window-min-height))
2405 ;; At this point, every window on the frame is too small to split.
2406 (setq w2 (display-buffer buf))
2407 (setq w2 (split-window window
2408 (max window-min-height
2409 (- (window-height window)
2410 (1+ (max window-min-height target-lines)))))))
2411 (set-window-buffer w2 buf)
2412 (if (< (1- (window-height w2)) target-lines)
2413 (progn
2414 (select-window w2)
2415 (enlarge-window (- target-lines (1- (window-height w2))))))
2416 (set-window-start w2 1)
2417 )))
2419 (defvar dired-no-confirm nil
2420 "A list of symbols for commands dired should not confirm.
2421 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2422 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2423 `touch' and `uncompress'.")
2425 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2426 "Return FUNCTION's result on ARGS after showing which files are marked.
2427 Displays the file names in a buffer named BUFNAME;
2429 This uses function `dired-pop-to-buffer' to do that.
2431 FUNCTION should not manipulate files, just read input
2432 (an argument or confirmation).
2433 The window is not shown if there is just one file or
2434 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2435 FILES is the list of marked files."
2436 (or bufname (setq bufname " *Marked Files*"))
2437 (if (or (eq dired-no-confirm t)
2438 (memq op-symbol dired-no-confirm)
2439 (= (length files) 1))
2440 (apply function args)
2441 (with-current-buffer (get-buffer-create bufname)
2442 (erase-buffer)
2443 (dired-format-columns-of-files files)
2444 (remove-text-properties (point-min) (point-max)
2445 '(mouse-face nil help-echo nil)))
2446 (save-window-excursion
2447 (dired-pop-to-buffer bufname)
2448 (apply function args))))
2450 (defun dired-format-columns-of-files (files)
2451 ;; Files should be in forward order for this loop.
2452 ;; i.e., (car files) = first file in buffer.
2453 ;; Returns the number of lines used.
2454 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2455 (width (- (window-width (selected-window)) 2))
2456 (columns (max 1 (/ width maxlen)))
2457 (nfiles (length files))
2458 (rows (+ (/ nfiles columns)
2459 (if (zerop (% nfiles columns)) 0 1)))
2460 (i 0)
2461 (j 0))
2462 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2463 (make-list (- (* columns rows) nfiles) "")))
2464 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2465 (while (< j rows)
2466 (while (< i columns)
2467 (indent-to (* i maxlen))
2468 (insert (car files))
2469 (setq files (nthcdr rows files)
2470 i (1+ i)))
2472 (setq i 0
2473 j (1+ j)
2474 files (cdr files)))
2475 rows))
2476 \f
2477 ;; Commands to mark or flag file(s) at or near current line.
2479 (defun dired-repeat-over-lines (arg function)
2480 ;; This version skips non-file lines.
2481 (let ((pos (make-marker)))
2482 (beginning-of-line)
2483 (while (and (> arg 0) (not (eobp)))
2484 (setq arg (1- arg))
2485 (beginning-of-line)
2486 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2487 (save-excursion
2488 (forward-line 1)
2489 (move-marker pos (1+ (point))))
2490 (save-excursion (funcall function))
2491 ;; Advance to the next line--actually, to the line that *was* next.
2492 ;; (If FUNCTION inserted some new lines in between, skip them.)
2493 (goto-char pos))
2494 (while (and (< arg 0) (not (bobp)))
2495 (setq arg (1+ arg))
2496 (forward-line -1)
2497 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2498 (beginning-of-line)
2499 (save-excursion (funcall function)))
2500 (move-marker pos nil)
2501 (dired-move-to-filename)))
2503 (defun dired-between-files ()
2504 ;; This used to be a regexp match of the `total ...' line output by
2505 ;; ls, which is slightly faster, but that is not very robust; notably,
2506 ;; it fails for non-english locales.
2507 (save-excursion (not (dired-move-to-filename))))
2509 (defun dired-next-marked-file (arg &optional wrap opoint)
2510 "Move to the next marked file, wrapping around the end of the buffer."
2512 (or opoint (setq opoint (point)));; return to where interactively started
2513 (if (if (> arg 0)
2514 (re-search-forward dired-re-mark nil t arg)
2515 (beginning-of-line)
2516 (re-search-backward dired-re-mark nil t (- arg)))
2517 (dired-move-to-filename)
2518 (if (null wrap)
2519 (progn
2520 (goto-char opoint)
2521 (error "No next marked file"))
2522 (message "(Wraparound for next marked file)")
2523 (goto-char (if (> arg 0) (point-min) (point-max)))
2524 (dired-next-marked-file arg nil opoint))))
2526 (defun dired-prev-marked-file (arg &optional wrap)
2527 "Move to the previous marked file, wrapping around the end of the buffer."
2529 (dired-next-marked-file (- arg) wrap))
2531 (defun dired-file-marker (file)
2532 ;; Return FILE's marker, or nil if unmarked.
2533 (save-excursion
2534 (and (dired-goto-file file)
2535 (progn
2536 (beginning-of-line)
2538 (following-char))))))
2540 (defun dired-mark-files-in-region (start end)
2541 (let (buffer-read-only)
2542 (if (> start end)
2543 (error "start > end"))
2544 (goto-char start) ; assumed at beginning of line
2545 (while (< (point) end)
2546 ;; Skip subdir line and following garbage like the `total' line:
2547 (while (and (< (point) end) (dired-between-files))
2548 (forward-line 1))
2549 (if (and (not (looking-at dired-re-dot))
2550 (dired-get-filename nil t))
2551 (progn
2552 (delete-char 1)
2553 (insert dired-marker-char)))
2554 (forward-line 1))))
2556 (defun dired-mark (arg)
2557 "Mark the current (or next ARG) files.
2558 If on a subdir headerline, mark all its files except `.' and `..'.
2562 this subdir."
2563 (interactive "P")
2564 (if (dired-get-subdir)
2565 (save-excursion (dired-mark-subdir-files))
2566 (let (buffer-read-only)
2567 (dired-repeat-over-lines
2568 (prefix-numeric-value arg)
2569 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2571 (defun dired-unmark (arg)
2572 "Unmark the current (or next ARG) files.
2573 If looking at a subdir, unmark all its files except `.' and `..'."
2574 (interactive "P")
2576 (dired-mark arg)))
2578 (defun dired-flag-file-deletion (arg)
2579 "In Dired, flag the current line's file for deletion.
2580 With prefix arg, repeat over several lines.
2582 If on a subdir headerline, mark all its files except `.' and `..'."
2583 (interactive "P")
2584 (let ((dired-marker-char dired-del-marker))
2585 (dired-mark arg)))
2587 (defun dired-unmark-backward (arg)
2588 "In Dired, move up lines and remove deletion flag there.
2589 Optional prefix ARG says how many lines to unflag; default is one line."
2590 (interactive "p")
2591 (dired-unmark (- arg)))
2593 (defun dired-toggle-marks ()
2594 "Toggle marks: marked files become unmarked, and vice versa.
2595 Files marked with other flags (such as `D') are not affected.
2596 `.' and `..' are never toggled.
2597 As always, hidden subdirs are not affected."
2598 (interactive)
2599 (save-excursion
2600 (goto-char (point-min))
2601 (let (buffer-read-only)
2602 (while (not (eobp))
2603 (or (dired-between-files)
2604 (looking-at dired-re-dot)
2605 ;; use subst instead of insdel because it does not move
2606 ;; the gap and thus should be faster and because
2607 ;; other characters are left alone automatically
2608 (apply 'subst-char-in-region
2609 (point) (1+ (point))
2613 (forward-line 1)))))
2614 \f
2615 ;;; Commands to mark or flag files based on their characteristics or names.
2617 (defvar dired-regexp-history nil
2618 "History list of regular expressions used in Dired commands.")
2620 (defun dired-read-regexp (prompt)
2621 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2623 (defun dired-mark-files-regexp (regexp &optional marker-char)
2624 "Mark all files matching REGEXP for use in later commands.
2625 A prefix argument means to unmark them instead.
2626 `.' and `..' are never marked.
2629 object files--just `.o' will mark more than you might think."
2630 (interactive
2631 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2632 " files (regexp): "))
2634 (let ((dired-marker-char (or marker-char dired-marker-char)))
2635 (dired-mark-if
2636 (and (not (looking-at dired-re-dot))
2637 (not (eolp)) ; empty line
2638 (let ((fn (dired-get-filename nil t)))
2639 (and fn (string-match regexp (file-name-nondirectory fn)))))
2640 "matching file")))
2642 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2643 "Mark all files with contents containing REGEXP for use in later commands.
2644 A prefix argument means to unmark them instead.
2645 `.' and `..' are never marked."
2646 (interactive
2647 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2648 " files containing (regexp): "))
2650 (let ((dired-marker-char (or marker-char dired-marker-char)))
2651 (dired-mark-if
2652 (and (not (looking-at dired-re-dot))
2653 (not (eolp)) ; empty line
2654 (let ((fn (dired-get-filename nil t)))
2655 (when (and fn (file-readable-p fn)
2656 (not (file-directory-p fn)))
2657 (let ((prebuf (get-file-buffer fn)))
2658 (message "Checking %s" fn)
2659 ;; For now we do it inside emacs
2660 ;; Grep might be better if there are a lot of files
2661 (if prebuf
2662 (with-current-buffer prebuf
2663 (save-excursion
2664 (goto-char (point-min))
2665 (re-search-forward regexp nil t)))
2666 (with-temp-buffer
2667 (insert-file-contents fn)
2668 (goto-char (point-min))
2669 (re-search-forward regexp nil t))))
2670 )))
2671 "matching file")))
2673 (defun dired-flag-files-regexp (regexp)
2674 "In Dired, flag all files containing the specified REGEXP for deletion.
2675 The match is against the non-directory part of the filename. Use `^'
2676 and `$' to anchor matches. Exclude subdirs by hiding them.
2677 `.' and `..' are never flagged."
2678 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2679 (dired-mark-files-regexp regexp dired-del-marker))
2681 (defun dired-mark-symlinks (unflag-p)
2682 "Mark all symbolic links.
2683 With prefix argument, unflag all those files."
2684 (interactive "P")
2686 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2688 (defun dired-mark-directories (unflag-p)
2689 "Mark all directory file lines except `.' and `..'.
2690 With prefix argument, unflag all those files."
2691 (interactive "P")
2693 (dired-mark-if (and (looking-at dired-re-dir)
2694 (not (looking-at dired-re-dot)))
2695 "directory file")))
2697 (defun dired-mark-executables (unflag-p)
2698 "Mark all executable files.
2699 With prefix argument, unflag all those files."
2700 (interactive "P")
2702 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2704 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2705 ;; files for which PREDICATE returns non-nil.
2707 (defun dired-flag-auto-save-files (&optional unflag-p)
2708 "Flag for deletion files whose names suggest they are auto save files.
2709 A prefix argument says to unflag those files instead."
2710 (interactive "P")
2712 (dired-mark-if
2713 ;; It is less than general to check for # here,
2714 ;; but it's the only way this runs fast enough.
2715 (and (save-excursion (end-of-line)
2716 (or
2717 (eq (preceding-char) ?#)
2718 ;; Handle executables in case of -F option.
2719 ;; We need not worry about the other kinds
2720 ;; of markings that -F makes, since they won't
2721 ;; appear on real auto-save files.
2722 (if (eq (preceding-char) ?*)
2723 (progn
2724 (forward-char -1)
2725 (eq (preceding-char) ?#)))))
2726 (not (looking-at dired-re-dir))
2727 (let ((fn (dired-get-filename t t)))
2728 (if fn (auto-save-file-name-p
2729 (file-name-nondirectory fn)))))
2730 "auto save file")))
2732 (defcustom dired-garbage-files-regexp
2733 ;; `log' here is dubious, since it's typically used for useful log
2734 ;; files, not just TeX stuff. -- fx
2735 (concat (regexp-opt
2736 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2739 :type 'regexp
2740 :group 'dired)
2742 (defun dired-flag-garbage-files ()
2743 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2744 (interactive)
2745 (dired-flag-files-regexp dired-garbage-files-regexp))
2747 (defun dired-flag-backup-files (&optional unflag-p)
2748 "Flag all backup files (names ending with `~') for deletion.
2749 With prefix argument, unflag these files."
2750 (interactive "P")
2751 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
2752 (dired-mark-if
2753 ;; Don't call backup-file-name-p unless the last character looks like
2754 ;; it might be the end of a backup file name. This isn't very general,
2755 ;; but it's the only way this runs fast enough.
2756 (and (save-excursion (end-of-line)
2757 ;; Handle executables in case of -F option.
2758 ;; We need not worry about the other kinds
2759 ;; of markings that -F makes, since they won't
2760 ;; appear on real backup files.
2761 (if (eq (preceding-char) ?*)
2762 (forward-char -1))
2763 (eq (preceding-char) ?~))
2764 (not (looking-at dired-re-dir))
2765 (let ((fn (dired-get-filename t t)))
2766 (if fn (backup-file-name-p fn))))
2767 "backup file")))
2769 (defun dired-change-marks (&optional old new)
2770 "Change all OLD marks to NEW marks.
2771 OLD and NEW are both characters used to mark files."
2772 (interactive
2773 (let* ((cursor-in-echo-area t)
2774 (old (progn (message "Change (old mark): ") (read-char)))
2775 (new (progn (message "Change %c marks to (new mark): " old)
2776 (read-char))))
2777 (list old new)))
2779 (ding)
2781 (buffer-read-only))
2782 (save-excursion
2783 (goto-char (point-min))
2784 (while (search-forward string nil t)
2785 (if (if (= old ?\ )
2786 (save-match-data
2787 (dired-get-filename 'no-dir t))
2788 t)
2789 (subst-char-in-region (match-beginning 0)
2790 (match-end 0) old new)))))))
2792 (defun dired-unmark-all-marks ()
2793 "Remove all marks from all files in the Dired buffer."
2794 (interactive)
2797 (defun dired-unmark-all-files (mark &optional arg)
2798 "Remove a specific mark (or any mark) from every file.
2799 After this command, type the mark character to remove,
2800 or type RET to remove all marks.
2801 With prefix arg, query for each marked file.
2804 (save-excursion
2805 (let* ((count 0)
2806 buffer-read-only case-fold-search query
2808 (help-form "\
2809 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2810 `!' to unmark all remaining files with no more questions."))
2811 (goto-char (point-min))
2813 (re-search-forward dired-re-mark nil t)
2814 (search-forward string nil t))
2815 (if (or (not arg)
2816 (let ((file (dired-get-filename t t)))
2817 (and file
2818 (dired-query 'query "Unmark file `%s'? "
2819 file))))
2820 (progn (subst-char-in-region (1- (point)) (point)
2821 (preceding-char) ?\ )
2822 (setq count (1+ count)))))
2823 (message (if (= count 1) "1 mark removed"
2824 "%d marks removed")
2825 count))))
2826 \f
2827 ;; Logging failures operating on files, and showing the results.
2829 (defvar dired-log-buffer "*Dired log*")
2831 (defun dired-why ()
2832 "Pop up a buffer with error log output from Dired.
2833 A group of errors from a single command ends with a formfeed.
2835 (interactive)
2836 (if (get-buffer dired-log-buffer)
2837 (let ((owindow (selected-window))
2838 (window (display-buffer (get-buffer dired-log-buffer))))
2839 (unwind-protect
2840 (progn
2841 (select-window window)
2842 (goto-char (point-max))
2843 (forward-line -1)
2844 (backward-page 1)
2845 (recenter 0))
2846 (select-window owindow)))))
2848 (defun dired-log (log &rest args)
2849 ;; Log a message or the contents of a buffer.
2850 ;; If LOG is a string and there are more args, it is formatted with
2852 ;; End each bunch of errors with (dired-log t):
2853 ;; this inserts the current time and buffer at the start of the page,
2855 (let ((obuf (current-buffer)))
2856 (with-current-buffer (get-buffer-create dired-log-buffer)
2857 (goto-char (point-max))
2858 (let ((inhibit-read-only t))
2859 (cond ((stringp log)
2860 (insert (if args
2861 (apply (function format) log args)
2862 log)))
2863 ((bufferp log)
2864 (insert-buffer log))
2865 ((eq t log)
2866 (backward-page 1)
2867 (unless (bolp)
2869 (insert (current-time-string)
2871 (goto-char (point-max))
2874 (defun dired-log-summary (string failures)
2875 (if (= (length failures) 1)
2876 (message "%s"
2877 (with-current-buffer dired-log-buffer
2878 (goto-char (point-max))
2879 (backward-page 1)
2880 (if (eolp) (forward-line 1))
2881 (buffer-substring (point) (point-max))))
2882 (message (if failures "%s--type ? for details (%s)"
2883 "%s--type ? for details")
2884 string failures))
2885 ;; Log a summary describing a bunch of errors.
2887 (dired-log t))
2888 \f
2889 ;;; Sorting
2891 ;; Most ls can only sort by name or by date (with -t), nothing else.
2892 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2893 ;; So anything that does not contain these is sort "by name".
2895 (defvar dired-ls-sorting-switches "SXU"
2896 "String of `ls' switches \(single letters\) except `t' that influence sorting.
2898 This indicates to Dired which option switches to watch out for because they
2899 will change the sorting order behavior of `ls'.
2901 To change the default sorting order \(e.g. add a `-v' option\), see the
2902 variable `dired-listing-switches'. To temporarily override the listing
2905 (defvar dired-sort-by-date-regexp
2906 (concat "^-[^" dired-ls-sorting-switches
2907 "]*t[^" dired-ls-sorting-switches "]*$")
2908 "Regexp recognized by dired to set `by date' mode.")
2910 (defvar dired-sort-by-name-regexp
2911 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2912 "Regexp recognized by dired to set `by name' mode.")
2914 (defvar dired-sort-inhibit nil
2915 "Non-nil means the Dired sort command is disabled.
2916 The idea is to set this buffer-locally in special Dired buffers.")
2918 (defun dired-sort-set-modeline ()
2919 ;; Set modeline display according to dired-actual-switches.
2920 ;; Modeline display of "by name" or "by date" guarantees the user a
2921 ;; match with the corresponding regexps. Non-matching switches are
2922 ;; shown literally.
2923 (setq mode-name
2924 (let (case-fold-search)
2925 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
2926 "Dired by name")
2927 ((string-match dired-sort-by-date-regexp dired-actual-switches)
2928 "Dired by date")
2929 (t
2930 (concat "Dired " dired-actual-switches)))))
2931 (force-mode-line-update))
2933 (defun dired-sort-toggle-or-edit (&optional arg)
2934 "Toggle between sort by date/name and refresh the dired buffer.
2935 With a prefix argument you can edit the current listing switches instead."
2936 (interactive "P")
2937 (when dired-sort-inhibit
2938 (error "Cannot sort this Dired buffer"))
2939 (if arg
2940 (dired-sort-other
2941 (read-string "ls switches (must contain -l): " dired-actual-switches))
2942 (dired-sort-toggle)))
2944 (defun dired-sort-toggle ()
2945 ;; Toggle between sort by date/name. Reverts the buffer.
2946 (setq dired-actual-switches
2947 (let (case-fold-search)
2948 (if (string-match " " dired-actual-switches)
2949 ;; New toggle scheme: add/remove a trailing " -t"
2951 (substring dired-actual-switches 0 (match-beginning 0))
2952 (concat dired-actual-switches " -t"))
2953 ;; old toggle scheme: look for some 't' switch and add/remove it
2954 (concat
2955 "-l"
2956 (dired-replace-in-string (concat "[-lt"
2957 dired-ls-sorting-switches "]")
2958 ""
2959 dired-actual-switches)
2960 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2961 dired-actual-switches)
2962 ""
2963 "t")))))
2964 (dired-sort-set-modeline)
2965 (revert-buffer))
2967 ;; Some user code loads dired especially for this.
2968 ;; Don't do that--use replace-regexp-in-string instead.
2969 (defun dired-replace-in-string (regexp newtext string)
2970 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2972 (let ((result "") (start 0) mb me)
2973 (while (string-match regexp string start)
2974 (setq mb (match-beginning 0)
2975 me (match-end 0)
2976 result (concat result (substring string start mb) newtext)
2977 start me))
2978 (concat result (substring string start))))
2980 (defun dired-sort-other (switches &optional no-revert)
2981 "Specify new ls SWITCHES for current dired buffer.
2982 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
2983 set the minor mode accordingly, others appear literally in the mode line.
2984 With optional second arg NO-REVERT, don't refresh the listing afterwards."
2985 (dired-sort-R-check switches)
2986 (setq dired-actual-switches switches)
2987 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
2988 (or no-revert (revert-buffer)))
2990 (make-variable-buffer-local
2991 (defvar dired-subdir-alist-pre-R nil
2992 "Value of `dired-subdir-alist' before -R switch added."))
2994 (defun dired-sort-R-check (switches)
2995 "Additional processing of -R in ls option string SWITCHES.
2996 Saves `dired-subdir-alist' when R is set and restores saved value
2997 minus any directories explicitly deleted when R is cleared.
2998 To be called first in body of `dired-sort-other', etc."
2999 (cond
3000 ((and (string-match "R" switches)
3001 (not (string-match "R" dired-actual-switches)))
3002 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3003 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3004 ((and (string-match "R" dired-actual-switches)
3005 (not (string-match "R" switches)))
3006 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3007 ;; that are still present:
3008 (setq dired-subdir-alist
3009 (if dired-subdir-alist-pre-R
3010 (let (subdirs)
3011 (while dired-subdir-alist-pre-R
3012 (if (assoc (caar dired-subdir-alist-pre-R)
3013 dired-subdir-alist)
3014 ;; subdir still present...
3015 (setq subdirs
3016 (cons (car dired-subdir-alist-pre-R)
3017 subdirs)))
3018 (setq dired-subdir-alist-pre-R
3019 (cdr dired-subdir-alist-pre-R)))
3020 (reverse subdirs))
3021 ;; No pre-R subdir alist, so revert to main directory
3022 ;; listing:
3023 (list (car (reverse dired-subdir-alist))))))))
3024 \f
3025 ;; To make this file smaller, the less common commands
3026 ;; go in a separate file. But autoload them here
3027 ;; to make the separation invisible.
3029 (autoload 'dired-diff "dired-aux"
3030 "Compare file at point with file FILE using `diff'.
3031 FILE defaults to the file at the mark. (That's the mark set by
3033 The prompted-for file is the first file given to `diff'."
3034 t)
3036 (autoload 'dired-backup-diff "dired-aux"
3037 "Diff this file with its backup file or vice versa.
3038 Uses the latest backup, if there are several numerical backups.
3039 If this file is a backup, diff it with its original.
3040 The backup file is the first file given to `diff'."
3041 t)
3043 (autoload 'dired-clean-directory "dired-aux"
3044 "Flag numerical backups for deletion.
3045 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3046 Positive prefix arg KEEP overrides `dired-kept-versions';
3047 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3050 with a prefix argument."
3051 t)
3053 (autoload 'dired-do-chmod "dired-aux"
3054 "Change the mode of the marked (or next ARG) files.
3055 This calls chmod, thus symbolic modes like `g+w' are allowed."
3056 t)
3058 (autoload 'dired-do-chgrp "dired-aux"
3059 "Change the group of the marked (or next ARG) files."
3060 t)
3062 (autoload 'dired-do-chown "dired-aux"
3063 "Change the owner of the marked (or next ARG) files."
3064 t)
3066 (autoload 'dired-do-touch "dired-aux"
3067 "Change the timestamp of the marked (or next ARG) files."
3068 t)
3070 (autoload 'dired-do-print "dired-aux"
3071 "Print the marked (or next ARG) files.
3072 Uses the shell command coming from variables `lpr-command' and
3073 `lpr-switches' as default."
3074 t)
3076 (autoload 'dired-do-shell-command "dired-aux"
3077 "Run a shell command COMMAND on the marked files.
3078 If no files are marked or a specific numeric prefix arg is given,
3080 The prompt mentions the file(s) or the marker, as appropriate.
3082 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3083 COMMAND just once with the entire file list substituted there.
3085 If there is no `*', but there is a `?' in COMMAND, surrounded by
3086 whitespace, this runs COMMAND on each file individually with the
3087 file name substituted for `?'.
3089 Otherwise, this runs COMMAND on each file individually with the
3090 file name added at the end of COMMAND (separated by a space).
3092 `*' and `?' when not surrounded by whitespace have no special
3093 significance for `dired-do-shell-command', and are passed through
3094 normally to the shell, but you must confirm first. To pass `*' by
3097 If COMMAND produces output, it goes to a separate buffer.
3099 This feature does not try to redisplay Dired buffers afterward, as
3100 there's no telling what files COMMAND may have changed.
3103 When COMMAND runs, its working directory is the top-level directory of
3104 the Dired buffer, so output files usually are created there instead of
3105 in a subdir.
3107 In a noninteractive call (from Lisp code), you must specify
3108 the list of file names explicitly with the FILE-LIST argument."
3109 t)
3111 (autoload 'dired-do-kill-lines "dired-aux"
3112 "Kill all marked lines (not the files).
3113 With a prefix arg, kill all lines not marked or flagged."
3114 t)
3116 (autoload 'dired-do-compress "dired-aux"
3117 "Compress or uncompress marked (or next ARG) files."
3118 t)
3120 (autoload 'dired-do-byte-compile "dired-aux"
3121 "Byte compile marked (or next ARG) Emacs Lisp files."
3122 t)
3124 (autoload 'dired-do-load "dired-aux"
3125 "Load the marked (or next ARG) Emacs Lisp files."
3126 t)
3128 (autoload 'dired-do-redisplay "dired-aux"
3129 "Redisplay all marked (or next ARG) files.
3130 If on a subdir line, redisplay that subdirectory. In that case,
3131 a prefix arg lets you edit the `ls' switches used for the new listing."
3132 t)
3134 (autoload 'dired-create-directory "dired-aux"
3135 "Create a directory called DIRECTORY."
3136 t)
3138 (autoload 'dired-do-copy "dired-aux"
3139 "Copy all marked (or next ARG) files, or copy the current file.
3140 Thus, a zero prefix argument copies nothing. But it toggles the
3141 variable `dired-copy-preserve-time' (which see)."
3142 t)
3144 (autoload 'dired-do-symlink "dired-aux"
3145 "Make symbolic links to current file or all marked (or next ARG) files.
3146 When operating on just the current file, you specify the new name.
3147 When operating on multiple or marked files, you specify a directory
3148 and new symbolic links are made in that directory
3149 with the same names that the files currently have."
3150 t)
3152 (autoload 'dired-do-hardlink "dired-aux"
3153 "Add names (hard links) current file or all marked (or next ARG) files.
3154 When operating on just the current file, you specify the new name.
3155 When operating on multiple or marked files, you specify a directory
3156 and new hard links are made in that directory
3157 with the same names that the files currently have."
3158 t)
3160 (autoload 'dired-do-rename "dired-aux"
3161 "Rename current file or all marked (or next ARG) files.
3162 When renaming just the current file, you specify the new name.
3163 When renaming multiple or marked files, you specify a directory."
3164 t)
3166 (autoload 'dired-do-rename-regexp "dired-aux"
3167 "Rename marked files containing REGEXP to NEWNAME.
3168 As each match is found, the user must type a character saying
3171 REGEXP defaults to the last regexp used.
3172 With a zero prefix arg, renaming by regexp affects the full file name;
3173 usually only the non-directory part of file names is used and changed."
3174 t)
3176 (autoload 'dired-do-copy-regexp "dired-aux"
3177 "Copy all marked files containing REGEXP to NEWNAME.
3178 See function `dired-do-rename-regexp' for more info."
3179 t)
3181 (autoload 'dired-do-hardlink-regexp "dired-aux"
3182 "Hardlink all marked files containing REGEXP to NEWNAME.
3183 See function `dired-do-rename-regexp' for more info."
3184 t)
3186 (autoload 'dired-do-symlink-regexp "dired-aux"
3187 "Symlink all marked files containing REGEXP to NEWNAME.
3188 See function `dired-do-rename-regexp' for more info."
3189 t)
3191 (autoload 'dired-upcase "dired-aux"
3192 "Rename all marked (or next ARG) files to upper case."
3193 t)
3195 (autoload 'dired-downcase "dired-aux"
3196 "Rename all marked (or next ARG) files to lower case."
3197 t)
3199 (autoload 'dired-maybe-insert-subdir "dired-aux"
3200 "Insert this subdirectory into the same dired buffer.
3202 else inserts it at its natural place (as `ls -lR' would have done).
3203 With a prefix arg, you may edit the ls switches used for this listing.
3204 You can add `R' to the switches to expand the whole tree starting at
3205 this subdirectory.
3206 This function takes some pains to conform to `ls -lR' output."
3207 t)
3209 (autoload 'dired-next-subdir "dired-aux"
3210 "Go to next subdirectory, regardless of level."
3211 t)
3213 (autoload 'dired-prev-subdir "dired-aux"
3214 "Go to previous subdirectory, regardless of level.
3215 When called interactively and not on a subdir line, go to this subdir's line."
3216 t)
3218 (autoload 'dired-goto-subdir "dired-aux"
3219 "Go to end of header line of DIR in this dired buffer.
3220 Return value of point on success, otherwise return nil.
3222 t)
3224 (autoload 'dired-mark-subdir-files "dired-aux"
3225 "Mark all files except `.' and `..'."
3226 t)
3228 (autoload 'dired-kill-subdir "dired-aux"
3229 "Remove all lines of current subdirectory.
3230 Lower levels are unaffected."
3231 t)
3233 (autoload 'dired-tree-up "dired-aux"
3234 "Go up ARG levels in the dired tree."
3235 t)
3237 (autoload 'dired-tree-down "dired-aux"
3238 "Go down in the dired tree."
3239 t)
3241 (autoload 'dired-hide-subdir "dired-aux"
3242 "Hide or unhide the current subdirectory and move to next directory.
3243 Optional prefix arg is a repeat factor.
3245 t)
3247 (autoload 'dired-hide-all "dired-aux"
3248 "Hide all subdirectories, leaving only their header lines.
3249 If there is already something hidden, make everything visible again.
3251 t)
3253 (autoload 'dired-show-file-type "dired-aux"
3254 "Print the type of FILE, according to the `file' command.
3255 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
3256 true then the type of the file linked to by FILE is printed instead."
3257 t)
3259 (autoload 'dired-run-shell-command "dired-aux")
3261 (autoload 'dired-query "dired-aux")
3262 \f
3264 ;;;; Drag and drop support
3266 (defun dired-dnd-test-function (window action types)
3267 "The test function for drag and drop into dired buffers.
3268 WINDOW is where the mouse is when this function is called. It may be a frame
3269 if the mouse is over the menu bar, scroll bar or tool bar.
3270 ACTION is the suggested action from the source, and TYPES are the
3271 types the drop data can have. This function only accepts drops with
3272 types in `x-dnd-known-types'. It returns the action suggested by the source."
3273 (let ((type (x-dnd-choose-type types)))
3274 (if type
3275 (cons action type)
3276 nil)))
3278 (defun dired-dnd-popup-notice ()
3279 (x-popup-dialog
3280 t
3282 ("Ok" . nil))))
3285 (defun dired-dnd-do-ask-action (uri)
3286 ;; No need to get actions and descriptions from the source,
3287 ;; we only have three actions anyway.
3288 (let ((action (x-popup-menu
3289 t
3290 (list "What action?"
3291 (cons ""
3292 '(("Copy here" . copy)
3293 ("Move here" . move)
3294 ("Link here" . link)
3295 "--"
3296 ("Cancel" . nil)))))))
3297 (if action
3298 (dired-dnd-handle-local-file uri action)
3299 nil)))
3301 (defun dired-dnd-handle-local-file (uri action)
3302 "Copy, move or link a file to the dired directory.
3303 URI is the file to handle, ACTION is one of copy, move, link or ask.
3304 Ask means pop up a menu for the user to select one of copy, move or link."
3305 (require 'dired-aux)
3306 (let* ((from (x-dnd-get-local-file-name uri t))
3307 (to (if from (concat (dired-current-directory)
3308 (file-name-nondirectory from))
3309 nil)))
3310 (if from
3311 (cond ((or (eq action 'copy)
3312 (eq action 'private)) ; Treat private as copy.
3314 ;; If copying a directory and dired-recursive-copies is nil,
3315 ;; dired-copy-file silently fails. Pop up a notice.
3316 (if (and (file-directory-p from)
3317 (not dired-recursive-copies))
3318 (dired-dnd-popup-notice)
3319 (progn
3320 (dired-copy-file from to 1)
3321 (dired-relist-entry to)
3322 action)))
3324 ((eq action 'move)
3325 (dired-rename-file from to 1)
3326 (dired-relist-entry to)
3327 action)
3329 ((eq action 'link)
3330 (make-symbolic-link from to 1)
3331 (dired-relist-entry to)
3332 action)
3334 ((eq action 'ask)
3335 (dired-dnd-do-ask-action uri))
3337 (t nil)))))
3339 (defun dired-dnd-handle-file (uri action)
3340 "Copy, move or link a file to the dired directory if it is a local file.
3341 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3342 ACTION is one of copy, move, link or ask.
3343 Ask means pop up a menu for the user to select one of copy, move or link."
3344 (let ((local-file (x-dnd-get-local-file-uri uri)))
3345 (if local-file (dired-dnd-handle-local-file local-file action)
3346 nil)))
3347 \f
3349 ;;;; Desktop support
3351 (eval-when-compile (require 'desktop))
3353 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3354 "Auxiliary information to be saved in desktop file."
3355 (cons
3356 ;; Value of `dired-directory'.
3357 (if (consp dired-directory)
3358 ;; Directory name followed by list of files.
3359 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3360 (cdr dired-directory))
3361 ;; Directory name, optionally with with shell wildcard.
3362 (desktop-file-name dired-directory desktop-dirname))
3363 ;; Subdirectories in `dired-subdir-alist'.
3364 (cdr
3365 (nreverse
3366 (mapcar
3367 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3368 dired-subdir-alist)))))
3370 ;;;###autoload
3371 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3372 desktop-buffer-name
3373 desktop-buffer-misc)
3374 "Restore a dired buffer specified in a desktop file."
3375 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3376 ;; This value is a directory name, optionally with with shell wildcard or
3377 ;; a directory name followed by list of files.
3378 (let* ((dired-dir (car desktop-buffer-misc))
3379 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3380 (if (file-directory-p (file-name-directory dir))
3381 (progn
3382 (dired dired-dir)
3383 ;; The following elements of `desktop-buffer-misc' are the keys
3384 ;; from `dired-subdir-alist'.
3385 (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3386 (current-buffer))
3387 (message "Desktop: Directory %s no longer exists." dir)
3388 (when desktop-missing-file-warning (sit-for 1))
3389 nil)))
3391 \f
3392 (if (eq system-type 'vax-vms)
3393 (load "dired-vms"))
3395 (provide 'dired)
3397 (run-hooks 'dired-load-hook) ; for your customizations
3399 ;;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3400 ;;; dired.el ends here