| blob | c421e51ffd178a567a0080547dffc9c852c66450 |
1 ;;; dired.el --- directory-browsing commands -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1986, 1992-1997, 2000-2018 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: files
9 ;; Package: emacs
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This is a major mode for directory browsing and editing.
29 ;; It is documented in the Emacs manual.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
38 ;; When bootstrapping dired-loaddefs has not been generated.
44 ;;; Customizable variables
47 "Directory editing."
52 "Handling marks in Dired."
57 ;;;###autoload
59 "Switches passed to `ls' for Dired. MUST contain the `l' option.
60 May contain all other options that don't contradict `-l';
61 may contain even `F', `b', `i' and `s'. See also the variable
62 `dired-ls-F-marks-symlinks' concerning the `F' switch.
63 Options that include embedded whitespace must be quoted
65 `combine-and-quote-strings' to produce the correct quoting of
66 each option.
67 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
68 some of the `ls' switches are not supported; see the doc string of
69 `insert-directory' in `ls-lisp.el' for more details."
74 "If non-nil, switches passed to `ls' for inserting subdirectories.
75 If nil, `dired-listing-switches' is used."
85 "Name of chown command (usually `chown')."
91 The special value of `unspecified' means to check explicitly, and
92 save the result in this variable. This is performed the first
93 time `dired-insert-directory' is called.
95 Note that if you set this option to nil, either through choice or
98 spaces. You might want to install ls from GNU Coreutils, which does
99 support this option. Alternatively, you might want to use Emacs's
101 (setq ls-lisp-use-insert-directory-program nil)
104 Note that `ls-lisp' does not support as many options as GNU ls, though.
105 For more details, see Info node `(emacs)ls in Lisp'."
112 "Name of chmod command (usually `chmod')."
117 "Name of touch command (usually `touch')."
122 "Informs Dired about how `ls -lF' marks symbolic links.
123 Set this to t if `ls' (or whatever program is specified by
124 `insert-directory-program') with `-lF' marks the symbolic link
125 itself with a trailing @ (usually the case under Ultrix).
127 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
128 nil (the default), if it gives `bar@ -> foo', set it to t.
130 Dired checks if there is really a @ appended. Thus, if you have a
131 marking `ls' program on one host and a non-marking on another host, and
132 don't care about symbolic links which really end in a @, you can
133 always set this variable to t."
138 "Regexp of files to skip when finding first file of a directory.
139 A value of nil means move to the subdir line.
140 A value of t means move to first file."
143 regexp)
147 ;; Use t as default so that moved files "take their markers with them".
148 "Controls marking of renamed files.
149 If t, files keep their previous marks when they are renamed.
150 If a character, renamed files (whether previously marked or not)
151 are afterward marked with that character.
152 This option affects only files renamed by `dired-do-rename' and
153 `dired-do-rename-regexp'. See `wdired-keep-marker-rename'
154 if you want to do the same for files renamed in WDired mode."
160 "Controls marking of copied files.
161 If t, copied files are marked if and as the corresponding original files were.
162 If a character, copied files are unconditionally marked with that character."
168 "Controls marking of newly made hard links.
169 If t, they are marked if and as the files linked to were marked.
170 If a character, new links are unconditionally marked with that character."
176 "Controls marking of newly made symbolic links.
177 If t, they are marked if and as the files linked to were marked.
178 If a character, new links are unconditionally marked with that character."
184 "If non-nil, Dired tries to guess a default target directory.
185 This means: if there is a Dired buffer displayed in the next
186 window, use its current directory, instead of this Dired buffer's
187 current directory.
189 The target is used in the prompt for file copy, rename etc."
194 "If non-nil, Dired preserves the last-modified time in a file copy.
195 \(This works on only some systems.)"
199 ; These variables were deleted and the replacements are on files.el.
200 ; We leave aliases behind for back-compatibility.
204 ;;; Hook variables
207 "Run after loading Dired.
208 You can customize key bindings or load extensions with this."
213 "Run at the very end of `dired-mode'."
218 "This hook is run before a Dired buffer is read in (created or reverted)."
223 "Hook run after each time a file or directory is read by Dired.
224 After each listing of a file or directory, this hook is run
225 with the buffer narrowed to the listing."
228 ;; Note this can't simply be run inside function `dired-ls' as the hook
229 ;; functions probably depend on the dired-subdir-alist to be OK.
232 "This hook is used to position the point.
233 It is run by the function `dired-initial-position'."
242 "The functions to call when a drop in `dired-mode' is made.
243 See `dnd-protocol-alist' for more information. When nil, behave
244 as in other buffers. Changing this option is effective only for
245 new Dired buffers."
252 "Non-nil means `dired-hide-details-mode' hides symbolic link targets."
258 "Non-nil means `dired-hide-details-mode' hides all but header and file lines."
264 "Non-nil means revert buffers visiting files before searching them.
265 By default, commands like `dired-mark-files-containing-regexp' will
266 search any buffers visiting the marked files without reverting them,
267 even if they were changed on disk. When this option is non-nil, such
268 buffers are always reverted in a temporary buffer before searching
269 them: the search is performed on the temporary buffer, the original
270 buffer visiting the file is not modified."
275 ;; Internal variables
278 ;; so that you can write things like
279 ;; (let ((dired-marker-char ?X))
280 ;; ;; great code using X markers ...
281 ;; )
282 ;; For example, commands operating on two sets of files, A and B.
283 ;; Or marking files with digits 0-9. This could implicate
284 ;; concentric sets or an order for the marked files.
285 ;; The code depends on dynamic scoping on the marker char.
286 "In Dired, the current mark character.
293 ;; I see no reason ever to make this nil -- rms.
294 ;; (> baud-rate search-slow-speed)
297 "use the Customization interface to add a new rule
303 ;;;###autoload
305 "The directory name or wildcard spec that this Dired directory lists.
306 Local to each Dired buffer. May be a list, in which case the car is the
307 directory name and the cdr is the list of files to mention.
310 ;; Beware of "-l;reboot" etc. See bug#3230.
312 "Return non-nil if string SWITCHES does not look risky for Dired."
326 ;; These regexps must be tested at beginning-of-line, but are also
327 ;; used to search for next matches, so neither omitting "^" nor
328 ;; replacing "^" by "\n" (to make it slightly faster) will work.
331 ;; "Regexp matching a marked line.
332 ;; Important: the match ends just after the marker."
334 ;; The [^:] part after "d" and "l" is to avoid confusion with the
335 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
342 "-[-r][-w].[-r][-w][xs][-r][-w]."
348 ;; The subdirectory names in the next two lists are expanded.
350 "Association list of subdirectories and their buffer positions.
351 Each subdirectory has an element: (DIRNAME . STARTMARKER).
352 The order of elements is the reverse of the order in the buffer.
356 "Keeps track of which switches to use for inserted subdirectories.
363 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
364 Subexpression 1 is the subdirectory proper, no trailing colon.
365 The match starts at the beginning of the line and ends after the end
370 "Faces used by Dired."
376 "Face used for directory headers."
384 "Face used for Dired marks."
392 "Face used for marked files."
400 "Face used for files flagged for deletion."
407 ;; Inherit from font-lock-warning-face since with min-colors 8
408 ;; font-lock-comment-face is not colored any more.
410 "Face used to highlight a part of a buffer that needs user attention."
418 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
419 ;; font-lock-comment-face is not colored any more.
421 "Face used to highlight permissions of group- and world-writable files."
429 "Face used for subdirectories."
437 "Face used for symbolic links."
445 "Face used for files suffixed with `completion-ignored-extensions'."
453 ;;
454 ;; Dired marks.
456 ;;
457 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
458 ;; file name itself. We search for Dired defined regexps, and then use the
459 ;; Dired defined function `dired-move-to-filename' before searching for the
460 ;; simple regexp ".+". It is that regexp which matches the file name.
461 ;;
462 ;; Marked files.
465 ;;
466 ;; Flagged files.
469 ;; People who are paranoid about security would consider this more
470 ;; important than other things such as whether it is a directory.
471 ;; But we don't want to encourage paranoia, so our default
472 ;; should be what's most useful for non-paranoids. -- rms.
473 ;;; ;;
474 ;;; ;; Files that are group or world writable.
475 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
476 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
477 ;;; '(1 dired-warning-face)
478 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
479 ;; However, we don't need to highlight the file name, only the
480 ;; permissions, to win generally. -- fx.
481 ;; Fixme: we could also put text properties on the permission
482 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
489 ;;
490 ;; Subdirectories.
493 ;;
494 ;; Symbolic links.
497 ;;
498 ;; Files suffixed with `completion-ignored-extensions'.
500 ;; It is quicker to first find just an extension, then go back to the
501 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
504 ;;
505 ;; Files suffixed with `completion-ignored-extensions'
506 ;; plus a character put in by -F.
512 ;; If the last character is not part of the filename,
513 ;; move back to the start of the filename
514 ;; so it can be fontified.
515 ;; Otherwise, leave point at the end of the line;
516 ;; that way, nothing is fontified.
520 ;;
521 ;; Explicitly put the default face on file names ending in a colon to
522 ;; avoid fontifying them as directory header.
525 ;;
526 ;; Directory headers.
528 )
532 \f
533 ;;; Macros must be defined before they are used, for the byte compiler.
536 "Mark all files for which PREDICATE evals to non-nil.
537 PREDICATE is evaluated on each line, with point at beginning of line.
538 MSG is a noun phrase for the type of files being marked.
539 It should end with a noun that can be pluralized by adding `s'.
540 Return value is the number of files marked, or nil if none were marked."
550 ,msg
552 " for deletion"
563 count
564 ,msg
572 distinguish-one-marked)
573 "Eval BODY with point on each marked line. Return a list of BODY's results.
574 If no marked file could be found, execute BODY on the current
575 line. ARG, if non-nil, specifies the files to use instead of the
576 marked files.
578 If ARG is an integer, use the next ARG (or previous -ARG, if
579 ARG<0) files. In that case, point is dragged along. This is so
580 that commands on the next ARG (instead of the marked) files can
581 be chained easily.
582 For any other non-nil value of ARG, use the current file.
584 If optional third arg SHOW-PROGRESS evaluates to non-nil,
585 redisplay the dired buffer after each file is processed.
587 No guarantee is made about the position on the marked line.
588 BODY must ensure this itself if it depends on this.
590 Search starts at the beginning of the buffer, thus the car of the
591 list corresponds to the line nearest to the buffer's bottom.
592 This is also true for (positive and negative) integer values of
593 ARG.
595 BODY should not be too long as it is expanded four times.
597 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one
598 marked file, return (t FILENAME) instead of (FILENAME)."
599 ;;
600 ;;Warning: BODY must not add new lines before point - this may cause an
601 ;;endless loop.
602 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
609 ,arg
615 results))
616 ;; non-nil, non-integer ARG means use current file:
621 ;; remember position of next marked file before BODY
622 ;; can insert lines before the just found file,
623 ;; confusing us by finding the same marked file again
624 ;; and again and...
632 ;; move after last match
641 results
643 ;; save-excursion loses, again
647 "Return the marked files' names as list of strings.
648 The list is in the same order as the buffer, that is, the car is the
649 first marked file.
650 Values returned are normally absolute file names.
651 Optional arg LOCALP as in `dired-get-filename'.
652 Optional second argument ARG, if non-nil, specifies files near
653 point instead of marked files. It usually comes from the prefix
654 argument.
655 If ARG is an integer, use the next ARG files.
656 If ARG is any other non-nil value, return the current file name.
657 If no files are marked, and ARG is nil, also return the current file name.
658 Optional third argument FILTER, if non-nil, is a function to select
659 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
661 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
662 return (t FILENAME) instead of (FILENAME).
663 Don't use that together with FILTER."
668 arg nil distinguish-one-marked))))
669 result)
674 all-of-them
679 result)))
680 \f
681 ;; The dired command
684 ;; For use in interactive.
688 dired-listing-switches))
689 ;; If a dialog is used, call `read-directory-name' so the
690 ;; dialog code knows we want directories. Some dialogs
691 ;; can only select directories or files when popped up,
692 ;; not both. If no dialog is used, call `read-file-name'
693 ;; because the user may want completion of file names for
694 ;; use in a wildcard pattern.
697 nil default-directory nil)
699 nil default-directory nil)))))
701 ;; We want to switch to a more sophisticated version of
702 ;; dired-read-dir-and-switches like the following, if there is a way
703 ;; to make it more intuitive. See bug#1285.
705 ;; (defun dired-read-dir-and-switches (str)
706 ;; ;; For use in interactive.
707 ;; (reverse
708 ;; (list
709 ;; (if current-prefix-arg
710 ;; (read-string "Dired listing switches: "
711 ;; dired-listing-switches))
712 ;; ;; If a dialog is about to be used, call read-directory-name so
713 ;; ;; the dialog code knows we want directories. Some dialogs can
714 ;; ;; only select directories or files when popped up, not both.
715 ;; (if (next-read-file-uses-dialog-p)
716 ;; (read-directory-name (format "Dired %s(directory): " str)
717 ;; nil default-directory nil)
718 ;; (let ((cie ()))
719 ;; (dolist (ext completion-ignored-extensions)
720 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
721 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
722 ;; (let* ((default (and buffer-file-name
723 ;; (abbreviate-file-name buffer-file-name)))
724 ;; (cie cie)
725 ;; (completion-table
726 ;; ;; We need a mix of read-file-name and
727 ;; ;; read-directory-name so that completion to directories
728 ;; ;; is preferred, but if the user wants to enter a global
729 ;; ;; pattern, he can still use completion on filenames to
730 ;; ;; help him write the pattern.
731 ;; ;; Essentially, we want to use
732 ;; ;; (completion-table-with-predicate
733 ;; ;; 'read-file-name-internal 'file-directory-p nil)
734 ;; ;; but that doesn't work because read-file-name-internal
735 ;; ;; does not obey its `predicate' argument.
736 ;; (completion-table-in-turn
737 ;; (lambda (str pred action)
738 ;; (let ((read-file-name-predicate
739 ;; (lambda (f)
740 ;; (and (not (member f '("./" "../")))
741 ;; ;; Hack! Faster than file-directory-p!
742 ;; (eq (aref f (1- (length f))) ?/)
743 ;; (not (string-match cie f))))))
744 ;; (complete-with-action
745 ;; action 'read-file-name-internal str nil)))
746 ;; 'read-file-name-internal)))
747 ;; (minibuffer-with-setup-hook
748 ;; (lambda ()
749 ;; (setq minibuffer-default default)
750 ;; (setq minibuffer-completion-table completion-table))
751 ;; (read-file-name (format "Dired %s(directory): " str)
752 ;; nil default-directory nil))))))))
755 "Try to get a file name at point in the current dired buffer.
756 This hook is intended to be put in `file-name-at-point-functions'.
757 Note that it returns an abbreviated name that can't be used
758 as an argument to `dired-goto-file'."
765 ;;;###autoload (define-key ctl-x-map "d" 'dired)
766 ;;;###autoload
769 Optional second argument SWITCHES specifies the `ls' options used.
770 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
772 If DIRNAME is a string, Dired displays a list of files in DIRNAME (which
773 may also have shell wildcards appended to select certain files).
775 If DIRNAME is a cons, its first element is taken as the directory name
776 and the rest as an explicit list of files to make directory entries for.
777 In this case, SWITCHES are applied to each of the files separately, and
778 therefore switches that control the order of the files in the produced
779 listing have no effect.
786 If DIRNAME is already in a Dired buffer, that buffer is used without refresh."
787 ;; Cannot use (interactive "D") because of wildcards.
791 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
792 ;;;###autoload
798 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
799 ;;;###autoload
805 ;;;###autoload
807 "Like `dired' but returns the Dired buffer as value, does not select it."
809 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
810 ;; some shells make:
821 ;; If the argument was syntactically a directory name not a file name,
822 ;; or if it happens to name a file that is a directory,
823 ;; convert it syntactically to a directory name.
824 ;; The reason for checking initially-was-dirname
825 ;; and not just file-directory-p
826 ;; is that file-directory-p is slow over ftp.
834 ;; The following is an internal dired function. It returns non-nil if
835 ;; the directory visited by the current dired buffer has changed on
836 ;; disk. DIRNAME should be the directory name of that directory.
845 "Return non-nil if current Dired buffer needs updating.
846 If NOCONFIRM is non-nil, then this function always returns nil
847 for a remote directory. This feature is used by Auto Revert mode."
853 ;; Do not auto-revert when the dired buffer can be currently
854 ;; written by the user as in `wdired-mode'.
855 buffer-read-only
859 "Automatically revert Dired buffer on revisiting.
860 If t, revisiting an existing Dired buffer automatically reverts it.
861 If its value is a function, call this function with the directory
862 name as single argument and revert the buffer if it returns non-nil.
863 Otherwise, a message offering to revert the changed dired buffer
864 is displayed.
865 Note that this is not the same as `auto-revert-mode' that
866 periodically reverts at specified time intervals."
876 "Return non-nil if some file names are misaligned.
877 The return value is the target column for the file names."
881 ;; Use point difference instead of `current-column', because
882 ;; the former works when `dired-hide-details-mode' is enabled.
895 "Align all files adding spaces in front of the size column."
903 ;; Use point difference instead of `current-column', because
904 ;; the former works when `dired-hide-details-mode' is enabled.
916 ;; If DIR-OR-LIST is a string and there is an existing dired buffer
917 ;; for it, just leave buffer as it is (don't even call dired-revert).
918 ;; This saves time especially for deep trees or with ange-ftp.
919 ;; The user can type `g' easily, and it is more consistent with find-file.
920 ;; But if SWITCHES are given they are probably different from the
921 ;; buffer's old value, so call dired-sort-other, which does
922 ;; revert the buffer.
923 ;; Revert the buffer if DIR-OR-LIST is a cons or `dired-directory'
924 ;; is a cons and DIR-OR-LIST is a string.
925 ;; A pity we can't possibly do "Directory has changed - refresh? "
926 ;; like find-file does.
927 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
928 ;; see there.
931 ;; Look for an existing buffer.
933 ;; Note that buffer already is in dired-mode, if found.
940 ;; file list may have changed
942 ;; this calls dired-revert
944 ;; Always revert when `dir-or-list' is a cons. Also revert
945 ;; if `dired-directory' is a cons but `dir-or-list' is not.
949 ;; Always revert regardless of whether it has changed or not.
952 ;; Revert when predicate function returns non-nil.
957 ;; If directory has changed on disk, offer to revert.
962 ;; Else a new buffer
965 ;; We can do this unconditionally
966 ;; because dired-noselect ensures that the name
967 ;; is passed in directory name syntax
968 ;; if it was the name of a directory at all.
973 ;; default-directory and dired-actual-switches are set now
974 ;; (buffer-local), so we can call dired-readin:
979 ;; dired-readin can fail if parent directories are inaccessible.
980 ;; Don't leave an empty buffer around in that case.
987 buffer))
990 ;; Enlarged by dired-advertise
991 ;; Queried by function dired-buffers-for-dir. When this detects a
992 ;; killed buffer, it is removed from this list.
997 ;; FIXME add a doc-string, and document dired-x extensions.
999 ;; This differs from dired-buffers-for-dir in that it does not consider
1000 ;; subdirs of default-directory and searches for the first match only.
1001 ;; Also, the major mode must be MODE.
1003 dired-find-subdir
1004 ;; Don't try to find a wildcard as a subdirectory.
1010 ;; Wildcards must match, too:
1012 ;; We don't want to switch to the same buffer---
1015 ;; ---unless it's the only possibility:
1017 ;; No dired-x, or dired-find-subdir nil.
1026 dired-directory ;; nil during find-alternate-file
1031 dired-directory))))
1033 blist nil)
1035 found)))
1037 \f
1038 ;; Read in a new dired buffer
1041 "Read in a new Dired buffer.
1042 Differs from `dired-insert-subdir' in that it accepts
1043 wildcards, erases the buffer, and builds the subdir-alist anew
1044 \(including making it buffer-local and clearing it first)."
1046 ;; default-directory and dired-actual-switches must be buffer-local
1047 ;; and initialized by now.
1049 ;; This makes read-in much faster.
1050 ;; In particular, it prevents the font lock hook from running
1051 ;; until the directory is all read in.
1058 ;; This hook which may want to modify dired-actual-switches
1059 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
1060 ;; where ls won't understand -Al switches.
1067 ;; Don't make undo entries for readin.
1073 ;; Must first make alist buffer local and set it to nil because
1074 ;; dired-build-subdir-alist will call dired-clear-alist first
1081 ;; No need to narrow since the whole buffer contains just
1082 ;; dired-readin's output, nothing else. The hook can
1083 ;; successfully use dired functions (e.g. dired-get-filename)
1084 ;; as the subdir-alist has been built in dired-readin.
1087 ;; Subroutines of dired-readin
1090 ;; Insert listing for the specified dir (and maybe file list)
1091 ;; already in dired-directory, assuming a clean buffer.
1097 file-list nil))
1101 ;; If we are reading a whole single directory...
1107 ;; Else treat it as a wildcard spec
1108 ;; unless we have an explicit list of files.
1113 "Align the fields of a file to the ones of surrounding lines.
1114 BEG..END is the line where the file info is located."
1115 ;; Some versions of ls try to adjust the size of each field so as to just
1116 ;; hold the largest element ("largest" in the current invocation, of
1117 ;; course). So when a single line is output, the size of each field is
1118 ;; just big enough for that one output. Thus when dired refreshes one
1119 ;; line, the alignment if this line w.r.t the rest is messed up because
1120 ;; the fields of that one line will generally be smaller.
1121 ;;
1122 ;; To work around this problem, we here add spaces to try and
1123 ;; re-align the fields as needed. Since this is purely aesthetic,
1124 ;; it is of utmost importance that it doesn't mess up anything like
1125 ;; `dired-move-to-filename'. To this end, we limit ourselves to
1126 ;; adding spaces only, and to only add them at places where there
1127 ;; was already at least one space. This way, as long as
1128 ;; `directory-listing-before-filename-regexp' always matches spaces
1129 ;; with "*" or "+", we know we haven't made anything worse. There
1130 ;; is one spot where the exact number of spaces is important, which
1131 ;; is just before the actual filename, so we refrain from adding
1132 ;; spaces there (and within the filename as well, of course).
1135 ;; Check that there is indeed a file, and that there is another adjacent
1136 ;; file with which to align, and that additional spaces are needed to
1137 ;; align the filenames.
1150 ;; Make sure there is some work left to do.
1152 ;; If we've only looked at the line above, check to see if the line
1153 ;; below exists as well and if so, align with the shorter one.
1162 ;; Keep positions uptodate when we insert stuff.
1165 ;; Main loop.
1169 ;; Don't touch anything just before (and after) the
1170 ;; beginning of the filename.
1172 ;; We're now just in front of a field, with a space behind us.
1174 ;; Nums are right-aligned.
1176 ;; Let's look at the other line, in the same column: we
1177 ;; should be either near the end of the previous field, or
1178 ;; in the space between that field and the next.
1179 ;; [ Of course, it's also possible that we're already within
1180 ;; the next field or even past it, but that's unlikely since
1181 ;; other-col > file-col. ]
1182 ;; Let's find the distance to the alignment-point (either
1183 ;; the beginning or the end of the next field, depending on
1184 ;; whether this field is left or right aligned).
1194 ;; Now, the number of spaces to insert is align-pt-offset
1195 ;; minus the distance to the equivalent point on the
1196 ;; current line.
1199 align-pt-offset
1209 ;; Let's just make really sure we did not mess up.
1212 ;; Damn! We messed up: let's revert the change.
1214 ;; Now skip to next field.
1222 "Return non-nil if the string SWITCHES matches LONG or SHORT format."
1227 switches))))
1230 "Return non-nil if the string SWITCHES contains -b or --escape."
1231 ;; Do not match things like "--block-size" that happen to contain "b".
1235 "Return non-nil if the string SWITCHES contains -R or --recursive."
1239 "Insert a directory listing of DIR, Dired style.
1240 Use SWITCHES to make the listings.
1241 If FILE-LIST is non-nil, list only those files.
1242 Otherwise, if WILDCARD is non-nil, expand wildcards;
1243 in that case, DIR should be a file name that uses wildcards.
1244 In other cases, DIR should be a directory name or a directory filename.
1245 If HDR is non-nil, insert a header line with the directory name."
1248 end)
1250 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1251 ;; ls-lisp emulation is used, except if they want to use `ls'
1252 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1259 ;; Check whether "ls --dired" gives exit code 0, and
1260 ;; save the answer in `dired-use-ls-dired'.
1267 nil))
1268 dired-use-ls-dired)))
1270 ;; Expand directory wildcards and fill file-list.
1274 ;; We don't know whether the remote ls supports
1275 ;; "--dired", so we cannot add it to the `process-file'
1276 ;; call for wildcards.
1294 ;; We used to specify the C locale here, to force English
1295 ;; month names; but this should not be necessary any
1296 ;; more, with the new value of
1297 ;; `directory-listing-before-filename-regexp'.
1302 ;; Re-align fields, if necessary.
1305 ;; Quote certain characters, unless ls quoted them for us.
1314 nil t))
1320 nil t))
1322 ;; Replace any newlines in DIR with literal "\n"s, for the sake
1323 ;; of the header line. To disambiguate a literal "\n" in the
1324 ;; actual dirname, we also replace "\" with "\\".
1325 ;; Personally, I think this should always be done, irrespective
1326 ;; of the value of dired-actual-switches, because:
1327 ;; i) Dired simply does not work with an unescaped newline in
1328 ;; the directory name used in the header (bug=10469#28), and
1329 ;; ii) "\" is always replaced with "\\" in the listing, so doing
1330 ;; it in the header as well makes things consistent.
1331 ;; But at present it is only done if "-b" is in ls-switches,
1332 ;; because newlines in dirnames are uncommon, and people may
1333 ;; have gotten used to seeing unescaped "\" in the headers.
1334 ;; Note: adjust dired-build-subdir-alist if you change this.
1337 ;; If we used --dired and it worked, the lines are already indented.
1338 ;; Otherwise, indent them.
1344 ;; Insert text at the beginning to standardize things.
1351 ;; Note that dired-build-subdir-alist will replace the name
1352 ;; by its expansion, so it does not matter whether what we insert
1353 ;; here is fully expanded, but it should be absolute.
1358 ;; Insert "wildcard" line where "total" line would be for a full dir.
1365 "Add various text properties to the lines in the region."
1384 highlight
1385 dired-filename t
1391 \f
1392 ;; Reverting a dired buffer
1395 "Reread the Dired buffer.
1396 Must also be called after `dired-actual-switches' have changed.
1397 Should not fail even on completely garbaged buffers.
1398 Preserves old cursor, marks/flags, hidden-p.
1400 Dired sets `revert-buffer-function' to this function. The args
1401 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1413 ;; treat top level dir extra (it may contain wildcards)
1420 ;; Run dired-after-readin-hook just once, below.
1425 ;; ... run the hook for the whole buffer, and only after markers
1426 ;; have been reinserted (else omitting in dired-x would omit marked files)
1434 ;; outside of the let scope
1435 ;;; Might as well not override the user if the user changed this.
1436 ;;; (setq buffer-read-only t)
1437 )
1439 ;; Subroutines of dired-revert
1440 ;; Some of these are also used when inserting subdirs.
1443 "Return current positions in the buffer and all windows with this directory.
1444 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1446 BUFFER-POSITION is the point position in the current Dired buffer.
1447 It has the form (BUFFER DIRED-FILENAME BUFFER-LINE-NUMBER).
1449 WINDOW-POSITIONS are current positions in all windows displaying
1450 this dired buffer. The window positions have the form (WINDOW
1451 DIRED-FILENAME WINDOW-LINE-NUMBER).
1453 We store line numbers instead of point positions because the header
1454 lines might change as well: when this happen the line number doesn't
1455 change; the point does."
1466 "Restore POSITIONS saved with `dired-save-positions'."
1475 ;; Ensure that window still displays the original buffer.
1485 "Return alist of files and their marks, from BEG to END."
1496 alist))
1499 "Mark all files remembered in ALIST.
1500 Each element of ALIST looks like (FILE . MARKERCHAR)."
1514 "Return a list of names of subdirs currently hidden."
1524 result))
1527 "Try to insert all subdirs that were displayed before.
1528 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1540 "Remove directory DIR from any directory cache."
1544 \f
1545 ;; dired mode key bindings and initialization
1548 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1549 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1554 ;; Commands to mark or flag certain categories of files
1558 ;; Upper case keys (except !) for operating on the marked files
1578 ;; Comparison commands
1580 ;; Tree Dired commands
1586 ;; move to marked files
1589 ;; Make all regexp commands share a `%' prefix:
1590 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1591 ;; but that seems to serve little purpose, and copy-keymap
1592 ;; does a better job without it.
1605 ;; Commands for marking and unmarking.
1622 ;; Lower keys for commands not operating on all the marked files
1648 ;; moving
1656 ;; hiding
1660 ;; isearch
1665 ;; misc
1667 ;; `toggle-read-only' is an obsolete alias for `read-only-mode'
1673 ;; thumbnail manipulation (image-dired)
1686 ;; encryption and decryption (epa-dired)
1692 ;; Make menu bar items.
1694 ;; No need to fo this, now that top-level items are fewer.
1695 ;;;;
1696 ;; Get rid of the Edit menu bar item to save space.
1697 ;(define-key map [menu-bar edit] 'undefined)
1810 ;; When running on plain MS-DOS, there's only one
1811 ;; letter-case for file names.
1999 map)
2001 \f
2002 ;; Dired mode is suitable only for specially formatted data.
2005 ;; Autoload cookie needed by desktop.el
2006 ;;;###autoload
2008 "\
2011 (optionally) its subdirectories, in the format of `ls -lR'.
2014 compress, load or byte-compile them, change their file attributes
2017 by file or all files matching certain criteria.
2019 The buffer is read-only. Digits are prefix arguments.
2022 Most commands operate on the marked files and use the current file
2023 if no files are marked. Use a numeric prefix argument to operate on
2024 the next ARG (or previous -ARG if ARG<0) files, or just `1'
2025 to operate on the current file only. Prefix arguments override marks.
2027 to see why something went wrong.
2032 (or dired it in another buffer, if it is a directory).
2039 This retains all marks and hides subdirs again that were hidden before.
2040 Use `SPC' and `DEL' to move down and up by lines.
2043 to read the
2045 to relist the file at point or the marked files or a
2047 again for the directory tree.
2050 for more info):
2052 `dired-listing-switches'
2053 `dired-trivial-filenames'
2054 `dired-marker-char'
2055 `dired-del-marker'
2056 `dired-keep-marker-rename'
2057 `dired-keep-marker-copy'
2058 `dired-keep-marker-hardlink'
2059 `dired-keep-marker-symlink'
2063 `dired-before-readin-hook'
2064 `dired-after-readin-hook'
2065 `dired-mode-hook'
2066 `dired-load-hook'
2068 Keybindings:
2070 ;; Not to be called interactively (e.g. dired-directory will be set
2071 ;; to default-directory, which is wrong with wildcards).
2076 mode-name "Dired"
2077 ;; case-fold-search nil
2078 buffer-read-only t
2079 selective-display t ; for subdirectory hiding
2080 mode-line-buffer-identification
2082 ;; Ignore dired-hide-details-* value of invisible text property by default.
2089 ;; list-buffers uses this to display the dir being edited in this buffer.
2093 dired-directory)))
2107 \f
2108 ;; Idiosyncratic dired commands that don't deal with marks.
2111 "Summarize basic Dired commands and show recent Dired errors."
2114 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
2119 "Undo in a Dired buffer.
2120 This doesn't recover lost files, it just undoes changes in the buffer itself.
2121 You can use it to recover marks, killed lines or subdirs."
2130 "Edit Dired buffer with Wdired, or make it read-only.
2131 If the current buffer can be edited with Wdired, (i.e. the major
2132 mode is `dired-mode'), call `wdired-change-to-wdired-mode'.
2133 Otherwise, toggle `read-only-mode'."
2140 "Move down lines then position at filename.
2141 Optional prefix ARG says how many lines to move; default is one line."
2146 ;; We never want to move point into an invisible line.
2153 "Move up lines then position at filename.
2154 Optional prefix ARG says how many lines to move; default is one line."
2159 "Goto ARGth next directory file line."
2171 "Goto ARGth previous directory file line."
2176 "Run Dired on parent directory of current directory.
2177 Find the parent directory either in this buffer or another buffer.
2178 Creates a buffer if necessary.
2179 If OTHER-WINDOW (the optional prefix arg), display the parent
2180 directory in another window."
2185 ;; Only try dired-goto-subdir if buffer has more than one dir.
2195 "Get the current line's file name, with an error if file does not exist."
2197 ;; We pass t for second arg so that we don't get error for `.' and `..'.
2199 file-name)
2204 file-name
2209 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
2212 "In Dired, visit the file or directory named on this line."
2214 ;; Bind `find-file-run-dired' so that the command works on directories
2215 ;; too, independent of the user's setting.
2217 ;; This binding prevents problems with preserving point in
2218 ;; windows displaying Dired buffers, because reverting a Dired
2219 ;; buffer empties it, which changes the places where the
2220 ;; markers used by switch-to-buffer-preserve-window-point
2221 ;; point.
2224 nil
2225 switch-to-buffer-preserve-window-point)))
2229 "In Dired, visit file or directory on current line via `find-alternate-file'.
2230 This kills the Dired buffer, then visits the current line's file or directory."
2234 ;; Don't override the setting from .emacs.
2235 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
2238 "In Dired, visit the file or directory name you click on.
2239 The optional arguments FIND-FILE-FUNC and FIND-DIR-FUNC specify
2240 functions to visit the file and directory, respectively. If
2241 omitted or nil, these arguments default to `find-file' and `dired',
2242 respectively."
2265 "In Dired, visit the file or directory name you click on in another window."
2270 "In Dired, visit the file or directory name you click on in another frame."
2275 "In Dired, examine a file in view mode, returning to Dired when done.
2276 When file is a directory, show it in this buffer if it is inserted.
2277 Otherwise, display it in another buffer."
2287 "In Dired, visit this file or directory in another window."
2292 "In Dired, display this file or directory in another window."
2295 t))
2296 \f
2297 ;;; Functions for extracting and manipulating file names in Dired buffers.
2300 "In Dired, return name of file mentioned on this line.
2301 Value returned normally includes the directory name.
2302 Optional arg LOCALP with value `no-dir' means don't include directory
2303 name in result. A value of `verbatim' means to return the name exactly as
2304 it occurs in the buffer, and a value of t means construct name relative to
2305 `default-directory', which still may contain slashes if in a subdirectory.
2306 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2307 regular filenames and return nil if no filename on this line.
2308 Otherwise, an error occurs in these cases."
2313 ;; nil if no file on this line, but no-error-if-not-filep is t:
2316 ;; Get rid of the mouse-face property that file names have.
2318 ;; Unquote names quoted by ls or by dired-insert-directory.
2319 ;; This code was written using `read' to unquote, because
2320 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2321 ;; char) etc. in a lisp loop. Unfortunately, this decision
2322 ;; has necessitated hacks such as dealing with filenames
2323 ;; with quotation marks in their names.
2326 ;; Unescape any spaces escaped by ls -b (bug#10469).
2327 ;; Other -b quotes, eg \t, \n, work transparently.
2345 ;; Hence we don't need to worry about converting `\\' back to `\'.
2347 ;; The above `read' will return a unibyte string if FILE
2348 ;; contains eight-bit-control/graphic characters.
2356 nil)
2358 file)
2366 ;; check for safe-magic property so that we won't
2367 ;; put /: for names that don't really need them.
2368 ;; For instance, .gz files when auto-compression-mode is on.
2371 file)))
2373 file)
2377 ;; check for safe-magic property so that we won't
2378 ;; put /: for names that don't really need them.
2379 ;; For instance, .gz files when auto-compression-mode is on.
2382 file)))
2388 "Replace first match of REGEXP in STRING with NEWTEXT.
2389 If it does not match, nil is returned instead of the new string.
2390 Optional arg LITERAL means to take NEWTEXT literally.
2391 Optional arg GLOBAL means to replace all matches."
2398 ret)
2400 nil
2404 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2405 ;; We can't always use expand-file-name as this would get rid of `.'
2406 ;; or expand in / instead default-directory if DIR=="".
2407 ;; This should be good enough for ange-ftp.
2408 ;; It should be reasonably fast, though, as it is called in
2409 ;; dired-get-filename.
2413 "Convert FILE (an absolute file name) to a name relative to DIR.
2414 If DIR is omitted or nil, it defaults to `default-directory'.
2415 If FILE is not in the directory tree of DIR, return FILE
2416 unchanged."
2418 ;; This case comes into play if default-directory is set to
2419 ;; use ~.
2424 file))
2425 \f
2427 "Toggle visibility of detailed information in current Dired buffer.
2428 When this minor mode is enabled, details such as file ownership and
2429 permissions are hidden from view.
2431 See options: `dired-hide-details-hide-symlink-targets' and
2432 `dired-hide-details-hide-information-lines'."
2439 'dired-hide-details-update-invisibility-spec
2440 nil
2441 t)
2443 'dired-hide-details-update-invisibility-spec
2444 t)))
2448 'add-to-invisibility-spec
2452 dired-hide-details-hide-information-lines)
2453 'add-to-invisibility-spec
2457 dired-hide-details-hide-symlink-targets
2459 'add-to-invisibility-spec
2462 \f
2463 ;;; Functions for finding the file name in a dired buffer line.
2469 ;; Move to first char of filename on this line.
2470 ;; Returns position (point) or nil if no filename on this line."
2472 "Move to the beginning of the filename on the current line.
2473 Return the position of the beginning of the filename, or nil if none found."
2474 ;; This is the UNIX version.
2477 ;; First try assuming `ls --dired' was used.
2485 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2489 nil)
2494 ;; Assumes point is at beginning of filename,
2495 ;; thus the rwx bit re-search-backward below will succeed in *this*
2496 ;; line if at all. So, it should be called only after
2497 ;; (dired-move-to-filename t).
2498 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2499 ;; This is the UNIX version.
2509 nil
2511 ;; Restrict perm bits to be non-blank,
2512 ;; otherwise this matches one char to early (looking backward):
2513 ;; "l---------" (some systems make symlinks that way)
2514 ;; "----------" (plain file with zero perms)
2516 dired-permission-flags-regexp nil t)
2519 ;; Only with -F we need to know whether it's an executable
2521 used-F
2529 ;; Move point to end of name:
2535 dired-ls-F-marks-symlinks
2539 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2540 ;; one trailing character. (Executable bits on symlinks ain't mean
2541 ;; a thing, even to ls, but we know it's not a symlink.)
2544 executable)
2553 nil
2556 \f
2557 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2560 "Copy names of marked (or next ARG) files into the kill ring.
2561 The names are separated by a space.
2562 With a zero prefix arg, use the absolute file name of each marked file.
2564 `default-directory'. (This still may contain slashes if in a subdirectory.)
2566 If on a subdir headerline, use absolute subdirname instead;
2567 prefix arg and marked files are ignored in this case.
2590 \f
2591 ;; Keeping Dired buffers in sync with the filesystem and with each other
2594 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2595 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2596 ;; matches FILE.
2597 ;; The list is in reverse order of buffer creation, most recent last.
2598 ;; As a side effect, killed dired buffers for DIR are removed from
2599 ;; dired-buffers.
2606 ;; Buffer is killed - clean up:
2614 dired-directory)))
2617 file)))
2621 result))
2624 "Convert glob-pattern PATTERN to a regular expression."
2626 regexp)
2638 ;; Fails to handle ^ yet ????
2652 regexp
2660 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2661 ;; With wildcards we actually advertise too much.
2664 t ; we have already advertised ourselves
2667 dired-buffers)))))
2670 ;; Remove DIR from the buffer alist in variable dired-buffers.
2671 ;; This has the effect of removing any buffer whose main directory is DIR.
2672 ;; It does not affect buffers in which DIR is a subdir.
2673 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2676 \f
2677 ;; Tree Dired
2679 ;;; utility functions
2682 ;;"Is FILE part of the directory tree starting at DIR?"
2687 ;; Prepend default-directory to DIR if relative file name.
2688 ;; dired-get-filename must be able to make a valid file name from a
2689 ;; file and its directory DIR.
2692 dir
2696 ;;"Return the subdir name on this line, or nil if not on a headerline."
2697 ;; Look up in the alist whether this is a headerline.
2703 dired-subdir-alist))))
2704 cur-dir))))
2706 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2720 ;; Return an index into alist for use with nth
2721 ;; for the sake of subdir moving commands.
2730 "Go to next subdirectory, regardless of level."
2731 ;; Use 0 arg to go to this directory's header line.
2732 ;; NO-SKIP prevents moving to end of header line, returning whatever
2733 ;; position was found in dired-subdir-alist.
2736 pos index)
2737 ;; nth with negative arg does not return nil but the first element
2747 nil ; return nil if not found
2751 "Build `dired-subdir-alist' by parsing the buffer.
2752 Returns the new value of the alist.
2753 If optional arg SWITCHES is non-nil, use its value
2754 instead of `dired-actual-switches'."
2762 new-dir-name
2764 ;; Used to expand subdirectory names correctly in recursive
2765 ;; ange-ftp listings.
2772 ;; Avoid taking a file name ending in a colon
2773 ;; as a subdir name.
2783 new-dir-name
2794 ;; Undo any escaping of newlines and \ by dired-insert-directory.
2795 ;; Convert "n" preceded by odd number of \ to newline, and \\ to \.
2803 temp nil)
2807 temp nil))
2810 temp nil))))
2811 new-dir-name)
2814 ;; Place a sub directory boundary between lines.
2821 ;; We don't need to sort it because it is in buffer order per
2822 ;; constructionem. Return new alist:
2823 dired-subdir-alist))
2826 ;; Add new DIR at NEW-MARKER. Don't sort.
2829 dired-subdir-alist)))
2832 ;; Position point on first nontrivial file after point.
2848 "Go to line describing file FILE in this Dired buffer."
2849 ;; Return value of point on success, else nil.
2850 ;; FILE must be an absolute file name.
2851 ;; Loses if FILE contains control chars like "\007" for which ls
2852 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2853 ;; it in the buffer.
2866 ;; First, look for a listing under the absolute name.
2870 ;; Next, look for it as a relative name with leading
2871 ;; subdirectories. (This happens in Dired buffers
2872 ;; created by find-dired, for example.)
2876 default-directory)
2878 ;; Otherwise, look for it as a relative name, a base
2879 ;; name only. The hair is to get the result of
2880 ;; `dired-goto-subdir' without calling it if we don't
2881 ;; have any subdirs.
2888 file
2890 ;; Return buffer position, if found.
2895 "Advance to the Dired listing labeled by FILE; return its position.
2896 Return nil if the listing is not found. If FILE contains
2897 characters that would not appear in a Dired buffer, search using
2898 the quoted forms of those characters.
2900 FULL-NAME specifies the actual file name the listing must have,
2901 as returned by `dired-get-filename'. LIMIT is the search limit."
2907 ;; FIXME: to fix this for embedded control characters etc, we
2908 ;; should escape everything that `ls -b' does.
2913 ;; filenames are preceded by SPC, this makes the search faster
2914 ;; (e.g. for the filename "-").
2918 ;; Check that we are in the right place. Match could have
2919 ;; BASE just as initial substring or in permission bits etc.
2923 found)))
2927 ;; FIXME document whatever dired-x is doing.
2929 "Where point should go in a new listing of DIRNAME.
2930 Point is assumed to be at the beginning of new subdir line.
2931 It runs the hook `dired-initial-position-hook'."
2937 \f
2938 ;; These are hooks which make tree dired work.
2939 ;; They are in this file because other parts of dired need to call them.
2940 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2942 ;; This function is called for each retrieved filename.
2943 ;; It could stand to be faster, though it's mostly function call
2944 ;; overhead. Avoiding the function call seems to save about 10% in
2945 ;; dired-get-filename. Make it a defsubst?
2947 "Return the name of the subdirectory to which this line belongs.
2948 This returns a string with trailing slash, like `default-directory'.
2949 Optional argument means return a file name relative to `default-directory',
2950 in which case the value could be an empty string if `default-directory'
2951 is the directory where the file on this line resides."
2954 ;; probably because called in a non-dired buffer
2956 elt dir)
2960 ;; use `<=' (not `<') as subdir line is part of subdir
2962 nil ; found
2966 dir)))
2968 ;; Subdirs start at the beginning of their header lines and end just
2969 ;; before the beginning of the next header line (or end of buffer).
2976 \f
2977 ;; Deleting files
2980 "Whether Dired deletes directories recursively.
2981 If nil, Dired will not delete non-empty directories.
2982 `always' means to delete non-empty directories recursively,
2983 without asking. This is dangerous!
2984 `top' means to ask for each top-level directory specified by the
2985 Dired deletion command, and delete its subdirectories without
2986 asking.
2987 Any other value means to ask for each directory."
2995 ;; Match anything but `.' and `..'.
2999 "Type:
3000 `yes' to delete recursively the current directory,
3001 `no' to skip to next,
3002 `all' to delete all remaining directories with no more questions,
3003 `quit' to exit,
3007 "Ask a question with valid answers: yes, no, all, quit, help.
3008 PROMPT must end with '? ', for instance, 'Delete it? '.
3009 If optional arg HELP-MSG is non-nil, then is a message to show when
3010 the user answers 'help'. Otherwise, default to `dired-delete-help'."
3027 answer))
3029 ;; Delete file, possibly delete a directory and all its files.
3030 ;; This function is useful outside of dired. One could change its name
3031 ;; to e.g. recursive-delete-file and put it somewhere else.
3033 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
3034 RECURSIVE determines what to do with a non-empty directory. The effect of
3035 its possible values is:
3037 nil -- do not delete.
3038 `always' -- delete recursively without asking.
3039 `top' -- ask for each directory at top level.
3040 Anything else -- ask for each sub-directory.
3042 TRASH non-nil means to trash the file instead of deleting, provided
3043 `delete-by-moving-to-trash' (which see) is non-nil."
3044 ;; This test is equivalent to
3045 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
3046 ;; but more efficient
3055 "trash"
3067 "In Dired, delete the files flagged for deletion.
3068 If NOMESSAGE is non-nil, we don't display any message
3069 if there are no flagged files.
3070 `dired-recursive-deletes' controls whether deletion of
3071 non-empty directories is allowed."
3075 case-fold-search)
3080 ;; this can't move point since ARG is nil
3082 nil))
3083 nil t)
3088 "Delete all marked (or next ARG) files.
3089 `dired-recursive-deletes' controls whether deletion of
3090 non-empty directories is allowed."
3091 ;; This is more consistent with the file marking feature than
3092 ;; dired-do-flagged-delete.
3096 ;; this may move point if ARG is an integer
3098 arg))
3099 arg t))
3104 ;; L is an alist of files to delete, with their buffer positions.
3105 ;; ARG is the prefix arg.
3106 ;; Filenames are absolute.
3107 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
3108 ;; That way as changes are made in the buffer they do not shift the
3109 ;; lines still to be changed, so the (point) values in L stay valid.
3110 ;; Also, for subdirs in natural order, a subdir's files are deleted
3111 ;; before the subdir itself - the other way around would not work.
3115 ;; Bind `dired-recursive-deletes' so that we can change it
3116 ;; locally according with the user answer within `dired-delete-file'.
3119 ;; canonicalize file list for pop up
3131 succ count))
3139 ;; if we get here, removing worked
3156 failures)))))
3161 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
3162 ;; If the buffer has a wildcard pattern, check that it matches FILE.
3163 ;; (FILE does not include a directory component.)
3164 ;; FILE may be nil, in which case ignore it.
3165 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
3168 file))
3172 success-list))
3174 ;; Delete the entry for FILE from
3187 "Clean up after a deleted file or directory FN.
3188 Removes any expanded subdirectory of deleted directory. If
3189 `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
3190 kill any buffers visiting those files, prompting for
3191 confirmation. To disable the confirmation, see
3192 `dired-clean-confirm-killing-deleted-buffers'."
3196 ;; Offer to kill buffer of deleted file FN.
3214 \f
3215 ;; Confirmation
3224 "Return a string suitable for use in a Dired prompt.
3225 ARG is normally the prefix argument for the calling command.
3226 FILES should be a list of file names.
3230 ;; distinguish-one-marked can cause the first element to be just t.
3235 ;; more than 1 file:
3237 ;; abs(arg) = count
3238 ;; Perhaps this is nicer, but it also takes more screen space:
3239 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
3240 ;; count)
3245 "Pop up buffer BUF in a way suitable for Dired."
3251 ;; Try to split the selected window vertically if
3252 ;; that's possible. (Bug#1806)
3254 ;; Otherwise, try to split WINDOW sensibly.
3256 pop-up-frames)
3258 ;; See Bug#12281.
3260 ;; If dired-shrink-to-fit is t, make its window fit its contents.
3262 ;; Try to not delete window when we want to display less than
3263 ;; `window-min-height' lines.
3267 "A list of symbols for commands Dired should not confirm, or t.
3268 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
3269 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
3270 `touch' and `uncompress'.
3271 If t, confirmation is never needed."
3282 "Return FUNCTION's result on ARGS after showing which files are marked.
3283 Displays the file names in a window showing a buffer named
3285 window is not shown if there is just one file, `dired-no-confirm'
3286 is t, or OP-SYMBOL is a member of the list in `dired-no-confirm'.
3288 By default, Dired shrinks the display buffer to fit the marked files.
3289 To disable this, use the Customization interface to add a new rule
3291 action argument symbol is `window-height' and its value is nil.
3293 FILES is the list of marked files. It can also be (t FILENAME)
3294 in the case of one marked file, to distinguish that from using
3295 just the current file.
3297 FUNCTION should not manipulate files, just read input (an
3298 argument or confirmation)."
3301 ;; If FILES defaulted to the current line's file.
3305 ;; Mark *Marked Files* window as softly-dedicated, to prevent
3306 ;; other buffers e.g. *Completions* from reusing it (bug#17554).
3309 buffer
3319 ;; Handle (t FILE) just like (FILE), here. That value is
3320 ;; used (only in some cases), to mean just one file that was
3321 ;; marked, rather than the current line file.
3332 \f
3333 ;; Commands to mark or flag file(s) at or near current line.
3336 ;; This version skips non-file lines.
3347 ;; Advance to the next line--actually, to the line that *was* next.
3348 ;; (If FUNCTION inserted some new lines in between, skip them.)
3360 ;; This used to be a regexp match of the `total ...' line output by
3361 ;; ls, which is slightly faster, but that is not very robust; notably,
3362 ;; it fails for non-english locales.
3366 "Move to the ARGth next marked file.
3367 ARG is the numeric prefix argument and defaults to 1.
3368 If WRAP is non-nil, which happens interactively, wrap around
3369 to the beginning of the buffer and search from there, if no
3370 marked file is found after this line.
3371 Optional argument OPOINT specifies the buffer position to
3372 return to if no ARGth marked file is found; it defaults to
3373 the position where this command was invoked."
3390 "Move to the ARGth previous marked file.
3391 ARG is the numeric prefix argument and defaults to 1.
3392 If WRAP is non-nil, which happens interactively, wrap around
3393 to the end of the buffer and search backwards from there, if
3394 no ARGth marked file is found before this line."
3399 ;; Return FILE's marker, or nil if unmarked.
3413 ;; Skip subdir line and following garbage like the `total' line:
3424 "Mark the file at point in the Dired buffer.
3425 If the region is active, mark all files in the region.
3426 Otherwise, with a prefix arg, mark files on the next ARG lines.
3428 If on a subdir headerline, mark all its files except `.' and `..'.
3432 this subdir."
3435 ;; Mark files in the active region.
3443 ;; Mark subdir files from the subdir headerline.
3446 ;; Mark the current (or next ARG) files.
3454 "Unmark the file at point in the Dired buffer.
3455 If the region is active, unmark all files in the region.
3456 Otherwise, with a prefix arg, unmark files on the next ARG lines.
3458 If looking at a subdir, unmark all its files except `.' and `..'.
3459 If the region is active in Transient Mark mode, unmark all files
3460 in the active region."
3466 "In Dired, flag the current line's file for deletion.
3467 If the region is active, flag all files in the region.
3468 Otherwise, with a prefix arg, flag files on the next ARG lines.
3470 If on a subdir headerline, flag all its files except `.' and `..'.
3471 If the region is active in Transient Mark mode, flag all files
3472 in the active region."
3478 "In Dired, move up lines and remove marks or deletion flags there.
3479 Optional prefix ARG says how many lines to unmark/unflag; default
3480 is one line.
3481 If the region is active in Transient Mark mode, unmark all files
3482 in the active region."
3487 "Toggle marks: marked files become unmarked, and vice versa.
3488 Files marked with other flags (such as `D') are not affected.
3489 `.' and `..' are never toggled.
3490 As always, hidden subdirs are not affected."
3498 ;; use subst instead of insdel because it does not move
3499 ;; the gap and thus should be faster and because
3500 ;; other characters are left alone automatically
3507 \f
3508 ;;; Commands to mark or flag files based on their characteristics or names.
3514 "Read a regexp using `read-regexp'."
3519 "Mark all files matching REGEXP for use in later commands.
3520 A prefix argument means to unmark them instead.
3521 `.' and `..' are never marked.
3524 object files--just `.o' will mark more than you might think."
3528 ;; Add more suggestions into the default list
3546 "Mark all files with contents containing REGEXP for use in later commands.
3547 A prefix argument means to unmark them instead.
3548 `.' and `..' are never marked.
3550 Note that if a file is visited in an Emacs buffer, and
3551 `dired-always-read-filesystem' is nil, this command will
3552 look in the buffer without revisiting the file, so the results might
3553 be inconsistent with the file on disk if its contents has changed
3554 since it was last visited."
3569 ;; For now we do it inside emacs
3570 ;; Grep might be better if there are a lot of files
3580 )))
3584 "In Dired, flag all files containing the specified REGEXP for deletion.
3585 The match is against the non-directory part of the filename. Use `^'
3586 and `$' to anchor matches. Exclude subdirs by hiding them.
3587 `.' and `..' are never flagged."
3593 "Mark all symbolic links.
3594 With prefix argument, unmark or unflag all those files."
3600 "Mark all directory file lines except `.' and `..'.
3601 With prefix argument, unmark or unflag all those files."
3609 "Mark all executable files.
3610 With prefix argument, unmark or unflag all those files."
3615 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3616 ;; files for which PREDICATE returns non-nil.
3619 "Flag for deletion files whose names suggest they are auto save files.
3620 A prefix argument says to unmark or unflag those files instead."
3624 ;; It is less than general to check for # here,
3625 ;; but it's the only way this runs fast enough.
3629 ;; Handle executables in case of -F option.
3630 ;; We need not worry about the other kinds
3631 ;; of markings that -F makes, since they won't
3632 ;; appear on real auto-save files.
3644 ;; `log' here is dubious, since it's typically used for useful log
3645 ;; files, not just TeX stuff. -- fx
3654 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3659 "Flag all backup files (names ending with `~') for deletion.
3660 With prefix argument, unmark or unflag these files."
3664 ;; Don't call backup-file-name-p unless the last character looks like
3665 ;; it might be the end of a backup file name. This isn't very general,
3666 ;; but it's the only way this runs fast enough.
3668 ;; Handle executables in case of -F option.
3669 ;; We need not worry about the other kinds
3670 ;; of markings that -F makes, since they won't
3671 ;; appear on real backup files.
3681 "Change all OLD marks to NEW marks.
3682 OLD and NEW are both characters used to mark files."
3699 t)
3704 "Remove all marks from all files in the Dired buffer."
3708 ;; Bound in dired-unmark-all-files
3712 "Remove a specific mark (or any mark) from every file.
3713 After this command, type the mark character to remove,
3714 or type RET to remove all marks.
3715 With prefix arg, query for each marked file.
3721 dired-unmark-all-files-query
3724 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3734 "Unmark file `%s'? "
3735 file))))
3741 count))))
3742 \f
3743 ;; Logging failures operating on files, and showing the results.
3748 "Pop up a buffer with error log output from Dired.
3749 A group of errors from a single command ends with a formfeed.
3765 ;; Log a message or the contents of a buffer.
3766 ;; If LOG is a string and there are more args, it is formatted with
3767 ;; those ARGS. Usually the LOG string ends with a \n.
3768 ;; End each bunch of errors with (dired-log t):
3769 ;; this inserts the current time and buffer at the start of the page,
3770 ;; and \f (formfeed) at the end.
3778 log)))
3791 "State a summary of a command's failures, in echo area and log buffer.
3792 STRING is an overall summary of the failures.
3793 FAILURES is a list of file names that we failed to operate on,
3794 or nil if file names are not applicable."
3804 string failures))
3805 ;; Log a summary describing a bunch of errors.
3808 \f
3809 ;;; Sorting
3811 ;; Most ls can only sort by name or by date (with -t), nothing else.
3812 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3813 ;; So anything that does not contain these is sort "by name".
3818 This indicates to Dired which option switches to watch out for because they
3819 will change the sorting order behavior of `ls'.
3821 To change the default sorting order (e.g. add a `-v' option), see the
3822 variable `dired-listing-switches'. To temporarily override the listing
3827 ;; `dired-ls-sorting-switches' after -t overrides -t.
3839 "Non-nil means the Dired sort command is disabled.
3843 ;; Set mode line display according to dired-actual-switches.
3844 ;; Mode line display of "by name" or "by date" guarantees the user a
3845 ;; match with the corresponding regexps. Non-matching switches are
3846 ;; shown literally.
3851 dired-sort-by-name-regexp dired-actual-switches)
3854 dired-sort-by-date-regexp dired-actual-switches)
3864 "Toggle sorting by date, and refresh the Dired buffer.
3865 With a prefix argument, edit the current listing switches instead."
3875 ;; Toggle between sort by date/name. Reverts the buffer.
3877 dired-actual-switches))
3878 ;; Regexp for finding (possibly embedded) -t switches.
3880 case-fold-search)
3881 ;; Remove the -t switch.
3885 ;; Remove a stand-alone -t switch.
3888 ;; Remove a switch of the form -XtY for some X and Y.
3892 ;; Now, if we weren't sorting by date before, add the -t switch.
3893 ;; Some simple-minded ls implementations (eg ftp servers) only
3894 ;; allow a single option string, so try not to add " -t" if possible.
3899 dired-actual-switches)
3900 "t"
3905 ;; Some user code loads dired especially for this.
3906 ;; Don't do that--use replace-regexp-in-string instead.
3908 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3909 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3915 start me))
3919 "Specify new `ls' SWITCHES for current Dired buffer.
3920 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3921 set the minor mode accordingly, others appear literally in the mode line.
3922 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3932 "Additional processing of -R in ls option string SWITCHES.
3933 Saves `dired-subdir-alist' when R is set and restores saved value
3934 minus any directories explicitly deleted when R is cleared.
3935 To be called first in body of `dired-sort-other', etc."
3939 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3943 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3944 ;; that are still present:
3950 dired-subdir-alist)
3951 ;; subdir still present...
3954 subdirs)))
3958 ;; No pre-R subdir alist, so revert to main directory
3959 ;; listing:
3961 \f
3963 ;;;; Drag and drop support
3966 "Whether Dired copies directories recursively.
3967 If nil, never copy recursively.
3968 `always' means to copy recursively without asking.
3969 `top' means to ask for each directory at top level.
3970 Any other value means to ask for each directory."
3985 ;; No need to get actions and descriptions from the source,
3986 ;; we only have three actions anyway.
3988 t
3994 "--"
3998 nil)))
4003 ;; Only used when (featurep 'dnd).
4010 "Copy, move or link a file to the Dired directory.
4011 URI is the file to handle, ACTION is one of copy, move, link or ask.
4012 Ask means pop up a menu for the user to select one of copy, move or link."
4021 ;; If copying a directory and dired-recursive-copies is
4022 ;; nil, dired-copy-file fails. Pop up a notice.
4032 ;; Binding dired-overwrite-confirmed to nil makes
4033 ;; dired-handle-overwrite a no-op. We instead use
4034 ;; y-or-n-p, which pops a graphical menu.
4035 dired-overwrite-confirmed backup-file)
4037 ;; d-b-o is defined in dired-aux.
4039 dired-backup-overwrite
4055 action))))))
4058 "Copy, move or link a file to the Dired directory if it is a local file.
4059 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
4060 ACTION is one of copy, move, link or ask.
4061 Ask means pop up a menu for the user to select one of copy, move or link."
4064 nil)))
4065 \f
4067 ;;;; Desktop support
4073 "Auxiliary information to be saved in desktop file."
4075 ;; Value of `dired-directory'.
4077 ;; Directory name followed by list of files.
4080 ;; Directory name, optionally with shell wildcard.
4082 ;; Subdirectories in `dired-subdir-alist'.
4087 dired-subdir-alist)))))
4090 _buffer-name
4091 misc-data)
4092 "Restore a Dired buffer specified in a desktop file."
4093 ;; First element of `misc-data' is the value of `dired-directory'.
4094 ;; This value is a directory name, optionally with shell wildcard or
4095 ;; a directory name followed by list of files.
4101 ;; The following elements of `misc-data' are the keys
4102 ;; from `dired-subdir-alist'.
4107 nil)))
4116 ;;; dired.el ends here