| blob | 0795b0175a2a788898d95d62006742ba2bfa6cdb |
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))
250 failures)
262 files))
267 nil))))
269 ;;;###autoload
271 "Change the mode of the marked (or next ARG) files.
272 Symbolic modes like `g+w' are allowed."
287 "Change mode of %s to: "
289 num-modes)
291 ;; We used to treat empty input as DEFAULT, but that is not
292 ;; such a good idea (Bug#9361).
299 file
304 ;;;###autoload
306 "Change the group of the marked (or next ARG) files."
312 ;;;###autoload
314 "Change the owner of the marked (or next ARG) files."
320 ;;;###autoload
322 "Change the timestamp of the marked (or next ARG) files.
323 This calls touch."
327 ;; Process all the files in FILES in batches of a convenient size,
328 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
329 ;; Batches are chosen to need less than MAX chars for the file names,
330 ;; allowing 3 extra characters of separator per file name.
333 past
335 failures)
336 ;; Accumulate files as long as they fit in MAX chars,
337 ;; then process the ones accumulated so far.
342 ;; If we have at least 1 pending file
343 ;; and this file won't fit in the length limit, process now.
346 ;; The elements of PENDING are now in forward order.
347 ;; Do the operation and record failures.
349 failures)
350 ;; Transfer the elements of PENDING onto PAST
351 ;; and clear it out. Now PAST contains the first N files
352 ;; specified (for some N), and FILES contains the rest.
354 pending nil
356 ;; Do (setq pending (cons thisfile pending))
357 ;; but reuse the cons that was in `files'.
365 failures)
366 ;; Now the original list FILES has been put back as it was.
369 ;;;###autoload
371 "Print the marked (or next ARG) files.
372 Uses the shell command coming from variables `lpr-command' and
373 `lpr-switches' as default."
377 "Print %s with: "
382 lpr-switches))
389 "Read args for a Dired marked-files command, prompting with PROMPT.
390 Return the user input (a string).
392 INITIAL, if non-nil, is the initial minibuffer input.
393 OP-SYMBOL is an operation symbol (see `dired-no-confirm').
394 ARG is normally the prefix argument for the calling command.
395 FILES should be a list of file names.
398 of such values, available via history commands. Note that if the
399 user enters empty input, this function returns the empty string,
400 not DEFAULT-VALUE."
402 'read-from-minibuffer
404 initial nil nil nil default-value))
405 \f
406 ;;; Cleaning a directory: flagging some backups for deletion.
410 ;;;###autoload
412 "Flag numerical backups for deletion.
413 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
414 Positive prefix arg KEEP overrides `dired-kept-versions';
415 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
418 with a prefix argument."
425 late-retention early-retention)
426 ;; Look at each file.
427 ;; If the file has numeric backup versions,
428 ;; put on dired-file-version-alist an element of the form
429 ;; (FILENAME . VERSION-NUMBER-LIST)
431 ;; Sort each VERSION-NUMBER-LIST,
432 ;; and remove the versions not to be deleted.
440 sorted-v-list)))
444 ;; Look at each file. If it is a numeric backup file,
445 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
449 ;;; Subroutines of dired-clean-directory.
452 ;; Perform FUN with point at the end of each non-directory line.
453 ;; FUN takes one argument, the absolute filename.
470 ;; Only do work if this file is not already in the alist.
472 nil
473 ;; If it looks like file FN has versions, return a list of the versions.
474 ;;That is a list of strings which are file names.
475 ;;The caller may want to flag some of these files for deletion.
480 base-versions
486 dired-file-version-alist)))))))
490 base-version-list)
500 \f
501 ;;; Shell commands
506 "Return a list of all commands associated with current dired files.
507 This function is used to add all related commands retrieved by `mailcap'
508 to the end of the list of defaults just after the default value."
516 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
518 "Read a dired shell command.
520 which is replaced by the value returned by `dired-mark-prompt',
521 with ARG and FILES as its arguments. FILES should be a list of
522 file names. The result is used as the prompt.
524 This normally reads using `read-shell-command', but if the
525 `dired-x' package is loaded, use `dired-guess-shell-command' to
526 offer a smarter default choice of shell command."
538 ;;;###autoload
540 "Run a shell command COMMAND on the marked files asynchronously.
542 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
543 adds `* &' surrounded by whitespace and executes the command asynchronously.
544 The output appears in the buffer `*Async Shell Command*'."
548 ;; Want to give feedback whether this file or marked files are used:
550 current-prefix-arg
551 files)))
558 ;; The in-background argument is only needed in Emacs 18 where
559 ;; shell-command doesn't understand an appended ampersand `&'.
560 ;;;###autoload
562 "Run a shell command COMMAND on the marked files.
563 If no files are marked or a specific numeric prefix arg is given,
565 The prompt mentions the file(s) or the marker, as appropriate.
567 If there is a `*' in COMMAND, surrounded by whitespace, this runs
568 COMMAND just once with the entire file list substituted there.
570 If there is no `*', but there is a `?' in COMMAND, surrounded by
571 whitespace, this runs COMMAND on each file individually with the
572 file name substituted for `?'.
574 Otherwise, this runs COMMAND on each file individually with the
575 file name added at the end of COMMAND (separated by a space).
577 `*' and `?' when not surrounded by whitespace have no special
578 significance for `dired-do-shell-command', and are passed through
579 normally to the shell, but you must confirm first.
581 If you want to use `*' as a shell wildcard with whitespace around
583 `*' in the shell, but avoids Dired's special handling.
585 If COMMAND produces output, it goes to a separate buffer.
587 This feature does not try to redisplay Dired buffers afterward, as
588 there's no telling what files COMMAND may have changed.
591 When COMMAND runs, its working directory is the top-level directory
592 of the Dired buffer, so output files usually are created there
593 instead of in a subdir.
595 In a noninteractive call (from Lisp code), you must specify
596 the list of file names explicitly with the FILE-LIST argument, which
597 can be produced by `dired-get-marked-files', for example."
598 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
599 ;;actual work and can be redefined for customization.
603 ;; Want to give feedback whether this file or marked files are used:
606 current-prefix-arg
607 files)
608 current-prefix-arg
609 files)))
614 ;; Get confirmation for wildcards that may have been meant
615 ;; to control substitution of a file name or the file name list.
629 nil
630 file-list)
631 ;; execute the shell command
635 ;; Might use {,} for bash or csh:
644 ;; "Make up a shell command line from COMMAND and FILE-LIST.
645 ;; If ON-EACH is t, COMMAND should be applied to each file, else
646 ;; simply concat all files and apply COMMAND to this.
647 ;; FILE-LIST's elements will be quoted for the shell."
648 ;; Might be redefined for smarter things and could then use RAW-ARG
649 ;; (coming from interactive P and currently ignored) to decide what to do.
650 ;; Smart would be a way to access basename or extension of file names.
659 retval))
664 file-list dired-mark-separator)))
669 ;; This is an extra function so that it can be redefined by ange-ftp.
670 ;;;###autoload
677 ;; Return nil for sake of nconc in dired-bunch-files.
678 nil)
679 \f
682 ; "Display MSG while running PROGRAM, and check for output.
683 ;Remaining arguments are strings passed as command arguments to PROGRAM.
684 ; On error, insert output
685 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
686 ; Caller can cons up a list of failed args.
687 ;Else returns nil for success."
691 ;; Get a clean buffer for error output:
704 nil))))
705 \f
706 ;; Commands that delete or redisplay part of the dired buffer.
709 "Kill the current line (not the files).
710 With a prefix argument, kill that many lines starting with the current line.
711 \(A negative argument kills backward.)"
730 ;;;###autoload
732 "Kill all marked lines (not the files).
733 With a prefix argument, kill that many lines starting with the current line.
734 \(A negative argument kills backward.)
735 If you use this command with a prefix argument to kill the line
736 for a file that is a directory, which you have inserted in the
737 Dired buffer as a subdirectory, then it deletes that subdirectory
738 from the buffer as well.
739 To kill an entire subdirectory \(without killing its line in the
740 parent directory), go to its directory header line and use this
741 command with a prefix argument (the value does not matter)."
742 ;; Returns count of killed lines. FMT="" suppresses message.
760 count))))
762 ;;;###end dired-cmd.el
763 \f
764 ;;; 30K
765 ;;;###begin dired-cp.el
768 ;; Compress or uncompress the current file.
769 ;; Return nil for success, offending filename else.
775 ;; Remove any preexisting entry for the name NEW-FILE.
780 ;; Now replace the current line with an entry for NEW-FILE.
783 from-file)))
789 ;; For .z, try gunzip. It might be an old gzip file,
790 ;; or it might be from compact? pack? (which?) but gunzip handles both.
796 ;; This item controls naming for compression.
798 "Control changes in file name suffixes for compression and uncompression.
799 Each element specifies one transformation rule, and has the form:
800 (REGEXP NEW-SUFFIX PROGRAM)
801 The rule applies when the old file name matches REGEXP.
802 The new file name is computed by deleting the part that matches REGEXP
803 (as well as anything after that), then adding NEW-SUFFIX in its place.
804 If PROGRAM is non-nil, the rule is an uncompression rule,
805 and uncompression is done by running PROGRAM.
808 ;;;###autoload
810 ;; Compress or uncompress FILE.
811 ;; Return the name of the compressed or uncompressed file.
812 ;; Return nil if no change in files.
814 suffix newname
816 ;; See if any suffix rule matches this file name.
822 ;; If so, compute desired new name.
829 nil)
831 ;; We found an uncompression rule.
834 newname))
836 ;;; We don't recognize the file as compressed, so compress it.
837 ;;; Try gzip; if we don't have that, use compress.
843 out-name)))
848 ;; Rename the compressed file to NEWNAME
849 ;; if it hasn't got that name already.
853 newname)
854 out-name)))
858 ;; Don't use NEWNAME with `compress'.
860 \f
862 ;; Request confirmation from the user that the operation described
863 ;; by OP-SYMBOL is to be performed on the marked files.
864 ;; Confirmation consists in a y-or-n question with a file list
865 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
866 ;; The files used are determined by ARG (as in dired-get-marked-files).
869 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
870 ;; is marked pops up a window. That will help the user see
871 ;; it isn't the current line file.
880 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
881 ; and display failures.
883 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
884 ; the short form of the filename) for a failure and probably logs a
885 ; detailed error explanation using function `dired-log'.
887 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
888 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
889 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
890 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
892 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
904 ;; end this bunch of errors:
908 failures)))))
910 ;;;###autoload
912 "Format PROMPT with ARGS, query user, and store the result in SYM.
913 The return value is either nil or t.
915 The user may type y or SPC to accept once; n or DEL to skip once;
916 ! to accept this and subsequent queries; or q or ESC to decline
917 this and subsequent queries.
919 If SYM is already bound to a non-nil value, this function may
920 return automatically without querying the user. If SYM is !,
921 return t; if SYM is q or ESC, return nil."
938 \f
939 ;;;###autoload
941 "Compress or uncompress marked (or next ARG) files."
945 ;; Commands for Emacs Lisp files - load and byte compile
948 ;; Return nil for success, offending file name else.
950 elc-file buffer-read-only failure)
965 nil)))
967 ;;;###autoload
969 "Byte compile marked (or next ARG) Emacs Lisp files."
974 ;; Return nil for success, offending file name else.
980 nil
984 ;;;###autoload
986 "Load the marked (or next ARG) Emacs Lisp files."
990 ;;;###autoload
992 "Redisplay all marked (or next ARG) files.
993 If on a subdir line, redisplay that subdirectory. In that case,
994 a prefix arg lets you edit the `ls' switches used for the new listing.
996 Dired remembers switches specified with a prefix arg, so that reverting
997 the buffer will not reset them. However, using `dired-undo' to re-insert
998 or delete subdirectories can bypass this machinery. Hence, you sometimes
999 may have to reset some subdirectory switches after a `dired-undo'.
1000 You can reset all subdirectory switches to the default using
1002 See Info node `(emacs)Subdir switches' for more details."
1003 ;; Moves point if the next ARG files are redisplayed.
1009 dir
1013 dired-subdir-switches
1014 dired-actual-switches)))))
1016 ;; message much faster than making dired-map-over-marks show progress
1020 ;; Postpone readin hook till we map
1021 ;; over all marked files (Bug#6810).
1025 arg)
1031 "Set `dired-switches-alist' to nil and revert dired buffer."
1035 \f
1037 ;; Delete the current line, and insert an entry for FILE.
1038 ;; If FILE is nil, then just delete the current line.
1039 ;; Keeps any marks that may be present in column one (doing this
1040 ;; here is faster than with dired-add-entry's optional arg).
1041 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1049 ;; Replace space by old marker without moving point.
1050 ;; Faster than goto+insdel inside a save-excursion?
1054 ;;;###autoload
1065 "Add a new dired entry for FILENAME.
1066 Optionally mark it with MARKER-CHAR (a character, else uses
1067 `dired-marker-char'). Note that this adds the entry `out of order'
1068 if files are sorted by time, etc.
1069 Skips files that match `dired-trivial-filenames'.
1070 Exposes hidden subdirectories if a file is added there.
1072 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1073 files matching `dired-omit-regexp'."
1076 ;; Avoid calling ls for files that are going to be omitted anyway.
1082 filename)
1087 filename
1089 ;; Do it!
1092 ;; Entry is always for files, even if they happen to also be directories
1096 reason)
1101 reason
1108 ;; We are already where we should be, except when
1109 ;; point is before the subdir line or its total line.
1113 ;; else try to find correct place to insert
1117 ;; Point is at end of subdir line.
1119 ;; found - skip subdir and `total' line
1120 ;; and uninteresting files like . and ..
1121 ;; This better not move into the next subdir!
1123 ;; not found
1128 ;; Don't expand `.'.
1129 ;; Show just the file name within directory.
1132 directory
1136 ;; Put in desired marker char.
1140 dired-marker-char)))
1142 ;; Compensate for a bug in ange-ftp.
1143 ;; It inserts the file's absolute name, rather than
1144 ;; the relative one. That may be hard to fix since it
1145 ;; is probably controlled by something in ftp.
1161 ;; The subdir-alist is not affected...
1169 ;; return nil if all went well
1170 nil))
1174 ;; Don't do it (dired-omit-mode).
1175 ;; Return t for success (perhaps we should return file-exists-p).
1176 t))
1179 ;; Return pos of first file line of DIR, skipping header and total
1180 ;; or wildcard lines.
1181 ;; Important: never moves into the next subdir.
1182 ;; DIR is assumed to be unhidden.
1191 ;;;###autoload
1204 ;;;###autoload
1206 "Create or update the line for FILE in all Dired buffers it would belong in."
1212 ;; Relist the line for FILE, or just add it if it did not exist.
1213 ;; FILE must be an absolute file name.
1215 ;; If cursor is already on FILE's line delete-region will cause
1216 ;; save-excursion to fail because of floating makers,
1217 ;; moving point to beginning of line. Sigh.
1226 \f
1227 ;;; Copy, move/rename, making hard and symbolic links
1230 "Non-nil if Dired should ask about making backups before overwriting files.
1231 Special value `always' suppresses confirmation."
1237 ;; This is a fluid var used in dired-handle-overwrite. It should be
1238 ;; let-bound whenever dired-copy-file etc are called. See
1239 ;; dired-create-files for an example.
1243 ;; Save old version of file TO that is to be overwritten.
1244 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1245 ;; from dired-create-files.
1248 dired-overwrite-confirmed
1252 "Make backup for existing file `%s'? "
1253 to)))
1257 ;;;###autoload
1261 dired-recursive-copies))
1266 preserve-time top recursive)
1275 ;; This is a directory.
1277 ;; Not a directory.
1281 ;; It is a symlink
1286 dired-create-files-failures)
1289 ;;;###autoload
1293 ;; Silently rename the visited file of any buffer visiting this file.
1298 ;; See if it's an inserted subdir, and rename that, too.
1306 ;; Update visited file name of all affected buffers
1316 to-dir
1317 buffer-file-name)))
1323 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1324 ;; one of its subdirectories is expanded in this buffer.
1332 ;; ELT's subdir is affected by the rename
1335 ;; if top level directory was renamed, lots of things have to be
1336 ;; updated:
1341 ;; with and without wildcards
1343 to))
1346 ;; try to rename buffer, but just leave old name if new
1347 ;; name would already exist (don't try appending "<%d>")
1350 ;; ... we dired TO now:
1354 ;; Update the headerline and dired-subdir-alist element, as well as
1355 ;; dired-switches-alist element, of directory described by
1356 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1357 ;; describes either DIR itself or a subdir of DIR.
1361 buffer-read-only)
1363 ;; Update subdir headerline in buffer
1366 dir)
1371 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1377 \f
1378 ;; Bound in dired-create-files
1382 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1385 "Create one or more new files from a list of existing files FN-LIST.
1386 This function also handles querying the user, updating Dired
1387 buffers, and displaying a success or failure message.
1389 FILE-CREATOR should be a function. It is called once for each
1390 file in FN-LIST, and must create a new file, querying the user
1391 and updating Dired buffers as necessary. It should accept three
1392 arguments: the old file name, the new name, and an argument
1393 OK-IF-ALREADY-EXISTS with the same meaning as in `copy-file'.
1395 OPERATION should be a capitalized string describing the operation
1396 performed (e.g. `Copy'). It is used for error logging.
1398 FN-LIST is the list of files to copy (full absolute file names).
1400 NAME-CONSTRUCTOR should be a function accepting a single
1401 argument, the name of an old file, and returning either the
1402 corresponding new file name or nil to skip.
1404 Optional MARKER-CHAR is a character with which to mark every
1405 newfile's entry, or t to use the current marker character if the
1406 old file was marked."
1424 Type SPC or `y' to overwrite file `%s',
1425 DEL or `n' to skip to next,
1426 ESC or `q' to not overwrite any of the remaining files,
1430 ;; must determine if FROM is marked before file-creator
1431 ;; gets a chance to delete it (in case of a move).
1436 ;; Handle the `dired-copy-file' file-creator specially
1437 ;; When copying a directory to another directory or
1438 ;; possibly to itself or one of its subdirectories.
1439 ;; e.g "~/foo/" => "~/test/"
1440 ;; or "~/foo/" =>"~/foo/"
1441 ;; or "~/foo/ => ~/foo/bar/")
1442 ;; In this case the 'name-constructor' have set the destination
1443 ;; TO to "~/test/foo" because the old emacs23 behavior
1444 ;; of `copy-directory' was to not create the subdirectory
1445 ;; and instead copy the contents.
1446 ;; With the new behavior of `copy-directory'
1447 ;; (similar to the `cp' shell command) we don't
1448 ;; need such a construction of the target directory,
1449 ;; so modify the destination TO to "~/test/" instead of "~/test/foo/".
1455 ;; If DESTNAME is a subdirectory of FROM, not a symlink,
1456 ;; and the method in use is copying, signal an error.
1461 from to)))
1466 ;; If we get here, file-creator hasn't been aborted
1467 ;; and the old entry (if any) has to be deleted
1468 ;; before adding the new entry.
1476 failures)
1478 operation from to err))))))))
1486 total)
1487 failures))
1493 failures))
1499 skipped))
1504 \f
1506 &optional marker-char op1
1507 how-to)
1508 "Create a new file for each marked file.
1509 Prompts user for target, which is a directory in which to create
1510 the new files. Target may also be a plain file if only one marked
1511 file exists. The way the default for the target directory is
1512 computed depends on the value of `dired-dwim-target-directory'.
1513 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1514 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1515 FILE-CREATOR and OPERATION as in `dired-create-files'.
1516 ARG as in `dired-get-marked-files'.
1517 Optional arg MARKER-CHAR as in `dired-create-files'.
1518 Optional arg OP1 is an alternate form for OPERATION if there is
1519 only one file.
1520 Optional arg HOW-TO determines how to treat the target.
1521 If HOW-TO is nil, use `file-directory-p' to determine if the
1522 target is a directory. If so, the marked file(s) are created
1523 inside that directory. Otherwise, the target is a plain file;
1524 an error is raised unless there is exactly one marked file.
1525 If HOW-TO is t, target is always treated as a plain file.
1526 Otherwise, HOW-TO should be a function of one argument, TARGET.
1527 If its return value is nil, TARGET is regarded as a plain file.
1528 If it return value is a list, TARGET is a generalized
1529 directory (e.g. some sort of archive). The first element of
1530 this list must be a function with at least four arguments:
1531 operation - as OPERATION above.
1532 rfn-list - list of the relative names for the marked files.
1533 fn-list - list of the absolute names for the marked files.
1534 target - the name of the target itself.
1535 The rest of into-dir are optional arguments.
1536 For any other return value, TARGET is treated as a directory."
1545 target-dir)))
1554 target-dir op-symbol arg rfn-list default))))
1556 ;; Allow DOS/Windows users to change the letter
1557 ;; case of a directory. If we don't test these
1558 ;; conditions up front, file-directory-p below
1559 ;; will return t because the filesystem is
1560 ;; case-insensitive, and Emacs will try to move
1561 ;; foo -> foo/foo, which fails.
1564 dired-one-file
1572 nil
1580 ;; rename-file bombs when moving directories unless we do this:
1583 file-creator operation fn-list
1585 ;; This function uses fluid variable target when called
1586 ;; inside dired-create-files:
1591 marker-char))))
1593 ;; Read arguments for a marked-files command that wants a file name,
1594 ;; perhaps popping up the list of marked files.
1595 ;; ARG is the prefix arg and indicates whether the files came from
1596 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1597 ;; If the current file was used, the list has but one element and ARG
1598 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1599 ;; DEFAULT is the default value to return if the user just hits RET;
1600 ;; if it is omitted or nil, then the name of the directory is used.
1605 nil op-symbol files
1610 ;; Try to guess which target directory the user may want.
1611 ;; If there is a dired buffer displayed in one of the next windows,
1612 ;; use its current subdir, else use current subdir of this dired buffer.
1615 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1626 this-dir)))
1629 ;; Return a list of default values for file-reading functions in Dired.
1630 ;; This list may contain directories from Dired buffers in other windows.
1631 ;; `fn-list' is a list of file names used to build a list of defaults.
1632 ;; When nil or more than one element, a list of defaults will
1633 ;; contain only directory names. `target-dir' is a directory name
1634 ;; to exclude from the returned list, for the case when this
1635 ;; directory name is already presented in initial input.
1636 ;; For Dired operations that support `dired-dwim-target',
1637 ;; the argument `target-dir' should have the value returned
1638 ;; from `dired-dwim-target-directory'.
1643 dired-dirs)
1644 ;; Get a list of directories of visible buffers in dired-mode.
1649 ;; Force the current dir to be the first in the list.
1652 ;; Remove the target dir (if specified) or the current dir from
1653 ;; default values, because it should be already in initial input.
1655 ;; Return a list of default values.
1657 ;; For one file operation, provide a list that contains
1658 ;; other directories, other directories with the appended filename
1659 ;; and the current directory with the appended filename, e.g.
1660 ;; 1. /TARGET-DIR/
1661 ;; 2. /TARGET-DIR/FILENAME
1662 ;; 3. /CURRENT-DIR/FILENAME
1671 ;; For multi-file operation, return only a list of other directories.
1672 dired-dirs)))
1674 \f
1675 ;;;###autoload
1677 "Create a directory called DIRECTORY.
1678 If DIRECTORY already exists, signal an error."
1685 ;; Find the topmost nonexistent parent dir (variable `new')
1697 ;; This may not always be what you want, especially if target is your
1698 ;; home directory and it happens to be a symbolic link, as is often the
1699 ;; case with NFS and automounters. Or if you want to make symlinks
1700 ;; into directories that themselves are only symlinks, also quite
1701 ;; common.
1703 ;; So we don't use this function as value for HOW-TO in
1704 ;; dired-do-symlink, which has the minor disadvantage of
1705 ;; making links *into* a symlinked-dir, when you really wanted to
1706 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1707 ;; just have to remove that symlink by hand before making your marked
1708 ;; symlinks.
1711 "Either nil or a function used by `dired-do-copy' to determine target.
1714 ;;;###autoload
1716 "Copy all marked (or next ARG) files, or copy the current file.
1717 This normally preserves the last-modified date when copying.
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 copies of these files 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.
1725 This command copies symbolic links by creating new ones,
1726 like `cp -d'."
1730 "Copy"
1731 arg dired-keep-marker-copy
1732 nil dired-copy-how-to-fn)))
1734 ;;;###autoload
1736 "Make symbolic links to current file or all marked (or next ARG) files.
1737 When operating on just the current file, you specify the new name.
1738 When operating on multiple or marked files, you specify a directory
1739 and new symbolic links are made in that directory
1740 with the same names that the files currently have. The default
1741 suggested for the target directory depends on the value of
1742 `dired-dwim-target', which see.
1749 ;;;###autoload
1751 "Add names (hard links) current file or all marked (or next ARG) files.
1752 When operating on just the current file, you specify the new name.
1753 When operating on multiple or marked files, you specify a directory
1754 and new hard links are made in that directory
1755 with the same names that the files currently have. The default
1756 suggested for the target directory depends on the value of
1757 `dired-dwim-target', which see."
1764 ;; error is caught in -create-files
1766 ;; Update the link count
1769 ;;;###autoload
1771 "Rename current file or all marked (or next ARG) files.
1772 When renaming just the current file, you specify the new name.
1773 When renaming multiple or marked files, you specify a directory.
1774 This command also renames any buffers that are visiting the files.
1775 The default suggested for the target directory depends on the value
1776 of `dired-dwim-target', which see."
1780 ;;;###end dired-cp.el
1781 \f
1782 ;;; 5K
1783 ;;;###begin dired-re.el
1788 ;; Create a new file for each marked file using regexps.
1789 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1790 ;; ARG as in dired-get-marked-files.
1791 ;; Matches each marked file against REGEXP and constructs the new
1792 ;; filename from NEWNAME (like in function replace-match).
1793 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1794 ;; instead of only the non-directory part of the file.
1795 ;; Optional arg MARKER-CHAR as in dired-create-files.
1799 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1800 `!' to %s all remaining matches with no more questions."
1804 ;; Function to construct new filename using REGEXP and NEWNAME:
1809 ;; must bind help-form directly around call to
1810 ;; dired-query
1814 operation-prompt
1815 from
1816 to)
1817 to)
1819 operation from regexp)))))
1820 ;; not whole-name, replace non-directory part only
1831 operation-prompt
1834 to)
1837 rename-regexp-query)
1839 file-creator operation fn-list regexp-name-constructor marker-char)))
1842 ;; Prompt user about performing OPERATION.
1843 ;; Read and return list of: regexp newname arg whole-name.
1856 ;;;###autoload
1858 "Rename selected files whose names match REGEXP to NEWNAME.
1860 With non-zero prefix argument ARG, the command operates on the next ARG
1861 files. Otherwise, it operates on all the marked files, or the current
1862 file if none are marked.
1864 As each match is found, the user must type a character saying
1867 REGEXP defaults to the last regexp used.
1869 With a zero prefix arg, renaming by regexp affects the absolute file name.
1870 Normally, only the non-directory part of the file name is used and changed."
1876 ;;;###autoload
1878 "Copy selected files whose names match REGEXP to NEWNAME.
1879 See function `dired-do-rename-regexp' for more info."
1885 arg regexp newname whole-name dired-keep-marker-copy)))
1887 ;;;###autoload
1889 "Hardlink selected files whose names match REGEXP to NEWNAME.
1890 See function `dired-do-rename-regexp' for more info."
1896 ;;;###autoload
1898 "Symlink selected files whose names match REGEXP to NEWNAME.
1899 See function `dired-do-rename-regexp' for more info."
1909 ;; Perform FILE-CREATOR on the non-directory part of marked files
1910 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1911 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1914 file-creator
1915 operation
1923 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1924 `!' to %s all remaining matches with no more questions."
1931 to))))
1932 dired-keep-marker-rename)))
1937 basename-constructor operation arg))
1939 ;;;###autoload
1941 "Rename all marked (or next ARG) files to upper case."
1945 ;;;###autoload
1947 "Rename all marked (or next ARG) files to lower case."
1951 ;;;###end dired-re.el
1952 \f
1953 ;;; 13K
1954 ;;;###begin dired-ins.el
1956 ;;;###autoload
1958 switches no-error-if-not-dir-p)
1959 "Insert this subdirectory into the same dired buffer.
1961 else inserts it at its natural place (as `ls -lR' would have done).
1962 With a prefix arg, you may edit the ls switches used for this listing.
1963 You can add `R' to the switches to expand the whole tree starting at
1964 this subdirectory.
1965 This function takes some pains to conform to `ls -lR' output.
1967 Dired remembers switches specified with a prefix arg, so that reverting
1968 the buffer will not reset them. However, using `dired-undo' to re-insert
1969 or delete subdirectories can bypass this machinery. Hence, you sometimes
1970 may have to reset some subdirectory switches after a `dired-undo'.
1971 You can reset all subdirectory switches to the default using
1973 See Info node `(emacs)Subdir switches' for more details."
1980 ;; We don't need a marker for opoint as the subdir is always
1981 ;; inserted *after* opoint.
1986 ;; Push mark so that it's easy to find back. Do this after the
1987 ;; insert message so that the user sees the `Mark set' message.
1990 ;;;###autoload
1992 "Insert this subdirectory into the same dired buffer.
1993 If it is already present, overwrites previous entry,
1994 else inserts it at its natural place (as `ls -lR' would have done).
1995 With a prefix arg, you may edit the `ls' switches used for this listing.
1996 You can add `R' to the switches to expand the whole tree starting at
1997 this subdirectory.
1998 This function takes some pains to conform to `ls -lR' output."
1999 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
2000 ;; Prospero where dired-ls does the right thing, but
2001 ;; file-directory-p has not been redefined.
2015 switches-have-R mark-alist case-fold-search buffer-read-only)
2018 ;; case-fold-search is nil now, so we can test for capital `R':
2020 ;; avoid duplicated subdirs
2023 ;; If subdir is already present, remove it and remember its marks
2047 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2048 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2061 ;; all switches that make a difference to dired-get-filename:
2065 ;; Add new DIR at NEW-MARKER. Sort alist.
2070 ;; Keep the alist sorted on buffer position.
2078 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2079 Interactively, you can kill DIRNAME as well by using a prefix argument.
2080 In interactive use, the command prompts for DIRNAME.
2082 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2083 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2094 m-alist))
2097 ;; Find pos for new subdir, according to tree order.
2098 ;;(goto-char (point-max))
2105 ;; Insert NEW-DIR after DIR
2107 alist nil)))
2109 ;; want a separating newline between subdirs
2116 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2117 ;; Move to that buffer position. Return a mark-alist.
2120 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2129 ;; Insert ls output after point.
2130 ;; Return the boundary of the inserted text (as list of BEG and END).
2135 dired-subdir-switches
2138 ;; If doing the top level directory of the buffer,
2139 ;; redo it as specified in dired-directory.
2145 ;; Point is at the correct subdir alist position for ELT,
2146 ;; BEG-END is the subdir-region (as list of begin and end).
2148 ;; update its position (should actually be unchanged)
2151 ;; The hook may depend on the subdir-alist containing the just
2152 ;; inserted subdir, so run it after dired-alist-add:
2160 ;; hook may add or delete lines, but the subdir boundary
2161 ;; marker floats
2165 ;; Lexicographic order on file name components, like `ls -lR':
2166 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2167 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2168 ;; or DIR1 and DIR2 are in the same parentdir and their last
2169 ;; components are string-lessp.
2170 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2171 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2172 ;; if dired-actual-switches contained `t'.
2178 components-2
2190 t)
2192 nil)
2195 ;; There should be a builtin split function - inverse to mapconcat.
2197 "Splitting on regexp PAT, turn string STR into a list of substrings.
2198 Optional third arg LIMIT (>= 1) is a limit to the length of the
2199 resulting list.
2200 Thus, if SEP is a regexp that only matches itself,
2202 (mapconcat 'identity (dired-split SEP STRING) SEP)
2204 is always equal to STRING."
2217 start end)
2218 ))
2225 \f
2226 ;;; moving by subdirectories
2228 ;;;###autoload
2230 "Go to previous subdirectory, regardless of level.
2231 When called interactively and not on a subdir line, go to this subdir's line."
2232 ;;(interactive "p")
2236 ;; if on subdir start already, don't stay there!
2246 ;;;###autoload
2248 "Go to end of header line of DIR in this dired buffer.
2249 Return value of point on success, otherwise return nil.
2255 dired-subdir-alist ; table
2256 nil ; predicate
2257 t ; require-match
2264 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2265 ;; at either \r or \n after this function succeeds.
2268 \f
2269 ;;;###autoload
2271 "Mark all files except `.' and `..' in current subdirectory.
2272 If the Dired buffer shows multiple directories, this command
2273 marks the files listed in the subdirectory that point is in."
2278 ;;;###autoload
2280 "Remove all lines of current subdirectory.
2281 Lower levels are unaffected."
2282 ;; With optional REMEMBER-MARKS, return a mark-alist.
2289 buffer-read-only)
2303 ;; Remove DIR from the alist
2307 ;;;###autoload
2309 "Go up ARG levels in the dired tree."
2315 ;;(setq dir (expand-file-name dir))
2319 ;;;###autoload
2321 "Go down in the dired tree."
2335 \f
2336 ;;; hiding
2352 ;;;###autoload
2354 "Hide or unhide the current subdirectory and move to next directory.
2355 Optional prefix arg is a repeat factor.
2365 buffer-read-only)
2366 ;; keep header line visible, hide rest
2375 ;;;###autoload
2377 "Hide all subdirectories, leaving only their header lines.
2378 If there is already something hidden, make everything visible again.
2383 buffer-read-only)
2387 ;; unhide - bombs on \r in filenames
2389 ;; hide
2396 ;; we're somewhere on current dir's line
2404 ;;;###end dired-ins.el
2406 \f
2407 ;; Search only in file names in the Dired buffer.
2410 "Non-nil to Isearch in file names only.
2411 If t, Isearch in Dired always matches only file names.
2412 If `dwim', Isearch matches file names when initial point position is on
2413 a file name. Otherwise, it searches the whole buffer without restrictions."
2423 "Toggle file names searching on or off.
2424 When on, Isearch skips matches outside file names using the predicate
2425 `dired-isearch-filter-filenames' that matches only at file names.
2426 When off, it uses the original predicate."
2430 dired-isearch-filter-predicate-orig
2435 ;;;###autoload
2437 "Set up isearch to search in Dired file names.
2438 Intended to be added to `isearch-mode-hook'."
2450 "Clean up the Dired file name search after terminating isearch."
2457 "Test whether the current search hit is a visible file name.
2458 Return non-nil if the text from BEG to END is part of a file
2459 name (has the text property `dired-filename') and is visible."
2464 t)))
2466 ;;;###autoload
2468 "Search for a string using Isearch only in file names in the Dired buffer."
2473 ;;;###autoload
2475 "Search for a regexp using Isearch only in file names in the Dired buffer."
2480 \f
2481 ;; Functions for searching in tags style among marked files.
2483 ;;;###autoload
2485 "Search for a string through all marked files using Isearch."
2490 ;;;###autoload
2492 "Search for a regexp through all marked files using Isearch."
2497 ;;;###autoload
2499 "Search through all marked files for a match for REGEXP.
2500 Stops when a match is found.
2505 ;;;###autoload
2507 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2508 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2519 buffer-read-only))
2526 \f
2527 ;;;###autoload
2529 "Print the type of FILE, according to the `file' command.
2530 If you give a prefix to this command, and FILE is a symbolic
2531 link, then the type of the file linked to by FILE is printed
2532 instead."
2545 ;; Local Variables:
2546 ;; byte-compile-dynamic: t
2547 ;; generated-autoload-file: "dired.el"
2548 ;; End:
2550 ;;; dired-aux.el ends here