| blob | 0341214a98e1dd4f3f21a387f8e67459aab12055 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4 ;; 2001, 2003, 2004 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."
64 "If non-nil, switches passed to `ls' for inserting subdirectories.
67 ; Don't use absolute file names as /bin should be in any PATH and people
68 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
69 ; usually not in PATH.
71 ;;;###autoload
74 "chown"
76 "/usr/sbin/chown"
89 ;;;###autoload
91 "*Informs dired about how `ls -lF' marks symbolic links.
92 Set this to t if `ls' (or whatever program is specified by
93 `insert-directory-program') with `-lF' marks the symbolic link
94 itself with a trailing @ (usually the case under Ultrix).
96 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
97 nil (the default), if it gives `bar@ -> foo', set it to t.
99 Dired checks if there is really a @ appended. Thus, if you have a
100 marking `ls' program on one host and a non-marking on another host, and
101 don't care about symbolic links which really end in a @, you can
102 always set this variable to t."
106 ;;;###autoload
108 "*Regexp of files to skip when finding first file of a directory.
109 A value of nil means move to the subdir line.
110 A value of t means move to first file."
113 regexp)
116 ;;;###autoload
118 ;; Use t as default so that moved files "take their markers with them".
119 "*Controls marking of renamed files.
120 If t, files keep their previous marks when they are renamed.
121 If a character, renamed files (whether previously marked or not)
122 are afterward marked with that character."
127 ;;;###autoload
129 "*Controls marking of copied files.
130 If t, copied files are marked if and as the corresponding original files were.
131 If a character, copied files are unconditionally marked with that character."
136 ;;;###autoload
138 "*Controls marking of newly made hard links.
139 If t, they are marked if and as the files linked to were marked.
140 If a character, new links are unconditionally marked with that character."
145 ;;;###autoload
147 "*Controls marking of newly made symbolic links.
148 If t, they are marked if and as the files linked to were marked.
149 If a character, new links are unconditionally marked with that character."
154 ;;;###autoload
156 "*If non-nil, dired tries to guess a default target directory.
157 This means: if there is a dired buffer displayed in the next window,
158 use its current subdir, instead of the current subdir of this dired buffer.
160 The target is used in the prompt for file copy, rename etc."
164 ;;;###autoload
166 "*If non-nil, Dired preserves the last-modified time in a file copy.
167 \(This works on only some systems.)"
171 ; These variables were deleted and the replacements are on files.el.
172 ; We leave aliases behind for back-compatibility.
176 ;;; Hook variables
179 "Run after loading dired.
180 You can customize key bindings or load extensions with this."
185 "Run at the very end of dired-mode."
190 "This hook is run before a dired buffer is read in (created or reverted)."
195 "Hook run after each time a file or directory is read by Dired.
196 After each listing of a file or directory, this hook is run
197 with the buffer narrowed to the listing."
200 ;; Note this can't simply be run inside function `dired-ls' as the hook
201 ;; functions probably depend on the dired-subdir-alist to be OK.
203 ;; Internal variables
206 ;; so that you can write things like
207 ;; (let ((dired-marker-char ?X))
208 ;; ;; great code using X markers ...
209 ;; )
210 ;; For example, commands operating on two sets of files, A and B.
211 ;; Or marking files with digits 0-9. This could implicate
212 ;; concentric sets or an order for the marked files.
213 ;; The code depends on dynamic scoping on the marker char.
214 "In Dired, the current mark character.
221 t
222 ;; I see no reason ever to make this nil -- rms.
223 ;; (> baud-rate search-slow-speed)
230 ;;;###autoload
232 "The directory name or wildcard spec that this Dired directory lists.
233 Local to each dired buffer. May be a list, in which case the car is the
234 directory name and the cdr is the list of files to mention.
243 ;; These regexps must be tested at beginning-of-line, but are also
244 ;; used to search for next matches, so neither omitting "^" nor
245 ;; replacing "^" by "\n" (to make it slightly faster) will work.
248 ;; "Regexp matching a marked line.
249 ;; Important: the match ends just after the marker."
251 ;; The [^:] part after "d" and "l" is to avoid confusion with the
252 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
260 "-[-r][-w].[-r][-w][xs][-r][-w]."
266 ;; The subdirectory names in the next two lists are expanded.
268 "Association list of subdirectories and their buffer positions.
269 Each subdirectory has an element: (DIRNAME . STARTMARKER).
270 The order of elements is the reverse of the order in the buffer.
274 "Keeps track of which switches to use for inserted subdirectories.
279 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
280 Subexpression 1 is the subdirectory proper, no trailing colon.
281 The match starts at the beginning of the line and ends after the end
286 "Faces used by dired."
292 "Face used for directory headers."
300 "Face used for dired marks."
308 "Face used for marked files."
316 "Face used for flagged files."
324 "Face used to highlight a part of a buffer that needs user attention."
332 "Face used for subdirectories."
340 "Face used for symbolic links."
348 "Face used for files suffixed with `completion-ignored-extensions'."
356 ;;
357 ;; Directory headers.
359 ;;
360 ;; Dired marks.
362 ;;
363 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
364 ;; file name itself. We search for Dired defined regexps, and then use the
365 ;; Dired defined function `dired-move-to-filename' before searching for the
366 ;; simple regexp ".+". It is that regexp which matches the file name.
367 ;;
368 ;; Marked files.
371 ;;
372 ;; Flagged files.
375 ;; People who are paranoid about security would consider this more
376 ;; important than other things such as whether it is a directory.
377 ;; But we don't want to encourage paranoia, so our default
378 ;; should be what's most useful for non-paranoids. -- rms.
379 ;;; ;;
380 ;;; ;; Files that are group or world writable.
381 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
382 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
383 ;;; '(1 dired-warning-face)
384 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
385 ;; However, we don't need to highlight the file name, only the
386 ;; permissions, to win generally. -- fx.
387 ;; Fixme: we could also put text properties on the permission
388 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
395 ;;
396 ;; Subdirectories.
399 ;;
400 ;; Symbolic links.
403 ;;
404 ;; Files suffixed with `completion-ignored-extensions'.
406 ;; It is quicker to first find just an extension, then go back to the
407 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
411 \f
412 ;;; Macros must be defined before they are used, for the byte compiler.
415 "Mark all files for which PREDICATE evals to non-nil.
416 PREDICATE is evaluated on each line, with point at beginning of line.
417 MSG is a noun phrase for the type of files being marked.
418 It should end with a noun that can be pluralized by adding `s'.
419 Return value is the number of files marked, or nil if none were marked."
433 count
434 ,msg
442 "Eval BODY with point on each marked line. Return a list of BODY's results.
443 If no marked file could be found, execute BODY on the current line.
444 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
445 files instead of the marked files.
446 In that case point is dragged along. This is so that commands on
447 the next ARG (instead of the marked) files can be chained easily.
448 If ARG is otherwise non-nil, use current file instead.
449 If optional third arg SHOW-PROGRESS evaluates to non-nil,
450 redisplay the dired buffer after each file is processed.
451 No guarantee is made about the position on the marked line.
452 BODY must ensure this itself if it depends on this.
453 Search starts at the beginning of the buffer, thus the car of the list
454 corresponds to the line nearest to the buffer's bottom. This
455 is also true for (positive and negative) integer values of ARG.
456 BODY should not be too long as it is expanded four times."
457 ;;
458 ;;Warning: BODY must not add new lines before point - this may cause an
459 ;;endless loop.
460 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
467 ,arg
473 results))
474 ;; non-nil, non-integer ARG means use current file:
479 ;; remember position of next marked file before BODY
480 ;; can insert lines before the just found file,
481 ;; confusing us by finding the same marked file again
482 ;; and again and...
490 ;; move after last match
497 results
499 ;; save-excursion loses, again
503 "Return the marked files' names as list of strings.
504 The list is in the same order as the buffer, that is, the car is the
505 first marked file.
506 Values returned are normally absolute file names.
507 Optional arg LOCALP as in `dired-get-filename'.
508 Optional second argument ARG specifies files near point
509 instead of marked files. If ARG is an integer, use the next ARG files.
510 If ARG is otherwise non-nil, use file. Usually ARG comes from
511 the command's prefix arg.
512 Optional third argument FILTER, if non-nil, is a function to select
513 some of the files--those for which (funcall FILTER FILENAME) is non-nil."
517 result)
523 result)))
524 \f
525 ;; The dired command
528 ;; For use in interactive.
532 dired-listing-switches))
533 ;; If a dialog is about to be used, call read-directory-name so
534 ;; the dialog code knows we want directories. Some dialogs can
535 ;; only select directories or files when popped up, not both.
538 nil default-directory nil)
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.
617 "Return non-nil if current dired buffer needs updating.
618 If NOCONFIRM is non-nil, then this function always returns nil
619 for a remote directory. This feature is used by Auto Revert Mode."
627 ;; Separate function from dired-noselect for the sake of dired-vms.el.
629 ;; If there is an existing dired buffer for DIRNAME, just leave
630 ;; buffer as it is (don't even call dired-revert).
631 ;; This saves time especially for deep trees or with ange-ftp.
632 ;; The user can type `g' easily, and it is more consistent with find-file.
633 ;; But if SWITCHES are given they are probably different from the
634 ;; buffer's old value, so call dired-sort-other, which does
635 ;; revert the buffer.
636 ;; A pity we can't possibly do "Directory has changed - refresh? "
637 ;; like find-file does.
638 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
639 ;; see there.
641 buffer
642 ;; note that buffer already is in dired-mode, if found
643 new-buffer-p
648 ;; Look for an existing buffer.
653 ;; We don't want default-major-mode to run hooks and set auto-fill
654 ;; or whatever, now that dired-mode does not
655 ;; kill-all-local-variables any longer.
660 ;; file list may have changed
662 ;; this calls dired-revert
664 ;; If directory has changed on disk, offer to revert.
669 ;; Else a new buffer
671 ;; We can do this unconditionally
672 ;; because dired-noselect ensures that the name
673 ;; is passed in directory name syntax
674 ;; if it was the name of a directory at all.
679 ;; default-directory and dired-actual-switches are set now
680 ;; (buffer-local), so we can call dired-readin:
685 ;; dired-readin can fail if parent directories are inaccessible.
686 ;; Don't leave an empty buffer around in that case.
691 buffer))
694 ;; Enlarged by dired-advertise
695 ;; Queried by function dired-buffers-for-dir. When this detects a
696 ;; killed buffer, it is removed from this list.
700 ;; This differs from dired-buffers-for-dir in that it does not consider
701 ;; subdirs of default-directory and searches for the first match only.
702 ;; Also, the major mode must be MODE.
712 dired-directory ;; nil during find-alternate-file
717 dired-directory))))
719 blist nil)
721 found))
723 \f
724 ;; Read in a new dired buffer
727 "Read in a new dired buffer.
728 Differs from `dired-insert-subdir' in that it accepts
729 wildcards, erases the buffer, and builds the subdir-alist anew
730 \(including making it buffer-local and clearing it first)."
732 ;; default-directory and dired-actual-switches must be buffer-local
733 ;; and initialized by now.
740 ;; This hook which may want to modify dired-actual-switches
741 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
742 ;; where ls won't understand -Al switches.
747 ;; Don't make undo entries for readin.
753 ;; Must first make alist buffer local and set it to nil because
754 ;; dired-build-subdir-alist will call dired-clear-alist first
761 ;; No need to narrow since the whole buffer contains just
762 ;; dired-readin's output, nothing else. The hook can
763 ;; successfully use dired functions (e.g. dired-get-filename)
764 ;; as the subdir-alist has been built in dired-readin.
767 ;; Subroutines of dired-readin
770 ;; Insert listing for the specified dir (and maybe file list)
771 ;; already in dired-directory, assuming a clean buffer.
777 file-list nil))
781 ;; If we are reading a whole single directory...
786 ;; Else treat it as a wildcard spec
787 ;; unless we have an explicit list of files.
792 "Align the fields of a file to the ones of surrounding lines.
793 BEG..END is the line where the file info is located."
794 ;; Some versions of ls try to adjust the size of each field so as to just
795 ;; hold the largest element ("largest" in the current invocation, of
796 ;; course). So when a single line is output, the size of each field is
797 ;; just big enough for that one output. Thus when dired refreshes one
798 ;; line, the alignment if this line w.r.t the rest is messed up because
799 ;; the fields of that one line will generally be smaller.
800 ;;
801 ;; To work around this problem, we here add spaces to try and re-align the
802 ;; fields as needed. Since this is purely aesthetic, it is of utmost
803 ;; importance that it doesn't mess up anything like
804 ;; `dired-move-to-filename'. To this end, we limit ourselves to adding
805 ;; spaces only, and to only add them at places where there was already at
806 ;; least one space. This way, as long as `dired-move-to-filename-regexp'
807 ;; always matches spaces with "*" or "+", we know we haven't made anything
808 ;; worse. There is one spot where the exact number of spaces is
809 ;; important, which is just before the actual filename, so we refrain from
810 ;; adding spaces there (and within the filename as well, of course).
813 ;; Check the there is indeed a file, and that there is anoter adjacent
814 ;; file with which to align, and that additional spaces are needed to
815 ;; align the filenames.
828 ;; Make sure there is some work left to do.
830 ;; If we've only looked at the line above, check to see if the line
831 ;; below exists as well and if so, align with the shorter one.
840 ;; Keep positions uptodate when we insert stuff.
843 ;; Main loop.
847 ;; Don't touch anything just before (and after) the
848 ;; beginning of the filename.
850 ;; We're now just in front of a field, with a space behind us.
852 ;; Nums are right-aligned.
854 ;; Let's look at the other line, in the same column: we
855 ;; should be either near the end of the previous field, or
856 ;; in the space between that field and the next.
857 ;; [ Of course, it's also possible that we're already within
858 ;; the next field or even past it, but that's unlikely since
859 ;; other-col > file-col. ]
860 ;; Let's find the distance to the alignment-point (either
861 ;; the beginning or the end of the next field, depending on
862 ;; whether this field is left or right aligned).
872 ;; Now, the number of spaces to insert is align-pt-offset
873 ;; minus the distance to the equivalent point on the
874 ;; current line.
877 align-pt-offset
887 ;; Let's just make really sure we did not mess up.
890 ;; Damn! We messed up: let's revert the change.
892 ;; Now skip to next field.
898 "Insert a directory listing of DIR, Dired style.
899 Use SWITCHES to make the listings.
900 If FILE-LIST is non-nil, list only those files.
901 Otherwise, if WILDCARD is non-nil, expand wildcards;
902 in that case, DIR should be a file name that uses wildcards.
903 In other cases, DIR should be a directory name or a directory filename.
904 If HDR is non-nil, insert a header line with the directory name."
907 end)
910 ;; We used to specify the C locale here, to force English month names;
911 ;; but this should not be necessary any more,
912 ;; with the new value of dired-move-to-filename-regexp.
917 ;; Re-align fields, if necessary.
920 ;; Quote certain characters, unless ls quoted them for us.
929 nil t))
935 nil t))
938 ;; If we used --dired and it worked, the lines are already indented.
939 ;; Otherwise, indent them.
945 ;; Insert text at the beginning to standardize things.
949 ;; Note that dired-build-subdir-alist will replace the name
950 ;; by its expansion, so it does not matter whether what we insert
951 ;; here is fully expanded, but it should be absolute.
954 ;; Insert "wildcard" line where "total" line would be for a full dir.
958 "Make the file names highlight when the mouse is on them."
973 \f
974 ;; Reverting a dired buffer
977 "Reread the dired buffer.
978 Must also be called after dired-actual-switches have changed.
979 Should not fail even on completely garbaged buffers.
980 Preserves old cursor, marks/flags, hidden-p."
989 buffer-read-only)
993 ;; treat top level dir extra (it may contain wildcards)
998 ;; don't run that hook for each subdir...
1001 ;; ... run the hook for the whole buffer, and only after markers
1002 ;; have been reinserted (else omitting in dired-x would omit marked files)
1012 ;; outside of the let scope
1013 ;;; Might as well not override the user if the user changed this.
1014 ;;; (setq buffer-read-only t)
1015 )
1017 ;; Subroutines of dired-revert
1018 ;; Some of these are also used when inserting subdirs.
1021 "Return alist of files and their marks, from BEG to END."
1032 alist))
1035 "Mark all files remembered in ALIST.
1036 Each element of ALIST looks like (FILE . MARKERCHAR)."
1050 "Return a list of names of subdirs currently hidden."
1060 result))
1063 "Try to insert all subdirs that were displayed before.
1064 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1078 "Remove directory DIR from any directory cache."
1082 \f
1083 ;; dired mode key bindings and initialization
1086 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1087 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1092 ;; Commands to mark or flag certain categories of files
1097 ;; Upper case keys (except !) for operating on the marked files
1115 ;; Comparison commands
1118 ;; Tree Dired commands
1124 ;; move to marked files
1127 ;; Make all regexp commands share a `%' prefix:
1128 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1129 ;; but that seems to serve little purpose, and copy-keymap
1130 ;; does a better job without it.
1142 ;; Commands for marking and unmarking.
1159 ;; Lower keys for commands not operating on all the marked files
1185 ;; moving
1193 (define-key map [up] 'dired-previous-line)
1194 ;; hiding
1195 (define-key map "$" 'dired-hide-subdir)
1196 (define-key map "\M-$" 'dired-hide-all)
1197 ;; misc
1198 (define-key map "?" 'dired-summary)
1200 (define-key map "\C-_" 'dired-undo)
1201 (define-key map "\C-xu" 'dired-undo)
1203 ;; Make menu bar items.
1205 ;; No need to fo this, now that top-level items are fewer.
1206 ;;;;
1207 ;; Get rid of the Edit menu bar item to save space.
1208 ;(define-key map [menu-bar edit] 'undefined)
1210 (define-key map [menu-bar subdir]
1211 (cons "Subdir" (make-sparse-keymap "Subdir")))
1213 (define-key map [menu-bar subdir hide-all]
1214 '(menu-item "Hide All" dired-hide-all
1215 :help "Hide all subdirectories, leave only header lines"))
1216 (define-key map [menu-bar subdir hide-subdir]
1217 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1218 :help "Hide or unhide current directory listing"))
1219 (define-key map [menu-bar subdir tree-down]
1220 '(menu-item "Tree Down" dired-tree-down
1221 :help "Go to first subdirectory header down the tree"))
1222 (define-key map [menu-bar subdir tree-up]
1223 '(menu-item "Tree Up" dired-tree-up
1224 :help "Go to first subdirectory header up the tree"))
1225 (define-key map [menu-bar subdir up]
1226 '(menu-item "Up Directory" dired-up-directory
1227 :help "Edit the parent directory"))
1228 (define-key map [menu-bar subdir prev-subdir]
1229 '(menu-item "Prev Subdir" dired-prev-subdir
1230 :help "Go to previous subdirectory header line"))
1231 (define-key map [menu-bar subdir next-subdir]
1232 '(menu-item "Next Subdir" dired-next-subdir
1233 :help "Go to next subdirectory header line"))
1234 (define-key map [menu-bar subdir prev-dirline]
1235 '(menu-item "Prev Dirline" dired-prev-dirline
1236 :help "Move to next directory-file line"))
1237 (define-key map [menu-bar subdir next-dirline]
1238 '(menu-item "Next Dirline" dired-next-dirline
1239 :help "Move to previous directory-file line"))
1240 (define-key map [menu-bar subdir insert]
1241 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1242 :help "Insert contents of subdirectory"))
1244 (define-key map [menu-bar immediate]
1245 (cons "Immediate" (make-sparse-keymap "Immediate")))
1247 (define-key map [menu-bar immediate revert-buffer]
1248 '(menu-item "Refresh" revert-buffer
1249 :help "Update contents of shown directories"))
1251 (define-key map [menu-bar immediate dashes]
1252 '("--"))
1254 (define-key map [menu-bar immediate backup-diff]
1255 '(menu-item "Compare with Backup" dired-backup-diff
1256 :help "Diff file at cursor with its latest backup"))
1257 (define-key map [menu-bar immediate diff]
1258 '(menu-item "Diff..." dired-diff
1259 :help "Compare file at cursor with another file"))
1260 (define-key map [menu-bar immediate view]
1261 '(menu-item "View This File" dired-view-file
1262 :help "Examine file at cursor in read-only mode"))
1263 (define-key map [menu-bar immediate display]
1264 '(menu-item "Display in Other Window" dired-display-file
1265 :help "Display file at cursor in other window"))
1266 (define-key map [menu-bar immediate find-file-other-window]
1267 '(menu-item "Find in Other Window" dired-find-file-other-window
1268 :help "Edit file at cursor in other window"))
1269 (define-key map [menu-bar immediate find-file]
1270 '(menu-item "Find This File" dired-find-file
1271 :help "Edit file at cursor"))
1272 (define-key map [menu-bar immediate create-directory]
1273 '(menu-item "Create Directory..." dired-create-directory))
1274 (define-key map [menu-bar immediate wdired-mode]
1275 '(menu-item "Edit File Names" wdired-change-to-wdired-mode))
1277 (define-key map [menu-bar regexp]
1278 (cons "Regexp" (make-sparse-keymap "Regexp")))
1280 (define-key map [menu-bar regexp downcase]
1281 '(menu-item "Downcase" dired-downcase
1282 ;; When running on plain MS-DOS, there's only one
1283 ;; letter-case for file names.
1284 :enable (or (not (fboundp 'msdos-long-file-names))
1285 (msdos-long-file-names))
1286 :help "Rename marked files to lower-case name"))
1287 (define-key map [menu-bar regexp upcase]
1288 '(menu-item "Upcase" dired-upcase
1289 :enable (or (not (fboundp 'msdos-long-file-names))
1290 (msdos-long-file-names))
1291 :help "Rename marked files to upper-case name"))
1292 (define-key map [menu-bar regexp hardlink]
1293 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1294 :help "Make hard links for files matching regexp"))
1295 (define-key map [menu-bar regexp symlink]
1296 '(menu-item "Symlink..." dired-do-symlink-regexp
1297 :visible (fboundp 'make-symbolic-link)
1298 :help "Make symbolic links for files matching regexp"))
1299 (define-key map [menu-bar regexp rename]
1300 '(menu-item "Rename..." dired-do-rename-regexp
1301 :help "Rename marked files matching regexp"))
1302 (define-key map [menu-bar regexp copy]
1303 '(menu-item "Copy..." dired-do-copy-regexp
1304 :help "Copy marked files matching regexp"))
1305 (define-key map [menu-bar regexp flag]
1306 '(menu-item "Flag..." dired-flag-files-regexp
1307 :help "Flag files matching regexp for deletion"))
1308 (define-key map [menu-bar regexp mark]
1309 '(menu-item "Mark..." dired-mark-files-regexp
1310 :help "Mark files matching regexp for future operations"))
1311 (define-key map [menu-bar regexp mark-cont]
1312 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1313 :help "Mark files whose contents matches regexp"))
1315 (define-key map [menu-bar mark]
1316 (cons "Mark" (make-sparse-keymap "Mark")))
1318 (define-key map [menu-bar mark prev]
1319 '(menu-item "Previous Marked" dired-prev-marked-file
1320 :help "Move to previous marked file"))
1321 (define-key map [menu-bar mark next]
1322 '(menu-item "Next Marked" dired-next-marked-file
1323 :help "Move to next marked file"))
1324 (define-key map [menu-bar mark marks]
1325 '(menu-item "Change Marks..." dired-change-marks
1326 :help "Replace marker with another character"))
1327 (define-key map [menu-bar mark unmark-all]
1328 '(menu-item "Unmark All" dired-unmark-all-marks))
1329 (define-key map [menu-bar mark symlinks]
1330 '(menu-item "Mark Symlinks" dired-mark-symlinks
1331 :visible (fboundp 'make-symbolic-link)
1332 :help "Mark all symbolic links"))
1333 (define-key map [menu-bar mark directories]
1334 '(menu-item "Mark Directories" dired-mark-directories
1335 :help "Mark all directories except `.' and `..'"))
1336 (define-key map [menu-bar mark directory]
1337 '(menu-item "Mark Old Backups" dired-clean-directory
1338 :help "Flag old numbered backups for deletion"))
1339 (define-key map [menu-bar mark executables]
1340 '(menu-item "Mark Executables" dired-mark-executables
1341 :help "Mark all executable files"))
1342 (define-key map [menu-bar mark garbage-files]
1343 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1344 :help "Flag unneeded files for deletion"))
1345 (define-key map [menu-bar mark backup-files]
1346 '(menu-item "Flag Backup Files" dired-flag-backup-files
1347 :help "Flag all backup files for deletion"))
1348 (define-key map [menu-bar mark auto-save-files]
1349 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1350 :help "Flag auto-save files for deletion"))
1351 (define-key map [menu-bar mark deletion]
1352 '(menu-item "Flag" dired-flag-file-deletion
1353 :help "Flag current line's file for deletion"))
1354 (define-key map [menu-bar mark unmark]
1355 '(menu-item "Unmark" dired-unmark
1356 :help "Unmark or unflag current line's file"))
1357 (define-key map [menu-bar mark mark]
1358 '(menu-item "Mark" dired-mark
1359 :help "Mark current line's file for future operations"))
1360 (define-key map [menu-bar mark toggle-marks]
1361 '(menu-item "Toggle Marks" dired-toggle-marks
1362 :help "Mark unmarked files, unmark marked ones"))
1364 (define-key map [menu-bar operate]
1365 (cons "Operate" (make-sparse-keymap "Operate")))
1367 (define-key map [menu-bar operate query-replace]
1368 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1369 :help "Replace regexp in marked files"))
1370 (define-key map [menu-bar operate search]
1371 '(menu-item "Search Files..." dired-do-search
1372 :help "Search marked files for regexp"))
1373 (define-key map [menu-bar operate chown]
1374 '(menu-item "Change Owner..." dired-do-chown
1375 :visible (not (memq system-type '(ms-dos windows-nt)))
1376 :help "Change the owner of marked files"))
1377 (define-key map [menu-bar operate chgrp]
1378 '(menu-item "Change Group..." dired-do-chgrp
1379 :visible (not (memq system-type '(ms-dos windows-nt)))
1380 :help "Change the group of marked files"))
1381 (define-key map [menu-bar operate chmod]
1382 '(menu-item "Change Mode..." dired-do-chmod
1383 :help "Change mode (attributes) of marked files"))
1384 (define-key map [menu-bar operate touch]
1385 '(menu-item "Change Timestamp..." dired-do-touch
1386 :help "Change timestamp of marked files"))
1387 (define-key map [menu-bar operate load]
1388 '(menu-item "Load" dired-do-load
1389 :help "Load marked Emacs Lisp files"))
1390 (define-key map [menu-bar operate compile]
1391 '(menu-item "Byte-compile" dired-do-byte-compile
1392 :help "Byte-compile marked Emacs Lisp files"))
1393 (define-key map [menu-bar operate compress]
1394 '(menu-item "Compress" dired-do-compress
1395 :help "Compress/uncompress marked files"))
1396 (define-key map [menu-bar operate print]
1397 '(menu-item "Print..." dired-do-print
1398 :help "Ask for print command and print marked files"))
1399 (define-key map [menu-bar operate hardlink]
1400 '(menu-item "Hardlink to..." dired-do-hardlink
1401 :help "Make hard links for current or marked files"))
1402 (define-key map [menu-bar operate symlink]
1403 '(menu-item "Symlink to..." dired-do-symlink
1404 :visible (fboundp 'make-symbolic-link)
1405 :help "Make symbolic links for current or marked files"))
1406 (define-key map [menu-bar operate command]
1407 '(menu-item "Shell Command..." dired-do-shell-command
1408 :help "Run a shell command on each of marked files"))
1409 (define-key map [menu-bar operate delete]
1410 '(menu-item "Delete" dired-do-delete
1411 :help "Delete current file or all marked files"))
1412 (define-key map [menu-bar operate rename]
1413 '(menu-item "Rename to..." dired-do-rename
1414 :help "Rename current file or move marked files"))
1415 (define-key map [menu-bar operate copy]
1416 '(menu-item "Copy to..." dired-do-copy
1417 :help "Copy current file or all marked files"))
1419 map)
1420 "Local keymap for `dired-mode' buffers.")
1421 \f
1422 ;; Dired mode is suitable only for specially formatted data.
1423 (put 'dired-mode 'mode-class 'special)
1425 (defun dired-mode (&optional dirname switches)
1426 "\
1429 \(optionally) its subdirectories, in the format of `ls -lR'.
1432 compress, load or byte-compile them, change their file attributes
1435 by file or all files matching certain criteria.
1437 Letters no longer insert themselves. Digits are prefix arguments.
1440 Most commands operate on the marked files and use the current file
1441 if no files are marked. Use a numeric prefix argument to operate on
1442 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1443 to operate on the current file only. Prefix arguments override marks.
1445 to see why something went wrong.
1450 (or dired it in another buffer, if it is a directory).
1457 This retains all marks and hides subdirs again that were hidden before.
1458 SPC and DEL can be used to move down and up by lines.
1461 to read the
1463 to relist a single or the marked files or a
1465 again for the directory tree.
1468 for more info):
1470 `dired-listing-switches'
1471 `dired-trivial-filenames'
1472 `dired-shrink-to-fit'
1473 `dired-marker-char'
1474 `dired-del-marker'
1475 `dired-keep-marker-rename'
1476 `dired-keep-marker-copy'
1477 `dired-keep-marker-hardlink'
1478 `dired-keep-marker-symlink'
1482 `dired-before-readin-hook'
1483 `dired-after-readin-hook'
1484 `dired-mode-hook'
1485 `dired-load-hook'
1487 Keybindings:
1489 ;; Not to be called interactively (e.g. dired-directory will be set
1490 ;; to default-directory, which is wrong with wildcards).
1491 (kill-all-local-variables)
1492 (use-local-map dired-mode-map)
1493 (dired-advertise) ; default-directory is already set
1494 (setq major-mode 'dired-mode
1495 mode-name "Dired"
1496 ;; case-fold-search nil
1497 buffer-read-only t
1498 selective-display t ; for subdirectory hiding
1499 mode-line-buffer-identification
1500 (propertized-buffer-identification "%17b"))
1501 (set (make-local-variable 'revert-buffer-function)
1502 (function dired-revert))
1503 (set (make-local-variable 'buffer-stale-function)
1504 (function dired-buffer-stale-p))
1505 (set (make-local-variable 'page-delimiter)
1507 (set (make-local-variable 'dired-directory)
1508 (or dirname default-directory))
1509 ;; list-buffers uses this to display the dir being edited in this buffer.
1510 (set (make-local-variable 'list-buffers-directory)
1511 (expand-file-name (if (listp dired-directory)
1512 (car dired-directory)
1513 dired-directory)))
1514 (set (make-local-variable 'dired-actual-switches)
1515 (or switches dired-listing-switches))
1516 (set (make-local-variable 'font-lock-defaults)
1517 '(dired-font-lock-keywords t nil nil beginning-of-line))
1518 (set (make-local-variable 'desktop-save-buffer)
1519 'dired-desktop-buffer-misc-data)
1520 (setq dired-switches-alist nil)
1521 (dired-sort-other dired-actual-switches t)
1522 (run-mode-hooks 'dired-mode-hook)
1523 (when (featurep 'x-dnd)
1524 (make-variable-buffer-local 'x-dnd-test-function)
1525 (make-variable-buffer-local 'x-dnd-protocol-alist)
1526 (setq x-dnd-test-function 'dired-dnd-test-function)
1527 (setq x-dnd-protocol-alist
1528 (append '(("^file:///" . dired-dnd-handle-local-file)
1529 ("^file://" . dired-dnd-handle-file)
1530 ("^file:" . dired-dnd-handle-local-file))
1531 x-dnd-protocol-alist))))
1532 \f
1533 ;; Idiosyncratic dired commands that don't deal with marks.
1535 (defun dired-summary ()
1536 "Summarize basic Dired commands and show recent Dired errors."
1537 (interactive)
1538 (dired-why)
1539 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1540 (message
1541 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1543 (defun dired-undo ()
1544 "Undo in a dired buffer.
1545 This doesn't recover lost files, it just undoes changes in the buffer itself.
1546 You can use it to recover marks, killed lines or subdirs."
1547 (interactive)
1548 (let (buffer-read-only)
1549 (undo))
1550 (dired-build-subdir-alist)
1551 (message "Change in Dired buffer undone.
1552 Actual changes in files cannot be undone by Emacs."))
1554 (defun dired-next-line (arg)
1555 "Move down lines then position at filename.
1556 Optional prefix ARG says how many lines to move; default is one line."
1557 (interactive "p")
1558 (next-line arg)
1559 (dired-move-to-filename))
1561 (defun dired-previous-line (arg)
1562 "Move up lines then position at filename.
1563 Optional prefix ARG says how many lines to move; default is one line."
1564 (interactive "p")
1565 (previous-line arg)
1566 (dired-move-to-filename))
1568 (defun dired-next-dirline (arg &optional opoint)
1569 "Goto ARG'th next directory file line."
1570 (interactive "p")
1571 (or opoint (setq opoint (point)))
1572 (if (if (> arg 0)
1573 (re-search-forward dired-re-dir nil t arg)
1574 (beginning-of-line)
1575 (re-search-backward dired-re-dir nil t (- arg)))
1576 (dired-move-to-filename) ; user may type `i' or `f'
1577 (goto-char opoint)
1578 (error "No more subdirectories")))
1580 (defun dired-prev-dirline (arg)
1581 "Goto ARG'th previous directory file line."
1582 (interactive "p")
1583 (dired-next-dirline (- arg)))
1585 (defun dired-up-directory (&optional other-window)
1586 "Run Dired on parent directory of current directory.
1587 Find the parent directory either in this buffer or another buffer.
1588 Creates a buffer if necessary."
1589 (interactive "P")
1590 (let* ((dir (dired-current-directory))
1591 (up (file-name-directory (directory-file-name dir))))
1592 (or (dired-goto-file (directory-file-name dir))
1593 ;; Only try dired-goto-subdir if buffer has more than one dir.
1594 (and (cdr dired-subdir-alist)
1595 (dired-goto-subdir up))
1596 (progn
1597 (if other-window
1598 (dired-other-window up)
1599 (dired up))
1600 (dired-goto-file dir)))))
1602 (defun dired-get-file-for-visit ()
1603 "Get the current line's file name, with an error if file does not exist."
1604 (interactive)
1605 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1606 (let ((raw (dired-get-filename nil t))
1607 file-name)
1608 (if (null raw)
1609 (error "No file on this line"))
1610 (setq file-name (file-name-sans-versions raw t))
1611 (if (file-exists-p file-name)
1612 file-name
1613 (if (file-symlink-p file-name)
1614 (error "File is a symlink to a nonexistent target")
1615 (error "File no longer exists; type `g' to update Dired buffer")))))
1617 ;; Force `f' rather than `e' in the mode doc:
1618 (defalias 'dired-advertised-find-file 'dired-find-file)
1619 (defun dired-find-file ()
1620 "In Dired, visit the file or directory named on this line."
1621 (interactive)
1622 ;; Bind `find-file-run-dired' so that the command works on directories
1623 ;; too, independent of the user's setting.
1624 (let ((find-file-run-dired t))
1625 (find-file (dired-get-file-for-visit))))
1627 (defun dired-find-alternate-file ()
1628 "In Dired, visit this file or directory instead of the dired buffer."
1629 (interactive)
1630 (set-buffer-modified-p nil)
1631 (find-alternate-file (dired-get-file-for-visit)))
1632 ;; Don't override the setting from .emacs.
1633 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1635 (defun dired-mouse-find-file-other-window (event)
1636 "In Dired, visit the file or directory name you click on."
1637 (interactive "e")
1638 (let (window pos file)
1639 (save-excursion
1640 (setq window (posn-window (event-end event))
1641 pos (posn-point (event-end event)))
1642 (if (not (windowp window))
1643 (error "No file chosen"))
1644 (set-buffer (window-buffer window))
1645 (goto-char pos)
1646 (setq file (dired-get-file-for-visit)))
1647 (if (file-directory-p file)
1648 (or (and (cdr dired-subdir-alist)
1649 (dired-goto-subdir file))
1650 (progn
1651 (select-window window)
1652 (dired-other-window file)))
1653 (select-window window)
1654 (find-file-other-window (file-name-sans-versions file t)))))
1656 (defun dired-view-file ()
1657 "In Dired, examine a file in view mode, returning to dired when done.
1658 When file is a directory, show it in this buffer if it is inserted.
1659 Otherwise, display it in another buffer."
1660 (interactive)
1661 (let ((file (dired-get-file-for-visit)))
1662 (if (file-directory-p file)
1663 (or (and (cdr dired-subdir-alist)
1664 (dired-goto-subdir file))
1665 (dired file))
1666 (view-file file))))
1668 (defun dired-find-file-other-window ()
1669 "In Dired, visit this file or directory in another window."
1670 (interactive)
1671 (find-file-other-window (dired-get-file-for-visit)))
1673 (defun dired-display-file ()
1674 "In Dired, display this file or directory in another window."
1675 (interactive)
1676 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1677 \f
1678 ;;; Functions for extracting and manipulating file names in Dired buffers.
1680 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1681 "In Dired, return name of file mentioned on this line.
1682 Value returned normally includes the directory name.
1683 Optional arg LOCALP with value `no-dir' means don't include directory
1684 name in result. A value of `verbatim' means to return the name exactly as
1685 it occurs in the buffer, and a value of t means construct name relative to
1686 `default-directory', which still may contain slashes if in a subdirectory.
1687 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1688 regular filenames and return nil if no filename on this line.
1689 Otherwise, an error occurs in these cases."
1690 (let (case-fold-search file p1 p2 already-absolute)
1691 (save-excursion
1692 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1693 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1694 ;; nil if no file on this line, but no-error-if-not-filep is t:
1695 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1696 (progn
1697 ;; Get rid of the mouse-face property that file names have.
1698 (set-text-properties 0 (length file) nil file)
1699 ;; Unquote names quoted by ls or by dired-insert-directory.
1700 ;; Using read to unquote is much faster than substituting
1702 (setq file
1703 (read
1705 ;; Some ls -b don't escape quotes, argh!
1706 ;; This is not needed for GNU ls, though.
1707 (or (dired-string-replace-match
1709 file)
1711 ;; The above `read' will return a unibyte string if FILE
1712 ;; contains eight-bit-control/graphic characters.
1713 (if (and enable-multibyte-characters
1714 (not (multibyte-string-p file)))
1715 (setq file (string-to-multibyte file)))))
1716 (and file (file-name-absolute-p file)
1717 ;; A relative file name can start with ~.
1718 ;; Don't treat it as absolute in this context.
1719 (not (eq (aref file 0) ?~))
1720 (setq already-absolute t))
1721 (cond
1722 ((null file)
1723 nil)
1724 ((eq localp 'verbatim)
1725 file)
1726 ((and (not no-error-if-not-filep)
1727 (member file '("." "..")))
1728 (error "Cannot operate on `.' or `..'"))
1729 ((and (eq localp 'no-dir) already-absolute)
1730 (file-name-nondirectory file))
1731 (already-absolute
1732 (let ((handler (find-file-name-handler file nil)))
1733 ;; check for safe-magic property so that we won't
1734 ;; put /: for names that don't really need them.
1735 ;; For instance, .gz files when auto-compression-mode is on.
1736 (if (and handler (not (get handler 'safe-magic)))
1737 (concat "/:" file)
1738 file)))
1739 ((eq localp 'no-dir)
1740 file)
1741 ((equal (dired-current-directory) "/")
1742 (setq file (concat (dired-current-directory localp) file))
1743 (let ((handler (find-file-name-handler file nil)))
1744 ;; check for safe-magic property so that we won't
1745 ;; put /: for names that don't really need them.
1746 ;; For instance, .gz files when auto-compression-mode is on.
1747 (if (and handler (not (get handler 'safe-magic)))
1748 (concat "/:" file)
1749 file)))
1750 (t
1751 (concat (dired-current-directory localp) file)))))
1753 (defun dired-string-replace-match (regexp string newtext
1754 &optional literal global)
1755 "Replace first match of REGEXP in STRING with NEWTEXT.
1756 If it does not match, nil is returned instead of the new string.
1757 Optional arg LITERAL means to take NEWTEXT literally.
1758 Optional arg GLOBAL means to replace all matches."
1759 (if global
1760 (let ((start 0) ret)
1761 (while (string-match regexp string start)
1762 (let ((from-end (- (length string) (match-end 0))))
1763 (setq ret (setq string (replace-match newtext t literal string)))
1764 (setq start (- (length string) from-end))))
1765 ret)
1766 (if (not (string-match regexp string 0))
1767 nil
1768 (replace-match newtext t literal string))))
1770 (defun dired-make-absolute (file &optional dir)
1771 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1772 ;; We can't always use expand-file-name as this would get rid of `.'
1773 ;; or expand in / instead default-directory if DIR=="".
1774 ;; This should be good enough for ange-ftp, but might easily be
1775 ;; redefined (for VMS?).
1776 ;; It should be reasonably fast, though, as it is called in
1777 ;; dired-get-filename.
1778 (concat (or dir default-directory) file))
1780 (defun dired-make-relative (file &optional dir ignore)
1781 "Convert FILE (an absolute file name) to a name relative to DIR.
1782 If this is impossible, return FILE unchanged.
1783 DIR must be a directory name, not a file name."
1784 (or dir (setq dir default-directory))
1785 ;; This case comes into play if default-directory is set to
1786 ;; use ~.
1787 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1788 (setq dir (expand-file-name dir)))
1789 (if (string-match (concat "^" (regexp-quote dir)) file)
1790 (substring file (match-end 0))
1791 ;;; (or no-error
1792 ;;; (error "%s: not in directory tree growing at %s" file dir))
1793 file))
1794 \f
1795 ;;; Functions for finding the file name in a dired buffer line.
1797 (defvar dired-move-to-filename-regexp
1800 ;; In some locales, month abbreviations are as short as 2 letters,
1801 ;; and they can be followed by ".".
1802 ;; In Breton, a month name can include a quote character.
1804 (s " ")
1805 (yyyy "[0-9][0-9][0-9][0-9]")
1806 (dd "[ 0-3][0-9]")
1807 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
1809 (zone "[-+][0-2][0-9][0-5][0-9]")
1810 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
1815 s "+"
1817 (western-comma (concat month s "+" dd "," s "+" yyyy))
1818 ;; Japanese MS-Windows ls-lisp has one-digit months, and
1819 ;; omits the Kanji characters after month and day-of-month.
1820 (mm "[ 0-1]?[0-9]")
1821 (japanese
1822 (concat mm l "?" s dd l "?" s "+"
1824 ;; The "[0-9]" below requires the previous column to end in a digit.
1825 ;; This avoids recognizing `1 may 1997' as a date in the line:
1826 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
1827 ;; The "[kKMGTPEZY]?" below supports "ls -alh" output.
1828 ;; The ".*" below finds the last match if there are multiple matches.
1829 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
1830 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
1831 (concat ".*[0-9][kKMGTPEZY]?" s
1833 s "+"))
1834 "Regular expression to match up to the file name in a directory listing.
1835 The default value is designed to recognize dates and times
1836 regardless of the language.")
1838 (defvar dired-permission-flags-regexp
1840 "Regular expression to match the permission flags in `ls -l'.")
1842 ;; Move to first char of filename on this line.
1843 ;; Returns position (point) or nil if no filename on this line."
1844 (defun dired-move-to-filename (&optional raise-error eol)
1845 "Move to the beginning of the filename on the current line.
1846 Return the position of the beginning of the filename, or nil if none found."
1847 ;; This is the UNIX version.
1848 (or eol (setq eol (line-end-position)))
1849 (beginning-of-line)
1850 ;; First try assuming `ls --dired' was used.
1851 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1852 (cond
1853 ((and change (< change eol))
1854 (goto-char change))
1855 ((re-search-forward dired-move-to-filename-regexp eol t)
1856 (goto-char (match-end 0)))
1857 ((re-search-forward dired-permission-flags-regexp eol t)
1858 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1859 (if raise-error
1860 (error "Unrecognized line! Check dired-move-to-filename-regexp"))
1861 (beginning-of-line)
1862 nil)
1863 (raise-error
1864 (error "No file on this line")))))
1866 (defun dired-move-to-end-of-filename (&optional no-error)
1867 ;; Assumes point is at beginning of filename,
1868 ;; thus the rwx bit re-search-backward below will succeed in *this*
1869 ;; line if at all. So, it should be called only after
1870 ;; (dired-move-to-filename t).
1871 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1872 ;; This is the UNIX version.
1873 (if (get-text-property (point) 'dired-filename)
1874 (goto-char (next-single-property-change (point) 'dired-filename))
1875 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1876 ;; case-fold-search is nil now, so we can test for capital F:
1877 (setq used-F (string-match "F" dired-actual-switches)
1878 opoint (point)
1879 eol (save-excursion (end-of-line) (point))
1880 hidden (and selective-display
1882 (if hidden
1883 nil
1884 (save-excursion ;; Find out what kind of file this is:
1885 ;; Restrict perm bits to be non-blank,
1886 ;; otherwise this matches one char to early (looking backward):
1887 ;; "l---------" (some systems make symlinks that way)
1888 ;; "----------" (plain file with zero perms)
1889 (if (re-search-backward
1890 dired-permission-flags-regexp nil t)
1891 (setq file-type (char-after (match-beginning 1))
1892 symlink (eq file-type ?l)
1893 ;; Only with -F we need to know whether it's an executable
1894 executable (and
1895 used-F
1896 (string-match
1897 "[xst]" ;; execute bit set anywhere?
1898 (concat
1899 (match-string 2)
1900 (match-string 3)
1901 (match-string 4)))))
1902 (or no-error (error "No file on this line"))))
1903 ;; Move point to end of name:
1904 (if symlink
1905 (if (search-forward " -> " eol t)
1906 (progn
1907 (forward-char -4)
1908 (and used-F
1909 dired-ls-F-marks-symlinks
1910 (eq (preceding-char) ?@) ;; did ls really mark the link?
1911 (forward-char -1))))
1912 (goto-char eol) ;; else not a symbolic link
1913 ;; ls -lF marks dirs, sockets and executables with exactly one
1914 ;; trailing character. (Executable bits on symlinks ain't mean
1915 ;; a thing, even to ls, but we know it's not a symlink.)
1916 (and used-F
1917 (or (memq file-type '(?d ?s))
1918 executable)
1919 (forward-char -1))))
1920 (or no-error
1921 (not (eq opoint (point)))
1922 (error (if hidden
1923 (substitute-command-keys
1925 "No file on this line")))
1926 (if (eq opoint (point))
1927 nil
1928 (point)))))
1930 \f
1931 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
1933 (defun dired-copy-filename-as-kill (&optional arg)
1934 "Copy names of marked (or next ARG) files into the kill ring.
1935 The names are separated by a space.
1936 With a zero prefix arg, use the absolute file name of each marked file.
1939 If on a subdir headerline, use subdirname instead; prefix arg is ignored
1940 in this case.
1943 (interactive "P")
1944 (let ((string
1945 (or (dired-get-subdir)
1946 (mapconcat (function identity)
1947 (if arg
1948 (cond ((zerop (prefix-numeric-value arg))
1949 (dired-get-marked-files))
1950 ((integerp arg)
1951 (dired-get-marked-files 'no-dir arg))
1952 (t ; else a raw arg
1953 (dired-get-marked-files t)))
1954 (dired-get-marked-files 'no-dir))
1955 " "))))
1956 (if (eq last-command 'kill-region)
1957 (kill-append string nil)
1958 (kill-new string))
1959 (message "%s" string)))
1961 \f
1962 ;; Keeping Dired buffers in sync with the filesystem and with each other
1964 (defun dired-buffers-for-dir (dir &optional file)
1965 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1966 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1967 ;; matches FILE.
1968 ;; The list is in reverse order of buffer creation, most recent last.
1969 ;; As a side effect, killed dired buffers for DIR are removed from
1970 ;; dired-buffers.
1971 (setq dir (file-name-as-directory dir))
1972 (let ((alist dired-buffers) result elt buf)
1973 (while alist
1974 (setq elt (car alist)
1975 buf (cdr elt))
1976 (if (buffer-name buf)
1977 (if (dired-in-this-tree dir (car elt))
1978 (with-current-buffer buf
1979 (and (assoc dir dired-subdir-alist)
1980 (or (null file)
1981 (let ((wildcards
1982 (file-name-nondirectory dired-directory)))
1983 (or (= 0 (length wildcards))
1984 (string-match (dired-glob-regexp wildcards)
1985 file))))
1986 (setq result (cons buf result)))))
1987 ;; else buffer is killed - clean up:
1988 (setq dired-buffers (delq elt dired-buffers)))
1989 (setq alist (cdr alist)))
1990 result))
1992 (defun dired-glob-regexp (pattern)
1993 "Convert glob-pattern PATTERN to a regular expression."
1994 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1995 regexp)
1996 (while (string-match "[[?*]" pattern matched-in-pattern)
1997 (let ((op-end (match-end 0))
1998 (next-op (aref pattern (match-beginning 0))))
1999 (setq regexp (concat regexp
2000 (regexp-quote
2001 (substring pattern matched-in-pattern
2002 (match-beginning 0)))))
2003 (cond ((= next-op ??)
2004 (setq regexp (concat regexp "."))
2005 (setq matched-in-pattern op-end))
2006 ((= next-op ?\[)
2007 ;; Fails to handle ^ yet ????
2008 (let* ((set-start (match-beginning 0))
2009 (set-cont
2010 (if (= (aref pattern (1+ set-start)) ?^)
2011 (+ 3 set-start)
2012 (+ 2 set-start)))
2013 (set-end (string-match "]" pattern set-cont))
2014 (set (substring pattern set-start (1+ set-end))))
2015 (setq regexp (concat regexp set))
2016 (setq matched-in-pattern (1+ set-end))))
2017 ((= next-op ?*)
2018 (setq regexp (concat regexp ".*"))
2019 (setq matched-in-pattern op-end)))))
2021 regexp
2022 (regexp-quote
2023 (substring pattern matched-in-pattern))
2028 (defun dired-advertise ()
2029 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2030 ;; With wildcards we actually advertise too much.
2031 (let ((expanded-default (expand-file-name default-directory)))
2032 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2033 t ; we have already advertised ourselves
2034 (setq dired-buffers
2035 (cons (cons expanded-default (current-buffer))
2036 dired-buffers)))))
2038 (defun dired-unadvertise (dir)
2039 ;; Remove DIR from the buffer alist in variable dired-buffers.
2040 ;; This has the effect of removing any buffer whose main directory is DIR.
2041 ;; It does not affect buffers in which DIR is a subdir.
2042 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2043 (setq dired-buffers
2044 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2045 \f
2046 ;; Tree Dired
2048 ;;; utility functions
2050 (defun dired-in-this-tree (file dir)
2051 ;;"Is FILE part of the directory tree starting at DIR?"
2052 (let (case-fold-search)
2053 (string-match (concat "^" (regexp-quote dir)) file)))
2055 (defun dired-normalize-subdir (dir)
2056 ;; Prepend default-directory to DIR if relative file name.
2057 ;; dired-get-filename must be able to make a valid file name from a
2058 ;; file and its directory DIR.
2059 (file-name-as-directory
2060 (if (file-name-absolute-p dir)
2061 dir
2062 (expand-file-name dir default-directory))))
2064 (defun dired-get-subdir ()
2065 ;;"Return the subdir name on this line, or nil if not on a headerline."
2066 ;; Look up in the alist whether this is a headerline.
2067 (save-excursion
2068 (let ((cur-dir (dired-current-directory)))
2069 (beginning-of-line) ; alist stores b-o-l positions
2070 (and (zerop (- (point)
2071 (dired-get-subdir-min (assoc cur-dir
2072 dired-subdir-alist))))
2073 cur-dir))))
2075 ;(defun dired-get-subdir-min (elt)
2076 ; (cdr elt))
2077 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2078 (defalias 'dired-get-subdir-min 'cdr)
2080 (defun dired-get-subdir-max (elt)
2081 (save-excursion
2082 (goto-char (dired-get-subdir-min elt))
2083 (dired-subdir-max)))
2085 (defun dired-clear-alist ()
2086 (while dired-subdir-alist
2087 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2088 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2090 (defun dired-subdir-index (dir)
2091 ;; Return an index into alist for use with nth
2092 ;; for the sake of subdir moving commands.
2093 (let (found (index 0) (alist dired-subdir-alist))
2094 (while alist
2095 (if (string= dir (car (car alist)))
2096 (setq alist nil found t)
2097 (setq alist (cdr alist) index (1+ index))))
2098 (if found index nil)))
2100 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2101 "Go to next subdirectory, regardless of level."
2102 ;; Use 0 arg to go to this directory's header line.
2103 ;; NO-SKIP prevents moving to end of header line, returning whatever
2104 ;; position was found in dired-subdir-alist.
2105 (interactive "p")
2106 (let ((this-dir (dired-current-directory))
2107 pos index)
2108 ;; nth with negative arg does not return nil but the first element
2109 (setq index (- (dired-subdir-index this-dir) arg))
2110 (setq pos (if (>= index 0)
2111 (dired-get-subdir-min (nth index dired-subdir-alist))))
2112 (if pos
2113 (progn
2114 (goto-char pos)
2116 (point))
2117 (if no-error-if-not-found
2118 nil ; return nil if not found
2119 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2121 (defun dired-build-subdir-alist (&optional switches)
2122 "Build `dired-subdir-alist' by parsing the buffer.
2123 Returns the new value of the alist.
2124 If optional arg SWITCHES is non-nil, use its value
2125 instead of `dired-actual-switches'."
2126 (interactive)
2127 (dired-clear-alist)
2128 (save-excursion
2129 (let* ((count 0)
2130 (buffer-read-only nil)
2131 (switches (or switches dired-actual-switches))
2132 new-dir-name
2133 (R-ftp-base-dir-regex
2134 ;; Used to expand subdirectory names correctly in recursive
2135 ;; ange-ftp listings.
2136 (and (string-match "R" switches)
2139 (goto-char (point-min))
2140 (setq dired-subdir-alist nil)
2141 (while (and (re-search-forward dired-subdir-regexp nil t)
2142 ;; Avoid taking a file name ending in a colon
2143 ;; as a subdir name.
2144 (not (save-excursion
2145 (goto-char (match-beginning 0))
2146 (beginning-of-line)
2147 (forward-char 2)
2148 (save-match-data (looking-at dired-re-perms)))))
2149 (save-excursion
2150 (goto-char (match-beginning 1))
2151 (setq new-dir-name
2152 (buffer-substring-no-properties (point) (match-end 1))
2153 new-dir-name
2154 (save-match-data
2155 (if (and R-ftp-base-dir-regex
2156 (not (string= new-dir-name default-directory))
2157 (string-match R-ftp-base-dir-regex new-dir-name))
2158 (concat default-directory
2159 (substring new-dir-name (match-end 0)))
2160 (expand-file-name new-dir-name))))
2161 (delete-region (point) (match-end 1))
2162 (insert new-dir-name))
2163 (setq count (1+ count))
2164 (dired-alist-add-1 new-dir-name
2165 ;; Place a sub directory boundary between lines.
2166 (save-excursion
2167 (goto-char (match-beginning 0))
2168 (beginning-of-line)
2169 (point-marker))))
2170 (if (and (> count 1) (interactive-p))
2171 (message "Buffer includes %d directories" count))
2172 ;; We don't need to sort it because it is in buffer order per
2173 ;; constructionem. Return new alist:
2174 dired-subdir-alist)))
2176 (defun dired-alist-add-1 (dir new-marker)
2177 ;; Add new DIR at NEW-MARKER. Don't sort.
2178 (setq dired-subdir-alist
2179 (cons (cons (dired-normalize-subdir dir) new-marker)
2180 dired-subdir-alist)))
2182 (defun dired-goto-next-nontrivial-file ()
2183 ;; Position point on first nontrivial file after point.
2184 (dired-goto-next-file);; so there is a file to compare with
2185 (if (stringp dired-trivial-filenames)
2186 (while (and (not (eobp))
2187 (string-match dired-trivial-filenames
2188 (file-name-nondirectory
2189 (or (dired-get-filename nil t) ""))))
2190 (forward-line 1)
2191 (dired-move-to-filename))))
2193 (defun dired-goto-next-file ()
2194 (let ((max (1- (dired-subdir-max))))
2195 (while (and (not (dired-move-to-filename)) (< (point) max))
2196 (forward-line 1))))
2198 (defun dired-goto-file (file)
2199 "Go to file line of FILE in this dired buffer."
2200 ;; Return value of point on success, else nil.
2201 ;; FILE must be an absolute file name.
2204 ;; it in the buffer.
2205 (interactive
2206 (prog1 ; let push-mark display its message
2207 (list (expand-file-name
2208 (read-file-name "Goto file: "
2209 (dired-current-directory))))
2210 (push-mark)))
2211 (setq file (directory-file-name file)) ; does no harm if no directory
2212 (let (found case-fold-search dir)
2213 (setq dir (or (file-name-directory file)
2214 (error "File name `%s' is not absolute" file)))
2215 (save-excursion
2216 ;; The hair here is to get the result of dired-goto-subdir
2217 ;; without really calling it if we don't have any subdirs.
2218 (if (if (string= dir (expand-file-name default-directory))
2219 (goto-char (point-min))
2220 (and (cdr dired-subdir-alist)
2221 (dired-goto-subdir dir)))
2222 (let ((base (file-name-nondirectory file))
2223 search-string
2224 (boundary (dired-subdir-max)))
2225 (setq search-string
2227 (setq search-string
2229 (while (and (not found)
2230 ;; filenames are preceded by SPC, this makes
2231 ;; the search faster (e.g. for the filename "-"!).
2232 (search-forward (concat " " search-string)
2233 boundary 'move))
2234 ;; Match could have BASE just as initial substring or
2235 ;; or in permission bits or date or
2236 ;; not be a proper filename at all:
2237 (if (equal base (dired-get-filename 'no-dir t))
2238 ;; Must move to filename since an (actually
2239 ;; correct) match could have been elsewhere on the
2240 ;; ;; line (e.g. "-" would match somewhere in the
2241 ;; permission bits).
2242 (setq found (dired-move-to-filename))
2243 ;; If this isn't the right line, move forward to avoid
2244 ;; trying this line again.
2245 (forward-line 1))))))
2246 (and found
2247 ;; return value of point (i.e., FOUND):
2248 (goto-char found))))
2250 (defun dired-initial-position (dirname)
2251 ;; Where point should go in a new listing of DIRNAME.
2252 ;; Point assumed at beginning of new subdir line.
2253 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2254 (end-of-line)
2255 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2256 \f
2257 ;; These are hooks which make tree dired work.
2258 ;; They are in this file because other parts of dired need to call them.
2259 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2261 ;; This function is called for each retrieved filename.
2262 ;; It could stand to be faster, though it's mostly function call
2263 ;; overhead. Avoiding the function call seems to save about 10% in
2264 ;; dired-get-filename. Make it a defsubst?
2265 (defun dired-current-directory (&optional localp)
2266 "Return the name of the subdirectory to which this line belongs.
2267 This returns a string with trailing slash, like `default-directory'.
2268 Optional argument means return a file name relative to `default-directory'."
2269 (let ((here (point))
2270 (alist (or dired-subdir-alist
2271 ;; probably because called in a non-dired buffer
2272 (error "No subdir-alist in %s" (current-buffer))))
2273 elt dir)
2274 (while alist
2275 (setq elt (car alist)
2276 dir (car elt)
2277 ;; use `<=' (not `<') as subdir line is part of subdir
2278 alist (if (<= (dired-get-subdir-min elt) here)
2279 nil ; found
2280 (cdr alist))))
2281 (if localp
2282 (dired-make-relative dir default-directory)
2283 dir)))
2285 ;; Subdirs start at the beginning of their header lines and end just
2286 ;; before the beginning of the next header line (or end of buffer).
2288 (defun dired-subdir-max ()
2289 (save-excursion
2290 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2291 (point-max)
2292 (point))))
2293 \f
2294 ;; Deleting files
2296 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
2297 "*Decide whether recursive deletes are allowed.
2298 nil means no recursive deletes.
2299 `always' means delete recursively without asking. This is DANGEROUS!
2300 `top' means ask for each directory at top level, but delete its subdirectories
2301 without asking.
2302 Anything else means ask for each directory."
2303 :type '(choice :tag "Delete non-empty directories"
2304 (const :tag "Yes" always)
2305 (const :tag "No--only delete empty directories" nil)
2306 (const :tag "Confirm for each directory" t)
2307 (const :tag "Confirm for each top directory only" top))
2308 :group 'dired)
2310 ;; Match anything but `.' and `..'.
2313 ;; Delete file, possibly delete a directory and all its files.
2314 ;; This function is usefull outside of dired. One could change it's name
2315 ;; to e.g. recursive-delete-file and put it somewhere else.
2316 (defun dired-delete-file (file &optional recursive) "\
2317 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2318 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2319 Nil, do not delete.
2320 `always', delete recursively without asking.
2321 `top', ask for each directory at top level.
2322 Anything else, ask for each sub-directory."
2323 (let (files)
2324 ;; This test is equivalent to
2325 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2326 ;; but more efficient
2327 (if (not (eq t (car (file-attributes file))))
2328 (delete-file file)
2329 (when (and recursive
2330 (setq files
2331 (directory-files file t dired-re-no-dot)) ; Not empty.
2332 (or (eq recursive 'always)
2333 (yes-or-no-p (format "Recursive delete of %s "
2334 (dired-make-relative file)))))
2335 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2336 (while files ; Recursively delete (possibly asking).
2337 (dired-delete-file (car files) recursive)
2338 (setq files (cdr files))))
2339 (delete-directory file))))
2341 (defun dired-do-flagged-delete (&optional nomessage)
2342 "In Dired, delete the files flagged for deletion.
2343 If NOMESSAGE is non-nil, we don't display any message
2344 if there are no flagged files."
2345 (interactive)
2346 (let* ((dired-marker-char dired-del-marker)
2347 (regexp (dired-marker-regexp))
2348 case-fold-search)
2349 (if (save-excursion (goto-char (point-min))
2350 (re-search-forward regexp nil t))
2351 (dired-internal-do-deletions
2352 ;; this can't move point since ARG is nil
2353 (dired-map-over-marks (cons (dired-get-filename) (point))
2354 nil)
2355 nil)
2356 (or nomessage
2357 (message "(No deletions requested)")))))
2359 (defun dired-do-delete (&optional arg)
2360 "Delete all marked (or next ARG) files."
2361 ;; This is more consistent with the file marking feature than
2362 ;; dired-do-flagged-delete.
2363 (interactive "P")
2364 (dired-internal-do-deletions
2365 ;; this may move point if ARG is an integer
2366 (dired-map-over-marks (cons (dired-get-filename) (point))
2367 arg)
2368 arg))
2370 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2372 (defun dired-internal-do-deletions (l arg)
2373 ;; L is an alist of files to delete, with their buffer positions.
2374 ;; ARG is the prefix arg.
2375 ;; Filenames are absolute (VMS needs this for logical search paths).
2376 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2377 ;; That way as changes are made in the buffer they do not shift the
2378 ;; lines still to be changed, so the (point) values in L stay valid.
2379 ;; Also, for subdirs in natural order, a subdir's files are deleted
2380 ;; before the subdir itself - the other way around would not work.
2381 (let ((files (mapcar (function car) l))
2382 (count (length l))
2383 (succ 0))
2384 ;; canonicalize file list for pop up
2385 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2386 (if (dired-mark-pop-up
2387 " *Deletions*" 'delete files dired-deletion-confirmer
2388 (format "Delete %s " (dired-mark-prompt arg files)))
2389 (save-excursion
2390 (let (failures);; files better be in reverse order for this loop!
2391 (while l
2392 (goto-char (cdr (car l)))
2393 (let (buffer-read-only)
2394 (condition-case err
2395 (let ((fn (car (car l))))
2396 (dired-delete-file fn dired-recursive-deletes)
2397 ;; if we get here, removing worked
2398 (setq succ (1+ succ))
2399 (message "%s of %s deletions" succ count)
2400 (dired-fun-in-all-buffers
2401 (file-name-directory fn) (file-name-nondirectory fn)
2402 (function dired-delete-entry) fn))
2403 (error;; catch errors from failed deletions
2405 (setq failures (cons (car (car l)) failures)))))
2406 (setq l (cdr l)))
2407 (if (not failures)
2408 (message "%d deletion%s done" count (dired-plural-s count))
2409 (dired-log-summary
2410 (format "%d of %d deletion%s failed"
2411 (length failures) count
2412 (dired-plural-s count))
2413 failures))))
2414 (message "(No deletions performed)")))
2415 (dired-move-to-filename))
2417 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2418 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2419 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2420 ;; (FILE does not include a directory component.)
2421 ;; FILE may be nil, in which case ignore it.
2422 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2423 (let (success-list)
2424 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2425 file))
2426 (with-current-buffer buf
2427 (if (apply fun args)
2428 (setq success-list (cons (buffer-name buf) success-list)))))
2429 success-list))
2431 ;; Delete the entry for FILE from
2432 (defun dired-delete-entry (file)
2433 (save-excursion
2434 (and (dired-goto-file file)
2435 (let (buffer-read-only)
2436 (delete-region (progn (beginning-of-line) (point))
2437 (save-excursion (forward-line 1) (point))))))
2438 (dired-clean-up-after-deletion file))
2440 ;; This is a separate function for the sake of dired-x.el.
2441 (defun dired-clean-up-after-deletion (fn)
2442 ;; Clean up after a deleted file or directory FN.
2443 (save-excursion (and (cdr dired-subdir-alist)
2444 (dired-goto-subdir fn)
2445 (dired-kill-subdir))))
2446 \f
2447 ;; Confirmation
2449 (defun dired-marker-regexp ()
2450 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2452 (defun dired-plural-s (count)
2453 (if (= 1 count) "" "s"))
2455 (defun dired-mark-prompt (arg files)
2456 ;; Return a string for use in a prompt, either the current file
2457 ;; name, or the marker and a count of marked files.
2458 (let ((count (length files)))
2459 (if (= count 1)
2460 (car files)
2461 ;; more than 1 file:
2462 (if (integerp arg)
2463 ;; abs(arg) = count
2464 ;; Perhaps this is nicer, but it also takes more screen space:
2465 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2466 ;; count)
2467 (format "[next %d files]" arg)
2468 (format "%c [%d files]" dired-marker-char count)))))
2470 (defun dired-pop-to-buffer (buf)
2471 ;; Pop up buffer BUF.
2472 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2473 (if (not dired-shrink-to-fit)
2474 (pop-to-buffer (get-buffer-create buf))
2475 ;; let window shrink to fit:
2476 (let ((window (selected-window))
2477 target-lines w2)
2478 (cond ;; if split-height-threshold is enabled, use the largest window
2479 ((and (> (window-height (setq w2 (get-largest-window)))
2480 split-height-threshold)
2481 (= (frame-width) (window-width w2)))
2482 (setq window w2))
2483 ;; if the least-recently-used window is big enough, use it
2484 ((and (> (window-height (setq w2 (get-lru-window)))
2485 (* 2 window-min-height))
2486 (= (frame-width) (window-width w2)))
2487 (setq window w2)))
2488 (save-excursion
2489 (set-buffer buf)
2490 (goto-char (point-max))
2492 (setq target-lines (count-lines (point-min) (point)))
2493 ;; Don't forget to count the last line.
2494 (if (not (bolp))
2495 (setq target-lines (1+ target-lines))))
2496 (if (<= (window-height window) (* 2 window-min-height))
2497 ;; At this point, every window on the frame is too small to split.
2498 (setq w2 (display-buffer buf))
2499 (setq w2 (split-window window
2500 (max window-min-height
2501 (- (window-height window)
2502 (1+ (max window-min-height target-lines)))))))
2503 (set-window-buffer w2 buf)
2504 (if (< (1- (window-height w2)) target-lines)
2505 (progn
2506 (select-window w2)
2507 (enlarge-window (- target-lines (1- (window-height w2))))))
2508 (set-window-start w2 1)
2509 )))
2511 (defvar dired-no-confirm nil
2512 "A list of symbols for commands dired should not confirm.
2513 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2514 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2515 `touch' and `uncompress'.")
2517 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2518 "Return FUNCTION's result on ARGS after showing which files are marked.
2519 Displays the file names in a buffer named BUFNAME;
2521 This uses function `dired-pop-to-buffer' to do that.
2523 FUNCTION should not manipulate files, just read input
2524 (an argument or confirmation).
2525 The window is not shown if there is just one file or
2526 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2527 FILES is the list of marked files."
2528 (or bufname (setq bufname " *Marked Files*"))
2529 (if (or (eq dired-no-confirm t)
2530 (memq op-symbol dired-no-confirm)
2531 (= (length files) 1))
2532 (apply function args)
2533 (with-current-buffer (get-buffer-create bufname)
2534 (erase-buffer)
2535 (dired-format-columns-of-files files)
2536 (remove-text-properties (point-min) (point-max)
2537 '(mouse-face nil help-echo nil)))
2538 (save-window-excursion
2539 (dired-pop-to-buffer bufname)
2540 (apply function args))))
2542 (defun dired-format-columns-of-files (files)
2543 ;; Files should be in forward order for this loop.
2544 ;; i.e., (car files) = first file in buffer.
2545 ;; Returns the number of lines used.
2546 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2547 (width (- (window-width (selected-window)) 2))
2548 (columns (max 1 (/ width maxlen)))
2549 (nfiles (length files))
2550 (rows (+ (/ nfiles columns)
2551 (if (zerop (% nfiles columns)) 0 1)))
2552 (i 0)
2553 (j 0))
2554 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2555 (make-list (- (* columns rows) nfiles) "")))
2556 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2557 (while (< j rows)
2558 (while (< i columns)
2559 (indent-to (* i maxlen))
2560 (insert (car files))
2561 (setq files (nthcdr rows files)
2562 i (1+ i)))
2564 (setq i 0
2565 j (1+ j)
2566 files (cdr files)))
2567 rows))
2568 \f
2569 ;; Commands to mark or flag file(s) at or near current line.
2571 (defun dired-repeat-over-lines (arg function)
2572 ;; This version skips non-file lines.
2573 (let ((pos (make-marker)))
2574 (beginning-of-line)
2575 (while (and (> arg 0) (not (eobp)))
2576 (setq arg (1- arg))
2577 (beginning-of-line)
2578 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2579 (save-excursion
2580 (forward-line 1)
2581 (move-marker pos (1+ (point))))
2582 (save-excursion (funcall function))
2583 ;; Advance to the next line--actually, to the line that *was* next.
2584 ;; (If FUNCTION inserted some new lines in between, skip them.)
2585 (goto-char pos))
2586 (while (and (< arg 0) (not (bobp)))
2587 (setq arg (1+ arg))
2588 (forward-line -1)
2589 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2590 (beginning-of-line)
2591 (save-excursion (funcall function)))
2592 (move-marker pos nil)
2593 (dired-move-to-filename)))
2595 (defun dired-between-files ()
2596 ;; This used to be a regexp match of the `total ...' line output by
2597 ;; ls, which is slightly faster, but that is not very robust; notably,
2598 ;; it fails for non-english locales.
2599 (save-excursion (not (dired-move-to-filename))))
2601 (defun dired-next-marked-file (arg &optional wrap opoint)
2602 "Move to the next marked file, wrapping around the end of the buffer."
2604 (or opoint (setq opoint (point)));; return to where interactively started
2605 (if (if (> arg 0)
2606 (re-search-forward dired-re-mark nil t arg)
2607 (beginning-of-line)
2608 (re-search-backward dired-re-mark nil t (- arg)))
2609 (dired-move-to-filename)
2610 (if (null wrap)
2611 (progn
2612 (goto-char opoint)
2613 (error "No next marked file"))
2614 (message "(Wraparound for next marked file)")
2615 (goto-char (if (> arg 0) (point-min) (point-max)))
2616 (dired-next-marked-file arg nil opoint))))
2618 (defun dired-prev-marked-file (arg &optional wrap)
2619 "Move to the previous marked file, wrapping around the end of the buffer."
2621 (dired-next-marked-file (- arg) wrap))
2623 (defun dired-file-marker (file)
2624 ;; Return FILE's marker, or nil if unmarked.
2625 (save-excursion
2626 (and (dired-goto-file file)
2627 (progn
2628 (beginning-of-line)
2630 (following-char))))))
2632 (defun dired-mark-files-in-region (start end)
2633 (let (buffer-read-only)
2634 (if (> start end)
2635 (error "start > end"))
2636 (goto-char start) ; assumed at beginning of line
2637 (while (< (point) end)
2638 ;; Skip subdir line and following garbage like the `total' line:
2639 (while (and (< (point) end) (dired-between-files))
2640 (forward-line 1))
2641 (if (and (not (looking-at dired-re-dot))
2642 (dired-get-filename nil t))
2643 (progn
2644 (delete-char 1)
2645 (insert dired-marker-char)))
2646 (forward-line 1))))
2648 (defun dired-mark (arg)
2649 "Mark the current (or next ARG) files.
2650 If on a subdir headerline, mark all its files except `.' and `..'.
2654 this subdir."
2655 (interactive "P")
2656 (if (dired-get-subdir)
2657 (save-excursion (dired-mark-subdir-files))
2658 (let (buffer-read-only)
2659 (dired-repeat-over-lines
2660 (prefix-numeric-value arg)
2661 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2663 (defun dired-unmark (arg)
2664 "Unmark the current (or next ARG) files.
2665 If looking at a subdir, unmark all its files except `.' and `..'."
2666 (interactive "P")
2668 (dired-mark arg)))
2670 (defun dired-flag-file-deletion (arg)
2671 "In Dired, flag the current line's file for deletion.
2672 With prefix arg, repeat over several lines.
2674 If on a subdir headerline, mark all its files except `.' and `..'."
2675 (interactive "P")
2676 (let ((dired-marker-char dired-del-marker))
2677 (dired-mark arg)))
2679 (defun dired-unmark-backward (arg)
2680 "In Dired, move up lines and remove deletion flag there.
2681 Optional prefix ARG says how many lines to unflag; default is one line."
2682 (interactive "p")
2683 (dired-unmark (- arg)))
2685 (defun dired-toggle-marks ()
2686 "Toggle marks: marked files become unmarked, and vice versa.
2687 Files marked with other flags (such as `D') are not affected.
2688 `.' and `..' are never toggled.
2689 As always, hidden subdirs are not affected."
2690 (interactive)
2691 (save-excursion
2692 (goto-char (point-min))
2693 (let (buffer-read-only)
2694 (while (not (eobp))
2695 (or (dired-between-files)
2696 (looking-at dired-re-dot)
2697 ;; use subst instead of insdel because it does not move
2698 ;; the gap and thus should be faster and because
2699 ;; other characters are left alone automatically
2700 (apply 'subst-char-in-region
2701 (point) (1+ (point))
2705 (forward-line 1)))))
2706 \f
2707 ;;; Commands to mark or flag files based on their characteristics or names.
2709 (defvar dired-regexp-history nil
2710 "History list of regular expressions used in Dired commands.")
2712 (defun dired-read-regexp (prompt)
2713 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2715 (defun dired-mark-files-regexp (regexp &optional marker-char)
2716 "Mark all files matching REGEXP for use in later commands.
2717 A prefix argument means to unmark them instead.
2718 `.' and `..' are never marked.
2721 object files--just `.o' will mark more than you might think."
2722 (interactive
2723 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2724 " files (regexp): "))
2726 (let ((dired-marker-char (or marker-char dired-marker-char)))
2727 (dired-mark-if
2728 (and (not (looking-at dired-re-dot))
2729 (not (eolp)) ; empty line
2730 (let ((fn (dired-get-filename nil t)))
2731 (and fn (string-match regexp (file-name-nondirectory fn)))))
2732 "matching file")))
2734 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2735 "Mark all files with contents containing REGEXP for use in later commands.
2736 A prefix argument means to unmark them instead.
2737 `.' and `..' are never marked."
2738 (interactive
2739 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2740 " files containing (regexp): "))
2742 (let ((dired-marker-char (or marker-char dired-marker-char)))
2743 (dired-mark-if
2744 (and (not (looking-at dired-re-dot))
2745 (not (eolp)) ; empty line
2746 (let ((fn (dired-get-filename nil t)))
2747 (when (and fn (file-readable-p fn)
2748 (not (file-directory-p fn)))
2749 (let ((prebuf (get-file-buffer fn)))
2750 (message "Checking %s" fn)
2751 ;; For now we do it inside emacs
2752 ;; Grep might be better if there are a lot of files
2753 (if prebuf
2754 (with-current-buffer prebuf
2755 (save-excursion
2756 (goto-char (point-min))
2757 (re-search-forward regexp nil t)))
2758 (with-temp-buffer
2759 (insert-file-contents fn)
2760 (goto-char (point-min))
2761 (re-search-forward regexp nil t))))
2762 )))
2763 "matching file")))
2765 (defun dired-flag-files-regexp (regexp)
2766 "In Dired, flag all files containing the specified REGEXP for deletion.
2767 The match is against the non-directory part of the filename. Use `^'
2768 and `$' to anchor matches. Exclude subdirs by hiding them.
2769 `.' and `..' are never flagged."
2770 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2771 (dired-mark-files-regexp regexp dired-del-marker))
2773 (defun dired-mark-symlinks (unflag-p)
2774 "Mark all symbolic links.
2775 With prefix argument, unflag all those files."
2776 (interactive "P")
2778 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2780 (defun dired-mark-directories (unflag-p)
2781 "Mark all directory file lines except `.' and `..'.
2782 With prefix argument, unflag all those files."
2783 (interactive "P")
2785 (dired-mark-if (and (looking-at dired-re-dir)
2786 (not (looking-at dired-re-dot)))
2787 "directory file")))
2789 (defun dired-mark-executables (unflag-p)
2790 "Mark all executable files.
2791 With prefix argument, unflag all those files."
2792 (interactive "P")
2794 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2796 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2797 ;; files for which PREDICATE returns non-nil.
2799 (defun dired-flag-auto-save-files (&optional unflag-p)
2800 "Flag for deletion files whose names suggest they are auto save files.
2801 A prefix argument says to unflag those files instead."
2802 (interactive "P")
2804 (dired-mark-if
2805 ;; It is less than general to check for # here,
2806 ;; but it's the only way this runs fast enough.
2807 (and (save-excursion (end-of-line)
2808 (or
2809 (eq (preceding-char) ?#)
2810 ;; Handle executables in case of -F option.
2811 ;; We need not worry about the other kinds
2812 ;; of markings that -F makes, since they won't
2813 ;; appear on real auto-save files.
2814 (if (eq (preceding-char) ?*)
2815 (progn
2816 (forward-char -1)
2817 (eq (preceding-char) ?#)))))
2818 (not (looking-at dired-re-dir))
2819 (let ((fn (dired-get-filename t t)))
2820 (if fn (auto-save-file-name-p
2821 (file-name-nondirectory fn)))))
2822 "auto save file")))
2824 (defcustom dired-garbage-files-regexp
2825 ;; `log' here is dubious, since it's typically used for useful log
2826 ;; files, not just TeX stuff. -- fx
2827 (concat (regexp-opt
2828 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2831 :type 'regexp
2832 :group 'dired)
2834 (defun dired-flag-garbage-files ()
2835 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2836 (interactive)
2837 (dired-flag-files-regexp dired-garbage-files-regexp))
2839 (defun dired-flag-backup-files (&optional unflag-p)
2840 "Flag all backup files (names ending with `~') for deletion.
2841 With prefix argument, unflag these files."
2842 (interactive "P")
2843 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
2844 (dired-mark-if
2845 ;; Don't call backup-file-name-p unless the last character looks like
2846 ;; it might be the end of a backup file name. This isn't very general,
2847 ;; but it's the only way this runs fast enough.
2848 (and (save-excursion (end-of-line)
2849 ;; Handle executables in case of -F option.
2850 ;; We need not worry about the other kinds
2851 ;; of markings that -F makes, since they won't
2852 ;; appear on real backup files.
2853 (if (eq (preceding-char) ?*)
2854 (forward-char -1))
2855 (eq (preceding-char) ?~))
2856 (not (looking-at dired-re-dir))
2857 (let ((fn (dired-get-filename t t)))
2858 (if fn (backup-file-name-p fn))))
2859 "backup file")))
2861 (defun dired-change-marks (&optional old new)
2862 "Change all OLD marks to NEW marks.
2863 OLD and NEW are both characters used to mark files."
2864 (interactive
2865 (let* ((cursor-in-echo-area t)
2866 (old (progn (message "Change (old mark): ") (read-char)))
2867 (new (progn (message "Change %c marks to (new mark): " old)
2868 (read-char))))
2869 (list old new)))
2871 (ding)
2873 (buffer-read-only))
2874 (save-excursion
2875 (goto-char (point-min))
2876 (while (search-forward string nil t)
2877 (if (if (= old ?\ )
2878 (save-match-data
2879 (dired-get-filename 'no-dir t))
2880 t)
2881 (subst-char-in-region (match-beginning 0)
2882 (match-end 0) old new)))))))
2884 (defun dired-unmark-all-marks ()
2885 "Remove all marks from all files in the Dired buffer."
2886 (interactive)
2889 (defun dired-unmark-all-files (mark &optional arg)
2890 "Remove a specific mark (or any mark) from every file.
2891 After this command, type the mark character to remove,
2892 or type RET to remove all marks.
2893 With prefix arg, query for each marked file.
2896 (save-excursion
2897 (let* ((count 0)
2898 buffer-read-only case-fold-search query
2900 (help-form "\
2901 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2902 `!' to unmark all remaining files with no more questions."))
2903 (goto-char (point-min))
2905 (re-search-forward dired-re-mark nil t)
2906 (search-forward string nil t))
2907 (if (or (not arg)
2908 (let ((file (dired-get-filename t t)))
2909 (and file
2910 (dired-query 'query "Unmark file `%s'? "
2911 file))))
2912 (progn (subst-char-in-region (1- (point)) (point)
2913 (preceding-char) ?\ )
2914 (setq count (1+ count)))))
2915 (message (if (= count 1) "1 mark removed"
2916 "%d marks removed")
2917 count))))
2918 \f
2919 ;; Logging failures operating on files, and showing the results.
2921 (defvar dired-log-buffer "*Dired log*")
2923 (defun dired-why ()
2924 "Pop up a buffer with error log output from Dired.
2925 A group of errors from a single command ends with a formfeed.
2927 (interactive)
2928 (if (get-buffer dired-log-buffer)
2929 (let ((owindow (selected-window))
2930 (window (display-buffer (get-buffer dired-log-buffer))))
2931 (unwind-protect
2932 (progn
2933 (select-window window)
2934 (goto-char (point-max))
2935 (forward-line -1)
2936 (backward-page 1)
2937 (recenter 0))
2938 (select-window owindow)))))
2940 (defun dired-log (log &rest args)
2941 ;; Log a message or the contents of a buffer.
2942 ;; If LOG is a string and there are more args, it is formatted with
2944 ;; End each bunch of errors with (dired-log t):
2945 ;; this inserts the current time and buffer at the start of the page,
2947 (let ((obuf (current-buffer)))
2948 (with-current-buffer (get-buffer-create dired-log-buffer)
2949 (goto-char (point-max))
2950 (let ((inhibit-read-only t))
2951 (cond ((stringp log)
2952 (insert (if args
2953 (apply (function format) log args)
2954 log)))
2955 ((bufferp log)
2956 (insert-buffer log))
2957 ((eq t log)
2958 (backward-page 1)
2959 (unless (bolp)
2961 (insert (current-time-string)
2963 (goto-char (point-max))
2966 (defun dired-log-summary (string failures)
2967 (if (= (length failures) 1)
2968 (message "%s"
2969 (with-current-buffer dired-log-buffer
2970 (goto-char (point-max))
2971 (backward-page 1)
2972 (if (eolp) (forward-line 1))
2973 (buffer-substring (point) (point-max))))
2974 (message (if failures "%s--type ? for details (%s)"
2975 "%s--type ? for details")
2976 string failures))
2977 ;; Log a summary describing a bunch of errors.
2979 (dired-log t))
2980 \f
2981 ;;; Sorting
2983 ;; Most ls can only sort by name or by date (with -t), nothing else.
2984 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2985 ;; So anything that does not contain these is sort "by name".
2987 (defvar dired-ls-sorting-switches "SXU"
2990 This indicates to Dired which option switches to watch out for because they
2991 will change the sorting order behavior of `ls'.
2993 To change the default sorting order \(e.g. add a `-v' option\), see the
2994 variable `dired-listing-switches'. To temporarily override the listing
2997 (defvar dired-sort-by-date-regexp
2998 (concat "^-[^" dired-ls-sorting-switches
2999 "]*t[^" dired-ls-sorting-switches "]*$")
3000 "Regexp recognized by dired to set `by date' mode.")
3002 (defvar dired-sort-by-name-regexp
3003 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3004 "Regexp recognized by dired to set `by name' mode.")
3006 (defvar dired-sort-inhibit nil
3007 "Non-nil means the Dired sort command is disabled.
3008 The idea is to set this buffer-locally in special Dired buffers.")
3010 (defun dired-sort-set-modeline ()
3011 ;; Set modeline display according to dired-actual-switches.
3012 ;; Modeline display of "by name" or "by date" guarantees the user a
3013 ;; match with the corresponding regexps. Non-matching switches are
3014 ;; shown literally.
3015 (setq mode-name
3016 (let (case-fold-search)
3017 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
3018 "Dired by name")
3019 ((string-match dired-sort-by-date-regexp dired-actual-switches)
3020 "Dired by date")
3021 (t
3022 (concat "Dired " dired-actual-switches)))))
3023 (force-mode-line-update))
3025 (defun dired-sort-toggle-or-edit (&optional arg)
3026 "Toggle between sort by date/name and refresh the dired buffer.
3027 With a prefix argument you can edit the current listing switches instead."
3028 (interactive "P")
3029 (when dired-sort-inhibit
3030 (error "Cannot sort this Dired buffer"))
3031 (if arg
3032 (dired-sort-other
3033 (read-string "ls switches (must contain -l): " dired-actual-switches))
3034 (dired-sort-toggle)))
3036 (defun dired-sort-toggle ()
3037 ;; Toggle between sort by date/name. Reverts the buffer.
3038 (setq dired-actual-switches
3039 (let (case-fold-search)
3040 (if (string-match " " dired-actual-switches)
3041 ;; New toggle scheme: add/remove a trailing " -t"
3043 (substring dired-actual-switches 0 (match-beginning 0))
3044 (concat dired-actual-switches " -t"))
3045 ;; old toggle scheme: look for some 't' switch and add/remove it
3046 (concat
3047 "-l"
3048 (dired-replace-in-string (concat "[-lt"
3049 dired-ls-sorting-switches "]")
3050 ""
3051 dired-actual-switches)
3052 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3053 dired-actual-switches)
3054 ""
3055 "t")))))
3056 (dired-sort-set-modeline)
3057 (revert-buffer))
3059 ;; Some user code loads dired especially for this.
3060 ;; Don't do that--use replace-regexp-in-string instead.
3061 (defun dired-replace-in-string (regexp newtext string)
3062 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3064 (let ((result "") (start 0) mb me)
3065 (while (string-match regexp string start)
3066 (setq mb (match-beginning 0)
3067 me (match-end 0)
3068 result (concat result (substring string start mb) newtext)
3069 start me))
3070 (concat result (substring string start))))
3072 (defun dired-sort-other (switches &optional no-revert)
3073 "Specify new ls SWITCHES for current dired buffer.
3074 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3075 set the minor mode accordingly, others appear literally in the mode line.
3076 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3077 (dired-sort-R-check switches)
3078 (setq dired-actual-switches switches)
3079 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
3080 (or no-revert (revert-buffer)))
3082 (make-variable-buffer-local
3083 (defvar dired-subdir-alist-pre-R nil
3084 "Value of `dired-subdir-alist' before -R switch added."))
3086 (defun dired-sort-R-check (switches)
3087 "Additional processing of -R in ls option string SWITCHES.
3088 Saves `dired-subdir-alist' when R is set and restores saved value
3089 minus any directories explicitly deleted when R is cleared.
3090 To be called first in body of `dired-sort-other', etc."
3091 (cond
3092 ((and (string-match "R" switches)
3093 (not (string-match "R" dired-actual-switches)))
3094 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3095 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3096 ((and (string-match "R" dired-actual-switches)
3097 (not (string-match "R" switches)))
3098 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3099 ;; that are still present:
3100 (setq dired-subdir-alist
3101 (if dired-subdir-alist-pre-R
3102 (let (subdirs)
3103 (while dired-subdir-alist-pre-R
3104 (if (assoc (caar dired-subdir-alist-pre-R)
3105 dired-subdir-alist)
3106 ;; subdir still present...
3107 (setq subdirs
3108 (cons (car dired-subdir-alist-pre-R)
3109 subdirs)))
3110 (setq dired-subdir-alist-pre-R
3111 (cdr dired-subdir-alist-pre-R)))
3112 (reverse subdirs))
3113 ;; No pre-R subdir alist, so revert to main directory
3114 ;; listing:
3115 (list (car (reverse dired-subdir-alist))))))))
3116 \f
3118 ;;;; Drag and drop support
3120 (defcustom dired-recursive-copies nil
3121 "*Decide whether recursive copies are allowed.
3122 nil means no recursive copies.
3123 `always' means copy recursively without asking.
3124 `top' means ask for each directory at top level.
3125 Anything else means ask for each directory."
3126 :type '(choice :tag "Copy directories"
3127 (const :tag "No recursive copies" nil)
3128 (const :tag "Ask for each directory" t)
3129 (const :tag "Ask for each top directory only" top)
3130 (const :tag "Copy directories without asking" always))
3131 :group 'dired)
3133 (defun dired-dnd-test-function (window action types)
3134 "The test function for drag and drop into dired buffers.
3135 WINDOW is where the mouse is when this function is called. It may be a frame
3136 if the mouse is over the menu bar, scroll bar or tool bar.
3137 ACTION is the suggested action from the source, and TYPES are the
3138 types the drop data can have. This function only accepts drops with
3139 types in `x-dnd-known-types'. It returns the action suggested by the source."
3140 (let ((type (x-dnd-choose-type types)))
3141 (if type
3142 (cons action type)
3143 nil)))
3145 (defun dired-dnd-popup-notice ()
3146 (x-popup-dialog
3147 t
3149 ("Ok" . nil))))
3152 (defun dired-dnd-do-ask-action (uri)
3153 ;; No need to get actions and descriptions from the source,
3154 ;; we only have three actions anyway.
3155 (let ((action (x-popup-menu
3156 t
3157 (list "What action?"
3158 (cons ""
3159 '(("Copy here" . copy)
3160 ("Move here" . move)
3161 ("Link here" . link)
3162 "--"
3163 ("Cancel" . nil)))))))
3164 (if action
3165 (dired-dnd-handle-local-file uri action)
3166 nil)))
3168 (defun dired-dnd-handle-local-file (uri action)
3169 "Copy, move or link a file to the dired directory.
3170 URI is the file to handle, ACTION is one of copy, move, link or ask.
3171 Ask means pop up a menu for the user to select one of copy, move or link."
3172 (require 'dired-aux)
3173 (let* ((from (x-dnd-get-local-file-name uri t))
3174 (to (if from (concat (dired-current-directory)
3175 (file-name-nondirectory from))
3176 nil)))
3177 (if from
3178 (cond ((or (eq action 'copy)
3179 (eq action 'private)) ; Treat private as copy.
3181 ;; If copying a directory and dired-recursive-copies is nil,
3182 ;; dired-copy-file silently fails. Pop up a notice.
3183 (if (and (file-directory-p from)
3184 (not dired-recursive-copies))
3185 (dired-dnd-popup-notice)
3186 (progn
3187 (dired-copy-file from to 1)
3188 (dired-relist-entry to)
3189 action)))
3191 ((eq action 'move)
3192 (dired-rename-file from to 1)
3193 (dired-relist-entry to)
3194 action)
3196 ((eq action 'link)
3197 (make-symbolic-link from to 1)
3198 (dired-relist-entry to)
3199 action)
3201 ((eq action 'ask)
3202 (dired-dnd-do-ask-action uri))
3204 (t nil)))))
3206 (defun dired-dnd-handle-file (uri action)
3207 "Copy, move or link a file to the dired directory if it is a local file.
3208 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3209 ACTION is one of copy, move, link or ask.
3210 Ask means pop up a menu for the user to select one of copy, move or link."
3211 (let ((local-file (x-dnd-get-local-file-uri uri)))
3212 (if local-file (dired-dnd-handle-local-file local-file action)
3213 nil)))
3214 \f
3216 ;;;; Desktop support
3218 (eval-when-compile (require 'desktop))
3220 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3221 "Auxiliary information to be saved in desktop file."
3222 (cons
3223 ;; Value of `dired-directory'.
3224 (if (consp dired-directory)
3225 ;; Directory name followed by list of files.
3226 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3227 (cdr dired-directory))
3228 ;; Directory name, optionally with with shell wildcard.
3229 (desktop-file-name dired-directory desktop-dirname))
3230 ;; Subdirectories in `dired-subdir-alist'.
3231 (cdr
3232 (nreverse
3233 (mapcar
3234 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3235 dired-subdir-alist)))))
3237 ;;;###autoload
3238 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3239 desktop-buffer-name
3240 desktop-buffer-misc)
3241 "Restore a dired buffer specified in a desktop file."
3242 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3243 ;; This value is a directory name, optionally with with shell wildcard or
3244 ;; a directory name followed by list of files.
3245 (let* ((dired-dir (car desktop-buffer-misc))
3246 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3247 (if (file-directory-p (file-name-directory dir))
3248 (progn
3249 (dired dired-dir)
3250 ;; The following elements of `desktop-buffer-misc' are the keys
3251 ;; from `dired-subdir-alist'.
3252 (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3253 (current-buffer))
3254 (message "Desktop: Directory %s no longer exists." dir)
3255 (when desktop-missing-file-warning (sit-for 1))
3256 nil)))
3258 \f
3259 (if (eq system-type 'vax-vms)
3260 (load "dired-vms"))
3262 (provide 'dired)
3264 (run-hooks 'dired-load-hook) ; for your customizations
3266 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3267 ;;; dired.el ends here