| blob | 8a499c474643a7ea4c0ff341a57f858e7145ef47 |
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 FILES should be a list of file names.
402 of such values, available via history commands. Note that if the
403 user enters empty input, this function returns the empty string,
404 not DEFAULT-VALUE.
406 Optional argument COLLECTION is a collection of possible completions,
407 suitable for use by `completing-read'."
409 'completing-read
411 collection nil nil initial nil default-value nil))
412 \f
413 ;;; Cleaning a directory: flagging some backups for deletion.
417 ;;;###autoload
419 "Flag numerical backups for deletion.
420 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
421 Positive prefix arg KEEP overrides `dired-kept-versions';
422 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
425 with a prefix argument."
432 late-retention early-retention)
433 ;; Look at each file.
434 ;; If the file has numeric backup versions,
435 ;; put on dired-file-version-alist an element of the form
436 ;; (FILENAME . VERSION-NUMBER-LIST)
438 ;; Sort each VERSION-NUMBER-LIST,
439 ;; and remove the versions not to be deleted.
447 sorted-v-list)))
451 ;; Look at each file. If it is a numeric backup file,
452 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
456 ;;; Subroutines of dired-clean-directory.
459 ;; Perform FUN with point at the end of each non-directory line.
460 ;; FUN takes one argument, the absolute filename.
477 ;; Only do work if this file is not already in the alist.
479 nil
480 ;; If it looks like file FN has versions, return a list of the versions.
481 ;;That is a list of strings which are file names.
482 ;;The caller may want to flag some of these files for deletion.
487 base-versions
493 dired-file-version-alist)))))))
497 base-version-list)
507 \f
508 ;;; Shell commands
513 "Return a list of all commands associated with current dired files.
514 This function is used to add all related commands retrieved by `mailcap'
515 to the end of the list of defaults just after the default value."
523 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
525 "Read a dired shell command.
527 which is replaced by the value returned by `dired-mark-prompt',
528 with ARG and FILES as its arguments. FILES should be a list of
529 file names. The result is used as the prompt.
531 This normally reads using `read-shell-command', but if the
532 `dired-x' package is loaded, use `dired-guess-shell-command' to
533 offer a smarter default choice of shell command."
545 ;;;###autoload
547 "Run a shell command COMMAND on the marked files asynchronously.
549 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
550 adds `* &' surrounded by whitespace and executes the command asynchronously.
551 The output appears in the buffer `*Async Shell Command*'."
555 ;; Want to give feedback whether this file or marked files are used:
557 current-prefix-arg
558 files)))
565 ;; The in-background argument is only needed in Emacs 18 where
566 ;; shell-command doesn't understand an appended ampersand `&'.
567 ;;;###autoload
569 "Run a shell command COMMAND on the marked files.
570 If no files are marked or a specific numeric prefix arg is given,
572 The prompt mentions the file(s) or the marker, as appropriate.
574 If there is a `*' in COMMAND, surrounded by whitespace, this runs
575 COMMAND just once with the entire file list substituted there.
577 If there is no `*', but there is a `?' in COMMAND, surrounded by
578 whitespace, this runs COMMAND on each file individually with the
579 file name substituted for `?'.
581 Otherwise, this runs COMMAND on each file individually with the
582 file name added at the end of COMMAND (separated by a space).
584 `*' and `?' when not surrounded by whitespace have no special
585 significance for `dired-do-shell-command', and are passed through
586 normally to the shell, but you must confirm first.
588 If you want to use `*' as a shell wildcard with whitespace around
590 `*' in the shell, but avoids Dired's special handling.
592 If COMMAND produces output, it goes to a separate buffer.
594 This feature does not try to redisplay Dired buffers afterward, as
595 there's no telling what files COMMAND may have changed.
598 When COMMAND runs, its working directory is the top-level directory
599 of the Dired buffer, so output files usually are created there
600 instead of in a subdir.
602 In a noninteractive call (from Lisp code), you must specify
603 the list of file names explicitly with the FILE-LIST argument, which
604 can be produced by `dired-get-marked-files', for example."
605 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
606 ;;actual work and can be redefined for customization.
610 ;; Want to give feedback whether this file or marked files are used:
613 current-prefix-arg
614 files)
615 current-prefix-arg
616 files)))
621 ;; Get confirmation for wildcards that may have been meant
622 ;; to control substitution of a file name or the file name list.
636 nil
637 file-list)
638 ;; execute the shell command
642 ;; Might use {,} for bash or csh:
651 ;; "Make up a shell command line from COMMAND and FILE-LIST.
652 ;; If ON-EACH is t, COMMAND should be applied to each file, else
653 ;; simply concat all files and apply COMMAND to this.
654 ;; FILE-LIST's elements will be quoted for the shell."
655 ;; Might be redefined for smarter things and could then use RAW-ARG
656 ;; (coming from interactive P and currently ignored) to decide what to do.
657 ;; Smart would be a way to access basename or extension of file names.
666 retval))
671 file-list dired-mark-separator)))
676 ;; This is an extra function so that it can be redefined by ange-ftp.
677 ;;;###autoload
684 ;; Return nil for sake of nconc in dired-bunch-files.
685 nil)
686 \f
689 ; "Display MSG while running PROGRAM, and check for output.
690 ;Remaining arguments are strings passed as command arguments to PROGRAM.
691 ; On error, insert output
692 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
693 ; Caller can cons up a list of failed args.
694 ;Else returns nil for success."
698 ;; Get a clean buffer for error output:
711 nil))))
712 \f
713 ;; Commands that delete or redisplay part of the dired buffer.
716 "Kill the current line (not the files).
717 With a prefix argument, kill that many lines starting with the current line.
718 \(A negative argument kills backward.)"
737 ;;;###autoload
739 "Kill all marked lines (not the files).
740 With a prefix argument, kill that many lines starting with the current line.
741 \(A negative argument kills backward.)
742 If you use this command with a prefix argument to kill the line
743 for a file that is a directory, which you have inserted in the
744 Dired buffer as a subdirectory, then it deletes that subdirectory
745 from the buffer as well.
746 To kill an entire subdirectory \(without killing its line in the
747 parent directory), go to its directory header line and use this
748 command with a prefix argument (the value does not matter)."
749 ;; Returns count of killed lines. FMT="" suppresses message.
767 count))))
769 ;;;###end dired-cmd.el
770 \f
771 ;;; 30K
772 ;;;###begin dired-cp.el
775 ;; Compress or uncompress the current file.
776 ;; Return nil for success, offending filename else.
782 ;; Remove any preexisting entry for the name NEW-FILE.
787 ;; Now replace the current line with an entry for NEW-FILE.
790 from-file)))
796 ;; For .z, try gunzip. It might be an old gzip file,
797 ;; or it might be from compact? pack? (which?) but gunzip handles both.
803 ;; This item controls naming for compression.
805 "Control changes in file name suffixes for compression and uncompression.
806 Each element specifies one transformation rule, and has the form:
807 (REGEXP NEW-SUFFIX PROGRAM)
808 The rule applies when the old file name matches REGEXP.
809 The new file name is computed by deleting the part that matches REGEXP
810 (as well as anything after that), then adding NEW-SUFFIX in its place.
811 If PROGRAM is non-nil, the rule is an uncompression rule,
812 and uncompression is done by running PROGRAM.
815 ;;;###autoload
817 ;; Compress or uncompress FILE.
818 ;; Return the name of the compressed or uncompressed file.
819 ;; Return nil if no change in files.
821 suffix newname
823 ;; See if any suffix rule matches this file name.
829 ;; If so, compute desired new name.
836 nil)
838 ;; We found an uncompression rule.
841 newname))
843 ;;; We don't recognize the file as compressed, so compress it.
844 ;;; Try gzip; if we don't have that, use compress.
850 out-name)))
855 ;; Rename the compressed file to NEWNAME
856 ;; if it hasn't got that name already.
860 newname)
861 out-name)))
865 ;; Don't use NEWNAME with `compress'.
867 \f
869 ;; Request confirmation from the user that the operation described
870 ;; by OP-SYMBOL is to be performed on the marked files.
871 ;; Confirmation consists in a y-or-n question with a file list
872 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
873 ;; The files used are determined by ARG (as in dired-get-marked-files).
876 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
877 ;; is marked pops up a window. That will help the user see
878 ;; it isn't the current line file.
887 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
888 ; and display failures.
890 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
891 ; the short form of the filename) for a failure and probably logs a
892 ; detailed error explanation using function `dired-log'.
894 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
895 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
896 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
897 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
899 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
911 ;; end this bunch of errors:
915 failures)))))
917 ;;;###autoload
919 "Format PROMPT with ARGS, query user, and store the result in SYM.
920 The return value is either nil or t.
922 The user may type y or SPC to accept once; n or DEL to skip once;
923 ! to accept this and subsequent queries; or q or ESC to decline
924 this and subsequent queries.
926 If SYM is already bound to a non-nil value, this function may
927 return automatically without querying the user. If SYM is !,
928 return t; if SYM is q or ESC, return nil."
945 \f
946 ;;;###autoload
948 "Compress or uncompress marked (or next ARG) files."
952 ;; Commands for Emacs Lisp files - load and byte compile
955 ;; Return nil for success, offending file name else.
957 elc-file buffer-read-only failure)
972 nil)))
974 ;;;###autoload
976 "Byte compile marked (or next ARG) Emacs Lisp files."
981 ;; Return nil for success, offending file name else.
987 nil
991 ;;;###autoload
993 "Load the marked (or next ARG) Emacs Lisp files."
997 ;;;###autoload
999 "Redisplay all marked (or next ARG) files.
1000 If on a subdir line, redisplay that subdirectory. In that case,
1001 a prefix arg lets you edit the `ls' switches used for the new listing.
1003 Dired remembers switches specified with a prefix arg, so that reverting
1004 the buffer will not reset them. However, using `dired-undo' to re-insert
1005 or delete subdirectories can bypass this machinery. Hence, you sometimes
1006 may have to reset some subdirectory switches after a `dired-undo'.
1007 You can reset all subdirectory switches to the default using
1009 See Info node `(emacs)Subdir switches' for more details."
1010 ;; Moves point if the next ARG files are redisplayed.
1016 dir
1020 dired-subdir-switches
1021 dired-actual-switches)))))
1023 ;; message much faster than making dired-map-over-marks show progress
1027 ;; Postpone readin hook till we map
1028 ;; over all marked files (Bug#6810).
1032 arg)
1038 "Set `dired-switches-alist' to nil and revert dired buffer."
1042 \f
1044 ;; Delete the current line, and insert an entry for FILE.
1045 ;; If FILE is nil, then just delete the current line.
1046 ;; Keeps any marks that may be present in column one (doing this
1047 ;; here is faster than with dired-add-entry's optional arg).
1048 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1056 ;; Replace space by old marker without moving point.
1057 ;; Faster than goto+insdel inside a save-excursion?
1061 ;;;###autoload
1072 "Add a new dired entry for FILENAME.
1073 Optionally mark it with MARKER-CHAR (a character, else uses
1074 `dired-marker-char'). Note that this adds the entry `out of order'
1075 if files are sorted by time, etc.
1076 Skips files that match `dired-trivial-filenames'.
1077 Exposes hidden subdirectories if a file is added there.
1079 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1080 files matching `dired-omit-regexp'."
1083 ;; Avoid calling ls for files that are going to be omitted anyway.
1089 filename)
1094 filename
1096 ;; Do it!
1099 ;; Entry is always for files, even if they happen to also be directories
1103 reason)
1108 reason
1115 ;; We are already where we should be, except when
1116 ;; point is before the subdir line or its total line.
1120 ;; else try to find correct place to insert
1124 ;; Point is at end of subdir line.
1126 ;; found - skip subdir and `total' line
1127 ;; and uninteresting files like . and ..
1128 ;; This better not move into the next subdir!
1130 ;; not found
1135 ;; Don't expand `.'.
1136 ;; Show just the file name within directory.
1139 directory
1143 ;; Put in desired marker char.
1147 dired-marker-char)))
1149 ;; Compensate for a bug in ange-ftp.
1150 ;; It inserts the file's absolute name, rather than
1151 ;; the relative one. That may be hard to fix since it
1152 ;; is probably controlled by something in ftp.
1168 ;; The subdir-alist is not affected...
1176 ;; return nil if all went well
1177 nil))
1181 ;; Don't do it (dired-omit-mode).
1182 ;; Return t for success (perhaps we should return file-exists-p).
1183 t))
1186 ;; Return pos of first file line of DIR, skipping header and total
1187 ;; or wildcard lines.
1188 ;; Important: never moves into the next subdir.
1189 ;; DIR is assumed to be unhidden.
1198 ;;;###autoload
1211 ;;;###autoload
1213 "Create or update the line for FILE in all Dired buffers it would belong in."
1219 ;; Relist the line for FILE, or just add it if it did not exist.
1220 ;; FILE must be an absolute file name.
1222 ;; If cursor is already on FILE's line delete-region will cause
1223 ;; save-excursion to fail because of floating makers,
1224 ;; moving point to beginning of line. Sigh.
1233 \f
1234 ;;; Copy, move/rename, making hard and symbolic links
1237 "Non-nil if Dired should ask about making backups before overwriting files.
1238 Special value `always' suppresses confirmation."
1244 ;; This is a fluid var used in dired-handle-overwrite. It should be
1245 ;; let-bound whenever dired-copy-file etc are called. See
1246 ;; dired-create-files for an example.
1250 ;; Save old version of file TO that is to be overwritten.
1251 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1252 ;; from dired-create-files.
1255 dired-overwrite-confirmed
1259 "Make backup for existing file `%s'? "
1260 to)))
1264 ;;;###autoload
1268 dired-recursive-copies))
1273 preserve-time top recursive)
1282 ;; This is a directory.
1284 ;; Not a directory.
1288 ;; It is a symlink
1293 dired-create-files-failures)
1296 ;;;###autoload
1300 ;; Silently rename the visited file of any buffer visiting this file.
1305 ;; See if it's an inserted subdir, and rename that, too.
1313 ;; Update visited file name of all affected buffers
1323 to-dir
1324 buffer-file-name)))
1330 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1331 ;; one of its subdirectories is expanded in this buffer.
1339 ;; ELT's subdir is affected by the rename
1342 ;; if top level directory was renamed, lots of things have to be
1343 ;; updated:
1348 ;; with and without wildcards
1350 to))
1353 ;; try to rename buffer, but just leave old name if new
1354 ;; name would already exist (don't try appending "<%d>")
1357 ;; ... we dired TO now:
1361 ;; Update the headerline and dired-subdir-alist element, as well as
1362 ;; dired-switches-alist element, of directory described by
1363 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1364 ;; describes either DIR itself or a subdir of DIR.
1368 buffer-read-only)
1370 ;; Update subdir headerline in buffer
1373 dir)
1378 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1384 \f
1385 ;; Bound in dired-create-files
1389 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1392 "Create one or more new files from a list of existing files FN-LIST.
1393 This function also handles querying the user, updating Dired
1394 buffers, and displaying a success or failure message.
1396 FILE-CREATOR should be a function. It is called once for each
1397 file in FN-LIST, and must create a new file, querying the user
1398 and updating Dired buffers as necessary. It should accept three
1399 arguments: the old file name, the new name, and an argument
1400 OK-IF-ALREADY-EXISTS with the same meaning as in `copy-file'.
1402 OPERATION should be a capitalized string describing the operation
1403 performed (e.g. `Copy'). It is used for error logging.
1405 FN-LIST is the list of files to copy (full absolute file names).
1407 NAME-CONSTRUCTOR should be a function accepting a single
1408 argument, the name of an old file, and returning either the
1409 corresponding new file name or nil to skip.
1411 Optional MARKER-CHAR is a character with which to mark every
1412 newfile's entry, or t to use the current marker character if the
1413 old file was marked."
1431 Type SPC or `y' to overwrite file `%s',
1432 DEL or `n' to skip to next,
1433 ESC or `q' to not overwrite any of the remaining files,
1437 ;; must determine if FROM is marked before file-creator
1438 ;; gets a chance to delete it (in case of a move).
1443 ;; Handle the `dired-copy-file' file-creator specially
1444 ;; When copying a directory to another directory or
1445 ;; possibly to itself or one of its subdirectories.
1446 ;; e.g "~/foo/" => "~/test/"
1447 ;; or "~/foo/" =>"~/foo/"
1448 ;; or "~/foo/ => ~/foo/bar/")
1449 ;; In this case the 'name-constructor' have set the destination
1450 ;; TO to "~/test/foo" because the old emacs23 behavior
1451 ;; of `copy-directory' was to not create the subdirectory
1452 ;; and instead copy the contents.
1453 ;; With the new behavior of `copy-directory'
1454 ;; (similar to the `cp' shell command) we don't
1455 ;; need such a construction of the target directory,
1456 ;; so modify the destination TO to "~/test/" instead of "~/test/foo/".
1462 ;; If DESTNAME is a subdirectory of FROM, not a symlink,
1463 ;; and the method in use is copying, signal an error.
1468 from to)))
1473 ;; If we get here, file-creator hasn't been aborted
1474 ;; and the old entry (if any) has to be deleted
1475 ;; before adding the new entry.
1483 failures)
1485 operation from to err))))))))
1493 total)
1494 failures))
1500 failures))
1506 skipped))
1511 \f
1513 &optional marker-char op1
1514 how-to)
1515 "Create a new file for each marked file.
1516 Prompts user for target, which is a directory in which to create
1517 the new files. Target may also be a plain file if only one marked
1518 file exists. The way the default for the target directory is
1519 computed depends on the value of `dired-dwim-target-directory'.
1520 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1521 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1522 FILE-CREATOR and OPERATION as in `dired-create-files'.
1523 ARG as in `dired-get-marked-files'.
1524 Optional arg MARKER-CHAR as in `dired-create-files'.
1525 Optional arg OP1 is an alternate form for OPERATION if there is
1526 only one file.
1527 Optional arg HOW-TO determines how to treat the target.
1528 If HOW-TO is nil, use `file-directory-p' to determine if the
1529 target is a directory. If so, the marked file(s) are created
1530 inside that directory. Otherwise, the target is a plain file;
1531 an error is raised unless there is exactly one marked file.
1532 If HOW-TO is t, target is always treated as a plain file.
1533 Otherwise, HOW-TO should be a function of one argument, TARGET.
1534 If its return value is nil, TARGET is regarded as a plain file.
1535 If it return value is a list, TARGET is a generalized
1536 directory (e.g. some sort of archive). The first element of
1537 this list must be a function with at least four arguments:
1538 operation - as OPERATION above.
1539 rfn-list - list of the relative names for the marked files.
1540 fn-list - list of the absolute names for the marked files.
1541 target - the name of the target itself.
1542 The rest of into-dir are optional arguments.
1543 For any other return value, TARGET is treated as a directory."
1552 target-dir)))
1561 target-dir op-symbol arg rfn-list default))))
1563 ;; Allow DOS/Windows users to change the letter
1564 ;; case of a directory. If we don't test these
1565 ;; conditions up front, file-directory-p below
1566 ;; will return t because the filesystem is
1567 ;; case-insensitive, and Emacs will try to move
1568 ;; foo -> foo/foo, which fails.
1571 dired-one-file
1579 nil
1587 ;; rename-file bombs when moving directories unless we do this:
1590 file-creator operation fn-list
1592 ;; This function uses fluid variable target when called
1593 ;; inside dired-create-files:
1598 marker-char))))
1600 ;; Read arguments for a marked-files command that wants a file name,
1601 ;; perhaps popping up the list of marked files.
1602 ;; ARG is the prefix arg and indicates whether the files came from
1603 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1604 ;; If the current file was used, the list has but one element and ARG
1605 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1606 ;; DEFAULT is the default value to return if the user just hits RET;
1607 ;; if it is omitted or nil, then the name of the directory is used.
1612 nil op-symbol files
1617 ;; Try to guess which target directory the user may want.
1618 ;; If there is a dired buffer displayed in one of the next windows,
1619 ;; use its current subdir, else use current subdir of this dired buffer.
1622 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1633 this-dir)))
1636 ;; Return a list of default values for file-reading functions in Dired.
1637 ;; This list may contain directories from Dired buffers in other windows.
1638 ;; `fn-list' is a list of file names used to build a list of defaults.
1639 ;; When nil or more than one element, a list of defaults will
1640 ;; contain only directory names. `target-dir' is a directory name
1641 ;; to exclude from the returned list, for the case when this
1642 ;; directory name is already presented in initial input.
1643 ;; For Dired operations that support `dired-dwim-target',
1644 ;; the argument `target-dir' should have the value returned
1645 ;; from `dired-dwim-target-directory'.
1650 dired-dirs)
1651 ;; Get a list of directories of visible buffers in dired-mode.
1656 ;; Force the current dir to be the first in the list.
1659 ;; Remove the target dir (if specified) or the current dir from
1660 ;; default values, because it should be already in initial input.
1662 ;; Return a list of default values.
1664 ;; For one file operation, provide a list that contains
1665 ;; other directories, other directories with the appended filename
1666 ;; and the current directory with the appended filename, e.g.
1667 ;; 1. /TARGET-DIR/
1668 ;; 2. /TARGET-DIR/FILENAME
1669 ;; 3. /CURRENT-DIR/FILENAME
1678 ;; For multi-file operation, return only a list of other directories.
1679 dired-dirs)))
1681 \f
1682 ;;;###autoload
1684 "Create a directory called DIRECTORY.
1685 If DIRECTORY already exists, signal an error."
1692 ;; Find the topmost nonexistent parent dir (variable `new')
1704 ;; This may not always be what you want, especially if target is your
1705 ;; home directory and it happens to be a symbolic link, as is often the
1706 ;; case with NFS and automounters. Or if you want to make symlinks
1707 ;; into directories that themselves are only symlinks, also quite
1708 ;; common.
1710 ;; So we don't use this function as value for HOW-TO in
1711 ;; dired-do-symlink, which has the minor disadvantage of
1712 ;; making links *into* a symlinked-dir, when you really wanted to
1713 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1714 ;; just have to remove that symlink by hand before making your marked
1715 ;; symlinks.
1718 "Either nil or a function used by `dired-do-copy' to determine target.
1721 ;;;###autoload
1723 "Copy all marked (or next ARG) files, or copy the current file.
1724 This normally preserves the last-modified date when copying.
1725 When operating on just the current file, you specify the new name.
1726 When operating on multiple or marked files, you specify a directory,
1727 and new copies of these files are made in that directory
1728 with the same names that the files currently have. The default
1729 suggested for the target directory depends on the value of
1730 `dired-dwim-target', which see.
1732 This command copies symbolic links by creating new ones,
1733 like `cp -d'."
1737 "Copy"
1738 arg dired-keep-marker-copy
1739 nil dired-copy-how-to-fn)))
1741 ;;;###autoload
1743 "Make symbolic links to current file or all marked (or next ARG) files.
1744 When operating on just the current file, you specify the new name.
1745 When operating on multiple or marked files, you specify a directory
1746 and new symbolic links are made in that directory
1747 with the same names that the files currently have. The default
1748 suggested for the target directory depends on the value of
1749 `dired-dwim-target', which see.
1756 ;;;###autoload
1758 "Add names (hard links) current file or all marked (or next ARG) files.
1759 When operating on just the current file, you specify the new name.
1760 When operating on multiple or marked files, you specify a directory
1761 and new hard links are made in that directory
1762 with the same names that the files currently have. The default
1763 suggested for the target directory depends on the value of
1764 `dired-dwim-target', which see."
1771 ;; error is caught in -create-files
1773 ;; Update the link count
1776 ;;;###autoload
1778 "Rename current file or all marked (or next ARG) files.
1779 When renaming just the current file, you specify the new name.
1780 When renaming multiple or marked files, you specify a directory.
1781 This command also renames any buffers that are visiting the files.
1782 The default suggested for the target directory depends on the value
1783 of `dired-dwim-target', which see."
1787 ;;;###end dired-cp.el
1788 \f
1789 ;;; 5K
1790 ;;;###begin dired-re.el
1795 ;; Create a new file for each marked file using regexps.
1796 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1797 ;; ARG as in dired-get-marked-files.
1798 ;; Matches each marked file against REGEXP and constructs the new
1799 ;; filename from NEWNAME (like in function replace-match).
1800 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1801 ;; instead of only the non-directory part of the file.
1802 ;; Optional arg MARKER-CHAR as in dired-create-files.
1806 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1807 `!' to %s all remaining matches with no more questions."
1811 ;; Function to construct new filename using REGEXP and NEWNAME:
1816 ;; must bind help-form directly around call to
1817 ;; dired-query
1821 operation-prompt
1822 from
1823 to)
1824 to)
1826 operation from regexp)))))
1827 ;; not whole-name, replace non-directory part only
1838 operation-prompt
1841 to)
1844 rename-regexp-query)
1846 file-creator operation fn-list regexp-name-constructor marker-char)))
1849 ;; Prompt user about performing OPERATION.
1850 ;; Read and return list of: regexp newname arg whole-name.
1863 ;;;###autoload
1865 "Rename selected files whose names match REGEXP to NEWNAME.
1867 With non-zero prefix argument ARG, the command operates on the next ARG
1868 files. Otherwise, it operates on all the marked files, or the current
1869 file if none are marked.
1871 As each match is found, the user must type a character saying
1874 REGEXP defaults to the last regexp used.
1876 With a zero prefix arg, renaming by regexp affects the absolute file name.
1877 Normally, only the non-directory part of the file name is used and changed."
1883 ;;;###autoload
1885 "Copy selected files whose names match REGEXP to NEWNAME.
1886 See function `dired-do-rename-regexp' for more info."
1892 arg regexp newname whole-name dired-keep-marker-copy)))
1894 ;;;###autoload
1896 "Hardlink selected files whose names match REGEXP to NEWNAME.
1897 See function `dired-do-rename-regexp' for more info."
1903 ;;;###autoload
1905 "Symlink selected files whose names match REGEXP to NEWNAME.
1906 See function `dired-do-rename-regexp' for more info."
1916 ;; Perform FILE-CREATOR on the non-directory part of marked files
1917 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1918 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1921 file-creator
1922 operation
1930 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1931 `!' to %s all remaining matches with no more questions."
1938 to))))
1939 dired-keep-marker-rename)))
1944 basename-constructor operation arg))
1946 ;;;###autoload
1948 "Rename all marked (or next ARG) files to upper case."
1952 ;;;###autoload
1954 "Rename all marked (or next ARG) files to lower case."
1958 ;;;###end dired-re.el
1959 \f
1960 ;;; 13K
1961 ;;;###begin dired-ins.el
1963 ;;;###autoload
1965 switches no-error-if-not-dir-p)
1966 "Insert this subdirectory into the same dired buffer.
1968 else inserts it at its natural place (as `ls -lR' would have done).
1969 With a prefix arg, you may edit the ls switches used for this listing.
1970 You can add `R' to the switches to expand the whole tree starting at
1971 this subdirectory.
1972 This function takes some pains to conform to `ls -lR' output.
1974 Dired remembers switches specified with a prefix arg, so that reverting
1975 the buffer will not reset them. However, using `dired-undo' to re-insert
1976 or delete subdirectories can bypass this machinery. Hence, you sometimes
1977 may have to reset some subdirectory switches after a `dired-undo'.
1978 You can reset all subdirectory switches to the default using
1980 See Info node `(emacs)Subdir switches' for more details."
1987 ;; We don't need a marker for opoint as the subdir is always
1988 ;; inserted *after* opoint.
1993 ;; Push mark so that it's easy to find back. Do this after the
1994 ;; insert message so that the user sees the `Mark set' message.
1997 ;;;###autoload
1999 "Insert this subdirectory into the same dired buffer.
2000 If it is already present, overwrites previous entry,
2001 else inserts it at its natural place (as `ls -lR' would have done).
2002 With a prefix arg, you may edit the `ls' switches used for this listing.
2003 You can add `R' to the switches to expand the whole tree starting at
2004 this subdirectory.
2005 This function takes some pains to conform to `ls -lR' output."
2006 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
2007 ;; Prospero where dired-ls does the right thing, but
2008 ;; file-directory-p has not been redefined.
2022 switches-have-R mark-alist case-fold-search buffer-read-only)
2025 ;; case-fold-search is nil now, so we can test for capital `R':
2027 ;; avoid duplicated subdirs
2030 ;; If subdir is already present, remove it and remember its marks
2054 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2055 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2068 ;; all switches that make a difference to dired-get-filename:
2072 ;; Add new DIR at NEW-MARKER. Sort alist.
2077 ;; Keep the alist sorted on buffer position.
2085 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2086 Interactively, you can kill DIRNAME as well by using a prefix argument.
2087 In interactive use, the command prompts for DIRNAME.
2089 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2090 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2101 m-alist))
2104 ;; Find pos for new subdir, according to tree order.
2105 ;;(goto-char (point-max))
2112 ;; Insert NEW-DIR after DIR
2114 alist nil)))
2116 ;; want a separating newline between subdirs
2123 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2124 ;; Move to that buffer position. Return a mark-alist.
2127 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2136 ;; Insert ls output after point.
2137 ;; Return the boundary of the inserted text (as list of BEG and END).
2142 dired-subdir-switches
2145 ;; If doing the top level directory of the buffer,
2146 ;; redo it as specified in dired-directory.
2152 ;; Point is at the correct subdir alist position for ELT,
2153 ;; BEG-END is the subdir-region (as list of begin and end).
2155 ;; update its position (should actually be unchanged)
2158 ;; The hook may depend on the subdir-alist containing the just
2159 ;; inserted subdir, so run it after dired-alist-add:
2167 ;; hook may add or delete lines, but the subdir boundary
2168 ;; marker floats
2172 ;; Lexicographic order on file name components, like `ls -lR':
2173 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2174 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2175 ;; or DIR1 and DIR2 are in the same parentdir and their last
2176 ;; components are string-lessp.
2177 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2178 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2179 ;; if dired-actual-switches contained `t'.
2185 components-2
2197 t)
2199 nil)
2202 ;; There should be a builtin split function - inverse to mapconcat.
2204 "Splitting on regexp PAT, turn string STR into a list of substrings.
2205 Optional third arg LIMIT (>= 1) is a limit to the length of the
2206 resulting list.
2207 Thus, if SEP is a regexp that only matches itself,
2209 (mapconcat 'identity (dired-split SEP STRING) SEP)
2211 is always equal to STRING."
2224 start end)
2225 ))
2232 \f
2233 ;;; moving by subdirectories
2235 ;;;###autoload
2237 "Go to previous subdirectory, regardless of level.
2238 When called interactively and not on a subdir line, go to this subdir's line."
2239 ;;(interactive "p")
2243 ;; if on subdir start already, don't stay there!
2253 ;;;###autoload
2255 "Go to end of header line of DIR in this dired buffer.
2256 Return value of point on success, otherwise return nil.
2262 dired-subdir-alist ; table
2263 nil ; predicate
2264 t ; require-match
2271 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2272 ;; at either \r or \n after this function succeeds.
2275 \f
2276 ;;;###autoload
2278 "Mark all files except `.' and `..' in current subdirectory.
2279 If the Dired buffer shows multiple directories, this command
2280 marks the files listed in the subdirectory that point is in."
2285 ;;;###autoload
2287 "Remove all lines of current subdirectory.
2288 Lower levels are unaffected."
2289 ;; With optional REMEMBER-MARKS, return a mark-alist.
2296 buffer-read-only)
2310 ;; Remove DIR from the alist
2314 ;;;###autoload
2316 "Go up ARG levels in the dired tree."
2322 ;;(setq dir (expand-file-name dir))
2326 ;;;###autoload
2328 "Go down in the dired tree."
2342 \f
2343 ;;; hiding
2359 ;;;###autoload
2361 "Hide or unhide the current subdirectory and move to next directory.
2362 Optional prefix arg is a repeat factor.
2372 buffer-read-only)
2373 ;; keep header line visible, hide rest
2382 ;;;###autoload
2384 "Hide all subdirectories, leaving only their header lines.
2385 If there is already something hidden, make everything visible again.
2390 buffer-read-only)
2394 ;; unhide - bombs on \r in filenames
2396 ;; hide
2403 ;; we're somewhere on current dir's line
2411 ;;;###end dired-ins.el
2413 \f
2414 ;; Search only in file names in the Dired buffer.
2417 "Non-nil to Isearch in file names only.
2418 If t, Isearch in Dired always matches only file names.
2419 If `dwim', Isearch matches file names when initial point position is on
2420 a file name. Otherwise, it searches the whole buffer without restrictions."
2430 "Toggle file names searching on or off.
2431 When on, Isearch skips matches outside file names using the predicate
2432 `dired-isearch-filter-filenames' that matches only at file names.
2433 When off, it uses the original predicate."
2437 dired-isearch-filter-predicate-orig
2442 ;;;###autoload
2444 "Set up isearch to search in Dired file names.
2445 Intended to be added to `isearch-mode-hook'."
2457 "Clean up the Dired file name search after terminating isearch."
2464 "Test whether the current search hit is a visible file name.
2465 Return non-nil if the text from BEG to END is part of a file
2466 name (has the text property `dired-filename') and is visible."
2471 t)))
2473 ;;;###autoload
2475 "Search for a string using Isearch only in file names in the Dired buffer."
2480 ;;;###autoload
2482 "Search for a regexp using Isearch only in file names in the Dired buffer."
2487 \f
2488 ;; Functions for searching in tags style among marked files.
2490 ;;;###autoload
2492 "Search for a string through all marked files using Isearch."
2497 ;;;###autoload
2499 "Search for a regexp through all marked files using Isearch."
2504 ;;;###autoload
2506 "Search through all marked files for a match for REGEXP.
2507 Stops when a match is found.
2512 ;;;###autoload
2514 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2515 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2526 buffer-read-only))
2533 \f
2534 ;;;###autoload
2536 "Print the type of FILE, according to the `file' command.
2537 If you give a prefix to this command, and FILE is a symbolic
2538 link, then the type of the file linked to by FILE is printed
2539 instead."
2552 ;; Local Variables:
2553 ;; byte-compile-dynamic: t
2554 ;; generated-autoload-file: "dired.el"
2555 ;; End:
2557 ;;; dired-aux.el ends here