| blob | ef069d234531160bb038f79ce89972b0ecc1600d |
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.
206 ;;; Hook variables
209 "Run after loading Dired.
210 You can customize key bindings or load extensions with this."
215 "Run at the very end of `dired-mode'."
220 "This hook is run before a Dired buffer is read in (created or reverted)."
225 "Hook run after each time a file or directory is read by Dired.
226 After each listing of a file or directory, this hook is run
227 with the buffer narrowed to the listing."
230 ;; Note this can't simply be run inside function `dired-ls' as the hook
231 ;; functions probably depend on the dired-subdir-alist to be OK.
234 "This hook is used to position the point.
235 It is run by the function `dired-initial-position'."
244 "The functions to call when a drop in `dired-mode' is made.
245 See `dnd-protocol-alist' for more information. When nil, behave
246 as in other buffers. Changing this option is effective only for
247 new Dired buffers."
254 "Non-nil means `dired-hide-details-mode' hides symbolic link targets."
260 "Non-nil means `dired-hide-details-mode' hides all but header and file lines."
266 "Non-nil means revert buffers visiting files before searching them.
267 By default, commands like `dired-mark-files-containing-regexp' will
268 search any buffers visiting the marked files without reverting them,
269 even if they were changed on disk. When this option is non-nil, such
270 buffers are always reverted in a temporary buffer before searching
271 them: the search is performed on the temporary buffer, the original
272 buffer visiting the file is not modified."
277 ;; Internal variables
280 ;; so that you can write things like
281 ;; (let ((dired-marker-char ?X))
282 ;; ;; great code using X markers ...
283 ;; )
284 ;; For example, commands operating on two sets of files, A and B.
285 ;; Or marking files with digits 0-9. This could implicate
286 ;; concentric sets or an order for the marked files.
287 ;; The code depends on dynamic scoping on the marker char.
288 "In Dired, the current mark character.
295 ;; I see no reason ever to make this nil -- rms.
296 ;; (> baud-rate search-slow-speed)
299 "use the Customization interface to add a new rule
305 ;;;###autoload
307 "The directory name or wildcard spec that this Dired directory lists.
308 Local to each Dired buffer. May be a list, in which case the car is the
309 directory name and the cdr is the list of files to mention.
312 ;; Beware of "-l;reboot" etc. See bug#3230.
314 "Return non-nil if string SWITCHES does not look risky for Dired."
328 ;; These regexps must be tested at beginning-of-line, but are also
329 ;; used to search for next matches, so neither omitting "^" nor
330 ;; replacing "^" by "\n" (to make it slightly faster) will work.
333 ;; "Regexp matching a marked line.
334 ;; Important: the match ends just after the marker."
336 ;; The [^:] part after "d" and "l" is to avoid confusion with the
337 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
344 "-[-r][-w].[-r][-w][xs][-r][-w]."
350 ;; The subdirectory names in the next two lists are expanded.
352 "Association list of subdirectories and their buffer positions.
353 Each subdirectory has an element: (DIRNAME . STARTMARKER).
354 The order of elements is the reverse of the order in the buffer.
358 "Keeps track of which switches to use for inserted subdirectories.
365 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
366 Subexpression 1 is the subdirectory proper, no trailing colon.
367 The match starts at the beginning of the line and ends after the end
372 "Faces used by Dired."
378 "Face used for directory headers."
386 "Face used for Dired marks."
394 "Face used for marked files."
402 "Face used for files flagged for deletion."
409 ;; Inherit from font-lock-warning-face since with min-colors 8
410 ;; font-lock-comment-face is not colored any more.
412 "Face used to highlight a part of a buffer that needs user attention."
420 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
421 ;; font-lock-comment-face is not colored any more.
423 "Face used to highlight permissions of group- and world-writable files."
431 "Face used for subdirectories."
439 "Face used for symbolic links."
447 "Face used for files suffixed with `completion-ignored-extensions'."
455 ;;
456 ;; Dired marks.
458 ;;
459 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
460 ;; file name itself. We search for Dired defined regexps, and then use the
461 ;; Dired defined function `dired-move-to-filename' before searching for the
462 ;; simple regexp ".+". It is that regexp which matches the file name.
463 ;;
464 ;; Marked files.
467 ;;
468 ;; Flagged files.
471 ;; People who are paranoid about security would consider this more
472 ;; important than other things such as whether it is a directory.
473 ;; But we don't want to encourage paranoia, so our default
474 ;; should be what's most useful for non-paranoids. -- rms.
475 ;;; ;;
476 ;;; ;; Files that are group or world writable.
477 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
478 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
479 ;;; '(1 dired-warning-face)
480 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
481 ;; However, we don't need to highlight the file name, only the
482 ;; permissions, to win generally. -- fx.
483 ;; Fixme: we could also put text properties on the permission
484 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
491 ;;
492 ;; Subdirectories.
495 ;;
496 ;; Symbolic links.
499 ;;
500 ;; Files suffixed with `completion-ignored-extensions'.
502 ;; It is quicker to first find just an extension, then go back to the
503 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
506 ;;
507 ;; Files suffixed with `completion-ignored-extensions'
508 ;; plus a character put in by -F.
514 ;; If the last character is not part of the filename,
515 ;; move back to the start of the filename
516 ;; so it can be fontified.
517 ;; Otherwise, leave point at the end of the line;
518 ;; that way, nothing is fontified.
522 ;;
523 ;; Explicitly put the default face on file names ending in a colon to
524 ;; avoid fontifying them as directory header.
527 ;;
528 ;; Directory headers.
530 )
534 \f
535 ;;; Macros must be defined before they are used, for the byte compiler.
538 "Mark all files for which PREDICATE evals to non-nil.
539 PREDICATE is evaluated on each line, with point at beginning of line.
540 MSG is a noun phrase for the type of files being marked.
541 It should end with a noun that can be pluralized by adding `s'.
542 Return value is the number of files marked, or nil if none were marked."
552 ,msg
554 " for deletion"
565 count
566 ,msg
574 distinguish-one-marked)
575 "Eval BODY with point on each marked line. Return a list of BODY's results.
576 If no marked file could be found, execute BODY on the current
577 line. ARG, if non-nil, specifies the files to use instead of the
578 marked files.
580 If ARG is an integer, use the next ARG (or previous -ARG, if
581 ARG<0) files. In that case, point is dragged along. This is so
582 that commands on the next ARG (instead of the marked) files can
583 be chained easily.
584 For any other non-nil value of ARG, use the current file.
586 If optional third arg SHOW-PROGRESS evaluates to non-nil,
587 redisplay the dired buffer after each file is processed.
589 No guarantee is made about the position on the marked line.
590 BODY must ensure this itself if it depends on this.
592 Search starts at the beginning of the buffer, thus the car of the
593 list corresponds to the line nearest to the buffer's bottom.
594 This is also true for (positive and negative) integer values of
595 ARG.
597 BODY should not be too long as it is expanded four times.
599 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one
600 marked file, return (t FILENAME) instead of (FILENAME)."
601 ;;
602 ;;Warning: BODY must not add new lines before point - this may cause an
603 ;;endless loop.
604 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
611 ,arg
617 results))
618 ;; non-nil, non-integer ARG means use current file:
623 ;; remember position of next marked file before BODY
624 ;; can insert lines before the just found file,
625 ;; confusing us by finding the same marked file again
626 ;; and again and...
634 ;; move after last match
643 results
645 ;; save-excursion loses, again
649 "Return the marked files' names as list of strings.
650 The list is in the same order as the buffer, that is, the car is the
651 first marked file.
652 Values returned are normally absolute file names.
653 Optional arg LOCALP as in `dired-get-filename'.
654 Optional second argument ARG, if non-nil, specifies files near
655 point instead of marked files. It usually comes from the prefix
656 argument.
657 If ARG is an integer, use the next ARG files.
658 If ARG is any other non-nil value, return the current file name.
659 If no files are marked, and ARG is nil, also return the current file name.
660 Optional third argument FILTER, if non-nil, is a function to select
661 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
663 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
664 return (t FILENAME) instead of (FILENAME).
665 Don't use that together with FILTER.
667 If ERROR is non-nil, signal an error when the list of found files is empty.
668 ERROR can be a string with the error message."
673 arg nil distinguish-one-marked))))
674 result)
680 all-of-them
687 result))
689 \f
690 ;; The dired command
693 ;; For use in interactive.
697 dired-listing-switches))
698 ;; If a dialog is used, call `read-directory-name' so the
699 ;; dialog code knows we want directories. Some dialogs
700 ;; can only select directories or files when popped up,
701 ;; not both. If no dialog is used, call `read-file-name'
702 ;; because the user may want completion of file names for
703 ;; use in a wildcard pattern.
706 nil default-directory nil)
708 nil default-directory nil)))))
710 ;; We want to switch to a more sophisticated version of
711 ;; dired-read-dir-and-switches like the following, if there is a way
712 ;; to make it more intuitive. See bug#1285.
714 ;; (defun dired-read-dir-and-switches (str)
715 ;; ;; For use in interactive.
716 ;; (reverse
717 ;; (list
718 ;; (if current-prefix-arg
719 ;; (read-string "Dired listing switches: "
720 ;; dired-listing-switches))
721 ;; ;; If a dialog is about to be used, call read-directory-name so
722 ;; ;; the dialog code knows we want directories. Some dialogs can
723 ;; ;; only select directories or files when popped up, not both.
724 ;; (if (next-read-file-uses-dialog-p)
725 ;; (read-directory-name (format "Dired %s(directory): " str)
726 ;; nil default-directory nil)
727 ;; (let ((cie ()))
728 ;; (dolist (ext completion-ignored-extensions)
729 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
730 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
731 ;; (let* ((default (and buffer-file-name
732 ;; (abbreviate-file-name buffer-file-name)))
733 ;; (cie cie)
734 ;; (completion-table
735 ;; ;; We need a mix of read-file-name and
736 ;; ;; read-directory-name so that completion to directories
737 ;; ;; is preferred, but if the user wants to enter a global
738 ;; ;; pattern, he can still use completion on filenames to
739 ;; ;; help him write the pattern.
740 ;; ;; Essentially, we want to use
741 ;; ;; (completion-table-with-predicate
742 ;; ;; 'read-file-name-internal 'file-directory-p nil)
743 ;; ;; but that doesn't work because read-file-name-internal
744 ;; ;; does not obey its `predicate' argument.
745 ;; (completion-table-in-turn
746 ;; (lambda (str pred action)
747 ;; (let ((read-file-name-predicate
748 ;; (lambda (f)
749 ;; (and (not (member f '("./" "../")))
750 ;; ;; Hack! Faster than file-directory-p!
751 ;; (eq (aref f (1- (length f))) ?/)
752 ;; (not (string-match cie f))))))
753 ;; (complete-with-action
754 ;; action 'read-file-name-internal str nil)))
755 ;; 'read-file-name-internal)))
756 ;; (minibuffer-with-setup-hook
757 ;; (lambda ()
758 ;; (setq minibuffer-default default)
759 ;; (setq minibuffer-completion-table completion-table))
760 ;; (read-file-name (format "Dired %s(directory): " str)
761 ;; nil default-directory nil))))))))
764 "Try to get a file name at point in the current dired buffer.
765 This hook is intended to be put in `file-name-at-point-functions'.
766 Note that it returns an abbreviated name that can't be used
767 as an argument to `dired-goto-file'."
774 ;;;###autoload (define-key ctl-x-map "d" 'dired)
775 ;;;###autoload
778 Optional second argument SWITCHES specifies the `ls' options used.
779 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
781 If DIRNAME is a string, Dired displays a list of files in DIRNAME (which
782 may also have shell wildcards appended to select certain files).
784 If DIRNAME is a cons, its first element is taken as the directory name
785 and the rest as an explicit list of files to make directory entries for.
786 In this case, SWITCHES are applied to each of the files separately, and
787 therefore switches that control the order of the files in the produced
788 listing have no effect.
795 If DIRNAME is already in a Dired buffer, that buffer is used without refresh."
796 ;; Cannot use (interactive "D") because of wildcards.
800 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
801 ;;;###autoload
807 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
808 ;;;###autoload
814 ;;;###autoload
816 "Like `dired' but returns the Dired buffer as value, does not select it."
818 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
819 ;; some shells make:
830 ;; If the argument was syntactically a directory name not a file name,
831 ;; or if it happens to name a file that is a directory,
832 ;; convert it syntactically to a directory name.
833 ;; The reason for checking initially-was-dirname
834 ;; and not just file-directory-p
835 ;; is that file-directory-p is slow over ftp.
843 ;; The following is an internal dired function. It returns non-nil if
844 ;; the directory visited by the current dired buffer has changed on
845 ;; disk. DIRNAME should be the directory name of that directory.
854 "Return non-nil if current Dired buffer needs updating.
855 If NOCONFIRM is non-nil, then this function always returns nil
856 for a remote directory. This feature is used by Auto Revert mode."
862 ;; Do not auto-revert when the dired buffer can be currently
863 ;; written by the user as in `wdired-mode'.
864 buffer-read-only
868 "Automatically revert Dired buffer on revisiting.
869 If t, revisiting an existing Dired buffer automatically reverts it.
870 If its value is a function, call this function with the directory
871 name as single argument and revert the buffer if it returns non-nil.
872 Otherwise, a message offering to revert the changed dired buffer
873 is displayed.
874 Note that this is not the same as `auto-revert-mode' that
875 periodically reverts at specified time intervals."
885 "Return non-nil if some file names are misaligned.
886 The return value is the target column for the file names."
890 ;; Use point difference instead of `current-column', because
891 ;; the former works when `dired-hide-details-mode' is enabled.
904 "Align all files adding spaces in front of the size column."
912 ;; Use point difference instead of `current-column', because
913 ;; the former works when `dired-hide-details-mode' is enabled.
925 ;; If DIR-OR-LIST is a string and there is an existing dired buffer
926 ;; for it, just leave buffer as it is (don't even call dired-revert).
927 ;; This saves time especially for deep trees or with ange-ftp.
928 ;; The user can type `g' easily, and it is more consistent with find-file.
929 ;; But if SWITCHES are given they are probably different from the
930 ;; buffer's old value, so call dired-sort-other, which does
931 ;; revert the buffer.
932 ;; Revert the buffer if DIR-OR-LIST is a cons or `dired-directory'
933 ;; is a cons and DIR-OR-LIST is a string.
934 ;; A pity we can't possibly do "Directory has changed - refresh? "
935 ;; like find-file does.
936 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
937 ;; see there.
940 ;; Look for an existing buffer.
942 ;; Note that buffer already is in dired-mode, if found.
949 ;; file list may have changed
951 ;; this calls dired-revert
953 ;; Always revert when `dir-or-list' is a cons. Also revert
954 ;; if `dired-directory' is a cons but `dir-or-list' is not.
958 ;; Always revert regardless of whether it has changed or not.
961 ;; Revert when predicate function returns non-nil.
966 ;; If directory has changed on disk, offer to revert.
971 ;; Else a new buffer
974 ;; We can do this unconditionally
975 ;; because dired-noselect ensures that the name
976 ;; is passed in directory name syntax
977 ;; if it was the name of a directory at all.
982 ;; default-directory and dired-actual-switches are set now
983 ;; (buffer-local), so we can call dired-readin:
988 ;; dired-readin can fail if parent directories are inaccessible.
989 ;; Don't leave an empty buffer around in that case.
996 buffer))
999 ;; Enlarged by dired-advertise
1000 ;; Queried by function dired-buffers-for-dir. When this detects a
1001 ;; killed buffer, it is removed from this list.
1006 ;; FIXME add a doc-string, and document dired-x extensions.
1008 ;; This differs from dired-buffers-for-dir in that it does not consider
1009 ;; subdirs of default-directory and searches for the first match only.
1010 ;; Also, the major mode must be MODE.
1012 dired-find-subdir
1013 ;; Don't try to find a wildcard as a subdirectory.
1019 ;; Wildcards must match, too:
1021 ;; We don't want to switch to the same buffer---
1024 ;; ---unless it's the only possibility:
1026 ;; No dired-x, or dired-find-subdir nil.
1035 dired-directory ;; nil during find-alternate-file
1040 dired-directory))))
1042 blist nil)
1044 found)))
1046 \f
1047 ;; Read in a new dired buffer
1050 "Read in a new Dired buffer.
1051 Differs from `dired-insert-subdir' in that it accepts
1052 wildcards, erases the buffer, and builds the subdir-alist anew
1053 \(including making it buffer-local and clearing it first)."
1055 ;; default-directory and dired-actual-switches must be buffer-local
1056 ;; and initialized by now.
1058 ;; This makes read-in much faster.
1059 ;; In particular, it prevents the font lock hook from running
1060 ;; until the directory is all read in.
1067 ;; This hook which may want to modify dired-actual-switches
1068 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
1069 ;; where ls won't understand -Al switches.
1076 ;; Don't make undo entries for readin.
1082 ;; Must first make alist buffer local and set it to nil because
1083 ;; dired-build-subdir-alist will call dired-clear-alist first
1090 ;; No need to narrow since the whole buffer contains just
1091 ;; dired-readin's output, nothing else. The hook can
1092 ;; successfully use dired functions (e.g. dired-get-filename)
1093 ;; as the subdir-alist has been built in dired-readin.
1096 ;; Subroutines of dired-readin
1099 ;; Insert listing for the specified dir (and maybe file list)
1100 ;; already in dired-directory, assuming a clean buffer.
1106 file-list nil))
1110 ;; If we are reading a whole single directory...
1116 ;; Else treat it as a wildcard spec
1117 ;; unless we have an explicit list of files.
1122 "Align the fields of a file to the ones of surrounding lines.
1123 BEG..END is the line where the file info is located."
1124 ;; Some versions of ls try to adjust the size of each field so as to just
1125 ;; hold the largest element ("largest" in the current invocation, of
1126 ;; course). So when a single line is output, the size of each field is
1127 ;; just big enough for that one output. Thus when dired refreshes one
1128 ;; line, the alignment if this line w.r.t the rest is messed up because
1129 ;; the fields of that one line will generally be smaller.
1130 ;;
1131 ;; To work around this problem, we here add spaces to try and
1132 ;; re-align the fields as needed. Since this is purely aesthetic,
1133 ;; it is of utmost importance that it doesn't mess up anything like
1134 ;; `dired-move-to-filename'. To this end, we limit ourselves to
1135 ;; adding spaces only, and to only add them at places where there
1136 ;; was already at least one space. This way, as long as
1137 ;; `directory-listing-before-filename-regexp' always matches spaces
1138 ;; with "*" or "+", we know we haven't made anything worse. There
1139 ;; is one spot where the exact number of spaces is important, which
1140 ;; is just before the actual filename, so we refrain from adding
1141 ;; spaces there (and within the filename as well, of course).
1144 ;; Check that there is indeed a file, and that there is another adjacent
1145 ;; file with which to align, and that additional spaces are needed to
1146 ;; align the filenames.
1159 ;; Make sure there is some work left to do.
1161 ;; If we've only looked at the line above, check to see if the line
1162 ;; below exists as well and if so, align with the shorter one.
1171 ;; Keep positions uptodate when we insert stuff.
1174 ;; Main loop.
1178 ;; Don't touch anything just before (and after) the
1179 ;; beginning of the filename.
1181 ;; We're now just in front of a field, with a space behind us.
1183 ;; Nums are right-aligned.
1185 ;; Let's look at the other line, in the same column: we
1186 ;; should be either near the end of the previous field, or
1187 ;; in the space between that field and the next.
1188 ;; [ Of course, it's also possible that we're already within
1189 ;; the next field or even past it, but that's unlikely since
1190 ;; other-col > file-col. ]
1191 ;; Let's find the distance to the alignment-point (either
1192 ;; the beginning or the end of the next field, depending on
1193 ;; whether this field is left or right aligned).
1203 ;; Now, the number of spaces to insert is align-pt-offset
1204 ;; minus the distance to the equivalent point on the
1205 ;; current line.
1208 align-pt-offset
1218 ;; Let's just make really sure we did not mess up.
1221 ;; Damn! We messed up: let's revert the change.
1223 ;; Now skip to next field.
1231 "Return non-nil if the string SWITCHES matches LONG or SHORT format."
1236 switches))))
1239 "Return non-nil if the string SWITCHES contains -b or --escape."
1240 ;; Do not match things like "--block-size" that happen to contain "b".
1244 "Return non-nil if the string SWITCHES contains -R or --recursive."
1248 "Insert a directory listing of DIR, Dired style.
1249 Use SWITCHES to make the listings.
1250 If FILE-LIST is non-nil, list only those files.
1251 Otherwise, if WILDCARD is non-nil, expand wildcards;
1252 in that case, DIR should be a file name that uses wildcards.
1253 In other cases, DIR should be a directory name or a directory filename.
1254 If HDR is non-nil, insert a header line with the directory name."
1257 end)
1259 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1260 ;; ls-lisp emulation is used, except if they want to use `ls'
1261 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1268 ;; Check whether "ls --dired" gives exit code 0, and
1269 ;; save the answer in `dired-use-ls-dired'.
1276 nil))
1277 dired-use-ls-dired)))
1279 ;; Expand directory wildcards and fill file-list.
1283 ;; We don't know whether the remote ls supports
1284 ;; "--dired", so we cannot add it to the `process-file'
1285 ;; call for wildcards.
1303 ;; We used to specify the C locale here, to force English
1304 ;; month names; but this should not be necessary any
1305 ;; more, with the new value of
1306 ;; `directory-listing-before-filename-regexp'.
1311 ;; Re-align fields, if necessary.
1314 ;; Quote certain characters, unless ls quoted them for us.
1323 nil t))
1329 nil t))
1331 ;; Replace any newlines in DIR with literal "\n"s, for the sake
1332 ;; of the header line. To disambiguate a literal "\n" in the
1333 ;; actual dirname, we also replace "\" with "\\".
1334 ;; Personally, I think this should always be done, irrespective
1335 ;; of the value of dired-actual-switches, because:
1336 ;; i) Dired simply does not work with an unescaped newline in
1337 ;; the directory name used in the header (bug=10469#28), and
1338 ;; ii) "\" is always replaced with "\\" in the listing, so doing
1339 ;; it in the header as well makes things consistent.
1340 ;; But at present it is only done if "-b" is in ls-switches,
1341 ;; because newlines in dirnames are uncommon, and people may
1342 ;; have gotten used to seeing unescaped "\" in the headers.
1343 ;; Note: adjust dired-build-subdir-alist if you change this.
1346 ;; If we used --dired and it worked, the lines are already indented.
1347 ;; Otherwise, indent them.
1353 ;; Insert text at the beginning to standardize things.
1360 ;; Note that dired-build-subdir-alist will replace the name
1361 ;; by its expansion, so it does not matter whether what we insert
1362 ;; here is fully expanded, but it should be absolute.
1367 ;; Insert "wildcard" line where "total" line would be for a full dir.
1374 "Add various text properties to the lines in the region."
1393 highlight
1394 dired-filename t
1400 \f
1401 ;; Reverting a dired buffer
1404 "Reread the Dired buffer.
1405 Must also be called after `dired-actual-switches' have changed.
1406 Should not fail even on completely garbaged buffers.
1407 Preserves old cursor, marks/flags, hidden-p.
1409 Dired sets `revert-buffer-function' to this function. The args
1410 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1422 ;; treat top level dir extra (it may contain wildcards)
1429 ;; Run dired-after-readin-hook just once, below.
1434 ;; ... run the hook for the whole buffer, and only after markers
1435 ;; have been reinserted (else omitting in dired-x would omit marked files)
1443 ;; outside of the let scope
1444 ;;; Might as well not override the user if the user changed this.
1445 ;;; (setq buffer-read-only t)
1446 )
1448 ;; Subroutines of dired-revert
1449 ;; Some of these are also used when inserting subdirs.
1452 "Return current positions in the buffer and all windows with this directory.
1453 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1455 BUFFER-POSITION is the point position in the current Dired buffer.
1456 It has the form (BUFFER DIRED-FILENAME BUFFER-LINE-NUMBER).
1458 WINDOW-POSITIONS are current positions in all windows displaying
1459 this dired buffer. The window positions have the form (WINDOW
1460 DIRED-FILENAME WINDOW-LINE-NUMBER).
1462 We store line numbers instead of point positions because the header
1463 lines might change as well: when this happen the line number doesn't
1464 change; the point does."
1475 "Restore POSITIONS saved with `dired-save-positions'."
1484 ;; Ensure that window still displays the original buffer.
1494 "Return alist of files and their marks, from BEG to END."
1505 alist))
1508 "Mark all files remembered in ALIST.
1509 Each element of ALIST looks like (FILE . MARKERCHAR)."
1523 "Return a list of names of subdirs currently hidden."
1533 result))
1536 "Try to insert all subdirs that were displayed before.
1537 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1549 "Remove directory DIR from any directory cache."
1553 \f
1554 ;; dired mode key bindings and initialization
1557 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1558 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1563 ;; Commands to mark or flag certain categories of files
1567 ;; Upper case keys (except !) for operating on the marked files
1587 ;; Comparison commands
1589 ;; Tree Dired commands
1595 ;; move to marked files
1598 ;; Make all regexp commands share a `%' prefix:
1599 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1600 ;; but that seems to serve little purpose, and copy-keymap
1601 ;; does a better job without it.
1614 ;; Commands for marking and unmarking.
1631 ;; Lower keys for commands not operating on all the marked files
1657 ;; moving
1665 ;; hiding
1669 ;; isearch
1674 ;; misc
1676 ;; `toggle-read-only' is an obsolete alias for `read-only-mode'
1682 ;; thumbnail manipulation (image-dired)
1695 ;; encryption and decryption (epa-dired)
1701 ;; Make menu bar items.
1703 ;; No need to fo this, now that top-level items are fewer.
1704 ;;;;
1705 ;; Get rid of the Edit menu bar item to save space.
1706 ;(define-key map [menu-bar edit] 'undefined)
1819 ;; When running on plain MS-DOS, there's only one
1820 ;; letter-case for file names.
2008 map)
2010 \f
2011 ;; Dired mode is suitable only for specially formatted data.
2014 ;; Autoload cookie needed by desktop.el
2015 ;;;###autoload
2017 "\
2020 (optionally) its subdirectories, in the format of `ls -lR'.
2023 compress, load or byte-compile them, change their file attributes
2026 by file or all files matching certain criteria.
2028 The buffer is read-only. Digits are prefix arguments.
2031 Most commands operate on the marked files and use the current file
2032 if no files are marked. Use a numeric prefix argument to operate on
2033 the next ARG (or previous -ARG if ARG<0) files, or just `1'
2034 to operate on the current file only. Prefix arguments override marks.
2036 to see why something went wrong.
2041 (or dired it in another buffer, if it is a directory).
2048 This retains all marks and hides subdirs again that were hidden before.
2049 Use `SPC' and `DEL' to move down and up by lines.
2052 to read the
2054 to relist the file at point or the marked files or a
2056 again for the directory tree.
2059 for more info):
2061 `dired-listing-switches'
2062 `dired-trivial-filenames'
2063 `dired-marker-char'
2064 `dired-del-marker'
2065 `dired-keep-marker-rename'
2066 `dired-keep-marker-copy'
2067 `dired-keep-marker-hardlink'
2068 `dired-keep-marker-symlink'
2072 `dired-before-readin-hook'
2073 `dired-after-readin-hook'
2074 `dired-mode-hook'
2075 `dired-load-hook'
2077 Keybindings:
2079 ;; Not to be called interactively (e.g. dired-directory will be set
2080 ;; to default-directory, which is wrong with wildcards).
2085 mode-name "Dired"
2086 ;; case-fold-search nil
2087 buffer-read-only t
2088 selective-display t ; for subdirectory hiding
2089 mode-line-buffer-identification
2091 ;; Ignore dired-hide-details-* value of invisible text property by default.
2098 ;; list-buffers uses this to display the dir being edited in this buffer.
2102 dired-directory)))
2116 \f
2117 ;; Idiosyncratic dired commands that don't deal with marks.
2120 "Summarize basic Dired commands and show recent Dired errors."
2123 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
2128 "Undo in a Dired buffer.
2129 This doesn't recover lost files, it just undoes changes in the buffer itself.
2130 You can use it to recover marks, killed lines or subdirs."
2139 "Edit Dired buffer with Wdired, or make it read-only.
2140 If the current buffer can be edited with Wdired, (i.e. the major
2141 mode is `dired-mode'), call `wdired-change-to-wdired-mode'.
2142 Otherwise, toggle `read-only-mode'."
2149 "Move down lines then position at filename.
2150 Optional prefix ARG says how many lines to move; default is one line."
2155 ;; We never want to move point into an invisible line.
2162 "Move up lines then position at filename.
2163 Optional prefix ARG says how many lines to move; default is one line."
2168 "Goto ARGth next directory file line."
2180 "Goto ARGth previous directory file line."
2185 "Run Dired on parent directory of current directory.
2186 Find the parent directory either in this buffer or another buffer.
2187 Creates a buffer if necessary.
2188 If OTHER-WINDOW (the optional prefix arg), display the parent
2189 directory in another window."
2194 ;; Only try dired-goto-subdir if buffer has more than one dir.
2204 "Get the current line's file name, with an error if file does not exist."
2206 ;; We pass t for second arg so that we don't get error for `.' and `..'.
2208 file-name)
2213 file-name
2218 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
2221 "In Dired, visit the file or directory named on this line."
2223 ;; Bind `find-file-run-dired' so that the command works on directories
2224 ;; too, independent of the user's setting.
2226 ;; This binding prevents problems with preserving point in
2227 ;; windows displaying Dired buffers, because reverting a Dired
2228 ;; buffer empties it, which changes the places where the
2229 ;; markers used by switch-to-buffer-preserve-window-point
2230 ;; point.
2233 nil
2234 switch-to-buffer-preserve-window-point)))
2238 "In Dired, visit file or directory on current line via `find-alternate-file'.
2239 This kills the Dired buffer, then visits the current line's file or directory."
2243 ;; Don't override the setting from .emacs.
2244 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
2247 "In Dired, visit the file or directory name you click on.
2248 The optional arguments FIND-FILE-FUNC and FIND-DIR-FUNC specify
2249 functions to visit the file and directory, respectively. If
2250 omitted or nil, these arguments default to `find-file' and `dired',
2251 respectively."
2274 "In Dired, visit the file or directory name you click on in another window."
2279 "In Dired, visit the file or directory name you click on in another frame."
2284 "In Dired, examine a file in view mode, returning to Dired when done.
2285 When file is a directory, show it in this buffer if it is inserted.
2286 Otherwise, display it in another buffer."
2296 "In Dired, visit this file or directory in another window."
2301 "In Dired, display this file or directory in another window."
2304 t))
2305 \f
2306 ;;; Functions for extracting and manipulating file names in Dired buffers.
2309 "In Dired, return name of file mentioned on this line.
2310 Value returned normally includes the directory name.
2311 Optional arg LOCALP with value `no-dir' means don't include directory
2312 name in result. A value of `verbatim' means to return the name exactly as
2313 it occurs in the buffer, and a value of t means construct name relative to
2314 `default-directory', which still may contain slashes if in a subdirectory.
2315 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2316 regular filenames and return nil if no filename on this line.
2317 Otherwise, an error occurs in these cases."
2322 ;; nil if no file on this line, but no-error-if-not-filep is t:
2325 ;; Get rid of the mouse-face property that file names have.
2327 ;; Unquote names quoted by ls or by dired-insert-directory.
2328 ;; This code was written using `read' to unquote, because
2329 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2330 ;; char) etc. in a lisp loop. Unfortunately, this decision
2331 ;; has necessitated hacks such as dealing with filenames
2332 ;; with quotation marks in their names.
2335 ;; Unescape any spaces escaped by ls -b (bug#10469).
2336 ;; Other -b quotes, eg \t, \n, work transparently.
2354 ;; Hence we don't need to worry about converting `\\' back to `\'.
2356 ;; The above `read' will return a unibyte string if FILE
2357 ;; contains eight-bit-control/graphic characters.
2365 nil)
2367 file)
2375 ;; check for safe-magic property so that we won't
2376 ;; put /: for names that don't really need them.
2377 ;; For instance, .gz files when auto-compression-mode is on.
2380 file)))
2382 file)
2386 ;; check for safe-magic property so that we won't
2387 ;; put /: for names that don't really need them.
2388 ;; For instance, .gz files when auto-compression-mode is on.
2391 file)))
2397 "Replace first match of REGEXP in STRING with NEWTEXT.
2398 If it does not match, nil is returned instead of the new string.
2399 Optional arg LITERAL means to take NEWTEXT literally.
2400 Optional arg GLOBAL means to replace all matches."
2407 ret)
2409 nil
2413 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2414 ;; We can't always use expand-file-name as this would get rid of `.'
2415 ;; or expand in / instead default-directory if DIR=="".
2416 ;; This should be good enough for ange-ftp.
2417 ;; It should be reasonably fast, though, as it is called in
2418 ;; dired-get-filename.
2422 "Convert FILE (an absolute file name) to a name relative to DIR.
2423 If DIR is omitted or nil, it defaults to `default-directory'.
2424 If FILE is not in the directory tree of DIR, return FILE
2425 unchanged."
2427 ;; This case comes into play if default-directory is set to
2428 ;; use ~.
2433 file))
2434 \f
2436 "Toggle visibility of detailed information in current Dired buffer.
2437 When this minor mode is enabled, details such as file ownership and
2438 permissions are hidden from view.
2440 See options: `dired-hide-details-hide-symlink-targets' and
2441 `dired-hide-details-hide-information-lines'."
2448 'dired-hide-details-update-invisibility-spec
2449 nil
2450 t)
2452 'dired-hide-details-update-invisibility-spec
2453 t)))
2457 'add-to-invisibility-spec
2461 dired-hide-details-hide-information-lines)
2462 'add-to-invisibility-spec
2466 dired-hide-details-hide-symlink-targets
2468 'add-to-invisibility-spec
2471 \f
2472 ;;; Functions for finding the file name in a dired buffer line.
2478 ;; Move to first char of filename on this line.
2479 ;; Returns position (point) or nil if no filename on this line."
2481 "Move to the beginning of the filename on the current line.
2482 Return the position of the beginning of the filename, or nil if none found."
2483 ;; This is the UNIX version.
2486 ;; First try assuming `ls --dired' was used.
2494 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2498 nil)
2503 ;; Assumes point is at beginning of filename,
2504 ;; thus the rwx bit re-search-backward below will succeed in *this*
2505 ;; line if at all. So, it should be called only after
2506 ;; (dired-move-to-filename t).
2507 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2508 ;; This is the UNIX version.
2518 nil
2520 ;; Restrict perm bits to be non-blank,
2521 ;; otherwise this matches one char to early (looking backward):
2522 ;; "l---------" (some systems make symlinks that way)
2523 ;; "----------" (plain file with zero perms)
2525 dired-permission-flags-regexp nil t)
2528 ;; Only with -F we need to know whether it's an executable
2530 used-F
2538 ;; Move point to end of name:
2544 dired-ls-F-marks-symlinks
2548 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2549 ;; one trailing character. (Executable bits on symlinks ain't mean
2550 ;; a thing, even to ls, but we know it's not a symlink.)
2553 executable)
2562 nil
2565 \f
2566 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2569 "Copy names of marked (or next ARG) files into the kill ring.
2570 The names are separated by a space.
2571 With a zero prefix arg, use the absolute file name of each marked file.
2573 `default-directory'. (This still may contain slashes if in a subdirectory.)
2575 If on a subdir headerline, use absolute subdirname instead;
2576 prefix arg and marked files are ignored in this case.
2599 \f
2600 ;; Keeping Dired buffers in sync with the filesystem and with each other
2603 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2604 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2605 ;; matches FILE.
2606 ;; The list is in reverse order of buffer creation, most recent last.
2607 ;; As a side effect, killed dired buffers for DIR are removed from
2608 ;; dired-buffers.
2615 ;; Buffer is killed - clean up:
2623 dired-directory)))
2626 file)))
2630 result))
2633 "Convert glob-pattern PATTERN to a regular expression."
2635 regexp)
2647 ;; Fails to handle ^ yet ????
2661 regexp
2669 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2670 ;; With wildcards we actually advertise too much.
2673 t ; we have already advertised ourselves
2676 dired-buffers)))))
2679 ;; Remove DIR from the buffer alist in variable dired-buffers.
2680 ;; This has the effect of removing any buffer whose main directory is DIR.
2681 ;; It does not affect buffers in which DIR is a subdir.
2682 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2685 \f
2686 ;; Tree Dired
2688 ;;; utility functions
2691 ;;"Is FILE part of the directory tree starting at DIR?"
2696 ;; Prepend default-directory to DIR if relative file name.
2697 ;; dired-get-filename must be able to make a valid file name from a
2698 ;; file and its directory DIR.
2701 dir
2705 ;;"Return the subdir name on this line, or nil if not on a headerline."
2706 ;; Look up in the alist whether this is a headerline.
2712 dired-subdir-alist))))
2713 cur-dir))))
2715 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2729 ;; Return an index into alist for use with nth
2730 ;; for the sake of subdir moving commands.
2739 "Go to next subdirectory, regardless of level."
2740 ;; Use 0 arg to go to this directory's header line.
2741 ;; NO-SKIP prevents moving to end of header line, returning whatever
2742 ;; position was found in dired-subdir-alist.
2745 pos index)
2746 ;; nth with negative arg does not return nil but the first element
2756 nil ; return nil if not found
2760 "Build `dired-subdir-alist' by parsing the buffer.
2761 Returns the new value of the alist.
2762 If optional arg SWITCHES is non-nil, use its value
2763 instead of `dired-actual-switches'."
2771 new-dir-name
2773 ;; Used to expand subdirectory names correctly in recursive
2774 ;; ange-ftp listings.
2781 ;; Avoid taking a file name ending in a colon
2782 ;; as a subdir name.
2792 new-dir-name
2803 ;; Undo any escaping of newlines and \ by dired-insert-directory.
2804 ;; Convert "n" preceded by odd number of \ to newline, and \\ to \.
2812 temp nil)
2816 temp nil))
2819 temp nil))))
2820 new-dir-name)
2823 ;; Place a sub directory boundary between lines.
2830 ;; We don't need to sort it because it is in buffer order per
2831 ;; constructionem. Return new alist:
2832 dired-subdir-alist))
2835 ;; Add new DIR at NEW-MARKER. Don't sort.
2838 dired-subdir-alist)))
2841 ;; Position point on first nontrivial file after point.
2857 "Go to line describing file FILE in this Dired buffer."
2858 ;; Return value of point on success, else nil.
2859 ;; FILE must be an absolute file name.
2860 ;; Loses if FILE contains control chars like "\007" for which ls
2861 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2862 ;; it in the buffer.
2875 ;; First, look for a listing under the absolute name.
2879 ;; Next, look for it as a relative name with leading
2880 ;; subdirectories. (This happens in Dired buffers
2881 ;; created by find-dired, for example.)
2885 default-directory)
2887 ;; Otherwise, look for it as a relative name, a base
2888 ;; name only. The hair is to get the result of
2889 ;; `dired-goto-subdir' without calling it if we don't
2890 ;; have any subdirs.
2897 file
2899 ;; Return buffer position, if found.
2904 "Advance to the Dired listing labeled by FILE; return its position.
2905 Return nil if the listing is not found. If FILE contains
2906 characters that would not appear in a Dired buffer, search using
2907 the quoted forms of those characters.
2909 FULL-NAME specifies the actual file name the listing must have,
2910 as returned by `dired-get-filename'. LIMIT is the search limit."
2916 ;; FIXME: to fix this for embedded control characters etc, we
2917 ;; should escape everything that `ls -b' does.
2922 ;; filenames are preceded by SPC, this makes the search faster
2923 ;; (e.g. for the filename "-").
2927 ;; Check that we are in the right place. Match could have
2928 ;; BASE just as initial substring or in permission bits etc.
2932 found)))
2936 ;; FIXME document whatever dired-x is doing.
2938 "Where point should go in a new listing of DIRNAME.
2939 Point is assumed to be at the beginning of new subdir line.
2940 It runs the hook `dired-initial-position-hook'."
2946 \f
2947 ;; These are hooks which make tree dired work.
2948 ;; They are in this file because other parts of dired need to call them.
2949 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2951 ;; This function is called for each retrieved filename.
2952 ;; It could stand to be faster, though it's mostly function call
2953 ;; overhead. Avoiding the function call seems to save about 10% in
2954 ;; dired-get-filename. Make it a defsubst?
2956 "Return the name of the subdirectory to which this line belongs.
2957 This returns a string with trailing slash, like `default-directory'.
2958 Optional argument means return a file name relative to `default-directory',
2959 in which case the value could be an empty string if `default-directory'
2960 is the directory where the file on this line resides."
2963 ;; probably because called in a non-dired buffer
2965 elt dir)
2969 ;; use `<=' (not `<') as subdir line is part of subdir
2971 nil ; found
2975 dir)))
2977 ;; Subdirs start at the beginning of their header lines and end just
2978 ;; before the beginning of the next header line (or end of buffer).
2985 \f
2986 ;; Deleting files
2989 "Whether Dired deletes directories recursively.
2990 If nil, Dired will not delete non-empty directories.
2991 `always' means to delete non-empty directories recursively,
2992 without asking. This is dangerous!
2993 `top' means to ask for each top-level directory specified by the
2994 Dired deletion command, and delete its subdirectories without
2995 asking.
2996 Any other value means to ask for each directory."
3004 ;; Match anything but `.' and `..'.
3007 ;; Delete file, possibly delete a directory and all its files.
3008 ;; This function is useful outside of dired. One could change its name
3009 ;; to e.g. recursive-delete-file and put it somewhere else.
3011 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
3012 RECURSIVE determines what to do with a non-empty directory. The effect of
3013 its possible values is:
3015 nil -- do not delete.
3016 `always' -- delete recursively without asking.
3017 `top' -- ask for each directory at top level.
3018 Anything else -- ask for each sub-directory.
3020 TRASH non-nil means to trash the file instead of deleting, provided
3021 `delete-by-moving-to-trash' (which see) is non-nil."
3022 ;; This test is equivalent to
3023 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
3024 ;; but more efficient
3033 "trash"
3037 prompt
3051 "In Dired, delete the files flagged for deletion.
3052 If NOMESSAGE is non-nil, we don't display any message
3053 if there are no flagged files.
3054 `dired-recursive-deletes' controls whether deletion of
3055 non-empty directories is allowed."
3059 case-fold-search)
3064 ;; this can't move point since ARG is nil
3066 nil))
3067 nil t)
3072 "Delete all marked (or next ARG) files.
3073 `dired-recursive-deletes' controls whether deletion of
3074 non-empty directories is allowed."
3075 ;; This is more consistent with the file marking feature than
3076 ;; dired-do-flagged-delete.
3080 ;; this may move point if ARG is an integer
3082 arg))
3083 arg t))
3088 ;; L is an alist of files to delete, with their buffer positions.
3089 ;; ARG is the prefix arg.
3090 ;; Filenames are absolute.
3091 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
3092 ;; That way as changes are made in the buffer they do not shift the
3093 ;; lines still to be changed, so the (point) values in L stay valid.
3094 ;; Also, for subdirs in natural order, a subdir's files are deleted
3095 ;; before the subdir itself - the other way around would not work.
3099 ;; Bind `dired-recursive-deletes' so that we can change it
3100 ;; locally according with the user answer within `dired-delete-file'.
3103 ;; canonicalize file list for pop up
3115 succ count))
3123 ;; if we get here, removing worked
3140 failures)))))
3145 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
3146 ;; If the buffer has a wildcard pattern, check that it matches FILE.
3147 ;; (FILE does not include a directory component.)
3148 ;; FILE may be nil, in which case ignore it.
3149 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
3152 file))
3156 success-list))
3158 ;; Delete the entry for FILE from
3171 "Clean up after a deleted file or directory FN.
3172 Removes any expanded subdirectory of deleted directory. If
3173 `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
3174 kill any buffers visiting those files, prompting for
3175 confirmation. To disable the confirmation, see
3176 `dired-clean-confirm-killing-deleted-buffers'."
3180 ;; Offer to kill buffer of deleted file FN.
3198 \f
3199 ;; Confirmation
3208 "Return a string suitable for use in a Dired prompt.
3209 ARG is normally the prefix argument for the calling command.
3210 FILES should be a list of file names.
3214 ;; distinguish-one-marked can cause the first element to be just t.
3219 ;; more than 1 file:
3221 ;; abs(arg) = count
3222 ;; Perhaps this is nicer, but it also takes more screen space:
3223 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
3224 ;; count)
3229 "Pop up buffer BUF in a way suitable for Dired."
3235 ;; Try to split the selected window vertically if
3236 ;; that's possible. (Bug#1806)
3238 ;; Otherwise, try to split WINDOW sensibly.
3240 pop-up-frames)
3242 ;; See Bug#12281.
3244 ;; If dired-shrink-to-fit is t, make its window fit its contents.
3246 ;; Try to not delete window when we want to display less than
3247 ;; `window-min-height' lines.
3251 "A list of symbols for commands Dired should not confirm, or t.
3252 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
3253 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
3254 `touch' and `uncompress'.
3255 If t, confirmation is never needed."
3266 "Return FUNCTION's result on ARGS after showing which files are marked.
3267 Displays the file names in a window showing a buffer named
3269 window is not shown if there is just one file, `dired-no-confirm'
3270 is t, or OP-SYMBOL is a member of the list in `dired-no-confirm'.
3272 By default, Dired shrinks the display buffer to fit the marked files.
3273 To disable this, use the Customization interface to add a new rule
3275 action argument symbol is `window-height' and its value is nil.
3277 FILES is the list of marked files. It can also be (t FILENAME)
3278 in the case of one marked file, to distinguish that from using
3279 just the current file.
3281 FUNCTION should not manipulate files, just read input (an
3282 argument or confirmation)."
3285 ;; If FILES defaulted to the current line's file.
3289 ;; Mark *Marked Files* window as softly-dedicated, to prevent
3290 ;; other buffers e.g. *Completions* from reusing it (bug#17554).
3293 buffer
3303 ;; Handle (t FILE) just like (FILE), here. That value is
3304 ;; used (only in some cases), to mean just one file that was
3305 ;; marked, rather than the current line file.
3316 \f
3317 ;; Commands to mark or flag file(s) at or near current line.
3320 ;; This version skips non-file lines.
3331 ;; Advance to the next line--actually, to the line that *was* next.
3332 ;; (If FUNCTION inserted some new lines in between, skip them.)
3344 ;; This used to be a regexp match of the `total ...' line output by
3345 ;; ls, which is slightly faster, but that is not very robust; notably,
3346 ;; it fails for non-english locales.
3350 "Move to the ARGth next marked file.
3351 ARG is the numeric prefix argument and defaults to 1.
3352 If WRAP is non-nil, which happens interactively, wrap around
3353 to the beginning of the buffer and search from there, if no
3354 marked file is found after this line.
3355 Optional argument OPOINT specifies the buffer position to
3356 return to if no ARGth marked file is found; it defaults to
3357 the position where this command was invoked."
3374 "Move to the ARGth previous marked file.
3375 ARG is the numeric prefix argument and defaults to 1.
3376 If WRAP is non-nil, which happens interactively, wrap around
3377 to the end of the buffer and search backwards from there, if
3378 no ARGth marked file is found before this line."
3383 ;; Return FILE's marker, or nil if unmarked.
3397 ;; Skip subdir line and following garbage like the `total' line:
3408 "Mark the file at point in the Dired buffer.
3409 If the region is active, mark all files in the region.
3410 Otherwise, with a prefix arg, mark files on the next ARG lines.
3412 If on a subdir headerline, mark all its files except `.' and `..'.
3416 this subdir."
3419 ;; Mark files in the active region.
3427 ;; Mark subdir files from the subdir headerline.
3430 ;; Mark the current (or next ARG) files.
3438 "Unmark the file at point in the Dired buffer.
3439 If the region is active, unmark all files in the region.
3440 Otherwise, with a prefix arg, unmark files on the next ARG lines.
3442 If looking at a subdir, unmark all its files except `.' and `..'.
3443 If the region is active in Transient Mark mode, unmark all files
3444 in the active region."
3450 "In Dired, flag the current line's file for deletion.
3451 If the region is active, flag all files in the region.
3452 Otherwise, with a prefix arg, flag files on the next ARG lines.
3454 If on a subdir headerline, flag all its files except `.' and `..'.
3455 If the region is active in Transient Mark mode, flag all files
3456 in the active region."
3462 "In Dired, move up lines and remove marks or deletion flags there.
3463 Optional prefix ARG says how many lines to unmark/unflag; default
3464 is one line.
3465 If the region is active in Transient Mark mode, unmark all files
3466 in the active region."
3471 "Toggle marks: marked files become unmarked, and vice versa.
3472 Files marked with other flags (such as `D') are not affected.
3473 `.' and `..' are never toggled.
3474 As always, hidden subdirs are not affected."
3482 ;; use subst instead of insdel because it does not move
3483 ;; the gap and thus should be faster and because
3484 ;; other characters are left alone automatically
3491 \f
3492 ;;; Commands to mark or flag files based on their characteristics or names.
3498 "Read a regexp using `read-regexp'."
3503 "Mark all files matching REGEXP for use in later commands.
3504 A prefix argument means to unmark them instead.
3505 `.' and `..' are never marked.
3508 object files--just `.o' will mark more than you might think."
3512 ;; Add more suggestions into the default list
3530 "Mark all files with contents containing REGEXP for use in later commands.
3531 A prefix argument means to unmark them instead.
3532 `.' and `..' are never marked.
3534 Note that if a file is visited in an Emacs buffer, and
3535 `dired-always-read-filesystem' is nil, this command will
3536 look in the buffer without revisiting the file, so the results might
3537 be inconsistent with the file on disk if its contents has changed
3538 since it was last visited."
3553 ;; For now we do it inside emacs
3554 ;; Grep might be better if there are a lot of files
3564 )))
3568 "In Dired, flag all files containing the specified REGEXP for deletion.
3569 The match is against the non-directory part of the filename. Use `^'
3570 and `$' to anchor matches. Exclude subdirs by hiding them.
3571 `.' and `..' are never flagged."
3577 "Mark all symbolic links.
3578 With prefix argument, unmark or unflag all those files."
3584 "Mark all directory file lines except `.' and `..'.
3585 With prefix argument, unmark or unflag all those files."
3593 "Mark all executable files.
3594 With prefix argument, unmark or unflag all those files."
3599 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3600 ;; files for which PREDICATE returns non-nil.
3603 "Flag for deletion files whose names suggest they are auto save files.
3604 A prefix argument says to unmark or unflag those files instead."
3608 ;; It is less than general to check for # here,
3609 ;; but it's the only way this runs fast enough.
3613 ;; Handle executables in case of -F option.
3614 ;; We need not worry about the other kinds
3615 ;; of markings that -F makes, since they won't
3616 ;; appear on real auto-save files.
3628 ;; `log' here is dubious, since it's typically used for useful log
3629 ;; files, not just TeX stuff. -- fx
3638 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3643 "Flag all backup files (names ending with `~') for deletion.
3644 With prefix argument, unmark or unflag these files."
3648 ;; Don't call backup-file-name-p unless the last character looks like
3649 ;; it might be the end of a backup file name. This isn't very general,
3650 ;; but it's the only way this runs fast enough.
3652 ;; Handle executables in case of -F option.
3653 ;; We need not worry about the other kinds
3654 ;; of markings that -F makes, since they won't
3655 ;; appear on real backup files.
3665 "Change all OLD marks to NEW marks.
3666 OLD and NEW are both characters used to mark files."
3683 t)
3688 "Remove all marks from all files in the Dired buffer."
3692 ;; Bound in dired-unmark-all-files
3696 "Remove a specific mark (or any mark) from every file.
3697 After this command, type the mark character to remove,
3698 or type RET to remove all marks.
3699 With prefix arg, query for each marked file.
3705 dired-unmark-all-files-query
3708 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3718 "Unmark file `%s'? "
3719 file))))
3725 count))))
3726 \f
3727 ;; Logging failures operating on files, and showing the results.
3732 "Pop up a buffer with error log output from Dired.
3733 A group of errors from a single command ends with a formfeed.
3749 ;; Log a message or the contents of a buffer.
3750 ;; If LOG is a string and there are more args, it is formatted with
3751 ;; those ARGS. Usually the LOG string ends with a \n.
3752 ;; End each bunch of errors with (dired-log t):
3753 ;; this inserts the current time and buffer at the start of the page,
3754 ;; and \f (formfeed) at the end.
3762 log)))
3775 "State a summary of a command's failures, in echo area and log buffer.
3776 STRING is an overall summary of the failures.
3777 FAILURES is a list of file names that we failed to operate on,
3778 or nil if file names are not applicable."
3788 string failures))
3789 ;; Log a summary describing a bunch of errors.
3792 \f
3793 ;;; Sorting
3795 ;; Most ls can only sort by name or by date (with -t), nothing else.
3796 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3797 ;; So anything that does not contain these is sort "by name".
3802 This indicates to Dired which option switches to watch out for because they
3803 will change the sorting order behavior of `ls'.
3805 To change the default sorting order (e.g. add a `-v' option), see the
3806 variable `dired-listing-switches'. To temporarily override the listing
3811 ;; `dired-ls-sorting-switches' after -t overrides -t.
3823 "Non-nil means the Dired sort command is disabled.
3827 ;; Set mode line display according to dired-actual-switches.
3828 ;; Mode line display of "by name" or "by date" guarantees the user a
3829 ;; match with the corresponding regexps. Non-matching switches are
3830 ;; shown literally.
3835 dired-sort-by-name-regexp dired-actual-switches)
3838 dired-sort-by-date-regexp dired-actual-switches)
3848 "Toggle sorting by date, and refresh the Dired buffer.
3849 With a prefix argument, edit the current listing switches instead."
3859 ;; Toggle between sort by date/name. Reverts the buffer.
3861 dired-actual-switches))
3862 ;; Regexp for finding (possibly embedded) -t switches.
3864 case-fold-search)
3865 ;; Remove the -t switch.
3869 ;; Remove a stand-alone -t switch.
3872 ;; Remove a switch of the form -XtY for some X and Y.
3876 ;; Now, if we weren't sorting by date before, add the -t switch.
3877 ;; Some simple-minded ls implementations (eg ftp servers) only
3878 ;; allow a single option string, so try not to add " -t" if possible.
3883 dired-actual-switches)
3884 "t"
3889 ;; Some user code loads dired especially for this.
3890 ;; Don't do that--use replace-regexp-in-string instead.
3892 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3893 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3899 start me))
3903 "Specify new `ls' SWITCHES for current Dired buffer.
3904 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3905 set the minor mode accordingly, others appear literally in the mode line.
3906 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3916 "Additional processing of -R in ls option string SWITCHES.
3917 Saves `dired-subdir-alist' when R is set and restores saved value
3918 minus any directories explicitly deleted when R is cleared.
3919 To be called first in body of `dired-sort-other', etc."
3923 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3927 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3928 ;; that are still present:
3934 dired-subdir-alist)
3935 ;; subdir still present...
3938 subdirs)))
3942 ;; No pre-R subdir alist, so revert to main directory
3943 ;; listing:
3945 \f
3947 ;;;; Drag and drop support
3950 "Whether Dired copies directories recursively.
3951 If nil, never copy recursively.
3952 `always' means to copy recursively without asking.
3953 `top' means to ask for each directory at top level.
3954 Any other value means to ask for each directory."
3969 ;; No need to get actions and descriptions from the source,
3970 ;; we only have three actions anyway.
3972 t
3978 "--"
3982 nil)))
3987 ;; Only used when (featurep 'dnd).
3994 "Copy, move or link a file to the Dired directory.
3995 URI is the file to handle, ACTION is one of copy, move, link or ask.
3996 Ask means pop up a menu for the user to select one of copy, move or link."
4005 ;; If copying a directory and dired-recursive-copies is
4006 ;; nil, dired-copy-file fails. Pop up a notice.
4016 ;; Binding dired-overwrite-confirmed to nil makes
4017 ;; dired-handle-overwrite a no-op. We instead use
4018 ;; y-or-n-p, which pops a graphical menu.
4019 dired-overwrite-confirmed backup-file)
4021 ;; d-b-o is defined in dired-aux.
4023 dired-backup-overwrite
4039 action))))))
4042 "Copy, move or link a file to the Dired directory if it is a local file.
4043 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
4044 ACTION is one of copy, move, link or ask.
4045 Ask means pop up a menu for the user to select one of copy, move or link."
4048 nil)))
4049 \f
4051 ;;;; Desktop support
4057 "Auxiliary information to be saved in desktop file."
4059 ;; Value of `dired-directory'.
4061 ;; Directory name followed by list of files.
4064 ;; Directory name, optionally with shell wildcard.
4066 ;; Subdirectories in `dired-subdir-alist'.
4071 dired-subdir-alist)))))
4074 _buffer-name
4075 misc-data)
4076 "Restore a Dired buffer specified in a desktop file."
4077 ;; First element of `misc-data' is the value of `dired-directory'.
4078 ;; This value is a directory name, optionally with shell wildcard or
4079 ;; a directory name followed by list of files.
4085 ;; The following elements of `misc-data' are the keys
4086 ;; from `dired-subdir-alist'.
4091 nil)))
4100 ;;; dired.el ends here