| blob | 2733372eb7b0575273c0b8a236d77dcc8f7f7054 |
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".
342 "-[-r][-w].[-r][-w][xs][-r][-w]."
348 ;; The subdirectory names in the next two lists are expanded.
350 "Association list of subdirectories and their buffer positions.
351 Each subdirectory has an element: (DIRNAME . STARTMARKER).
352 The order of elements is the reverse of the order in the buffer.
356 "Keeps track of which switches to use for inserted subdirectories.
363 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
364 Subexpression 1 is the subdirectory proper, no trailing colon.
365 The match starts at the beginning of the line and ends after the end
370 "Faces used by Dired."
376 "Face used for directory headers."
384 "Face used for Dired marks."
392 "Face used for marked files."
400 "Face used for files flagged for deletion."
407 ;; Inherit from font-lock-warning-face since with min-colors 8
408 ;; font-lock-comment-face is not colored any more.
410 "Face used to highlight a part of a buffer that needs user attention."
418 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
419 ;; font-lock-comment-face is not colored any more.
421 "Face used to highlight permissions of group- and world-writable files."
429 "Face used for subdirectories."
437 "Face used for symbolic links."
445 "Face used for files suffixed with `completion-ignored-extensions'."
453 ;;
454 ;; Dired marks.
456 ;;
457 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
458 ;; file name itself. We search for Dired defined regexps, and then use the
459 ;; Dired defined function `dired-move-to-filename' before searching for the
460 ;; simple regexp ".+". It is that regexp which matches the file name.
461 ;;
462 ;; Marked files.
465 ;;
466 ;; Flagged files.
469 ;; People who are paranoid about security would consider this more
470 ;; important than other things such as whether it is a directory.
471 ;; But we don't want to encourage paranoia, so our default
472 ;; should be what's most useful for non-paranoids. -- rms.
473 ;;; ;;
474 ;;; ;; Files that are group or world writable.
475 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
476 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
477 ;;; '(1 dired-warning-face)
478 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
479 ;; However, we don't need to highlight the file name, only the
480 ;; permissions, to win generally. -- fx.
481 ;; Fixme: we could also put text properties on the permission
482 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
489 ;;
490 ;; Subdirectories.
493 ;;
494 ;; Symbolic links.
497 ;;
498 ;; Files suffixed with `completion-ignored-extensions'.
500 ;; It is quicker to first find just an extension, then go back to the
501 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
504 ;;
505 ;; Files suffixed with `completion-ignored-extensions'
506 ;; plus a character put in by -F.
512 ;; If the last character is not part of the filename,
513 ;; move back to the start of the filename
514 ;; so it can be fontified.
515 ;; Otherwise, leave point at the end of the line;
516 ;; that way, nothing is fontified.
520 ;;
521 ;; Explicitly put the default face on file names ending in a colon to
522 ;; avoid fontifying them as directory header.
525 ;;
526 ;; Directory headers.
528 )
532 \f
533 ;;; Macros must be defined before they are used, for the byte compiler.
536 "Mark all files for which PREDICATE evals to non-nil.
537 PREDICATE is evaluated on each line, with point at beginning of line.
538 MSG is a noun phrase for the type of files being marked.
539 It should end with a noun that can be pluralized by adding `s'.
540 Return value is the number of files marked, or nil if none were marked."
550 ,msg
552 " for deletion"
563 count
564 ,msg
572 distinguish-one-marked)
573 "Eval BODY with point on each marked line. Return a list of BODY's results.
574 If no marked file could be found, execute BODY on the current
575 line. ARG, if non-nil, specifies the files to use instead of the
576 marked files.
578 If ARG is an integer, use the next ARG (or previous -ARG, if
579 ARG<0) files. In that case, point is dragged along. This is so
580 that commands on the next ARG (instead of the marked) files can
581 be chained easily.
582 For any other non-nil value of ARG, use the current file.
584 If optional third arg SHOW-PROGRESS evaluates to non-nil,
585 redisplay the dired buffer after each file is processed.
587 No guarantee is made about the position on the marked line.
588 BODY must ensure this itself if it depends on this.
590 Search starts at the beginning of the buffer, thus the car of the
591 list corresponds to the line nearest to the buffer's bottom.
592 This is also true for (positive and negative) integer values of
593 ARG.
595 BODY should not be too long as it is expanded four times.
597 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one
598 marked file, return (t FILENAME) instead of (FILENAME)."
599 ;;
600 ;;Warning: BODY must not add new lines before point - this may cause an
601 ;;endless loop.
602 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
609 ,arg
615 results))
616 ;; non-nil, non-integer ARG means use current file:
621 ;; remember position of next marked file before BODY
622 ;; can insert lines before the just found file,
623 ;; confusing us by finding the same marked file again
624 ;; and again and...
632 ;; move after last match
641 results
643 ;; save-excursion loses, again
647 "Return the marked files' names as list of strings.
648 The list is in the same order as the buffer, that is, the car is the
649 first marked file.
650 Values returned are normally absolute file names.
651 Optional arg LOCALP as in `dired-get-filename'.
652 Optional second argument ARG, if non-nil, specifies files near
653 point instead of marked files. It usually comes from the prefix
654 argument.
655 If ARG is an integer, use the next ARG files.
656 If ARG is any other non-nil value, return the current file name.
657 If no files are marked, and ARG is nil, also return the current file name.
658 Optional third argument FILTER, if non-nil, is a function to select
659 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
661 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
662 return (t FILENAME) instead of (FILENAME).
663 Don't use that together with FILTER."
668 arg nil distinguish-one-marked))))
669 result)
674 all-of-them
679 result)))
680 \f
681 ;; The dired command
684 ;; For use in interactive.
688 dired-listing-switches))
689 ;; If a dialog is used, call `read-directory-name' so the
690 ;; dialog code knows we want directories. Some dialogs
691 ;; can only select directories or files when popped up,
692 ;; not both. If no dialog is used, call `read-file-name'
693 ;; because the user may want completion of file names for
694 ;; use in a wildcard pattern.
697 nil default-directory nil)
699 nil default-directory nil)))))
701 ;; We want to switch to a more sophisticated version of
702 ;; dired-read-dir-and-switches like the following, if there is a way
703 ;; to make it more intuitive. See bug#1285.
705 ;; (defun dired-read-dir-and-switches (str)
706 ;; ;; For use in interactive.
707 ;; (reverse
708 ;; (list
709 ;; (if current-prefix-arg
710 ;; (read-string "Dired listing switches: "
711 ;; dired-listing-switches))
712 ;; ;; If a dialog is about to be used, call read-directory-name so
713 ;; ;; the dialog code knows we want directories. Some dialogs can
714 ;; ;; only select directories or files when popped up, not both.
715 ;; (if (next-read-file-uses-dialog-p)
716 ;; (read-directory-name (format "Dired %s(directory): " str)
717 ;; nil default-directory nil)
718 ;; (let ((cie ()))
719 ;; (dolist (ext completion-ignored-extensions)
720 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
721 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
722 ;; (let* ((default (and buffer-file-name
723 ;; (abbreviate-file-name buffer-file-name)))
724 ;; (cie cie)
725 ;; (completion-table
726 ;; ;; We need a mix of read-file-name and
727 ;; ;; read-directory-name so that completion to directories
728 ;; ;; is preferred, but if the user wants to enter a global
729 ;; ;; pattern, he can still use completion on filenames to
730 ;; ;; help him write the pattern.
731 ;; ;; Essentially, we want to use
732 ;; ;; (completion-table-with-predicate
733 ;; ;; 'read-file-name-internal 'file-directory-p nil)
734 ;; ;; but that doesn't work because read-file-name-internal
735 ;; ;; does not obey its `predicate' argument.
736 ;; (completion-table-in-turn
737 ;; (lambda (str pred action)
738 ;; (let ((read-file-name-predicate
739 ;; (lambda (f)
740 ;; (and (not (member f '("./" "../")))
741 ;; ;; Hack! Faster than file-directory-p!
742 ;; (eq (aref f (1- (length f))) ?/)
743 ;; (not (string-match cie f))))))
744 ;; (complete-with-action
745 ;; action 'read-file-name-internal str nil)))
746 ;; 'read-file-name-internal)))
747 ;; (minibuffer-with-setup-hook
748 ;; (lambda ()
749 ;; (setq minibuffer-default default)
750 ;; (setq minibuffer-completion-table completion-table))
751 ;; (read-file-name (format "Dired %s(directory): " str)
752 ;; nil default-directory nil))))))))
755 "Try to get a file name at point in the current dired buffer.
756 This hook is intended to be put in `file-name-at-point-functions'.
757 Note that it returns an abbreviated name that can't be used
758 as an argument to `dired-goto-file'."
765 ;;;###autoload (define-key ctl-x-map "d" 'dired)
766 ;;;###autoload
769 Optional second argument SWITCHES specifies the `ls' options used.
770 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
772 If DIRNAME is a string, Dired displays a list of files in DIRNAME (which
773 may also have shell wildcards appended to select certain files).
775 If DIRNAME is a cons, its first element is taken as the directory name
776 and the rest as an explicit list of files to make directory entries for.
777 In this case, SWITCHES are applied to each of the files separately, and
778 therefore switches that control the order of the files in the produced
779 listing have no effect.
786 If DIRNAME is already in a Dired buffer, that buffer is used without refresh."
787 ;; Cannot use (interactive "D") because of wildcards.
791 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
792 ;;;###autoload
798 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
799 ;;;###autoload
805 ;;;###autoload
807 "Like `dired' but returns the Dired buffer as value, does not select it."
809 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
810 ;; some shells make:
821 ;; If the argument was syntactically a directory name not a file name,
822 ;; or if it happens to name a file that is a directory,
823 ;; convert it syntactically to a directory name.
824 ;; The reason for checking initially-was-dirname
825 ;; and not just file-directory-p
826 ;; is that file-directory-p is slow over ftp.
834 ;; The following is an internal dired function. It returns non-nil if
835 ;; the directory visited by the current dired buffer has changed on
836 ;; disk. DIRNAME should be the directory name of that directory.
845 "Return non-nil if current Dired buffer needs updating.
846 If NOCONFIRM is non-nil, then this function always returns nil
847 for a remote directory. This feature is used by Auto Revert mode."
853 ;; Do not auto-revert when the dired buffer can be currently
854 ;; written by the user as in `wdired-mode'.
855 buffer-read-only
859 "Automatically revert Dired buffer on revisiting.
860 If t, revisiting an existing Dired buffer automatically reverts it.
861 If its value is a function, call this function with the directory
862 name as single argument and revert the buffer if it returns non-nil.
863 Otherwise, a message offering to revert the changed dired buffer
864 is displayed.
865 Note that this is not the same as `auto-revert-mode' that
866 periodically reverts at specified time intervals."
876 ;; If there is an existing dired buffer for DIRNAME, just leave
877 ;; buffer as it is (don't even call dired-revert).
878 ;; This saves time especially for deep trees or with ange-ftp.
879 ;; The user can type `g' easily, and it is more consistent with find-file.
880 ;; But if SWITCHES are given they are probably different from the
881 ;; buffer's old value, so call dired-sort-other, which does
882 ;; revert the buffer.
883 ;; A pity we can't possibly do "Directory has changed - refresh? "
884 ;; like find-file does.
885 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
886 ;; see there.
889 ;; Look for an existing buffer.
891 ;; Note that buffer already is in dired-mode, if found.
898 ;; file list may have changed
900 ;; this calls dired-revert
902 ;; Always revert regardless of whether it has changed or not.
905 ;; Revert when predicate function returns non-nil.
910 ;; If directory has changed on disk, offer to revert.
915 ;; Else a new buffer
917 ;; We can do this unconditionally
918 ;; because dired-noselect ensures that the name
919 ;; is passed in directory name syntax
920 ;; if it was the name of a directory at all.
925 ;; default-directory and dired-actual-switches are set now
926 ;; (buffer-local), so we can call dired-readin:
931 ;; dired-readin can fail if parent directories are inaccessible.
932 ;; Don't leave an empty buffer around in that case.
937 buffer))
940 ;; Enlarged by dired-advertise
941 ;; Queried by function dired-buffers-for-dir. When this detects a
942 ;; killed buffer, it is removed from this list.
947 ;; FIXME add a doc-string, and document dired-x extensions.
949 ;; This differs from dired-buffers-for-dir in that it does not consider
950 ;; subdirs of default-directory and searches for the first match only.
951 ;; Also, the major mode must be MODE.
953 dired-find-subdir
954 ;; Don't try to find a wildcard as a subdirectory.
960 ;; Wildcards must match, too:
962 ;; We don't want to switch to the same buffer---
965 ;; ---unless it's the only possibility:
967 ;; No dired-x, or dired-find-subdir nil.
976 dired-directory ;; nil during find-alternate-file
981 dired-directory))))
983 blist nil)
985 found)))
987 \f
988 ;; Read in a new dired buffer
991 "Read in a new Dired buffer.
992 Differs from `dired-insert-subdir' in that it accepts
993 wildcards, erases the buffer, and builds the subdir-alist anew
994 \(including making it buffer-local and clearing it first)."
996 ;; default-directory and dired-actual-switches must be buffer-local
997 ;; and initialized by now.
999 ;; This makes readin much much faster.
1000 ;; In particular, it prevents the font lock hook from running
1001 ;; until the directory is all read in.
1008 ;; This hook which may want to modify dired-actual-switches
1009 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
1010 ;; where ls won't understand -Al switches.
1017 ;; Don't make undo entries for readin.
1023 ;; Must first make alist buffer local and set it to nil because
1024 ;; dired-build-subdir-alist will call dired-clear-alist first
1031 ;; No need to narrow since the whole buffer contains just
1032 ;; dired-readin's output, nothing else. The hook can
1033 ;; successfully use dired functions (e.g. dired-get-filename)
1034 ;; as the subdir-alist has been built in dired-readin.
1037 ;; Subroutines of dired-readin
1040 ;; Insert listing for the specified dir (and maybe file list)
1041 ;; already in dired-directory, assuming a clean buffer.
1047 file-list nil))
1051 ;; If we are reading a whole single directory...
1056 ;; Else treat it as a wildcard spec
1057 ;; unless we have an explicit list of files.
1062 "Align the fields of a file to the ones of surrounding lines.
1063 BEG..END is the line where the file info is located."
1064 ;; Some versions of ls try to adjust the size of each field so as to just
1065 ;; hold the largest element ("largest" in the current invocation, of
1066 ;; course). So when a single line is output, the size of each field is
1067 ;; just big enough for that one output. Thus when dired refreshes one
1068 ;; line, the alignment if this line w.r.t the rest is messed up because
1069 ;; the fields of that one line will generally be smaller.
1070 ;;
1071 ;; To work around this problem, we here add spaces to try and
1072 ;; re-align the fields as needed. Since this is purely aesthetic,
1073 ;; it is of utmost importance that it doesn't mess up anything like
1074 ;; `dired-move-to-filename'. To this end, we limit ourselves to
1075 ;; adding spaces only, and to only add them at places where there
1076 ;; was already at least one space. This way, as long as
1077 ;; `directory-listing-before-filename-regexp' always matches spaces
1078 ;; with "*" or "+", we know we haven't made anything worse. There
1079 ;; is one spot where the exact number of spaces is important, which
1080 ;; is just before the actual filename, so we refrain from adding
1081 ;; spaces there (and within the filename as well, of course).
1084 ;; Check that there is indeed a file, and that there is another adjacent
1085 ;; file with which to align, and that additional spaces are needed to
1086 ;; align the filenames.
1099 ;; Make sure there is some work left to do.
1101 ;; If we've only looked at the line above, check to see if the line
1102 ;; below exists as well and if so, align with the shorter one.
1111 ;; Keep positions uptodate when we insert stuff.
1114 ;; Main loop.
1118 ;; Don't touch anything just before (and after) the
1119 ;; beginning of the filename.
1121 ;; We're now just in front of a field, with a space behind us.
1123 ;; Nums are right-aligned.
1125 ;; Let's look at the other line, in the same column: we
1126 ;; should be either near the end of the previous field, or
1127 ;; in the space between that field and the next.
1128 ;; [ Of course, it's also possible that we're already within
1129 ;; the next field or even past it, but that's unlikely since
1130 ;; other-col > file-col. ]
1131 ;; Let's find the distance to the alignment-point (either
1132 ;; the beginning or the end of the next field, depending on
1133 ;; whether this field is left or right aligned).
1143 ;; Now, the number of spaces to insert is align-pt-offset
1144 ;; minus the distance to the equivalent point on the
1145 ;; current line.
1148 align-pt-offset
1158 ;; Let's just make really sure we did not mess up.
1161 ;; Damn! We messed up: let's revert the change.
1163 ;; Now skip to next field.
1171 "Return non-nil if the string SWITCHES matches LONG or SHORT format."
1176 switches))))
1179 "Return non-nil if the string SWITCHES contains -b or --escape."
1180 ;; Do not match things like "--block-size" that happen to contain "b".
1184 "Return non-nil if the string SWITCHES contains -R or --recursive."
1188 "Insert a directory listing of DIR, Dired style.
1189 Use SWITCHES to make the listings.
1190 If FILE-LIST is non-nil, list only those files.
1191 Otherwise, if WILDCARD is non-nil, expand wildcards;
1192 in that case, DIR should be a file name that uses wildcards.
1193 In other cases, DIR should be a directory name or a directory filename.
1194 If HDR is non-nil, insert a header line with the directory name."
1197 end)
1199 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1200 ;; ls-lisp emulation is used, except if they want to use `ls'
1201 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1205 ;; Check whether "ls --dired" gives exit code 0, and
1206 ;; save the answer in `dired-use-ls-dired'.
1213 nil))
1214 dired-use-ls-dired)
1217 ;; We used to specify the C locale here, to force English month names;
1218 ;; but this should not be necessary any more,
1219 ;; with the new value of `directory-listing-before-filename-regexp'.
1224 ;; Re-align fields, if necessary.
1227 ;; Quote certain characters, unless ls quoted them for us.
1236 nil t))
1242 nil t))
1244 ;; Replace any newlines in DIR with literal "\n"s, for the sake
1245 ;; of the header line. To disambiguate a literal "\n" in the
1246 ;; actual dirname, we also replace "\" with "\\".
1247 ;; Personally, I think this should always be done, irrespective
1248 ;; of the value of dired-actual-switches, because:
1249 ;; i) Dired simply does not work with an unescaped newline in
1250 ;; the directory name used in the header (bug=10469#28), and
1251 ;; ii) "\" is always replaced with "\\" in the listing, so doing
1252 ;; it in the header as well makes things consistent.
1253 ;; But at present it is only done if "-b" is in ls-switches,
1254 ;; because newlines in dirnames are uncommon, and people may
1255 ;; have gotten used to seeing unescaped "\" in the headers.
1256 ;; Note: adjust dired-build-subdir-alist if you change this.
1259 ;; If we used --dired and it worked, the lines are already indented.
1260 ;; Otherwise, indent them.
1266 ;; Insert text at the beginning to standardize things.
1273 ;; Note that dired-build-subdir-alist will replace the name
1274 ;; by its expansion, so it does not matter whether what we insert
1275 ;; here is fully expanded, but it should be absolute.
1279 ;; Insert "wildcard" line where "total" line would be for a full dir.
1284 "Add various text properties to the lines in the region."
1303 highlight
1304 dired-filename t
1310 \f
1311 ;; Reverting a dired buffer
1314 "Reread the Dired buffer.
1315 Must also be called after `dired-actual-switches' have changed.
1316 Should not fail even on completely garbaged buffers.
1317 Preserves old cursor, marks/flags, hidden-p.
1319 Dired sets `revert-buffer-function' to this function. The args
1320 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1332 ;; treat top level dir extra (it may contain wildcards)
1339 ;; Run dired-after-readin-hook just once, below.
1344 ;; ... run the hook for the whole buffer, and only after markers
1345 ;; have been reinserted (else omitting in dired-x would omit marked files)
1353 ;; outside of the let scope
1354 ;;; Might as well not override the user if the user changed this.
1355 ;;; (setq buffer-read-only t)
1356 )
1358 ;; Subroutines of dired-revert
1359 ;; Some of these are also used when inserting subdirs.
1362 "Return current positions in the buffer and all windows with this directory.
1363 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1365 BUFFER-POSITION is the point position in the current Dired buffer.
1366 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1368 WINDOW-POSITIONS are current positions in all windows displaying
1369 this dired buffer. The window positions have the form (WINDOW
1370 DIRED-FILENAME WINDOW-POINT)."
1381 "Restore POSITIONS saved with `dired-save-positions'."
1389 ;; Ensure that window still displays the original buffer.
1398 "Return alist of files and their marks, from BEG to END."
1409 alist))
1412 "Mark all files remembered in ALIST.
1413 Each element of ALIST looks like (FILE . MARKERCHAR)."
1427 "Return a list of names of subdirs currently hidden."
1437 result))
1440 "Try to insert all subdirs that were displayed before.
1441 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1453 "Remove directory DIR from any directory cache."
1457 \f
1458 ;; dired mode key bindings and initialization
1461 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1462 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1467 ;; Commands to mark or flag certain categories of files
1471 ;; Upper case keys (except !) for operating on the marked files
1491 ;; Comparison commands
1493 ;; Tree Dired commands
1499 ;; move to marked files
1502 ;; Make all regexp commands share a `%' prefix:
1503 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1504 ;; but that seems to serve little purpose, and copy-keymap
1505 ;; does a better job without it.
1518 ;; Commands for marking and unmarking.
1535 ;; Lower keys for commands not operating on all the marked files
1561 ;; moving
1569 ;; hiding
1573 ;; isearch
1578 ;; misc
1580 ;; `toggle-read-only' is an obsolete alias for `read-only-mode'
1586 ;; thumbnail manipulation (image-dired)
1599 ;; encryption and decryption (epa-dired)
1605 ;; Make menu bar items.
1607 ;; No need to fo this, now that top-level items are fewer.
1608 ;;;;
1609 ;; Get rid of the Edit menu bar item to save space.
1610 ;(define-key map [menu-bar edit] 'undefined)
1723 ;; When running on plain MS-DOS, there's only one
1724 ;; letter-case for file names.
1912 map)
1914 \f
1915 ;; Dired mode is suitable only for specially formatted data.
1918 ;; Autoload cookie needed by desktop.el
1919 ;;;###autoload
1921 "\
1924 (optionally) its subdirectories, in the format of `ls -lR'.
1927 compress, load or byte-compile them, change their file attributes
1930 by file or all files matching certain criteria.
1932 The buffer is read-only. Digits are prefix arguments.
1935 Most commands operate on the marked files and use the current file
1936 if no files are marked. Use a numeric prefix argument to operate on
1937 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1938 to operate on the current file only. Prefix arguments override marks.
1940 to see why something went wrong.
1945 (or dired it in another buffer, if it is a directory).
1952 This retains all marks and hides subdirs again that were hidden before.
1953 Use `SPC' and `DEL' to move down and up by lines.
1956 to read the
1958 to relist the file at point or the marked files or a
1960 again for the directory tree.
1963 for more info):
1965 `dired-listing-switches'
1966 `dired-trivial-filenames'
1967 `dired-marker-char'
1968 `dired-del-marker'
1969 `dired-keep-marker-rename'
1970 `dired-keep-marker-copy'
1971 `dired-keep-marker-hardlink'
1972 `dired-keep-marker-symlink'
1976 `dired-before-readin-hook'
1977 `dired-after-readin-hook'
1978 `dired-mode-hook'
1979 `dired-load-hook'
1981 Keybindings:
1983 ;; Not to be called interactively (e.g. dired-directory will be set
1984 ;; to default-directory, which is wrong with wildcards).
1989 mode-name "Dired"
1990 ;; case-fold-search nil
1991 buffer-read-only t
1992 selective-display t ; for subdirectory hiding
1993 mode-line-buffer-identification
1995 ;; Ignore dired-hide-details-* value of invisible text property by default.
2002 ;; list-buffers uses this to display the dir being edited in this buffer.
2006 dired-directory)))
2020 \f
2021 ;; Idiosyncratic dired commands that don't deal with marks.
2024 "Summarize basic Dired commands and show recent Dired errors."
2027 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
2032 "Undo in a Dired buffer.
2033 This doesn't recover lost files, it just undoes changes in the buffer itself.
2034 You can use it to recover marks, killed lines or subdirs."
2043 "Edit Dired buffer with Wdired, or make it read-only.
2044 If the current buffer can be edited with Wdired, (i.e. the major
2045 mode is `dired-mode'), call `wdired-change-to-wdired-mode'.
2046 Otherwise, toggle `read-only-mode'."
2053 "Move down lines then position at filename.
2054 Optional prefix ARG says how many lines to move; default is one line."
2059 ;; We never want to move point into an invisible line.
2066 "Move up lines then position at filename.
2067 Optional prefix ARG says how many lines to move; default is one line."
2072 "Goto ARGth next directory file line."
2084 "Goto ARGth previous directory file line."
2089 "Run Dired on parent directory of current directory.
2090 Find the parent directory either in this buffer or another buffer.
2091 Creates a buffer if necessary.
2092 If OTHER-WINDOW (the optional prefix arg), display the parent
2093 directory in another window."
2098 ;; Only try dired-goto-subdir if buffer has more than one dir.
2108 "Get the current line's file name, with an error if file does not exist."
2110 ;; We pass t for second arg so that we don't get error for `.' and `..'.
2112 file-name)
2117 file-name
2122 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
2125 "In Dired, visit the file or directory named on this line."
2127 ;; Bind `find-file-run-dired' so that the command works on directories
2128 ;; too, independent of the user's setting.
2133 "In Dired, visit this file or directory instead of the Dired buffer."
2137 ;; Don't override the setting from .emacs.
2138 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
2141 "In Dired, visit the file or directory name you click on."
2162 "In Dired, examine a file in view mode, returning to Dired when done.
2163 When file is a directory, show it in this buffer if it is inserted.
2164 Otherwise, display it in another buffer."
2174 "In Dired, visit this file or directory in another window."
2179 "In Dired, display this file or directory in another window."
2182 t))
2183 \f
2184 ;;; Functions for extracting and manipulating file names in Dired buffers.
2187 "In Dired, return name of file mentioned on this line.
2188 Value returned normally includes the directory name.
2189 Optional arg LOCALP with value `no-dir' means don't include directory
2190 name in result. A value of `verbatim' means to return the name exactly as
2191 it occurs in the buffer, and a value of t means construct name relative to
2192 `default-directory', which still may contain slashes if in a subdirectory.
2193 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2194 regular filenames and return nil if no filename on this line.
2195 Otherwise, an error occurs in these cases."
2200 ;; nil if no file on this line, but no-error-if-not-filep is t:
2203 ;; Get rid of the mouse-face property that file names have.
2205 ;; Unquote names quoted by ls or by dired-insert-directory.
2206 ;; This code was written using `read' to unquote, because
2207 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2208 ;; char) etc. in a lisp loop. Unfortunately, this decision
2209 ;; has necessitated hacks such as dealing with filenames
2210 ;; with quotation marks in their names.
2213 ;; Unescape any spaces escaped by ls -b (bug#10469).
2214 ;; Other -b quotes, eg \t, \n, work transparently.
2232 ;; Hence we don't need to worry about converting `\\' back to `\'.
2234 ;; The above `read' will return a unibyte string if FILE
2235 ;; contains eight-bit-control/graphic characters.
2240 ;; A relative file name can start with ~.
2241 ;; Don't treat it as absolute in this context.
2246 nil)
2248 file)
2256 ;; check for safe-magic property so that we won't
2257 ;; put /: for names that don't really need them.
2258 ;; For instance, .gz files when auto-compression-mode is on.
2261 file)))
2263 file)
2267 ;; check for safe-magic property so that we won't
2268 ;; put /: for names that don't really need them.
2269 ;; For instance, .gz files when auto-compression-mode is on.
2272 file)))
2278 "Replace first match of REGEXP in STRING with NEWTEXT.
2279 If it does not match, nil is returned instead of the new string.
2280 Optional arg LITERAL means to take NEWTEXT literally.
2281 Optional arg GLOBAL means to replace all matches."
2288 ret)
2290 nil
2294 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2295 ;; We can't always use expand-file-name as this would get rid of `.'
2296 ;; or expand in / instead default-directory if DIR=="".
2297 ;; This should be good enough for ange-ftp.
2298 ;; It should be reasonably fast, though, as it is called in
2299 ;; dired-get-filename.
2303 "Convert FILE (an absolute file name) to a name relative to DIR.
2304 If DIR is omitted or nil, it defaults to `default-directory'.
2305 If FILE is not in the directory tree of DIR, return FILE
2306 unchanged."
2308 ;; This case comes into play if default-directory is set to
2309 ;; use ~.
2314 file))
2315 \f
2317 "Toggle visibility of detailed information in current Dired buffer.
2318 When this minor mode is enabled, details such as file ownership and
2319 permissions are hidden from view.
2321 See options: `dired-hide-details-hide-symlink-targets' and
2322 `dired-hide-details-hide-information-lines'."
2329 'dired-hide-details-update-invisibility-spec
2330 nil
2331 t)
2333 'dired-hide-details-update-invisibility-spec
2334 t)))
2338 'add-to-invisibility-spec
2342 dired-hide-details-hide-information-lines)
2343 'add-to-invisibility-spec
2347 dired-hide-details-hide-symlink-targets
2349 'add-to-invisibility-spec
2352 \f
2353 ;;; Functions for finding the file name in a dired buffer line.
2359 ;; Move to first char of filename on this line.
2360 ;; Returns position (point) or nil if no filename on this line."
2362 "Move to the beginning of the filename on the current line.
2363 Return the position of the beginning of the filename, or nil if none found."
2364 ;; This is the UNIX version.
2367 ;; First try assuming `ls --dired' was used.
2375 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2379 nil)
2384 ;; Assumes point is at beginning of filename,
2385 ;; thus the rwx bit re-search-backward below will succeed in *this*
2386 ;; line if at all. So, it should be called only after
2387 ;; (dired-move-to-filename t).
2388 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2389 ;; This is the UNIX version.
2399 nil
2401 ;; Restrict perm bits to be non-blank,
2402 ;; otherwise this matches one char to early (looking backward):
2403 ;; "l---------" (some systems make symlinks that way)
2404 ;; "----------" (plain file with zero perms)
2406 dired-permission-flags-regexp nil t)
2409 ;; Only with -F we need to know whether it's an executable
2411 used-F
2419 ;; Move point to end of name:
2425 dired-ls-F-marks-symlinks
2429 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2430 ;; one trailing character. (Executable bits on symlinks ain't mean
2431 ;; a thing, even to ls, but we know it's not a symlink.)
2434 executable)
2443 nil
2446 \f
2447 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2450 "Copy names of marked (or next ARG) files into the kill ring.
2451 The names are separated by a space.
2452 With a zero prefix arg, use the absolute file name of each marked file.
2454 `default-directory'. (This still may contain slashes if in a subdirectory.)
2456 If on a subdir headerline, use absolute subdirname instead;
2457 prefix arg and marked files are ignored in this case.
2480 \f
2481 ;; Keeping Dired buffers in sync with the filesystem and with each other
2484 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2485 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2486 ;; matches FILE.
2487 ;; The list is in reverse order of buffer creation, most recent last.
2488 ;; As a side effect, killed dired buffers for DIR are removed from
2489 ;; dired-buffers.
2496 ;; Buffer is killed - clean up:
2504 dired-directory)))
2507 file)))
2511 result))
2514 "Convert glob-pattern PATTERN to a regular expression."
2516 regexp)
2528 ;; Fails to handle ^ yet ????
2542 regexp
2550 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2551 ;; With wildcards we actually advertise too much.
2554 t ; we have already advertised ourselves
2557 dired-buffers)))))
2560 ;; Remove DIR from the buffer alist in variable dired-buffers.
2561 ;; This has the effect of removing any buffer whose main directory is DIR.
2562 ;; It does not affect buffers in which DIR is a subdir.
2563 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2566 \f
2567 ;; Tree Dired
2569 ;;; utility functions
2572 ;;"Is FILE part of the directory tree starting at DIR?"
2577 ;; Prepend default-directory to DIR if relative file name.
2578 ;; dired-get-filename must be able to make a valid file name from a
2579 ;; file and its directory DIR.
2582 dir
2586 ;;"Return the subdir name on this line, or nil if not on a headerline."
2587 ;; Look up in the alist whether this is a headerline.
2593 dired-subdir-alist))))
2594 cur-dir))))
2596 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2610 ;; Return an index into alist for use with nth
2611 ;; for the sake of subdir moving commands.
2620 "Go to next subdirectory, regardless of level."
2621 ;; Use 0 arg to go to this directory's header line.
2622 ;; NO-SKIP prevents moving to end of header line, returning whatever
2623 ;; position was found in dired-subdir-alist.
2626 pos index)
2627 ;; nth with negative arg does not return nil but the first element
2637 nil ; return nil if not found
2641 "Build `dired-subdir-alist' by parsing the buffer.
2642 Returns the new value of the alist.
2643 If optional arg SWITCHES is non-nil, use its value
2644 instead of `dired-actual-switches'."
2652 new-dir-name
2654 ;; Used to expand subdirectory names correctly in recursive
2655 ;; ange-ftp listings.
2662 ;; Avoid taking a file name ending in a colon
2663 ;; as a subdir name.
2673 new-dir-name
2684 ;; Undo any escaping of newlines and \ by dired-insert-directory.
2685 ;; Convert "n" preceded by odd number of \ to newline, and \\ to \.
2693 temp nil)
2697 temp nil))
2700 temp nil))))
2701 new-dir-name)
2704 ;; Place a sub directory boundary between lines.
2711 ;; We don't need to sort it because it is in buffer order per
2712 ;; constructionem. Return new alist:
2713 dired-subdir-alist))
2716 ;; Add new DIR at NEW-MARKER. Don't sort.
2719 dired-subdir-alist)))
2722 ;; Position point on first nontrivial file after point.
2738 "Go to line describing file FILE in this Dired buffer."
2739 ;; Return value of point on success, else nil.
2740 ;; FILE must be an absolute file name.
2741 ;; Loses if FILE contains control chars like "\007" for which ls
2742 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2743 ;; it in the buffer.
2756 ;; First, look for a listing under the absolute name.
2760 ;; Next, look for it as a relative name with leading
2761 ;; subdirectories. (This happens in Dired buffers
2762 ;; created by find-dired, for example.)
2766 default-directory)
2768 ;; Otherwise, look for it as a relative name, a base
2769 ;; name only. The hair is to get the result of
2770 ;; `dired-goto-subdir' without calling it if we don't
2771 ;; have any subdirs.
2778 file
2780 ;; Return buffer position, if found.
2785 "Advance to the Dired listing labeled by FILE; return its position.
2786 Return nil if the listing is not found. If FILE contains
2787 characters that would not appear in a Dired buffer, search using
2788 the quoted forms of those characters.
2790 FULL-NAME specifies the actual file name the listing must have,
2791 as returned by `dired-get-filename'. LIMIT is the search limit."
2797 ;; FIXME: to fix this for embedded control characters etc, we
2798 ;; should escape everything that `ls -b' does.
2803 ;; filenames are preceded by SPC, this makes the search faster
2804 ;; (e.g. for the filename "-").
2808 ;; Check that we are in the right place. Match could have
2809 ;; BASE just as initial substring or in permission bits etc.
2813 found)))
2817 ;; FIXME document whatever dired-x is doing.
2819 "Where point should go in a new listing of DIRNAME.
2820 Point is assumed to be at the beginning of new subdir line.
2821 It runs the hook `dired-initial-position-hook'."
2827 \f
2828 ;; These are hooks which make tree dired work.
2829 ;; They are in this file because other parts of dired need to call them.
2830 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2832 ;; This function is called for each retrieved filename.
2833 ;; It could stand to be faster, though it's mostly function call
2834 ;; overhead. Avoiding the function call seems to save about 10% in
2835 ;; dired-get-filename. Make it a defsubst?
2837 "Return the name of the subdirectory to which this line belongs.
2838 This returns a string with trailing slash, like `default-directory'.
2839 Optional argument means return a file name relative to `default-directory',
2840 in which case the value could be an empty string if `default-directory'
2841 is the directory where the file on this line resides."
2844 ;; probably because called in a non-dired buffer
2846 elt dir)
2850 ;; use `<=' (not `<') as subdir line is part of subdir
2852 nil ; found
2856 dir)))
2858 ;; Subdirs start at the beginning of their header lines and end just
2859 ;; before the beginning of the next header line (or end of buffer).
2866 \f
2867 ;; Deleting files
2870 "Whether Dired deletes directories recursively.
2871 If nil, Dired will not delete non-empty directories.
2872 `always' means to delete non-empty directories recursively,
2873 without asking. This is dangerous!
2874 `top' means to ask for each top-level directory specified by the
2875 Dired deletion command, and delete its subdirectories without
2876 asking.
2877 Any other value means to ask for each directory."
2885 ;; Match anything but `.' and `..'.
2888 ;; Delete file, possibly delete a directory and all its files.
2889 ;; This function is useful outside of dired. One could change its name
2890 ;; to e.g. recursive-delete-file and put it somewhere else.
2892 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2893 RECURSIVE determines what to do with a non-empty directory. The effect of
2894 its possible values is:
2896 nil -- do not delete.
2897 `always' -- delete recursively without asking.
2898 `top' -- ask for each directory at top level.
2899 Anything else -- ask for each sub-directory.
2901 TRASH non-nil means to trash the file instead of deleting, provided
2902 `delete-by-moving-to-trash' (which see) is non-nil."
2903 ;; This test is equivalent to
2904 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2905 ;; but more efficient
2913 delete-by-moving-to-trash)
2914 "trash"
2922 "In Dired, delete the files flagged for deletion.
2923 If NOMESSAGE is non-nil, we don't display any message
2924 if there are no flagged files.
2925 `dired-recursive-deletes' controls whether deletion of
2926 non-empty directories is allowed."
2930 case-fold-search)
2934 ;; this can't move point since ARG is nil
2936 nil)
2937 nil t)
2942 "Delete all marked (or next ARG) files.
2943 `dired-recursive-deletes' controls whether deletion of
2944 non-empty directories is allowed."
2945 ;; This is more consistent with the file marking feature than
2946 ;; dired-do-flagged-delete.
2949 ;; this may move point if ARG is an integer
2951 arg)
2952 arg t))
2957 ;; L is an alist of files to delete, with their buffer positions.
2958 ;; ARG is the prefix arg.
2959 ;; Filenames are absolute.
2960 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2961 ;; That way as changes are made in the buffer they do not shift the
2962 ;; lines still to be changed, so the (point) values in L stay valid.
2963 ;; Also, for subdirs in natural order, a subdir's files are deleted
2964 ;; before the subdir itself - the other way around would not work.
2969 ;; canonicalize file list for pop up
2980 succ count))
2988 ;; if we get here, removing worked
3004 failures))))
3009 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
3010 ;; If the buffer has a wildcard pattern, check that it matches FILE.
3011 ;; (FILE does not include a directory component.)
3012 ;; FILE may be nil, in which case ignore it.
3013 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
3016 file))
3020 success-list))
3022 ;; Delete the entry for FILE from
3034 "Clean up after a deleted file or directory FN.
3035 Removes any expanded subdirectory of deleted directory.
3036 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
3037 also offers to kill buffers visiting deleted files and directories."
3041 ;; Offer to kill buffer of deleted file FN.
3057 \f
3058 ;; Confirmation
3067 "Return a string suitable for use in a Dired prompt.
3068 ARG is normally the prefix argument for the calling command.
3069 FILES should be a list of file names.
3073 ;; distinguish-one-marked can cause the first element to be just t.
3078 ;; more than 1 file:
3080 ;; abs(arg) = count
3081 ;; Perhaps this is nicer, but it also takes more screen space:
3082 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
3083 ;; count)
3088 "Pop up buffer BUF in a way suitable for Dired."
3094 ;; Try to split the selected window vertically if
3095 ;; that's possible. (Bug#1806)
3097 ;; Otherwise, try to split WINDOW sensibly.
3099 pop-up-frames)
3101 ;; See Bug#12281.
3103 ;; If dired-shrink-to-fit is t, make its window fit its contents.
3105 ;; Try to not delete window when we want to display less than
3106 ;; `window-min-height' lines.
3110 "A list of symbols for commands Dired should not confirm, or t.
3111 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
3112 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
3113 `touch' and `uncompress'.
3114 If t, confirmation is never needed."
3125 "Return FUNCTION's result on ARGS after showing which files are marked.
3126 Displays the file names in a window showing a buffer named
3128 window is not shown if there is just one file, `dired-no-confirm'
3129 is t, or OP-SYMBOL is a member of the list in `dired-no-confirm'.
3131 By default, Dired shrinks the display buffer to fit the marked files.
3132 To disable this, use the Customization interface to add a new rule
3134 action argument symbol is `window-height' and its value is nil.
3136 FILES is the list of marked files. It can also be (t FILENAME)
3137 in the case of one marked file, to distinguish that from using
3138 just the current file.
3140 FUNCTION should not manipulate files, just read input (an
3141 argument or confirmation)."
3144 ;; If FILES defaulted to the current line's file.
3148 ;; Mark *Marked Files* window as softly-dedicated, to prevent
3149 ;; other buffers e.g. *Completions* from reusing it (bug#17554).
3152 buffer
3162 ;; Handle (t FILE) just like (FILE), here. That value is
3163 ;; used (only in some cases), to mean just one file that was
3164 ;; marked, rather than the current line file.
3175 \f
3176 ;; Commands to mark or flag file(s) at or near current line.
3179 ;; This version skips non-file lines.
3190 ;; Advance to the next line--actually, to the line that *was* next.
3191 ;; (If FUNCTION inserted some new lines in between, skip them.)
3203 ;; This used to be a regexp match of the `total ...' line output by
3204 ;; ls, which is slightly faster, but that is not very robust; notably,
3205 ;; it fails for non-english locales.
3209 "Move to the next marked file.
3210 If WRAP is non-nil, wrap around to the beginning of the buffer if
3211 we reach the end."
3228 "Move to the previous marked file.
3229 If WRAP is non-nil, wrap around to the end of the buffer if we
3230 reach the beginning of the buffer."
3235 ;; Return FILE's marker, or nil if unmarked.
3249 ;; Skip subdir line and following garbage like the `total' line:
3260 "Mark the file at point in the Dired buffer.
3261 If the region is active, mark all files in the region.
3262 Otherwise, with a prefix arg, mark files on the next ARG lines.
3264 If on a subdir headerline, mark all its files except `.' and `..'.
3268 this subdir."
3271 ;; Mark files in the active region.
3279 ;; Mark subdir files from the subdir headerline.
3282 ;; Mark the current (or next ARG) files.
3290 "Unmark the file at point in the Dired buffer.
3291 If the region is active, unmark all files in the region.
3292 Otherwise, with a prefix arg, unmark files on the next ARG lines.
3294 If looking at a subdir, unmark all its files except `.' and `..'.
3295 If the region is active in Transient Mark mode, unmark all files
3296 in the active region."
3302 "In Dired, flag the current line's file for deletion.
3303 If the region is active, flag all files in the region.
3304 Otherwise, with a prefix arg, flag files on the next ARG lines.
3306 If on a subdir headerline, flag all its files except `.' and `..'.
3307 If the region is active in Transient Mark mode, flag all files
3308 in the active region."
3314 "In Dired, move up lines and remove marks or deletion flags there.
3315 Optional prefix ARG says how many lines to unmark/unflag; default
3316 is one line.
3317 If the region is active in Transient Mark mode, unmark all files
3318 in the active region."
3323 "Toggle marks: marked files become unmarked, and vice versa.
3324 Files marked with other flags (such as `D') are not affected.
3325 `.' and `..' are never toggled.
3326 As always, hidden subdirs are not affected."
3334 ;; use subst instead of insdel because it does not move
3335 ;; the gap and thus should be faster and because
3336 ;; other characters are left alone automatically
3343 \f
3344 ;;; Commands to mark or flag files based on their characteristics or names.
3350 "Read a regexp using `read-regexp'."
3355 "Mark all files matching REGEXP for use in later commands.
3356 A prefix argument means to unmark them instead.
3357 `.' and `..' are never marked.
3360 object files--just `.o' will mark more than you might think."
3375 "Mark all files with contents containing REGEXP for use in later commands.
3376 A prefix argument means to unmark them instead.
3377 `.' and `..' are never marked.
3379 Note that if a file is visited in an Emacs buffer, and
3380 `dired-always-read-filesystem' is nil, this command will
3381 look in the buffer without revisiting the file, so the results might
3382 be inconsistent with the file on disk if its contents has changed
3383 since it was last visited."
3398 ;; For now we do it inside emacs
3399 ;; Grep might be better if there are a lot of files
3409 )))
3413 "In Dired, flag all files containing the specified REGEXP for deletion.
3414 The match is against the non-directory part of the filename. Use `^'
3415 and `$' to anchor matches. Exclude subdirs by hiding them.
3416 `.' and `..' are never flagged."
3422 "Mark all symbolic links.
3423 With prefix argument, unmark or unflag all those files."
3429 "Mark all directory file lines except `.' and `..'.
3430 With prefix argument, unmark or unflag all those files."
3438 "Mark all executable files.
3439 With prefix argument, unmark or unflag all those files."
3444 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3445 ;; files for which PREDICATE returns non-nil.
3448 "Flag for deletion files whose names suggest they are auto save files.
3449 A prefix argument says to unmark or unflag those files instead."
3453 ;; It is less than general to check for # here,
3454 ;; but it's the only way this runs fast enough.
3458 ;; Handle executables in case of -F option.
3459 ;; We need not worry about the other kinds
3460 ;; of markings that -F makes, since they won't
3461 ;; appear on real auto-save files.
3473 ;; `log' here is dubious, since it's typically used for useful log
3474 ;; files, not just TeX stuff. -- fx
3483 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3488 "Flag all backup files (names ending with `~') for deletion.
3489 With prefix argument, unmark or unflag these files."
3493 ;; Don't call backup-file-name-p unless the last character looks like
3494 ;; it might be the end of a backup file name. This isn't very general,
3495 ;; but it's the only way this runs fast enough.
3497 ;; Handle executables in case of -F option.
3498 ;; We need not worry about the other kinds
3499 ;; of markings that -F makes, since they won't
3500 ;; appear on real backup files.
3510 "Change all OLD marks to NEW marks.
3511 OLD and NEW are both characters used to mark files."
3528 t)
3533 "Remove all marks from all files in the Dired buffer."
3537 ;; Bound in dired-unmark-all-files
3541 "Remove a specific mark (or any mark) from every file.
3542 After this command, type the mark character to remove,
3543 or type RET to remove all marks.
3544 With prefix arg, query for each marked file.
3550 dired-unmark-all-files-query
3553 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3563 "Unmark file `%s'? "
3564 file))))
3570 count))))
3571 \f
3572 ;; Logging failures operating on files, and showing the results.
3577 "Pop up a buffer with error log output from Dired.
3578 A group of errors from a single command ends with a formfeed.
3594 ;; Log a message or the contents of a buffer.
3595 ;; If LOG is a string and there are more args, it is formatted with
3596 ;; those ARGS. Usually the LOG string ends with a \n.
3597 ;; End each bunch of errors with (dired-log t):
3598 ;; this inserts the current time and buffer at the start of the page,
3599 ;; and \f (formfeed) at the end.
3607 log)))
3620 "State a summary of a command's failures, in echo area and log buffer.
3621 STRING is an overall summary of the failures.
3622 FAILURES is a list of file names that we failed to operate on,
3623 or nil if file names are not applicable."
3633 string failures))
3634 ;; Log a summary describing a bunch of errors.
3637 \f
3638 ;;; Sorting
3640 ;; Most ls can only sort by name or by date (with -t), nothing else.
3641 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3642 ;; So anything that does not contain these is sort "by name".
3647 This indicates to Dired which option switches to watch out for because they
3648 will change the sorting order behavior of `ls'.
3650 To change the default sorting order (e.g. add a `-v' option), see the
3651 variable `dired-listing-switches'. To temporarily override the listing
3656 ;; `dired-ls-sorting-switches' after -t overrides -t.
3668 "Non-nil means the Dired sort command is disabled.
3672 ;; Set mode line display according to dired-actual-switches.
3673 ;; Mode line display of "by name" or "by date" guarantees the user a
3674 ;; match with the corresponding regexps. Non-matching switches are
3675 ;; shown literally.
3680 dired-sort-by-name-regexp dired-actual-switches)
3683 dired-sort-by-date-regexp dired-actual-switches)
3693 "Toggle sorting by date, and refresh the Dired buffer.
3694 With a prefix argument, edit the current listing switches instead."
3704 ;; Toggle between sort by date/name. Reverts the buffer.
3706 dired-actual-switches))
3707 ;; Regexp for finding (possibly embedded) -t switches.
3709 case-fold-search)
3710 ;; Remove the -t switch.
3714 ;; Remove a stand-alone -t switch.
3717 ;; Remove a switch of the form -XtY for some X and Y.
3721 ;; Now, if we weren't sorting by date before, add the -t switch.
3722 ;; Some simple-minded ls implementations (eg ftp servers) only
3723 ;; allow a single option string, so try not to add " -t" if possible.
3728 dired-actual-switches)
3729 "t"
3734 ;; Some user code loads dired especially for this.
3735 ;; Don't do that--use replace-regexp-in-string instead.
3737 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3738 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3744 start me))
3748 "Specify new `ls' SWITCHES for current Dired buffer.
3749 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3750 set the minor mode accordingly, others appear literally in the mode line.
3751 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3761 "Additional processing of -R in ls option string SWITCHES.
3762 Saves `dired-subdir-alist' when R is set and restores saved value
3763 minus any directories explicitly deleted when R is cleared.
3764 To be called first in body of `dired-sort-other', etc."
3768 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3772 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3773 ;; that are still present:
3779 dired-subdir-alist)
3780 ;; subdir still present...
3783 subdirs)))
3787 ;; No pre-R subdir alist, so revert to main directory
3788 ;; listing:
3790 \f
3792 ;;;; Drag and drop support
3795 "Whether Dired copies directories recursively.
3796 If nil, never copy recursively.
3797 `always' means to copy recursively without asking.
3798 `top' means to ask for each directory at top level.
3799 Any other value means to ask for each directory."
3814 ;; No need to get actions and descriptions from the source,
3815 ;; we only have three actions anyway.
3817 t
3823 "--"
3827 nil)))
3832 ;; Only used when (featurep 'dnd).
3839 "Copy, move or link a file to the Dired directory.
3840 URI is the file to handle, ACTION is one of copy, move, link or ask.
3841 Ask means pop up a menu for the user to select one of copy, move or link."
3850 ;; If copying a directory and dired-recursive-copies is
3851 ;; nil, dired-copy-file fails. Pop up a notice.
3861 ;; Binding dired-overwrite-confirmed to nil makes
3862 ;; dired-handle-overwrite a no-op. We instead use
3863 ;; y-or-n-p, which pops a graphical menu.
3864 dired-overwrite-confirmed backup-file)
3866 ;; d-b-o is defined in dired-aux.
3868 dired-backup-overwrite
3884 action))))))
3887 "Copy, move or link a file to the Dired directory if it is a local file.
3888 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3889 ACTION is one of copy, move, link or ask.
3890 Ask means pop up a menu for the user to select one of copy, move or link."
3893 nil)))
3894 \f
3896 ;;;; Desktop support
3902 "Auxiliary information to be saved in desktop file."
3904 ;; Value of `dired-directory'.
3906 ;; Directory name followed by list of files.
3909 ;; Directory name, optionally with shell wildcard.
3911 ;; Subdirectories in `dired-subdir-alist'.
3916 dired-subdir-alist)))))
3919 _buffer-name
3920 misc-data)
3921 "Restore a Dired buffer specified in a desktop file."
3922 ;; First element of `misc-data' is the value of `dired-directory'.
3923 ;; This value is a directory name, optionally with shell wildcard or
3924 ;; a directory name followed by list of files.
3930 ;; The following elements of `misc-data' are the keys
3931 ;; from `dired-subdir-alist'.
3936 nil)))
3945 ;;; dired.el ends here