| blob | 4976d2cd68391f690c32c2d893ab870c181d92e1 |
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 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'."
69 ;; Additional file with the mark.
81 diff-switches
85 ;;;###autoload
87 "Diff this file with its backup file or vice versa.
88 Uses the latest backup, if there are several numerical backups.
89 If this file is a backup, diff it with its original.
90 The backup file is the first file given to `diff'.
91 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
96 diff-switches
98 nil))
101 ;;;###autoload
103 "Mark files with different file attributes in two dired buffers.
104 Compare file attributes of files in the current directory
105 with file attributes in directory DIR2 using PREDICATE on pairs of files
106 with the same name. Mark files for which PREDICATE returns non-nil.
107 Mark files with different names if PREDICATE is nil (or interactively
108 with empty input at the predicate prompt).
110 PREDICATE is a Lisp expression that can refer to the following variables:
112 size1, size2 - file size in bytes
113 mtime1, mtime2 - last modification time in seconds, as a float
114 fa1, fa2 - list of file attributes
115 returned by function `file-attributes'
117 where 1 refers to attribute of file in the current dired buffer
118 and 2 to attribute of file in second dired buffer.
120 Examples of PREDICATE:
122 (> mtime1 mtime2) - mark newer files
123 (not (= size1 size2)) - mark files with different sizes
124 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
125 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
126 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
137 target-dir target-dir t)))
142 file-list1 file-list2)
148 'cadr
150 file-alist1 file-alist2
151 predicate))
153 'cadr
155 file-alist2 file-alist1
156 predicate)))
158 dir1 nil
163 dir2 nil
172 "Combine LIST1 and LIST2 using a set-difference operation.
173 The result list contains all file items that appear in LIST1 but not LIST2.
174 This is a non-destructive function; it makes a copy of the data if necessary
175 to avoid corrupting the original LIST1 and LIST2.
176 PREDICATE (see `dired-compare-directories') is an additional match
177 condition. Two file items are considered to match if they are equal
178 *and* PREDICATE evaluates to t."
180 list1
196 list)
201 "Return a list of all file names and attributes from DIR.
202 List has a form of (file-name full-file-name (attribute-list))."
207 full-file-name
210 \f
213 "Create initial input value for `touch' command."
224 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
225 ;; refresh their file lines.
226 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
227 ;; PROGRAM is the program used to change the attribute.
228 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
229 ;; ARG describes which files to use, as in dired-get-marked-files.
235 op-symbol arg files))
237 failures)
248 files))
253 nil))))
255 ;;;###autoload
257 "Change the mode of the marked (or next ARG) files.
258 Symbolic modes like `g+w' are allowed."
273 "Change mode of %s to: " nil
279 file
284 ;;;###autoload
286 "Change the group of the marked (or next ARG) files."
292 ;;;###autoload
294 "Change the owner of the marked (or next ARG) files."
300 ;;;###autoload
302 "Change the timestamp of the marked (or next ARG) files.
303 This calls touch."
307 ;; Process all the files in FILES in batches of a convenient size,
308 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
309 ;; Batches are chosen to need less than MAX chars for the file names,
310 ;; allowing 3 extra characters of separator per file name.
313 past
315 failures)
316 ;; Accumulate files as long as they fit in MAX chars,
317 ;; then process the ones accumulated so far.
322 ;; If we have at least 1 pending file
323 ;; and this file won't fit in the length limit, process now.
326 ;; The elements of PENDING are now in forward order.
327 ;; Do the operation and record failures.
329 failures)
330 ;; Transfer the elemens of PENDING onto PAST
331 ;; and clear it out. Now PAST contains the first N files
332 ;; specified (for some N), and FILES contains the rest.
334 pending nil
336 ;; Do (setq pending (cons thisfile pending))
337 ;; but reuse the cons that was in `files'.
345 failures)
346 ;; Now the original list FILES has been put back as it was.
349 ;;;###autoload
351 "Print the marked (or next ARG) files.
352 Uses the shell command coming from variables `lpr-command' and
353 `lpr-switches' as default."
357 "Print %s with: "
362 lpr-switches))
367 ;; Read arguments for a marked-files command that wants a string
368 ;; that is not a file name,
369 ;; perhaps popping up the list of marked files.
370 ;; ARG is the prefix arg and indicates whether the files came from
371 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
372 ;; If the current file was used, the list has but one element and ARG
373 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
376 ;; PROMPT for a string, with INITIAL input and DEFAULT value.
377 ;; Other args are used to give user feedback and pop-up:
378 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
380 nil op-symbol files
383 \f
384 ;;; Cleaning a directory: flagging some backups for deletion.
388 ;;;###autoload
390 "Flag numerical backups for deletion.
391 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
392 Positive prefix arg KEEP overrides `dired-kept-versions';
393 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
396 with a prefix argument."
403 late-retention early-retention)
404 ;; Look at each file.
405 ;; If the file has numeric backup versions,
406 ;; put on dired-file-version-alist an element of the form
407 ;; (FILENAME . VERSION-NUMBER-LIST)
409 ;; Sort each VERSION-NUMBER-LIST,
410 ;; and remove the versions not to be deleted.
418 sorted-v-list)))
422 ;; Look at each file. If it is a numeric backup file,
423 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
427 ;;; Subroutines of dired-clean-directory.
430 ;; Perform FUN with point at the end of each non-directory line.
431 ;; FUN takes one argument, the absolute filename.
446 ;; Only do work if this file is not already in the alist.
448 nil
449 ;; If it looks like file FN has versions, return a list of the versions.
450 ;;That is a list of strings which are file names.
451 ;;The caller may want to flag some of these files for deletion.
456 base-versions
462 dired-file-version-alist)))))))
466 base-version-list)
476 \f
477 ;;; Shell commands
482 "Return a list of all commands associated with current dired files.
483 This function is used to add all related commands retrieved by `mailcap'
484 to the end of the list of defaults just after the default value."
492 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
494 "Read a dired shell command prompting with PROMPT (using `read-shell-command').
495 ARG is the prefix arg and may be used to indicate in the prompt which
496 FILES are affected."
502 nil 'shell files
503 #'read-shell-command
505 nil nil)))
507 ;;;###autoload
509 "Run a shell command COMMAND on the marked files asynchronously.
511 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
512 adds `* &' surrounded by whitespace and executes the command asynchronously.
513 The output appears in the buffer `*Async Shell Command*'."
517 ;; Want to give feedback whether this file or marked files are used:
519 current-prefix-arg
520 files)))
527 ;; The in-background argument is only needed in Emacs 18 where
528 ;; shell-command doesn't understand an appended ampersand `&'.
529 ;;;###autoload
531 "Run a shell command COMMAND on the marked files.
532 If no files are marked or a specific numeric prefix arg is given,
534 The prompt mentions the file(s) or the marker, as appropriate.
536 If there is a `*' in COMMAND, surrounded by whitespace, this runs
537 COMMAND just once with the entire file list substituted there.
539 If there is no `*', but there is a `?' in COMMAND, surrounded by
540 whitespace, this runs COMMAND on each file individually with the
541 file name substituted for `?'.
543 Otherwise, this runs COMMAND on each file individually with the
544 file name added at the end of COMMAND (separated by a space).
546 `*' and `?' when not surrounded by whitespace have no special
547 significance for `dired-do-shell-command', and are passed through
548 normally to the shell, but you must confirm first. To pass `*' by
551 If COMMAND produces output, it goes to a separate buffer.
553 This feature does not try to redisplay Dired buffers afterward, as
554 there's no telling what files COMMAND may have changed.
557 When COMMAND runs, its working directory is the top-level directory
558 of the Dired buffer, so output files usually are created there
559 instead of in a subdir.
561 In a noninteractive call (from Lisp code), you must specify
562 the list of file names explicitly with the FILE-LIST argument, which
563 can be produced by `dired-get-marked-files', for example."
564 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
565 ;;actual work and can be redefined for customization.
569 ;; Want to give feedback whether this file or marked files are used:
572 current-prefix-arg
573 files)
574 current-prefix-arg
575 files)))
580 ;; Get confirmation for wildcards that may have been meant
581 ;; to control substitution of a file name or the file name list.
595 nil
596 file-list)
597 ;; execute the shell command
601 ;; Might use {,} for bash or csh:
610 ;; "Make up a shell command line from COMMAND and FILE-LIST.
611 ;; If ON-EACH is t, COMMAND should be applied to each file, else
612 ;; simply concat all files and apply COMMAND to this.
613 ;; FILE-LIST's elements will be quoted for the shell."
614 ;; Might be redefined for smarter things and could then use RAW-ARG
615 ;; (coming from interactive P and currently ignored) to decide what to do.
616 ;; Smart would be a way to access basename or extension of file names.
625 retval))
630 file-list dired-mark-separator)))
635 ;; This is an extra function so that it can be redefined by ange-ftp.
636 ;;;###autoload
643 ;; Return nil for sake of nconc in dired-bunch-files.
644 nil)
645 \f
648 ; "Display MSG while running PROGRAM, and check for output.
649 ;Remaining arguments are strings passed as command arguments to PROGRAM.
650 ; On error, insert output
651 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
652 ; Caller can cons up a list of failed args.
653 ;Else returns nil for success."
657 ;; Get a clean buffer for error output:
670 nil))))
671 \f
672 ;; Commands that delete or redisplay part of the dired buffer.
693 ;;;###autoload
695 "Kill all marked lines (not the files).
696 With a prefix argument, kill that many lines starting with the current line.
697 \(A negative argument kills backward.)
698 If you use this command with a prefix argument to kill the line
699 for a file that is a directory, which you have inserted in the
700 Dired buffer as a subdirectory, then it deletes that subdirectory
701 from the buffer as well.
702 To kill an entire subdirectory \(without killing its line in the
703 parent directory), go to its directory header line and use this
704 command with a prefix argument (the value does not matter)."
705 ;; Returns count of killed lines. FMT="" suppresses message.
723 count))))
725 ;;;###end dired-cmd.el
726 \f
727 ;;; 30K
728 ;;;###begin dired-cp.el
731 ;; Compress or uncompress the current file.
732 ;; Return nil for success, offending filename else.
738 ;; Remove any preexisting entry for the name NEW-FILE.
743 ;; Now replace the current line with an entry for NEW-FILE.
746 from-file)))
752 ;; For .z, try gunzip. It might be an old gzip file,
753 ;; or it might be from compact? pack? (which?) but gunzip handles both.
759 ;; This item controls naming for compression.
761 "Control changes in file name suffixes for compression and uncompression.
762 Each element specifies one transformation rule, and has the form:
763 (REGEXP NEW-SUFFIX PROGRAM)
764 The rule applies when the old file name matches REGEXP.
765 The new file name is computed by deleting the part that matches REGEXP
766 (as well as anything after that), then adding NEW-SUFFIX in its place.
767 If PROGRAM is non-nil, the rule is an uncompression rule,
768 and uncompression is done by running PROGRAM.
771 ;;;###autoload
773 ;; Compress or uncompress FILE.
774 ;; Return the name of the compressed or uncompressed file.
775 ;; Return nil if no change in files.
777 suffix newname
779 ;; See if any suffix rule matches this file name.
785 ;; If so, compute desired new name.
792 nil)
794 ;; We found an uncompression rule.
797 newname))
799 ;;; We don't recognize the file as compressed, so compress it.
800 ;;; Try gzip; if we don't have that, use compress.
806 out-name)))
811 ;; Rename the compressed file to NEWNAME
812 ;; if it hasn't got that name already.
816 newname)
817 out-name)))
821 ;; Don't use NEWNAME with `compress'.
823 \f
825 ;; Request confirmation from the user that the operation described
826 ;; by OP-SYMBOL is to be performed on the marked files.
827 ;; Confirmation consists in a y-or-n question with a file list
828 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
829 ;; The files used are determined by ARG (as in dired-get-marked-files).
832 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
833 ;; is marked pops up a window. That will help the user see
834 ;; it isn't the current line file.
843 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
844 ; and display failures.
846 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
847 ; the short form of the filename) for a failure and probably logs a
848 ; detailed error explanation using function `dired-log'.
850 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
851 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
852 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
853 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
855 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
867 ;; end this bunch of errors:
871 failures)))))
878 ;; None of these keys quit - use C-g for that.
879 ))
881 ;;;###autoload
883 "Query user and return nil or t.
884 Store answer in symbol VAR (which must initially be bound to nil).
885 Format PROMPT with ARGS.
886 Binding variable `help-form' will help the user who types the help key."
902 done result elt)
908 ;; read-event returns -1 if we are in a kbd
909 ;; macro and there are no more events in the
910 ;; macro. Attempt to get an event
911 ;; interactively.
917 dired-query-alist)))))))
918 ;; Display the question with the answer.
922 \f
923 ;;;###autoload
925 "Compress or uncompress marked (or next ARG) files."
929 ;; Commands for Emacs Lisp files - load and byte compile
932 ;; Return nil for success, offending file name else.
934 elc-file buffer-read-only failure)
949 nil)))
951 ;;;###autoload
953 "Byte compile marked (or next ARG) Emacs Lisp files."
958 ;; Return nil for success, offending file name else.
964 nil
968 ;;;###autoload
970 "Load the marked (or next ARG) Emacs Lisp files."
974 ;;;###autoload
976 "Redisplay all marked (or next ARG) files.
977 If on a subdir line, redisplay that subdirectory. In that case,
978 a prefix arg lets you edit the `ls' switches used for the new listing.
980 Dired remembers switches specified with a prefix arg, so that reverting
981 the buffer will not reset them. However, using `dired-undo' to re-insert
982 or delete subdirectories can bypass this machinery. Hence, you sometimes
983 may have to reset some subdirectory switches after a `dired-undo'.
984 You can reset all subdirectory switches to the default using
986 See Info node `(emacs)Subdir switches' for more details."
987 ;; Moves point if the next ARG files are redisplayed.
993 dir
997 dired-subdir-switches
998 dired-actual-switches)))))
1000 ;; message much faster than making dired-map-over-marks show progress
1006 arg)
1011 "Set `dired-switches-alist' to nil and revert dired buffer."
1015 \f
1017 ;; Delete the current line, and insert an entry for FILE.
1018 ;; If FILE is nil, then just delete the current line.
1019 ;; Keeps any marks that may be present in column one (doing this
1020 ;; here is faster than with dired-add-entry's optional arg).
1021 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1029 ;; Replace space by old marker without moving point.
1030 ;; Faster than goto+insdel inside a save-excursion?
1034 ;;;###autoload
1041 ;; Add a new entry for FILENAME, optionally marking it
1042 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
1043 ;; Note that this adds the entry `out of order' if files sorted by
1044 ;; time, etc.
1045 ;; At least this version inserts in the right subdirectory (if present).
1046 ;; And it skips "." or ".." (see `dired-trivial-filenames').
1047 ;; Hidden subdirs are exposed if a file is added there.
1049 ;; Entry is always for files, even if they happen to also be directories
1054 reason)
1059 reason
1066 ;; We are already where we should be, except when
1067 ;; point is before the subdir line or its total line.
1071 ;; else try to find correct place to insert
1076 ;; found - skip subdir and `total' line
1077 ;; and uninteresting files like . and ..
1078 ;; This better not moves into the next subdir!
1080 ;; not found
1085 ;; Don't expand `.'. Show just the file name within directory.
1091 ;; Put in desired marker char.
1096 ;; Compensate for a bug in ange-ftp.
1097 ;; It inserts the file's absolute name, rather than
1098 ;; the relative one. That may be hard to fix since it
1099 ;; is probably controlled by something in ftp.
1122 ;; return nil if all went well
1123 nil))
1129 ;; Return pos of first file line of DIR, skipping header and total
1130 ;; or wildcard lines.
1131 ;; Important: never moves into the next subdir.
1132 ;; DIR is assumed to be unhidden.
1141 ;;;###autoload
1154 ;;;###autoload
1156 "Create or update the line for FILE in all Dired buffers it would belong in."
1162 ;; Relist the line for FILE, or just add it if it did not exist.
1163 ;; FILE must be an absolute file name.
1165 ;; If cursor is already on FILE's line delete-region will cause
1166 ;; save-excursion to fail because of floating makers,
1167 ;; moving point to beginning of line. Sigh.
1176 \f
1177 ;;; Copy, move/rename, making hard and symbolic links
1180 "Non-nil if Dired should ask about making backups before overwriting files.
1181 Special value `always' suppresses confirmation."
1187 ;; This is a fluid var used in dired-handle-overwrite. It should be
1188 ;; let-bound whenever dired-copy-file etc are called. See
1189 ;; dired-create-files for an example.
1193 ;; Save old version of file TO that is to be overwritten.
1194 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1195 ;; from dired-create-files.
1198 dired-overwrite-confirmed
1202 "Make backup for existing file `%s'? "
1203 to)))
1207 ;;;###autoload
1211 dired-recursive-copies))
1216 preserve-time top recursive)
1218 dirfailed)
1223 ;; This is a directory.
1225 ;; Not a directory.
1229 ;; It is a symlink
1234 dired-create-files-failures)
1237 ;;;###autoload
1241 ;; Silently rename the visited file of any buffer visiting this file.
1246 ;; See if it's an inserted subdir, and rename that, too.
1254 ;; Update visited file name of all affected buffers
1264 to-dir
1265 buffer-file-name)))
1271 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1272 ;; one of its subdirectories is expanded in this buffer.
1280 ;; ELT's subdir is affected by the rename
1283 ;; if top level directory was renamed, lots of things have to be
1284 ;; updated:
1289 ;; with and without wildcards
1291 to))
1294 ;; try to rename buffer, but just leave old name if new
1295 ;; name would already exist (don't try appending "<%d>")
1298 ;; ... we dired TO now:
1302 ;; Update the headerline and dired-subdir-alist element, as well as
1303 ;; dired-switches-alist element, of directory described by
1304 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1305 ;; describes either DIR itself or a subdir of DIR.
1309 buffer-read-only)
1311 ;; Update subdir headerline in buffer
1314 dir)
1319 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1325 \f
1326 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1330 ;; Create a new file for each from a list of existing files. The user
1331 ;; is queried, dired buffers are updated, and at the end a success or
1332 ;; failure message is displayed
1334 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1336 ;; It is called for each file and must create newfile, the entry of
1337 ;; which will be added. The user will be queried if the file already
1338 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1339 ;; rename), it is FILE-CREATOR's responsibility to update dired
1340 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1341 ;; could not create newfile. The error is caught and logged.
1343 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1344 ;; operation performed. It is used for error logging.
1346 ;; FN-LIST is the list of files to copy (full absolute file names).
1348 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1349 ;; skip. If it skips files for other reasons than a direct user
1350 ;; query, it is supposed to tell why (using dired-log).
1352 ;; Optional MARKER-CHAR is a character with which to mark every
1353 ;; newfile's entry, or t to use the current marker character if the
1354 ;; oldfile was marked.
1373 Type SPC or `y' to overwrite file `%s',
1374 DEL or `n' to skip to next,
1375 ESC or `q' to not overwrite any of the remaining files,
1379 ;; must determine if FROM is marked before file-creator
1380 ;; gets a chance to delete it (in case of a move).
1389 ;; If we get here, file-creator hasn't been aborted
1390 ;; and the old entry (if any) has to be deleted
1391 ;; before adding the new entry.
1399 failures)
1401 operation from to err))))))))
1409 total)
1410 failures))
1416 failures))
1422 skipped))
1427 \f
1429 &optional marker-char op1
1430 how-to)
1431 "Create a new file for each marked file.
1432 Prompts user for target, which is a directory in which to create
1433 the new files. Target may also be a plain file if only one marked
1434 file exists. The way the default for the target directory is
1435 computed depends on the value of `dired-dwim-target-directory'.
1436 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1437 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1438 FILE-CREATOR and OPERATION as in `dired-create-files'.
1439 ARG as in `dired-get-marked-files'.
1440 Optional arg MARKER-CHAR as in `dired-create-files'.
1441 Optional arg OP1 is an alternate form for OPERATION if there is
1442 only one file.
1443 Optional arg HOW-TO determiness how to treat the target.
1444 If HOW-TO is nil, use `file-directory-p' to determine if the
1445 target is a directory. If so, the marked file(s) are created
1446 inside that directory. Otherwise, the target is a plain file;
1447 an error is raised unless there is exactly one marked file.
1448 If HOW-TO is t, target is always treated as a plain file.
1449 Otherwise, HOW-TO should be a function of one argument, TARGET.
1450 If its return value is nil, TARGET is regarded as a plain file.
1451 If it return value is a list, TARGET is a generalized
1452 directory (e.g. some sort of archive). The first element of
1453 this list must be a function with at least four arguments:
1454 operation - as OPERATION above.
1455 rfn-list - list of the relative names for the marked files.
1456 fn-list - list of the absolute names for the marked files.
1457 target - the name of the target itself.
1458 The rest of into-dir are optional arguments.
1459 For any other return value, TARGET is treated as a directory."
1468 target-dir)))
1477 target-dir op-symbol arg rfn-list default))))
1479 ;; Allow DOS/Windows users to change the letter
1480 ;; case of a directory. If we don't test these
1481 ;; conditions up front, file-directory-p below
1482 ;; will return t because the filesystem is
1483 ;; case-insensitive, and Emacs will try to move
1484 ;; foo -> foo/foo, which fails.
1487 dired-one-file
1495 nil
1503 ;; rename-file bombs when moving directories unless we do this:
1506 file-creator operation fn-list
1508 ;; This function uses fluid variable target when called
1509 ;; inside dired-create-files:
1514 marker-char))))
1516 ;; Read arguments for a marked-files command that wants a file name,
1517 ;; perhaps popping up the list of marked files.
1518 ;; ARG is the prefix arg and indicates whether the files came from
1519 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1520 ;; If the current file was used, the list has but one element and ARG
1521 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1522 ;; DEFAULT is the default value to return if the user just hits RET;
1523 ;; if it is omitted or nil, then the name of the directory is used.
1528 nil op-symbol files
1533 ;; Try to guess which target directory the user may want.
1534 ;; If there is a dired buffer displayed in one of the next windows,
1535 ;; use its current subdir, else use current subdir of this dired buffer.
1538 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1549 this-dir)))
1552 ;; Return a list of default values for file-reading functions in Dired.
1553 ;; This list may contain directories from Dired buffers in other windows.
1554 ;; `fn-list' is a list of file names used to build a list of defaults.
1555 ;; When nil or more than one element, a list of defaults will
1556 ;; contain only directory names. `target-dir' is a directory name
1557 ;; to exclude from the returned list, for the case when this
1558 ;; directory name is already presented in initial input.
1559 ;; For Dired operations that support `dired-dwim-target',
1560 ;; the argument `target-dir' should have the value returned
1561 ;; from `dired-dwim-target-directory'.
1566 dired-dirs)
1567 ;; Get a list of directories of visible buffers in dired-mode.
1572 ;; Force the current dir to be the first in the list.
1575 ;; Remove the target dir (if specified) or the current dir from
1576 ;; default values, because it should be already in initial input.
1578 ;; Return a list of default values.
1580 ;; For one file operation, provide a list that contains
1581 ;; other directories, other directories with the appended filename
1582 ;; and the current directory with the appended filename, e.g.
1583 ;; 1. /TARGET-DIR/
1584 ;; 2. /TARGET-DIR/FILENAME
1585 ;; 3. /CURRENT-DIR/FILENAME
1594 ;; For multi-file operation, return only a list of other directories.
1595 dired-dirs)))
1597 \f
1598 ;;;###autoload
1600 "Create a directory called DIRECTORY."
1605 ;; Find the topmost nonexistent parent dir (variable `new')
1617 ;; This may not always be what you want, especially if target is your
1618 ;; home directory and it happens to be a symbolic link, as is often the
1619 ;; case with NFS and automounters. Or if you want to make symlinks
1620 ;; into directories that themselves are only symlinks, also quite
1621 ;; common.
1623 ;; So we don't use this function as value for HOW-TO in
1624 ;; dired-do-symlink, which has the minor disadvantage of
1625 ;; making links *into* a symlinked-dir, when you really wanted to
1626 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1627 ;; just have to remove that symlink by hand before making your marked
1628 ;; symlinks.
1631 "Either nil or a function used by `dired-do-copy' to determine target.
1634 ;;;###autoload
1636 "Copy all marked (or next ARG) files, or copy the current file.
1637 This normally preserves the last-modified date when copying.
1638 When operating on just the current file, you specify the new name.
1639 When operating on multiple or marked files, you specify a directory,
1640 and new copies of these files are made in that directory
1641 with the same names that the files currently have. The default
1642 suggested for the target directory depends on the value of
1643 `dired-dwim-target', which see.
1645 This command copies symbolic links by creating new ones,
1646 like `cp -d'."
1650 "Copy"
1651 arg dired-keep-marker-copy
1652 nil dired-copy-how-to-fn)))
1654 ;;;###autoload
1656 "Make symbolic links to current file or all marked (or next ARG) files.
1657 When operating on just the current file, you specify the new name.
1658 When operating on multiple or marked files, you specify a directory
1659 and new symbolic links are made in that directory
1660 with the same names that the files currently have. The default
1661 suggested for the target directory depends on the value of
1662 `dired-dwim-target', which see.
1669 ;;;###autoload
1671 "Add names (hard links) current file or all marked (or next ARG) files.
1672 When operating on just the current file, you specify the new name.
1673 When operating on multiple or marked files, you specify a directory
1674 and new hard links are made in that directory
1675 with the same names that the files currently have. The default
1676 suggested for the target directory depends on the value of
1677 `dired-dwim-target', which see."
1684 ;; error is caught in -create-files
1686 ;; Update the link count
1689 ;;;###autoload
1691 "Rename current file or all marked (or next ARG) files.
1692 When renaming just the current file, you specify the new name.
1693 When renaming multiple or marked files, you specify a directory.
1694 This command also renames any buffers that are visiting the files.
1695 The default suggested for the target directory depends on the value
1696 of `dired-dwim-target', which see."
1700 ;;;###end dired-cp.el
1701 \f
1702 ;;; 5K
1703 ;;;###begin dired-re.el
1706 ;; Create a new file for each marked file using regexps.
1707 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1708 ;; ARG as in dired-get-marked-files.
1709 ;; Matches each marked file against REGEXP and constructs the new
1710 ;; filename from NEWNAME (like in function replace-match).
1711 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1712 ;; instead of only the non-directory part of the file.
1713 ;; Optional arg MARKER-CHAR as in dired-create-files.
1718 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1719 `!' to %s all remaining matches with no more questions."
1723 ;; Function to construct new filename using REGEXP and NEWNAME:
1728 ;; must bind help-form directly around call to
1729 ;; dired-query
1733 operation-prompt
1734 from
1735 to)
1736 to)
1738 operation from regexp)))))
1739 ;; not whole-name, replace non-directory part only
1750 operation-prompt
1753 to)
1756 rename-regexp-query)
1758 file-creator operation fn-list regexp-name-constructor marker-char)))
1761 ;; Prompt user about performing OPERATION.
1762 ;; Read and return list of: regexp newname arg whole-name.
1775 ;;;###autoload
1777 "Rename selected files whose names match REGEXP to NEWNAME.
1779 With non-zero prefix argument ARG, the command operates on the next ARG
1780 files. Otherwise, it operates on all the marked files, or the current
1781 file if none are marked.
1783 As each match is found, the user must type a character saying
1786 REGEXP defaults to the last regexp used.
1788 With a zero prefix arg, renaming by regexp affects the absolute file name.
1789 Normally, only the non-directory part of the file name is used and changed."
1795 ;;;###autoload
1797 "Copy selected files whose names match REGEXP to NEWNAME.
1798 See function `dired-do-rename-regexp' for more info."
1804 arg regexp newname whole-name dired-keep-marker-copy)))
1806 ;;;###autoload
1808 "Hardlink selected files whose names match REGEXP to NEWNAME.
1809 See function `dired-do-rename-regexp' for more info."
1815 ;;;###autoload
1817 "Symlink selected files whose names match REGEXP to NEWNAME.
1818 See function `dired-do-rename-regexp' for more info."
1826 ;; Perform FILE-CREATOR on the non-directory part of marked files
1827 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1828 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1831 file-creator
1832 operation
1840 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1841 `!' to %s all remaining matches with no more questions."
1848 to))))
1849 dired-keep-marker-rename)))
1854 basename-constructor operation arg))
1856 ;;;###autoload
1858 "Rename all marked (or next ARG) files to upper case."
1862 ;;;###autoload
1864 "Rename all marked (or next ARG) files to lower case."
1868 ;;;###end dired-re.el
1869 \f
1870 ;;; 13K
1871 ;;;###begin dired-ins.el
1873 ;;;###autoload
1875 switches no-error-if-not-dir-p)
1876 "Insert this subdirectory into the same dired buffer.
1878 else inserts it at its natural place (as `ls -lR' would have done).
1879 With a prefix arg, you may edit the ls switches used for this listing.
1880 You can add `R' to the switches to expand the whole tree starting at
1881 this subdirectory.
1882 This function takes some pains to conform to `ls -lR' output.
1884 Dired remembers switches specified with a prefix arg, so that reverting
1885 the buffer will not reset them. However, using `dired-undo' to re-insert
1886 or delete subdirectories can bypass this machinery. Hence, you sometimes
1887 may have to reset some subdirectory switches after a `dired-undo'.
1888 You can reset all subdirectory switches to the default using
1890 See Info node `(emacs)Subdir switches' for more details."
1897 ;; We don't need a marker for opoint as the subdir is always
1898 ;; inserted *after* opoint.
1903 ;; Push mark so that it's easy to find back. Do this after the
1904 ;; insert message so that the user sees the `Mark set' message.
1907 ;;;###autoload
1909 "Insert this subdirectory into the same dired buffer.
1910 If it is already present, overwrites previous entry,
1911 else inserts it at its natural place (as `ls -lR' would have done).
1912 With a prefix arg, you may edit the `ls' switches used for this listing.
1913 You can add `R' to the switches to expand the whole tree starting at
1914 this subdirectory.
1915 This function takes some pains to conform to `ls -lR' output."
1916 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1917 ;; Prospero where dired-ls does the right thing, but
1918 ;; file-directory-p has not been redefined.
1932 switches-have-R mark-alist case-fold-search buffer-read-only)
1935 ;; case-fold-search is nil now, so we can test for capital `R':
1937 ;; avoid duplicated subdirs
1940 ;; If subdir is already present, remove it and remember its marks
1964 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1965 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1978 ;; all switches that make a difference to dired-get-filename:
1982 ;; Add new DIR at NEW-MARKER. Sort alist.
1987 ;; Keep the alist sorted on buffer position.
1995 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1996 Interactively, you can kill DIRNAME as well by using a prefix argument.
1997 In interactive use, the command prompts for DIRNAME.
1999 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2000 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2011 m-alist))
2014 ;; Find pos for new subdir, according to tree order.
2015 ;;(goto-char (point-max))
2023 ;; Insert NEW-DIR after DIR
2025 alist nil)))
2027 ;; want a separating newline between subdirs
2034 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2035 ;; Move to that buffer position. Return a mark-alist.
2038 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2047 ;; Insert ls output after point.
2048 ;; Return the boundary of the inserted text (as list of BEG and END).
2053 dired-subdir-switches
2056 ;; If doing the top level directory of the buffer,
2057 ;; redo it as specified in dired-directory.
2063 ;; Point is at the correct subdir alist position for ELT,
2064 ;; BEG-END is the subdir-region (as list of begin and end).
2066 ;; update its position (should actually be unchanged)
2069 ;; The hook may depend on the subdir-alist containing the just
2070 ;; inserted subdir, so run it after dired-alist-add:
2078 ;; hook may add or delete lines, but the subdir boundary
2079 ;; marker floats
2083 ;; Lexicographic order on file name components, like `ls -lR':
2084 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2085 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2086 ;; or DIR1 and DIR2 are in the same parentdir and their last
2087 ;; components are string-lessp.
2088 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2089 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2090 ;; if dired-actual-switches contained `t'.
2096 components-2
2108 t)
2110 nil)
2113 ;; There should be a builtin split function - inverse to mapconcat.
2115 "Splitting on regexp PAT, turn string STR into a list of substrings.
2116 Optional third arg LIMIT (>= 1) is a limit to the length of the
2117 resulting list.
2118 Thus, if SEP is a regexp that only matches itself,
2120 (mapconcat 'identity (dired-split SEP STRING) SEP)
2122 is always equal to STRING."
2135 start end)
2136 ))
2143 \f
2144 ;;; moving by subdirectories
2146 ;;;###autoload
2148 "Go to previous subdirectory, regardless of level.
2149 When called interactively and not on a subdir line, go to this subdir's line."
2150 ;;(interactive "p")
2154 ;; if on subdir start already, don't stay there!
2164 ;;;###autoload
2166 "Go to end of header line of DIR in this dired buffer.
2167 Return value of point on success, otherwise return nil.
2173 dired-subdir-alist ; table
2174 nil ; predicate
2175 t ; require-match
2182 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2183 ;; at either \r or \n after this function succeeds.
2186 \f
2187 ;;;###autoload
2189 "Mark all files except `.' and `..' in current subdirectory.
2190 If the Dired buffer shows multiple directories, this command
2191 marks the files listed in the subdirectory that point is in."
2196 ;;;###autoload
2198 "Remove all lines of current subdirectory.
2199 Lower levels are unaffected."
2200 ;; With optional REMEMBER-MARKS, return a mark-alist.
2207 buffer-read-only)
2221 ;; Remove DIR from the alist
2225 ;;;###autoload
2227 "Go up ARG levels in the dired tree."
2233 ;;(setq dir (expand-file-name dir))
2237 ;;;###autoload
2239 "Go down in the dired tree."
2253 \f
2254 ;;; hiding
2270 ;;;###autoload
2272 "Hide or unhide the current subdirectory and move to next directory.
2273 Optional prefix arg is a repeat factor.
2283 buffer-read-only)
2284 ;; keep header line visible, hide rest
2293 ;;;###autoload
2295 "Hide all subdirectories, leaving only their header lines.
2296 If there is already something hidden, make everything visible again.
2301 buffer-read-only)
2305 ;; unhide - bombs on \r in filenames
2307 ;; hide
2314 ;; we're somewhere on current dir's line
2322 ;;;###end dired-ins.el
2324 \f
2325 ;; Search only in file names in the Dired buffer.
2328 "Non-nil to Isearch in file names only.
2329 If t, Isearch in Dired always matches only file names.
2330 If `dwim', Isearch matches file names when initial point position is on
2331 a file name. Otherwise, it searches the whole buffer without restrictions."
2341 "Toggle file names searching on or off.
2342 When on, Isearch skips matches outside file names using the predicate
2343 `dired-isearch-filter-filenames' that matches only at file names.
2344 When off, it uses the original predicate."
2348 dired-isearch-filter-predicate-orig
2353 ;;;###autoload
2355 "Set up isearch to search in Dired file names.
2356 Intended to be added to `isearch-mode-hook'."
2368 "Clean up the Dired file name search after terminating isearch."
2375 "Test whether the current search hit is a visible file name.
2376 Return non-nil if the text from BEG to END is part of a file
2377 name (has the text property `dired-filename') and is visible."
2382 t)))
2384 ;;;###autoload
2386 "Search for a string using Isearch only in file names in the Dired buffer."
2391 ;;;###autoload
2393 "Search for a regexp using Isearch only in file names in the Dired buffer."
2398 \f
2399 ;; Functions for searching in tags style among marked files.
2401 ;;;###autoload
2403 "Search for a string through all marked files using Isearch."
2408 ;;;###autoload
2410 "Search for a regexp through all marked files using Isearch."
2415 ;;;###autoload
2417 "Search through all marked files for a match for REGEXP.
2418 Stops when a match is found.
2423 ;;;###autoload
2425 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2426 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2437 buffer-read-only))
2444 \f
2445 ;;;###autoload
2447 "Print the type of FILE, according to the `file' command.
2448 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2449 true then the type of the file linked to by FILE is printed instead."
2462 ;; Local Variables:
2463 ;; byte-compile-dynamic: t
2464 ;; generated-autoload-file: "dired.el"
2465 ;; End:
2467 ;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2468 ;;; dired-aux.el ends here