| blob | 31d0495175a16aa50fb22c476fe5cddaae0cd859 |
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985-1986, 1992, 1994, 1998, 2000-2013 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
7 ;; Maintainer: FSF
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."
419 "Print %s with: "
424 lpr-switches))
431 "Read args for a Dired marked-files command, prompting with PROMPT.
432 Return the user input (a string).
434 INITIAL, if non-nil, is the initial minibuffer input.
435 OP-SYMBOL is an operation symbol (see `dired-no-confirm').
436 ARG is normally the prefix argument for the calling command;
437 it is passed as the first argument to `dired-mark-prompt'.
438 FILES should be a list of marked files' names.
440 Optional arg DEFAULT-VALUE is a default value or list of default
441 values, passed as the seventh arg to `completing-read'.
443 Optional arg COLLECTION is a collection of possible completions,
444 passed as the second arg to `completing-read'."
446 'completing-read
448 collection nil nil initial nil default-value nil))
449 \f
450 ;;; Cleaning a directory: flagging some backups for deletion.
454 ;;;###autoload
456 "Flag numerical backups for deletion.
457 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
458 Positive prefix arg KEEP overrides `dired-kept-versions';
459 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
462 with a prefix argument."
469 late-retention early-retention)
470 ;; Look at each file.
471 ;; If the file has numeric backup versions,
472 ;; put on dired-file-version-alist an element of the form
473 ;; (FILENAME . VERSION-NUMBER-LIST)
475 ;; Sort each VERSION-NUMBER-LIST,
476 ;; and remove the versions not to be deleted.
484 sorted-v-list)))
488 ;; Look at each file. If it is a numeric backup file,
489 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
493 ;;; Subroutines of dired-clean-directory.
496 ;; Perform FUN with point at the end of each non-directory line.
497 ;; FUN takes one argument, the absolute filename.
514 ;; Only do work if this file is not already in the alist.
516 nil
517 ;; If it looks like file FN has versions, return a list of the versions.
518 ;;That is a list of strings which are file names.
519 ;;The caller may want to flag some of these files for deletion.
524 base-versions
530 dired-file-version-alist)))))))
534 base-version-list)
544 \f
545 ;;; Shell commands
550 "Return a list of all commands associated with current dired files.
551 This function is used to add all related commands retrieved by `mailcap'
552 to the end of the list of defaults just after the default value."
560 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
562 "Read a dired shell command.
564 which is replaced by the value returned by `dired-mark-prompt',
565 with ARG and FILES as its arguments. FILES should be a list of
566 file names. The result is used as the prompt.
568 This normally reads using `read-shell-command', but if the
569 `dired-x' package is loaded, use `dired-guess-shell-command' to
570 offer a smarter default choice of shell command."
582 ;;;###autoload
584 "Run a shell command COMMAND on the marked files asynchronously.
586 Like `dired-do-shell-command', but adds `&' at the end of COMMAND
587 to execute it asynchronously.
589 When operating on multiple files, asynchronous commands
590 are executed in the background on each file in parallel.
591 In shell syntax this means separating the individual commands
592 with `&'. However, when COMMAND ends in `;' or `;&' then commands
593 are executed in the background on each file sequentially waiting
594 for each command to terminate before running the next command.
595 In shell syntax this means separating the individual commands with `;'.
597 The output appears in the buffer `*Async Shell Command*'."
601 ;; Want to give feedback whether this file or marked files are used:
603 current-prefix-arg
604 files)))
609 ;;;###autoload
611 "Run a shell command COMMAND on the marked files.
612 If no files are marked or a numeric prefix arg is given,
614 The prompt mentions the file(s) or the marker, as appropriate.
616 If there is a `*' in COMMAND, surrounded by whitespace, this runs
617 COMMAND just once with the entire file list substituted there.
619 If there is no `*', but there is a `?' in COMMAND, surrounded by
620 whitespace, this runs COMMAND on each file individually with the
621 file name substituted for `?'.
623 Otherwise, this runs COMMAND on each file individually with the
624 file name added at the end of COMMAND (separated by a space).
626 `*' and `?' when not surrounded by whitespace have no special
627 significance for `dired-do-shell-command', and are passed through
628 normally to the shell, but you must confirm first.
630 If you want to use `*' as a shell wildcard with whitespace around
632 `*' in the shell, but avoids Dired's special handling.
634 If COMMAND ends in `&', `;', or `;&', it is executed in the
635 background asynchronously, and the output appears in the buffer
636 `*Async Shell Command*'. When operating on multiple files and COMMAND
637 ends in `&', the shell command is executed on each file in parallel.
638 However, when COMMAND ends in `;' or `;&' then commands are executed
639 in the background on each file sequentially waiting for each command
640 to terminate before running the next command. You can also use
641 `dired-do-async-shell-command' that automatically adds `&'.
643 Otherwise, COMMAND is executed synchronously, and the output
644 appears in the buffer `*Shell Command Output*'.
646 This feature does not try to redisplay Dired buffers afterward, as
647 there's no telling what files COMMAND may have changed.
650 When COMMAND runs, its working directory is the top-level directory
651 of the Dired buffer, so output files usually are created there
652 instead of in a subdir.
654 In a noninteractive call (from Lisp code), you must specify
655 the list of file names explicitly with the FILE-LIST argument, which
656 can be produced by `dired-get-marked-files', for example."
657 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
658 ;;actual work and can be redefined for customization.
662 ;; Want to give feedback whether this file or marked files are used:
664 current-prefix-arg
665 files)))
670 ;; Get confirmation for wildcards that may have been meant
671 ;; to control substitution of a file name or the file name list.
685 nil
686 file-list)
687 ;; execute the shell command
691 ;; Might use {,} for bash or csh:
700 ;; "Make up a shell command line from COMMAND and FILE-LIST.
701 ;; If ON-EACH is t, COMMAND should be applied to each file, else
702 ;; simply concat all files and apply COMMAND to this.
703 ;; FILE-LIST's elements will be quoted for the shell."
704 ;; Might be redefined for smarter things and could then use RAW-ARG
705 ;; (coming from interactive P and currently ignored) to decide what to do.
706 ;; Smart would be a way to access basename or extension of file names.
710 command))
714 command))
723 retval))
730 file-list dired-mark-separator)))
736 ;; This is an extra function so that it can be redefined by ange-ftp.
737 ;;;###autoload
744 ;; Return nil for sake of nconc in dired-bunch-files.
745 nil)
746 \f
749 ; "Display MSG while running PROGRAM, and check for output.
750 ;Remaining arguments are strings passed as command arguments to PROGRAM.
751 ; On error, insert output
752 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
753 ; Caller can cons up a list of failed args.
754 ;Else returns nil for success."
758 ;; Get a clean buffer for error output:
771 nil))))
772 \f
773 ;; Commands that delete or redisplay part of the dired buffer.
776 "Kill the current line (not the files).
777 With a prefix argument, kill that many lines starting with the current line.
778 \(A negative argument kills backward.)"
797 ;;;###autoload
799 "Kill all marked lines (not the files).
800 With a prefix argument, kill that many lines starting with the current line.
801 \(A negative argument kills backward.)
802 If you use this command with a prefix argument to kill the line
803 for a file that is a directory, which you have inserted in the
804 Dired buffer as a subdirectory, then it deletes that subdirectory
805 from the buffer as well.
806 To kill an entire subdirectory \(without killing its line in the
807 parent directory), go to its directory header line and use this
808 command with a prefix argument (the value does not matter)."
809 ;; Returns count of killed lines. FMT="" suppresses message.
827 count))))
829 ;;;###end dired-cmd.el
830 \f
831 ;;; 30K
832 ;;;###begin dired-cp.el
835 ;; Compress or uncompress the current file.
836 ;; Return nil for success, offending filename else.
842 ;; Remove any preexisting entry for the name NEW-FILE.
845 ;; Now replace the current line with an entry for NEW-FILE.
848 from-file)))
854 ;; For .z, try gunzip. It might be an old gzip file,
855 ;; or it might be from compact? pack? (which?) but gunzip handles both.
861 ;; This item controls naming for compression.
863 "Control changes in file name suffixes for compression and uncompression.
864 Each element specifies one transformation rule, and has the form:
865 (REGEXP NEW-SUFFIX PROGRAM)
866 The rule applies when the old file name matches REGEXP.
867 The new file name is computed by deleting the part that matches REGEXP
868 (as well as anything after that), then adding NEW-SUFFIX in its place.
869 If PROGRAM is non-nil, the rule is an uncompression rule,
870 and uncompression is done by running PROGRAM.
873 ;;;###autoload
875 ;; Compress or uncompress FILE.
876 ;; Return the name of the compressed or uncompressed file.
877 ;; Return nil if no change in files.
879 suffix newname
881 ;; See if any suffix rule matches this file name.
887 ;; If so, compute desired new name.
894 nil)
896 ;; We found an uncompression rule.
899 newname))
901 ;;; We don't recognize the file as compressed, so compress it.
902 ;;; Try gzip; if we don't have that, use compress.
908 out-name)))
913 ;; Rename the compressed file to NEWNAME
914 ;; if it hasn't got that name already.
918 newname)
919 out-name)))
923 ;; Don't use NEWNAME with `compress'.
925 \f
927 ;; Request confirmation from the user that the operation described
928 ;; by OP-SYMBOL is to be performed on the marked files.
929 ;; Confirmation consists in a y-or-n question with a file list
930 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
931 ;; The files used are determined by ARG (as in dired-get-marked-files).
934 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
935 ;; is marked pops up a window. That will help the user see
936 ;; it isn't the current line file.
945 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
946 ; and display failures.
948 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
949 ; the short form of the filename) for a failure and probably logs a
950 ; detailed error explanation using function `dired-log'.
952 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
953 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
954 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
955 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
957 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
969 ;; end this bunch of errors:
973 failures)))))
975 ;;;###autoload
977 "Format PROMPT with ARGS, query user, and store the result in SYM.
978 The return value is either nil or t.
980 The user may type y or SPC to accept once; n or DEL to skip once;
981 ! to accept this and subsequent queries; or q or ESC to decline
982 this and subsequent queries.
984 If SYM is already bound to a non-nil value, this function may
985 return automatically without querying the user. If SYM is !,
986 return t; if SYM is q or ESC, return nil."
1003 \f
1004 ;;;###autoload
1006 "Compress or uncompress marked (or next ARG) files."
1010 ;; Commands for Emacs Lisp files - load and byte compile
1013 ;; Return nil for success, offending file name else.
1015 elc-file buffer-read-only failure)
1030 nil)))
1032 ;;;###autoload
1034 "Byte compile marked (or next ARG) Emacs Lisp files."
1039 ;; Return nil for success, offending file name else.
1045 nil
1049 ;;;###autoload
1051 "Load the marked (or next ARG) Emacs Lisp files."
1055 ;;;###autoload
1057 "Redisplay all marked (or next ARG) files.
1058 If on a subdir line, redisplay that subdirectory. In that case,
1059 a prefix arg lets you edit the `ls' switches used for the new listing.
1061 Dired remembers switches specified with a prefix arg, so that reverting
1062 the buffer will not reset them. However, using `dired-undo' to re-insert
1063 or delete subdirectories can bypass this machinery. Hence, you sometimes
1064 may have to reset some subdirectory switches after a `dired-undo'.
1065 You can reset all subdirectory switches to the default using
1067 See Info node `(emacs)Subdir switches' for more details."
1068 ;; Moves point if the next ARG files are redisplayed.
1074 dir
1078 dired-subdir-switches
1079 dired-actual-switches)))))
1081 ;; message much faster than making dired-map-over-marks show progress
1085 ;; Postpone readin hook till we map
1086 ;; over all marked files (Bug#6810).
1090 arg)
1096 "Set `dired-switches-alist' to nil and revert dired buffer."
1100 \f
1102 ;; Delete the current line, and insert an entry for FILE.
1103 ;; If FILE is nil, then just delete the current line.
1104 ;; Keeps any marks that may be present in column one (doing this
1105 ;; here is faster than with dired-add-entry's optional arg).
1106 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1114 ;; Replace space by old marker without moving point.
1115 ;; Faster than goto+insdel inside a save-excursion?
1119 ;;;###autoload
1130 "Add a new dired entry for FILENAME.
1131 Optionally mark it with MARKER-CHAR (a character, else uses
1132 `dired-marker-char'). Note that this adds the entry `out of order'
1133 if files are sorted by time, etc.
1134 Skips files that match `dired-trivial-filenames'.
1135 Exposes hidden subdirectories if a file is added there.
1137 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1138 files matching `dired-omit-regexp'."
1141 ;; Avoid calling ls for files that are going to be omitted anyway.
1147 filename)
1152 filename
1154 ;; Do it!
1157 ;; Entry is always for files, even if they happen to also be directories
1161 reason)
1166 reason
1173 ;; We are already where we should be, except when
1174 ;; point is before the subdir line or its total line.
1178 ;; else try to find correct place to insert
1182 ;; Point is at end of subdir line.
1184 ;; found - skip subdir and `total' line
1185 ;; and uninteresting files like . and ..
1186 ;; This better not move into the next subdir!
1188 ;; not found
1193 ;; Don't expand `.'.
1194 ;; Show just the file name within directory.
1197 directory
1201 ;; Put in desired marker char.
1205 dired-marker-char)))
1207 ;; Compensate for a bug in ange-ftp.
1208 ;; It inserts the file's absolute name, rather than
1209 ;; the relative one. That may be hard to fix since it
1210 ;; is probably controlled by something in ftp.
1226 ;; The subdir-alist is not affected...
1234 ;; return nil if all went well
1235 nil))
1239 ;; Don't do it (dired-omit-mode).
1240 ;; Return t for success (perhaps we should return file-exists-p).
1241 t))
1244 ;; Return pos of first file line of DIR, skipping header and total
1245 ;; or wildcard lines.
1246 ;; Important: never moves into the next subdir.
1247 ;; DIR is assumed to be unhidden.
1256 ;;;###autoload
1269 ;;;###autoload
1271 "Create or update the line for FILE in all Dired buffers it would belong in."
1277 ;; Relist the line for FILE, or just add it if it did not exist.
1278 ;; FILE must be an absolute file name.
1280 ;; If cursor is already on FILE's line delete-region will cause
1281 ;; save-excursion to fail because of floating makers,
1282 ;; moving point to beginning of line. Sigh.
1291 \f
1292 ;;; Copy, move/rename, making hard and symbolic links
1295 "Non-nil if Dired should ask about making backups before overwriting files.
1296 Special value `always' suppresses confirmation."
1302 ;; This is a fluid var used in dired-handle-overwrite. It should be
1303 ;; let-bound whenever dired-copy-file etc are called. See
1304 ;; dired-create-files for an example.
1308 ;; Save old version of file TO that is to be overwritten.
1309 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1310 ;; from dired-create-files.
1313 dired-overwrite-confirmed
1317 "Make backup for existing file `%s'? "
1318 to)))
1322 ;;;###autoload
1326 dired-recursive-copies))
1331 preserve-time top recursive)
1340 ;; This is a directory.
1342 ;; Not a directory.
1346 ;; It is a symlink
1351 dired-create-files-failures)
1354 ;;;###autoload
1358 ;; Silently rename the visited file of any buffer visiting this file.
1363 ;; See if it's an inserted subdir, and rename that, too.
1371 ;; Update visited file name of all affected buffers
1381 to-dir
1382 buffer-file-name)))
1388 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1389 ;; one of its subdirectories is expanded in this buffer.
1397 ;; ELT's subdir is affected by the rename
1400 ;; if top level directory was renamed, lots of things have to be
1401 ;; updated:
1406 ;; with and without wildcards
1408 to))
1411 ;; try to rename buffer, but just leave old name if new
1412 ;; name would already exist (don't try appending "<%d>")
1415 ;; ... we dired TO now:
1419 ;; Update the headerline and dired-subdir-alist element, as well as
1420 ;; dired-switches-alist element, of directory described by
1421 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1422 ;; describes either DIR itself or a subdir of DIR.
1426 buffer-read-only)
1428 ;; Update subdir headerline in buffer
1431 dir)
1436 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1442 \f
1443 ;; Bound in dired-create-files
1447 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1450 "Create one or more new files from a list of existing files FN-LIST.
1451 This function also handles querying the user, updating Dired
1452 buffers, and displaying a success or failure message.
1454 FILE-CREATOR should be a function. It is called once for each
1455 file in FN-LIST, and must create a new file, querying the user
1456 and updating Dired buffers as necessary. It should accept three
1457 arguments: the old file name, the new name, and an argument
1458 OK-IF-ALREADY-EXISTS with the same meaning as in `copy-file'.
1460 OPERATION should be a capitalized string describing the operation
1461 performed (e.g. `Copy'). It is used for error logging.
1463 FN-LIST is the list of files to copy (full absolute file names).
1465 NAME-CONSTRUCTOR should be a function accepting a single
1466 argument, the name of an old file, and returning either the
1467 corresponding new file name or nil to skip.
1469 If optional argument MARKER-CHAR is non-nil, mark each
1470 newly-created file's Dired entry with the character MARKER-CHAR,
1471 or with the current marker character if MARKER-CHAR is t."
1489 Type SPC or `y' to overwrite file `%s',
1490 DEL or `n' to skip to next,
1491 ESC or `q' to not overwrite any of the remaining files,
1495 ;; must determine if FROM is marked before file-creator
1496 ;; gets a chance to delete it (in case of a move).
1501 ;; Handle the `dired-copy-file' file-creator specially
1502 ;; When copying a directory to another directory or
1503 ;; possibly to itself or one of its subdirectories.
1504 ;; e.g "~/foo/" => "~/test/"
1505 ;; or "~/foo/" =>"~/foo/"
1506 ;; or "~/foo/ => ~/foo/bar/")
1507 ;; In this case the 'name-constructor' have set the destination
1508 ;; TO to "~/test/foo" because the old emacs23 behavior
1509 ;; of `copy-directory' was to not create the subdirectory
1510 ;; and instead copy the contents.
1511 ;; With the new behavior of `copy-directory'
1512 ;; (similar to the `cp' shell command) we don't
1513 ;; need such a construction of the target directory,
1514 ;; so modify the destination TO to "~/test/" instead of "~/test/foo/".
1520 ;; If DESTNAME is a subdirectory of FROM, not a symlink,
1521 ;; and the method in use is copying, signal an error.
1526 from to)))
1531 ;; If we get here, file-creator hasn't been aborted
1532 ;; and the old entry (if any) has to be deleted
1533 ;; before adding the new entry.
1541 failures)
1543 operation from to err))))))))
1551 total)
1552 failures))
1558 failures))
1564 skipped))
1569 \f
1571 &optional marker-char op1
1572 how-to)
1573 "Create a new file for each marked file.
1574 Prompt user for a target directory in which to create the new
1575 files. The target may also be a non-directory file, if only
1576 one file is marked. The initial suggestion for target is the
1577 Dired buffer's current directory (or, if `dired-dwim-target' is
1578 non-nil, the current directory of a neighboring Dired window).
1579 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1580 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1581 FILE-CREATOR and OPERATION as in `dired-create-files'.
1582 ARG as in `dired-get-marked-files'.
1583 Optional arg MARKER-CHAR as in `dired-create-files'.
1584 Optional arg OP1 is an alternate form for OPERATION if there is
1585 only one file.
1586 Optional arg HOW-TO determines how to treat the target.
1587 If HOW-TO is nil, use `file-directory-p' to determine if the
1588 target is a directory. If so, the marked file(s) are created
1589 inside that directory. Otherwise, the target is a plain file;
1590 an error is raised unless there is exactly one marked file.
1591 If HOW-TO is t, target is always treated as a plain file.
1592 Otherwise, HOW-TO should be a function of one argument, TARGET.
1593 If its return value is nil, TARGET is regarded as a plain file.
1594 If it return value is a list, TARGET is a generalized
1595 directory (e.g. some sort of archive). The first element of
1596 this list must be a function with at least four arguments:
1597 operation - as OPERATION above.
1598 rfn-list - list of the relative names for the marked files.
1599 fn-list - list of the absolute names for the marked files.
1600 target - the name of the target itself.
1601 The rest of into-dir are optional arguments.
1602 For any other return value, TARGET is treated as a directory."
1611 target-dir)))
1620 target-dir op-symbol arg rfn-list default))))
1622 ;; Allow DOS/Windows users to change the letter
1623 ;; case of a directory. If we don't test these
1624 ;; conditions up front, file-directory-p below
1625 ;; will return t because the filesystem is
1626 ;; case-insensitive, and Emacs will try to move
1627 ;; foo -> foo/foo, which fails.
1630 dired-one-file
1638 nil
1646 ;; rename-file bombs when moving directories unless we do this:
1649 file-creator operation fn-list
1651 ;; This function uses fluid variable target when called
1652 ;; inside dired-create-files:
1657 marker-char))))
1659 ;; Read arguments for a marked-files command that wants a file name,
1660 ;; perhaps popping up the list of marked files.
1661 ;; ARG is the prefix arg and indicates whether the files came from
1662 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1663 ;; If the current file was used, the list has but one element and ARG
1664 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1665 ;; DEFAULT is the default value to return if the user just hits RET;
1666 ;; if it is omitted or nil, then the name of the directory is used.
1671 nil op-symbol files
1676 ;; Try to guess which target directory the user may want.
1677 ;; If there is a dired buffer displayed in one of the next windows,
1678 ;; use its current subdir, else use current subdir of this dired buffer.
1681 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1692 this-dir)))
1695 ;; Return a list of default values for file-reading functions in Dired.
1696 ;; This list may contain directories from Dired buffers in other windows.
1697 ;; `fn-list' is a list of file names used to build a list of defaults.
1698 ;; When nil or more than one element, a list of defaults will
1699 ;; contain only directory names. `target-dir' is a directory name
1700 ;; to exclude from the returned list, for the case when this
1701 ;; directory name is already presented in initial input.
1702 ;; For Dired operations that support `dired-dwim-target',
1703 ;; the argument `target-dir' should have the value returned
1704 ;; from `dired-dwim-target-directory'.
1709 dired-dirs)
1710 ;; Get a list of directories of visible buffers in dired-mode.
1715 ;; Force the current dir to be the first in the list.
1718 ;; Remove the target dir (if specified) or the current dir from
1719 ;; default values, because it should be already in initial input.
1721 ;; Return a list of default values.
1723 ;; For one file operation, provide a list that contains
1724 ;; other directories, other directories with the appended filename
1725 ;; and the current directory with the appended filename, e.g.
1726 ;; 1. /TARGET-DIR/
1727 ;; 2. /TARGET-DIR/FILENAME
1728 ;; 3. /CURRENT-DIR/FILENAME
1737 ;; For multi-file operation, return only a list of other directories.
1738 dired-dirs)))
1740 \f
1741 ;;;###autoload
1743 "Create a directory called DIRECTORY.
1744 If DIRECTORY already exists, signal an error."
1751 ;; Find the topmost nonexistent parent dir (variable `new')
1763 ;; This may not always be what you want, especially if target is your
1764 ;; home directory and it happens to be a symbolic link, as is often the
1765 ;; case with NFS and automounters. Or if you want to make symlinks
1766 ;; into directories that themselves are only symlinks, also quite
1767 ;; common.
1769 ;; So we don't use this function as value for HOW-TO in
1770 ;; dired-do-symlink, which has the minor disadvantage of
1771 ;; making links *into* a symlinked-dir, when you really wanted to
1772 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1773 ;; just have to remove that symlink by hand before making your marked
1774 ;; symlinks.
1777 "Either nil or a function used by `dired-do-copy' to determine target.
1780 ;;;###autoload
1782 "Copy all marked (or next ARG) files, or copy the current file.
1783 When operating on just the current file, prompt for the new name.
1785 When operating on multiple or marked files, prompt for a target
1786 directory, and make the new copies in that directory, with the
1787 same names as the original files. The initial suggestion for the
1788 target directory is the Dired buffer's current directory (or, if
1789 `dired-dwim-target' is non-nil, the current directory of a
1790 neighboring Dired window).
1792 If `dired-copy-preserve-time' is non-nil, this command preserves
1793 the modification time of each old file in the copy, similar to
1796 This command copies symbolic links by creating new ones, similar
1801 "Copy"
1802 arg dired-keep-marker-copy
1803 nil dired-copy-how-to-fn)))
1805 ;;;###autoload
1807 "Make symbolic links to current file or all marked (or next ARG) files.
1808 When operating on just the current file, you specify the new name.
1809 When operating on multiple or marked files, you specify a directory
1810 and new symbolic links are made in that directory
1811 with the same names that the files currently have. The default
1812 suggested for the target directory depends on the value of
1813 `dired-dwim-target', which see.
1820 ;;;###autoload
1822 "Add names (hard links) current file or all marked (or next ARG) files.
1823 When operating on just the current file, you specify the new name.
1824 When operating on multiple or marked files, you specify a directory
1825 and new hard links are made in that directory
1826 with the same names that the files currently have. The default
1827 suggested for the target directory depends on the value of
1828 `dired-dwim-target', which see."
1835 ;; error is caught in -create-files
1837 ;; Update the link count
1840 ;;;###autoload
1842 "Rename current file or all marked (or next ARG) files.
1843 When renaming just the current file, you specify the new name.
1844 When renaming multiple or marked files, you specify a directory.
1845 This command also renames any buffers that are visiting the files.
1846 The default suggested for the target directory depends on the value
1847 of `dired-dwim-target', which see."
1851 ;;;###end dired-cp.el
1852 \f
1853 ;;; 5K
1854 ;;;###begin dired-re.el
1859 ;; Create a new file for each marked file using regexps.
1860 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1861 ;; ARG as in dired-get-marked-files.
1862 ;; Matches each marked file against REGEXP and constructs the new
1863 ;; filename from NEWNAME (like in function replace-match).
1864 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1865 ;; instead of only the non-directory part of the file.
1866 ;; Optional arg MARKER-CHAR as in dired-create-files.
1870 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1871 `!' to %s all remaining matches with no more questions."
1875 ;; Function to construct new filename using REGEXP and NEWNAME:
1880 ;; must bind help-form directly around call to
1881 ;; dired-query
1885 operation-prompt
1886 from
1887 to)
1888 to)
1890 operation from regexp)))))
1891 ;; not whole-name, replace non-directory part only
1902 operation-prompt
1905 to)
1908 rename-regexp-query)
1910 file-creator operation fn-list regexp-name-constructor marker-char)))
1913 ;; Prompt user about performing OPERATION.
1914 ;; Read and return list of: regexp newname arg whole-name.
1927 ;;;###autoload
1929 "Rename selected files whose names match REGEXP to NEWNAME.
1931 With non-zero prefix argument ARG, the command operates on the next ARG
1932 files. Otherwise, it operates on all the marked files, or the current
1933 file if none are marked.
1935 As each match is found, the user must type a character saying
1938 REGEXP defaults to the last regexp used.
1940 With a zero prefix arg, renaming by regexp affects the absolute file name.
1941 Normally, only the non-directory part of the file name is used and changed."
1947 ;;;###autoload
1949 "Copy selected files whose names match REGEXP to NEWNAME.
1950 See function `dired-do-rename-regexp' for more info."
1956 arg regexp newname whole-name dired-keep-marker-copy)))
1958 ;;;###autoload
1960 "Hardlink selected files whose names match REGEXP to NEWNAME.
1961 See function `dired-do-rename-regexp' for more info."
1967 ;;;###autoload
1969 "Symlink selected files whose names match REGEXP to NEWNAME.
1970 See function `dired-do-rename-regexp' for more info."
1980 ;; Perform FILE-CREATOR on the non-directory part of marked files
1981 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1982 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1985 file-creator
1986 operation
1994 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1995 `!' to %s all remaining matches with no more questions."
2002 to))))
2003 dired-keep-marker-rename)))
2008 basename-constructor operation arg))
2010 ;;;###autoload
2012 "Rename all marked (or next ARG) files to upper case."
2016 ;;;###autoload
2018 "Rename all marked (or next ARG) files to lower case."
2022 ;;;###end dired-re.el
2023 \f
2024 ;;; 13K
2025 ;;;###begin dired-ins.el
2027 ;;;###autoload
2029 switches no-error-if-not-dir-p)
2030 "Insert this subdirectory into the same dired buffer.
2032 else inserts it at its natural place (as `ls -lR' would have done).
2033 With a prefix arg, you may edit the ls switches used for this listing.
2034 You can add `R' to the switches to expand the whole tree starting at
2035 this subdirectory.
2036 This function takes some pains to conform to `ls -lR' output.
2038 Dired remembers switches specified with a prefix arg, so that reverting
2039 the buffer will not reset them. However, using `dired-undo' to re-insert
2040 or delete subdirectories can bypass this machinery. Hence, you sometimes
2041 may have to reset some subdirectory switches after a `dired-undo'.
2042 You can reset all subdirectory switches to the default using
2044 See Info node `(emacs)Subdir switches' for more details."
2051 ;; We don't need a marker for opoint as the subdir is always
2052 ;; inserted *after* opoint.
2057 ;; Push mark so that it's easy to find back. Do this after the
2058 ;; insert message so that the user sees the `Mark set' message.
2061 ;;;###autoload
2063 "Insert this subdirectory into the same Dired buffer.
2064 If it is already present, overwrite the previous entry;
2065 otherwise, insert it at its natural place (as `ls -lR' would
2066 have done).
2067 With a prefix arg, you may edit the `ls' switches used for this listing.
2068 You can add `R' to the switches to expand the whole tree starting at
2069 this subdirectory.
2070 This function takes some pains to conform to `ls -lR' output."
2071 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
2072 ;; Prospero where dired-ls does the right thing, but
2073 ;; file-directory-p has not been redefined.
2087 switches-have-R mark-alist case-fold-search buffer-read-only)
2090 ;; case-fold-search is nil now, so we can test for capital `R':
2092 ;; avoid duplicated subdirs
2095 ;; If subdir is already present, remove it and remember its marks
2119 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2120 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2133 ;; all switches that make a difference to dired-get-filename:
2137 ;; Add new DIR at NEW-MARKER. Sort alist.
2142 ;; Keep the alist sorted on buffer position.
2150 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2151 Interactively, you can kill DIRNAME as well by using a prefix argument.
2152 In interactive use, the command prompts for DIRNAME.
2154 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2155 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2166 m-alist))
2169 ;; Find pos for new subdir, according to tree order.
2170 ;;(goto-char (point-max))
2177 ;; Insert NEW-DIR after DIR
2179 alist nil)))
2181 ;; want a separating newline between subdirs
2188 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2189 ;; Move to that buffer position. Return a mark-alist.
2192 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2201 ;; Insert ls output after point.
2202 ;; Return the boundary of the inserted text (as list of BEG and END).
2207 dired-subdir-switches
2210 ;; If doing the top level directory of the buffer,
2211 ;; redo it as specified in dired-directory.
2217 ;; Point is at the correct subdir alist position for ELT,
2218 ;; BEG-END is the subdir-region (as list of begin and end).
2220 ;; update its position (should actually be unchanged)
2223 ;; The hook may depend on the subdir-alist containing the just
2224 ;; inserted subdir, so run it after dired-alist-add:
2232 ;; hook may add or delete lines, but the subdir boundary
2233 ;; marker floats
2237 ;; Lexicographic order on file name components, like `ls -lR':
2238 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2239 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2240 ;; or DIR1 and DIR2 are in the same parentdir and their last
2241 ;; components are string-lessp.
2242 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2243 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2244 ;; if dired-actual-switches contained `t'.
2250 components-2
2262 t)
2264 nil)
2267 ;; There should be a builtin split function - inverse to mapconcat.
2269 "Splitting on regexp PAT, turn string STR into a list of substrings.
2270 Optional third arg LIMIT (>= 1) is a limit to the length of the
2271 resulting list.
2272 Thus, if SEP is a regexp that only matches itself,
2274 (mapconcat 'identity (dired-split SEP STRING) SEP)
2276 is always equal to STRING."
2289 start end)
2290 ))
2297 \f
2298 ;;; moving by subdirectories
2300 ;;;###autoload
2302 "Go to previous subdirectory, regardless of level.
2303 When called interactively and not on a subdir line, go to this subdir's line."
2304 ;;(interactive "p")
2308 ;; if on subdir start already, don't stay there!
2318 ;;;###autoload
2320 "Go to end of header line of DIR in this dired buffer.
2321 Return value of point on success, otherwise return nil.
2327 dired-subdir-alist ; table
2328 nil ; predicate
2329 t ; require-match
2336 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2337 ;; at either \r or \n after this function succeeds.
2340 \f
2341 ;;;###autoload
2343 "Mark all files except `.' and `..' in current subdirectory.
2344 If the Dired buffer shows multiple directories, this command
2345 marks the files listed in the subdirectory that point is in."
2350 ;;;###autoload
2352 "Remove all lines of current subdirectory.
2353 Lower levels are unaffected."
2354 ;; With optional REMEMBER-MARKS, return a mark-alist.
2361 buffer-read-only)
2375 ;; Remove DIR from the alist
2379 ;;;###autoload
2381 "Go up ARG levels in the dired tree."
2387 ;;(setq dir (expand-file-name dir))
2391 ;;;###autoload
2393 "Go down in the dired tree."
2407 \f
2408 ;;; hiding
2424 ;;;###autoload
2426 "Hide or unhide the current subdirectory and move to next directory.
2427 Optional prefix arg is a repeat factor.
2437 buffer-read-only)
2438 ;; keep header line visible, hide rest
2447 ;;;###autoload
2449 "Hide all subdirectories, leaving only their header lines.
2450 If there is already something hidden, make everything visible again.
2455 buffer-read-only)
2459 ;; unhide - bombs on \r in filenames
2461 ;; hide
2468 ;; we're somewhere on current dir's line
2476 ;;;###end dired-ins.el
2478 \f
2479 ;; Search only in file names in the Dired buffer.
2482 "Non-nil to Isearch in file names only.
2483 If t, Isearch in Dired always matches only file names.
2484 If `dwim', Isearch matches file names when initial point position is on
2485 a file name. Otherwise, it searches the whole buffer without restrictions."
2493 "Toggle file names searching on or off.
2494 When on, Isearch skips matches outside file names using the predicate
2495 `dired-isearch-filter-filenames' that matches only at file names.
2496 When off, it uses the original predicate."
2497 nil nil nil
2500 #'dired-isearch-filter-filenames
2508 ;;;###autoload
2510 "Set up isearch to search in Dired file names.
2511 Intended to be added to `isearch-mode-hook'."
2520 "Clean up the Dired file name search after terminating isearch."
2526 "Test whether the current search hit is a file name.
2527 Return non-nil if the text from BEG to END is part of a file
2528 name (has the text property `dired-filename')."
2532 t))
2534 ;;;###autoload
2536 "Search for a string using Isearch only in file names in the Dired buffer."
2541 ;;;###autoload
2543 "Search for a regexp using Isearch only in file names in the Dired buffer."
2548 \f
2549 ;; Functions for searching in tags style among marked files.
2551 ;;;###autoload
2553 "Search for a string through all marked files using Isearch."
2558 ;;;###autoload
2560 "Search for a regexp through all marked files using Isearch."
2565 ;;;###autoload
2567 "Search through all marked files for a match for REGEXP.
2568 Stops when a match is found.
2573 ;;;###autoload
2575 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2576 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2587 buffer-read-only))
2594 \f
2595 ;;;###autoload
2597 "Print the type of FILE, according to the `file' command.
2598 If you give a prefix to this command, and FILE is a symbolic
2599 link, then the type of the file linked to by FILE is printed
2600 instead."
2613 ;; Local Variables:
2614 ;; byte-compile-dynamic: t
2615 ;; generated-autoload-file: "dired.el"
2616 ;; End:
2618 ;;; dired-aux.el ends here