| blob | a056ad679fa2df853b90b51a05eaa2c9fde64be9 |
1 ;;; dired.el --- directory-browsing commands -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1986, 1992-1997, 2000-2017 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 <http://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:
37 ;; When bootstrapping dired-loaddefs has not been generated.
43 ;;; Customizable variables
46 "Directory editing."
51 "Handling marks in Dired."
56 ;;;###autoload
58 "Switches passed to `ls' for Dired. MUST contain the `l' option.
59 May contain all other options that don't contradict `-l';
60 may contain even `F', `b', `i' and `s'. See also the variable
61 `dired-ls-F-marks-symlinks' concerning the `F' switch.
62 Options that include embedded whitespace must be quoted
64 `combine-and-quote-strings' to produce the correct quoting of
65 each option.
66 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
67 some of the `ls' switches are not supported; see the doc string of
68 `insert-directory' in `ls-lisp.el' for more details."
73 "If non-nil, switches passed to `ls' for inserting subdirectories.
74 If nil, `dired-listing-switches' is used."
84 "Name of chown command (usually `chown')."
90 The special value of `unspecified' means to check explicitly, and
91 save the result in this variable. This is performed the first
92 time `dired-insert-directory' is called.
94 Note that if you set this option to nil, either through choice or
97 spaces. You might want to install ls from GNU Coreutils, which does
98 support this option. Alternatively, you might want to use Emacs's
100 (setq ls-lisp-use-insert-directory-program nil)
103 Note that `ls-lisp' does not support as many options as GNU ls, though.
104 For more details, see Info node `(emacs)ls in Lisp'."
111 "Name of chmod command (usually `chmod')."
116 "Name of touch command (usually `touch')."
121 "Informs Dired about how `ls -lF' marks symbolic links.
122 Set this to t if `ls' (or whatever program is specified by
123 `insert-directory-program') with `-lF' marks the symbolic link
124 itself with a trailing @ (usually the case under Ultrix).
126 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
127 nil (the default), if it gives `bar@ -> foo', set it to t.
129 Dired checks if there is really a @ appended. Thus, if you have a
130 marking `ls' program on one host and a non-marking on another host, and
131 don't care about symbolic links which really end in a @, you can
132 always set this variable to t."
137 "Regexp of files to skip when finding first file of a directory.
138 A value of nil means move to the subdir line.
139 A value of t means move to first file."
142 regexp)
146 ;; Use t as default so that moved files "take their markers with them".
147 "Controls marking of renamed files.
148 If t, files keep their previous marks when they are renamed.
149 If a character, renamed files (whether previously marked or not)
150 are afterward marked with that character.
151 This option affects only files renamed by `dired-do-rename' and
152 `dired-do-rename-regexp'. See `wdired-keep-marker-rename'
153 if you want to do the same for files renamed in WDired mode."
159 "Controls marking of copied files.
160 If t, copied files are marked if and as the corresponding original files were.
161 If a character, copied files are unconditionally marked with that character."
167 "Controls marking of newly made hard links.
168 If t, they are marked if and as the files linked to were marked.
169 If a character, new links are unconditionally marked with that character."
175 "Controls marking of newly made symbolic links.
176 If t, they are marked if and as the files linked to were marked.
177 If a character, new links are unconditionally marked with that character."
183 "If non-nil, Dired tries to guess a default target directory.
184 This means: if there is a Dired buffer displayed in the next
185 window, use its current directory, instead of this Dired buffer's
186 current directory.
188 The target is used in the prompt for file copy, rename etc."
193 "If non-nil, Dired preserves the last-modified time in a file copy.
194 \(This works on only some systems.)"
198 ; These variables were deleted and the replacements are on files.el.
199 ; We leave aliases behind for back-compatibility.
203 ;;; Hook variables
206 "Run after loading Dired.
207 You can customize key bindings or load extensions with this."
212 "Run at the very end of `dired-mode'."
217 "This hook is run before a Dired buffer is read in (created or reverted)."
222 "Hook run after each time a file or directory is read by Dired.
223 After each listing of a file or directory, this hook is run
224 with the buffer narrowed to the listing."
227 ;; Note this can't simply be run inside function `dired-ls' as the hook
228 ;; functions probably depend on the dired-subdir-alist to be OK.
231 "This hook is used to position the point.
232 It is run by the function `dired-initial-position'."
241 "The functions to call when a drop in `dired-mode' is made.
242 See `dnd-protocol-alist' for more information. When nil, behave
243 as in other buffers. Changing this option is effective only for
244 new Dired buffers."
251 "Non-nil means `dired-hide-details-mode' hides symbolic link targets."
257 "Non-nil means `dired-hide-details-mode' hides all but header and file lines."
263 "Non-nil means revert buffers visiting files before searching them.
264 By default, commands like `dired-mark-files-containing-regexp' will
265 search any buffers visiting the marked files without reverting them,
266 even if they were changed on disk. When this option is non-nil, such
267 buffers are always reverted in a temporary buffer before searching
268 them: the search is performed on the temporary buffer, the original
269 buffer visiting the file is not modified."
274 ;; Internal variables
277 ;; so that you can write things like
278 ;; (let ((dired-marker-char ?X))
279 ;; ;; great code using X markers ...
280 ;; )
281 ;; For example, commands operating on two sets of files, A and B.
282 ;; Or marking files with digits 0-9. This could implicate
283 ;; concentric sets or an order for the marked files.
284 ;; The code depends on dynamic scoping on the marker char.
285 "In Dired, the current mark character.
292 ;; I see no reason ever to make this nil -- rms.
293 ;; (> baud-rate search-slow-speed)
296 "use the Customization interface to add a new rule
302 ;;;###autoload
304 "The directory name or wildcard spec that this Dired directory lists.
305 Local to each Dired buffer. May be a list, in which case the car is the
306 directory name and the cdr is the list of files to mention.
309 ;; Beware of "-l;reboot" etc. See bug#3230.
311 "Return non-nil if string SWITCHES does not look risky for Dired."
325 ;; These regexps must be tested at beginning-of-line, but are also
326 ;; used to search for next matches, so neither omitting "^" nor
327 ;; replacing "^" by "\n" (to make it slightly faster) will work.
330 ;; "Regexp matching a marked line.
331 ;; Important: the match ends just after the marker."
333 ;; The [^:] part after "d" and "l" is to avoid confusion with the
334 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
341 "-[-r][-w].[-r][-w][xs][-r][-w]."
347 ;; The subdirectory names in the next two lists are expanded.
349 "Association list of subdirectories and their buffer positions.
350 Each subdirectory has an element: (DIRNAME . STARTMARKER).
351 The order of elements is the reverse of the order in the buffer.
355 "Keeps track of which switches to use for inserted subdirectories.
362 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
363 Subexpression 1 is the subdirectory proper, no trailing colon.
364 The match starts at the beginning of the line and ends after the end
369 "Faces used by Dired."
375 "Face used for directory headers."
383 "Face used for Dired marks."
391 "Face used for marked files."
399 "Face used for files flagged for deletion."
406 ;; Inherit from font-lock-warning-face since with min-colors 8
407 ;; font-lock-comment-face is not colored any more.
409 "Face used to highlight a part of a buffer that needs user attention."
417 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
418 ;; font-lock-comment-face is not colored any more.
420 "Face used to highlight permissions of group- and world-writable files."
428 "Face used for subdirectories."
436 "Face used for symbolic links."
444 "Face used for files suffixed with `completion-ignored-extensions'."
452 ;;
453 ;; Dired marks.
455 ;;
456 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
457 ;; file name itself. We search for Dired defined regexps, and then use the
458 ;; Dired defined function `dired-move-to-filename' before searching for the
459 ;; simple regexp ".+". It is that regexp which matches the file name.
460 ;;
461 ;; Marked files.
464 ;;
465 ;; Flagged files.
468 ;; People who are paranoid about security would consider this more
469 ;; important than other things such as whether it is a directory.
470 ;; But we don't want to encourage paranoia, so our default
471 ;; should be what's most useful for non-paranoids. -- rms.
472 ;;; ;;
473 ;;; ;; Files that are group or world writable.
474 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
475 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
476 ;;; '(1 dired-warning-face)
477 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
478 ;; However, we don't need to highlight the file name, only the
479 ;; permissions, to win generally. -- fx.
480 ;; Fixme: we could also put text properties on the permission
481 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
488 ;;
489 ;; Subdirectories.
492 ;;
493 ;; Symbolic links.
496 ;;
497 ;; Files suffixed with `completion-ignored-extensions'.
499 ;; It is quicker to first find just an extension, then go back to the
500 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
503 ;;
504 ;; Files suffixed with `completion-ignored-extensions'
505 ;; plus a character put in by -F.
511 ;; If the last character is not part of the filename,
512 ;; move back to the start of the filename
513 ;; so it can be fontified.
514 ;; Otherwise, leave point at the end of the line;
515 ;; that way, nothing is fontified.
519 ;;
520 ;; Explicitly put the default face on file names ending in a colon to
521 ;; avoid fontifying them as directory header.
524 ;;
525 ;; Directory headers.
527 )
531 \f
532 ;;; Macros must be defined before they are used, for the byte compiler.
535 "Mark all files for which PREDICATE evals to non-nil.
536 PREDICATE is evaluated on each line, with point at beginning of line.
537 MSG is a noun phrase for the type of files being marked.
538 It should end with a noun that can be pluralized by adding `s'.
539 Return value is the number of files marked, or nil if none were marked."
549 ,msg
551 " for deletion"
562 count
563 ,msg
571 distinguish-one-marked)
572 "Eval BODY with point on each marked line. Return a list of BODY's results.
573 If no marked file could be found, execute BODY on the current
574 line. ARG, if non-nil, specifies the files to use instead of the
575 marked files.
577 If ARG is an integer, use the next ARG (or previous -ARG, if
578 ARG<0) files. In that case, point is dragged along. This is so
579 that commands on the next ARG (instead of the marked) files can
580 be chained easily.
581 For any other non-nil value of ARG, use the current file.
583 If optional third arg SHOW-PROGRESS evaluates to non-nil,
584 redisplay the dired buffer after each file is processed.
586 No guarantee is made about the position on the marked line.
587 BODY must ensure this itself if it depends on this.
589 Search starts at the beginning of the buffer, thus the car of the
590 list corresponds to the line nearest to the buffer's bottom.
591 This is also true for (positive and negative) integer values of
592 ARG.
594 BODY should not be too long as it is expanded four times.
596 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one
597 marked file, return (t FILENAME) instead of (FILENAME)."
598 ;;
599 ;;Warning: BODY must not add new lines before point - this may cause an
600 ;;endless loop.
601 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
608 ,arg
614 results))
615 ;; non-nil, non-integer ARG means use current file:
620 ;; remember position of next marked file before BODY
621 ;; can insert lines before the just found file,
622 ;; confusing us by finding the same marked file again
623 ;; and again and...
631 ;; move after last match
640 results
642 ;; save-excursion loses, again
646 "Return the marked files' names as list of strings.
647 The list is in the same order as the buffer, that is, the car is the
648 first marked file.
649 Values returned are normally absolute file names.
650 Optional arg LOCALP as in `dired-get-filename'.
651 Optional second argument ARG, if non-nil, specifies files near
652 point instead of marked files. It usually comes from the prefix
653 argument.
654 If ARG is an integer, use the next ARG files.
655 If ARG is any other non-nil value, return the current file name.
656 If no files are marked, and ARG is nil, also return the current file name.
657 Optional third argument FILTER, if non-nil, is a function to select
658 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
660 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
661 return (t FILENAME) instead of (FILENAME).
662 Don't use that together with FILTER."
667 arg nil distinguish-one-marked))))
668 result)
673 all-of-them
678 result)))
679 \f
680 ;; The dired command
683 ;; For use in interactive.
687 dired-listing-switches))
688 ;; If a dialog is used, call `read-directory-name' so the
689 ;; dialog code knows we want directories. Some dialogs
690 ;; can only select directories or files when popped up,
691 ;; not both. If no dialog is used, call `read-file-name'
692 ;; because the user may want completion of file names for
693 ;; use in a wildcard pattern.
696 nil default-directory nil)
698 nil default-directory nil)))))
700 ;; We want to switch to a more sophisticated version of
701 ;; dired-read-dir-and-switches like the following, if there is a way
702 ;; to make it more intuitive. See bug#1285.
704 ;; (defun dired-read-dir-and-switches (str)
705 ;; ;; For use in interactive.
706 ;; (reverse
707 ;; (list
708 ;; (if current-prefix-arg
709 ;; (read-string "Dired listing switches: "
710 ;; dired-listing-switches))
711 ;; ;; If a dialog is about to be used, call read-directory-name so
712 ;; ;; the dialog code knows we want directories. Some dialogs can
713 ;; ;; only select directories or files when popped up, not both.
714 ;; (if (next-read-file-uses-dialog-p)
715 ;; (read-directory-name (format "Dired %s(directory): " str)
716 ;; nil default-directory nil)
717 ;; (let ((cie ()))
718 ;; (dolist (ext completion-ignored-extensions)
719 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
720 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
721 ;; (let* ((default (and buffer-file-name
722 ;; (abbreviate-file-name buffer-file-name)))
723 ;; (cie cie)
724 ;; (completion-table
725 ;; ;; We need a mix of read-file-name and
726 ;; ;; read-directory-name so that completion to directories
727 ;; ;; is preferred, but if the user wants to enter a global
728 ;; ;; pattern, he can still use completion on filenames to
729 ;; ;; help him write the pattern.
730 ;; ;; Essentially, we want to use
731 ;; ;; (completion-table-with-predicate
732 ;; ;; 'read-file-name-internal 'file-directory-p nil)
733 ;; ;; but that doesn't work because read-file-name-internal
734 ;; ;; does not obey its `predicate' argument.
735 ;; (completion-table-in-turn
736 ;; (lambda (str pred action)
737 ;; (let ((read-file-name-predicate
738 ;; (lambda (f)
739 ;; (and (not (member f '("./" "../")))
740 ;; ;; Hack! Faster than file-directory-p!
741 ;; (eq (aref f (1- (length f))) ?/)
742 ;; (not (string-match cie f))))))
743 ;; (complete-with-action
744 ;; action 'read-file-name-internal str nil)))
745 ;; 'read-file-name-internal)))
746 ;; (minibuffer-with-setup-hook
747 ;; (lambda ()
748 ;; (setq minibuffer-default default)
749 ;; (setq minibuffer-completion-table completion-table))
750 ;; (read-file-name (format "Dired %s(directory): " str)
751 ;; nil default-directory nil))))))))
754 "Try to get a file name at point in the current dired buffer.
755 This hook is intended to be put in `file-name-at-point-functions'.
756 Note that it returns an abbreviated name that can't be used
757 as an argument to `dired-goto-file'."
764 ;;;###autoload (define-key ctl-x-map "d" 'dired)
765 ;;;###autoload
768 Optional second argument SWITCHES specifies the `ls' options used.
769 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
771 If DIRNAME is a string, Dired displays a list of files in DIRNAME (which
772 may also have shell wildcards appended to select certain files).
774 If DIRNAME is a cons, its first element is taken as the directory name
775 and the rest as an explicit list of files to make directory entries for.
776 In this case, SWITCHES are applied to each of the files separately, and
777 therefore switches that control the order of the files in the produced
778 listing have no effect.
785 If DIRNAME is already in a Dired buffer, that buffer is used without refresh."
786 ;; Cannot use (interactive "D") because of wildcards.
790 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
791 ;;;###autoload
797 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
798 ;;;###autoload
804 ;;;###autoload
806 "Like `dired' but returns the Dired buffer as value, does not select it."
808 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
809 ;; some shells make:
820 ;; If the argument was syntactically a directory name not a file name,
821 ;; or if it happens to name a file that is a directory,
822 ;; convert it syntactically to a directory name.
823 ;; The reason for checking initially-was-dirname
824 ;; and not just file-directory-p
825 ;; is that file-directory-p is slow over ftp.
833 ;; The following is an internal dired function. It returns non-nil if
834 ;; the directory visited by the current dired buffer has changed on
835 ;; disk. DIRNAME should be the directory name of that directory.
844 "Return non-nil if current Dired buffer needs updating.
845 If NOCONFIRM is non-nil, then this function always returns nil
846 for a remote directory. This feature is used by Auto Revert mode."
852 ;; Do not auto-revert when the dired buffer can be currently
853 ;; written by the user as in `wdired-mode'.
854 buffer-read-only
858 "Automatically revert Dired buffer on revisiting.
859 If t, revisiting an existing Dired buffer automatically reverts it.
860 If its value is a function, call this function with the directory
861 name as single argument and revert the buffer if it returns non-nil.
862 Otherwise, a message offering to revert the changed dired buffer
863 is displayed.
864 Note that this is not the same as `auto-revert-mode' that
865 periodically reverts at specified time intervals."
875 ;; If DIR-OR-LIST is a string and there is an existing dired buffer
876 ;; for it, just leave buffer as it is (don't even call dired-revert).
877 ;; This saves time especially for deep trees or with ange-ftp.
878 ;; The user can type `g' easily, and it is more consistent with find-file.
879 ;; But if SWITCHES are given they are probably different from the
880 ;; buffer's old value, so call dired-sort-other, which does
881 ;; revert the buffer.
882 ;; Revert the buffer if DIR-OR-LIST is a cons or `dired-directory'
883 ;; is a cons and DIR-OR-LIST is a string.
884 ;; A pity we can't possibly do "Directory has changed - refresh? "
885 ;; like find-file does.
886 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
887 ;; see there.
890 ;; Look for an existing buffer.
892 ;; Note that buffer already is in dired-mode, if found.
899 ;; file list may have changed
901 ;; this calls dired-revert
903 ;; Always revert when `dir-or-list' is a cons. Also revert
904 ;; if `dired-directory' is a cons but `dir-or-list' is not.
908 ;; Always revert regardless of whether it has changed or not.
911 ;; Revert when predicate function returns non-nil.
916 ;; If directory has changed on disk, offer to revert.
921 ;; Else a new buffer
924 ;; We can do this unconditionally
925 ;; because dired-noselect ensures that the name
926 ;; is passed in directory name syntax
927 ;; if it was the name of a directory at all.
932 ;; default-directory and dired-actual-switches are set now
933 ;; (buffer-local), so we can call dired-readin:
938 ;; dired-readin can fail if parent directories are inaccessible.
939 ;; Don't leave an empty buffer around in that case.
944 buffer))
947 ;; Enlarged by dired-advertise
948 ;; Queried by function dired-buffers-for-dir. When this detects a
949 ;; killed buffer, it is removed from this list.
954 ;; FIXME add a doc-string, and document dired-x extensions.
956 ;; This differs from dired-buffers-for-dir in that it does not consider
957 ;; subdirs of default-directory and searches for the first match only.
958 ;; Also, the major mode must be MODE.
960 dired-find-subdir
961 ;; Don't try to find a wildcard as a subdirectory.
967 ;; Wildcards must match, too:
969 ;; We don't want to switch to the same buffer---
972 ;; ---unless it's the only possibility:
974 ;; No dired-x, or dired-find-subdir nil.
983 dired-directory ;; nil during find-alternate-file
988 dired-directory))))
990 blist nil)
992 found)))
994 \f
995 ;; Read in a new dired buffer
998 "Read in a new Dired buffer.
999 Differs from `dired-insert-subdir' in that it accepts
1000 wildcards, erases the buffer, and builds the subdir-alist anew
1001 \(including making it buffer-local and clearing it first)."
1003 ;; default-directory and dired-actual-switches must be buffer-local
1004 ;; and initialized by now.
1006 ;; This makes readin much much faster.
1007 ;; In particular, it prevents the font lock hook from running
1008 ;; until the directory is all read in.
1015 ;; This hook which may want to modify dired-actual-switches
1016 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
1017 ;; where ls won't understand -Al switches.
1024 ;; Don't make undo entries for readin.
1030 ;; Must first make alist buffer local and set it to nil because
1031 ;; dired-build-subdir-alist will call dired-clear-alist first
1038 ;; No need to narrow since the whole buffer contains just
1039 ;; dired-readin's output, nothing else. The hook can
1040 ;; successfully use dired functions (e.g. dired-get-filename)
1041 ;; as the subdir-alist has been built in dired-readin.
1044 ;; Subroutines of dired-readin
1047 ;; Insert listing for the specified dir (and maybe file list)
1048 ;; already in dired-directory, assuming a clean buffer.
1054 file-list nil))
1058 ;; If we are reading a whole single directory...
1064 ;; Else treat it as a wildcard spec
1065 ;; unless we have an explicit list of files.
1070 "Align the fields of a file to the ones of surrounding lines.
1071 BEG..END is the line where the file info is located."
1072 ;; Some versions of ls try to adjust the size of each field so as to just
1073 ;; hold the largest element ("largest" in the current invocation, of
1074 ;; course). So when a single line is output, the size of each field is
1075 ;; just big enough for that one output. Thus when dired refreshes one
1076 ;; line, the alignment if this line w.r.t the rest is messed up because
1077 ;; the fields of that one line will generally be smaller.
1078 ;;
1079 ;; To work around this problem, we here add spaces to try and
1080 ;; re-align the fields as needed. Since this is purely aesthetic,
1081 ;; it is of utmost importance that it doesn't mess up anything like
1082 ;; `dired-move-to-filename'. To this end, we limit ourselves to
1083 ;; adding spaces only, and to only add them at places where there
1084 ;; was already at least one space. This way, as long as
1085 ;; `directory-listing-before-filename-regexp' always matches spaces
1086 ;; with "*" or "+", we know we haven't made anything worse. There
1087 ;; is one spot where the exact number of spaces is important, which
1088 ;; is just before the actual filename, so we refrain from adding
1089 ;; spaces there (and within the filename as well, of course).
1092 ;; Check that there is indeed a file, and that there is another adjacent
1093 ;; file with which to align, and that additional spaces are needed to
1094 ;; align the filenames.
1107 ;; Make sure there is some work left to do.
1109 ;; If we've only looked at the line above, check to see if the line
1110 ;; below exists as well and if so, align with the shorter one.
1119 ;; Keep positions uptodate when we insert stuff.
1122 ;; Main loop.
1126 ;; Don't touch anything just before (and after) the
1127 ;; beginning of the filename.
1129 ;; We're now just in front of a field, with a space behind us.
1131 ;; Nums are right-aligned.
1133 ;; Let's look at the other line, in the same column: we
1134 ;; should be either near the end of the previous field, or
1135 ;; in the space between that field and the next.
1136 ;; [ Of course, it's also possible that we're already within
1137 ;; the next field or even past it, but that's unlikely since
1138 ;; other-col > file-col. ]
1139 ;; Let's find the distance to the alignment-point (either
1140 ;; the beginning or the end of the next field, depending on
1141 ;; whether this field is left or right aligned).
1151 ;; Now, the number of spaces to insert is align-pt-offset
1152 ;; minus the distance to the equivalent point on the
1153 ;; current line.
1156 align-pt-offset
1166 ;; Let's just make really sure we did not mess up.
1169 ;; Damn! We messed up: let's revert the change.
1171 ;; Now skip to next field.
1179 "Return non-nil if the string SWITCHES matches LONG or SHORT format."
1184 switches))))
1187 "Return non-nil if the string SWITCHES contains -b or --escape."
1188 ;; Do not match things like "--block-size" that happen to contain "b".
1192 "Return non-nil if the string SWITCHES contains -R or --recursive."
1196 "Insert a directory listing of DIR, Dired style.
1197 Use SWITCHES to make the listings.
1198 If FILE-LIST is non-nil, list only those files.
1199 Otherwise, if WILDCARD is non-nil, expand wildcards;
1200 in that case, DIR should be a file name that uses wildcards.
1201 In other cases, DIR should be a directory name or a directory filename.
1202 If HDR is non-nil, insert a header line with the directory name."
1205 end)
1207 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1208 ;; ls-lisp emulation is used, except if they want to use `ls'
1209 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1216 ;; Check whether "ls --dired" gives exit code 0, and
1217 ;; save the answer in `dired-use-ls-dired'.
1224 nil))
1225 dired-use-ls-dired)))
1227 ;; Expand directory wildcards and fill file-list.
1241 ;; We used to specify the C locale here, to force English
1242 ;; month names; but this should not be necessary any
1243 ;; more, with the new value of
1244 ;; `directory-listing-before-filename-regexp'.
1249 ;; Re-align fields, if necessary.
1252 ;; Quote certain characters, unless ls quoted them for us.
1261 nil t))
1267 nil t))
1269 ;; Replace any newlines in DIR with literal "\n"s, for the sake
1270 ;; of the header line. To disambiguate a literal "\n" in the
1271 ;; actual dirname, we also replace "\" with "\\".
1272 ;; Personally, I think this should always be done, irrespective
1273 ;; of the value of dired-actual-switches, because:
1274 ;; i) Dired simply does not work with an unescaped newline in
1275 ;; the directory name used in the header (bug=10469#28), and
1276 ;; ii) "\" is always replaced with "\\" in the listing, so doing
1277 ;; it in the header as well makes things consistent.
1278 ;; But at present it is only done if "-b" is in ls-switches,
1279 ;; because newlines in dirnames are uncommon, and people may
1280 ;; have gotten used to seeing unescaped "\" in the headers.
1281 ;; Note: adjust dired-build-subdir-alist if you change this.
1284 ;; If we used --dired and it worked, the lines are already indented.
1285 ;; Otherwise, indent them.
1291 ;; Insert text at the beginning to standardize things.
1298 ;; Note that dired-build-subdir-alist will replace the name
1299 ;; by its expansion, so it does not matter whether what we insert
1300 ;; here is fully expanded, but it should be absolute.
1305 ;; Insert "wildcard" line where "total" line would be for a full dir.
1312 "Add various text properties to the lines in the region."
1331 highlight
1332 dired-filename t
1338 \f
1339 ;; Reverting a dired buffer
1342 "Reread the Dired buffer.
1343 Must also be called after `dired-actual-switches' have changed.
1344 Should not fail even on completely garbaged buffers.
1345 Preserves old cursor, marks/flags, hidden-p.
1347 Dired sets `revert-buffer-function' to this function. The args
1348 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1360 ;; treat top level dir extra (it may contain wildcards)
1367 ;; Run dired-after-readin-hook just once, below.
1372 ;; ... run the hook for the whole buffer, and only after markers
1373 ;; have been reinserted (else omitting in dired-x would omit marked files)
1381 ;; outside of the let scope
1382 ;;; Might as well not override the user if the user changed this.
1383 ;;; (setq buffer-read-only t)
1384 )
1386 ;; Subroutines of dired-revert
1387 ;; Some of these are also used when inserting subdirs.
1390 "Return current positions in the buffer and all windows with this directory.
1391 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1393 BUFFER-POSITION is the point position in the current Dired buffer.
1394 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1396 WINDOW-POSITIONS are current positions in all windows displaying
1397 this dired buffer. The window positions have the form (WINDOW
1398 DIRED-FILENAME WINDOW-POINT)."
1409 "Restore POSITIONS saved with `dired-save-positions'."
1417 ;; Ensure that window still displays the original buffer.
1426 "Return alist of files and their marks, from BEG to END."
1437 alist))
1440 "Mark all files remembered in ALIST.
1441 Each element of ALIST looks like (FILE . MARKERCHAR)."
1455 "Return a list of names of subdirs currently hidden."
1465 result))
1468 "Try to insert all subdirs that were displayed before.
1469 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1481 "Remove directory DIR from any directory cache."
1485 \f
1486 ;; dired mode key bindings and initialization
1489 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1490 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1495 ;; Commands to mark or flag certain categories of files
1499 ;; Upper case keys (except !) for operating on the marked files
1519 ;; Comparison commands
1521 ;; Tree Dired commands
1527 ;; move to marked files
1530 ;; Make all regexp commands share a `%' prefix:
1531 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1532 ;; but that seems to serve little purpose, and copy-keymap
1533 ;; does a better job without it.
1546 ;; Commands for marking and unmarking.
1563 ;; Lower keys for commands not operating on all the marked files
1589 ;; moving
1597 ;; hiding
1601 ;; isearch
1606 ;; misc
1608 ;; `toggle-read-only' is an obsolete alias for `read-only-mode'
1614 ;; thumbnail manipulation (image-dired)
1627 ;; encryption and decryption (epa-dired)
1633 ;; Make menu bar items.
1635 ;; No need to fo this, now that top-level items are fewer.
1636 ;;;;
1637 ;; Get rid of the Edit menu bar item to save space.
1638 ;(define-key map [menu-bar edit] 'undefined)
1751 ;; When running on plain MS-DOS, there's only one
1752 ;; letter-case for file names.
1940 map)
1942 \f
1943 ;; Dired mode is suitable only for specially formatted data.
1946 ;; Autoload cookie needed by desktop.el
1947 ;;;###autoload
1949 "\
1952 (optionally) its subdirectories, in the format of `ls -lR'.
1955 compress, load or byte-compile them, change their file attributes
1958 by file or all files matching certain criteria.
1960 The buffer is read-only. Digits are prefix arguments.
1963 Most commands operate on the marked files and use the current file
1964 if no files are marked. Use a numeric prefix argument to operate on
1965 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1966 to operate on the current file only. Prefix arguments override marks.
1968 to see why something went wrong.
1973 (or dired it in another buffer, if it is a directory).
1980 This retains all marks and hides subdirs again that were hidden before.
1981 Use `SPC' and `DEL' to move down and up by lines.
1984 to read the
1986 to relist the file at point or the marked files or a
1988 again for the directory tree.
1991 for more info):
1993 `dired-listing-switches'
1994 `dired-trivial-filenames'
1995 `dired-marker-char'
1996 `dired-del-marker'
1997 `dired-keep-marker-rename'
1998 `dired-keep-marker-copy'
1999 `dired-keep-marker-hardlink'
2000 `dired-keep-marker-symlink'
2004 `dired-before-readin-hook'
2005 `dired-after-readin-hook'
2006 `dired-mode-hook'
2007 `dired-load-hook'
2009 Keybindings:
2011 ;; Not to be called interactively (e.g. dired-directory will be set
2012 ;; to default-directory, which is wrong with wildcards).
2017 mode-name "Dired"
2018 ;; case-fold-search nil
2019 buffer-read-only t
2020 selective-display t ; for subdirectory hiding
2021 mode-line-buffer-identification
2023 ;; Ignore dired-hide-details-* value of invisible text property by default.
2030 ;; list-buffers uses this to display the dir being edited in this buffer.
2034 dired-directory)))
2048 \f
2049 ;; Idiosyncratic dired commands that don't deal with marks.
2052 "Summarize basic Dired commands and show recent Dired errors."
2055 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
2060 "Undo in a Dired buffer.
2061 This doesn't recover lost files, it just undoes changes in the buffer itself.
2062 You can use it to recover marks, killed lines or subdirs."
2071 "Edit Dired buffer with Wdired, or make it read-only.
2072 If the current buffer can be edited with Wdired, (i.e. the major
2073 mode is `dired-mode'), call `wdired-change-to-wdired-mode'.
2074 Otherwise, toggle `read-only-mode'."
2081 "Move down lines then position at filename.
2082 Optional prefix ARG says how many lines to move; default is one line."
2087 ;; We never want to move point into an invisible line.
2094 "Move up lines then position at filename.
2095 Optional prefix ARG says how many lines to move; default is one line."
2100 "Goto ARGth next directory file line."
2112 "Goto ARGth previous directory file line."
2117 "Run Dired on parent directory of current directory.
2118 Find the parent directory either in this buffer or another buffer.
2119 Creates a buffer if necessary.
2120 If OTHER-WINDOW (the optional prefix arg), display the parent
2121 directory in another window."
2126 ;; Only try dired-goto-subdir if buffer has more than one dir.
2136 "Get the current line's file name, with an error if file does not exist."
2138 ;; We pass t for second arg so that we don't get error for `.' and `..'.
2140 file-name)
2145 file-name
2150 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
2153 "In Dired, visit the file or directory named on this line."
2155 ;; Bind `find-file-run-dired' so that the command works on directories
2156 ;; too, independent of the user's setting.
2158 ;; This binding prevents problems with preserving point in
2159 ;; windows displaying Dired buffers, because reverting a Dired
2160 ;; buffer empties it, which changes the places where the
2161 ;; markers used by switch-to-buffer-preserve-window-point
2162 ;; point.
2165 nil
2166 switch-to-buffer-preserve-window-point)))
2170 "In Dired, visit this file or directory instead of the Dired buffer."
2174 ;; Don't override the setting from .emacs.
2175 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
2178 "In Dired, visit the file or directory name you click on."
2199 "In Dired, examine a file in view mode, returning to Dired when done.
2200 When file is a directory, show it in this buffer if it is inserted.
2201 Otherwise, display it in another buffer."
2211 "In Dired, visit this file or directory in another window."
2216 "In Dired, display this file or directory in another window."
2219 t))
2220 \f
2221 ;;; Functions for extracting and manipulating file names in Dired buffers.
2224 "In Dired, return name of file mentioned on this line.
2225 Value returned normally includes the directory name.
2226 Optional arg LOCALP with value `no-dir' means don't include directory
2227 name in result. A value of `verbatim' means to return the name exactly as
2228 it occurs in the buffer, and a value of t means construct name relative to
2229 `default-directory', which still may contain slashes if in a subdirectory.
2230 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2231 regular filenames and return nil if no filename on this line.
2232 Otherwise, an error occurs in these cases."
2237 ;; nil if no file on this line, but no-error-if-not-filep is t:
2240 ;; Get rid of the mouse-face property that file names have.
2242 ;; Unquote names quoted by ls or by dired-insert-directory.
2243 ;; This code was written using `read' to unquote, because
2244 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2245 ;; char) etc. in a lisp loop. Unfortunately, this decision
2246 ;; has necessitated hacks such as dealing with filenames
2247 ;; with quotation marks in their names.
2250 ;; Unescape any spaces escaped by ls -b (bug#10469).
2251 ;; Other -b quotes, eg \t, \n, work transparently.
2269 ;; Hence we don't need to worry about converting `\\' back to `\'.
2271 ;; The above `read' will return a unibyte string if FILE
2272 ;; contains eight-bit-control/graphic characters.
2277 ;; A relative file name can start with ~.
2278 ;; Don't treat it as absolute in this context.
2283 nil)
2285 file)
2293 ;; check for safe-magic property so that we won't
2294 ;; put /: for names that don't really need them.
2295 ;; For instance, .gz files when auto-compression-mode is on.
2298 file)))
2300 file)
2304 ;; check for safe-magic property so that we won't
2305 ;; put /: for names that don't really need them.
2306 ;; For instance, .gz files when auto-compression-mode is on.
2309 file)))
2315 "Replace first match of REGEXP in STRING with NEWTEXT.
2316 If it does not match, nil is returned instead of the new string.
2317 Optional arg LITERAL means to take NEWTEXT literally.
2318 Optional arg GLOBAL means to replace all matches."
2325 ret)
2327 nil
2331 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2332 ;; We can't always use expand-file-name as this would get rid of `.'
2333 ;; or expand in / instead default-directory if DIR=="".
2334 ;; This should be good enough for ange-ftp.
2335 ;; It should be reasonably fast, though, as it is called in
2336 ;; dired-get-filename.
2340 "Convert FILE (an absolute file name) to a name relative to DIR.
2341 If DIR is omitted or nil, it defaults to `default-directory'.
2342 If FILE is not in the directory tree of DIR, return FILE
2343 unchanged."
2345 ;; This case comes into play if default-directory is set to
2346 ;; use ~.
2351 file))
2352 \f
2354 "Toggle visibility of detailed information in current Dired buffer.
2355 When this minor mode is enabled, details such as file ownership and
2356 permissions are hidden from view.
2358 See options: `dired-hide-details-hide-symlink-targets' and
2359 `dired-hide-details-hide-information-lines'."
2366 'dired-hide-details-update-invisibility-spec
2367 nil
2368 t)
2370 'dired-hide-details-update-invisibility-spec
2371 t)))
2375 'add-to-invisibility-spec
2379 dired-hide-details-hide-information-lines)
2380 'add-to-invisibility-spec
2384 dired-hide-details-hide-symlink-targets
2386 'add-to-invisibility-spec
2389 \f
2390 ;;; Functions for finding the file name in a dired buffer line.
2396 ;; Move to first char of filename on this line.
2397 ;; Returns position (point) or nil if no filename on this line."
2399 "Move to the beginning of the filename on the current line.
2400 Return the position of the beginning of the filename, or nil if none found."
2401 ;; This is the UNIX version.
2404 ;; First try assuming `ls --dired' was used.
2412 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2416 nil)
2421 ;; Assumes point is at beginning of filename,
2422 ;; thus the rwx bit re-search-backward below will succeed in *this*
2423 ;; line if at all. So, it should be called only after
2424 ;; (dired-move-to-filename t).
2425 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2426 ;; This is the UNIX version.
2436 nil
2438 ;; Restrict perm bits to be non-blank,
2439 ;; otherwise this matches one char to early (looking backward):
2440 ;; "l---------" (some systems make symlinks that way)
2441 ;; "----------" (plain file with zero perms)
2443 dired-permission-flags-regexp nil t)
2446 ;; Only with -F we need to know whether it's an executable
2448 used-F
2456 ;; Move point to end of name:
2462 dired-ls-F-marks-symlinks
2466 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2467 ;; one trailing character. (Executable bits on symlinks ain't mean
2468 ;; a thing, even to ls, but we know it's not a symlink.)
2471 executable)
2480 nil
2483 \f
2484 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2487 "Copy names of marked (or next ARG) files into the kill ring.
2488 The names are separated by a space.
2489 With a zero prefix arg, use the absolute file name of each marked file.
2491 `default-directory'. (This still may contain slashes if in a subdirectory.)
2493 If on a subdir headerline, use absolute subdirname instead;
2494 prefix arg and marked files are ignored in this case.
2517 \f
2518 ;; Keeping Dired buffers in sync with the filesystem and with each other
2521 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2522 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2523 ;; matches FILE.
2524 ;; The list is in reverse order of buffer creation, most recent last.
2525 ;; As a side effect, killed dired buffers for DIR are removed from
2526 ;; dired-buffers.
2533 ;; Buffer is killed - clean up:
2541 dired-directory)))
2544 file)))
2548 result))
2551 "Convert glob-pattern PATTERN to a regular expression."
2553 regexp)
2565 ;; Fails to handle ^ yet ????
2579 regexp
2587 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2588 ;; With wildcards we actually advertise too much.
2591 t ; we have already advertised ourselves
2594 dired-buffers)))))
2597 ;; Remove DIR from the buffer alist in variable dired-buffers.
2598 ;; This has the effect of removing any buffer whose main directory is DIR.
2599 ;; It does not affect buffers in which DIR is a subdir.
2600 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2603 \f
2604 ;; Tree Dired
2606 ;;; utility functions
2609 ;;"Is FILE part of the directory tree starting at DIR?"
2614 ;; Prepend default-directory to DIR if relative file name.
2615 ;; dired-get-filename must be able to make a valid file name from a
2616 ;; file and its directory DIR.
2619 dir
2623 ;;"Return the subdir name on this line, or nil if not on a headerline."
2624 ;; Look up in the alist whether this is a headerline.
2630 dired-subdir-alist))))
2631 cur-dir))))
2633 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2647 ;; Return an index into alist for use with nth
2648 ;; for the sake of subdir moving commands.
2657 "Go to next subdirectory, regardless of level."
2658 ;; Use 0 arg to go to this directory's header line.
2659 ;; NO-SKIP prevents moving to end of header line, returning whatever
2660 ;; position was found in dired-subdir-alist.
2663 pos index)
2664 ;; nth with negative arg does not return nil but the first element
2674 nil ; return nil if not found
2678 "Build `dired-subdir-alist' by parsing the buffer.
2679 Returns the new value of the alist.
2680 If optional arg SWITCHES is non-nil, use its value
2681 instead of `dired-actual-switches'."
2689 new-dir-name
2691 ;; Used to expand subdirectory names correctly in recursive
2692 ;; ange-ftp listings.
2699 ;; Avoid taking a file name ending in a colon
2700 ;; as a subdir name.
2710 new-dir-name
2721 ;; Undo any escaping of newlines and \ by dired-insert-directory.
2722 ;; Convert "n" preceded by odd number of \ to newline, and \\ to \.
2730 temp nil)
2734 temp nil))
2737 temp nil))))
2738 new-dir-name)
2741 ;; Place a sub directory boundary between lines.
2748 ;; We don't need to sort it because it is in buffer order per
2749 ;; constructionem. Return new alist:
2750 dired-subdir-alist))
2753 ;; Add new DIR at NEW-MARKER. Don't sort.
2756 dired-subdir-alist)))
2759 ;; Position point on first nontrivial file after point.
2775 "Go to line describing file FILE in this Dired buffer."
2776 ;; Return value of point on success, else nil.
2777 ;; FILE must be an absolute file name.
2778 ;; Loses if FILE contains control chars like "\007" for which ls
2779 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2780 ;; it in the buffer.
2793 ;; First, look for a listing under the absolute name.
2797 ;; Next, look for it as a relative name with leading
2798 ;; subdirectories. (This happens in Dired buffers
2799 ;; created by find-dired, for example.)
2803 default-directory)
2805 ;; Otherwise, look for it as a relative name, a base
2806 ;; name only. The hair is to get the result of
2807 ;; `dired-goto-subdir' without calling it if we don't
2808 ;; have any subdirs.
2815 file
2817 ;; Return buffer position, if found.
2822 "Advance to the Dired listing labeled by FILE; return its position.
2823 Return nil if the listing is not found. If FILE contains
2824 characters that would not appear in a Dired buffer, search using
2825 the quoted forms of those characters.
2827 FULL-NAME specifies the actual file name the listing must have,
2828 as returned by `dired-get-filename'. LIMIT is the search limit."
2834 ;; FIXME: to fix this for embedded control characters etc, we
2835 ;; should escape everything that `ls -b' does.
2840 ;; filenames are preceded by SPC, this makes the search faster
2841 ;; (e.g. for the filename "-").
2845 ;; Check that we are in the right place. Match could have
2846 ;; BASE just as initial substring or in permission bits etc.
2850 found)))
2854 ;; FIXME document whatever dired-x is doing.
2856 "Where point should go in a new listing of DIRNAME.
2857 Point is assumed to be at the beginning of new subdir line.
2858 It runs the hook `dired-initial-position-hook'."
2864 \f
2865 ;; These are hooks which make tree dired work.
2866 ;; They are in this file because other parts of dired need to call them.
2867 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2869 ;; This function is called for each retrieved filename.
2870 ;; It could stand to be faster, though it's mostly function call
2871 ;; overhead. Avoiding the function call seems to save about 10% in
2872 ;; dired-get-filename. Make it a defsubst?
2874 "Return the name of the subdirectory to which this line belongs.
2875 This returns a string with trailing slash, like `default-directory'.
2876 Optional argument means return a file name relative to `default-directory',
2877 in which case the value could be an empty string if `default-directory'
2878 is the directory where the file on this line resides."
2881 ;; probably because called in a non-dired buffer
2883 elt dir)
2887 ;; use `<=' (not `<') as subdir line is part of subdir
2889 nil ; found
2893 dir)))
2895 ;; Subdirs start at the beginning of their header lines and end just
2896 ;; before the beginning of the next header line (or end of buffer).
2903 \f
2904 ;; Deleting files
2907 "Whether Dired deletes directories recursively.
2908 If nil, Dired will not delete non-empty directories.
2909 `always' means to delete non-empty directories recursively,
2910 without asking. This is dangerous!
2911 `top' means to ask for each top-level directory specified by the
2912 Dired deletion command, and delete its subdirectories without
2913 asking.
2914 Any other value means to ask for each directory."
2922 ;; Match anything but `.' and `..'.
2925 ;; Delete file, possibly delete a directory and all its files.
2926 ;; This function is useful outside of dired. One could change its name
2927 ;; to e.g. recursive-delete-file and put it somewhere else.
2929 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2930 RECURSIVE determines what to do with a non-empty directory. The effect of
2931 its possible values is:
2933 nil -- do not delete.
2934 `always' -- delete recursively without asking.
2935 `top' -- ask for each directory at top level.
2936 Anything else -- ask for each sub-directory.
2938 TRASH non-nil means to trash the file instead of deleting, provided
2939 `delete-by-moving-to-trash' (which see) is non-nil."
2940 ;; This test is equivalent to
2941 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2942 ;; but more efficient
2950 delete-by-moving-to-trash)
2951 "trash"
2959 "In Dired, delete the files flagged for deletion.
2960 If NOMESSAGE is non-nil, we don't display any message
2961 if there are no flagged files.
2962 `dired-recursive-deletes' controls whether deletion of
2963 non-empty directories is allowed."
2967 case-fold-search)
2971 ;; this can't move point since ARG is nil
2973 nil)
2974 nil t)
2979 "Delete all marked (or next ARG) files.
2980 `dired-recursive-deletes' controls whether deletion of
2981 non-empty directories is allowed."
2982 ;; This is more consistent with the file marking feature than
2983 ;; dired-do-flagged-delete.
2986 ;; this may move point if ARG is an integer
2988 arg)
2989 arg t))
2994 ;; L is an alist of files to delete, with their buffer positions.
2995 ;; ARG is the prefix arg.
2996 ;; Filenames are absolute.
2997 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2998 ;; That way as changes are made in the buffer they do not shift the
2999 ;; lines still to be changed, so the (point) values in L stay valid.
3000 ;; Also, for subdirs in natural order, a subdir's files are deleted
3001 ;; before the subdir itself - the other way around would not work.
3006 ;; canonicalize file list for pop up
3017 succ count))
3025 ;; if we get here, removing worked
3041 failures))))
3046 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
3047 ;; If the buffer has a wildcard pattern, check that it matches FILE.
3048 ;; (FILE does not include a directory component.)
3049 ;; FILE may be nil, in which case ignore it.
3050 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
3053 file))
3057 success-list))
3059 ;; Delete the entry for FILE from
3071 "Clean up after a deleted file or directory FN.
3072 Removes any expanded subdirectory of deleted directory.
3073 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
3074 also offers to kill buffers visiting deleted files and directories."
3078 ;; Offer to kill buffer of deleted file FN.
3094 \f
3095 ;; Confirmation
3104 "Return a string suitable for use in a Dired prompt.
3105 ARG is normally the prefix argument for the calling command.
3106 FILES should be a list of file names.
3110 ;; distinguish-one-marked can cause the first element to be just t.
3115 ;; more than 1 file:
3117 ;; abs(arg) = count
3118 ;; Perhaps this is nicer, but it also takes more screen space:
3119 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
3120 ;; count)
3125 "Pop up buffer BUF in a way suitable for Dired."
3131 ;; Try to split the selected window vertically if
3132 ;; that's possible. (Bug#1806)
3134 ;; Otherwise, try to split WINDOW sensibly.
3136 pop-up-frames)
3138 ;; See Bug#12281.
3140 ;; If dired-shrink-to-fit is t, make its window fit its contents.
3142 ;; Try to not delete window when we want to display less than
3143 ;; `window-min-height' lines.
3147 "A list of symbols for commands Dired should not confirm, or t.
3148 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
3149 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
3150 `touch' and `uncompress'.
3151 If t, confirmation is never needed."
3162 "Return FUNCTION's result on ARGS after showing which files are marked.
3163 Displays the file names in a window showing a buffer named
3165 window is not shown if there is just one file, `dired-no-confirm'
3166 is t, or OP-SYMBOL is a member of the list in `dired-no-confirm'.
3168 By default, Dired shrinks the display buffer to fit the marked files.
3169 To disable this, use the Customization interface to add a new rule
3171 action argument symbol is `window-height' and its value is nil.
3173 FILES is the list of marked files. It can also be (t FILENAME)
3174 in the case of one marked file, to distinguish that from using
3175 just the current file.
3177 FUNCTION should not manipulate files, just read input (an
3178 argument or confirmation)."
3181 ;; If FILES defaulted to the current line's file.
3185 ;; Mark *Marked Files* window as softly-dedicated, to prevent
3186 ;; other buffers e.g. *Completions* from reusing it (bug#17554).
3189 buffer
3199 ;; Handle (t FILE) just like (FILE), here. That value is
3200 ;; used (only in some cases), to mean just one file that was
3201 ;; marked, rather than the current line file.
3212 \f
3213 ;; Commands to mark or flag file(s) at or near current line.
3216 ;; This version skips non-file lines.
3227 ;; Advance to the next line--actually, to the line that *was* next.
3228 ;; (If FUNCTION inserted some new lines in between, skip them.)
3240 ;; This used to be a regexp match of the `total ...' line output by
3241 ;; ls, which is slightly faster, but that is not very robust; notably,
3242 ;; it fails for non-english locales.
3246 "Move to the next marked file.
3247 If WRAP is non-nil, wrap around to the beginning of the buffer if
3248 we reach the end."
3265 "Move to the previous marked file.
3266 If WRAP is non-nil, wrap around to the end of the buffer if we
3267 reach the beginning of the buffer."
3272 ;; Return FILE's marker, or nil if unmarked.
3286 ;; Skip subdir line and following garbage like the `total' line:
3297 "Mark the file at point in the Dired buffer.
3298 If the region is active, mark all files in the region.
3299 Otherwise, with a prefix arg, mark files on the next ARG lines.
3301 If on a subdir headerline, mark all its files except `.' and `..'.
3305 this subdir."
3308 ;; Mark files in the active region.
3316 ;; Mark subdir files from the subdir headerline.
3319 ;; Mark the current (or next ARG) files.
3327 "Unmark the file at point in the Dired buffer.
3328 If the region is active, unmark all files in the region.
3329 Otherwise, with a prefix arg, unmark files on the next ARG lines.
3331 If looking at a subdir, unmark all its files except `.' and `..'.
3332 If the region is active in Transient Mark mode, unmark all files
3333 in the active region."
3339 "In Dired, flag the current line's file for deletion.
3340 If the region is active, flag all files in the region.
3341 Otherwise, with a prefix arg, flag files on the next ARG lines.
3343 If on a subdir headerline, flag all its files except `.' and `..'.
3344 If the region is active in Transient Mark mode, flag all files
3345 in the active region."
3351 "In Dired, move up lines and remove marks or deletion flags there.
3352 Optional prefix ARG says how many lines to unmark/unflag; default
3353 is one line.
3354 If the region is active in Transient Mark mode, unmark all files
3355 in the active region."
3360 "Toggle marks: marked files become unmarked, and vice versa.
3361 Files marked with other flags (such as `D') are not affected.
3362 `.' and `..' are never toggled.
3363 As always, hidden subdirs are not affected."
3371 ;; use subst instead of insdel because it does not move
3372 ;; the gap and thus should be faster and because
3373 ;; other characters are left alone automatically
3380 \f
3381 ;;; Commands to mark or flag files based on their characteristics or names.
3387 "Read a regexp using `read-regexp'."
3392 "Mark all files matching REGEXP for use in later commands.
3393 A prefix argument means to unmark them instead.
3394 `.' and `..' are never marked.
3397 object files--just `.o' will mark more than you might think."
3401 ;; Add more suggestions into the default list
3419 "Mark all files with contents containing REGEXP for use in later commands.
3420 A prefix argument means to unmark them instead.
3421 `.' and `..' are never marked.
3423 Note that if a file is visited in an Emacs buffer, and
3424 `dired-always-read-filesystem' is nil, this command will
3425 look in the buffer without revisiting the file, so the results might
3426 be inconsistent with the file on disk if its contents has changed
3427 since it was last visited."
3442 ;; For now we do it inside emacs
3443 ;; Grep might be better if there are a lot of files
3453 )))
3457 "In Dired, flag all files containing the specified REGEXP for deletion.
3458 The match is against the non-directory part of the filename. Use `^'
3459 and `$' to anchor matches. Exclude subdirs by hiding them.
3460 `.' and `..' are never flagged."
3466 "Mark all symbolic links.
3467 With prefix argument, unmark or unflag all those files."
3473 "Mark all directory file lines except `.' and `..'.
3474 With prefix argument, unmark or unflag all those files."
3482 "Mark all executable files.
3483 With prefix argument, unmark or unflag all those files."
3488 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3489 ;; files for which PREDICATE returns non-nil.
3492 "Flag for deletion files whose names suggest they are auto save files.
3493 A prefix argument says to unmark or unflag those files instead."
3497 ;; It is less than general to check for # here,
3498 ;; but it's the only way this runs fast enough.
3502 ;; Handle executables in case of -F option.
3503 ;; We need not worry about the other kinds
3504 ;; of markings that -F makes, since they won't
3505 ;; appear on real auto-save files.
3517 ;; `log' here is dubious, since it's typically used for useful log
3518 ;; files, not just TeX stuff. -- fx
3527 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3532 "Flag all backup files (names ending with `~') for deletion.
3533 With prefix argument, unmark or unflag these files."
3537 ;; Don't call backup-file-name-p unless the last character looks like
3538 ;; it might be the end of a backup file name. This isn't very general,
3539 ;; but it's the only way this runs fast enough.
3541 ;; Handle executables in case of -F option.
3542 ;; We need not worry about the other kinds
3543 ;; of markings that -F makes, since they won't
3544 ;; appear on real backup files.
3554 "Change all OLD marks to NEW marks.
3555 OLD and NEW are both characters used to mark files."
3572 t)
3577 "Remove all marks from all files in the Dired buffer."
3581 ;; Bound in dired-unmark-all-files
3585 "Remove a specific mark (or any mark) from every file.
3586 After this command, type the mark character to remove,
3587 or type RET to remove all marks.
3588 With prefix arg, query for each marked file.
3594 dired-unmark-all-files-query
3597 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3607 "Unmark file `%s'? "
3608 file))))
3614 count))))
3615 \f
3616 ;; Logging failures operating on files, and showing the results.
3621 "Pop up a buffer with error log output from Dired.
3622 A group of errors from a single command ends with a formfeed.
3638 ;; Log a message or the contents of a buffer.
3639 ;; If LOG is a string and there are more args, it is formatted with
3640 ;; those ARGS. Usually the LOG string ends with a \n.
3641 ;; End each bunch of errors with (dired-log t):
3642 ;; this inserts the current time and buffer at the start of the page,
3643 ;; and \f (formfeed) at the end.
3651 log)))
3664 "State a summary of a command's failures, in echo area and log buffer.
3665 STRING is an overall summary of the failures.
3666 FAILURES is a list of file names that we failed to operate on,
3667 or nil if file names are not applicable."
3677 string failures))
3678 ;; Log a summary describing a bunch of errors.
3681 \f
3682 ;;; Sorting
3684 ;; Most ls can only sort by name or by date (with -t), nothing else.
3685 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3686 ;; So anything that does not contain these is sort "by name".
3691 This indicates to Dired which option switches to watch out for because they
3692 will change the sorting order behavior of `ls'.
3694 To change the default sorting order (e.g. add a `-v' option), see the
3695 variable `dired-listing-switches'. To temporarily override the listing
3700 ;; `dired-ls-sorting-switches' after -t overrides -t.
3712 "Non-nil means the Dired sort command is disabled.
3716 ;; Set mode line display according to dired-actual-switches.
3717 ;; Mode line display of "by name" or "by date" guarantees the user a
3718 ;; match with the corresponding regexps. Non-matching switches are
3719 ;; shown literally.
3724 dired-sort-by-name-regexp dired-actual-switches)
3727 dired-sort-by-date-regexp dired-actual-switches)
3737 "Toggle sorting by date, and refresh the Dired buffer.
3738 With a prefix argument, edit the current listing switches instead."
3748 ;; Toggle between sort by date/name. Reverts the buffer.
3750 dired-actual-switches))
3751 ;; Regexp for finding (possibly embedded) -t switches.
3753 case-fold-search)
3754 ;; Remove the -t switch.
3758 ;; Remove a stand-alone -t switch.
3761 ;; Remove a switch of the form -XtY for some X and Y.
3765 ;; Now, if we weren't sorting by date before, add the -t switch.
3766 ;; Some simple-minded ls implementations (eg ftp servers) only
3767 ;; allow a single option string, so try not to add " -t" if possible.
3772 dired-actual-switches)
3773 "t"
3778 ;; Some user code loads dired especially for this.
3779 ;; Don't do that--use replace-regexp-in-string instead.
3781 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3782 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3788 start me))
3792 "Specify new `ls' SWITCHES for current Dired buffer.
3793 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3794 set the minor mode accordingly, others appear literally in the mode line.
3795 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3805 "Additional processing of -R in ls option string SWITCHES.
3806 Saves `dired-subdir-alist' when R is set and restores saved value
3807 minus any directories explicitly deleted when R is cleared.
3808 To be called first in body of `dired-sort-other', etc."
3812 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3816 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3817 ;; that are still present:
3823 dired-subdir-alist)
3824 ;; subdir still present...
3827 subdirs)))
3831 ;; No pre-R subdir alist, so revert to main directory
3832 ;; listing:
3834 \f
3836 ;;;; Drag and drop support
3839 "Whether Dired copies directories recursively.
3840 If nil, never copy recursively.
3841 `always' means to copy recursively without asking.
3842 `top' means to ask for each directory at top level.
3843 Any other value means to ask for each directory."
3858 ;; No need to get actions and descriptions from the source,
3859 ;; we only have three actions anyway.
3861 t
3867 "--"
3871 nil)))
3876 ;; Only used when (featurep 'dnd).
3883 "Copy, move or link a file to the Dired directory.
3884 URI is the file to handle, ACTION is one of copy, move, link or ask.
3885 Ask means pop up a menu for the user to select one of copy, move or link."
3894 ;; If copying a directory and dired-recursive-copies is
3895 ;; nil, dired-copy-file fails. Pop up a notice.
3905 ;; Binding dired-overwrite-confirmed to nil makes
3906 ;; dired-handle-overwrite a no-op. We instead use
3907 ;; y-or-n-p, which pops a graphical menu.
3908 dired-overwrite-confirmed backup-file)
3910 ;; d-b-o is defined in dired-aux.
3912 dired-backup-overwrite
3928 action))))))
3931 "Copy, move or link a file to the Dired directory if it is a local file.
3932 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3933 ACTION is one of copy, move, link or ask.
3934 Ask means pop up a menu for the user to select one of copy, move or link."
3937 nil)))
3938 \f
3940 ;;;; Desktop support
3946 "Auxiliary information to be saved in desktop file."
3948 ;; Value of `dired-directory'.
3950 ;; Directory name followed by list of files.
3953 ;; Directory name, optionally with shell wildcard.
3955 ;; Subdirectories in `dired-subdir-alist'.
3960 dired-subdir-alist)))))
3963 _buffer-name
3964 misc-data)
3965 "Restore a Dired buffer specified in a desktop file."
3966 ;; First element of `misc-data' is the value of `dired-directory'.
3967 ;; This value is a directory name, optionally with shell wildcard or
3968 ;; a directory name followed by list of files.
3974 ;; The following elements of `misc-data' are the keys
3975 ;; from `dired-subdir-alist'.
3980 nil)))
3989 ;;; dired.el ends here