| blob | 7734a9bd69fb568aa9dbe02cae00512661ec9121 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007 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' in `ls-lisp.el' for more details."
64 "If non-nil, switches passed to `ls' for inserting subdirectories.
67 ; Don't use absolute file names as /bin should be in any PATH and people
68 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
69 ; usually not in PATH.
71 ;;;###autoload
74 "chown"
76 "/usr/sbin/chown"
89 ;;;###autoload
91 "*Informs Dired about how `ls -lF' marks symbolic links.
92 Set this to t if `ls' (or whatever program is specified by
93 `insert-directory-program') with `-lF' marks the symbolic link
94 itself with a trailing @ (usually the case under Ultrix).
96 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
97 nil (the default), if it gives `bar@ -> foo', set it to t.
99 Dired checks if there is really a @ appended. Thus, if you have a
100 marking `ls' program on one host and a non-marking on another host, and
101 don't care about symbolic links which really end in a @, you can
102 always set this variable to t."
106 ;;;###autoload
108 "*Regexp of files to skip when finding first file of a directory.
109 A value of nil means move to the subdir line.
110 A value of t means move to first file."
113 regexp)
116 ;;;###autoload
118 ;; Use t as default so that moved files "take their markers with them".
119 "*Controls marking of renamed files.
120 If t, files keep their previous marks when they are renamed.
121 If a character, renamed files (whether previously marked or not)
122 are afterward marked with that character."
127 ;;;###autoload
129 "*Controls marking of copied files.
130 If t, copied files are marked if and as the corresponding original files were.
131 If a character, copied files are unconditionally marked with that character."
136 ;;;###autoload
138 "*Controls marking of newly made hard links.
139 If t, they are marked if and as the files linked to were marked.
140 If a character, new links are unconditionally marked with that character."
145 ;;;###autoload
147 "*Controls marking of newly made symbolic links.
148 If t, they are marked if and as the files linked to were marked.
149 If a character, new links are unconditionally marked with that character."
154 ;;;###autoload
156 "*If non-nil, Dired tries to guess a default target directory.
157 This means: if there is a dired buffer displayed in the next window,
158 use its current subdir, instead of the current subdir of this dired buffer.
160 The target is used in the prompt for file copy, rename etc."
164 ;;;###autoload
166 "*If non-nil, Dired preserves the last-modified time in a file copy.
167 \(This works on only some systems.)"
171 ; These variables were deleted and the replacements are on files.el.
172 ; We leave aliases behind for back-compatibility.
176 ;;; Hook variables
179 "Run after loading Dired.
180 You can customize key bindings or load extensions with this."
185 "Run at the very end of `dired-mode'."
190 "This hook is run before a dired buffer is read in (created or reverted)."
195 "Hook run after each time a file or directory is read by Dired.
196 After each listing of a file or directory, this hook is run
197 with the buffer narrowed to the listing."
200 ;; Note this can't simply be run inside function `dired-ls' as the hook
201 ;; functions probably depend on the dired-subdir-alist to be OK.
207 "The functions to call when a drop in `dired-mode' is made.
208 See `dnd-protocol-alist' for more information. When nil, behave
209 as in other buffers. Changing this option is effective only for
210 new dired buffers."
216 ;; Internal variables
219 ;; so that you can write things like
220 ;; (let ((dired-marker-char ?X))
221 ;; ;; great code using X markers ...
222 ;; )
223 ;; For example, commands operating on two sets of files, A and B.
224 ;; Or marking files with digits 0-9. This could implicate
225 ;; concentric sets or an order for the marked files.
226 ;; The code depends on dynamic scoping on the marker char.
227 "In Dired, the current mark character.
234 ;; I see no reason ever to make this nil -- rms.
235 ;; (> baud-rate search-slow-speed)
242 ;;;###autoload
244 "The directory name or wildcard spec that this dired directory lists.
245 Local to each dired buffer. May be a list, in which case the car is the
246 directory name and the cdr is the list of files to mention.
255 ;; These regexps must be tested at beginning-of-line, but are also
256 ;; used to search for next matches, so neither omitting "^" nor
257 ;; replacing "^" by "\n" (to make it slightly faster) will work.
260 ;; "Regexp matching a marked line.
261 ;; Important: the match ends just after the marker."
263 ;; The [^:] part after "d" and "l" is to avoid confusion with the
264 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
272 "-[-r][-w].[-r][-w][xs][-r][-w]."
278 ;; The subdirectory names in the next two lists are expanded.
280 "Association list of subdirectories and their buffer positions.
281 Each subdirectory has an element: (DIRNAME . STARTMARKER).
282 The order of elements is the reverse of the order in the buffer.
286 "Keeps track of which switches to use for inserted subdirectories.
294 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
295 Subexpression 1 is the subdirectory proper, no trailing colon.
296 The match starts at the beginning of the line and ends after the end
301 "Faces used by Dired."
307 "Face used for directory headers."
315 "Face used for dired marks."
323 "Face used for marked files."
331 "Face used for flagged files."
339 "Face used to highlight a part of a buffer that needs user attention."
347 "Face used for subdirectories."
355 "Face used for symbolic links."
363 "Face used for files suffixed with `completion-ignored-extensions'."
371 ;;
372 ;; Directory headers.
374 ;;
375 ;; Dired marks.
377 ;;
378 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
379 ;; file name itself. We search for Dired defined regexps, and then use the
380 ;; Dired defined function `dired-move-to-filename' before searching for the
381 ;; simple regexp ".+". It is that regexp which matches the file name.
382 ;;
383 ;; Marked files.
386 ;;
387 ;; Flagged files.
390 ;; People who are paranoid about security would consider this more
391 ;; important than other things such as whether it is a directory.
392 ;; But we don't want to encourage paranoia, so our default
393 ;; should be what's most useful for non-paranoids. -- rms.
394 ;;; ;;
395 ;;; ;; Files that are group or world writable.
396 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
397 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
398 ;;; '(1 dired-warning-face)
399 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
400 ;; However, we don't need to highlight the file name, only the
401 ;; permissions, to win generally. -- fx.
402 ;; Fixme: we could also put text properties on the permission
403 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
410 ;;
411 ;; Subdirectories.
414 ;;
415 ;; Symbolic links.
418 ;;
419 ;; Files suffixed with `completion-ignored-extensions'.
421 ;; It is quicker to first find just an extension, then go back to the
422 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
425 ;;
426 ;; Files suffixed with `completion-ignored-extensions'
427 ;; plus a character put in by -F.
433 ;; If the last character is not part of the filename,
434 ;; move back to the start of the filename
435 ;; so it can be fontified.
436 ;; Otherwise, leave point at the end of the line;
437 ;; that way, nothing is fontified.
441 )
445 \f
446 ;;; Macros must be defined before they are used, for the byte compiler.
449 "Mark all files for which PREDICATE evals to non-nil.
450 PREDICATE is evaluated on each line, with point at beginning of line.
451 MSG is a noun phrase for the type of files being marked.
452 It should end with a noun that can be pluralized by adding `s'.
453 Return value is the number of files marked, or nil if none were marked."
467 count
468 ,msg
476 distinguish-one-marked)
477 "Eval BODY with point on each marked line. Return a list of BODY's results.
478 If no marked file could be found, execute BODY on the current line.
479 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
480 files instead of the marked files.
481 In that case point is dragged along. This is so that commands on
482 the next ARG (instead of the marked) files can be chained easily.
483 If ARG is otherwise non-nil, use current file instead.
484 If optional third arg SHOW-PROGRESS evaluates to non-nil,
485 redisplay the dired buffer after each file is processed.
486 No guarantee is made about the position on the marked line.
487 BODY must ensure this itself if it depends on this.
488 Search starts at the beginning of the buffer, thus the car of the list
489 corresponds to the line nearest to the buffer's bottom. This
490 is also true for (positive and negative) integer values of ARG.
491 BODY should not be too long as it is expanded four times.
493 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
494 return (t FILENAME) instead of (FILENAME)."
495 ;;
496 ;;Warning: BODY must not add new lines before point - this may cause an
497 ;;endless loop.
498 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
505 ,arg
511 results))
512 ;; non-nil, non-integer ARG means use current file:
517 ;; remember position of next marked file before BODY
518 ;; can insert lines before the just found file,
519 ;; confusing us by finding the same marked file again
520 ;; and again and...
528 ;; move after last match
537 results
539 ;; save-excursion loses, again
543 "Return the marked files' names as list of strings.
544 The list is in the same order as the buffer, that is, the car is the
545 first marked file.
546 Values returned are normally absolute file names.
547 Optional arg LOCALP as in `dired-get-filename'.
548 Optional second argument ARG specifies files near point
549 instead of marked files. If ARG is an integer, use the next ARG files.
550 If ARG is otherwise non-nil, use file. Usually ARG comes from
551 the command's prefix arg.
552 Optional third argument FILTER, if non-nil, is a function to select
553 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
555 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
556 return (t FILENAME) instead of (FILENAME).
557 Don't use that together with FILTER."
562 arg nil distinguish-one-marked)))
563 result)
566 all-of-them
571 result)))
572 \f
573 ;; The dired command
576 ;; For use in interactive.
580 dired-listing-switches))
581 ;; If a dialog is about to be used, call read-directory-name so
582 ;; the dialog code knows we want directories. Some dialogs can
583 ;; only select directories or files when popped up, not both.
586 nil default-directory nil)
588 nil default-directory nil)))))
590 ;;;###autoload (define-key ctl-x-map "d" 'dired)
591 ;;;###autoload
594 Optional second argument SWITCHES specifies the `ls' options used.
595 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
596 Dired displays a list of files in DIRNAME (which may also have
597 shell wildcards appended to select certain files). If DIRNAME is a cons,
598 its first element is taken as the directory name and the rest as an explicit
599 list of files to make directory entries for.
601 You can move around in it with the usual commands.
606 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
607 ;; Cannot use (interactive "D") because of wildcards.
611 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
612 ;;;###autoload
618 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
619 ;;;###autoload
625 ;;;###autoload
627 "Like `dired' but returns the dired buffer as value, does not select it."
629 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
630 ;; some shells make:
641 ;; If the argument was syntactically a directory name not a file name,
642 ;; or if it happens to name a file that is a directory,
643 ;; convert it syntactically to a directory name.
644 ;; The reason for checking initially-was-dirname
645 ;; and not just file-directory-p
646 ;; is that file-directory-p is slow over ftp.
654 ;; The following is an internal dired function. It returns non-nil if
655 ;; the directory visited by the current dired buffer has changed on
656 ;; disk. DIRNAME should be the directory name of that directory.
665 "Return non-nil if current dired buffer needs updating.
666 If NOCONFIRM is non-nil, then this function always returns nil
667 for a remote directory. This feature is used by Auto Revert Mode."
675 ;; Separate function from dired-noselect for the sake of dired-vms.el.
677 ;; If there is an existing dired buffer for DIRNAME, just leave
678 ;; buffer as it is (don't even call dired-revert).
679 ;; This saves time especially for deep trees or with ange-ftp.
680 ;; The user can type `g' easily, and it is more consistent with find-file.
681 ;; But if SWITCHES are given they are probably different from the
682 ;; buffer's old value, so call dired-sort-other, which does
683 ;; revert the buffer.
684 ;; A pity we can't possibly do "Directory has changed - refresh? "
685 ;; like find-file does.
686 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
687 ;; see there.
689 buffer
690 ;; note that buffer already is in dired-mode, if found
691 new-buffer-p
696 ;; Look for an existing buffer.
701 ;; We don't want default-major-mode to run hooks and set auto-fill
702 ;; or whatever, now that dired-mode does not
703 ;; kill-all-local-variables any longer.
708 ;; file list may have changed
710 ;; this calls dired-revert
712 ;; If directory has changed on disk, offer to revert.
717 ;; Else a new buffer
719 ;; We can do this unconditionally
720 ;; because dired-noselect ensures that the name
721 ;; is passed in directory name syntax
722 ;; if it was the name of a directory at all.
727 ;; default-directory and dired-actual-switches are set now
728 ;; (buffer-local), so we can call dired-readin:
733 ;; dired-readin can fail if parent directories are inaccessible.
734 ;; Don't leave an empty buffer around in that case.
739 buffer))
742 ;; Enlarged by dired-advertise
743 ;; Queried by function dired-buffers-for-dir. When this detects a
744 ;; killed buffer, it is removed from this list.
748 ;; This differs from dired-buffers-for-dir in that it does not consider
749 ;; subdirs of default-directory and searches for the first match only.
750 ;; Also, the major mode must be MODE.
760 dired-directory ;; nil during find-alternate-file
765 dired-directory))))
767 blist nil)
769 found))
771 \f
772 ;; Read in a new dired buffer
775 "Read in a new dired buffer.
776 Differs from `dired-insert-subdir' in that it accepts
777 wildcards, erases the buffer, and builds the subdir-alist anew
778 \(including making it buffer-local and clearing it first)."
780 ;; default-directory and dired-actual-switches must be buffer-local
781 ;; and initialized by now.
788 ;; This hook which may want to modify dired-actual-switches
789 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
790 ;; where ls won't understand -Al switches.
798 ;; Don't make undo entries for readin.
804 ;; Must first make alist buffer local and set it to nil because
805 ;; dired-build-subdir-alist will call dired-clear-alist first
812 ;; No need to narrow since the whole buffer contains just
813 ;; dired-readin's output, nothing else. The hook can
814 ;; successfully use dired functions (e.g. dired-get-filename)
815 ;; as the subdir-alist has been built in dired-readin.
818 ;; Subroutines of dired-readin
821 ;; Insert listing for the specified dir (and maybe file list)
822 ;; already in dired-directory, assuming a clean buffer.
828 file-list nil))
832 ;; If we are reading a whole single directory...
837 ;; Else treat it as a wildcard spec
838 ;; unless we have an explicit list of files.
843 "Align the fields of a file to the ones of surrounding lines.
844 BEG..END is the line where the file info is located."
845 ;; Some versions of ls try to adjust the size of each field so as to just
846 ;; hold the largest element ("largest" in the current invocation, of
847 ;; course). So when a single line is output, the size of each field is
848 ;; just big enough for that one output. Thus when dired refreshes one
849 ;; line, the alignment if this line w.r.t the rest is messed up because
850 ;; the fields of that one line will generally be smaller.
851 ;;
852 ;; To work around this problem, we here add spaces to try and
853 ;; re-align the fields as needed. Since this is purely aesthetic,
854 ;; it is of utmost importance that it doesn't mess up anything like
855 ;; `dired-move-to-filename'. To this end, we limit ourselves to
856 ;; adding spaces only, and to only add them at places where there
857 ;; was already at least one space. This way, as long as
858 ;; `directory-listing-before-filename-regexp' always matches spaces
859 ;; with "*" or "+", we know we haven't made anything worse. There
860 ;; is one spot where the exact number of spaces is important, which
861 ;; is just before the actual filename, so we refrain from adding
862 ;; spaces there (and within the filename as well, of course).
865 ;; Check the there is indeed a file, and that there is anoter adjacent
866 ;; file with which to align, and that additional spaces are needed to
867 ;; align the filenames.
880 ;; Make sure there is some work left to do.
882 ;; If we've only looked at the line above, check to see if the line
883 ;; below exists as well and if so, align with the shorter one.
892 ;; Keep positions uptodate when we insert stuff.
895 ;; Main loop.
899 ;; Don't touch anything just before (and after) the
900 ;; beginning of the filename.
902 ;; We're now just in front of a field, with a space behind us.
904 ;; Nums are right-aligned.
906 ;; Let's look at the other line, in the same column: we
907 ;; should be either near the end of the previous field, or
908 ;; in the space between that field and the next.
909 ;; [ Of course, it's also possible that we're already within
910 ;; the next field or even past it, but that's unlikely since
911 ;; other-col > file-col. ]
912 ;; Let's find the distance to the alignment-point (either
913 ;; the beginning or the end of the next field, depending on
914 ;; whether this field is left or right aligned).
924 ;; Now, the number of spaces to insert is align-pt-offset
925 ;; minus the distance to the equivalent point on the
926 ;; current line.
929 align-pt-offset
939 ;; Let's just make really sure we did not mess up.
942 ;; Damn! We messed up: let's revert the change.
944 ;; Now skip to next field.
950 "Insert a directory listing of DIR, Dired style.
951 Use SWITCHES to make the listings.
952 If FILE-LIST is non-nil, list only those files.
953 Otherwise, if WILDCARD is non-nil, expand wildcards;
954 in that case, DIR should be a file name that uses wildcards.
955 In other cases, DIR should be a directory name or a directory filename.
956 If HDR is non-nil, insert a header line with the directory name."
959 end)
962 ;; We used to specify the C locale here, to force English month names;
963 ;; but this should not be necessary any more,
964 ;; with the new value of `directory-listing-before-filename-regexp'.
969 ;; Re-align fields, if necessary.
972 ;; Quote certain characters, unless ls quoted them for us.
981 nil t))
987 nil t))
990 ;; If we used --dired and it worked, the lines are already indented.
991 ;; Otherwise, indent them.
997 ;; Insert text at the beginning to standardize things.
1001 ;; Note that dired-build-subdir-alist will replace the name
1002 ;; by its expansion, so it does not matter whether what we insert
1003 ;; here is fully expanded, but it should be absolute.
1006 ;; Insert "wildcard" line where "total" line would be for a full dir.
1010 "Make the file names highlight when the mouse is on them."
1025 \f
1026 ;; Reverting a dired buffer
1029 "Reread the dired buffer.
1030 Must also be called after `dired-actual-switches' have changed.
1031 Should not fail even on completely garbaged buffers.
1032 Preserves old cursor, marks/flags, hidden-p."
1041 buffer-read-only)
1045 ;; treat top level dir extra (it may contain wildcards)
1048 ;; Run dired-after-readin-hook just once, below.
1053 ;; ... run the hook for the whole buffer, and only after markers
1054 ;; have been reinserted (else omitting in dired-x would omit marked files)
1064 ;; outside of the let scope
1065 ;;; Might as well not override the user if the user changed this.
1066 ;;; (setq buffer-read-only t)
1067 )
1069 ;; Subroutines of dired-revert
1070 ;; Some of these are also used when inserting subdirs.
1073 "Return alist of files and their marks, from BEG to END."
1084 alist))
1087 "Mark all files remembered in ALIST.
1088 Each element of ALIST looks like (FILE . MARKERCHAR)."
1102 "Return a list of names of subdirs currently hidden."
1112 result))
1115 "Try to insert all subdirs that were displayed before.
1116 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1130 "Remove directory DIR from any directory cache."
1134 \f
1135 ;; dired mode key bindings and initialization
1138 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1139 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1144 ;; Commands to mark or flag certain categories of files
1149 ;; Upper case keys (except !) for operating on the marked files
1167 ;; Comparison commands
1170 ;; Tree Dired commands
1176 ;; move to marked files
1179 ;; Make all regexp commands share a `%' prefix:
1180 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1181 ;; but that seems to serve little purpose, and copy-keymap
1182 ;; does a better job without it.
1194 ;; Commands for marking and unmarking.
1211 ;; Lower keys for commands not operating on all the marked files
1237 ;; moving
1245 (define-key map [up] 'dired-previous-line)
1246 ;; hiding
1247 (define-key map "$" 'dired-hide-subdir)
1248 (define-key map "\M-$" 'dired-hide-all)
1249 ;; misc
1250 (define-key map "?" 'dired-summary)
1252 (define-key map [remap undo] 'dired-undo)
1253 (define-key map [remap advertised-undo] 'dired-undo)
1254 ;; thumbnail manipulation (tumme)
1255 (define-key map "\C-td" 'tumme-display-thumbs)
1256 (define-key map "\C-tt" 'tumme-tag-files)
1257 (define-key map "\C-tr" 'tumme-delete-tag)
1258 (define-key map "\C-tj" 'tumme-jump-thumbnail-buffer)
1259 (define-key map "\C-ti" 'tumme-dired-display-image)
1260 (define-key map "\C-tx" 'tumme-dired-display-external)
1261 (define-key map "\C-ta" 'tumme-display-thumbs-append)
1262 (define-key map "\C-t." 'tumme-display-thumb)
1263 (define-key map "\C-tc" 'tumme-dired-comment-files)
1264 (define-key map "\C-tf" 'tumme-mark-tagged-files)
1265 (define-key map "\C-t\C-t" 'tumme-dired-insert-marked-thumbs)
1266 (define-key map "\C-te" 'tumme-dired-edit-comment-and-tags)
1268 ;; Make menu bar items.
1270 ;; No need to fo this, now that top-level items are fewer.
1271 ;;;;
1272 ;; Get rid of the Edit menu bar item to save space.
1273 ;(define-key map [menu-bar edit] 'undefined)
1275 (define-key map [menu-bar subdir]
1276 (cons "Subdir" (make-sparse-keymap "Subdir")))
1278 (define-key map [menu-bar subdir hide-all]
1279 '(menu-item "Hide All" dired-hide-all
1280 :help "Hide all subdirectories, leave only header lines"))
1281 (define-key map [menu-bar subdir hide-subdir]
1282 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1283 :help "Hide or unhide current directory listing"))
1284 (define-key map [menu-bar subdir tree-down]
1285 '(menu-item "Tree Down" dired-tree-down
1286 :help "Go to first subdirectory header down the tree"))
1287 (define-key map [menu-bar subdir tree-up]
1288 '(menu-item "Tree Up" dired-tree-up
1289 :help "Go to first subdirectory header up the tree"))
1290 (define-key map [menu-bar subdir up]
1291 '(menu-item "Up Directory" dired-up-directory
1292 :help "Edit the parent directory"))
1293 (define-key map [menu-bar subdir prev-subdir]
1294 '(menu-item "Prev Subdir" dired-prev-subdir
1295 :help "Go to previous subdirectory header line"))
1296 (define-key map [menu-bar subdir next-subdir]
1297 '(menu-item "Next Subdir" dired-next-subdir
1298 :help "Go to next subdirectory header line"))
1299 (define-key map [menu-bar subdir prev-dirline]
1300 '(menu-item "Prev Dirline" dired-prev-dirline
1301 :help "Move to next directory-file line"))
1302 (define-key map [menu-bar subdir next-dirline]
1303 '(menu-item "Next Dirline" dired-next-dirline
1304 :help "Move to previous directory-file line"))
1305 (define-key map [menu-bar subdir insert]
1306 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1307 :help "Insert contents of subdirectory"))
1309 (define-key map [menu-bar immediate]
1310 (cons "Immediate" (make-sparse-keymap "Immediate")))
1312 (define-key map
1313 [menu-bar immediate tumme-dired-display-external]
1314 '(menu-item "Display Image Externally" tumme-dired-display-external
1315 :help "Display image in external viewer"))
1316 (define-key map
1317 [menu-bar immediate tumme-dired-display-image]
1318 '(menu-item "Display Image" tumme-dired-display-image
1319 :help "Display sized image in a separate window"))
1321 (define-key map [menu-bar immediate dashes-4]
1322 '("--"))
1324 (define-key map [menu-bar immediate revert-buffer]
1325 '(menu-item "Refresh" revert-buffer
1326 :help "Update contents of shown directories"))
1328 (define-key map [menu-bar immediate dashes]
1329 '("--"))
1331 (define-key map [menu-bar immediate compare-directories]
1332 '(menu-item "Compare Directories..." dired-compare-directories
1333 :help "Mark files with different attributes in two dired buffers"))
1334 (define-key map [menu-bar immediate backup-diff]
1335 '(menu-item "Compare with Backup" dired-backup-diff
1336 :help "Diff file at cursor with its latest backup"))
1337 (define-key map [menu-bar immediate diff]
1338 '(menu-item "Diff..." dired-diff
1339 :help "Compare file at cursor with another file"))
1340 (define-key map [menu-bar immediate view]
1341 '(menu-item "View This File" dired-view-file
1342 :help "Examine file at cursor in read-only mode"))
1343 (define-key map [menu-bar immediate display]
1344 '(menu-item "Display in Other Window" dired-display-file
1345 :help "Display file at cursor in other window"))
1346 (define-key map [menu-bar immediate find-file-other-window]
1347 '(menu-item "Find in Other Window" dired-find-file-other-window
1348 :help "Edit file at cursor in other window"))
1349 (define-key map [menu-bar immediate find-file]
1350 '(menu-item "Find This File" dired-find-file
1351 :help "Edit file at cursor"))
1352 (define-key map [menu-bar immediate create-directory]
1353 '(menu-item "Create Directory..." dired-create-directory))
1354 (define-key map [menu-bar immediate wdired-mode]
1355 '(menu-item "Edit File Names" wdired-change-to-wdired-mode))
1357 (define-key map [menu-bar regexp]
1358 (cons "Regexp" (make-sparse-keymap "Regexp")))
1360 (define-key map
1361 [menu-bar regexp tumme-mark-tagged-files]
1362 '(menu-item "Mark From Image Tag..." tumme-mark-tagged-files
1363 :help "Mark files whose image tags matches regexp"))
1365 (define-key map [menu-bar regexp dashes-1]
1366 '("--"))
1368 (define-key map [menu-bar regexp downcase]
1369 '(menu-item "Downcase" dired-downcase
1370 ;; When running on plain MS-DOS, there's only one
1371 ;; letter-case for file names.
1372 :enable (or (not (fboundp 'msdos-long-file-names))
1373 (msdos-long-file-names))
1374 :help "Rename marked files to lower-case name"))
1375 (define-key map [menu-bar regexp upcase]
1376 '(menu-item "Upcase" dired-upcase
1377 :enable (or (not (fboundp 'msdos-long-file-names))
1378 (msdos-long-file-names))
1379 :help "Rename marked files to upper-case name"))
1380 (define-key map [menu-bar regexp hardlink]
1381 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1382 :help "Make hard links for files matching regexp"))
1383 (define-key map [menu-bar regexp symlink]
1384 '(menu-item "Symlink..." dired-do-symlink-regexp
1385 :visible (fboundp 'make-symbolic-link)
1386 :help "Make symbolic links for files matching regexp"))
1387 (define-key map [menu-bar regexp rename]
1388 '(menu-item "Rename..." dired-do-rename-regexp
1389 :help "Rename marked files matching regexp"))
1390 (define-key map [menu-bar regexp copy]
1391 '(menu-item "Copy..." dired-do-copy-regexp
1392 :help "Copy marked files matching regexp"))
1393 (define-key map [menu-bar regexp flag]
1394 '(menu-item "Flag..." dired-flag-files-regexp
1395 :help "Flag files matching regexp for deletion"))
1396 (define-key map [menu-bar regexp mark]
1397 '(menu-item "Mark..." dired-mark-files-regexp
1398 :help "Mark files matching regexp for future operations"))
1399 (define-key map [menu-bar regexp mark-cont]
1400 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1401 :help "Mark files whose contents matches regexp"))
1403 (define-key map [menu-bar mark]
1404 (cons "Mark" (make-sparse-keymap "Mark")))
1406 (define-key map [menu-bar mark prev]
1407 '(menu-item "Previous Marked" dired-prev-marked-file
1408 :help "Move to previous marked file"))
1409 (define-key map [menu-bar mark next]
1410 '(menu-item "Next Marked" dired-next-marked-file
1411 :help "Move to next marked file"))
1412 (define-key map [menu-bar mark marks]
1413 '(menu-item "Change Marks..." dired-change-marks
1414 :help "Replace marker with another character"))
1415 (define-key map [menu-bar mark unmark-all]
1416 '(menu-item "Unmark All" dired-unmark-all-marks))
1417 (define-key map [menu-bar mark symlinks]
1418 '(menu-item "Mark Symlinks" dired-mark-symlinks
1419 :visible (fboundp 'make-symbolic-link)
1420 :help "Mark all symbolic links"))
1421 (define-key map [menu-bar mark directories]
1422 '(menu-item "Mark Directories" dired-mark-directories
1423 :help "Mark all directories except `.' and `..'"))
1424 (define-key map [menu-bar mark directory]
1425 '(menu-item "Mark Old Backups" dired-clean-directory
1426 :help "Flag old numbered backups for deletion"))
1427 (define-key map [menu-bar mark executables]
1428 '(menu-item "Mark Executables" dired-mark-executables
1429 :help "Mark all executable files"))
1430 (define-key map [menu-bar mark garbage-files]
1431 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1432 :help "Flag unneeded files for deletion"))
1433 (define-key map [menu-bar mark backup-files]
1434 '(menu-item "Flag Backup Files" dired-flag-backup-files
1435 :help "Flag all backup files for deletion"))
1436 (define-key map [menu-bar mark auto-save-files]
1437 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1438 :help "Flag auto-save files for deletion"))
1439 (define-key map [menu-bar mark deletion]
1440 '(menu-item "Flag" dired-flag-file-deletion
1441 :help "Flag current line's file for deletion"))
1442 (define-key map [menu-bar mark unmark]
1443 '(menu-item "Unmark" dired-unmark
1444 :help "Unmark or unflag current line's file"))
1445 (define-key map [menu-bar mark mark]
1446 '(menu-item "Mark" dired-mark
1447 :help "Mark current line's file for future operations"))
1448 (define-key map [menu-bar mark toggle-marks]
1449 '(menu-item "Toggle Marks" dired-toggle-marks
1450 :help "Mark unmarked files, unmark marked ones"))
1452 (define-key map [menu-bar operate]
1453 (cons "Operate" (make-sparse-keymap "Operate")))
1455 (define-key map [menu-bar operate dashes-2]
1456 '("--"))
1458 (define-key map
1459 [menu-bar operate tumme-delete-tag]
1460 '(menu-item "Delete Image Tag..." tumme-delete-tag
1461 :help "Delete image tag from current or marked files"))
1462 (define-key map
1463 [menu-bar operate tumme-tag-files]
1464 '(menu-item "Add Image Tags..." tumme-tag-files
1465 :help "Add image tags to current or marked files"))
1466 (define-key map
1467 [menu-bar operate tumme-dired-comment-files]
1468 '(menu-item "Add Image Comment..." tumme-dired-comment-files
1469 :help "Add image comment to current or marked files"))
1470 (define-key map
1471 [menu-bar operate tumme-display-thumbs]
1472 '(menu-item "Display Thumbnails" tumme-display-thumbs
1473 :help "Display thumbnails for current or marked image files"))
1475 (define-key map [menu-bar operate dashes-3]
1476 '("--"))
1478 (define-key map [menu-bar operate query-replace]
1479 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1480 :help "Replace regexp in marked files"))
1481 (define-key map [menu-bar operate search]
1482 '(menu-item "Search Files..." dired-do-search
1483 :help "Search marked files for regexp"))
1484 (define-key map [menu-bar operate chown]
1485 '(menu-item "Change Owner..." dired-do-chown
1486 :visible (not (memq system-type '(ms-dos windows-nt)))
1487 :help "Change the owner of marked files"))
1488 (define-key map [menu-bar operate chgrp]
1489 '(menu-item "Change Group..." dired-do-chgrp
1490 :visible (not (memq system-type '(ms-dos windows-nt)))
1491 :help "Change the group of marked files"))
1492 (define-key map [menu-bar operate chmod]
1493 '(menu-item "Change Mode..." dired-do-chmod
1494 :help "Change mode (attributes) of marked files"))
1495 (define-key map [menu-bar operate touch]
1496 '(menu-item "Change Timestamp..." dired-do-touch
1497 :help "Change timestamp of marked files"))
1498 (define-key map [menu-bar operate load]
1499 '(menu-item "Load" dired-do-load
1500 :help "Load marked Emacs Lisp files"))
1501 (define-key map [menu-bar operate compile]
1502 '(menu-item "Byte-compile" dired-do-byte-compile
1503 :help "Byte-compile marked Emacs Lisp files"))
1504 (define-key map [menu-bar operate compress]
1505 '(menu-item "Compress" dired-do-compress
1506 :help "Compress/uncompress marked files"))
1507 (define-key map [menu-bar operate print]
1508 '(menu-item "Print..." dired-do-print
1509 :help "Ask for print command and print marked files"))
1510 (define-key map [menu-bar operate hardlink]
1511 '(menu-item "Hardlink to..." dired-do-hardlink
1512 :help "Make hard links for current or marked files"))
1513 (define-key map [menu-bar operate symlink]
1514 '(menu-item "Symlink to..." dired-do-symlink
1515 :visible (fboundp 'make-symbolic-link)
1516 :help "Make symbolic links for current or marked files"))
1517 (define-key map [menu-bar operate command]
1518 '(menu-item "Shell Command..." dired-do-shell-command
1519 :help "Run a shell command on each of marked files"))
1520 (define-key map [menu-bar operate delete]
1521 '(menu-item "Delete" dired-do-delete
1522 :help "Delete current file or all marked files"))
1523 (define-key map [menu-bar operate rename]
1524 '(menu-item "Rename to..." dired-do-rename
1525 :help "Rename current file or move marked files"))
1526 (define-key map [menu-bar operate copy]
1527 '(menu-item "Copy to..." dired-do-copy
1528 :help "Copy current file or all marked files"))
1530 map)
1531 "Local keymap for `dired-mode' buffers.")
1532 \f
1533 ;; Dired mode is suitable only for specially formatted data.
1534 (put 'dired-mode 'mode-class 'special)
1536 ;; Autoload cookie needed by desktop.el
1537 ;;;###autoload
1538 (defun dired-mode (&optional dirname switches)
1539 "\
1542 \(optionally) its subdirectories, in the format of `ls -lR'.
1545 compress, load or byte-compile them, change their file attributes
1548 by file or all files matching certain criteria.
1550 Letters no longer insert themselves. Digits are prefix arguments.
1553 Most commands operate on the marked files and use the current file
1554 if no files are marked. Use a numeric prefix argument to operate on
1555 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1556 to operate on the current file only. Prefix arguments override marks.
1558 to see why something went wrong.
1563 (or dired it in another buffer, if it is a directory).
1570 This retains all marks and hides subdirs again that were hidden before.
1571 SPC and DEL can be used to move down and up by lines.
1574 to read the
1576 to relist a single or the marked files or a
1578 again for the directory tree.
1581 for more info):
1583 `dired-listing-switches'
1584 `dired-trivial-filenames'
1585 `dired-shrink-to-fit'
1586 `dired-marker-char'
1587 `dired-del-marker'
1588 `dired-keep-marker-rename'
1589 `dired-keep-marker-copy'
1590 `dired-keep-marker-hardlink'
1591 `dired-keep-marker-symlink'
1595 `dired-before-readin-hook'
1596 `dired-after-readin-hook'
1597 `dired-mode-hook'
1598 `dired-load-hook'
1600 Keybindings:
1602 ;; Not to be called interactively (e.g. dired-directory will be set
1603 ;; to default-directory, which is wrong with wildcards).
1604 (kill-all-local-variables)
1605 (use-local-map dired-mode-map)
1606 (dired-advertise) ; default-directory is already set
1607 (setq major-mode 'dired-mode
1608 mode-name "Dired"
1609 ;; case-fold-search nil
1610 buffer-read-only t
1611 selective-display t ; for subdirectory hiding
1612 mode-line-buffer-identification
1613 (propertized-buffer-identification "%17b"))
1614 (set (make-local-variable 'revert-buffer-function)
1615 (function dired-revert))
1616 (set (make-local-variable 'buffer-stale-function)
1617 (function dired-buffer-stale-p))
1618 (set (make-local-variable 'page-delimiter)
1620 (set (make-local-variable 'dired-directory)
1621 (or dirname default-directory))
1622 ;; list-buffers uses this to display the dir being edited in this buffer.
1623 (set (make-local-variable 'list-buffers-directory)
1624 (expand-file-name (if (listp dired-directory)
1625 (car dired-directory)
1626 dired-directory)))
1627 (set (make-local-variable 'dired-actual-switches)
1628 (or switches dired-listing-switches))
1629 (set (make-local-variable 'font-lock-defaults)
1630 '(dired-font-lock-keywords t nil nil beginning-of-line))
1631 (set (make-local-variable 'desktop-save-buffer)
1632 'dired-desktop-buffer-misc-data)
1633 (setq dired-switches-alist nil)
1634 (dired-sort-other dired-actual-switches t)
1635 (when (featurep 'dnd)
1636 (set (make-local-variable 'dnd-protocol-alist)
1637 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1638 (run-mode-hooks 'dired-mode-hook))
1639 \f
1640 ;; Idiosyncratic dired commands that don't deal with marks.
1642 (defun dired-summary ()
1643 "Summarize basic Dired commands and show recent dired errors."
1644 (interactive)
1645 (dired-why)
1646 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1647 (message
1648 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1650 (defun dired-undo ()
1651 "Undo in a dired buffer.
1652 This doesn't recover lost files, it just undoes changes in the buffer itself.
1653 You can use it to recover marks, killed lines or subdirs."
1654 (interactive)
1655 (let (buffer-read-only)
1656 (undo))
1657 (dired-build-subdir-alist)
1658 (message "Change in dired buffer undone.
1659 Actual changes in files cannot be undone by Emacs."))
1661 (defun dired-next-line (arg)
1662 "Move down lines then position at filename.
1663 Optional prefix ARG says how many lines to move; default is one line."
1664 (interactive "p")
1665 (next-line arg)
1666 (dired-move-to-filename))
1668 (defun dired-previous-line (arg)
1669 "Move up lines then position at filename.
1670 Optional prefix ARG says how many lines to move; default is one line."
1671 (interactive "p")
1672 (previous-line arg)
1673 (dired-move-to-filename))
1675 (defun dired-next-dirline (arg &optional opoint)
1676 "Goto ARG'th next directory file line."
1677 (interactive "p")
1678 (or opoint (setq opoint (point)))
1679 (if (if (> arg 0)
1680 (re-search-forward dired-re-dir nil t arg)
1681 (beginning-of-line)
1682 (re-search-backward dired-re-dir nil t (- arg)))
1683 (dired-move-to-filename) ; user may type `i' or `f'
1684 (goto-char opoint)
1685 (error "No more subdirectories")))
1687 (defun dired-prev-dirline (arg)
1688 "Goto ARG'th previous directory file line."
1689 (interactive "p")
1690 (dired-next-dirline (- arg)))
1692 (defun dired-up-directory (&optional other-window)
1693 "Run Dired on parent directory of current directory.
1694 Find the parent directory either in this buffer or another buffer.
1695 Creates a buffer if necessary."
1696 (interactive "P")
1697 (let* ((dir (dired-current-directory))
1698 (up (file-name-directory (directory-file-name dir))))
1699 (or (dired-goto-file (directory-file-name dir))
1700 ;; Only try dired-goto-subdir if buffer has more than one dir.
1701 (and (cdr dired-subdir-alist)
1702 (dired-goto-subdir up))
1703 (progn
1704 (if other-window
1705 (dired-other-window up)
1706 (dired up))
1707 (dired-goto-file dir)))))
1709 (defun dired-get-file-for-visit ()
1710 "Get the current line's file name, with an error if file does not exist."
1711 (interactive)
1712 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1713 (let ((raw (dired-get-filename nil t))
1714 file-name)
1715 (if (null raw)
1716 (error "No file on this line"))
1717 (setq file-name (file-name-sans-versions raw t))
1718 (if (file-exists-p file-name)
1719 file-name
1720 (if (file-symlink-p file-name)
1721 (error "File is a symlink to a nonexistent target")
1722 (error "File no longer exists; type `g' to update dired buffer")))))
1724 ;; Force `f' rather than `e' in the mode doc:
1725 (defalias 'dired-advertised-find-file 'dired-find-file)
1726 (defun dired-find-file ()
1727 "In Dired, visit the file or directory named on this line."
1728 (interactive)
1729 ;; Bind `find-file-run-dired' so that the command works on directories
1730 ;; too, independent of the user's setting.
1731 (let ((find-file-run-dired t))
1732 (find-file (dired-get-file-for-visit))))
1734 (defun dired-find-alternate-file ()
1735 "In Dired, visit this file or directory instead of the dired buffer."
1736 (interactive)
1737 (set-buffer-modified-p nil)
1738 (find-alternate-file (dired-get-file-for-visit)))
1739 ;; Don't override the setting from .emacs.
1740 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1742 (defun dired-mouse-find-file-other-window (event)
1743 "In Dired, visit the file or directory name you click on."
1744 (interactive "e")
1745 (let (window pos file)
1746 (save-excursion
1747 (setq window (posn-window (event-end event))
1748 pos (posn-point (event-end event)))
1749 (if (not (windowp window))
1750 (error "No file chosen"))
1751 (set-buffer (window-buffer window))
1752 (goto-char pos)
1753 (setq file (dired-get-file-for-visit)))
1754 (if (file-directory-p file)
1755 (or (and (cdr dired-subdir-alist)
1756 (dired-goto-subdir file))
1757 (progn
1758 (select-window window)
1759 (dired-other-window file)))
1760 (select-window window)
1761 (find-file-other-window (file-name-sans-versions file t)))))
1763 (defun dired-view-file ()
1764 "In Dired, examine a file in view mode, returning to Dired when done.
1765 When file is a directory, show it in this buffer if it is inserted.
1766 Otherwise, display it in another buffer."
1767 (interactive)
1768 (let ((file (dired-get-file-for-visit)))
1769 (if (file-directory-p file)
1770 (or (and (cdr dired-subdir-alist)
1771 (dired-goto-subdir file))
1772 (dired file))
1773 (view-file file))))
1775 (defun dired-find-file-other-window ()
1776 "In Dired, visit this file or directory in another window."
1777 (interactive)
1778 (find-file-other-window (dired-get-file-for-visit)))
1780 (defun dired-display-file ()
1781 "In Dired, display this file or directory in another window."
1782 (interactive)
1783 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1784 \f
1785 ;;; Functions for extracting and manipulating file names in Dired buffers.
1787 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1788 "In Dired, return name of file mentioned on this line.
1789 Value returned normally includes the directory name.
1790 Optional arg LOCALP with value `no-dir' means don't include directory
1791 name in result. A value of `verbatim' means to return the name exactly as
1792 it occurs in the buffer, and a value of t means construct name relative to
1793 `default-directory', which still may contain slashes if in a subdirectory.
1794 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1795 regular filenames and return nil if no filename on this line.
1796 Otherwise, an error occurs in these cases."
1797 (let (case-fold-search file p1 p2 already-absolute)
1798 (save-excursion
1799 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1800 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1801 ;; nil if no file on this line, but no-error-if-not-filep is t:
1802 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1803 (progn
1804 ;; Get rid of the mouse-face property that file names have.
1805 (set-text-properties 0 (length file) nil file)
1806 ;; Unquote names quoted by ls or by dired-insert-directory.
1807 ;; Using read to unquote is much faster than substituting
1809 (setq file
1810 (read
1812 ;; Some ls -b don't escape quotes, argh!
1813 ;; This is not needed for GNU ls, though.
1814 (or (dired-string-replace-match
1816 file)
1818 ;; The above `read' will return a unibyte string if FILE
1819 ;; contains eight-bit-control/graphic characters.
1820 (if (and enable-multibyte-characters
1821 (not (multibyte-string-p file)))
1822 (setq file (string-to-multibyte file)))))
1823 (and file (file-name-absolute-p file)
1824 ;; A relative file name can start with ~.
1825 ;; Don't treat it as absolute in this context.
1826 (not (eq (aref file 0) ?~))
1827 (setq already-absolute t))
1828 (cond
1829 ((null file)
1830 nil)
1831 ((eq localp 'verbatim)
1832 file)
1833 ((and (not no-error-if-not-filep)
1834 (member file '("." "..")))
1835 (error "Cannot operate on `.' or `..'"))
1836 ((and (eq localp 'no-dir) already-absolute)
1837 (file-name-nondirectory file))
1838 (already-absolute
1839 (let ((handler (find-file-name-handler file nil)))
1840 ;; check for safe-magic property so that we won't
1841 ;; put /: for names that don't really need them.
1842 ;; For instance, .gz files when auto-compression-mode is on.
1843 (if (and handler (not (get handler 'safe-magic)))
1844 (concat "/:" file)
1845 file)))
1846 ((eq localp 'no-dir)
1847 file)
1848 ((equal (dired-current-directory) "/")
1849 (setq file (concat (dired-current-directory localp) file))
1850 (let ((handler (find-file-name-handler file nil)))
1851 ;; check for safe-magic property so that we won't
1852 ;; put /: for names that don't really need them.
1853 ;; For instance, .gz files when auto-compression-mode is on.
1854 (if (and handler (not (get handler 'safe-magic)))
1855 (concat "/:" file)
1856 file)))
1857 (t
1858 (concat (dired-current-directory localp) file)))))
1860 (defun dired-string-replace-match (regexp string newtext
1861 &optional literal global)
1862 "Replace first match of REGEXP in STRING with NEWTEXT.
1863 If it does not match, nil is returned instead of the new string.
1864 Optional arg LITERAL means to take NEWTEXT literally.
1865 Optional arg GLOBAL means to replace all matches."
1866 (if global
1867 (let ((start 0) ret)
1868 (while (string-match regexp string start)
1869 (let ((from-end (- (length string) (match-end 0))))
1870 (setq ret (setq string (replace-match newtext t literal string)))
1871 (setq start (- (length string) from-end))))
1872 ret)
1873 (if (not (string-match regexp string 0))
1874 nil
1875 (replace-match newtext t literal string))))
1877 (defun dired-make-absolute (file &optional dir)
1878 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
1879 ;; We can't always use expand-file-name as this would get rid of `.'
1880 ;; or expand in / instead default-directory if DIR=="".
1881 ;; This should be good enough for ange-ftp, but might easily be
1882 ;; redefined (for VMS?).
1883 ;; It should be reasonably fast, though, as it is called in
1884 ;; dired-get-filename.
1885 (concat (or dir default-directory) file))
1887 (defun dired-make-relative (file &optional dir ignore)
1888 "Convert FILE (an absolute file name) to a name relative to DIR.
1889 If this is impossible, return FILE unchanged.
1890 DIR must be a directory name, not a file name."
1891 (or dir (setq dir default-directory))
1892 ;; This case comes into play if default-directory is set to
1893 ;; use ~.
1894 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1895 (setq dir (expand-file-name dir)))
1896 (if (string-match (concat "^" (regexp-quote dir)) file)
1897 (substring file (match-end 0))
1898 ;;; (or no-error
1899 ;;; (error "%s: not in directory tree growing at %s" file dir))
1900 file))
1901 \f
1902 ;;; Functions for finding the file name in a dired buffer line.
1904 (defvar dired-permission-flags-regexp
1906 "Regular expression to match the permission flags in `ls -l'.")
1908 ;; Move to first char of filename on this line.
1909 ;; Returns position (point) or nil if no filename on this line."
1910 (defun dired-move-to-filename (&optional raise-error eol)
1911 "Move to the beginning of the filename on the current line.
1912 Return the position of the beginning of the filename, or nil if none found."
1913 ;; This is the UNIX version.
1914 (or eol (setq eol (line-end-position)))
1915 (beginning-of-line)
1916 ;; First try assuming `ls --dired' was used.
1917 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
1918 (cond
1919 ((and change (< change eol))
1920 (goto-char change))
1921 ((re-search-forward directory-listing-before-filename-regexp eol t)
1922 (goto-char (match-end 0)))
1923 ((re-search-forward dired-permission-flags-regexp eol t)
1924 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
1925 (if raise-error
1926 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
1927 (beginning-of-line)
1928 nil)
1929 (raise-error
1930 (error "No file on this line")))))
1932 (defun dired-move-to-end-of-filename (&optional no-error)
1933 ;; Assumes point is at beginning of filename,
1934 ;; thus the rwx bit re-search-backward below will succeed in *this*
1935 ;; line if at all. So, it should be called only after
1936 ;; (dired-move-to-filename t).
1937 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1938 ;; This is the UNIX version.
1939 (if (get-text-property (point) 'dired-filename)
1940 (goto-char (next-single-property-change (point) 'dired-filename))
1941 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1942 ;; case-fold-search is nil now, so we can test for capital F:
1943 (setq used-F (string-match "F" dired-actual-switches)
1944 opoint (point)
1945 eol (save-excursion (end-of-line) (point))
1946 hidden (and selective-display
1948 (if hidden
1949 nil
1950 (save-excursion ;; Find out what kind of file this is:
1951 ;; Restrict perm bits to be non-blank,
1952 ;; otherwise this matches one char to early (looking backward):
1953 ;; "l---------" (some systems make symlinks that way)
1954 ;; "----------" (plain file with zero perms)
1955 (if (re-search-backward
1956 dired-permission-flags-regexp nil t)
1957 (setq file-type (char-after (match-beginning 1))
1958 symlink (eq file-type ?l)
1959 ;; Only with -F we need to know whether it's an executable
1960 executable (and
1961 used-F
1962 (string-match
1963 "[xst]" ;; execute bit set anywhere?
1964 (concat
1965 (match-string 2)
1966 (match-string 3)
1967 (match-string 4)))))
1968 (or no-error (error "No file on this line"))))
1969 ;; Move point to end of name:
1970 (if symlink
1971 (if (search-forward " -> " eol t)
1972 (progn
1973 (forward-char -4)
1974 (and used-F
1975 dired-ls-F-marks-symlinks
1976 (eq (preceding-char) ?@) ;; did ls really mark the link?
1977 (forward-char -1))))
1978 (goto-char eol) ;; else not a symbolic link
1979 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
1980 ;; one trailing character. (Executable bits on symlinks ain't mean
1981 ;; a thing, even to ls, but we know it's not a symlink.)
1982 (and used-F
1983 (or (memq file-type '(?d ?s ?p))
1984 executable)
1985 (forward-char -1))))
1986 (or no-error
1987 (not (eq opoint (point)))
1988 (error (if hidden
1989 (substitute-command-keys
1991 "No file on this line")))
1992 (if (eq opoint (point))
1993 nil
1994 (point)))))
1996 \f
1997 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
1999 (defun dired-copy-filename-as-kill (&optional arg)
2000 "Copy names of marked (or next ARG) files into the kill ring.
2001 The names are separated by a space.
2002 With a zero prefix arg, use the absolute file name of each marked file.
2004 `default-directory'. (This still may contain slashes if in a subdirectory.)
2006 If on a subdir headerline, use absolute subdirname instead;
2007 prefix arg and marked files are ignored in this case.
2010 (interactive "P")
2011 (let ((string
2012 (or (dired-get-subdir)
2013 (mapconcat (function identity)
2014 (if arg
2015 (cond ((zerop (prefix-numeric-value arg))
2016 (dired-get-marked-files))
2017 ((consp arg)
2018 (dired-get-marked-files t))
2019 (t
2020 (dired-get-marked-files
2021 'no-dir (prefix-numeric-value arg))))
2022 (dired-get-marked-files 'no-dir))
2023 " "))))
2024 (if (eq last-command 'kill-region)
2025 (kill-append string nil)
2026 (kill-new string))
2027 (message "%s" string)))
2029 \f
2030 ;; Keeping Dired buffers in sync with the filesystem and with each other
2032 (defun dired-buffers-for-dir (dir &optional file)
2033 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
2034 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2035 ;; matches FILE.
2036 ;; The list is in reverse order of buffer creation, most recent last.
2037 ;; As a side effect, killed dired buffers for DIR are removed from
2038 ;; dired-buffers.
2039 (setq dir (file-name-as-directory dir))
2040 (let ((alist dired-buffers) result elt buf)
2041 (while alist
2042 (setq elt (car alist)
2043 buf (cdr elt))
2044 (if (buffer-name buf)
2045 (if (dired-in-this-tree dir (car elt))
2046 (with-current-buffer buf
2047 (and (assoc dir dired-subdir-alist)
2048 (or (null file)
2049 (let ((wildcards
2050 (file-name-nondirectory dired-directory)))
2051 (or (= 0 (length wildcards))
2052 (string-match (dired-glob-regexp wildcards)
2053 file))))
2054 (setq result (cons buf result)))))
2055 ;; else buffer is killed - clean up:
2056 (setq dired-buffers (delq elt dired-buffers)))
2057 (setq alist (cdr alist)))
2058 result))
2060 (defun dired-glob-regexp (pattern)
2061 "Convert glob-pattern PATTERN to a regular expression."
2062 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2063 regexp)
2064 (while (string-match "[[?*]" pattern matched-in-pattern)
2065 (let ((op-end (match-end 0))
2066 (next-op (aref pattern (match-beginning 0))))
2067 (setq regexp (concat regexp
2068 (regexp-quote
2069 (substring pattern matched-in-pattern
2070 (match-beginning 0)))))
2071 (cond ((= next-op ??)
2072 (setq regexp (concat regexp "."))
2073 (setq matched-in-pattern op-end))
2074 ((= next-op ?\[)
2075 ;; Fails to handle ^ yet ????
2076 (let* ((set-start (match-beginning 0))
2077 (set-cont
2078 (if (= (aref pattern (1+ set-start)) ?^)
2079 (+ 3 set-start)
2080 (+ 2 set-start)))
2081 (set-end (string-match "]" pattern set-cont))
2082 (set (substring pattern set-start (1+ set-end))))
2083 (setq regexp (concat regexp set))
2084 (setq matched-in-pattern (1+ set-end))))
2085 ((= next-op ?*)
2086 (setq regexp (concat regexp ".*"))
2087 (setq matched-in-pattern op-end)))))
2089 regexp
2090 (regexp-quote
2091 (substring pattern matched-in-pattern))
2096 (defun dired-advertise ()
2097 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2098 ;; With wildcards we actually advertise too much.
2099 (let ((expanded-default (expand-file-name default-directory)))
2100 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2101 t ; we have already advertised ourselves
2102 (setq dired-buffers
2103 (cons (cons expanded-default (current-buffer))
2104 dired-buffers)))))
2106 (defun dired-unadvertise (dir)
2107 ;; Remove DIR from the buffer alist in variable dired-buffers.
2108 ;; This has the effect of removing any buffer whose main directory is DIR.
2109 ;; It does not affect buffers in which DIR is a subdir.
2110 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2111 (setq dired-buffers
2112 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2113 \f
2114 ;; Tree Dired
2116 ;;; utility functions
2118 (defun dired-in-this-tree (file dir)
2119 ;;"Is FILE part of the directory tree starting at DIR?"
2120 (let (case-fold-search)
2121 (string-match (concat "^" (regexp-quote dir)) file)))
2123 (defun dired-normalize-subdir (dir)
2124 ;; Prepend default-directory to DIR if relative file name.
2125 ;; dired-get-filename must be able to make a valid file name from a
2126 ;; file and its directory DIR.
2127 (file-name-as-directory
2128 (if (file-name-absolute-p dir)
2129 dir
2130 (expand-file-name dir default-directory))))
2132 (defun dired-get-subdir ()
2133 ;;"Return the subdir name on this line, or nil if not on a headerline."
2134 ;; Look up in the alist whether this is a headerline.
2135 (save-excursion
2136 (let ((cur-dir (dired-current-directory)))
2137 (beginning-of-line) ; alist stores b-o-l positions
2138 (and (zerop (- (point)
2139 (dired-get-subdir-min (assoc cur-dir
2140 dired-subdir-alist))))
2141 cur-dir))))
2143 ;(defun dired-get-subdir-min (elt)
2144 ; (cdr elt))
2145 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2146 (defalias 'dired-get-subdir-min 'cdr)
2148 (defun dired-get-subdir-max (elt)
2149 (save-excursion
2150 (goto-char (dired-get-subdir-min elt))
2151 (dired-subdir-max)))
2153 (defun dired-clear-alist ()
2154 (while dired-subdir-alist
2155 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2156 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2158 (defun dired-subdir-index (dir)
2159 ;; Return an index into alist for use with nth
2160 ;; for the sake of subdir moving commands.
2161 (let (found (index 0) (alist dired-subdir-alist))
2162 (while alist
2163 (if (string= dir (car (car alist)))
2164 (setq alist nil found t)
2165 (setq alist (cdr alist) index (1+ index))))
2166 (if found index nil)))
2168 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2169 "Go to next subdirectory, regardless of level."
2170 ;; Use 0 arg to go to this directory's header line.
2171 ;; NO-SKIP prevents moving to end of header line, returning whatever
2172 ;; position was found in dired-subdir-alist.
2173 (interactive "p")
2174 (let ((this-dir (dired-current-directory))
2175 pos index)
2176 ;; nth with negative arg does not return nil but the first element
2177 (setq index (- (dired-subdir-index this-dir) arg))
2178 (setq pos (if (>= index 0)
2179 (dired-get-subdir-min (nth index dired-subdir-alist))))
2180 (if pos
2181 (progn
2182 (goto-char pos)
2184 (point))
2185 (if no-error-if-not-found
2186 nil ; return nil if not found
2187 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2189 (defun dired-build-subdir-alist (&optional switches)
2190 "Build `dired-subdir-alist' by parsing the buffer.
2191 Returns the new value of the alist.
2192 If optional arg SWITCHES is non-nil, use its value
2193 instead of `dired-actual-switches'."
2194 (interactive)
2195 (dired-clear-alist)
2196 (save-excursion
2197 (let* ((count 0)
2198 (buffer-read-only nil)
2199 (buffer-undo-list t)
2200 (switches (or switches dired-actual-switches))
2201 new-dir-name
2202 (R-ftp-base-dir-regex
2203 ;; Used to expand subdirectory names correctly in recursive
2204 ;; ange-ftp listings.
2205 (and (string-match "R" switches)
2208 (goto-char (point-min))
2209 (setq dired-subdir-alist nil)
2210 (while (re-search-forward dired-subdir-regexp nil t)
2211 ;; Avoid taking a file name ending in a colon
2212 ;; as a subdir name.
2213 (unless (save-excursion
2214 (goto-char (match-beginning 0))
2215 (beginning-of-line)
2216 (forward-char 2)
2217 (save-match-data (looking-at dired-re-perms)))
2218 (save-excursion
2219 (goto-char (match-beginning 1))
2220 (setq new-dir-name
2221 (buffer-substring-no-properties (point) (match-end 1))
2222 new-dir-name
2223 (save-match-data
2224 (if (and R-ftp-base-dir-regex
2225 (not (string= new-dir-name default-directory))
2226 (string-match R-ftp-base-dir-regex new-dir-name))
2227 (concat default-directory
2228 (substring new-dir-name (match-end 0)))
2229 (expand-file-name new-dir-name))))
2230 (delete-region (point) (match-end 1))
2231 (insert new-dir-name))
2232 (setq count (1+ count))
2233 (dired-alist-add-1 new-dir-name
2234 ;; Place a sub directory boundary between lines.
2235 (save-excursion
2236 (goto-char (match-beginning 0))
2237 (beginning-of-line)
2238 (point-marker)))))
2239 (if (and (> count 1) (interactive-p))
2240 (message "Buffer includes %d directories" count)))
2241 ;; We don't need to sort it because it is in buffer order per
2242 ;; constructionem. Return new alist:
2243 dired-subdir-alist))
2245 (defun dired-alist-add-1 (dir new-marker)
2246 ;; Add new DIR at NEW-MARKER. Don't sort.
2247 (setq dired-subdir-alist
2248 (cons (cons (dired-normalize-subdir dir) new-marker)
2249 dired-subdir-alist)))
2251 (defun dired-goto-next-nontrivial-file ()
2252 ;; Position point on first nontrivial file after point.
2253 (dired-goto-next-file);; so there is a file to compare with
2254 (if (stringp dired-trivial-filenames)
2255 (while (and (not (eobp))
2256 (string-match dired-trivial-filenames
2257 (file-name-nondirectory
2258 (or (dired-get-filename nil t) ""))))
2259 (forward-line 1)
2260 (dired-move-to-filename))))
2262 (defun dired-goto-next-file ()
2263 (let ((max (1- (dired-subdir-max))))
2264 (while (and (not (dired-move-to-filename)) (< (point) max))
2265 (forward-line 1))))
2267 (defun dired-goto-file (file)
2268 "Go to line describing file FILE in this dired buffer."
2269 ;; Return value of point on success, else nil.
2270 ;; FILE must be an absolute file name.
2273 ;; it in the buffer.
2274 (interactive
2275 (prog1 ; let push-mark display its message
2276 (list (expand-file-name
2277 (read-file-name "Goto file: "
2278 (dired-current-directory))))
2279 (push-mark)))
2280 (setq file (directory-file-name file)) ; does no harm if no directory
2281 (let (found case-fold-search dir)
2282 (setq dir (or (file-name-directory file)
2283 (error "File name `%s' is not absolute" file)))
2284 (save-excursion
2285 ;; The hair here is to get the result of dired-goto-subdir
2286 ;; without really calling it if we don't have any subdirs.
2287 (if (if (string= dir (expand-file-name default-directory))
2288 (goto-char (point-min))
2289 (and (cdr dired-subdir-alist)
2290 (dired-goto-subdir dir)))
2291 (let ((base (file-name-nondirectory file))
2292 search-string
2293 (boundary (dired-subdir-max)))
2294 (setq search-string
2296 (setq search-string
2298 (while (and (not found)
2299 ;; filenames are preceded by SPC, this makes
2300 ;; the search faster (e.g. for the filename "-"!).
2301 (search-forward (concat " " search-string)
2302 boundary 'move))
2303 ;; Match could have BASE just as initial substring or
2304 ;; or in permission bits or date or
2305 ;; not be a proper filename at all:
2306 (if (equal base (dired-get-filename 'no-dir t))
2307 ;; Must move to filename since an (actually
2308 ;; correct) match could have been elsewhere on the
2309 ;; ;; line (e.g. "-" would match somewhere in the
2310 ;; permission bits).
2311 (setq found (dired-move-to-filename))
2312 ;; If this isn't the right line, move forward to avoid
2313 ;; trying this line again.
2314 (forward-line 1))))))
2315 (and found
2316 ;; return value of point (i.e., FOUND):
2317 (goto-char found))))
2319 (defun dired-initial-position (dirname)
2320 ;; Where point should go in a new listing of DIRNAME.
2321 ;; Point assumed at beginning of new subdir line.
2322 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2323 (end-of-line)
2324 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2325 \f
2326 ;; These are hooks which make tree dired work.
2327 ;; They are in this file because other parts of dired need to call them.
2328 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2330 ;; This function is called for each retrieved filename.
2331 ;; It could stand to be faster, though it's mostly function call
2332 ;; overhead. Avoiding the function call seems to save about 10% in
2333 ;; dired-get-filename. Make it a defsubst?
2334 (defun dired-current-directory (&optional localp)
2335 "Return the name of the subdirectory to which this line belongs.
2336 This returns a string with trailing slash, like `default-directory'.
2337 Optional argument means return a file name relative to `default-directory'."
2338 (let ((here (point))
2339 (alist (or dired-subdir-alist
2340 ;; probably because called in a non-dired buffer
2341 (error "No subdir-alist in %s" (current-buffer))))
2342 elt dir)
2343 (while alist
2344 (setq elt (car alist)
2345 dir (car elt)
2346 ;; use `<=' (not `<') as subdir line is part of subdir
2347 alist (if (<= (dired-get-subdir-min elt) here)
2348 nil ; found
2349 (cdr alist))))
2350 (if localp
2351 (dired-make-relative dir default-directory)
2352 dir)))
2354 ;; Subdirs start at the beginning of their header lines and end just
2355 ;; before the beginning of the next header line (or end of buffer).
2357 (defun dired-subdir-max ()
2358 (save-excursion
2359 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2360 (point-max)
2361 (point))))
2362 \f
2363 ;; Deleting files
2365 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
2366 "*Decide whether recursive deletes are allowed.
2367 nil means no recursive deletes.
2368 `always' means delete recursively without asking. This is DANGEROUS!
2369 `top' means ask for each directory at top level, but delete its subdirectories
2370 without asking.
2371 Anything else means ask for each directory."
2372 :type '(choice :tag "Delete non-empty directories"
2373 (const :tag "Yes" always)
2374 (const :tag "No--only delete empty directories" nil)
2375 (const :tag "Confirm for each directory" t)
2376 (const :tag "Confirm for each top directory only" top))
2377 :group 'dired)
2379 ;; Match anything but `.' and `..'.
2382 ;; Delete file, possibly delete a directory and all its files.
2383 ;; This function is usefull outside of dired. One could change it's name
2384 ;; to e.g. recursive-delete-file and put it somewhere else.
2385 (defun dired-delete-file (file &optional recursive) "\
2386 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2387 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2388 nil, do not delete.
2389 `always', delete recursively without asking.
2390 `top', ask for each directory at top level.
2391 Anything else, ask for each sub-directory."
2392 (let (files)
2393 ;; This test is equivalent to
2394 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2395 ;; but more efficient
2396 (if (not (eq t (car (file-attributes file))))
2397 (delete-file file)
2398 (when (and recursive
2399 (setq files
2400 (directory-files file t dired-re-no-dot)) ; Not empty.
2401 (or (eq recursive 'always)
2402 (yes-or-no-p (format "Recursive delete of %s? "
2403 (dired-make-relative file)))))
2404 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2405 (while files ; Recursively delete (possibly asking).
2406 (dired-delete-file (car files) recursive)
2407 (setq files (cdr files))))
2408 (delete-directory file))))
2410 (defun dired-do-flagged-delete (&optional nomessage)
2411 "In Dired, delete the files flagged for deletion.
2412 If NOMESSAGE is non-nil, we don't display any message
2413 if there are no flagged files."
2414 (interactive)
2415 (let* ((dired-marker-char dired-del-marker)
2416 (regexp (dired-marker-regexp))
2417 case-fold-search)
2418 (if (save-excursion (goto-char (point-min))
2419 (re-search-forward regexp nil t))
2420 (dired-internal-do-deletions
2421 ;; this can't move point since ARG is nil
2422 (dired-map-over-marks (cons (dired-get-filename) (point))
2423 nil)
2424 nil)
2425 (or nomessage
2426 (message "(No deletions requested)")))))
2428 (defun dired-do-delete (&optional arg)
2429 "Delete all marked (or next ARG) files."
2430 ;; This is more consistent with the file marking feature than
2431 ;; dired-do-flagged-delete.
2432 (interactive "P")
2433 (dired-internal-do-deletions
2434 ;; this may move point if ARG is an integer
2435 (dired-map-over-marks (cons (dired-get-filename) (point))
2436 arg)
2437 arg))
2439 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2441 (defun dired-internal-do-deletions (l arg)
2442 ;; L is an alist of files to delete, with their buffer positions.
2443 ;; ARG is the prefix arg.
2444 ;; Filenames are absolute (VMS needs this for logical search paths).
2445 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2446 ;; That way as changes are made in the buffer they do not shift the
2447 ;; lines still to be changed, so the (point) values in L stay valid.
2448 ;; Also, for subdirs in natural order, a subdir's files are deleted
2449 ;; before the subdir itself - the other way around would not work.
2450 (let ((files (mapcar (function car) l))
2451 (count (length l))
2452 (succ 0))
2453 ;; canonicalize file list for pop up
2454 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2455 (if (dired-mark-pop-up
2456 " *Deletions*" 'delete files dired-deletion-confirmer
2457 (format "Delete %s " (dired-mark-prompt arg files)))
2458 (save-excursion
2459 (let (failures);; files better be in reverse order for this loop!
2460 (while l
2461 (goto-char (cdr (car l)))
2462 (let (buffer-read-only)
2463 (condition-case err
2464 (let ((fn (car (car l))))
2465 (dired-delete-file fn dired-recursive-deletes)
2466 ;; if we get here, removing worked
2467 (setq succ (1+ succ))
2468 (message "%s of %s deletions" succ count)
2469 (dired-fun-in-all-buffers
2470 (file-name-directory fn) (file-name-nondirectory fn)
2471 (function dired-delete-entry) fn))
2472 (error;; catch errors from failed deletions
2474 (setq failures (cons (car (car l)) failures)))))
2475 (setq l (cdr l)))
2476 (if (not failures)
2477 (message "%d deletion%s done" count (dired-plural-s count))
2478 (dired-log-summary
2479 (format "%d of %d deletion%s failed"
2480 (length failures) count
2481 (dired-plural-s count))
2482 failures))))
2483 (message "(No deletions performed)")))
2484 (dired-move-to-filename))
2486 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2487 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2488 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2489 ;; (FILE does not include a directory component.)
2490 ;; FILE may be nil, in which case ignore it.
2491 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2492 (let (success-list)
2493 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2494 file))
2495 (with-current-buffer buf
2496 (if (apply fun args)
2497 (setq success-list (cons (buffer-name buf) success-list)))))
2498 success-list))
2500 ;; Delete the entry for FILE from
2501 (defun dired-delete-entry (file)
2502 (save-excursion
2503 (and (dired-goto-file file)
2504 (let (buffer-read-only)
2505 (delete-region (progn (beginning-of-line) (point))
2506 (save-excursion (forward-line 1) (point))))))
2507 (dired-clean-up-after-deletion file))
2509 ;; This is a separate function for the sake of dired-x.el.
2510 (defun dired-clean-up-after-deletion (fn)
2511 ;; Clean up after a deleted file or directory FN.
2512 (save-excursion (and (cdr dired-subdir-alist)
2513 (dired-goto-subdir fn)
2514 (dired-kill-subdir))))
2515 \f
2516 ;; Confirmation
2518 (defun dired-marker-regexp ()
2519 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2521 (defun dired-plural-s (count)
2522 (if (= 1 count) "" "s"))
2524 (defun dired-mark-prompt (arg files)
2525 ;; Return a string for use in a prompt, either the current file
2526 ;; name, or the marker and a count of marked files.
2527 (let ((count (length files)))
2528 (if (= count 1)
2529 (car files)
2530 ;; more than 1 file:
2531 (if (integerp arg)
2532 ;; abs(arg) = count
2533 ;; Perhaps this is nicer, but it also takes more screen space:
2534 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2535 ;; count)
2536 (format "[next %d files]" arg)
2537 (format "%c [%d files]" dired-marker-char count)))))
2539 (defun dired-pop-to-buffer (buf)
2540 ;; Pop up buffer BUF.
2541 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2542 (if (not dired-shrink-to-fit)
2543 (pop-to-buffer (get-buffer-create buf))
2544 ;; let window shrink to fit:
2545 (let ((window (selected-window))
2546 target-lines w2)
2547 (cond ;; if split-height-threshold is enabled, use the largest window
2548 ((and (> (window-height (setq w2 (get-largest-window)))
2549 split-height-threshold)
2550 (= (frame-width) (window-width w2)))
2551 (setq window w2))
2552 ;; if the least-recently-used window is big enough, use it
2553 ((and (> (window-height (setq w2 (get-lru-window)))
2554 (* 2 window-min-height))
2555 (= (frame-width) (window-width w2)))
2556 (setq window w2)))
2557 (save-excursion
2558 (set-buffer buf)
2559 (goto-char (point-max))
2561 (setq target-lines (count-lines (point-min) (point)))
2562 ;; Don't forget to count the last line.
2563 (if (not (bolp))
2564 (setq target-lines (1+ target-lines))))
2565 (if (<= (window-height window) (* 2 window-min-height))
2566 ;; At this point, every window on the frame is too small to split.
2567 (setq w2 (display-buffer buf))
2568 (setq w2 (split-window window
2569 (max window-min-height
2570 (- (window-height window)
2571 (1+ (max window-min-height target-lines)))))))
2572 (set-window-buffer w2 buf)
2573 (if (< (1- (window-height w2)) target-lines)
2574 (progn
2575 (select-window w2)
2576 (enlarge-window (- target-lines (1- (window-height w2))))))
2577 (set-window-start w2 1)
2578 )))
2580 (defcustom dired-no-confirm nil
2581 "A list of symbols for commands Dired should not confirm.
2582 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2583 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2584 `touch' and `uncompress'."
2585 :group 'dired
2586 :type '(set (const byte-compile) (const chgrp)
2587 (const chmod) (const chown) (const compress)
2588 (const copy) (const delete) (const hardlink)
2589 (const load) (const move) (const print)
2590 (const shell) (const symlink) (const touch)
2591 (const uncompress)))
2593 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2594 "Return FUNCTION's result on ARGS after showing which files are marked.
2595 Displays the file names in a buffer named BUFNAME;
2597 This uses function `dired-pop-to-buffer' to do that.
2599 FUNCTION should not manipulate files, just read input
2600 (an argument or confirmation).
2601 The window is not shown if there is just one file or
2602 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2603 FILES is the list of marked files. It can also be (t FILENAME)
2604 in the case of one marked file, to distinguish that from using
2605 just the current file."
2606 (or bufname (setq bufname " *Marked Files*"))
2607 (if (or (eq dired-no-confirm t)
2608 (memq op-symbol dired-no-confirm)
2609 ;; If FILES defaulted to the current line's file.
2610 (= (length files) 1))
2611 (apply function args)
2612 (with-current-buffer (get-buffer-create bufname)
2613 (erase-buffer)
2614 ;; Handle (t FILE) just like (FILE), here.
2615 ;; That value is used (only in some cases), to mean
2616 ;; just one file that was marked, rather than the current line file.
2617 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2618 (remove-text-properties (point-min) (point-max)
2619 '(mouse-face nil help-echo nil)))
2620 (save-window-excursion
2621 (dired-pop-to-buffer bufname)
2622 (apply function args))))
2624 (defun dired-format-columns-of-files (files)
2625 ;; Files should be in forward order for this loop.
2626 ;; i.e., (car files) = first file in buffer.
2627 ;; Returns the number of lines used.
2628 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2629 (width (- (window-width (selected-window)) 2))
2630 (columns (max 1 (/ width maxlen)))
2631 (nfiles (length files))
2632 (rows (+ (/ nfiles columns)
2633 (if (zerop (% nfiles columns)) 0 1)))
2634 (i 0)
2635 (j 0))
2636 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2637 (make-list (- (* columns rows) nfiles) "")))
2638 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2639 (while (< j rows)
2640 (while (< i columns)
2641 (indent-to (* i maxlen))
2642 (insert (car files))
2643 (setq files (nthcdr rows files)
2644 i (1+ i)))
2646 (setq i 0
2647 j (1+ j)
2648 files (cdr files)))
2649 rows))
2650 \f
2651 ;; Commands to mark or flag file(s) at or near current line.
2653 (defun dired-repeat-over-lines (arg function)
2654 ;; This version skips non-file lines.
2655 (let ((pos (make-marker)))
2656 (beginning-of-line)
2657 (while (and (> arg 0) (not (eobp)))
2658 (setq arg (1- arg))
2659 (beginning-of-line)
2660 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2661 (save-excursion
2662 (forward-line 1)
2663 (move-marker pos (1+ (point))))
2664 (save-excursion (funcall function))
2665 ;; Advance to the next line--actually, to the line that *was* next.
2666 ;; (If FUNCTION inserted some new lines in between, skip them.)
2667 (goto-char pos))
2668 (while (and (< arg 0) (not (bobp)))
2669 (setq arg (1+ arg))
2670 (forward-line -1)
2671 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2672 (beginning-of-line)
2673 (save-excursion (funcall function)))
2674 (move-marker pos nil)
2675 (dired-move-to-filename)))
2677 (defun dired-between-files ()
2678 ;; This used to be a regexp match of the `total ...' line output by
2679 ;; ls, which is slightly faster, but that is not very robust; notably,
2680 ;; it fails for non-english locales.
2681 (save-excursion (not (dired-move-to-filename))))
2683 (defun dired-next-marked-file (arg &optional wrap opoint)
2684 "Move to the next marked file, wrapping around the end of the buffer."
2686 (or opoint (setq opoint (point)));; return to where interactively started
2687 (if (if (> arg 0)
2688 (re-search-forward dired-re-mark nil t arg)
2689 (beginning-of-line)
2690 (re-search-backward dired-re-mark nil t (- arg)))
2691 (dired-move-to-filename)
2692 (if (null wrap)
2693 (progn
2694 (goto-char opoint)
2695 (error "No next marked file"))
2696 (message "(Wraparound for next marked file)")
2697 (goto-char (if (> arg 0) (point-min) (point-max)))
2698 (dired-next-marked-file arg nil opoint))))
2700 (defun dired-prev-marked-file (arg &optional wrap)
2701 "Move to the previous marked file, wrapping around the end of the buffer."
2703 (dired-next-marked-file (- arg) wrap))
2705 (defun dired-file-marker (file)
2706 ;; Return FILE's marker, or nil if unmarked.
2707 (save-excursion
2708 (and (dired-goto-file file)
2709 (progn
2710 (beginning-of-line)
2712 (following-char))))))
2714 (defun dired-mark-files-in-region (start end)
2715 (let (buffer-read-only)
2716 (if (> start end)
2717 (error "start > end"))
2718 (goto-char start) ; assumed at beginning of line
2719 (while (< (point) end)
2720 ;; Skip subdir line and following garbage like the `total' line:
2721 (while (and (< (point) end) (dired-between-files))
2722 (forward-line 1))
2723 (if (and (not (looking-at dired-re-dot))
2724 (dired-get-filename nil t))
2725 (progn
2726 (delete-char 1)
2727 (insert dired-marker-char)))
2728 (forward-line 1))))
2730 (defun dired-mark (arg)
2731 "Mark the current (or next ARG) files.
2732 If on a subdir headerline, mark all its files except `.' and `..'.
2736 this subdir."
2737 (interactive "P")
2738 (if (dired-get-subdir)
2739 (save-excursion (dired-mark-subdir-files))
2740 (let (buffer-read-only)
2741 (dired-repeat-over-lines
2742 (prefix-numeric-value arg)
2743 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2745 (defun dired-unmark (arg)
2746 "Unmark the current (or next ARG) files.
2747 If looking at a subdir, unmark all its files except `.' and `..'."
2748 (interactive "P")
2750 (dired-mark arg)))
2752 (defun dired-flag-file-deletion (arg)
2753 "In Dired, flag the current line's file for deletion.
2754 With prefix arg, repeat over several lines.
2756 If on a subdir headerline, mark all its files except `.' and `..'."
2757 (interactive "P")
2758 (let ((dired-marker-char dired-del-marker))
2759 (dired-mark arg)))
2761 (defun dired-unmark-backward (arg)
2762 "In Dired, move up lines and remove deletion flag there.
2763 Optional prefix ARG says how many lines to unflag; default is one line."
2764 (interactive "p")
2765 (dired-unmark (- arg)))
2767 (defun dired-toggle-marks ()
2768 "Toggle marks: marked files become unmarked, and vice versa.
2769 Files marked with other flags (such as `D') are not affected.
2770 `.' and `..' are never toggled.
2771 As always, hidden subdirs are not affected."
2772 (interactive)
2773 (save-excursion
2774 (goto-char (point-min))
2775 (let (buffer-read-only)
2776 (while (not (eobp))
2777 (or (dired-between-files)
2778 (looking-at dired-re-dot)
2779 ;; use subst instead of insdel because it does not move
2780 ;; the gap and thus should be faster and because
2781 ;; other characters are left alone automatically
2782 (apply 'subst-char-in-region
2783 (point) (1+ (point))
2787 (forward-line 1)))))
2788 \f
2789 ;;; Commands to mark or flag files based on their characteristics or names.
2791 (defvar dired-regexp-history nil
2792 "History list of regular expressions used in Dired commands.")
2794 (defun dired-read-regexp (prompt)
2795 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2797 (defun dired-mark-files-regexp (regexp &optional marker-char)
2798 "Mark all files matching REGEXP for use in later commands.
2799 A prefix argument means to unmark them instead.
2800 `.' and `..' are never marked.
2803 object files--just `.o' will mark more than you might think."
2804 (interactive
2805 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2806 " files (regexp): "))
2808 (let ((dired-marker-char (or marker-char dired-marker-char)))
2809 (dired-mark-if
2810 (and (not (looking-at dired-re-dot))
2811 (not (eolp)) ; empty line
2812 (let ((fn (dired-get-filename nil t)))
2813 (and fn (string-match regexp (file-name-nondirectory fn)))))
2814 "matching file")))
2816 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2817 "Mark all files with contents containing REGEXP for use in later commands.
2818 A prefix argument means to unmark them instead.
2819 `.' and `..' are never marked."
2820 (interactive
2821 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2822 " files containing (regexp): "))
2824 (let ((dired-marker-char (or marker-char dired-marker-char)))
2825 (dired-mark-if
2826 (and (not (looking-at dired-re-dot))
2827 (not (eolp)) ; empty line
2828 (let ((fn (dired-get-filename nil t)))
2829 (when (and fn (file-readable-p fn)
2830 (not (file-directory-p fn)))
2831 (let ((prebuf (get-file-buffer fn)))
2832 (message "Checking %s" fn)
2833 ;; For now we do it inside emacs
2834 ;; Grep might be better if there are a lot of files
2835 (if prebuf
2836 (with-current-buffer prebuf
2837 (save-excursion
2838 (goto-char (point-min))
2839 (re-search-forward regexp nil t)))
2840 (with-temp-buffer
2841 (insert-file-contents fn)
2842 (goto-char (point-min))
2843 (re-search-forward regexp nil t))))
2844 )))
2845 "matching file")))
2847 (defun dired-flag-files-regexp (regexp)
2848 "In Dired, flag all files containing the specified REGEXP for deletion.
2849 The match is against the non-directory part of the filename. Use `^'
2850 and `$' to anchor matches. Exclude subdirs by hiding them.
2851 `.' and `..' are never flagged."
2852 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2853 (dired-mark-files-regexp regexp dired-del-marker))
2855 (defun dired-mark-symlinks (unflag-p)
2856 "Mark all symbolic links.
2857 With prefix argument, unflag all those files."
2858 (interactive "P")
2860 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2862 (defun dired-mark-directories (unflag-p)
2863 "Mark all directory file lines except `.' and `..'.
2864 With prefix argument, unflag all those files."
2865 (interactive "P")
2867 (dired-mark-if (and (looking-at dired-re-dir)
2868 (not (looking-at dired-re-dot)))
2869 "directory file")))
2871 (defun dired-mark-executables (unflag-p)
2872 "Mark all executable files.
2873 With prefix argument, unflag all those files."
2874 (interactive "P")
2876 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2878 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2879 ;; files for which PREDICATE returns non-nil.
2881 (defun dired-flag-auto-save-files (&optional unflag-p)
2882 "Flag for deletion files whose names suggest they are auto save files.
2883 A prefix argument says to unflag those files instead."
2884 (interactive "P")
2886 (dired-mark-if
2887 ;; It is less than general to check for # here,
2888 ;; but it's the only way this runs fast enough.
2889 (and (save-excursion (end-of-line)
2890 (or
2891 (eq (preceding-char) ?#)
2892 ;; Handle executables in case of -F option.
2893 ;; We need not worry about the other kinds
2894 ;; of markings that -F makes, since they won't
2895 ;; appear on real auto-save files.
2896 (if (eq (preceding-char) ?*)
2897 (progn
2898 (forward-char -1)
2899 (eq (preceding-char) ?#)))))
2900 (not (looking-at dired-re-dir))
2901 (let ((fn (dired-get-filename t t)))
2902 (if fn (auto-save-file-name-p
2903 (file-name-nondirectory fn)))))
2904 "auto save file")))
2906 (defcustom dired-garbage-files-regexp
2907 ;; `log' here is dubious, since it's typically used for useful log
2908 ;; files, not just TeX stuff. -- fx
2909 (concat (regexp-opt
2910 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
2913 :type 'regexp
2914 :group 'dired)
2916 (defun dired-flag-garbage-files ()
2917 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2918 (interactive)
2919 (dired-flag-files-regexp dired-garbage-files-regexp))
2921 (defun dired-flag-backup-files (&optional unflag-p)
2922 "Flag all backup files (names ending with `~') for deletion.
2923 With prefix argument, unflag these files."
2924 (interactive "P")
2925 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
2926 (dired-mark-if
2927 ;; Don't call backup-file-name-p unless the last character looks like
2928 ;; it might be the end of a backup file name. This isn't very general,
2929 ;; but it's the only way this runs fast enough.
2930 (and (save-excursion (end-of-line)
2931 ;; Handle executables in case of -F option.
2932 ;; We need not worry about the other kinds
2933 ;; of markings that -F makes, since they won't
2934 ;; appear on real backup files.
2935 (if (eq (preceding-char) ?*)
2936 (forward-char -1))
2937 (eq (preceding-char) ?~))
2938 (not (looking-at dired-re-dir))
2939 (let ((fn (dired-get-filename t t)))
2940 (if fn (backup-file-name-p fn))))
2941 "backup file")))
2943 (defun dired-change-marks (&optional old new)
2944 "Change all OLD marks to NEW marks.
2945 OLD and NEW are both characters used to mark files."
2946 (interactive
2947 (let* ((cursor-in-echo-area t)
2948 (old (progn (message "Change (old mark): ") (read-char)))
2949 (new (progn (message "Change %c marks to (new mark): " old)
2950 (read-char))))
2951 (list old new)))
2953 (ding)
2955 (buffer-read-only))
2956 (save-excursion
2957 (goto-char (point-min))
2958 (while (search-forward string nil t)
2959 (if (if (= old ?\s)
2960 (save-match-data
2961 (dired-get-filename 'no-dir t))
2962 t)
2963 (subst-char-in-region (match-beginning 0)
2964 (match-end 0) old new)))))))
2966 (defun dired-unmark-all-marks ()
2967 "Remove all marks from all files in the dired buffer."
2968 (interactive)
2971 (defun dired-unmark-all-files (mark &optional arg)
2972 "Remove a specific mark (or any mark) from every file.
2973 After this command, type the mark character to remove,
2974 or type RET to remove all marks.
2975 With prefix arg, query for each marked file.
2978 (save-excursion
2979 (let* ((count 0)
2980 buffer-read-only case-fold-search query
2982 (help-form "\
2983 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2984 `!' to unmark all remaining files with no more questions."))
2985 (goto-char (point-min))
2987 (re-search-forward dired-re-mark nil t)
2988 (search-forward string nil t))
2989 (if (or (not arg)
2990 (let ((file (dired-get-filename t t)))
2991 (and file
2992 (dired-query 'query "Unmark file `%s'? "
2993 file))))
2994 (progn (subst-char-in-region (1- (point)) (point)
2995 (preceding-char) ?\s)
2996 (setq count (1+ count)))))
2997 (message (if (= count 1) "1 mark removed"
2998 "%d marks removed")
2999 count))))
3000 \f
3001 ;; Logging failures operating on files, and showing the results.
3003 (defvar dired-log-buffer "*Dired log*")
3005 (defun dired-why ()
3006 "Pop up a buffer with error log output from Dired.
3007 A group of errors from a single command ends with a formfeed.
3009 (interactive)
3010 (if (get-buffer dired-log-buffer)
3011 (let ((owindow (selected-window))
3012 (window (display-buffer (get-buffer dired-log-buffer))))
3013 (unwind-protect
3014 (progn
3015 (select-window window)
3016 (goto-char (point-max))
3017 (forward-line -1)
3018 (backward-page 1)
3019 (recenter 0))
3020 (select-window owindow)))))
3022 (defun dired-log (log &rest args)
3023 ;; Log a message or the contents of a buffer.
3024 ;; If LOG is a string and there are more args, it is formatted with
3026 ;; End each bunch of errors with (dired-log t):
3027 ;; this inserts the current time and buffer at the start of the page,
3029 (let ((obuf (current-buffer)))
3030 (with-current-buffer (get-buffer-create dired-log-buffer)
3031 (goto-char (point-max))
3032 (let ((inhibit-read-only t))
3033 (cond ((stringp log)
3034 (insert (if args
3035 (apply (function format) log args)
3036 log)))
3037 ((bufferp log)
3038 (insert-buffer-substring log))
3039 ((eq t log)
3040 (backward-page 1)
3041 (unless (bolp)
3043 (insert (current-time-string)
3045 (goto-char (point-max))
3048 (defun dired-log-summary (string failures)
3049 "State a summary of a command's failures, in echo area and log buffer.
3050 STRING is an overall summary of the failures.
3051 FAILURES is a list of file names that we failed to operate on,
3052 or nil if file names are not applicable."
3053 (if (= (length failures) 1)
3054 (message "%s"
3055 (with-current-buffer dired-log-buffer
3056 (goto-char (point-max))
3057 (backward-page 1)
3058 (if (eolp) (forward-line 1))
3059 (buffer-substring (point) (point-max))))
3060 (message (if failures "%s--type ? for details (%s)"
3061 "%s--type ? for details")
3062 string failures))
3063 ;; Log a summary describing a bunch of errors.
3065 (dired-log t))
3066 \f
3067 ;;; Sorting
3069 ;; Most ls can only sort by name or by date (with -t), nothing else.
3070 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3071 ;; So anything that does not contain these is sort "by name".
3073 (defvar dired-ls-sorting-switches "SXU"
3076 This indicates to Dired which option switches to watch out for because they
3077 will change the sorting order behavior of `ls'.
3079 To change the default sorting order \(e.g. add a `-v' option\), see the
3080 variable `dired-listing-switches'. To temporarily override the listing
3083 (defvar dired-sort-by-date-regexp
3084 (concat "^-[^" dired-ls-sorting-switches
3085 "]*t[^" dired-ls-sorting-switches "]*$")
3086 "Regexp recognized by Dired to set `by date' mode.")
3088 (defvar dired-sort-by-name-regexp
3089 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3090 "Regexp recognized by Dired to set `by name' mode.")
3092 (defvar dired-sort-inhibit nil
3093 "Non-nil means the Dired sort command is disabled.
3094 The idea is to set this buffer-locally in special dired buffers.")
3096 (defun dired-sort-set-modeline ()
3097 ;; Set modeline display according to dired-actual-switches.
3098 ;; Modeline display of "by name" or "by date" guarantees the user a
3099 ;; match with the corresponding regexps. Non-matching switches are
3100 ;; shown literally.
3101 (when (eq major-mode 'dired-mode)
3102 (setq mode-name
3103 (let (case-fold-search)
3104 (cond ((string-match
3105 dired-sort-by-name-regexp dired-actual-switches)
3106 "Dired by name")
3107 ((string-match
3108 dired-sort-by-date-regexp dired-actual-switches)
3109 "Dired by date")
3110 (t
3111 (concat "Dired " dired-actual-switches)))))
3112 (force-mode-line-update)))
3114 (defun dired-sort-toggle-or-edit (&optional arg)
3115 "Toggle between sort by date/name and refresh the dired buffer.
3116 With a prefix argument you can edit the current listing switches instead."
3117 (interactive "P")
3118 (when dired-sort-inhibit
3119 (error "Cannot sort this dired buffer"))
3120 (if arg
3121 (dired-sort-other
3122 (read-string "ls switches (must contain -l): " dired-actual-switches))
3123 (dired-sort-toggle)))
3125 (defun dired-sort-toggle ()
3126 ;; Toggle between sort by date/name. Reverts the buffer.
3127 (setq dired-actual-switches
3128 (let (case-fold-search)
3129 (if (string-match " " dired-actual-switches)
3130 ;; New toggle scheme: add/remove a trailing " -t"
3132 (substring dired-actual-switches 0 (match-beginning 0))
3133 (concat dired-actual-switches " -t"))
3134 ;; old toggle scheme: look for some 't' switch and add/remove it
3135 (concat
3136 "-l"
3137 (dired-replace-in-string (concat "[-lt"
3138 dired-ls-sorting-switches "]")
3139 ""
3140 dired-actual-switches)
3141 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3142 dired-actual-switches)
3143 ""
3144 "t")))))
3145 (dired-sort-set-modeline)
3146 (revert-buffer))
3148 ;; Some user code loads dired especially for this.
3149 ;; Don't do that--use replace-regexp-in-string instead.
3150 (defun dired-replace-in-string (regexp newtext string)
3151 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3153 (let ((result "") (start 0) mb me)
3154 (while (string-match regexp string start)
3155 (setq mb (match-beginning 0)
3156 me (match-end 0)
3157 result (concat result (substring string start mb) newtext)
3158 start me))
3159 (concat result (substring string start))))
3161 (defun dired-sort-other (switches &optional no-revert)
3162 "Specify new `ls' SWITCHES for current dired buffer.
3163 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3164 set the minor mode accordingly, others appear literally in the mode line.
3165 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3166 (dired-sort-R-check switches)
3167 (setq dired-actual-switches switches)
3168 (dired-sort-set-modeline)
3169 (or no-revert (revert-buffer)))
3171 (defvar dired-subdir-alist-pre-R nil
3172 "Value of `dired-subdir-alist' before -R switch added.")
3173 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3175 (defun dired-sort-R-check (switches)
3176 "Additional processing of -R in ls option string SWITCHES.
3177 Saves `dired-subdir-alist' when R is set and restores saved value
3178 minus any directories explicitly deleted when R is cleared.
3179 To be called first in body of `dired-sort-other', etc."
3180 (cond
3181 ((and (string-match "R" switches)
3182 (not (string-match "R" dired-actual-switches)))
3183 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3184 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3185 ((and (string-match "R" dired-actual-switches)
3186 (not (string-match "R" switches)))
3187 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3188 ;; that are still present:
3189 (setq dired-subdir-alist
3190 (if dired-subdir-alist-pre-R
3191 (let (subdirs)
3192 (while dired-subdir-alist-pre-R
3193 (if (assoc (caar dired-subdir-alist-pre-R)
3194 dired-subdir-alist)
3195 ;; subdir still present...
3196 (setq subdirs
3197 (cons (car dired-subdir-alist-pre-R)
3198 subdirs)))
3199 (setq dired-subdir-alist-pre-R
3200 (cdr dired-subdir-alist-pre-R)))
3201 (reverse subdirs))
3202 ;; No pre-R subdir alist, so revert to main directory
3203 ;; listing:
3204 (list (car (reverse dired-subdir-alist))))))))
3205 \f
3207 ;;;; Drag and drop support
3209 (defcustom dired-recursive-copies nil
3210 "*Decide whether recursive copies are allowed.
3211 nil means no recursive copies.
3212 `always' means copy recursively without asking.
3213 `top' means ask for each directory at top level.
3214 Anything else means ask for each directory."
3215 :type '(choice :tag "Copy directories"
3216 (const :tag "No recursive copies" nil)
3217 (const :tag "Ask for each directory" t)
3218 (const :tag "Ask for each top directory only" top)
3219 (const :tag "Copy directories without asking" always))
3220 :group 'dired)
3222 (defun dired-dnd-popup-notice ()
3223 (message-box
3227 (defun dired-dnd-do-ask-action (uri)
3228 ;; No need to get actions and descriptions from the source,
3229 ;; we only have three actions anyway.
3230 (let ((action (x-popup-menu
3231 t
3232 (list "What action?"
3233 (cons ""
3234 '(("Copy here" . copy)
3235 ("Move here" . move)
3236 ("Link here" . link)
3237 "--"
3238 ("Cancel" . nil)))))))
3239 (if action
3240 (dired-dnd-handle-local-file uri action)
3241 nil)))
3243 (defun dired-dnd-handle-local-file (uri action)
3244 "Copy, move or link a file to the dired directory.
3245 URI is the file to handle, ACTION is one of copy, move, link or ask.
3246 Ask means pop up a menu for the user to select one of copy, move or link."
3247 (require 'dired-aux)
3248 (let* ((from (dnd-get-local-file-name uri t))
3249 (to (if from (concat (dired-current-directory)
3250 (file-name-nondirectory from))
3251 nil)))
3252 (if from
3253 (cond ((or (eq action 'copy)
3254 (eq action 'private)) ; Treat private as copy.
3256 ;; If copying a directory and dired-recursive-copies is nil,
3257 ;; dired-copy-file silently fails. Pop up a notice.
3258 (if (and (file-directory-p from)
3259 (not dired-recursive-copies))
3260 (dired-dnd-popup-notice)
3261 (progn
3262 (dired-copy-file from to 1)
3263 (dired-relist-entry to)
3264 action)))
3266 ((eq action 'move)
3267 (dired-rename-file from to 1)
3268 (dired-relist-entry to)
3269 action)
3271 ((eq action 'link)
3272 (make-symbolic-link from to 1)
3273 (dired-relist-entry to)
3274 action)
3276 ((eq action 'ask)
3277 (dired-dnd-do-ask-action uri))
3279 (t nil)))))
3281 (defun dired-dnd-handle-file (uri action)
3282 "Copy, move or link a file to the dired directory if it is a local file.
3283 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3284 ACTION is one of copy, move, link or ask.
3285 Ask means pop up a menu for the user to select one of copy, move or link."
3286 (let ((local-file (dnd-get-local-file-uri uri)))
3287 (if local-file (dired-dnd-handle-local-file local-file action)
3288 nil)))
3289 \f
3291 ;;;; Desktop support
3293 (eval-when-compile (require 'desktop))
3295 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3296 "Auxiliary information to be saved in desktop file."
3297 (cons
3298 ;; Value of `dired-directory'.
3299 (if (consp dired-directory)
3300 ;; Directory name followed by list of files.
3301 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3302 (cdr dired-directory))
3303 ;; Directory name, optionally with shell wildcard.
3304 (desktop-file-name dired-directory desktop-dirname))
3305 ;; Subdirectories in `dired-subdir-alist'.
3306 (cdr
3307 (nreverse
3308 (mapcar
3309 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3310 dired-subdir-alist)))))
3312 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3313 desktop-buffer-name
3314 desktop-buffer-misc)
3315 "Restore a dired buffer specified in a desktop file."
3316 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3317 ;; This value is a directory name, optionally with shell wildcard or
3318 ;; a directory name followed by list of files.
3319 (let* ((dired-dir (car desktop-buffer-misc))
3320 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3321 (if (file-directory-p (file-name-directory dir))
3322 (progn
3323 (dired dired-dir)
3324 ;; The following elements of `desktop-buffer-misc' are the keys
3325 ;; from `dired-subdir-alist'.
3326 (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3327 (current-buffer))
3328 (message "Desktop: Directory %s no longer exists." dir)
3329 (when desktop-missing-file-warning (sit-for 1))
3330 nil)))
3332 (add-to-list 'desktop-buffer-mode-handlers
3333 '(dired-mode . dired-restore-desktop-buffer))
3335 \f
3336 (if (eq system-type 'vax-vms)
3337 (load "dired-vms"))
3339 (provide 'dired)
3341 (run-hooks 'dired-load-hook) ; for your customizations
3343 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
3344 ;;; dired.el ends here