| blob | ca6f12e0fc75d498e10cb75e9a44f7f6a665cdc4 |
1 ;;; dired-aux.el --- less commonly used parts of dired -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001
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'."
71 diff-switches
75 ;;;###autoload
77 "Diff this file with its backup file or vice versa.
78 Uses the latest backup, if there are several numerical backups.
79 If this file is a backup, diff it with its original.
80 The backup file is the first file given to `diff'.
81 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
86 diff-switches
88 nil))
92 ;; Change file attributes (mode, group, owner) of marked files and
93 ;; refresh their file lines.
94 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
95 ;; PROGRAM is the program used to change the attribute.
96 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
97 ;; ARG describes which files to use, as in dired-get-marked-files.
102 nil op-symbol arg files))
104 failures)
112 files))
117 nil))))
119 ;;;###autoload
121 "Change the mode of the marked (or next ARG) files.
122 This calls chmod, thus symbolic modes like `g+w' are allowed."
126 ;;;###autoload
128 "Change the group of the marked (or next ARG) files."
134 ;;;###autoload
136 "Change the owner of the marked (or next ARG) files."
142 ;; Process all the files in FILES in batches of a convenient size,
143 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
144 ;; Batches are chosen to need less than MAX chars for the file names,
145 ;; allowing 3 extra characters of separator per file name.
148 past
150 failures)
151 ;; Accumulate files as long as they fit in MAX chars,
152 ;; then process the ones accumulated so far.
157 ;; If we have at least 1 pending file
158 ;; and this file won't fit in the length limit, process now.
161 ;; The elements of PENDING are now in forward order.
162 ;; Do the operation and record failures.
164 failures)
165 ;; Transfer the elemens of PENDING onto PAST
166 ;; and clear it out. Now PAST contains the first N files
167 ;; specified (for some N), and FILES contains the rest.
169 pending nil
171 ;; Do (setq pending (cons thisfile pending))
172 ;; but reuse the cons that was in `files'.
180 failures)
181 ;; Now the original list FILES has been put back as it was.
184 ;;;###autoload
186 "Print the marked (or next ARG) files.
187 Uses the shell command coming from variables `lpr-command' and
188 `lpr-switches' as default."
192 "Print %s with: "
197 lpr-switches))
202 ;; Read arguments for a marked-files command that wants a string
203 ;; that is not a file name,
204 ;; perhaps popping up the list of marked files.
205 ;; ARG is the prefix arg and indicates whether the files came from
206 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
207 ;; If the current file was used, the list has but one element and ARG
208 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
211 ;; PROMPT for a string, with INITIAL input.
212 ;; Other args are used to give user feedback and pop-up:
213 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
215 nil op-symbol files
218 \f
219 ;;; Cleaning a directory: flagging some backups for deletion.
224 "Flag numerical backups for deletion.
225 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
226 Positive prefix arg KEEP overrides `dired-kept-versions';
227 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
230 with a prefix argument."
237 late-retention early-retention)
238 ;; Look at each file.
239 ;; If the file has numeric backup versions,
240 ;; put on dired-file-version-alist an element of the form
241 ;; (FILENAME . VERSION-NUMBER-LIST)
243 ;; Sort each VERSION-NUMBER-LIST,
244 ;; and remove the versions not to be deleted.
252 sorted-v-list)))
256 ;; Look at each file. If it is a numeric backup file,
257 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
261 ;;; Subroutines of dired-clean-directory.
264 ;; Perform FUN with point at the end of each non-directory line.
265 ;; FUN takes one argument, the absolute filename.
280 ;; Only do work if this file is not already in the alist.
282 nil
283 ;; If it looks like file FN has versions, return a list of the versions.
284 ;;That is a list of strings which are file names.
285 ;;The caller may want to flag some of these files for deletion.
290 base-versions
296 dired-file-version-alist)))))))
300 base-version-list)
310 \f
311 ;;; Shell commands
314 ;; "Read a dired shell command prompting with PROMPT (using read-string).
315 ;;ARG is the prefix arg and may be used to indicate in the prompt which
316 ;; files are affected.
317 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
319 nil 'shell files
324 ;; The in-background argument is only needed in Emacs 18 where
325 ;; shell-command doesn't understand an appended ampersand `&'.
326 ;;;###autoload
328 "Run a shell command COMMAND on the marked files.
329 If no files are marked or a specific numeric prefix arg is given,
331 The prompt mentions the file(s) or the marker, as appropriate.
333 If there is a `*' in COMMAND, surrounded by whitespace, this runs
334 COMMAND just once with the entire file list substituted there.
336 If there is no `*', but there is a `?' in COMMAND, surrounded by
337 whitespace, this runs COMMAND on each file individually with the
338 file name substituted for `?'.
340 Otherwise, this runs COMMAND on each file individually with the
341 file name added at the end of COMMAND (separated by a space).
343 `*' and `?' when not surrounded by whitespace have no special
344 significance for `dired-do-shell-command', and are passed through
345 normally to the shell, but you must confirm first. To pass `*' by
348 If COMMAND produces output, it goes to a separate buffer.
350 This feature does not try to redisplay Dired buffers afterward, as
351 there's no telling what files COMMAND may have changed.
354 When COMMAND runs, its working directory is the top-level directory of
355 the Dired buffer, so output files usually are created there instead of
356 in a subdir.
358 In a noninteractive call (from Lisp code), you must specify
359 the list of file names explicitly with the FILE-LIST argument."
360 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
361 ;;actual work and can be redefined for customization.
365 ;; Want to give feedback whether this file or marked files are used:
368 current-prefix-arg
369 files)
370 current-prefix-arg
371 files)))
376 ;; Get confirmation for wildcards that may have been meant
377 ;; to control substitution of a file name or the file name list.
391 nil
392 file-list)
393 ;; execute the shell command
397 ;; Might use {,} for bash or csh:
406 ;; "Make up a shell command line from COMMAND and FILE-LIST.
407 ;; If ON-EACH is t, COMMAND should be applied to each file, else
408 ;; simply concat all files and apply COMMAND to this.
409 ;; FILE-LIST's elements will be quoted for the shell."
410 ;; Might be redefined for smarter things and could then use RAW-ARG
411 ;; (coming from interactive P and currently ignored) to decide what to do.
412 ;; Smart would be a way to access basename or extension of file names.
421 retval))
426 file-list dired-mark-separator)))
431 ;; This is an extra function so that it can be redefined by ange-ftp.
438 ;; Return nil for sake of nconc in dired-bunch-files.
439 nil)
440 \f
441 ;; In Emacs 19 this will return program's exit status.
442 ;; This is a separate function so that ange-ftp can redefine it.
444 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
445 ;Remaining arguments are strings passed as command arguments to PROGRAM."
446 ;; Look for a handler for default-directory in case it is a remote file name.
451 program discard arguments)
455 ; "Display MSG while running PROGRAM, and check for output.
456 ;Remaining arguments are strings passed as command arguments to PROGRAM.
457 ; On error, insert output
458 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
459 ; Caller can cons up a list of failed args.
460 ;Else returns nil for success."
464 ;; Get a clean buffer for error output:
478 nil))))
479 \f
480 ;; Commands that delete or redisplay part of the dired buffer.
501 ;;;###autoload
503 "Kill all marked lines (not the files).
504 With a prefix argument, kill that many lines starting with the current line.
505 \(A negative argument kills lines before the current line.)
506 To kill an entire subdirectory, go to its directory header line
507 and use this command with a prefix argument (the value does not matter)."
508 ;; Returns count of killed lines. FMT="" suppresses message.
524 ;; else kill unmarked lines
535 count))))
537 ;;;###end dired-cmd.el
538 \f
539 ;;; 30K
540 ;;;###begin dired-cp.el
543 ;; Compress or uncompress the current file.
544 ;; Return nil for success, offending filename else.
550 ;; Remove any preexisting entry for the name NEW-FILE.
555 ;; Now replace the current line with an entry for NEW-FILE.
558 from-file)))
564 ;; For .z, try gunzip. It might be an old gzip file,
565 ;; or it might be from compact? pack? (which?) but gunzip handles both.
568 ;; This item controls naming for compression.
570 "Control changes in file name suffixes for compression and uncompression.
571 Each element specifies one transformation rule, and has the form:
572 (REGEXP NEW-SUFFIX PROGRAM)
573 The rule applies when the old file name matches REGEXP.
574 The new file name is computed by deleting the part that matches REGEXP
575 (as well as anything after that), then adding NEW-SUFFIX in its place.
576 If PROGRAM is non-nil, the rule is an uncompression rule,
577 and uncompression is done by running PROGRAM.
580 ;;;###autoload
582 ;; Compress or uncompress FILE.
583 ;; Return the name of the compressed or uncompressed file.
584 ;; Return nil if no change in files.
586 suffix newname
588 ;; See if any suffix rule matches this file name.
594 ;; If so, compute desired new name.
601 nil)
603 ;; We found an uncompression rule.
606 newname))
608 ;;; We don't recognize the file as compressed, so compress it.
609 ;;; Try gzip; if we don't have that, use compress.
617 ;; Rename the compressed file to NEWNAME
618 ;; if it hasn't got that name already.
622 newname)
623 out-name)))
627 ;; Don't use NEWNAME with `compress'.
629 \f
631 ;; Request confirmation from the user that the operation described
632 ;; by OP-SYMBOL is to be performed on the marked files.
633 ;; Confirmation consists in a y-or-n question with a file list
634 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
635 ;; The files used are determined by ARG (as in dired-get-marked-files).
646 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
647 ; and display failures.
649 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
650 ; the short form of the filename) for a failure and probably logs a
651 ; detailed error explanation using function `dired-log'.
653 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
654 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
655 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
656 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
658 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
670 ;; end this bunch of errors:
674 failures)))))
681 ;; None of these keys quit - use C-g for that.
682 ))
685 ;; Query user and return nil or t.
686 ;; Store answer in symbol VAR (which must initially be bound to nil).
687 ;; Format PROMPT with ARGS.
688 ;; Binding variable help-form will help the user who types the help key.
702 result elt)
703 ;; Actually it looks nicer without cursor-in-echo-area - you can
704 ;; look at the dired buffer instead of at the prompt to decide.
714 \f
715 ;;;###autoload
717 "Compress or uncompress marked (or next ARG) files."
721 ;; Commands for Emacs Lisp files - load and byte compile
724 ;; Return nil for success, offending file name else.
726 elc-file buffer-read-only failure)
741 nil)))
743 ;;;###autoload
745 "Byte compile marked (or next ARG) Emacs Lisp files."
750 ;; Return nil for success, offending file name else.
756 nil
760 ;;;###autoload
762 "Load the marked (or next ARG) Emacs Lisp files."
766 ;;;###autoload
768 "Redisplay all marked (or next ARG) files.
769 If on a subdir line, redisplay that subdirectory. In that case,
770 a prefix arg lets you edit the `ls' switches used for the new listing."
771 ;; Moves point if the next ARG files are redisplayed.
778 ;; message much faster than making dired-map-over-marks show progress
784 arg)
787 \f
789 ;; Delete the current line, and insert an entry for FILE.
790 ;; If FILE is nil, then just delete the current line.
791 ;; Keeps any marks that may be present in column one (doing this
792 ;; here is faster than with dired-add-entry's optional arg).
793 ;; Does not update other dired buffers. Use dired-relist-entry for that.
801 ;; Replace space by old marker without moving point.
802 ;; Faster than goto+insdel inside a save-excursion?
806 ;;;###autoload
813 ;; Add a new entry for FILENAME, optionally marking it
814 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
815 ;; Note that this adds the entry `out of order' if files sorted by
816 ;; time, etc.
817 ;; At least this version inserts in the right subdirectory (if present).
818 ;; And it skips "." or ".." (see `dired-trivial-filenames').
819 ;; Hidden subdirs are exposed if a file is added there.
821 ;; Entry is always for files, even if they happen to also be directories
826 reason)
831 reason
838 ;; We are already where we should be, except when
839 ;; point is before the subdir line or its total line.
843 ;; else try to find correct place to insert
848 ;; found - skip subdir and `total' line
849 ;; and uninteresting files like . and ..
850 ;; This better not moves into the next subdir!
852 ;; not found
857 ;; Don't expand `.'. Show just the file name within directory.
863 ;; Put in desired marker char.
868 ;; Compensate for a bug in ange-ftp.
869 ;; It inserts the file's absolute name, rather than
870 ;; the relative one. That may be hard to fix since it
871 ;; is probably controlled by something in ftp.
894 ;; return nil if all went well
895 nil))
901 ;; Return pos of first file line of DIR, skipping header and total
902 ;; or wildcard lines.
903 ;; Important: never moves into the next subdir.
904 ;; DIR is assumed to be unhidden.
905 ;; Will probably be redefined for VMS etc.
914 ;;;###autoload
927 ;;;###autoload
929 "Create or update the line for FILE in all Dired buffers it would belong in."
935 ;; Relist the line for FILE, or just add it if it did not exist.
936 ;; FILE must be an absolute file name.
938 ;; If cursor is already on FILE's line delete-region will cause
939 ;; save-excursion to fail because of floating makers,
940 ;; moving point to beginning of line. Sigh.
949 \f
950 ;;; Copy, move/rename, making hard and symbolic links
953 "*Decide whether recursive copies are allowed.
954 nil means no recursive copies.
955 `always' means copy recursively without asking.
956 `top' means ask for each directory at top level.
957 Anything else means ask for each directory."
966 "*Non-nil if Dired should ask about making backups before overwriting files.
967 Special value `always' suppresses confirmation."
976 ;; Save old version of file TO that is to be overwritten.
977 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
978 ;; from dired-create-files.
981 dired-overwrite-confirmed
986 to))))
991 ;;;###autoload
996 dired-recursive-copies)
1001 preserve-time top recursive)
1015 ok-flag preserve-time nil recursive)
1020 ;;;###autoload
1024 ;; Silently rename the visited file of any buffer visiting this file.
1029 ;; See if it's an inserted subdir, and rename that, too.
1037 ;; Update visited file name of all affected buffers
1048 to-dir
1049 buffer-file-name)))
1055 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1056 ;; one of its subdirectories is expanded in this buffer.
1064 ;; ELT's subdir is affected by the rename
1067 ;; if top level directory was renamed, lots of things have to be
1068 ;; updated:
1073 ;; with and without wildcards
1075 to))
1078 ;; try to rename buffer, but just leave old name if new
1079 ;; name would already exist (don't try appending "<%d>")
1082 ;; ... we dired TO now:
1086 ;; Update the headerline and dired-subdir-alist element of directory
1087 ;; described by alist-element ELT to reflect the moving of DIR to TO.
1088 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
1092 buffer-read-only)
1094 ;; Update subdir headerline in buffer
1097 dir)
1102 ;; Update buffer-local dired-subdir-alist
1106 \f
1107 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1111 ;; Create a new file for each from a list of existing files. The user
1112 ;; is queried, dired buffers are updated, and at the end a success or
1113 ;; failure message is displayed
1115 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1117 ;; It is called for each file and must create newfile, the entry of
1118 ;; which will be added. The user will be queried if the file already
1119 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1120 ;; rename), it is FILE-CREATOR's responsibility to update dired
1121 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1122 ;; could not create newfile. The error is caught and logged.
1124 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1125 ;; operation performed. It is used for error logging.
1127 ;; FN-LIST is the list of files to copy (full absolute file names).
1129 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1130 ;; skip. If it skips files for other reasons than a direct user
1131 ;; query, it is supposed to tell why (using dired-log).
1133 ;; Optional MARKER-CHAR is a character with which to mark every
1134 ;; newfile's entry, or t to use the current marker character if the
1135 ;; oldfile was marked.
1155 Type SPC or `y' to overwrite file `%s',
1156 DEL or `n' to skip to next,
1157 ESC or `q' to not overwrite any of the remaining files,
1161 ;; must determine if FROM is marked before file-creator
1162 ;; gets a chance to delete it (in case of a move).
1171 ;; If we get here, file-creator hasn't been aborted
1172 ;; and the old entry (if any) has to be deleted
1173 ;; before adding the new entry.
1182 operation from to err))))))))
1183 fn-list))
1190 failures))
1196 skipped))
1201 \f
1203 &optional marker-char op1
1204 how-to)
1205 "Create a new file for each marked file.
1206 Prompts user for target, which is a directory in which to create
1207 the new files. Target may be a plain file if only one marked
1208 file exists. The way the default for the target directory is
1209 computed depends on the value of `dired-dwim-target-directory'.
1210 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1211 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1212 FILE-CREATOR and OPERATION as in `dired-create-files'.
1213 ARG as in `dired-get-marked-files'.
1214 Optional arg MARKER-CHAR as in `dired-create-files'.
1215 Optional arg OP1 is an alternate form for OPERATION if there is
1216 only one file.
1217 Optional arg HOW-TO is used to set the value of the into-dir variable
1218 which determines how to treat target.
1219 If into-dir is set to nil then target is not regarded as a directory,
1220 there must be exactly one marked file, else error.
1221 Else if into-dir is set to a list, then target is a generalized
1222 directory (e.g. some sort of archive). The first element of into-dir
1223 must be a function with at least four arguments:
1224 operation as OPERATION above.
1225 rfn-list a list of the relative names for the marked files.
1226 fn-list a list of the absolute names for the marked files.
1227 target.
1228 The rest of into-dir are optional arguments.
1229 Else into-dir is not a list. Target is a directory.
1230 The marked file(s) are created inside the target directory.
1232 If HOW-TO is not given (or nil), then into-dir is set to true if
1233 target is a directory and otherwise to nil.
1234 Else if HOW-TO is t, then into-dir is set to nil.
1235 Else HOW-TO is assumed to be a function of one argument, target,
1236 that looks at target and returns a value for the into-dir
1237 variable. The function `dired-into-dir-with-symlinks' is provided
1238 for the case (common when creating symlinks) that symbolic
1239 links to directories are not to be considered as directories
1240 (as `file-directory-p' would if HOW-TO had been nil)."
1249 target-dir)))
1253 target-dir op-symbol arg rfn-list default)))
1255 ;; Allow DOS/Windows users to change the letter
1256 ;; case of a directory. If we don't test these
1257 ;; conditions up front, file-directory-p below
1258 ;; will return t because the filesystem is
1259 ;; case-insensitive, and Emacs will try to move
1260 ;; foo -> foo/foo, which fails.
1263 dired-one-file
1271 nil
1279 ;; rename-file bombs when moving directories unless we do this:
1282 file-creator operation fn-list
1284 ;; This function uses fluid variable target when called
1285 ;; inside dired-create-files:
1290 marker-char))))
1292 ;; Read arguments for a marked-files command that wants a file name,
1293 ;; perhaps popping up the list of marked files.
1294 ;; ARG is the prefix arg and indicates whether the files came from
1295 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1296 ;; If the current file was used, the list has but one element and ARG
1297 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1298 ;; DEFAULT is the default value to return if the user just hits RET;
1299 ;; if it is omitted or nil, then the name of the directory is used.
1304 nil op-symbol files
1309 ;; Try to guess which target directory the user may want.
1310 ;; If there is a dired buffer displayed in the next window, use
1311 ;; its current subdir, else use current subdir of this dired buffer.
1314 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1322 this-dir)))
1323 \f
1324 ;;;###autoload
1326 "Create a directory called DIRECTORY."
1337 ;; This may not always be what you want, especially if target is your
1338 ;; home directory and it happens to be a symbolic link, as is often the
1339 ;; case with NFS and automounters. Or if you want to make symlinks
1340 ;; into directories that themselves are only symlinks, also quite
1341 ;; common.
1343 ;; So we don't use this function as value for HOW-TO in
1344 ;; dired-do-symlink, which has the minor disadvantage of
1345 ;; making links *into* a symlinked-dir, when you really wanted to
1346 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1347 ;; just have to remove that symlink by hand before making your marked
1348 ;; symlinks.
1351 "nil or a function used by `dired-do-copy' to determine target.
1354 ;;;###autoload
1356 "Copy all marked (or next ARG) files, or copy the current file.
1357 This normally preserves the last-modified date when copying.
1358 When operating on just the current file, you specify the new name.
1359 When operating on multiple or marked files, you specify a directory,
1360 and new copies of these files are made in that directory
1361 with the same names that the files currently have. The default
1362 suggested for the target directory depends on the value of
1363 `dired-dwim-target', which see."
1368 arg dired-keep-marker-copy
1369 nil dired-copy-how-to-fn)))
1371 ;;;###autoload
1373 "Make symbolic links to current file or all marked (or next ARG) files.
1374 When operating on just the current file, you specify the new name.
1375 When operating on multiple or marked files, you specify a directory
1376 and new symbolic links are made in that directory
1377 with the same names that the files currently have. The default
1378 suggested for the target directory depends on the value of
1379 `dired-dwim-target', which see."
1384 ;;;###autoload
1386 "Add names (hard links) current file or all marked (or next ARG) files.
1387 When operating on just the current file, you specify the new name.
1388 When operating on multiple or marked files, you specify a directory
1389 and new hard links are made in that directory
1390 with the same names that the files currently have. The default
1391 suggested for the target directory depends on the value of
1392 `dired-dwim-target', which see."
1399 ;; error is caught in -create-files
1401 ;; Update the link count
1404 ;;;###autoload
1406 "Rename current file or all marked (or next ARG) files.
1407 When renaming just the current file, you specify the new name.
1408 When renaming multiple or marked files, you specify a directory.
1409 This command also renames any buffers that are visiting the files.
1410 The default suggested for the target directory depends on the value
1411 of `dired-dwim-target', which see."
1415 ;;;###end dired-cp.el
1416 \f
1417 ;;; 5K
1418 ;;;###begin dired-re.el
1421 ;; Create a new file for each marked file using regexps.
1422 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1423 ;; ARG as in dired-get-marked-files.
1424 ;; Matches each marked file against REGEXP and constructs the new
1425 ;; filename from NEWNAME (like in function replace-match).
1426 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1427 ;; instead of only the non-directory part of the file.
1428 ;; Optional arg MARKER-CHAR as in dired-create-files.
1433 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1434 `!' to %s all remaining matches with no more questions."
1438 ;; Function to construct new filename using REGEXP and NEWNAME:
1443 ;; must bind help-form directly around call to
1444 ;; dired-query
1448 operation-prompt
1449 from
1450 to)
1451 to)
1453 operation from regexp)))))
1454 ;; not whole-name, replace non-directory part only
1465 operation-prompt
1468 to)
1471 rename-regexp-query)
1473 file-creator operation fn-list regexp-name-constructor marker-char)))
1476 ;; Prompt user about performing OPERATION.
1477 ;; Read and return list of: regexp newname arg whole-name.
1490 ;;;###autoload
1492 "Rename selected files whose names match REGEXP to NEWNAME.
1494 With non-zero prefix argument ARG, the command operates on the next ARG
1495 files. Otherwise, it operates on all the marked files, or the current
1496 file if none are marked.
1498 As each match is found, the user must type a character saying
1501 REGEXP defaults to the last regexp used.
1503 With a zero prefix arg, renaming by regexp affects the absolute file name.
1504 Normally, only the non-directory part of the file name is used and changed."
1510 ;;;###autoload
1512 "Copy selected files whose names match REGEXP to NEWNAME.
1513 See function `dired-do-rename-regexp' for more info."
1519 arg regexp newname whole-name dired-keep-marker-copy)))
1521 ;;;###autoload
1523 "Hardlink selected files whose names match REGEXP to NEWNAME.
1524 See function `dired-do-rename-regexp' for more info."
1530 ;;;###autoload
1532 "Symlink selected files whose names match REGEXP to NEWNAME.
1533 See function `dired-do-rename-regexp' for more info."
1541 ;; Perform FILE-CREATOR on the non-directory part of marked files
1542 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1543 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1546 file-creator
1547 operation
1555 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1556 `!' to %s all remaining matches with no more questions."
1563 to))))
1564 dired-keep-marker-rename)))
1569 basename-constructor operation arg))
1571 ;;;###autoload
1573 "Rename all marked (or next ARG) files to upper case."
1577 ;;;###autoload
1579 "Rename all marked (or next ARG) files to lower case."
1583 ;;;###end dired-re.el
1584 \f
1585 ;;; 13K
1586 ;;;###begin dired-ins.el
1588 ;;;###autoload
1590 switches no-error-if-not-dir-p)
1591 "Insert this subdirectory into the same dired buffer.
1593 else inserts it at its natural place (as `ls -lR' would have done).
1594 With a prefix arg, you may edit the ls switches used for this listing.
1595 You can add `R' to the switches to expand the whole tree starting at
1596 this subdirectory.
1597 This function takes some pains to conform to `ls -lR' output."
1603 ;; We don't need a marker for opoint as the subdir is always
1604 ;; inserted *after* opoint.
1609 ;; Push mark so that it's easy to find back. Do this after the
1610 ;; insert message so that the user sees the `Mark set' message.
1613 ;;;###autoload
1615 "Insert this subdirectory into the same dired buffer.
1616 If it is already present, overwrites previous entry,
1617 else inserts it at its natural place (as `ls -lR' would have done).
1618 With a prefix arg, you may edit the `ls' switches used for this listing.
1619 You can add `R' to the switches to expand the whole tree starting at
1620 this subdirectory.
1621 This function takes some pains to conform to `ls -lR' output."
1622 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1623 ;; Prospero where dired-ls does the right thing, but
1624 ;; file-directory-p has not been redefined.
1635 switches-have-R mark-alist case-fold-search buffer-read-only)
1636 ;; case-fold-search is nil now, so we can test for capital `R':
1638 ;; avoid duplicated subdirs
1641 ;; If subdir is already present, remove it and remember its marks
1650 ;; This is a separate function for dired-vms.
1652 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1653 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1664 x))))
1665 ;; all switches that make a difference to dired-get-filename:
1669 ;; Add new DIR at NEW-MARKER. Sort alist.
1674 ;; Keep the alist sorted on buffer position.
1682 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1683 With optional arg REMEMBER-MARKS, return an alist of marked files."
1694 m-alist))
1697 ;; Find pos for new subdir, according to tree order.
1698 ;;(goto-char (point-max))
1706 ;; Insert NEW-DIR after DIR
1708 alist nil)))
1710 ;; want a separating newline between subdirs
1717 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1718 ;; Move to that buffer position. Return a mark-alist.
1721 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1730 ;; Insert ls output after point.
1731 ;; Return the boundary of the inserted text (as list of BEG and END).
1739 ;; If doing the top level directory of the buffer,
1740 ;; redo it as specified in dired-directory.
1747 ;; Point is at the correct subdir alist position for ELT,
1748 ;; BEG-END is the subdir-region (as list of begin and end).
1750 ;; update its position (should actually be unchanged)
1753 ;; The hook may depend on the subdir-alist containing the just
1754 ;; inserted subdir, so run it after dired-alist-add:
1762 ;; hook may add or delete lines, but the subdir boundary
1763 ;; marker floats
1767 ;; Lexicographic order on file name components, like `ls -lR':
1768 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1769 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1770 ;; or DIR1 and DIR2 are in the same parentdir and their last
1771 ;; components are string-lessp.
1772 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1773 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1774 ;; if dired-actual-switches contained `t'.
1780 components-2
1792 t)
1794 nil)
1797 ;; There should be a builtin split function - inverse to mapconcat.
1799 "Splitting on regexp PAT, turn string STR into a list of substrings.
1800 Optional third arg LIMIT (>= 1) is a limit to the length of the
1801 resulting list.
1802 Thus, if SEP is a regexp that only matches itself,
1804 (mapconcat 'identity (dired-split SEP STRING) SEP)
1806 is always equal to STRING."
1819 start end)
1820 ))
1827 \f
1828 ;;; moving by subdirectories
1830 ;;;###autoload
1832 "Go to previous subdirectory, regardless of level.
1833 When called interactively and not on a subdir line, go to this subdir's line."
1834 ;;(interactive "p")
1838 ;; if on subdir start already, don't stay there!
1848 ;;;###autoload
1850 "Go to end of header line of DIR in this dired buffer.
1851 Return value of point on success, otherwise return nil.
1857 dired-subdir-alist ; table
1858 nil ; predicate
1859 t ; require-match
1866 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1867 ;; at either \r or \n after this function succeeds.
1870 \f
1871 ;;;###autoload
1873 "Mark all files except `.' and `..' in current subdirectory.
1874 If the Dired buffer shows multiple directories, this command
1875 marks the files listed in the subdirectory that point is in."
1880 ;;;###autoload
1882 "Remove all lines of current subdirectory.
1883 Lower levels are unaffected."
1884 ;; With optional REMEMBER-MARKS, return a mark-alist.
1888 buffer-read-only cur-dir)
1900 ;; Remove DIR from the alist
1904 ;;;###autoload
1906 "Go up ARG levels in the dired tree."
1912 ;;(setq dir (expand-file-name dir))
1916 ;;;###autoload
1918 "Go down in the dired tree."
1932 \f
1933 ;;; hiding
1949 ;;;###autoload
1951 "Hide or unhide the current subdirectory and move to next directory.
1952 Optional prefix arg is a repeat factor.
1961 buffer-read-only)
1962 ;; keep header line visible, hide rest
1970 ;;;###autoload
1972 "Hide all subdirectories, leaving only their header lines.
1973 If there is already something hidden, make everything visible again.
1981 ;; unhide - bombs on \r in filenames
1983 ;; hide
1990 ;; we're somewhere on current dir's line
1997 ;;;###end dired-ins.el
1999 \f
2000 ;; Functions for searching in tags style among marked files.
2002 ;;;###autoload
2004 "Search through all marked files for a match for REGEXP.
2005 Stops when a match is found.
2010 ;;;###autoload
2012 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2013 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2023 \f
2024 ;;;###autoload
2026 "Print the type of FILE, according to the `file' command.
2027 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2028 true then the type of the file linked to by FILE is printed instead."
2040 ;;; dired-aux.el ends here