| blob | f627fc1246f1f9c404b33f172ef0a12dd4640132 |
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985-1986, 1992, 1994, 1998, 2000-2015 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 ;; The parts of dired mode not normally used. This is a space-saving hack
29 ;; to avoid having to load a large mode when all that's wanted are a few
30 ;; functions.
32 ;; Rewritten in 1990/1991 to add tree features, file marking and
33 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
34 ;; Finished up by rms in 1992.
36 ;;; Code:
38 ;; We need macros in dired.el to compile properly,
39 ;; and we call subroutines in it too.
43 "Variable where `dired-create-files' records failing file names.
44 Functions that operate recursively can store additional names
47 ;;; 15K
48 ;;;###begin dired-cmd.el
49 ;; Diffing and compressing
54 ;;;###autoload
56 "Compare file at point with file FILE using `diff'.
57 If called interactively, prompt for FILE. If the file at point
58 has a backup file, use that as the default. If the file at point
59 is a backup file, use its original. If the mark is active
60 in Transient Mark mode, use the file at the mark as the default.
64 FILE is the first file given to `diff'. The file at point
65 is the second file given to `diff'.
67 With prefix arg, prompt for second argument SWITCHES, which is
68 the string of command switches for the third argument of `diff'."
71 ;; Get the latest existing backup file or its original.
75 ;; Get the file at the mark.
81 ;; Use it as default if it's not the same as the current file,
82 ;; and the target dir is current or there is a default file.
86 default-file))
87 default-file))
100 target-dir default t))
104 diff-switches
118 ;;;###autoload
120 "Diff this file with its backup file or vice versa.
121 Uses the latest backup, if there are several numerical backups.
122 If this file is a backup, diff it with its original.
123 The backup file is the first file given to `diff'.
124 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
129 diff-switches
131 nil))
134 ;;;###autoload
136 "Mark files with different file attributes in two dired buffers.
137 Compare file attributes of files in the current directory
138 with file attributes in directory DIR2 using PREDICATE on pairs of files
139 with the same name. Mark files for which PREDICATE returns non-nil.
140 Mark files with different names if PREDICATE is nil (or interactively
141 with empty input at the predicate prompt).
143 PREDICATE is a Lisp expression that can refer to the following variables:
145 size1, size2 - file size in bytes
146 mtime1, mtime2 - last modification time in seconds, as a float
147 fa1, fa2 - list of file attributes
148 returned by function `file-attributes'
150 where 1 refers to attribute of file in the current dired buffer
151 and 2 to attribute of file in second dired buffer.
153 Examples of PREDICATE:
155 (> mtime1 mtime2) - mark newer files
156 (not (= size1 size2)) - mark files with different sizes
157 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
158 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
159 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
170 target-dir target-dir t)))
175 file-list1 file-list2)
181 'cadr
183 file-alist1 file-alist2
184 predicate))
186 'cadr
188 file-alist2 file-alist1
189 predicate)))
191 dir1 nil
196 dir2 nil
205 "Combine LIST1 and LIST2 using a set-difference operation.
206 The result list contains all file items that appear in LIST1 but not LIST2.
207 This is a non-destructive function; it makes a copy of the data if necessary
208 to avoid corrupting the original LIST1 and LIST2.
209 PREDICATE (see `dired-compare-directories') is an additional match
210 condition. Two file items are considered to match if they are equal
211 *and* PREDICATE evaluates to t."
213 list1
229 list)
234 "Return a list of all file names and attributes from DIR.
235 List has a form of (file-name full-file-name (attribute-list))."
240 full-file-name
243 \f
244 ;;; Change file attributes
247 ;; Change file attributes (group, owner, timestamp) of marked files and
248 ;; refresh their file lines.
249 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
250 ;; PROGRAM is the program used to change the attribute.
251 ;; OP-SYMBOL is the type of operation (for use in `dired-mark-pop-up').
252 ;; ARG describes which files to use, as in `dired-get-marked-files'.
254 ;; The source of default file attributes is the file at point.
259 "%Y%m%d%H%M.%S"
267 " (default now): "
270 arg files default
276 failures)
283 ;; Use `eq' instead of `equal'
284 ;; to detect empty input (bug#12399).
291 files))
296 nil))))
298 ;;;###autoload
300 "Change the mode of the marked (or next ARG) files.
301 Symbolic modes like `g+w' are allowed.
302 Type M-n to pull the file attributes of the file at point
303 into the minibuffer."
306 ;; The source of default file attributes is the file at point.
320 "Change mode of %s to: "
322 num-modes)
324 ;; Use `eq' instead of `equal'
325 ;; to detect empty input (bug#12399).
327 ;; We used to treat empty input as DEFAULT, but that is not
328 ;; such a good idea (Bug#9361).
335 file
340 ;;;###autoload
342 "Change the group of the marked (or next ARG) files.
343 Type M-n to pull the file attributes of the file at point
344 into the minibuffer."
350 ;;;###autoload
352 "Change the owner of the marked (or next ARG) files.
353 Type M-n to pull the file attributes of the file at point
354 into the minibuffer."
360 ;;;###autoload
362 "Change the timestamp of the marked (or next ARG) files.
363 This calls touch.
364 Type M-n to pull the file attributes of the file at point
365 into the minibuffer."
369 ;; Process all the files in FILES in batches of a convenient size,
370 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
371 ;; Batches are chosen to need less than MAX chars for the file names,
372 ;; allowing 3 extra characters of separator per file name.
375 past
377 failures)
378 ;; Accumulate files as long as they fit in MAX chars,
379 ;; then process the ones accumulated so far.
384 ;; If we have at least 1 pending file
385 ;; and this file won't fit in the length limit, process now.
388 ;; The elements of PENDING are now in forward order.
389 ;; Do the operation and record failures.
391 failures)
392 ;; Transfer the elements of PENDING onto PAST
393 ;; and clear it out. Now PAST contains the first N files
394 ;; specified (for some N), and FILES contains the rest.
396 pending nil
398 ;; Do (setq pending (cons thisfile pending))
399 ;; but reuse the cons that was in `files'.
407 failures)
408 ;; Now the original list FILES has been put back as it was.
411 ;;;###autoload
413 "Print the marked (or next ARG) files.
414 Uses the shell command coming from variables `lpr-command' and
415 `lpr-switches' as default."
422 lpr-switches)
423 lpr-switches))
425 "Print %s with: "
430 lpr-switches))
437 "Read args for a Dired marked-files command, prompting with PROMPT.
438 Return the user input (a string).
440 INITIAL, if non-nil, is the initial minibuffer input.
441 OP-SYMBOL is an operation symbol (see `dired-no-confirm').
442 ARG is normally the prefix argument for the calling command;
443 it is passed as the first argument to `dired-mark-prompt'.
444 FILES should be a list of marked files' names.
446 Optional arg DEFAULT-VALUE is a default value or list of default
447 values, passed as the seventh arg to `completing-read'.
449 Optional arg COLLECTION is a collection of possible completions,
450 passed as the second arg to `completing-read'."
452 'completing-read
454 collection nil nil initial nil default-value nil))
455 \f
456 ;;; Cleaning a directory: flagging some backups for deletion.
460 ;;;###autoload
462 "Flag numerical backups for deletion.
463 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
464 Positive prefix arg KEEP overrides `dired-kept-versions';
465 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
468 with a prefix argument."
475 late-retention early-retention)
476 ;; Look at each file.
477 ;; If the file has numeric backup versions,
478 ;; put on dired-file-version-alist an element of the form
479 ;; (FILENAME . VERSION-NUMBER-LIST)
481 ;; Sort each VERSION-NUMBER-LIST,
482 ;; and remove the versions not to be deleted.
490 sorted-v-list)))
494 ;; Look at each file. If it is a numeric backup file,
495 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
499 ;;; Subroutines of dired-clean-directory.
502 ;; Perform FUN with point at the end of each non-directory line.
503 ;; FUN takes one argument, the absolute filename.
520 ;; Only do work if this file is not already in the alist.
522 nil
523 ;; If it looks like file FN has versions, return a list of the versions.
524 ;;That is a list of strings which are file names.
525 ;;The caller may want to flag some of these files for deletion.
530 base-versions
536 dired-file-version-alist)))))))
540 base-version-list)
550 \f
551 ;;; Shell commands
556 "Return a list of all commands associated with current dired files.
557 This function is used to add all related commands retrieved by `mailcap'
558 to the end of the list of defaults just after the default value."
566 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
568 "Read a dired shell command.
570 which is replaced by the value returned by `dired-mark-prompt',
571 with ARG and FILES as its arguments. FILES should be a list of
572 file names. The result is used as the prompt.
574 This normally reads using `read-shell-command', but if the
575 `dired-x' package is loaded, use `dired-guess-shell-command' to
576 offer a smarter default choice of shell command."
588 ;;;###autoload
590 "Run a shell command COMMAND on the marked files asynchronously.
592 Like `dired-do-shell-command', but adds `&' at the end of COMMAND
593 to execute it asynchronously.
595 When operating on multiple files, asynchronous commands
596 are executed in the background on each file in parallel.
597 In shell syntax this means separating the individual commands
598 with `&'. However, when COMMAND ends in `;' or `;&' then commands
599 are executed in the background on each file sequentially waiting
600 for each command to terminate before running the next command.
601 In shell syntax this means separating the individual commands with `;'.
603 The output appears in the buffer `*Async Shell Command*'."
607 ;; Want to give feedback whether this file or marked files are used:
609 current-prefix-arg
610 files)))
615 ;;;###autoload
617 "Run a shell command COMMAND on the marked files.
618 If no files are marked or a numeric prefix arg is given,
620 The prompt mentions the file(s) or the marker, as appropriate.
622 If there is a `*' in COMMAND, surrounded by whitespace, this runs
623 COMMAND just once with the entire file list substituted there.
625 If there is no `*', but there is a `?' in COMMAND, surrounded by
626 whitespace, this runs COMMAND on each file individually with the
627 file name substituted for `?'.
629 Otherwise, this runs COMMAND on each file individually with the
630 file name added at the end of COMMAND (separated by a space).
632 `*' and `?' when not surrounded by whitespace have no special
633 significance for `dired-do-shell-command', and are passed through
634 normally to the shell, but you must confirm first.
636 If you want to use `*' as a shell wildcard with whitespace around
638 `*' in the shell, but avoids Dired's special handling.
640 If COMMAND ends in `&', `;', or `;&', it is executed in the
641 background asynchronously, and the output appears in the buffer
642 `*Async Shell Command*'. When operating on multiple files and COMMAND
643 ends in `&', the shell command is executed on each file in parallel.
644 However, when COMMAND ends in `;' or `;&' then commands are executed
645 in the background on each file sequentially waiting for each command
646 to terminate before running the next command. You can also use
647 `dired-do-async-shell-command' that automatically adds `&'.
649 Otherwise, COMMAND is executed synchronously, and the output
650 appears in the buffer `*Shell Command Output*'.
652 This feature does not try to redisplay Dired buffers afterward, as
653 there's no telling what files COMMAND may have changed.
656 When COMMAND runs, its working directory is the top-level directory
657 of the Dired buffer, so output files usually are created there
658 instead of in a subdir.
660 In a noninteractive call (from Lisp code), you must specify
661 the list of file names explicitly with the FILE-LIST argument, which
662 can be produced by `dired-get-marked-files', for example."
663 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
664 ;;actual work and can be redefined for customization.
668 ;; Want to give feedback whether this file or marked files are used:
670 current-prefix-arg
671 files)))
676 ;; Get confirmation for wildcards that may have been meant
677 ;; to control substitution of a file name or the file name list.
691 nil
692 file-list)
693 ;; execute the shell command
697 ;; Might use {,} for bash or csh:
706 ;; "Make up a shell command line from COMMAND and FILE-LIST.
707 ;; If ON-EACH is t, COMMAND should be applied to each file, else
708 ;; simply concat all files and apply COMMAND to this.
709 ;; FILE-LIST's elements will be quoted for the shell."
710 ;; Might be redefined for smarter things and could then use RAW-ARG
711 ;; (coming from interactive P and currently ignored) to decide what to do.
712 ;; Smart would be a way to access basename or extension of file names.
716 command))
720 command))
729 retval))
736 file-list dired-mark-separator)))
742 ;; This is an extra function so that it can be redefined by ange-ftp.
743 ;;;###autoload
750 ;; Return nil for sake of nconc in dired-bunch-files.
751 nil)
752 \f
755 ; "Display MSG while running PROGRAM, and check for output.
756 ;Remaining arguments are strings passed as command arguments to PROGRAM.
757 ; On error, insert output
758 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
759 ; Caller can cons up a list of failed args.
760 ;Else returns nil for success."
764 ;; Get a clean buffer for error output:
777 nil))))
778 \f
779 ;; Commands that delete or redisplay part of the dired buffer.
782 "Kill the current line (not the files).
783 With a prefix argument, kill that many lines starting with the current line.
784 \(A negative argument kills backward.)"
803 ;;;###autoload
805 "Kill all marked lines (not the files).
806 With a prefix argument, kill that many lines starting with the current line.
807 \(A negative argument kills backward.)
808 If you use this command with a prefix argument to kill the line
809 for a file that is a directory, which you have inserted in the
810 Dired buffer as a subdirectory, then it deletes that subdirectory
811 from the buffer as well.
812 To kill an entire subdirectory \(without killing its line in the
813 parent directory), go to its directory header line and use this
814 command with a prefix argument (the value does not matter)."
815 ;; Returns count of killed lines. FMT="" suppresses message.
833 count))))
835 ;;;###end dired-cmd.el
836 \f
837 ;;; 30K
838 ;;;###begin dired-cp.el
841 ;; Compress or uncompress the current file.
842 ;; Return nil for success, offending filename else.
848 ;; Remove any preexisting entry for the name NEW-FILE.
851 ;; Now replace the current line with an entry for NEW-FILE.
854 from-file)))
860 ;; For .z, try gunzip. It might be an old gzip file,
861 ;; or it might be from compact? pack? (which?) but gunzip handles both.
867 ;; This item controls naming for compression.
869 "Control changes in file name suffixes for compression and uncompression.
870 Each element specifies one transformation rule, and has the form:
871 (REGEXP NEW-SUFFIX PROGRAM)
872 The rule applies when the old file name matches REGEXP.
873 The new file name is computed by deleting the part that matches REGEXP
874 (as well as anything after that), then adding NEW-SUFFIX in its place.
875 If PROGRAM is non-nil, the rule is an uncompression rule,
876 and uncompression is done by running PROGRAM.
879 ;;;###autoload
881 ;; Compress or uncompress FILE.
882 ;; Return the name of the compressed or uncompressed file.
883 ;; Return nil if no change in files.
885 suffix newname
887 ;; See if any suffix rule matches this file name.
893 ;; If so, compute desired new name.
900 nil)
902 ;; We found an uncompression rule.
905 newname))
907 ;;; We don't recognize the file as compressed, so compress it.
908 ;;; Try gzip; if we don't have that, use compress.
914 out-name)))
919 ;; Rename the compressed file to NEWNAME
920 ;; if it hasn't got that name already.
924 newname)
925 out-name)))
929 ;; Don't use NEWNAME with `compress'.
931 \f
933 ;; Request confirmation from the user that the operation described
934 ;; by OP-SYMBOL is to be performed on the marked files.
935 ;; Confirmation consists in a y-or-n question with a file list
936 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
937 ;; The files used are determined by ARG (as in dired-get-marked-files).
940 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
941 ;; is marked pops up a window. That will help the user see
942 ;; it isn't the current line file.
951 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
952 ; and display failures.
954 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
955 ; the short form of the filename) for a failure and probably logs a
956 ; detailed error explanation using function `dired-log'.
958 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
959 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
960 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
961 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
963 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
975 ;; end this bunch of errors:
979 failures)))))
981 ;;;###autoload
983 "Format PROMPT with ARGS, query user, and store the result in SYM.
984 The return value is either nil or t.
986 The user may type y or SPC to accept once; n or DEL to skip once;
987 ! to accept this and subsequent queries; or q or ESC to decline
988 this and subsequent queries.
990 If SYM is already bound to a non-nil value, this function may
991 return automatically without querying the user. If SYM is !,
992 return t; if SYM is q or ESC, return nil."
1009 \f
1010 ;;;###autoload
1012 "Compress or uncompress marked (or next ARG) files."
1016 ;; Commands for Emacs Lisp files - load and byte compile
1019 ;; Return nil for success, offending file name else.
1021 elc-file buffer-read-only failure)
1036 nil)))
1038 ;;;###autoload
1040 "Byte compile marked (or next ARG) Emacs Lisp files."
1045 ;; Return nil for success, offending file name else.
1051 nil
1055 ;;;###autoload
1057 "Load the marked (or next ARG) Emacs Lisp files."
1061 ;;;###autoload
1063 "Redisplay all marked (or next ARG) files.
1064 If on a subdir line, redisplay that subdirectory. In that case,
1065 a prefix arg lets you edit the `ls' switches used for the new listing.
1067 Dired remembers switches specified with a prefix arg, so that reverting
1068 the buffer will not reset them. However, using `dired-undo' to re-insert
1069 or delete subdirectories can bypass this machinery. Hence, you sometimes
1070 may have to reset some subdirectory switches after a `dired-undo'.
1071 You can reset all subdirectory switches to the default using
1073 See Info node `(emacs)Subdir switches' for more details."
1074 ;; Moves point if the next ARG files are redisplayed.
1080 dir
1084 dired-subdir-switches
1085 dired-actual-switches)))))
1087 ;; message much faster than making dired-map-over-marks show progress
1091 ;; Postpone readin hook till we map
1092 ;; over all marked files (Bug#6810).
1096 arg)
1102 "Set `dired-switches-alist' to nil and revert dired buffer."
1106 \f
1108 ;; Delete the current line, and insert an entry for FILE.
1109 ;; If FILE is nil, then just delete the current line.
1110 ;; Keeps any marks that may be present in column one (doing this
1111 ;; here is faster than with dired-add-entry's optional arg).
1112 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1120 ;; Replace space by old marker without moving point.
1121 ;; Faster than goto+insdel inside a save-excursion?
1125 ;;;###autoload
1136 "Add a new dired entry for FILENAME.
1137 Optionally mark it with MARKER-CHAR (a character, else uses
1138 `dired-marker-char'). Note that this adds the entry `out of order'
1139 if files are sorted by time, etc.
1140 Skips files that match `dired-trivial-filenames'.
1141 Exposes hidden subdirectories if a file is added there.
1143 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1144 files matching `dired-omit-regexp'."
1147 ;; Avoid calling ls for files that are going to be omitted anyway.
1153 filename)
1158 filename
1160 ;; Do it!
1163 ;; Entry is always for files, even if they happen to also be directories
1167 reason)
1172 reason
1179 ;; We are already where we should be, except when
1180 ;; point is before the subdir line or its total line.
1184 ;; else try to find correct place to insert
1188 ;; Point is at end of subdir line.
1190 ;; found - skip subdir and `total' line
1191 ;; and uninteresting files like . and ..
1192 ;; This better not move into the next subdir!
1194 ;; not found
1199 ;; Don't expand `.'.
1200 ;; Show just the file name within directory.
1203 directory
1207 ;; Put in desired marker char.
1211 dired-marker-char)))
1213 ;; Compensate for a bug in ange-ftp.
1214 ;; It inserts the file's absolute name, rather than
1215 ;; the relative one. That may be hard to fix since it
1216 ;; is probably controlled by something in ftp.
1232 ;; The subdir-alist is not affected...
1240 ;; return nil if all went well
1241 nil))
1245 ;; Don't do it (dired-omit-mode).
1246 ;; Return t for success (perhaps we should return file-exists-p).
1247 t))
1250 ;; Return pos of first file line of DIR, skipping header and total
1251 ;; or wildcard lines.
1252 ;; Important: never moves into the next subdir.
1253 ;; DIR is assumed to be unhidden.
1262 ;;;###autoload
1275 ;;;###autoload
1277 "Create or update the line for FILE in all Dired buffers it would belong in."
1283 ;; Relist the line for FILE, or just add it if it did not exist.
1284 ;; FILE must be an absolute file name.
1286 ;; If cursor is already on FILE's line delete-region will cause
1287 ;; save-excursion to fail because of floating makers,
1288 ;; moving point to beginning of line. Sigh.
1297 \f
1298 ;;; Copy, move/rename, making hard and symbolic links
1301 "Non-nil if Dired should ask about making backups before overwriting files.
1302 Special value `always' suppresses confirmation."
1308 ;; This is a fluid var used in dired-handle-overwrite. It should be
1309 ;; let-bound whenever dired-copy-file etc are called. See
1310 ;; dired-create-files for an example.
1314 ;; Save old version of file TO that is to be overwritten.
1315 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1316 ;; from dired-create-files.
1319 dired-overwrite-confirmed
1323 "Make backup for existing file `%s'? "
1324 to)))
1328 ;;;###autoload
1332 dired-recursive-copies))
1337 preserve-time top recursive)
1350 ;; It is a symlink
1355 dired-create-files-failures)
1358 ;;;###autoload
1362 ;; Silently rename the visited file of any buffer visiting this file.
1367 ;; See if it's an inserted subdir, and rename that, too.
1375 ;; Update visited file name of all affected buffers
1385 to-dir
1386 buffer-file-name)))
1392 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1393 ;; one of its subdirectories is expanded in this buffer.
1401 ;; ELT's subdir is affected by the rename
1404 ;; if top level directory was renamed, lots of things have to be
1405 ;; updated:
1410 ;; with and without wildcards
1412 to))
1415 ;; try to rename buffer, but just leave old name if new
1416 ;; name would already exist (don't try appending "<%d>")
1419 ;; ... we dired TO now:
1423 ;; Update the headerline and dired-subdir-alist element, as well as
1424 ;; dired-switches-alist element, of directory described by
1425 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1426 ;; describes either DIR itself or a subdir of DIR.
1430 buffer-read-only)
1432 ;; Update subdir headerline in buffer
1435 dir)
1440 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1446 \f
1447 ;; Bound in dired-create-files
1451 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1454 "Create one or more new files from a list of existing files FN-LIST.
1455 This function also handles querying the user, updating Dired
1456 buffers, and displaying a success or failure message.
1458 FILE-CREATOR should be a function. It is called once for each
1459 file in FN-LIST, and must create a new file, querying the user
1460 and updating Dired buffers as necessary. It should accept three
1461 arguments: the old file name, the new name, and an argument
1462 OK-IF-ALREADY-EXISTS with the same meaning as in `copy-file'.
1464 OPERATION should be a capitalized string describing the operation
1465 performed (e.g. `Copy'). It is used for error logging.
1467 FN-LIST is the list of files to copy (full absolute file names).
1469 NAME-CONSTRUCTOR should be a function accepting a single
1470 argument, the name of an old file, and returning either the
1471 corresponding new file name or nil to skip.
1473 If optional argument MARKER-CHAR is non-nil, mark each
1474 newly-created file's Dired entry with the character MARKER-CHAR,
1475 or with the current marker character if MARKER-CHAR is t."
1493 Type SPC or `y' to overwrite file `%s',
1494 DEL or `n' to skip to next,
1495 ESC or `q' to not overwrite any of the remaining files,
1499 ;; must determine if FROM is marked before file-creator
1500 ;; gets a chance to delete it (in case of a move).
1505 ;; Handle the `dired-copy-file' file-creator specially
1506 ;; When copying a directory to another directory or
1507 ;; possibly to itself or one of its subdirectories.
1508 ;; e.g "~/foo/" => "~/test/"
1509 ;; or "~/foo/" =>"~/foo/"
1510 ;; or "~/foo/ => ~/foo/bar/")
1511 ;; In this case the 'name-constructor' have set the destination
1512 ;; TO to "~/test/foo" because the old emacs23 behavior
1513 ;; of `copy-directory' was to not create the subdirectory
1514 ;; and instead copy the contents.
1515 ;; With the new behavior of `copy-directory'
1516 ;; (similar to the `cp' shell command) we don't
1517 ;; need such a construction of the target directory,
1518 ;; so modify the destination TO to "~/test/" instead of "~/test/foo/".
1524 ;; If DESTNAME is a subdirectory of FROM, not a symlink,
1525 ;; and the method in use is copying, signal an error.
1530 from to)))
1535 ;; If we get here, file-creator hasn't been aborted
1536 ;; and the old entry (if any) has to be deleted
1537 ;; before adding the new entry.
1545 failures)
1547 operation from to err))))))))
1555 total)
1556 failures))
1562 failures))
1568 skipped))
1573 \f
1575 &optional marker-char op1
1576 how-to)
1577 "Create a new file for each marked file.
1578 Prompt user for a target directory in which to create the new
1579 files. The target may also be a non-directory file, if only
1580 one file is marked. The initial suggestion for target is the
1581 Dired buffer's current directory (or, if `dired-dwim-target' is
1582 non-nil, the current directory of a neighboring Dired window).
1583 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1584 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1585 FILE-CREATOR and OPERATION as in `dired-create-files'.
1586 ARG as in `dired-get-marked-files'.
1587 Optional arg MARKER-CHAR as in `dired-create-files'.
1588 Optional arg OP1 is an alternate form for OPERATION if there is
1589 only one file.
1590 Optional arg HOW-TO determines how to treat the target.
1591 If HOW-TO is nil, use `file-directory-p' to determine if the
1592 target is a directory. If so, the marked file(s) are created
1593 inside that directory. Otherwise, the target is a plain file;
1594 an error is raised unless there is exactly one marked file.
1595 If HOW-TO is t, target is always treated as a plain file.
1596 Otherwise, HOW-TO should be a function of one argument, TARGET.
1597 If its return value is nil, TARGET is regarded as a plain file.
1598 If it return value is a list, TARGET is a generalized
1599 directory (e.g. some sort of archive). The first element of
1600 this list must be a function with at least four arguments:
1601 operation - as OPERATION above.
1602 rfn-list - list of the relative names for the marked files.
1603 fn-list - list of the absolute names for the marked files.
1604 target - the name of the target itself.
1605 The rest of into-dir are optional arguments.
1606 For any other return value, TARGET is treated as a directory."
1615 target-dir)))
1624 target-dir op-symbol arg rfn-list default))))
1626 ;; Allow DOS/Windows users to change the letter
1627 ;; case of a directory. If we don't test these
1628 ;; conditions up front, file-directory-p below
1629 ;; will return t because the filesystem is
1630 ;; case-insensitive, and Emacs will try to move
1631 ;; foo -> foo/foo, which fails.
1634 dired-one-file
1642 nil
1650 ;; rename-file bombs when moving directories unless we do this:
1653 file-creator operation fn-list
1655 ;; This function uses fluid variable target when called
1656 ;; inside dired-create-files:
1661 marker-char))))
1663 ;; Read arguments for a marked-files command that wants a file name,
1664 ;; perhaps popping up the list of marked files.
1665 ;; ARG is the prefix arg and indicates whether the files came from
1666 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1667 ;; If the current file was used, the list has but one element and ARG
1668 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1669 ;; DEFAULT is the default value to return if the user just hits RET;
1670 ;; if it is omitted or nil, then the name of the directory is used.
1675 nil op-symbol files
1680 ;; Try to guess which target directory the user may want.
1681 ;; If there is a dired buffer displayed in one of the next windows,
1682 ;; use its current subdir, else use current subdir of this dired buffer.
1685 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1696 this-dir)))
1699 ;; Return a list of default values for file-reading functions in Dired.
1700 ;; This list may contain directories from Dired buffers in other windows.
1701 ;; `fn-list' is a list of file names used to build a list of defaults.
1702 ;; When nil or more than one element, a list of defaults will
1703 ;; contain only directory names. `target-dir' is a directory name
1704 ;; to exclude from the returned list, for the case when this
1705 ;; directory name is already presented in initial input.
1706 ;; For Dired operations that support `dired-dwim-target',
1707 ;; the argument `target-dir' should have the value returned
1708 ;; from `dired-dwim-target-directory'.
1713 dired-dirs)
1714 ;; Get a list of directories of visible buffers in dired-mode.
1719 ;; Force the current dir to be the first in the list.
1722 ;; Remove the target dir (if specified) or the current dir from
1723 ;; default values, because it should be already in initial input.
1725 ;; Return a list of default values.
1727 ;; For one file operation, provide a list that contains
1728 ;; other directories, other directories with the appended filename
1729 ;; and the current directory with the appended filename, e.g.
1730 ;; 1. /TARGET-DIR/
1731 ;; 2. /TARGET-DIR/FILENAME
1732 ;; 3. /CURRENT-DIR/FILENAME
1741 ;; For multi-file operation, return only a list of other directories.
1742 dired-dirs)))
1744 \f
1745 ;;;###autoload
1747 "Create a directory called DIRECTORY.
1748 If DIRECTORY already exists, signal an error."
1755 ;; Find the topmost nonexistent parent dir (variable `new')
1767 ;; This may not always be what you want, especially if target is your
1768 ;; home directory and it happens to be a symbolic link, as is often the
1769 ;; case with NFS and automounters. Or if you want to make symlinks
1770 ;; into directories that themselves are only symlinks, also quite
1771 ;; common.
1773 ;; So we don't use this function as value for HOW-TO in
1774 ;; dired-do-symlink, which has the minor disadvantage of
1775 ;; making links *into* a symlinked-dir, when you really wanted to
1776 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1777 ;; just have to remove that symlink by hand before making your marked
1778 ;; symlinks.
1781 "Either nil or a function used by `dired-do-copy' to determine target.
1784 ;;;###autoload
1786 "Copy all marked (or next ARG) files, or copy the current file.
1787 When operating on just the current file, prompt for the new name.
1789 When operating on multiple or marked files, prompt for a target
1790 directory, and make the new copies in that directory, with the
1791 same names as the original files. The initial suggestion for the
1792 target directory is the Dired buffer's current directory (or, if
1793 `dired-dwim-target' is non-nil, the current directory of a
1794 neighboring Dired window).
1796 If `dired-copy-preserve-time' is non-nil, this command preserves
1797 the modification time of each old file in the copy, similar to
1800 This command copies symbolic links by creating new ones, similar
1805 "Copy"
1806 arg dired-keep-marker-copy
1807 nil dired-copy-how-to-fn)))
1809 ;;;###autoload
1811 "Make symbolic links to current file or all marked (or next ARG) files.
1812 When operating on just the current file, you specify the new name.
1813 When operating on multiple or marked files, you specify a directory
1814 and new symbolic links are made in that directory
1815 with the same names that the files currently have. The default
1816 suggested for the target directory depends on the value of
1817 `dired-dwim-target', which see.
1824 ;;;###autoload
1826 "Add names (hard links) current file or all marked (or next ARG) files.
1827 When operating on just the current file, you specify the new name.
1828 When operating on multiple or marked files, you specify a directory
1829 and new hard links are made in that directory
1830 with the same names that the files currently have. The default
1831 suggested for the target directory depends on the value of
1832 `dired-dwim-target', which see."
1839 ;; error is caught in -create-files
1841 ;; Update the link count
1844 ;;;###autoload
1846 "Rename current file or all marked (or next ARG) files.
1847 When renaming just the current file, you specify the new name.
1848 When renaming multiple or marked files, you specify a directory.
1849 This command also renames any buffers that are visiting the files.
1850 The default suggested for the target directory depends on the value
1851 of `dired-dwim-target', which see."
1855 ;;;###end dired-cp.el
1856 \f
1857 ;;; 5K
1858 ;;;###begin dired-re.el
1863 ;; Create a new file for each marked file using regexps.
1864 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1865 ;; ARG as in dired-get-marked-files.
1866 ;; Matches each marked file against REGEXP and constructs the new
1867 ;; filename from NEWNAME (like in function replace-match).
1868 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1869 ;; instead of only the non-directory part of the file.
1870 ;; Optional arg MARKER-CHAR as in dired-create-files.
1874 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1875 `!' to %s all remaining matches with no more questions."
1879 ;; Function to construct new filename using REGEXP and NEWNAME:
1884 ;; must bind help-form directly around call to
1885 ;; dired-query
1889 operation-prompt
1890 from
1891 to)
1892 to)
1894 operation from regexp)))))
1895 ;; not whole-name, replace non-directory part only
1906 operation-prompt
1909 to)
1912 rename-regexp-query)
1914 file-creator operation fn-list regexp-name-constructor marker-char)))
1917 ;; Prompt user about performing OPERATION.
1918 ;; Read and return list of: regexp newname arg whole-name.
1932 ;;;###autoload
1934 "Rename selected files whose names match REGEXP to NEWNAME.
1936 With non-zero prefix argument ARG, the command operates on the next ARG
1937 files. Otherwise, it operates on all the marked files, or the current
1938 file if none are marked.
1940 As each match is found, the user must type a character saying
1943 REGEXP defaults to the last regexp used.
1945 With a zero prefix arg, renaming by regexp affects the absolute file name.
1946 Normally, only the non-directory part of the file name is used and changed."
1952 ;;;###autoload
1954 "Copy selected files whose names match REGEXP to NEWNAME.
1955 See function `dired-do-rename-regexp' for more info."
1961 arg regexp newname whole-name dired-keep-marker-copy)))
1963 ;;;###autoload
1965 "Hardlink selected files whose names match REGEXP to NEWNAME.
1966 See function `dired-do-rename-regexp' for more info."
1972 ;;;###autoload
1974 "Symlink selected files whose names match REGEXP to NEWNAME.
1975 See function `dired-do-rename-regexp' for more info."
1985 ;; Perform FILE-CREATOR on the non-directory part of marked files
1986 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1987 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1990 file-creator
1991 operation
1999 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
2000 `!' to %s all remaining matches with no more questions."
2007 to))))
2008 dired-keep-marker-rename)))
2013 basename-constructor operation arg))
2015 ;;;###autoload
2017 "Rename all marked (or next ARG) files to upper case."
2021 ;;;###autoload
2023 "Rename all marked (or next ARG) files to lower case."
2027 ;;;###end dired-re.el
2028 \f
2029 ;;; 13K
2030 ;;;###begin dired-ins.el
2032 ;;;###autoload
2034 switches no-error-if-not-dir-p)
2035 "Insert this subdirectory into the same dired buffer.
2037 else inserts it at its natural place (as `ls -lR' would have done).
2038 With a prefix arg, you may edit the ls switches used for this listing.
2039 You can add `R' to the switches to expand the whole tree starting at
2040 this subdirectory.
2041 This function takes some pains to conform to `ls -lR' output.
2043 Dired remembers switches specified with a prefix arg, so that reverting
2044 the buffer will not reset them. However, using `dired-undo' to re-insert
2045 or delete subdirectories can bypass this machinery. Hence, you sometimes
2046 may have to reset some subdirectory switches after a `dired-undo'.
2047 You can reset all subdirectory switches to the default using
2049 See Info node `(emacs)Subdir switches' for more details."
2056 ;; We don't need a marker for opoint as the subdir is always
2057 ;; inserted *after* opoint.
2062 ;; Push mark so that it's easy to find back. Do this after the
2063 ;; insert message so that the user sees the `Mark set' message.
2066 ;;;###autoload
2068 "Insert this subdirectory into the same Dired buffer.
2069 If it is already present, overwrite the previous entry;
2070 otherwise, insert it at its natural place (as `ls -lR' would
2071 have done).
2072 With a prefix arg, you may edit the `ls' switches used for this listing.
2073 You can add `R' to the switches to expand the whole tree starting at
2074 this subdirectory.
2075 This function takes some pains to conform to `ls -lR' output."
2076 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
2077 ;; Prospero where dired-ls does the right thing, but
2078 ;; file-directory-p has not been redefined.
2092 switches-have-R mark-alist case-fold-search buffer-read-only)
2095 ;; case-fold-search is nil now, so we can test for capital `R':
2097 ;; avoid duplicated subdirs
2100 ;; If subdir is already present, remove it and remember its marks
2124 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2125 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2138 ;; all switches that make a difference to dired-get-filename:
2142 ;; Add new DIR at NEW-MARKER. Sort alist.
2147 ;; Keep the alist sorted on buffer position.
2155 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2156 Interactively, you can kill DIRNAME as well by using a prefix argument.
2157 In interactive use, the command prompts for DIRNAME.
2159 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2160 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2171 m-alist))
2174 ;; Find pos for new subdir, according to tree order.
2175 ;;(goto-char (point-max))
2182 ;; Insert NEW-DIR after DIR
2184 alist nil)))
2186 ;; want a separating newline between subdirs
2193 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2194 ;; Move to that buffer position. Return a mark-alist.
2197 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2206 ;; Insert ls output after point.
2207 ;; Return the boundary of the inserted text (as list of BEG and END).
2212 dired-subdir-switches
2215 ;; If doing the top level directory of the buffer,
2216 ;; redo it as specified in dired-directory.
2222 ;; Point is at the correct subdir alist position for ELT,
2223 ;; BEG-END is the subdir-region (as list of begin and end).
2225 ;; update its position (should actually be unchanged)
2228 ;; The hook may depend on the subdir-alist containing the just
2229 ;; inserted subdir, so run it after dired-alist-add:
2237 ;; hook may add or delete lines, but the subdir boundary
2238 ;; marker floats
2242 ;; Lexicographic order on file name components, like `ls -lR':
2243 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2244 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2245 ;; or DIR1 and DIR2 are in the same parentdir and their last
2246 ;; components are string-lessp.
2247 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2248 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2249 ;; if dired-actual-switches contained `t'.
2255 components-2
2267 t)
2269 nil)
2272 ;; There should be a builtin split function - inverse to mapconcat.
2274 "Splitting on regexp PAT, turn string STR into a list of substrings.
2275 Optional third arg LIMIT (>= 1) is a limit to the length of the
2276 resulting list.
2277 Thus, if SEP is a regexp that only matches itself,
2279 (mapconcat 'identity (dired-split SEP STRING) SEP)
2281 is always equal to STRING."
2294 start end)
2295 ))
2302 \f
2303 ;;; moving by subdirectories
2305 ;;;###autoload
2307 "Go to previous subdirectory, regardless of level.
2308 When called interactively and not on a subdir line, go to this subdir's line."
2309 ;;(interactive "p")
2313 ;; if on subdir start already, don't stay there!
2323 ;;;###autoload
2325 "Go to end of header line of DIR in this dired buffer.
2326 Return value of point on success, otherwise return nil.
2332 dired-subdir-alist ; table
2333 nil ; predicate
2334 t ; require-match
2341 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2342 ;; at either \r or \n after this function succeeds.
2345 \f
2346 ;;;###autoload
2348 "Mark all files except `.' and `..' in current subdirectory.
2349 If the Dired buffer shows multiple directories, this command
2350 marks the files listed in the subdirectory that point is in."
2355 ;;;###autoload
2357 "Remove all lines of current subdirectory.
2358 Lower levels are unaffected."
2359 ;; With optional REMEMBER-MARKS, return a mark-alist.
2366 buffer-read-only)
2380 ;; Remove DIR from the alist
2384 ;;;###autoload
2386 "Go up ARG levels in the dired tree."
2392 ;;(setq dir (expand-file-name dir))
2396 ;;;###autoload
2398 "Go down in the dired tree."
2412 \f
2413 ;;; hiding
2429 ;;;###autoload
2431 "Hide or unhide the current subdirectory and move to next directory.
2432 Optional prefix arg is a repeat factor.
2442 buffer-read-only)
2443 ;; keep header line visible, hide rest
2452 ;;;###autoload
2454 "Hide all subdirectories, leaving only their header lines.
2455 If there is already something hidden, make everything visible again.
2460 buffer-read-only)
2464 ;; unhide - bombs on \r in filenames
2466 ;; hide
2473 ;; we're somewhere on current dir's line
2481 ;;;###end dired-ins.el
2483 \f
2484 ;; Search only in file names in the Dired buffer.
2487 "Non-nil to Isearch in file names only.
2488 If t, Isearch in Dired always matches only file names.
2489 If `dwim', Isearch matches file names when initial point position is on
2490 a file name. Otherwise, it searches the whole buffer without restrictions."
2498 "Toggle file names searching on or off.
2499 When on, Isearch skips matches outside file names using the predicate
2500 `dired-isearch-filter-filenames' that matches only at file names.
2501 When off, it uses the original predicate."
2502 nil nil nil
2505 #'dired-isearch-filter-filenames
2513 ;;;###autoload
2515 "Set up isearch to search in Dired file names.
2516 Intended to be added to `isearch-mode-hook'."
2525 "Clean up the Dired file name search after terminating isearch."
2531 "Test whether the current search hit is a file name.
2532 Return non-nil if the text from BEG to END is part of a file
2533 name (has the text property `dired-filename')."
2537 ;;;###autoload
2539 "Search for a string using Isearch only in file names in the Dired buffer."
2544 ;;;###autoload
2546 "Search for a regexp using Isearch only in file names in the Dired buffer."
2551 \f
2552 ;; Functions for searching in tags style among marked files.
2554 ;;;###autoload
2556 "Search for a string through all marked files using Isearch."
2561 ;;;###autoload
2563 "Search for a regexp through all marked files using Isearch."
2568 ;;;###autoload
2570 "Search through all marked files for a match for REGEXP.
2571 Stops when a match is found.
2576 ;;;###autoload
2578 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2579 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2590 buffer-read-only))
2597 \f
2598 ;;;###autoload
2600 "Print the type of FILE, according to the `file' command.
2601 If you give a prefix to this command, and FILE is a symbolic
2602 link, then the type of the file linked to by FILE is printed
2603 instead."
2616 ;; Local Variables:
2617 ;; byte-compile-dynamic: t
2618 ;; generated-autoload-file: "dired.el"
2619 ;; End:
2621 ;;; dired-aux.el ends here