| blob | 508bc39bbb5304a6e1f2013e35d4ac813a2fb75a |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005 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., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;; This is a major mode for directory browsing and editing. It is
30 ;; documented in the Emacs manual.
32 ;; Rewritten in 1990/1991 to add tree features, file marking and
33 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
34 ;; Finished up by rms in 1992.
36 ;;; Code:
38 ;;; Customizable variables
41 "Directory editing."
46 "Handling marks in Dired."
51 ;;;###autoload
53 "*Switches passed to `ls' for Dired. MUST contain the `l' option.
54 May contain all other options that don't contradict `-l';
55 may contain even `F', `b', `i' and `s'. See also the variable
56 `dired-ls-F-marks-symlinks' concerning the `F' switch.
57 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
58 some of the `ls' switches are not supported; see the doc string of
59 `insert-directory' 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.
207 "The functions to call when a drop in `dired-mode' is made.
208 See `dnd-protocol-alist' for more information. When nil, behave
209 as in other buffers."
215 ;; Internal variables
218 ;; so that you can write things like
219 ;; (let ((dired-marker-char ?X))
220 ;; ;; great code using X markers ...
221 ;; )
222 ;; For example, commands operating on two sets of files, A and B.
223 ;; Or marking files with digits 0-9. This could implicate
224 ;; concentric sets or an order for the marked files.
225 ;; The code depends on dynamic scoping on the marker char.
226 "In Dired, the current mark character.
233 ;; I see no reason ever to make this nil -- rms.
234 ;; (> baud-rate search-slow-speed)
241 ;;;###autoload
243 "The directory name or wildcard spec that this dired directory lists.
244 Local to each dired buffer. May be a list, in which case the car is the
245 directory name and the cdr is the list of files to mention.
254 ;; These regexps must be tested at beginning-of-line, but are also
255 ;; used to search for next matches, so neither omitting "^" nor
256 ;; replacing "^" by "\n" (to make it slightly faster) will work.
259 ;; "Regexp matching a marked line.
260 ;; Important: the match ends just after the marker."
262 ;; The [^:] part after "d" and "l" is to avoid confusion with the
263 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
271 "-[-r][-w].[-r][-w][xs][-r][-w]."
277 ;; The subdirectory names in the next two lists are expanded.
279 "Association list of subdirectories and their buffer positions.
280 Each subdirectory has an element: (DIRNAME . STARTMARKER).
281 The order of elements is the reverse of the order in the buffer.
285 "Keeps track of which switches to use for inserted subdirectories.
290 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
291 Subexpression 1 is the subdirectory proper, no trailing colon.
292 The match starts at the beginning of the line and ends after the end
297 "Faces used by Dired."
303 "Face used for directory headers."
311 "Face used for dired marks."
319 "Face used for marked files."
327 "Face used for flagged files."
335 "Face used to highlight a part of a buffer that needs user attention."
343 "Face used for subdirectories."
351 "Face used for symbolic links."
359 "Face used for files suffixed with `completion-ignored-extensions'."
367 ;;
368 ;; Directory headers.
370 ;;
371 ;; Dired marks.
373 ;;
374 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
375 ;; file name itself. We search for Dired defined regexps, and then use the
376 ;; Dired defined function `dired-move-to-filename' before searching for the
377 ;; simple regexp ".+". It is that regexp which matches the file name.
378 ;;
379 ;; Marked files.
382 ;;
383 ;; Flagged files.
386 ;; People who are paranoid about security would consider this more
387 ;; important than other things such as whether it is a directory.
388 ;; But we don't want to encourage paranoia, so our default
389 ;; should be what's most useful for non-paranoids. -- rms.
390 ;;; ;;
391 ;;; ;; Files that are group or world writable.
392 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
393 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
394 ;;; '(1 dired-warning-face)
395 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
396 ;; However, we don't need to highlight the file name, only the
397 ;; permissions, to win generally. -- fx.
398 ;; Fixme: we could also put text properties on the permission
399 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
406 ;;
407 ;; Subdirectories.
410 ;;
411 ;; Symbolic links.
414 ;;
415 ;; Files suffixed with `completion-ignored-extensions'.
417 ;; It is quicker to first find just an extension, then go back to the
418 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
421 ;;
422 ;; Files suffixed with `completion-ignored-extensions'
423 ;; plus a character put in by -F.
429 ;; If the last character is not part of the filename,
430 ;; move back to the start of the filename
431 ;; so it can be fontified.
432 ;; Otherwise, leave point at the end of the line;
433 ;; that way, nothing is fontified.
437 )
441 \f
442 ;;; Macros must be defined before they are used, for the byte compiler.
445 "Mark all files for which PREDICATE evals to non-nil.
446 PREDICATE is evaluated on each line, with point at beginning of line.
447 MSG is a noun phrase for the type of files being marked.
448 It should end with a noun that can be pluralized by adding `s'.
449 Return value is the number of files marked, or nil if none were marked."
463 count
464 ,msg
472 distinguish-one-marked)
473 "Eval BODY with point on each marked line. Return a list of BODY's results.
474 If no marked file could be found, execute BODY on the current line.
475 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
476 files instead of the marked files.
477 In that case point is dragged along. This is so that commands on
478 the next ARG (instead of the marked) files can be chained easily.
479 If ARG is otherwise non-nil, use current file instead.
480 If optional third arg SHOW-PROGRESS evaluates to non-nil,
481 redisplay the dired buffer after each file is processed.
482 No guarantee is made about the position on the marked line.
483 BODY must ensure this itself if it depends on this.
484 Search starts at the beginning of the buffer, thus the car of the list
485 corresponds to the line nearest to the buffer's bottom. This
486 is also true for (positive and negative) integer values of ARG.
487 BODY should not be too long as it is expanded four times.
489 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
490 return (t FILENAME) instead of (FILENAME)."
491 ;;
492 ;;Warning: BODY must not add new lines before point - this may cause an
493 ;;endless loop.
494 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
501 ,arg
507 results))
508 ;; non-nil, non-integer ARG means use current file:
513 ;; remember position of next marked file before BODY
514 ;; can insert lines before the just found file,
515 ;; confusing us by finding the same marked file again
516 ;; and again and...
524 ;; move after last match
533 results
535 ;; save-excursion loses, again
539 "Return the marked files' names as list of strings.
540 The list is in the same order as the buffer, that is, the car is the
541 first marked file.
542 Values returned are normally absolute file names.
543 Optional arg LOCALP as in `dired-get-filename'.
544 Optional second argument ARG specifies files near point
545 instead of marked files. If ARG is an integer, use the next ARG files.
546 If ARG is otherwise non-nil, use file. Usually ARG comes from
547 the command's prefix arg.
548 Optional third argument FILTER, if non-nil, is a function to select
549 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
551 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
552 return (t FILENAME) instead of (FILENAME).
553 Don't use that together with FILTER."
558 arg nil distinguish-one-marked)))
559 result)
562 all-of-them
567 result)))
568 \f
569 ;; The dired command
572 ;; For use in interactive.
576 dired-listing-switches))
577 ;; If a dialog is about to be used, call read-directory-name so
578 ;; the dialog code knows we want directories. Some dialogs can
579 ;; only select directories or files when popped up, not both.
582 nil default-directory nil)
584 nil default-directory nil)))))
586 ;;;###autoload (define-key ctl-x-map "d" 'dired)
587 ;;;###autoload
590 Optional second argument SWITCHES specifies the `ls' options used.
591 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
592 Dired displays a list of files in DIRNAME (which may also have
593 shell wildcards appended to select certain files). If DIRNAME is a cons,
594 its first element is taken as the directory name and the rest as an explicit
595 list of files to make directory entries for.
597 You can move around in it with the usual commands.
602 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
603 ;; Cannot use (interactive "D") because of wildcards.
607 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
608 ;;;###autoload
614 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
615 ;;;###autoload
621 ;;;###autoload
623 "Like `dired' but returns the dired buffer as value, does not select it."
625 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
626 ;; some shells make:
637 ;; If the argument was syntactically a directory name not a file name,
638 ;; or if it happens to name a file that is a directory,
639 ;; convert it syntactically to a directory name.
640 ;; The reason for checking initially-was-dirname
641 ;; and not just file-directory-p
642 ;; is that file-directory-p is slow over ftp.
650 ;; The following is an internal dired function. It returns non-nil if
651 ;; the directory visited by the current dired buffer has changed on
652 ;; disk. DIRNAME should be the directory name of that directory.
661 "Return non-nil if current dired buffer needs updating.
662 If NOCONFIRM is non-nil, then this function always returns nil
663 for a remote directory. This feature is used by Auto Revert Mode."
671 ;; Separate function from dired-noselect for the sake of dired-vms.el.
673 ;; If there is an existing dired buffer for DIRNAME, just leave
674 ;; buffer as it is (don't even call dired-revert).
675 ;; This saves time especially for deep trees or with ange-ftp.
676 ;; The user can type `g' easily, and it is more consistent with find-file.
677 ;; But if SWITCHES are given they are probably different from the
678 ;; buffer's old value, so call dired-sort-other, which does
679 ;; revert the buffer.
680 ;; A pity we can't possibly do "Directory has changed - refresh? "
681 ;; like find-file does.
682 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
683 ;; see there.
685 buffer
686 ;; note that buffer already is in dired-mode, if found
687 new-buffer-p
692 ;; Look for an existing buffer.
697 ;; We don't want default-major-mode to run hooks and set auto-fill
698 ;; or whatever, now that dired-mode does not
699 ;; kill-all-local-variables any longer.
704 ;; file list may have changed
706 ;; this calls dired-revert
708 ;; If directory has changed on disk, offer to revert.
713 ;; Else a new buffer
715 ;; We can do this unconditionally
716 ;; because dired-noselect ensures that the name
717 ;; is passed in directory name syntax
718 ;; if it was the name of a directory at all.
723 ;; default-directory and dired-actual-switches are set now
724 ;; (buffer-local), so we can call dired-readin:
729 ;; dired-readin can fail if parent directories are inaccessible.
730 ;; Don't leave an empty buffer around in that case.
735 buffer))
738 ;; Enlarged by dired-advertise
739 ;; Queried by function dired-buffers-for-dir. When this detects a
740 ;; killed buffer, it is removed from this list.
744 ;; This differs from dired-buffers-for-dir in that it does not consider
745 ;; subdirs of default-directory and searches for the first match only.
746 ;; Also, the major mode must be MODE.
756 dired-directory ;; nil during find-alternate-file
761 dired-directory))))
763 blist nil)
765 found))
767 \f
768 ;; Read in a new dired buffer
771 "Read in a new dired buffer.
772 Differs from `dired-insert-subdir' in that it accepts
773 wildcards, erases the buffer, and builds the subdir-alist anew
774 \(including making it buffer-local and clearing it first)."
776 ;; default-directory and dired-actual-switches must be buffer-local
777 ;; and initialized by now.
784 ;; This hook which may want to modify dired-actual-switches
785 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
786 ;; where ls won't understand -Al switches.
791 ;; Don't make undo entries for readin.
797 ;; Must first make alist buffer local and set it to nil because
798 ;; dired-build-subdir-alist will call dired-clear-alist first
805 ;; No need to narrow since the whole buffer contains just
806 ;; dired-readin's output, nothing else. The hook can
807 ;; successfully use dired functions (e.g. dired-get-filename)
808 ;; as the subdir-alist has been built in dired-readin.
811 ;; Subroutines of dired-readin
814 ;; Insert listing for the specified dir (and maybe file list)
815 ;; already in dired-directory, assuming a clean buffer.
821 file-list nil))
825 ;; If we are reading a whole single directory...
830 ;; Else treat it as a wildcard spec
831 ;; unless we have an explicit list of files.
836 "Align the fields of a file to the ones of surrounding lines.
837 BEG..END is the line where the file info is located."
838 ;; Some versions of ls try to adjust the size of each field so as to just
839 ;; hold the largest element ("largest" in the current invocation, of
840 ;; course). So when a single line is output, the size of each field is
841 ;; just big enough for that one output. Thus when dired refreshes one
842 ;; line, the alignment if this line w.r.t the rest is messed up because
843 ;; the fields of that one line will generally be smaller.
844 ;;
845 ;; To work around this problem, we here add spaces to try and re-align the
846 ;; fields as needed. Since this is purely aesthetic, it is of utmost
847 ;; importance that it doesn't mess up anything like
848 ;; `dired-move-to-filename'. To this end, we limit ourselves to adding
849 ;; spaces only, and to only add them at places where there was already at
850 ;; least one space. This way, as long as `dired-move-to-filename-regexp'
851 ;; always matches spaces with "*" or "+", we know we haven't made anything
852 ;; worse. There is one spot where the exact number of spaces is
853 ;; important, which is just before the actual filename, so we refrain from
854 ;; adding spaces there (and within the filename as well, of course).
857 ;; Check the there is indeed a file, and that there is anoter adjacent
858 ;; file with which to align, and that additional spaces are needed to
859 ;; align the filenames.
872 ;; Make sure there is some work left to do.
874 ;; If we've only looked at the line above, check to see if the line
875 ;; below exists as well and if so, align with the shorter one.
884 ;; Keep positions uptodate when we insert stuff.
887 ;; Main loop.
891 ;; Don't touch anything just before (and after) the
892 ;; beginning of the filename.
894 ;; We're now just in front of a field, with a space behind us.
896 ;; Nums are right-aligned.
898 ;; Let's look at the other line, in the same column: we
899 ;; should be either near the end of the previous field, or
900 ;; in the space between that field and the next.
901 ;; [ Of course, it's also possible that we're already within
902 ;; the next field or even past it, but that's unlikely since
903 ;; other-col > file-col. ]
904 ;; Let's find the distance to the alignment-point (either
905 ;; the beginning or the end of the next field, depending on
906 ;; whether this field is left or right aligned).
916 ;; Now, the number of spaces to insert is align-pt-offset
917 ;; minus the distance to the equivalent point on the
918 ;; current line.
921 align-pt-offset
931 ;; Let's just make really sure we did not mess up.
934 ;; Damn! We messed up: let's revert the change.
936 ;; Now skip to next field.
942 "Insert a directory listing of DIR, Dired style.
943 Use SWITCHES to make the listings.
944 If FILE-LIST is non-nil, list only those files.
945 Otherwise, if WILDCARD is non-nil, expand wildcards;
946 in that case, DIR should be a file name that uses wildcards.
947 In other cases, DIR should be a directory name or a directory filename.
948 If HDR is non-nil, insert a header line with the directory name."
951 end)
954 ;; We used to specify the C locale here, to force English month names;
955 ;; but this should not be necessary any more,
956 ;; with the new value of dired-move-to-filename-regexp.
961 ;; Re-align fields, if necessary.
964 ;; Quote certain characters, unless ls quoted them for us.
973 nil t))
979 nil t))
982 ;; If we used --dired and it worked, the lines are already indented.
983 ;; Otherwise, indent them.
989 ;; Insert text at the beginning to standardize things.
993 ;; Note that dired-build-subdir-alist will replace the name
994 ;; by its expansion, so it does not matter whether what we insert
995 ;; here is fully expanded, but it should be absolute.
998 ;; Insert "wildcard" line where "total" line would be for a full dir.
1002 "Make the file names highlight when the mouse is on them."
1017 \f
1018 ;; Reverting a dired buffer
1021 "Reread the dired buffer.
1022 Must also be called after `dired-actual-switches' have changed.
1023 Should not fail even on completely garbaged buffers.
1024 Preserves old cursor, marks/flags, hidden-p."
1033 buffer-read-only)
1037 ;; treat top level dir extra (it may contain wildcards)
1042 ;; don't run that hook for each subdir...
1045 ;; ... run the hook for the whole buffer, and only after markers
1046 ;; have been reinserted (else omitting in dired-x would omit marked files)
1056 ;; outside of the let scope
1057 ;;; Might as well not override the user if the user changed this.
1058 ;;; (setq buffer-read-only t)
1059 )
1061 ;; Subroutines of dired-revert
1062 ;; Some of these are also used when inserting subdirs.
1065 "Return alist of files and their marks, from BEG to END."
1076 alist))
1079 "Mark all files remembered in ALIST.
1080 Each element of ALIST looks like (FILE . MARKERCHAR)."
1094 "Return a list of names of subdirs currently hidden."
1104 result))
1107 "Try to insert all subdirs that were displayed before.
1108 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1122 "Remove directory DIR from any directory cache."
1126 \f
1127 ;; dired mode key bindings and initialization
1130 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1131 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1136 ;; Commands to mark or flag certain categories of files
1141 ;; Upper case keys (except !) for operating on the marked files
1159 ;; Comparison commands
1162 ;; Tree Dired commands
1168 ;; move to marked files
1171 ;; Make all regexp commands share a `%' prefix:
1172 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1173 ;; but that seems to serve little purpose, and copy-keymap
1174 ;; does a better job without it.
1186 ;; Commands for marking and unmarking.
1203 ;; Lower keys for commands not operating on all the marked files
1229 ;; moving
1237 (define-key map [up] 'dired-previous-line)
1238 ;; hiding
1239 (define-key map "$" 'dired-hide-subdir)
1240 (define-key map "\M-$" 'dired-hide-all)
1241 ;; misc
1242 (define-key map "?" 'dired-summary)
1244 (define-key map [remap undo] 'dired-undo)
1245 (define-key map [remap advertised-undo] 'dired-undo)
1247 ;; Make menu bar items.
1249 ;; No need to fo this, now that top-level items are fewer.
1250 ;;;;
1251 ;; Get rid of the Edit menu bar item to save space.
1252 ;(define-key map [menu-bar edit] 'undefined)
1254 (define-key map [menu-bar subdir]
1255 (cons "Subdir" (make-sparse-keymap "Subdir")))
1257 (define-key map [menu-bar subdir hide-all]
1258 '(menu-item "Hide All" dired-hide-all
1259 :help "Hide all subdirectories, leave only header lines"))
1260 (define-key map [menu-bar subdir hide-subdir]
1261 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1262 :help "Hide or unhide current directory listing"))
1263 (define-key map [menu-bar subdir tree-down]
1264 '(menu-item "Tree Down" dired-tree-down
1265 :help "Go to first subdirectory header down the tree"))
1266 (define-key map [menu-bar subdir tree-up]
1267 '(menu-item "Tree Up" dired-tree-up
1268 :help "Go to first subdirectory header up the tree"))
1269 (define-key map [menu-bar subdir up]
1270 '(menu-item "Up Directory" dired-up-directory
1271 :help "Edit the parent directory"))
1272 (define-key map [menu-bar subdir prev-subdir]
1273 '(menu-item "Prev Subdir" dired-prev-subdir
1274 :help "Go to previous subdirectory header line"))
1275 (define-key map [menu-bar subdir next-subdir]
1276 '(menu-item "Next Subdir" dired-next-subdir
1277 :help "Go to next subdirectory header line"))
1278 (define-key map [menu-bar subdir prev-dirline]
1279 '(menu-item "Prev Dirline" dired-prev-dirline
1280 :help "Move to next directory-file line"))
1281 (define-key map [menu-bar subdir next-dirline]
1282 '(menu-item "Next Dirline" dired-next-dirline
1283 :help "Move to previous directory-file line"))
1284 (define-key map [menu-bar subdir insert]
1285 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1286 :help "Insert contents of subdirectory"))
1288 (define-key map [menu-bar immediate]
1289 (cons "Immediate" (make-sparse-keymap "Immediate")))
1291 (define-key map [menu-bar immediate revert-buffer]
1292 '(menu-item "Refresh" revert-buffer
1293 :help "Update contents of shown directories"))
1295 (define-key map [menu-bar immediate dashes]
1296 '("--"))
1298 (define-key map [menu-bar immediate compare-directories]
1299 '(menu-item "Compare directories..." dired-compare-directories
1300 :help "Mark files with different attributes in two dired buffers"))
1301 (define-key map [menu-bar immediate backup-diff]
1302 '(menu-item "Compare with Backup" dired-backup-diff
1303 :help "Diff file at cursor with its latest backup"))
1304 (define-key map [menu-bar immediate diff]
1305 '(menu-item "Diff..." dired-diff
1306 :help "Compare file at cursor with another file"))
1307 (define-key map [menu-bar immediate view]
1308 '(menu-item "View This File" dired-view-file
1309 :help "Examine file at cursor in read-only mode"))
1310 (define-key map [menu-bar immediate display]
1311 '(menu-item "Display in Other Window" dired-display-file
1312 :help "Display file at cursor in other window"))
1313 (define-key map [menu-bar immediate find-file-other-window]
1314 '(menu-item "Find in Other Window" dired-find-file-other-window
1315 :help "Edit file at cursor in other window"))
1316 (define-key map [menu-bar immediate find-file]
1317 '(menu-item "Find This File" dired-find-file
1318 :help "Edit file at cursor"))
1319 (define-key map [menu-bar immediate create-directory]
1320 '(menu-item "Create Directory..." dired-create-directory))
1321 (define-key map [menu-bar immediate wdired-mode]
1322 '(menu-item "Edit File Names" wdired-change-to-wdired-mode))
1324 (define-key map [menu-bar regexp]
1325 (cons "Regexp" (make-sparse-keymap "Regexp")))
1327 (define-key map [menu-bar regexp downcase]
1328 '(menu-item "Downcase" dired-downcase
1329 ;; When running on plain MS-DOS, there's only one
1330 ;; letter-case for file names.
1331 :enable (or (not (fboundp 'msdos-long-file-names))
1332 (msdos-long-file-names))
1333 :help "Rename marked files to lower-case name"))
1334 (define-key map [menu-bar regexp upcase]
1335 '(menu-item "Upcase" dired-upcase
1336 :enable (or (not (fboundp 'msdos-long-file-names))
1337 (msdos-long-file-names))
1338 :help "Rename marked files to upper-case name"))
1339 (define-key map [menu-bar regexp hardlink]
1340 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1341 :help "Make hard links for files matching regexp"))
1342 (define-key map [menu-bar regexp symlink]
1343 '(menu-item "Symlink..." dired-do-symlink-regexp
1344 :visible (fboundp 'make-symbolic-link)
1345 :help "Make symbolic links for files matching regexp"))
1346 (define-key map [menu-bar regexp rename]
1347 '(menu-item "Rename..." dired-do-rename-regexp
1348 :help "Rename marked files matching regexp"))
1349 (define-key map [menu-bar regexp copy]
1350 '(menu-item "Copy..." dired-do-copy-regexp
1351 :help "Copy marked files matching regexp"))
1352 (define-key map [menu-bar regexp flag]
1353 '(menu-item "Flag..." dired-flag-files-regexp
1354 :help "Flag files matching regexp for deletion"))
1355 (define-key map [menu-bar regexp mark]
1356 '(menu-item "Mark..." dired-mark-files-regexp
1357 :help "Mark files matching regexp for future operations"))
1358 (define-key map [menu-bar regexp mark-cont]
1359 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1360 :help "Mark files whose contents matches regexp"))
1362 (define-key map [menu-bar mark]
1363 (cons "Mark" (make-sparse-keymap "Mark")))
1365 (define-key map [menu-bar mark prev]
1366 '(menu-item "Previous Marked" dired-prev-marked-file
1367 :help "Move to previous marked file"))
1368 (define-key map [menu-bar mark next]
1369 '(menu-item "Next Marked" dired-next-marked-file
1370 :help "Move to next marked file"))
1371 (define-key map [menu-bar mark marks]
1372 '(menu-item "Change Marks..." dired-change-marks
1373 :help "Replace marker with another character"))
1374 (define-key map [menu-bar mark unmark-all]
1375 '(menu-item "Unmark All" dired-unmark-all-marks))
1376 (define-key map [menu-bar mark symlinks]
1377 '(menu-item "Mark Symlinks" dired-mark-symlinks
1378 :visible (fboundp 'make-symbolic-link)
1379 :help "Mark all symbolic links"))
1380 (define-key map [menu-bar mark directories]
1381 '(menu-item "Mark Directories" dired-mark-directories
1382 :help "Mark all directories except `.' and `..'"))
1383 (define-key map [menu-bar mark directory]
1384 '(menu-item "Mark Old Backups" dired-clean-directory
1385 :help "Flag old numbered backups for deletion"))
1386 (define-key map [menu-bar mark executables]
1387 '(menu-item "Mark Executables" dired-mark-executables
1388 :help "Mark all executable files"))
1389 (define-key map [menu-bar mark garbage-files]
1390 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1391 :help "Flag unneeded files for deletion"))
1392 (define-key map [menu-bar mark backup-files]
1393 '(menu-item "Flag Backup Files" dired-flag-backup-files
1394 :help "Flag all backup files for deletion"))
1395 (define-key map [menu-bar mark auto-save-files]
1396 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1397 :help "Flag auto-save files for deletion"))
1398 (define-key map [menu-bar mark deletion]
1399 '(menu-item "Flag" dired-flag-file-deletion
1400 :help "Flag current line's file for deletion"))
1401 (define-key map [menu-bar mark unmark]
1402 '(menu-item "Unmark" dired-unmark
1403 :help "Unmark or unflag current line's file"))
1404 (define-key map [menu-bar mark mark]
1405 '(menu-item "Mark" dired-mark
1406 :help "Mark current line's file for future operations"))
1407 (define-key map [menu-bar mark toggle-marks]
1408 '(menu-item "Toggle Marks" dired-toggle-marks
1409 :help "Mark unmarked files, unmark marked ones"))
1411 (define-key map [menu-bar operate]
1412 (cons "Operate" (make-sparse-keymap "Operate")))
1414 (define-key map [menu-bar operate query-replace]
1415 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1416 :help "Replace regexp in marked files"))
1417 (define-key map [menu-bar operate search]
1418 '(menu-item "Search Files..." dired-do-search
1419 :help "Search marked files for regexp"))
1420 (define-key map [menu-bar operate chown]
1421 '(menu-item "Change Owner..." dired-do-chown
1422 :visible (not (memq system-type '(ms-dos windows-nt)))
1423 :help "Change the owner of marked files"))
1424 (define-key map [menu-bar operate chgrp]
1425 '(menu-item "Change Group..." dired-do-chgrp
1426 :visible (not (memq system-type '(ms-dos windows-nt)))
1427 :help "Change the group of marked files"))
1428 (define-key map [menu-bar operate chmod]
1429 '(menu-item "Change Mode..." dired-do-chmod
1430 :help "Change mode (attributes) of marked files"))
1431 (define-key map [menu-bar operate touch]
1432 '(menu-item "Change Timestamp..." dired-do-touch
1433 :help "Change timestamp of marked files"))
1434 (define-key map [menu-bar operate load]
1435 '(menu-item "Load" dired-do-load
1436 :help "Load marked Emacs Lisp files"))
1437 (define-key map [menu-bar operate compile]
1438 '(menu-item "Byte-compile" dired-do-byte-compile
1439 :help "Byte-compile marked Emacs Lisp files"))
1440 (define-key map [menu-bar operate compress]
1441 '(menu-item "Compress" dired-do-compress
1442 :help "Compress/uncompress marked files"))
1443 (define-key map [menu-bar operate print]
1444 '(menu-item "Print..." dired-do-print
1445 :help "Ask for print command and print marked files"))
1446 (define-key map [menu-bar operate hardlink]
1447 '(menu-item "Hardlink to..." dired-do-hardlink
1448 :help "Make hard links for current or marked files"))
1449 (define-key map [menu-bar operate symlink]
1450 '(menu-item "Symlink to..." dired-do-symlink
1451 :visible (fboundp 'make-symbolic-link)
1452 :help "Make symbolic links for current or marked files"))
1453 (define-key map [menu-bar operate command]
1454 '(menu-item "Shell Command..." dired-do-shell-command
1455 :help "Run a shell command on each of marked files"))
1456 (define-key map [menu-bar operate delete]
1457 '(menu-item "Delete" dired-do-delete
1458 :help "Delete current file or all marked files"))
1459 (define-key map [menu-bar operate rename]
1460 '(menu-item "Rename to..." dired-do-rename
1461 :help "Rename current file or move marked files"))
1462 (define-key map [menu-bar operate copy]
1463 '(menu-item "Copy to..." dired-do-copy
1464 :help "Copy current file or all marked files"))
1466 map)
1467 "Local keymap for `dired-mode' buffers.")
1468 \f
1469 ;; Dired mode is suitable only for specially formatted data.
1470 (put 'dired-mode 'mode-class 'special)
1472 ;; Autoload cookie needed by desktop.el
1473 ;;;###autoload
1474 (defun dired-mode (&optional dirname switches)
1475 "\
1478 \(optionally) its subdirectories, in the format of `ls -lR'.
1481 compress, load or byte-compile them, change their file attributes
1484 by file or all files matching certain criteria.
1486 Letters no longer insert themselves. Digits are prefix arguments.
1489 Most commands operate on the marked files and use the current file
1490 if no files are marked. Use a numeric prefix argument to operate on
1491 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1492 to operate on the current file only. Prefix arguments override marks.
1494 to see why something went wrong.
1499 (or dired it in another buffer, if it is a directory).
1506 This retains all marks and hides subdirs again that were hidden before.
1507 SPC and DEL can be used to move down and up by lines.
1510 to read the
1512 to relist a single or the marked files or a
1514 again for the directory tree.
1517 for more info):
1519 `dired-listing-switches'
1520 `dired-trivial-filenames'
1521 `dired-shrink-to-fit'
1522 `dired-marker-char'
1523 `dired-del-marker'
1524 `dired-keep-marker-rename'
1525 `dired-keep-marker-copy'
1526 `dired-keep-marker-hardlink'
1527 `dired-keep-marker-symlink'
1531 `dired-before-readin-hook'
1532 `dired-after-readin-hook'
1533 `dired-mode-hook'
1534 `dired-load-hook'
1536 Keybindings:
1538 ;; Not to be called interactively (e.g. dired-directory will be set
1539 ;; to default-directory, which is wrong with wildcards).
1540 (kill-all-local-variables)
1541 (use-local-map dired-mode-map)
1542 (dired-advertise) ; default-directory is already set
1543 (setq major-mode 'dired-mode
1544 mode-name "Dired"
1545 ;; case-fold-search nil
1546 buffer-read-only t
1547 selective-display t ; for subdirectory hiding
1548 mode-line-buffer-identification
1549 (propertized-buffer-identification "%17b"))
1550 (set (make-local-variable 'revert-buffer-function)
1551 (function dired-revert))
1552 (set (make-local-variable 'buffer-stale-function)
1553 (function dired-buffer-stale-p))
1554 (set (make-local-variable 'page-delimiter)
1556 (set (make-local-variable 'dired-directory)
1557 (or dirname default-directory))
1558 ;; list-buffers uses this to display the dir being edited in this buffer.
1559 (set (make-local-variable 'list-buffers-directory)
1560 (expand-file-name (if (listp dired-directory)
1561 (car dired-directory)
1562 dired-directory)))
1563 (set (make-local-variable 'dired-actual-switches)
1564 (or switches dired-listing-switches))
1565 (set (make-local-variable 'font-lock-defaults)
1566 '(dired-font-lock-keywords t nil nil beginning-of-line))
1567 (set (make-local-variable 'desktop-save-buffer)
1568 'dired-desktop-buffer-misc-data)
1569 (setq dired-switches-alist nil)
1570 (dired-sort-other dired-actual-switches t)
1571 (when (featurep 'dnd)
1572 (set (make-local-variable 'dnd-protocol-alist)
1573 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1574 (run-mode-hooks 'dired-mode-hook))
1575 \f
1576 ;; Idiosyncratic dired commands that don't deal with marks.
1578 (defun dired-summary ()
1579 "Summarize basic Dired commands and show recent dired errors."
1580 (interactive)
1581 (dired-why)
1582 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1583 (message
1584 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1586 (defun dired-undo ()
1587 "Undo in a dired buffer.
1588 This doesn't recover lost files, it just undoes changes in the buffer itself.
1589 You can use it to recover marks, killed lines or subdirs."
1590 (interactive)
1591 (let (buffer-read-only)
1592 (undo))
1593 (dired-build-subdir-alist)
1594 (message "Change in dired buffer undone.
1595 Actual changes in files cannot be undone by Emacs."))
1597 (defun dired-next-line (arg)
1598 "Move down lines then position at filename.
1599 Optional prefix ARG says how many lines to move; default is one line."
1600 (interactive "p")
1601 (next-line arg)
1602 (dired-move-to-filename))
1604 (defun dired-previous-line (arg)
1605 "Move up lines then position at filename.
1606 Optional prefix ARG says how many lines to move; default is one line."
1607 (interactive "p")
1608 (previous-line arg)
1609 (dired-move-to-filename))
1611 (defun dired-next-dirline (arg &optional opoint)
1612 "Goto ARG'th next directory file line."
1613 (interactive "p")
1614 (or opoint (setq opoint (point)))
1615 (if (if (> arg 0)
1616 (re-search-forward dired-re-dir nil t arg)
1617 (beginning-of-line)
1618 (re-search-backward dired-re-dir nil t (- arg)))
1619 (dired-move-to-filename) ; user may type `i' or `f'
1620 (goto-char opoint)
1621 (error "No more subdirectories")))
1623 (defun dired-prev-dirline (arg)
1624 "Goto ARG'th previous directory file line."
1625 (interactive "p")
1626 (dired-next-dirline (- arg)))
1628 (defun dired-up-directory (&optional other-window)
1629 "Run Dired on parent directory of current directory.
1630 Find the parent directory either in this buffer or another buffer.
1631 Creates a buffer if necessary."
1632 (interactive "P")
1633 (let* ((dir (dired-current-directory))
1634 (up (file-name-directory (directory-file-name dir))))
1635 (or (dired-goto-file (directory-file-name dir))
1636 ;; Only try dired-goto-subdir if buffer has more than one dir.
1637 (and (cdr dired-subdir-alist)
1638 (dired-goto-subdir up))
1639 (progn
1640 (if other-window
1641 (dired-other-window up)
1642 (dired up))
1643 (dired-goto-file dir)))))
1645 (defun dired-get-file-for-visit ()
1646 "Get the current line's file name, with an error if file does not exist."
1647 (interactive)
1648 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1649 (let ((raw (dired-get-filename nil t))
1650 file-name)
1651 (if (null raw)
1652 (error "No file on this line"))
1653 (setq file-name (file-name-sans-versions raw t))
1654 (if (file-exists-p file-name)
1655 file-name
1656 (if (file-symlink-p file-name)
1657 (error "File is a symlink to a nonexistent target")
1658 (error "File no longer exists; type `g' to update dired buffer")))))
1660 ;; Force `f' rather than `e' in the mode doc:
1661 (defalias 'dired-advertised-find-file 'dired-find-file)
1662 (defun dired-find-file ()
1663 "In Dired, visit the file or directory named on this line."
1664 (interactive)
1665 ;; Bind `find-file-run-dired' so that the command works on directories
1666 ;; too, independent of the user's setting.
1667 (let ((find-file-run-dired t))
1668 (find-file (dired-get-file-for-visit))))
1670 (defun dired-find-alternate-file ()
1671 "In Dired, visit this file or directory instead of the dired buffer."
1672 (interactive)
1673 (set-buffer-modified-p nil)
1674 (find-alternate-file (dired-get-file-for-visit)))
1675 ;; Don't override the setting from .emacs.
1676 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1678 (defun dired-mouse-find-file-other-window (event)
1679 "In Dired, visit the file or directory name you click on."
1680 (interactive "e")
1681 (let (window pos file)
1682 (save-excursion
1683 (setq window (posn-window (event-end event))
1684 pos (posn-point (event-end event)))
1685 (if (not (windowp window))
1686 (error "No file chosen"))
1687 (set-buffer (window-buffer window))
1688 (goto-char pos)
1689 (setq file (dired-get-file-for-visit)))
1690 (if (file-directory-p file)
1691 (or (and (cdr dired-subdir-alist)
1692 (dired-goto-subdir file))
1693 (progn
1694 (select-window window)
1695 (dired-other-window file)))
1696 (select-window window)
1697 (find-file-other-window (file-name-sans-versions file t)))))
1699 (defun dired-view-file ()
1700 "In Dired, examine a file in view mode, returning to Dired when done.
1701 When file is a directory, show it in this buffer if it is inserted.
1702 Otherwise, display it in another buffer."
1703 (interactive)
1704 (let ((file (dired-get-file-for-visit)))
1705 (if (file-directory-p file)
1706 (or (and (cdr dired-subdir-alist)
1707 (dired-goto-subdir file))
1708 (dired file))
1709 (view-file file))))
1711 (defun dired-find-file-other-window ()
1712 "In Dired, visit this file or directory in another window."
1713 (interactive)
1714 (find-file-other-window (dired-get-file-for-visit)))
1716 (defun dired-display-file ()
1717 "In Dired, display this file or directory in another window."
1718 (interactive)
1719 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1720 \f
1721 ;;; Functions for extracting and manipulating file names in Dired buffers.
1723 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1724 "In Dired, return name of file mentioned on this line.
1725 Value returned normally includes the directory name.
1726 Optional arg LOCALP with value `no-dir' means don't include directory
1727 name in result. A value of `verbatim' means to return the name exactly as
1728 it occurs in the buffer, and a value of t means construct name relative to
1729 `default-directory', which still may contain slashes if in a subdirectory.
1730 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1731 regular filenames and return nil if no filename on this line.
1732 Otherwise, an error occurs in these cases."
1733 (let (case-fold-search file p1 p2 already-absolute)
1734 (save-excursion
1735 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1736 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1737 ;; nil if no file on this line, but no-error-if-not-filep is t:
1738 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1739 (progn
1740 ;; Get rid of the mouse-face property that file names have.
1741 (set-text-properties 0 (length file) nil file)
1742 ;; Unquote names quoted by ls or by dired-insert-directory.
1743 ;; Using read to unquote is much faster than substituting
1745 (setq file
1746 (read
1748 ;; Some ls -b don't escape quotes, argh!
1749 ;; This is not needed for GNU ls, though.
1750 (or (dired-string-replace-match
1752 file)
1754 ;; The above `read' will return a unibyte string if FILE
1755 ;; contains eight-bit-control/graphic characters.
1756 (if (and enable-multibyte-characters
1757 (not (multibyte-string-p file)))
1758 (setq file (string-to-multibyte file)))))
1759 (and file (file-name-absolute-p file)
1760 ;; A relative file name can start with ~.
1761 ;; Don't treat it as absolute in this context.
1762 (not (eq (aref file 0) ?~))
1763 (setq already-absolute t))
1764 (cond
1765 ((null file)
1766 nil)
1767 ((eq localp 'verbatim)
1768 file)
1769 ((and (not no-error-if-not-filep)
1770 (member file '("." "..")))
1771 (error "Cannot operate on `.' or `..'"))
1772 ((and (eq localp 'no-dir) already-absolute)
1773 (file-name-nondirectory file))
1774 (already-absolute
1775 (let ((handler (find-file-name-handler file nil)))
1776 ;; check for safe-magic property so that we won't
1777 ;; put /: for names that don't really need them.
1778 ;; For instance, .gz files when auto-compression-mode is on.
1779 (if (and handler (not (get handler 'safe-magic)))
1780 (concat "/:" file)
1781 file)))
1782 ((eq localp 'no-dir)
1783 file)
1784 ((equal (dired-current-directory) "/")
1785 (setq file (concat (dired-current-directory localp) file))
1786 (let ((handler (find-file-name-handler file nil)))
1787 ;; check for safe-magic property so that we won't
1788 ;; put /: for names that don't really need them.
1789 ;; For instance, .gz files when auto-compression-mode is on.
1790 (if (and handler (not (get handler 'safe-magic)))
1791 (concat "/:" file)
1792 file)))
1793 (t
1794 (concat (dired-current-directory localp) file)))))
1796 (defun dired-string-replace-match (regexp string newtext
1797 &optional literal global)
1798 "Replace first match of REGEXP in STRING with NEWTEXT.
1799 If it does not match, nil is returned instead of the new string.
1800 Optional arg LITERAL means to take NEWTEXT literally.
1801 Optional arg GLOBAL means to replace all matches."
1802 (if global
1803 (let ((start 0) ret)
1804 (while (string-match regexp string start)
1805 (let ((from-end (- (length string) (match-end 0))))
1806 (setq ret (setq string (replace-match newtext t literal string)))
1807 (setq start (- (length string) from-end))))
1808 ret)
1809 (if (not (string-match regexp string 0))
1810 nil
1811 (replace-match newtext t literal string))))
1813 (defun dired-make-absolute (file &optional dir)
1814 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1815 ;; We can't always use expand-file-name as this would get rid of `.'
1816 ;; or expand in / instead default-directory if DIR=="".
1817 ;; This should be good enough for ange-ftp, but might easily be
1818 ;; redefined (for VMS?).
1819 ;; It should be reasonably fast, though, as it is called in
1820 ;; dired-get-filename.
1821 (concat (or dir default-directory) file))
1823 (defun dired-make-relative (file &optional dir ignore)
1824 "Convert FILE (an absolute file name) to a name relative to DIR.
1825 If this is impossible, return FILE unchanged.
1826 DIR must be a directory name, not a file name."
1827 (or dir (setq dir default-directory))
1828 ;; This case comes into play if default-directory is set to
1829 ;; use ~.
1830 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1831 (setq dir (expand-file-name dir)))
1832 (if (string-match (concat "^" (regexp-quote dir)) file)
1833 (substring file (match-end 0))
1834 ;;; (or no-error
1835 ;;; (error "%s: not in directory tree growing at %s" file dir))
1836 file))
1837 \f
1838 ;;; Functions for finding the file name in a dired buffer line.
1840 (defvar dired-move-to-filename-regexp
1843 ;; In some locales, month abbreviations are as short as 2 letters,
1844 ;; and they can be followed by ".".
1845 ;; In Breton, a month name can include a quote character.
1847 (s " ")
1848 (yyyy "[0-9][0-9][0-9][0-9]")
1849 (dd "[ 0-3][0-9]")
1850 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
1852 (zone "[-+][0-2][0-9][0-5][0-9]")
1853 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
1858 s "+"
1860 (western-comma (concat month s "+" dd "," s "+" yyyy))
1861 ;; Japanese MS-Windows ls-lisp has one-digit months, and
1862 ;; omits the Kanji characters after month and day-of-month.
1863 (mm "[ 0-1]?[0-9]")
1864 (japanese
1865 (concat mm l "?" s dd l "?" s "+"
1867 ;; The "[0-9]" below requires the previous column to end in a digit.
1868 ;; This avoids recognizing `1 may 1997' as a date in the line:
1869 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
1870 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
1871 ;; The ".*" below finds the last match if there are multiple matches.
1872 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
1873 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
1874 (concat ".*[0-9][BkKMGTPEZY]?" s
1876 s "+"))
1877 "Regular expression to match up to the file name in a directory listing.
1878 The default value is designed to recognize dates and times
1879 regardless of the language.")
1881 (defvar dired-permission-flags-regexp
1883 "Regular expression to match the permission flags in `ls -l'.")
1885 ;; Move to first char of filename on this line.
1886 ;; Returns position (point) or nil if no filename on this line."
1887 (defun dired-move-to-filename (&optional raise-error eol)
1888 "Move to the beginning of the filename on the current line.
1889 Return the position of the beginning of the filename, or nil if none found."
1890 ;; This is the UNIX version.
1891 (or eol (setq eol (line-end-position)))
1892 (beginning-of-line)
1893 ;; First try assuming `ls --dired' was used.
1894 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1895 (cond
1896 ((and change (< change eol))
1897 (goto-char change))
1898 ((re-search-forward dired-move-to-filename-regexp eol t)
1899 (goto-char (match-end 0)))
1900 ((re-search-forward dired-permission-flags-regexp eol t)
1901 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1902 (if raise-error
1903 (error "Unrecognized line! Check dired-move-to-filename-regexp"))
1904 (beginning-of-line)
1905 nil)
1906 (raise-error
1907 (error "No file on this line")))))
1909 (defun dired-move-to-end-of-filename (&optional no-error)
1910 ;; Assumes point is at beginning of filename,
1911 ;; thus the rwx bit re-search-backward below will succeed in *this*
1912 ;; line if at all. So, it should be called only after
1913 ;; (dired-move-to-filename t).
1914 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1915 ;; This is the UNIX version.
1916 (if (get-text-property (point) 'dired-filename)
1917 (goto-char (next-single-property-change (point) 'dired-filename))
1918 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1919 ;; case-fold-search is nil now, so we can test for capital F:
1920 (setq used-F (string-match "F" dired-actual-switches)
1921 opoint (point)
1922 eol (save-excursion (end-of-line) (point))
1923 hidden (and selective-display
1925 (if hidden
1926 nil
1927 (save-excursion ;; Find out what kind of file this is:
1928 ;; Restrict perm bits to be non-blank,
1929 ;; otherwise this matches one char to early (looking backward):
1930 ;; "l---------" (some systems make symlinks that way)
1931 ;; "----------" (plain file with zero perms)
1932 (if (re-search-backward
1933 dired-permission-flags-regexp nil t)
1934 (setq file-type (char-after (match-beginning 1))
1935 symlink (eq file-type ?l)
1936 ;; Only with -F we need to know whether it's an executable
1937 executable (and
1938 used-F
1939 (string-match
1940 "[xst]" ;; execute bit set anywhere?
1941 (concat
1942 (match-string 2)
1943 (match-string 3)
1944 (match-string 4)))))
1945 (or no-error (error "No file on this line"))))
1946 ;; Move point to end of name:
1947 (if symlink
1948 (if (search-forward " -> " eol t)
1949 (progn
1950 (forward-char -4)
1951 (and used-F
1952 dired-ls-F-marks-symlinks
1953 (eq (preceding-char) ?@) ;; did ls really mark the link?
1954 (forward-char -1))))
1955 (goto-char eol) ;; else not a symbolic link
1956 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
1957 ;; one trailing character. (Executable bits on symlinks ain't mean
1958 ;; a thing, even to ls, but we know it's not a symlink.)
1959 (and used-F
1960 (or (memq file-type '(?d ?s ?p))
1961 executable)
1962 (forward-char -1))))
1963 (or no-error
1964 (not (eq opoint (point)))
1965 (error (if hidden
1966 (substitute-command-keys
1968 "No file on this line")))
1969 (if (eq opoint (point))
1970 nil
1971 (point)))))
1973 \f
1974 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
1976 (defun dired-copy-filename-as-kill (&optional arg)
1977 "Copy names of marked (or next ARG) files into the kill ring.
1978 The names are separated by a space.
1979 With a zero prefix arg, use the absolute file name of each marked file.
1981 `default-directory'. (This still may contain slashes if in a subdirectory.)
1983 If on a subdir headerline, use absolute subdirname instead;
1984 prefix arg and marked files are ignored in this case.
1987 (interactive "P")
1988 (let ((string
1989 (or (dired-get-subdir)
1990 (mapconcat (function identity)
1991 (if arg
1992 (cond ((zerop (prefix-numeric-value arg))
1993 (dired-get-marked-files))
1994 ((consp arg)
1995 (dired-get-marked-files t))
1996 (t
1997 (dired-get-marked-files
1998 'no-dir (prefix-numeric-value arg))))
1999 (dired-get-marked-files 'no-dir))
2000 " "))))
2001 (if (eq last-command 'kill-region)
2002 (kill-append string nil)
2003 (kill-new string))
2004 (message "%s" string)))
2006 \f
2007 ;; Keeping Dired buffers in sync with the filesystem and with each other
2009 (defun dired-buffers-for-dir (dir &optional file)
2010 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2011 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2012 ;; matches FILE.
2013 ;; The list is in reverse order of buffer creation, most recent last.
2014 ;; As a side effect, killed dired buffers for DIR are removed from
2015 ;; dired-buffers.
2016 (setq dir (file-name-as-directory dir))
2017 (let ((alist dired-buffers) result elt buf)
2018 (while alist
2019 (setq elt (car alist)
2020 buf (cdr elt))
2021 (if (buffer-name buf)
2022 (if (dired-in-this-tree dir (car elt))
2023 (with-current-buffer buf
2024 (and (assoc dir dired-subdir-alist)
2025 (or (null file)
2026 (let ((wildcards
2027 (file-name-nondirectory dired-directory)))
2028 (or (= 0 (length wildcards))
2029 (string-match (dired-glob-regexp wildcards)
2030 file))))
2031 (setq result (cons buf result)))))
2032 ;; else buffer is killed - clean up:
2033 (setq dired-buffers (delq elt dired-buffers)))
2034 (setq alist (cdr alist)))
2035 result))
2037 (defun dired-glob-regexp (pattern)
2038 "Convert glob-pattern PATTERN to a regular expression."
2039 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2040 regexp)
2041 (while (string-match "[[?*]" pattern matched-in-pattern)
2042 (let ((op-end (match-end 0))
2043 (next-op (aref pattern (match-beginning 0))))
2044 (setq regexp (concat regexp
2045 (regexp-quote
2046 (substring pattern matched-in-pattern
2047 (match-beginning 0)))))
2048 (cond ((= next-op ??)
2049 (setq regexp (concat regexp "."))
2050 (setq matched-in-pattern op-end))
2051 ((= next-op ?\[)
2052 ;; Fails to handle ^ yet ????
2053 (let* ((set-start (match-beginning 0))
2054 (set-cont
2055 (if (= (aref pattern (1+ set-start)) ?^)
2056 (+ 3 set-start)
2057 (+ 2 set-start)))
2058 (set-end (string-match "]" pattern set-cont))
2059 (set (substring pattern set-start (1+ set-end))))
2060 (setq regexp (concat regexp set))
2061 (setq matched-in-pattern (1+ set-end))))
2062 ((= next-op ?*)
2063 (setq regexp (concat regexp ".*"))
2064 (setq matched-in-pattern op-end)))))
2066 regexp
2067 (regexp-quote
2068 (substring pattern matched-in-pattern))
2073 (defun dired-advertise ()
2074 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2075 ;; With wildcards we actually advertise too much.
2076 (let ((expanded-default (expand-file-name default-directory)))
2077 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2078 t ; we have already advertised ourselves
2079 (setq dired-buffers
2080 (cons (cons expanded-default (current-buffer))
2081 dired-buffers)))))
2083 (defun dired-unadvertise (dir)
2084 ;; Remove DIR from the buffer alist in variable dired-buffers.
2085 ;; This has the effect of removing any buffer whose main directory is DIR.
2086 ;; It does not affect buffers in which DIR is a subdir.
2087 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2088 (setq dired-buffers
2089 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2090 \f
2091 ;; Tree Dired
2093 ;;; utility functions
2095 (defun dired-in-this-tree (file dir)
2096 ;;"Is FILE part of the directory tree starting at DIR?"
2097 (let (case-fold-search)
2098 (string-match (concat "^" (regexp-quote dir)) file)))
2100 (defun dired-normalize-subdir (dir)
2101 ;; Prepend default-directory to DIR if relative file name.
2102 ;; dired-get-filename must be able to make a valid file name from a
2103 ;; file and its directory DIR.
2104 (file-name-as-directory
2105 (if (file-name-absolute-p dir)
2106 dir
2107 (expand-file-name dir default-directory))))
2109 (defun dired-get-subdir ()
2110 ;;"Return the subdir name on this line, or nil if not on a headerline."
2111 ;; Look up in the alist whether this is a headerline.
2112 (save-excursion
2113 (let ((cur-dir (dired-current-directory)))
2114 (beginning-of-line) ; alist stores b-o-l positions
2115 (and (zerop (- (point)
2116 (dired-get-subdir-min (assoc cur-dir
2117 dired-subdir-alist))))
2118 cur-dir))))
2120 ;(defun dired-get-subdir-min (elt)
2121 ; (cdr elt))
2122 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2123 (defalias 'dired-get-subdir-min 'cdr)
2125 (defun dired-get-subdir-max (elt)
2126 (save-excursion
2127 (goto-char (dired-get-subdir-min elt))
2128 (dired-subdir-max)))
2130 (defun dired-clear-alist ()
2131 (while dired-subdir-alist
2132 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2133 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2135 (defun dired-subdir-index (dir)
2136 ;; Return an index into alist for use with nth
2137 ;; for the sake of subdir moving commands.
2138 (let (found (index 0) (alist dired-subdir-alist))
2139 (while alist
2140 (if (string= dir (car (car alist)))
2141 (setq alist nil found t)
2142 (setq alist (cdr alist) index (1+ index))))
2143 (if found index nil)))
2145 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2146 "Go to next subdirectory, regardless of level."
2147 ;; Use 0 arg to go to this directory's header line.
2148 ;; NO-SKIP prevents moving to end of header line, returning whatever
2149 ;; position was found in dired-subdir-alist.
2150 (interactive "p")
2151 (let ((this-dir (dired-current-directory))
2152 pos index)
2153 ;; nth with negative arg does not return nil but the first element
2154 (setq index (- (dired-subdir-index this-dir) arg))
2155 (setq pos (if (>= index 0)
2156 (dired-get-subdir-min (nth index dired-subdir-alist))))
2157 (if pos
2158 (progn
2159 (goto-char pos)
2161 (point))
2162 (if no-error-if-not-found
2163 nil ; return nil if not found
2164 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2166 (defun dired-build-subdir-alist (&optional switches)
2167 "Build `dired-subdir-alist' by parsing the buffer.
2168 Returns the new value of the alist.
2169 If optional arg SWITCHES is non-nil, use its value
2170 instead of `dired-actual-switches'."
2171 (interactive)
2172 (dired-clear-alist)
2173 (save-excursion
2174 (let* ((count 0)
2175 (buffer-read-only nil)
2176 (buffer-undo-list t)
2177 (switches (or switches dired-actual-switches))
2178 new-dir-name
2179 (R-ftp-base-dir-regex
2180 ;; Used to expand subdirectory names correctly in recursive
2181 ;; ange-ftp listings.
2182 (and (string-match "R" switches)
2185 (goto-char (point-min))
2186 (setq dired-subdir-alist nil)
2187 (while (and (re-search-forward dired-subdir-regexp nil t)
2188 ;; Avoid taking a file name ending in a colon
2189 ;; as a subdir name.
2190 (not (save-excursion
2191 (goto-char (match-beginning 0))
2192 (beginning-of-line)
2193 (forward-char 2)
2194 (save-match-data (looking-at dired-re-perms)))))
2195 (save-excursion
2196 (goto-char (match-beginning 1))
2197 (setq new-dir-name
2198 (buffer-substring-no-properties (point) (match-end 1))
2199 new-dir-name
2200 (save-match-data
2201 (if (and R-ftp-base-dir-regex
2202 (not (string= new-dir-name default-directory))
2203 (string-match R-ftp-base-dir-regex new-dir-name))
2204 (concat default-directory
2205 (substring new-dir-name (match-end 0)))
2206 (expand-file-name new-dir-name))))
2207 (delete-region (point) (match-end 1))
2208 (insert new-dir-name))
2209 (setq count (1+ count))
2210 (dired-alist-add-1 new-dir-name
2211 ;; Place a sub directory boundary between lines.
2212 (save-excursion
2213 (goto-char (match-beginning 0))
2214 (beginning-of-line)
2215 (point-marker))))
2216 (if (and (> count 1) (interactive-p))
2217 (message "Buffer includes %d directories" count))
2218 ;; We don't need to sort it because it is in buffer order per
2219 ;; constructionem. Return new alist:
2220 dired-subdir-alist)))
2222 (defun dired-alist-add-1 (dir new-marker)
2223 ;; Add new DIR at NEW-MARKER. Don't sort.
2224 (setq dired-subdir-alist
2225 (cons (cons (dired-normalize-subdir dir) new-marker)
2226 dired-subdir-alist)))
2228 (defun dired-goto-next-nontrivial-file ()
2229 ;; Position point on first nontrivial file after point.
2230 (dired-goto-next-file);; so there is a file to compare with
2231 (if (stringp dired-trivial-filenames)
2232 (while (and (not (eobp))
2233 (string-match dired-trivial-filenames
2234 (file-name-nondirectory
2235 (or (dired-get-filename nil t) ""))))
2236 (forward-line 1)
2237 (dired-move-to-filename))))
2239 (defun dired-goto-next-file ()
2240 (let ((max (1- (dired-subdir-max))))
2241 (while (and (not (dired-move-to-filename)) (< (point) max))
2242 (forward-line 1))))
2244 (defun dired-goto-file (file)
2245 "Go to file line of FILE in this dired buffer."
2246 ;; Return value of point on success, else nil.
2247 ;; FILE must be an absolute file name.
2250 ;; it in the buffer.
2251 (interactive
2252 (prog1 ; let push-mark display its message
2253 (list (expand-file-name
2254 (read-file-name "Goto file: "
2255 (dired-current-directory))))
2256 (push-mark)))
2257 (setq file (directory-file-name file)) ; does no harm if no directory
2258 (let (found case-fold-search dir)
2259 (setq dir (or (file-name-directory file)
2260 (error "File name `%s' is not absolute" file)))
2261 (save-excursion
2262 ;; The hair here is to get the result of dired-goto-subdir
2263 ;; without really calling it if we don't have any subdirs.
2264 (if (if (string= dir (expand-file-name default-directory))
2265 (goto-char (point-min))
2266 (and (cdr dired-subdir-alist)
2267 (dired-goto-subdir dir)))
2268 (let ((base (file-name-nondirectory file))
2269 search-string
2270 (boundary (dired-subdir-max)))
2271 (setq search-string
2273 (setq search-string
2275 (while (and (not found)
2276 ;; filenames are preceded by SPC, this makes
2277 ;; the search faster (e.g. for the filename "-"!).
2278 (search-forward (concat " " search-string)
2279 boundary 'move))
2280 ;; Match could have BASE just as initial substring or
2281 ;; or in permission bits or date or
2282 ;; not be a proper filename at all:
2283 (if (equal base (dired-get-filename 'no-dir t))
2284 ;; Must move to filename since an (actually
2285 ;; correct) match could have been elsewhere on the
2286 ;; ;; line (e.g. "-" would match somewhere in the
2287 ;; permission bits).
2288 (setq found (dired-move-to-filename))
2289 ;; If this isn't the right line, move forward to avoid
2290 ;; trying this line again.
2291 (forward-line 1))))))
2292 (and found
2293 ;; return value of point (i.e., FOUND):
2294 (goto-char found))))
2296 (defun dired-initial-position (dirname)
2297 ;; Where point should go in a new listing of DIRNAME.
2298 ;; Point assumed at beginning of new subdir line.
2299 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2300 (end-of-line)
2301 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2302 \f
2303 ;; These are hooks which make tree dired work.
2304 ;; They are in this file because other parts of dired need to call them.
2305 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2307 ;; This function is called for each retrieved filename.
2308 ;; It could stand to be faster, though it's mostly function call
2309 ;; overhead. Avoiding the function call seems to save about 10% in
2310 ;; dired-get-filename. Make it a defsubst?
2311 (defun dired-current-directory (&optional localp)
2312 "Return the name of the subdirectory to which this line belongs.
2313 This returns a string with trailing slash, like `default-directory'.
2314 Optional argument means return a file name relative to `default-directory'."
2315 (let ((here (point))
2316 (alist (or dired-subdir-alist
2317 ;; probably because called in a non-dired buffer
2318 (error "No subdir-alist in %s" (current-buffer))))
2319 elt dir)
2320 (while alist
2321 (setq elt (car alist)
2322 dir (car elt)
2323 ;; use `<=' (not `<') as subdir line is part of subdir
2324 alist (if (<= (dired-get-subdir-min elt) here)
2325 nil ; found
2326 (cdr alist))))
2327 (if localp
2328 (dired-make-relative dir default-directory)
2329 dir)))
2331 ;; Subdirs start at the beginning of their header lines and end just
2332 ;; before the beginning of the next header line (or end of buffer).
2334 (defun dired-subdir-max ()
2335 (save-excursion
2336 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2337 (point-max)
2338 (point))))
2339 \f
2340 ;; Deleting files
2342 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
2343 "*Decide whether recursive deletes are allowed.
2344 nil means no recursive deletes.
2345 `always' means delete recursively without asking. This is DANGEROUS!
2346 `top' means ask for each directory at top level, but delete its subdirectories
2347 without asking.
2348 Anything else means ask for each directory."
2349 :type '(choice :tag "Delete non-empty directories"
2350 (const :tag "Yes" always)
2351 (const :tag "No--only delete empty directories" nil)
2352 (const :tag "Confirm for each directory" t)
2353 (const :tag "Confirm for each top directory only" top))
2354 :group 'dired)
2356 ;; Match anything but `.' and `..'.
2359 ;; Delete file, possibly delete a directory and all its files.
2360 ;; This function is usefull outside of dired. One could change it's name
2361 ;; to e.g. recursive-delete-file and put it somewhere else.
2362 (defun dired-delete-file (file &optional recursive) "\
2363 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2364 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2365 nil, do not delete.
2366 `always', delete recursively without asking.
2367 `top', ask for each directory at top level.
2368 Anything else, ask for each sub-directory."
2369 (let (files)
2370 ;; This test is equivalent to
2371 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2372 ;; but more efficient
2373 (if (not (eq t (car (file-attributes file))))
2374 (delete-file file)
2375 (when (and recursive
2376 (setq files
2377 (directory-files file t dired-re-no-dot)) ; Not empty.
2378 (or (eq recursive 'always)
2379 (yes-or-no-p (format "Recursive delete of %s "
2380 (dired-make-relative file)))))
2381 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2382 (while files ; Recursively delete (possibly asking).
2383 (dired-delete-file (car files) recursive)
2384 (setq files (cdr files))))
2385 (delete-directory file))))
2387 (defun dired-do-flagged-delete (&optional nomessage)
2388 "In Dired, delete the files flagged for deletion.
2389 If NOMESSAGE is non-nil, we don't display any message
2390 if there are no flagged files."
2391 (interactive)
2392 (let* ((dired-marker-char dired-del-marker)
2393 (regexp (dired-marker-regexp))
2394 case-fold-search)
2395 (if (save-excursion (goto-char (point-min))
2396 (re-search-forward regexp nil t))
2397 (dired-internal-do-deletions
2398 ;; this can't move point since ARG is nil
2399 (dired-map-over-marks (cons (dired-get-filename) (point))
2400 nil)
2401 nil)
2402 (or nomessage
2403 (message "(No deletions requested)")))))
2405 (defun dired-do-delete (&optional arg)
2406 "Delete all marked (or next ARG) files."
2407 ;; This is more consistent with the file marking feature than
2408 ;; dired-do-flagged-delete.
2409 (interactive "P")
2410 (dired-internal-do-deletions
2411 ;; this may move point if ARG is an integer
2412 (dired-map-over-marks (cons (dired-get-filename) (point))
2413 arg)
2414 arg))
2416 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2418 (defun dired-internal-do-deletions (l arg)
2419 ;; L is an alist of files to delete, with their buffer positions.
2420 ;; ARG is the prefix arg.
2421 ;; Filenames are absolute (VMS needs this for logical search paths).
2422 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2423 ;; That way as changes are made in the buffer they do not shift the
2424 ;; lines still to be changed, so the (point) values in L stay valid.
2425 ;; Also, for subdirs in natural order, a subdir's files are deleted
2426 ;; before the subdir itself - the other way around would not work.
2427 (let ((files (mapcar (function car) l))
2428 (count (length l))
2429 (succ 0))
2430 ;; canonicalize file list for pop up
2431 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2432 (if (dired-mark-pop-up
2433 " *Deletions*" 'delete files dired-deletion-confirmer
2434 (format "Delete %s " (dired-mark-prompt arg files)))
2435 (save-excursion
2436 (let (failures);; files better be in reverse order for this loop!
2437 (while l
2438 (goto-char (cdr (car l)))
2439 (let (buffer-read-only)
2440 (condition-case err
2441 (let ((fn (car (car l))))
2442 (dired-delete-file fn dired-recursive-deletes)
2443 ;; if we get here, removing worked
2444 (setq succ (1+ succ))
2445 (message "%s of %s deletions" succ count)
2446 (dired-fun-in-all-buffers
2447 (file-name-directory fn) (file-name-nondirectory fn)
2448 (function dired-delete-entry) fn))
2449 (error;; catch errors from failed deletions
2451 (setq failures (cons (car (car l)) failures)))))
2452 (setq l (cdr l)))
2453 (if (not failures)
2454 (message "%d deletion%s done" count (dired-plural-s count))
2455 (dired-log-summary
2456 (format "%d of %d deletion%s failed"
2457 (length failures) count
2458 (dired-plural-s count))
2459 failures))))
2460 (message "(No deletions performed)")))
2461 (dired-move-to-filename))
2463 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2464 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2465 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2466 ;; (FILE does not include a directory component.)
2467 ;; FILE may be nil, in which case ignore it.
2468 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2469 (let (success-list)
2470 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2471 file))
2472 (with-current-buffer buf
2473 (if (apply fun args)
2474 (setq success-list (cons (buffer-name buf) success-list)))))
2475 success-list))
2477 ;; Delete the entry for FILE from
2478 (defun dired-delete-entry (file)
2479 (save-excursion
2480 (and (dired-goto-file file)
2481 (let (buffer-read-only)
2482 (delete-region (progn (beginning-of-line) (point))
2483 (save-excursion (forward-line 1) (point))))))
2484 (dired-clean-up-after-deletion file))
2486 ;; This is a separate function for the sake of dired-x.el.
2487 (defun dired-clean-up-after-deletion (fn)
2488 ;; Clean up after a deleted file or directory FN.
2489 (save-excursion (and (cdr dired-subdir-alist)
2490 (dired-goto-subdir fn)
2491 (dired-kill-subdir))))
2492 \f
2493 ;; Confirmation
2495 (defun dired-marker-regexp ()
2496 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2498 (defun dired-plural-s (count)
2499 (if (= 1 count) "" "s"))
2501 (defun dired-mark-prompt (arg files)
2502 ;; Return a string for use in a prompt, either the current file
2503 ;; name, or the marker and a count of marked files.
2504 (let ((count (length files)))
2505 (if (= count 1)
2506 (car files)
2507 ;; more than 1 file:
2508 (if (integerp arg)
2509 ;; abs(arg) = count
2510 ;; Perhaps this is nicer, but it also takes more screen space:
2511 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2512 ;; count)
2513 (format "[next %d files]" arg)
2514 (format "%c [%d files]" dired-marker-char count)))))
2516 (defun dired-pop-to-buffer (buf)
2517 ;; Pop up buffer BUF.
2518 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2519 (if (not dired-shrink-to-fit)
2520 (pop-to-buffer (get-buffer-create buf))
2521 ;; let window shrink to fit:
2522 (let ((window (selected-window))
2523 target-lines w2)
2524 (cond ;; if split-height-threshold is enabled, use the largest window
2525 ((and (> (window-height (setq w2 (get-largest-window)))
2526 split-height-threshold)
2527 (= (frame-width) (window-width w2)))
2528 (setq window w2))
2529 ;; if the least-recently-used window is big enough, use it
2530 ((and (> (window-height (setq w2 (get-lru-window)))
2531 (* 2 window-min-height))
2532 (= (frame-width) (window-width w2)))
2533 (setq window w2)))
2534 (save-excursion
2535 (set-buffer buf)
2536 (goto-char (point-max))
2538 (setq target-lines (count-lines (point-min) (point)))
2539 ;; Don't forget to count the last line.
2540 (if (not (bolp))
2541 (setq target-lines (1+ target-lines))))
2542 (if (<= (window-height window) (* 2 window-min-height))
2543 ;; At this point, every window on the frame is too small to split.
2544 (setq w2 (display-buffer buf))
2545 (setq w2 (split-window window
2546 (max window-min-height
2547 (- (window-height window)
2548 (1+ (max window-min-height target-lines)))))))
2549 (set-window-buffer w2 buf)
2550 (if (< (1- (window-height w2)) target-lines)
2551 (progn
2552 (select-window w2)
2553 (enlarge-window (- target-lines (1- (window-height w2))))))
2554 (set-window-start w2 1)
2555 )))
2557 (defvar dired-no-confirm nil
2558 "A list of symbols for commands Dired should not confirm.
2559 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2560 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2561 `touch' and `uncompress'.")
2563 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2564 "Return FUNCTION's result on ARGS after showing which files are marked.
2565 Displays the file names in a buffer named BUFNAME;
2567 This uses function `dired-pop-to-buffer' to do that.
2569 FUNCTION should not manipulate files, just read input
2570 (an argument or confirmation).
2571 The window is not shown if there is just one file or
2572 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2573 FILES is the list of marked files. It can also be (t FILENAME)
2574 in the case of one marked file, to distinguish that from using
2575 just the current file."
2576 (or bufname (setq bufname " *Marked Files*"))
2577 (if (or (eq dired-no-confirm t)
2578 (memq op-symbol dired-no-confirm)
2579 ;; If FILES defaulted to the current line's file.
2580 (= (length files) 1))
2581 (apply function args)
2582 (with-current-buffer (get-buffer-create bufname)
2583 (erase-buffer)
2584 ;; Handle (t FILE) just like (FILE), here.
2585 ;; That value is used (only in some cases), to mean
2586 ;; just one file that was marked, rather than the current line file.
2587 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2588 (remove-text-properties (point-min) (point-max)
2589 '(mouse-face nil help-echo nil)))
2590 (save-window-excursion
2591 (dired-pop-to-buffer bufname)
2592 (apply function args))))
2594 (defun dired-format-columns-of-files (files)
2595 ;; Files should be in forward order for this loop.
2596 ;; i.e., (car files) = first file in buffer.
2597 ;; Returns the number of lines used.
2598 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2599 (width (- (window-width (selected-window)) 2))
2600 (columns (max 1 (/ width maxlen)))
2601 (nfiles (length files))
2602 (rows (+ (/ nfiles columns)
2603 (if (zerop (% nfiles columns)) 0 1)))
2604 (i 0)
2605 (j 0))
2606 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2607 (make-list (- (* columns rows) nfiles) "")))
2608 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2609 (while (< j rows)
2610 (while (< i columns)
2611 (indent-to (* i maxlen))
2612 (insert (car files))
2613 (setq files (nthcdr rows files)
2614 i (1+ i)))
2616 (setq i 0
2617 j (1+ j)
2618 files (cdr files)))
2619 rows))
2620 \f
2621 ;; Commands to mark or flag file(s) at or near current line.
2623 (defun dired-repeat-over-lines (arg function)
2624 ;; This version skips non-file lines.
2625 (let ((pos (make-marker)))
2626 (beginning-of-line)
2627 (while (and (> arg 0) (not (eobp)))
2628 (setq arg (1- arg))
2629 (beginning-of-line)
2630 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2631 (save-excursion
2632 (forward-line 1)
2633 (move-marker pos (1+ (point))))
2634 (save-excursion (funcall function))
2635 ;; Advance to the next line--actually, to the line that *was* next.
2636 ;; (If FUNCTION inserted some new lines in between, skip them.)
2637 (goto-char pos))
2638 (while (and (< arg 0) (not (bobp)))
2639 (setq arg (1+ arg))
2640 (forward-line -1)
2641 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2642 (beginning-of-line)
2643 (save-excursion (funcall function)))
2644 (move-marker pos nil)
2645 (dired-move-to-filename)))
2647 (defun dired-between-files ()
2648 ;; This used to be a regexp match of the `total ...' line output by
2649 ;; ls, which is slightly faster, but that is not very robust; notably,
2650 ;; it fails for non-english locales.
2651 (save-excursion (not (dired-move-to-filename))))
2653 (defun dired-next-marked-file (arg &optional wrap opoint)
2654 "Move to the next marked file, wrapping around the end of the buffer."
2656 (or opoint (setq opoint (point)));; return to where interactively started
2657 (if (if (> arg 0)
2658 (re-search-forward dired-re-mark nil t arg)
2659 (beginning-of-line)
2660 (re-search-backward dired-re-mark nil t (- arg)))
2661 (dired-move-to-filename)
2662 (if (null wrap)
2663 (progn
2664 (goto-char opoint)
2665 (error "No next marked file"))
2666 (message "(Wraparound for next marked file)")
2667 (goto-char (if (> arg 0) (point-min) (point-max)))
2668 (dired-next-marked-file arg nil opoint))))
2670 (defun dired-prev-marked-file (arg &optional wrap)
2671 "Move to the previous marked file, wrapping around the end of the buffer."
2673 (dired-next-marked-file (- arg) wrap))
2675 (defun dired-file-marker (file)
2676 ;; Return FILE's marker, or nil if unmarked.
2677 (save-excursion
2678 (and (dired-goto-file file)
2679 (progn
2680 (beginning-of-line)
2682 (following-char))))))
2684 (defun dired-mark-files-in-region (start end)
2685 (let (buffer-read-only)
2686 (if (> start end)
2687 (error "start > end"))
2688 (goto-char start) ; assumed at beginning of line
2689 (while (< (point) end)
2690 ;; Skip subdir line and following garbage like the `total' line:
2691 (while (and (< (point) end) (dired-between-files))
2692 (forward-line 1))
2693 (if (and (not (looking-at dired-re-dot))
2694 (dired-get-filename nil t))
2695 (progn
2696 (delete-char 1)
2697 (insert dired-marker-char)))
2698 (forward-line 1))))
2700 (defun dired-mark (arg)
2701 "Mark the current (or next ARG) files.
2702 If on a subdir headerline, mark all its files except `.' and `..'.
2706 this subdir."
2707 (interactive "P")
2708 (if (dired-get-subdir)
2709 (save-excursion (dired-mark-subdir-files))
2710 (let (buffer-read-only)
2711 (dired-repeat-over-lines
2712 (prefix-numeric-value arg)
2713 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2715 (defun dired-unmark (arg)
2716 "Unmark the current (or next ARG) files.
2717 If looking at a subdir, unmark all its files except `.' and `..'."
2718 (interactive "P")
2720 (dired-mark arg)))
2722 (defun dired-flag-file-deletion (arg)
2723 "In Dired, flag the current line's file for deletion.
2724 With prefix arg, repeat over several lines.
2726 If on a subdir headerline, mark all its files except `.' and `..'."
2727 (interactive "P")
2728 (let ((dired-marker-char dired-del-marker))
2729 (dired-mark arg)))
2731 (defun dired-unmark-backward (arg)
2732 "In Dired, move up lines and remove deletion flag there.
2733 Optional prefix ARG says how many lines to unflag; default is one line."
2734 (interactive "p")
2735 (dired-unmark (- arg)))
2737 (defun dired-toggle-marks ()
2738 "Toggle marks: marked files become unmarked, and vice versa.
2739 Files marked with other flags (such as `D') are not affected.
2740 `.' and `..' are never toggled.
2741 As always, hidden subdirs are not affected."
2742 (interactive)
2743 (save-excursion
2744 (goto-char (point-min))
2745 (let (buffer-read-only)
2746 (while (not (eobp))
2747 (or (dired-between-files)
2748 (looking-at dired-re-dot)
2749 ;; use subst instead of insdel because it does not move
2750 ;; the gap and thus should be faster and because
2751 ;; other characters are left alone automatically
2752 (apply 'subst-char-in-region
2753 (point) (1+ (point))
2757 (forward-line 1)))))
2758 \f
2759 ;;; Commands to mark or flag files based on their characteristics or names.
2761 (defvar dired-regexp-history nil
2762 "History list of regular expressions used in Dired commands.")
2764 (defun dired-read-regexp (prompt)
2765 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2767 (defun dired-mark-files-regexp (regexp &optional marker-char)
2768 "Mark all files matching REGEXP for use in later commands.
2769 A prefix argument means to unmark them instead.
2770 `.' and `..' are never marked.
2773 object files--just `.o' will mark more than you might think."
2774 (interactive
2775 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2776 " files (regexp): "))
2778 (let ((dired-marker-char (or marker-char dired-marker-char)))
2779 (dired-mark-if
2780 (and (not (looking-at dired-re-dot))
2781 (not (eolp)) ; empty line
2782 (let ((fn (dired-get-filename nil t)))
2783 (and fn (string-match regexp (file-name-nondirectory fn)))))
2784 "matching file")))
2786 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2787 "Mark all files with contents containing REGEXP for use in later commands.
2788 A prefix argument means to unmark them instead.
2789 `.' and `..' are never marked."
2790 (interactive
2791 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2792 " files containing (regexp): "))
2794 (let ((dired-marker-char (or marker-char dired-marker-char)))
2795 (dired-mark-if
2796 (and (not (looking-at dired-re-dot))
2797 (not (eolp)) ; empty line
2798 (let ((fn (dired-get-filename nil t)))
2799 (when (and fn (file-readable-p fn)
2800 (not (file-directory-p fn)))
2801 (let ((prebuf (get-file-buffer fn)))
2802 (message "Checking %s" fn)
2803 ;; For now we do it inside emacs
2804 ;; Grep might be better if there are a lot of files
2805 (if prebuf
2806 (with-current-buffer prebuf
2807 (save-excursion
2808 (goto-char (point-min))
2809 (re-search-forward regexp nil t)))
2810 (with-temp-buffer
2811 (insert-file-contents fn)
2812 (goto-char (point-min))
2813 (re-search-forward regexp nil t))))
2814 )))
2815 "matching file")))
2817 (defun dired-flag-files-regexp (regexp)
2818 "In Dired, flag all files containing the specified REGEXP for deletion.
2819 The match is against the non-directory part of the filename. Use `^'
2820 and `$' to anchor matches. Exclude subdirs by hiding them.
2821 `.' and `..' are never flagged."
2822 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2823 (dired-mark-files-regexp regexp dired-del-marker))
2825 (defun dired-mark-symlinks (unflag-p)
2826 "Mark all symbolic links.
2827 With prefix argument, unflag all those files."
2828 (interactive "P")
2830 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2832 (defun dired-mark-directories (unflag-p)
2833 "Mark all directory file lines except `.' and `..'.
2834 With prefix argument, unflag all those files."
2835 (interactive "P")
2837 (dired-mark-if (and (looking-at dired-re-dir)
2838 (not (looking-at dired-re-dot)))
2839 "directory file")))
2841 (defun dired-mark-executables (unflag-p)
2842 "Mark all executable files.
2843 With prefix argument, unflag all those files."
2844 (interactive "P")
2846 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2848 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2849 ;; files for which PREDICATE returns non-nil.
2851 (defun dired-flag-auto-save-files (&optional unflag-p)
2852 "Flag for deletion files whose names suggest they are auto save files.
2853 A prefix argument says to unflag those files instead."
2854 (interactive "P")
2856 (dired-mark-if
2857 ;; It is less than general to check for # here,
2858 ;; but it's the only way this runs fast enough.
2859 (and (save-excursion (end-of-line)
2860 (or
2861 (eq (preceding-char) ?#)
2862 ;; Handle executables in case of -F option.
2863 ;; We need not worry about the other kinds
2864 ;; of markings that -F makes, since they won't
2865 ;; appear on real auto-save files.
2866 (if (eq (preceding-char) ?*)
2867 (progn
2868 (forward-char -1)
2869 (eq (preceding-char) ?#)))))
2870 (not (looking-at dired-re-dir))
2871 (let ((fn (dired-get-filename t t)))
2872 (if fn (auto-save-file-name-p
2873 (file-name-nondirectory fn)))))
2874 "auto save file")))
2876 (defcustom dired-garbage-files-regexp
2877 ;; `log' here is dubious, since it's typically used for useful log
2878 ;; files, not just TeX stuff. -- fx
2879 (concat (regexp-opt
2880 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2883 :type 'regexp
2884 :group 'dired)
2886 (defun dired-flag-garbage-files ()
2887 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2888 (interactive)
2889 (dired-flag-files-regexp dired-garbage-files-regexp))
2891 (defun dired-flag-backup-files (&optional unflag-p)
2892 "Flag all backup files (names ending with `~') for deletion.
2893 With prefix argument, unflag these files."
2894 (interactive "P")
2895 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
2896 (dired-mark-if
2897 ;; Don't call backup-file-name-p unless the last character looks like
2898 ;; it might be the end of a backup file name. This isn't very general,
2899 ;; but it's the only way this runs fast enough.
2900 (and (save-excursion (end-of-line)
2901 ;; Handle executables in case of -F option.
2902 ;; We need not worry about the other kinds
2903 ;; of markings that -F makes, since they won't
2904 ;; appear on real backup files.
2905 (if (eq (preceding-char) ?*)
2906 (forward-char -1))
2907 (eq (preceding-char) ?~))
2908 (not (looking-at dired-re-dir))
2909 (let ((fn (dired-get-filename t t)))
2910 (if fn (backup-file-name-p fn))))
2911 "backup file")))
2913 (defun dired-change-marks (&optional old new)
2914 "Change all OLD marks to NEW marks.
2915 OLD and NEW are both characters used to mark files."
2916 (interactive
2917 (let* ((cursor-in-echo-area t)
2918 (old (progn (message "Change (old mark): ") (read-char)))
2919 (new (progn (message "Change %c marks to (new mark): " old)
2920 (read-char))))
2921 (list old new)))
2923 (ding)
2925 (buffer-read-only))
2926 (save-excursion
2927 (goto-char (point-min))
2928 (while (search-forward string nil t)
2929 (if (if (= old ?\s)
2930 (save-match-data
2931 (dired-get-filename 'no-dir t))
2932 t)
2933 (subst-char-in-region (match-beginning 0)
2934 (match-end 0) old new)))))))
2936 (defun dired-unmark-all-marks ()
2937 "Remove all marks from all files in the dired buffer."
2938 (interactive)
2941 (defun dired-unmark-all-files (mark &optional arg)
2942 "Remove a specific mark (or any mark) from every file.
2943 After this command, type the mark character to remove,
2944 or type RET to remove all marks.
2945 With prefix arg, query for each marked file.
2948 (save-excursion
2949 (let* ((count 0)
2950 buffer-read-only case-fold-search query
2952 (help-form "\
2953 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2954 `!' to unmark all remaining files with no more questions."))
2955 (goto-char (point-min))
2957 (re-search-forward dired-re-mark nil t)
2958 (search-forward string nil t))
2959 (if (or (not arg)
2960 (let ((file (dired-get-filename t t)))
2961 (and file
2962 (dired-query 'query "Unmark file `%s'? "
2963 file))))
2964 (progn (subst-char-in-region (1- (point)) (point)
2965 (preceding-char) ?\s)
2966 (setq count (1+ count)))))
2967 (message (if (= count 1) "1 mark removed"
2968 "%d marks removed")
2969 count))))
2970 \f
2971 ;; Logging failures operating on files, and showing the results.
2973 (defvar dired-log-buffer "*Dired log*")
2975 (defun dired-why ()
2976 "Pop up a buffer with error log output from Dired.
2977 A group of errors from a single command ends with a formfeed.
2979 (interactive)
2980 (if (get-buffer dired-log-buffer)
2981 (let ((owindow (selected-window))
2982 (window (display-buffer (get-buffer dired-log-buffer))))
2983 (unwind-protect
2984 (progn
2985 (select-window window)
2986 (goto-char (point-max))
2987 (forward-line -1)
2988 (backward-page 1)
2989 (recenter 0))
2990 (select-window owindow)))))
2992 (defun dired-log (log &rest args)
2993 ;; Log a message or the contents of a buffer.
2994 ;; If LOG is a string and there are more args, it is formatted with
2996 ;; End each bunch of errors with (dired-log t):
2997 ;; this inserts the current time and buffer at the start of the page,
2999 (let ((obuf (current-buffer)))
3000 (with-current-buffer (get-buffer-create dired-log-buffer)
3001 (goto-char (point-max))
3002 (let ((inhibit-read-only t))
3003 (cond ((stringp log)
3004 (insert (if args
3005 (apply (function format) log args)
3006 log)))
3007 ((bufferp log)
3008 (insert-buffer-substring log))
3009 ((eq t log)
3010 (backward-page 1)
3011 (unless (bolp)
3013 (insert (current-time-string)
3015 (goto-char (point-max))
3018 (defun dired-log-summary (string failures)
3019 (if (= (length failures) 1)
3020 (message "%s"
3021 (with-current-buffer dired-log-buffer
3022 (goto-char (point-max))
3023 (backward-page 1)
3024 (if (eolp) (forward-line 1))
3025 (buffer-substring (point) (point-max))))
3026 (message (if failures "%s--type ? for details (%s)"
3027 "%s--type ? for details")
3028 string failures))
3029 ;; Log a summary describing a bunch of errors.
3031 (dired-log t))
3032 \f
3033 ;;; Sorting
3035 ;; Most ls can only sort by name or by date (with -t), nothing else.
3036 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3037 ;; So anything that does not contain these is sort "by name".
3039 (defvar dired-ls-sorting-switches "SXU"
3042 This indicates to Dired which option switches to watch out for because they
3043 will change the sorting order behavior of `ls'.
3045 To change the default sorting order \(e.g. add a `-v' option\), see the
3046 variable `dired-listing-switches'. To temporarily override the listing
3049 (defvar dired-sort-by-date-regexp
3050 (concat "^-[^" dired-ls-sorting-switches
3051 "]*t[^" dired-ls-sorting-switches "]*$")
3052 "Regexp recognized by Dired to set `by date' mode.")
3054 (defvar dired-sort-by-name-regexp
3055 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3056 "Regexp recognized by Dired to set `by name' mode.")
3058 (defvar dired-sort-inhibit nil
3059 "Non-nil means the Dired sort command is disabled.
3060 The idea is to set this buffer-locally in special dired buffers.")
3062 (defun dired-sort-set-modeline ()
3063 ;; Set modeline display according to dired-actual-switches.
3064 ;; Modeline display of "by name" or "by date" guarantees the user a
3065 ;; match with the corresponding regexps. Non-matching switches are
3066 ;; shown literally.
3067 (setq mode-name
3068 (let (case-fold-search)
3069 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
3070 "Dired by name")
3071 ((string-match dired-sort-by-date-regexp dired-actual-switches)
3072 "Dired by date")
3073 (t
3074 (concat "Dired " dired-actual-switches)))))
3075 (force-mode-line-update))
3077 (defun dired-sort-toggle-or-edit (&optional arg)
3078 "Toggle between sort by date/name and refresh the dired buffer.
3079 With a prefix argument you can edit the current listing switches instead."
3080 (interactive "P")
3081 (when dired-sort-inhibit
3082 (error "Cannot sort this dired buffer"))
3083 (if arg
3084 (dired-sort-other
3085 (read-string "ls switches (must contain -l): " dired-actual-switches))
3086 (dired-sort-toggle)))
3088 (defun dired-sort-toggle ()
3089 ;; Toggle between sort by date/name. Reverts the buffer.
3090 (setq dired-actual-switches
3091 (let (case-fold-search)
3092 (if (string-match " " dired-actual-switches)
3093 ;; New toggle scheme: add/remove a trailing " -t"
3095 (substring dired-actual-switches 0 (match-beginning 0))
3096 (concat dired-actual-switches " -t"))
3097 ;; old toggle scheme: look for some 't' switch and add/remove it
3098 (concat
3099 "-l"
3100 (dired-replace-in-string (concat "[-lt"
3101 dired-ls-sorting-switches "]")
3102 ""
3103 dired-actual-switches)
3104 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3105 dired-actual-switches)
3106 ""
3107 "t")))))
3108 (dired-sort-set-modeline)
3109 (revert-buffer))
3111 ;; Some user code loads dired especially for this.
3112 ;; Don't do that--use replace-regexp-in-string instead.
3113 (defun dired-replace-in-string (regexp newtext string)
3114 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3116 (let ((result "") (start 0) mb me)
3117 (while (string-match regexp string start)
3118 (setq mb (match-beginning 0)
3119 me (match-end 0)
3120 result (concat result (substring string start mb) newtext)
3121 start me))
3122 (concat result (substring string start))))
3124 (defun dired-sort-other (switches &optional no-revert)
3125 "Specify new `ls' SWITCHES for current dired buffer.
3126 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3127 set the minor mode accordingly, others appear literally in the mode line.
3128 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3129 (dired-sort-R-check switches)
3130 (setq dired-actual-switches switches)
3131 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
3132 (or no-revert (revert-buffer)))
3134 (make-variable-buffer-local
3135 (defvar dired-subdir-alist-pre-R nil
3136 "Value of `dired-subdir-alist' before -R switch added."))
3138 (defun dired-sort-R-check (switches)
3139 "Additional processing of -R in ls option string SWITCHES.
3140 Saves `dired-subdir-alist' when R is set and restores saved value
3141 minus any directories explicitly deleted when R is cleared.
3142 To be called first in body of `dired-sort-other', etc."
3143 (cond
3144 ((and (string-match "R" switches)
3145 (not (string-match "R" dired-actual-switches)))
3146 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3147 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3148 ((and (string-match "R" dired-actual-switches)
3149 (not (string-match "R" switches)))
3150 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3151 ;; that are still present:
3152 (setq dired-subdir-alist
3153 (if dired-subdir-alist-pre-R
3154 (let (subdirs)
3155 (while dired-subdir-alist-pre-R
3156 (if (assoc (caar dired-subdir-alist-pre-R)
3157 dired-subdir-alist)
3158 ;; subdir still present...
3159 (setq subdirs
3160 (cons (car dired-subdir-alist-pre-R)
3161 subdirs)))
3162 (setq dired-subdir-alist-pre-R
3163 (cdr dired-subdir-alist-pre-R)))
3164 (reverse subdirs))
3165 ;; No pre-R subdir alist, so revert to main directory
3166 ;; listing:
3167 (list (car (reverse dired-subdir-alist))))))))
3168 \f
3170 ;;;; Drag and drop support
3172 (defcustom dired-recursive-copies nil
3173 "*Decide whether recursive copies are allowed.
3174 nil means no recursive copies.
3175 `always' means copy recursively without asking.
3176 `top' means ask for each directory at top level.
3177 Anything else means ask for each directory."
3178 :type '(choice :tag "Copy directories"
3179 (const :tag "No recursive copies" nil)
3180 (const :tag "Ask for each directory" t)
3181 (const :tag "Ask for each top directory only" top)
3182 (const :tag "Copy directories without asking" always))
3183 :group 'dired)
3185 (defun dired-dnd-popup-notice ()
3186 (message-box
3190 (defun dired-dnd-do-ask-action (uri)
3191 ;; No need to get actions and descriptions from the source,
3192 ;; we only have three actions anyway.
3193 (let ((action (x-popup-menu
3194 t
3195 (list "What action?"
3196 (cons ""
3197 '(("Copy here" . copy)
3198 ("Move here" . move)
3199 ("Link here" . link)
3200 "--"
3201 ("Cancel" . nil)))))))
3202 (if action
3203 (dired-dnd-handle-local-file uri action)
3204 nil)))
3206 (defun dired-dnd-handle-local-file (uri action)
3207 "Copy, move or link a file to the dired directory.
3208 URI is the file to handle, ACTION is one of copy, move, link or ask.
3209 Ask means pop up a menu for the user to select one of copy, move or link."
3210 (require 'dired-aux)
3211 (let* ((from (dnd-get-local-file-name uri t))
3212 (to (if from (concat (dired-current-directory)
3213 (file-name-nondirectory from))
3214 nil)))
3215 (if from
3216 (cond ((or (eq action 'copy)
3217 (eq action 'private)) ; Treat private as copy.
3219 ;; If copying a directory and dired-recursive-copies is nil,
3220 ;; dired-copy-file silently fails. Pop up a notice.
3221 (if (and (file-directory-p from)
3222 (not dired-recursive-copies))
3223 (dired-dnd-popup-notice)
3224 (progn
3225 (dired-copy-file from to 1)
3226 (dired-relist-entry to)
3227 action)))
3229 ((eq action 'move)
3230 (dired-rename-file from to 1)
3231 (dired-relist-entry to)
3232 action)
3234 ((eq action 'link)
3235 (make-symbolic-link from to 1)
3236 (dired-relist-entry to)
3237 action)
3239 ((eq action 'ask)
3240 (dired-dnd-do-ask-action uri))
3242 (t nil)))))
3244 (defun dired-dnd-handle-file (uri action)
3245 "Copy, move or link a file to the dired directory if it is a local file.
3246 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3247 ACTION is one of copy, move, link or ask.
3248 Ask means pop up a menu for the user to select one of copy, move or link."
3249 (let ((local-file (dnd-get-local-file-uri uri)))
3250 (if local-file (dired-dnd-handle-local-file local-file action)
3251 nil)))
3252 \f
3254 ;;;; Desktop support
3256 (eval-when-compile (require 'desktop))
3258 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3259 "Auxiliary information to be saved in desktop file."
3260 (cons
3261 ;; Value of `dired-directory'.
3262 (if (consp dired-directory)
3263 ;; Directory name followed by list of files.
3264 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3265 (cdr dired-directory))
3266 ;; Directory name, optionally with shell wildcard.
3267 (desktop-file-name dired-directory desktop-dirname))
3268 ;; Subdirectories in `dired-subdir-alist'.
3269 (cdr
3270 (nreverse
3271 (mapcar
3272 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3273 dired-subdir-alist)))))
3275 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3276 desktop-buffer-name
3277 desktop-buffer-misc)
3278 "Restore a dired buffer specified in a desktop file."
3279 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3280 ;; This value is a directory name, optionally with shell wildcard or
3281 ;; a directory name followed by list of files.
3282 (let* ((dired-dir (car desktop-buffer-misc))
3283 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3284 (if (file-directory-p (file-name-directory dir))
3285 (progn
3286 (dired dired-dir)
3287 ;; The following elements of `desktop-buffer-misc' are the keys
3288 ;; from `dired-subdir-alist'.
3289 (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3290 (current-buffer))
3291 (message "Desktop: Directory %s no longer exists." dir)
3292 (when desktop-missing-file-warning (sit-for 1))
3293 nil)))
3295 (add-to-list 'desktop-buffer-mode-handlers
3296 '(dired-mode . dired-restore-desktop-buffer))
3298 \f
3299 (if (eq system-type 'vax-vms)
3300 (load "dired-vms"))
3302 (provide 'dired)
3304 (run-hooks 'dired-load-hook) ; for your customizations
3306 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3307 ;;; dired.el ends here