| blob | 617cb38585f932b4c4d0711db63e76860c920a42 |
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., 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.
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))
94 ;;;###autoload
96 "Mark files with different file attributes in two dired buffers.
97 Compare file attributes of files in the current directory
98 with file attributes in directory DIR2 using PREDICATE on pairs of files
99 with the same name. Mark files for which PREDICATE returns non-nil.
100 Mark files with different names if PREDICATE is nil (or interactively
101 with empty input at the predicate prompt).
103 PREDICATE is a Lisp expression that can refer to the following variables:
105 size1, size2 - file size in bytes
106 mtime1, mtime2 - last modification time in seconds, as a float
107 fa1, fa2 - list of file attributes
108 returned by function `file-attributes'
110 where 1 refers to attribute of file in the current dired buffer
111 and 2 to attribute of file in second dired buffer.
113 Examples of PREDICATE:
115 (> mtime1 mtime2) - mark newer files
116 (not (= size1 size2)) - mark files with different sizes
117 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
118 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
119 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
129 file-list1 file-list2)
135 'cadr
137 file-alist1 file-alist2
138 predicate))
140 'cadr
142 file-alist2 file-alist1
143 predicate)))
145 dir1 nil
150 dir2 nil
159 "Combine LIST1 and LIST2 using a set-difference operation.
160 The result list contains all file items that appear in LIST1 but not LIST2.
161 This is a non-destructive function; it makes a copy of the data if necessary
162 to avoid corrupting the original LIST1 and LIST2.
163 PREDICATE (see `dired-compare-directories') is an additional match
164 condition. Two file items are considered to match if they are equal
165 *and* PREDICATE evaluates to t."
167 list1
183 list)
188 "Return a list of all file names and attributes from DIR.
189 List has a form of (file-name full-file-name (attribute-list))"
194 full-file-name
197 \f
200 "Create initial input value for `touch' command."
211 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
212 ;; refresh their file lines.
213 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
214 ;; PROGRAM is the program used to change the attribute.
215 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
216 ;; ARG describes which files to use, as in dired-get-marked-files.
222 op-symbol arg files))
224 failures)
235 files))
240 nil))))
242 ;;;###autoload
244 "Change the mode of the marked (or next ARG) files.
245 This calls chmod, thus symbolic modes like `g+w' are allowed."
249 ;;;###autoload
251 "Change the group of the marked (or next ARG) files."
257 ;;;###autoload
259 "Change the owner of the marked (or next ARG) files."
265 ;;;###autoload
267 "Change the timestamp of the marked (or next ARG) files.
268 This calls touch."
272 ;; Process all the files in FILES in batches of a convenient size,
273 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
274 ;; Batches are chosen to need less than MAX chars for the file names,
275 ;; allowing 3 extra characters of separator per file name.
278 past
280 failures)
281 ;; Accumulate files as long as they fit in MAX chars,
282 ;; then process the ones accumulated so far.
287 ;; If we have at least 1 pending file
288 ;; and this file won't fit in the length limit, process now.
291 ;; The elements of PENDING are now in forward order.
292 ;; Do the operation and record failures.
294 failures)
295 ;; Transfer the elemens of PENDING onto PAST
296 ;; and clear it out. Now PAST contains the first N files
297 ;; specified (for some N), and FILES contains the rest.
299 pending nil
301 ;; Do (setq pending (cons thisfile pending))
302 ;; but reuse the cons that was in `files'.
310 failures)
311 ;; Now the original list FILES has been put back as it was.
314 ;;;###autoload
316 "Print the marked (or next ARG) files.
317 Uses the shell command coming from variables `lpr-command' and
318 `lpr-switches' as default."
322 "Print %s with: "
327 lpr-switches))
332 ;; Read arguments for a marked-files command that wants a string
333 ;; that is not a file name,
334 ;; perhaps popping up the list of marked files.
335 ;; ARG is the prefix arg and indicates whether the files came from
336 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
337 ;; If the current file was used, the list has but one element and ARG
338 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
341 ;; PROMPT for a string, with INITIAL input.
342 ;; Other args are used to give user feedback and pop-up:
343 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
345 nil op-symbol files
348 \f
349 ;;; Cleaning a directory: flagging some backups for deletion.
353 ;;;###autoload
355 "Flag numerical backups for deletion.
356 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
357 Positive prefix arg KEEP overrides `dired-kept-versions';
358 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
361 with a prefix argument."
368 late-retention early-retention)
369 ;; Look at each file.
370 ;; If the file has numeric backup versions,
371 ;; put on dired-file-version-alist an element of the form
372 ;; (FILENAME . VERSION-NUMBER-LIST)
374 ;; Sort each VERSION-NUMBER-LIST,
375 ;; and remove the versions not to be deleted.
383 sorted-v-list)))
387 ;; Look at each file. If it is a numeric backup file,
388 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
392 ;;; Subroutines of dired-clean-directory.
395 ;; Perform FUN with point at the end of each non-directory line.
396 ;; FUN takes one argument, the absolute filename.
411 ;; Only do work if this file is not already in the alist.
413 nil
414 ;; If it looks like file FN has versions, return a list of the versions.
415 ;;That is a list of strings which are file names.
416 ;;The caller may want to flag some of these files for deletion.
421 base-versions
427 dired-file-version-alist)))))))
431 base-version-list)
441 \f
442 ;;; Shell commands
445 ;; "Read a dired shell command prompting with PROMPT (using read-string).
446 ;;ARG is the prefix arg and may be used to indicate in the prompt which
447 ;; files are affected.
448 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
450 nil 'shell files
455 ;; The in-background argument is only needed in Emacs 18 where
456 ;; shell-command doesn't understand an appended ampersand `&'.
457 ;;;###autoload
459 "Run a shell command COMMAND on the marked files.
460 If no files are marked or a specific numeric prefix arg is given,
462 The prompt mentions the file(s) or the marker, as appropriate.
464 If there is a `*' in COMMAND, surrounded by whitespace, this runs
465 COMMAND just once with the entire file list substituted there.
467 If there is no `*', but there is a `?' in COMMAND, surrounded by
468 whitespace, this runs COMMAND on each file individually with the
469 file name substituted for `?'.
471 Otherwise, this runs COMMAND on each file individually with the
472 file name added at the end of COMMAND (separated by a space).
474 `*' and `?' when not surrounded by whitespace have no special
475 significance for `dired-do-shell-command', and are passed through
476 normally to the shell, but you must confirm first. To pass `*' by
479 If COMMAND produces output, it goes to a separate buffer.
481 This feature does not try to redisplay Dired buffers afterward, as
482 there's no telling what files COMMAND may have changed.
485 When COMMAND runs, its working directory is the top-level directory of
486 the Dired buffer, so output files usually are created there instead of
487 in a subdir.
489 In a noninteractive call (from Lisp code), you must specify
490 the list of file names explicitly with the FILE-LIST argument."
491 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
492 ;;actual work and can be redefined for customization.
496 ;; Want to give feedback whether this file or marked files are used:
499 current-prefix-arg
500 files)
501 current-prefix-arg
502 files)))
507 ;; Get confirmation for wildcards that may have been meant
508 ;; to control substitution of a file name or the file name list.
522 nil
523 file-list)
524 ;; execute the shell command
528 ;; Might use {,} for bash or csh:
537 ;; "Make up a shell command line from COMMAND and FILE-LIST.
538 ;; If ON-EACH is t, COMMAND should be applied to each file, else
539 ;; simply concat all files and apply COMMAND to this.
540 ;; FILE-LIST's elements will be quoted for the shell."
541 ;; Might be redefined for smarter things and could then use RAW-ARG
542 ;; (coming from interactive P and currently ignored) to decide what to do.
543 ;; Smart would be a way to access basename or extension of file names.
552 retval))
557 file-list dired-mark-separator)))
562 ;; This is an extra function so that it can be redefined by ange-ftp.
563 ;;;###autoload
570 ;; Return nil for sake of nconc in dired-bunch-files.
571 nil)
572 \f
573 ;; In Emacs 19 this will return program's exit status.
574 ;; This is a separate function so that ange-ftp can redefine it.
576 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
577 ;Remaining arguments are strings passed as command arguments to PROGRAM."
578 ;; Look for a handler for default-directory in case it is a remote file name.
583 program discard arguments)
587 ; "Display MSG while running PROGRAM, and check for output.
588 ;Remaining arguments are strings passed as command arguments to PROGRAM.
589 ; On error, insert output
590 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
591 ; Caller can cons up a list of failed args.
592 ;Else returns nil for success."
596 ;; Get a clean buffer for error output:
610 nil))))
611 \f
612 ;; Commands that delete or redisplay part of the dired buffer.
633 ;;;###autoload
635 "Kill all marked lines (not the files).
636 With a prefix argument, kill that many lines starting with the current line.
637 \(A negative argument kills backward.)
638 If you use this command with a prefix argument to kill the line
639 for a file that is a directory, which you have inserted in the
640 Dired buffer as a subdirectory, then it deletes that subdirectory
641 from the buffer as well.
642 To kill an entire subdirectory \(without killing its line in the
643 parent directory), go to its directory header line and use this
644 command with a prefix argument (the value does not matter)."
645 ;; Returns count of killed lines. FMT="" suppresses message.
663 count))))
665 ;;;###end dired-cmd.el
666 \f
667 ;;; 30K
668 ;;;###begin dired-cp.el
671 ;; Compress or uncompress the current file.
672 ;; Return nil for success, offending filename else.
678 ;; Remove any preexisting entry for the name NEW-FILE.
683 ;; Now replace the current line with an entry for NEW-FILE.
686 from-file)))
692 ;; For .z, try gunzip. It might be an old gzip file,
693 ;; or it might be from compact? pack? (which?) but gunzip handles both.
698 ;; This item controls naming for compression.
700 "Control changes in file name suffixes for compression and uncompression.
701 Each element specifies one transformation rule, and has the form:
702 (REGEXP NEW-SUFFIX PROGRAM)
703 The rule applies when the old file name matches REGEXP.
704 The new file name is computed by deleting the part that matches REGEXP
705 (as well as anything after that), then adding NEW-SUFFIX in its place.
706 If PROGRAM is non-nil, the rule is an uncompression rule,
707 and uncompression is done by running PROGRAM.
710 ;;;###autoload
712 ;; Compress or uncompress FILE.
713 ;; Return the name of the compressed or uncompressed file.
714 ;; Return nil if no change in files.
716 suffix newname
718 ;; See if any suffix rule matches this file name.
724 ;; If so, compute desired new name.
731 nil)
733 ;; We found an uncompression rule.
736 newname))
738 ;;; We don't recognize the file as compressed, so compress it.
739 ;;; Try gzip; if we don't have that, use compress.
747 ;; Rename the compressed file to NEWNAME
748 ;; if it hasn't got that name already.
752 newname)
753 out-name)))
757 ;; Don't use NEWNAME with `compress'.
759 \f
761 ;; Request confirmation from the user that the operation described
762 ;; by OP-SYMBOL is to be performed on the marked files.
763 ;; Confirmation consists in a y-or-n question with a file list
764 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
765 ;; The files used are determined by ARG (as in dired-get-marked-files).
768 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
769 ;; is marked pops up a window. That will help the user see
770 ;; it isn't the current line file.
779 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
780 ; and display failures.
782 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
783 ; the short form of the filename) for a failure and probably logs a
784 ; detailed error explanation using function `dired-log'.
786 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
787 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
788 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
789 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
791 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
803 ;; end this bunch of errors:
807 failures)))))
814 ;; None of these keys quit - use C-g for that.
815 ))
817 ;;;###autoload
819 ;; Query user and return nil or t.
820 ;; Store answer in symbol VAR (which must initially be bound to nil).
821 ;; Format PROMPT with ARGS.
822 ;; Binding variable help-form will help the user who types the help key.
836 result elt)
837 ;; Actually it looks nicer without cursor-in-echo-area - you can
838 ;; look at the dired buffer instead of at the prompt to decide.
847 ;; Display the question with the answer.
851 \f
852 ;;;###autoload
854 "Compress or uncompress marked (or next ARG) files."
858 ;; Commands for Emacs Lisp files - load and byte compile
861 ;; Return nil for success, offending file name else.
863 elc-file buffer-read-only failure)
878 nil)))
880 ;;;###autoload
882 "Byte compile marked (or next ARG) Emacs Lisp files."
887 ;; Return nil for success, offending file name else.
893 nil
897 ;;;###autoload
899 "Load the marked (or next ARG) Emacs Lisp files."
903 ;;;###autoload
905 "Redisplay all marked (or next ARG) files.
906 If on a subdir line, redisplay that subdirectory. In that case,
907 a prefix arg lets you edit the `ls' switches used for the new listing.
909 Dired remembers switches specified with a prefix arg, so that reverting
910 the buffer will not reset them. However, using `dired-undo' to re-insert
911 or delete subdirectories can bypass this machinery. Hence, you sometimes
912 may have to reset some subdirectory switches after a `dired-undo'.
913 You can reset all subdirectory switches to the default using
915 See Info node `(emacs-xtra)Subdir switches' for more details."
916 ;; Moves point if the next ARG files are redisplayed.
922 dir
926 dired-subdir-switches
927 dired-actual-switches)))))
929 ;; message much faster than making dired-map-over-marks show progress
935 arg)
940 "Set `dired-switches-alist' to nil and revert dired buffer."
944 \f
946 ;; Delete the current line, and insert an entry for FILE.
947 ;; If FILE is nil, then just delete the current line.
948 ;; Keeps any marks that may be present in column one (doing this
949 ;; here is faster than with dired-add-entry's optional arg).
950 ;; Does not update other dired buffers. Use dired-relist-entry for that.
958 ;; Replace space by old marker without moving point.
959 ;; Faster than goto+insdel inside a save-excursion?
963 ;;;###autoload
970 ;; Add a new entry for FILENAME, optionally marking it
971 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
972 ;; Note that this adds the entry `out of order' if files sorted by
973 ;; time, etc.
974 ;; At least this version inserts in the right subdirectory (if present).
975 ;; And it skips "." or ".." (see `dired-trivial-filenames').
976 ;; Hidden subdirs are exposed if a file is added there.
978 ;; Entry is always for files, even if they happen to also be directories
983 reason)
988 reason
995 ;; We are already where we should be, except when
996 ;; point is before the subdir line or its total line.
1000 ;; else try to find correct place to insert
1005 ;; found - skip subdir and `total' line
1006 ;; and uninteresting files like . and ..
1007 ;; This better not moves into the next subdir!
1009 ;; not found
1014 ;; Don't expand `.'. Show just the file name within directory.
1020 ;; Put in desired marker char.
1025 ;; Compensate for a bug in ange-ftp.
1026 ;; It inserts the file's absolute name, rather than
1027 ;; the relative one. That may be hard to fix since it
1028 ;; is probably controlled by something in ftp.
1051 ;; return nil if all went well
1052 nil))
1058 ;; Return pos of first file line of DIR, skipping header and total
1059 ;; or wildcard lines.
1060 ;; Important: never moves into the next subdir.
1061 ;; DIR is assumed to be unhidden.
1062 ;; Will probably be redefined for VMS etc.
1071 ;;;###autoload
1084 ;;;###autoload
1086 "Create or update the line for FILE in all Dired buffers it would belong in."
1092 ;; Relist the line for FILE, or just add it if it did not exist.
1093 ;; FILE must be an absolute file name.
1095 ;; If cursor is already on FILE's line delete-region will cause
1096 ;; save-excursion to fail because of floating makers,
1097 ;; moving point to beginning of line. Sigh.
1106 \f
1107 ;;; Copy, move/rename, making hard and symbolic links
1110 "*Non-nil if Dired should ask about making backups before overwriting files.
1111 Special value `always' suppresses confirmation."
1120 ;; Save old version of file TO that is to be overwritten.
1121 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1122 ;; from dired-create-files.
1125 dired-overwrite-confirmed
1130 to))))
1135 ;;;###autoload
1140 dired-recursive-copies)
1145 preserve-time top recursive)
1151 ;; This is a directory.
1161 ok-flag preserve-time nil recursive)
1163 ;; Not a directory.
1166 ;; It is a symlink
1170 ;;;###autoload
1174 ;; Silently rename the visited file of any buffer visiting this file.
1179 ;; See if it's an inserted subdir, and rename that, too.
1187 ;; Update visited file name of all affected buffers
1198 to-dir
1199 buffer-file-name)))
1205 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1206 ;; one of its subdirectories is expanded in this buffer.
1214 ;; ELT's subdir is affected by the rename
1217 ;; if top level directory was renamed, lots of things have to be
1218 ;; updated:
1223 ;; with and without wildcards
1225 to))
1228 ;; try to rename buffer, but just leave old name if new
1229 ;; name would already exist (don't try appending "<%d>")
1232 ;; ... we dired TO now:
1236 ;; Update the headerline and dired-subdir-alist element, as well as
1237 ;; dired-switches-alist element, of directory described by
1238 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1239 ;; describes either DIR itself or a subdir of DIR.
1243 buffer-read-only)
1245 ;; Update subdir headerline in buffer
1248 dir)
1253 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1259 \f
1260 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1264 ;; Create a new file for each from a list of existing files. The user
1265 ;; is queried, dired buffers are updated, and at the end a success or
1266 ;; failure message is displayed
1268 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1270 ;; It is called for each file and must create newfile, the entry of
1271 ;; which will be added. The user will be queried if the file already
1272 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1273 ;; rename), it is FILE-CREATOR's responsibility to update dired
1274 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1275 ;; could not create newfile. The error is caught and logged.
1277 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1278 ;; operation performed. It is used for error logging.
1280 ;; FN-LIST is the list of files to copy (full absolute file names).
1282 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1283 ;; skip. If it skips files for other reasons than a direct user
1284 ;; query, it is supposed to tell why (using dired-log).
1286 ;; Optional MARKER-CHAR is a character with which to mark every
1287 ;; newfile's entry, or t to use the current marker character if the
1288 ;; oldfile was marked.
1308 Type SPC or `y' to overwrite file `%s',
1309 DEL or `n' to skip to next,
1310 ESC or `q' to not overwrite any of the remaining files,
1314 ;; must determine if FROM is marked before file-creator
1315 ;; gets a chance to delete it (in case of a move).
1324 ;; If we get here, file-creator hasn't been aborted
1325 ;; and the old entry (if any) has to be deleted
1326 ;; before adding the new entry.
1335 operation from to err))))))))
1336 fn-list))
1343 failures))
1349 skipped))
1354 \f
1356 &optional marker-char op1
1357 how-to)
1358 "Create a new file for each marked file.
1359 Prompts user for target, which is a directory in which to create
1360 the new files. Target may be a plain file if only one marked
1361 file exists. The way the default for the target directory is
1362 computed depends on the value of `dired-dwim-target-directory'.
1363 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1364 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1365 FILE-CREATOR and OPERATION as in `dired-create-files'.
1366 ARG as in `dired-get-marked-files'.
1367 Optional arg MARKER-CHAR as in `dired-create-files'.
1368 Optional arg OP1 is an alternate form for OPERATION if there is
1369 only one file.
1370 Optional arg HOW-TO is used to set the value of the into-dir variable
1371 which determines how to treat target.
1372 If into-dir is set to nil then target is not regarded as a directory,
1373 there must be exactly one marked file, else error.
1374 Else if into-dir is set to a list, then target is a generalized
1375 directory (e.g. some sort of archive). The first element of into-dir
1376 must be a function with at least four arguments:
1377 operation as OPERATION above.
1378 rfn-list a list of the relative names for the marked files.
1379 fn-list a list of the absolute names for the marked files.
1380 target.
1381 The rest of into-dir are optional arguments.
1382 Else into-dir is not a list. Target is a directory.
1383 The marked file(s) are created inside the target directory.
1385 If HOW-TO is not given (or nil), then into-dir is set to true if
1386 target is a directory and otherwise to nil.
1387 Else if HOW-TO is t, then into-dir is set to nil.
1388 Else HOW-TO is assumed to be a function of one argument, target,
1389 that looks at target and returns a value for the into-dir
1390 variable. The function `dired-into-dir-with-symlinks' is provided
1391 for the case (common when creating symlinks) that symbolic
1392 links to directories are not to be considered as directories
1393 (as `file-directory-p' would if HOW-TO had been nil)."
1402 target-dir)))
1406 target-dir op-symbol arg rfn-list default)))
1408 ;; Allow DOS/Windows users to change the letter
1409 ;; case of a directory. If we don't test these
1410 ;; conditions up front, file-directory-p below
1411 ;; will return t because the filesystem is
1412 ;; case-insensitive, and Emacs will try to move
1413 ;; foo -> foo/foo, which fails.
1416 dired-one-file
1424 nil
1432 ;; rename-file bombs when moving directories unless we do this:
1435 file-creator operation fn-list
1437 ;; This function uses fluid variable target when called
1438 ;; inside dired-create-files:
1443 marker-char))))
1445 ;; Read arguments for a marked-files command that wants a file name,
1446 ;; perhaps popping up the list of marked files.
1447 ;; ARG is the prefix arg and indicates whether the files came from
1448 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1449 ;; If the current file was used, the list has but one element and ARG
1450 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1451 ;; DEFAULT is the default value to return if the user just hits RET;
1452 ;; if it is omitted or nil, then the name of the directory is used.
1457 nil op-symbol files
1462 ;; Try to guess which target directory the user may want.
1463 ;; If there is a dired buffer displayed in the next window, use
1464 ;; its current subdir, else use current subdir of this dired buffer.
1467 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1475 this-dir)))
1476 \f
1477 ;;;###autoload
1479 "Create a directory called DIRECTORY."
1490 ;; This may not always be what you want, especially if target is your
1491 ;; home directory and it happens to be a symbolic link, as is often the
1492 ;; case with NFS and automounters. Or if you want to make symlinks
1493 ;; into directories that themselves are only symlinks, also quite
1494 ;; common.
1496 ;; So we don't use this function as value for HOW-TO in
1497 ;; dired-do-symlink, which has the minor disadvantage of
1498 ;; making links *into* a symlinked-dir, when you really wanted to
1499 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1500 ;; just have to remove that symlink by hand before making your marked
1501 ;; symlinks.
1504 "nil or a function used by `dired-do-copy' to determine target.
1507 ;;;###autoload
1509 "Copy all marked (or next ARG) files, or copy the current file.
1510 This normally preserves the last-modified date when copying.
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 copies of these files 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."
1520 "Copy"
1521 arg dired-keep-marker-copy
1522 nil dired-copy-how-to-fn)))
1524 ;;;###autoload
1526 "Make symbolic links to current file or all marked (or next ARG) files.
1527 When operating on just the current file, you specify the new name.
1528 When operating on multiple or marked files, you specify a directory
1529 and new symbolic links are made in that directory
1530 with the same names that the files currently have. The default
1531 suggested for the target directory depends on the value of
1532 `dired-dwim-target', which see."
1537 ;;;###autoload
1539 "Add names (hard links) current file or all marked (or next ARG) files.
1540 When operating on just the current file, you specify the new name.
1541 When operating on multiple or marked files, you specify a directory
1542 and new hard links are made in that directory
1543 with the same names that the files currently have. The default
1544 suggested for the target directory depends on the value of
1545 `dired-dwim-target', which see."
1552 ;; error is caught in -create-files
1554 ;; Update the link count
1557 ;;;###autoload
1559 "Rename current file or all marked (or next ARG) files.
1560 When renaming just the current file, you specify the new name.
1561 When renaming multiple or marked files, you specify a directory.
1562 This command also renames any buffers that are visiting the files.
1563 The default suggested for the target directory depends on the value
1564 of `dired-dwim-target', which see."
1568 ;;;###end dired-cp.el
1569 \f
1570 ;;; 5K
1571 ;;;###begin dired-re.el
1574 ;; Create a new file for each marked file using regexps.
1575 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1576 ;; ARG as in dired-get-marked-files.
1577 ;; Matches each marked file against REGEXP and constructs the new
1578 ;; filename from NEWNAME (like in function replace-match).
1579 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1580 ;; instead of only the non-directory part of the file.
1581 ;; Optional arg MARKER-CHAR as in dired-create-files.
1586 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1587 `!' to %s all remaining matches with no more questions."
1591 ;; Function to construct new filename using REGEXP and NEWNAME:
1596 ;; must bind help-form directly around call to
1597 ;; dired-query
1601 operation-prompt
1602 from
1603 to)
1604 to)
1606 operation from regexp)))))
1607 ;; not whole-name, replace non-directory part only
1618 operation-prompt
1621 to)
1624 rename-regexp-query)
1626 file-creator operation fn-list regexp-name-constructor marker-char)))
1629 ;; Prompt user about performing OPERATION.
1630 ;; Read and return list of: regexp newname arg whole-name.
1643 ;;;###autoload
1645 "Rename selected files whose names match REGEXP to NEWNAME.
1647 With non-zero prefix argument ARG, the command operates on the next ARG
1648 files. Otherwise, it operates on all the marked files, or the current
1649 file if none are marked.
1651 As each match is found, the user must type a character saying
1654 REGEXP defaults to the last regexp used.
1656 With a zero prefix arg, renaming by regexp affects the absolute file name.
1657 Normally, only the non-directory part of the file name is used and changed."
1663 ;;;###autoload
1665 "Copy selected files whose names match REGEXP to NEWNAME.
1666 See function `dired-do-rename-regexp' for more info."
1672 arg regexp newname whole-name dired-keep-marker-copy)))
1674 ;;;###autoload
1676 "Hardlink selected files whose names match REGEXP to NEWNAME.
1677 See function `dired-do-rename-regexp' for more info."
1683 ;;;###autoload
1685 "Symlink selected files whose names match REGEXP to NEWNAME.
1686 See function `dired-do-rename-regexp' for more info."
1694 ;; Perform FILE-CREATOR on the non-directory part of marked files
1695 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1696 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1699 file-creator
1700 operation
1708 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1709 `!' to %s all remaining matches with no more questions."
1716 to))))
1717 dired-keep-marker-rename)))
1722 basename-constructor operation arg))
1724 ;;;###autoload
1726 "Rename all marked (or next ARG) files to upper case."
1730 ;;;###autoload
1732 "Rename all marked (or next ARG) files to lower case."
1736 ;;;###end dired-re.el
1737 \f
1738 ;;; 13K
1739 ;;;###begin dired-ins.el
1741 ;;;###autoload
1743 switches no-error-if-not-dir-p)
1744 "Insert this subdirectory into the same dired buffer.
1746 else inserts it at its natural place (as `ls -lR' would have done).
1747 With a prefix arg, you may edit the ls switches used for this listing.
1748 You can add `R' to the switches to expand the whole tree starting at
1749 this subdirectory.
1750 This function takes some pains to conform to `ls -lR' output.
1752 Dired remembers switches specified with a prefix arg, so that reverting
1753 the buffer will not reset them. However, using `dired-undo' to re-insert
1754 or delete subdirectories can bypass this machinery. Hence, you sometimes
1755 may have to reset some subdirectory switches after a `dired-undo'.
1756 You can reset all subdirectory switches to the default using
1758 See Info node `(emacs-xtra)Subdir switches' for more details."
1765 ;; We don't need a marker for opoint as the subdir is always
1766 ;; inserted *after* opoint.
1771 ;; Push mark so that it's easy to find back. Do this after the
1772 ;; insert message so that the user sees the `Mark set' message.
1775 ;;;###autoload
1777 "Insert this subdirectory into the same dired buffer.
1778 If it is already present, overwrites previous entry,
1779 else inserts it at its natural place (as `ls -lR' would have done).
1780 With a prefix arg, you may edit the `ls' switches used for this listing.
1781 You can add `R' to the switches to expand the whole tree starting at
1782 this subdirectory.
1783 This function takes some pains to conform to `ls -lR' output."
1784 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1785 ;; Prospero where dired-ls does the right thing, but
1786 ;; file-directory-p has not been redefined.
1800 switches-have-R mark-alist case-fold-search buffer-read-only)
1803 ;; case-fold-search is nil now, so we can test for capital `R':
1805 ;; avoid duplicated subdirs
1808 ;; If subdir is already present, remove it and remember its marks
1831 ;; This is a separate function for dired-vms.
1833 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1834 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1847 ;; all switches that make a difference to dired-get-filename:
1851 ;; Add new DIR at NEW-MARKER. Sort alist.
1856 ;; Keep the alist sorted on buffer position.
1864 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1865 Interactively, you can kill DIRNAME as well by using a prefix argument.
1866 In interactive use, the command prompts for DIRNAME.
1868 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1869 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1880 m-alist))
1883 ;; Find pos for new subdir, according to tree order.
1884 ;;(goto-char (point-max))
1892 ;; Insert NEW-DIR after DIR
1894 alist nil)))
1896 ;; want a separating newline between subdirs
1903 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1904 ;; Move to that buffer position. Return a mark-alist.
1907 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1916 ;; Insert ls output after point.
1917 ;; Return the boundary of the inserted text (as list of BEG and END).
1922 dired-subdir-switches
1925 ;; If doing the top level directory of the buffer,
1926 ;; redo it as specified in dired-directory.
1932 ;; Point is at the correct subdir alist position for ELT,
1933 ;; BEG-END is the subdir-region (as list of begin and end).
1935 ;; update its position (should actually be unchanged)
1938 ;; The hook may depend on the subdir-alist containing the just
1939 ;; inserted subdir, so run it after dired-alist-add:
1947 ;; hook may add or delete lines, but the subdir boundary
1948 ;; marker floats
1952 ;; Lexicographic order on file name components, like `ls -lR':
1953 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1954 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1955 ;; or DIR1 and DIR2 are in the same parentdir and their last
1956 ;; components are string-lessp.
1957 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1958 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1959 ;; if dired-actual-switches contained `t'.
1965 components-2
1977 t)
1979 nil)
1982 ;; There should be a builtin split function - inverse to mapconcat.
1984 "Splitting on regexp PAT, turn string STR into a list of substrings.
1985 Optional third arg LIMIT (>= 1) is a limit to the length of the
1986 resulting list.
1987 Thus, if SEP is a regexp that only matches itself,
1989 (mapconcat 'identity (dired-split SEP STRING) SEP)
1991 is always equal to STRING."
2004 start end)
2005 ))
2012 \f
2013 ;;; moving by subdirectories
2015 ;;;###autoload
2017 "Go to previous subdirectory, regardless of level.
2018 When called interactively and not on a subdir line, go to this subdir's line."
2019 ;;(interactive "p")
2023 ;; if on subdir start already, don't stay there!
2033 ;;;###autoload
2035 "Go to end of header line of DIR in this dired buffer.
2036 Return value of point on success, otherwise return nil.
2042 dired-subdir-alist ; table
2043 nil ; predicate
2044 t ; require-match
2051 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2052 ;; at either \r or \n after this function succeeds.
2055 \f
2056 ;;;###autoload
2058 "Mark all files except `.' and `..' in current subdirectory.
2059 If the Dired buffer shows multiple directories, this command
2060 marks the files listed in the subdirectory that point is in."
2065 ;;;###autoload
2067 "Remove all lines of current subdirectory.
2068 Lower levels are unaffected."
2069 ;; With optional REMEMBER-MARKS, return a mark-alist.
2076 buffer-read-only)
2090 ;; Remove DIR from the alist
2094 ;;;###autoload
2096 "Go up ARG levels in the dired tree."
2102 ;;(setq dir (expand-file-name dir))
2106 ;;;###autoload
2108 "Go down in the dired tree."
2122 \f
2123 ;;; hiding
2139 ;;;###autoload
2141 "Hide or unhide the current subdirectory and move to next directory.
2142 Optional prefix arg is a repeat factor.
2152 buffer-read-only)
2153 ;; keep header line visible, hide rest
2162 ;;;###autoload
2164 "Hide all subdirectories, leaving only their header lines.
2165 If there is already something hidden, make everything visible again.
2170 buffer-read-only)
2174 ;; unhide - bombs on \r in filenames
2176 ;; hide
2183 ;; we're somewhere on current dir's line
2191 ;;;###end dired-ins.el
2193 \f
2194 ;; Functions for searching in tags style among marked files.
2196 ;;;###autoload
2198 "Search through all marked files for a match for REGEXP.
2199 Stops when a match is found.
2204 ;;;###autoload
2206 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2207 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2215 buffer-read-only))
2222 \f
2223 ;;;###autoload
2225 "Print the type of FILE, according to the `file' command.
2226 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2227 true then the type of the file linked to by FILE is printed instead."
2239 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2240 ;;; dired-aux.el ends here