| blob | c767b1c6b3eccafc29697125ea555cb8c6b378d0 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 1997 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"
75 ;;;###autoload
77 "*Informs dired about how `ls -lF' marks symbolic links.
78 Set this to t if `ls' (or whatever program is specified by
79 `insert-directory-program') with `-lF' marks the symbolic link
80 itself with a trailing @ (usually the case under Ultrix).
82 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
83 nil (the default), if it gives `bar@ -> foo', set it to t.
85 Dired checks if there is really a @ appended. Thus, if you have a
86 marking `ls' program on one host and a non-marking on another host, and
87 don't care about symbolic links which really end in a @, you can
88 always set this variable to t."
92 ;;;###autoload
94 "*Regexp of files to skip when finding first file of a directory.
95 A value of nil means move to the subdir line.
96 A value of t means move to first file."
99 regexp)
102 ;;;###autoload
104 ;; Use t as default so that moved files "take their markers with them".
105 "*Controls marking of renamed files.
106 If t, files keep their previous marks when they are renamed.
107 If a character, renamed files (whether previously marked or not)
108 are afterward marked with that character."
113 ;;;###autoload
115 "*Controls marking of copied files.
116 If t, copied files are marked if and as the corresponding original files were.
117 If a character, copied files are unconditionally marked with that character."
122 ;;;###autoload
124 "*Controls marking of newly made hard links.
125 If t, they are marked if and as the files linked to were marked.
126 If a character, new links are unconditionally marked with that character."
131 ;;;###autoload
133 "*Controls marking of newly made symbolic links.
134 If t, they are marked if and as the files linked to were marked.
135 If a character, new links are unconditionally marked with that character."
140 ;;;###autoload
142 "*If non-nil, dired tries to guess a default target directory.
143 This means: if there is a dired buffer displayed in the next window,
144 use its current subdir, instead of the current subdir of this dired buffer.
146 The target is used in the prompt for file copy, rename etc."
150 ;;;###autoload
152 "*If non-nil, Dired preserves the last-modified time in a file copy.
153 \(This works on only some systems.)"
157 ;;; Hook variables
160 "Run after loading dired.
170 "Hook run after each time a file or directory is read by Dired.
171 After each listing of a file or directory, this hook is run
173 ;; Note this can't simply be run inside function `dired-ls' as the hook
174 ;; functions probably depend on the dired-subdir-alist to be OK.
176 ;;; Internal variables
179 ;; so that you can write things like
180 ;; (let ((dired-marker-char ?X))
181 ;; ;; great code using X markers ...
182 ;; )
183 ;; For example, commands operating on two sets of files, A and B.
184 ;; Or marking files with digits 0-9. This could implicate
185 ;; concentric sets or an order for the marked files.
186 ;; The code depends on dynamic scoping on the marker char.
187 "In Dired, the current mark character.
194 t
195 ;; I see no reason ever to make this nil -- rms.
196 ;; (> baud-rate search-slow-speed)
204 "The directory name or shell wildcard that was used as argument to `ls'.
205 Local to each dired buffer. May be a list, in which case the car is the
214 ;; These regexps must be tested at beginning-of-line, but are also
215 ;; used to search for next matches, so neither omitting "^" nor
216 ;; replacing "^" by "\n" (to make it slightly faster) will work.
219 ;; "Regexp matching a marked line.
220 ;; Important: the match ends just after the marker."
229 "-[-r][-w].[-r][-w][xs][-r][-w]."
235 ;; The subdirectory names in this list are expanded.
237 "Association list of subdirectories and their buffer positions.
238 Each subdirectory has an element: (DIRNAME . STARTMARKER).
239 The order of elements is the reverse of the order in the buffer.
243 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
244 Subexpression 1 is the subdirectory proper, no trailing colon.
245 The match starts at the beginning of the line and ends after the end
251 ;;
252 ;; Directory headers.
254 ;;
255 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
256 ;; file name itself. We search for Dired defined regexps, and then use the
257 ;; Dired defined function `dired-move-to-filename' before searching for the
258 ;; simple regexp ".+". It is that regexp which matches the file name.
259 ;;
260 ;; Dired marks.
264 ;;
265 ;; Files that are group or world writable.
270 ;;
271 ;; Subdirectories.
274 ;;
275 ;; Symbolic links.
278 ;;
279 ;; Files suffixed with `completion-ignored-extensions'.
282 ;; It is quicker to first find just an extension, then go back to the
283 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
287 \f
288 ;;; Macros must be defined before they are used, for the byte compiler.
290 ;; Mark all files for which CONDITION evals to non-nil.
291 ;; CONDITION is evaluated on each line, with point at beginning of line.
292 ;; MSG is a noun phrase for the type of files being marked.
293 ;; It should end with a noun that can be pluralized by adding `s'.
294 ;; Return value is the number of files marked, or nil if none were marked.
309 count
318 ;; "Macro: Perform BODY with point somewhere on each marked line
319 ;;and return a list of BODY's results.
320 ;;If no marked file could be found, execute BODY on the current line.
321 ;; If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
322 ;; files instead of the marked files.
323 ;; In that case point is dragged along. This is so that commands on
324 ;; the next ARG (instead of the marked) files can be chained easily.
325 ;; If ARG is otherwise non-nil, use current file instead.
326 ;;If optional third arg SHOW-PROGRESS evaluates to non-nil,
327 ;; redisplay the dired buffer after each file is processed.
328 ;;No guarantee is made about the position on the marked line.
329 ;; BODY must ensure this itself if it depends on this.
330 ;;Search starts at the beginning of the buffer, thus the car of the list
331 ;; corresponds to the line nearest to the buffer's bottom. This
332 ;; is also true for (positive and negative) integer values of ARG.
333 ;;BODY should not be too long as it is expanded four times."
334 ;;
335 ;;Warning: BODY must not add new lines before point - this may cause an
336 ;;endless loop.
337 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
350 results))
351 ;; non-nil, non-integer ARG means use current file:
356 ;; remember position of next marked file before BODY
357 ;; can insert lines before the just found file,
358 ;; confusing us by finding the same marked file again
359 ;; and again and...
367 ;; move after last match
374 results
376 ;; save-excursion loses, again
380 "Return the marked files' names as list of strings.
381 The list is in the same order as the buffer, that is, the car is the
382 first marked file.
383 Values returned are normally absolute pathnames.
384 Optional arg LOCALP as in `dired-get-filename'.
385 Optional second argument ARG forces to use other files. If ARG is an
386 integer, use the next ARG files. If ARG is otherwise non-nil, use
387 current file. Usually ARG comes from the current prefix arg."
391 \f
392 ;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
393 ;; other special applications.
394 \f
395 ;; The dired command
398 ;; For use in interactive.
402 dired-listing-switches))
404 nil default-directory nil))))
406 ;;;###autoload (define-key ctl-x-map "d" 'dired)
407 ;;;###autoload
410 Optional second argument SWITCHES specifies the `ls' options used.
411 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
412 Dired displays a list of files in DIRNAME (which may also have
413 shell wildcards appended to select certain files). If DIRNAME is a cons,
414 its first element is taken as the directory name and the rest as an explicit
415 list of files to make directory entries for.
417 You can move around in it with the usual commands.
422 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
423 ;; Cannot use (interactive "D") because of wildcards.
427 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
428 ;;;###autoload
434 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
435 ;;;###autoload
441 ;;;###autoload
443 "Like `dired' but returns the dired buffer as value, does not select it."
445 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
446 ;; some shells make:
457 ;; If the argument was syntactically a directory name not a file name,
458 ;; or if it happens to name a file that is a directory,
459 ;; convert it syntactically to a directory name.
460 ;; The reason for checking initially-was-dirname
461 ;; and not just file-directory-p
462 ;; is that file-directory-p is slow over ftp.
470 ;; Separate function from dired-noselect for the sake of dired-vms.el.
472 ;; If there is an existing dired buffer for DIRNAME, just leave
473 ;; buffer as it is (don't even call dired-revert).
474 ;; This saves time especially for deep trees or with ange-ftp.
475 ;; The user can type `g'easily, and it is more consistent with find-file.
476 ;; But if SWITCHES are given they are probably different from the
477 ;; buffer's old value, so call dired-sort-other, which does
478 ;; revert the buffer.
479 ;; A pity we can't possibly do "Directory has changed - refresh? "
480 ;; like find-file does.
481 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
482 ;; see there.
484 ;; The following line used to use dir-or-list.
485 ;; That never found an existing buffer, in the case
486 ;; where it is a list.
488 ;; note that buffer already is in dired-mode, if found
493 ;; We don't want default-major-mode to run hooks and set auto-fill
494 ;; or whatever, now that dired-mode does not
495 ;; kill-all-local-variables any longer.
500 ;; file list may have changed
503 ;; this calls dired-revert
505 ;; If directory has changed on disk, offer to revert.
512 nil
516 ;; Else a new buffer
518 ;; We can do this unconditionally
519 ;; because dired-noselect ensures that the name
520 ;; is passed in directory name syntax
521 ;; if it was the name of a directory at all.
526 ;; default-directory and dired-actual-switches are set now
527 ;; (buffer-local), so we can call dired-readin:
532 ;; dired-readin can fail if parent directories are inaccessible.
533 ;; Don't leave an empty buffer around in that case.
535 ;; No need to narrow since the whole buffer contains just
536 ;; dired-readin's output, nothing else. The hook can
537 ;; successfully use dired functions (e.g. dired-get-filename)
538 ;; as the subdir-alist has been built in dired-readin.
543 buffer))
546 ;; This differs from dired-buffers-for-dir in that it does not consider
547 ;; subdirs of default-directory and searches for the first match only.
548 ;; Also, the major mode must be MODE.
561 blist nil)
563 found))
565 \f
566 ;; Read in a new dired buffer
568 ;; dired-readin differs from dired-insert-subdir in that it accepts
569 ;; wildcards, erases the buffer, and builds the subdir-alist anew
570 ;; (including making it buffer-local and clearing it first).
572 ;; default-directory and dired-actual-switches must be buffer-local
573 ;; and initialized by now.
574 ;; Thus we can test (equal default-directory dirname) instead of
575 ;; (file-directory-p dirname) and save a filesystem transaction.
576 ;; Also, we can run this hook which may want to modify the switches
577 ;; based on default-directory, e.g. with ange-ftp to a SysV host
578 ;; where ls won't understand -Al switches.
595 ;; We need this to make the root dir have a header line as all
596 ;; other subdirs have:
599 ;; can't run dired-after-readin-hook here, it may depend on the subdir
600 ;; alist to be OK.
601 )
603 ;; Must first make alist buffer local and set it to nil because
604 ;; dired-build-subdir-alist will call dired-clear-alist first
612 ;; Subroutines of dired-readin
615 ;; Just insert listing for the passed-in directory or
616 ;; directory-and-file list, assuming a clean buffer.
621 ;; Expand before comparing in case one or both have been abbreviated.
625 ;; If we are reading a whole single directory...
630 ;; Else assume it contains wildcards,
631 ;; unless it is an explicit list of files.
639 ;; Do the right thing whether dir-or-list is atomic or not. If it is,
640 ;; inset all files listed in the cdr (the car is the passed-in directory
641 ;; list).
644 end)
645 ;; We used to specify the C locale here, to force English month names;
646 ;; but this should not be necessary any more,
647 ;; with the new value of dired-move-to-filename-regexp.
649 ;; In this case, use the file names in the cdr
650 ;; exactly as originally given to dired-noselect.
654 ;; Expand the file name here because it may have been abbreviated
655 ;; in dired-noselect.
657 ;; Quote certain characters, unless ls quoted them for us.
671 ;; Make the file names highlight when the mouse is on them.
687 ;; Insert DIR's headerline with no trailing slash, exactly like ls
688 ;; would, and put cursor where dired-build-subdir-alist puts subdir
689 ;; boundaries.
692 \f
693 ;; Reverting a dired buffer
696 ;; Reread the dired buffer. Must also be called after
697 ;; dired-actual-switches have changed.
698 ;; Should not fail even on completely garbaged buffers.
699 ;; Preserves old cursor, marks/flags, hidden-p.
707 buffer-read-only)
711 ;; treat top level dir extra (it may contain wildcards)
716 ;; don't run that hook for each subdir...
719 ;; ... run the hook for the whole buffer, and only after markers
720 ;; have been reinserted (else omitting in dired-x would omit marked files)
729 hidden-subdirs)))
730 ;; outside of the let scope
731 ;;; Might as well not override the user if the user changed this.
732 ;;; (setq buffer-read-only t)
733 )
735 ;; Subroutines of dired-revert
736 ;; Some of these are also used when inserting subdirs.
739 ;; Return alist of files and their marks, from BEG to END.
750 alist))
752 ;; Mark all files remembered in ALIST.
753 ;; Each element of ALIST looks like (FILE . MARKERCHAR).
767 ;; Return a list of names of subdirs currently hidden.
778 result))
780 ;; Try to insert all subdirs that were displayed before,
781 ;; according to the former subdir alist OLD-SUBDIR-ALIST.
795 ;; Remove directory DIR from any directory cache.
800 \f
801 ;; dired mode key bindings and initialization
805 nil
806 ;; This looks ugly when substitute-command-keys uses C-d instead d:
807 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
812 ;; Commands to mark or flag certain categories of files
817 ;; Upper case keys (except !) for operating on the marked files
834 ;; Comparison commands
837 ;; Tree Dired commands
843 ;; move to marked files
846 ;; Make all regexp commands share a `%' prefix:
847 ;; We used to get to the submap via a symbol dired-regexp-prefix,
848 ;; but that seems to serve little purpose, and copy-keymap
849 ;; does a better job without it.
860 ;; Commands for marking and unmarking.
875 ;; Lower keys for commands not operating on all the marked files
896 ;; moving
904 (define-key map [up] 'dired-previous-line)
905 ;; hiding
906 (define-key map "$" 'dired-hide-subdir)
907 (define-key map "\M-$" 'dired-hide-all)
908 ;; misc
909 (define-key map "?" 'dired-summary)
911 (define-key map "\C-_" 'dired-undo)
912 (define-key map "\C-xu" 'dired-undo)
914 ;; Make menu bar items.
916 ;; Get rid of the Edit menu bar item to save space.
917 (define-key map [menu-bar edit] 'undefined)
919 (define-key map [menu-bar subdir]
920 (cons "Subdir" (make-sparse-keymap "Subdir")))
922 (define-key map [menu-bar subdir hide-all]
923 '("Hide All" . dired-hide-all))
924 (define-key map [menu-bar subdir hide-subdir]
925 '("Hide Subdir" . dired-hide-subdir))
926 (define-key map [menu-bar subdir tree-down]
927 '("Tree Down" . dired-tree-down))
928 (define-key map [menu-bar subdir tree-up]
929 '("Tree Up" . dired-tree-up))
930 (define-key map [menu-bar subdir up]
931 '("Up Directory" . dired-up-directory))
932 (define-key map [menu-bar subdir prev-subdir]
933 '("Prev Subdir" . dired-prev-subdir))
934 (define-key map [menu-bar subdir next-subdir]
935 '("Next Subdir" . dired-next-subdir))
936 (define-key map [menu-bar subdir prev-dirline]
937 '("Prev Dirline" . dired-prev-dirline))
938 (define-key map [menu-bar subdir next-dirline]
939 '("Next Dirline" . dired-next-dirline))
940 (define-key map [menu-bar subdir insert]
941 '("Insert This Subdir" . dired-maybe-insert-subdir))
943 (define-key map [menu-bar immediate]
944 (cons "Immediate" (make-sparse-keymap "Immediate")))
946 (define-key map [menu-bar immediate revert-buffer]
947 '("Update Buffer" . revert-buffer))
949 (define-key map [menu-bar immediate dashes]
950 '("--"))
952 (define-key map [menu-bar immediate backup-diff]
953 '("Compare with Backup" . dired-backup-diff))
954 (define-key map [menu-bar immediate diff]
955 '("Diff" . dired-diff))
956 (define-key map [menu-bar immediate view]
957 '("View This File" . dired-view-file))
958 (define-key map [menu-bar immediate display]
959 '("Display in Other Window" . dired-display-file))
960 (define-key map [menu-bar immediate find-file-other-window]
961 '("Find in Other Window" . dired-find-file-other-window))
962 (define-key map [menu-bar immediate find-file]
963 '("Find This File" . dired-find-file))
964 (define-key map [menu-bar immediate create-directory]
965 '("Create Directory..." . dired-create-directory))
967 (define-key map [menu-bar regexp]
968 (cons "Regexp" (make-sparse-keymap "Regexp")))
970 (define-key map [menu-bar regexp downcase]
971 '("Downcase" . dired-downcase))
972 (define-key map [menu-bar regexp upcase]
973 '("Upcase" . dired-upcase))
974 (define-key map [menu-bar regexp hardlink]
975 '("Hardlink..." . dired-do-hardlink-regexp))
976 (define-key map [menu-bar regexp symlink]
977 '("Symlink..." . dired-do-symlink-regexp))
978 (define-key map [menu-bar regexp rename]
979 '("Rename..." . dired-do-rename-regexp))
980 (define-key map [menu-bar regexp copy]
981 '("Copy..." . dired-do-copy-regexp))
982 (define-key map [menu-bar regexp flag]
983 '("Flag..." . dired-flag-files-regexp))
984 (define-key map [menu-bar regexp mark]
985 '("Mark..." . dired-mark-files-regexp))
987 (define-key map [menu-bar mark]
988 (cons "Mark" (make-sparse-keymap "Mark")))
990 (define-key map [menu-bar mark prev]
991 '("Previous Marked" . dired-prev-marked-file))
992 (define-key map [menu-bar mark next]
993 '("Next Marked" . dired-next-marked-file))
994 (define-key map [menu-bar mark marks]
995 '("Change Marks..." . dired-change-marks))
996 (define-key map [menu-bar mark unmark-all]
997 '("Unmark All" . dired-unmark-all-marks))
998 (define-key map [menu-bar mark symlinks]
999 '("Mark Symlinks" . dired-mark-symlinks))
1000 (define-key map [menu-bar mark directories]
1001 '("Mark Directories" . dired-mark-directories))
1002 (define-key map [menu-bar mark directory]
1003 '("Mark Old Backups" . dired-clean-directory))
1004 (define-key map [menu-bar mark executables]
1005 '("Mark Executables" . dired-mark-executables))
1006 (define-key map [menu-bar mark garbage-files]
1007 '("Flag Garbage Files" . dired-flag-garbage-files))
1008 (define-key map [menu-bar mark backup-files]
1009 '("Flag Backup Files" . dired-flag-backup-files))
1010 (define-key map [menu-bar mark auto-save-files]
1011 '("Flag Auto-save Files" . dired-flag-auto-save-files))
1012 (define-key map [menu-bar mark deletion]
1013 '("Flag" . dired-flag-file-deletion))
1014 (define-key map [menu-bar mark unmark]
1015 '("Unmark" . dired-unmark))
1016 (define-key map [menu-bar mark mark]
1017 '("Mark" . dired-mark))
1019 (define-key map [menu-bar operate]
1020 (cons "Operate" (make-sparse-keymap "Operate")))
1022 (define-key map [menu-bar operate query-replace]
1023 '("Query Replace in Files..." . dired-do-query-replace))
1024 (define-key map [menu-bar operate search]
1025 '("Search Files..." . dired-do-search))
1026 (define-key map [menu-bar operate chown]
1027 '("Change Owner..." . dired-do-chown))
1028 (define-key map [menu-bar operate chgrp]
1029 '("Change Group..." . dired-do-chgrp))
1030 (define-key map [menu-bar operate chmod]
1031 '("Change Mode..." . dired-do-chmod))
1032 (define-key map [menu-bar operate load]
1033 '("Load" . dired-do-load))
1034 (define-key map [menu-bar operate compile]
1035 '("Byte-compile" . dired-do-byte-compile))
1036 (define-key map [menu-bar operate compress]
1037 '("Compress" . dired-do-compress))
1038 (define-key map [menu-bar operate print]
1039 '("Print" . dired-do-print))
1040 (define-key map [menu-bar operate hardlink]
1041 '("Hardlink to..." . dired-do-hardlink))
1042 (define-key map [menu-bar operate symlink]
1043 '("Symlink to..." . dired-do-symlink))
1044 (define-key map [menu-bar operate command]
1045 '("Shell Command..." . dired-do-shell-command))
1046 (define-key map [menu-bar operate delete]
1047 '("Delete" . dired-do-delete))
1048 (define-key map [menu-bar operate rename]
1049 '("Rename to..." . dired-do-rename))
1050 (define-key map [menu-bar operate copy]
1051 '("Copy to..." . dired-do-copy))
1053 (setq dired-mode-map map)))
1054 \f
1055 ;; Dired mode is suitable only for specially formatted data.
1056 (put 'dired-mode 'mode-class 'special)
1058 (defun dired-mode (&optional dirname switches)
1059 "\
1062 \(optionally) its subdirectories, in the format of `ls -lR'.
1065 compress, load or byte-compile them, change their file attributes
1068 by file or all files matching certain criteria.
1070 Letters no longer insert themselves. Digits are prefix arguments.
1073 Most commands operate on the marked files and use the current file
1074 if no files are marked. Use a numeric prefix argument to operate on
1075 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1076 to operate on the current file only. Prefix arguments override marks.
1078 to see why something went wrong.
1083 (or dired it in another buffer, if it is a directory).
1090 This retains all marks and hides subdirs again that were hidden before.
1091 SPC and DEL can be used to move down and up by lines.
1094 to read the
1096 to relist a single or the marked files or a
1098 again for the directory tree.
1101 for more info):
1103 dired-listing-switches
1104 dired-trivial-filenames
1105 dired-shrink-to-fit
1106 dired-marker-char
1107 dired-del-marker
1108 dired-keep-marker-rename
1109 dired-keep-marker-copy
1110 dired-keep-marker-hardlink
1111 dired-keep-marker-symlink
1115 dired-before-readin-hook
1116 dired-after-readin-hook
1117 dired-mode-hook
1118 dired-load-hook
1120 Keybindings:
1122 ;; Not to be called interactively (e.g. dired-directory will be set
1123 ;; to default-directory, which is wrong with wildcards).
1124 (kill-all-local-variables)
1125 (use-local-map dired-mode-map)
1126 (dired-advertise) ; default-directory is already set
1127 (setq major-mode 'dired-mode
1128 mode-name "Dired"
1129 ;; case-fold-search nil
1130 buffer-read-only t
1131 selective-display t ; for subdirectory hiding
1132 mode-line-buffer-identification '("%17b"))
1133 (set (make-local-variable 'revert-buffer-function)
1134 (function dired-revert))
1135 (set (make-local-variable 'page-delimiter)
1137 (set (make-local-variable 'dired-directory)
1138 (or dirname default-directory))
1139 ;; list-buffers uses this to display the dir being edited in this buffer.
1140 (set (make-local-variable 'list-buffers-directory)
1141 (expand-file-name dired-directory))
1142 (set (make-local-variable 'dired-actual-switches)
1143 (or switches dired-listing-switches))
1144 (set (make-local-variable 'font-lock-defaults) '(dired-font-lock-keywords t))
1145 (dired-sort-other dired-actual-switches t)
1146 (run-hooks 'dired-mode-hook))
1147 \f
1148 ;; Idiosyncratic dired commands that don't deal with marks.
1150 (defun dired-quit ()
1151 "Bury the current dired buffer."
1152 (interactive)
1153 (bury-buffer))
1155 (defun dired-summary ()
1156 "Summarize basic Dired commands and show recent Dired errors."
1157 (interactive)
1158 (dired-why)
1159 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1160 (message
1161 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1163 (defun dired-undo ()
1164 "Undo in a dired buffer.
1165 This doesn't recover lost files, it just undoes changes in the buffer itself.
1166 You can use it to recover marks, killed lines or subdirs.
1168 parse the buffer again."
1169 (interactive)
1170 (let (buffer-read-only)
1171 (undo)))
1173 (defun dired-next-line (arg)
1174 "Move down lines then position at filename.
1175 Optional prefix ARG says how many lines to move; default is one line."
1176 (interactive "p")
1177 (next-line arg)
1178 (dired-move-to-filename))
1180 (defun dired-previous-line (arg)
1181 "Move up lines then position at filename.
1182 Optional prefix ARG says how many lines to move; default is one line."
1183 (interactive "p")
1184 (previous-line arg)
1185 (dired-move-to-filename))
1187 (defun dired-next-dirline (arg &optional opoint)
1188 "Goto ARG'th next directory file line."
1189 (interactive "p")
1190 (or opoint (setq opoint (point)))
1191 (if (if (> arg 0)
1192 (re-search-forward dired-re-dir nil t arg)
1193 (beginning-of-line)
1194 (re-search-backward dired-re-dir nil t (- arg)))
1195 (dired-move-to-filename) ; user may type `i' or `f'
1196 (goto-char opoint)
1197 (error "No more subdirectories")))
1199 (defun dired-prev-dirline (arg)
1200 "Goto ARG'th previous directory file line."
1201 (interactive "p")
1202 (dired-next-dirline (- arg)))
1204 (defun dired-up-directory (&optional other-window)
1205 "Run dired on parent directory of current directory.
1206 Find the parent directory either in this buffer or another buffer.
1207 Creates a buffer if necessary."
1208 (interactive "P")
1209 (let* ((dir (dired-current-directory))
1210 (up (file-name-directory (directory-file-name dir))))
1211 (or (dired-goto-file (directory-file-name dir))
1212 ;; Only try dired-goto-subdir if buffer has more than one dir.
1213 (and (cdr dired-subdir-alist)
1214 (dired-goto-subdir up))
1215 (progn
1216 (if other-window
1217 (dired-other-window up)
1218 (dired up))
1219 (dired-goto-file dir)))))
1221 ;; Force `f' rather than `e' in the mode doc:
1222 (defalias 'dired-advertised-find-file 'dired-find-file)
1223 (defun dired-find-file ()
1224 "In dired, visit the file or directory named on this line."
1225 (interactive)
1226 (let ((file-name (file-name-sans-versions (dired-get-filename) t)))
1227 (if (file-exists-p file-name)
1228 (find-file file-name)
1229 (if (file-symlink-p file-name)
1230 (error "File is a symlink to a nonexistent target")
1231 (error "File no longer exists; type `g' to update Dired buffer")))))
1233 (defun dired-mouse-find-file-other-window (event)
1234 "In dired, visit the file or directory name you click on."
1235 (interactive "e")
1236 (let (file)
1237 (save-excursion
1238 (set-buffer (window-buffer (posn-window (event-end event))))
1239 (save-excursion
1240 (goto-char (posn-point (event-end event)))
1241 (setq file (dired-get-filename))))
1242 (select-window (posn-window (event-end event)))
1243 (find-file-other-window (file-name-sans-versions file t))))
1245 (defun dired-view-file ()
1246 "In dired, examine a file in view mode, returning to dired when done.
1247 When file is a directory, show it in this buffer if it is inserted;
1248 otherwise, display it in another buffer."
1249 (interactive)
1250 (if (file-directory-p (dired-get-filename))
1251 (or (and (cdr dired-subdir-alist)
1252 (dired-goto-subdir (dired-get-filename)))
1253 (dired (dired-get-filename)))
1254 (view-file (dired-get-filename))))
1256 (defun dired-find-file-other-window ()
1257 "In dired, visit this file or directory in another window."
1258 (interactive)
1259 (find-file-other-window (file-name-sans-versions (dired-get-filename) t)))
1261 (defun dired-display-file ()
1262 "In dired, display this file or directory in another window."
1263 (interactive)
1264 (let ((file (file-name-sans-versions (dired-get-filename) t)))
1265 (display-buffer (find-file-noselect file))))
1266 \f
1267 ;;; Functions for extracting and manipulating file names in dired buffers.
1269 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1270 "In dired, return name of file mentioned on this line.
1271 Value returned normally includes the directory name.
1272 Optional arg LOCALP with value `no-dir' means don't include directory
1273 name in result. A value of t means construct name relative to
1274 `default-directory', which still may contain slashes if in a subdirectory.
1275 Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1276 this line, otherwise an error occurs."
1277 (let (case-fold-search file p1 p2)
1278 (save-excursion
1279 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
1280 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
1281 ;; nil if no file on this line, but no-error-if-not-filep is t:
1282 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
1283 (progn
1284 ;; Get rid of the mouse-face property that file names have.
1285 (set-text-properties 0 (length file) nil file)
1286 ;; Unquote names quoted by ls or by dired-insert-directory.
1287 ;; Using read to unquote is much faster than substituting
1289 (setq file
1290 (read
1292 ;; some ls -b don't escape quotes, argh!
1293 ;; This is not needed for GNU ls, though.
1294 (or (dired-string-replace-match
1296 file)
1298 (if (eq localp 'no-dir)
1299 file
1300 (and file (concat (dired-current-directory localp) file)))))
1302 (defun dired-string-replace-match (regexp string newtext
1303 &optional literal global)
1304 "Replace first match of REGEXP in STRING with NEWTEXT.
1305 If it does not match, nil is returned instead of the new string.
1306 Optional arg LITERAL means to take NEWTEXT literally.
1307 Optional arg GLOBAL means to replace all matches."
1308 (if global
1309 (let ((start 0))
1310 (while (string-match regexp string start)
1311 (let ((from-end (- (length string) (match-end 0))))
1312 (setq string (replace-match newtext t literal string))
1313 (setq start (- (length string) from-end))))
1314 string)
1315 (if (not (string-match regexp string 0))
1316 nil
1317 (replace-match newtext t literal string))))
1319 (defun dired-make-absolute (file &optional dir)
1320 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1321 ;; We can't always use expand-file-name as this would get rid of `.'
1322 ;; or expand in / instead default-directory if DIR=="".
1323 ;; This should be good enough for ange-ftp, but might easily be
1324 ;; redefined (for VMS?).
1325 ;; It should be reasonably fast, though, as it is called in
1326 ;; dired-get-filename.
1327 (concat (or dir default-directory) file))
1329 (defun dired-make-relative (file &optional dir ignore)
1330 "Convert FILE (an absolute file name) to a name relative to DIR.
1331 If this is impossible, return FILE unchanged.
1332 DIR must be a directory name, not a file name."
1333 (or dir (setq dir default-directory))
1334 ;; This case comes into play if default-directory is set to
1335 ;; use ~.
1336 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
1337 (setq dir (expand-file-name dir)))
1338 (if (string-match (concat "^" (regexp-quote dir)) file)
1339 (substring file (match-end 0))
1340 ;;; (or no-error
1341 ;;; (error "%s: not in directory tree growing at %s" file dir))
1342 file))
1343 \f
1344 ;;; Functions for finding the file name in a dired buffer line.
1346 (defvar dired-move-to-filename-regexp
1348 [ 0-9][0-9][:0-9][0-9][ 0-9] "
1349 "Regular expression to match a month abbreviation followed date/time.")
1351 (defvar dired-permission-flags-regexp
1353 "Regular expression to match the permission flags in `ls -l'.")
1355 ;; Move to first char of filename on this line.
1356 ;; Returns position (point) or nil if no filename on this line."
1357 (defun dired-move-to-filename (&optional raise-error eol)
1358 ;; This is the UNIX version.
1359 (or eol (setq eol (progn (end-of-line) (point))))
1360 (beginning-of-line)
1361 (if (re-search-forward dired-move-to-filename-regexp eol t)
1362 (goto-char (match-end 0))
1363 (if raise-error
1364 (error "No file on this line"))))
1366 (defun dired-move-to-end-of-filename (&optional no-error)
1367 ;; Assumes point is at beginning of filename,
1368 ;; thus the rwx bit re-search-backward below will succeed in *this*
1369 ;; line if at all. So, it should be called only after
1370 ;; (dired-move-to-filename t).
1371 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1372 ;; This is the UNIX version.
1373 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
1374 ;; case-fold-search is nil now, so we can test for capital F:
1375 (setq used-F (string-match "F" dired-actual-switches)
1376 opoint (point)
1377 eol (save-excursion (end-of-line) (point))
1378 hidden (and selective-display
1380 (if hidden
1381 nil
1382 (save-excursion;; Find out what kind of file this is:
1383 ;; Restrict perm bits to be non-blank,
1384 ;; otherwise this matches one char to early (looking backward):
1385 ;; "l---------" (some systems make symlinks that way)
1386 ;; "----------" (plain file with zero perms)
1387 (if (re-search-backward
1388 dired-permission-flags-regexp nil t)
1389 (setq file-type (char-after (match-beginning 1))
1390 symlink (eq file-type ?l)
1391 ;; Only with -F we need to know whether it's an executable
1392 executable (and
1393 used-F
1394 (string-match
1395 "[xst]";; execute bit set anywhere?
1396 (concat
1397 (buffer-substring (match-beginning 2)
1398 (match-end 2))
1399 (buffer-substring (match-beginning 3)
1400 (match-end 3))
1401 (buffer-substring (match-beginning 4)
1402 (match-end 4))))))
1403 (or no-error (error "No file on this line"))))
1404 ;; Move point to end of name:
1405 (if symlink
1406 (if (search-forward " ->" eol t)
1407 (progn
1408 (forward-char -3)
1409 (and used-F
1410 dired-ls-F-marks-symlinks
1411 (eq (preceding-char) ?@);; did ls really mark the link?
1412 (forward-char -1))))
1413 (goto-char eol);; else not a symbolic link
1414 ;; ls -lF marks dirs, sockets and executables with exactly one
1415 ;; trailing character. (Executable bits on symlinks ain't mean
1416 ;; a thing, even to ls, but we know it's not a symlink.)
1417 (and used-F
1418 (or (memq file-type '(?d ?s))
1419 executable)
1420 (forward-char -1))))
1421 (or no-error
1422 (not (eq opoint (point)))
1423 (error (if hidden
1424 (substitute-command-keys
1426 "No file on this line")))
1427 (if (eq opoint (point))
1428 nil
1429 (point))))
1431 \f
1432 ;; Keeping Dired buffers in sync with the filesystem and with each other
1434 (defvar dired-buffers nil
1435 ;; Enlarged by dired-advertise
1436 ;; Queried by function dired-buffers-for-dir. When this detects a
1437 ;; killed buffer, it is removed from this list.
1438 "Alist of expanded directories and their associated dired buffers.")
1440 (defun dired-buffers-for-dir (dir &optional file)
1441 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1442 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
1443 ;; matches FILE.
1444 ;; The list is in reverse order of buffer creation, most recent last.
1445 ;; As a side effect, killed dired buffers for DIR are removed from
1446 ;; dired-buffers.
1447 (setq dir (file-name-as-directory dir))
1448 (let ((alist dired-buffers) result elt buf pattern)
1449 (while alist
1450 (setq elt (car alist)
1451 buf (cdr elt))
1452 (if (buffer-name buf)
1453 (if (dired-in-this-tree dir (car elt))
1454 (with-current-buffer buf
1455 (and (assoc dir dired-subdir-alist)
1456 (or (null file)
1457 (let ((wildcards
1458 (file-name-nondirectory dired-directory)))
1459 (or (= 0 (length wildcards))
1460 (string-match (dired-glob-regexp wildcards)
1461 file))))
1462 (setq result (cons buf result)))))
1463 ;; else buffer is killed - clean up:
1464 (setq dired-buffers (delq elt dired-buffers)))
1465 (setq alist (cdr alist)))
1466 result))
1468 (defun dired-glob-regexp (pattern)
1469 "Convert glob-pattern PATTERN to a regular expression."
1470 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
1471 regexp)
1472 (while (string-match "[[?*]" pattern matched-in-pattern)
1473 (let ((op-end (match-end 0))
1474 (next-op (aref pattern (match-beginning 0))))
1475 (setq regexp (concat regexp
1476 (regexp-quote
1477 (substring pattern matched-in-pattern
1478 (match-beginning 0)))))
1479 (cond ((= next-op ??)
1480 (setq regexp (concat regexp "."))
1481 (setq matched-in-pattern op-end))
1482 ((= next-op ?\[)
1483 ;; Fails to handle ^ yet ????
1484 (let* ((set-start (match-beginning 0))
1485 (set-cont
1486 (if (= (aref pattern (1+ set-start)) ?^)
1487 (+ 3 set-start)
1488 (+ 2 set-start)))
1489 (set-end (string-match "]" pattern set-cont))
1490 (set (substring pattern set-start (1+ set-end))))
1491 (setq regexp (concat regexp set))
1492 (setq matched-in-pattern (1+ set-end))))
1493 ((= next-op ?*)
1494 (setq regexp (concat regexp ".*"))
1495 (setq matched-in-pattern op-end)))))
1497 regexp
1498 (regexp-quote
1499 (substring pattern matched-in-pattern))
1504 (defun dired-advertise ()
1505 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1506 ;; With wildcards we actually advertise too much.
1507 (let ((expanded-default (expand-file-name default-directory)))
1508 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
1509 t ; we have already advertised ourselves
1510 (setq dired-buffers
1511 (cons (cons expanded-default (current-buffer))
1512 dired-buffers)))))
1514 (defun dired-unadvertise (dir)
1515 ;; Remove DIR from the buffer alist in variable dired-buffers.
1516 ;; This has the effect of removing any buffer whose main directory is DIR.
1517 ;; It does not affect buffers in which DIR is a subdir.
1518 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1519 (setq dired-buffers
1520 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
1521 \f
1522 ;; Tree Dired
1524 ;;; utility functions
1526 (defun dired-in-this-tree (file dir)
1527 ;;"Is FILE part of the directory tree starting at DIR?"
1528 (let (case-fold-search)
1529 (string-match (concat "^" (regexp-quote dir)) file)))
1531 (defun dired-normalize-subdir (dir)
1532 ;; Prepend default-directory to DIR if relative path name.
1533 ;; dired-get-filename must be able to make a valid filename from a
1534 ;; file and its directory DIR.
1535 (file-name-as-directory
1536 (if (file-name-absolute-p dir)
1537 dir
1538 (expand-file-name dir default-directory))))
1540 (defun dired-get-subdir ()
1541 ;;"Return the subdir name on this line, or nil if not on a headerline."
1542 ;; Look up in the alist whether this is a headerline.
1543 (save-excursion
1544 (let ((cur-dir (dired-current-directory)))
1545 (beginning-of-line) ; alist stores b-o-l positions
1546 (and (zerop (- (point)
1547 (dired-get-subdir-min (assoc cur-dir
1548 dired-subdir-alist))))
1549 cur-dir))))
1551 ;(defun dired-get-subdir-min (elt)
1552 ; (cdr elt))
1553 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
1554 (defalias 'dired-get-subdir-min 'cdr)
1556 (defun dired-get-subdir-max (elt)
1557 (save-excursion
1558 (goto-char (dired-get-subdir-min elt))
1559 (dired-subdir-max)))
1561 (defun dired-clear-alist ()
1562 (while dired-subdir-alist
1563 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
1564 (setq dired-subdir-alist (cdr dired-subdir-alist))))
1566 (defun dired-subdir-index (dir)
1567 ;; Return an index into alist for use with nth
1568 ;; for the sake of subdir moving commands.
1569 (let (found (index 0) (alist dired-subdir-alist))
1570 (while alist
1571 (if (string= dir (car (car alist)))
1572 (setq alist nil found t)
1573 (setq alist (cdr alist) index (1+ index))))
1574 (if found index nil)))
1576 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
1577 "Go to next subdirectory, regardless of level."
1578 ;; Use 0 arg to go to this directory's header line.
1579 ;; NO-SKIP prevents moving to end of header line, returning whatever
1580 ;; position was found in dired-subdir-alist.
1581 (interactive "p")
1582 (let ((this-dir (dired-current-directory))
1583 pos index)
1584 ;; nth with negative arg does not return nil but the first element
1585 (setq index (- (dired-subdir-index this-dir) arg))
1586 (setq pos (if (>= index 0)
1587 (dired-get-subdir-min (nth index dired-subdir-alist))))
1588 (if pos
1589 (progn
1590 (goto-char pos)
1592 (point))
1593 (if no-error-if-not-found
1594 nil ; return nil if not found
1595 (error "%s directory" (if (> arg 0) "Last" "First"))))))
1597 (defun dired-build-subdir-alist ()
1598 "Build `dired-subdir-alist' by parsing the buffer.
1599 Returns the new value of the alist."
1600 (interactive)
1601 (dired-clear-alist)
1602 (save-excursion
1603 (let ((count 0)
1604 (buffer-read-only nil)
1605 new-dir-name)
1606 (goto-char (point-min))
1607 (setq dired-subdir-alist nil)
1608 (while (and (re-search-forward dired-subdir-regexp nil t)
1609 ;; Avoid taking a file name ending in a colon
1610 ;; as a subdir name.
1611 (not (save-excursion
1612 (goto-char (match-beginning 0))
1613 (beginning-of-line)
1614 (forward-char 2)
1615 (save-match-data (looking-at dired-re-perms)))))
1616 (save-excursion
1617 (goto-char (match-beginning 1))
1618 (setq new-dir-name
1619 (expand-file-name (buffer-substring (point) (match-end 1))))
1620 (delete-region (point) (match-end 1))
1621 (insert new-dir-name))
1622 (setq count (1+ count))
1623 (dired-alist-add-1 new-dir-name
1624 ;; Place a sub directory boundary between lines.
1625 (save-excursion
1626 (goto-char (match-beginning 0))
1627 (beginning-of-line)
1628 (point-marker))))
1629 (if (> count 1)
1630 (message "Buffer includes %d directories" count))
1631 ;; We don't need to sort it because it is in buffer order per
1632 ;; constructionem. Return new alist:
1633 dired-subdir-alist)))
1635 (defun dired-alist-add-1 (dir new-marker)
1636 ;; Add new DIR at NEW-MARKER. Don't sort.
1637 (setq dired-subdir-alist
1638 (cons (cons (dired-normalize-subdir dir) new-marker)
1639 dired-subdir-alist)))
1641 (defun dired-goto-next-nontrivial-file ()
1642 ;; Position point on first nontrivial file after point.
1643 (dired-goto-next-file);; so there is a file to compare with
1644 (if (stringp dired-trivial-filenames)
1645 (while (and (not (eobp))
1646 (string-match dired-trivial-filenames
1647 (file-name-nondirectory
1648 (or (dired-get-filename nil t) ""))))
1649 (forward-line 1)
1650 (dired-move-to-filename))))
1652 (defun dired-goto-next-file ()
1653 (let ((max (1- (dired-subdir-max))))
1654 (while (and (not (dired-move-to-filename)) (< (point) max))
1655 (forward-line 1))))
1657 (defun dired-goto-file (file)
1658 "Go to file line of FILE in this dired buffer."
1659 ;; Return value of point on success, else nil.
1660 ;; FILE must be an absolute pathname.
1663 ;; it in the buffer.
1664 (interactive
1665 (prog1 ; let push-mark display its message
1666 (list (expand-file-name
1667 (read-file-name "Goto file: "
1668 (dired-current-directory))))
1669 (push-mark)))
1670 (setq file (directory-file-name file)) ; does no harm if no directory
1671 (let (found case-fold-search dir)
1672 (setq dir (or (file-name-directory file)
1673 (error "Need absolute pathname for %s" file)))
1674 (save-excursion
1675 ;; The hair here is to get the result of dired-goto-subdir
1676 ;; without really calling it if we don't have any subdirs.
1677 (if (if (string= dir (expand-file-name default-directory))
1678 (goto-char (point-min))
1679 (and (cdr dired-subdir-alist)
1680 (dired-goto-subdir dir)))
1681 (let ((base (file-name-nondirectory file))
1682 (boundary (dired-subdir-max)))
1683 (while (and (not found)
1684 ;; filenames are preceded by SPC, this makes
1685 ;; the search faster (e.g. for the filename "-"!).
1686 (search-forward (concat " " base) boundary 'move))
1687 ;; Match could have BASE just as initial substring or
1688 ;; or in permission bits or date or
1689 ;; not be a proper filename at all:
1690 (if (equal base (dired-get-filename 'no-dir t))
1691 ;; Must move to filename since an (actually
1692 ;; correct) match could have been elsewhere on the
1693 ;; ;; line (e.g. "-" would match somewhere in the
1694 ;; permission bits).
1695 (setq found (dired-move-to-filename))
1696 ;; If this isn't the right line, move forward to avoid
1697 ;; trying this line again.
1698 (forward-line 1))))))
1699 (and found
1700 ;; return value of point (i.e., FOUND):
1701 (goto-char found))))
1703 (defun dired-initial-position (dirname)
1704 ;; Where point should go in a new listing of DIRNAME.
1705 ;; Point assumed at beginning of new subdir line.
1706 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1707 (end-of-line)
1708 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1709 \f
1710 ;; These are hooks which make tree dired work.
1711 ;; They are in this file because other parts of dired need to call them.
1712 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
1714 ;; This function is called for each retrieved filename.
1715 ;; It could stand to be faster, though it's mostly function call
1716 ;; overhead. Avoiding the function call seems to save about 10% in
1717 ;; dired-get-filename. Make it a defsubst?
1718 (defun dired-current-directory (&optional localp)
1719 "Return the name of the subdirectory to which this line belongs.
1720 This returns a string with trailing slash, like `default-directory'.
1721 Optional argument means return a file name relative to `default-directory'."
1722 (let ((here (point))
1723 (alist (or dired-subdir-alist
1724 ;; probably because called in a non-dired buffer
1725 (error "No subdir-alist in %s" (current-buffer))))
1726 elt dir)
1727 (while alist
1728 (setq elt (car alist)
1729 dir (car elt)
1730 ;; use `<=' (not `<') as subdir line is part of subdir
1731 alist (if (<= (dired-get-subdir-min elt) here)
1732 nil ; found
1733 (cdr alist))))
1734 (if localp
1735 (dired-make-relative dir default-directory)
1736 dir)))
1738 ;; Subdirs start at the beginning of their header lines and end just
1739 ;; before the beginning of the next header line (or end of buffer).
1741 (defun dired-subdir-max ()
1742 (save-excursion
1743 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
1744 (point-max)
1745 (point))))
1746 \f
1747 ;; Deleting files
1749 (defun dired-do-flagged-delete (&optional nomessage)
1750 "In dired, delete the files flagged for deletion.
1751 If NOMESSAGE is non-nil, we don't display any message
1752 if there are no flagged files."
1753 (interactive)
1754 (let* ((dired-marker-char dired-del-marker)
1755 (regexp (dired-marker-regexp))
1756 case-fold-search)
1757 (if (save-excursion (goto-char (point-min))
1758 (re-search-forward regexp nil t))
1759 (dired-internal-do-deletions
1760 ;; this can't move point since ARG is nil
1761 (dired-map-over-marks (cons (dired-get-filename) (point))
1762 nil)
1763 nil)
1764 (or nomessage
1765 (message "(No deletions requested)")))))
1767 (defun dired-do-delete (&optional arg)
1768 "Delete all marked (or next ARG) files."
1769 ;; This is more consistent with the file marking feature than
1770 ;; dired-do-flagged-delete.
1771 (interactive "P")
1772 (dired-internal-do-deletions
1773 ;; this may move point if ARG is an integer
1774 (dired-map-over-marks (cons (dired-get-filename) (point))
1775 arg)
1776 arg))
1778 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
1780 (defun dired-internal-do-deletions (l arg)
1781 ;; L is an alist of files to delete, with their buffer positions.
1782 ;; ARG is the prefix arg.
1783 ;; Filenames are absolute (VMS needs this for logical search paths).
1784 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
1785 ;; That way as changes are made in the buffer they do not shift the
1786 ;; lines still to be changed, so the (point) values in L stay valid.
1787 ;; Also, for subdirs in natural order, a subdir's files are deleted
1788 ;; before the subdir itself - the other way around would not work.
1789 (let ((files (mapcar (function car) l))
1790 (count (length l))
1791 (succ 0))
1792 ;; canonicalize file list for pop up
1793 (setq files (nreverse (mapcar (function dired-make-relative) files)))
1794 (if (dired-mark-pop-up
1795 " *Deletions*" 'delete files dired-deletion-confirmer
1796 (format "Delete %s " (dired-mark-prompt arg files)))
1797 (save-excursion
1798 (let (failures);; files better be in reverse order for this loop!
1799 (while l
1800 (goto-char (cdr (car l)))
1801 (let (buffer-read-only)
1802 (condition-case err
1803 (let ((fn (car (car l))))
1804 ;; This test is equivalent to
1805 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1806 ;; but more efficient
1807 (if (eq t (car (file-attributes fn)))
1808 (delete-directory fn)
1809 (delete-file fn))
1810 ;; if we get here, removing worked
1811 (setq succ (1+ succ))
1812 (message "%s of %s deletions" succ count)
1813 (delete-region (progn (beginning-of-line) (point))
1814 (progn (forward-line 1) (point)))
1815 (dired-clean-up-after-deletion fn))
1816 (error;; catch errors from failed deletions
1818 (setq failures (cons (car (car l)) failures)))))
1819 (setq l (cdr l)))
1820 (if (not failures)
1821 (message "%d deletion%s done" count (dired-plural-s count))
1822 (dired-log-summary
1823 (format "%d of %d deletion%s failed"
1824 (length failures) count
1825 (dired-plural-s count))
1826 failures))))
1827 (message "(No deletions performed)")))
1828 (dired-move-to-filename))
1830 ;; This is a separate function for the sake of dired-x.el.
1831 (defun dired-clean-up-after-deletion (fn)
1832 ;; Clean up after a deleted file or directory FN.
1833 (save-excursion (and (cdr dired-subdir-alist)
1834 (dired-goto-subdir fn)
1835 (dired-kill-subdir))))
1836 \f
1837 ;; Confirmation
1839 (defun dired-marker-regexp ()
1840 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
1842 (defun dired-plural-s (count)
1843 (if (= 1 count) "" "s"))
1845 (defun dired-mark-prompt (arg files)
1846 ;; Return a string for use in a prompt, either the current file
1847 ;; name, or the marker and a count of marked files.
1848 (let ((count (length files)))
1849 (if (= count 1)
1850 (car files)
1851 ;; more than 1 file:
1852 (if (integerp arg)
1853 ;; abs(arg) = count
1854 ;; Perhaps this is nicer, but it also takes more screen space:
1855 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
1856 ;; count)
1857 (format "[next %d files]" arg)
1858 (format "%c [%d files]" dired-marker-char count)))))
1860 (defun dired-pop-to-buffer (buf)
1861 ;; Pop up buffer BUF.
1862 ;; If dired-shrink-to-fit is t, make its window fit its contents.
1863 (if (not dired-shrink-to-fit)
1864 (pop-to-buffer (get-buffer-create buf))
1865 ;; let window shrink to fit:
1866 (let ((window (selected-window))
1867 target-lines w2)
1868 (cond ;; if split-window-threshold is enabled, use the largest window
1869 ((and (> (window-height (setq w2 (get-largest-window)))
1870 split-height-threshold)
1871 (= (frame-width) (window-width w2)))
1872 (setq window w2))
1873 ;; if the least-recently-used window is big enough, use it
1874 ((and (> (window-height (setq w2 (get-lru-window)))
1875 (* 2 window-min-height))
1876 (= (frame-width) (window-width w2)))
1877 (setq window w2)))
1878 (save-excursion
1879 (set-buffer buf)
1880 (goto-char (point-max))
1882 (setq target-lines (count-lines (point-min) (point)))
1883 ;; Don't forget to count the last line.
1884 (if (not (bolp))
1885 (setq target-lines (1+ target-lines))))
1886 (if (<= (window-height window) (* 2 window-min-height))
1887 ;; At this point, every window on the frame is too small to split.
1888 (setq w2 (display-buffer buf))
1889 (setq w2 (split-window window
1890 (max window-min-height
1891 (- (window-height window)
1892 (1+ (max window-min-height target-lines)))))))
1893 (set-window-buffer w2 buf)
1894 (if (< (1- (window-height w2)) target-lines)
1895 (progn
1896 (select-window w2)
1897 (enlarge-window (- target-lines (1- (window-height w2))))))
1898 (set-window-start w2 1)
1899 )))
1901 (defvar dired-no-confirm nil
1902 "A list of symbols for commands dired should not confirm.
1903 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
1904 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink' and
1905 `uncompress'.")
1907 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
1908 ;;"Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
1909 ;;Return FUNCTION's result on ARGS after popping up a window (in a buffer
1911 ;;files. Uses function `dired-pop-to-buffer' to do that.
1912 ;; FUNCTION should not manipulate files.
1913 ;; It should only read input (an argument or confirmation).
1914 ;;The window is not shown if there is just one file or
1915 ;; OP-SYMBOL is a member of the list in `dired-no-confirm'.
1916 ;;FILES is the list of marked files."
1917 (or bufname (setq bufname " *Marked Files*"))
1918 (if (or (eq dired-no-confirm t)
1919 (memq op-symbol dired-no-confirm)
1920 (= (length files) 1))
1921 (apply function args)
1922 (save-excursion
1923 (set-buffer (get-buffer-create bufname))
1924 (erase-buffer)
1925 (dired-format-columns-of-files files)
1926 (remove-text-properties (point-min) (point-max) '(mouse-face)))
1927 (save-window-excursion
1928 (dired-pop-to-buffer bufname)
1929 (apply function args))))
1931 (defun dired-format-columns-of-files (files)
1932 ;; Files should be in forward order for this loop.
1933 ;; i.e., (car files) = first file in buffer.
1934 ;; Returns the number of lines used.
1935 (let* ((maxlen (+ 2 (apply 'max (mapcar 'length files))))
1936 (width (- (window-width (selected-window)) 2))
1937 (columns (max 1 (/ width maxlen)))
1938 (nfiles (length files))
1939 (rows (+ (/ nfiles columns)
1940 (if (zerop (% nfiles columns)) 0 1)))
1941 (i 0)
1942 (j 0))
1943 (setq files (nconc (copy-sequence files) ; fill up with empty fns
1944 (make-list (- (* columns rows) nfiles) "")))
1945 (setcdr (nthcdr (1- (length files)) files) files) ; make circular
1946 (while (< j rows)
1947 (while (< i columns)
1948 (indent-to (* i maxlen))
1949 (insert (car files))
1950 (setq files (nthcdr rows files)
1951 i (1+ i)))
1953 (setq i 0
1954 j (1+ j)
1955 files (cdr files)))
1956 rows))
1957 \f
1958 ;; Commands to mark or flag file(s) at or near current line.
1960 (defun dired-repeat-over-lines (arg function)
1961 ;; This version skips non-file lines.
1962 (let ((pos (make-marker)))
1963 (beginning-of-line)
1964 (while (and (> arg 0) (not (eobp)))
1965 (setq arg (1- arg))
1966 (beginning-of-line)
1967 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
1968 (save-excursion
1969 (forward-line 1)
1970 (move-marker pos (1+ (point))))
1971 (save-excursion (funcall function))
1972 ;; Advance to the next line--actually, to the line that *was* next.
1973 ;; (If FUNCTION inserted some new lines in between, skip them.)
1974 (goto-char pos))
1975 (while (and (< arg 0) (not (bobp)))
1976 (setq arg (1+ arg))
1977 (forward-line -1)
1978 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
1979 (beginning-of-line)
1980 (save-excursion (funcall function)))
1981 (move-marker pos nil)
1982 (dired-move-to-filename)))
1984 (defun dired-between-files ()
1985 ;; Point must be at beginning of line
1986 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
1987 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
1989 (and (looking-at dired-subdir-regexp)
1990 (save-excursion (not (dired-move-to-filename))))))
1992 (defun dired-next-marked-file (arg &optional wrap opoint)
1993 "Move to the next marked file, wrapping around the end of the buffer."
1995 (or opoint (setq opoint (point)));; return to where interactively started
1996 (if (if (> arg 0)
1997 (re-search-forward dired-re-mark nil t arg)
1998 (beginning-of-line)
1999 (re-search-backward dired-re-mark nil t (- arg)))
2000 (dired-move-to-filename)
2001 (if (null wrap)
2002 (progn
2003 (goto-char opoint)
2004 (error "No next marked file"))
2005 (message "(Wraparound for next marked file)")
2006 (goto-char (if (> arg 0) (point-min) (point-max)))
2007 (dired-next-marked-file arg nil opoint))))
2009 (defun dired-prev-marked-file (arg &optional wrap)
2010 "Move to the previous marked file, wrapping around the end of the buffer."
2012 (dired-next-marked-file (- arg) wrap))
2014 (defun dired-file-marker (file)
2015 ;; Return FILE's marker, or nil if unmarked.
2016 (save-excursion
2017 (and (dired-goto-file file)
2018 (progn
2019 (beginning-of-line)
2021 (following-char))))))
2023 (defun dired-mark-files-in-region (start end)
2024 (let (buffer-read-only)
2025 (if (> start end)
2026 (error "start > end"))
2027 (goto-char start) ; assumed at beginning of line
2028 (while (< (point) end)
2029 ;; Skip subdir line and following garbage like the `total' line:
2030 (while (and (< (point) end) (dired-between-files))
2031 (forward-line 1))
2032 (if (and (not (looking-at dired-re-dot))
2033 (dired-get-filename nil t))
2034 (progn
2035 (delete-char 1)
2036 (insert dired-marker-char)))
2037 (forward-line 1))))
2039 (defun dired-mark (arg)
2040 "Mark the current (or next ARG) files.
2041 If on a subdir headerline, mark all its files except `.' and `..'.
2045 this subdir."
2046 (interactive "P")
2047 (if (dired-get-subdir)
2048 (save-excursion (dired-mark-subdir-files))
2049 (let (buffer-read-only)
2050 (dired-repeat-over-lines
2051 (prefix-numeric-value arg)
2052 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2054 (defun dired-unmark (arg)
2055 "Unmark the current (or next ARG) files.
2056 If looking at a subdir, unmark all its files except `.' and `..'."
2057 (interactive "P")
2059 (dired-mark arg)))
2061 (defun dired-flag-file-deletion (arg)
2062 "In dired, flag the current line's file for deletion.
2063 With prefix arg, repeat over several lines.
2065 If on a subdir headerline, mark all its files except `.' and `..'."
2066 (interactive "P")
2067 (let ((dired-marker-char dired-del-marker))
2068 (dired-mark arg)))
2070 (defun dired-unmark-backward (arg)
2071 "In dired, move up lines and remove deletion flag there.
2072 Optional prefix ARG says how many lines to unflag; default is one line."
2073 (interactive "p")
2074 (dired-unmark (- arg)))
2075 \f
2076 ;;; Commands to mark or flag files based on their characteristics or names.
2078 (defvar dired-regexp-history nil
2079 "History list of regular expressions used in Dired commands.")
2081 (defun dired-read-regexp (prompt)
2082 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2084 (defun dired-mark-files-regexp (regexp &optional marker-char)
2085 "Mark all files matching REGEXP for use in later commands.
2086 A prefix argument means to unmark them instead.
2087 `.' and `..' are never marked.
2090 object files--just `.o' will mark more than you might think."
2091 (interactive
2092 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2093 " files (regexp): "))
2095 (let ((dired-marker-char (or marker-char dired-marker-char)))
2096 (dired-mark-if
2097 (and (not (looking-at dired-re-dot))
2098 (not (eolp)) ; empty line
2099 (let ((fn (dired-get-filename nil t)))
2100 (and fn (string-match regexp (file-name-nondirectory fn)))))
2101 "matching file")))
2103 (defun dired-flag-files-regexp (regexp)
2104 "In dired, flag all files containing the specified REGEXP for deletion.
2105 The match is against the non-directory part of the filename. Use `^'
2106 and `$' to anchor matches. Exclude subdirs by hiding them.
2107 `.' and `..' are never flagged."
2108 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
2109 (dired-mark-files-regexp regexp dired-del-marker))
2111 (defun dired-mark-symlinks (unflag-p)
2112 "Mark all symbolic links.
2113 With prefix argument, unflag all those files."
2114 (interactive "P")
2116 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
2118 (defun dired-mark-directories (unflag-p)
2119 "Mark all directory file lines except `.' and `..'.
2120 With prefix argument, unflag all those files."
2121 (interactive "P")
2123 (dired-mark-if (and (looking-at dired-re-dir)
2124 (not (looking-at dired-re-dot)))
2125 "directory file")))
2127 (defun dired-mark-executables (unflag-p)
2128 "Mark all executable files.
2129 With prefix argument, unflag all those files."
2130 (interactive "P")
2132 (dired-mark-if (looking-at dired-re-exe) "executable file")))
2134 ;; dired-x.el has a dired-mark-sexp interactive command: mark
2135 ;; files for which PREDICATE returns non-nil.
2137 (defun dired-flag-auto-save-files (&optional unflag-p)
2138 "Flag for deletion files whose names suggest they are auto save files.
2139 A prefix argument says to unflag those files instead."
2140 (interactive "P")
2142 (dired-mark-if
2143 ;; It is less than general to check for # here,
2144 ;; but it's the only way this runs fast enough.
2145 (and (save-excursion (end-of-line)
2146 (or
2147 (eq (preceding-char) ?#)
2148 ;; Handle executables in case of -F option.
2149 ;; We need not worry about the other kinds
2150 ;; of markings that -F makes, since they won't
2151 ;; appear on real auto-save files.
2152 (if (eq (preceding-char) ?*)
2153 (progn
2154 (forward-char -1)
2155 (eq (preceding-char) ?#)))))
2156 (not (looking-at dired-re-dir))
2157 (let ((fn (dired-get-filename t t)))
2158 (if fn (auto-save-file-name-p
2159 (file-name-nondirectory fn)))))
2160 "auto save file")))
2162 (defvar dired-garbage-files-regexp
2166 (defun dired-flag-garbage-files ()
2167 (interactive)
2168 "Flag for deletion all files that match `dired-garbage-files-regexp'."
2169 (dired-flag-files-regexp dired-garbage-files-regexp))
2171 (defun dired-flag-backup-files (&optional unflag-p)
2172 "Flag all backup files (names ending with `~') for deletion.
2173 With prefix argument, unflag these files."
2174 (interactive "P")
2175 (let ((dired-marker-char (if unflag-p ?\ dired-del-marker)))
2176 (dired-mark-if
2177 ;; Don't call backup-file-name-p unless the last character looks like
2178 ;; it might be the end of a backup file name. This isn't very general,
2179 ;; but it's the only way this runs fast enough.
2180 (and (save-excursion (end-of-line)
2181 ;; Handle executables in case of -F option.
2182 ;; We need not worry about the other kinds
2183 ;; of markings that -F makes, since they won't
2184 ;; appear on real backup files.
2185 (if (eq (preceding-char) ?*)
2186 (forward-char -1))
2187 (eq (preceding-char) ?~))
2188 (not (looking-at dired-re-dir))
2189 (let ((fn (dired-get-filename t t)))
2190 (if fn (backup-file-name-p fn))))
2191 "backup file")))
2193 (defun dired-change-marks (&optional old new)
2194 "Change all OLD marks to NEW marks.
2195 OLD and NEW are both characters used to mark files."
2196 (interactive
2197 (let* ((cursor-in-echo-area t)
2198 (old (progn (message "Change (old mark): ") (read-char)))
2199 (new (progn (message "Change %c marks to (new mark): " old)
2200 (read-char))))
2201 (list old new)))
2203 (ding)
2205 (buffer-read-only))
2206 (save-excursion
2207 (goto-char (point-min))
2208 (while (search-forward string nil t)
2209 (if (if (= old ?\ )
2210 (save-match-data
2211 (dired-get-filename 'no-dir t))
2212 t)
2213 (subst-char-in-region (match-beginning 0)
2214 (match-end 0) old new)))))))
2216 (defun dired-unmark-all-marks ()
2217 "Remove all marks from all files in the Dired buffer."
2218 (interactive)
2221 (defun dired-unmark-all-files (mark &optional arg)
2222 "Remove a specific mark (or any mark) from every file.
2223 After this command, type the mark character to remove,
2224 or type RET to remove all marks.
2225 With prefix arg, query for each marked file.
2228 (save-excursion
2229 (let* ((count 0)
2230 buffer-read-only case-fold-search query
2232 (help-form "\
2233 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
2234 `!' to unmark all remaining files with no more questions."))
2235 (goto-char (point-min))
2237 (re-search-forward dired-re-mark nil t)
2238 (search-forward string nil t))
2239 (if (or (not arg)
2240 (dired-query 'query "Unmark file `%s'? "
2241 (dired-get-filename t)))
2242 (progn (subst-char-in-region (1- (point)) (point)
2243 (preceding-char) ?\ )
2244 (setq count (1+ count)))))
2245 (message (if (= count 1) "1 mark removed"
2246 "%d marks removed")
2247 count))))
2248 \f
2249 ;; Logging failures operating on files, and showing the results.
2251 (defvar dired-log-buffer "*Dired log*")
2253 (defun dired-why ()
2254 "Pop up a buffer with error log output from Dired.
2255 A group of errors from a single command ends with a formfeed.
2257 (interactive)
2258 (if (get-buffer dired-log-buffer)
2259 (let ((owindow (selected-window))
2260 (window (display-buffer (get-buffer dired-log-buffer))))
2261 (unwind-protect
2262 (progn
2263 (select-window window)
2264 (goto-char (point-max))
2265 (recenter -1))
2266 (select-window owindow)))))
2268 (defun dired-log (log &rest args)
2269 ;; Log a message or the contents of a buffer.
2270 ;; If LOG is a string and there are more args, it is formatted with
2272 ;; End each bunch of errors with (dired-log t): this inserts
2274 (let ((obuf (current-buffer)))
2275 (unwind-protect ; want to move point
2276 (progn
2277 (set-buffer (get-buffer-create dired-log-buffer))
2278 (goto-char (point-max))
2279 (let (buffer-read-only)
2280 (cond ((stringp log)
2281 (insert (if args
2282 (apply (function format) log args)
2283 log)))
2284 ((bufferp log)
2285 (insert-buffer log))
2286 ((eq t log)
2289 (set-buffer obuf))))
2291 (defun dired-log-summary (string failures)
2292 (message (if failures "%s--type ? for details (%s)"
2293 "%s--type ? for details")
2294 string failures)
2295 ;; Log a summary describing a bunch of errors.
2297 (dired-log t))
2298 \f
2299 ;;; Sorting
2301 ;; Most ls can only sort by name or by date (with -t), nothing else.
2302 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2303 ;; So anything that does not contain these is sort "by name".
2305 (defvar dired-ls-sorting-switches "SXU"
2306 "String of `ls' switches (single letters) except `t' that influence sorting.")
2308 (defvar dired-sort-by-date-regexp
2309 (concat "^-[^" dired-ls-sorting-switches
2310 "]*t[^" dired-ls-sorting-switches "]*$")
2311 "Regexp recognized by dired to set `by date' mode.")
2313 (defvar dired-sort-by-name-regexp
2314 (concat "^-[^t" dired-ls-sorting-switches "]+$")
2315 "Regexp recognized by dired to set `by name' mode.")
2317 (defun dired-sort-set-modeline ()
2318 ;; Set modeline display according to dired-actual-switches.
2319 ;; Modeline display of "by name" or "by date" guarantees the user a
2320 ;; match with the corresponding regexps. Non-matching switches are
2321 ;; shown literally.
2322 (setq mode-name
2323 (let (case-fold-search)
2324 (cond ((string-match dired-sort-by-name-regexp dired-actual-switches)
2325 "Dired by name")
2326 ((string-match dired-sort-by-date-regexp dired-actual-switches)
2327 "Dired by date")
2328 (t
2329 (concat "Dired " dired-actual-switches)))))
2330 (force-mode-line-update))
2332 (defun dired-sort-toggle-or-edit (&optional arg)
2333 "Toggle between sort by date/name and refresh the dired buffer.
2334 With a prefix argument you can edit the current listing switches instead."
2335 (interactive "P")
2336 (if arg
2337 (dired-sort-other
2338 (read-string "ls switches (must contain -l): " dired-actual-switches))
2339 (dired-sort-toggle)))
2341 (defun dired-sort-toggle ()
2342 ;; Toggle between sort by date/name. Reverts the buffer.
2343 (setq dired-actual-switches
2344 (let (case-fold-search)
2345 (concat
2346 "-l"
2347 (dired-replace-in-string (concat "[-lt"
2348 dired-ls-sorting-switches "]")
2349 ""
2350 dired-actual-switches)
2351 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
2352 dired-actual-switches)
2353 ""
2354 "t"))))
2355 (dired-sort-set-modeline)
2356 (revert-buffer))
2358 (defun dired-replace-in-string (regexp newtext string)
2359 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2361 (let ((result "") (start 0) mb me)
2362 (while (string-match regexp string start)
2363 (setq mb (match-beginning 0)
2364 me (match-end 0)
2365 result (concat result (substring string start mb) newtext)
2366 start me))
2367 (concat result (substring string start))))
2369 (defun dired-sort-other (switches &optional no-revert)
2370 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2371 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2372 ;; minor mode accordingly, others appear literally in the mode line.
2373 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2374 (setq dired-actual-switches switches)
2375 (if (eq major-mode 'dired-mode) (dired-sort-set-modeline))
2376 (or no-revert (revert-buffer)))
2377 \f
2378 ;; To make this file smaller, the less common commands
2379 ;; go in a separate file. But autoload them here
2380 ;; to make the separation invisible.
2382 (autoload 'dired-diff "dired-aux"
2383 "Compare file at point with file FILE using `diff'.
2384 FILE defaults to the file at the mark.
2385 The prompted-for file is the first file given to `diff'."
2386 t)
2388 (autoload 'dired-backup-diff "dired-aux"
2389 "Diff this file with its backup file or vice versa.
2390 Uses the latest backup, if there are several numerical backups.
2391 If this file is a backup, diff it with its original.
2392 The backup file is the first file given to `diff'."
2393 t)
2395 (autoload 'dired-clean-directory "dired-aux"
2396 "Flag numerical backups for deletion.
2397 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2398 Positive prefix arg KEEP overrides `dired-kept-versions';
2399 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2402 with a prefix argument."
2403 t)
2405 (autoload 'dired-do-chmod "dired-aux"
2406 "Change the mode of the marked (or next ARG) files.
2407 This calls chmod, thus symbolic modes like `g+w' are allowed."
2408 t)
2410 (autoload 'dired-do-chgrp "dired-aux"
2411 "Change the group of the marked (or next ARG) files."
2412 t)
2414 (autoload 'dired-do-chown "dired-aux"
2415 "Change the owner of the marked (or next ARG) files."
2416 t)
2418 (autoload 'dired-do-print "dired-aux"
2419 "Print the marked (or next ARG) files.
2420 Uses the shell command coming from variables `lpr-command' and
2421 `lpr-switches' as default."
2422 t)
2424 (autoload 'dired-do-shell-command "dired-aux"
2425 "Run a shell command COMMAND on the marked files.
2426 If no files are marked or a specific numeric prefix arg is given,
2428 The prompt mentions the file(s) or the marker, as appropriate.
2430 If there is output, it goes to a separate buffer.
2432 Normally the command is run on each file individually.
2433 However, if there is a `*' in the command then it is run
2434 just once with the entire file list substituted there.
2436 No automatic redisplay of dired buffers is attempted, as there's no
2437 telling what files the command may have changed. Type
2440 The shell command has the top level directory as working directory, so
2441 output files usually are created there instead of in a subdir."
2442 t)
2444 (autoload 'dired-do-kill-lines "dired-aux"
2445 "Kill all marked lines (not the files).
2446 With a prefix arg, kill all lines not marked or flagged."
2447 t)
2449 (autoload 'dired-do-compress "dired-aux"
2450 "Compress or uncompress marked (or next ARG) files."
2451 t)
2453 (autoload 'dired-do-byte-compile "dired-aux"
2454 "Byte compile marked (or next ARG) Emacs Lisp files."
2455 t)
2457 (autoload 'dired-do-load "dired-aux"
2458 "Load the marked (or next ARG) Emacs Lisp files."
2459 t)
2461 (autoload 'dired-do-redisplay "dired-aux"
2462 "Redisplay all marked (or next ARG) files.
2463 If on a subdir line, redisplay that subdirectory. In that case,
2464 a prefix arg lets you edit the `ls' switches used for the new listing."
2465 t)
2467 (autoload 'dired-create-directory "dired-aux"
2468 "Create a directory called DIRECTORY."
2469 t)
2471 (autoload 'dired-do-copy "dired-aux"
2472 "Copy all marked (or next ARG) files, or copy the current file.
2473 Thus, a zero prefix argument copies nothing. But it toggles the
2474 variable `dired-copy-preserve-time' (which see)."
2475 t)
2477 (autoload 'dired-do-symlink "dired-aux"
2478 "Make symbolic links to current file or all marked (or next ARG) files.
2479 When operating on just the current file, you specify the new name.
2480 When operating on multiple or marked files, you specify a directory
2481 and new symbolic links are made in that directory
2482 with the same names that the files currently have."
2483 t)
2485 (autoload 'dired-do-hardlink "dired-aux"
2486 "Add names (hard links) current file or all marked (or next ARG) files.
2487 When operating on just the current file, you specify the new name.
2488 When operating on multiple or marked files, you specify a directory
2489 and new hard links are made in that directory
2490 with the same names that the files currently have."
2491 t)
2493 (autoload 'dired-do-rename "dired-aux"
2494 "Rename current file or all marked (or next ARG) files.
2495 When renaming just the current file, you specify the new name.
2496 When renaming multiple or marked files, you specify a directory."
2497 t)
2499 (autoload 'dired-do-rename-regexp "dired-aux"
2500 "Rename marked files containing REGEXP to NEWNAME.
2501 As each match is found, the user must type a character saying
2504 REGEXP defaults to the last regexp used.
2505 With a zero prefix arg, renaming by regexp affects the complete
2506 pathname - usually only the non-directory part of file names is used
2507 and changed."
2508 t)
2510 (autoload 'dired-do-copy-regexp "dired-aux"
2511 "Copy all marked files containing REGEXP to NEWNAME.
2512 See function `dired-rename-regexp' for more info."
2513 t)
2515 (autoload 'dired-do-hardlink-regexp "dired-aux"
2516 "Hardlink all marked files containing REGEXP to NEWNAME.
2517 See function `dired-rename-regexp' for more info."
2518 t)
2520 (autoload 'dired-do-symlink-regexp "dired-aux"
2521 "Symlink all marked files containing REGEXP to NEWNAME.
2522 See function `dired-rename-regexp' for more info."
2523 t)
2525 (autoload 'dired-upcase "dired-aux"
2526 "Rename all marked (or next ARG) files to upper case."
2527 t)
2529 (autoload 'dired-downcase "dired-aux"
2530 "Rename all marked (or next ARG) files to lower case."
2531 t)
2533 (autoload 'dired-maybe-insert-subdir "dired-aux"
2534 "Insert this subdirectory into the same dired buffer.
2536 else inserts it at its natural place (as `ls -lR' would have done).
2537 With a prefix arg, you may edit the ls switches used for this listing.
2538 You can add `R' to the switches to expand the whole tree starting at
2539 this subdirectory.
2540 This function takes some pains to conform to `ls -lR' output."
2541 t)
2543 (autoload 'dired-next-subdir "dired-aux"
2544 "Go to next subdirectory, regardless of level."
2545 t)
2547 (autoload 'dired-prev-subdir "dired-aux"
2548 "Go to previous subdirectory, regardless of level.
2549 When called interactively and not on a subdir line, go to this subdir's line."
2550 t)
2552 (autoload 'dired-goto-subdir "dired-aux"
2553 "Go to end of header line of DIR in this dired buffer.
2554 Return value of point on success, otherwise return nil.
2556 t)
2558 (autoload 'dired-mark-subdir-files "dired-aux"
2559 "Mark all files except `.' and `..'."
2560 t)
2562 (autoload 'dired-kill-subdir "dired-aux"
2563 "Remove all lines of current subdirectory.
2564 Lower levels are unaffected."
2565 t)
2567 (autoload 'dired-tree-up "dired-aux"
2568 "Go up ARG levels in the dired tree."
2569 t)
2571 (autoload 'dired-tree-down "dired-aux"
2572 "Go down in the dired tree."
2573 t)
2575 (autoload 'dired-hide-subdir "dired-aux"
2576 "Hide or unhide the current subdirectory and move to next directory.
2577 Optional prefix arg is a repeat factor.
2579 t)
2581 (autoload 'dired-hide-all "dired-aux"
2582 "Hide all subdirectories, leaving only their header lines.
2583 If there is already something hidden, make everything visible again.
2585 t)
2586 \f
2587 (if (eq system-type 'vax-vms)
2588 (load "dired-vms"))
2590 (provide 'dired)
2592 (run-hooks 'dired-load-hook) ; for your customizations
2594 ;;; dired.el ends here