| blob | 28b285f8b1fa8705e4aa3c1535591b1ecd6be0b1 |
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
7 ;; Maintainer: FSF
8 ;; Keywords: files
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; The parts of dired mode not normally used. This is a space-saving hack
28 ;; to avoid having to load a large mode when all that's wanted are a few
29 ;; functions.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
37 ;; We need macros in dired.el to compile properly,
38 ;; and we call subroutines in it too.
42 "Variable where `dired-create-files' records failing file names.
43 Functions that operate recursively can store additional names
46 ;;; 15K
47 ;;;###begin dired-cmd.el
48 ;; Diffing and compressing
53 ;;;###autoload
55 "Compare file at point with file FILE using `diff'.
56 FILE defaults to the file at the mark. (That's the mark set by
58 The prompted-for file is the first file given to `diff'.
59 With prefix arg, prompt for second argument SWITCHES,
60 which is options for `diff'."
63 ;; Get the file at the mark.
67 ;; Use it as default if it's not the same as the current file,
68 ;; and the target dir is the current dir or the mark is active.
72 mark-active))
73 file-at-mark))
87 target-dir default t))
91 diff-switches
102 ;;;###autoload
104 "Diff this file with its backup file or vice versa.
105 Uses the latest backup, if there are several numerical backups.
106 If this file is a backup, diff it with its original.
107 The backup file is the first file given to `diff'.
108 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
113 diff-switches
115 nil))
118 ;;;###autoload
120 "Mark files with different file attributes in two dired buffers.
121 Compare file attributes of files in the current directory
122 with file attributes in directory DIR2 using PREDICATE on pairs of files
123 with the same name. Mark files for which PREDICATE returns non-nil.
124 Mark files with different names if PREDICATE is nil (or interactively
125 with empty input at the predicate prompt).
127 PREDICATE is a Lisp expression that can refer to the following variables:
129 size1, size2 - file size in bytes
130 mtime1, mtime2 - last modification time in seconds, as a float
131 fa1, fa2 - list of file attributes
132 returned by function `file-attributes'
134 where 1 refers to attribute of file in the current dired buffer
135 and 2 to attribute of file in second dired buffer.
137 Examples of PREDICATE:
139 (> mtime1 mtime2) - mark newer files
140 (not (= size1 size2)) - mark files with different sizes
141 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
142 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
143 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
154 target-dir target-dir t)))
159 file-list1 file-list2)
165 'cadr
167 file-alist1 file-alist2
168 predicate))
170 'cadr
172 file-alist2 file-alist1
173 predicate)))
175 dir1 nil
180 dir2 nil
189 "Combine LIST1 and LIST2 using a set-difference operation.
190 The result list contains all file items that appear in LIST1 but not LIST2.
191 This is a non-destructive function; it makes a copy of the data if necessary
192 to avoid corrupting the original LIST1 and LIST2.
193 PREDICATE (see `dired-compare-directories') is an additional match
194 condition. Two file items are considered to match if they are equal
195 *and* PREDICATE evaluates to t."
197 list1
213 list)
218 "Return a list of all file names and attributes from DIR.
219 List has a form of (file-name full-file-name (attribute-list))."
224 full-file-name
227 \f
230 "Create initial input value for `touch' command."
241 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
242 ;; refresh their file lines.
243 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
244 ;; PROGRAM is the program used to change the attribute.
245 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
246 ;; ARG describes which files to use, as in dired-get-marked-files.
252 op-symbol arg files))
254 failures)
265 files))
270 nil))))
272 ;;;###autoload
274 "Change the mode of the marked (or next ARG) files.
275 Symbolic modes like `g+w' are allowed."
290 "Change mode of %s to: " nil
296 file
301 ;;;###autoload
303 "Change the group of the marked (or next ARG) files."
309 ;;;###autoload
311 "Change the owner of the marked (or next ARG) files."
317 ;;;###autoload
319 "Change the timestamp of the marked (or next ARG) files.
320 This calls touch."
324 ;; Process all the files in FILES in batches of a convenient size,
325 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
326 ;; Batches are chosen to need less than MAX chars for the file names,
327 ;; allowing 3 extra characters of separator per file name.
330 past
332 failures)
333 ;; Accumulate files as long as they fit in MAX chars,
334 ;; then process the ones accumulated so far.
339 ;; If we have at least 1 pending file
340 ;; and this file won't fit in the length limit, process now.
343 ;; The elements of PENDING are now in forward order.
344 ;; Do the operation and record failures.
346 failures)
347 ;; Transfer the elemens of PENDING onto PAST
348 ;; and clear it out. Now PAST contains the first N files
349 ;; specified (for some N), and FILES contains the rest.
351 pending nil
353 ;; Do (setq pending (cons thisfile pending))
354 ;; but reuse the cons that was in `files'.
362 failures)
363 ;; Now the original list FILES has been put back as it was.
366 ;;;###autoload
368 "Print the marked (or next ARG) files.
369 Uses the shell command coming from variables `lpr-command' and
370 `lpr-switches' as default."
374 "Print %s with: "
379 lpr-switches))
384 ;; Read arguments for a marked-files command that wants a string
385 ;; that is not a file name,
386 ;; perhaps popping up the list of marked files.
387 ;; ARG is the prefix arg and indicates whether the files came from
388 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
389 ;; If the current file was used, the list has but one element and ARG
390 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
393 ;; PROMPT for a string, with INITIAL input and DEFAULT value.
394 ;; Other args are used to give user feedback and pop-up:
395 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
397 nil op-symbol files
400 \f
401 ;;; Cleaning a directory: flagging some backups for deletion.
405 ;;;###autoload
407 "Flag numerical backups for deletion.
408 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
409 Positive prefix arg KEEP overrides `dired-kept-versions';
410 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
413 with a prefix argument."
420 late-retention early-retention)
421 ;; Look at each file.
422 ;; If the file has numeric backup versions,
423 ;; put on dired-file-version-alist an element of the form
424 ;; (FILENAME . VERSION-NUMBER-LIST)
426 ;; Sort each VERSION-NUMBER-LIST,
427 ;; and remove the versions not to be deleted.
435 sorted-v-list)))
439 ;; Look at each file. If it is a numeric backup file,
440 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
444 ;;; Subroutines of dired-clean-directory.
447 ;; Perform FUN with point at the end of each non-directory line.
448 ;; FUN takes one argument, the absolute filename.
463 ;; Only do work if this file is not already in the alist.
465 nil
466 ;; If it looks like file FN has versions, return a list of the versions.
467 ;;That is a list of strings which are file names.
468 ;;The caller may want to flag some of these files for deletion.
473 base-versions
479 dired-file-version-alist)))))))
483 base-version-list)
493 \f
494 ;;; Shell commands
499 "Return a list of all commands associated with current dired files.
500 This function is used to add all related commands retrieved by `mailcap'
501 to the end of the list of defaults just after the default value."
509 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
511 "Read a dired shell command prompting with PROMPT (using `read-shell-command').
512 ARG is the prefix arg and may be used to indicate in the prompt which
513 FILES are affected."
519 nil 'shell files
520 #'read-shell-command
522 nil nil)))
524 ;;;###autoload
526 "Run a shell command COMMAND on the marked files asynchronously.
528 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
529 adds `* &' surrounded by whitespace and executes the command asynchronously.
530 The output appears in the buffer `*Async Shell Command*'."
534 ;; Want to give feedback whether this file or marked files are used:
536 current-prefix-arg
537 files)))
544 ;; The in-background argument is only needed in Emacs 18 where
545 ;; shell-command doesn't understand an appended ampersand `&'.
546 ;;;###autoload
548 "Run a shell command COMMAND on the marked files.
549 If no files are marked or a specific numeric prefix arg is given,
551 The prompt mentions the file(s) or the marker, as appropriate.
553 If there is a `*' in COMMAND, surrounded by whitespace, this runs
554 COMMAND just once with the entire file list substituted there.
556 If there is no `*', but there is a `?' in COMMAND, surrounded by
557 whitespace, this runs COMMAND on each file individually with the
558 file name substituted for `?'.
560 Otherwise, this runs COMMAND on each file individually with the
561 file name added at the end of COMMAND (separated by a space).
563 `*' and `?' when not surrounded by whitespace have no special
564 significance for `dired-do-shell-command', and are passed through
565 normally to the shell, but you must confirm first. To pass `*' by
568 If COMMAND produces output, it goes to a separate buffer.
570 This feature does not try to redisplay Dired buffers afterward, as
571 there's no telling what files COMMAND may have changed.
574 When COMMAND runs, its working directory is the top-level directory
575 of the Dired buffer, so output files usually are created there
576 instead of in a subdir.
578 In a noninteractive call (from Lisp code), you must specify
579 the list of file names explicitly with the FILE-LIST argument, which
580 can be produced by `dired-get-marked-files', for example."
581 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
582 ;;actual work and can be redefined for customization.
586 ;; Want to give feedback whether this file or marked files are used:
589 current-prefix-arg
590 files)
591 current-prefix-arg
592 files)))
597 ;; Get confirmation for wildcards that may have been meant
598 ;; to control substitution of a file name or the file name list.
612 nil
613 file-list)
614 ;; execute the shell command
618 ;; Might use {,} for bash or csh:
627 ;; "Make up a shell command line from COMMAND and FILE-LIST.
628 ;; If ON-EACH is t, COMMAND should be applied to each file, else
629 ;; simply concat all files and apply COMMAND to this.
630 ;; FILE-LIST's elements will be quoted for the shell."
631 ;; Might be redefined for smarter things and could then use RAW-ARG
632 ;; (coming from interactive P and currently ignored) to decide what to do.
633 ;; Smart would be a way to access basename or extension of file names.
642 retval))
647 file-list dired-mark-separator)))
652 ;; This is an extra function so that it can be redefined by ange-ftp.
653 ;;;###autoload
660 ;; Return nil for sake of nconc in dired-bunch-files.
661 nil)
662 \f
665 ; "Display MSG while running PROGRAM, and check for output.
666 ;Remaining arguments are strings passed as command arguments to PROGRAM.
667 ; On error, insert output
668 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
669 ; Caller can cons up a list of failed args.
670 ;Else returns nil for success."
674 ;; Get a clean buffer for error output:
687 nil))))
688 \f
689 ;; Commands that delete or redisplay part of the dired buffer.
710 ;;;###autoload
712 "Kill all marked lines (not the files).
713 With a prefix argument, kill that many lines starting with the current line.
714 \(A negative argument kills backward.)
715 If you use this command with a prefix argument to kill the line
716 for a file that is a directory, which you have inserted in the
717 Dired buffer as a subdirectory, then it deletes that subdirectory
718 from the buffer as well.
719 To kill an entire subdirectory \(without killing its line in the
720 parent directory), go to its directory header line and use this
721 command with a prefix argument (the value does not matter)."
722 ;; Returns count of killed lines. FMT="" suppresses message.
740 count))))
742 ;;;###end dired-cmd.el
743 \f
744 ;;; 30K
745 ;;;###begin dired-cp.el
748 ;; Compress or uncompress the current file.
749 ;; Return nil for success, offending filename else.
755 ;; Remove any preexisting entry for the name NEW-FILE.
760 ;; Now replace the current line with an entry for NEW-FILE.
763 from-file)))
769 ;; For .z, try gunzip. It might be an old gzip file,
770 ;; or it might be from compact? pack? (which?) but gunzip handles both.
776 ;; This item controls naming for compression.
778 "Control changes in file name suffixes for compression and uncompression.
779 Each element specifies one transformation rule, and has the form:
780 (REGEXP NEW-SUFFIX PROGRAM)
781 The rule applies when the old file name matches REGEXP.
782 The new file name is computed by deleting the part that matches REGEXP
783 (as well as anything after that), then adding NEW-SUFFIX in its place.
784 If PROGRAM is non-nil, the rule is an uncompression rule,
785 and uncompression is done by running PROGRAM.
788 ;;;###autoload
790 ;; Compress or uncompress FILE.
791 ;; Return the name of the compressed or uncompressed file.
792 ;; Return nil if no change in files.
794 suffix newname
796 ;; See if any suffix rule matches this file name.
802 ;; If so, compute desired new name.
809 nil)
811 ;; We found an uncompression rule.
814 newname))
816 ;;; We don't recognize the file as compressed, so compress it.
817 ;;; Try gzip; if we don't have that, use compress.
823 out-name)))
828 ;; Rename the compressed file to NEWNAME
829 ;; if it hasn't got that name already.
833 newname)
834 out-name)))
838 ;; Don't use NEWNAME with `compress'.
840 \f
842 ;; Request confirmation from the user that the operation described
843 ;; by OP-SYMBOL is to be performed on the marked files.
844 ;; Confirmation consists in a y-or-n question with a file list
845 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
846 ;; The files used are determined by ARG (as in dired-get-marked-files).
849 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
850 ;; is marked pops up a window. That will help the user see
851 ;; it isn't the current line file.
860 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
861 ; and display failures.
863 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
864 ; the short form of the filename) for a failure and probably logs a
865 ; detailed error explanation using function `dired-log'.
867 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
868 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
869 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
870 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
872 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
884 ;; end this bunch of errors:
888 failures)))))
895 ;; None of these keys quit - use C-g for that.
896 ))
898 ;;;###autoload
900 "Query user and return nil or t.
901 Store answer in symbol VAR (which must initially be bound to nil).
902 Format PROMPT with ARGS.
903 Binding variable `help-form' will help the user who types the help key."
919 done result elt)
925 ;; read-event returns -1 if we are in a kbd
926 ;; macro and there are no more events in the
927 ;; macro. Attempt to get an event
928 ;; interactively.
934 dired-query-alist)))))))
935 ;; Display the question with the answer.
939 \f
940 ;;;###autoload
942 "Compress or uncompress marked (or next ARG) files."
946 ;; Commands for Emacs Lisp files - load and byte compile
949 ;; Return nil for success, offending file name else.
951 elc-file buffer-read-only failure)
966 nil)))
968 ;;;###autoload
970 "Byte compile marked (or next ARG) Emacs Lisp files."
975 ;; Return nil for success, offending file name else.
981 nil
985 ;;;###autoload
987 "Load the marked (or next ARG) Emacs Lisp files."
991 ;;;###autoload
993 "Redisplay all marked (or next ARG) files.
994 If on a subdir line, redisplay that subdirectory. In that case,
995 a prefix arg lets you edit the `ls' switches used for the new listing.
997 Dired remembers switches specified with a prefix arg, so that reverting
998 the buffer will not reset them. However, using `dired-undo' to re-insert
999 or delete subdirectories can bypass this machinery. Hence, you sometimes
1000 may have to reset some subdirectory switches after a `dired-undo'.
1001 You can reset all subdirectory switches to the default using
1003 See Info node `(emacs)Subdir switches' for more details."
1004 ;; Moves point if the next ARG files are redisplayed.
1010 dir
1014 dired-subdir-switches
1015 dired-actual-switches)))))
1017 ;; message much faster than making dired-map-over-marks show progress
1021 ;; Postphone readin hook till we map
1022 ;; over all marked files (Bug#6810).
1026 arg)
1032 "Set `dired-switches-alist' to nil and revert dired buffer."
1036 \f
1038 ;; Delete the current line, and insert an entry for FILE.
1039 ;; If FILE is nil, then just delete the current line.
1040 ;; Keeps any marks that may be present in column one (doing this
1041 ;; here is faster than with dired-add-entry's optional arg).
1042 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1050 ;; Replace space by old marker without moving point.
1051 ;; Faster than goto+insdel inside a save-excursion?
1055 ;;;###autoload
1062 ;; Add a new entry for FILENAME, optionally marking it
1063 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
1064 ;; Note that this adds the entry `out of order' if files sorted by
1065 ;; time, etc.
1066 ;; At least this version inserts in the right subdirectory (if present).
1067 ;; And it skips "." or ".." (see `dired-trivial-filenames').
1068 ;; Hidden subdirs are exposed if a file is added there.
1070 ;; Entry is always for files, even if they happen to also be directories
1075 reason)
1080 reason
1087 ;; We are already where we should be, except when
1088 ;; point is before the subdir line or its total line.
1092 ;; else try to find correct place to insert
1097 ;; found - skip subdir and `total' line
1098 ;; and uninteresting files like . and ..
1099 ;; This better not moves into the next subdir!
1101 ;; not found
1106 ;; Don't expand `.'. Show just the file name within directory.
1112 ;; Put in desired marker char.
1117 ;; Compensate for a bug in ange-ftp.
1118 ;; It inserts the file's absolute name, rather than
1119 ;; the relative one. That may be hard to fix since it
1120 ;; is probably controlled by something in ftp.
1143 ;; return nil if all went well
1144 nil))
1150 ;; Return pos of first file line of DIR, skipping header and total
1151 ;; or wildcard lines.
1152 ;; Important: never moves into the next subdir.
1153 ;; DIR is assumed to be unhidden.
1162 ;;;###autoload
1175 ;;;###autoload
1177 "Create or update the line for FILE in all Dired buffers it would belong in."
1183 ;; Relist the line for FILE, or just add it if it did not exist.
1184 ;; FILE must be an absolute file name.
1186 ;; If cursor is already on FILE's line delete-region will cause
1187 ;; save-excursion to fail because of floating makers,
1188 ;; moving point to beginning of line. Sigh.
1197 \f
1198 ;;; Copy, move/rename, making hard and symbolic links
1201 "Non-nil if Dired should ask about making backups before overwriting files.
1202 Special value `always' suppresses confirmation."
1208 ;; This is a fluid var used in dired-handle-overwrite. It should be
1209 ;; let-bound whenever dired-copy-file etc are called. See
1210 ;; dired-create-files for an example.
1214 ;; Save old version of file TO that is to be overwritten.
1215 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1216 ;; from dired-create-files.
1219 dired-overwrite-confirmed
1223 "Make backup for existing file `%s'? "
1224 to)))
1228 ;;;###autoload
1232 dired-recursive-copies))
1237 preserve-time top recursive)
1239 dirfailed)
1244 ;; This is a directory.
1246 ;; Not a directory.
1250 ;; It is a symlink
1255 dired-create-files-failures)
1258 ;;;###autoload
1262 ;; Silently rename the visited file of any buffer visiting this file.
1267 ;; See if it's an inserted subdir, and rename that, too.
1275 ;; Update visited file name of all affected buffers
1285 to-dir
1286 buffer-file-name)))
1292 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1293 ;; one of its subdirectories is expanded in this buffer.
1301 ;; ELT's subdir is affected by the rename
1304 ;; if top level directory was renamed, lots of things have to be
1305 ;; updated:
1310 ;; with and without wildcards
1312 to))
1315 ;; try to rename buffer, but just leave old name if new
1316 ;; name would already exist (don't try appending "<%d>")
1319 ;; ... we dired TO now:
1323 ;; Update the headerline and dired-subdir-alist element, as well as
1324 ;; dired-switches-alist element, of directory described by
1325 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1326 ;; describes either DIR itself or a subdir of DIR.
1330 buffer-read-only)
1332 ;; Update subdir headerline in buffer
1335 dir)
1340 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1346 \f
1347 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1351 ;; Create a new file for each from a list of existing files. The user
1352 ;; is queried, dired buffers are updated, and at the end a success or
1353 ;; failure message is displayed
1355 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1357 ;; It is called for each file and must create newfile, the entry of
1358 ;; which will be added. The user will be queried if the file already
1359 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1360 ;; rename), it is FILE-CREATOR's responsibility to update dired
1361 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1362 ;; could not create newfile. The error is caught and logged.
1364 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1365 ;; operation performed. It is used for error logging.
1367 ;; FN-LIST is the list of files to copy (full absolute file names).
1369 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1370 ;; skip. If it skips files for other reasons than a direct user
1371 ;; query, it is supposed to tell why (using dired-log).
1373 ;; Optional MARKER-CHAR is a character with which to mark every
1374 ;; newfile's entry, or t to use the current marker character if the
1375 ;; oldfile was marked.
1394 Type SPC or `y' to overwrite file `%s',
1395 DEL or `n' to skip to next,
1396 ESC or `q' to not overwrite any of the remaining files,
1400 ;; must determine if FROM is marked before file-creator
1401 ;; gets a chance to delete it (in case of a move).
1410 ;; If we get here, file-creator hasn't been aborted
1411 ;; and the old entry (if any) has to be deleted
1412 ;; before adding the new entry.
1420 failures)
1422 operation from to err))))))))
1430 total)
1431 failures))
1437 failures))
1443 skipped))
1448 \f
1450 &optional marker-char op1
1451 how-to)
1452 "Create a new file for each marked file.
1453 Prompts user for target, which is a directory in which to create
1454 the new files. Target may also be a plain file if only one marked
1455 file exists. The way the default for the target directory is
1456 computed depends on the value of `dired-dwim-target-directory'.
1457 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1458 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1459 FILE-CREATOR and OPERATION as in `dired-create-files'.
1460 ARG as in `dired-get-marked-files'.
1461 Optional arg MARKER-CHAR as in `dired-create-files'.
1462 Optional arg OP1 is an alternate form for OPERATION if there is
1463 only one file.
1464 Optional arg HOW-TO determiness how to treat the target.
1465 If HOW-TO is nil, use `file-directory-p' to determine if the
1466 target is a directory. If so, the marked file(s) are created
1467 inside that directory. Otherwise, the target is a plain file;
1468 an error is raised unless there is exactly one marked file.
1469 If HOW-TO is t, target is always treated as a plain file.
1470 Otherwise, HOW-TO should be a function of one argument, TARGET.
1471 If its return value is nil, TARGET is regarded as a plain file.
1472 If it return value is a list, TARGET is a generalized
1473 directory (e.g. some sort of archive). The first element of
1474 this list must be a function with at least four arguments:
1475 operation - as OPERATION above.
1476 rfn-list - list of the relative names for the marked files.
1477 fn-list - list of the absolute names for the marked files.
1478 target - the name of the target itself.
1479 The rest of into-dir are optional arguments.
1480 For any other return value, TARGET is treated as a directory."
1489 target-dir)))
1498 target-dir op-symbol arg rfn-list default))))
1500 ;; Allow DOS/Windows users to change the letter
1501 ;; case of a directory. If we don't test these
1502 ;; conditions up front, file-directory-p below
1503 ;; will return t because the filesystem is
1504 ;; case-insensitive, and Emacs will try to move
1505 ;; foo -> foo/foo, which fails.
1508 dired-one-file
1516 nil
1524 ;; rename-file bombs when moving directories unless we do this:
1527 file-creator operation fn-list
1529 ;; This function uses fluid variable target when called
1530 ;; inside dired-create-files:
1535 marker-char))))
1537 ;; Read arguments for a marked-files command that wants a file name,
1538 ;; perhaps popping up the list of marked files.
1539 ;; ARG is the prefix arg and indicates whether the files came from
1540 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1541 ;; If the current file was used, the list has but one element and ARG
1542 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1543 ;; DEFAULT is the default value to return if the user just hits RET;
1544 ;; if it is omitted or nil, then the name of the directory is used.
1549 nil op-symbol files
1554 ;; Try to guess which target directory the user may want.
1555 ;; If there is a dired buffer displayed in one of the next windows,
1556 ;; use its current subdir, else use current subdir of this dired buffer.
1559 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1570 this-dir)))
1573 ;; Return a list of default values for file-reading functions in Dired.
1574 ;; This list may contain directories from Dired buffers in other windows.
1575 ;; `fn-list' is a list of file names used to build a list of defaults.
1576 ;; When nil or more than one element, a list of defaults will
1577 ;; contain only directory names. `target-dir' is a directory name
1578 ;; to exclude from the returned list, for the case when this
1579 ;; directory name is already presented in initial input.
1580 ;; For Dired operations that support `dired-dwim-target',
1581 ;; the argument `target-dir' should have the value returned
1582 ;; from `dired-dwim-target-directory'.
1587 dired-dirs)
1588 ;; Get a list of directories of visible buffers in dired-mode.
1593 ;; Force the current dir to be the first in the list.
1596 ;; Remove the target dir (if specified) or the current dir from
1597 ;; default values, because it should be already in initial input.
1599 ;; Return a list of default values.
1601 ;; For one file operation, provide a list that contains
1602 ;; other directories, other directories with the appended filename
1603 ;; and the current directory with the appended filename, e.g.
1604 ;; 1. /TARGET-DIR/
1605 ;; 2. /TARGET-DIR/FILENAME
1606 ;; 3. /CURRENT-DIR/FILENAME
1615 ;; For multi-file operation, return only a list of other directories.
1616 dired-dirs)))
1618 \f
1619 ;;;###autoload
1621 "Create a directory called DIRECTORY."
1626 ;; Find the topmost nonexistent parent dir (variable `new')
1638 ;; This may not always be what you want, especially if target is your
1639 ;; home directory and it happens to be a symbolic link, as is often the
1640 ;; case with NFS and automounters. Or if you want to make symlinks
1641 ;; into directories that themselves are only symlinks, also quite
1642 ;; common.
1644 ;; So we don't use this function as value for HOW-TO in
1645 ;; dired-do-symlink, which has the minor disadvantage of
1646 ;; making links *into* a symlinked-dir, when you really wanted to
1647 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1648 ;; just have to remove that symlink by hand before making your marked
1649 ;; symlinks.
1652 "Either nil or a function used by `dired-do-copy' to determine target.
1655 ;;;###autoload
1657 "Copy all marked (or next ARG) files, or copy the current file.
1658 This normally preserves the last-modified date when copying.
1659 When operating on just the current file, you specify the new name.
1660 When operating on multiple or marked files, you specify a directory,
1661 and new copies of these files are made in that directory
1662 with the same names that the files currently have. The default
1663 suggested for the target directory depends on the value of
1664 `dired-dwim-target', which see.
1666 This command copies symbolic links by creating new ones,
1667 like `cp -d'."
1671 "Copy"
1672 arg dired-keep-marker-copy
1673 nil dired-copy-how-to-fn)))
1675 ;;;###autoload
1677 "Make symbolic links to current file or all marked (or next ARG) files.
1678 When operating on just the current file, you specify the new name.
1679 When operating on multiple or marked files, you specify a directory
1680 and new symbolic links are made in that directory
1681 with the same names that the files currently have. The default
1682 suggested for the target directory depends on the value of
1683 `dired-dwim-target', which see.
1690 ;;;###autoload
1692 "Add names (hard links) current file or all marked (or next ARG) files.
1693 When operating on just the current file, you specify the new name.
1694 When operating on multiple or marked files, you specify a directory
1695 and new hard links are made in that directory
1696 with the same names that the files currently have. The default
1697 suggested for the target directory depends on the value of
1698 `dired-dwim-target', which see."
1705 ;; error is caught in -create-files
1707 ;; Update the link count
1710 ;;;###autoload
1712 "Rename current file or all marked (or next ARG) files.
1713 When renaming just the current file, you specify the new name.
1714 When renaming multiple or marked files, you specify a directory.
1715 This command also renames any buffers that are visiting the files.
1716 The default suggested for the target directory depends on the value
1717 of `dired-dwim-target', which see."
1721 ;;;###end dired-cp.el
1722 \f
1723 ;;; 5K
1724 ;;;###begin dired-re.el
1727 ;; Create a new file for each marked file using regexps.
1728 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1729 ;; ARG as in dired-get-marked-files.
1730 ;; Matches each marked file against REGEXP and constructs the new
1731 ;; filename from NEWNAME (like in function replace-match).
1732 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1733 ;; instead of only the non-directory part of the file.
1734 ;; Optional arg MARKER-CHAR as in dired-create-files.
1739 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1740 `!' to %s all remaining matches with no more questions."
1744 ;; Function to construct new filename using REGEXP and NEWNAME:
1749 ;; must bind help-form directly around call to
1750 ;; dired-query
1754 operation-prompt
1755 from
1756 to)
1757 to)
1759 operation from regexp)))))
1760 ;; not whole-name, replace non-directory part only
1771 operation-prompt
1774 to)
1777 rename-regexp-query)
1779 file-creator operation fn-list regexp-name-constructor marker-char)))
1782 ;; Prompt user about performing OPERATION.
1783 ;; Read and return list of: regexp newname arg whole-name.
1796 ;;;###autoload
1798 "Rename selected files whose names match REGEXP to NEWNAME.
1800 With non-zero prefix argument ARG, the command operates on the next ARG
1801 files. Otherwise, it operates on all the marked files, or the current
1802 file if none are marked.
1804 As each match is found, the user must type a character saying
1807 REGEXP defaults to the last regexp used.
1809 With a zero prefix arg, renaming by regexp affects the absolute file name.
1810 Normally, only the non-directory part of the file name is used and changed."
1816 ;;;###autoload
1818 "Copy selected files whose names match REGEXP to NEWNAME.
1819 See function `dired-do-rename-regexp' for more info."
1825 arg regexp newname whole-name dired-keep-marker-copy)))
1827 ;;;###autoload
1829 "Hardlink selected files whose names match REGEXP to NEWNAME.
1830 See function `dired-do-rename-regexp' for more info."
1836 ;;;###autoload
1838 "Symlink selected files whose names match REGEXP to NEWNAME.
1839 See function `dired-do-rename-regexp' for more info."
1847 ;; Perform FILE-CREATOR on the non-directory part of marked files
1848 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1849 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1852 file-creator
1853 operation
1861 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1862 `!' to %s all remaining matches with no more questions."
1869 to))))
1870 dired-keep-marker-rename)))
1875 basename-constructor operation arg))
1877 ;;;###autoload
1879 "Rename all marked (or next ARG) files to upper case."
1883 ;;;###autoload
1885 "Rename all marked (or next ARG) files to lower case."
1889 ;;;###end dired-re.el
1890 \f
1891 ;;; 13K
1892 ;;;###begin dired-ins.el
1894 ;;;###autoload
1896 switches no-error-if-not-dir-p)
1897 "Insert this subdirectory into the same dired buffer.
1899 else inserts it at its natural place (as `ls -lR' would have done).
1900 With a prefix arg, you may edit the ls switches used for this listing.
1901 You can add `R' to the switches to expand the whole tree starting at
1902 this subdirectory.
1903 This function takes some pains to conform to `ls -lR' output.
1905 Dired remembers switches specified with a prefix arg, so that reverting
1906 the buffer will not reset them. However, using `dired-undo' to re-insert
1907 or delete subdirectories can bypass this machinery. Hence, you sometimes
1908 may have to reset some subdirectory switches after a `dired-undo'.
1909 You can reset all subdirectory switches to the default using
1911 See Info node `(emacs)Subdir switches' for more details."
1918 ;; We don't need a marker for opoint as the subdir is always
1919 ;; inserted *after* opoint.
1924 ;; Push mark so that it's easy to find back. Do this after the
1925 ;; insert message so that the user sees the `Mark set' message.
1928 ;;;###autoload
1930 "Insert this subdirectory into the same dired buffer.
1931 If it is already present, overwrites previous entry,
1932 else inserts it at its natural place (as `ls -lR' would have done).
1933 With a prefix arg, you may edit the `ls' switches used for this listing.
1934 You can add `R' to the switches to expand the whole tree starting at
1935 this subdirectory.
1936 This function takes some pains to conform to `ls -lR' output."
1937 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1938 ;; Prospero where dired-ls does the right thing, but
1939 ;; file-directory-p has not been redefined.
1953 switches-have-R mark-alist case-fold-search buffer-read-only)
1956 ;; case-fold-search is nil now, so we can test for capital `R':
1958 ;; avoid duplicated subdirs
1961 ;; If subdir is already present, remove it and remember its marks
1985 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1986 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1999 ;; all switches that make a difference to dired-get-filename:
2003 ;; Add new DIR at NEW-MARKER. Sort alist.
2008 ;; Keep the alist sorted on buffer position.
2016 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2017 Interactively, you can kill DIRNAME as well by using a prefix argument.
2018 In interactive use, the command prompts for DIRNAME.
2020 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2021 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2032 m-alist))
2035 ;; Find pos for new subdir, according to tree order.
2036 ;;(goto-char (point-max))
2044 ;; Insert NEW-DIR after DIR
2046 alist nil)))
2048 ;; want a separating newline between subdirs
2055 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2056 ;; Move to that buffer position. Return a mark-alist.
2059 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2068 ;; Insert ls output after point.
2069 ;; Return the boundary of the inserted text (as list of BEG and END).
2074 dired-subdir-switches
2077 ;; If doing the top level directory of the buffer,
2078 ;; redo it as specified in dired-directory.
2084 ;; Point is at the correct subdir alist position for ELT,
2085 ;; BEG-END is the subdir-region (as list of begin and end).
2087 ;; update its position (should actually be unchanged)
2090 ;; The hook may depend on the subdir-alist containing the just
2091 ;; inserted subdir, so run it after dired-alist-add:
2099 ;; hook may add or delete lines, but the subdir boundary
2100 ;; marker floats
2104 ;; Lexicographic order on file name components, like `ls -lR':
2105 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2106 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2107 ;; or DIR1 and DIR2 are in the same parentdir and their last
2108 ;; components are string-lessp.
2109 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2110 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2111 ;; if dired-actual-switches contained `t'.
2117 components-2
2129 t)
2131 nil)
2134 ;; There should be a builtin split function - inverse to mapconcat.
2136 "Splitting on regexp PAT, turn string STR into a list of substrings.
2137 Optional third arg LIMIT (>= 1) is a limit to the length of the
2138 resulting list.
2139 Thus, if SEP is a regexp that only matches itself,
2141 (mapconcat 'identity (dired-split SEP STRING) SEP)
2143 is always equal to STRING."
2156 start end)
2157 ))
2164 \f
2165 ;;; moving by subdirectories
2167 ;;;###autoload
2169 "Go to previous subdirectory, regardless of level.
2170 When called interactively and not on a subdir line, go to this subdir's line."
2171 ;;(interactive "p")
2175 ;; if on subdir start already, don't stay there!
2185 ;;;###autoload
2187 "Go to end of header line of DIR in this dired buffer.
2188 Return value of point on success, otherwise return nil.
2194 dired-subdir-alist ; table
2195 nil ; predicate
2196 t ; require-match
2203 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2204 ;; at either \r or \n after this function succeeds.
2207 \f
2208 ;;;###autoload
2210 "Mark all files except `.' and `..' in current subdirectory.
2211 If the Dired buffer shows multiple directories, this command
2212 marks the files listed in the subdirectory that point is in."
2217 ;;;###autoload
2219 "Remove all lines of current subdirectory.
2220 Lower levels are unaffected."
2221 ;; With optional REMEMBER-MARKS, return a mark-alist.
2228 buffer-read-only)
2242 ;; Remove DIR from the alist
2246 ;;;###autoload
2248 "Go up ARG levels in the dired tree."
2254 ;;(setq dir (expand-file-name dir))
2258 ;;;###autoload
2260 "Go down in the dired tree."
2274 \f
2275 ;;; hiding
2291 ;;;###autoload
2293 "Hide or unhide the current subdirectory and move to next directory.
2294 Optional prefix arg is a repeat factor.
2304 buffer-read-only)
2305 ;; keep header line visible, hide rest
2314 ;;;###autoload
2316 "Hide all subdirectories, leaving only their header lines.
2317 If there is already something hidden, make everything visible again.
2322 buffer-read-only)
2326 ;; unhide - bombs on \r in filenames
2328 ;; hide
2335 ;; we're somewhere on current dir's line
2343 ;;;###end dired-ins.el
2345 \f
2346 ;; Search only in file names in the Dired buffer.
2349 "Non-nil to Isearch in file names only.
2350 If t, Isearch in Dired always matches only file names.
2351 If `dwim', Isearch matches file names when initial point position is on
2352 a file name. Otherwise, it searches the whole buffer without restrictions."
2362 "Toggle file names searching on or off.
2363 When on, Isearch skips matches outside file names using the predicate
2364 `dired-isearch-filter-filenames' that matches only at file names.
2365 When off, it uses the original predicate."
2369 dired-isearch-filter-predicate-orig
2374 ;;;###autoload
2376 "Set up isearch to search in Dired file names.
2377 Intended to be added to `isearch-mode-hook'."
2389 "Clean up the Dired file name search after terminating isearch."
2396 "Test whether the current search hit is a visible file name.
2397 Return non-nil if the text from BEG to END is part of a file
2398 name (has the text property `dired-filename') and is visible."
2403 t)))
2405 ;;;###autoload
2407 "Search for a string using Isearch only in file names in the Dired buffer."
2412 ;;;###autoload
2414 "Search for a regexp using Isearch only in file names in the Dired buffer."
2419 \f
2420 ;; Functions for searching in tags style among marked files.
2422 ;;;###autoload
2424 "Search for a string through all marked files using Isearch."
2429 ;;;###autoload
2431 "Search for a regexp through all marked files using Isearch."
2436 ;;;###autoload
2438 "Search through all marked files for a match for REGEXP.
2439 Stops when a match is found.
2444 ;;;###autoload
2446 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2447 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2458 buffer-read-only))
2465 \f
2466 ;;;###autoload
2468 "Print the type of FILE, according to the `file' command.
2469 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2470 true then the type of the file linked to by FILE is printed instead."
2483 ;; Local Variables:
2484 ;; byte-compile-dynamic: t
2485 ;; generated-autoload-file: "dired.el"
2486 ;; End:
2488 ;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2489 ;;; dired-aux.el ends here