| blob | c533c81be0e424ff56f0a593a6a1a366e346eed8 |
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985-1986, 1992, 1994, 1998, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
7 ;; Maintainer: FSF
8 ;; Keywords: files
9 ;; Package: emacs
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; The parts of dired mode not normally used. This is a space-saving hack
29 ;; to avoid having to load a large mode when all that's wanted are a few
30 ;; functions.
32 ;; Rewritten in 1990/1991 to add tree features, file marking and
33 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
34 ;; Finished up by rms in 1992.
36 ;;; Code:
38 ;; We need macros in dired.el to compile properly,
39 ;; and we call subroutines in it too.
43 "Variable where `dired-create-files' records failing file names.
44 Functions that operate recursively can store additional names
47 ;;; 15K
48 ;;;###begin dired-cmd.el
49 ;; Diffing and compressing
54 ;;;###autoload
56 "Compare file at point with file FILE using `diff'.
57 FILE defaults to the file at the mark. (That's the mark set by
59 The prompted-for file is the first file given to `diff'.
60 With prefix arg, prompt for second argument SWITCHES,
61 which is options for `diff'."
64 ;; Get the file at the mark.
68 ;; Use it as default if it's not the same as the current file,
69 ;; and the target dir is the current dir or the mark is active.
73 mark-active))
74 file-at-mark))
88 target-dir default t))
92 diff-switches
103 ;;;###autoload
105 "Diff this file with its backup file or vice versa.
106 Uses the latest backup, if there are several numerical backups.
107 If this file is a backup, diff it with its original.
108 The backup file is the first file given to `diff'.
109 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
114 diff-switches
116 nil))
119 ;;;###autoload
121 "Mark files with different file attributes in two dired buffers.
122 Compare file attributes of files in the current directory
123 with file attributes in directory DIR2 using PREDICATE on pairs of files
124 with the same name. Mark files for which PREDICATE returns non-nil.
125 Mark files with different names if PREDICATE is nil (or interactively
126 with empty input at the predicate prompt).
128 PREDICATE is a Lisp expression that can refer to the following variables:
130 size1, size2 - file size in bytes
131 mtime1, mtime2 - last modification time in seconds, as a float
132 fa1, fa2 - list of file attributes
133 returned by function `file-attributes'
135 where 1 refers to attribute of file in the current dired buffer
136 and 2 to attribute of file in second dired buffer.
138 Examples of PREDICATE:
140 (> mtime1 mtime2) - mark newer files
141 (not (= size1 size2)) - mark files with different sizes
142 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
143 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
144 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
155 target-dir target-dir t)))
160 file-list1 file-list2)
166 'cadr
168 file-alist1 file-alist2
169 predicate))
171 'cadr
173 file-alist2 file-alist1
174 predicate)))
176 dir1 nil
181 dir2 nil
190 "Combine LIST1 and LIST2 using a set-difference operation.
191 The result list contains all file items that appear in LIST1 but not LIST2.
192 This is a non-destructive function; it makes a copy of the data if necessary
193 to avoid corrupting the original LIST1 and LIST2.
194 PREDICATE (see `dired-compare-directories') is an additional match
195 condition. Two file items are considered to match if they are equal
196 *and* PREDICATE evaluates to t."
198 list1
214 list)
219 "Return a list of all file names and attributes from DIR.
220 List has a form of (file-name full-file-name (attribute-list))."
225 full-file-name
228 \f
231 "Create initial input value for `touch' command."
242 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
243 ;; refresh their file lines.
244 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
245 ;; PROGRAM is the program used to change the attribute.
246 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
247 ;; ARG describes which files to use, as in dired-get-marked-files.
253 op-symbol arg files))
255 failures)
266 files))
271 nil))))
273 ;;;###autoload
275 "Change the mode of the marked (or next ARG) files.
276 Symbolic modes like `g+w' are allowed."
291 "Change mode of %s to: " nil
297 file
302 ;;;###autoload
304 "Change the group of the marked (or next ARG) files."
310 ;;;###autoload
312 "Change the owner of the marked (or next ARG) files."
318 ;;;###autoload
320 "Change the timestamp of the marked (or next ARG) files.
321 This calls touch."
325 ;; Process all the files in FILES in batches of a convenient size,
326 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
327 ;; Batches are chosen to need less than MAX chars for the file names,
328 ;; allowing 3 extra characters of separator per file name.
331 past
333 failures)
334 ;; Accumulate files as long as they fit in MAX chars,
335 ;; then process the ones accumulated so far.
340 ;; If we have at least 1 pending file
341 ;; and this file won't fit in the length limit, process now.
344 ;; The elements of PENDING are now in forward order.
345 ;; Do the operation and record failures.
347 failures)
348 ;; Transfer the elemens of PENDING onto PAST
349 ;; and clear it out. Now PAST contains the first N files
350 ;; specified (for some N), and FILES contains the rest.
352 pending nil
354 ;; Do (setq pending (cons thisfile pending))
355 ;; but reuse the cons that was in `files'.
363 failures)
364 ;; Now the original list FILES has been put back as it was.
367 ;;;###autoload
369 "Print the marked (or next ARG) files.
370 Uses the shell command coming from variables `lpr-command' and
371 `lpr-switches' as default."
375 "Print %s with: "
380 lpr-switches))
385 ;; Read arguments for a marked-files command that wants a string
386 ;; that is not a file name,
387 ;; perhaps popping up the list of marked files.
388 ;; ARG is the prefix arg and indicates whether the files came from
389 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
390 ;; If the current file was used, the list has but one element and ARG
391 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
394 ;; PROMPT for a string, with INITIAL input and DEFAULT value.
395 ;; Other args are used to give user feedback and pop-up:
396 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
398 nil op-symbol files
401 \f
402 ;;; Cleaning a directory: flagging some backups for deletion.
406 ;;;###autoload
408 "Flag numerical backups for deletion.
409 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
410 Positive prefix arg KEEP overrides `dired-kept-versions';
411 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
414 with a prefix argument."
421 late-retention early-retention)
422 ;; Look at each file.
423 ;; If the file has numeric backup versions,
424 ;; put on dired-file-version-alist an element of the form
425 ;; (FILENAME . VERSION-NUMBER-LIST)
427 ;; Sort each VERSION-NUMBER-LIST,
428 ;; and remove the versions not to be deleted.
436 sorted-v-list)))
440 ;; Look at each file. If it is a numeric backup file,
441 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
445 ;;; Subroutines of dired-clean-directory.
448 ;; Perform FUN with point at the end of each non-directory line.
449 ;; FUN takes one argument, the absolute filename.
464 ;; Only do work if this file is not already in the alist.
466 nil
467 ;; If it looks like file FN has versions, return a list of the versions.
468 ;;That is a list of strings which are file names.
469 ;;The caller may want to flag some of these files for deletion.
474 base-versions
480 dired-file-version-alist)))))))
484 base-version-list)
494 \f
495 ;;; Shell commands
500 "Return a list of all commands associated with current dired files.
501 This function is used to add all related commands retrieved by `mailcap'
502 to the end of the list of defaults just after the default value."
510 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
512 "Read a dired shell command prompting with PROMPT.
513 Passes the prefix argument ARG to `dired-mark-prompt', so that it
514 can be used in the prompt to indicate which FILES are affected.
515 Normally reads the command with `read-shell-command', but if the
516 `dired-x' packages is loaded, uses `dired-guess-shell-command' to offer
517 a smarter default choice of shell command."
529 ;;;###autoload
531 "Run a shell command COMMAND on the marked files asynchronously.
533 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
534 adds `* &' surrounded by whitespace and executes the command asynchronously.
535 The output appears in the buffer `*Async Shell Command*'."
539 ;; Want to give feedback whether this file or marked files are used:
541 current-prefix-arg
542 files)))
549 ;; The in-background argument is only needed in Emacs 18 where
550 ;; shell-command doesn't understand an appended ampersand `&'.
551 ;;;###autoload
553 "Run a shell command COMMAND on the marked files.
554 If no files are marked or a specific numeric prefix arg is given,
556 The prompt mentions the file(s) or the marker, as appropriate.
558 If there is a `*' in COMMAND, surrounded by whitespace, this runs
559 COMMAND just once with the entire file list substituted there.
561 If there is no `*', but there is a `?' in COMMAND, surrounded by
562 whitespace, this runs COMMAND on each file individually with the
563 file name substituted for `?'.
565 Otherwise, this runs COMMAND on each file individually with the
566 file name added at the end of COMMAND (separated by a space).
568 `*' and `?' when not surrounded by whitespace have no special
569 significance for `dired-do-shell-command', and are passed through
570 normally to the shell, but you must confirm first. To pass `*' by
573 If COMMAND produces output, it goes to a separate buffer.
575 This feature does not try to redisplay Dired buffers afterward, as
576 there's no telling what files COMMAND may have changed.
579 When COMMAND runs, its working directory is the top-level directory
580 of the Dired buffer, so output files usually are created there
581 instead of in a subdir.
583 In a noninteractive call (from Lisp code), you must specify
584 the list of file names explicitly with the FILE-LIST argument, which
585 can be produced by `dired-get-marked-files', for example."
586 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
587 ;;actual work and can be redefined for customization.
591 ;; Want to give feedback whether this file or marked files are used:
594 current-prefix-arg
595 files)
596 current-prefix-arg
597 files)))
602 ;; Get confirmation for wildcards that may have been meant
603 ;; to control substitution of a file name or the file name list.
617 nil
618 file-list)
619 ;; execute the shell command
623 ;; Might use {,} for bash or csh:
632 ;; "Make up a shell command line from COMMAND and FILE-LIST.
633 ;; If ON-EACH is t, COMMAND should be applied to each file, else
634 ;; simply concat all files and apply COMMAND to this.
635 ;; FILE-LIST's elements will be quoted for the shell."
636 ;; Might be redefined for smarter things and could then use RAW-ARG
637 ;; (coming from interactive P and currently ignored) to decide what to do.
638 ;; Smart would be a way to access basename or extension of file names.
647 retval))
652 file-list dired-mark-separator)))
657 ;; This is an extra function so that it can be redefined by ange-ftp.
658 ;;;###autoload
665 ;; Return nil for sake of nconc in dired-bunch-files.
666 nil)
667 \f
670 ; "Display MSG while running PROGRAM, and check for output.
671 ;Remaining arguments are strings passed as command arguments to PROGRAM.
672 ; On error, insert output
673 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
674 ; Caller can cons up a list of failed args.
675 ;Else returns nil for success."
679 ;; Get a clean buffer for error output:
692 nil))))
693 \f
694 ;; Commands that delete or redisplay part of the dired buffer.
715 ;;;###autoload
717 "Kill all marked lines (not the files).
718 With a prefix argument, kill that many lines starting with the current line.
719 \(A negative argument kills backward.)
720 If you use this command with a prefix argument to kill the line
721 for a file that is a directory, which you have inserted in the
722 Dired buffer as a subdirectory, then it deletes that subdirectory
723 from the buffer as well.
724 To kill an entire subdirectory \(without killing its line in the
725 parent directory), go to its directory header line and use this
726 command with a prefix argument (the value does not matter)."
727 ;; Returns count of killed lines. FMT="" suppresses message.
745 count))))
747 ;;;###end dired-cmd.el
748 \f
749 ;;; 30K
750 ;;;###begin dired-cp.el
753 ;; Compress or uncompress the current file.
754 ;; Return nil for success, offending filename else.
760 ;; Remove any preexisting entry for the name NEW-FILE.
765 ;; Now replace the current line with an entry for NEW-FILE.
768 from-file)))
774 ;; For .z, try gunzip. It might be an old gzip file,
775 ;; or it might be from compact? pack? (which?) but gunzip handles both.
781 ;; This item controls naming for compression.
783 "Control changes in file name suffixes for compression and uncompression.
784 Each element specifies one transformation rule, and has the form:
785 (REGEXP NEW-SUFFIX PROGRAM)
786 The rule applies when the old file name matches REGEXP.
787 The new file name is computed by deleting the part that matches REGEXP
788 (as well as anything after that), then adding NEW-SUFFIX in its place.
789 If PROGRAM is non-nil, the rule is an uncompression rule,
790 and uncompression is done by running PROGRAM.
793 ;;;###autoload
795 ;; Compress or uncompress FILE.
796 ;; Return the name of the compressed or uncompressed file.
797 ;; Return nil if no change in files.
799 suffix newname
801 ;; See if any suffix rule matches this file name.
807 ;; If so, compute desired new name.
814 nil)
816 ;; We found an uncompression rule.
819 newname))
821 ;;; We don't recognize the file as compressed, so compress it.
822 ;;; Try gzip; if we don't have that, use compress.
828 out-name)))
833 ;; Rename the compressed file to NEWNAME
834 ;; if it hasn't got that name already.
838 newname)
839 out-name)))
843 ;; Don't use NEWNAME with `compress'.
845 \f
847 ;; Request confirmation from the user that the operation described
848 ;; by OP-SYMBOL is to be performed on the marked files.
849 ;; Confirmation consists in a y-or-n question with a file list
850 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
851 ;; The files used are determined by ARG (as in dired-get-marked-files).
854 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
855 ;; is marked pops up a window. That will help the user see
856 ;; it isn't the current line file.
865 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
866 ; and display failures.
868 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
869 ; the short form of the filename) for a failure and probably logs a
870 ; detailed error explanation using function `dired-log'.
872 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
873 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
874 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
875 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
877 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
889 ;; end this bunch of errors:
893 failures)))))
895 ;;;###autoload
897 "Format PROMPT with ARGS, query user, and store the result in SYM.
898 The return value is either nil or t.
900 The user may type y or SPC to accept once; n or DEL to skip once;
901 ! to accept this and subsequent queries; or q or ESC to decline
902 this and subsequent queries.
904 If SYM is already bound to a non-nil value, this function may
905 return automatically without querying the user. If SYM is !,
906 return t; if SYM is q or ESC, return nil."
924 \f
925 ;;;###autoload
927 "Compress or uncompress marked (or next ARG) files."
931 ;; Commands for Emacs Lisp files - load and byte compile
934 ;; Return nil for success, offending file name else.
936 elc-file buffer-read-only failure)
951 nil)))
953 ;;;###autoload
955 "Byte compile marked (or next ARG) Emacs Lisp files."
960 ;; Return nil for success, offending file name else.
966 nil
970 ;;;###autoload
972 "Load the marked (or next ARG) Emacs Lisp files."
976 ;;;###autoload
978 "Redisplay all marked (or next ARG) files.
979 If on a subdir line, redisplay that subdirectory. In that case,
980 a prefix arg lets you edit the `ls' switches used for the new listing.
982 Dired remembers switches specified with a prefix arg, so that reverting
983 the buffer will not reset them. However, using `dired-undo' to re-insert
984 or delete subdirectories can bypass this machinery. Hence, you sometimes
985 may have to reset some subdirectory switches after a `dired-undo'.
986 You can reset all subdirectory switches to the default using
988 See Info node `(emacs)Subdir switches' for more details."
989 ;; Moves point if the next ARG files are redisplayed.
995 dir
999 dired-subdir-switches
1000 dired-actual-switches)))))
1002 ;; message much faster than making dired-map-over-marks show progress
1006 ;; Postphone readin hook till we map
1007 ;; over all marked files (Bug#6810).
1011 arg)
1017 "Set `dired-switches-alist' to nil and revert dired buffer."
1021 \f
1023 ;; Delete the current line, and insert an entry for FILE.
1024 ;; If FILE is nil, then just delete the current line.
1025 ;; Keeps any marks that may be present in column one (doing this
1026 ;; here is faster than with dired-add-entry's optional arg).
1027 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1035 ;; Replace space by old marker without moving point.
1036 ;; Faster than goto+insdel inside a save-excursion?
1040 ;;;###autoload
1051 "Add a new dired entry for FILENAME.
1052 Optionally mark it with MARKER-CHAR (a character, else uses
1053 `dired-marker-char'). Note that this adds the entry `out of order'
1054 if files are sorted by time, etc.
1055 Skips files that match `dired-trivial-filenames'.
1056 Exposes hidden subdirectories if a file is added there.
1058 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1059 files matching `dired-omit-regexp'."
1062 ;; Avoid calling ls for files that are going to be omitted anyway.
1068 filename)
1073 filename
1075 ;; Do it!
1078 ;; Entry is always for files, even if they happen to also be directories
1083 reason)
1088 reason
1095 ;; We are already where we should be, except when
1096 ;; point is before the subdir line or its total line.
1100 ;; else try to find correct place to insert
1104 ;; Point is at end of subdir line.
1106 ;; found - skip subdir and `total' line
1107 ;; and uninteresting files like . and ..
1108 ;; This better not move into the next subdir!
1110 ;; not found
1115 ;; Don't expand `.'.
1116 ;; Show just the file name within directory.
1119 directory
1123 ;; Put in desired marker char.
1127 dired-marker-char)))
1129 ;; Compensate for a bug in ange-ftp.
1130 ;; It inserts the file's absolute name, rather than
1131 ;; the relative one. That may be hard to fix since it
1132 ;; is probably controlled by something in ftp.
1148 ;; The subdir-alist is not affected...
1156 ;; return nil if all went well
1157 nil))
1161 ;; Don't do it (dired-omit-mode).
1162 ;; Return t for success (perhaps we should return file-exists-p).
1163 t))
1166 ;; Return pos of first file line of DIR, skipping header and total
1167 ;; or wildcard lines.
1168 ;; Important: never moves into the next subdir.
1169 ;; DIR is assumed to be unhidden.
1178 ;;;###autoload
1191 ;;;###autoload
1193 "Create or update the line for FILE in all Dired buffers it would belong in."
1199 ;; Relist the line for FILE, or just add it if it did not exist.
1200 ;; FILE must be an absolute file name.
1202 ;; If cursor is already on FILE's line delete-region will cause
1203 ;; save-excursion to fail because of floating makers,
1204 ;; moving point to beginning of line. Sigh.
1213 \f
1214 ;;; Copy, move/rename, making hard and symbolic links
1217 "Non-nil if Dired should ask about making backups before overwriting files.
1218 Special value `always' suppresses confirmation."
1224 ;; This is a fluid var used in dired-handle-overwrite. It should be
1225 ;; let-bound whenever dired-copy-file etc are called. See
1226 ;; dired-create-files for an example.
1230 ;; Save old version of file TO that is to be overwritten.
1231 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1232 ;; from dired-create-files.
1235 dired-overwrite-confirmed
1239 "Make backup for existing file `%s'? "
1240 to)))
1244 ;;;###autoload
1248 dired-recursive-copies))
1253 preserve-time top recursive)
1255 dirfailed)
1260 ;; This is a directory.
1262 ;; Not a directory.
1266 ;; It is a symlink
1271 dired-create-files-failures)
1274 ;;;###autoload
1278 ;; Silently rename the visited file of any buffer visiting this file.
1283 ;; See if it's an inserted subdir, and rename that, too.
1291 ;; Update visited file name of all affected buffers
1301 to-dir
1302 buffer-file-name)))
1308 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1309 ;; one of its subdirectories is expanded in this buffer.
1317 ;; ELT's subdir is affected by the rename
1320 ;; if top level directory was renamed, lots of things have to be
1321 ;; updated:
1326 ;; with and without wildcards
1328 to))
1331 ;; try to rename buffer, but just leave old name if new
1332 ;; name would already exist (don't try appending "<%d>")
1335 ;; ... we dired TO now:
1339 ;; Update the headerline and dired-subdir-alist element, as well as
1340 ;; dired-switches-alist element, of directory described by
1341 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1342 ;; describes either DIR itself or a subdir of DIR.
1346 buffer-read-only)
1348 ;; Update subdir headerline in buffer
1351 dir)
1356 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1362 \f
1363 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1367 ;; Create a new file for each from a list of existing files. The user
1368 ;; is queried, dired buffers are updated, and at the end a success or
1369 ;; failure message is displayed
1371 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1373 ;; It is called for each file and must create newfile, the entry of
1374 ;; which will be added. The user will be queried if the file already
1375 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1376 ;; rename), it is FILE-CREATOR's responsibility to update dired
1377 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1378 ;; could not create newfile. The error is caught and logged.
1380 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1381 ;; operation performed. It is used for error logging.
1383 ;; FN-LIST is the list of files to copy (full absolute file names).
1385 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1386 ;; skip. If it skips files for other reasons than a direct user
1387 ;; query, it is supposed to tell why (using dired-log).
1389 ;; Optional MARKER-CHAR is a character with which to mark every
1390 ;; newfile's entry, or t to use the current marker character if the
1391 ;; oldfile was marked.
1410 Type SPC or `y' to overwrite file `%s',
1411 DEL or `n' to skip to next,
1412 ESC or `q' to not overwrite any of the remaining files,
1416 ;; must determine if FROM is marked before file-creator
1417 ;; gets a chance to delete it (in case of a move).
1430 ;; If we get here, file-creator hasn't been aborted
1431 ;; and the old entry (if any) has to be deleted
1432 ;; before adding the new entry.
1440 failures)
1442 operation from to err))))))))
1450 total)
1451 failures))
1457 failures))
1463 skipped))
1468 \f
1470 &optional marker-char op1
1471 how-to)
1472 "Create a new file for each marked file.
1473 Prompts user for target, which is a directory in which to create
1474 the new files. Target may also be a plain file if only one marked
1475 file exists. The way the default for the target directory is
1476 computed depends on the value of `dired-dwim-target-directory'.
1477 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1478 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1479 FILE-CREATOR and OPERATION as in `dired-create-files'.
1480 ARG as in `dired-get-marked-files'.
1481 Optional arg MARKER-CHAR as in `dired-create-files'.
1482 Optional arg OP1 is an alternate form for OPERATION if there is
1483 only one file.
1484 Optional arg HOW-TO determiness how to treat the target.
1485 If HOW-TO is nil, use `file-directory-p' to determine if the
1486 target is a directory. If so, the marked file(s) are created
1487 inside that directory. Otherwise, the target is a plain file;
1488 an error is raised unless there is exactly one marked file.
1489 If HOW-TO is t, target is always treated as a plain file.
1490 Otherwise, HOW-TO should be a function of one argument, TARGET.
1491 If its return value is nil, TARGET is regarded as a plain file.
1492 If it return value is a list, TARGET is a generalized
1493 directory (e.g. some sort of archive). The first element of
1494 this list must be a function with at least four arguments:
1495 operation - as OPERATION above.
1496 rfn-list - list of the relative names for the marked files.
1497 fn-list - list of the absolute names for the marked files.
1498 target - the name of the target itself.
1499 The rest of into-dir are optional arguments.
1500 For any other return value, TARGET is treated as a directory."
1509 target-dir)))
1518 target-dir op-symbol arg rfn-list default))))
1520 ;; Allow DOS/Windows users to change the letter
1521 ;; case of a directory. If we don't test these
1522 ;; conditions up front, file-directory-p below
1523 ;; will return t because the filesystem is
1524 ;; case-insensitive, and Emacs will try to move
1525 ;; foo -> foo/foo, which fails.
1528 dired-one-file
1536 nil
1544 ;; rename-file bombs when moving directories unless we do this:
1547 file-creator operation fn-list
1549 ;; This function uses fluid variable target when called
1550 ;; inside dired-create-files:
1555 marker-char))))
1557 ;; Read arguments for a marked-files command that wants a file name,
1558 ;; perhaps popping up the list of marked files.
1559 ;; ARG is the prefix arg and indicates whether the files came from
1560 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1561 ;; If the current file was used, the list has but one element and ARG
1562 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1563 ;; DEFAULT is the default value to return if the user just hits RET;
1564 ;; if it is omitted or nil, then the name of the directory is used.
1569 nil op-symbol files
1574 ;; Try to guess which target directory the user may want.
1575 ;; If there is a dired buffer displayed in one of the next windows,
1576 ;; use its current subdir, else use current subdir of this dired buffer.
1579 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1590 this-dir)))
1593 ;; Return a list of default values for file-reading functions in Dired.
1594 ;; This list may contain directories from Dired buffers in other windows.
1595 ;; `fn-list' is a list of file names used to build a list of defaults.
1596 ;; When nil or more than one element, a list of defaults will
1597 ;; contain only directory names. `target-dir' is a directory name
1598 ;; to exclude from the returned list, for the case when this
1599 ;; directory name is already presented in initial input.
1600 ;; For Dired operations that support `dired-dwim-target',
1601 ;; the argument `target-dir' should have the value returned
1602 ;; from `dired-dwim-target-directory'.
1607 dired-dirs)
1608 ;; Get a list of directories of visible buffers in dired-mode.
1613 ;; Force the current dir to be the first in the list.
1616 ;; Remove the target dir (if specified) or the current dir from
1617 ;; default values, because it should be already in initial input.
1619 ;; Return a list of default values.
1621 ;; For one file operation, provide a list that contains
1622 ;; other directories, other directories with the appended filename
1623 ;; and the current directory with the appended filename, e.g.
1624 ;; 1. /TARGET-DIR/
1625 ;; 2. /TARGET-DIR/FILENAME
1626 ;; 3. /CURRENT-DIR/FILENAME
1635 ;; For multi-file operation, return only a list of other directories.
1636 dired-dirs)))
1638 \f
1639 ;;;###autoload
1641 "Create a directory called DIRECTORY."
1646 ;; Find the topmost nonexistent parent dir (variable `new')
1658 ;; This may not always be what you want, especially if target is your
1659 ;; home directory and it happens to be a symbolic link, as is often the
1660 ;; case with NFS and automounters. Or if you want to make symlinks
1661 ;; into directories that themselves are only symlinks, also quite
1662 ;; common.
1664 ;; So we don't use this function as value for HOW-TO in
1665 ;; dired-do-symlink, which has the minor disadvantage of
1666 ;; making links *into* a symlinked-dir, when you really wanted to
1667 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1668 ;; just have to remove that symlink by hand before making your marked
1669 ;; symlinks.
1672 "Either nil or a function used by `dired-do-copy' to determine target.
1675 ;;;###autoload
1677 "Copy all marked (or next ARG) files, or copy the current file.
1678 This normally preserves the last-modified date when copying.
1679 When operating on just the current file, you specify the new name.
1680 When operating on multiple or marked files, you specify a directory,
1681 and new copies of these files are made in that directory
1682 with the same names that the files currently have. The default
1683 suggested for the target directory depends on the value of
1684 `dired-dwim-target', which see.
1686 This command copies symbolic links by creating new ones,
1687 like `cp -d'."
1691 "Copy"
1692 arg dired-keep-marker-copy
1693 nil dired-copy-how-to-fn)))
1695 ;;;###autoload
1697 "Make symbolic links to current file or all marked (or next ARG) files.
1698 When operating on just the current file, you specify the new name.
1699 When operating on multiple or marked files, you specify a directory
1700 and new symbolic links are made in that directory
1701 with the same names that the files currently have. The default
1702 suggested for the target directory depends on the value of
1703 `dired-dwim-target', which see.
1710 ;;;###autoload
1712 "Add names (hard links) current file or all marked (or next ARG) files.
1713 When operating on just the current file, you specify the new name.
1714 When operating on multiple or marked files, you specify a directory
1715 and new hard links are made in that directory
1716 with the same names that the files currently have. The default
1717 suggested for the target directory depends on the value of
1718 `dired-dwim-target', which see."
1725 ;; error is caught in -create-files
1727 ;; Update the link count
1730 ;;;###autoload
1732 "Rename current file or all marked (or next ARG) files.
1733 When renaming just the current file, you specify the new name.
1734 When renaming multiple or marked files, you specify a directory.
1735 This command also renames any buffers that are visiting the files.
1736 The default suggested for the target directory depends on the value
1737 of `dired-dwim-target', which see."
1741 ;;;###end dired-cp.el
1742 \f
1743 ;;; 5K
1744 ;;;###begin dired-re.el
1747 ;; Create a new file for each marked file using regexps.
1748 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1749 ;; ARG as in dired-get-marked-files.
1750 ;; Matches each marked file against REGEXP and constructs the new
1751 ;; filename from NEWNAME (like in function replace-match).
1752 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1753 ;; instead of only the non-directory part of the file.
1754 ;; Optional arg MARKER-CHAR as in dired-create-files.
1759 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1760 `!' to %s all remaining matches with no more questions."
1764 ;; Function to construct new filename using REGEXP and NEWNAME:
1769 ;; must bind help-form directly around call to
1770 ;; dired-query
1774 operation-prompt
1775 from
1776 to)
1777 to)
1779 operation from regexp)))))
1780 ;; not whole-name, replace non-directory part only
1791 operation-prompt
1794 to)
1797 rename-regexp-query)
1799 file-creator operation fn-list regexp-name-constructor marker-char)))
1802 ;; Prompt user about performing OPERATION.
1803 ;; Read and return list of: regexp newname arg whole-name.
1816 ;;;###autoload
1818 "Rename selected files whose names match REGEXP to NEWNAME.
1820 With non-zero prefix argument ARG, the command operates on the next ARG
1821 files. Otherwise, it operates on all the marked files, or the current
1822 file if none are marked.
1824 As each match is found, the user must type a character saying
1827 REGEXP defaults to the last regexp used.
1829 With a zero prefix arg, renaming by regexp affects the absolute file name.
1830 Normally, only the non-directory part of the file name is used and changed."
1836 ;;;###autoload
1838 "Copy selected files whose names match REGEXP to NEWNAME.
1839 See function `dired-do-rename-regexp' for more info."
1845 arg regexp newname whole-name dired-keep-marker-copy)))
1847 ;;;###autoload
1849 "Hardlink selected files whose names match REGEXP to NEWNAME.
1850 See function `dired-do-rename-regexp' for more info."
1856 ;;;###autoload
1858 "Symlink selected files whose names match REGEXP to NEWNAME.
1859 See function `dired-do-rename-regexp' for more info."
1867 ;; Perform FILE-CREATOR on the non-directory part of marked files
1868 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1869 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1872 file-creator
1873 operation
1881 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1882 `!' to %s all remaining matches with no more questions."
1889 to))))
1890 dired-keep-marker-rename)))
1895 basename-constructor operation arg))
1897 ;;;###autoload
1899 "Rename all marked (or next ARG) files to upper case."
1903 ;;;###autoload
1905 "Rename all marked (or next ARG) files to lower case."
1909 ;;;###end dired-re.el
1910 \f
1911 ;;; 13K
1912 ;;;###begin dired-ins.el
1914 ;;;###autoload
1916 switches no-error-if-not-dir-p)
1917 "Insert this subdirectory into the same dired buffer.
1919 else inserts it at its natural place (as `ls -lR' would have done).
1920 With a prefix arg, you may edit the ls switches used for this listing.
1921 You can add `R' to the switches to expand the whole tree starting at
1922 this subdirectory.
1923 This function takes some pains to conform to `ls -lR' output.
1925 Dired remembers switches specified with a prefix arg, so that reverting
1926 the buffer will not reset them. However, using `dired-undo' to re-insert
1927 or delete subdirectories can bypass this machinery. Hence, you sometimes
1928 may have to reset some subdirectory switches after a `dired-undo'.
1929 You can reset all subdirectory switches to the default using
1931 See Info node `(emacs)Subdir switches' for more details."
1938 ;; We don't need a marker for opoint as the subdir is always
1939 ;; inserted *after* opoint.
1944 ;; Push mark so that it's easy to find back. Do this after the
1945 ;; insert message so that the user sees the `Mark set' message.
1948 ;;;###autoload
1950 "Insert this subdirectory into the same dired buffer.
1951 If it is already present, overwrites previous entry,
1952 else inserts it at its natural place (as `ls -lR' would have done).
1953 With a prefix arg, you may edit the `ls' switches used for this listing.
1954 You can add `R' to the switches to expand the whole tree starting at
1955 this subdirectory.
1956 This function takes some pains to conform to `ls -lR' output."
1957 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1958 ;; Prospero where dired-ls does the right thing, but
1959 ;; file-directory-p has not been redefined.
1973 switches-have-R mark-alist case-fold-search buffer-read-only)
1976 ;; case-fold-search is nil now, so we can test for capital `R':
1978 ;; avoid duplicated subdirs
1981 ;; If subdir is already present, remove it and remember its marks
2005 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2006 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2019 ;; all switches that make a difference to dired-get-filename:
2023 ;; Add new DIR at NEW-MARKER. Sort alist.
2028 ;; Keep the alist sorted on buffer position.
2036 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2037 Interactively, you can kill DIRNAME as well by using a prefix argument.
2038 In interactive use, the command prompts for DIRNAME.
2040 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2041 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2052 m-alist))
2055 ;; Find pos for new subdir, according to tree order.
2056 ;;(goto-char (point-max))
2064 ;; Insert NEW-DIR after DIR
2066 alist nil)))
2068 ;; want a separating newline between subdirs
2075 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2076 ;; Move to that buffer position. Return a mark-alist.
2079 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2088 ;; Insert ls output after point.
2089 ;; Return the boundary of the inserted text (as list of BEG and END).
2094 dired-subdir-switches
2097 ;; If doing the top level directory of the buffer,
2098 ;; redo it as specified in dired-directory.
2104 ;; Point is at the correct subdir alist position for ELT,
2105 ;; BEG-END is the subdir-region (as list of begin and end).
2107 ;; update its position (should actually be unchanged)
2110 ;; The hook may depend on the subdir-alist containing the just
2111 ;; inserted subdir, so run it after dired-alist-add:
2119 ;; hook may add or delete lines, but the subdir boundary
2120 ;; marker floats
2124 ;; Lexicographic order on file name components, like `ls -lR':
2125 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2126 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2127 ;; or DIR1 and DIR2 are in the same parentdir and their last
2128 ;; components are string-lessp.
2129 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2130 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2131 ;; if dired-actual-switches contained `t'.
2137 components-2
2149 t)
2151 nil)
2154 ;; There should be a builtin split function - inverse to mapconcat.
2156 "Splitting on regexp PAT, turn string STR into a list of substrings.
2157 Optional third arg LIMIT (>= 1) is a limit to the length of the
2158 resulting list.
2159 Thus, if SEP is a regexp that only matches itself,
2161 (mapconcat 'identity (dired-split SEP STRING) SEP)
2163 is always equal to STRING."
2176 start end)
2177 ))
2184 \f
2185 ;;; moving by subdirectories
2187 ;;;###autoload
2189 "Go to previous subdirectory, regardless of level.
2190 When called interactively and not on a subdir line, go to this subdir's line."
2191 ;;(interactive "p")
2195 ;; if on subdir start already, don't stay there!
2205 ;;;###autoload
2207 "Go to end of header line of DIR in this dired buffer.
2208 Return value of point on success, otherwise return nil.
2214 dired-subdir-alist ; table
2215 nil ; predicate
2216 t ; require-match
2223 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2224 ;; at either \r or \n after this function succeeds.
2227 \f
2228 ;;;###autoload
2230 "Mark all files except `.' and `..' in current subdirectory.
2231 If the Dired buffer shows multiple directories, this command
2232 marks the files listed in the subdirectory that point is in."
2237 ;;;###autoload
2239 "Remove all lines of current subdirectory.
2240 Lower levels are unaffected."
2241 ;; With optional REMEMBER-MARKS, return a mark-alist.
2248 buffer-read-only)
2262 ;; Remove DIR from the alist
2266 ;;;###autoload
2268 "Go up ARG levels in the dired tree."
2274 ;;(setq dir (expand-file-name dir))
2278 ;;;###autoload
2280 "Go down in the dired tree."
2294 \f
2295 ;;; hiding
2311 ;;;###autoload
2313 "Hide or unhide the current subdirectory and move to next directory.
2314 Optional prefix arg is a repeat factor.
2324 buffer-read-only)
2325 ;; keep header line visible, hide rest
2334 ;;;###autoload
2336 "Hide all subdirectories, leaving only their header lines.
2337 If there is already something hidden, make everything visible again.
2342 buffer-read-only)
2346 ;; unhide - bombs on \r in filenames
2348 ;; hide
2355 ;; we're somewhere on current dir's line
2363 ;;;###end dired-ins.el
2365 \f
2366 ;; Search only in file names in the Dired buffer.
2369 "Non-nil to Isearch in file names only.
2370 If t, Isearch in Dired always matches only file names.
2371 If `dwim', Isearch matches file names when initial point position is on
2372 a file name. Otherwise, it searches the whole buffer without restrictions."
2382 "Toggle file names searching on or off.
2383 When on, Isearch skips matches outside file names using the predicate
2384 `dired-isearch-filter-filenames' that matches only at file names.
2385 When off, it uses the original predicate."
2389 dired-isearch-filter-predicate-orig
2394 ;;;###autoload
2396 "Set up isearch to search in Dired file names.
2397 Intended to be added to `isearch-mode-hook'."
2409 "Clean up the Dired file name search after terminating isearch."
2416 "Test whether the current search hit is a visible file name.
2417 Return non-nil if the text from BEG to END is part of a file
2418 name (has the text property `dired-filename') and is visible."
2423 t)))
2425 ;;;###autoload
2427 "Search for a string using Isearch only in file names in the Dired buffer."
2432 ;;;###autoload
2434 "Search for a regexp using Isearch only in file names in the Dired buffer."
2439 \f
2440 ;; Functions for searching in tags style among marked files.
2442 ;;;###autoload
2444 "Search for a string through all marked files using Isearch."
2449 ;;;###autoload
2451 "Search for a regexp through all marked files using Isearch."
2456 ;;;###autoload
2458 "Search through all marked files for a match for REGEXP.
2459 Stops when a match is found.
2464 ;;;###autoload
2466 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2467 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2478 buffer-read-only))
2485 \f
2486 ;;;###autoload
2488 "Print the type of FILE, according to the `file' command.
2489 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2490 true then the type of the file linked to by FILE is printed instead."
2503 ;; Local Variables:
2504 ;; byte-compile-dynamic: t
2505 ;; generated-autoload-file: "dired.el"
2506 ;; End:
2508 ;;; dired-aux.el ends here