| blob | 2e210d084ba4d54f36e1cc50be84dc6f63f5396d |
1 ;;; dired-aux.el --- less commonly used parts of dired -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2004
4 ;; 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 2, or (at your option)
15 ;; 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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; The parts of dired mode not normally used. This is a space-saving hack
30 ;; to avoid having to load a large mode when all that's wanted are a few
31 ;; functions.
33 ;; Rewritten in 1990/1991 to add tree features, file marking and
34 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
35 ;; Finished up by rms in 1992.
37 ;;; Code:
39 ;; We need macros in dired.el to compile properly.
42 ;;; 15K
43 ;;;###begin dired-cmd.el
44 ;; Diffing and compressing
49 ;;;###autoload
51 "Compare file at point with file FILE using `diff'.
52 FILE defaults to the file at the mark. (That's the mark set by
54 The prompted-for file is the first file given to `diff'.
55 With prefix arg, prompt for second argument SWITCHES,
56 which is options for `diff'."
70 default t)
74 diff-switches
78 ;;;###autoload
80 "Diff this file with its backup file or vice versa.
81 Uses the latest backup, if there are several numerical backups.
82 If this file is a backup, diff it with its original.
83 The backup file is the first file given to `diff'.
84 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
89 diff-switches
91 nil))
95 "Mark files with different file attributes in two dired buffers.
96 Compare file attributes of files in the current directory
97 with file attributes in directory DIR2 using PREDICATE on pairs of files
98 with the same name. Mark files for which PREDICATE returns non-nil.
99 Mark files with different names if PREDICATE is nil (or interactively
100 when the user enters empty input at the predicate prompt).
102 PREDICATE is a Lisp expression that can refer to the following variables:
104 size1, size2 - file size in bytes
105 mtime1, mtime2 - last modification time in seconds, as a float
106 fa1, fa2 - list of file attributes
107 returned by function `file-attributes'
109 where 1 refers to attribute of file in the current dired buffer
110 and 2 to attribute of file in second dired buffer.
112 Examples of PREDICATE:
114 (> mtime1 mtime2) - mark newer files
115 (not (= size1 size2)) - mark files with different sizes
116 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
117 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
118 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
128 'cadr
130 file-alist1 file-alist2
131 predicate)))
133 'cadr
135 file-alist2 file-alist1
136 predicate))))
138 dir1 nil
143 dir2 nil
152 "Combine LIST1 and LIST2 using a set-difference operation.
153 The result list contains all file items that appear in LIST1 but not LIST2.
154 This is a non-destructive function; it makes a copy of the data if necessary
155 to avoid corrupting the original LIST1 and LIST2.
156 PREDICATE (see `dired-compare-directories') is an additional match
157 condition. Two file items are considered to match if they are equal
158 *and* PREDICATE evaluates to t."
160 list1
176 list)
181 "Return a list of all file names and attributes from DIR.
182 List has a form of (file-name full-file-name (attribute-list))"
187 full-file-name
190 \f
193 "Create initial input value for `touch' command."
204 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
205 ;; refresh their file lines.
206 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
207 ;; PROGRAM is the program used to change the attribute.
208 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
209 ;; ARG describes which files to use, as in dired-get-marked-files.
215 op-symbol arg files))
217 failures)
228 files))
233 nil))))
235 ;;;###autoload
237 "Change the mode of the marked (or next ARG) files.
238 This calls chmod, thus symbolic modes like `g+w' are allowed."
242 ;;;###autoload
244 "Change the group of the marked (or next ARG) files."
250 ;;;###autoload
252 "Change the owner of the marked (or next ARG) files."
258 ;;;###autoload
260 "Change the timestamp of the marked (or next ARG) files.
261 This calls touch."
265 ;; Process all the files in FILES in batches of a convenient size,
266 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
267 ;; Batches are chosen to need less than MAX chars for the file names,
268 ;; allowing 3 extra characters of separator per file name.
271 past
273 failures)
274 ;; Accumulate files as long as they fit in MAX chars,
275 ;; then process the ones accumulated so far.
280 ;; If we have at least 1 pending file
281 ;; and this file won't fit in the length limit, process now.
284 ;; The elements of PENDING are now in forward order.
285 ;; Do the operation and record failures.
287 failures)
288 ;; Transfer the elemens of PENDING onto PAST
289 ;; and clear it out. Now PAST contains the first N files
290 ;; specified (for some N), and FILES contains the rest.
292 pending nil
294 ;; Do (setq pending (cons thisfile pending))
295 ;; but reuse the cons that was in `files'.
303 failures)
304 ;; Now the original list FILES has been put back as it was.
307 ;;;###autoload
309 "Print the marked (or next ARG) files.
310 Uses the shell command coming from variables `lpr-command' and
311 `lpr-switches' as default."
315 "Print %s with: "
320 lpr-switches))
325 ;; Read arguments for a marked-files command that wants a string
326 ;; that is not a file name,
327 ;; perhaps popping up the list of marked files.
328 ;; ARG is the prefix arg and indicates whether the files came from
329 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
330 ;; If the current file was used, the list has but one element and ARG
331 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
334 ;; PROMPT for a string, with INITIAL input.
335 ;; Other args are used to give user feedback and pop-up:
336 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
338 nil op-symbol files
341 \f
342 ;;; Cleaning a directory: flagging some backups for deletion.
346 ;;;###autoload
348 "Flag numerical backups for deletion.
349 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
350 Positive prefix arg KEEP overrides `dired-kept-versions';
351 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
354 with a prefix argument."
361 late-retention early-retention)
362 ;; Look at each file.
363 ;; If the file has numeric backup versions,
364 ;; put on dired-file-version-alist an element of the form
365 ;; (FILENAME . VERSION-NUMBER-LIST)
367 ;; Sort each VERSION-NUMBER-LIST,
368 ;; and remove the versions not to be deleted.
376 sorted-v-list)))
380 ;; Look at each file. If it is a numeric backup file,
381 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
385 ;;; Subroutines of dired-clean-directory.
388 ;; Perform FUN with point at the end of each non-directory line.
389 ;; FUN takes one argument, the absolute filename.
404 ;; Only do work if this file is not already in the alist.
406 nil
407 ;; If it looks like file FN has versions, return a list of the versions.
408 ;;That is a list of strings which are file names.
409 ;;The caller may want to flag some of these files for deletion.
414 base-versions
420 dired-file-version-alist)))))))
424 base-version-list)
434 \f
435 ;;; Shell commands
438 ;; "Read a dired shell command prompting with PROMPT (using read-string).
439 ;;ARG is the prefix arg and may be used to indicate in the prompt which
440 ;; files are affected.
441 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
443 nil 'shell files
448 ;; The in-background argument is only needed in Emacs 18 where
449 ;; shell-command doesn't understand an appended ampersand `&'.
450 ;;;###autoload
452 "Run a shell command COMMAND on the marked files.
453 If no files are marked or a specific numeric prefix arg is given,
455 The prompt mentions the file(s) or the marker, as appropriate.
457 If there is a `*' in COMMAND, surrounded by whitespace, this runs
458 COMMAND just once with the entire file list substituted there.
460 If there is no `*', but there is a `?' in COMMAND, surrounded by
461 whitespace, this runs COMMAND on each file individually with the
462 file name substituted for `?'.
464 Otherwise, this runs COMMAND on each file individually with the
465 file name added at the end of COMMAND (separated by a space).
467 `*' and `?' when not surrounded by whitespace have no special
468 significance for `dired-do-shell-command', and are passed through
469 normally to the shell, but you must confirm first. To pass `*' by
472 If COMMAND produces output, it goes to a separate buffer.
474 This feature does not try to redisplay Dired buffers afterward, as
475 there's no telling what files COMMAND may have changed.
478 When COMMAND runs, its working directory is the top-level directory of
479 the Dired buffer, so output files usually are created there instead of
480 in a subdir.
482 In a noninteractive call (from Lisp code), you must specify
483 the list of file names explicitly with the FILE-LIST argument."
484 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
485 ;;actual work and can be redefined for customization.
489 ;; Want to give feedback whether this file or marked files are used:
492 current-prefix-arg
493 files)
494 current-prefix-arg
495 files)))
500 ;; Get confirmation for wildcards that may have been meant
501 ;; to control substitution of a file name or the file name list.
515 nil
516 file-list)
517 ;; execute the shell command
521 ;; Might use {,} for bash or csh:
530 ;; "Make up a shell command line from COMMAND and FILE-LIST.
531 ;; If ON-EACH is t, COMMAND should be applied to each file, else
532 ;; simply concat all files and apply COMMAND to this.
533 ;; FILE-LIST's elements will be quoted for the shell."
534 ;; Might be redefined for smarter things and could then use RAW-ARG
535 ;; (coming from interactive P and currently ignored) to decide what to do.
536 ;; Smart would be a way to access basename or extension of file names.
545 retval))
550 file-list dired-mark-separator)))
555 ;; This is an extra function so that it can be redefined by ange-ftp.
556 ;;;###autoload
563 ;; Return nil for sake of nconc in dired-bunch-files.
564 nil)
565 \f
566 ;; In Emacs 19 this will return program's exit status.
567 ;; This is a separate function so that ange-ftp can redefine it.
569 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
570 ;Remaining arguments are strings passed as command arguments to PROGRAM."
571 ;; Look for a handler for default-directory in case it is a remote file name.
576 program discard arguments)
580 ; "Display MSG while running PROGRAM, and check for output.
581 ;Remaining arguments are strings passed as command arguments to PROGRAM.
582 ; On error, insert output
583 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
584 ; Caller can cons up a list of failed args.
585 ;Else returns nil for success."
589 ;; Get a clean buffer for error output:
603 nil))))
604 \f
605 ;; Commands that delete or redisplay part of the dired buffer.
626 ;;;###autoload
628 "Kill all marked lines (not the files).
629 With a prefix argument, kill that many lines starting with the current line.
630 \(A negative argument kills backward.)
631 If you use this command with a prefix argument to kill the line
632 for a file that is a directory, which you have inserted in the
633 Dired buffer as a subdirectory, then it deletes that subdirectory
634 from the buffer as well.
635 To kill an entire subdirectory \(without killing its line in the
636 parent directory), go to its directory header line and use this
637 command with a prefix argument (the value does not matter)."
638 ;; Returns count of killed lines. FMT="" suppresses message.
656 count))))
658 ;;;###end dired-cmd.el
659 \f
660 ;;; 30K
661 ;;;###begin dired-cp.el
664 ;; Compress or uncompress the current file.
665 ;; Return nil for success, offending filename else.
671 ;; Remove any preexisting entry for the name NEW-FILE.
676 ;; Now replace the current line with an entry for NEW-FILE.
679 from-file)))
685 ;; For .z, try gunzip. It might be an old gzip file,
686 ;; or it might be from compact? pack? (which?) but gunzip handles both.
691 ;; This item controls naming for compression.
693 "Control changes in file name suffixes for compression and uncompression.
694 Each element specifies one transformation rule, and has the form:
695 (REGEXP NEW-SUFFIX PROGRAM)
696 The rule applies when the old file name matches REGEXP.
697 The new file name is computed by deleting the part that matches REGEXP
698 (as well as anything after that), then adding NEW-SUFFIX in its place.
699 If PROGRAM is non-nil, the rule is an uncompression rule,
700 and uncompression is done by running PROGRAM.
703 ;;;###autoload
705 ;; Compress or uncompress FILE.
706 ;; Return the name of the compressed or uncompressed file.
707 ;; Return nil if no change in files.
709 suffix newname
711 ;; See if any suffix rule matches this file name.
717 ;; If so, compute desired new name.
724 nil)
726 ;; We found an uncompression rule.
729 newname))
731 ;;; We don't recognize the file as compressed, so compress it.
732 ;;; Try gzip; if we don't have that, use compress.
740 ;; Rename the compressed file to NEWNAME
741 ;; if it hasn't got that name already.
745 newname)
746 out-name)))
750 ;; Don't use NEWNAME with `compress'.
752 \f
754 ;; Request confirmation from the user that the operation described
755 ;; by OP-SYMBOL is to be performed on the marked files.
756 ;; Confirmation consists in a y-or-n question with a file list
757 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
758 ;; The files used are determined by ARG (as in dired-get-marked-files).
769 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
770 ; and display failures.
772 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
773 ; the short form of the filename) for a failure and probably logs a
774 ; detailed error explanation using function `dired-log'.
776 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
777 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
778 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
779 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
781 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
793 ;; end this bunch of errors:
797 failures)))))
804 ;; None of these keys quit - use C-g for that.
805 ))
807 ;;;###autoload
809 ;; Query user and return nil or t.
810 ;; Store answer in symbol VAR (which must initially be bound to nil).
811 ;; Format PROMPT with ARGS.
812 ;; Binding variable help-form will help the user who types the help key.
826 result elt)
827 ;; Actually it looks nicer without cursor-in-echo-area - you can
828 ;; look at the dired buffer instead of at the prompt to decide.
838 \f
839 ;;;###autoload
841 "Compress or uncompress marked (or next ARG) files."
845 ;; Commands for Emacs Lisp files - load and byte compile
848 ;; Return nil for success, offending file name else.
850 elc-file buffer-read-only failure)
865 nil)))
867 ;;;###autoload
869 "Byte compile marked (or next ARG) Emacs Lisp files."
874 ;; Return nil for success, offending file name else.
880 nil
884 ;;;###autoload
886 "Load the marked (or next ARG) Emacs Lisp files."
890 ;;;###autoload
892 "Redisplay all marked (or next ARG) files.
893 If on a subdir line, redisplay that subdirectory. In that case,
894 a prefix arg lets you edit the `ls' switches used for the new listing.
896 Dired remembers switches specified with a prefix arg, so that reverting
897 the buffer will not reset them. However, using `dired-undo' to re-insert
898 or delete subdirectories can bypass this machinery. Hence, you sometimes
899 may have to reset some subdirectory switches after a `dired-undo'.
900 You can reset all subdirectory switches to the default using
902 See Info node `(emacs-xtra)Subdir switches' for more details."
903 ;; Moves point if the next ARG files are redisplayed.
909 dir
913 dired-subdir-switches
914 dired-actual-switches)))))
916 ;; message much faster than making dired-map-over-marks show progress
922 arg)
927 "Set `dired-switches-alist' to nil and revert dired buffer."
931 \f
933 ;; Delete the current line, and insert an entry for FILE.
934 ;; If FILE is nil, then just delete the current line.
935 ;; Keeps any marks that may be present in column one (doing this
936 ;; here is faster than with dired-add-entry's optional arg).
937 ;; Does not update other dired buffers. Use dired-relist-entry for that.
945 ;; Replace space by old marker without moving point.
946 ;; Faster than goto+insdel inside a save-excursion?
950 ;;;###autoload
957 ;; Add a new entry for FILENAME, optionally marking it
958 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
959 ;; Note that this adds the entry `out of order' if files sorted by
960 ;; time, etc.
961 ;; At least this version inserts in the right subdirectory (if present).
962 ;; And it skips "." or ".." (see `dired-trivial-filenames').
963 ;; Hidden subdirs are exposed if a file is added there.
965 ;; Entry is always for files, even if they happen to also be directories
970 reason)
975 reason
982 ;; We are already where we should be, except when
983 ;; point is before the subdir line or its total line.
987 ;; else try to find correct place to insert
992 ;; found - skip subdir and `total' line
993 ;; and uninteresting files like . and ..
994 ;; This better not moves into the next subdir!
996 ;; not found
1001 ;; Don't expand `.'. Show just the file name within directory.
1007 ;; Put in desired marker char.
1012 ;; Compensate for a bug in ange-ftp.
1013 ;; It inserts the file's absolute name, rather than
1014 ;; the relative one. That may be hard to fix since it
1015 ;; is probably controlled by something in ftp.
1038 ;; return nil if all went well
1039 nil))
1045 ;; Return pos of first file line of DIR, skipping header and total
1046 ;; or wildcard lines.
1047 ;; Important: never moves into the next subdir.
1048 ;; DIR is assumed to be unhidden.
1049 ;; Will probably be redefined for VMS etc.
1058 ;;;###autoload
1071 ;;;###autoload
1073 "Create or update the line for FILE in all Dired buffers it would belong in."
1079 ;; Relist the line for FILE, or just add it if it did not exist.
1080 ;; FILE must be an absolute file name.
1082 ;; If cursor is already on FILE's line delete-region will cause
1083 ;; save-excursion to fail because of floating makers,
1084 ;; moving point to beginning of line. Sigh.
1093 \f
1094 ;;; Copy, move/rename, making hard and symbolic links
1097 "*Non-nil if Dired should ask about making backups before overwriting files.
1098 Special value `always' suppresses confirmation."
1107 ;; Save old version of file TO that is to be overwritten.
1108 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1109 ;; from dired-create-files.
1112 dired-overwrite-confirmed
1117 to))))
1122 ;;;###autoload
1127 dired-recursive-copies)
1132 preserve-time top recursive)
1146 ok-flag preserve-time nil recursive)
1151 ;;;###autoload
1155 ;; Silently rename the visited file of any buffer visiting this file.
1160 ;; See if it's an inserted subdir, and rename that, too.
1168 ;; Update visited file name of all affected buffers
1179 to-dir
1180 buffer-file-name)))
1186 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1187 ;; one of its subdirectories is expanded in this buffer.
1195 ;; ELT's subdir is affected by the rename
1198 ;; if top level directory was renamed, lots of things have to be
1199 ;; updated:
1204 ;; with and without wildcards
1206 to))
1209 ;; try to rename buffer, but just leave old name if new
1210 ;; name would already exist (don't try appending "<%d>")
1213 ;; ... we dired TO now:
1217 ;; Update the headerline and dired-subdir-alist element, as well as
1218 ;; dired-switches-alist element, of directory described by
1219 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1220 ;; describes either DIR itself or a subdir of DIR.
1224 buffer-read-only)
1226 ;; Update subdir headerline in buffer
1229 dir)
1234 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1240 \f
1241 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1245 ;; Create a new file for each from a list of existing files. The user
1246 ;; is queried, dired buffers are updated, and at the end a success or
1247 ;; failure message is displayed
1249 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1251 ;; It is called for each file and must create newfile, the entry of
1252 ;; which will be added. The user will be queried if the file already
1253 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1254 ;; rename), it is FILE-CREATOR's responsibility to update dired
1255 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1256 ;; could not create newfile. The error is caught and logged.
1258 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1259 ;; operation performed. It is used for error logging.
1261 ;; FN-LIST is the list of files to copy (full absolute file names).
1263 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1264 ;; skip. If it skips files for other reasons than a direct user
1265 ;; query, it is supposed to tell why (using dired-log).
1267 ;; Optional MARKER-CHAR is a character with which to mark every
1268 ;; newfile's entry, or t to use the current marker character if the
1269 ;; oldfile was marked.
1289 Type SPC or `y' to overwrite file `%s',
1290 DEL or `n' to skip to next,
1291 ESC or `q' to not overwrite any of the remaining files,
1295 ;; must determine if FROM is marked before file-creator
1296 ;; gets a chance to delete it (in case of a move).
1305 ;; If we get here, file-creator hasn't been aborted
1306 ;; and the old entry (if any) has to be deleted
1307 ;; before adding the new entry.
1316 operation from to err))))))))
1317 fn-list))
1324 failures))
1330 skipped))
1335 \f
1337 &optional marker-char op1
1338 how-to)
1339 "Create a new file for each marked file.
1340 Prompts user for target, which is a directory in which to create
1341 the new files. Target may be a plain file if only one marked
1342 file exists. The way the default for the target directory is
1343 computed depends on the value of `dired-dwim-target-directory'.
1344 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1345 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1346 FILE-CREATOR and OPERATION as in `dired-create-files'.
1347 ARG as in `dired-get-marked-files'.
1348 Optional arg MARKER-CHAR as in `dired-create-files'.
1349 Optional arg OP1 is an alternate form for OPERATION if there is
1350 only one file.
1351 Optional arg HOW-TO is used to set the value of the into-dir variable
1352 which determines how to treat target.
1353 If into-dir is set to nil then target is not regarded as a directory,
1354 there must be exactly one marked file, else error.
1355 Else if into-dir is set to a list, then target is a generalized
1356 directory (e.g. some sort of archive). The first element of into-dir
1357 must be a function with at least four arguments:
1358 operation as OPERATION above.
1359 rfn-list a list of the relative names for the marked files.
1360 fn-list a list of the absolute names for the marked files.
1361 target.
1362 The rest of into-dir are optional arguments.
1363 Else into-dir is not a list. Target is a directory.
1364 The marked file(s) are created inside the target directory.
1366 If HOW-TO is not given (or nil), then into-dir is set to true if
1367 target is a directory and otherwise to nil.
1368 Else if HOW-TO is t, then into-dir is set to nil.
1369 Else HOW-TO is assumed to be a function of one argument, target,
1370 that looks at target and returns a value for the into-dir
1371 variable. The function `dired-into-dir-with-symlinks' is provided
1372 for the case (common when creating symlinks) that symbolic
1373 links to directories are not to be considered as directories
1374 (as `file-directory-p' would if HOW-TO had been nil)."
1383 target-dir)))
1387 target-dir op-symbol arg rfn-list default)))
1389 ;; Allow DOS/Windows users to change the letter
1390 ;; case of a directory. If we don't test these
1391 ;; conditions up front, file-directory-p below
1392 ;; will return t because the filesystem is
1393 ;; case-insensitive, and Emacs will try to move
1394 ;; foo -> foo/foo, which fails.
1397 dired-one-file
1405 nil
1413 ;; rename-file bombs when moving directories unless we do this:
1416 file-creator operation fn-list
1418 ;; This function uses fluid variable target when called
1419 ;; inside dired-create-files:
1424 marker-char))))
1426 ;; Read arguments for a marked-files command that wants a file name,
1427 ;; perhaps popping up the list of marked files.
1428 ;; ARG is the prefix arg and indicates whether the files came from
1429 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1430 ;; If the current file was used, the list has but one element and ARG
1431 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1432 ;; DEFAULT is the default value to return if the user just hits RET;
1433 ;; if it is omitted or nil, then the name of the directory is used.
1438 nil op-symbol files
1443 ;; Try to guess which target directory the user may want.
1444 ;; If there is a dired buffer displayed in the next window, use
1445 ;; its current subdir, else use current subdir of this dired buffer.
1448 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1456 this-dir)))
1457 \f
1458 ;;;###autoload
1460 "Create a directory called DIRECTORY."
1471 ;; This may not always be what you want, especially if target is your
1472 ;; home directory and it happens to be a symbolic link, as is often the
1473 ;; case with NFS and automounters. Or if you want to make symlinks
1474 ;; into directories that themselves are only symlinks, also quite
1475 ;; common.
1477 ;; So we don't use this function as value for HOW-TO in
1478 ;; dired-do-symlink, which has the minor disadvantage of
1479 ;; making links *into* a symlinked-dir, when you really wanted to
1480 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1481 ;; just have to remove that symlink by hand before making your marked
1482 ;; symlinks.
1485 "nil or a function used by `dired-do-copy' to determine target.
1488 ;;;###autoload
1490 "Copy all marked (or next ARG) files, or copy the current file.
1491 This normally preserves the last-modified date when copying.
1492 When operating on just the current file, you specify the new name.
1493 When operating on multiple or marked files, you specify a directory,
1494 and new copies of these files are made in that directory
1495 with the same names that the files currently have. The default
1496 suggested for the target directory depends on the value of
1497 `dired-dwim-target', which see."
1502 arg dired-keep-marker-copy
1503 nil dired-copy-how-to-fn)))
1505 ;;;###autoload
1507 "Make symbolic links to current file or all marked (or next ARG) files.
1508 When operating on just the current file, you specify the new name.
1509 When operating on multiple or marked files, you specify a directory
1510 and new symbolic links are made in that directory
1511 with the same names that the files currently have. The default
1512 suggested for the target directory depends on the value of
1513 `dired-dwim-target', which see."
1518 ;;;###autoload
1520 "Add names (hard links) current file or all marked (or next ARG) files.
1521 When operating on just the current file, you specify the new name.
1522 When operating on multiple or marked files, you specify a directory
1523 and new hard links are made in that directory
1524 with the same names that the files currently have. The default
1525 suggested for the target directory depends on the value of
1526 `dired-dwim-target', which see."
1533 ;; error is caught in -create-files
1535 ;; Update the link count
1538 ;;;###autoload
1540 "Rename current file or all marked (or next ARG) files.
1541 When renaming just the current file, you specify the new name.
1542 When renaming multiple or marked files, you specify a directory.
1543 This command also renames any buffers that are visiting the files.
1544 The default suggested for the target directory depends on the value
1545 of `dired-dwim-target', which see."
1549 ;;;###end dired-cp.el
1550 \f
1551 ;;; 5K
1552 ;;;###begin dired-re.el
1555 ;; Create a new file for each marked file using regexps.
1556 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1557 ;; ARG as in dired-get-marked-files.
1558 ;; Matches each marked file against REGEXP and constructs the new
1559 ;; filename from NEWNAME (like in function replace-match).
1560 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1561 ;; instead of only the non-directory part of the file.
1562 ;; Optional arg MARKER-CHAR as in dired-create-files.
1567 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1568 `!' to %s all remaining matches with no more questions."
1572 ;; Function to construct new filename using REGEXP and NEWNAME:
1577 ;; must bind help-form directly around call to
1578 ;; dired-query
1582 operation-prompt
1583 from
1584 to)
1585 to)
1587 operation from regexp)))))
1588 ;; not whole-name, replace non-directory part only
1599 operation-prompt
1602 to)
1605 rename-regexp-query)
1607 file-creator operation fn-list regexp-name-constructor marker-char)))
1610 ;; Prompt user about performing OPERATION.
1611 ;; Read and return list of: regexp newname arg whole-name.
1624 ;;;###autoload
1626 "Rename selected files whose names match REGEXP to NEWNAME.
1628 With non-zero prefix argument ARG, the command operates on the next ARG
1629 files. Otherwise, it operates on all the marked files, or the current
1630 file if none are marked.
1632 As each match is found, the user must type a character saying
1635 REGEXP defaults to the last regexp used.
1637 With a zero prefix arg, renaming by regexp affects the absolute file name.
1638 Normally, only the non-directory part of the file name is used and changed."
1644 ;;;###autoload
1646 "Copy selected files whose names match REGEXP to NEWNAME.
1647 See function `dired-do-rename-regexp' for more info."
1653 arg regexp newname whole-name dired-keep-marker-copy)))
1655 ;;;###autoload
1657 "Hardlink selected files whose names match REGEXP to NEWNAME.
1658 See function `dired-do-rename-regexp' for more info."
1664 ;;;###autoload
1666 "Symlink selected files whose names match REGEXP to NEWNAME.
1667 See function `dired-do-rename-regexp' for more info."
1675 ;; Perform FILE-CREATOR on the non-directory part of marked files
1676 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1677 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1680 file-creator
1681 operation
1689 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1690 `!' to %s all remaining matches with no more questions."
1697 to))))
1698 dired-keep-marker-rename)))
1703 basename-constructor operation arg))
1705 ;;;###autoload
1707 "Rename all marked (or next ARG) files to upper case."
1711 ;;;###autoload
1713 "Rename all marked (or next ARG) files to lower case."
1717 ;;;###end dired-re.el
1718 \f
1719 ;;; 13K
1720 ;;;###begin dired-ins.el
1722 ;;;###autoload
1724 switches no-error-if-not-dir-p)
1725 "Insert this subdirectory into the same dired buffer.
1727 else inserts it at its natural place (as `ls -lR' would have done).
1728 With a prefix arg, you may edit the ls switches used for this listing.
1729 You can add `R' to the switches to expand the whole tree starting at
1730 this subdirectory.
1731 This function takes some pains to conform to `ls -lR' output.
1733 Dired remembers switches specified with a prefix arg, so that reverting
1734 the buffer will not reset them. However, using `dired-undo' to re-insert
1735 or delete subdirectories can bypass this machinery. Hence, you sometimes
1736 may have to reset some subdirectory switches after a `dired-undo'.
1737 You can reset all subdirectory switches to the default using
1739 See Info node `(emacs-xtra)Subdir switches' for more details."
1746 ;; We don't need a marker for opoint as the subdir is always
1747 ;; inserted *after* opoint.
1752 ;; Push mark so that it's easy to find back. Do this after the
1753 ;; insert message so that the user sees the `Mark set' message.
1756 ;;;###autoload
1758 "Insert this subdirectory into the same dired buffer.
1759 If it is already present, overwrites previous entry,
1760 else inserts it at its natural place (as `ls -lR' would have done).
1761 With a prefix arg, you may edit the `ls' switches used for this listing.
1762 You can add `R' to the switches to expand the whole tree starting at
1763 this subdirectory.
1764 This function takes some pains to conform to `ls -lR' output."
1765 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1766 ;; Prospero where dired-ls does the right thing, but
1767 ;; file-directory-p has not been redefined.
1781 switches-have-R mark-alist case-fold-search buffer-read-only)
1784 ;; case-fold-search is nil now, so we can test for capital `R':
1786 ;; avoid duplicated subdirs
1789 ;; If subdir is already present, remove it and remember its marks
1812 ;; This is a separate function for dired-vms.
1814 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1815 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1828 ;; all switches that make a difference to dired-get-filename:
1832 ;; Add new DIR at NEW-MARKER. Sort alist.
1837 ;; Keep the alist sorted on buffer position.
1845 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1846 Interactively, you can kill DIRNAME as well by using a prefix argument.
1847 In interactive use, the command prompts for DIRNAME.
1849 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1850 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1861 m-alist))
1864 ;; Find pos for new subdir, according to tree order.
1865 ;;(goto-char (point-max))
1873 ;; Insert NEW-DIR after DIR
1875 alist nil)))
1877 ;; want a separating newline between subdirs
1884 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1885 ;; Move to that buffer position. Return a mark-alist.
1888 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1897 ;; Insert ls output after point.
1898 ;; Return the boundary of the inserted text (as list of BEG and END).
1903 dired-subdir-switches
1906 ;; If doing the top level directory of the buffer,
1907 ;; redo it as specified in dired-directory.
1913 ;; Point is at the correct subdir alist position for ELT,
1914 ;; BEG-END is the subdir-region (as list of begin and end).
1916 ;; update its position (should actually be unchanged)
1919 ;; The hook may depend on the subdir-alist containing the just
1920 ;; inserted subdir, so run it after dired-alist-add:
1928 ;; hook may add or delete lines, but the subdir boundary
1929 ;; marker floats
1933 ;; Lexicographic order on file name components, like `ls -lR':
1934 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1935 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1936 ;; or DIR1 and DIR2 are in the same parentdir and their last
1937 ;; components are string-lessp.
1938 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1939 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1940 ;; if dired-actual-switches contained `t'.
1946 components-2
1958 t)
1960 nil)
1963 ;; There should be a builtin split function - inverse to mapconcat.
1965 "Splitting on regexp PAT, turn string STR into a list of substrings.
1966 Optional third arg LIMIT (>= 1) is a limit to the length of the
1967 resulting list.
1968 Thus, if SEP is a regexp that only matches itself,
1970 (mapconcat 'identity (dired-split SEP STRING) SEP)
1972 is always equal to STRING."
1985 start end)
1986 ))
1993 \f
1994 ;;; moving by subdirectories
1996 ;;;###autoload
1998 "Go to previous subdirectory, regardless of level.
1999 When called interactively and not on a subdir line, go to this subdir's line."
2000 ;;(interactive "p")
2004 ;; if on subdir start already, don't stay there!
2014 ;;;###autoload
2016 "Go to end of header line of DIR in this dired buffer.
2017 Return value of point on success, otherwise return nil.
2023 dired-subdir-alist ; table
2024 nil ; predicate
2025 t ; require-match
2032 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2033 ;; at either \r or \n after this function succeeds.
2036 \f
2037 ;;;###autoload
2039 "Mark all files except `.' and `..' in current subdirectory.
2040 If the Dired buffer shows multiple directories, this command
2041 marks the files listed in the subdirectory that point is in."
2046 ;;;###autoload
2048 "Remove all lines of current subdirectory.
2049 Lower levels are unaffected."
2050 ;; With optional REMEMBER-MARKS, return a mark-alist.
2057 buffer-read-only)
2071 ;; Remove DIR from the alist
2075 ;;;###autoload
2077 "Go up ARG levels in the dired tree."
2083 ;;(setq dir (expand-file-name dir))
2087 ;;;###autoload
2089 "Go down in the dired tree."
2103 \f
2104 ;;; hiding
2120 ;;;###autoload
2122 "Hide or unhide the current subdirectory and move to next directory.
2123 Optional prefix arg is a repeat factor.
2133 buffer-read-only)
2134 ;; keep header line visible, hide rest
2143 ;;;###autoload
2145 "Hide all subdirectories, leaving only their header lines.
2146 If there is already something hidden, make everything visible again.
2151 buffer-read-only)
2155 ;; unhide - bombs on \r in filenames
2157 ;; hide
2164 ;; we're somewhere on current dir's line
2172 ;;;###end dired-ins.el
2174 \f
2175 ;; Functions for searching in tags style among marked files.
2177 ;;;###autoload
2179 "Search through all marked files for a match for REGEXP.
2180 Stops when a match is found.
2185 ;;;###autoload
2187 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2188 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2196 buffer-read-only))
2203 \f
2204 ;;;###autoload
2206 "Print the type of FILE, according to the `file' command.
2207 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2208 true then the type of the file linked to by FILE is printed instead."
2220 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2221 ;;; dired-aux.el ends here