| blob | eec3045b53a837790faaa59f210c6623d229ccd6 |
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))
94 ;;;###autoload
96 "Mark files with different file attributes in two dired buffers.
97 Compare file attributes of files in the current directory
98 with file attributes in directory DIR2 using PREDICATE on pairs of files
99 with the same name. Mark files for which PREDICATE returns non-nil.
100 Mark files with different names if PREDICATE is nil (or interactively
101 with empty input at the predicate prompt).
103 PREDICATE is a Lisp expression that can refer to the following variables:
105 size1, size2 - file size in bytes
106 mtime1, mtime2 - last modification time in seconds, as a float
107 fa1, fa2 - list of file attributes
108 returned by function `file-attributes'
110 where 1 refers to attribute of file in the current dired buffer
111 and 2 to attribute of file in second dired buffer.
113 Examples of PREDICATE:
115 (> mtime1 mtime2) - mark newer files
116 (not (= size1 size2)) - mark files with different sizes
117 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
118 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
119 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
130 'cadr
132 file-alist1 file-alist2
133 predicate)))
135 'cadr
137 file-alist2 file-alist1
138 predicate))))
140 dir1 nil
145 dir2 nil
154 "Combine LIST1 and LIST2 using a set-difference operation.
155 The result list contains all file items that appear in LIST1 but not LIST2.
156 This is a non-destructive function; it makes a copy of the data if necessary
157 to avoid corrupting the original LIST1 and LIST2.
158 PREDICATE (see `dired-compare-directories') is an additional match
159 condition. Two file items are considered to match if they are equal
160 *and* PREDICATE evaluates to t."
162 list1
178 list)
183 "Return a list of all file names and attributes from DIR.
184 List has a form of (file-name full-file-name (attribute-list))"
189 full-file-name
192 \f
195 "Create initial input value for `touch' command."
206 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
207 ;; refresh their file lines.
208 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
209 ;; PROGRAM is the program used to change the attribute.
210 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
211 ;; ARG describes which files to use, as in dired-get-marked-files.
217 op-symbol arg files))
219 failures)
230 files))
235 nil))))
237 ;;;###autoload
239 "Change the mode of the marked (or next ARG) files.
240 This calls chmod, thus symbolic modes like `g+w' are allowed."
244 ;;;###autoload
246 "Change the group of the marked (or next ARG) files."
252 ;;;###autoload
254 "Change the owner of the marked (or next ARG) files."
260 ;;;###autoload
262 "Change the timestamp of the marked (or next ARG) files.
263 This calls touch."
267 ;; Process all the files in FILES in batches of a convenient size,
268 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
269 ;; Batches are chosen to need less than MAX chars for the file names,
270 ;; allowing 3 extra characters of separator per file name.
273 past
275 failures)
276 ;; Accumulate files as long as they fit in MAX chars,
277 ;; then process the ones accumulated so far.
282 ;; If we have at least 1 pending file
283 ;; and this file won't fit in the length limit, process now.
286 ;; The elements of PENDING are now in forward order.
287 ;; Do the operation and record failures.
289 failures)
290 ;; Transfer the elemens of PENDING onto PAST
291 ;; and clear it out. Now PAST contains the first N files
292 ;; specified (for some N), and FILES contains the rest.
294 pending nil
296 ;; Do (setq pending (cons thisfile pending))
297 ;; but reuse the cons that was in `files'.
305 failures)
306 ;; Now the original list FILES has been put back as it was.
309 ;;;###autoload
311 "Print the marked (or next ARG) files.
312 Uses the shell command coming from variables `lpr-command' and
313 `lpr-switches' as default."
317 "Print %s with: "
322 lpr-switches))
327 ;; Read arguments for a marked-files command that wants a string
328 ;; that is not a file name,
329 ;; perhaps popping up the list of marked files.
330 ;; ARG is the prefix arg and indicates whether the files came from
331 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
332 ;; If the current file was used, the list has but one element and ARG
333 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
336 ;; PROMPT for a string, with INITIAL input.
337 ;; Other args are used to give user feedback and pop-up:
338 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
340 nil op-symbol files
343 \f
344 ;;; Cleaning a directory: flagging some backups for deletion.
348 ;;;###autoload
350 "Flag numerical backups for deletion.
351 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
352 Positive prefix arg KEEP overrides `dired-kept-versions';
353 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
356 with a prefix argument."
363 late-retention early-retention)
364 ;; Look at each file.
365 ;; If the file has numeric backup versions,
366 ;; put on dired-file-version-alist an element of the form
367 ;; (FILENAME . VERSION-NUMBER-LIST)
369 ;; Sort each VERSION-NUMBER-LIST,
370 ;; and remove the versions not to be deleted.
378 sorted-v-list)))
382 ;; Look at each file. If it is a numeric backup file,
383 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
387 ;;; Subroutines of dired-clean-directory.
390 ;; Perform FUN with point at the end of each non-directory line.
391 ;; FUN takes one argument, the absolute filename.
406 ;; Only do work if this file is not already in the alist.
408 nil
409 ;; If it looks like file FN has versions, return a list of the versions.
410 ;;That is a list of strings which are file names.
411 ;;The caller may want to flag some of these files for deletion.
416 base-versions
422 dired-file-version-alist)))))))
426 base-version-list)
436 \f
437 ;;; Shell commands
440 ;; "Read a dired shell command prompting with PROMPT (using read-string).
441 ;;ARG is the prefix arg and may be used to indicate in the prompt which
442 ;; files are affected.
443 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
445 nil 'shell files
450 ;; The in-background argument is only needed in Emacs 18 where
451 ;; shell-command doesn't understand an appended ampersand `&'.
452 ;;;###autoload
454 "Run a shell command COMMAND on the marked files.
455 If no files are marked or a specific numeric prefix arg is given,
457 The prompt mentions the file(s) or the marker, as appropriate.
459 If there is a `*' in COMMAND, surrounded by whitespace, this runs
460 COMMAND just once with the entire file list substituted there.
462 If there is no `*', but there is a `?' in COMMAND, surrounded by
463 whitespace, this runs COMMAND on each file individually with the
464 file name substituted for `?'.
466 Otherwise, this runs COMMAND on each file individually with the
467 file name added at the end of COMMAND (separated by a space).
469 `*' and `?' when not surrounded by whitespace have no special
470 significance for `dired-do-shell-command', and are passed through
471 normally to the shell, but you must confirm first. To pass `*' by
474 If COMMAND produces output, it goes to a separate buffer.
476 This feature does not try to redisplay Dired buffers afterward, as
477 there's no telling what files COMMAND may have changed.
480 When COMMAND runs, its working directory is the top-level directory of
481 the Dired buffer, so output files usually are created there instead of
482 in a subdir.
484 In a noninteractive call (from Lisp code), you must specify
485 the list of file names explicitly with the FILE-LIST argument."
486 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
487 ;;actual work and can be redefined for customization.
491 ;; Want to give feedback whether this file or marked files are used:
494 current-prefix-arg
495 files)
496 current-prefix-arg
497 files)))
502 ;; Get confirmation for wildcards that may have been meant
503 ;; to control substitution of a file name or the file name list.
517 nil
518 file-list)
519 ;; execute the shell command
523 ;; Might use {,} for bash or csh:
532 ;; "Make up a shell command line from COMMAND and FILE-LIST.
533 ;; If ON-EACH is t, COMMAND should be applied to each file, else
534 ;; simply concat all files and apply COMMAND to this.
535 ;; FILE-LIST's elements will be quoted for the shell."
536 ;; Might be redefined for smarter things and could then use RAW-ARG
537 ;; (coming from interactive P and currently ignored) to decide what to do.
538 ;; Smart would be a way to access basename or extension of file names.
547 retval))
552 file-list dired-mark-separator)))
557 ;; This is an extra function so that it can be redefined by ange-ftp.
558 ;;;###autoload
565 ;; Return nil for sake of nconc in dired-bunch-files.
566 nil)
567 \f
568 ;; In Emacs 19 this will return program's exit status.
569 ;; This is a separate function so that ange-ftp can redefine it.
571 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
572 ;Remaining arguments are strings passed as command arguments to PROGRAM."
573 ;; Look for a handler for default-directory in case it is a remote file name.
578 program discard arguments)
582 ; "Display MSG while running PROGRAM, and check for output.
583 ;Remaining arguments are strings passed as command arguments to PROGRAM.
584 ; On error, insert output
585 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
586 ; Caller can cons up a list of failed args.
587 ;Else returns nil for success."
591 ;; Get a clean buffer for error output:
605 nil))))
606 \f
607 ;; Commands that delete or redisplay part of the dired buffer.
628 ;;;###autoload
630 "Kill all marked lines (not the files).
631 With a prefix argument, kill that many lines starting with the current line.
632 \(A negative argument kills backward.)
633 If you use this command with a prefix argument to kill the line
634 for a file that is a directory, which you have inserted in the
635 Dired buffer as a subdirectory, then it deletes that subdirectory
636 from the buffer as well.
637 To kill an entire subdirectory \(without killing its line in the
638 parent directory), go to its directory header line and use this
639 command with a prefix argument (the value does not matter)."
640 ;; Returns count of killed lines. FMT="" suppresses message.
658 count))))
660 ;;;###end dired-cmd.el
661 \f
662 ;;; 30K
663 ;;;###begin dired-cp.el
666 ;; Compress or uncompress the current file.
667 ;; Return nil for success, offending filename else.
673 ;; Remove any preexisting entry for the name NEW-FILE.
678 ;; Now replace the current line with an entry for NEW-FILE.
681 from-file)))
687 ;; For .z, try gunzip. It might be an old gzip file,
688 ;; or it might be from compact? pack? (which?) but gunzip handles both.
693 ;; This item controls naming for compression.
695 "Control changes in file name suffixes for compression and uncompression.
696 Each element specifies one transformation rule, and has the form:
697 (REGEXP NEW-SUFFIX PROGRAM)
698 The rule applies when the old file name matches REGEXP.
699 The new file name is computed by deleting the part that matches REGEXP
700 (as well as anything after that), then adding NEW-SUFFIX in its place.
701 If PROGRAM is non-nil, the rule is an uncompression rule,
702 and uncompression is done by running PROGRAM.
705 ;;;###autoload
707 ;; Compress or uncompress FILE.
708 ;; Return the name of the compressed or uncompressed file.
709 ;; Return nil if no change in files.
711 suffix newname
713 ;; See if any suffix rule matches this file name.
719 ;; If so, compute desired new name.
726 nil)
728 ;; We found an uncompression rule.
731 newname))
733 ;;; We don't recognize the file as compressed, so compress it.
734 ;;; Try gzip; if we don't have that, use compress.
742 ;; Rename the compressed file to NEWNAME
743 ;; if it hasn't got that name already.
747 newname)
748 out-name)))
752 ;; Don't use NEWNAME with `compress'.
754 \f
756 ;; Request confirmation from the user that the operation described
757 ;; by OP-SYMBOL is to be performed on the marked files.
758 ;; Confirmation consists in a y-or-n question with a file list
759 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
760 ;; The files used are determined by ARG (as in dired-get-marked-files).
763 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
764 ;; is marked pops up a window. That will help the user see
765 ;; it isn't the current line file.
774 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
775 ; and display failures.
777 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
778 ; the short form of the filename) for a failure and probably logs a
779 ; detailed error explanation using function `dired-log'.
781 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
782 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
783 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
784 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
786 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
798 ;; end this bunch of errors:
802 failures)))))
809 ;; None of these keys quit - use C-g for that.
810 ))
812 ;;;###autoload
814 ;; Query user and return nil or t.
815 ;; Store answer in symbol VAR (which must initially be bound to nil).
816 ;; Format PROMPT with ARGS.
817 ;; Binding variable help-form will help the user who types the help key.
831 result elt)
832 ;; Actually it looks nicer without cursor-in-echo-area - you can
833 ;; look at the dired buffer instead of at the prompt to decide.
843 \f
844 ;;;###autoload
846 "Compress or uncompress marked (or next ARG) files."
850 ;; Commands for Emacs Lisp files - load and byte compile
853 ;; Return nil for success, offending file name else.
855 elc-file buffer-read-only failure)
870 nil)))
872 ;;;###autoload
874 "Byte compile marked (or next ARG) Emacs Lisp files."
879 ;; Return nil for success, offending file name else.
885 nil
889 ;;;###autoload
891 "Load the marked (or next ARG) Emacs Lisp files."
895 ;;;###autoload
897 "Redisplay all marked (or next ARG) files.
898 If on a subdir line, redisplay that subdirectory. In that case,
899 a prefix arg lets you edit the `ls' switches used for the new listing.
901 Dired remembers switches specified with a prefix arg, so that reverting
902 the buffer will not reset them. However, using `dired-undo' to re-insert
903 or delete subdirectories can bypass this machinery. Hence, you sometimes
904 may have to reset some subdirectory switches after a `dired-undo'.
905 You can reset all subdirectory switches to the default using
907 See Info node `(emacs-xtra)Subdir switches' for more details."
908 ;; Moves point if the next ARG files are redisplayed.
914 dir
918 dired-subdir-switches
919 dired-actual-switches)))))
921 ;; message much faster than making dired-map-over-marks show progress
927 arg)
932 "Set `dired-switches-alist' to nil and revert dired buffer."
936 \f
938 ;; Delete the current line, and insert an entry for FILE.
939 ;; If FILE is nil, then just delete the current line.
940 ;; Keeps any marks that may be present in column one (doing this
941 ;; here is faster than with dired-add-entry's optional arg).
942 ;; Does not update other dired buffers. Use dired-relist-entry for that.
950 ;; Replace space by old marker without moving point.
951 ;; Faster than goto+insdel inside a save-excursion?
955 ;;;###autoload
962 ;; Add a new entry for FILENAME, optionally marking it
963 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
964 ;; Note that this adds the entry `out of order' if files sorted by
965 ;; time, etc.
966 ;; At least this version inserts in the right subdirectory (if present).
967 ;; And it skips "." or ".." (see `dired-trivial-filenames').
968 ;; Hidden subdirs are exposed if a file is added there.
970 ;; Entry is always for files, even if they happen to also be directories
975 reason)
980 reason
987 ;; We are already where we should be, except when
988 ;; point is before the subdir line or its total line.
992 ;; else try to find correct place to insert
997 ;; found - skip subdir and `total' line
998 ;; and uninteresting files like . and ..
999 ;; This better not moves into the next subdir!
1001 ;; not found
1006 ;; Don't expand `.'. Show just the file name within directory.
1012 ;; Put in desired marker char.
1017 ;; Compensate for a bug in ange-ftp.
1018 ;; It inserts the file's absolute name, rather than
1019 ;; the relative one. That may be hard to fix since it
1020 ;; is probably controlled by something in ftp.
1043 ;; return nil if all went well
1044 nil))
1050 ;; Return pos of first file line of DIR, skipping header and total
1051 ;; or wildcard lines.
1052 ;; Important: never moves into the next subdir.
1053 ;; DIR is assumed to be unhidden.
1054 ;; Will probably be redefined for VMS etc.
1063 ;;;###autoload
1076 ;;;###autoload
1078 "Create or update the line for FILE in all Dired buffers it would belong in."
1084 ;; Relist the line for FILE, or just add it if it did not exist.
1085 ;; FILE must be an absolute file name.
1087 ;; If cursor is already on FILE's line delete-region will cause
1088 ;; save-excursion to fail because of floating makers,
1089 ;; moving point to beginning of line. Sigh.
1098 \f
1099 ;;; Copy, move/rename, making hard and symbolic links
1102 "*Non-nil if Dired should ask about making backups before overwriting files.
1103 Special value `always' suppresses confirmation."
1112 ;; Save old version of file TO that is to be overwritten.
1113 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1114 ;; from dired-create-files.
1117 dired-overwrite-confirmed
1122 to))))
1127 ;;;###autoload
1132 dired-recursive-copies)
1137 preserve-time top recursive)
1143 ;; This is a directory.
1153 ok-flag preserve-time nil recursive)
1155 ;; Not a directory.
1158 ;; It is a symlink
1162 ;;;###autoload
1166 ;; Silently rename the visited file of any buffer visiting this file.
1171 ;; See if it's an inserted subdir, and rename that, too.
1179 ;; Update visited file name of all affected buffers
1190 to-dir
1191 buffer-file-name)))
1197 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1198 ;; one of its subdirectories is expanded in this buffer.
1206 ;; ELT's subdir is affected by the rename
1209 ;; if top level directory was renamed, lots of things have to be
1210 ;; updated:
1215 ;; with and without wildcards
1217 to))
1220 ;; try to rename buffer, but just leave old name if new
1221 ;; name would already exist (don't try appending "<%d>")
1224 ;; ... we dired TO now:
1228 ;; Update the headerline and dired-subdir-alist element, as well as
1229 ;; dired-switches-alist element, of directory described by
1230 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1231 ;; describes either DIR itself or a subdir of DIR.
1235 buffer-read-only)
1237 ;; Update subdir headerline in buffer
1240 dir)
1245 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1251 \f
1252 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1256 ;; Create a new file for each from a list of existing files. The user
1257 ;; is queried, dired buffers are updated, and at the end a success or
1258 ;; failure message is displayed
1260 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1262 ;; It is called for each file and must create newfile, the entry of
1263 ;; which will be added. The user will be queried if the file already
1264 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1265 ;; rename), it is FILE-CREATOR's responsibility to update dired
1266 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1267 ;; could not create newfile. The error is caught and logged.
1269 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1270 ;; operation performed. It is used for error logging.
1272 ;; FN-LIST is the list of files to copy (full absolute file names).
1274 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1275 ;; skip. If it skips files for other reasons than a direct user
1276 ;; query, it is supposed to tell why (using dired-log).
1278 ;; Optional MARKER-CHAR is a character with which to mark every
1279 ;; newfile's entry, or t to use the current marker character if the
1280 ;; oldfile was marked.
1300 Type SPC or `y' to overwrite file `%s',
1301 DEL or `n' to skip to next,
1302 ESC or `q' to not overwrite any of the remaining files,
1306 ;; must determine if FROM is marked before file-creator
1307 ;; gets a chance to delete it (in case of a move).
1316 ;; If we get here, file-creator hasn't been aborted
1317 ;; and the old entry (if any) has to be deleted
1318 ;; before adding the new entry.
1327 operation from to err))))))))
1328 fn-list))
1335 failures))
1341 skipped))
1346 \f
1348 &optional marker-char op1
1349 how-to)
1350 "Create a new file for each marked file.
1351 Prompts user for target, which is a directory in which to create
1352 the new files. Target may be a plain file if only one marked
1353 file exists. The way the default for the target directory is
1354 computed depends on the value of `dired-dwim-target-directory'.
1355 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1356 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1357 FILE-CREATOR and OPERATION as in `dired-create-files'.
1358 ARG as in `dired-get-marked-files'.
1359 Optional arg MARKER-CHAR as in `dired-create-files'.
1360 Optional arg OP1 is an alternate form for OPERATION if there is
1361 only one file.
1362 Optional arg HOW-TO is used to set the value of the into-dir variable
1363 which determines how to treat target.
1364 If into-dir is set to nil then target is not regarded as a directory,
1365 there must be exactly one marked file, else error.
1366 Else if into-dir is set to a list, then target is a generalized
1367 directory (e.g. some sort of archive). The first element of into-dir
1368 must be a function with at least four arguments:
1369 operation as OPERATION above.
1370 rfn-list a list of the relative names for the marked files.
1371 fn-list a list of the absolute names for the marked files.
1372 target.
1373 The rest of into-dir are optional arguments.
1374 Else into-dir is not a list. Target is a directory.
1375 The marked file(s) are created inside the target directory.
1377 If HOW-TO is not given (or nil), then into-dir is set to true if
1378 target is a directory and otherwise to nil.
1379 Else if HOW-TO is t, then into-dir is set to nil.
1380 Else HOW-TO is assumed to be a function of one argument, target,
1381 that looks at target and returns a value for the into-dir
1382 variable. The function `dired-into-dir-with-symlinks' is provided
1383 for the case (common when creating symlinks) that symbolic
1384 links to directories are not to be considered as directories
1385 (as `file-directory-p' would if HOW-TO had been nil)."
1394 target-dir)))
1398 target-dir op-symbol arg rfn-list default)))
1400 ;; Allow DOS/Windows users to change the letter
1401 ;; case of a directory. If we don't test these
1402 ;; conditions up front, file-directory-p below
1403 ;; will return t because the filesystem is
1404 ;; case-insensitive, and Emacs will try to move
1405 ;; foo -> foo/foo, which fails.
1408 dired-one-file
1416 nil
1424 ;; rename-file bombs when moving directories unless we do this:
1427 file-creator operation fn-list
1429 ;; This function uses fluid variable target when called
1430 ;; inside dired-create-files:
1435 marker-char))))
1437 ;; Read arguments for a marked-files command that wants a file name,
1438 ;; perhaps popping up the list of marked files.
1439 ;; ARG is the prefix arg and indicates whether the files came from
1440 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1441 ;; If the current file was used, the list has but one element and ARG
1442 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1443 ;; DEFAULT is the default value to return if the user just hits RET;
1444 ;; if it is omitted or nil, then the name of the directory is used.
1449 nil op-symbol files
1454 ;; Try to guess which target directory the user may want.
1455 ;; If there is a dired buffer displayed in the next window, use
1456 ;; its current subdir, else use current subdir of this dired buffer.
1459 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1467 this-dir)))
1468 \f
1469 ;;;###autoload
1471 "Create a directory called DIRECTORY."
1482 ;; This may not always be what you want, especially if target is your
1483 ;; home directory and it happens to be a symbolic link, as is often the
1484 ;; case with NFS and automounters. Or if you want to make symlinks
1485 ;; into directories that themselves are only symlinks, also quite
1486 ;; common.
1488 ;; So we don't use this function as value for HOW-TO in
1489 ;; dired-do-symlink, which has the minor disadvantage of
1490 ;; making links *into* a symlinked-dir, when you really wanted to
1491 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1492 ;; just have to remove that symlink by hand before making your marked
1493 ;; symlinks.
1496 "nil or a function used by `dired-do-copy' to determine target.
1499 ;;;###autoload
1501 "Copy all marked (or next ARG) files, or copy the current file.
1502 This normally preserves the last-modified date when copying.
1503 When operating on just the current file, you specify the new name.
1504 When operating on multiple or marked files, you specify a directory,
1505 and new copies of these files are made in that directory
1506 with the same names that the files currently have. The default
1507 suggested for the target directory depends on the value of
1508 `dired-dwim-target', which see."
1513 arg dired-keep-marker-copy
1514 nil dired-copy-how-to-fn)))
1516 ;;;###autoload
1518 "Make symbolic links to current file or all marked (or next ARG) files.
1519 When operating on just the current file, you specify the new name.
1520 When operating on multiple or marked files, you specify a directory
1521 and new symbolic links are made in that directory
1522 with the same names that the files currently have. The default
1523 suggested for the target directory depends on the value of
1524 `dired-dwim-target', which see."
1529 ;;;###autoload
1531 "Add names (hard links) current file or all marked (or next ARG) files.
1532 When operating on just the current file, you specify the new name.
1533 When operating on multiple or marked files, you specify a directory
1534 and new hard links are made in that directory
1535 with the same names that the files currently have. The default
1536 suggested for the target directory depends on the value of
1537 `dired-dwim-target', which see."
1544 ;; error is caught in -create-files
1546 ;; Update the link count
1549 ;;;###autoload
1551 "Rename current file or all marked (or next ARG) files.
1552 When renaming just the current file, you specify the new name.
1553 When renaming multiple or marked files, you specify a directory.
1554 This command also renames any buffers that are visiting the files.
1555 The default suggested for the target directory depends on the value
1556 of `dired-dwim-target', which see."
1560 ;;;###end dired-cp.el
1561 \f
1562 ;;; 5K
1563 ;;;###begin dired-re.el
1566 ;; Create a new file for each marked file using regexps.
1567 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1568 ;; ARG as in dired-get-marked-files.
1569 ;; Matches each marked file against REGEXP and constructs the new
1570 ;; filename from NEWNAME (like in function replace-match).
1571 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1572 ;; instead of only the non-directory part of the file.
1573 ;; Optional arg MARKER-CHAR as in dired-create-files.
1578 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1579 `!' to %s all remaining matches with no more questions."
1583 ;; Function to construct new filename using REGEXP and NEWNAME:
1588 ;; must bind help-form directly around call to
1589 ;; dired-query
1593 operation-prompt
1594 from
1595 to)
1596 to)
1598 operation from regexp)))))
1599 ;; not whole-name, replace non-directory part only
1610 operation-prompt
1613 to)
1616 rename-regexp-query)
1618 file-creator operation fn-list regexp-name-constructor marker-char)))
1621 ;; Prompt user about performing OPERATION.
1622 ;; Read and return list of: regexp newname arg whole-name.
1635 ;;;###autoload
1637 "Rename selected files whose names match REGEXP to NEWNAME.
1639 With non-zero prefix argument ARG, the command operates on the next ARG
1640 files. Otherwise, it operates on all the marked files, or the current
1641 file if none are marked.
1643 As each match is found, the user must type a character saying
1646 REGEXP defaults to the last regexp used.
1648 With a zero prefix arg, renaming by regexp affects the absolute file name.
1649 Normally, only the non-directory part of the file name is used and changed."
1655 ;;;###autoload
1657 "Copy selected files whose names match REGEXP to NEWNAME.
1658 See function `dired-do-rename-regexp' for more info."
1664 arg regexp newname whole-name dired-keep-marker-copy)))
1666 ;;;###autoload
1668 "Hardlink selected files whose names match REGEXP to NEWNAME.
1669 See function `dired-do-rename-regexp' for more info."
1675 ;;;###autoload
1677 "Symlink selected files whose names match REGEXP to NEWNAME.
1678 See function `dired-do-rename-regexp' for more info."
1686 ;; Perform FILE-CREATOR on the non-directory part of marked files
1687 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1688 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1691 file-creator
1692 operation
1700 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1701 `!' to %s all remaining matches with no more questions."
1708 to))))
1709 dired-keep-marker-rename)))
1714 basename-constructor operation arg))
1716 ;;;###autoload
1718 "Rename all marked (or next ARG) files to upper case."
1722 ;;;###autoload
1724 "Rename all marked (or next ARG) files to lower case."
1728 ;;;###end dired-re.el
1729 \f
1730 ;;; 13K
1731 ;;;###begin dired-ins.el
1733 ;;;###autoload
1735 switches no-error-if-not-dir-p)
1736 "Insert this subdirectory into the same dired buffer.
1738 else inserts it at its natural place (as `ls -lR' would have done).
1739 With a prefix arg, you may edit the ls switches used for this listing.
1740 You can add `R' to the switches to expand the whole tree starting at
1741 this subdirectory.
1742 This function takes some pains to conform to `ls -lR' output.
1744 Dired remembers switches specified with a prefix arg, so that reverting
1745 the buffer will not reset them. However, using `dired-undo' to re-insert
1746 or delete subdirectories can bypass this machinery. Hence, you sometimes
1747 may have to reset some subdirectory switches after a `dired-undo'.
1748 You can reset all subdirectory switches to the default using
1750 See Info node `(emacs-xtra)Subdir switches' for more details."
1757 ;; We don't need a marker for opoint as the subdir is always
1758 ;; inserted *after* opoint.
1763 ;; Push mark so that it's easy to find back. Do this after the
1764 ;; insert message so that the user sees the `Mark set' message.
1767 ;;;###autoload
1769 "Insert this subdirectory into the same dired buffer.
1770 If it is already present, overwrites previous entry,
1771 else inserts it at its natural place (as `ls -lR' would have done).
1772 With a prefix arg, you may edit the `ls' switches used for this listing.
1773 You can add `R' to the switches to expand the whole tree starting at
1774 this subdirectory.
1775 This function takes some pains to conform to `ls -lR' output."
1776 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1777 ;; Prospero where dired-ls does the right thing, but
1778 ;; file-directory-p has not been redefined.
1792 switches-have-R mark-alist case-fold-search buffer-read-only)
1795 ;; case-fold-search is nil now, so we can test for capital `R':
1797 ;; avoid duplicated subdirs
1800 ;; If subdir is already present, remove it and remember its marks
1823 ;; This is a separate function for dired-vms.
1825 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1826 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1839 ;; all switches that make a difference to dired-get-filename:
1843 ;; Add new DIR at NEW-MARKER. Sort alist.
1848 ;; Keep the alist sorted on buffer position.
1856 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1857 Interactively, you can kill DIRNAME as well by using a prefix argument.
1858 In interactive use, the command prompts for DIRNAME.
1860 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1861 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1872 m-alist))
1875 ;; Find pos for new subdir, according to tree order.
1876 ;;(goto-char (point-max))
1884 ;; Insert NEW-DIR after DIR
1886 alist nil)))
1888 ;; want a separating newline between subdirs
1895 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1896 ;; Move to that buffer position. Return a mark-alist.
1899 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1908 ;; Insert ls output after point.
1909 ;; Return the boundary of the inserted text (as list of BEG and END).
1914 dired-subdir-switches
1917 ;; If doing the top level directory of the buffer,
1918 ;; redo it as specified in dired-directory.
1924 ;; Point is at the correct subdir alist position for ELT,
1925 ;; BEG-END is the subdir-region (as list of begin and end).
1927 ;; update its position (should actually be unchanged)
1930 ;; The hook may depend on the subdir-alist containing the just
1931 ;; inserted subdir, so run it after dired-alist-add:
1939 ;; hook may add or delete lines, but the subdir boundary
1940 ;; marker floats
1944 ;; Lexicographic order on file name components, like `ls -lR':
1945 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1946 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1947 ;; or DIR1 and DIR2 are in the same parentdir and their last
1948 ;; components are string-lessp.
1949 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1950 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1951 ;; if dired-actual-switches contained `t'.
1957 components-2
1969 t)
1971 nil)
1974 ;; There should be a builtin split function - inverse to mapconcat.
1976 "Splitting on regexp PAT, turn string STR into a list of substrings.
1977 Optional third arg LIMIT (>= 1) is a limit to the length of the
1978 resulting list.
1979 Thus, if SEP is a regexp that only matches itself,
1981 (mapconcat 'identity (dired-split SEP STRING) SEP)
1983 is always equal to STRING."
1996 start end)
1997 ))
2004 \f
2005 ;;; moving by subdirectories
2007 ;;;###autoload
2009 "Go to previous subdirectory, regardless of level.
2010 When called interactively and not on a subdir line, go to this subdir's line."
2011 ;;(interactive "p")
2015 ;; if on subdir start already, don't stay there!
2025 ;;;###autoload
2027 "Go to end of header line of DIR in this dired buffer.
2028 Return value of point on success, otherwise return nil.
2034 dired-subdir-alist ; table
2035 nil ; predicate
2036 t ; require-match
2043 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2044 ;; at either \r or \n after this function succeeds.
2047 \f
2048 ;;;###autoload
2050 "Mark all files except `.' and `..' in current subdirectory.
2051 If the Dired buffer shows multiple directories, this command
2052 marks the files listed in the subdirectory that point is in."
2057 ;;;###autoload
2059 "Remove all lines of current subdirectory.
2060 Lower levels are unaffected."
2061 ;; With optional REMEMBER-MARKS, return a mark-alist.
2068 buffer-read-only)
2082 ;; Remove DIR from the alist
2086 ;;;###autoload
2088 "Go up ARG levels in the dired tree."
2094 ;;(setq dir (expand-file-name dir))
2098 ;;;###autoload
2100 "Go down in the dired tree."
2114 \f
2115 ;;; hiding
2131 ;;;###autoload
2133 "Hide or unhide the current subdirectory and move to next directory.
2134 Optional prefix arg is a repeat factor.
2144 buffer-read-only)
2145 ;; keep header line visible, hide rest
2154 ;;;###autoload
2156 "Hide all subdirectories, leaving only their header lines.
2157 If there is already something hidden, make everything visible again.
2162 buffer-read-only)
2166 ;; unhide - bombs on \r in filenames
2168 ;; hide
2175 ;; we're somewhere on current dir's line
2183 ;;;###end dired-ins.el
2185 \f
2186 ;; Functions for searching in tags style among marked files.
2188 ;;;###autoload
2190 "Search through all marked files for a match for REGEXP.
2191 Stops when a match is found.
2196 ;;;###autoload
2198 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2199 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2207 buffer-read-only))
2214 \f
2215 ;;;###autoload
2217 "Print the type of FILE, according to the `file' command.
2218 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2219 true then the type of the file linked to by FILE is printed instead."
2231 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2232 ;;; dired-aux.el ends here