| blob | 1fc8e0e805aa6959c2e3e09990add45ea4300264 |
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'."
71 diff-switches
75 ;;;###autoload
77 "Diff this file with its backup file or vice versa.
78 Uses the latest backup, if there are several numerical backups.
79 If this file is a backup, diff it with its original.
80 The backup file is the first file given to `diff'.
81 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
86 diff-switches
88 nil))
92 "Mark files with different file attributes in two dired buffers.
93 Compare file attributes of files in the current directory
94 with file attributes in directory DIR2 using PREDICATE on pairs of files
95 with the same name. Mark files for which PREDICATE returns non-nil.
96 Mark files with different names if PREDICATE is nil (or interactively
97 when the user enters empty input at the predicate prompt).
99 PREDICATE is a Lisp expression that can refer to the following variables:
101 size1, size2 - file size in bytes
102 mtime1, mtime2 - last modification time in seconds, as a float
103 fa1, fa2 - list of file attributes
104 returned by function `file-attributes'
106 where 1 refers to attribute of file in the current dired buffer
107 and 2 to attribute of file in second dired buffer.
109 Examples of PREDICATE:
111 (> mtime1 mtime2) - mark newer files
112 (not (= size1 size2)) - mark files with different sizes
113 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
114 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
115 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
125 'cadr
127 file-alist1 file-alist2
128 predicate)))
130 'cadr
132 file-alist2 file-alist1
133 predicate))))
135 dir1 nil
140 dir2 nil
149 "Combine LIST1 and LIST2 using a set-difference operation.
150 The result list contains all file items that appear in LIST1 but not LIST2.
151 This is a non-destructive function; it makes a copy of the data if necessary
152 to avoid corrupting the original LIST1 and LIST2.
153 PREDICATE (see `dired-compare-directories') is an additional match
154 condition. Two file items are considered to match if they are equal
155 *and* PREDICATE evaluates to t."
157 list1
173 list)
178 "Return a list of all file names and attributes from DIR.
179 List has a form of (file-name full-file-name (attribute-list))"
184 full-file-name
187 \f
189 ;; Change file attributes (mode, group, owner) of marked files and
190 ;; refresh their file lines.
191 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
192 ;; PROGRAM is the program used to change the attribute.
193 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
194 ;; ARG describes which files to use, as in dired-get-marked-files.
199 nil op-symbol arg files))
201 failures)
209 files))
214 nil))))
216 ;;;###autoload
218 "Change the mode of the marked (or next ARG) files.
219 This calls chmod, thus symbolic modes like `g+w' are allowed."
223 ;;;###autoload
225 "Change the group of the marked (or next ARG) files."
231 ;;;###autoload
233 "Change the owner of the marked (or next ARG) files."
239 ;; Process all the files in FILES in batches of a convenient size,
240 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
241 ;; Batches are chosen to need less than MAX chars for the file names,
242 ;; allowing 3 extra characters of separator per file name.
245 past
247 failures)
248 ;; Accumulate files as long as they fit in MAX chars,
249 ;; then process the ones accumulated so far.
254 ;; If we have at least 1 pending file
255 ;; and this file won't fit in the length limit, process now.
258 ;; The elements of PENDING are now in forward order.
259 ;; Do the operation and record failures.
261 failures)
262 ;; Transfer the elemens of PENDING onto PAST
263 ;; and clear it out. Now PAST contains the first N files
264 ;; specified (for some N), and FILES contains the rest.
266 pending nil
268 ;; Do (setq pending (cons thisfile pending))
269 ;; but reuse the cons that was in `files'.
277 failures)
278 ;; Now the original list FILES has been put back as it was.
281 ;;;###autoload
283 "Print the marked (or next ARG) files.
284 Uses the shell command coming from variables `lpr-command' and
285 `lpr-switches' as default."
289 "Print %s with: "
294 lpr-switches))
299 ;; Read arguments for a marked-files command that wants a string
300 ;; that is not a file name,
301 ;; perhaps popping up the list of marked files.
302 ;; ARG is the prefix arg and indicates whether the files came from
303 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
304 ;; If the current file was used, the list has but one element and ARG
305 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
308 ;; PROMPT for a string, with INITIAL input.
309 ;; Other args are used to give user feedback and pop-up:
310 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
312 nil op-symbol files
315 \f
316 ;;; Cleaning a directory: flagging some backups for deletion.
321 "Flag numerical backups for deletion.
322 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
323 Positive prefix arg KEEP overrides `dired-kept-versions';
324 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
327 with a prefix argument."
334 late-retention early-retention)
335 ;; Look at each file.
336 ;; If the file has numeric backup versions,
337 ;; put on dired-file-version-alist an element of the form
338 ;; (FILENAME . VERSION-NUMBER-LIST)
340 ;; Sort each VERSION-NUMBER-LIST,
341 ;; and remove the versions not to be deleted.
349 sorted-v-list)))
353 ;; Look at each file. If it is a numeric backup file,
354 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
358 ;;; Subroutines of dired-clean-directory.
361 ;; Perform FUN with point at the end of each non-directory line.
362 ;; FUN takes one argument, the absolute filename.
377 ;; Only do work if this file is not already in the alist.
379 nil
380 ;; If it looks like file FN has versions, return a list of the versions.
381 ;;That is a list of strings which are file names.
382 ;;The caller may want to flag some of these files for deletion.
387 base-versions
393 dired-file-version-alist)))))))
397 base-version-list)
407 \f
408 ;;; Shell commands
411 ;; "Read a dired shell command prompting with PROMPT (using read-string).
412 ;;ARG is the prefix arg and may be used to indicate in the prompt which
413 ;; files are affected.
414 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
416 nil 'shell files
421 ;; The in-background argument is only needed in Emacs 18 where
422 ;; shell-command doesn't understand an appended ampersand `&'.
423 ;;;###autoload
425 "Run a shell command COMMAND on the marked files.
426 If no files are marked or a specific numeric prefix arg is given,
428 The prompt mentions the file(s) or the marker, as appropriate.
430 If there is a `*' in COMMAND, surrounded by whitespace, this runs
431 COMMAND just once with the entire file list substituted there.
433 If there is no `*', but there is a `?' in COMMAND, surrounded by
434 whitespace, this runs COMMAND on each file individually with the
435 file name substituted for `?'.
437 Otherwise, this runs COMMAND on each file individually with the
438 file name added at the end of COMMAND (separated by a space).
440 `*' and `?' when not surrounded by whitespace have no special
441 significance for `dired-do-shell-command', and are passed through
442 normally to the shell, but you must confirm first. To pass `*' by
445 If COMMAND produces output, it goes to a separate buffer.
447 This feature does not try to redisplay Dired buffers afterward, as
448 there's no telling what files COMMAND may have changed.
451 When COMMAND runs, its working directory is the top-level directory of
452 the Dired buffer, so output files usually are created there instead of
453 in a subdir.
455 In a noninteractive call (from Lisp code), you must specify
456 the list of file names explicitly with the FILE-LIST argument."
457 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
458 ;;actual work and can be redefined for customization.
462 ;; Want to give feedback whether this file or marked files are used:
465 current-prefix-arg
466 files)
467 current-prefix-arg
468 files)))
473 ;; Get confirmation for wildcards that may have been meant
474 ;; to control substitution of a file name or the file name list.
488 nil
489 file-list)
490 ;; execute the shell command
494 ;; Might use {,} for bash or csh:
503 ;; "Make up a shell command line from COMMAND and FILE-LIST.
504 ;; If ON-EACH is t, COMMAND should be applied to each file, else
505 ;; simply concat all files and apply COMMAND to this.
506 ;; FILE-LIST's elements will be quoted for the shell."
507 ;; Might be redefined for smarter things and could then use RAW-ARG
508 ;; (coming from interactive P and currently ignored) to decide what to do.
509 ;; Smart would be a way to access basename or extension of file names.
518 retval))
523 file-list dired-mark-separator)))
528 ;; This is an extra function so that it can be redefined by ange-ftp.
535 ;; Return nil for sake of nconc in dired-bunch-files.
536 nil)
537 \f
538 ;; In Emacs 19 this will return program's exit status.
539 ;; This is a separate function so that ange-ftp can redefine it.
541 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
542 ;Remaining arguments are strings passed as command arguments to PROGRAM."
543 ;; Look for a handler for default-directory in case it is a remote file name.
548 program discard arguments)
552 ; "Display MSG while running PROGRAM, and check for output.
553 ;Remaining arguments are strings passed as command arguments to PROGRAM.
554 ; On error, insert output
555 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
556 ; Caller can cons up a list of failed args.
557 ;Else returns nil for success."
561 ;; Get a clean buffer for error output:
575 nil))))
576 \f
577 ;; Commands that delete or redisplay part of the dired buffer.
598 ;;;###autoload
600 "Kill all marked lines (not the files).
601 With a prefix argument, kill that many lines starting with the current line.
602 \(A negative argument kills lines before the current line.)
603 To kill an entire subdirectory, go to its directory header line
604 and use this command with a prefix argument (the value does not matter)."
605 ;; Returns count of killed lines. FMT="" suppresses message.
621 ;; else kill unmarked lines
632 count))))
634 ;;;###end dired-cmd.el
635 \f
636 ;;; 30K
637 ;;;###begin dired-cp.el
640 ;; Compress or uncompress the current file.
641 ;; Return nil for success, offending filename else.
647 ;; Remove any preexisting entry for the name NEW-FILE.
652 ;; Now replace the current line with an entry for NEW-FILE.
655 from-file)))
661 ;; For .z, try gunzip. It might be an old gzip file,
662 ;; or it might be from compact? pack? (which?) but gunzip handles both.
667 ;; This item controls naming for compression.
669 "Control changes in file name suffixes for compression and uncompression.
670 Each element specifies one transformation rule, and has the form:
671 (REGEXP NEW-SUFFIX PROGRAM)
672 The rule applies when the old file name matches REGEXP.
673 The new file name is computed by deleting the part that matches REGEXP
674 (as well as anything after that), then adding NEW-SUFFIX in its place.
675 If PROGRAM is non-nil, the rule is an uncompression rule,
676 and uncompression is done by running PROGRAM.
679 ;;;###autoload
681 ;; Compress or uncompress FILE.
682 ;; Return the name of the compressed or uncompressed file.
683 ;; Return nil if no change in files.
685 suffix newname
687 ;; See if any suffix rule matches this file name.
693 ;; If so, compute desired new name.
700 nil)
702 ;; We found an uncompression rule.
705 newname))
707 ;;; We don't recognize the file as compressed, so compress it.
708 ;;; Try gzip; if we don't have that, use compress.
716 ;; Rename the compressed file to NEWNAME
717 ;; if it hasn't got that name already.
721 newname)
722 out-name)))
726 ;; Don't use NEWNAME with `compress'.
728 \f
730 ;; Request confirmation from the user that the operation described
731 ;; by OP-SYMBOL is to be performed on the marked files.
732 ;; Confirmation consists in a y-or-n question with a file list
733 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
734 ;; The files used are determined by ARG (as in dired-get-marked-files).
745 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
746 ; and display failures.
748 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
749 ; the short form of the filename) for a failure and probably logs a
750 ; detailed error explanation using function `dired-log'.
752 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
753 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
754 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
755 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
757 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
769 ;; end this bunch of errors:
773 failures)))))
780 ;; None of these keys quit - use C-g for that.
781 ))
784 ;; Query user and return nil or t.
785 ;; Store answer in symbol VAR (which must initially be bound to nil).
786 ;; Format PROMPT with ARGS.
787 ;; Binding variable help-form will help the user who types the help key.
801 result elt)
802 ;; Actually it looks nicer without cursor-in-echo-area - you can
803 ;; look at the dired buffer instead of at the prompt to decide.
813 \f
814 ;;;###autoload
816 "Compress or uncompress marked (or next ARG) files."
820 ;; Commands for Emacs Lisp files - load and byte compile
823 ;; Return nil for success, offending file name else.
825 elc-file buffer-read-only failure)
840 nil)))
842 ;;;###autoload
844 "Byte compile marked (or next ARG) Emacs Lisp files."
849 ;; Return nil for success, offending file name else.
855 nil
859 ;;;###autoload
861 "Load the marked (or next ARG) Emacs Lisp files."
865 ;;;###autoload
867 "Redisplay all marked (or next ARG) files.
868 If on a subdir line, redisplay that subdirectory. In that case,
869 a prefix arg lets you edit the `ls' switches used for the new listing."
870 ;; Moves point if the next ARG files are redisplayed.
877 ;; message much faster than making dired-map-over-marks show progress
883 arg)
886 \f
888 ;; Delete the current line, and insert an entry for FILE.
889 ;; If FILE is nil, then just delete the current line.
890 ;; Keeps any marks that may be present in column one (doing this
891 ;; here is faster than with dired-add-entry's optional arg).
892 ;; Does not update other dired buffers. Use dired-relist-entry for that.
900 ;; Replace space by old marker without moving point.
901 ;; Faster than goto+insdel inside a save-excursion?
905 ;;;###autoload
912 ;; Add a new entry for FILENAME, optionally marking it
913 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
914 ;; Note that this adds the entry `out of order' if files sorted by
915 ;; time, etc.
916 ;; At least this version inserts in the right subdirectory (if present).
917 ;; And it skips "." or ".." (see `dired-trivial-filenames').
918 ;; Hidden subdirs are exposed if a file is added there.
920 ;; Entry is always for files, even if they happen to also be directories
925 reason)
930 reason
937 ;; We are already where we should be, except when
938 ;; point is before the subdir line or its total line.
942 ;; else try to find correct place to insert
947 ;; found - skip subdir and `total' line
948 ;; and uninteresting files like . and ..
949 ;; This better not moves into the next subdir!
951 ;; not found
956 ;; Don't expand `.'. Show just the file name within directory.
962 ;; Put in desired marker char.
967 ;; Compensate for a bug in ange-ftp.
968 ;; It inserts the file's absolute name, rather than
969 ;; the relative one. That may be hard to fix since it
970 ;; is probably controlled by something in ftp.
993 ;; return nil if all went well
994 nil))
1000 ;; Return pos of first file line of DIR, skipping header and total
1001 ;; or wildcard lines.
1002 ;; Important: never moves into the next subdir.
1003 ;; DIR is assumed to be unhidden.
1004 ;; Will probably be redefined for VMS etc.
1013 ;;;###autoload
1026 ;;;###autoload
1028 "Create or update the line for FILE in all Dired buffers it would belong in."
1034 ;; Relist the line for FILE, or just add it if it did not exist.
1035 ;; FILE must be an absolute file name.
1037 ;; If cursor is already on FILE's line delete-region will cause
1038 ;; save-excursion to fail because of floating makers,
1039 ;; moving point to beginning of line. Sigh.
1048 \f
1049 ;;; Copy, move/rename, making hard and symbolic links
1052 "*Decide whether recursive copies are allowed.
1053 nil means no recursive copies.
1054 `always' means copy recursively without asking.
1055 `top' means ask for each directory at top level.
1056 Anything else means ask for each directory."
1065 "*Non-nil if Dired should ask about making backups before overwriting files.
1066 Special value `always' suppresses confirmation."
1075 ;; Save old version of file TO that is to be overwritten.
1076 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1077 ;; from dired-create-files.
1080 dired-overwrite-confirmed
1085 to))))
1090 ;;;###autoload
1095 dired-recursive-copies)
1100 preserve-time top recursive)
1114 ok-flag preserve-time nil recursive)
1119 ;;;###autoload
1123 ;; Silently rename the visited file of any buffer visiting this file.
1128 ;; See if it's an inserted subdir, and rename that, too.
1136 ;; Update visited file name of all affected buffers
1147 to-dir
1148 buffer-file-name)))
1154 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1155 ;; one of its subdirectories is expanded in this buffer.
1163 ;; ELT's subdir is affected by the rename
1166 ;; if top level directory was renamed, lots of things have to be
1167 ;; updated:
1172 ;; with and without wildcards
1174 to))
1177 ;; try to rename buffer, but just leave old name if new
1178 ;; name would already exist (don't try appending "<%d>")
1181 ;; ... we dired TO now:
1185 ;; Update the headerline and dired-subdir-alist element of directory
1186 ;; described by alist-element ELT to reflect the moving of DIR to TO.
1187 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
1191 buffer-read-only)
1193 ;; Update subdir headerline in buffer
1196 dir)
1201 ;; Update buffer-local dired-subdir-alist
1205 \f
1206 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1210 ;; Create a new file for each from a list of existing files. The user
1211 ;; is queried, dired buffers are updated, and at the end a success or
1212 ;; failure message is displayed
1214 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1216 ;; It is called for each file and must create newfile, the entry of
1217 ;; which will be added. The user will be queried if the file already
1218 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1219 ;; rename), it is FILE-CREATOR's responsibility to update dired
1220 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1221 ;; could not create newfile. The error is caught and logged.
1223 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1224 ;; operation performed. It is used for error logging.
1226 ;; FN-LIST is the list of files to copy (full absolute file names).
1228 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1229 ;; skip. If it skips files for other reasons than a direct user
1230 ;; query, it is supposed to tell why (using dired-log).
1232 ;; Optional MARKER-CHAR is a character with which to mark every
1233 ;; newfile's entry, or t to use the current marker character if the
1234 ;; oldfile was marked.
1254 Type SPC or `y' to overwrite file `%s',
1255 DEL or `n' to skip to next,
1256 ESC or `q' to not overwrite any of the remaining files,
1260 ;; must determine if FROM is marked before file-creator
1261 ;; gets a chance to delete it (in case of a move).
1270 ;; If we get here, file-creator hasn't been aborted
1271 ;; and the old entry (if any) has to be deleted
1272 ;; before adding the new entry.
1281 operation from to err))))))))
1282 fn-list))
1289 failures))
1295 skipped))
1300 \f
1302 &optional marker-char op1
1303 how-to)
1304 "Create a new file for each marked file.
1305 Prompts user for target, which is a directory in which to create
1306 the new files. Target may be a plain file if only one marked
1307 file exists. The way the default for the target directory is
1308 computed depends on the value of `dired-dwim-target-directory'.
1309 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1310 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1311 FILE-CREATOR and OPERATION as in `dired-create-files'.
1312 ARG as in `dired-get-marked-files'.
1313 Optional arg MARKER-CHAR as in `dired-create-files'.
1314 Optional arg OP1 is an alternate form for OPERATION if there is
1315 only one file.
1316 Optional arg HOW-TO is used to set the value of the into-dir variable
1317 which determines how to treat target.
1318 If into-dir is set to nil then target is not regarded as a directory,
1319 there must be exactly one marked file, else error.
1320 Else if into-dir is set to a list, then target is a generalized
1321 directory (e.g. some sort of archive). The first element of into-dir
1322 must be a function with at least four arguments:
1323 operation as OPERATION above.
1324 rfn-list a list of the relative names for the marked files.
1325 fn-list a list of the absolute names for the marked files.
1326 target.
1327 The rest of into-dir are optional arguments.
1328 Else into-dir is not a list. Target is a directory.
1329 The marked file(s) are created inside the target directory.
1331 If HOW-TO is not given (or nil), then into-dir is set to true if
1332 target is a directory and otherwise to nil.
1333 Else if HOW-TO is t, then into-dir is set to nil.
1334 Else HOW-TO is assumed to be a function of one argument, target,
1335 that looks at target and returns a value for the into-dir
1336 variable. The function `dired-into-dir-with-symlinks' is provided
1337 for the case (common when creating symlinks) that symbolic
1338 links to directories are not to be considered as directories
1339 (as `file-directory-p' would if HOW-TO had been nil)."
1348 target-dir)))
1352 target-dir op-symbol arg rfn-list default)))
1354 ;; Allow DOS/Windows users to change the letter
1355 ;; case of a directory. If we don't test these
1356 ;; conditions up front, file-directory-p below
1357 ;; will return t because the filesystem is
1358 ;; case-insensitive, and Emacs will try to move
1359 ;; foo -> foo/foo, which fails.
1362 dired-one-file
1370 nil
1378 ;; rename-file bombs when moving directories unless we do this:
1381 file-creator operation fn-list
1383 ;; This function uses fluid variable target when called
1384 ;; inside dired-create-files:
1389 marker-char))))
1391 ;; Read arguments for a marked-files command that wants a file name,
1392 ;; perhaps popping up the list of marked files.
1393 ;; ARG is the prefix arg and indicates whether the files came from
1394 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1395 ;; If the current file was used, the list has but one element and ARG
1396 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1397 ;; DEFAULT is the default value to return if the user just hits RET;
1398 ;; if it is omitted or nil, then the name of the directory is used.
1403 nil op-symbol files
1408 ;; Try to guess which target directory the user may want.
1409 ;; If there is a dired buffer displayed in the next window, use
1410 ;; its current subdir, else use current subdir of this dired buffer.
1413 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1421 this-dir)))
1422 \f
1423 ;;;###autoload
1425 "Create a directory called DIRECTORY."
1436 ;; This may not always be what you want, especially if target is your
1437 ;; home directory and it happens to be a symbolic link, as is often the
1438 ;; case with NFS and automounters. Or if you want to make symlinks
1439 ;; into directories that themselves are only symlinks, also quite
1440 ;; common.
1442 ;; So we don't use this function as value for HOW-TO in
1443 ;; dired-do-symlink, which has the minor disadvantage of
1444 ;; making links *into* a symlinked-dir, when you really wanted to
1445 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1446 ;; just have to remove that symlink by hand before making your marked
1447 ;; symlinks.
1450 "nil or a function used by `dired-do-copy' to determine target.
1453 ;;;###autoload
1455 "Copy all marked (or next ARG) files, or copy the current file.
1456 This normally preserves the last-modified date when copying.
1457 When operating on just the current file, you specify the new name.
1458 When operating on multiple or marked files, you specify a directory,
1459 and new copies of these files are made in that directory
1460 with the same names that the files currently have. The default
1461 suggested for the target directory depends on the value of
1462 `dired-dwim-target', which see."
1467 arg dired-keep-marker-copy
1468 nil dired-copy-how-to-fn)))
1470 ;;;###autoload
1472 "Make symbolic links to current file or all marked (or next ARG) files.
1473 When operating on just the current file, you specify the new name.
1474 When operating on multiple or marked files, you specify a directory
1475 and new symbolic links are made in that directory
1476 with the same names that the files currently have. The default
1477 suggested for the target directory depends on the value of
1478 `dired-dwim-target', which see."
1483 ;;;###autoload
1485 "Add names (hard links) current file or all marked (or next ARG) files.
1486 When operating on just the current file, you specify the new name.
1487 When operating on multiple or marked files, you specify a directory
1488 and new hard links are made in that directory
1489 with the same names that the files currently have. The default
1490 suggested for the target directory depends on the value of
1491 `dired-dwim-target', which see."
1498 ;; error is caught in -create-files
1500 ;; Update the link count
1503 ;;;###autoload
1505 "Rename current file or all marked (or next ARG) files.
1506 When renaming just the current file, you specify the new name.
1507 When renaming multiple or marked files, you specify a directory.
1508 This command also renames any buffers that are visiting the files.
1509 The default suggested for the target directory depends on the value
1510 of `dired-dwim-target', which see."
1514 ;;;###end dired-cp.el
1515 \f
1516 ;;; 5K
1517 ;;;###begin dired-re.el
1520 ;; Create a new file for each marked file using regexps.
1521 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1522 ;; ARG as in dired-get-marked-files.
1523 ;; Matches each marked file against REGEXP and constructs the new
1524 ;; filename from NEWNAME (like in function replace-match).
1525 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1526 ;; instead of only the non-directory part of the file.
1527 ;; Optional arg MARKER-CHAR as in dired-create-files.
1532 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1533 `!' to %s all remaining matches with no more questions."
1537 ;; Function to construct new filename using REGEXP and NEWNAME:
1542 ;; must bind help-form directly around call to
1543 ;; dired-query
1547 operation-prompt
1548 from
1549 to)
1550 to)
1552 operation from regexp)))))
1553 ;; not whole-name, replace non-directory part only
1564 operation-prompt
1567 to)
1570 rename-regexp-query)
1572 file-creator operation fn-list regexp-name-constructor marker-char)))
1575 ;; Prompt user about performing OPERATION.
1576 ;; Read and return list of: regexp newname arg whole-name.
1589 ;;;###autoload
1591 "Rename selected files whose names match REGEXP to NEWNAME.
1593 With non-zero prefix argument ARG, the command operates on the next ARG
1594 files. Otherwise, it operates on all the marked files, or the current
1595 file if none are marked.
1597 As each match is found, the user must type a character saying
1600 REGEXP defaults to the last regexp used.
1602 With a zero prefix arg, renaming by regexp affects the absolute file name.
1603 Normally, only the non-directory part of the file name is used and changed."
1609 ;;;###autoload
1611 "Copy selected files whose names match REGEXP to NEWNAME.
1612 See function `dired-do-rename-regexp' for more info."
1618 arg regexp newname whole-name dired-keep-marker-copy)))
1620 ;;;###autoload
1622 "Hardlink selected files whose names match REGEXP to NEWNAME.
1623 See function `dired-do-rename-regexp' for more info."
1629 ;;;###autoload
1631 "Symlink selected files whose names match REGEXP to NEWNAME.
1632 See function `dired-do-rename-regexp' for more info."
1640 ;; Perform FILE-CREATOR on the non-directory part of marked files
1641 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1642 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1645 file-creator
1646 operation
1654 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1655 `!' to %s all remaining matches with no more questions."
1662 to))))
1663 dired-keep-marker-rename)))
1668 basename-constructor operation arg))
1670 ;;;###autoload
1672 "Rename all marked (or next ARG) files to upper case."
1676 ;;;###autoload
1678 "Rename all marked (or next ARG) files to lower case."
1682 ;;;###end dired-re.el
1683 \f
1684 ;;; 13K
1685 ;;;###begin dired-ins.el
1687 ;;;###autoload
1689 switches no-error-if-not-dir-p)
1690 "Insert this subdirectory into the same dired buffer.
1692 else inserts it at its natural place (as `ls -lR' would have done).
1693 With a prefix arg, you may edit the ls switches used for this listing.
1694 You can add `R' to the switches to expand the whole tree starting at
1695 this subdirectory.
1696 This function takes some pains to conform to `ls -lR' output."
1702 ;; We don't need a marker for opoint as the subdir is always
1703 ;; inserted *after* opoint.
1708 ;; Push mark so that it's easy to find back. Do this after the
1709 ;; insert message so that the user sees the `Mark set' message.
1712 ;;;###autoload
1714 "Insert this subdirectory into the same dired buffer.
1715 If it is already present, overwrites previous entry,
1716 else inserts it at its natural place (as `ls -lR' would have done).
1717 With a prefix arg, you may edit the `ls' switches used for this listing.
1718 You can add `R' to the switches to expand the whole tree starting at
1719 this subdirectory.
1720 This function takes some pains to conform to `ls -lR' output."
1721 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1722 ;; Prospero where dired-ls does the right thing, but
1723 ;; file-directory-p has not been redefined.
1734 switches-have-R mark-alist case-fold-search buffer-read-only)
1735 ;; case-fold-search is nil now, so we can test for capital `R':
1737 ;; avoid duplicated subdirs
1740 ;; If subdir is already present, remove it and remember its marks
1749 ;; This is a separate function for dired-vms.
1751 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1752 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1763 x))))
1764 ;; all switches that make a difference to dired-get-filename:
1768 ;; Add new DIR at NEW-MARKER. Sort alist.
1773 ;; Keep the alist sorted on buffer position.
1781 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1782 With optional arg REMEMBER-MARKS, return an alist of marked files."
1793 m-alist))
1796 ;; Find pos for new subdir, according to tree order.
1797 ;;(goto-char (point-max))
1805 ;; Insert NEW-DIR after DIR
1807 alist nil)))
1809 ;; want a separating newline between subdirs
1816 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1817 ;; Move to that buffer position. Return a mark-alist.
1820 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1829 ;; Insert ls output after point.
1830 ;; Return the boundary of the inserted text (as list of BEG and END).
1838 ;; If doing the top level directory of the buffer,
1839 ;; redo it as specified in dired-directory.
1846 ;; Point is at the correct subdir alist position for ELT,
1847 ;; BEG-END is the subdir-region (as list of begin and end).
1849 ;; update its position (should actually be unchanged)
1852 ;; The hook may depend on the subdir-alist containing the just
1853 ;; inserted subdir, so run it after dired-alist-add:
1861 ;; hook may add or delete lines, but the subdir boundary
1862 ;; marker floats
1866 ;; Lexicographic order on file name components, like `ls -lR':
1867 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1868 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1869 ;; or DIR1 and DIR2 are in the same parentdir and their last
1870 ;; components are string-lessp.
1871 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1872 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1873 ;; if dired-actual-switches contained `t'.
1879 components-2
1891 t)
1893 nil)
1896 ;; There should be a builtin split function - inverse to mapconcat.
1898 "Splitting on regexp PAT, turn string STR into a list of substrings.
1899 Optional third arg LIMIT (>= 1) is a limit to the length of the
1900 resulting list.
1901 Thus, if SEP is a regexp that only matches itself,
1903 (mapconcat 'identity (dired-split SEP STRING) SEP)
1905 is always equal to STRING."
1918 start end)
1919 ))
1926 \f
1927 ;;; moving by subdirectories
1929 ;;;###autoload
1931 "Go to previous subdirectory, regardless of level.
1932 When called interactively and not on a subdir line, go to this subdir's line."
1933 ;;(interactive "p")
1937 ;; if on subdir start already, don't stay there!
1947 ;;;###autoload
1949 "Go to end of header line of DIR in this dired buffer.
1950 Return value of point on success, otherwise return nil.
1956 dired-subdir-alist ; table
1957 nil ; predicate
1958 t ; require-match
1965 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1966 ;; at either \r or \n after this function succeeds.
1969 \f
1970 ;;;###autoload
1972 "Mark all files except `.' and `..' in current subdirectory.
1973 If the Dired buffer shows multiple directories, this command
1974 marks the files listed in the subdirectory that point is in."
1979 ;;;###autoload
1981 "Remove all lines of current subdirectory.
1982 Lower levels are unaffected."
1983 ;; With optional REMEMBER-MARKS, return a mark-alist.
1987 buffer-read-only cur-dir)
1999 ;; Remove DIR from the alist
2003 ;;;###autoload
2005 "Go up ARG levels in the dired tree."
2011 ;;(setq dir (expand-file-name dir))
2015 ;;;###autoload
2017 "Go down in the dired tree."
2031 \f
2032 ;;; hiding
2048 ;;;###autoload
2050 "Hide or unhide the current subdirectory and move to next directory.
2051 Optional prefix arg is a repeat factor.
2060 buffer-read-only)
2061 ;; keep header line visible, hide rest
2069 ;;;###autoload
2071 "Hide all subdirectories, leaving only their header lines.
2072 If there is already something hidden, make everything visible again.
2080 ;; unhide - bombs on \r in filenames
2082 ;; hide
2089 ;; we're somewhere on current dir's line
2096 ;;;###end dired-ins.el
2098 \f
2099 ;; Functions for searching in tags style among marked files.
2101 ;;;###autoload
2103 "Search through all marked files for a match for REGEXP.
2104 Stops when a match is found.
2109 ;;;###autoload
2111 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2112 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2120 buffer-read-only))
2127 \f
2128 ;;;###autoload
2130 "Print the type of FILE, according to the `file' command.
2131 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2132 true then the type of the file linked to by FILE is printed instead."
2144 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2145 ;;; dired-aux.el ends here