| blob | 8908e5ba4254085ea6124de84024322c412a364f |
1 ;;; dired-aux.el --- less commonly used parts of dired -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 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 3, 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., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, 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.
43 "Variable where `dired-create-files' records failing file names.
44 Functions that operate recursively can store additional names
47 ;;; 15K
48 ;;;###begin dired-cmd.el
49 ;; Diffing and compressing
54 ;;;###autoload
56 "Compare file at point with file FILE using `diff'.
57 FILE defaults to the file at the mark. (That's the mark set by
59 The prompted-for file is the first file given to `diff'.
60 With prefix arg, prompt for second argument SWITCHES,
61 which is options for `diff'."
74 current
81 default t)
85 diff-switches
89 ;;;###autoload
91 "Diff this file with its backup file or vice versa.
92 Uses the latest backup, if there are several numerical backups.
93 If this file is a backup, diff it with its original.
94 The backup file is the first file given to `diff'.
95 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
100 diff-switches
102 nil))
105 ;;;###autoload
107 "Mark files with different file attributes in two dired buffers.
108 Compare file attributes of files in the current directory
109 with file attributes in directory DIR2 using PREDICATE on pairs of files
110 with the same name. Mark files for which PREDICATE returns non-nil.
111 Mark files with different names if PREDICATE is nil (or interactively
112 with empty input at the predicate prompt).
114 PREDICATE is a Lisp expression that can refer to the following variables:
116 size1, size2 - file size in bytes
117 mtime1, mtime2 - last modification time in seconds, as a float
118 fa1, fa2 - list of file attributes
119 returned by function `file-attributes'
121 where 1 refers to attribute of file in the current dired buffer
122 and 2 to attribute of file in second dired buffer.
124 Examples of PREDICATE:
126 (> mtime1 mtime2) - mark newer files
127 (not (= size1 size2)) - mark files with different sizes
128 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
129 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
130 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
140 file-list1 file-list2)
146 'cadr
148 file-alist1 file-alist2
149 predicate))
151 'cadr
153 file-alist2 file-alist1
154 predicate)))
156 dir1 nil
161 dir2 nil
170 "Combine LIST1 and LIST2 using a set-difference operation.
171 The result list contains all file items that appear in LIST1 but not LIST2.
172 This is a non-destructive function; it makes a copy of the data if necessary
173 to avoid corrupting the original LIST1 and LIST2.
174 PREDICATE (see `dired-compare-directories') is an additional match
175 condition. Two file items are considered to match if they are equal
176 *and* PREDICATE evaluates to t."
178 list1
194 list)
199 "Return a list of all file names and attributes from DIR.
200 List has a form of (file-name full-file-name (attribute-list))"
205 full-file-name
208 \f
211 "Create initial input value for `touch' command."
222 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
223 ;; refresh their file lines.
224 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
225 ;; PROGRAM is the program used to change the attribute.
226 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
227 ;; ARG describes which files to use, as in dired-get-marked-files.
233 op-symbol arg files))
235 failures)
246 files))
251 nil))))
253 ;;;###autoload
255 "Change the mode of the marked (or next ARG) files.
256 This calls chmod, thus symbolic modes like `g+w' are allowed."
260 ;;;###autoload
262 "Change the group of the marked (or next ARG) files."
268 ;;;###autoload
270 "Change the owner of the marked (or next ARG) files."
276 ;;;###autoload
278 "Change the timestamp of the marked (or next ARG) files.
279 This calls touch."
283 ;; Process all the files in FILES in batches of a convenient size,
284 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
285 ;; Batches are chosen to need less than MAX chars for the file names,
286 ;; allowing 3 extra characters of separator per file name.
289 past
291 failures)
292 ;; Accumulate files as long as they fit in MAX chars,
293 ;; then process the ones accumulated so far.
298 ;; If we have at least 1 pending file
299 ;; and this file won't fit in the length limit, process now.
302 ;; The elements of PENDING are now in forward order.
303 ;; Do the operation and record failures.
305 failures)
306 ;; Transfer the elemens of PENDING onto PAST
307 ;; and clear it out. Now PAST contains the first N files
308 ;; specified (for some N), and FILES contains the rest.
310 pending nil
312 ;; Do (setq pending (cons thisfile pending))
313 ;; but reuse the cons that was in `files'.
321 failures)
322 ;; Now the original list FILES has been put back as it was.
325 ;;;###autoload
327 "Print the marked (or next ARG) files.
328 Uses the shell command coming from variables `lpr-command' and
329 `lpr-switches' as default."
333 "Print %s with: "
338 lpr-switches))
343 ;; Read arguments for a marked-files command that wants a string
344 ;; that is not a file name,
345 ;; perhaps popping up the list of marked files.
346 ;; ARG is the prefix arg and indicates whether the files came from
347 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
348 ;; If the current file was used, the list has but one element and ARG
349 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
352 ;; PROMPT for a string, with INITIAL input.
353 ;; Other args are used to give user feedback and pop-up:
354 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
356 nil op-symbol files
359 \f
360 ;;; Cleaning a directory: flagging some backups for deletion.
364 ;;;###autoload
366 "Flag numerical backups for deletion.
367 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
368 Positive prefix arg KEEP overrides `dired-kept-versions';
369 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
372 with a prefix argument."
379 late-retention early-retention)
380 ;; Look at each file.
381 ;; If the file has numeric backup versions,
382 ;; put on dired-file-version-alist an element of the form
383 ;; (FILENAME . VERSION-NUMBER-LIST)
385 ;; Sort each VERSION-NUMBER-LIST,
386 ;; and remove the versions not to be deleted.
394 sorted-v-list)))
398 ;; Look at each file. If it is a numeric backup file,
399 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
403 ;;; Subroutines of dired-clean-directory.
406 ;; Perform FUN with point at the end of each non-directory line.
407 ;; FUN takes one argument, the absolute filename.
422 ;; Only do work if this file is not already in the alist.
424 nil
425 ;; If it looks like file FN has versions, return a list of the versions.
426 ;;That is a list of strings which are file names.
427 ;;The caller may want to flag some of these files for deletion.
432 base-versions
438 dired-file-version-alist)))))))
442 base-version-list)
452 \f
453 ;;; Shell commands
456 ;; "Read a dired shell command prompting with PROMPT (using read-string).
457 ;;ARG is the prefix arg and may be used to indicate in the prompt which
458 ;; files are affected.
459 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
461 nil 'shell files
466 ;; The in-background argument is only needed in Emacs 18 where
467 ;; shell-command doesn't understand an appended ampersand `&'.
468 ;;;###autoload
470 "Run a shell command COMMAND on the marked files.
471 If no files are marked or a specific numeric prefix arg is given,
473 The prompt mentions the file(s) or the marker, as appropriate.
475 If there is a `*' in COMMAND, surrounded by whitespace, this runs
476 COMMAND just once with the entire file list substituted there.
478 If there is no `*', but there is a `?' in COMMAND, surrounded by
479 whitespace, this runs COMMAND on each file individually with the
480 file name substituted for `?'.
482 Otherwise, this runs COMMAND on each file individually with the
483 file name added at the end of COMMAND (separated by a space).
485 `*' and `?' when not surrounded by whitespace have no special
486 significance for `dired-do-shell-command', and are passed through
487 normally to the shell, but you must confirm first. To pass `*' by
490 If COMMAND produces output, it goes to a separate buffer.
492 This feature does not try to redisplay Dired buffers afterward, as
493 there's no telling what files COMMAND may have changed.
496 When COMMAND runs, its working directory is the top-level directory of
497 the Dired buffer, so output files usually are created there instead of
498 in a subdir.
500 In a noninteractive call (from Lisp code), you must specify
501 the list of file names explicitly with the FILE-LIST argument, which
502 can be produced by `dired-get-marked-files', for example."
503 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
504 ;;actual work and can be redefined for customization.
508 ;; Want to give feedback whether this file or marked files are used:
511 current-prefix-arg
512 files)
513 current-prefix-arg
514 files)))
519 ;; Get confirmation for wildcards that may have been meant
520 ;; to control substitution of a file name or the file name list.
534 nil
535 file-list)
536 ;; execute the shell command
540 ;; Might use {,} for bash or csh:
549 ;; "Make up a shell command line from COMMAND and FILE-LIST.
550 ;; If ON-EACH is t, COMMAND should be applied to each file, else
551 ;; simply concat all files and apply COMMAND to this.
552 ;; FILE-LIST's elements will be quoted for the shell."
553 ;; Might be redefined for smarter things and could then use RAW-ARG
554 ;; (coming from interactive P and currently ignored) to decide what to do.
555 ;; Smart would be a way to access basename or extension of file names.
564 retval))
569 file-list dired-mark-separator)))
574 ;; This is an extra function so that it can be redefined by ange-ftp.
575 ;;;###autoload
582 ;; Return nil for sake of nconc in dired-bunch-files.
583 nil)
584 \f
585 ;; In Emacs 19 this will return program's exit status.
586 ;; This is a separate function so that ange-ftp can redefine it.
588 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
589 ;Remaining arguments are strings passed as command arguments to PROGRAM."
590 ;; Look for a handler for default-directory in case it is a remote file name.
595 program discard arguments)
599 ; "Display MSG while running PROGRAM, and check for output.
600 ;Remaining arguments are strings passed as command arguments to PROGRAM.
601 ; On error, insert output
602 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
603 ; Caller can cons up a list of failed args.
604 ;Else returns nil for success."
608 ;; Get a clean buffer for error output:
622 nil))))
623 \f
624 ;; Commands that delete or redisplay part of the dired buffer.
645 ;;;###autoload
647 "Kill all marked lines (not the files).
648 With a prefix argument, kill that many lines starting with the current line.
649 \(A negative argument kills backward.)
650 If you use this command with a prefix argument to kill the line
651 for a file that is a directory, which you have inserted in the
652 Dired buffer as a subdirectory, then it deletes that subdirectory
653 from the buffer as well.
654 To kill an entire subdirectory \(without killing its line in the
655 parent directory), go to its directory header line and use this
656 command with a prefix argument (the value does not matter)."
657 ;; Returns count of killed lines. FMT="" suppresses message.
675 count))))
677 ;;;###end dired-cmd.el
678 \f
679 ;;; 30K
680 ;;;###begin dired-cp.el
683 ;; Compress or uncompress the current file.
684 ;; Return nil for success, offending filename else.
690 ;; Remove any preexisting entry for the name NEW-FILE.
695 ;; Now replace the current line with an entry for NEW-FILE.
698 from-file)))
704 ;; For .z, try gunzip. It might be an old gzip file,
705 ;; or it might be from compact? pack? (which?) but gunzip handles both.
710 ;; This item controls naming for compression.
712 "Control changes in file name suffixes for compression and uncompression.
713 Each element specifies one transformation rule, and has the form:
714 (REGEXP NEW-SUFFIX PROGRAM)
715 The rule applies when the old file name matches REGEXP.
716 The new file name is computed by deleting the part that matches REGEXP
717 (as well as anything after that), then adding NEW-SUFFIX in its place.
718 If PROGRAM is non-nil, the rule is an uncompression rule,
719 and uncompression is done by running PROGRAM.
722 ;;;###autoload
724 ;; Compress or uncompress FILE.
725 ;; Return the name of the compressed or uncompressed file.
726 ;; Return nil if no change in files.
728 suffix newname
730 ;; See if any suffix rule matches this file name.
736 ;; If so, compute desired new name.
743 nil)
745 ;; We found an uncompression rule.
748 newname))
750 ;;; We don't recognize the file as compressed, so compress it.
751 ;;; Try gzip; if we don't have that, use compress.
757 out-name)))
762 ;; Rename the compressed file to NEWNAME
763 ;; if it hasn't got that name already.
767 newname)
768 out-name)))
772 ;; Don't use NEWNAME with `compress'.
774 \f
776 ;; Request confirmation from the user that the operation described
777 ;; by OP-SYMBOL is to be performed on the marked files.
778 ;; Confirmation consists in a y-or-n question with a file list
779 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
780 ;; The files used are determined by ARG (as in dired-get-marked-files).
783 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
784 ;; is marked pops up a window. That will help the user see
785 ;; it isn't the current line file.
794 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
795 ; and display failures.
797 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
798 ; the short form of the filename) for a failure and probably logs a
799 ; detailed error explanation using function `dired-log'.
801 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
802 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
803 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
804 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
806 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
818 ;; end this bunch of errors:
822 failures)))))
829 ;; None of these keys quit - use C-g for that.
830 ))
832 ;;;###autoload
834 ;; Query user and return nil or t.
835 ;; Store answer in symbol VAR (which must initially be bound to nil).
836 ;; Format PROMPT with ARGS.
837 ;; Binding variable help-form will help the user who types the help key.
851 result elt)
852 ;; Actually it looks nicer without cursor-in-echo-area - you can
853 ;; look at the dired buffer instead of at the prompt to decide.
862 ;; Display the question with the answer.
866 \f
867 ;;;###autoload
869 "Compress or uncompress marked (or next ARG) files."
873 ;; Commands for Emacs Lisp files - load and byte compile
876 ;; Return nil for success, offending file name else.
878 elc-file buffer-read-only failure)
893 nil)))
895 ;;;###autoload
897 "Byte compile marked (or next ARG) Emacs Lisp files."
902 ;; Return nil for success, offending file name else.
908 nil
912 ;;;###autoload
914 "Load the marked (or next ARG) Emacs Lisp files."
918 ;;;###autoload
920 "Redisplay all marked (or next ARG) files.
921 If on a subdir line, redisplay that subdirectory. In that case,
922 a prefix arg lets you edit the `ls' switches used for the new listing.
924 Dired remembers switches specified with a prefix arg, so that reverting
925 the buffer will not reset them. However, using `dired-undo' to re-insert
926 or delete subdirectories can bypass this machinery. Hence, you sometimes
927 may have to reset some subdirectory switches after a `dired-undo'.
928 You can reset all subdirectory switches to the default using
930 See Info node `(emacs)Subdir switches' for more details."
931 ;; Moves point if the next ARG files are redisplayed.
937 dir
941 dired-subdir-switches
942 dired-actual-switches)))))
944 ;; message much faster than making dired-map-over-marks show progress
950 arg)
955 "Set `dired-switches-alist' to nil and revert dired buffer."
959 \f
961 ;; Delete the current line, and insert an entry for FILE.
962 ;; If FILE is nil, then just delete the current line.
963 ;; Keeps any marks that may be present in column one (doing this
964 ;; here is faster than with dired-add-entry's optional arg).
965 ;; Does not update other dired buffers. Use dired-relist-entry for that.
973 ;; Replace space by old marker without moving point.
974 ;; Faster than goto+insdel inside a save-excursion?
978 ;;;###autoload
985 ;; Add a new entry for FILENAME, optionally marking it
986 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
987 ;; Note that this adds the entry `out of order' if files sorted by
988 ;; time, etc.
989 ;; At least this version inserts in the right subdirectory (if present).
990 ;; And it skips "." or ".." (see `dired-trivial-filenames').
991 ;; Hidden subdirs are exposed if a file is added there.
993 ;; Entry is always for files, even if they happen to also be directories
998 reason)
1003 reason
1010 ;; We are already where we should be, except when
1011 ;; point is before the subdir line or its total line.
1015 ;; else try to find correct place to insert
1020 ;; found - skip subdir and `total' line
1021 ;; and uninteresting files like . and ..
1022 ;; This better not moves into the next subdir!
1024 ;; not found
1029 ;; Don't expand `.'. Show just the file name within directory.
1035 ;; Put in desired marker char.
1040 ;; Compensate for a bug in ange-ftp.
1041 ;; It inserts the file's absolute name, rather than
1042 ;; the relative one. That may be hard to fix since it
1043 ;; is probably controlled by something in ftp.
1066 ;; return nil if all went well
1067 nil))
1073 ;; Return pos of first file line of DIR, skipping header and total
1074 ;; or wildcard lines.
1075 ;; Important: never moves into the next subdir.
1076 ;; DIR is assumed to be unhidden.
1077 ;; Will probably be redefined for VMS etc.
1086 ;;;###autoload
1099 ;;;###autoload
1101 "Create or update the line for FILE in all Dired buffers it would belong in."
1107 ;; Relist the line for FILE, or just add it if it did not exist.
1108 ;; FILE must be an absolute file name.
1110 ;; If cursor is already on FILE's line delete-region will cause
1111 ;; save-excursion to fail because of floating makers,
1112 ;; moving point to beginning of line. Sigh.
1121 \f
1122 ;;; Copy, move/rename, making hard and symbolic links
1125 "*Non-nil if Dired should ask about making backups before overwriting files.
1126 Special value `always' suppresses confirmation."
1135 ;; Save old version of file TO that is to be overwritten.
1136 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1137 ;; from dired-create-files.
1140 dired-overwrite-confirmed
1144 "Make backup for existing file `%s'? "
1145 to)))
1150 ;;;###autoload
1154 dired-recursive-copies))
1157 preserve-time top recursive)
1159 dirfailed)
1164 ;; This is a directory.
1171 dired-create-files-failures)
1174 nil))))
1185 dired-create-files-failures)
1191 ;; Catch errors copying within a directory,
1192 ;; and report them through the dired log mechanism
1193 ;; just as our caller will do for the top level files.
1196 thisfrom thisto
1197 ok-flag preserve-time nil recursive)
1200 dired-create-files-failures)
1204 ;; Not a directory.
1208 ;; It is a symlink
1213 dired-create-files-failures)
1216 ;;;###autoload
1220 ;; Silently rename the visited file of any buffer visiting this file.
1225 ;; See if it's an inserted subdir, and rename that, too.
1233 ;; Update visited file name of all affected buffers
1244 to-dir
1245 buffer-file-name)))
1251 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1252 ;; one of its subdirectories is expanded in this buffer.
1260 ;; ELT's subdir is affected by the rename
1263 ;; if top level directory was renamed, lots of things have to be
1264 ;; updated:
1269 ;; with and without wildcards
1271 to))
1274 ;; try to rename buffer, but just leave old name if new
1275 ;; name would already exist (don't try appending "<%d>")
1278 ;; ... we dired TO now:
1282 ;; Update the headerline and dired-subdir-alist element, as well as
1283 ;; dired-switches-alist element, of directory described by
1284 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1285 ;; describes either DIR itself or a subdir of DIR.
1289 buffer-read-only)
1291 ;; Update subdir headerline in buffer
1294 dir)
1299 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1305 \f
1306 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1310 ;; Create a new file for each from a list of existing files. The user
1311 ;; is queried, dired buffers are updated, and at the end a success or
1312 ;; failure message is displayed
1314 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1316 ;; It is called for each file and must create newfile, the entry of
1317 ;; which will be added. The user will be queried if the file already
1318 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1319 ;; rename), it is FILE-CREATOR's responsibility to update dired
1320 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1321 ;; could not create newfile. The error is caught and logged.
1323 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1324 ;; operation performed. It is used for error logging.
1326 ;; FN-LIST is the list of files to copy (full absolute file names).
1328 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1329 ;; skip. If it skips files for other reasons than a direct user
1330 ;; query, it is supposed to tell why (using dired-log).
1332 ;; Optional MARKER-CHAR is a character with which to mark every
1333 ;; newfile's entry, or t to use the current marker character if the
1334 ;; oldfile was marked.
1355 Type SPC or `y' to overwrite file `%s',
1356 DEL or `n' to skip to next,
1357 ESC or `q' to not overwrite any of the remaining files,
1361 ;; must determine if FROM is marked before file-creator
1362 ;; gets a chance to delete it (in case of a move).
1371 ;; If we get here, file-creator hasn't been aborted
1372 ;; and the old entry (if any) has to be deleted
1373 ;; before adding the new entry.
1381 failures)
1383 operation from to err))))))))
1384 fn-list))
1392 total)
1393 failures))
1399 failures))
1405 skipped))
1410 \f
1412 &optional marker-char op1
1413 how-to)
1414 "Create a new file for each marked file.
1415 Prompts user for target, which is a directory in which to create
1416 the new files. Target may be a plain file if only one marked
1417 file exists. The way the default for the target directory is
1418 computed depends on the value of `dired-dwim-target-directory'.
1419 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1420 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1421 FILE-CREATOR and OPERATION as in `dired-create-files'.
1422 ARG as in `dired-get-marked-files'.
1423 Optional arg MARKER-CHAR as in `dired-create-files'.
1424 Optional arg OP1 is an alternate form for OPERATION if there is
1425 only one file.
1426 Optional arg HOW-TO is used to set the value of the into-dir variable
1427 which determines how to treat target.
1428 If into-dir is set to nil then target is not regarded as a directory,
1429 there must be exactly one marked file, else error.
1430 Else if into-dir is set to a list, then target is a generalized
1431 directory (e.g. some sort of archive). The first element of into-dir
1432 must be a function with at least four arguments:
1433 operation as OPERATION above.
1434 rfn-list a list of the relative names for the marked files.
1435 fn-list a list of the absolute names for the marked files.
1436 target.
1437 The rest of into-dir are optional arguments.
1438 Else into-dir is not a list. Target is a directory.
1439 The marked file(s) are created inside the target directory.
1441 If HOW-TO is not given (or nil), then into-dir is set to true if
1442 target is a directory and otherwise to nil.
1443 Else if HOW-TO is t, then into-dir is set to nil.
1444 Else HOW-TO is assumed to be a function of one argument, target,
1445 that looks at target and returns a value for the into-dir
1446 variable. The function `dired-into-dir-with-symlinks' is provided
1447 for the case (common when creating symlinks) that symbolic
1448 links to directories are not to be considered as directories
1449 (as `file-directory-p' would if HOW-TO had been nil)."
1458 target-dir)))
1462 target-dir op-symbol arg rfn-list default)))
1464 ;; Allow DOS/Windows users to change the letter
1465 ;; case of a directory. If we don't test these
1466 ;; conditions up front, file-directory-p below
1467 ;; will return t because the filesystem is
1468 ;; case-insensitive, and Emacs will try to move
1469 ;; foo -> foo/foo, which fails.
1472 dired-one-file
1480 nil
1488 ;; rename-file bombs when moving directories unless we do this:
1491 file-creator operation fn-list
1493 ;; This function uses fluid variable target when called
1494 ;; inside dired-create-files:
1499 marker-char))))
1501 ;; Read arguments for a marked-files command that wants a file name,
1502 ;; perhaps popping up the list of marked files.
1503 ;; ARG is the prefix arg and indicates whether the files came from
1504 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1505 ;; If the current file was used, the list has but one element and ARG
1506 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1507 ;; DEFAULT is the default value to return if the user just hits RET;
1508 ;; if it is omitted or nil, then the name of the directory is used.
1513 nil op-symbol files
1518 ;; Try to guess which target directory the user may want.
1519 ;; If there is a dired buffer displayed in the next window, use
1520 ;; its current subdir, else use current subdir of this dired buffer.
1523 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1531 this-dir)))
1532 \f
1533 ;;;###autoload
1535 "Create a directory called DIRECTORY."
1546 ;; This may not always be what you want, especially if target is your
1547 ;; home directory and it happens to be a symbolic link, as is often the
1548 ;; case with NFS and automounters. Or if you want to make symlinks
1549 ;; into directories that themselves are only symlinks, also quite
1550 ;; common.
1552 ;; So we don't use this function as value for HOW-TO in
1553 ;; dired-do-symlink, which has the minor disadvantage of
1554 ;; making links *into* a symlinked-dir, when you really wanted to
1555 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1556 ;; just have to remove that symlink by hand before making your marked
1557 ;; symlinks.
1560 "nil or a function used by `dired-do-copy' to determine target.
1563 ;;;###autoload
1565 "Copy all marked (or next ARG) files, or copy the current file.
1566 This normally preserves the last-modified date when copying.
1567 When operating on just the current file, you specify the new name.
1568 When operating on multiple or marked files, you specify a directory,
1569 and new copies of these files are made in that directory
1570 with the same names that the files currently have. The default
1571 suggested for the target directory depends on the value of
1572 `dired-dwim-target', which see.
1574 This command copies symbolic links by creating new ones,
1575 like `cp -d'."
1579 "Copy"
1580 arg dired-keep-marker-copy
1581 nil dired-copy-how-to-fn)))
1583 ;;;###autoload
1585 "Make symbolic links to current file or all marked (or next ARG) files.
1586 When operating on just the current file, you specify the new name.
1587 When operating on multiple or marked files, you specify a directory
1588 and new symbolic links are made in that directory
1589 with the same names that the files currently have. The default
1590 suggested for the target directory depends on the value of
1591 `dired-dwim-target', which see.
1598 ;;;###autoload
1600 "Add names (hard links) current file or all marked (or next ARG) files.
1601 When operating on just the current file, you specify the new name.
1602 When operating on multiple or marked files, you specify a directory
1603 and new hard links are made in that directory
1604 with the same names that the files currently have. The default
1605 suggested for the target directory depends on the value of
1606 `dired-dwim-target', which see."
1613 ;; error is caught in -create-files
1615 ;; Update the link count
1618 ;;;###autoload
1620 "Rename current file or all marked (or next ARG) files.
1621 When renaming just the current file, you specify the new name.
1622 When renaming multiple or marked files, you specify a directory.
1623 This command also renames any buffers that are visiting the files.
1624 The default suggested for the target directory depends on the value
1625 of `dired-dwim-target', which see."
1629 ;;;###end dired-cp.el
1630 \f
1631 ;;; 5K
1632 ;;;###begin dired-re.el
1635 ;; Create a new file for each marked file using regexps.
1636 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1637 ;; ARG as in dired-get-marked-files.
1638 ;; Matches each marked file against REGEXP and constructs the new
1639 ;; filename from NEWNAME (like in function replace-match).
1640 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1641 ;; instead of only the non-directory part of the file.
1642 ;; Optional arg MARKER-CHAR as in dired-create-files.
1647 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1648 `!' to %s all remaining matches with no more questions."
1652 ;; Function to construct new filename using REGEXP and NEWNAME:
1657 ;; must bind help-form directly around call to
1658 ;; dired-query
1662 operation-prompt
1663 from
1664 to)
1665 to)
1667 operation from regexp)))))
1668 ;; not whole-name, replace non-directory part only
1679 operation-prompt
1682 to)
1685 rename-regexp-query)
1687 file-creator operation fn-list regexp-name-constructor marker-char)))
1690 ;; Prompt user about performing OPERATION.
1691 ;; Read and return list of: regexp newname arg whole-name.
1704 ;;;###autoload
1706 "Rename selected files whose names match REGEXP to NEWNAME.
1708 With non-zero prefix argument ARG, the command operates on the next ARG
1709 files. Otherwise, it operates on all the marked files, or the current
1710 file if none are marked.
1712 As each match is found, the user must type a character saying
1715 REGEXP defaults to the last regexp used.
1717 With a zero prefix arg, renaming by regexp affects the absolute file name.
1718 Normally, only the non-directory part of the file name is used and changed."
1724 ;;;###autoload
1726 "Copy selected files whose names match REGEXP to NEWNAME.
1727 See function `dired-do-rename-regexp' for more info."
1733 arg regexp newname whole-name dired-keep-marker-copy)))
1735 ;;;###autoload
1737 "Hardlink selected files whose names match REGEXP to NEWNAME.
1738 See function `dired-do-rename-regexp' for more info."
1744 ;;;###autoload
1746 "Symlink selected files whose names match REGEXP to NEWNAME.
1747 See function `dired-do-rename-regexp' for more info."
1755 ;; Perform FILE-CREATOR on the non-directory part of marked files
1756 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1757 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1760 file-creator
1761 operation
1769 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1770 `!' to %s all remaining matches with no more questions."
1777 to))))
1778 dired-keep-marker-rename)))
1783 basename-constructor operation arg))
1785 ;;;###autoload
1787 "Rename all marked (or next ARG) files to upper case."
1791 ;;;###autoload
1793 "Rename all marked (or next ARG) files to lower case."
1797 ;;;###end dired-re.el
1798 \f
1799 ;;; 13K
1800 ;;;###begin dired-ins.el
1802 ;;;###autoload
1804 switches no-error-if-not-dir-p)
1805 "Insert this subdirectory into the same dired buffer.
1807 else inserts it at its natural place (as `ls -lR' would have done).
1808 With a prefix arg, you may edit the ls switches used for this listing.
1809 You can add `R' to the switches to expand the whole tree starting at
1810 this subdirectory.
1811 This function takes some pains to conform to `ls -lR' output.
1813 Dired remembers switches specified with a prefix arg, so that reverting
1814 the buffer will not reset them. However, using `dired-undo' to re-insert
1815 or delete subdirectories can bypass this machinery. Hence, you sometimes
1816 may have to reset some subdirectory switches after a `dired-undo'.
1817 You can reset all subdirectory switches to the default using
1819 See Info node `(emacs)Subdir switches' for more details."
1826 ;; We don't need a marker for opoint as the subdir is always
1827 ;; inserted *after* opoint.
1832 ;; Push mark so that it's easy to find back. Do this after the
1833 ;; insert message so that the user sees the `Mark set' message.
1836 ;;;###autoload
1838 "Insert this subdirectory into the same dired buffer.
1839 If it is already present, overwrites previous entry,
1840 else inserts it at its natural place (as `ls -lR' would have done).
1841 With a prefix arg, you may edit the `ls' switches used for this listing.
1842 You can add `R' to the switches to expand the whole tree starting at
1843 this subdirectory.
1844 This function takes some pains to conform to `ls -lR' output."
1845 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1846 ;; Prospero where dired-ls does the right thing, but
1847 ;; file-directory-p has not been redefined.
1861 switches-have-R mark-alist case-fold-search buffer-read-only)
1864 ;; case-fold-search is nil now, so we can test for capital `R':
1866 ;; avoid duplicated subdirs
1869 ;; If subdir is already present, remove it and remember its marks
1892 ;; This is a separate function for dired-vms.
1894 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1895 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1908 ;; all switches that make a difference to dired-get-filename:
1912 ;; Add new DIR at NEW-MARKER. Sort alist.
1917 ;; Keep the alist sorted on buffer position.
1925 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1926 Interactively, you can kill DIRNAME as well by using a prefix argument.
1927 In interactive use, the command prompts for DIRNAME.
1929 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1930 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1941 m-alist))
1944 ;; Find pos for new subdir, according to tree order.
1945 ;;(goto-char (point-max))
1953 ;; Insert NEW-DIR after DIR
1955 alist nil)))
1957 ;; want a separating newline between subdirs
1964 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1965 ;; Move to that buffer position. Return a mark-alist.
1968 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1977 ;; Insert ls output after point.
1978 ;; Return the boundary of the inserted text (as list of BEG and END).
1983 dired-subdir-switches
1986 ;; If doing the top level directory of the buffer,
1987 ;; redo it as specified in dired-directory.
1993 ;; Point is at the correct subdir alist position for ELT,
1994 ;; BEG-END is the subdir-region (as list of begin and end).
1996 ;; update its position (should actually be unchanged)
1999 ;; The hook may depend on the subdir-alist containing the just
2000 ;; inserted subdir, so run it after dired-alist-add:
2008 ;; hook may add or delete lines, but the subdir boundary
2009 ;; marker floats
2013 ;; Lexicographic order on file name components, like `ls -lR':
2014 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2015 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2016 ;; or DIR1 and DIR2 are in the same parentdir and their last
2017 ;; components are string-lessp.
2018 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2019 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2020 ;; if dired-actual-switches contained `t'.
2026 components-2
2038 t)
2040 nil)
2043 ;; There should be a builtin split function - inverse to mapconcat.
2045 "Splitting on regexp PAT, turn string STR into a list of substrings.
2046 Optional third arg LIMIT (>= 1) is a limit to the length of the
2047 resulting list.
2048 Thus, if SEP is a regexp that only matches itself,
2050 (mapconcat 'identity (dired-split SEP STRING) SEP)
2052 is always equal to STRING."
2065 start end)
2066 ))
2073 \f
2074 ;;; moving by subdirectories
2076 ;;;###autoload
2078 "Go to previous subdirectory, regardless of level.
2079 When called interactively and not on a subdir line, go to this subdir's line."
2080 ;;(interactive "p")
2084 ;; if on subdir start already, don't stay there!
2094 ;;;###autoload
2096 "Go to end of header line of DIR in this dired buffer.
2097 Return value of point on success, otherwise return nil.
2103 dired-subdir-alist ; table
2104 nil ; predicate
2105 t ; require-match
2112 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2113 ;; at either \r or \n after this function succeeds.
2116 \f
2117 ;;;###autoload
2119 "Mark all files except `.' and `..' in current subdirectory.
2120 If the Dired buffer shows multiple directories, this command
2121 marks the files listed in the subdirectory that point is in."
2126 ;;;###autoload
2128 "Remove all lines of current subdirectory.
2129 Lower levels are unaffected."
2130 ;; With optional REMEMBER-MARKS, return a mark-alist.
2137 buffer-read-only)
2151 ;; Remove DIR from the alist
2155 ;;;###autoload
2157 "Go up ARG levels in the dired tree."
2163 ;;(setq dir (expand-file-name dir))
2167 ;;;###autoload
2169 "Go down in the dired tree."
2183 \f
2184 ;;; hiding
2200 ;;;###autoload
2202 "Hide or unhide the current subdirectory and move to next directory.
2203 Optional prefix arg is a repeat factor.
2213 buffer-read-only)
2214 ;; keep header line visible, hide rest
2223 ;;;###autoload
2225 "Hide all subdirectories, leaving only their header lines.
2226 If there is already something hidden, make everything visible again.
2231 buffer-read-only)
2235 ;; unhide - bombs on \r in filenames
2237 ;; hide
2244 ;; we're somewhere on current dir's line
2252 ;;;###end dired-ins.el
2254 \f
2255 ;; Functions for searching in tags style among marked files.
2257 ;;;###autoload
2259 "Search through all marked files for a match for REGEXP.
2260 Stops when a match is found.
2265 ;;;###autoload
2267 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2268 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2279 buffer-read-only))
2286 \f
2287 ;;;###autoload
2289 "Print the type of FILE, according to the `file' command.
2290 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2291 true then the type of the file linked to by FILE is printed instead."
2303 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2304 ;;; dired-aux.el ends here