| blob | 77f06456c4cecf049be554be70d6f6a84831d67a |
1 ;;; dired-aux.el --- less commonly used parts of dired -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998 Free Software Foundation, Inc.
5 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; The parts of dired mode not normally used. This is a space-saving hack
28 ;; to avoid having to load a large mode when all that's wanted are a few
29 ;; functions.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
37 ;; We need macros in dired.el to compile properly.
40 ;;; 15K
41 ;;;###begin dired-cmd.el
42 ;; Diffing and compressing
44 ;;;###autoload
46 "Compare file at point with file FILE using `diff'.
47 FILE defaults to the file at the mark.
48 The prompted-for file is the first file given to `diff'.
49 With prefix arg, prompt for second argument SWITCHES,
50 which is options for `diff'."
65 diff-switches
69 ;;;###autoload
71 "Diff this file with its backup file or vice versa.
72 Uses the latest backup, if there are several numerical backups.
73 If this file is a backup, diff it with its original.
74 The backup file is the first file given to `diff'.
75 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
80 diff-switches
82 nil))
86 ;; Change file attributes (mode, group, owner) of marked files and
87 ;; refresh their file lines.
88 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
89 ;; PROGRAM is the program used to change the attribute.
90 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
91 ;; ARG describes which files to use, as in dired-get-marked-files.
96 nil op-symbol arg files))
98 failures)
106 files))
111 nil))))
113 ;;;###autoload
115 "Change the mode of the marked (or next ARG) files.
116 This calls chmod, thus symbolic modes like `g+w' are allowed."
120 ;;;###autoload
122 "Change the group of the marked (or next ARG) files."
128 ;;;###autoload
130 "Change the owner of the marked (or next ARG) files."
136 ;; Process all the files in FILES in batches of a convenient size,
137 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
138 ;; Batches are chosen to need less than MAX chars for the file names,
139 ;; allowing 3 extra characters of separator per file name.
143 failures)
144 ;; Accumulate files as long as they fit in MAX chars,
145 ;; then process the ones accumulated so far.
150 ;; If we have at least 1 pending file
151 ;; and this file won't fit in the length limit, process now.
155 failures)
156 pending nil
158 ;; Do (setq pending (cons thisfile pending))
159 ;; but reuse the cons that was in `files'.
165 failures)))
167 ;;;###autoload
169 "Print the marked (or next ARG) files.
170 Uses the shell command coming from variables `lpr-command' and
171 `lpr-switches' as default."
175 "Print %s with: "
180 lpr-switches))
185 ;; Read arguments for a marked-files command that wants a string
186 ;; that is not a file name,
187 ;; perhaps popping up the list of marked files.
188 ;; ARG is the prefix arg and indicates whether the files came from
189 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
190 ;; If the current file was used, the list has but one element and ARG
191 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
194 ;; PROMPT for a string, with INITIAL input.
195 ;; Other args are used to give user feedback and pop-up:
196 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
198 nil op-symbol files
201 \f
202 ;;; Cleaning a directory: flagging some backups for deletion.
207 "Flag numerical backups for deletion.
208 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
209 Positive prefix arg KEEP overrides `dired-kept-versions';
210 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
213 with a prefix argument."
220 late-retention early-retention)
221 ;; Look at each file.
222 ;; If the file has numeric backup versions,
223 ;; put on dired-file-version-alist an element of the form
224 ;; (FILENAME . VERSION-NUMBER-LIST)
226 ;; Sort each VERSION-NUMBER-LIST,
227 ;; and remove the versions not to be deleted.
235 sorted-v-list)))
239 ;; Look at each file. If it is a numeric backup file,
240 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
244 ;;; Subroutines of dired-clean-directory.
247 ;; Perform FUN with point at the end of each non-directory line.
248 ;; FUN takes one argument, the absolute filename.
263 ;; Only do work if this file is not already in the alist.
265 nil
266 ;; If it looks like file FN has versions, return a list of the versions.
267 ;;That is a list of strings which are file names.
268 ;;The caller may want to flag some of these files for deletion.
273 base-versions
279 dired-file-version-alist)))))))
283 base-version-list)
293 \f
294 ;;; Shell commands
297 ;; "Read a dired shell command prompting with PROMPT (using read-string).
298 ;;ARG is the prefix arg and may be used to indicate in the prompt which
299 ;; files are affected.
300 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
302 nil 'shell files
307 ;; The in-background argument is only needed in Emacs 18 where
308 ;; shell-command doesn't understand an appended ampersand `&'.
309 ;;;###autoload
311 "Run a shell command COMMAND on the marked files.
312 If no files are marked or a specific numeric prefix arg is given,
314 The prompt mentions the file(s) or the marker, as appropriate.
316 If there is output, it goes to a separate buffer.
318 Normally the command is run on each file individually.
319 However, if there is a `*' in the command then it is run
320 just once with the entire file list substituted there.
322 If there is no `*', but a `?' in the command then it is still run
323 on each file individually but with the filename substituted there
324 instead of att the end of the command.
326 No automatic redisplay of dired buffers is attempted, as there's no
327 telling what files the command may have changed. Type
330 The shell command has the top level directory as working directory, so
331 output files usually are created there instead of in a subdir.
333 In a noninteractive call (from Lisp code), you must specify
334 the list of file names explicitly with the FILE-LIST argument."
335 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
336 ;;actual work and can be redefined for customization.
340 ;; Want to give feedback whether this file or marked files are used:
343 current-prefix-arg
344 files)
345 current-prefix-arg
346 files)))
354 nil
355 file-list)
356 ;; execute the shell command
360 ;; Might use {,} for bash or csh:
369 ;; "Make up a shell command line from COMMAND and FILE-LIST.
370 ;; If ON-EACH is t, COMMAND should be applied to each file, else
371 ;; simply concat all files and apply COMMAND to this.
372 ;; FILE-LIST's elements will be quoted for the shell."
373 ;; Might be redefined for smarter things and could then use RAW-ARG
374 ;; (coming from interactive P and currently ignored) to decide what to do.
375 ;; Smart would be a way to access basename or extension of file names.
376 ;; See dired-trns.el for an approach to this.
377 ;; Bug: There is no way to quote a * or a ?
378 ;; On the other hand, you can never accidentally get a * or a ? into
379 ;; your cmd.
391 file-list dired-mark-separator)))
396 ;; This is an extra function so that it can be redefined by ange-ftp.
403 ;; Return nil for sake of nconc in dired-bunch-files.
404 nil)
405 \f
406 ;; In Emacs 19 this will return program's exit status.
407 ;; This is a separate function so that ange-ftp can redefine it.
409 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
410 ;Remaining arguments are strings passed as command arguments to PROGRAM."
411 ;; Look for a handler for default-directory in case it is a remote file name.
416 program discard arguments)
420 ; "Display MSG while running PROGRAM, and check for output.
421 ;Remaining arguments are strings passed as command arguments to PROGRAM.
422 ; On error, insert output
423 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
424 ; Caller can cons up a list of failed args.
425 ;Else returns nil for success."
429 ;; Get a clean buffer for error output:
443 nil))))
444 \f
445 ;; Commands that delete or redisplay part of the dired buffer.
466 ;;;###autoload
468 "Kill all marked lines (not the files).
469 With a prefix argument, kill that many lines starting with the current line.
470 \(A negative argument kills lines before the current line.)
471 To kill an entire subdirectory, go to its directory header line
472 and use this command with a prefix argument (the value does not matter)."
473 ;; Returns count of killed lines. FMT="" suppresses message.
489 ;; else kill unmarked lines
500 count))))
502 ;;;###end dired-cmd.el
503 \f
504 ;;; 30K
505 ;;;###begin dired-cp.el
508 ;; Compress or uncompress the current file.
509 ;; Return nil for success, offending filename else.
515 ;; Remove any preexisting entry for the name NEW-FILE.
520 ;; Now replace the current line with an entry for NEW-FILE.
523 from-file)))
529 ;; For .z, try gunzip. It might be an old gzip file,
530 ;; or it might be from compact? pack? (which?) but gunzip handles both.
533 ;; This item controls naming for compression.
535 "Control changes in file name suffixes for compression and uncompression.
536 Each element specifies one transformation rule, and has the form:
537 (REGEXP NEW-SUFFIX PROGRAM)
538 The rule applies when the old file name matches REGEXP.
539 The new file name is computed by deleting the part that matches REGEXP
540 (as well as anything after that), then adding NEW-SUFFIX in its place.
541 If PROGRAM is non-nil, the rule is an uncompression rule,
542 and uncompression is done by running PROGRAM.
545 ;;;###autoload
547 ;; Compress or uncompress FILE.
548 ;; Return the name of the compressed or uncompressed file.
549 ;; Return nil if no change in files.
551 suffix newname
553 ;; See if any suffix rule matches this file name.
559 ;; If so, compute desired new name.
566 nil)
568 ;; We found an uncompression rule.
571 newname))
573 ;;; We don't recognize the file as compressed, so compress it.
574 ;;; Try gzip; if we don't have that, use compress.
582 ;; Rename the compressed file to NEWNAME
583 ;; if it hasn't got that name already.
587 newname)
588 out-name)))
592 ;; Don't use NEWNAME with `compress'.
594 \f
596 ;; Request confirmation from the user that the operation described
597 ;; by OP-SYMBOL is to be performed on the marked files.
598 ;; Confirmation consists in a y-or-n question with a file list
599 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
600 ;; The files used are determined by ARG (as in dired-get-marked-files).
611 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
612 ; and display failures.
614 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
615 ; the short form of the filename) for a failure and probably logs a
616 ; detailed error explanation using function `dired-log'.
618 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
619 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
620 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
621 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
623 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
635 ;; end this bunch of errors:
639 failures)))))
646 ;; None of these keys quit - use C-g for that.
647 ))
650 ;; Query user and return nil or t.
651 ;; Store answer in symbol VAR (which must initially be bound to nil).
652 ;; Format PROMPT with ARGS.
653 ;; Binding variable help-form will help the user who types the help key.
667 result elt)
668 ;; Actually it looks nicer without cursor-in-echo-area - you can
669 ;; look at the dired buffer instead of at the prompt to decide.
679 \f
680 ;;;###autoload
682 "Compress or uncompress marked (or next ARG) files."
686 ;; Commands for Emacs Lisp files - load and byte compile
689 ;; Return nil for success, offending file name else.
691 elc-file buffer-read-only failure)
706 nil)))
708 ;;;###autoload
710 "Byte compile marked (or next ARG) Emacs Lisp files."
715 ;; Return nil for success, offending file name else.
721 nil
725 ;;;###autoload
727 "Load the marked (or next ARG) Emacs Lisp files."
731 ;;;###autoload
733 "Redisplay all marked (or next ARG) files.
734 If on a subdir line, redisplay that subdirectory. In that case,
735 a prefix arg lets you edit the `ls' switches used for the new listing."
736 ;; Moves point if the next ARG files are redisplayed.
743 ;; message much faster than making dired-map-over-marks show progress
749 arg)
752 \f
754 ;; Delete the current line, and insert an entry for FILE.
755 ;; If FILE is nil, then just delete the current line.
756 ;; Keeps any marks that may be present in column one (doing this
757 ;; here is faster than with dired-add-entry's optional arg).
758 ;; Does not update other dired buffers. Use dired-relist-entry for that.
766 ;; Replace space by old marker without moving point.
767 ;; Faster than goto+insdel inside a save-excursion?
772 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
773 ;; If the buffer has a wildcard pattern, check that it matches FILE.
774 ;; (FILE does not include a directory component.)
775 ;; FILE may be nil, in which case ignore it.
776 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
778 file))
780 buf success-list)
790 success-list))
792 ;;;###autoload
799 ;; Add a new entry for FILENAME, optionally marking it
800 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
801 ;; Note that this adds the entry `out of order' if files sorted by
802 ;; time, etc.
803 ;; At least this version inserts in the right subdirectory (if present).
804 ;; And it skips "." or ".." (see `dired-trivial-filenames').
805 ;; Hidden subdirs are exposed if a file is added there.
807 ;; Entry is always for files, even if they happen to also be directories
812 reason)
817 reason
824 ;; We are already where we should be, except when
825 ;; point is before the subdir line or its total line.
829 ;; else try to find correct place to insert
834 ;; found - skip subdir and `total' line
835 ;; and uninteresting files like . and ..
836 ;; This better not moves into the next subdir!
838 ;; not found
844 ;; don't expand `.'. Show just the file name within directory.
848 ;; Compensate for a bug in ange-ftp.
849 ;; It inserts the file's absolute name, rather than
850 ;; the relative one. That may be hard to fix since it
851 ;; is probably controlled by something in ftp.
861 ;; Give each line a text property recording info about it.
872 ;; return nil if all went well
873 nil))
878 ;; This is a separate function for the sake of nested dired format.
880 ;; two spaces or a marker plus a space:
887 ;; Return pos of first file line of DIR, skipping header and total
888 ;; or wildcard lines.
889 ;; Important: never moves into the next subdir.
890 ;; DIR is assumed to be unhidden.
891 ;; Will probably be redefined for VMS etc.
900 ;;;###autoload
913 ;;;###autoload
920 ;; Relist the line for FILE, or just add it if it did not exist.
921 ;; FILE must be an absolute file name.
923 ;; If cursor is already on FILE's line delete-region will cause
924 ;; save-excursion to fail because of floating makers,
925 ;; moving point to beginning of line. Sigh.
934 \f
935 ;;; Copy, move/rename, making hard and symbolic links
938 "*Decide whether recursive copies are allowed.
939 Nil means no recursive copies.
940 `always' means copy recursively without asking.
941 `top' means ask for each directory at top level.
942 Anything else means ask for each directory."
951 "*Non-nil if Dired should ask about making backups before overwriting files.
952 Special value `always' suppresses confirmation."
961 ;; Save old version of a to be overwritten file TO.
962 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
963 ;; from dired-create-files.
966 dired-overwrite-confirmed
971 to))))
976 ;;;###autoload
981 dired-recursive-copies)
986 preserve-time top recursive)
1000 ok-flag preserve-time nil recursive)
1005 ;;;###autoload
1009 ;; Silently rename the visited file of any buffer visiting this file.
1014 ;; See if it's an inserted subdir, and rename that, too.
1022 ;; Update visited file name of all affected buffers
1033 to-dir
1034 buffer-file-name)))
1040 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1041 ;; one of its subdirectories is expanded in this buffer.
1049 ;; ELT's subdir is affected by the rename
1052 ;; if top level directory was renamed, lots of things have to be
1053 ;; updated:
1058 ;; with and without wildcards
1060 to))
1063 ;; try to rename buffer, but just leave old name if new
1064 ;; name would already exist (don't try appending "<%d>")
1067 ;; ... we dired TO now:
1071 ;; Update the headerline and dired-subdir-alist element of directory
1072 ;; described by alist-element ELT to reflect the moving of DIR to TO.
1073 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
1077 buffer-read-only)
1079 ;; Update subdir headerline in buffer
1082 dir)
1087 ;; Update buffer-local dired-subdir-alist
1091 \f
1092 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1096 ;; Create a new file for each from a list of existing files. The user
1097 ;; is queried, dired buffers are updated, and at the end a success or
1098 ;; failure message is displayed
1100 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1102 ;; It is called for each file and must create newfile, the entry of
1103 ;; which will be added. The user will be queried if the file already
1104 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1105 ;; rename), it is FILE-CREATOR's responsibility to update dired
1106 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1107 ;; could not create newfile. The error is caught and logged.
1109 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1110 ;; operation performed. It is used for error logging.
1112 ;; FN-LIST is the list of files to copy (full absolute file names).
1114 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1115 ;; skip. If it skips files for other reasons than a direct user
1116 ;; query, it is supposed to tell why (using dired-log).
1118 ;; Optional MARKER-CHAR is a character with which to mark every
1119 ;; newfile's entry, or t to use the current marker character if the
1120 ;; oldfile was marked.
1140 Type SPC or `y' to overwrite file `%s',
1141 DEL or `n' to skip to next,
1142 ESC or `q' to not overwrite any of the remaining files,
1146 ;; must determine if FROM is marked before file-creator
1147 ;; gets a chance to delete it (in case of a move).
1156 ;; If we get here, file-creator hasn't been aborted
1157 ;; and the old entry (if any) has to be deleted
1158 ;; before adding the new entry.
1167 operation from to err))))))))
1168 fn-list))
1175 failures))
1181 skipped))
1186 \f
1188 &optional marker-char op1
1189 how-to)
1190 ;; Create a new file for each marked file.
1191 ;; Prompts user for target, which is a directory in which to create
1192 ;; the new files. Target may be a plain file if only one marked
1193 ;; file exists.
1194 ;; OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1195 ;; will determine whether pop-ups are appropriate for this OP-SYMBOL.
1196 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1197 ;; ARG as in dired-get-marked-files.
1198 ;; Optional arg MARKER-CHAR as in dired-create-files.
1199 ;; Optional arg OP1 is an alternate form for OPERATION if there is
1200 ;; only one file.
1201 ;; Optional arg HOW-TO is used to set the value of the into-dir variable
1202 ;; which determines how to treat target.
1203 ;; If into-dir is set to nil then target is not regarded as a directory,
1204 ;; there must be exactly one marked file, else error.
1205 ;; Else if into-dir is set to a list, then target is a genearlized
1206 ;; directory (e.g. some sort of archive). The first element of into-dir
1207 ;; must be a function with at least four arguments:
1208 ;; operation as OPERATION above.
1209 ;; rfn-list a list of the relative names for the marked files.
1210 ;; fn-list a list of the absolute names for the marked files.
1211 ;; target.
1212 ;; The rest of into-dir are optional arguments.
1213 ;; Else into-dir is not a list. Target is a directory.
1214 ;; The marked file(s) are created inside the target directory.
1215 ;;
1216 ;; If HOW-TO is not given (or nil), then into-dir is set to true if
1217 ;; target is a directory and otherwise to nil.
1218 ;; Else if HOW-TO is t, then into-dir is set to nil.
1219 ;; Else HOW-TO is assumed to be a function of one argument, target,
1220 ;; that looks at target and returns a value for the into-dir
1221 ;; variable. The function dired-into-dir-with-symlinks is provided
1222 ;; for the case (common when creating symlinks) that symbolic
1223 ;; links to directories are not to be considered as directories
1224 ;; (as file-directory-p would if HOW-TO had been nil).
1234 op-symbol arg rfn-list)))
1242 ;; rename-file bombs when moving directories unless we do this:
1245 file-creator operation fn-list
1247 ;; This function uses fluid variable target when called
1248 ;; inside dired-create-files:
1253 marker-char))))
1255 ;; Read arguments for a marked-files command that wants a file name,
1256 ;; perhaps popping up the list of marked files.
1257 ;; ARG is the prefix arg and indicates whether the files came from
1258 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1259 ;; If the current file was used, the list has but one element and ARG
1260 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1264 nil op-symbol files
1269 ;; Try to guess which target directory the user may want.
1270 ;; If there is a dired buffer displayed in the next window, use
1271 ;; its current subdir, else use current subdir of this dired buffer.
1274 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1282 this-dir)))
1283 \f
1284 ;;;###autoload
1286 "Create a directory called DIRECTORY."
1297 ;; This may not always be what you want, especially if target is your
1298 ;; home directory and it happens to be a symbolic link, as is often the
1299 ;; case with NFS and automounters. Or if you want to make symlinks
1300 ;; into directories that themselves are only symlinks, also quite
1301 ;; common.
1303 ;; So we don't use this function as value for HOW-TO in
1304 ;; dired-do-symlink, which has the minor disadvantage of
1305 ;; making links *into* a symlinked-dir, when you really wanted to
1306 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1307 ;; just have to remove that symlink by hand before making your marked
1308 ;; symlinks.
1311 "Nil or a function used by `dired-do-copy' to determine target.
1314 ;;;###autoload
1316 "Copy all marked (or next ARG) files, or copy the current file.
1317 This normally preserves the last-modified date when copying.
1318 When operating on just the current file, you specify the new name.
1319 When operating on multiple or marked files, you specify a directory,
1320 and new copies of these files are made in that directory
1321 with the same names that the files currently have."
1326 arg dired-keep-marker-copy
1327 nil dired-copy-how-to-fn)))
1329 ;;;###autoload
1331 "Make symbolic links to current file or all marked (or next ARG) files.
1332 When operating on just the current file, you specify the new name.
1333 When operating on multiple or marked files, you specify a directory
1334 and new symbolic links are made in that directory
1335 with the same names that the files currently have."
1340 ;;;###autoload
1342 "Add names (hard links) current file or all marked (or next ARG) files.
1343 When operating on just the current file, you specify the new name.
1344 When operating on multiple or marked files, you specify a directory
1345 and new hard links are made in that directory
1346 with the same names that the files currently have."
1351 ;;;###autoload
1353 "Rename current file or all marked (or next ARG) files.
1354 When renaming just the current file, you specify the new name.
1355 When renaming multiple or marked files, you specify a directory."
1359 ;;;###end dired-cp.el
1360 \f
1361 ;;; 5K
1362 ;;;###begin dired-re.el
1365 ;; Create a new file for each marked file using regexps.
1366 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1367 ;; ARG as in dired-get-marked-files.
1368 ;; Matches each marked file against REGEXP and constructs the new
1369 ;; filename from NEWNAME (like in function replace-match).
1370 ;; Optional arg WHOLE-PATH means match/replace the whole file name
1371 ;; instead of only the non-directory part of the file.
1372 ;; Optional arg MARKER-CHAR as in dired-create-files.
1377 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1378 `!' to %s all remaining matches with no more questions."
1382 ;; Function to construct new filename using REGEXP and NEWNAME:
1387 ;; must bind help-form directly around call to
1388 ;; dired-query
1392 operation-prompt
1393 from
1394 to)
1395 to)
1397 operation from regexp)))))
1398 ;; not whole-path, replace non-directory part only
1409 operation-prompt
1412 to)
1415 rename-regexp-query)
1417 file-creator operation fn-list regexp-name-constructor marker-char)))
1420 ;; Prompt user about performing OPERATION.
1421 ;; Read and return list of: regexp newname arg whole-path.
1434 ;;;###autoload
1436 "Rename marked files containing REGEXP to NEWNAME.
1437 As each match is found, the user must type a character saying
1440 REGEXP defaults to the last regexp used.
1442 With a zero prefix arg, renaming by regexp affects the absolute file name.
1443 Normally, only the non-directory part of the file name is used and changed."
1449 ;;;###autoload
1451 "Copy all marked files containing REGEXP to NEWNAME.
1452 See function `dired-do-rename-regexp' for more info."
1458 arg regexp newname whole-path dired-keep-marker-copy)))
1460 ;;;###autoload
1462 "Hardlink all marked files containing REGEXP to NEWNAME.
1463 See function `dired-do-rename-regexp' for more info."
1469 ;;;###autoload
1471 "Symlink all marked files containing REGEXP to NEWNAME.
1472 See function `dired-do-rename-regexp' for more info."
1480 ;; Perform FILE-CREATOR on the non-directory part of marked files
1481 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1482 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1485 file-creator
1486 operation
1494 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1495 `!' to %s all remaining matches with no more questions."
1502 to))))
1503 dired-keep-marker-rename)))
1508 basename-constructor operation arg))
1510 ;;;###autoload
1512 "Rename all marked (or next ARG) files to upper case."
1516 ;;;###autoload
1518 "Rename all marked (or next ARG) files to lower case."
1522 ;;;###end dired-re.el
1523 \f
1524 ;;; 13K
1525 ;;;###begin dired-ins.el
1527 ;;;###autoload
1529 switches no-error-if-not-dir-p)
1530 "Insert this subdirectory into the same dired buffer.
1532 else inserts it at its natural place (as `ls -lR' would have done).
1533 With a prefix arg, you may edit the ls switches used for this listing.
1534 You can add `R' to the switches to expand the whole tree starting at
1535 this subdirectory.
1536 This function takes some pains to conform to `ls -lR' output."
1542 ;; We don't need a marker for opoint as the subdir is always
1543 ;; inserted *after* opoint.
1548 ;; Push mark so that it's easy to find back. Do this after the
1549 ;; insert message so that the user sees the `Mark set' message.
1552 ;;;###autoload
1554 "Insert this subdirectory into the same dired buffer.
1555 If it is already present, overwrites previous entry,
1556 else inserts it at its natural place (as `ls -lR' would have done).
1557 With a prefix arg, you may edit the `ls' switches used for this listing.
1558 You can add `R' to the switches to expand the whole tree starting at
1559 this subdirectory.
1560 This function takes some pains to conform to `ls -lR' output."
1561 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1562 ;; Prospero where dired-ls does the right thing, but
1563 ;; file-directory-p has not been redefined.
1574 switches-have-R mark-alist case-fold-search buffer-read-only)
1575 ;; case-fold-search is nil now, so we can test for capital `R':
1577 ;; avoid duplicated subdirs
1580 ;; If subdir is already present, remove it and remember its marks
1589 ;; This is a separate function for dired-vms.
1591 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1592 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1603 x))))
1604 ;; all switches that make a difference to dired-get-filename:
1608 ;; Add new DIR at NEW-MARKER. Sort alist.
1613 ;; Keep the alist sorted on buffer position.
1621 ;;"Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1622 ;; With optional arg REMEMBER-MARKS, return an alist of marked files."
1633 m-alist))
1636 ;; Find pos for new subdir, according to tree order.
1637 ;;(goto-char (point-max))
1645 ;; Insert NEW-DIR after DIR
1647 alist nil)))
1649 ;; want a separating newline between subdirs
1656 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1657 ;; Move to that buffer position. Return a mark-alist.
1660 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1669 ;; Insert ls output after point and put point on the correct
1670 ;; position for the subdir alist.
1671 ;; Return the boundary of the inserted text (as list of BEG and END).
1678 ;; top level directory may contain wildcards:
1686 ;; call dired-insert-headerline afterwards, as under VMS dired-ls
1687 ;; does insert the headerline itself and the insert function just
1688 ;; moves point.
1689 ;; Need a marker for END as this inserts text.
1693 ;; point is now like in dired-build-subdir-alist
1699 ;; Point is at the correct subdir alist position for ELT,
1700 ;; BEG-END is the subdir-region (as list of begin and end).
1702 ;; update its position (should actually be unchanged)
1705 ;; The hook may depend on the subdir-alist containing the just
1706 ;; inserted subdir, so run it after dired-alist-add:
1714 ;; hook may add or delete lines, but the subdir boundary
1715 ;; marker floats
1719 ;; Lexicographic order on file name components, like `ls -lR':
1720 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1721 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1722 ;; or DIR1 and DIR2 are in the same parentdir and their last
1723 ;; components are string-lessp.
1724 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1725 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1726 ;; if dired-actual-switches contained `t'.
1732 components-2
1744 t)
1746 nil)
1749 ;; There should be a builtin split function - inverse to mapconcat.
1751 "Splitting on regexp PAT, turn string STR into a list of substrings.
1752 Optional third arg LIMIT (>= 1) is a limit to the length of the
1753 resulting list.
1754 Thus, if SEP is a regexp that only matches itself,
1756 (mapconcat 'identity (dired-split SEP STRING) SEP)
1758 is always equal to STRING."
1771 start end)
1772 ))
1779 \f
1780 ;;; moving by subdirectories
1782 ;;;###autoload
1784 "Go to previous subdirectory, regardless of level.
1785 When called interactively and not on a subdir line, go to this subdir's line."
1786 ;;(interactive "p")
1790 ;; if on subdir start already, don't stay there!
1800 ;;;###autoload
1802 "Go to end of header line of DIR in this dired buffer.
1803 Return value of point on success, otherwise return nil.
1809 dired-subdir-alist ; table
1810 nil ; predicate
1811 t ; require-match
1818 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1819 ;; at either \r or \n after this function succeeds.
1822 \f
1823 ;;;###autoload
1825 "Mark all files except `.' and `..' in current subdirectory.
1826 If the Dired buffer shows multiple directories, this command
1827 marks the files listed in the subdirectory that point is in."
1832 ;;;###autoload
1834 "Remove all lines of current subdirectory.
1835 Lower levels are unaffected."
1836 ;; With optional REMEMBER-MARKS, return a mark-alist.
1840 buffer-read-only cur-dir)
1852 ;; Remove DIR from the alist
1856 ;;;###autoload
1858 "Go up ARG levels in the dired tree."
1864 ;;(setq dir (expand-file-name dir))
1868 ;;;###autoload
1870 "Go down in the dired tree."
1884 \f
1885 ;;; hiding
1901 ;;;###autoload
1903 "Hide or unhide the current subdirectory and move to next directory.
1904 Optional prefix arg is a repeat factor.
1913 buffer-read-only)
1914 ;; keep header line visible, hide rest
1922 ;;;###autoload
1924 "Hide all subdirectories, leaving only their header lines.
1925 If there is already something hidden, make everything visible again.
1933 ;; unhide - bombs on \r in filenames
1935 ;; hide
1942 ;; we're somewhere on current dir's line
1949 ;;;###end dired-ins.el
1951 \f
1952 ;; Functions for searching in tags style among marked files.
1954 ;;;###autoload
1956 "Search through all marked files for a match for REGEXP.
1957 Stops when a match is found.
1962 ;;;###autoload
1964 "Do `query-replace-regexp' of FROM with TO, on all marked files.
1965 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
1971 \f
1975 ;;; dired-aux.el ends here