| blob | 6186f762e0a891ed8f4c8974ce0cc3401d90ba45 |
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985-1986, 1992, 1994, 1998, 2000-2012
4 ;; Free Software 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 FILE defaults to the file at the mark. (That's the mark set by
59 The prompted-for FILE is the first file given to `diff'.
60 With prefix arg, prompt for second argument SWITCHES,
61 which is the string of command switches for `diff'."
64 ;; Get the file at the mark.
68 ;; Use it as default if it's not the same as the current file,
69 ;; and the target dir is the current dir or the mark is active.
73 mark-active))
74 file-at-mark))
88 target-dir default t))
92 diff-switches
103 ;;;###autoload
105 "Diff this file with its backup file or vice versa.
106 Uses the latest backup, if there are several numerical backups.
107 If this file is a backup, diff it with its original.
108 The backup file is the first file given to `diff'.
109 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
114 diff-switches
116 nil))
119 ;;;###autoload
121 "Mark files with different file attributes in two dired buffers.
122 Compare file attributes of files in the current directory
123 with file attributes in directory DIR2 using PREDICATE on pairs of files
124 with the same name. Mark files for which PREDICATE returns non-nil.
125 Mark files with different names if PREDICATE is nil (or interactively
126 with empty input at the predicate prompt).
128 PREDICATE is a Lisp expression that can refer to the following variables:
130 size1, size2 - file size in bytes
131 mtime1, mtime2 - last modification time in seconds, as a float
132 fa1, fa2 - list of file attributes
133 returned by function `file-attributes'
135 where 1 refers to attribute of file in the current dired buffer
136 and 2 to attribute of file in second dired buffer.
138 Examples of PREDICATE:
140 (> mtime1 mtime2) - mark newer files
141 (not (= size1 size2)) - mark files with different sizes
142 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
143 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
144 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
155 target-dir target-dir t)))
160 file-list1 file-list2)
166 'cadr
168 file-alist1 file-alist2
169 predicate))
171 'cadr
173 file-alist2 file-alist1
174 predicate)))
176 dir1 nil
181 dir2 nil
190 "Combine LIST1 and LIST2 using a set-difference operation.
191 The result list contains all file items that appear in LIST1 but not LIST2.
192 This is a non-destructive function; it makes a copy of the data if necessary
193 to avoid corrupting the original LIST1 and LIST2.
194 PREDICATE (see `dired-compare-directories') is an additional match
195 condition. Two file items are considered to match if they are equal
196 *and* PREDICATE evaluates to t."
198 list1
214 list)
219 "Return a list of all file names and attributes from DIR.
220 List has a form of (file-name full-file-name (attribute-list))."
225 full-file-name
228 \f
229 ;;; Change file attributes
232 ;; Change file attributes (group, owner, timestamp) of marked files and
233 ;; refresh their file lines.
234 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
235 ;; PROGRAM is the program used to change the attribute.
236 ;; OP-SYMBOL is the type of operation (for use in `dired-mark-pop-up').
237 ;; ARG describes which files to use, as in `dired-get-marked-files'.
245 " (default now): "
248 arg files default
254 failures)
266 files))
271 nil))))
273 ;;;###autoload
275 "Change the mode of the marked (or next ARG) files.
276 Symbolic modes like `g+w' are allowed."
291 "Change mode of %s to: "
293 num-modes)
295 ;; We used to treat empty input as DEFAULT, but that is not
296 ;; such a good idea (Bug#9361).
303 file
308 ;;;###autoload
310 "Change the group of the marked (or next ARG) files."
316 ;;;###autoload
318 "Change the owner of the marked (or next ARG) files."
324 ;;;###autoload
326 "Change the timestamp of the marked (or next ARG) files.
327 This calls touch."
331 ;; Process all the files in FILES in batches of a convenient size,
332 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
333 ;; Batches are chosen to need less than MAX chars for the file names,
334 ;; allowing 3 extra characters of separator per file name.
337 past
339 failures)
340 ;; Accumulate files as long as they fit in MAX chars,
341 ;; then process the ones accumulated so far.
346 ;; If we have at least 1 pending file
347 ;; and this file won't fit in the length limit, process now.
350 ;; The elements of PENDING are now in forward order.
351 ;; Do the operation and record failures.
353 failures)
354 ;; Transfer the elements of PENDING onto PAST
355 ;; and clear it out. Now PAST contains the first N files
356 ;; specified (for some N), and FILES contains the rest.
358 pending nil
360 ;; Do (setq pending (cons thisfile pending))
361 ;; but reuse the cons that was in `files'.
369 failures)
370 ;; Now the original list FILES has been put back as it was.
373 ;;;###autoload
375 "Print the marked (or next ARG) files.
376 Uses the shell command coming from variables `lpr-command' and
377 `lpr-switches' as default."
381 "Print %s with: "
386 lpr-switches))
393 "Read args for a Dired marked-files command, prompting with PROMPT.
394 Return the user input (a string).
396 INITIAL, if non-nil, is the initial minibuffer input.
397 OP-SYMBOL is an operation symbol (see `dired-no-confirm').
398 ARG is normally the prefix argument for the calling command;
399 it is passed as the first argument to `dired-mark-prompt'.
400 FILES should be a list of marked files' names.
402 Optional arg DEFAULT-VALUE is a default value or list of default
403 values, passed as the seventh arg to `completing-read'.
405 Optional arg COLLECTION is a collection of possible completions,
406 passed as the second arg to `completing-read'."
408 'completing-read
410 collection nil nil initial nil default-value nil))
411 \f
412 ;;; Cleaning a directory: flagging some backups for deletion.
416 ;;;###autoload
418 "Flag numerical backups for deletion.
419 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
420 Positive prefix arg KEEP overrides `dired-kept-versions';
421 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
424 with a prefix argument."
431 late-retention early-retention)
432 ;; Look at each file.
433 ;; If the file has numeric backup versions,
434 ;; put on dired-file-version-alist an element of the form
435 ;; (FILENAME . VERSION-NUMBER-LIST)
437 ;; Sort each VERSION-NUMBER-LIST,
438 ;; and remove the versions not to be deleted.
446 sorted-v-list)))
450 ;; Look at each file. If it is a numeric backup file,
451 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
455 ;;; Subroutines of dired-clean-directory.
458 ;; Perform FUN with point at the end of each non-directory line.
459 ;; FUN takes one argument, the absolute filename.
476 ;; Only do work if this file is not already in the alist.
478 nil
479 ;; If it looks like file FN has versions, return a list of the versions.
480 ;;That is a list of strings which are file names.
481 ;;The caller may want to flag some of these files for deletion.
486 base-versions
492 dired-file-version-alist)))))))
496 base-version-list)
506 \f
507 ;;; Shell commands
512 "Return a list of all commands associated with current dired files.
513 This function is used to add all related commands retrieved by `mailcap'
514 to the end of the list of defaults just after the default value."
522 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
524 "Read a dired shell command.
526 which is replaced by the value returned by `dired-mark-prompt',
527 with ARG and FILES as its arguments. FILES should be a list of
528 file names. The result is used as the prompt.
530 This normally reads using `read-shell-command', but if the
531 `dired-x' package is loaded, use `dired-guess-shell-command' to
532 offer a smarter default choice of shell command."
544 ;;;###autoload
546 "Run a shell command COMMAND on the marked files asynchronously.
548 Like `dired-do-shell-command', but adds `&' at the end of COMMAND
549 to execute it asynchronously.
551 When operating on multiple files, asynchronous commands
552 are executed in the background on each file in parallel.
553 In shell syntax this means separating the individual commands
554 with `&'. However, when COMMAND ends in `;' or `;&' then commands
555 are executed in the background on each file sequentially waiting
556 for each command to terminate before running the next command.
557 In shell syntax this means separating the individual commands with `;'.
559 The output appears in the buffer `*Async Shell Command*'."
563 ;; Want to give feedback whether this file or marked files are used:
565 current-prefix-arg
566 files)))
571 ;;;###autoload
573 "Run a shell command COMMAND on the marked files.
574 If no files are marked or a numeric prefix arg is given,
576 The prompt mentions the file(s) or the marker, as appropriate.
578 If there is a `*' in COMMAND, surrounded by whitespace, this runs
579 COMMAND just once with the entire file list substituted there.
581 If there is no `*', but there is a `?' in COMMAND, surrounded by
582 whitespace, this runs COMMAND on each file individually with the
583 file name substituted for `?'.
585 Otherwise, this runs COMMAND on each file individually with the
586 file name added at the end of COMMAND (separated by a space).
588 `*' and `?' when not surrounded by whitespace have no special
589 significance for `dired-do-shell-command', and are passed through
590 normally to the shell, but you must confirm first.
592 If you want to use `*' as a shell wildcard with whitespace around
594 `*' in the shell, but avoids Dired's special handling.
596 If COMMAND ends in `&', `;', or `;&', it is executed in the
597 background asynchronously, and the output appears in the buffer
598 `*Async Shell Command*'. When operating on multiple files and COMMAND
599 ends in `&', the shell command is executed on each file in parallel.
600 However, when COMMAND ends in `;' or `;&' then commands are executed
601 in the background on each file sequentially waiting for each command
602 to terminate before running the next command. You can also use
603 `dired-do-async-shell-command' that automatically adds `&'.
605 Otherwise, COMMAND is executed synchronously, and the output
606 appears in the buffer `*Shell Command Output*'.
608 This feature does not try to redisplay Dired buffers afterward, as
609 there's no telling what files COMMAND may have changed.
612 When COMMAND runs, its working directory is the top-level directory
613 of the Dired buffer, so output files usually are created there
614 instead of in a subdir.
616 In a noninteractive call (from Lisp code), you must specify
617 the list of file names explicitly with the FILE-LIST argument, which
618 can be produced by `dired-get-marked-files', for example."
619 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
620 ;;actual work and can be redefined for customization.
624 ;; Want to give feedback whether this file or marked files are used:
626 current-prefix-arg
627 files)))
632 ;; Get confirmation for wildcards that may have been meant
633 ;; to control substitution of a file name or the file name list.
647 nil
648 file-list)
649 ;; execute the shell command
653 ;; Might use {,} for bash or csh:
662 ;; "Make up a shell command line from COMMAND and FILE-LIST.
663 ;; If ON-EACH is t, COMMAND should be applied to each file, else
664 ;; simply concat all files and apply COMMAND to this.
665 ;; FILE-LIST's elements will be quoted for the shell."
666 ;; Might be redefined for smarter things and could then use RAW-ARG
667 ;; (coming from interactive P and currently ignored) to decide what to do.
668 ;; Smart would be a way to access basename or extension of file names.
672 command))
676 command))
685 retval))
692 file-list dired-mark-separator)))
698 ;; This is an extra function so that it can be redefined by ange-ftp.
699 ;;;###autoload
706 ;; Return nil for sake of nconc in dired-bunch-files.
707 nil)
708 \f
711 ; "Display MSG while running PROGRAM, and check for output.
712 ;Remaining arguments are strings passed as command arguments to PROGRAM.
713 ; On error, insert output
714 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
715 ; Caller can cons up a list of failed args.
716 ;Else returns nil for success."
720 ;; Get a clean buffer for error output:
733 nil))))
734 \f
735 ;; Commands that delete or redisplay part of the dired buffer.
738 "Kill the current line (not the files).
739 With a prefix argument, kill that many lines starting with the current line.
740 \(A negative argument kills backward.)"
759 ;;;###autoload
761 "Kill all marked lines (not the files).
762 With a prefix argument, kill that many lines starting with the current line.
763 \(A negative argument kills backward.)
764 If you use this command with a prefix argument to kill the line
765 for a file that is a directory, which you have inserted in the
766 Dired buffer as a subdirectory, then it deletes that subdirectory
767 from the buffer as well.
768 To kill an entire subdirectory \(without killing its line in the
769 parent directory), go to its directory header line and use this
770 command with a prefix argument (the value does not matter)."
771 ;; Returns count of killed lines. FMT="" suppresses message.
789 count))))
791 ;;;###end dired-cmd.el
792 \f
793 ;;; 30K
794 ;;;###begin dired-cp.el
797 ;; Compress or uncompress the current file.
798 ;; Return nil for success, offending filename else.
804 ;; Remove any preexisting entry for the name NEW-FILE.
809 ;; Now replace the current line with an entry for NEW-FILE.
812 from-file)))
818 ;; For .z, try gunzip. It might be an old gzip file,
819 ;; or it might be from compact? pack? (which?) but gunzip handles both.
825 ;; This item controls naming for compression.
827 "Control changes in file name suffixes for compression and uncompression.
828 Each element specifies one transformation rule, and has the form:
829 (REGEXP NEW-SUFFIX PROGRAM)
830 The rule applies when the old file name matches REGEXP.
831 The new file name is computed by deleting the part that matches REGEXP
832 (as well as anything after that), then adding NEW-SUFFIX in its place.
833 If PROGRAM is non-nil, the rule is an uncompression rule,
834 and uncompression is done by running PROGRAM.
837 ;;;###autoload
839 ;; Compress or uncompress FILE.
840 ;; Return the name of the compressed or uncompressed file.
841 ;; Return nil if no change in files.
843 suffix newname
845 ;; See if any suffix rule matches this file name.
851 ;; If so, compute desired new name.
858 nil)
860 ;; We found an uncompression rule.
863 newname))
865 ;;; We don't recognize the file as compressed, so compress it.
866 ;;; Try gzip; if we don't have that, use compress.
872 out-name)))
877 ;; Rename the compressed file to NEWNAME
878 ;; if it hasn't got that name already.
882 newname)
883 out-name)))
887 ;; Don't use NEWNAME with `compress'.
889 \f
891 ;; Request confirmation from the user that the operation described
892 ;; by OP-SYMBOL is to be performed on the marked files.
893 ;; Confirmation consists in a y-or-n question with a file list
894 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
895 ;; The files used are determined by ARG (as in dired-get-marked-files).
898 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
899 ;; is marked pops up a window. That will help the user see
900 ;; it isn't the current line file.
909 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
910 ; and display failures.
912 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
913 ; the short form of the filename) for a failure and probably logs a
914 ; detailed error explanation using function `dired-log'.
916 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
917 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
918 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
919 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
921 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
933 ;; end this bunch of errors:
937 failures)))))
939 ;;;###autoload
941 "Format PROMPT with ARGS, query user, and store the result in SYM.
942 The return value is either nil or t.
944 The user may type y or SPC to accept once; n or DEL to skip once;
945 ! to accept this and subsequent queries; or q or ESC to decline
946 this and subsequent queries.
948 If SYM is already bound to a non-nil value, this function may
949 return automatically without querying the user. If SYM is !,
950 return t; if SYM is q or ESC, return nil."
967 \f
968 ;;;###autoload
970 "Compress or uncompress marked (or next ARG) files."
974 ;; Commands for Emacs Lisp files - load and byte compile
977 ;; Return nil for success, offending file name else.
979 elc-file buffer-read-only failure)
994 nil)))
996 ;;;###autoload
998 "Byte compile marked (or next ARG) Emacs Lisp files."
1003 ;; Return nil for success, offending file name else.
1009 nil
1013 ;;;###autoload
1015 "Load the marked (or next ARG) Emacs Lisp files."
1019 ;;;###autoload
1021 "Redisplay all marked (or next ARG) files.
1022 If on a subdir line, redisplay that subdirectory. In that case,
1023 a prefix arg lets you edit the `ls' switches used for the new listing.
1025 Dired remembers switches specified with a prefix arg, so that reverting
1026 the buffer will not reset them. However, using `dired-undo' to re-insert
1027 or delete subdirectories can bypass this machinery. Hence, you sometimes
1028 may have to reset some subdirectory switches after a `dired-undo'.
1029 You can reset all subdirectory switches to the default using
1031 See Info node `(emacs)Subdir switches' for more details."
1032 ;; Moves point if the next ARG files are redisplayed.
1038 dir
1042 dired-subdir-switches
1043 dired-actual-switches)))))
1045 ;; message much faster than making dired-map-over-marks show progress
1049 ;; Postpone readin hook till we map
1050 ;; over all marked files (Bug#6810).
1054 arg)
1060 "Set `dired-switches-alist' to nil and revert dired buffer."
1064 \f
1066 ;; Delete the current line, and insert an entry for FILE.
1067 ;; If FILE is nil, then just delete the current line.
1068 ;; Keeps any marks that may be present in column one (doing this
1069 ;; here is faster than with dired-add-entry's optional arg).
1070 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1078 ;; Replace space by old marker without moving point.
1079 ;; Faster than goto+insdel inside a save-excursion?
1083 ;;;###autoload
1094 "Add a new dired entry for FILENAME.
1095 Optionally mark it with MARKER-CHAR (a character, else uses
1096 `dired-marker-char'). Note that this adds the entry `out of order'
1097 if files are sorted by time, etc.
1098 Skips files that match `dired-trivial-filenames'.
1099 Exposes hidden subdirectories if a file is added there.
1101 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1102 files matching `dired-omit-regexp'."
1105 ;; Avoid calling ls for files that are going to be omitted anyway.
1111 filename)
1116 filename
1118 ;; Do it!
1121 ;; Entry is always for files, even if they happen to also be directories
1125 reason)
1130 reason
1137 ;; We are already where we should be, except when
1138 ;; point is before the subdir line or its total line.
1142 ;; else try to find correct place to insert
1146 ;; Point is at end of subdir line.
1148 ;; found - skip subdir and `total' line
1149 ;; and uninteresting files like . and ..
1150 ;; This better not move into the next subdir!
1152 ;; not found
1157 ;; Don't expand `.'.
1158 ;; Show just the file name within directory.
1161 directory
1165 ;; Put in desired marker char.
1169 dired-marker-char)))
1171 ;; Compensate for a bug in ange-ftp.
1172 ;; It inserts the file's absolute name, rather than
1173 ;; the relative one. That may be hard to fix since it
1174 ;; is probably controlled by something in ftp.
1190 ;; The subdir-alist is not affected...
1198 ;; return nil if all went well
1199 nil))
1203 ;; Don't do it (dired-omit-mode).
1204 ;; Return t for success (perhaps we should return file-exists-p).
1205 t))
1208 ;; Return pos of first file line of DIR, skipping header and total
1209 ;; or wildcard lines.
1210 ;; Important: never moves into the next subdir.
1211 ;; DIR is assumed to be unhidden.
1220 ;;;###autoload
1233 ;;;###autoload
1235 "Create or update the line for FILE in all Dired buffers it would belong in."
1241 ;; Relist the line for FILE, or just add it if it did not exist.
1242 ;; FILE must be an absolute file name.
1244 ;; If cursor is already on FILE's line delete-region will cause
1245 ;; save-excursion to fail because of floating makers,
1246 ;; moving point to beginning of line. Sigh.
1255 \f
1256 ;;; Copy, move/rename, making hard and symbolic links
1259 "Non-nil if Dired should ask about making backups before overwriting files.
1260 Special value `always' suppresses confirmation."
1266 ;; This is a fluid var used in dired-handle-overwrite. It should be
1267 ;; let-bound whenever dired-copy-file etc are called. See
1268 ;; dired-create-files for an example.
1272 ;; Save old version of file TO that is to be overwritten.
1273 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1274 ;; from dired-create-files.
1277 dired-overwrite-confirmed
1281 "Make backup for existing file `%s'? "
1282 to)))
1286 ;;;###autoload
1290 dired-recursive-copies))
1295 preserve-time top recursive)
1304 ;; This is a directory.
1306 ;; Not a directory.
1310 ;; It is a symlink
1315 dired-create-files-failures)
1318 ;;;###autoload
1322 ;; Silently rename the visited file of any buffer visiting this file.
1327 ;; See if it's an inserted subdir, and rename that, too.
1335 ;; Update visited file name of all affected buffers
1345 to-dir
1346 buffer-file-name)))
1352 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1353 ;; one of its subdirectories is expanded in this buffer.
1361 ;; ELT's subdir is affected by the rename
1364 ;; if top level directory was renamed, lots of things have to be
1365 ;; updated:
1370 ;; with and without wildcards
1372 to))
1375 ;; try to rename buffer, but just leave old name if new
1376 ;; name would already exist (don't try appending "<%d>")
1379 ;; ... we dired TO now:
1383 ;; Update the headerline and dired-subdir-alist element, as well as
1384 ;; dired-switches-alist element, of directory described by
1385 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1386 ;; describes either DIR itself or a subdir of DIR.
1390 buffer-read-only)
1392 ;; Update subdir headerline in buffer
1395 dir)
1400 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1406 \f
1407 ;; Bound in dired-create-files
1411 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1414 "Create one or more new files from a list of existing files FN-LIST.
1415 This function also handles querying the user, updating Dired
1416 buffers, and displaying a success or failure message.
1418 FILE-CREATOR should be a function. It is called once for each
1419 file in FN-LIST, and must create a new file, querying the user
1420 and updating Dired buffers as necessary. It should accept three
1421 arguments: the old file name, the new name, and an argument
1422 OK-IF-ALREADY-EXISTS with the same meaning as in `copy-file'.
1424 OPERATION should be a capitalized string describing the operation
1425 performed (e.g. `Copy'). It is used for error logging.
1427 FN-LIST is the list of files to copy (full absolute file names).
1429 NAME-CONSTRUCTOR should be a function accepting a single
1430 argument, the name of an old file, and returning either the
1431 corresponding new file name or nil to skip.
1433 If optional argument MARKER-CHAR is non-nil, mark each
1434 newly-created file's Dired entry with the character MARKER-CHAR,
1435 or with the current marker character if MARKER-CHAR is t."
1453 Type SPC or `y' to overwrite file `%s',
1454 DEL or `n' to skip to next,
1455 ESC or `q' to not overwrite any of the remaining files,
1459 ;; must determine if FROM is marked before file-creator
1460 ;; gets a chance to delete it (in case of a move).
1465 ;; Handle the `dired-copy-file' file-creator specially
1466 ;; When copying a directory to another directory or
1467 ;; possibly to itself or one of its subdirectories.
1468 ;; e.g "~/foo/" => "~/test/"
1469 ;; or "~/foo/" =>"~/foo/"
1470 ;; or "~/foo/ => ~/foo/bar/")
1471 ;; In this case the 'name-constructor' have set the destination
1472 ;; TO to "~/test/foo" because the old emacs23 behavior
1473 ;; of `copy-directory' was to not create the subdirectory
1474 ;; and instead copy the contents.
1475 ;; With the new behavior of `copy-directory'
1476 ;; (similar to the `cp' shell command) we don't
1477 ;; need such a construction of the target directory,
1478 ;; so modify the destination TO to "~/test/" instead of "~/test/foo/".
1484 ;; If DESTNAME is a subdirectory of FROM, not a symlink,
1485 ;; and the method in use is copying, signal an error.
1490 from to)))
1495 ;; If we get here, file-creator hasn't been aborted
1496 ;; and the old entry (if any) has to be deleted
1497 ;; before adding the new entry.
1505 failures)
1507 operation from to err))))))))
1515 total)
1516 failures))
1522 failures))
1528 skipped))
1533 \f
1535 &optional marker-char op1
1536 how-to)
1537 "Create a new file for each marked file.
1538 Prompt user for a target directory in which to create the new
1539 files. The target may also be a non-directory file, if only
1540 one file is marked. The initial suggestion for target is the
1541 Dired buffer's current directory (or, if `dired-dwim-target' is
1542 non-nil, the current directory of a neighboring Dired window).
1543 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1544 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1545 FILE-CREATOR and OPERATION as in `dired-create-files'.
1546 ARG as in `dired-get-marked-files'.
1547 Optional arg MARKER-CHAR as in `dired-create-files'.
1548 Optional arg OP1 is an alternate form for OPERATION if there is
1549 only one file.
1550 Optional arg HOW-TO determines how to treat the target.
1551 If HOW-TO is nil, use `file-directory-p' to determine if the
1552 target is a directory. If so, the marked file(s) are created
1553 inside that directory. Otherwise, the target is a plain file;
1554 an error is raised unless there is exactly one marked file.
1555 If HOW-TO is t, target is always treated as a plain file.
1556 Otherwise, HOW-TO should be a function of one argument, TARGET.
1557 If its return value is nil, TARGET is regarded as a plain file.
1558 If it return value is a list, TARGET is a generalized
1559 directory (e.g. some sort of archive). The first element of
1560 this list must be a function with at least four arguments:
1561 operation - as OPERATION above.
1562 rfn-list - list of the relative names for the marked files.
1563 fn-list - list of the absolute names for the marked files.
1564 target - the name of the target itself.
1565 The rest of into-dir are optional arguments.
1566 For any other return value, TARGET is treated as a directory."
1575 target-dir)))
1584 target-dir op-symbol arg rfn-list default))))
1586 ;; Allow DOS/Windows users to change the letter
1587 ;; case of a directory. If we don't test these
1588 ;; conditions up front, file-directory-p below
1589 ;; will return t because the filesystem is
1590 ;; case-insensitive, and Emacs will try to move
1591 ;; foo -> foo/foo, which fails.
1594 dired-one-file
1602 nil
1610 ;; rename-file bombs when moving directories unless we do this:
1613 file-creator operation fn-list
1615 ;; This function uses fluid variable target when called
1616 ;; inside dired-create-files:
1621 marker-char))))
1623 ;; Read arguments for a marked-files command that wants a file name,
1624 ;; perhaps popping up the list of marked files.
1625 ;; ARG is the prefix arg and indicates whether the files came from
1626 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1627 ;; If the current file was used, the list has but one element and ARG
1628 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1629 ;; DEFAULT is the default value to return if the user just hits RET;
1630 ;; if it is omitted or nil, then the name of the directory is used.
1635 nil op-symbol files
1640 ;; Try to guess which target directory the user may want.
1641 ;; If there is a dired buffer displayed in one of the next windows,
1642 ;; use its current subdir, else use current subdir of this dired buffer.
1645 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1656 this-dir)))
1659 ;; Return a list of default values for file-reading functions in Dired.
1660 ;; This list may contain directories from Dired buffers in other windows.
1661 ;; `fn-list' is a list of file names used to build a list of defaults.
1662 ;; When nil or more than one element, a list of defaults will
1663 ;; contain only directory names. `target-dir' is a directory name
1664 ;; to exclude from the returned list, for the case when this
1665 ;; directory name is already presented in initial input.
1666 ;; For Dired operations that support `dired-dwim-target',
1667 ;; the argument `target-dir' should have the value returned
1668 ;; from `dired-dwim-target-directory'.
1673 dired-dirs)
1674 ;; Get a list of directories of visible buffers in dired-mode.
1679 ;; Force the current dir to be the first in the list.
1682 ;; Remove the target dir (if specified) or the current dir from
1683 ;; default values, because it should be already in initial input.
1685 ;; Return a list of default values.
1687 ;; For one file operation, provide a list that contains
1688 ;; other directories, other directories with the appended filename
1689 ;; and the current directory with the appended filename, e.g.
1690 ;; 1. /TARGET-DIR/
1691 ;; 2. /TARGET-DIR/FILENAME
1692 ;; 3. /CURRENT-DIR/FILENAME
1701 ;; For multi-file operation, return only a list of other directories.
1702 dired-dirs)))
1704 \f
1705 ;;;###autoload
1707 "Create a directory called DIRECTORY.
1708 If DIRECTORY already exists, signal an error."
1715 ;; Find the topmost nonexistent parent dir (variable `new')
1727 ;; This may not always be what you want, especially if target is your
1728 ;; home directory and it happens to be a symbolic link, as is often the
1729 ;; case with NFS and automounters. Or if you want to make symlinks
1730 ;; into directories that themselves are only symlinks, also quite
1731 ;; common.
1733 ;; So we don't use this function as value for HOW-TO in
1734 ;; dired-do-symlink, which has the minor disadvantage of
1735 ;; making links *into* a symlinked-dir, when you really wanted to
1736 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1737 ;; just have to remove that symlink by hand before making your marked
1738 ;; symlinks.
1741 "Either nil or a function used by `dired-do-copy' to determine target.
1744 ;;;###autoload
1746 "Copy all marked (or next ARG) files, or copy the current file.
1747 When operating on just the current file, prompt for the new name.
1749 When operating on multiple or marked files, prompt for a target
1750 directory, and make the new copies in that directory, with the
1751 same names as the original files. The initial suggestion for the
1752 target directory is the Dired buffer's current directory (or, if
1753 `dired-dwim-target' is non-nil, the current directory of a
1754 neighboring Dired window).
1756 If `dired-copy-preserve-time' is non-nil, this command preserves
1757 the modification time of each old file in the copy, similar to
1760 This command copies symbolic links by creating new ones, similar
1765 "Copy"
1766 arg dired-keep-marker-copy
1767 nil dired-copy-how-to-fn)))
1769 ;;;###autoload
1771 "Make symbolic links to current file or all marked (or next ARG) files.
1772 When operating on just the current file, you specify the new name.
1773 When operating on multiple or marked files, you specify a directory
1774 and new symbolic links are made in that directory
1775 with the same names that the files currently have. The default
1776 suggested for the target directory depends on the value of
1777 `dired-dwim-target', which see.
1784 ;;;###autoload
1786 "Add names (hard links) current file or all marked (or next ARG) files.
1787 When operating on just the current file, you specify the new name.
1788 When operating on multiple or marked files, you specify a directory
1789 and new hard links are made in that directory
1790 with the same names that the files currently have. The default
1791 suggested for the target directory depends on the value of
1792 `dired-dwim-target', which see."
1799 ;; error is caught in -create-files
1801 ;; Update the link count
1804 ;;;###autoload
1806 "Rename current file or all marked (or next ARG) files.
1807 When renaming just the current file, you specify the new name.
1808 When renaming multiple or marked files, you specify a directory.
1809 This command also renames any buffers that are visiting the files.
1810 The default suggested for the target directory depends on the value
1811 of `dired-dwim-target', which see."
1815 ;;;###end dired-cp.el
1816 \f
1817 ;;; 5K
1818 ;;;###begin dired-re.el
1823 ;; Create a new file for each marked file using regexps.
1824 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1825 ;; ARG as in dired-get-marked-files.
1826 ;; Matches each marked file against REGEXP and constructs the new
1827 ;; filename from NEWNAME (like in function replace-match).
1828 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1829 ;; instead of only the non-directory part of the file.
1830 ;; Optional arg MARKER-CHAR as in dired-create-files.
1834 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1835 `!' to %s all remaining matches with no more questions."
1839 ;; Function to construct new filename using REGEXP and NEWNAME:
1844 ;; must bind help-form directly around call to
1845 ;; dired-query
1849 operation-prompt
1850 from
1851 to)
1852 to)
1854 operation from regexp)))))
1855 ;; not whole-name, replace non-directory part only
1866 operation-prompt
1869 to)
1872 rename-regexp-query)
1874 file-creator operation fn-list regexp-name-constructor marker-char)))
1877 ;; Prompt user about performing OPERATION.
1878 ;; Read and return list of: regexp newname arg whole-name.
1891 ;;;###autoload
1893 "Rename selected files whose names match REGEXP to NEWNAME.
1895 With non-zero prefix argument ARG, the command operates on the next ARG
1896 files. Otherwise, it operates on all the marked files, or the current
1897 file if none are marked.
1899 As each match is found, the user must type a character saying
1902 REGEXP defaults to the last regexp used.
1904 With a zero prefix arg, renaming by regexp affects the absolute file name.
1905 Normally, only the non-directory part of the file name is used and changed."
1911 ;;;###autoload
1913 "Copy selected files whose names match REGEXP to NEWNAME.
1914 See function `dired-do-rename-regexp' for more info."
1920 arg regexp newname whole-name dired-keep-marker-copy)))
1922 ;;;###autoload
1924 "Hardlink selected files whose names match REGEXP to NEWNAME.
1925 See function `dired-do-rename-regexp' for more info."
1931 ;;;###autoload
1933 "Symlink selected files whose names match REGEXP to NEWNAME.
1934 See function `dired-do-rename-regexp' for more info."
1944 ;; Perform FILE-CREATOR on the non-directory part of marked files
1945 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1946 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1949 file-creator
1950 operation
1958 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1959 `!' to %s all remaining matches with no more questions."
1966 to))))
1967 dired-keep-marker-rename)))
1972 basename-constructor operation arg))
1974 ;;;###autoload
1976 "Rename all marked (or next ARG) files to upper case."
1980 ;;;###autoload
1982 "Rename all marked (or next ARG) files to lower case."
1986 ;;;###end dired-re.el
1987 \f
1988 ;;; 13K
1989 ;;;###begin dired-ins.el
1991 ;;;###autoload
1993 switches no-error-if-not-dir-p)
1994 "Insert this subdirectory into the same dired buffer.
1996 else inserts it at its natural place (as `ls -lR' would have done).
1997 With a prefix arg, you may edit the ls switches used for this listing.
1998 You can add `R' to the switches to expand the whole tree starting at
1999 this subdirectory.
2000 This function takes some pains to conform to `ls -lR' output.
2002 Dired remembers switches specified with a prefix arg, so that reverting
2003 the buffer will not reset them. However, using `dired-undo' to re-insert
2004 or delete subdirectories can bypass this machinery. Hence, you sometimes
2005 may have to reset some subdirectory switches after a `dired-undo'.
2006 You can reset all subdirectory switches to the default using
2008 See Info node `(emacs)Subdir switches' for more details."
2015 ;; We don't need a marker for opoint as the subdir is always
2016 ;; inserted *after* opoint.
2021 ;; Push mark so that it's easy to find back. Do this after the
2022 ;; insert message so that the user sees the `Mark set' message.
2025 ;;;###autoload
2027 "Insert this subdirectory into the same Dired buffer.
2028 If it is already present, overwrite the previous entry;
2029 otherwise, insert it at its natural place (as `ls -lR' would
2030 have done).
2031 With a prefix arg, you may edit the `ls' switches used for this listing.
2032 You can add `R' to the switches to expand the whole tree starting at
2033 this subdirectory.
2034 This function takes some pains to conform to `ls -lR' output."
2035 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
2036 ;; Prospero where dired-ls does the right thing, but
2037 ;; file-directory-p has not been redefined.
2051 switches-have-R mark-alist case-fold-search buffer-read-only)
2054 ;; case-fold-search is nil now, so we can test for capital `R':
2056 ;; avoid duplicated subdirs
2059 ;; If subdir is already present, remove it and remember its marks
2083 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2084 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2097 ;; all switches that make a difference to dired-get-filename:
2101 ;; Add new DIR at NEW-MARKER. Sort alist.
2106 ;; Keep the alist sorted on buffer position.
2114 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2115 Interactively, you can kill DIRNAME as well by using a prefix argument.
2116 In interactive use, the command prompts for DIRNAME.
2118 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2119 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2130 m-alist))
2133 ;; Find pos for new subdir, according to tree order.
2134 ;;(goto-char (point-max))
2141 ;; Insert NEW-DIR after DIR
2143 alist nil)))
2145 ;; want a separating newline between subdirs
2152 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2153 ;; Move to that buffer position. Return a mark-alist.
2156 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2165 ;; Insert ls output after point.
2166 ;; Return the boundary of the inserted text (as list of BEG and END).
2171 dired-subdir-switches
2174 ;; If doing the top level directory of the buffer,
2175 ;; redo it as specified in dired-directory.
2181 ;; Point is at the correct subdir alist position for ELT,
2182 ;; BEG-END is the subdir-region (as list of begin and end).
2184 ;; update its position (should actually be unchanged)
2187 ;; The hook may depend on the subdir-alist containing the just
2188 ;; inserted subdir, so run it after dired-alist-add:
2196 ;; hook may add or delete lines, but the subdir boundary
2197 ;; marker floats
2201 ;; Lexicographic order on file name components, like `ls -lR':
2202 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2203 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2204 ;; or DIR1 and DIR2 are in the same parentdir and their last
2205 ;; components are string-lessp.
2206 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2207 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2208 ;; if dired-actual-switches contained `t'.
2214 components-2
2226 t)
2228 nil)
2231 ;; There should be a builtin split function - inverse to mapconcat.
2233 "Splitting on regexp PAT, turn string STR into a list of substrings.
2234 Optional third arg LIMIT (>= 1) is a limit to the length of the
2235 resulting list.
2236 Thus, if SEP is a regexp that only matches itself,
2238 (mapconcat 'identity (dired-split SEP STRING) SEP)
2240 is always equal to STRING."
2253 start end)
2254 ))
2261 \f
2262 ;;; moving by subdirectories
2264 ;;;###autoload
2266 "Go to previous subdirectory, regardless of level.
2267 When called interactively and not on a subdir line, go to this subdir's line."
2268 ;;(interactive "p")
2272 ;; if on subdir start already, don't stay there!
2282 ;;;###autoload
2284 "Go to end of header line of DIR in this dired buffer.
2285 Return value of point on success, otherwise return nil.
2291 dired-subdir-alist ; table
2292 nil ; predicate
2293 t ; require-match
2300 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2301 ;; at either \r or \n after this function succeeds.
2304 \f
2305 ;;;###autoload
2307 "Mark all files except `.' and `..' in current subdirectory.
2308 If the Dired buffer shows multiple directories, this command
2309 marks the files listed in the subdirectory that point is in."
2314 ;;;###autoload
2316 "Remove all lines of current subdirectory.
2317 Lower levels are unaffected."
2318 ;; With optional REMEMBER-MARKS, return a mark-alist.
2325 buffer-read-only)
2339 ;; Remove DIR from the alist
2343 ;;;###autoload
2345 "Go up ARG levels in the dired tree."
2351 ;;(setq dir (expand-file-name dir))
2355 ;;;###autoload
2357 "Go down in the dired tree."
2371 \f
2372 ;;; hiding
2388 ;;;###autoload
2390 "Hide or unhide the current subdirectory and move to next directory.
2391 Optional prefix arg is a repeat factor.
2401 buffer-read-only)
2402 ;; keep header line visible, hide rest
2411 ;;;###autoload
2413 "Hide all subdirectories, leaving only their header lines.
2414 If there is already something hidden, make everything visible again.
2419 buffer-read-only)
2423 ;; unhide - bombs on \r in filenames
2425 ;; hide
2432 ;; we're somewhere on current dir's line
2440 ;;;###end dired-ins.el
2442 \f
2443 ;; Search only in file names in the Dired buffer.
2446 "Non-nil to Isearch in file names only.
2447 If t, Isearch in Dired always matches only file names.
2448 If `dwim', Isearch matches file names when initial point position is on
2449 a file name. Otherwise, it searches the whole buffer without restrictions."
2459 "Toggle file names searching on or off.
2460 When on, Isearch skips matches outside file names using the predicate
2461 `dired-isearch-filter-filenames' that matches only at file names.
2462 When off, it uses the original predicate."
2466 dired-isearch-filter-predicate-orig
2471 ;;;###autoload
2473 "Set up isearch to search in Dired file names.
2474 Intended to be added to `isearch-mode-hook'."
2486 "Clean up the Dired file name search after terminating isearch."
2493 "Test whether the current search hit is a visible file name.
2494 Return non-nil if the text from BEG to END is part of a file
2495 name (has the text property `dired-filename') and is visible."
2500 t)))
2502 ;;;###autoload
2504 "Search for a string using Isearch only in file names in the Dired buffer."
2509 ;;;###autoload
2511 "Search for a regexp using Isearch only in file names in the Dired buffer."
2516 \f
2517 ;; Functions for searching in tags style among marked files.
2519 ;;;###autoload
2521 "Search for a string through all marked files using Isearch."
2526 ;;;###autoload
2528 "Search for a regexp through all marked files using Isearch."
2533 ;;;###autoload
2535 "Search through all marked files for a match for REGEXP.
2536 Stops when a match is found.
2541 ;;;###autoload
2543 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2544 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2555 buffer-read-only))
2562 \f
2563 ;;;###autoload
2565 "Print the type of FILE, according to the `file' command.
2566 If you give a prefix to this command, and FILE is a symbolic
2567 link, then the type of the file linked to by FILE is printed
2568 instead."
2581 ;; Local Variables:
2582 ;; byte-compile-dynamic: t
2583 ;; generated-autoload-file: "dired.el"
2584 ;; End:
2586 ;;; dired-aux.el ends here