| blob | 62d6928c024594a08501eaa8adde838d5137c442 |
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
7 ;; Maintainer: FSF
8 ;; Keywords: files
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; The parts of dired mode not normally used. This is a space-saving hack
28 ;; to avoid having to load a large mode when all that's wanted are a few
29 ;; functions.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
37 ;; We need macros in dired.el to compile properly,
38 ;; and we call subroutines in it too.
42 "Variable where `dired-create-files' records failing file names.
43 Functions that operate recursively can store additional names
46 ;;; 15K
47 ;;;###begin dired-cmd.el
48 ;; Diffing and compressing
53 ;;;###autoload
55 "Compare file at point with file FILE using `diff'.
56 FILE defaults to the file at the mark. (That's the mark set by
58 The prompted-for file is the first file given to `diff'.
59 With prefix arg, prompt for second argument SWITCHES,
60 which is options for `diff'."
63 ;; Get the file at the mark.
67 ;; Use it as default if it's not the same as the current file,
68 ;; and the target dir is the current dir or the mark is active.
72 mark-active))
73 file-at-mark))
87 target-dir default t))
91 diff-switches
102 ;;;###autoload
104 "Diff this file with its backup file or vice versa.
105 Uses the latest backup, if there are several numerical backups.
106 If this file is a backup, diff it with its original.
107 The backup file is the first file given to `diff'.
108 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
113 diff-switches
115 nil))
118 ;;;###autoload
120 "Mark files with different file attributes in two dired buffers.
121 Compare file attributes of files in the current directory
122 with file attributes in directory DIR2 using PREDICATE on pairs of files
123 with the same name. Mark files for which PREDICATE returns non-nil.
124 Mark files with different names if PREDICATE is nil (or interactively
125 with empty input at the predicate prompt).
127 PREDICATE is a Lisp expression that can refer to the following variables:
129 size1, size2 - file size in bytes
130 mtime1, mtime2 - last modification time in seconds, as a float
131 fa1, fa2 - list of file attributes
132 returned by function `file-attributes'
134 where 1 refers to attribute of file in the current dired buffer
135 and 2 to attribute of file in second dired buffer.
137 Examples of PREDICATE:
139 (> mtime1 mtime2) - mark newer files
140 (not (= size1 size2)) - mark files with different sizes
141 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
142 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
143 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
154 target-dir target-dir t)))
159 file-list1 file-list2)
165 'cadr
167 file-alist1 file-alist2
168 predicate))
170 'cadr
172 file-alist2 file-alist1
173 predicate)))
175 dir1 nil
180 dir2 nil
189 "Combine LIST1 and LIST2 using a set-difference operation.
190 The result list contains all file items that appear in LIST1 but not LIST2.
191 This is a non-destructive function; it makes a copy of the data if necessary
192 to avoid corrupting the original LIST1 and LIST2.
193 PREDICATE (see `dired-compare-directories') is an additional match
194 condition. Two file items are considered to match if they are equal
195 *and* PREDICATE evaluates to t."
197 list1
213 list)
218 "Return a list of all file names and attributes from DIR.
219 List has a form of (file-name full-file-name (attribute-list))."
224 full-file-name
227 \f
230 "Create initial input value for `touch' command."
241 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
242 ;; refresh their file lines.
243 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
244 ;; PROGRAM is the program used to change the attribute.
245 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
246 ;; ARG describes which files to use, as in dired-get-marked-files.
252 op-symbol arg files))
254 failures)
265 files))
270 nil))))
272 ;;;###autoload
274 "Change the mode of the marked (or next ARG) files.
275 Symbolic modes like `g+w' are allowed."
290 "Change mode of %s to: " nil
296 file
301 ;;;###autoload
303 "Change the group of the marked (or next ARG) files."
309 ;;;###autoload
311 "Change the owner of the marked (or next ARG) files."
317 ;;;###autoload
319 "Change the timestamp of the marked (or next ARG) files.
320 This calls touch."
324 ;; Process all the files in FILES in batches of a convenient size,
325 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
326 ;; Batches are chosen to need less than MAX chars for the file names,
327 ;; allowing 3 extra characters of separator per file name.
330 past
332 failures)
333 ;; Accumulate files as long as they fit in MAX chars,
334 ;; then process the ones accumulated so far.
339 ;; If we have at least 1 pending file
340 ;; and this file won't fit in the length limit, process now.
343 ;; The elements of PENDING are now in forward order.
344 ;; Do the operation and record failures.
346 failures)
347 ;; Transfer the elemens of PENDING onto PAST
348 ;; and clear it out. Now PAST contains the first N files
349 ;; specified (for some N), and FILES contains the rest.
351 pending nil
353 ;; Do (setq pending (cons thisfile pending))
354 ;; but reuse the cons that was in `files'.
362 failures)
363 ;; Now the original list FILES has been put back as it was.
366 ;;;###autoload
368 "Print the marked (or next ARG) files.
369 Uses the shell command coming from variables `lpr-command' and
370 `lpr-switches' as default."
374 "Print %s with: "
379 lpr-switches))
384 ;; Read arguments for a marked-files command that wants a string
385 ;; that is not a file name,
386 ;; perhaps popping up the list of marked files.
387 ;; ARG is the prefix arg and indicates whether the files came from
388 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
389 ;; If the current file was used, the list has but one element and ARG
390 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
393 ;; PROMPT for a string, with INITIAL input and DEFAULT value.
394 ;; Other args are used to give user feedback and pop-up:
395 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
397 nil op-symbol files
400 \f
401 ;;; Cleaning a directory: flagging some backups for deletion.
405 ;;;###autoload
407 "Flag numerical backups for deletion.
408 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
409 Positive prefix arg KEEP overrides `dired-kept-versions';
410 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
413 with a prefix argument."
420 late-retention early-retention)
421 ;; Look at each file.
422 ;; If the file has numeric backup versions,
423 ;; put on dired-file-version-alist an element of the form
424 ;; (FILENAME . VERSION-NUMBER-LIST)
426 ;; Sort each VERSION-NUMBER-LIST,
427 ;; and remove the versions not to be deleted.
435 sorted-v-list)))
439 ;; Look at each file. If it is a numeric backup file,
440 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
444 ;;; Subroutines of dired-clean-directory.
447 ;; Perform FUN with point at the end of each non-directory line.
448 ;; FUN takes one argument, the absolute filename.
463 ;; Only do work if this file is not already in the alist.
465 nil
466 ;; If it looks like file FN has versions, return a list of the versions.
467 ;;That is a list of strings which are file names.
468 ;;The caller may want to flag some of these files for deletion.
473 base-versions
479 dired-file-version-alist)))))))
483 base-version-list)
493 \f
494 ;;; Shell commands
499 "Return a list of all commands associated with current dired files.
500 This function is used to add all related commands retrieved by `mailcap'
501 to the end of the list of defaults just after the default value."
509 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
511 "Read a dired shell command prompting with PROMPT (using `read-shell-command').
512 ARG is the prefix arg and may be used to indicate in the prompt which
513 FILES are affected."
519 nil 'shell files
520 #'read-shell-command
522 nil nil)))
524 ;;;###autoload
526 "Run a shell command COMMAND on the marked files asynchronously.
528 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
529 adds `* &' surrounded by whitespace and executes the command asynchronously.
530 The output appears in the buffer `*Async Shell Command*'."
534 ;; Want to give feedback whether this file or marked files are used:
536 current-prefix-arg
537 files)))
544 ;; The in-background argument is only needed in Emacs 18 where
545 ;; shell-command doesn't understand an appended ampersand `&'.
546 ;;;###autoload
548 "Run a shell command COMMAND on the marked files.
549 If no files are marked or a specific numeric prefix arg is given,
551 The prompt mentions the file(s) or the marker, as appropriate.
553 If there is a `*' in COMMAND, surrounded by whitespace, this runs
554 COMMAND just once with the entire file list substituted there.
556 If there is no `*', but there is a `?' in COMMAND, surrounded by
557 whitespace, this runs COMMAND on each file individually with the
558 file name substituted for `?'.
560 Otherwise, this runs COMMAND on each file individually with the
561 file name added at the end of COMMAND (separated by a space).
563 `*' and `?' when not surrounded by whitespace have no special
564 significance for `dired-do-shell-command', and are passed through
565 normally to the shell, but you must confirm first. To pass `*' by
568 If COMMAND produces output, it goes to a separate buffer.
570 This feature does not try to redisplay Dired buffers afterward, as
571 there's no telling what files COMMAND may have changed.
574 When COMMAND runs, its working directory is the top-level directory
575 of the Dired buffer, so output files usually are created there
576 instead of in a subdir.
578 In a noninteractive call (from Lisp code), you must specify
579 the list of file names explicitly with the FILE-LIST argument, which
580 can be produced by `dired-get-marked-files', for example."
581 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
582 ;;actual work and can be redefined for customization.
586 ;; Want to give feedback whether this file or marked files are used:
589 current-prefix-arg
590 files)
591 current-prefix-arg
592 files)))
597 ;; Get confirmation for wildcards that may have been meant
598 ;; to control substitution of a file name or the file name list.
612 nil
613 file-list)
614 ;; execute the shell command
618 ;; Might use {,} for bash or csh:
627 ;; "Make up a shell command line from COMMAND and FILE-LIST.
628 ;; If ON-EACH is t, COMMAND should be applied to each file, else
629 ;; simply concat all files and apply COMMAND to this.
630 ;; FILE-LIST's elements will be quoted for the shell."
631 ;; Might be redefined for smarter things and could then use RAW-ARG
632 ;; (coming from interactive P and currently ignored) to decide what to do.
633 ;; Smart would be a way to access basename or extension of file names.
642 retval))
647 file-list dired-mark-separator)))
652 ;; This is an extra function so that it can be redefined by ange-ftp.
653 ;;;###autoload
660 ;; Return nil for sake of nconc in dired-bunch-files.
661 nil)
662 \f
665 ; "Display MSG while running PROGRAM, and check for output.
666 ;Remaining arguments are strings passed as command arguments to PROGRAM.
667 ; On error, insert output
668 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
669 ; Caller can cons up a list of failed args.
670 ;Else returns nil for success."
674 ;; Get a clean buffer for error output:
687 nil))))
688 \f
689 ;; Commands that delete or redisplay part of the dired buffer.
710 ;;;###autoload
712 "Kill all marked lines (not the files).
713 With a prefix argument, kill that many lines starting with the current line.
714 \(A negative argument kills backward.)
715 If you use this command with a prefix argument to kill the line
716 for a file that is a directory, which you have inserted in the
717 Dired buffer as a subdirectory, then it deletes that subdirectory
718 from the buffer as well.
719 To kill an entire subdirectory \(without killing its line in the
720 parent directory), go to its directory header line and use this
721 command with a prefix argument (the value does not matter)."
722 ;; Returns count of killed lines. FMT="" suppresses message.
740 count))))
742 ;;;###end dired-cmd.el
743 \f
744 ;;; 30K
745 ;;;###begin dired-cp.el
748 ;; Compress or uncompress the current file.
749 ;; Return nil for success, offending filename else.
755 ;; Remove any preexisting entry for the name NEW-FILE.
760 ;; Now replace the current line with an entry for NEW-FILE.
763 from-file)))
769 ;; For .z, try gunzip. It might be an old gzip file,
770 ;; or it might be from compact? pack? (which?) but gunzip handles both.
776 ;; This item controls naming for compression.
778 "Control changes in file name suffixes for compression and uncompression.
779 Each element specifies one transformation rule, and has the form:
780 (REGEXP NEW-SUFFIX PROGRAM)
781 The rule applies when the old file name matches REGEXP.
782 The new file name is computed by deleting the part that matches REGEXP
783 (as well as anything after that), then adding NEW-SUFFIX in its place.
784 If PROGRAM is non-nil, the rule is an uncompression rule,
785 and uncompression is done by running PROGRAM.
788 ;;;###autoload
790 ;; Compress or uncompress FILE.
791 ;; Return the name of the compressed or uncompressed file.
792 ;; Return nil if no change in files.
794 suffix newname
796 ;; See if any suffix rule matches this file name.
802 ;; If so, compute desired new name.
809 nil)
811 ;; We found an uncompression rule.
814 newname))
816 ;;; We don't recognize the file as compressed, so compress it.
817 ;;; Try gzip; if we don't have that, use compress.
823 out-name)))
828 ;; Rename the compressed file to NEWNAME
829 ;; if it hasn't got that name already.
833 newname)
834 out-name)))
838 ;; Don't use NEWNAME with `compress'.
840 \f
842 ;; Request confirmation from the user that the operation described
843 ;; by OP-SYMBOL is to be performed on the marked files.
844 ;; Confirmation consists in a y-or-n question with a file list
845 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
846 ;; The files used are determined by ARG (as in dired-get-marked-files).
849 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
850 ;; is marked pops up a window. That will help the user see
851 ;; it isn't the current line file.
860 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
861 ; and display failures.
863 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
864 ; the short form of the filename) for a failure and probably logs a
865 ; detailed error explanation using function `dired-log'.
867 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
868 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
869 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
870 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
872 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
884 ;; end this bunch of errors:
888 failures)))))
895 ;; None of these keys quit - use C-g for that.
896 ))
898 ;;;###autoload
900 "Query user and return nil or t.
901 Store answer in symbol VAR (which must initially be bound to nil).
902 Format PROMPT with ARGS.
903 Binding variable `help-form' will help the user who types the help key."
919 done result elt)
925 ;; read-event returns -1 if we are in a kbd
926 ;; macro and there are no more events in the
927 ;; macro. Attempt to get an event
928 ;; interactively.
934 dired-query-alist)))))))
935 ;; Display the question with the answer.
939 \f
940 ;;;###autoload
942 "Compress or uncompress marked (or next ARG) files."
946 ;; Commands for Emacs Lisp files - load and byte compile
949 ;; Return nil for success, offending file name else.
951 elc-file buffer-read-only failure)
966 nil)))
968 ;;;###autoload
970 "Byte compile marked (or next ARG) Emacs Lisp files."
975 ;; Return nil for success, offending file name else.
981 nil
985 ;;;###autoload
987 "Load the marked (or next ARG) Emacs Lisp files."
991 ;;;###autoload
993 "Redisplay all marked (or next ARG) files.
994 If on a subdir line, redisplay that subdirectory. In that case,
995 a prefix arg lets you edit the `ls' switches used for the new listing.
997 Dired remembers switches specified with a prefix arg, so that reverting
998 the buffer will not reset them. However, using `dired-undo' to re-insert
999 or delete subdirectories can bypass this machinery. Hence, you sometimes
1000 may have to reset some subdirectory switches after a `dired-undo'.
1001 You can reset all subdirectory switches to the default using
1003 See Info node `(emacs)Subdir switches' for more details."
1004 ;; Moves point if the next ARG files are redisplayed.
1010 dir
1014 dired-subdir-switches
1015 dired-actual-switches)))))
1017 ;; message much faster than making dired-map-over-marks show progress
1023 arg)
1028 "Set `dired-switches-alist' to nil and revert dired buffer."
1032 \f
1034 ;; Delete the current line, and insert an entry for FILE.
1035 ;; If FILE is nil, then just delete the current line.
1036 ;; Keeps any marks that may be present in column one (doing this
1037 ;; here is faster than with dired-add-entry's optional arg).
1038 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1046 ;; Replace space by old marker without moving point.
1047 ;; Faster than goto+insdel inside a save-excursion?
1051 ;;;###autoload
1058 ;; Add a new entry for FILENAME, optionally marking it
1059 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
1060 ;; Note that this adds the entry `out of order' if files sorted by
1061 ;; time, etc.
1062 ;; At least this version inserts in the right subdirectory (if present).
1063 ;; And it skips "." or ".." (see `dired-trivial-filenames').
1064 ;; Hidden subdirs are exposed if a file is added there.
1066 ;; Entry is always for files, even if they happen to also be directories
1071 reason)
1076 reason
1083 ;; We are already where we should be, except when
1084 ;; point is before the subdir line or its total line.
1088 ;; else try to find correct place to insert
1093 ;; found - skip subdir and `total' line
1094 ;; and uninteresting files like . and ..
1095 ;; This better not moves into the next subdir!
1097 ;; not found
1102 ;; Don't expand `.'. Show just the file name within directory.
1108 ;; Put in desired marker char.
1113 ;; Compensate for a bug in ange-ftp.
1114 ;; It inserts the file's absolute name, rather than
1115 ;; the relative one. That may be hard to fix since it
1116 ;; is probably controlled by something in ftp.
1139 ;; return nil if all went well
1140 nil))
1146 ;; Return pos of first file line of DIR, skipping header and total
1147 ;; or wildcard lines.
1148 ;; Important: never moves into the next subdir.
1149 ;; DIR is assumed to be unhidden.
1158 ;;;###autoload
1171 ;;;###autoload
1173 "Create or update the line for FILE in all Dired buffers it would belong in."
1179 ;; Relist the line for FILE, or just add it if it did not exist.
1180 ;; FILE must be an absolute file name.
1182 ;; If cursor is already on FILE's line delete-region will cause
1183 ;; save-excursion to fail because of floating makers,
1184 ;; moving point to beginning of line. Sigh.
1193 \f
1194 ;;; Copy, move/rename, making hard and symbolic links
1197 "Non-nil if Dired should ask about making backups before overwriting files.
1198 Special value `always' suppresses confirmation."
1204 ;; This is a fluid var used in dired-handle-overwrite. It should be
1205 ;; let-bound whenever dired-copy-file etc are called. See
1206 ;; dired-create-files for an example.
1210 ;; Save old version of file TO that is to be overwritten.
1211 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1212 ;; from dired-create-files.
1215 dired-overwrite-confirmed
1219 "Make backup for existing file `%s'? "
1220 to)))
1224 ;;;###autoload
1228 dired-recursive-copies))
1233 preserve-time top recursive)
1235 dirfailed)
1240 ;; This is a directory.
1242 ;; Not a directory.
1246 ;; It is a symlink
1251 dired-create-files-failures)
1254 ;;;###autoload
1258 ;; Silently rename the visited file of any buffer visiting this file.
1263 ;; See if it's an inserted subdir, and rename that, too.
1271 ;; Update visited file name of all affected buffers
1281 to-dir
1282 buffer-file-name)))
1288 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1289 ;; one of its subdirectories is expanded in this buffer.
1297 ;; ELT's subdir is affected by the rename
1300 ;; if top level directory was renamed, lots of things have to be
1301 ;; updated:
1306 ;; with and without wildcards
1308 to))
1311 ;; try to rename buffer, but just leave old name if new
1312 ;; name would already exist (don't try appending "<%d>")
1315 ;; ... we dired TO now:
1319 ;; Update the headerline and dired-subdir-alist element, as well as
1320 ;; dired-switches-alist element, of directory described by
1321 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1322 ;; describes either DIR itself or a subdir of DIR.
1326 buffer-read-only)
1328 ;; Update subdir headerline in buffer
1331 dir)
1336 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1342 \f
1343 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1347 ;; Create a new file for each from a list of existing files. The user
1348 ;; is queried, dired buffers are updated, and at the end a success or
1349 ;; failure message is displayed
1351 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1353 ;; It is called for each file and must create newfile, the entry of
1354 ;; which will be added. The user will be queried if the file already
1355 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1356 ;; rename), it is FILE-CREATOR's responsibility to update dired
1357 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1358 ;; could not create newfile. The error is caught and logged.
1360 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1361 ;; operation performed. It is used for error logging.
1363 ;; FN-LIST is the list of files to copy (full absolute file names).
1365 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1366 ;; skip. If it skips files for other reasons than a direct user
1367 ;; query, it is supposed to tell why (using dired-log).
1369 ;; Optional MARKER-CHAR is a character with which to mark every
1370 ;; newfile's entry, or t to use the current marker character if the
1371 ;; oldfile was marked.
1390 Type SPC or `y' to overwrite file `%s',
1391 DEL or `n' to skip to next,
1392 ESC or `q' to not overwrite any of the remaining files,
1396 ;; must determine if FROM is marked before file-creator
1397 ;; gets a chance to delete it (in case of a move).
1406 ;; If we get here, file-creator hasn't been aborted
1407 ;; and the old entry (if any) has to be deleted
1408 ;; before adding the new entry.
1416 failures)
1418 operation from to err))))))))
1426 total)
1427 failures))
1433 failures))
1439 skipped))
1444 \f
1446 &optional marker-char op1
1447 how-to)
1448 "Create a new file for each marked file.
1449 Prompts user for target, which is a directory in which to create
1450 the new files. Target may also be a plain file if only one marked
1451 file exists. The way the default for the target directory is
1452 computed depends on the value of `dired-dwim-target-directory'.
1453 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1454 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1455 FILE-CREATOR and OPERATION as in `dired-create-files'.
1456 ARG as in `dired-get-marked-files'.
1457 Optional arg MARKER-CHAR as in `dired-create-files'.
1458 Optional arg OP1 is an alternate form for OPERATION if there is
1459 only one file.
1460 Optional arg HOW-TO determiness how to treat the target.
1461 If HOW-TO is nil, use `file-directory-p' to determine if the
1462 target is a directory. If so, the marked file(s) are created
1463 inside that directory. Otherwise, the target is a plain file;
1464 an error is raised unless there is exactly one marked file.
1465 If HOW-TO is t, target is always treated as a plain file.
1466 Otherwise, HOW-TO should be a function of one argument, TARGET.
1467 If its return value is nil, TARGET is regarded as a plain file.
1468 If it return value is a list, TARGET is a generalized
1469 directory (e.g. some sort of archive). The first element of
1470 this list must be a function with at least four arguments:
1471 operation - as OPERATION above.
1472 rfn-list - list of the relative names for the marked files.
1473 fn-list - list of the absolute names for the marked files.
1474 target - the name of the target itself.
1475 The rest of into-dir are optional arguments.
1476 For any other return value, TARGET is treated as a directory."
1485 target-dir)))
1494 target-dir op-symbol arg rfn-list default))))
1496 ;; Allow DOS/Windows users to change the letter
1497 ;; case of a directory. If we don't test these
1498 ;; conditions up front, file-directory-p below
1499 ;; will return t because the filesystem is
1500 ;; case-insensitive, and Emacs will try to move
1501 ;; foo -> foo/foo, which fails.
1504 dired-one-file
1512 nil
1520 ;; rename-file bombs when moving directories unless we do this:
1523 file-creator operation fn-list
1525 ;; This function uses fluid variable target when called
1526 ;; inside dired-create-files:
1531 marker-char))))
1533 ;; Read arguments for a marked-files command that wants a file name,
1534 ;; perhaps popping up the list of marked files.
1535 ;; ARG is the prefix arg and indicates whether the files came from
1536 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1537 ;; If the current file was used, the list has but one element and ARG
1538 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1539 ;; DEFAULT is the default value to return if the user just hits RET;
1540 ;; if it is omitted or nil, then the name of the directory is used.
1545 nil op-symbol files
1550 ;; Try to guess which target directory the user may want.
1551 ;; If there is a dired buffer displayed in one of the next windows,
1552 ;; use its current subdir, else use current subdir of this dired buffer.
1555 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1566 this-dir)))
1569 ;; Return a list of default values for file-reading functions in Dired.
1570 ;; This list may contain directories from Dired buffers in other windows.
1571 ;; `fn-list' is a list of file names used to build a list of defaults.
1572 ;; When nil or more than one element, a list of defaults will
1573 ;; contain only directory names. `target-dir' is a directory name
1574 ;; to exclude from the returned list, for the case when this
1575 ;; directory name is already presented in initial input.
1576 ;; For Dired operations that support `dired-dwim-target',
1577 ;; the argument `target-dir' should have the value returned
1578 ;; from `dired-dwim-target-directory'.
1583 dired-dirs)
1584 ;; Get a list of directories of visible buffers in dired-mode.
1589 ;; Force the current dir to be the first in the list.
1592 ;; Remove the target dir (if specified) or the current dir from
1593 ;; default values, because it should be already in initial input.
1595 ;; Return a list of default values.
1597 ;; For one file operation, provide a list that contains
1598 ;; other directories, other directories with the appended filename
1599 ;; and the current directory with the appended filename, e.g.
1600 ;; 1. /TARGET-DIR/
1601 ;; 2. /TARGET-DIR/FILENAME
1602 ;; 3. /CURRENT-DIR/FILENAME
1611 ;; For multi-file operation, return only a list of other directories.
1612 dired-dirs)))
1614 \f
1615 ;;;###autoload
1617 "Create a directory called DIRECTORY."
1622 ;; Find the topmost nonexistent parent dir (variable `new')
1634 ;; This may not always be what you want, especially if target is your
1635 ;; home directory and it happens to be a symbolic link, as is often the
1636 ;; case with NFS and automounters. Or if you want to make symlinks
1637 ;; into directories that themselves are only symlinks, also quite
1638 ;; common.
1640 ;; So we don't use this function as value for HOW-TO in
1641 ;; dired-do-symlink, which has the minor disadvantage of
1642 ;; making links *into* a symlinked-dir, when you really wanted to
1643 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1644 ;; just have to remove that symlink by hand before making your marked
1645 ;; symlinks.
1648 "Either nil or a function used by `dired-do-copy' to determine target.
1651 ;;;###autoload
1653 "Copy all marked (or next ARG) files, or copy the current file.
1654 This normally preserves the last-modified date when copying.
1655 When operating on just the current file, you specify the new name.
1656 When operating on multiple or marked files, you specify a directory,
1657 and new copies of these files are made in that directory
1658 with the same names that the files currently have. The default
1659 suggested for the target directory depends on the value of
1660 `dired-dwim-target', which see.
1662 This command copies symbolic links by creating new ones,
1663 like `cp -d'."
1667 "Copy"
1668 arg dired-keep-marker-copy
1669 nil dired-copy-how-to-fn)))
1671 ;;;###autoload
1673 "Make symbolic links to current file or all marked (or next ARG) files.
1674 When operating on just the current file, you specify the new name.
1675 When operating on multiple or marked files, you specify a directory
1676 and new symbolic links are made in that directory
1677 with the same names that the files currently have. The default
1678 suggested for the target directory depends on the value of
1679 `dired-dwim-target', which see.
1686 ;;;###autoload
1688 "Add names (hard links) current file or all marked (or next ARG) files.
1689 When operating on just the current file, you specify the new name.
1690 When operating on multiple or marked files, you specify a directory
1691 and new hard links are made in that directory
1692 with the same names that the files currently have. The default
1693 suggested for the target directory depends on the value of
1694 `dired-dwim-target', which see."
1701 ;; error is caught in -create-files
1703 ;; Update the link count
1706 ;;;###autoload
1708 "Rename current file or all marked (or next ARG) files.
1709 When renaming just the current file, you specify the new name.
1710 When renaming multiple or marked files, you specify a directory.
1711 This command also renames any buffers that are visiting the files.
1712 The default suggested for the target directory depends on the value
1713 of `dired-dwim-target', which see."
1717 ;;;###end dired-cp.el
1718 \f
1719 ;;; 5K
1720 ;;;###begin dired-re.el
1723 ;; Create a new file for each marked file using regexps.
1724 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1725 ;; ARG as in dired-get-marked-files.
1726 ;; Matches each marked file against REGEXP and constructs the new
1727 ;; filename from NEWNAME (like in function replace-match).
1728 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1729 ;; instead of only the non-directory part of the file.
1730 ;; Optional arg MARKER-CHAR as in dired-create-files.
1735 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1736 `!' to %s all remaining matches with no more questions."
1740 ;; Function to construct new filename using REGEXP and NEWNAME:
1745 ;; must bind help-form directly around call to
1746 ;; dired-query
1750 operation-prompt
1751 from
1752 to)
1753 to)
1755 operation from regexp)))))
1756 ;; not whole-name, replace non-directory part only
1767 operation-prompt
1770 to)
1773 rename-regexp-query)
1775 file-creator operation fn-list regexp-name-constructor marker-char)))
1778 ;; Prompt user about performing OPERATION.
1779 ;; Read and return list of: regexp newname arg whole-name.
1792 ;;;###autoload
1794 "Rename selected files whose names match REGEXP to NEWNAME.
1796 With non-zero prefix argument ARG, the command operates on the next ARG
1797 files. Otherwise, it operates on all the marked files, or the current
1798 file if none are marked.
1800 As each match is found, the user must type a character saying
1803 REGEXP defaults to the last regexp used.
1805 With a zero prefix arg, renaming by regexp affects the absolute file name.
1806 Normally, only the non-directory part of the file name is used and changed."
1812 ;;;###autoload
1814 "Copy selected files whose names match REGEXP to NEWNAME.
1815 See function `dired-do-rename-regexp' for more info."
1821 arg regexp newname whole-name dired-keep-marker-copy)))
1823 ;;;###autoload
1825 "Hardlink selected files whose names match REGEXP to NEWNAME.
1826 See function `dired-do-rename-regexp' for more info."
1832 ;;;###autoload
1834 "Symlink selected files whose names match REGEXP to NEWNAME.
1835 See function `dired-do-rename-regexp' for more info."
1843 ;; Perform FILE-CREATOR on the non-directory part of marked files
1844 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1845 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1848 file-creator
1849 operation
1857 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1858 `!' to %s all remaining matches with no more questions."
1865 to))))
1866 dired-keep-marker-rename)))
1871 basename-constructor operation arg))
1873 ;;;###autoload
1875 "Rename all marked (or next ARG) files to upper case."
1879 ;;;###autoload
1881 "Rename all marked (or next ARG) files to lower case."
1885 ;;;###end dired-re.el
1886 \f
1887 ;;; 13K
1888 ;;;###begin dired-ins.el
1890 ;;;###autoload
1892 switches no-error-if-not-dir-p)
1893 "Insert this subdirectory into the same dired buffer.
1895 else inserts it at its natural place (as `ls -lR' would have done).
1896 With a prefix arg, you may edit the ls switches used for this listing.
1897 You can add `R' to the switches to expand the whole tree starting at
1898 this subdirectory.
1899 This function takes some pains to conform to `ls -lR' output.
1901 Dired remembers switches specified with a prefix arg, so that reverting
1902 the buffer will not reset them. However, using `dired-undo' to re-insert
1903 or delete subdirectories can bypass this machinery. Hence, you sometimes
1904 may have to reset some subdirectory switches after a `dired-undo'.
1905 You can reset all subdirectory switches to the default using
1907 See Info node `(emacs)Subdir switches' for more details."
1914 ;; We don't need a marker for opoint as the subdir is always
1915 ;; inserted *after* opoint.
1920 ;; Push mark so that it's easy to find back. Do this after the
1921 ;; insert message so that the user sees the `Mark set' message.
1924 ;;;###autoload
1926 "Insert this subdirectory into the same dired buffer.
1927 If it is already present, overwrites previous entry,
1928 else inserts it at its natural place (as `ls -lR' would have done).
1929 With a prefix arg, you may edit the `ls' switches used for this listing.
1930 You can add `R' to the switches to expand the whole tree starting at
1931 this subdirectory.
1932 This function takes some pains to conform to `ls -lR' output."
1933 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1934 ;; Prospero where dired-ls does the right thing, but
1935 ;; file-directory-p has not been redefined.
1949 switches-have-R mark-alist case-fold-search buffer-read-only)
1952 ;; case-fold-search is nil now, so we can test for capital `R':
1954 ;; avoid duplicated subdirs
1957 ;; If subdir is already present, remove it and remember its marks
1981 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1982 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1995 ;; all switches that make a difference to dired-get-filename:
1999 ;; Add new DIR at NEW-MARKER. Sort alist.
2004 ;; Keep the alist sorted on buffer position.
2012 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2013 Interactively, you can kill DIRNAME as well by using a prefix argument.
2014 In interactive use, the command prompts for DIRNAME.
2016 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2017 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2028 m-alist))
2031 ;; Find pos for new subdir, according to tree order.
2032 ;;(goto-char (point-max))
2040 ;; Insert NEW-DIR after DIR
2042 alist nil)))
2044 ;; want a separating newline between subdirs
2051 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2052 ;; Move to that buffer position. Return a mark-alist.
2055 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2064 ;; Insert ls output after point.
2065 ;; Return the boundary of the inserted text (as list of BEG and END).
2070 dired-subdir-switches
2073 ;; If doing the top level directory of the buffer,
2074 ;; redo it as specified in dired-directory.
2080 ;; Point is at the correct subdir alist position for ELT,
2081 ;; BEG-END is the subdir-region (as list of begin and end).
2083 ;; update its position (should actually be unchanged)
2086 ;; The hook may depend on the subdir-alist containing the just
2087 ;; inserted subdir, so run it after dired-alist-add:
2095 ;; hook may add or delete lines, but the subdir boundary
2096 ;; marker floats
2100 ;; Lexicographic order on file name components, like `ls -lR':
2101 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2102 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2103 ;; or DIR1 and DIR2 are in the same parentdir and their last
2104 ;; components are string-lessp.
2105 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2106 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2107 ;; if dired-actual-switches contained `t'.
2113 components-2
2125 t)
2127 nil)
2130 ;; There should be a builtin split function - inverse to mapconcat.
2132 "Splitting on regexp PAT, turn string STR into a list of substrings.
2133 Optional third arg LIMIT (>= 1) is a limit to the length of the
2134 resulting list.
2135 Thus, if SEP is a regexp that only matches itself,
2137 (mapconcat 'identity (dired-split SEP STRING) SEP)
2139 is always equal to STRING."
2152 start end)
2153 ))
2160 \f
2161 ;;; moving by subdirectories
2163 ;;;###autoload
2165 "Go to previous subdirectory, regardless of level.
2166 When called interactively and not on a subdir line, go to this subdir's line."
2167 ;;(interactive "p")
2171 ;; if on subdir start already, don't stay there!
2181 ;;;###autoload
2183 "Go to end of header line of DIR in this dired buffer.
2184 Return value of point on success, otherwise return nil.
2190 dired-subdir-alist ; table
2191 nil ; predicate
2192 t ; require-match
2199 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2200 ;; at either \r or \n after this function succeeds.
2203 \f
2204 ;;;###autoload
2206 "Mark all files except `.' and `..' in current subdirectory.
2207 If the Dired buffer shows multiple directories, this command
2208 marks the files listed in the subdirectory that point is in."
2213 ;;;###autoload
2215 "Remove all lines of current subdirectory.
2216 Lower levels are unaffected."
2217 ;; With optional REMEMBER-MARKS, return a mark-alist.
2224 buffer-read-only)
2238 ;; Remove DIR from the alist
2242 ;;;###autoload
2244 "Go up ARG levels in the dired tree."
2250 ;;(setq dir (expand-file-name dir))
2254 ;;;###autoload
2256 "Go down in the dired tree."
2270 \f
2271 ;;; hiding
2287 ;;;###autoload
2289 "Hide or unhide the current subdirectory and move to next directory.
2290 Optional prefix arg is a repeat factor.
2300 buffer-read-only)
2301 ;; keep header line visible, hide rest
2310 ;;;###autoload
2312 "Hide all subdirectories, leaving only their header lines.
2313 If there is already something hidden, make everything visible again.
2318 buffer-read-only)
2322 ;; unhide - bombs on \r in filenames
2324 ;; hide
2331 ;; we're somewhere on current dir's line
2339 ;;;###end dired-ins.el
2341 \f
2342 ;; Search only in file names in the Dired buffer.
2345 "Non-nil to Isearch in file names only.
2346 If t, Isearch in Dired always matches only file names.
2347 If `dwim', Isearch matches file names when initial point position is on
2348 a file name. Otherwise, it searches the whole buffer without restrictions."
2358 "Toggle file names searching on or off.
2359 When on, Isearch skips matches outside file names using the predicate
2360 `dired-isearch-filter-filenames' that matches only at file names.
2361 When off, it uses the original predicate."
2365 dired-isearch-filter-predicate-orig
2370 ;;;###autoload
2372 "Set up isearch to search in Dired file names.
2373 Intended to be added to `isearch-mode-hook'."
2385 "Clean up the Dired file name search after terminating isearch."
2392 "Test whether the current search hit is a visible file name.
2393 Return non-nil if the text from BEG to END is part of a file
2394 name (has the text property `dired-filename') and is visible."
2399 t)))
2401 ;;;###autoload
2403 "Search for a string using Isearch only in file names in the Dired buffer."
2408 ;;;###autoload
2410 "Search for a regexp using Isearch only in file names in the Dired buffer."
2415 \f
2416 ;; Functions for searching in tags style among marked files.
2418 ;;;###autoload
2420 "Search for a string through all marked files using Isearch."
2425 ;;;###autoload
2427 "Search for a regexp through all marked files using Isearch."
2432 ;;;###autoload
2434 "Search through all marked files for a match for REGEXP.
2435 Stops when a match is found.
2440 ;;;###autoload
2442 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2443 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2454 buffer-read-only))
2461 \f
2462 ;;;###autoload
2464 "Print the type of FILE, according to the `file' command.
2465 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2466 true then the type of the file linked to by FILE is printed instead."
2479 ;; Local Variables:
2480 ;; byte-compile-dynamic: t
2481 ;; generated-autoload-file: "dired.el"
2482 ;; End:
2484 ;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2485 ;;; dired-aux.el ends here