| blob | 4a9a637797cd37b496e313a59a57ddc4cc000a17 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 1997, 2000 Free Software Foundation, Inc.
5 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; This is a major mode for directory browsing and editing. It is
28 ;; documented in the Emacs manual.
30 ;; Rewritten in 1990/1991 to add tree features, file marking and
31 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
32 ;; Finished up by rms in 1992.
34 ;;; Code:
36 ;;; Customizable variables
39 "Directory editing."
43 "Handling marks in dired."
48 ;;;###autoload
50 "*Switches passed to `ls' for dired. MUST contain the `l' option.
51 May contain all other options that don't contradict `-l';
52 may contain even `F', `b', `i' and `s'. See also the variable
53 `dired-ls-F-marks-symlinks' concerning the `F' switch."
57 ; Don't use absolute paths as /bin should be in any PATH and people
58 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
59 ; usually not in PATH.
61 ;;;###autoload
64 "chown"
66 "/usr/sbin/chown"
73 ;;;###autoload
75 "*Informs dired about how `ls -lF' marks symbolic links.
76 Set this to t if `ls' (or whatever program is specified by
77 `insert-directory-program') with `-lF' marks the symbolic link
78 itself with a trailing @ (usually the case under Ultrix).
80 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
81 nil (the default), if it gives `bar@ -> foo', set it to t.
83 Dired checks if there is really a @ appended. Thus, if you have a
84 marking `ls' program on one host and a non-marking on another host, and
85 don't care about symbolic links which really end in a @, you can
86 always set this variable to t."
90 ;;;###autoload
92 "*Regexp of files to skip when finding first file of a directory.
93 A value of nil means move to the subdir line.
94 A value of t means move to first file."
97 regexp)
100 ;;;###autoload
102 ;; Use t as default so that moved files "take their markers with them".
103 "*Controls marking of renamed files.
104 If t, files keep their previous marks when they are renamed.
105 If a character, renamed files (whether previously marked or not)
106 are afterward marked with that character."
111 ;;;###autoload
113 "*Controls marking of copied files.
114 If t, copied files are marked if and as the corresponding original files were.
115 If a character, copied files are unconditionally marked with that character."
120 ;;;###autoload
122 "*Controls marking of newly made hard links.
123 If t, they are marked if and as the files linked to were marked.
124 If a character, new links are unconditionally marked with that character."
129 ;;;###autoload
131 "*Controls marking of newly made symbolic links.
132 If t, they are marked if and as the files linked to were marked.
133 If a character, new links are unconditionally marked with that character."
138 ;;;###autoload
140 "*If non-nil, dired tries to guess a default target directory.
141 This means: if there is a dired buffer displayed in the next window,
142 use its current subdir, instead of the current subdir of this dired buffer.
144 The target is used in the prompt for file copy, rename etc."
148 ;;;###autoload
150 "*If non-nil, Dired preserves the last-modified time in a file copy.
151 \(This works on only some systems.)"
156 "*Program to get the amount of free space on a file system.
157 We assume the output has the format of `df'.
158 The value of this variable must be just a command name or file name;
159 if you want to specify options, use `dired-free-space-args'.
161 A value of nil disables this feature."
166 "*Options to use when running `dired-free-space-program'."
170 ;;; Hook variables
173 "Run after loading dired.
183 "Hook run after each time a file or directory is read by Dired.
184 After each listing of a file or directory, this hook is run
186 ;; Note this can't simply be run inside function `dired-ls' as the hook
187 ;; functions probably depend on the dired-subdir-alist to be OK.
189 ;;; Internal variables
192 ;; so that you can write things like
193 ;; (let ((dired-marker-char ?X))
194 ;; ;; great code using X markers ...
195 ;; )
196 ;; For example, commands operating on two sets of files, A and B.
197 ;; Or marking files with digits 0-9. This could implicate
198 ;; concentric sets or an order for the marked files.
199 ;; The code depends on dynamic scoping on the marker char.
200 "In Dired, the current mark character.
207 t
208 ;; I see no reason ever to make this nil -- rms.
209 ;; (> baud-rate search-slow-speed)
217 "The directory name or shell wildcard that was used as argument to `ls'.
218 Local to each dired buffer. May be a list, in which case the car is the
227 ;; These regexps must be tested at beginning-of-line, but are also
228 ;; used to search for next matches, so neither omitting "^" nor
229 ;; replacing "^" by "\n" (to make it slightly faster) will work.
232 ;; "Regexp matching a marked line.
233 ;; Important: the match ends just after the marker."
235 ;; The [^:] part after "d" and "l" is to avoid confusion with the
236 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
244 "-[-r][-w].[-r][-w][xs][-r][-w]."
250 ;; The subdirectory names in this list are expanded.
252 "Association list of subdirectories and their buffer positions.
253 Each subdirectory has an element: (DIRNAME . STARTMARKER).
254 The order of elements is the reverse of the order in the buffer.
258 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
259 Subexpression 1 is the subdirectory proper, no trailing colon.
260 The match starts at the beginning of the line and ends after the end
266 ;;
267 ;; Directory headers.
269 ;;
270 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
271 ;; file name itself. We search for Dired defined regexps, and then use the
272 ;; Dired defined function `dired-move-to-filename' before searching for the
273 ;; simple regexp ".+". It is that regexp which matches the file name.
274 ;;
275 ;; Dired marks.
279 ;; People who are paranoid about security would consider this more
280 ;; important than other things such as whether it is a directory.
281 ;; But we don't want to encourage paranoia, so our default
282 ;; should be what's most useful for non-paranoids. -- rms.
283 ;;; ;;
284 ;;; ;; Files that are group or world writable.
285 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
286 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
287 ;;; '(1 font-lock-comment-face)
288 ;;; '(".+" (dired-move-to-filename) nil (0 font-lock-comment-face)))
289 ;;
290 ;; Subdirectories.
293 ;;
294 ;; Symbolic links.
297 ;;
298 ;; Files suffixed with `completion-ignored-extensions'.
301 ;; It is quicker to first find just an extension, then go back to the
302 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
306 \f
307 ;;; Macros must be defined before they are used, for the byte compiler.
309 ;; Mark all files for which CONDITION evals to non-nil.
310 ;; CONDITION is evaluated on each line, with point at beginning of line.
311 ;; MSG is a noun phrase for the type of files being marked.
312 ;; It should end with a noun that can be pluralized by adding `s'.
313 ;; Return value is the number of files marked, or nil if none were marked.
328 count
337 "Eval BODY with point on each marked line. Return a list of BODY's results.
338 If no marked file could be found, execute BODY on the current line.
339 If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
340 files instead of the marked files.
341 In that case point is dragged along. This is so that commands on
342 the next ARG (instead of the marked) files can be chained easily.
343 If ARG is otherwise non-nil, use current file instead.
344 If optional third arg SHOW-PROGRESS evaluates to non-nil,
345 redisplay the dired buffer after each file is processed.
346 No guarantee is made about the position on the marked line.
347 BODY must ensure this itself if it depends on this.
348 Search starts at the beginning of the buffer, thus the car of the list
349 corresponds to the line nearest to the buffer's bottom. This
350 is also true for (positive and negative) integer values of ARG.
351 BODY should not be too long as it is expanded four times."
352 ;;
353 ;;Warning: BODY must not add new lines before point - this may cause an
354 ;;endless loop.
355 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
362 ,arg
368 results))
369 ;; non-nil, non-integer ARG means use current file:
374 ;; remember position of next marked file before BODY
375 ;; can insert lines before the just found file,
376 ;; confusing us by finding the same marked file again
377 ;; and again and...
385 ;; move after last match
392 results
394 ;; save-excursion loses, again
398 "Return the marked files' names as list of strings.
399 The list is in the same order as the buffer, that is, the car is the
400 first marked file.
401 Values returned are normally absolute pathnames.
402 Optional arg LOCALP as in `dired-get-filename'.
403 Optional second argument ARG forces to use other files. If ARG is an
404 integer, use the next ARG files. If ARG is otherwise non-nil, use
405 current file. Usually ARG comes from the current prefix arg."
409 \f
410 ;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
411 ;; other special applications.
412 \f
413 ;; The dired command
416 ;; For use in interactive.
420 dired-listing-switches))
422 nil default-directory nil))))
424 ;;;###autoload (define-key ctl-x-map "d" 'dired)
425 ;;;###autoload
428 Optional second argument SWITCHES specifies the `ls' options used.
429 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
430 Dired displays a list of files in DIRNAME (which may also have
431 shell wildcards appended to select certain files). If DIRNAME is a cons,
432 its first element is taken as the directory name and the rest as an explicit
433 list of files to make directory entries for.
435 You can move around in it with the usual commands.
440 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
441 ;; Cannot use (interactive "D") because of wildcards.
445 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
446 ;;;###autoload
452 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
453 ;;;###autoload
459 ;;;###autoload
461 "Like `dired' but returns the dired buffer as value, does not select it."
463 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
464 ;; some shells make:
475 ;; If the argument was syntactically a directory name not a file name,
476 ;; or if it happens to name a file that is a directory,
477 ;; convert it syntactically to a directory name.
478 ;; The reason for checking initially-was-dirname
479 ;; and not just file-directory-p
480 ;; is that file-directory-p is slow over ftp.
488 ;; Separate function from dired-noselect for the sake of dired-vms.el.
490 ;; If there is an existing dired buffer for DIRNAME, just leave
491 ;; buffer as it is (don't even call dired-revert).
492 ;; This saves time especially for deep trees or with ange-ftp.
493 ;; The user can type `g'easily, and it is more consistent with find-file.
494 ;; But if SWITCHES are given they are probably different from the
495 ;; buffer's old value, so call dired-sort-other, which does
496 ;; revert the buffer.
497 ;; A pity we can't possibly do "Directory has changed - refresh? "
498 ;; like find-file does.
499 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
500 ;; see there.
502 ;; The following line used to use dir-or-list.
503 ;; That never found an existing buffer, in the case
504 ;; where it is a list.
506 ;; note that buffer already is in dired-mode, if found
511 ;; We don't want default-major-mode to run hooks and set auto-fill
512 ;; or whatever, now that dired-mode does not
513 ;; kill-all-local-variables any longer.
518 ;; file list may have changed
521 ;; this calls dired-revert
523 ;; If directory has changed on disk, offer to revert.
530 nil
534 ;; Else a new buffer
536 ;; We can do this unconditionally
537 ;; because dired-noselect ensures that the name
538 ;; is passed in directory name syntax
539 ;; if it was the name of a directory at all.
544 ;; default-directory and dired-actual-switches are set now
545 ;; (buffer-local), so we can call dired-readin:
550 ;; dired-readin can fail if parent directories are inaccessible.
551 ;; Don't leave an empty buffer around in that case.
553 ;; No need to narrow since the whole buffer contains just
554 ;; dired-readin's output, nothing else. The hook can
555 ;; successfully use dired functions (e.g. dired-get-filename)
556 ;; as the subdir-alist has been built in dired-readin.
561 buffer))
564 ;; Enlarged by dired-advertise
565 ;; Queried by function dired-buffers-for-dir. When this detects a
566 ;; killed buffer, it is removed from this list.
570 ;; This differs from dired-buffers-for-dir in that it does not consider
571 ;; subdirs of default-directory and searches for the first match only.
572 ;; Also, the major mode must be MODE.
585 blist nil)
587 found))
589 \f
590 ;; Read in a new dired buffer
592 ;; dired-readin differs from dired-insert-subdir in that it accepts
593 ;; wildcards, erases the buffer, and builds the subdir-alist anew
594 ;; (including making it buffer-local and clearing it first).
596 ;; default-directory and dired-actual-switches must be buffer-local
597 ;; and initialized by now.
598 ;; Thus we can test (equal default-directory dirname) instead of
599 ;; (file-directory-p dirname) and save a filesystem transaction.
600 ;; Also, we can run this hook which may want to modify the switches
601 ;; based on default-directory, e.g. with ange-ftp to a SysV host
602 ;; where ls won't understand -Al switches.
620 ;; We need this to make the root dir have a header line as all
621 ;; other subdirs have:
625 ;; can't run dired-after-readin-hook here, it may depend on the subdir
626 ;; alist to be OK.
627 )
629 ;; Must first make alist buffer local and set it to nil because
630 ;; dired-build-subdir-alist will call dired-clear-alist first
638 ;; Subroutines of dired-readin
641 ;; Just insert listing for the passed-in directory or
642 ;; directory-and-file list, assuming a clean buffer.
647 ;; Expand before comparing in case one or both have been abbreviated.
651 ;; If we are reading a whole single directory...
656 ;; Else assume it contains wildcards,
657 ;; unless it is an explicit list of files.
666 ;; Do the right thing whether dir-or-list is atomic or not. If it is,
667 ;; inset all files listed in the cdr (the car is the passed-in directory
668 ;; list).
671 end)
672 ;; We used to specify the C locale here, to force English month names;
673 ;; but this should not be necessary any more,
674 ;; with the new value of dired-move-to-filename-regexp.
676 ;; In this case, use the file names in the cdr
677 ;; exactly as originally given to dired-noselect.
681 ;; Expand the file name here because it may have been abbreviated
682 ;; in dired-noselect.
689 ;; Non-Posix systems don't always have dired-free-space-program,
690 ;; but might have an equivalent system call.
698 dired-free-space-args
710 ;; The dired-free-space-program failed; delete its output
713 ;; Quote certain characters, unless ls quoted them for us.
727 ;; Make the file names highlight when the mouse is on them.
743 ;; Insert DIR's headerline with no trailing slash, exactly like ls
744 ;; would, and put cursor where dired-build-subdir-alist puts subdir
745 ;; boundaries.
748 \f
749 ;; Reverting a dired buffer
752 ;; Reread the dired buffer. Must also be called after
753 ;; dired-actual-switches have changed.
754 ;; Should not fail even on completely garbaged buffers.
755 ;; Preserves old cursor, marks/flags, hidden-p.
763 buffer-read-only)
767 ;; treat top level dir extra (it may contain wildcards)
772 ;; don't run that hook for each subdir...
775 ;; ... run the hook for the whole buffer, and only after markers
776 ;; have been reinserted (else omitting in dired-x would omit marked files)
785 hidden-subdirs)))
786 ;; outside of the let scope
787 ;;; Might as well not override the user if the user changed this.
788 ;;; (setq buffer-read-only t)
789 )
791 ;; Subroutines of dired-revert
792 ;; Some of these are also used when inserting subdirs.
795 ;; Return alist of files and their marks, from BEG to END.
806 alist))
808 ;; Mark all files remembered in ALIST.
809 ;; Each element of ALIST looks like (FILE . MARKERCHAR).
823 ;; Return a list of names of subdirs currently hidden.
834 result))
836 ;; Try to insert all subdirs that were displayed before,
837 ;; according to the former subdir alist OLD-SUBDIR-ALIST.
851 ;; Remove directory DIR from any directory cache.
856 \f
857 ;; dired mode key bindings and initialization
861 nil
862 ;; This looks ugly when substitute-command-keys uses C-d instead d:
863 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
868 ;; Commands to mark or flag certain categories of files
873 ;; Upper case keys (except !) for operating on the marked files
890 ;; Comparison commands
893 ;; Tree Dired commands
899 ;; move to marked files
902 ;; Make all regexp commands share a `%' prefix:
903 ;; We used to get to the submap via a symbol dired-regexp-prefix,
904 ;; but that seems to serve little purpose, and copy-keymap
905 ;; does a better job without it.
917 ;; Commands for marking and unmarking.
933 ;; Lower keys for commands not operating on all the marked files
957 ;; moving
965 (define-key map [up] 'dired-previous-line)
966 ;; hiding
967 (define-key map "$" 'dired-hide-subdir)
968 (define-key map "\M-$" 'dired-hide-all)
969 ;; misc
970 (define-key map "?" 'dired-summary)
972 (define-key map "\C-_" 'dired-undo)
973 (define-key map "\C-xu" 'dired-undo)
975 ;; Make menu bar items.
977 ;; No need to fo this, now that top-level items are fewer.
978 ;;;;
979 ;; Get rid of the Edit menu bar item to save space.
980 ;(define-key map [menu-bar edit] 'undefined)
982 (define-key map [menu-bar subdir]
983 (cons "Subdir" (make-sparse-keymap "Subdir")))
985 (define-key map [menu-bar subdir hide-all]
986 '(menu-item "Hide All" dired-hide-all
987 :help "Hide all subdirectories, leave only header lines"))
988 (define-key map [menu-bar subdir hide-subdir]
989 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
990 :help "Hide or unhide current directory listing"))
991 (define-key map [menu-bar subdir tree-down]
992 '(menu-item "Tree Down" dired-tree-down
993 :help "Go to first subdirectory header down the tree"))
994 (define-key map [menu-bar subdir tree-up]
995 '(menu-item "Tree Up" dired-tree-up
996 :help "Go to first subdirectory header up the tree"))
997 (define-key map [menu-bar subdir up]
998 '(menu-item "Up Directory" dired-up-directory
999 :help "Edit the parent directory"))
1000 (define-key map [menu-bar subdir prev-subdir]
1001 '(menu-item "Prev Subdir" dired-prev-subdir
1002 :help "Go to previous subdirectory header line"))
1003 (define-key map [menu-bar subdir next-subdir]
1004 '(menu-item "Next Subdir" dired-next-subdir
1005 :help "Go to next subdirectory header line"))
1006 (define-key map [menu-bar subdir prev-dirline]
1007 '(menu-item "Prev Dirline" dired-prev-dirline
1008 :help "Move to next directory-file line"))
1009 (define-key map [menu-bar subdir next-dirline]
1010 '(menu-item "Next Dirline" dired-next-dirline
1011 :help "Move to previous directory-file line"))
1012 (define-key map [menu-bar subdir insert]
1013 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1014 :help "Insert contents of subdirectory"))
1016 (define-key map [menu-bar immediate]
1017 (cons "Immediate" (make-sparse-keymap "Immediate")))
1019 (define-key map [menu-bar immediate revert-buffer]
1020 '(menu-item "Refresh" revert-buffer
1021 :help "Update contents of shown directories"))
1023 (define-key map [menu-bar immediate dashes]
1024 '("--"))
1026 (define-key map [menu-bar immediate backup-diff]
1027 '(menu-item "Compare with Backup" dired-backup-diff
1028 :help "Diff file at cursor with its latest backup"))
1029 (define-key map [menu-bar immediate diff]
1030 '(menu-item "Diff..." dired-diff
1031 :help "Compare file at cursor with another file"))
1032 (define-key map [menu-bar immediate view]
1033 '(menu-item "View This File" dired-view-file
1034 :help "Examine file at cursor in read-only mode"))
1035 (define-key map [menu-bar immediate display]
1036 '(menu-item "Display in Other Window" dired-display-file
1037 :help "Display file at cursor in other window"))
1038 (define-key map [menu-bar immediate find-file-other-window]
1039 '(menu-item "Find in Other Window" dired-find-file-other-window
1040 :help "Edit file at cursor in other window"))
1041 (define-key map [menu-bar immediate find-file]
1042 '(menu-item "Find This File" dired-find-file
1043 :help "Edit file at cursor"))
1044 (define-key map [menu-bar immediate create-directory]
1045 '(menu-item "Create Directory..." dired-create-directory))
1047 (define-key map [menu-bar regexp]
1048 (cons "Regexp" (make-sparse-keymap "Regexp")))
1050 (define-key map [menu-bar regexp downcase]
1051 '(menu-item "Downcase" dired-downcase
1052 ;; When running on plain MS-DOS, there's only one
1053 ;; letter-case for file names.
1054 :enable (or (not (fboundp 'msdos-long-file-names))
1055 (msdos-long-file-names))
1056 :help "Rename marked files to lower-case name"))
1057 (define-key map [menu-bar regexp upcase]
1058 '(menu-item "Upcase" dired-upcase
1059 :enable (or (not (fboundp 'msdos-long-file-names))
1060 (msdos-long-file-names))
1061 :help "Rename marked files to upper-case name"))
1062 (define-key map [menu-bar regexp hardlink]
1063 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1064 :help "Make hard links for files matching regexp"))
1065 (define-key map [menu-bar regexp symlink]
1066 '(menu-item "Symlink..." dired-do-symlink-regexp
1067 :visible (fboundp 'make-symbolic-link)
1068 :help "Make symbolic links for files matching regexp"))
1069 (define-key map [menu-bar regexp rename]
1070 '(menu-item "Rename..." dired-do-rename-regexp
1071 :help "Rename marked files matching regexp"))
1072 (define-key map [menu-bar regexp copy]
1073 '(menu-item "Copy..." dired-do-copy-regexp
1074 :help "Copy marked files matching regexp"))
1075 (define-key map [menu-bar regexp flag]
1076 '(menu-item "Flag..." dired-flag-files-regexp
1077 :help "Flag files matching regexp for deletion"))
1078 (define-key map [menu-bar regexp mark]
1079 '(menu-item "Mark..." dired-mark-files-regexp
1080 :help "Mark files matching regexp for future operations"))
1081 (define-key map [menu-bar regexp mark-cont]
1082 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1083 :help "Mark files whose contents matches regexp"))
1085 (define-key map [menu-bar mark]
1086 (cons "Mark" (make-sparse-keymap "Mark")))
1088 (define-key map [menu-bar mark prev]
1089 '(menu-item "Previous Marked" dired-prev-marked-file
1090 :help "Move to previous marked file"))
1091 (define-key map [menu-bar mark next]
1092 '(menu-item "Next Marked" dired-next-marked-file
1093 :help "Move to next marked file"))
1094 (define-key map [menu-bar mark marks]
1095 '(menu-item "Change Marks..." dired-change-marks
1096 :help "Replace marker with another character"))
1097 (define-key map [menu-bar mark unmark-all]
1098 '(menu-item "Unmark All" dired-unmark-all-marks))
1099 (define-key map [menu-bar mark symlinks]
1100 '(menu-item "Mark Symlinks" dired-mark-symlinks
1101 :visible (fboundp 'make-symbolic-link)
1102 :help "Mark all symbolic links"))
1103 (define-key map [menu-bar mark directories]
1104 '(menu-item "Mark Directories" dired-mark-directories
1105 :help "Mark all directories except `.' and `..'"))
1106 (define-key map [menu-bar mark directory]
1107 '(menu-item "Mark Old Backups" dired-clean-directory
1108 :help "Flag old numbered backups for deletion"))
1109 (define-key map [menu-bar mark executables]
1110 '(menu-item "Mark Executables" dired-mark-executables
1111 :help "Mark all executable files"))
1112 (define-key map [menu-bar mark garbage-files]
1113 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1114 :help "Flag unneeded files for deletion"))
1115 (define-key map [menu-bar mark backup-files]
1116 '(menu-item "Flag Backup Files" dired-flag-backup-files
1117 :help "Flag all backup files for deletion"))
1118 (define-key map [menu-bar mark auto-save-files]
1119 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1120 :help "Flag auto-save files for deletion"))
1121 (define-key map [menu-bar mark deletion]
1122 '(menu-item "Flag" dired-flag-file-deletion
1123 :help "Flag current line's file for deletion"))
1124 (define-key map [menu-bar mark unmark]
1125 '(menu-item "Unmark" dired-unmark
1126 :help "Unmark or unflag current line's file"))
1127 (define-key map [menu-bar mark mark]
1128 '(menu-item "Mark" dired-mark
1129 :help "Mark current line's file for future operations"))
1130 (define-key map [menu-bar mark toggle-marks]
1131 '(menu-item "Toggle Marks" dired-do-toggle
1132 :help "Mark unmarked files, unmark marked ones"))
1134 (define-key map [menu-bar operate]
1135 (cons "Operate" (make-sparse-keymap "Operate")))
1137 (define-key map [menu-bar operate query-replace]
1138 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1139 :help "Replace regexp in marked files"))
1140 (define-key map [menu-bar operate search]
1141 '(menu-item "Search Files..." dired-do-search
1142 :help "Search marked files for regexp"))
1143 (define-key map [menu-bar operate chown]
1144 '(menu-item "Change Owner..." dired-do-chown
1145 :visible (not (memq system-type '(ms-dos windows-nt)))
1146 :help "Change the owner of marked files"))
1147 (define-key map [menu-bar operate chgrp]
1148 '(menu-item "Change Group..." dired-do-chgrp
1149 :visible (not (memq system-type '(ms-dos windows-nt)))
1150 :help "Change the group of marked files"))
1151 (define-key map [menu-bar operate chmod]
1152 '(menu-item "Change Mode..." dired-do-chmod
1153 :help "Change mode (attributes) of marked files"))
1154 (define-key map [menu-bar operate load]
1155 '(menu-item "Load" dired-do-load
1156 :help "Load marked Emacs Lisp files"))
1157 (define-key map [menu-bar operate compile]
1158 '(menu-item "Byte-compile" dired-do-byte-compile
1159 :help "Byte-compile marked Emacs Lisp files"))
1160 (define-key map [menu-bar operate compress]
1161 '(menu-item "Compress" dired-do-compress
1162 :help "Compress/uncompress marked files"))
1163 (define-key map [menu-bar operate print]
1164 '(menu-item "Print..." dired-do-print
1165 :help "Ask for print command and print marked files"))
1166 (define-key map [menu-bar operate hardlink]
1167 '(menu-item "Hardlink to..." dired-do-hardlink
1168 :help "Make hard links for current or marked files"))
1169 (define-key map [menu-bar operate symlink]
1170 '(menu-item "Symlink to..." dired-do-symlink
1171 :visible (fboundp 'make-symbolic-link)
1172 :help "Make symbolic links for current or marked files"))
1173 (define-key map [menu-bar operate command]
1174 '(menu-item "Shell Command..." dired-do-shell-command
1175 :help "Run a shell command on each of marked files"))
1176 (define-key map [menu-bar operate delete]
1177 '(menu-item "Delete" dired-do-delete
1178 :help "Delete current file or all marked files"))
1179 (define-key map [menu-bar operate rename]
1180 '(menu-item "Rename to..." dired-do-rename
1181 :help "Rename current file or move marked files"))
1182 (define-key map [menu-bar operate copy]
1183 '(menu-item "Copy to..." dired-do-copy
1184 :help "Copy current file or all marked files"))
1186 (setq dired-mode-map map)))
1187 \f
1188 ;; Dired mode is suitable only for specially formatted data.
1189 (put 'dired-mode 'mode-class 'special)
1191 (defun dired-mode (&optional dirname switches)
1192 "\
1195 \(optionally) its subdirectories, in the format of `ls -lR'.
1198 compress, load or byte-compile them, change their file attributes
1201 by file or all files matching certain criteria.
1203 Letters no longer insert themselves. Digits are prefix arguments.
1206 Most commands operate on the marked files and use the current file
1207 if no files are marked. Use a numeric prefix argument to operate on
1208 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1209 to operate on the current file only. Prefix arguments override marks.
1211 to see why something went wrong.
1216 (or dired it in another buffer, if it is a directory).
1223 This retains all marks and hides subdirs again that were hidden before.
1224 SPC and DEL can be used to move down and up by lines.
1227 to read the
1229 to relist a single or the marked files or a
1231 again for the directory tree.
1234 for more info):
1236 dired-listing-switches
1237 dired-trivial-filenames
1238 dired-shrink-to-fit
1239 dired-marker-char
1240 dired-del-marker
1241 dired-keep-marker-rename
1242 dired-keep-marker-copy
1243 dired-keep-marker-hardlink
1244 dired-keep-marker-symlink
1248 dired-before-readin-hook
1249 dired-after-readin-hook
1250 dired-mode-hook
1251 dired-load-hook
1253 Keybindings:
1255 ;; Not to be called interactively (e.g. dired-directory will be set
1256 ;; to default-directory, which is wrong with wildcards).
1257 (kill-all-local-variables)
1258 (use-local-map dired-mode-map)
1259 (dired-advertise) ; default-directory is already set
1260 (setq major-mode 'dired-mode
1261 mode-name "Dired"
1262 ;; case-fold-search nil
1263 buffer-read-only t
1264 selective-display t ; for subdirectory hiding
1265 mode-line-buffer-identification
1266 (propertized-buffer-identification "%17b"))
1267 (set (make-local-variable 'revert-buffer-function)
1268 (function dired-revert))
1269 (set (make-local-variable 'page-delimiter)
1271 (set (make-local-variable 'dired-directory)
1272 (or dirname default-directory))
1273 ;; list-buffers uses this to display the dir being edited in this buffer.
1274 (set (make-local-variable 'list-buffers-directory)
1275 (expand-file-name dired-directory))
1276 (set (make-local-variable 'dired-actual-switches)
1277 (or switches dired-listing-switches))
1278 (set (make-local-variable 'font-lock-defaults) '(dired-font-lock-keywords t))
1279 (dired-sort-other dired-actual-switches t)
1280 (run-hooks 'dired-mode-hook))
1281 \f
1282 ;; Idiosyncratic dired commands that don't deal with marks.
1284 (defun dired-summary ()
1285 "Summarize basic Dired commands and show recent Dired errors."
1286 (interactive)
1287 (dired-why)
1288 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1289 (message
1290 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1292 (defun dired-undo ()
1293 "Undo in a dired buffer.
1294 This doesn't recover lost files, it just undoes changes in the buffer itself.
1295 You can use it to recover marks, killed lines or subdirs.
1297 parse the buffer again."
1298 (interactive)
1299 (let (buffer-read-only)
1300 (undo)))
1302 (defun dired-next-line (arg)
1303 "Move down lines then position at filename.
1304 Optional prefix ARG says how many lines to move; default is one line."
1305 (interactive "p")
1306 (next-line arg)
1307 (dired-move-to-filename))
1309 (defun dired-previous-line (arg)
1310 "Move up lines then position at filename.
1311 Optional prefix ARG says how many lines to move; default is one line."
1312 (interactive "p")
1313 (previous-line arg)
1314 (dired-move-to-filename))
1316 (defun dired-next-dirline (arg &optional opoint)
1317 "Goto ARG'th next directory file line."
1318 (interactive "p")
1319 (or opoint (setq opoint (point)))
1320 (if (if (> arg 0)
1321 (re-search-forward dired-re-dir nil t arg)
1322 (beginning-of-line)
1323 (re-search-backward dired-re-dir nil t (- arg)))
1324 (dired-move-to-filename) ; user may type `i' or `f'
1325 (goto-char opoint)
1326 (error "No more subdirectories")))
1328 (defun dired-prev-dirline (arg)
1329 "Goto ARG'th previous directory file line."
1330 (interactive "p")
1331 (dired-next-dirline (- arg)))
1333 (defun dired-up-directory (&optional other-window)
1334 "Run dired on parent directory of current directory.
1335 Find the parent directory either in this buffer or another buffer.
1336 Creates a buffer if necessary."
1337 (interactive "P")
1338 (let* ((dir (dired-current-directory))
1339 (up (file-name-directory (directory-file-name dir))))
1340 (or (dired-goto-file (directory-file-name dir))
1341 ;; Only try dired-goto-subdir if buffer has more than one dir.
1342 (and (cdr dired-subdir-alist)
1343 (dired-goto-subdir up))
1344 (progn
1345 (if other-window
1346 (dired-other-window up)
1347 (dired up))
1348 (dired-goto-file dir)))))
1350 ;; Force `f' rather than `e' in the mode doc:
1351 (defalias 'dired-advertised-find-file 'dired-find-file)
1352 (defun dired-find-file ()
1353 "In dired, visit the file or directory named on this line."
1354 (interactive)
1355 (let ((file-name (file-name-sans-versions (dired-get-filename) t)))
1356 (if (file-exists-p file-name)
1357 (find-file file-name)
1358 (if (file-symlink-p file-name)
1359 (error "File is a symlink to a nonexistent target")
1360 (error "File no longer exists; type `g' to update Dired buffer")))))
1362 (defun dired-find-alternate-file ()
1363 "In dired, visit this file or directory instead of the dired buffer."
1364 (interactive)
1365 (set-buffer-modified-p nil)
1366 (find-alternate-file (dired-get-filename)))
1368 (defun dired-mouse-find-file-other-window (event)
1369 "In dired, visit the file or directory name you click on."
1370 (interactive "e")
1371 (let (file)
1372 (save-excursion
1373 (set-buffer (window-buffer (posn-window (event-end event))))
1374 (save-excursion
1375 (goto-char (posn-point (event-end event)))
1376 (setq file (dired-get-filename))))
1377 (select-window (posn-window (event-end event)))
1378 (find-file-other-window (file-name-sans-versions file t))))
1380 (defun dired-view-file ()
1381 "In dired, examine a file in view mode, returning to dired when done.
1382 When file is a directory, show it in this buffer if it is inserted;
1383 otherwise, display it in another buffer."
1384 (interactive)
1385 (if (file-directory-p (dired-get-filename))
1386 (or (and (cdr dired-subdir-alist)
1387 (dired-goto-subdir (dired-get-filename)))
1388 (dired (dired-get-filename)))
1389 (view-file (dired-get-filename))))
1391 (defun dired-find-file-other-window ()
1392 "In dired, visit this file or directory in another window."
1393 (interactive)
1394 (find-file-other-window (file-name-sans-versions (dired-get-filename) t)))
1396 (defun dired-display-file ()
1397 "In dired, display this file or directory in another window."
1398 (interactive)
1399 (let ((file (file-name-sans-versions (dired-get-filename) t)))
1400 (display-buffer (find-file-noselect file))))
1401 \f
1402 ;;; Functions for extracting and manipulating file names in dired buffers.
1404 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1405 "In dired, return name of file mentioned on this line.
1406 Value returned normally includes the directory name.
1407 Optional arg LOCALP with value `no-dir' means don't include directory
1408 name in result. A value of `verbatim' means to return the name exactly as
1409 it occurs in the buffer, and a value of t means construct name relative to
1410 `default-directory', which still may contain slashes if in a subdirectory.
1411 Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1412 this line, otherwise an error occurs."
1413 (let (case-fold-search file p1 p2 already-absolute)
1414 (save-excursion
1415 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1416 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1417 ;; nil if no file on this line, but no-error-if-not-filep is t:
1418 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1419 (progn
1420 ;; Get rid of the mouse-face property that file names have.
1421 (set-text-properties 0 (length file) nil file)
1422 ;; Unquote names quoted by ls or by dired-insert-directory.
1423 ;; Using read to unquote is much faster than substituting
1425 (setq file
1426 (read
1428 ;; some ls -b don't escape quotes, argh!
1429 ;; This is not needed for GNU ls, though.
1430 (or (dired-string-replace-match
1432 file)
1434 (and file (file-name-absolute-p file)
1435 (setq already-absolute t))
1436 (and file buffer-file-coding-system
1437 (not file-name-coding-system)
1438 (not default-file-name-coding-system)
1439 (setq file (encode-coding-string file buffer-file-coding-system)))
1440 (cond
1441 ((eq localp 'verbatim)
1442 file)
1443 ((and (eq localp 'no-dir) already-absolute)
1444 (file-name-nondirectory file))
1445 ((or already-absolute (eq localp 'no-dir))
1446 file)
1447 (t
1448 (and file (concat (dired-current-directory localp) file))))))
1450 (defun dired-string-replace-match (regexp string newtext
1451 &optional literal global)
1452 "Replace first match of REGEXP in STRING with NEWTEXT.
1453 If it does not match, nil is returned instead of the new string.
1454 Optional arg LITERAL means to take NEWTEXT literally.
1455 Optional arg GLOBAL means to replace all matches."
1456 (if global
1457 (let ((start 0) ret)
1458 (while (string-match regexp string start)
1459 (let ((from-end (- (length string) (match-end 0))))
1460 (setq ret (setq string (replace-match newtext t literal string)))
1461 (setq start (- (length string) from-end))))
1462 ret)
1463 (if (not (string-match regexp string 0))
1464 nil
1465 (replace-match newtext t literal string))))
1467 (defun dired-make-absolute (file &optional dir)
1468 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1469 ;; We can't always use expand-file-name as this would get rid of `.'
1470 ;; or expand in / instead default-directory if DIR=="".
1471 ;; This should be good enough for ange-ftp, but might easily be
1472 ;; redefined (for VMS?).
1473 ;; It should be reasonably fast, though, as it is called in
1474 ;; dired-get-filename.
1475 (concat (or dir default-directory) file))
1477 (defun dired-make-relative (file &optional dir ignore)
1478 "Convert FILE (an absolute file name) to a name relative to DIR.
1479 If this is impossible, return FILE unchanged.
1480 DIR must be a directory name, not a file name."
1481 (or dir (setq dir default-directory))
1482 ;; This case comes into play if default-directory is set to
1483 ;; use ~.
1484 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1485 (setq dir (expand-file-name dir)))
1486 (if (string-match (concat "^" (regexp-quote dir)) file)
1487 (substring file (match-end 0))
1488 ;;; (or no-error
1489 ;;; (error "%s: not in directory tree growing at %s" file dir))
1490 file))
1491 \f
1492 ;;; Functions for finding the file name in a dired buffer line.
1494 (defvar dired-move-to-filename-regexp
1496 ;; In some locales, month abbreviations are as short as 2 letters,
1497 ;; and they can be padded on the right with spaces.
1498 ;; weiand: changed: month ends potentially with . or , or .,
1499 ;;old (month (concat l l "+ *"))
1500 (month (concat l l "+[.]?,? *"))
1501 ;; Recognize any non-ASCII character.
1502 ;; The purpose is to match a Kanji character.
1505 (s " ")
1506 (yyyy "[0-9][0-9][0-9][0-9]")
1507 (mm "[ 0-1][0-9]")
1508 ;;old (dd "[ 0-3][0-9]")
1509 (dd "[ 0-3][0-9][.]?")
1510 (HH:MM "[ 0-2][0-9]:[0-5][0-9]")
1512 ;; weiand: changed: year potentially unaligned
1518 (japanese
1520 ;; The "[0-9]" below requires the previous column to end in a digit.
1521 ;; This avoids recognizing `1 may 1997' as a date in the line:
1522 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
1523 ;; The ".*" below finds the last match if there are multiple matches.
1524 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
1525 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
1527 "Regular expression to match up to the file name in a directory listing.
1528 The default value is designed to recognize dates and times
1529 regardless of the language.")
1531 (defvar dired-permission-flags-regexp
1533 "Regular expression to match the permission flags in `ls -l'.")
1535 ;; Move to first char of filename on this line.
1536 ;; Returns position (point) or nil if no filename on this line."
1537 (defun dired-move-to-filename (&optional raise-error eol)
1538 ;; This is the UNIX version.
1539 (or eol (setq eol (progn (end-of-line) (point))))
1540 (beginning-of-line)
1541 (if (re-search-forward dired-move-to-filename-regexp eol t)
1542 (goto-char (match-end 0))
1543 (if raise-error
1544 (error "No file on this line"))))
1546 (defun dired-move-to-end-of-filename (&optional no-error)
1547 ;; Assumes point is at beginning of filename,
1548 ;; thus the rwx bit re-search-backward below will succeed in *this*
1549 ;; line if at all. So, it should be called only after
1550 ;; (dired-move-to-filename t).
1551 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1552 ;; This is the UNIX version.
1553 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1554 ;; case-fold-search is nil now, so we can test for capital F:
1555 (setq used-F (string-match "F" dired-actual-switches)
1556 opoint (point)
1557 eol (save-excursion (end-of-line) (point))
1558 hidden (and selective-display
1560 (if hidden
1561 nil
1562 (save-excursion;; Find out what kind of file this is:
1563 ;; Restrict perm bits to be non-blank,
1564 ;; otherwise this matches one char to early (looking backward):
1565 ;; "l---------" (some systems make symlinks that way)
1566 ;; "----------" (plain file with zero perms)
1567 (if (re-search-backward
1568 dired-permission-flags-regexp nil t)
1569 (setq file-type (char-after (match-beginning 1))
1570 symlink (eq file-type ?l)
1571 ;; Only with -F we need to know whether it's an executable
1572 executable (and
1573 used-F
1574 (string-match
1575 "[xst]";; execute bit set anywhere?
1576 (concat
1577 (buffer-substring (match-beginning 2)
1578 (match-end 2))
1579 (buffer-substring (match-beginning 3)
1580 (match-end 3))
1581 (buffer-substring (match-beginning 4)
1582 (match-end 4))))))
1583 (or no-error (error "No file on this line"))))
1584 ;; Move point to end of name:
1585 (if symlink
1586 (if (search-forward " ->" eol t)
1587 (progn
1588 (forward-char -3)
1589 (and used-F
1590 dired-ls-F-marks-symlinks
1591 (eq (preceding-char) ?@);; did ls really mark the link?
1592 (forward-char -1))))
1593 (goto-char eol);; else not a symbolic link
1594 ;; ls -lF marks dirs, sockets and executables with exactly one
1595 ;; trailing character. (Executable bits on symlinks ain't mean
1596 ;; a thing, even to ls, but we know it's not a symlink.)
1597 (and used-F
1598 (or (memq file-type '(?d ?s))
1599 executable)
1600 (forward-char -1))))
1601 (or no-error
1602 (not (eq opoint (point)))
1603 (error (if hidden
1604 (substitute-command-keys
1606 "No file on this line")))
1607 (if (eq opoint (point))
1608 nil
1609 (point))))
1611 \f
1612 ;; Keeping Dired buffers in sync with the filesystem and with each other
1614 (defun dired-buffers-for-dir (dir &optional file)
1615 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1616 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1617 ;; matches FILE.
1618 ;; The list is in reverse order of buffer creation, most recent last.
1619 ;; As a side effect, killed dired buffers for DIR are removed from
1620 ;; dired-buffers.
1621 (setq dir (file-name-as-directory dir))
1622 (let ((alist dired-buffers) result elt buf pattern)
1623 (while alist
1624 (setq elt (car alist)
1625 buf (cdr elt))
1626 (if (buffer-name buf)
1627 (if (dired-in-this-tree dir (car elt))
1628 (with-current-buffer buf
1629 (and (assoc dir dired-subdir-alist)
1630 (or (null file)
1631 (let ((wildcards
1632 (file-name-nondirectory dired-directory)))
1633 (or (= 0 (length wildcards))
1634 (string-match (dired-glob-regexp wildcards)
1635 file))))
1636 (setq result (cons buf result)))))
1637 ;; else buffer is killed - clean up:
1638 (setq dired-buffers (delq elt dired-buffers)))
1639 (setq alist (cdr alist)))
1640 result))
1642 (defun dired-glob-regexp (pattern)
1643 "Convert glob-pattern PATTERN to a regular expression."
1644 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1645 regexp)
1646 (while (string-match "[[?*]" pattern matched-in-pattern)
1647 (let ((op-end (match-end 0))
1648 (next-op (aref pattern (match-beginning 0))))
1649 (setq regexp (concat regexp
1650 (regexp-quote
1651 (substring pattern matched-in-pattern
1652 (match-beginning 0)))))
1653 (cond ((= next-op ??)
1654 (setq regexp (concat regexp "."))
1655 (setq matched-in-pattern op-end))
1656 ((= next-op ?\[)
1657 ;; Fails to handle ^ yet ????
1658 (let* ((set-start (match-beginning 0))
1659 (set-cont
1660 (if (= (aref pattern (1+ set-start)) ?^)
1661 (+ 3 set-start)
1662 (+ 2 set-start)))
1663 (set-end (string-match "]" pattern set-cont))
1664 (set (substring pattern set-start (1+ set-end))))
1665 (setq regexp (concat regexp set))
1666 (setq matched-in-pattern (1+ set-end))))
1667 ((= next-op ?*)
1668 (setq regexp (concat regexp ".*"))
1669 (setq matched-in-pattern op-end)))))
1671 regexp
1672 (regexp-quote
1673 (substring pattern matched-in-pattern))
1678 (defun dired-advertise ()
1679 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1680 ;; With wildcards we actually advertise too much.
1681 (let ((expanded-default (expand-file-name default-directory)))
1682 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1683 t ; we have already advertised ourselves
1684 (setq dired-buffers
1685 (cons (cons expanded-default (current-buffer))
1686 dired-buffers)))))
1688 (defun dired-unadvertise (dir)
1689 ;; Remove DIR from the buffer alist in variable dired-buffers.
1690 ;; This has the effect of removing any buffer whose main directory is DIR.
1691 ;; It does not affect buffers in which DIR is a subdir.
1692 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1693 (setq dired-buffers
1694 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
1695 \f
1696 ;; Tree Dired
1698 ;;; utility functions
1700 (defun dired-in-this-tree (file dir)
1701 ;;"Is FILE part of the directory tree starting at DIR?"
1702 (let (case-fold-search)
1703 (string-match (concat "^" (regexp-quote dir)) file)))
1705 (defun dired-normalize-subdir (dir)
1706 ;; Prepend default-directory to DIR if relative path name.
1707 ;; dired-get-filename must be able to make a valid filename from a
1708 ;; file and its directory DIR.
1709 (file-name-as-directory
1710 (if (file-name-absolute-p dir)
1711 dir
1712 (expand-file-name dir default-directory))))
1714 (defun dired-get-subdir ()
1715 ;;"Return the subdir name on this line, or nil if not on a headerline."
1716 ;; Look up in the alist whether this is a headerline.
1717 (save-excursion
1718 (let ((cur-dir (dired-current-directory)))
1719 (beginning-of-line) ; alist stores b-o-l positions
1720 (and (zerop (- (point)
1721 (dired-get-subdir-min (assoc cur-dir
1722 dired-subdir-alist))))
1723 cur-dir))))
1725 ;(defun dired-get-subdir-min (elt)
1726 ; (cdr elt))
1727 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
1728 (defalias 'dired-get-subdir-min 'cdr)
1730 (defun dired-get-subdir-max (elt)
1731 (save-excursion
1732 (goto-char (dired-get-subdir-min elt))
1733 (dired-subdir-max)))
1735 (defun dired-clear-alist ()
1736 (while dired-subdir-alist
1737 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1738 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1740 (defun dired-subdir-index (dir)
1741 ;; Return an index into alist for use with nth
1742 ;; for the sake of subdir moving commands.
1743 (let (found (index 0) (alist dired-subdir-alist))
1744 (while alist
1745 (if (string= dir (car (car alist)))
1746 (setq alist nil found t)
1747 (setq alist (cdr alist) index (1+ index))))
1748 (if found index nil)))
1750 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1751 "Go to next subdirectory, regardless of level."
1752 ;; Use 0 arg to go to this directory's header line.
1753 ;; NO-SKIP prevents moving to end of header line, returning whatever
1754 ;; position was found in dired-subdir-alist.
1755 (interactive "p")
1756 (let ((this-dir (dired-current-directory))
1757 pos index)
1758 ;; nth with negative arg does not return nil but the first element
1759 (setq index (- (dired-subdir-index this-dir) arg))
1760 (setq pos (if (>= index 0)
1761 (dired-get-subdir-min (nth index dired-subdir-alist))))
1762 (if pos
1763 (progn
1764 (goto-char pos)
1766 (point))
1767 (if no-error-if-not-found
1768 nil ; return nil if not found
1769 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1771 (defun dired-build-subdir-alist ()
1772 "Build `dired-subdir-alist' by parsing the buffer.
1773 Returns the new value of the alist."
1774 (interactive)
1775 (dired-clear-alist)
1776 (save-excursion
1777 (let ((count 0)
1778 (buffer-read-only nil)
1779 new-dir-name
1780 (R-ftp-base-dir-regex
1781 ;; Used to expand subdirectory names correctly in recursive
1782 ;; ange-ftp listings.
1783 (and (string-match "R" dired-actual-switches)
1786 (goto-char (point-min))
1787 (setq dired-subdir-alist nil)
1788 (while (and (re-search-forward dired-subdir-regexp nil t)
1789 ;; Avoid taking a file name ending in a colon
1790 ;; as a subdir name.
1791 (not (save-excursion
1792 (goto-char (match-beginning 0))
1793 (beginning-of-line)
1794 (forward-char 2)
1795 (save-match-data (looking-at dired-re-perms)))))
1796 (save-excursion
1797 (goto-char (match-beginning 1))
1798 (setq new-dir-name
1799 (buffer-substring-no-properties (point) (match-end 1))
1800 new-dir-name
1801 (save-match-data
1802 (if (and R-ftp-base-dir-regex
1803 (not (string= new-dir-name default-directory))
1804 (string-match R-ftp-base-dir-regex new-dir-name))
1805 (concat default-directory
1806 (substring new-dir-name (match-end 0)))
1807 (expand-file-name new-dir-name))))
1808 (delete-region (point) (match-end 1))
1809 (insert new-dir-name))
1810 (setq count (1+ count))
1811 (dired-alist-add-1 new-dir-name
1812 ;; Place a sub directory boundary between lines.
1813 (save-excursion
1814 (goto-char (match-beginning 0))
1815 (beginning-of-line)
1816 (point-marker))))
1817 (if (> count 1)
1818 (message "Buffer includes %d directories" count))
1819 ;; We don't need to sort it because it is in buffer order per
1820 ;; constructionem. Return new alist:
1821 dired-subdir-alist)))
1823 (defun dired-alist-add-1 (dir new-marker)
1824 ;; Add new DIR at NEW-MARKER. Don't sort.
1825 (setq dired-subdir-alist
1826 (cons (cons (dired-normalize-subdir dir) new-marker)
1827 dired-subdir-alist)))
1829 (defun dired-goto-next-nontrivial-file ()
1830 ;; Position point on first nontrivial file after point.
1831 (dired-goto-next-file);; so there is a file to compare with
1832 (if (stringp dired-trivial-filenames)
1833 (while (and (not (eobp))
1834 (string-match dired-trivial-filenames
1835 (file-name-nondirectory
1836 (or (dired-get-filename nil t) ""))))
1837 (forward-line 1)
1838 (dired-move-to-filename))))
1840 (defun dired-goto-next-file ()
1841 (let ((max (1- (dired-subdir-max))))
1842 (while (and (not (dired-move-to-filename)) (< (point) max))
1843 (forward-line 1))))
1845 (defun dired-goto-file (file)
1846 "Go to file line of FILE in this dired buffer."
1847 ;; Return value of point on success, else nil.
1848 ;; FILE must be an absolute pathname.
1851 ;; it in the buffer.
1852 (interactive
1853 (prog1 ; let push-mark display its message
1854 (list (expand-file-name
1855 (read-file-name "Goto file: "
1856 (dired-current-directory))))
1857 (push-mark)))
1858 (setq file (directory-file-name file)) ; does no harm if no directory
1859 (let (found case-fold-search dir)
1860 (setq dir (or (file-name-directory file)
1861 (error "Need absolute pathname for %s" file)))
1862 (save-excursion
1863 ;; The hair here is to get the result of dired-goto-subdir
1864 ;; without really calling it if we don't have any subdirs.
1865 (if (if (string= dir (expand-file-name default-directory))
1866 (goto-char (point-min))
1867 (and (cdr dired-subdir-alist)
1868 (dired-goto-subdir dir)))
1869 (let ((base (file-name-nondirectory file))
1870 (boundary (dired-subdir-max)))
1871 (while (and (not found)
1872 ;; filenames are preceded by SPC, this makes
1873 ;; the search faster (e.g. for the filename "-"!).
1874 (search-forward (concat " " base) boundary 'move))
1875 ;; Match could have BASE just as initial substring or
1876 ;; or in permission bits or date or
1877 ;; not be a proper filename at all:
1878 (if (equal base (dired-get-filename 'no-dir t))
1879 ;; Must move to filename since an (actually
1880 ;; correct) match could have been elsewhere on the
1881 ;; ;; line (e.g. "-" would match somewhere in the
1882 ;; permission bits).
1883 (setq found (dired-move-to-filename))
1884 ;; If this isn't the right line, move forward to avoid
1885 ;; trying this line again.
1886 (forward-line 1))))))
1887 (and found
1888 ;; return value of point (i.e., FOUND):
1889 (goto-char found))))
1891 (defun dired-initial-position (dirname)
1892 ;; Where point should go in a new listing of DIRNAME.
1893 ;; Point assumed at beginning of new subdir line.
1894 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1895 (end-of-line)
1896 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1897 \f
1898 ;; These are hooks which make tree dired work.
1899 ;; They are in this file because other parts of dired need to call them.
1900 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
1902 ;; This function is called for each retrieved filename.
1903 ;; It could stand to be faster, though it's mostly function call
1904 ;; overhead. Avoiding the function call seems to save about 10% in
1905 ;; dired-get-filename. Make it a defsubst?
1906 (defun dired-current-directory (&optional localp)
1907 "Return the name of the subdirectory to which this line belongs.
1908 This returns a string with trailing slash, like `default-directory'.
1909 Optional argument means return a file name relative to `default-directory'."
1910 (let ((here (point))
1911 (alist (or dired-subdir-alist
1912 ;; probably because called in a non-dired buffer
1913 (error "No subdir-alist in %s" (current-buffer))))
1914 elt dir)
1915 (while alist
1916 (setq elt (car alist)
1917 dir (car elt)
1918 ;; use `<=' (not `<') as subdir line is part of subdir
1919 alist (if (<= (dired-get-subdir-min elt) here)
1920 nil ; found
1921 (cdr alist))))
1922 (if localp
1923 (dired-make-relative dir default-directory)
1924 dir)))
1926 ;; Subdirs start at the beginning of their header lines and end just
1927 ;; before the beginning of the next header line (or end of buffer).
1929 (defun dired-subdir-max ()
1930 (save-excursion
1931 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
1932 (point-max)
1933 (point))))
1934 \f
1935 ;; Deleting files
1937 (defcustom dired-recursive-deletes nil ; Default only delete empty directories.
1938 "*Decide whether recursive deletes are allowed.
1939 Nil means no recursive deletes.
1940 `always' means delete recursively without asking. This is DANGEROUS!
1941 `top' means ask for each directory at top level, but delete its subdirectories
1942 without asking.
1943 Anything else means ask for each directory."
1944 :type '(choice :tag "Delete not empty directory"
1945 (const :tag "No. Only empty directories" nil)
1946 (const :tag "Ask for each directory" t)
1947 (const :tag "Ask for each top directory only" top))
1948 :group 'dired)
1950 ;; Match anything but `.' and `..'.
1953 ;; Delete file, possibly delete a directory and all its files.
1954 ;; This function is usefull outside of dired. One could change it's name
1955 ;; to e.g. recursive-delete-file and put it somewhere else.
1956 (defun dired-delete-file (file &optional recursive) "\
1957 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
1958 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
1959 Nil, do not delete.
1960 `always', delete recursively without asking.
1961 `top', ask for each directory at top level.
1962 Anything else, ask for each sub-directory."
1963 (let (files)
1964 ;; This test is equivalent to
1965 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1966 ;; but more efficient
1967 (if (not (eq t (car (file-attributes file))))
1968 (delete-file file)
1969 (when (and recursive
1970 (setq files
1971 (directory-files file t dired-re-no-dot)) ; Not empty.
1972 (or (eq recursive 'always)
1973 (yes-or-no-p (format "Recursive delete of %s "
1974 (dired-make-relative file)))))
1975 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
1976 (while files ; Recursively delete (possibly asking).
1977 (dired-delete-file (car files) recursive)
1978 (setq files (cdr files))))
1979 (delete-directory file))))
1981 (defun dired-do-flagged-delete (&optional nomessage)
1982 "In dired, delete the files flagged for deletion.
1983 If NOMESSAGE is non-nil, we don't display any message
1984 if there are no flagged files."
1985 (interactive)
1986 (let* ((dired-marker-char dired-del-marker)
1987 (regexp (dired-marker-regexp))
1988 case-fold-search)
1989 (if (save-excursion (goto-char (point-min))
1990 (re-search-forward regexp nil t))
1991 (dired-internal-do-deletions
1992 ;; this can't move point since ARG is nil
1993 (dired-map-over-marks (cons (dired-get-filename) (point))
1994 nil)
1995 nil)
1996 (or nomessage
1997 (message "(No deletions requested)")))))
1999 (defun dired-do-delete (&optional arg)
2000 "Delete all marked (or next ARG) files."
2001 ;; This is more consistent with the file marking feature than
2002 ;; dired-do-flagged-delete.
2003 (interactive "P")
2004 (dired-internal-do-deletions
2005 ;; this may move point if ARG is an integer
2006 (dired-map-over-marks (cons (dired-get-filename) (point))
2007 arg)
2008 arg))
2010 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2012 (defun dired-internal-do-deletions (l arg)
2013 ;; L is an alist of files to delete, with their buffer positions.
2014 ;; ARG is the prefix arg.
2015 ;; Filenames are absolute (VMS needs this for logical search paths).
2016 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2017 ;; That way as changes are made in the buffer they do not shift the
2018 ;; lines still to be changed, so the (point) values in L stay valid.
2019 ;; Also, for subdirs in natural order, a subdir's files are deleted
2020 ;; before the subdir itself - the other way around would not work.
2021 (let ((files (mapcar (function car) l))
2022 (count (length l))
2023 (succ 0))
2024 ;; canonicalize file list for pop up
2025 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2026 (if (dired-mark-pop-up
2027 " *Deletions*" 'delete files dired-deletion-confirmer
2028 (format "Delete %s " (dired-mark-prompt arg files)))
2029 (save-excursion
2030 (let (failures);; files better be in reverse order for this loop!
2031 (while l
2032 (goto-char (cdr (car l)))
2033 (let (buffer-read-only)
2034 (condition-case err
2035 (let ((fn (car (car l))))
2036 (dired-delete-file fn dired-recursive-deletes)
2037 ;; if we get here, removing worked
2038 (setq succ (1+ succ))
2039 (message "%s of %s deletions" succ count)
2040 (delete-region (progn (beginning-of-line) (point))
2041 (progn (forward-line 1) (point)))
2042 (dired-clean-up-after-deletion fn))
2043 (error;; catch errors from failed deletions
2045 (setq failures (cons (car (car l)) failures)))))
2046 (setq l (cdr l)))
2047 (if (not failures)
2048 (message "%d deletion%s done" count (dired-plural-s count))
2049 (dired-log-summary
2050 (format "%d of %d deletion%s failed"
2051 (length failures) count
2052 (dired-plural-s count))
2053 failures))))
2054 (message "(No deletions performed)")))
2055 (dired-move-to-filename))
2057 ;; This is a separate function for the sake of dired-x.el.
2058 (defun dired-clean-up-after-deletion (fn)
2059 ;; Clean up after a deleted file or directory FN.
2060 (save-excursion (and (cdr dired-subdir-alist)
2061 (dired-goto-subdir fn)
2062 (dired-kill-subdir))))
2063 \f
2064 ;; Confirmation
2066 (defun dired-marker-regexp ()
2067 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2069 (defun dired-plural-s (count)
2070 (if (= 1 count) "" "s"))
2072 (defun dired-mark-prompt (arg files)
2073 ;; Return a string for use in a prompt, either the current file
2074 ;; name, or the marker and a count of marked files.
2075 (let ((count (length files)))
2076 (if (= count 1)
2077 (car files)
2078 ;; more than 1 file:
2079 (if (integerp arg)
2080 ;; abs(arg) = count
2081 ;; Perhaps this is nicer, but it also takes more screen space:
2082 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2083 ;; count)
2084 (format "[next %d files]" arg)
2085 (format "%c [%d files]" dired-marker-char count)))))
2087 (defun dired-pop-to-buffer (buf)
2088 ;; Pop up buffer BUF.
2089 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2090 (if (not dired-shrink-to-fit)
2091 (pop-to-buffer (get-buffer-create buf))
2092 ;; let window shrink to fit:
2093 (let ((window (selected-window))
2094 target-lines w2)
2095 (cond ;; if split-window-threshold is enabled, use the largest window
2096 ((and (> (window-height (setq w2 (get-largest-window)))
2097 split-height-threshold)
2098 (= (frame-width) (window-width w2)))
2099 (setq window w2))
2100 ;; if the least-recently-used window is big enough, use it
2101 ((and (> (window-height (setq w2 (get-lru-window)))
2102 (* 2 window-min-height))
2103 (= (frame-width) (window-width w2)))
2104 (setq window w2)))
2105 (save-excursion
2106 (set-buffer buf)
2107 (goto-char (point-max))
2109 (setq target-lines (count-lines (point-min) (point)))
2110 ;; Don't forget to count the last line.
2111 (if (not (bolp))
2112 (setq target-lines (1+ target-lines))))
2113 (if (<= (window-height window) (* 2 window-min-height))
2114 ;; At this point, every window on the frame is too small to split.
2115 (setq w2 (display-buffer buf))
2116 (setq w2 (split-window window
2117 (max window-min-height
2118 (- (window-height window)
2119 (1+ (max window-min-height target-lines)))))))
2120 (set-window-buffer w2 buf)
2121 (if (< (1- (window-height w2)) target-lines)
2122 (progn
2123 (select-window w2)
2124 (enlarge-window (- target-lines (1- (window-height w2))))))
2125 (set-window-start w2 1)
2126 )))
2128 (defvar dired-no-confirm nil
2129 "A list of symbols for commands dired should not confirm.
2130 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2131 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink' and
2132 `uncompress'.")
2134 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2135 "Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
2136 Return FUNCTION's result on ARGS after popping up a window (in a buffer
2138 files. Uses function `dired-pop-to-buffer' to do that.
2139 FUNCTION should not manipulate files.
2140 It should only read input (an argument or confirmation).
2141 The window is not shown if there is just one file or
2142 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2143 FILES is the list of marked files."
2144 (or bufname (setq bufname " *Marked Files*"))
2145 (if (or (eq dired-no-confirm t)
2146 (memq op-symbol dired-no-confirm)
2147 (= (length files) 1))
2148 (apply function args)
2149 (with-current-buffer (get-buffer-create bufname)
2150 (erase-buffer)
2151 (dired-format-columns-of-files files)
2152 (remove-text-properties (point-min) (point-max) '(mouse-face)))
2153 (save-window-excursion
2154 (dired-pop-to-buffer bufname)
2155 (apply function args))))
2157 (defun dired-format-columns-of-files (files)
2158 ;; Files should be in forward order for this loop.
2159 ;; i.e., (car files) = first file in buffer.
2160 ;; Returns the number of lines used.
2161 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
2162 (width (- (window-width (selected-window)) 2))
2163 (columns (max 1 (/ width maxlen)))
2164 (nfiles (length files))
2165 (rows (+ (/ nfiles columns)
2166 (if (zerop (% nfiles columns)) 0 1)))
2167 (i 0)
2168 (j 0))
2169 (setq files (nconc (copy-sequence files) ; fill up with empty fns
2170 (make-list (- (* columns rows) nfiles) "")))
2171 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
2172 (while (< j rows)
2173 (while (< i columns)
2174 (indent-to (* i maxlen))
2175 (insert (car files))
2176 (setq files (nthcdr rows files)
2177 i (1+ i)))
2179 (setq i 0
2180 j (1+ j)
2181 files (cdr files)))
2182 rows))
2183 \f
2184 ;; Commands to mark or flag file(s) at or near current line.
2186 (defun dired-repeat-over-lines (arg function)
2187 ;; This version skips non-file lines.
2188 (let ((pos (make-marker)))
2189 (beginning-of-line)
2190 (while (and (> arg 0) (not (eobp)))
2191 (setq arg (1- arg))
2192 (beginning-of-line)
2193 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2194 (save-excursion
2195 (forward-line 1)
2196 (move-marker pos (1+ (point))))
2197 (save-excursion (funcall function))
2198 ;; Advance to the next line--actually, to the line that *was* next.
2199 ;; (If FUNCTION inserted some new lines in between, skip them.)
2200 (goto-char pos))
2201 (while (and (< arg 0) (not (bobp)))
2202 (setq arg (1+ arg))
2203 (forward-line -1)
2204 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2205 (beginning-of-line)
2206 (save-excursion (funcall function)))
2207 (move-marker pos nil)
2208 (dired-move-to-filename)))
2210 (defun dired-between-files ()
2211 ;; Point must be at beginning of line
2212 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
2213 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
2215 (and (looking-at dired-subdir-regexp)
2216 (save-excursion (not (dired-move-to-filename))))))
2218 (defun dired-next-marked-file (arg &optional wrap opoint)
2219 "Move to the next marked file, wrapping around the end of the buffer."
2221 (or opoint (setq opoint (point)));; return to where interactively started
2222 (if (if (> arg 0)
2223 (re-search-forward dired-re-mark nil t arg)
2224 (beginning-of-line)
2225 (re-search-backward dired-re-mark nil t (- arg)))
2226 (dired-move-to-filename)
2227 (if (null wrap)
2228 (progn
2229 (goto-char opoint)
2230 (error "No next marked file"))
2231 (message "(Wraparound for next marked file)")
2232 (goto-char (if (> arg 0) (point-min) (point-max)))
2233 (dired-next-marked-file arg nil opoint))))
2235 (defun dired-prev-marked-file (arg &optional wrap)
2236 "Move to the previous marked file, wrapping around the end of the buffer."
2238 (dired-next-marked-file (- arg) wrap))
2240 (defun dired-file-marker (file)
2241 ;; Return FILE's marker, or nil if unmarked.
2242 (save-excursion
2243 (and (dired-goto-file file)
2244 (progn
2245 (beginning-of-line)
2247 (following-char))))))
2249 (defun dired-mark-files-in-region (start end)
2250 (let (buffer-read-only)
2251 (if (> start end)
2252 (error "start > end"))
2253 (goto-char start) ; assumed at beginning of line
2254 (while (< (point) end)
2255 ;; Skip subdir line and following garbage like the `total' line:
2256 (while (and (< (point) end) (dired-between-files))
2257 (forward-line 1))
2258 (if (and (not (looking-at dired-re-dot))
2259 (dired-get-filename nil t))
2260 (progn
2261 (delete-char 1)
2262 (insert dired-marker-char)))
2263 (forward-line 1))))
2265 (defun dired-mark (arg)
2266 "Mark the current (or next ARG) files.
2267 If on a subdir headerline, mark all its files except `.' and `..'.
2271 this subdir."
2272 (interactive "P")
2273 (if (dired-get-subdir)
2274 (save-excursion (dired-mark-subdir-files))
2275 (let (buffer-read-only)
2276 (dired-repeat-over-lines
2277 (prefix-numeric-value arg)
2278 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2280 (defun dired-unmark (arg)
2281 "Unmark the current (or next ARG) files.
2282 If looking at a subdir, unmark all its files except `.' and `..'."
2283 (interactive "P")
2285 (dired-mark arg)))
2287 (defun dired-flag-file-deletion (arg)
2288 "In dired, flag the current line's file for deletion.
2289 With prefix arg, repeat over several lines.
2291 If on a subdir headerline, mark all its files except `.' and `..'."
2292 (interactive "P")
2293 (let ((dired-marker-char dired-del-marker))
2294 (dired-mark arg)))
2296 (defun dired-unmark-backward (arg)
2297 "In dired, move up lines and remove deletion flag there.
2298 Optional prefix ARG says how many lines to unflag; default is one line."
2299 (interactive "p")
2300 (dired-unmark (- arg)))
2302 (defun dired-do-toggle ()
2303 "Toggle marks.
2304 That is, currently marked files become unmarked and vice versa.
2305 Files marked with other flags (such as `D') are not affected.
2306 `.' and `..' are never toggled.
2307 As always, hidden subdirs are not affected."
2308 (interactive)
2309 (save-excursion
2310 (goto-char (point-min))
2311 (let (buffer-read-only)
2312 (while (not (eobp))
2313 (or (dired-between-files)
2314 (looking-at dired-re-dot)
2315 ;; use subst instead of insdel because it does not move
2316 ;; the gap and thus should be faster and because
2317 ;; other characters are left alone automatically
2318 (apply 'subst-char-in-region
2319 (point) (1+ (point))
2323 (forward-line 1)))))
2324 \f
2325 ;;; Commands to mark or flag files based on their characteristics or names.
2327 (defvar dired-regexp-history nil
2328 "History list of regular expressions used in Dired commands.")
2330 (defun dired-read-regexp (prompt)
2331 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2333 (defun dired-mark-files-regexp (regexp &optional marker-char)
2334 "Mark all files matching REGEXP for use in later commands.
2335 A prefix argument means to unmark them instead.
2336 `.' and `..' are never marked.
2339 object files--just `.o' will mark more than you might think."
2340 (interactive
2341 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2342 " files (regexp): "))
2344 (let ((dired-marker-char (or marker-char dired-marker-char)))
2345 (dired-mark-if
2346 (and (not (looking-at dired-re-dot))
2347 (not (eolp)) ; empty line
2348 (let ((fn (dired-get-filename nil t)))
2349 (and fn (string-match regexp (file-name-nondirectory fn)))))
2350 "matching file")))
2352 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2353 "Mark all files with contents containing REGEXP for use in later commands.
2354 A prefix argument means to unmark them instead.
2355 `.' and `..' are never marked."
2356 (interactive
2357 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2358 " files containing (regexp): "))
2360 (let ((dired-marker-char (or marker-char dired-marker-char)))
2361 (dired-mark-if
2362 (and (not (looking-at dired-re-dot))
2363 (not (eolp)) ; empty line
2364 (let ((fn (dired-get-filename nil t)))
2365 (when (and fn (file-readable-p fn)
2366 (not (file-directory-p fn)))
2367 (let ((prebuf (get-file-buffer fn)))
2368 (message "Checking %s" fn)
2369 ;; For now we do it inside emacs
2370 ;; Grep might be better if there are a lot of files
2371 (if prebuf
2372 (with-current-buffer prebuf
2373 (save-excursion
2374 (goto-char (point-min))
2375 (re-search-forward regexp nil t)))
2376 (with-temp-buffer
2377 (insert-file-contents fn)
2378 (goto-char (point-min))
2379 (re-search-forward regexp nil t))))
2380 )))
2381 "matching file")))
2383 (defun dired-flag-files-regexp (regexp)
2384 "In dired, flag all files containing the specified REGEXP for deletion.
2385 The match is against the non-directory part of the filename. Use `^'
2386 and `$' to anchor matches. Exclude subdirs by hiding them.
2387 `.' and `..' are never flagged."
2388 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2389 (dired-mark-files-regexp regexp dired-del-marker))
2391 (defun dired-mark-symlinks (unflag-p)
2392 "Mark all symbolic links.
2393 With prefix argument, unflag all those files."
2394 (interactive "P")
2396 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2398 (defun dired-mark-directories (unflag-p)
2399 "Mark all directory file lines except `.' and `..'.
2400 With prefix argument, unflag all those files."
2401 (interactive "P")
2403 (dired-mark-if (and (looking-at dired-re-dir)
2404 (not (looking-at dired-re-dot)))
2405 "directory file")))
2407 (defun dired-mark-executables (unflag-p)
2408 "Mark all executable files.
2409 With prefix argument, unflag all those files."
2410 (interactive "P")
2412 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2414 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2415 ;; files for which PREDICATE returns non-nil.
2417 (defun dired-flag-auto-save-files (&optional unflag-p)
2418 "Flag for deletion files whose names suggest they are auto save files.
2419 A prefix argument says to unflag those files instead."
2420 (interactive "P")
2422 (dired-mark-if
2423 ;; It is less than general to check for # here,
2424 ;; but it's the only way this runs fast enough.
2425 (and (save-excursion (end-of-line)
2426 (or
2427 (eq (preceding-char) ?#)
2428 ;; Handle executables in case of -F option.
2429 ;; We need not worry about the other kinds
2430 ;; of markings that -F makes, since they won't
2431 ;; appear on real auto-save files.
2432 (if (eq (preceding-char) ?*)
2433 (progn
2434 (forward-char -1)
2435 (eq (preceding-char) ?#)))))
2436 (not (looking-at dired-re-dir))
2437 (let ((fn (dired-get-filename t t)))
2438 (if fn (auto-save-file-name-p
2439 (file-name-nondirectory fn)))))
2440 "auto save file")))
2442 (defvar dired-garbage-files-regexp
2446 (defun dired-flag-garbage-files ()
2447 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2448 (interactive)
2449 (dired-flag-files-regexp dired-garbage-files-regexp))
2451 (defun dired-flag-backup-files (&optional unflag-p)
2452 "Flag all backup files (names ending with `~') for deletion.
2453 With prefix argument, unflag these files."
2454 (interactive "P")
2455 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
2456 (dired-mark-if
2457 ;; Don't call backup-file-name-p unless the last character looks like
2458 ;; it might be the end of a backup file name. This isn't very general,
2459 ;; but it's the only way this runs fast enough.
2460 (and (save-excursion (end-of-line)
2461 ;; Handle executables in case of -F option.
2462 ;; We need not worry about the other kinds
2463 ;; of markings that -F makes, since they won't
2464 ;; appear on real backup files.
2465 (if (eq (preceding-char) ?*)
2466 (forward-char -1))
2467 (eq (preceding-char) ?~))
2468 (not (looking-at dired-re-dir))
2469 (let ((fn (dired-get-filename t t)))
2470 (if fn (backup-file-name-p fn))))
2471 "backup file")))
2473 (defun dired-change-marks (&optional old new)
2474 "Change all OLD marks to NEW marks.
2475 OLD and NEW are both characters used to mark files."
2476 (interactive
2477 (let* ((cursor-in-echo-area t)
2478 (old (progn (message "Change (old mark): ") (read-char)))
2479 (new (progn (message "Change %c marks to (new mark): " old)
2480 (read-char))))
2481 (list old new)))
2483 (ding)
2485 (buffer-read-only))
2486 (save-excursion
2487 (goto-char (point-min))
2488 (while (search-forward string nil t)
2489 (if (if (= old ?\ )
2490 (save-match-data
2491 (dired-get-filename 'no-dir t))
2492 t)
2493 (subst-char-in-region (match-beginning 0)
2494 (match-end 0) old new)))))))
2496 (defun dired-unmark-all-marks ()
2497 "Remove all marks from all files in the Dired buffer."
2498 (interactive)
2501 (defun dired-unmark-all-files (mark &optional arg)
2502 "Remove a specific mark (or any mark) from every file.
2503 After this command, type the mark character to remove,
2504 or type RET to remove all marks.
2505 With prefix arg, query for each marked file.
2508 (save-excursion
2509 (let* ((count 0)
2510 buffer-read-only case-fold-search query
2512 (help-form "\
2513 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2514 `!' to unmark all remaining files with no more questions."))
2515 (goto-char (point-min))
2517 (re-search-forward dired-re-mark nil t)
2518 (search-forward string nil t))
2519 (if (or (not arg)
2520 (dired-query 'query "Unmark file `%s'? "
2521 (dired-get-filename t)))
2522 (progn (subst-char-in-region (1- (point)) (point)
2523 (preceding-char) ?\ )
2524 (setq count (1+ count)))))
2525 (message (if (= count 1) "1 mark removed"
2526 "%d marks removed")
2527 count))))
2528 \f
2529 ;; Logging failures operating on files, and showing the results.
2531 (defvar dired-log-buffer "*Dired log*")
2533 (defun dired-why ()
2534 "Pop up a buffer with error log output from Dired.
2535 A group of errors from a single command ends with a formfeed.
2537 (interactive)
2538 (if (get-buffer dired-log-buffer)
2539 (let ((owindow (selected-window))
2540 (window (display-buffer (get-buffer dired-log-buffer))))
2541 (unwind-protect
2542 (progn
2543 (select-window window)
2544 (goto-char (point-max))
2545 (recenter -1))
2546 (select-window owindow)))))
2548 (defun dired-log (log &rest args)
2549 ;; Log a message or the contents of a buffer.
2550 ;; If LOG is a string and there are more args, it is formatted with
2552 ;; End each bunch of errors with (dired-log t): this inserts
2554 (let ((obuf (current-buffer)))
2555 (unwind-protect ; want to move point
2556 (progn
2557 (set-buffer (get-buffer-create dired-log-buffer))
2558 (goto-char (point-max))
2559 (let (buffer-read-only)
2560 (cond ((stringp log)
2561 (insert (if args
2562 (apply (function format) log args)
2563 log)))
2564 ((bufferp log)
2565 (insert-buffer log))
2566 ((eq t log)
2569 (set-buffer obuf))))
2571 (defun dired-log-summary (string failures)
2572 (message (if failures "%s--type ? for details (%s)"
2573 "%s--type ? for details")
2574 string failures)
2575 ;; Log a summary describing a bunch of errors.
2577 (dired-log t))
2578 \f
2579 ;;; Sorting
2581 ;; Most ls can only sort by name or by date (with -t), nothing else.
2582 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2583 ;; So anything that does not contain these is sort "by name".
2585 (defvar dired-ls-sorting-switches "SXU"
2586 "String of `ls' switches (single letters) except `t' that influence sorting.")
2588 (defvar dired-sort-by-date-regexp
2589 (concat "^-[^" dired-ls-sorting-switches
2590 "]*t[^" dired-ls-sorting-switches "]*$")
2591 "Regexp recognized by dired to set `by date' mode.")
2593 (defvar dired-sort-by-name-regexp
2594 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2595 "Regexp recognized by dired to set `by name' mode.")
2597 (defun dired-sort-set-modeline ()
2598 ;; Set modeline display according to dired-actual-switches.
2599 ;; Modeline display of "by name" or "by date" guarantees the user a
2600 ;; match with the corresponding regexps. Non-matching switches are
2601 ;; shown literally.
2602 (setq mode-name
2603 (let (case-fold-search)
2604 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
2605 "Dired by name")
2606 ((string-match dired-sort-by-date-regexp dired-actual-switches)
2607 "Dired by date")
2608 (t
2609 (concat "Dired " dired-actual-switches)))))
2610 (force-mode-line-update))
2612 (defun dired-sort-toggle-or-edit (&optional arg)
2613 "Toggle between sort by date/name and refresh the dired buffer.
2614 With a prefix argument you can edit the current listing switches instead."
2615 (interactive "P")
2616 (if arg
2617 (dired-sort-other
2618 (read-string "ls switches (must contain -l): " dired-actual-switches))
2619 (dired-sort-toggle)))
2621 (defun dired-sort-toggle ()
2622 ;; Toggle between sort by date/name. Reverts the buffer.
2623 (setq dired-actual-switches
2624 (let (case-fold-search)
2625 (if (string-match " " dired-actual-switches)
2626 ;; New toggle scheme: add/remove a trailing " -t"
2629 (concat dired-actual-switches " -t"))
2630 ;; old toggle scheme: look for some 't' switch and add/remove it
2631 (concat
2632 "-l"
2633 (dired-replace-in-string (concat "[-lt"
2634 dired-ls-sorting-switches "]")
2635 ""
2636 dired-actual-switches)
2637 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2638 dired-actual-switches)
2639 ""
2640 "t")))))
2641 (dired-sort-set-modeline)
2642 (revert-buffer))
2644 (defun dired-replace-in-string (regexp newtext string)
2645 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2647 (let ((result "") (start 0) mb me)
2648 (while (string-match regexp string start)
2649 (setq mb (match-beginning 0)
2650 me (match-end 0)
2651 result (concat result (substring string start mb) newtext)
2652 start me))
2653 (concat result (substring string start))))
2655 (defun dired-sort-other (switches &optional no-revert)
2656 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2657 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2658 ;; minor mode accordingly, others appear literally in the mode line.
2659 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2660 (dired-sort-R-check switches)
2661 (setq dired-actual-switches switches)
2662 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
2663 (or no-revert (revert-buffer)))
2665 (make-variable-buffer-local
2666 (defvar dired-subdir-alist-pre-R nil
2667 "Value of `dired-subdir-alist' before -R switch added."))
2669 (defun dired-sort-R-check (switches)
2670 "Additional processing of -R in ls option string SWITCHES.
2671 Saves `dired-subdir-alist' when R is set and restores saved value
2672 minus any directories explicitly deleted when R is cleared.
2673 To be called first in body of `dired-sort-other', etc."
2674 (cond
2675 ((and (string-match "R" switches)
2676 (not (string-match "R" dired-actual-switches)))
2677 ;; Adding -R to ls switches -- save `dired-subdir-alist':
2678 (setq dired-subdir-alist-pre-R dired-subdir-alist))
2679 ((and (string-match "R" dired-actual-switches)
2680 (not (string-match "R" switches)))
2681 ;; Deleting -R from ls switches -- revert to pre-R subdirs
2682 ;; that are still present:
2683 (setq dired-subdir-alist
2684 (if dired-subdir-alist-pre-R
2685 (let (subdirs)
2686 (while dired-subdir-alist-pre-R
2687 (if (assoc (caar dired-subdir-alist-pre-R)
2688 dired-subdir-alist)
2689 ;; subdir still present...
2690 (setq subdirs
2691 (cons (car dired-subdir-alist-pre-R)
2692 subdirs)))
2693 (setq dired-subdir-alist-pre-R
2694 (cdr dired-subdir-alist-pre-R)))
2695 (reverse subdirs))
2696 ;; No pre-R subdir alist, so revert to main directory
2697 ;; listing:
2698 (list (car (reverse dired-subdir-alist))))))))
2699 \f
2700 ;; To make this file smaller, the less common commands
2701 ;; go in a separate file. But autoload them here
2702 ;; to make the separation invisible.
2704 (autoload 'dired-diff "dired-aux"
2705 "Compare file at point with file FILE using `diff'.
2706 FILE defaults to the file at the mark.
2707 The prompted-for file is the first file given to `diff'."
2708 t)
2710 (autoload 'dired-backup-diff "dired-aux"
2711 "Diff this file with its backup file or vice versa.
2712 Uses the latest backup, if there are several numerical backups.
2713 If this file is a backup, diff it with its original.
2714 The backup file is the first file given to `diff'."
2715 t)
2717 (autoload 'dired-clean-directory "dired-aux"
2718 "Flag numerical backups for deletion.
2719 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2720 Positive prefix arg KEEP overrides `dired-kept-versions';
2721 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2724 with a prefix argument."
2725 t)
2727 (autoload 'dired-do-chmod "dired-aux"
2728 "Change the mode of the marked (or next ARG) files.
2729 This calls chmod, thus symbolic modes like `g+w' are allowed."
2730 t)
2732 (autoload 'dired-do-chgrp "dired-aux"
2733 "Change the group of the marked (or next ARG) files."
2734 t)
2736 (autoload 'dired-do-chown "dired-aux"
2737 "Change the owner of the marked (or next ARG) files."
2738 t)
2740 (autoload 'dired-do-print "dired-aux"
2741 "Print the marked (or next ARG) files.
2742 Uses the shell command coming from variables `lpr-command' and
2743 `lpr-switches' as default."
2744 t)
2746 (autoload 'dired-do-shell-command "dired-aux"
2747 "Run a shell command COMMAND on the marked files.
2748 If no files are marked or a specific numeric prefix arg is given,
2750 The prompt mentions the file(s) or the marker, as appropriate.
2752 If there is output, it goes to a separate buffer.
2754 Normally the command is run on each file individually.
2755 However, if there is a `*' in the command then it is run
2756 just once with the entire file list substituted there.
2758 No automatic redisplay of dired buffers is attempted, as there's no
2759 telling what files the command may have changed. Type
2762 The shell command has the top level directory as working directory, so
2763 output files usually are created there instead of in a subdir."
2764 t)
2766 (autoload 'dired-do-kill-lines "dired-aux"
2767 "Kill all marked lines (not the files).
2768 With a prefix arg, kill all lines not marked or flagged."
2769 t)
2771 (autoload 'dired-do-compress "dired-aux"
2772 "Compress or uncompress marked (or next ARG) files."
2773 t)
2775 (autoload 'dired-do-byte-compile "dired-aux"
2776 "Byte compile marked (or next ARG) Emacs Lisp files."
2777 t)
2779 (autoload 'dired-do-load "dired-aux"
2780 "Load the marked (or next ARG) Emacs Lisp files."
2781 t)
2783 (autoload 'dired-do-redisplay "dired-aux"
2784 "Redisplay all marked (or next ARG) files.
2785 If on a subdir line, redisplay that subdirectory. In that case,
2786 a prefix arg lets you edit the `ls' switches used for the new listing."
2787 t)
2789 (autoload 'dired-create-directory "dired-aux"
2790 "Create a directory called DIRECTORY."
2791 t)
2793 (autoload 'dired-do-copy "dired-aux"
2794 "Copy all marked (or next ARG) files, or copy the current file.
2795 Thus, a zero prefix argument copies nothing. But it toggles the
2796 variable `dired-copy-preserve-time' (which see)."
2797 t)
2799 (autoload 'dired-do-symlink "dired-aux"
2800 "Make symbolic links to current file or all marked (or next ARG) files.
2801 When operating on just the current file, you specify the new name.
2802 When operating on multiple or marked files, you specify a directory
2803 and new symbolic links are made in that directory
2804 with the same names that the files currently have."
2805 t)
2807 (autoload 'dired-do-hardlink "dired-aux"
2808 "Add names (hard links) current file or all marked (or next ARG) files.
2809 When operating on just the current file, you specify the new name.
2810 When operating on multiple or marked files, you specify a directory
2811 and new hard links are made in that directory
2812 with the same names that the files currently have."
2813 t)
2815 (autoload 'dired-do-rename "dired-aux"
2816 "Rename current file or all marked (or next ARG) files.
2817 When renaming just the current file, you specify the new name.
2818 When renaming multiple or marked files, you specify a directory."
2819 t)
2821 (autoload 'dired-do-rename-regexp "dired-aux"
2822 "Rename marked files containing REGEXP to NEWNAME.
2823 As each match is found, the user must type a character saying
2826 REGEXP defaults to the last regexp used.
2827 With a zero prefix arg, renaming by regexp affects the complete
2828 pathname - usually only the non-directory part of file names is used
2829 and changed."
2830 t)
2832 (autoload 'dired-do-copy-regexp "dired-aux"
2833 "Copy all marked files containing REGEXP to NEWNAME.
2834 See function `dired-do-rename-regexp' for more info."
2835 t)
2837 (autoload 'dired-do-hardlink-regexp "dired-aux"
2838 "Hardlink all marked files containing REGEXP to NEWNAME.
2839 See function `dired-do-rename-regexp' for more info."
2840 t)
2842 (autoload 'dired-do-symlink-regexp "dired-aux"
2843 "Symlink all marked files containing REGEXP to NEWNAME.
2844 See function `dired-do-rename-regexp' for more info."
2845 t)
2847 (autoload 'dired-upcase "dired-aux"
2848 "Rename all marked (or next ARG) files to upper case."
2849 t)
2851 (autoload 'dired-downcase "dired-aux"
2852 "Rename all marked (or next ARG) files to lower case."
2853 t)
2855 (autoload 'dired-maybe-insert-subdir "dired-aux"
2856 "Insert this subdirectory into the same dired buffer.
2858 else inserts it at its natural place (as `ls -lR' would have done).
2859 With a prefix arg, you may edit the ls switches used for this listing.
2860 You can add `R' to the switches to expand the whole tree starting at
2861 this subdirectory.
2862 This function takes some pains to conform to `ls -lR' output."
2863 t)
2865 (autoload 'dired-next-subdir "dired-aux"
2866 "Go to next subdirectory, regardless of level."
2867 t)
2869 (autoload 'dired-prev-subdir "dired-aux"
2870 "Go to previous subdirectory, regardless of level.
2871 When called interactively and not on a subdir line, go to this subdir's line."
2872 t)
2874 (autoload 'dired-goto-subdir "dired-aux"
2875 "Go to end of header line of DIR in this dired buffer.
2876 Return value of point on success, otherwise return nil.
2878 t)
2880 (autoload 'dired-mark-subdir-files "dired-aux"
2881 "Mark all files except `.' and `..'."
2882 t)
2884 (autoload 'dired-kill-subdir "dired-aux"
2885 "Remove all lines of current subdirectory.
2886 Lower levels are unaffected."
2887 t)
2889 (autoload 'dired-tree-up "dired-aux"
2890 "Go up ARG levels in the dired tree."
2891 t)
2893 (autoload 'dired-tree-down "dired-aux"
2894 "Go down in the dired tree."
2895 t)
2897 (autoload 'dired-hide-subdir "dired-aux"
2898 "Hide or unhide the current subdirectory and move to next directory.
2899 Optional prefix arg is a repeat factor.
2901 t)
2903 (autoload 'dired-hide-all "dired-aux"
2904 "Hide all subdirectories, leaving only their header lines.
2905 If there is already something hidden, make everything visible again.
2907 t)
2909 (autoload 'dired-show-file-type "dired-aux"
2910 "Print the type of FILE, according to the `file' command.
2911 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2912 true then the type of the file linked to by FILE is printed instead."
2913 t)
2914 \f
2915 (if (eq system-type 'vax-vms)
2916 (load "dired-vms"))
2918 (provide 'dired)
2920 (run-hooks 'dired-load-hook) ; for your customizations
2922 ;;; dired.el ends here