| blob | 8e4b3b5c6a68b8d8a55af5a8b4550f498569d135 |
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985-1986, 1992, 1994, 1998, 2000-2011
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 options 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
231 "Create initial input value for `touch' command."
232 ;; Nobody can explain what this version is supposed to do. (Bug#6887)
233 ;; Also, the manual says it uses "the present time".
234 ;;; (let (initial)
235 ;;; (while files
236 ;;; (let ((current (nth 5 (file-attributes (car files)))))
237 ;;; (if (and initial (not (equal initial current)))
238 ;;; (setq initial (current-time) files nil)
239 ;;; (setq initial current))
240 ;;; (setq files (cdr files))))
241 ;;; (format-time-string "%Y%m%d%H%M.%S" initial)))
245 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
246 ;; refresh their file lines.
247 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
248 ;; PROGRAM is the program used to change the attribute.
249 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
250 ;; ARG describes which files to use, as in dired-get-marked-files.
256 op-symbol arg files))
258 failures)
269 files))
274 nil))))
276 ;;;###autoload
278 "Change the mode of the marked (or next ARG) files.
279 Symbolic modes like `g+w' are allowed."
294 "Change mode of %s to: " nil
300 file
305 ;;;###autoload
307 "Change the group of the marked (or next ARG) files."
313 ;;;###autoload
315 "Change the owner of the marked (or next ARG) files."
321 ;;;###autoload
323 "Change the timestamp of the marked (or next ARG) files.
324 This calls touch."
328 ;; Process all the files in FILES in batches of a convenient size,
329 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
330 ;; Batches are chosen to need less than MAX chars for the file names,
331 ;; allowing 3 extra characters of separator per file name.
334 past
336 failures)
337 ;; Accumulate files as long as they fit in MAX chars,
338 ;; then process the ones accumulated so far.
343 ;; If we have at least 1 pending file
344 ;; and this file won't fit in the length limit, process now.
347 ;; The elements of PENDING are now in forward order.
348 ;; Do the operation and record failures.
350 failures)
351 ;; Transfer the elemens of PENDING onto PAST
352 ;; and clear it out. Now PAST contains the first N files
353 ;; specified (for some N), and FILES contains the rest.
355 pending nil
357 ;; Do (setq pending (cons thisfile pending))
358 ;; but reuse the cons that was in `files'.
366 failures)
367 ;; Now the original list FILES has been put back as it was.
370 ;;;###autoload
372 "Print the marked (or next ARG) files.
373 Uses the shell command coming from variables `lpr-command' and
374 `lpr-switches' as default."
378 "Print %s with: "
383 lpr-switches))
388 ;; Read arguments for a marked-files command that wants a string
389 ;; that is not a file name,
390 ;; perhaps popping up the list of marked files.
391 ;; ARG is the prefix arg and indicates whether the files came from
392 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
393 ;; If the current file was used, the list has but one element and ARG
394 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
397 ;; PROMPT for a string, with INITIAL input and DEFAULT value.
398 ;; Other args are used to give user feedback and pop-up:
399 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
401 nil op-symbol files
404 \f
405 ;;; Cleaning a directory: flagging some backups for deletion.
409 ;;;###autoload
411 "Flag numerical backups for deletion.
412 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
413 Positive prefix arg KEEP overrides `dired-kept-versions';
414 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
417 with a prefix argument."
424 late-retention early-retention)
425 ;; Look at each file.
426 ;; If the file has numeric backup versions,
427 ;; put on dired-file-version-alist an element of the form
428 ;; (FILENAME . VERSION-NUMBER-LIST)
430 ;; Sort each VERSION-NUMBER-LIST,
431 ;; and remove the versions not to be deleted.
439 sorted-v-list)))
443 ;; Look at each file. If it is a numeric backup file,
444 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
448 ;;; Subroutines of dired-clean-directory.
451 ;; Perform FUN with point at the end of each non-directory line.
452 ;; FUN takes one argument, the absolute filename.
469 ;; Only do work if this file is not already in the alist.
471 nil
472 ;; If it looks like file FN has versions, return a list of the versions.
473 ;;That is a list of strings which are file names.
474 ;;The caller may want to flag some of these files for deletion.
479 base-versions
485 dired-file-version-alist)))))))
489 base-version-list)
499 \f
500 ;;; Shell commands
505 "Return a list of all commands associated with current dired files.
506 This function is used to add all related commands retrieved by `mailcap'
507 to the end of the list of defaults just after the default value."
515 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
517 "Read a dired shell command prompting with PROMPT.
518 Passes the prefix argument ARG to `dired-mark-prompt', so that it
519 can be used in the prompt to indicate which FILES are affected.
520 Normally reads the command with `read-shell-command', but if the
521 `dired-x' packages is loaded, uses `dired-guess-shell-command' to offer
522 a smarter default choice of shell command."
534 ;;;###autoload
536 "Run a shell command COMMAND on the marked files asynchronously.
538 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
539 adds `* &' surrounded by whitespace and executes the command asynchronously.
540 The output appears in the buffer `*Async Shell Command*'."
544 ;; Want to give feedback whether this file or marked files are used:
546 current-prefix-arg
547 files)))
554 ;; The in-background argument is only needed in Emacs 18 where
555 ;; shell-command doesn't understand an appended ampersand `&'.
556 ;;;###autoload
558 "Run a shell command COMMAND on the marked files.
559 If no files are marked or a specific numeric prefix arg is given,
561 The prompt mentions the file(s) or the marker, as appropriate.
563 If there is a `*' in COMMAND, surrounded by whitespace, this runs
564 COMMAND just once with the entire file list substituted there.
566 If there is no `*', but there is a `?' in COMMAND, surrounded by
567 whitespace, this runs COMMAND on each file individually with the
568 file name substituted for `?'.
570 Otherwise, this runs COMMAND on each file individually with the
571 file name added at the end of COMMAND (separated by a space).
573 `*' and `?' when not surrounded by whitespace have no special
574 significance for `dired-do-shell-command', and are passed through
575 normally to the shell, but you must confirm first. To pass `*' by
578 If COMMAND produces output, it goes to a separate buffer.
580 This feature does not try to redisplay Dired buffers afterward, as
581 there's no telling what files COMMAND may have changed.
584 When COMMAND runs, its working directory is the top-level directory
585 of the Dired buffer, so output files usually are created there
586 instead of in a subdir.
588 In a noninteractive call (from Lisp code), you must specify
589 the list of file names explicitly with the FILE-LIST argument, which
590 can be produced by `dired-get-marked-files', for example."
591 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
592 ;;actual work and can be redefined for customization.
596 ;; Want to give feedback whether this file or marked files are used:
599 current-prefix-arg
600 files)
601 current-prefix-arg
602 files)))
607 ;; Get confirmation for wildcards that may have been meant
608 ;; to control substitution of a file name or the file name list.
622 nil
623 file-list)
624 ;; execute the shell command
628 ;; Might use {,} for bash or csh:
637 ;; "Make up a shell command line from COMMAND and FILE-LIST.
638 ;; If ON-EACH is t, COMMAND should be applied to each file, else
639 ;; simply concat all files and apply COMMAND to this.
640 ;; FILE-LIST's elements will be quoted for the shell."
641 ;; Might be redefined for smarter things and could then use RAW-ARG
642 ;; (coming from interactive P and currently ignored) to decide what to do.
643 ;; Smart would be a way to access basename or extension of file names.
652 retval))
657 file-list dired-mark-separator)))
662 ;; This is an extra function so that it can be redefined by ange-ftp.
663 ;;;###autoload
670 ;; Return nil for sake of nconc in dired-bunch-files.
671 nil)
672 \f
675 ; "Display MSG while running PROGRAM, and check for output.
676 ;Remaining arguments are strings passed as command arguments to PROGRAM.
677 ; On error, insert output
678 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
679 ; Caller can cons up a list of failed args.
680 ;Else returns nil for success."
684 ;; Get a clean buffer for error output:
697 nil))))
698 \f
699 ;; Commands that delete or redisplay part of the dired buffer.
720 ;;;###autoload
722 "Kill all marked lines (not the files).
723 With a prefix argument, kill that many lines starting with the current line.
724 \(A negative argument kills backward.)
725 If you use this command with a prefix argument to kill the line
726 for a file that is a directory, which you have inserted in the
727 Dired buffer as a subdirectory, then it deletes that subdirectory
728 from the buffer as well.
729 To kill an entire subdirectory \(without killing its line in the
730 parent directory), go to its directory header line and use this
731 command with a prefix argument (the value does not matter)."
732 ;; Returns count of killed lines. FMT="" suppresses message.
750 count))))
752 ;;;###end dired-cmd.el
753 \f
754 ;;; 30K
755 ;;;###begin dired-cp.el
758 ;; Compress or uncompress the current file.
759 ;; Return nil for success, offending filename else.
765 ;; Remove any preexisting entry for the name NEW-FILE.
770 ;; Now replace the current line with an entry for NEW-FILE.
773 from-file)))
779 ;; For .z, try gunzip. It might be an old gzip file,
780 ;; or it might be from compact? pack? (which?) but gunzip handles both.
786 ;; This item controls naming for compression.
788 "Control changes in file name suffixes for compression and uncompression.
789 Each element specifies one transformation rule, and has the form:
790 (REGEXP NEW-SUFFIX PROGRAM)
791 The rule applies when the old file name matches REGEXP.
792 The new file name is computed by deleting the part that matches REGEXP
793 (as well as anything after that), then adding NEW-SUFFIX in its place.
794 If PROGRAM is non-nil, the rule is an uncompression rule,
795 and uncompression is done by running PROGRAM.
798 ;;;###autoload
800 ;; Compress or uncompress FILE.
801 ;; Return the name of the compressed or uncompressed file.
802 ;; Return nil if no change in files.
804 suffix newname
806 ;; See if any suffix rule matches this file name.
812 ;; If so, compute desired new name.
819 nil)
821 ;; We found an uncompression rule.
824 newname))
826 ;;; We don't recognize the file as compressed, so compress it.
827 ;;; Try gzip; if we don't have that, use compress.
833 out-name)))
838 ;; Rename the compressed file to NEWNAME
839 ;; if it hasn't got that name already.
843 newname)
844 out-name)))
848 ;; Don't use NEWNAME with `compress'.
850 \f
852 ;; Request confirmation from the user that the operation described
853 ;; by OP-SYMBOL is to be performed on the marked files.
854 ;; Confirmation consists in a y-or-n question with a file list
855 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
856 ;; The files used are determined by ARG (as in dired-get-marked-files).
859 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
860 ;; is marked pops up a window. That will help the user see
861 ;; it isn't the current line file.
870 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
871 ; and display failures.
873 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
874 ; the short form of the filename) for a failure and probably logs a
875 ; detailed error explanation using function `dired-log'.
877 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
878 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
879 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
880 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
882 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
894 ;; end this bunch of errors:
898 failures)))))
900 ;;;###autoload
902 "Format PROMPT with ARGS, query user, and store the result in SYM.
903 The return value is either nil or t.
905 The user may type y or SPC to accept once; n or DEL to skip once;
906 ! to accept this and subsequent queries; or q or ESC to decline
907 this and subsequent queries.
909 If SYM is already bound to a non-nil value, this function may
910 return automatically without querying the user. If SYM is !,
911 return t; if SYM is q or ESC, return nil."
929 \f
930 ;;;###autoload
932 "Compress or uncompress marked (or next ARG) files."
936 ;; Commands for Emacs Lisp files - load and byte compile
939 ;; Return nil for success, offending file name else.
941 elc-file buffer-read-only failure)
956 nil)))
958 ;;;###autoload
960 "Byte compile marked (or next ARG) Emacs Lisp files."
965 ;; Return nil for success, offending file name else.
971 nil
975 ;;;###autoload
977 "Load the marked (or next ARG) Emacs Lisp files."
981 ;;;###autoload
983 "Redisplay all marked (or next ARG) files.
984 If on a subdir line, redisplay that subdirectory. In that case,
985 a prefix arg lets you edit the `ls' switches used for the new listing.
987 Dired remembers switches specified with a prefix arg, so that reverting
988 the buffer will not reset them. However, using `dired-undo' to re-insert
989 or delete subdirectories can bypass this machinery. Hence, you sometimes
990 may have to reset some subdirectory switches after a `dired-undo'.
991 You can reset all subdirectory switches to the default using
993 See Info node `(emacs)Subdir switches' for more details."
994 ;; Moves point if the next ARG files are redisplayed.
1000 dir
1004 dired-subdir-switches
1005 dired-actual-switches)))))
1007 ;; message much faster than making dired-map-over-marks show progress
1011 ;; Postphone readin hook till we map
1012 ;; over all marked files (Bug#6810).
1016 arg)
1022 "Set `dired-switches-alist' to nil and revert dired buffer."
1026 \f
1028 ;; Delete the current line, and insert an entry for FILE.
1029 ;; If FILE is nil, then just delete the current line.
1030 ;; Keeps any marks that may be present in column one (doing this
1031 ;; here is faster than with dired-add-entry's optional arg).
1032 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1040 ;; Replace space by old marker without moving point.
1041 ;; Faster than goto+insdel inside a save-excursion?
1045 ;;;###autoload
1056 "Add a new dired entry for FILENAME.
1057 Optionally mark it with MARKER-CHAR (a character, else uses
1058 `dired-marker-char'). Note that this adds the entry `out of order'
1059 if files are sorted by time, etc.
1060 Skips files that match `dired-trivial-filenames'.
1061 Exposes hidden subdirectories if a file is added there.
1063 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1064 files matching `dired-omit-regexp'."
1067 ;; Avoid calling ls for files that are going to be omitted anyway.
1073 filename)
1078 filename
1080 ;; Do it!
1083 ;; Entry is always for files, even if they happen to also be directories
1087 reason)
1092 reason
1099 ;; We are already where we should be, except when
1100 ;; point is before the subdir line or its total line.
1104 ;; else try to find correct place to insert
1108 ;; Point is at end of subdir line.
1110 ;; found - skip subdir and `total' line
1111 ;; and uninteresting files like . and ..
1112 ;; This better not move into the next subdir!
1114 ;; not found
1119 ;; Don't expand `.'.
1120 ;; Show just the file name within directory.
1123 directory
1127 ;; Put in desired marker char.
1131 dired-marker-char)))
1133 ;; Compensate for a bug in ange-ftp.
1134 ;; It inserts the file's absolute name, rather than
1135 ;; the relative one. That may be hard to fix since it
1136 ;; is probably controlled by something in ftp.
1152 ;; The subdir-alist is not affected...
1160 ;; return nil if all went well
1161 nil))
1165 ;; Don't do it (dired-omit-mode).
1166 ;; Return t for success (perhaps we should return file-exists-p).
1167 t))
1170 ;; Return pos of first file line of DIR, skipping header and total
1171 ;; or wildcard lines.
1172 ;; Important: never moves into the next subdir.
1173 ;; DIR is assumed to be unhidden.
1182 ;;;###autoload
1195 ;;;###autoload
1197 "Create or update the line for FILE in all Dired buffers it would belong in."
1203 ;; Relist the line for FILE, or just add it if it did not exist.
1204 ;; FILE must be an absolute file name.
1206 ;; If cursor is already on FILE's line delete-region will cause
1207 ;; save-excursion to fail because of floating makers,
1208 ;; moving point to beginning of line. Sigh.
1217 \f
1218 ;;; Copy, move/rename, making hard and symbolic links
1221 "Non-nil if Dired should ask about making backups before overwriting files.
1222 Special value `always' suppresses confirmation."
1228 ;; This is a fluid var used in dired-handle-overwrite. It should be
1229 ;; let-bound whenever dired-copy-file etc are called. See
1230 ;; dired-create-files for an example.
1234 ;; Save old version of file TO that is to be overwritten.
1235 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1236 ;; from dired-create-files.
1239 dired-overwrite-confirmed
1243 "Make backup for existing file `%s'? "
1244 to)))
1248 ;;;###autoload
1252 dired-recursive-copies))
1257 preserve-time top recursive)
1263 ;; This is a directory.
1265 ;; Not a directory.
1269 ;; It is a symlink
1274 dired-create-files-failures)
1277 ;;;###autoload
1281 ;; Silently rename the visited file of any buffer visiting this file.
1286 ;; See if it's an inserted subdir, and rename that, too.
1294 ;; Update visited file name of all affected buffers
1304 to-dir
1305 buffer-file-name)))
1311 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1312 ;; one of its subdirectories is expanded in this buffer.
1320 ;; ELT's subdir is affected by the rename
1323 ;; if top level directory was renamed, lots of things have to be
1324 ;; updated:
1329 ;; with and without wildcards
1331 to))
1334 ;; try to rename buffer, but just leave old name if new
1335 ;; name would already exist (don't try appending "<%d>")
1338 ;; ... we dired TO now:
1342 ;; Update the headerline and dired-subdir-alist element, as well as
1343 ;; dired-switches-alist element, of directory described by
1344 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1345 ;; describes either DIR itself or a subdir of DIR.
1349 buffer-read-only)
1351 ;; Update subdir headerline in buffer
1354 dir)
1359 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1365 \f
1366 ;; Bound in dired-create-files
1370 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1373 "Create one or more new files from a list of existing files FN-LIST.
1374 This function also handles querying the user, updating Dired
1375 buffers, and displaying a success or failure message.
1377 FILE-CREATOR should be a function. It is called once for each
1378 file in FN-LIST, and must create a new file, querying the user
1379 and updating Dired buffers as necessary. It should accept three
1380 arguments: the old file name, the new name, and an argument
1381 OK-IF-ALREADY-EXISTS with the same meaning as in `copy-file'.
1383 OPERATION should be a capitalized string describing the operation
1384 performed (e.g. `Copy'). It is used for error logging.
1386 FN-LIST is the list of files to copy (full absolute file names).
1388 NAME-CONSTRUCTOR should be a function accepting a single
1389 argument, the name of an old file, and returning either the
1390 corresponding new file name or nil to skip.
1392 Optional MARKER-CHAR is a character with which to mark every
1393 newfile's entry, or t to use the current marker character if the
1394 old file was marked."
1412 Type SPC or `y' to overwrite file `%s',
1413 DEL or `n' to skip to next,
1414 ESC or `q' to not overwrite any of the remaining files,
1418 ;; must determine if FROM is marked before file-creator
1419 ;; gets a chance to delete it (in case of a move).
1432 ;; If we get here, file-creator hasn't been aborted
1433 ;; and the old entry (if any) has to be deleted
1434 ;; before adding the new entry.
1442 failures)
1444 operation from to err))))))))
1452 total)
1453 failures))
1459 failures))
1465 skipped))
1470 \f
1472 &optional marker-char op1
1473 how-to)
1474 "Create a new file for each marked file.
1475 Prompts user for target, which is a directory in which to create
1476 the new files. Target may also be a plain file if only one marked
1477 file exists. The way the default for the target directory is
1478 computed depends on the value of `dired-dwim-target-directory'.
1479 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1480 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1481 FILE-CREATOR and OPERATION as in `dired-create-files'.
1482 ARG as in `dired-get-marked-files'.
1483 Optional arg MARKER-CHAR as in `dired-create-files'.
1484 Optional arg OP1 is an alternate form for OPERATION if there is
1485 only one file.
1486 Optional arg HOW-TO determiness how to treat the target.
1487 If HOW-TO is nil, use `file-directory-p' to determine if the
1488 target is a directory. If so, the marked file(s) are created
1489 inside that directory. Otherwise, the target is a plain file;
1490 an error is raised unless there is exactly one marked file.
1491 If HOW-TO is t, target is always treated as a plain file.
1492 Otherwise, HOW-TO should be a function of one argument, TARGET.
1493 If its return value is nil, TARGET is regarded as a plain file.
1494 If it return value is a list, TARGET is a generalized
1495 directory (e.g. some sort of archive). The first element of
1496 this list must be a function with at least four arguments:
1497 operation - as OPERATION above.
1498 rfn-list - list of the relative names for the marked files.
1499 fn-list - list of the absolute names for the marked files.
1500 target - the name of the target itself.
1501 The rest of into-dir are optional arguments.
1502 For any other return value, TARGET is treated as a directory."
1511 target-dir)))
1520 target-dir op-symbol arg rfn-list default))))
1522 ;; Allow DOS/Windows users to change the letter
1523 ;; case of a directory. If we don't test these
1524 ;; conditions up front, file-directory-p below
1525 ;; will return t because the filesystem is
1526 ;; case-insensitive, and Emacs will try to move
1527 ;; foo -> foo/foo, which fails.
1530 dired-one-file
1538 nil
1546 ;; rename-file bombs when moving directories unless we do this:
1549 file-creator operation fn-list
1551 ;; This function uses fluid variable target when called
1552 ;; inside dired-create-files:
1557 marker-char))))
1559 ;; Read arguments for a marked-files command that wants a file name,
1560 ;; perhaps popping up the list of marked files.
1561 ;; ARG is the prefix arg and indicates whether the files came from
1562 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1563 ;; If the current file was used, the list has but one element and ARG
1564 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1565 ;; DEFAULT is the default value to return if the user just hits RET;
1566 ;; if it is omitted or nil, then the name of the directory is used.
1571 nil op-symbol files
1576 ;; Try to guess which target directory the user may want.
1577 ;; If there is a dired buffer displayed in one of the next windows,
1578 ;; use its current subdir, else use current subdir of this dired buffer.
1581 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1592 this-dir)))
1595 ;; Return a list of default values for file-reading functions in Dired.
1596 ;; This list may contain directories from Dired buffers in other windows.
1597 ;; `fn-list' is a list of file names used to build a list of defaults.
1598 ;; When nil or more than one element, a list of defaults will
1599 ;; contain only directory names. `target-dir' is a directory name
1600 ;; to exclude from the returned list, for the case when this
1601 ;; directory name is already presented in initial input.
1602 ;; For Dired operations that support `dired-dwim-target',
1603 ;; the argument `target-dir' should have the value returned
1604 ;; from `dired-dwim-target-directory'.
1609 dired-dirs)
1610 ;; Get a list of directories of visible buffers in dired-mode.
1615 ;; Force the current dir to be the first in the list.
1618 ;; Remove the target dir (if specified) or the current dir from
1619 ;; default values, because it should be already in initial input.
1621 ;; Return a list of default values.
1623 ;; For one file operation, provide a list that contains
1624 ;; other directories, other directories with the appended filename
1625 ;; and the current directory with the appended filename, e.g.
1626 ;; 1. /TARGET-DIR/
1627 ;; 2. /TARGET-DIR/FILENAME
1628 ;; 3. /CURRENT-DIR/FILENAME
1637 ;; For multi-file operation, return only a list of other directories.
1638 dired-dirs)))
1640 \f
1641 ;;;###autoload
1643 "Create a directory called DIRECTORY.
1644 If DIRECTORY already exists, signal an error."
1651 ;; Find the topmost nonexistent parent dir (variable `new')
1663 ;; This may not always be what you want, especially if target is your
1664 ;; home directory and it happens to be a symbolic link, as is often the
1665 ;; case with NFS and automounters. Or if you want to make symlinks
1666 ;; into directories that themselves are only symlinks, also quite
1667 ;; common.
1669 ;; So we don't use this function as value for HOW-TO in
1670 ;; dired-do-symlink, which has the minor disadvantage of
1671 ;; making links *into* a symlinked-dir, when you really wanted to
1672 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1673 ;; just have to remove that symlink by hand before making your marked
1674 ;; symlinks.
1677 "Either nil or a function used by `dired-do-copy' to determine target.
1680 ;;;###autoload
1682 "Copy all marked (or next ARG) files, or copy the current file.
1683 This normally preserves the last-modified date when copying.
1684 When operating on just the current file, you specify the new name.
1685 When operating on multiple or marked files, you specify a directory,
1686 and new copies of these files are made in that directory
1687 with the same names that the files currently have. The default
1688 suggested for the target directory depends on the value of
1689 `dired-dwim-target', which see.
1691 This command copies symbolic links by creating new ones,
1692 like `cp -d'."
1696 "Copy"
1697 arg dired-keep-marker-copy
1698 nil dired-copy-how-to-fn)))
1700 ;;;###autoload
1702 "Make symbolic links to current file or all marked (or next ARG) files.
1703 When operating on just the current file, you specify the new name.
1704 When operating on multiple or marked files, you specify a directory
1705 and new symbolic links are made in that directory
1706 with the same names that the files currently have. The default
1707 suggested for the target directory depends on the value of
1708 `dired-dwim-target', which see.
1715 ;;;###autoload
1717 "Add names (hard links) current file or all marked (or next ARG) files.
1718 When operating on just the current file, you specify the new name.
1719 When operating on multiple or marked files, you specify a directory
1720 and new hard links are made in that directory
1721 with the same names that the files currently have. The default
1722 suggested for the target directory depends on the value of
1723 `dired-dwim-target', which see."
1730 ;; error is caught in -create-files
1732 ;; Update the link count
1735 ;;;###autoload
1737 "Rename current file or all marked (or next ARG) files.
1738 When renaming just the current file, you specify the new name.
1739 When renaming multiple or marked files, you specify a directory.
1740 This command also renames any buffers that are visiting the files.
1741 The default suggested for the target directory depends on the value
1742 of `dired-dwim-target', which see."
1746 ;;;###end dired-cp.el
1747 \f
1748 ;;; 5K
1749 ;;;###begin dired-re.el
1754 ;; Create a new file for each marked file using regexps.
1755 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1756 ;; ARG as in dired-get-marked-files.
1757 ;; Matches each marked file against REGEXP and constructs the new
1758 ;; filename from NEWNAME (like in function replace-match).
1759 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1760 ;; instead of only the non-directory part of the file.
1761 ;; Optional arg MARKER-CHAR as in dired-create-files.
1765 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1766 `!' to %s all remaining matches with no more questions."
1770 ;; Function to construct new filename using REGEXP and NEWNAME:
1775 ;; must bind help-form directly around call to
1776 ;; dired-query
1780 operation-prompt
1781 from
1782 to)
1783 to)
1785 operation from regexp)))))
1786 ;; not whole-name, replace non-directory part only
1797 operation-prompt
1800 to)
1803 rename-regexp-query)
1805 file-creator operation fn-list regexp-name-constructor marker-char)))
1808 ;; Prompt user about performing OPERATION.
1809 ;; Read and return list of: regexp newname arg whole-name.
1822 ;;;###autoload
1824 "Rename selected files whose names match REGEXP to NEWNAME.
1826 With non-zero prefix argument ARG, the command operates on the next ARG
1827 files. Otherwise, it operates on all the marked files, or the current
1828 file if none are marked.
1830 As each match is found, the user must type a character saying
1833 REGEXP defaults to the last regexp used.
1835 With a zero prefix arg, renaming by regexp affects the absolute file name.
1836 Normally, only the non-directory part of the file name is used and changed."
1842 ;;;###autoload
1844 "Copy selected files whose names match REGEXP to NEWNAME.
1845 See function `dired-do-rename-regexp' for more info."
1851 arg regexp newname whole-name dired-keep-marker-copy)))
1853 ;;;###autoload
1855 "Hardlink selected files whose names match REGEXP to NEWNAME.
1856 See function `dired-do-rename-regexp' for more info."
1862 ;;;###autoload
1864 "Symlink selected files whose names match REGEXP to NEWNAME.
1865 See function `dired-do-rename-regexp' for more info."
1875 ;; Perform FILE-CREATOR on the non-directory part of marked files
1876 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1877 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1880 file-creator
1881 operation
1889 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1890 `!' to %s all remaining matches with no more questions."
1897 to))))
1898 dired-keep-marker-rename)))
1903 basename-constructor operation arg))
1905 ;;;###autoload
1907 "Rename all marked (or next ARG) files to upper case."
1911 ;;;###autoload
1913 "Rename all marked (or next ARG) files to lower case."
1917 ;;;###end dired-re.el
1918 \f
1919 ;;; 13K
1920 ;;;###begin dired-ins.el
1922 ;;;###autoload
1924 switches no-error-if-not-dir-p)
1925 "Insert this subdirectory into the same dired buffer.
1927 else inserts it at its natural place (as `ls -lR' would have done).
1928 With a prefix arg, you may edit the ls switches used for this listing.
1929 You can add `R' to the switches to expand the whole tree starting at
1930 this subdirectory.
1931 This function takes some pains to conform to `ls -lR' output.
1933 Dired remembers switches specified with a prefix arg, so that reverting
1934 the buffer will not reset them. However, using `dired-undo' to re-insert
1935 or delete subdirectories can bypass this machinery. Hence, you sometimes
1936 may have to reset some subdirectory switches after a `dired-undo'.
1937 You can reset all subdirectory switches to the default using
1939 See Info node `(emacs)Subdir switches' for more details."
1946 ;; We don't need a marker for opoint as the subdir is always
1947 ;; inserted *after* opoint.
1952 ;; Push mark so that it's easy to find back. Do this after the
1953 ;; insert message so that the user sees the `Mark set' message.
1956 ;;;###autoload
1958 "Insert this subdirectory into the same dired buffer.
1959 If it is already present, overwrites previous entry,
1960 else inserts it at its natural place (as `ls -lR' would have done).
1961 With a prefix arg, you may edit the `ls' switches used for this listing.
1962 You can add `R' to the switches to expand the whole tree starting at
1963 this subdirectory.
1964 This function takes some pains to conform to `ls -lR' output."
1965 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1966 ;; Prospero where dired-ls does the right thing, but
1967 ;; file-directory-p has not been redefined.
1981 switches-have-R mark-alist case-fold-search buffer-read-only)
1984 ;; case-fold-search is nil now, so we can test for capital `R':
1986 ;; avoid duplicated subdirs
1989 ;; If subdir is already present, remove it and remember its marks
2013 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2014 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2027 ;; all switches that make a difference to dired-get-filename:
2031 ;; Add new DIR at NEW-MARKER. Sort alist.
2036 ;; Keep the alist sorted on buffer position.
2044 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2045 Interactively, you can kill DIRNAME as well by using a prefix argument.
2046 In interactive use, the command prompts for DIRNAME.
2048 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2049 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2060 m-alist))
2063 ;; Find pos for new subdir, according to tree order.
2064 ;;(goto-char (point-max))
2071 ;; Insert NEW-DIR after DIR
2073 alist nil)))
2075 ;; want a separating newline between subdirs
2082 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2083 ;; Move to that buffer position. Return a mark-alist.
2086 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2095 ;; Insert ls output after point.
2096 ;; Return the boundary of the inserted text (as list of BEG and END).
2101 dired-subdir-switches
2104 ;; If doing the top level directory of the buffer,
2105 ;; redo it as specified in dired-directory.
2111 ;; Point is at the correct subdir alist position for ELT,
2112 ;; BEG-END is the subdir-region (as list of begin and end).
2114 ;; update its position (should actually be unchanged)
2117 ;; The hook may depend on the subdir-alist containing the just
2118 ;; inserted subdir, so run it after dired-alist-add:
2126 ;; hook may add or delete lines, but the subdir boundary
2127 ;; marker floats
2131 ;; Lexicographic order on file name components, like `ls -lR':
2132 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2133 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2134 ;; or DIR1 and DIR2 are in the same parentdir and their last
2135 ;; components are string-lessp.
2136 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2137 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2138 ;; if dired-actual-switches contained `t'.
2144 components-2
2156 t)
2158 nil)
2161 ;; There should be a builtin split function - inverse to mapconcat.
2163 "Splitting on regexp PAT, turn string STR into a list of substrings.
2164 Optional third arg LIMIT (>= 1) is a limit to the length of the
2165 resulting list.
2166 Thus, if SEP is a regexp that only matches itself,
2168 (mapconcat 'identity (dired-split SEP STRING) SEP)
2170 is always equal to STRING."
2183 start end)
2184 ))
2191 \f
2192 ;;; moving by subdirectories
2194 ;;;###autoload
2196 "Go to previous subdirectory, regardless of level.
2197 When called interactively and not on a subdir line, go to this subdir's line."
2198 ;;(interactive "p")
2202 ;; if on subdir start already, don't stay there!
2212 ;;;###autoload
2214 "Go to end of header line of DIR in this dired buffer.
2215 Return value of point on success, otherwise return nil.
2221 dired-subdir-alist ; table
2222 nil ; predicate
2223 t ; require-match
2230 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2231 ;; at either \r or \n after this function succeeds.
2234 \f
2235 ;;;###autoload
2237 "Mark all files except `.' and `..' in current subdirectory.
2238 If the Dired buffer shows multiple directories, this command
2239 marks the files listed in the subdirectory that point is in."
2244 ;;;###autoload
2246 "Remove all lines of current subdirectory.
2247 Lower levels are unaffected."
2248 ;; With optional REMEMBER-MARKS, return a mark-alist.
2255 buffer-read-only)
2269 ;; Remove DIR from the alist
2273 ;;;###autoload
2275 "Go up ARG levels in the dired tree."
2281 ;;(setq dir (expand-file-name dir))
2285 ;;;###autoload
2287 "Go down in the dired tree."
2301 \f
2302 ;;; hiding
2318 ;;;###autoload
2320 "Hide or unhide the current subdirectory and move to next directory.
2321 Optional prefix arg is a repeat factor.
2331 buffer-read-only)
2332 ;; keep header line visible, hide rest
2341 ;;;###autoload
2343 "Hide all subdirectories, leaving only their header lines.
2344 If there is already something hidden, make everything visible again.
2349 buffer-read-only)
2353 ;; unhide - bombs on \r in filenames
2355 ;; hide
2362 ;; we're somewhere on current dir's line
2370 ;;;###end dired-ins.el
2372 \f
2373 ;; Search only in file names in the Dired buffer.
2376 "Non-nil to Isearch in file names only.
2377 If t, Isearch in Dired always matches only file names.
2378 If `dwim', Isearch matches file names when initial point position is on
2379 a file name. Otherwise, it searches the whole buffer without restrictions."
2389 "Toggle file names searching on or off.
2390 When on, Isearch skips matches outside file names using the predicate
2391 `dired-isearch-filter-filenames' that matches only at file names.
2392 When off, it uses the original predicate."
2396 dired-isearch-filter-predicate-orig
2401 ;;;###autoload
2403 "Set up isearch to search in Dired file names.
2404 Intended to be added to `isearch-mode-hook'."
2416 "Clean up the Dired file name search after terminating isearch."
2423 "Test whether the current search hit is a visible file name.
2424 Return non-nil if the text from BEG to END is part of a file
2425 name (has the text property `dired-filename') and is visible."
2430 t)))
2432 ;;;###autoload
2434 "Search for a string using Isearch only in file names in the Dired buffer."
2439 ;;;###autoload
2441 "Search for a regexp using Isearch only in file names in the Dired buffer."
2446 \f
2447 ;; Functions for searching in tags style among marked files.
2449 ;;;###autoload
2451 "Search for a string through all marked files using Isearch."
2456 ;;;###autoload
2458 "Search for a regexp through all marked files using Isearch."
2463 ;;;###autoload
2465 "Search through all marked files for a match for REGEXP.
2466 Stops when a match is found.
2471 ;;;###autoload
2473 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2474 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2485 buffer-read-only))
2492 \f
2493 ;;;###autoload
2495 "Print the type of FILE, according to the `file' command.
2496 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2497 true then the type of the file linked to by FILE is printed instead."
2510 ;; Local Variables:
2511 ;; byte-compile-dynamic: t
2512 ;; generated-autoload-file: "dired.el"
2513 ;; End:
2515 ;;; dired-aux.el ends here