| blob | 6f33831eb38f21b46692d4f1d86443a256daccb9 |
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 (using `read-shell-command').
513 ARG is the prefix arg and may be used to indicate in the prompt which
514 FILES are affected."
520 nil 'shell files
521 #'read-shell-command
523 nil nil)))
525 ;;;###autoload
527 "Run a shell command COMMAND on the marked files asynchronously.
529 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
530 adds `* &' surrounded by whitespace and executes the command asynchronously.
531 The output appears in the buffer `*Async Shell Command*'."
535 ;; Want to give feedback whether this file or marked files are used:
537 current-prefix-arg
538 files)))
545 ;; The in-background argument is only needed in Emacs 18 where
546 ;; shell-command doesn't understand an appended ampersand `&'.
547 ;;;###autoload
549 "Run a shell command COMMAND on the marked files.
550 If no files are marked or a specific numeric prefix arg is given,
552 The prompt mentions the file(s) or the marker, as appropriate.
554 If there is a `*' in COMMAND, surrounded by whitespace, this runs
555 COMMAND just once with the entire file list substituted there.
557 If there is no `*', but there is a `?' in COMMAND, surrounded by
558 whitespace, this runs COMMAND on each file individually with the
559 file name substituted for `?'.
561 Otherwise, this runs COMMAND on each file individually with the
562 file name added at the end of COMMAND (separated by a space).
564 `*' and `?' when not surrounded by whitespace have no special
565 significance for `dired-do-shell-command', and are passed through
566 normally to the shell, but you must confirm first. To pass `*' by
569 If COMMAND produces output, it goes to a separate buffer.
571 This feature does not try to redisplay Dired buffers afterward, as
572 there's no telling what files COMMAND may have changed.
575 When COMMAND runs, its working directory is the top-level directory
576 of the Dired buffer, so output files usually are created there
577 instead of in a subdir.
579 In a noninteractive call (from Lisp code), you must specify
580 the list of file names explicitly with the FILE-LIST argument, which
581 can be produced by `dired-get-marked-files', for example."
582 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
583 ;;actual work and can be redefined for customization.
587 ;; Want to give feedback whether this file or marked files are used:
590 current-prefix-arg
591 files)
592 current-prefix-arg
593 files)))
598 ;; Get confirmation for wildcards that may have been meant
599 ;; to control substitution of a file name or the file name list.
613 nil
614 file-list)
615 ;; execute the shell command
619 ;; Might use {,} for bash or csh:
628 ;; "Make up a shell command line from COMMAND and FILE-LIST.
629 ;; If ON-EACH is t, COMMAND should be applied to each file, else
630 ;; simply concat all files and apply COMMAND to this.
631 ;; FILE-LIST's elements will be quoted for the shell."
632 ;; Might be redefined for smarter things and could then use RAW-ARG
633 ;; (coming from interactive P and currently ignored) to decide what to do.
634 ;; Smart would be a way to access basename or extension of file names.
643 retval))
648 file-list dired-mark-separator)))
653 ;; This is an extra function so that it can be redefined by ange-ftp.
654 ;;;###autoload
661 ;; Return nil for sake of nconc in dired-bunch-files.
662 nil)
663 \f
666 ; "Display MSG while running PROGRAM, and check for output.
667 ;Remaining arguments are strings passed as command arguments to PROGRAM.
668 ; On error, insert output
669 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
670 ; Caller can cons up a list of failed args.
671 ;Else returns nil for success."
675 ;; Get a clean buffer for error output:
688 nil))))
689 \f
690 ;; Commands that delete or redisplay part of the dired buffer.
711 ;;;###autoload
713 "Kill all marked lines (not the files).
714 With a prefix argument, kill that many lines starting with the current line.
715 \(A negative argument kills backward.)
716 If you use this command with a prefix argument to kill the line
717 for a file that is a directory, which you have inserted in the
718 Dired buffer as a subdirectory, then it deletes that subdirectory
719 from the buffer as well.
720 To kill an entire subdirectory \(without killing its line in the
721 parent directory), go to its directory header line and use this
722 command with a prefix argument (the value does not matter)."
723 ;; Returns count of killed lines. FMT="" suppresses message.
741 count))))
743 ;;;###end dired-cmd.el
744 \f
745 ;;; 30K
746 ;;;###begin dired-cp.el
749 ;; Compress or uncompress the current file.
750 ;; Return nil for success, offending filename else.
756 ;; Remove any preexisting entry for the name NEW-FILE.
761 ;; Now replace the current line with an entry for NEW-FILE.
764 from-file)))
770 ;; For .z, try gunzip. It might be an old gzip file,
771 ;; or it might be from compact? pack? (which?) but gunzip handles both.
777 ;; This item controls naming for compression.
779 "Control changes in file name suffixes for compression and uncompression.
780 Each element specifies one transformation rule, and has the form:
781 (REGEXP NEW-SUFFIX PROGRAM)
782 The rule applies when the old file name matches REGEXP.
783 The new file name is computed by deleting the part that matches REGEXP
784 (as well as anything after that), then adding NEW-SUFFIX in its place.
785 If PROGRAM is non-nil, the rule is an uncompression rule,
786 and uncompression is done by running PROGRAM.
789 ;;;###autoload
791 ;; Compress or uncompress FILE.
792 ;; Return the name of the compressed or uncompressed file.
793 ;; Return nil if no change in files.
795 suffix newname
797 ;; See if any suffix rule matches this file name.
803 ;; If so, compute desired new name.
810 nil)
812 ;; We found an uncompression rule.
815 newname))
817 ;;; We don't recognize the file as compressed, so compress it.
818 ;;; Try gzip; if we don't have that, use compress.
824 out-name)))
829 ;; Rename the compressed file to NEWNAME
830 ;; if it hasn't got that name already.
834 newname)
835 out-name)))
839 ;; Don't use NEWNAME with `compress'.
841 \f
843 ;; Request confirmation from the user that the operation described
844 ;; by OP-SYMBOL is to be performed on the marked files.
845 ;; Confirmation consists in a y-or-n question with a file list
846 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
847 ;; The files used are determined by ARG (as in dired-get-marked-files).
850 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
851 ;; is marked pops up a window. That will help the user see
852 ;; it isn't the current line file.
861 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
862 ; and display failures.
864 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
865 ; the short form of the filename) for a failure and probably logs a
866 ; detailed error explanation using function `dired-log'.
868 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
869 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
870 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
871 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
873 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
885 ;; end this bunch of errors:
889 failures)))))
891 ;;;###autoload
893 "Format PROMPT with ARGS, query user, and store the result in SYM.
894 The return value is either nil or t.
896 The user may type y or SPC to accept once; n or DEL to skip once;
897 ! to accept this and subsequent queries; or q or ESC to decline
898 this and subsequent queries.
900 If SYM is already bound to a non-nil value, this function may
901 return automatically without querying the user. If SYM is !,
902 return t; if SYM is q or ESC, return nil."
920 \f
921 ;;;###autoload
923 "Compress or uncompress marked (or next ARG) files."
927 ;; Commands for Emacs Lisp files - load and byte compile
930 ;; Return nil for success, offending file name else.
932 elc-file buffer-read-only failure)
947 nil)))
949 ;;;###autoload
951 "Byte compile marked (or next ARG) Emacs Lisp files."
956 ;; Return nil for success, offending file name else.
962 nil
966 ;;;###autoload
968 "Load the marked (or next ARG) Emacs Lisp files."
972 ;;;###autoload
974 "Redisplay all marked (or next ARG) files.
975 If on a subdir line, redisplay that subdirectory. In that case,
976 a prefix arg lets you edit the `ls' switches used for the new listing.
978 Dired remembers switches specified with a prefix arg, so that reverting
979 the buffer will not reset them. However, using `dired-undo' to re-insert
980 or delete subdirectories can bypass this machinery. Hence, you sometimes
981 may have to reset some subdirectory switches after a `dired-undo'.
982 You can reset all subdirectory switches to the default using
984 See Info node `(emacs)Subdir switches' for more details."
985 ;; Moves point if the next ARG files are redisplayed.
991 dir
995 dired-subdir-switches
996 dired-actual-switches)))))
998 ;; message much faster than making dired-map-over-marks show progress
1002 ;; Postphone readin hook till we map
1003 ;; over all marked files (Bug#6810).
1007 arg)
1013 "Set `dired-switches-alist' to nil and revert dired buffer."
1017 \f
1019 ;; Delete the current line, and insert an entry for FILE.
1020 ;; If FILE is nil, then just delete the current line.
1021 ;; Keeps any marks that may be present in column one (doing this
1022 ;; here is faster than with dired-add-entry's optional arg).
1023 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1031 ;; Replace space by old marker without moving point.
1032 ;; Faster than goto+insdel inside a save-excursion?
1036 ;;;###autoload
1043 ;; Add a new entry for FILENAME, optionally marking it
1044 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
1045 ;; Note that this adds the entry `out of order' if files sorted by
1046 ;; time, etc.
1047 ;; At least this version inserts in the right subdirectory (if present).
1048 ;; And it skips "." or ".." (see `dired-trivial-filenames').
1049 ;; Hidden subdirs are exposed if a file is added there.
1051 ;; Entry is always for files, even if they happen to also be directories
1056 reason)
1061 reason
1068 ;; We are already where we should be, except when
1069 ;; point is before the subdir line or its total line.
1073 ;; else try to find correct place to insert
1078 ;; found - skip subdir and `total' line
1079 ;; and uninteresting files like . and ..
1080 ;; This better not moves into the next subdir!
1082 ;; not found
1087 ;; Don't expand `.'. Show just the file name within directory.
1093 ;; Put in desired marker char.
1098 ;; Compensate for a bug in ange-ftp.
1099 ;; It inserts the file's absolute name, rather than
1100 ;; the relative one. That may be hard to fix since it
1101 ;; is probably controlled by something in ftp.
1123 ;; return nil if all went well
1124 nil))
1130 ;; Return pos of first file line of DIR, skipping header and total
1131 ;; or wildcard lines.
1132 ;; Important: never moves into the next subdir.
1133 ;; DIR is assumed to be unhidden.
1142 ;;;###autoload
1155 ;;;###autoload
1157 "Create or update the line for FILE in all Dired buffers it would belong in."
1163 ;; Relist the line for FILE, or just add it if it did not exist.
1164 ;; FILE must be an absolute file name.
1166 ;; If cursor is already on FILE's line delete-region will cause
1167 ;; save-excursion to fail because of floating makers,
1168 ;; moving point to beginning of line. Sigh.
1177 \f
1178 ;;; Copy, move/rename, making hard and symbolic links
1181 "Non-nil if Dired should ask about making backups before overwriting files.
1182 Special value `always' suppresses confirmation."
1188 ;; This is a fluid var used in dired-handle-overwrite. It should be
1189 ;; let-bound whenever dired-copy-file etc are called. See
1190 ;; dired-create-files for an example.
1194 ;; Save old version of file TO that is to be overwritten.
1195 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1196 ;; from dired-create-files.
1199 dired-overwrite-confirmed
1203 "Make backup for existing file `%s'? "
1204 to)))
1208 ;;;###autoload
1212 dired-recursive-copies))
1217 preserve-time top recursive)
1219 dirfailed)
1224 ;; This is a directory.
1226 ;; Not a directory.
1230 ;; It is a symlink
1235 dired-create-files-failures)
1238 ;;;###autoload
1242 ;; Silently rename the visited file of any buffer visiting this file.
1247 ;; See if it's an inserted subdir, and rename that, too.
1255 ;; Update visited file name of all affected buffers
1265 to-dir
1266 buffer-file-name)))
1272 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1273 ;; one of its subdirectories is expanded in this buffer.
1281 ;; ELT's subdir is affected by the rename
1284 ;; if top level directory was renamed, lots of things have to be
1285 ;; updated:
1290 ;; with and without wildcards
1292 to))
1295 ;; try to rename buffer, but just leave old name if new
1296 ;; name would already exist (don't try appending "<%d>")
1299 ;; ... we dired TO now:
1303 ;; Update the headerline and dired-subdir-alist element, as well as
1304 ;; dired-switches-alist element, of directory described by
1305 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1306 ;; describes either DIR itself or a subdir of DIR.
1310 buffer-read-only)
1312 ;; Update subdir headerline in buffer
1315 dir)
1320 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1326 \f
1327 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1331 ;; Create a new file for each from a list of existing files. The user
1332 ;; is queried, dired buffers are updated, and at the end a success or
1333 ;; failure message is displayed
1335 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1337 ;; It is called for each file and must create newfile, the entry of
1338 ;; which will be added. The user will be queried if the file already
1339 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1340 ;; rename), it is FILE-CREATOR's responsibility to update dired
1341 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1342 ;; could not create newfile. The error is caught and logged.
1344 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1345 ;; operation performed. It is used for error logging.
1347 ;; FN-LIST is the list of files to copy (full absolute file names).
1349 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1350 ;; skip. If it skips files for other reasons than a direct user
1351 ;; query, it is supposed to tell why (using dired-log).
1353 ;; Optional MARKER-CHAR is a character with which to mark every
1354 ;; newfile's entry, or t to use the current marker character if the
1355 ;; oldfile was marked.
1374 Type SPC or `y' to overwrite file `%s',
1375 DEL or `n' to skip to next,
1376 ESC or `q' to not overwrite any of the remaining files,
1380 ;; must determine if FROM is marked before file-creator
1381 ;; gets a chance to delete it (in case of a move).
1390 ;; If we get here, file-creator hasn't been aborted
1391 ;; and the old entry (if any) has to be deleted
1392 ;; before adding the new entry.
1400 failures)
1402 operation from to err))))))))
1410 total)
1411 failures))
1417 failures))
1423 skipped))
1428 \f
1430 &optional marker-char op1
1431 how-to)
1432 "Create a new file for each marked file.
1433 Prompts user for target, which is a directory in which to create
1434 the new files. Target may also be a plain file if only one marked
1435 file exists. The way the default for the target directory is
1436 computed depends on the value of `dired-dwim-target-directory'.
1437 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1438 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1439 FILE-CREATOR and OPERATION as in `dired-create-files'.
1440 ARG as in `dired-get-marked-files'.
1441 Optional arg MARKER-CHAR as in `dired-create-files'.
1442 Optional arg OP1 is an alternate form for OPERATION if there is
1443 only one file.
1444 Optional arg HOW-TO determiness how to treat the target.
1445 If HOW-TO is nil, use `file-directory-p' to determine if the
1446 target is a directory. If so, the marked file(s) are created
1447 inside that directory. Otherwise, the target is a plain file;
1448 an error is raised unless there is exactly one marked file.
1449 If HOW-TO is t, target is always treated as a plain file.
1450 Otherwise, HOW-TO should be a function of one argument, TARGET.
1451 If its return value is nil, TARGET is regarded as a plain file.
1452 If it return value is a list, TARGET is a generalized
1453 directory (e.g. some sort of archive). The first element of
1454 this list must be a function with at least four arguments:
1455 operation - as OPERATION above.
1456 rfn-list - list of the relative names for the marked files.
1457 fn-list - list of the absolute names for the marked files.
1458 target - the name of the target itself.
1459 The rest of into-dir are optional arguments.
1460 For any other return value, TARGET is treated as a directory."
1469 target-dir)))
1478 target-dir op-symbol arg rfn-list default))))
1480 ;; Allow DOS/Windows users to change the letter
1481 ;; case of a directory. If we don't test these
1482 ;; conditions up front, file-directory-p below
1483 ;; will return t because the filesystem is
1484 ;; case-insensitive, and Emacs will try to move
1485 ;; foo -> foo/foo, which fails.
1488 dired-one-file
1496 nil
1504 ;; rename-file bombs when moving directories unless we do this:
1507 file-creator operation fn-list
1509 ;; This function uses fluid variable target when called
1510 ;; inside dired-create-files:
1515 marker-char))))
1517 ;; Read arguments for a marked-files command that wants a file name,
1518 ;; perhaps popping up the list of marked files.
1519 ;; ARG is the prefix arg and indicates whether the files came from
1520 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1521 ;; If the current file was used, the list has but one element and ARG
1522 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1523 ;; DEFAULT is the default value to return if the user just hits RET;
1524 ;; if it is omitted or nil, then the name of the directory is used.
1529 nil op-symbol files
1534 ;; Try to guess which target directory the user may want.
1535 ;; If there is a dired buffer displayed in one of the next windows,
1536 ;; use its current subdir, else use current subdir of this dired buffer.
1539 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1550 this-dir)))
1553 ;; Return a list of default values for file-reading functions in Dired.
1554 ;; This list may contain directories from Dired buffers in other windows.
1555 ;; `fn-list' is a list of file names used to build a list of defaults.
1556 ;; When nil or more than one element, a list of defaults will
1557 ;; contain only directory names. `target-dir' is a directory name
1558 ;; to exclude from the returned list, for the case when this
1559 ;; directory name is already presented in initial input.
1560 ;; For Dired operations that support `dired-dwim-target',
1561 ;; the argument `target-dir' should have the value returned
1562 ;; from `dired-dwim-target-directory'.
1567 dired-dirs)
1568 ;; Get a list of directories of visible buffers in dired-mode.
1573 ;; Force the current dir to be the first in the list.
1576 ;; Remove the target dir (if specified) or the current dir from
1577 ;; default values, because it should be already in initial input.
1579 ;; Return a list of default values.
1581 ;; For one file operation, provide a list that contains
1582 ;; other directories, other directories with the appended filename
1583 ;; and the current directory with the appended filename, e.g.
1584 ;; 1. /TARGET-DIR/
1585 ;; 2. /TARGET-DIR/FILENAME
1586 ;; 3. /CURRENT-DIR/FILENAME
1595 ;; For multi-file operation, return only a list of other directories.
1596 dired-dirs)))
1598 \f
1599 ;;;###autoload
1601 "Create a directory called DIRECTORY."
1606 ;; Find the topmost nonexistent parent dir (variable `new')
1618 ;; This may not always be what you want, especially if target is your
1619 ;; home directory and it happens to be a symbolic link, as is often the
1620 ;; case with NFS and automounters. Or if you want to make symlinks
1621 ;; into directories that themselves are only symlinks, also quite
1622 ;; common.
1624 ;; So we don't use this function as value for HOW-TO in
1625 ;; dired-do-symlink, which has the minor disadvantage of
1626 ;; making links *into* a symlinked-dir, when you really wanted to
1627 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1628 ;; just have to remove that symlink by hand before making your marked
1629 ;; symlinks.
1632 "Either nil or a function used by `dired-do-copy' to determine target.
1635 ;;;###autoload
1637 "Copy all marked (or next ARG) files, or copy the current file.
1638 This normally preserves the last-modified date when copying.
1639 When operating on just the current file, you specify the new name.
1640 When operating on multiple or marked files, you specify a directory,
1641 and new copies of these files are made in that directory
1642 with the same names that the files currently have. The default
1643 suggested for the target directory depends on the value of
1644 `dired-dwim-target', which see.
1646 This command copies symbolic links by creating new ones,
1647 like `cp -d'."
1651 "Copy"
1652 arg dired-keep-marker-copy
1653 nil dired-copy-how-to-fn)))
1655 ;;;###autoload
1657 "Make symbolic links to current file or all marked (or next ARG) files.
1658 When operating on just the current file, you specify the new name.
1659 When operating on multiple or marked files, you specify a directory
1660 and new symbolic links are made in that directory
1661 with the same names that the files currently have. The default
1662 suggested for the target directory depends on the value of
1663 `dired-dwim-target', which see.
1670 ;;;###autoload
1672 "Add names (hard links) current file or all marked (or next ARG) files.
1673 When operating on just the current file, you specify the new name.
1674 When operating on multiple or marked files, you specify a directory
1675 and new hard links are made in that directory
1676 with the same names that the files currently have. The default
1677 suggested for the target directory depends on the value of
1678 `dired-dwim-target', which see."
1685 ;; error is caught in -create-files
1687 ;; Update the link count
1690 ;;;###autoload
1692 "Rename current file or all marked (or next ARG) files.
1693 When renaming just the current file, you specify the new name.
1694 When renaming multiple or marked files, you specify a directory.
1695 This command also renames any buffers that are visiting the files.
1696 The default suggested for the target directory depends on the value
1697 of `dired-dwim-target', which see."
1701 ;;;###end dired-cp.el
1702 \f
1703 ;;; 5K
1704 ;;;###begin dired-re.el
1707 ;; Create a new file for each marked file using regexps.
1708 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1709 ;; ARG as in dired-get-marked-files.
1710 ;; Matches each marked file against REGEXP and constructs the new
1711 ;; filename from NEWNAME (like in function replace-match).
1712 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1713 ;; instead of only the non-directory part of the file.
1714 ;; Optional arg MARKER-CHAR as in dired-create-files.
1719 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1720 `!' to %s all remaining matches with no more questions."
1724 ;; Function to construct new filename using REGEXP and NEWNAME:
1729 ;; must bind help-form directly around call to
1730 ;; dired-query
1734 operation-prompt
1735 from
1736 to)
1737 to)
1739 operation from regexp)))))
1740 ;; not whole-name, replace non-directory part only
1751 operation-prompt
1754 to)
1757 rename-regexp-query)
1759 file-creator operation fn-list regexp-name-constructor marker-char)))
1762 ;; Prompt user about performing OPERATION.
1763 ;; Read and return list of: regexp newname arg whole-name.
1776 ;;;###autoload
1778 "Rename selected files whose names match REGEXP to NEWNAME.
1780 With non-zero prefix argument ARG, the command operates on the next ARG
1781 files. Otherwise, it operates on all the marked files, or the current
1782 file if none are marked.
1784 As each match is found, the user must type a character saying
1787 REGEXP defaults to the last regexp used.
1789 With a zero prefix arg, renaming by regexp affects the absolute file name.
1790 Normally, only the non-directory part of the file name is used and changed."
1796 ;;;###autoload
1798 "Copy selected files whose names match REGEXP to NEWNAME.
1799 See function `dired-do-rename-regexp' for more info."
1805 arg regexp newname whole-name dired-keep-marker-copy)))
1807 ;;;###autoload
1809 "Hardlink selected files whose names match REGEXP to NEWNAME.
1810 See function `dired-do-rename-regexp' for more info."
1816 ;;;###autoload
1818 "Symlink selected files whose names match REGEXP to NEWNAME.
1819 See function `dired-do-rename-regexp' for more info."
1827 ;; Perform FILE-CREATOR on the non-directory part of marked files
1828 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1829 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1832 file-creator
1833 operation
1841 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1842 `!' to %s all remaining matches with no more questions."
1849 to))))
1850 dired-keep-marker-rename)))
1855 basename-constructor operation arg))
1857 ;;;###autoload
1859 "Rename all marked (or next ARG) files to upper case."
1863 ;;;###autoload
1865 "Rename all marked (or next ARG) files to lower case."
1869 ;;;###end dired-re.el
1870 \f
1871 ;;; 13K
1872 ;;;###begin dired-ins.el
1874 ;;;###autoload
1876 switches no-error-if-not-dir-p)
1877 "Insert this subdirectory into the same dired buffer.
1879 else inserts it at its natural place (as `ls -lR' would have done).
1880 With a prefix arg, you may edit the ls switches used for this listing.
1881 You can add `R' to the switches to expand the whole tree starting at
1882 this subdirectory.
1883 This function takes some pains to conform to `ls -lR' output.
1885 Dired remembers switches specified with a prefix arg, so that reverting
1886 the buffer will not reset them. However, using `dired-undo' to re-insert
1887 or delete subdirectories can bypass this machinery. Hence, you sometimes
1888 may have to reset some subdirectory switches after a `dired-undo'.
1889 You can reset all subdirectory switches to the default using
1891 See Info node `(emacs)Subdir switches' for more details."
1898 ;; We don't need a marker for opoint as the subdir is always
1899 ;; inserted *after* opoint.
1904 ;; Push mark so that it's easy to find back. Do this after the
1905 ;; insert message so that the user sees the `Mark set' message.
1908 ;;;###autoload
1910 "Insert this subdirectory into the same dired buffer.
1911 If it is already present, overwrites previous entry,
1912 else inserts it at its natural place (as `ls -lR' would have done).
1913 With a prefix arg, you may edit the `ls' switches used for this listing.
1914 You can add `R' to the switches to expand the whole tree starting at
1915 this subdirectory.
1916 This function takes some pains to conform to `ls -lR' output."
1917 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1918 ;; Prospero where dired-ls does the right thing, but
1919 ;; file-directory-p has not been redefined.
1933 switches-have-R mark-alist case-fold-search buffer-read-only)
1936 ;; case-fold-search is nil now, so we can test for capital `R':
1938 ;; avoid duplicated subdirs
1941 ;; If subdir is already present, remove it and remember its marks
1965 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1966 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1979 ;; all switches that make a difference to dired-get-filename:
1983 ;; Add new DIR at NEW-MARKER. Sort alist.
1988 ;; Keep the alist sorted on buffer position.
1996 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1997 Interactively, you can kill DIRNAME as well by using a prefix argument.
1998 In interactive use, the command prompts for DIRNAME.
2000 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2001 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2012 m-alist))
2015 ;; Find pos for new subdir, according to tree order.
2016 ;;(goto-char (point-max))
2024 ;; Insert NEW-DIR after DIR
2026 alist nil)))
2028 ;; want a separating newline between subdirs
2035 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2036 ;; Move to that buffer position. Return a mark-alist.
2039 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2048 ;; Insert ls output after point.
2049 ;; Return the boundary of the inserted text (as list of BEG and END).
2054 dired-subdir-switches
2057 ;; If doing the top level directory of the buffer,
2058 ;; redo it as specified in dired-directory.
2064 ;; Point is at the correct subdir alist position for ELT,
2065 ;; BEG-END is the subdir-region (as list of begin and end).
2067 ;; update its position (should actually be unchanged)
2070 ;; The hook may depend on the subdir-alist containing the just
2071 ;; inserted subdir, so run it after dired-alist-add:
2079 ;; hook may add or delete lines, but the subdir boundary
2080 ;; marker floats
2084 ;; Lexicographic order on file name components, like `ls -lR':
2085 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2086 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2087 ;; or DIR1 and DIR2 are in the same parentdir and their last
2088 ;; components are string-lessp.
2089 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2090 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2091 ;; if dired-actual-switches contained `t'.
2097 components-2
2109 t)
2111 nil)
2114 ;; There should be a builtin split function - inverse to mapconcat.
2116 "Splitting on regexp PAT, turn string STR into a list of substrings.
2117 Optional third arg LIMIT (>= 1) is a limit to the length of the
2118 resulting list.
2119 Thus, if SEP is a regexp that only matches itself,
2121 (mapconcat 'identity (dired-split SEP STRING) SEP)
2123 is always equal to STRING."
2136 start end)
2137 ))
2144 \f
2145 ;;; moving by subdirectories
2147 ;;;###autoload
2149 "Go to previous subdirectory, regardless of level.
2150 When called interactively and not on a subdir line, go to this subdir's line."
2151 ;;(interactive "p")
2155 ;; if on subdir start already, don't stay there!
2165 ;;;###autoload
2167 "Go to end of header line of DIR in this dired buffer.
2168 Return value of point on success, otherwise return nil.
2174 dired-subdir-alist ; table
2175 nil ; predicate
2176 t ; require-match
2183 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2184 ;; at either \r or \n after this function succeeds.
2187 \f
2188 ;;;###autoload
2190 "Mark all files except `.' and `..' in current subdirectory.
2191 If the Dired buffer shows multiple directories, this command
2192 marks the files listed in the subdirectory that point is in."
2197 ;;;###autoload
2199 "Remove all lines of current subdirectory.
2200 Lower levels are unaffected."
2201 ;; With optional REMEMBER-MARKS, return a mark-alist.
2208 buffer-read-only)
2222 ;; Remove DIR from the alist
2226 ;;;###autoload
2228 "Go up ARG levels in the dired tree."
2234 ;;(setq dir (expand-file-name dir))
2238 ;;;###autoload
2240 "Go down in the dired tree."
2254 \f
2255 ;;; hiding
2271 ;;;###autoload
2273 "Hide or unhide the current subdirectory and move to next directory.
2274 Optional prefix arg is a repeat factor.
2284 buffer-read-only)
2285 ;; keep header line visible, hide rest
2294 ;;;###autoload
2296 "Hide all subdirectories, leaving only their header lines.
2297 If there is already something hidden, make everything visible again.
2302 buffer-read-only)
2306 ;; unhide - bombs on \r in filenames
2308 ;; hide
2315 ;; we're somewhere on current dir's line
2323 ;;;###end dired-ins.el
2325 \f
2326 ;; Search only in file names in the Dired buffer.
2329 "Non-nil to Isearch in file names only.
2330 If t, Isearch in Dired always matches only file names.
2331 If `dwim', Isearch matches file names when initial point position is on
2332 a file name. Otherwise, it searches the whole buffer without restrictions."
2342 "Toggle file names searching on or off.
2343 When on, Isearch skips matches outside file names using the predicate
2344 `dired-isearch-filter-filenames' that matches only at file names.
2345 When off, it uses the original predicate."
2349 dired-isearch-filter-predicate-orig
2354 ;;;###autoload
2356 "Set up isearch to search in Dired file names.
2357 Intended to be added to `isearch-mode-hook'."
2369 "Clean up the Dired file name search after terminating isearch."
2376 "Test whether the current search hit is a visible file name.
2377 Return non-nil if the text from BEG to END is part of a file
2378 name (has the text property `dired-filename') and is visible."
2383 t)))
2385 ;;;###autoload
2387 "Search for a string using Isearch only in file names in the Dired buffer."
2392 ;;;###autoload
2394 "Search for a regexp using Isearch only in file names in the Dired buffer."
2399 \f
2400 ;; Functions for searching in tags style among marked files.
2402 ;;;###autoload
2404 "Search for a string through all marked files using Isearch."
2409 ;;;###autoload
2411 "Search for a regexp through all marked files using Isearch."
2416 ;;;###autoload
2418 "Search through all marked files for a match for REGEXP.
2419 Stops when a match is found.
2424 ;;;###autoload
2426 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2427 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2438 buffer-read-only))
2445 \f
2446 ;;;###autoload
2448 "Print the type of FILE, according to the `file' command.
2449 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2450 true then the type of the file linked to by FILE is printed instead."
2463 ;; Local Variables:
2464 ;; byte-compile-dynamic: t
2465 ;; generated-autoload-file: "dired.el"
2466 ;; End:
2468 ;;; dired-aux.el ends here