| blob | b31d20782f38f25e6a0ec75ffefb73747bcce678 |
1 ;;; dired-aux.el --- less commonly used parts of dired -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
7 ;; Maintainer: FSF
8 ;; Keywords: files
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; The parts of dired mode not normally used. This is a space-saving hack
30 ;; to avoid having to load a large mode when all that's wanted are a few
31 ;; functions.
33 ;; Rewritten in 1990/1991 to add tree features, file marking and
34 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
35 ;; Finished up by rms in 1992.
37 ;;; Code:
39 ;; We need macros in dired.el to compile properly.
42 ;;; 15K
43 ;;;###begin dired-cmd.el
44 ;; Diffing and compressing
49 ;;;###autoload
51 "Compare file at point with file FILE using `diff'.
52 FILE defaults to the file at the mark. (That's the mark set by
54 The prompted-for file is the first file given to `diff'.
55 With prefix arg, prompt for second argument SWITCHES,
56 which is options for `diff'."
70 default t)
74 diff-switches
78 ;;;###autoload
80 "Diff this file with its backup file or vice versa.
81 Uses the latest backup, if there are several numerical backups.
82 If this file is a backup, diff it with its original.
83 The backup file is the first file given to `diff'.
84 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
89 diff-switches
91 nil))
95 "Mark files with different file attributes in two dired buffers.
96 Compare file attributes of files in the current directory
97 with file attributes in directory DIR2 using PREDICATE on pairs of files
98 with the same name. Mark files for which PREDICATE returns non-nil.
99 Mark files with different names if PREDICATE is nil (or interactively
100 when the user enters empty input at the predicate prompt).
102 PREDICATE is a Lisp expression that can refer to the following variables:
104 size1, size2 - file size in bytes
105 mtime1, mtime2 - last modification time in seconds, as a float
106 fa1, fa2 - list of file attributes
107 returned by function `file-attributes'
109 where 1 refers to attribute of file in the current dired buffer
110 and 2 to attribute of file in second dired buffer.
112 Examples of PREDICATE:
114 (> mtime1 mtime2) - mark newer files
115 (not (= size1 size2)) - mark files with different sizes
116 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
117 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
118 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
128 'cadr
130 file-alist1 file-alist2
131 predicate)))
133 'cadr
135 file-alist2 file-alist1
136 predicate))))
138 dir1 nil
143 dir2 nil
152 "Combine LIST1 and LIST2 using a set-difference operation.
153 The result list contains all file items that appear in LIST1 but not LIST2.
154 This is a non-destructive function; it makes a copy of the data if necessary
155 to avoid corrupting the original LIST1 and LIST2.
156 PREDICATE (see `dired-compare-directories') is an additional match
157 condition. Two file items are considered to match if they are equal
158 *and* PREDICATE evaluates to t."
160 list1
176 list)
181 "Return a list of all file names and attributes from DIR.
182 List has a form of (file-name full-file-name (attribute-list))"
187 full-file-name
190 \f
193 "Create initial input value for `touch' command."
204 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
205 ;; refresh their file lines.
206 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
207 ;; PROGRAM is the program used to change the attribute.
208 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
209 ;; ARG describes which files to use, as in dired-get-marked-files.
215 op-symbol arg files))
217 failures)
228 files))
233 nil))))
235 ;;;###autoload
237 "Change the mode of the marked (or next ARG) files.
238 This calls chmod, thus symbolic modes like `g+w' are allowed."
242 ;;;###autoload
244 "Change the group of the marked (or next ARG) files."
250 ;;;###autoload
252 "Change the owner of the marked (or next ARG) files."
259 "Change the timestamp of the marked (or next ARG) files.
260 This calls touch."
264 ;; Process all the files in FILES in batches of a convenient size,
265 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
266 ;; Batches are chosen to need less than MAX chars for the file names,
267 ;; allowing 3 extra characters of separator per file name.
270 past
272 failures)
273 ;; Accumulate files as long as they fit in MAX chars,
274 ;; then process the ones accumulated so far.
279 ;; If we have at least 1 pending file
280 ;; and this file won't fit in the length limit, process now.
283 ;; The elements of PENDING are now in forward order.
284 ;; Do the operation and record failures.
286 failures)
287 ;; Transfer the elemens of PENDING onto PAST
288 ;; and clear it out. Now PAST contains the first N files
289 ;; specified (for some N), and FILES contains the rest.
291 pending nil
293 ;; Do (setq pending (cons thisfile pending))
294 ;; but reuse the cons that was in `files'.
302 failures)
303 ;; Now the original list FILES has been put back as it was.
306 ;;;###autoload
308 "Print the marked (or next ARG) files.
309 Uses the shell command coming from variables `lpr-command' and
310 `lpr-switches' as default."
314 "Print %s with: "
319 lpr-switches))
324 ;; Read arguments for a marked-files command that wants a string
325 ;; that is not a file name,
326 ;; perhaps popping up the list of marked files.
327 ;; ARG is the prefix arg and indicates whether the files came from
328 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
329 ;; If the current file was used, the list has but one element and ARG
330 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
333 ;; PROMPT for a string, with INITIAL input.
334 ;; Other args are used to give user feedback and pop-up:
335 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
337 nil op-symbol files
340 \f
341 ;;; Cleaning a directory: flagging some backups for deletion.
346 "Flag numerical backups for deletion.
347 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
348 Positive prefix arg KEEP overrides `dired-kept-versions';
349 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
352 with a prefix argument."
359 late-retention early-retention)
360 ;; Look at each file.
361 ;; If the file has numeric backup versions,
362 ;; put on dired-file-version-alist an element of the form
363 ;; (FILENAME . VERSION-NUMBER-LIST)
365 ;; Sort each VERSION-NUMBER-LIST,
366 ;; and remove the versions not to be deleted.
374 sorted-v-list)))
378 ;; Look at each file. If it is a numeric backup file,
379 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
383 ;;; Subroutines of dired-clean-directory.
386 ;; Perform FUN with point at the end of each non-directory line.
387 ;; FUN takes one argument, the absolute filename.
402 ;; Only do work if this file is not already in the alist.
404 nil
405 ;; If it looks like file FN has versions, return a list of the versions.
406 ;;That is a list of strings which are file names.
407 ;;The caller may want to flag some of these files for deletion.
412 base-versions
418 dired-file-version-alist)))))))
422 base-version-list)
432 \f
433 ;;; Shell commands
436 ;; "Read a dired shell command prompting with PROMPT (using read-string).
437 ;;ARG is the prefix arg and may be used to indicate in the prompt which
438 ;; files are affected.
439 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
441 nil 'shell files
446 ;; The in-background argument is only needed in Emacs 18 where
447 ;; shell-command doesn't understand an appended ampersand `&'.
448 ;;;###autoload
450 "Run a shell command COMMAND on the marked files.
451 If no files are marked or a specific numeric prefix arg is given,
453 The prompt mentions the file(s) or the marker, as appropriate.
455 If there is a `*' in COMMAND, surrounded by whitespace, this runs
456 COMMAND just once with the entire file list substituted there.
458 If there is no `*', but there is a `?' in COMMAND, surrounded by
459 whitespace, this runs COMMAND on each file individually with the
460 file name substituted for `?'.
462 Otherwise, this runs COMMAND on each file individually with the
463 file name added at the end of COMMAND (separated by a space).
465 `*' and `?' when not surrounded by whitespace have no special
466 significance for `dired-do-shell-command', and are passed through
467 normally to the shell, but you must confirm first. To pass `*' by
470 If COMMAND produces output, it goes to a separate buffer.
472 This feature does not try to redisplay Dired buffers afterward, as
473 there's no telling what files COMMAND may have changed.
476 When COMMAND runs, its working directory is the top-level directory of
477 the Dired buffer, so output files usually are created there instead of
478 in a subdir.
480 In a noninteractive call (from Lisp code), you must specify
481 the list of file names explicitly with the FILE-LIST argument."
482 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
483 ;;actual work and can be redefined for customization.
487 ;; Want to give feedback whether this file or marked files are used:
490 current-prefix-arg
491 files)
492 current-prefix-arg
493 files)))
498 ;; Get confirmation for wildcards that may have been meant
499 ;; to control substitution of a file name or the file name list.
513 nil
514 file-list)
515 ;; execute the shell command
519 ;; Might use {,} for bash or csh:
528 ;; "Make up a shell command line from COMMAND and FILE-LIST.
529 ;; If ON-EACH is t, COMMAND should be applied to each file, else
530 ;; simply concat all files and apply COMMAND to this.
531 ;; FILE-LIST's elements will be quoted for the shell."
532 ;; Might be redefined for smarter things and could then use RAW-ARG
533 ;; (coming from interactive P and currently ignored) to decide what to do.
534 ;; Smart would be a way to access basename or extension of file names.
543 retval))
548 file-list dired-mark-separator)))
553 ;; This is an extra function so that it can be redefined by ange-ftp.
560 ;; Return nil for sake of nconc in dired-bunch-files.
561 nil)
562 \f
563 ;; In Emacs 19 this will return program's exit status.
564 ;; This is a separate function so that ange-ftp can redefine it.
566 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
567 ;Remaining arguments are strings passed as command arguments to PROGRAM."
568 ;; Look for a handler for default-directory in case it is a remote file name.
573 program discard arguments)
577 ; "Display MSG while running PROGRAM, and check for output.
578 ;Remaining arguments are strings passed as command arguments to PROGRAM.
579 ; On error, insert output
580 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
581 ; Caller can cons up a list of failed args.
582 ;Else returns nil for success."
586 ;; Get a clean buffer for error output:
600 nil))))
601 \f
602 ;; Commands that delete or redisplay part of the dired buffer.
623 ;;;###autoload
625 "Kill all marked lines (not the files).
626 With a prefix argument, kill that many lines starting with the current line.
627 \(A negative argument kills lines before the current line.)
628 To kill an entire subdirectory, go to its directory header line
629 and use this command with a prefix argument (the value does not matter)."
630 ;; Returns count of killed lines. FMT="" suppresses message.
646 ;; else kill unmarked lines
657 count))))
659 ;;;###end dired-cmd.el
660 \f
661 ;;; 30K
662 ;;;###begin dired-cp.el
665 ;; Compress or uncompress the current file.
666 ;; Return nil for success, offending filename else.
672 ;; Remove any preexisting entry for the name NEW-FILE.
677 ;; Now replace the current line with an entry for NEW-FILE.
680 from-file)))
686 ;; For .z, try gunzip. It might be an old gzip file,
687 ;; or it might be from compact? pack? (which?) but gunzip handles both.
692 ;; This item controls naming for compression.
694 "Control changes in file name suffixes for compression and uncompression.
695 Each element specifies one transformation rule, and has the form:
696 (REGEXP NEW-SUFFIX PROGRAM)
697 The rule applies when the old file name matches REGEXP.
698 The new file name is computed by deleting the part that matches REGEXP
699 (as well as anything after that), then adding NEW-SUFFIX in its place.
700 If PROGRAM is non-nil, the rule is an uncompression rule,
701 and uncompression is done by running PROGRAM.
704 ;;;###autoload
706 ;; Compress or uncompress FILE.
707 ;; Return the name of the compressed or uncompressed file.
708 ;; Return nil if no change in files.
710 suffix newname
712 ;; See if any suffix rule matches this file name.
718 ;; If so, compute desired new name.
725 nil)
727 ;; We found an uncompression rule.
730 newname))
732 ;;; We don't recognize the file as compressed, so compress it.
733 ;;; Try gzip; if we don't have that, use compress.
741 ;; Rename the compressed file to NEWNAME
742 ;; if it hasn't got that name already.
746 newname)
747 out-name)))
751 ;; Don't use NEWNAME with `compress'.
753 \f
755 ;; Request confirmation from the user that the operation described
756 ;; by OP-SYMBOL is to be performed on the marked files.
757 ;; Confirmation consists in a y-or-n question with a file list
758 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
759 ;; The files used are determined by ARG (as in dired-get-marked-files).
770 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
771 ; and display failures.
773 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
774 ; the short form of the filename) for a failure and probably logs a
775 ; detailed error explanation using function `dired-log'.
777 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
778 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
779 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
780 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
782 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
794 ;; end this bunch of errors:
798 failures)))))
805 ;; None of these keys quit - use C-g for that.
806 ))
809 ;; Query user and return nil or t.
810 ;; Store answer in symbol VAR (which must initially be bound to nil).
811 ;; Format PROMPT with ARGS.
812 ;; Binding variable help-form will help the user who types the help key.
826 result elt)
827 ;; Actually it looks nicer without cursor-in-echo-area - you can
828 ;; look at the dired buffer instead of at the prompt to decide.
838 \f
839 ;;;###autoload
841 "Compress or uncompress marked (or next ARG) files."
845 ;; Commands for Emacs Lisp files - load and byte compile
848 ;; Return nil for success, offending file name else.
850 elc-file buffer-read-only failure)
865 nil)))
867 ;;;###autoload
869 "Byte compile marked (or next ARG) Emacs Lisp files."
874 ;; Return nil for success, offending file name else.
880 nil
884 ;;;###autoload
886 "Load the marked (or next ARG) Emacs Lisp files."
890 ;;;###autoload
892 "Redisplay all marked (or next ARG) files.
893 If on a subdir line, redisplay that subdirectory. In that case,
894 a prefix arg lets you edit the `ls' switches used for the new listing."
895 ;; Moves point if the next ARG files are redisplayed.
902 ;; message much faster than making dired-map-over-marks show progress
908 arg)
911 \f
913 ;; Delete the current line, and insert an entry for FILE.
914 ;; If FILE is nil, then just delete the current line.
915 ;; Keeps any marks that may be present in column one (doing this
916 ;; here is faster than with dired-add-entry's optional arg).
917 ;; Does not update other dired buffers. Use dired-relist-entry for that.
925 ;; Replace space by old marker without moving point.
926 ;; Faster than goto+insdel inside a save-excursion?
930 ;;;###autoload
937 ;; Add a new entry for FILENAME, optionally marking it
938 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
939 ;; Note that this adds the entry `out of order' if files sorted by
940 ;; time, etc.
941 ;; At least this version inserts in the right subdirectory (if present).
942 ;; And it skips "." or ".." (see `dired-trivial-filenames').
943 ;; Hidden subdirs are exposed if a file is added there.
945 ;; Entry is always for files, even if they happen to also be directories
950 reason)
955 reason
962 ;; We are already where we should be, except when
963 ;; point is before the subdir line or its total line.
967 ;; else try to find correct place to insert
972 ;; found - skip subdir and `total' line
973 ;; and uninteresting files like . and ..
974 ;; This better not moves into the next subdir!
976 ;; not found
981 ;; Don't expand `.'. Show just the file name within directory.
987 ;; Put in desired marker char.
992 ;; Compensate for a bug in ange-ftp.
993 ;; It inserts the file's absolute name, rather than
994 ;; the relative one. That may be hard to fix since it
995 ;; is probably controlled by something in ftp.
1018 ;; return nil if all went well
1019 nil))
1025 ;; Return pos of first file line of DIR, skipping header and total
1026 ;; or wildcard lines.
1027 ;; Important: never moves into the next subdir.
1028 ;; DIR is assumed to be unhidden.
1029 ;; Will probably be redefined for VMS etc.
1038 ;;;###autoload
1051 ;;;###autoload
1053 "Create or update the line for FILE in all Dired buffers it would belong in."
1059 ;; Relist the line for FILE, or just add it if it did not exist.
1060 ;; FILE must be an absolute file name.
1062 ;; If cursor is already on FILE's line delete-region will cause
1063 ;; save-excursion to fail because of floating makers,
1064 ;; moving point to beginning of line. Sigh.
1073 \f
1074 ;;; Copy, move/rename, making hard and symbolic links
1077 "*Decide whether recursive copies are allowed.
1078 nil means no recursive copies.
1079 `always' means copy recursively without asking.
1080 `top' means ask for each directory at top level.
1081 Anything else means ask for each directory."
1090 "*Non-nil if Dired should ask about making backups before overwriting files.
1091 Special value `always' suppresses confirmation."
1100 ;; Save old version of file TO that is to be overwritten.
1101 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1102 ;; from dired-create-files.
1105 dired-overwrite-confirmed
1110 to))))
1115 ;;;###autoload
1120 dired-recursive-copies)
1125 preserve-time top recursive)
1139 ok-flag preserve-time nil recursive)
1144 ;;;###autoload
1148 ;; Silently rename the visited file of any buffer visiting this file.
1153 ;; See if it's an inserted subdir, and rename that, too.
1161 ;; Update visited file name of all affected buffers
1172 to-dir
1173 buffer-file-name)))
1179 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1180 ;; one of its subdirectories is expanded in this buffer.
1188 ;; ELT's subdir is affected by the rename
1191 ;; if top level directory was renamed, lots of things have to be
1192 ;; updated:
1197 ;; with and without wildcards
1199 to))
1202 ;; try to rename buffer, but just leave old name if new
1203 ;; name would already exist (don't try appending "<%d>")
1206 ;; ... we dired TO now:
1210 ;; Update the headerline and dired-subdir-alist element of directory
1211 ;; described by alist-element ELT to reflect the moving of DIR to TO.
1212 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
1216 buffer-read-only)
1218 ;; Update subdir headerline in buffer
1221 dir)
1226 ;; Update buffer-local dired-subdir-alist
1230 \f
1231 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1235 ;; Create a new file for each from a list of existing files. The user
1236 ;; is queried, dired buffers are updated, and at the end a success or
1237 ;; failure message is displayed
1239 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1241 ;; It is called for each file and must create newfile, the entry of
1242 ;; which will be added. The user will be queried if the file already
1243 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1244 ;; rename), it is FILE-CREATOR's responsibility to update dired
1245 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1246 ;; could not create newfile. The error is caught and logged.
1248 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1249 ;; operation performed. It is used for error logging.
1251 ;; FN-LIST is the list of files to copy (full absolute file names).
1253 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1254 ;; skip. If it skips files for other reasons than a direct user
1255 ;; query, it is supposed to tell why (using dired-log).
1257 ;; Optional MARKER-CHAR is a character with which to mark every
1258 ;; newfile's entry, or t to use the current marker character if the
1259 ;; oldfile was marked.
1279 Type SPC or `y' to overwrite file `%s',
1280 DEL or `n' to skip to next,
1281 ESC or `q' to not overwrite any of the remaining files,
1285 ;; must determine if FROM is marked before file-creator
1286 ;; gets a chance to delete it (in case of a move).
1295 ;; If we get here, file-creator hasn't been aborted
1296 ;; and the old entry (if any) has to be deleted
1297 ;; before adding the new entry.
1306 operation from to err))))))))
1307 fn-list))
1314 failures))
1320 skipped))
1325 \f
1327 &optional marker-char op1
1328 how-to)
1329 "Create a new file for each marked file.
1330 Prompts user for target, which is a directory in which to create
1331 the new files. Target may be a plain file if only one marked
1332 file exists. The way the default for the target directory is
1333 computed depends on the value of `dired-dwim-target-directory'.
1334 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1335 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1336 FILE-CREATOR and OPERATION as in `dired-create-files'.
1337 ARG as in `dired-get-marked-files'.
1338 Optional arg MARKER-CHAR as in `dired-create-files'.
1339 Optional arg OP1 is an alternate form for OPERATION if there is
1340 only one file.
1341 Optional arg HOW-TO is used to set the value of the into-dir variable
1342 which determines how to treat target.
1343 If into-dir is set to nil then target is not regarded as a directory,
1344 there must be exactly one marked file, else error.
1345 Else if into-dir is set to a list, then target is a generalized
1346 directory (e.g. some sort of archive). The first element of into-dir
1347 must be a function with at least four arguments:
1348 operation as OPERATION above.
1349 rfn-list a list of the relative names for the marked files.
1350 fn-list a list of the absolute names for the marked files.
1351 target.
1352 The rest of into-dir are optional arguments.
1353 Else into-dir is not a list. Target is a directory.
1354 The marked file(s) are created inside the target directory.
1356 If HOW-TO is not given (or nil), then into-dir is set to true if
1357 target is a directory and otherwise to nil.
1358 Else if HOW-TO is t, then into-dir is set to nil.
1359 Else HOW-TO is assumed to be a function of one argument, target,
1360 that looks at target and returns a value for the into-dir
1361 variable. The function `dired-into-dir-with-symlinks' is provided
1362 for the case (common when creating symlinks) that symbolic
1363 links to directories are not to be considered as directories
1364 (as `file-directory-p' would if HOW-TO had been nil)."
1373 target-dir)))
1377 target-dir op-symbol arg rfn-list default)))
1379 ;; Allow DOS/Windows users to change the letter
1380 ;; case of a directory. If we don't test these
1381 ;; conditions up front, file-directory-p below
1382 ;; will return t because the filesystem is
1383 ;; case-insensitive, and Emacs will try to move
1384 ;; foo -> foo/foo, which fails.
1387 dired-one-file
1395 nil
1403 ;; rename-file bombs when moving directories unless we do this:
1406 file-creator operation fn-list
1408 ;; This function uses fluid variable target when called
1409 ;; inside dired-create-files:
1414 marker-char))))
1416 ;; Read arguments for a marked-files command that wants a file name,
1417 ;; perhaps popping up the list of marked files.
1418 ;; ARG is the prefix arg and indicates whether the files came from
1419 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1420 ;; If the current file was used, the list has but one element and ARG
1421 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1422 ;; DEFAULT is the default value to return if the user just hits RET;
1423 ;; if it is omitted or nil, then the name of the directory is used.
1428 nil op-symbol files
1433 ;; Try to guess which target directory the user may want.
1434 ;; If there is a dired buffer displayed in the next window, use
1435 ;; its current subdir, else use current subdir of this dired buffer.
1438 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1446 this-dir)))
1447 \f
1448 ;;;###autoload
1450 "Create a directory called DIRECTORY."
1461 ;; This may not always be what you want, especially if target is your
1462 ;; home directory and it happens to be a symbolic link, as is often the
1463 ;; case with NFS and automounters. Or if you want to make symlinks
1464 ;; into directories that themselves are only symlinks, also quite
1465 ;; common.
1467 ;; So we don't use this function as value for HOW-TO in
1468 ;; dired-do-symlink, which has the minor disadvantage of
1469 ;; making links *into* a symlinked-dir, when you really wanted to
1470 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1471 ;; just have to remove that symlink by hand before making your marked
1472 ;; symlinks.
1475 "nil or a function used by `dired-do-copy' to determine target.
1478 ;;;###autoload
1480 "Copy all marked (or next ARG) files, or copy the current file.
1481 This normally preserves the last-modified date when copying.
1482 When operating on just the current file, you specify the new name.
1483 When operating on multiple or marked files, you specify a directory,
1484 and new copies of these files are made in that directory
1485 with the same names that the files currently have. The default
1486 suggested for the target directory depends on the value of
1487 `dired-dwim-target', which see."
1492 arg dired-keep-marker-copy
1493 nil dired-copy-how-to-fn)))
1495 ;;;###autoload
1497 "Make symbolic links to current file or all marked (or next ARG) files.
1498 When operating on just the current file, you specify the new name.
1499 When operating on multiple or marked files, you specify a directory
1500 and new symbolic links are made in that directory
1501 with the same names that the files currently have. The default
1502 suggested for the target directory depends on the value of
1503 `dired-dwim-target', which see."
1508 ;;;###autoload
1510 "Add names (hard links) current file or all marked (or next ARG) files.
1511 When operating on just the current file, you specify the new name.
1512 When operating on multiple or marked files, you specify a directory
1513 and new hard links are made in that directory
1514 with the same names that the files currently have. The default
1515 suggested for the target directory depends on the value of
1516 `dired-dwim-target', which see."
1523 ;; error is caught in -create-files
1525 ;; Update the link count
1528 ;;;###autoload
1530 "Rename current file or all marked (or next ARG) files.
1531 When renaming just the current file, you specify the new name.
1532 When renaming multiple or marked files, you specify a directory.
1533 This command also renames any buffers that are visiting the files.
1534 The default suggested for the target directory depends on the value
1535 of `dired-dwim-target', which see."
1539 ;;;###end dired-cp.el
1540 \f
1541 ;;; 5K
1542 ;;;###begin dired-re.el
1545 ;; Create a new file for each marked file using regexps.
1546 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1547 ;; ARG as in dired-get-marked-files.
1548 ;; Matches each marked file against REGEXP and constructs the new
1549 ;; filename from NEWNAME (like in function replace-match).
1550 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1551 ;; instead of only the non-directory part of the file.
1552 ;; Optional arg MARKER-CHAR as in dired-create-files.
1557 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1558 `!' to %s all remaining matches with no more questions."
1562 ;; Function to construct new filename using REGEXP and NEWNAME:
1567 ;; must bind help-form directly around call to
1568 ;; dired-query
1572 operation-prompt
1573 from
1574 to)
1575 to)
1577 operation from regexp)))))
1578 ;; not whole-name, replace non-directory part only
1589 operation-prompt
1592 to)
1595 rename-regexp-query)
1597 file-creator operation fn-list regexp-name-constructor marker-char)))
1600 ;; Prompt user about performing OPERATION.
1601 ;; Read and return list of: regexp newname arg whole-name.
1614 ;;;###autoload
1616 "Rename selected files whose names match REGEXP to NEWNAME.
1618 With non-zero prefix argument ARG, the command operates on the next ARG
1619 files. Otherwise, it operates on all the marked files, or the current
1620 file if none are marked.
1622 As each match is found, the user must type a character saying
1625 REGEXP defaults to the last regexp used.
1627 With a zero prefix arg, renaming by regexp affects the absolute file name.
1628 Normally, only the non-directory part of the file name is used and changed."
1634 ;;;###autoload
1636 "Copy selected files whose names match REGEXP to NEWNAME.
1637 See function `dired-do-rename-regexp' for more info."
1643 arg regexp newname whole-name dired-keep-marker-copy)))
1645 ;;;###autoload
1647 "Hardlink selected files whose names match REGEXP to NEWNAME.
1648 See function `dired-do-rename-regexp' for more info."
1654 ;;;###autoload
1656 "Symlink selected files whose names match REGEXP to NEWNAME.
1657 See function `dired-do-rename-regexp' for more info."
1665 ;; Perform FILE-CREATOR on the non-directory part of marked files
1666 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1667 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1670 file-creator
1671 operation
1679 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1680 `!' to %s all remaining matches with no more questions."
1687 to))))
1688 dired-keep-marker-rename)))
1693 basename-constructor operation arg))
1695 ;;;###autoload
1697 "Rename all marked (or next ARG) files to upper case."
1701 ;;;###autoload
1703 "Rename all marked (or next ARG) files to lower case."
1707 ;;;###end dired-re.el
1708 \f
1709 ;;; 13K
1710 ;;;###begin dired-ins.el
1712 ;;;###autoload
1714 switches no-error-if-not-dir-p)
1715 "Insert this subdirectory into the same dired buffer.
1717 else inserts it at its natural place (as `ls -lR' would have done).
1718 With a prefix arg, you may edit the ls switches used for this listing.
1719 You can add `R' to the switches to expand the whole tree starting at
1720 this subdirectory.
1721 This function takes some pains to conform to `ls -lR' output."
1727 ;; We don't need a marker for opoint as the subdir is always
1728 ;; inserted *after* opoint.
1733 ;; Push mark so that it's easy to find back. Do this after the
1734 ;; insert message so that the user sees the `Mark set' message.
1737 ;;;###autoload
1739 "Insert this subdirectory into the same dired buffer.
1740 If it is already present, overwrites previous entry,
1741 else inserts it at its natural place (as `ls -lR' would have done).
1742 With a prefix arg, you may edit the `ls' switches used for this listing.
1743 You can add `R' to the switches to expand the whole tree starting at
1744 this subdirectory.
1745 This function takes some pains to conform to `ls -lR' output."
1746 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1747 ;; Prospero where dired-ls does the right thing, but
1748 ;; file-directory-p has not been redefined.
1759 switches-have-R mark-alist case-fold-search buffer-read-only)
1760 ;; case-fold-search is nil now, so we can test for capital `R':
1762 ;; avoid duplicated subdirs
1765 ;; If subdir is already present, remove it and remember its marks
1774 ;; This is a separate function for dired-vms.
1776 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1777 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1788 x))))
1789 ;; all switches that make a difference to dired-get-filename:
1793 ;; Add new DIR at NEW-MARKER. Sort alist.
1798 ;; Keep the alist sorted on buffer position.
1806 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1807 With optional arg REMEMBER-MARKS, return an alist of marked files."
1818 m-alist))
1821 ;; Find pos for new subdir, according to tree order.
1822 ;;(goto-char (point-max))
1830 ;; Insert NEW-DIR after DIR
1832 alist nil)))
1834 ;; want a separating newline between subdirs
1841 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1842 ;; Move to that buffer position. Return a mark-alist.
1845 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1854 ;; Insert ls output after point.
1855 ;; Return the boundary of the inserted text (as list of BEG and END).
1863 ;; If doing the top level directory of the buffer,
1864 ;; redo it as specified in dired-directory.
1871 ;; Point is at the correct subdir alist position for ELT,
1872 ;; BEG-END is the subdir-region (as list of begin and end).
1874 ;; update its position (should actually be unchanged)
1877 ;; The hook may depend on the subdir-alist containing the just
1878 ;; inserted subdir, so run it after dired-alist-add:
1886 ;; hook may add or delete lines, but the subdir boundary
1887 ;; marker floats
1891 ;; Lexicographic order on file name components, like `ls -lR':
1892 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1893 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1894 ;; or DIR1 and DIR2 are in the same parentdir and their last
1895 ;; components are string-lessp.
1896 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1897 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1898 ;; if dired-actual-switches contained `t'.
1904 components-2
1916 t)
1918 nil)
1921 ;; There should be a builtin split function - inverse to mapconcat.
1923 "Splitting on regexp PAT, turn string STR into a list of substrings.
1924 Optional third arg LIMIT (>= 1) is a limit to the length of the
1925 resulting list.
1926 Thus, if SEP is a regexp that only matches itself,
1928 (mapconcat 'identity (dired-split SEP STRING) SEP)
1930 is always equal to STRING."
1943 start end)
1944 ))
1951 \f
1952 ;;; moving by subdirectories
1954 ;;;###autoload
1956 "Go to previous subdirectory, regardless of level.
1957 When called interactively and not on a subdir line, go to this subdir's line."
1958 ;;(interactive "p")
1962 ;; if on subdir start already, don't stay there!
1972 ;;;###autoload
1974 "Go to end of header line of DIR in this dired buffer.
1975 Return value of point on success, otherwise return nil.
1981 dired-subdir-alist ; table
1982 nil ; predicate
1983 t ; require-match
1990 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1991 ;; at either \r or \n after this function succeeds.
1994 \f
1995 ;;;###autoload
1997 "Mark all files except `.' and `..' in current subdirectory.
1998 If the Dired buffer shows multiple directories, this command
1999 marks the files listed in the subdirectory that point is in."
2004 ;;;###autoload
2006 "Remove all lines of current subdirectory.
2007 Lower levels are unaffected."
2008 ;; With optional REMEMBER-MARKS, return a mark-alist.
2012 buffer-read-only cur-dir)
2024 ;; Remove DIR from the alist
2028 ;;;###autoload
2030 "Go up ARG levels in the dired tree."
2036 ;;(setq dir (expand-file-name dir))
2040 ;;;###autoload
2042 "Go down in the dired tree."
2056 \f
2057 ;;; hiding
2073 ;;;###autoload
2075 "Hide or unhide the current subdirectory and move to next directory.
2076 Optional prefix arg is a repeat factor.
2085 buffer-read-only)
2086 ;; keep header line visible, hide rest
2094 ;;;###autoload
2096 "Hide all subdirectories, leaving only their header lines.
2097 If there is already something hidden, make everything visible again.
2105 ;; unhide - bombs on \r in filenames
2107 ;; hide
2114 ;; we're somewhere on current dir's line
2121 ;;;###end dired-ins.el
2123 \f
2124 ;; Functions for searching in tags style among marked files.
2126 ;;;###autoload
2128 "Search through all marked files for a match for REGEXP.
2129 Stops when a match is found.
2134 ;;;###autoload
2136 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2137 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2145 buffer-read-only))
2152 \f
2153 ;;;###autoload
2155 "Print the type of FILE, according to the `file' command.
2156 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2157 true then the type of the file linked to by FILE is printed instead."
2169 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2170 ;;; dired-aux.el ends here