| blob | 8cd7373070eeae05629a8fc40611df0dde1ea269 |
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
46 ;;;###autoload
48 "Compare file at point with file FILE using `diff'.
49 FILE defaults to the file at the mark. (That's the mark set by
51 The prompted-for file is the first file given to `diff'.
52 With prefix arg, prompt for second argument SWITCHES,
53 which is options for `diff'."
68 diff-switches
72 ;;;###autoload
74 "Diff this file with its backup file or vice versa.
75 Uses the latest backup, if there are several numerical backups.
76 If this file is a backup, diff it with its original.
77 The backup file is the first file given to `diff'.
78 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
83 diff-switches
85 nil))
89 ;; Change file attributes (mode, group, owner) of marked files and
90 ;; refresh their file lines.
91 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
92 ;; PROGRAM is the program used to change the attribute.
93 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
94 ;; ARG describes which files to use, as in dired-get-marked-files.
99 nil op-symbol arg files))
101 failures)
109 files))
114 nil))))
116 ;;;###autoload
118 "Change the mode of the marked (or next ARG) files.
119 This calls chmod, thus symbolic modes like `g+w' are allowed."
123 ;;;###autoload
125 "Change the group of the marked (or next ARG) files."
131 ;;;###autoload
133 "Change the owner of the marked (or next ARG) files."
139 ;; Process all the files in FILES in batches of a convenient size,
140 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
141 ;; Batches are chosen to need less than MAX chars for the file names,
142 ;; allowing 3 extra characters of separator per file name.
146 failures)
147 ;; Accumulate files as long as they fit in MAX chars,
148 ;; then process the ones accumulated so far.
153 ;; If we have at least 1 pending file
154 ;; and this file won't fit in the length limit, process now.
158 failures)
159 pending nil
161 ;; Do (setq pending (cons thisfile pending))
162 ;; but reuse the cons that was in `files'.
168 failures)))
170 ;;;###autoload
172 "Print the marked (or next ARG) files.
173 Uses the shell command coming from variables `lpr-command' and
174 `lpr-switches' as default."
178 "Print %s with: "
183 lpr-switches))
188 ;; Read arguments for a marked-files command that wants a string
189 ;; that is not a file name,
190 ;; perhaps popping up the list of marked files.
191 ;; ARG is the prefix arg and indicates whether the files came from
192 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
193 ;; If the current file was used, the list has but one element and ARG
194 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
197 ;; PROMPT for a string, with INITIAL input.
198 ;; Other args are used to give user feedback and pop-up:
199 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
201 nil op-symbol files
204 \f
205 ;;; Cleaning a directory: flagging some backups for deletion.
210 "Flag numerical backups for deletion.
211 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
212 Positive prefix arg KEEP overrides `dired-kept-versions';
213 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
216 with a prefix argument."
223 late-retention early-retention)
224 ;; Look at each file.
225 ;; If the file has numeric backup versions,
226 ;; put on dired-file-version-alist an element of the form
227 ;; (FILENAME . VERSION-NUMBER-LIST)
229 ;; Sort each VERSION-NUMBER-LIST,
230 ;; and remove the versions not to be deleted.
238 sorted-v-list)))
242 ;; Look at each file. If it is a numeric backup file,
243 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
247 ;;; Subroutines of dired-clean-directory.
250 ;; Perform FUN with point at the end of each non-directory line.
251 ;; FUN takes one argument, the absolute filename.
266 ;; Only do work if this file is not already in the alist.
268 nil
269 ;; If it looks like file FN has versions, return a list of the versions.
270 ;;That is a list of strings which are file names.
271 ;;The caller may want to flag some of these files for deletion.
276 base-versions
282 dired-file-version-alist)))))))
286 base-version-list)
296 \f
297 ;;; Shell commands
300 ;; "Read a dired shell command prompting with PROMPT (using read-string).
301 ;;ARG is the prefix arg and may be used to indicate in the prompt which
302 ;; files are affected.
303 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
305 nil 'shell files
310 ;; The in-background argument is only needed in Emacs 18 where
311 ;; shell-command doesn't understand an appended ampersand `&'.
312 ;;;###autoload
314 "Run a shell command COMMAND on the marked files.
315 If no files are marked or a specific numeric prefix arg is given,
317 The prompt mentions the file(s) or the marker, as appropriate.
319 If there is a `*' in COMMAND, surrounded by whitespace, this runs
320 COMMAND just once with the entire file list substituted there.
322 If there is no `*', but there is a `?' in COMMAND, surrounded by
323 whitespace, this runs COMMAND on each file individually with the
324 file name substituted for `?'.
326 Otherwise, this runs COMMAND on each file individually with the
327 file name added at the end of COMMAND (separated by a space).
329 `*' and `?' when not surrounded by whitespace have no special
330 significance for `dired-do-shell-command', and are passed through
331 normally to the shell, but you must confirm first. To pass `*' by
334 If COMMAND produces output, it goes to a separate buffer.
336 This feature does not try to redisplay Dired buffers afterward, as
337 there's no telling what files COMMAND may have changed.
340 When COMMAND runs, its working directory is the top-level directory of
341 the Dired buffer, so output files usually are created there instead of
342 in a subdir.
344 In a noninteractive call (from Lisp code), you must specify
345 the list of file names explicitly with the FILE-LIST argument."
346 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
347 ;;actual work and can be redefined for customization.
351 ;; Want to give feedback whether this file or marked files are used:
354 current-prefix-arg
355 files)
356 current-prefix-arg
357 files)))
362 ;; Get confirmation for wildcards that may have been meant
363 ;; to control substitution of a file name or the file name list.
375 nil
376 file-list)
377 ;; execute the shell command
381 ;; Might use {,} for bash or csh:
390 ;; "Make up a shell command line from COMMAND and FILE-LIST.
391 ;; If ON-EACH is t, COMMAND should be applied to each file, else
392 ;; simply concat all files and apply COMMAND to this.
393 ;; FILE-LIST's elements will be quoted for the shell."
394 ;; Might be redefined for smarter things and could then use RAW-ARG
395 ;; (coming from interactive P and currently ignored) to decide what to do.
396 ;; Smart would be a way to access basename or extension of file names.
410 file-list dired-mark-separator)))
415 ;; This is an extra function so that it can be redefined by ange-ftp.
422 ;; Return nil for sake of nconc in dired-bunch-files.
423 nil)
424 \f
425 ;; In Emacs 19 this will return program's exit status.
426 ;; This is a separate function so that ange-ftp can redefine it.
428 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
429 ;Remaining arguments are strings passed as command arguments to PROGRAM."
430 ;; Look for a handler for default-directory in case it is a remote file name.
435 program discard arguments)
439 ; "Display MSG while running PROGRAM, and check for output.
440 ;Remaining arguments are strings passed as command arguments to PROGRAM.
441 ; On error, insert output
442 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
443 ; Caller can cons up a list of failed args.
444 ;Else returns nil for success."
448 ;; Get a clean buffer for error output:
462 nil))))
463 \f
464 ;; Commands that delete or redisplay part of the dired buffer.
485 ;;;###autoload
487 "Kill all marked lines (not the files).
488 With a prefix argument, kill that many lines starting with the current line.
489 \(A negative argument kills lines before the current line.)
490 To kill an entire subdirectory, go to its directory header line
491 and use this command with a prefix argument (the value does not matter)."
492 ;; Returns count of killed lines. FMT="" suppresses message.
508 ;; else kill unmarked lines
519 count))))
521 ;;;###end dired-cmd.el
522 \f
523 ;;; 30K
524 ;;;###begin dired-cp.el
527 ;; Compress or uncompress the current file.
528 ;; Return nil for success, offending filename else.
534 ;; Remove any preexisting entry for the name NEW-FILE.
539 ;; Now replace the current line with an entry for NEW-FILE.
542 from-file)))
548 ;; For .z, try gunzip. It might be an old gzip file,
549 ;; or it might be from compact? pack? (which?) but gunzip handles both.
552 ;; This item controls naming for compression.
554 "Control changes in file name suffixes for compression and uncompression.
555 Each element specifies one transformation rule, and has the form:
556 (REGEXP NEW-SUFFIX PROGRAM)
557 The rule applies when the old file name matches REGEXP.
558 The new file name is computed by deleting the part that matches REGEXP
559 (as well as anything after that), then adding NEW-SUFFIX in its place.
560 If PROGRAM is non-nil, the rule is an uncompression rule,
561 and uncompression is done by running PROGRAM.
564 ;;;###autoload
566 ;; Compress or uncompress FILE.
567 ;; Return the name of the compressed or uncompressed file.
568 ;; Return nil if no change in files.
570 suffix newname
572 ;; See if any suffix rule matches this file name.
578 ;; If so, compute desired new name.
585 nil)
587 ;; We found an uncompression rule.
590 newname))
592 ;;; We don't recognize the file as compressed, so compress it.
593 ;;; Try gzip; if we don't have that, use compress.
601 ;; Rename the compressed file to NEWNAME
602 ;; if it hasn't got that name already.
606 newname)
607 out-name)))
611 ;; Don't use NEWNAME with `compress'.
613 \f
615 ;; Request confirmation from the user that the operation described
616 ;; by OP-SYMBOL is to be performed on the marked files.
617 ;; Confirmation consists in a y-or-n question with a file list
618 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
619 ;; The files used are determined by ARG (as in dired-get-marked-files).
630 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
631 ; and display failures.
633 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
634 ; the short form of the filename) for a failure and probably logs a
635 ; detailed error explanation using function `dired-log'.
637 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
638 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
639 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
640 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
642 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
654 ;; end this bunch of errors:
658 failures)))))
665 ;; None of these keys quit - use C-g for that.
666 ))
669 ;; Query user and return nil or t.
670 ;; Store answer in symbol VAR (which must initially be bound to nil).
671 ;; Format PROMPT with ARGS.
672 ;; Binding variable help-form will help the user who types the help key.
686 result elt)
687 ;; Actually it looks nicer without cursor-in-echo-area - you can
688 ;; look at the dired buffer instead of at the prompt to decide.
698 \f
699 ;;;###autoload
701 "Compress or uncompress marked (or next ARG) files."
705 ;; Commands for Emacs Lisp files - load and byte compile
708 ;; Return nil for success, offending file name else.
710 elc-file buffer-read-only failure)
725 nil)))
727 ;;;###autoload
729 "Byte compile marked (or next ARG) Emacs Lisp files."
734 ;; Return nil for success, offending file name else.
740 nil
744 ;;;###autoload
746 "Load the marked (or next ARG) Emacs Lisp files."
750 ;;;###autoload
752 "Redisplay all marked (or next ARG) files.
753 If on a subdir line, redisplay that subdirectory. In that case,
754 a prefix arg lets you edit the `ls' switches used for the new listing."
755 ;; Moves point if the next ARG files are redisplayed.
762 ;; message much faster than making dired-map-over-marks show progress
768 arg)
771 \f
773 ;; Delete the current line, and insert an entry for FILE.
774 ;; If FILE is nil, then just delete the current line.
775 ;; Keeps any marks that may be present in column one (doing this
776 ;; here is faster than with dired-add-entry's optional arg).
777 ;; Does not update other dired buffers. Use dired-relist-entry for that.
785 ;; Replace space by old marker without moving point.
786 ;; Faster than goto+insdel inside a save-excursion?
791 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
792 ;; If the buffer has a wildcard pattern, check that it matches FILE.
793 ;; (FILE does not include a directory component.)
794 ;; FILE may be nil, in which case ignore it.
795 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
797 file))
799 buf success-list)
809 success-list))
811 ;;;###autoload
818 ;; Add a new entry for FILENAME, optionally marking it
819 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
820 ;; Note that this adds the entry `out of order' if files sorted by
821 ;; time, etc.
822 ;; At least this version inserts in the right subdirectory (if present).
823 ;; And it skips "." or ".." (see `dired-trivial-filenames').
824 ;; Hidden subdirs are exposed if a file is added there.
826 ;; Entry is always for files, even if they happen to also be directories
831 reason)
836 reason
843 ;; We are already where we should be, except when
844 ;; point is before the subdir line or its total line.
848 ;; else try to find correct place to insert
853 ;; found - skip subdir and `total' line
854 ;; and uninteresting files like . and ..
855 ;; This better not moves into the next subdir!
857 ;; not found
863 ;; don't expand `.'. Show just the file name within directory.
867 ;; Compensate for a bug in ange-ftp.
868 ;; It inserts the file's absolute name, rather than
869 ;; the relative one. That may be hard to fix since it
870 ;; is probably controlled by something in ftp.
880 ;; Give each line a text property recording info about it.
891 ;; return nil if all went well
892 nil))
897 ;; This is a separate function for the sake of nested dired format.
899 ;; two spaces or a marker plus a space:
906 ;; Return pos of first file line of DIR, skipping header and total
907 ;; or wildcard lines.
908 ;; Important: never moves into the next subdir.
909 ;; DIR is assumed to be unhidden.
910 ;; Will probably be redefined for VMS etc.
919 ;;;###autoload
932 ;;;###autoload
939 ;; Relist the line for FILE, or just add it if it did not exist.
940 ;; FILE must be an absolute file name.
942 ;; If cursor is already on FILE's line delete-region will cause
943 ;; save-excursion to fail because of floating makers,
944 ;; moving point to beginning of line. Sigh.
953 \f
954 ;;; Copy, move/rename, making hard and symbolic links
957 "*Decide whether recursive copies are allowed.
958 nil means no recursive copies.
959 `always' means copy recursively without asking.
960 `top' means ask for each directory at top level.
961 Anything else means ask for each directory."
970 "*Non-nil if Dired should ask about making backups before overwriting files.
971 Special value `always' suppresses confirmation."
980 ;; Save old version of a to be overwritten file TO.
981 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
982 ;; from dired-create-files.
985 dired-overwrite-confirmed
990 to))))
995 ;;;###autoload
1000 dired-recursive-copies)
1005 preserve-time top recursive)
1019 ok-flag preserve-time nil recursive)
1024 ;;;###autoload
1028 ;; Silently rename the visited file of any buffer visiting this file.
1033 ;; See if it's an inserted subdir, and rename that, too.
1041 ;; Update visited file name of all affected buffers
1052 to-dir
1053 buffer-file-name)))
1059 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1060 ;; one of its subdirectories is expanded in this buffer.
1068 ;; ELT's subdir is affected by the rename
1071 ;; if top level directory was renamed, lots of things have to be
1072 ;; updated:
1077 ;; with and without wildcards
1079 to))
1082 ;; try to rename buffer, but just leave old name if new
1083 ;; name would already exist (don't try appending "<%d>")
1086 ;; ... we dired TO now:
1090 ;; Update the headerline and dired-subdir-alist element of directory
1091 ;; described by alist-element ELT to reflect the moving of DIR to TO.
1092 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
1096 buffer-read-only)
1098 ;; Update subdir headerline in buffer
1101 dir)
1106 ;; Update buffer-local dired-subdir-alist
1110 \f
1111 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1115 ;; Create a new file for each from a list of existing files. The user
1116 ;; is queried, dired buffers are updated, and at the end a success or
1117 ;; failure message is displayed
1119 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1121 ;; It is called for each file and must create newfile, the entry of
1122 ;; which will be added. The user will be queried if the file already
1123 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1124 ;; rename), it is FILE-CREATOR's responsibility to update dired
1125 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1126 ;; could not create newfile. The error is caught and logged.
1128 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1129 ;; operation performed. It is used for error logging.
1131 ;; FN-LIST is the list of files to copy (full absolute file names).
1133 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1134 ;; skip. If it skips files for other reasons than a direct user
1135 ;; query, it is supposed to tell why (using dired-log).
1137 ;; Optional MARKER-CHAR is a character with which to mark every
1138 ;; newfile's entry, or t to use the current marker character if the
1139 ;; oldfile was marked.
1159 Type SPC or `y' to overwrite file `%s',
1160 DEL or `n' to skip to next,
1161 ESC or `q' to not overwrite any of the remaining files,
1165 ;; must determine if FROM is marked before file-creator
1166 ;; gets a chance to delete it (in case of a move).
1175 ;; If we get here, file-creator hasn't been aborted
1176 ;; and the old entry (if any) has to be deleted
1177 ;; before adding the new entry.
1186 operation from to err))))))))
1187 fn-list))
1194 failures))
1200 skipped))
1205 \f
1207 &optional marker-char op1
1208 how-to)
1209 "Create a new file for each marked file.
1210 Prompts user for target, which is a directory in which to create
1211 the new files. Target may be a plain file if only one marked
1212 file exists. The way the default for the target directory is
1213 computed depends on the value of `dired-dwim-target-directory'.
1214 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1215 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1216 FILE-CREATOR and OPERATION as in `dired-create-files'.
1217 ARG as in `dired-get-marked-files'.
1218 Optional arg MARKER-CHAR as in `dired-create-files'.
1219 Optional arg OP1 is an alternate form for OPERATION if there is
1220 only one file.
1221 Optional arg HOW-TO is used to set the value of the into-dir variable
1222 which determines how to treat target.
1223 If into-dir is set to nil then target is not regarded as a directory,
1224 there must be exactly one marked file, else error.
1225 Else if into-dir is set to a list, then target is a generalized
1226 directory (e.g. some sort of archive). The first element of into-dir
1227 must be a function with at least four arguments:
1228 operation as OPERATION above.
1229 rfn-list a list of the relative names for the marked files.
1230 fn-list a list of the absolute names for the marked files.
1231 target.
1232 The rest of into-dir are optional arguments.
1233 Else into-dir is not a list. Target is a directory.
1234 The marked file(s) are created inside the target directory.
1236 If HOW-TO is not given (or nil), then into-dir is set to true if
1237 target is a directory and otherwise to nil.
1238 Else if HOW-TO is t, then into-dir is set to nil.
1239 Else HOW-TO is assumed to be a function of one argument, target,
1240 that looks at target and returns a value for the into-dir
1241 variable. The function `dired-into-dir-with-symlinks' is provided
1242 for the case (common when creating symlinks) that symbolic
1243 links to directories are not to be considered as directories
1244 (as `file-directory-p' would if HOW-TO had been nil)."
1253 target-dir)))
1257 target-dir op-symbol arg rfn-list default)))
1259 ;; Allow DOS/Windows users to change the letter
1260 ;; case of a directory. If we don't test these
1261 ;; conditions up front, file-directory-p below
1262 ;; will return t because the filesystem is
1263 ;; case-insensitive, and Emacs will try to move
1264 ;; foo -> foo/foo, which fails.
1267 dired-one-file
1275 nil
1283 ;; rename-file bombs when moving directories unless we do this:
1286 file-creator operation fn-list
1288 ;; This function uses fluid variable target when called
1289 ;; inside dired-create-files:
1294 marker-char))))
1296 ;; Read arguments for a marked-files command that wants a file name,
1297 ;; perhaps popping up the list of marked files.
1298 ;; ARG is the prefix arg and indicates whether the files came from
1299 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1300 ;; If the current file was used, the list has but one element and ARG
1301 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1302 ;; DEFAULT is the default value to return if the user just hits RET;
1303 ;; if it is omitted or nil, then the name of the directory is used.
1308 nil op-symbol files
1313 ;; Try to guess which target directory the user may want.
1314 ;; If there is a dired buffer displayed in the next window, use
1315 ;; its current subdir, else use current subdir of this dired buffer.
1318 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1326 this-dir)))
1327 \f
1328 ;;;###autoload
1330 "Create a directory called DIRECTORY."
1341 ;; This may not always be what you want, especially if target is your
1342 ;; home directory and it happens to be a symbolic link, as is often the
1343 ;; case with NFS and automounters. Or if you want to make symlinks
1344 ;; into directories that themselves are only symlinks, also quite
1345 ;; common.
1347 ;; So we don't use this function as value for HOW-TO in
1348 ;; dired-do-symlink, which has the minor disadvantage of
1349 ;; making links *into* a symlinked-dir, when you really wanted to
1350 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1351 ;; just have to remove that symlink by hand before making your marked
1352 ;; symlinks.
1355 "nil or a function used by `dired-do-copy' to determine target.
1358 ;;;###autoload
1360 "Copy all marked (or next ARG) files, or copy the current file.
1361 This normally preserves the last-modified date when copying.
1362 When operating on just the current file, you specify the new name.
1363 When operating on multiple or marked files, you specify a directory,
1364 and new copies of these files are made in that directory
1365 with the same names that the files currently have. The default
1366 suggested for the target directory depends on the value of
1367 `dired-dwim-target', which see."
1372 arg dired-keep-marker-copy
1373 nil dired-copy-how-to-fn)))
1375 ;;;###autoload
1377 "Make symbolic links to current file or all marked (or next ARG) files.
1378 When operating on just the current file, you specify the new name.
1379 When operating on multiple or marked files, you specify a directory
1380 and new symbolic links are made in that directory
1381 with the same names that the files currently have. The default
1382 suggested for the target directory depends on the value of
1383 `dired-dwim-target', which see."
1388 ;;;###autoload
1390 "Add names (hard links) current file or all marked (or next ARG) files.
1391 When operating on just the current file, you specify the new name.
1392 When operating on multiple or marked files, you specify a directory
1393 and new hard links are made in that directory
1394 with the same names that the files currently have. The default
1395 suggested for the target directory depends on the value of
1396 `dired-dwim-target', which see."
1401 ;;;###autoload
1403 "Rename current file or all marked (or next ARG) files.
1404 When renaming just the current file, you specify the new name.
1405 When renaming multiple or marked files, you specify a directory.
1406 The default suggested for the target directory depends on the value
1407 of `dired-dwim-target', which see."
1411 ;;;###end dired-cp.el
1412 \f
1413 ;;; 5K
1414 ;;;###begin dired-re.el
1417 ;; Create a new file for each marked file using regexps.
1418 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1419 ;; ARG as in dired-get-marked-files.
1420 ;; Matches each marked file against REGEXP and constructs the new
1421 ;; filename from NEWNAME (like in function replace-match).
1422 ;; Optional arg WHOLE-PATH means match/replace the whole file name
1423 ;; instead of only the non-directory part of the file.
1424 ;; Optional arg MARKER-CHAR as in dired-create-files.
1429 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1430 `!' to %s all remaining matches with no more questions."
1434 ;; Function to construct new filename using REGEXP and NEWNAME:
1439 ;; must bind help-form directly around call to
1440 ;; dired-query
1444 operation-prompt
1445 from
1446 to)
1447 to)
1449 operation from regexp)))))
1450 ;; not whole-path, replace non-directory part only
1461 operation-prompt
1464 to)
1467 rename-regexp-query)
1469 file-creator operation fn-list regexp-name-constructor marker-char)))
1472 ;; Prompt user about performing OPERATION.
1473 ;; Read and return list of: regexp newname arg whole-path.
1486 ;;;###autoload
1488 "Rename selected files whose names match REGEXP to NEWNAME.
1490 With non-zero prefix argument ARG, the command operates on the next ARG
1491 files. Otherwise, it operates on all the marked files, or the current
1492 file if none are marked.
1494 As each match is found, the user must type a character saying
1497 REGEXP defaults to the last regexp used.
1499 With a zero prefix arg, renaming by regexp affects the absolute file name.
1500 Normally, only the non-directory part of the file name is used and changed."
1506 ;;;###autoload
1508 "Copy selected files whose names match REGEXP to NEWNAME.
1509 See function `dired-do-rename-regexp' for more info."
1515 arg regexp newname whole-path dired-keep-marker-copy)))
1517 ;;;###autoload
1519 "Hardlink selected files whose names match REGEXP to NEWNAME.
1520 See function `dired-do-rename-regexp' for more info."
1526 ;;;###autoload
1528 "Symlink selected files whose names match REGEXP to NEWNAME.
1529 See function `dired-do-rename-regexp' for more info."
1537 ;; Perform FILE-CREATOR on the non-directory part of marked files
1538 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1539 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1542 file-creator
1543 operation
1551 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1552 `!' to %s all remaining matches with no more questions."
1559 to))))
1560 dired-keep-marker-rename)))
1565 basename-constructor operation arg))
1567 ;;;###autoload
1569 "Rename all marked (or next ARG) files to upper case."
1573 ;;;###autoload
1575 "Rename all marked (or next ARG) files to lower case."
1579 ;;;###end dired-re.el
1580 \f
1581 ;;; 13K
1582 ;;;###begin dired-ins.el
1584 ;;;###autoload
1586 switches no-error-if-not-dir-p)
1587 "Insert this subdirectory into the same dired buffer.
1589 else inserts it at its natural place (as `ls -lR' would have done).
1590 With a prefix arg, you may edit the ls switches used for this listing.
1591 You can add `R' to the switches to expand the whole tree starting at
1592 this subdirectory.
1593 This function takes some pains to conform to `ls -lR' output."
1599 ;; We don't need a marker for opoint as the subdir is always
1600 ;; inserted *after* opoint.
1605 ;; Push mark so that it's easy to find back. Do this after the
1606 ;; insert message so that the user sees the `Mark set' message.
1609 ;;;###autoload
1611 "Insert this subdirectory into the same dired buffer.
1612 If it is already present, overwrites previous entry,
1613 else inserts it at its natural place (as `ls -lR' would have done).
1614 With a prefix arg, you may edit the `ls' switches used for this listing.
1615 You can add `R' to the switches to expand the whole tree starting at
1616 this subdirectory.
1617 This function takes some pains to conform to `ls -lR' output."
1618 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1619 ;; Prospero where dired-ls does the right thing, but
1620 ;; file-directory-p has not been redefined.
1631 switches-have-R mark-alist case-fold-search buffer-read-only)
1632 ;; case-fold-search is nil now, so we can test for capital `R':
1634 ;; avoid duplicated subdirs
1637 ;; If subdir is already present, remove it and remember its marks
1646 ;; This is a separate function for dired-vms.
1648 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1649 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1660 x))))
1661 ;; all switches that make a difference to dired-get-filename:
1665 ;; Add new DIR at NEW-MARKER. Sort alist.
1670 ;; Keep the alist sorted on buffer position.
1678 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1679 With optional arg REMEMBER-MARKS, return an alist of marked files."
1690 m-alist))
1693 ;; Find pos for new subdir, according to tree order.
1694 ;;(goto-char (point-max))
1702 ;; Insert NEW-DIR after DIR
1704 alist nil)))
1706 ;; want a separating newline between subdirs
1713 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1714 ;; Move to that buffer position. Return a mark-alist.
1717 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1726 ;; Insert ls output after point and put point on the correct
1727 ;; position for the subdir alist.
1728 ;; Return the boundary of the inserted text (as list of BEG and END).
1735 ;; top level directory may contain wildcards:
1743 ;; call dired-insert-headerline afterwards, as under VMS dired-ls
1744 ;; does insert the headerline itself and the insert function just
1745 ;; moves point.
1746 ;; Need a marker for END as this inserts text.
1750 ;; point is now like in dired-build-subdir-alist
1756 ;; Point is at the correct subdir alist position for ELT,
1757 ;; BEG-END is the subdir-region (as list of begin and end).
1759 ;; update its position (should actually be unchanged)
1762 ;; The hook may depend on the subdir-alist containing the just
1763 ;; inserted subdir, so run it after dired-alist-add:
1771 ;; hook may add or delete lines, but the subdir boundary
1772 ;; marker floats
1776 ;; Lexicographic order on file name components, like `ls -lR':
1777 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1778 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1779 ;; or DIR1 and DIR2 are in the same parentdir and their last
1780 ;; components are string-lessp.
1781 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1782 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1783 ;; if dired-actual-switches contained `t'.
1789 components-2
1801 t)
1803 nil)
1806 ;; There should be a builtin split function - inverse to mapconcat.
1808 "Splitting on regexp PAT, turn string STR into a list of substrings.
1809 Optional third arg LIMIT (>= 1) is a limit to the length of the
1810 resulting list.
1811 Thus, if SEP is a regexp that only matches itself,
1813 (mapconcat 'identity (dired-split SEP STRING) SEP)
1815 is always equal to STRING."
1828 start end)
1829 ))
1836 \f
1837 ;;; moving by subdirectories
1839 ;;;###autoload
1841 "Go to previous subdirectory, regardless of level.
1842 When called interactively and not on a subdir line, go to this subdir's line."
1843 ;;(interactive "p")
1847 ;; if on subdir start already, don't stay there!
1857 ;;;###autoload
1859 "Go to end of header line of DIR in this dired buffer.
1860 Return value of point on success, otherwise return nil.
1866 dired-subdir-alist ; table
1867 nil ; predicate
1868 t ; require-match
1875 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1876 ;; at either \r or \n after this function succeeds.
1879 \f
1880 ;;;###autoload
1882 "Mark all files except `.' and `..' in current subdirectory.
1883 If the Dired buffer shows multiple directories, this command
1884 marks the files listed in the subdirectory that point is in."
1889 ;;;###autoload
1891 "Remove all lines of current subdirectory.
1892 Lower levels are unaffected."
1893 ;; With optional REMEMBER-MARKS, return a mark-alist.
1897 buffer-read-only cur-dir)
1909 ;; Remove DIR from the alist
1913 ;;;###autoload
1915 "Go up ARG levels in the dired tree."
1921 ;;(setq dir (expand-file-name dir))
1925 ;;;###autoload
1927 "Go down in the dired tree."
1941 \f
1942 ;;; hiding
1958 ;;;###autoload
1960 "Hide or unhide the current subdirectory and move to next directory.
1961 Optional prefix arg is a repeat factor.
1970 buffer-read-only)
1971 ;; keep header line visible, hide rest
1979 ;;;###autoload
1981 "Hide all subdirectories, leaving only their header lines.
1982 If there is already something hidden, make everything visible again.
1990 ;; unhide - bombs on \r in filenames
1992 ;; hide
1999 ;; we're somewhere on current dir's line
2006 ;;;###end dired-ins.el
2008 \f
2009 ;; Functions for searching in tags style among marked files.
2011 ;;;###autoload
2013 "Search through all marked files for a match for REGEXP.
2014 Stops when a match is found.
2019 ;;;###autoload
2021 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2022 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2028 \f
2029 ;;;###autoload
2031 "Print the type of FILE, according to the `file' command.
2032 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2033 true then the type of the file linked to by FILE is printed instead."
2045 ;;; dired-aux.el ends here