| blob | b9ceb728dbc1a5cafaf427b73d1feb54e11c76dc |
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 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 Symbolic modes like `g+w' are allowed."
260 "Change mode of %s to: " nil
266 file
271 ;;;###autoload
273 "Change the group of the marked (or next ARG) files."
279 ;;;###autoload
281 "Change the owner of the marked (or next ARG) files."
287 ;;;###autoload
289 "Change the timestamp of the marked (or next ARG) files.
290 This calls touch."
294 ;; Process all the files in FILES in batches of a convenient size,
295 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
296 ;; Batches are chosen to need less than MAX chars for the file names,
297 ;; allowing 3 extra characters of separator per file name.
300 past
302 failures)
303 ;; Accumulate files as long as they fit in MAX chars,
304 ;; then process the ones accumulated so far.
309 ;; If we have at least 1 pending file
310 ;; and this file won't fit in the length limit, process now.
313 ;; The elements of PENDING are now in forward order.
314 ;; Do the operation and record failures.
316 failures)
317 ;; Transfer the elemens of PENDING onto PAST
318 ;; and clear it out. Now PAST contains the first N files
319 ;; specified (for some N), and FILES contains the rest.
321 pending nil
323 ;; Do (setq pending (cons thisfile pending))
324 ;; but reuse the cons that was in `files'.
332 failures)
333 ;; Now the original list FILES has been put back as it was.
336 ;;;###autoload
338 "Print the marked (or next ARG) files.
339 Uses the shell command coming from variables `lpr-command' and
340 `lpr-switches' as default."
344 "Print %s with: "
349 lpr-switches))
354 ;; Read arguments for a marked-files command that wants a string
355 ;; that is not a file name,
356 ;; perhaps popping up the list of marked files.
357 ;; ARG is the prefix arg and indicates whether the files came from
358 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
359 ;; If the current file was used, the list has but one element and ARG
360 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
363 ;; PROMPT for a string, with INITIAL input.
364 ;; Other args are used to give user feedback and pop-up:
365 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
367 nil op-symbol files
370 \f
371 ;;; Cleaning a directory: flagging some backups for deletion.
375 ;;;###autoload
377 "Flag numerical backups for deletion.
378 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
379 Positive prefix arg KEEP overrides `dired-kept-versions';
380 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
383 with a prefix argument."
390 late-retention early-retention)
391 ;; Look at each file.
392 ;; If the file has numeric backup versions,
393 ;; put on dired-file-version-alist an element of the form
394 ;; (FILENAME . VERSION-NUMBER-LIST)
396 ;; Sort each VERSION-NUMBER-LIST,
397 ;; and remove the versions not to be deleted.
405 sorted-v-list)))
409 ;; Look at each file. If it is a numeric backup file,
410 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
414 ;;; Subroutines of dired-clean-directory.
417 ;; Perform FUN with point at the end of each non-directory line.
418 ;; FUN takes one argument, the absolute filename.
433 ;; Only do work if this file is not already in the alist.
435 nil
436 ;; If it looks like file FN has versions, return a list of the versions.
437 ;;That is a list of strings which are file names.
438 ;;The caller may want to flag some of these files for deletion.
443 base-versions
449 dired-file-version-alist)))))))
453 base-version-list)
463 \f
464 ;;; Shell commands
467 ;; "Read a dired shell command prompting with PROMPT (using read-string).
468 ;;ARG is the prefix arg and may be used to indicate in the prompt which
469 ;; files are affected.
470 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
472 nil 'shell files
477 ;; The in-background argument is only needed in Emacs 18 where
478 ;; shell-command doesn't understand an appended ampersand `&'.
479 ;;;###autoload
481 "Run a shell command COMMAND on the marked files.
482 If no files are marked or a specific numeric prefix arg is given,
484 The prompt mentions the file(s) or the marker, as appropriate.
486 If there is a `*' in COMMAND, surrounded by whitespace, this runs
487 COMMAND just once with the entire file list substituted there.
489 If there is no `*', but there is a `?' in COMMAND, surrounded by
490 whitespace, this runs COMMAND on each file individually with the
491 file name substituted for `?'.
493 Otherwise, this runs COMMAND on each file individually with the
494 file name added at the end of COMMAND (separated by a space).
496 `*' and `?' when not surrounded by whitespace have no special
497 significance for `dired-do-shell-command', and are passed through
498 normally to the shell, but you must confirm first. To pass `*' by
501 If COMMAND produces output, it goes to a separate buffer.
503 This feature does not try to redisplay Dired buffers afterward, as
504 there's no telling what files COMMAND may have changed.
507 When COMMAND runs, its working directory is the top-level directory of
508 the Dired buffer, so output files usually are created there instead of
509 in a subdir.
511 In a noninteractive call (from Lisp code), you must specify
512 the list of file names explicitly with the FILE-LIST argument, which
513 can be produced by `dired-get-marked-files', for example."
514 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
515 ;;actual work and can be redefined for customization.
519 ;; Want to give feedback whether this file or marked files are used:
522 current-prefix-arg
523 files)
524 current-prefix-arg
525 files)))
530 ;; Get confirmation for wildcards that may have been meant
531 ;; to control substitution of a file name or the file name list.
545 nil
546 file-list)
547 ;; execute the shell command
551 ;; Might use {,} for bash or csh:
560 ;; "Make up a shell command line from COMMAND and FILE-LIST.
561 ;; If ON-EACH is t, COMMAND should be applied to each file, else
562 ;; simply concat all files and apply COMMAND to this.
563 ;; FILE-LIST's elements will be quoted for the shell."
564 ;; Might be redefined for smarter things and could then use RAW-ARG
565 ;; (coming from interactive P and currently ignored) to decide what to do.
566 ;; Smart would be a way to access basename or extension of file names.
575 retval))
580 file-list dired-mark-separator)))
585 ;; This is an extra function so that it can be redefined by ange-ftp.
586 ;;;###autoload
593 ;; Return nil for sake of nconc in dired-bunch-files.
594 nil)
595 \f
598 ; "Display MSG while running PROGRAM, and check for output.
599 ;Remaining arguments are strings passed as command arguments to PROGRAM.
600 ; On error, insert output
601 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
602 ; Caller can cons up a list of failed args.
603 ;Else returns nil for success."
607 ;; Get a clean buffer for error output:
620 nil))))
621 \f
622 ;; Commands that delete or redisplay part of the dired buffer.
643 ;;;###autoload
645 "Kill all marked lines (not the files).
646 With a prefix argument, kill that many lines starting with the current line.
647 \(A negative argument kills backward.)
648 If you use this command with a prefix argument to kill the line
649 for a file that is a directory, which you have inserted in the
650 Dired buffer as a subdirectory, then it deletes that subdirectory
651 from the buffer as well.
652 To kill an entire subdirectory \(without killing its line in the
653 parent directory), go to its directory header line and use this
654 command with a prefix argument (the value does not matter)."
655 ;; Returns count of killed lines. FMT="" suppresses message.
673 count))))
675 ;;;###end dired-cmd.el
676 \f
677 ;;; 30K
678 ;;;###begin dired-cp.el
681 ;; Compress or uncompress the current file.
682 ;; Return nil for success, offending filename else.
688 ;; Remove any preexisting entry for the name NEW-FILE.
693 ;; Now replace the current line with an entry for NEW-FILE.
696 from-file)))
702 ;; For .z, try gunzip. It might be an old gzip file,
703 ;; or it might be from compact? pack? (which?) but gunzip handles both.
708 ;; This item controls naming for compression.
710 "Control changes in file name suffixes for compression and uncompression.
711 Each element specifies one transformation rule, and has the form:
712 (REGEXP NEW-SUFFIX PROGRAM)
713 The rule applies when the old file name matches REGEXP.
714 The new file name is computed by deleting the part that matches REGEXP
715 (as well as anything after that), then adding NEW-SUFFIX in its place.
716 If PROGRAM is non-nil, the rule is an uncompression rule,
717 and uncompression is done by running PROGRAM.
720 ;;;###autoload
722 ;; Compress or uncompress FILE.
723 ;; Return the name of the compressed or uncompressed file.
724 ;; Return nil if no change in files.
726 suffix newname
728 ;; See if any suffix rule matches this file name.
734 ;; If so, compute desired new name.
741 nil)
743 ;; We found an uncompression rule.
746 newname))
748 ;;; We don't recognize the file as compressed, so compress it.
749 ;;; Try gzip; if we don't have that, use compress.
755 out-name)))
760 ;; Rename the compressed file to NEWNAME
761 ;; if it hasn't got that name already.
765 newname)
766 out-name)))
770 ;; Don't use NEWNAME with `compress'.
772 \f
774 ;; Request confirmation from the user that the operation described
775 ;; by OP-SYMBOL is to be performed on the marked files.
776 ;; Confirmation consists in a y-or-n question with a file list
777 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
778 ;; The files used are determined by ARG (as in dired-get-marked-files).
781 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
782 ;; is marked pops up a window. That will help the user see
783 ;; it isn't the current line file.
792 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
793 ; and display failures.
795 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
796 ; the short form of the filename) for a failure and probably logs a
797 ; detailed error explanation using function `dired-log'.
799 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
800 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
801 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
802 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
804 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
816 ;; end this bunch of errors:
820 failures)))))
827 ;; None of these keys quit - use C-g for that.
828 ))
830 ;;;###autoload
832 ;; Query user and return nil or t.
833 ;; Store answer in symbol VAR (which must initially be bound to nil).
834 ;; Format PROMPT with ARGS.
835 ;; Binding variable help-form will help the user who types the help key.
849 result elt)
850 ;; Actually it looks nicer without cursor-in-echo-area - you can
851 ;; look at the dired buffer instead of at the prompt to decide.
860 ;; Display the question with the answer.
864 \f
865 ;;;###autoload
867 "Compress or uncompress marked (or next ARG) files."
871 ;; Commands for Emacs Lisp files - load and byte compile
874 ;; Return nil for success, offending file name else.
876 elc-file buffer-read-only failure)
891 nil)))
893 ;;;###autoload
895 "Byte compile marked (or next ARG) Emacs Lisp files."
900 ;; Return nil for success, offending file name else.
906 nil
910 ;;;###autoload
912 "Load the marked (or next ARG) Emacs Lisp files."
916 ;;;###autoload
918 "Redisplay all marked (or next ARG) files.
919 If on a subdir line, redisplay that subdirectory. In that case,
920 a prefix arg lets you edit the `ls' switches used for the new listing.
922 Dired remembers switches specified with a prefix arg, so that reverting
923 the buffer will not reset them. However, using `dired-undo' to re-insert
924 or delete subdirectories can bypass this machinery. Hence, you sometimes
925 may have to reset some subdirectory switches after a `dired-undo'.
926 You can reset all subdirectory switches to the default using
928 See Info node `(emacs)Subdir switches' for more details."
929 ;; Moves point if the next ARG files are redisplayed.
935 dir
939 dired-subdir-switches
940 dired-actual-switches)))))
942 ;; message much faster than making dired-map-over-marks show progress
948 arg)
953 "Set `dired-switches-alist' to nil and revert dired buffer."
957 \f
959 ;; Delete the current line, and insert an entry for FILE.
960 ;; If FILE is nil, then just delete the current line.
961 ;; Keeps any marks that may be present in column one (doing this
962 ;; here is faster than with dired-add-entry's optional arg).
963 ;; Does not update other dired buffers. Use dired-relist-entry for that.
971 ;; Replace space by old marker without moving point.
972 ;; Faster than goto+insdel inside a save-excursion?
976 ;;;###autoload
983 ;; Add a new entry for FILENAME, optionally marking it
984 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
985 ;; Note that this adds the entry `out of order' if files sorted by
986 ;; time, etc.
987 ;; At least this version inserts in the right subdirectory (if present).
988 ;; And it skips "." or ".." (see `dired-trivial-filenames').
989 ;; Hidden subdirs are exposed if a file is added there.
991 ;; Entry is always for files, even if they happen to also be directories
996 reason)
1001 reason
1008 ;; We are already where we should be, except when
1009 ;; point is before the subdir line or its total line.
1013 ;; else try to find correct place to insert
1018 ;; found - skip subdir and `total' line
1019 ;; and uninteresting files like . and ..
1020 ;; This better not moves into the next subdir!
1022 ;; not found
1027 ;; Don't expand `.'. Show just the file name within directory.
1033 ;; Put in desired marker char.
1038 ;; Compensate for a bug in ange-ftp.
1039 ;; It inserts the file's absolute name, rather than
1040 ;; the relative one. That may be hard to fix since it
1041 ;; is probably controlled by something in ftp.
1064 ;; return nil if all went well
1065 nil))
1071 ;; Return pos of first file line of DIR, skipping header and total
1072 ;; or wildcard lines.
1073 ;; Important: never moves into the next subdir.
1074 ;; DIR is assumed to be unhidden.
1075 ;; Will probably be redefined for VMS etc.
1084 ;;;###autoload
1097 ;;;###autoload
1099 "Create or update the line for FILE in all Dired buffers it would belong in."
1105 ;; Relist the line for FILE, or just add it if it did not exist.
1106 ;; FILE must be an absolute file name.
1108 ;; If cursor is already on FILE's line delete-region will cause
1109 ;; save-excursion to fail because of floating makers,
1110 ;; moving point to beginning of line. Sigh.
1119 \f
1120 ;;; Copy, move/rename, making hard and symbolic links
1123 "*Non-nil if Dired should ask about making backups before overwriting files.
1124 Special value `always' suppresses confirmation."
1133 ;; Save old version of file TO that is to be overwritten.
1134 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1135 ;; from dired-create-files.
1138 dired-overwrite-confirmed
1142 "Make backup for existing file `%s'? "
1143 to)))
1148 ;;;###autoload
1152 dired-recursive-copies))
1155 preserve-time top recursive)
1157 dirfailed)
1162 ;; This is a directory.
1169 dired-create-files-failures)
1172 nil))))
1183 dired-create-files-failures)
1189 ;; Catch errors copying within a directory,
1190 ;; and report them through the dired log mechanism
1191 ;; just as our caller will do for the top level files.
1194 thisfrom thisto
1195 ok-flag preserve-time nil recursive)
1198 dired-create-files-failures)
1202 ;; Not a directory.
1206 ;; It is a symlink
1211 dired-create-files-failures)
1214 ;;;###autoload
1218 ;; Silently rename the visited file of any buffer visiting this file.
1223 ;; See if it's an inserted subdir, and rename that, too.
1231 ;; Update visited file name of all affected buffers
1242 to-dir
1243 buffer-file-name)))
1249 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1250 ;; one of its subdirectories is expanded in this buffer.
1258 ;; ELT's subdir is affected by the rename
1261 ;; if top level directory was renamed, lots of things have to be
1262 ;; updated:
1267 ;; with and without wildcards
1269 to))
1272 ;; try to rename buffer, but just leave old name if new
1273 ;; name would already exist (don't try appending "<%d>")
1276 ;; ... we dired TO now:
1280 ;; Update the headerline and dired-subdir-alist element, as well as
1281 ;; dired-switches-alist element, of directory described by
1282 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1283 ;; describes either DIR itself or a subdir of DIR.
1287 buffer-read-only)
1289 ;; Update subdir headerline in buffer
1292 dir)
1297 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1303 \f
1304 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1308 ;; Create a new file for each from a list of existing files. The user
1309 ;; is queried, dired buffers are updated, and at the end a success or
1310 ;; failure message is displayed
1312 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1314 ;; It is called for each file and must create newfile, the entry of
1315 ;; which will be added. The user will be queried if the file already
1316 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1317 ;; rename), it is FILE-CREATOR's responsibility to update dired
1318 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1319 ;; could not create newfile. The error is caught and logged.
1321 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1322 ;; operation performed. It is used for error logging.
1324 ;; FN-LIST is the list of files to copy (full absolute file names).
1326 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1327 ;; skip. If it skips files for other reasons than a direct user
1328 ;; query, it is supposed to tell why (using dired-log).
1330 ;; Optional MARKER-CHAR is a character with which to mark every
1331 ;; newfile's entry, or t to use the current marker character if the
1332 ;; oldfile was marked.
1353 Type SPC or `y' to overwrite file `%s',
1354 DEL or `n' to skip to next,
1355 ESC or `q' to not overwrite any of the remaining files,
1359 ;; must determine if FROM is marked before file-creator
1360 ;; gets a chance to delete it (in case of a move).
1369 ;; If we get here, file-creator hasn't been aborted
1370 ;; and the old entry (if any) has to be deleted
1371 ;; before adding the new entry.
1379 failures)
1381 operation from to err))))))))
1382 fn-list))
1390 total)
1391 failures))
1397 failures))
1403 skipped))
1408 \f
1410 &optional marker-char op1
1411 how-to)
1412 "Create a new file for each marked file.
1413 Prompts user for target, which is a directory in which to create
1414 the new files. Target may be a plain file if only one marked
1415 file exists. The way the default for the target directory is
1416 computed depends on the value of `dired-dwim-target-directory'.
1417 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1418 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1419 FILE-CREATOR and OPERATION as in `dired-create-files'.
1420 ARG as in `dired-get-marked-files'.
1421 Optional arg MARKER-CHAR as in `dired-create-files'.
1422 Optional arg OP1 is an alternate form for OPERATION if there is
1423 only one file.
1424 Optional arg HOW-TO is used to set the value of the into-dir variable
1425 which determines how to treat target.
1426 If into-dir is set to nil then target is not regarded as a directory,
1427 there must be exactly one marked file, else error.
1428 Else if into-dir is set to a list, then target is a generalized
1429 directory (e.g. some sort of archive). The first element of into-dir
1430 must be a function with at least four arguments:
1431 operation as OPERATION above.
1432 rfn-list a list of the relative names for the marked files.
1433 fn-list a list of the absolute names for the marked files.
1434 target.
1435 The rest of into-dir are optional arguments.
1436 Else into-dir is not a list. Target is a directory.
1437 The marked file(s) are created inside the target directory.
1439 If HOW-TO is not given (or nil), then into-dir is set to true if
1440 target is a directory and otherwise to nil.
1441 Else if HOW-TO is t, then into-dir is set to nil.
1442 Else HOW-TO is assumed to be a function of one argument, target,
1443 that looks at target and returns a value for the into-dir
1444 variable. The function `dired-into-dir-with-symlinks' is provided
1445 for the case (common when creating symlinks) that symbolic
1446 links to directories are not to be considered as directories
1447 (as `file-directory-p' would if HOW-TO had been nil)."
1456 target-dir)))
1460 target-dir op-symbol arg rfn-list default)))
1462 ;; Allow DOS/Windows users to change the letter
1463 ;; case of a directory. If we don't test these
1464 ;; conditions up front, file-directory-p below
1465 ;; will return t because the filesystem is
1466 ;; case-insensitive, and Emacs will try to move
1467 ;; foo -> foo/foo, which fails.
1470 dired-one-file
1478 nil
1486 ;; rename-file bombs when moving directories unless we do this:
1489 file-creator operation fn-list
1491 ;; This function uses fluid variable target when called
1492 ;; inside dired-create-files:
1497 marker-char))))
1499 ;; Read arguments for a marked-files command that wants a file name,
1500 ;; perhaps popping up the list of marked files.
1501 ;; ARG is the prefix arg and indicates whether the files came from
1502 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1503 ;; If the current file was used, the list has but one element and ARG
1504 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1505 ;; DEFAULT is the default value to return if the user just hits RET;
1506 ;; if it is omitted or nil, then the name of the directory is used.
1511 nil op-symbol files
1516 ;; Try to guess which target directory the user may want.
1517 ;; If there is a dired buffer displayed in the next window, use
1518 ;; its current subdir, else use current subdir of this dired buffer.
1521 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1529 this-dir)))
1530 \f
1531 ;;;###autoload
1533 "Create a directory called DIRECTORY."
1544 ;; This may not always be what you want, especially if target is your
1545 ;; home directory and it happens to be a symbolic link, as is often the
1546 ;; case with NFS and automounters. Or if you want to make symlinks
1547 ;; into directories that themselves are only symlinks, also quite
1548 ;; common.
1550 ;; So we don't use this function as value for HOW-TO in
1551 ;; dired-do-symlink, which has the minor disadvantage of
1552 ;; making links *into* a symlinked-dir, when you really wanted to
1553 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1554 ;; just have to remove that symlink by hand before making your marked
1555 ;; symlinks.
1558 "nil or a function used by `dired-do-copy' to determine target.
1561 ;;;###autoload
1563 "Copy all marked (or next ARG) files, or copy the current file.
1564 This normally preserves the last-modified date when copying.
1565 When operating on just the current file, you specify the new name.
1566 When operating on multiple or marked files, you specify a directory,
1567 and new copies of these files are made in that directory
1568 with the same names that the files currently have. The default
1569 suggested for the target directory depends on the value of
1570 `dired-dwim-target', which see.
1572 This command copies symbolic links by creating new ones,
1573 like `cp -d'."
1577 "Copy"
1578 arg dired-keep-marker-copy
1579 nil dired-copy-how-to-fn)))
1581 ;;;###autoload
1583 "Make symbolic links to current file or all marked (or next ARG) files.
1584 When operating on just the current file, you specify the new name.
1585 When operating on multiple or marked files, you specify a directory
1586 and new symbolic links are made in that directory
1587 with the same names that the files currently have. The default
1588 suggested for the target directory depends on the value of
1589 `dired-dwim-target', which see.
1596 ;;;###autoload
1598 "Add names (hard links) current file or all marked (or next ARG) files.
1599 When operating on just the current file, you specify the new name.
1600 When operating on multiple or marked files, you specify a directory
1601 and new hard links are made in that directory
1602 with the same names that the files currently have. The default
1603 suggested for the target directory depends on the value of
1604 `dired-dwim-target', which see."
1611 ;; error is caught in -create-files
1613 ;; Update the link count
1616 ;;;###autoload
1618 "Rename current file or all marked (or next ARG) files.
1619 When renaming just the current file, you specify the new name.
1620 When renaming multiple or marked files, you specify a directory.
1621 This command also renames any buffers that are visiting the files.
1622 The default suggested for the target directory depends on the value
1623 of `dired-dwim-target', which see."
1627 ;;;###end dired-cp.el
1628 \f
1629 ;;; 5K
1630 ;;;###begin dired-re.el
1633 ;; Create a new file for each marked file using regexps.
1634 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1635 ;; ARG as in dired-get-marked-files.
1636 ;; Matches each marked file against REGEXP and constructs the new
1637 ;; filename from NEWNAME (like in function replace-match).
1638 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1639 ;; instead of only the non-directory part of the file.
1640 ;; Optional arg MARKER-CHAR as in dired-create-files.
1645 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1646 `!' to %s all remaining matches with no more questions."
1650 ;; Function to construct new filename using REGEXP and NEWNAME:
1655 ;; must bind help-form directly around call to
1656 ;; dired-query
1660 operation-prompt
1661 from
1662 to)
1663 to)
1665 operation from regexp)))))
1666 ;; not whole-name, replace non-directory part only
1677 operation-prompt
1680 to)
1683 rename-regexp-query)
1685 file-creator operation fn-list regexp-name-constructor marker-char)))
1688 ;; Prompt user about performing OPERATION.
1689 ;; Read and return list of: regexp newname arg whole-name.
1702 ;;;###autoload
1704 "Rename selected files whose names match REGEXP to NEWNAME.
1706 With non-zero prefix argument ARG, the command operates on the next ARG
1707 files. Otherwise, it operates on all the marked files, or the current
1708 file if none are marked.
1710 As each match is found, the user must type a character saying
1713 REGEXP defaults to the last regexp used.
1715 With a zero prefix arg, renaming by regexp affects the absolute file name.
1716 Normally, only the non-directory part of the file name is used and changed."
1722 ;;;###autoload
1724 "Copy selected files whose names match REGEXP to NEWNAME.
1725 See function `dired-do-rename-regexp' for more info."
1731 arg regexp newname whole-name dired-keep-marker-copy)))
1733 ;;;###autoload
1735 "Hardlink selected files whose names match REGEXP to NEWNAME.
1736 See function `dired-do-rename-regexp' for more info."
1742 ;;;###autoload
1744 "Symlink selected files whose names match REGEXP to NEWNAME.
1745 See function `dired-do-rename-regexp' for more info."
1753 ;; Perform FILE-CREATOR on the non-directory part of marked files
1754 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1755 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1758 file-creator
1759 operation
1767 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1768 `!' to %s all remaining matches with no more questions."
1775 to))))
1776 dired-keep-marker-rename)))
1781 basename-constructor operation arg))
1783 ;;;###autoload
1785 "Rename all marked (or next ARG) files to upper case."
1789 ;;;###autoload
1791 "Rename all marked (or next ARG) files to lower case."
1795 ;;;###end dired-re.el
1796 \f
1797 ;;; 13K
1798 ;;;###begin dired-ins.el
1800 ;;;###autoload
1802 switches no-error-if-not-dir-p)
1803 "Insert this subdirectory into the same dired buffer.
1805 else inserts it at its natural place (as `ls -lR' would have done).
1806 With a prefix arg, you may edit the ls switches used for this listing.
1807 You can add `R' to the switches to expand the whole tree starting at
1808 this subdirectory.
1809 This function takes some pains to conform to `ls -lR' output.
1811 Dired remembers switches specified with a prefix arg, so that reverting
1812 the buffer will not reset them. However, using `dired-undo' to re-insert
1813 or delete subdirectories can bypass this machinery. Hence, you sometimes
1814 may have to reset some subdirectory switches after a `dired-undo'.
1815 You can reset all subdirectory switches to the default using
1817 See Info node `(emacs)Subdir switches' for more details."
1824 ;; We don't need a marker for opoint as the subdir is always
1825 ;; inserted *after* opoint.
1830 ;; Push mark so that it's easy to find back. Do this after the
1831 ;; insert message so that the user sees the `Mark set' message.
1834 ;;;###autoload
1836 "Insert this subdirectory into the same dired buffer.
1837 If it is already present, overwrites previous entry,
1838 else inserts it at its natural place (as `ls -lR' would have done).
1839 With a prefix arg, you may edit the `ls' switches used for this listing.
1840 You can add `R' to the switches to expand the whole tree starting at
1841 this subdirectory.
1842 This function takes some pains to conform to `ls -lR' output."
1843 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1844 ;; Prospero where dired-ls does the right thing, but
1845 ;; file-directory-p has not been redefined.
1859 switches-have-R mark-alist case-fold-search buffer-read-only)
1862 ;; case-fold-search is nil now, so we can test for capital `R':
1864 ;; avoid duplicated subdirs
1867 ;; If subdir is already present, remove it and remember its marks
1890 ;; This is a separate function for dired-vms.
1892 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1893 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1906 ;; all switches that make a difference to dired-get-filename:
1910 ;; Add new DIR at NEW-MARKER. Sort alist.
1915 ;; Keep the alist sorted on buffer position.
1923 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1924 Interactively, you can kill DIRNAME as well by using a prefix argument.
1925 In interactive use, the command prompts for DIRNAME.
1927 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1928 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1939 m-alist))
1942 ;; Find pos for new subdir, according to tree order.
1943 ;;(goto-char (point-max))
1951 ;; Insert NEW-DIR after DIR
1953 alist nil)))
1955 ;; want a separating newline between subdirs
1962 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1963 ;; Move to that buffer position. Return a mark-alist.
1966 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1975 ;; Insert ls output after point.
1976 ;; Return the boundary of the inserted text (as list of BEG and END).
1981 dired-subdir-switches
1984 ;; If doing the top level directory of the buffer,
1985 ;; redo it as specified in dired-directory.
1991 ;; Point is at the correct subdir alist position for ELT,
1992 ;; BEG-END is the subdir-region (as list of begin and end).
1994 ;; update its position (should actually be unchanged)
1997 ;; The hook may depend on the subdir-alist containing the just
1998 ;; inserted subdir, so run it after dired-alist-add:
2006 ;; hook may add or delete lines, but the subdir boundary
2007 ;; marker floats
2011 ;; Lexicographic order on file name components, like `ls -lR':
2012 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2013 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2014 ;; or DIR1 and DIR2 are in the same parentdir and their last
2015 ;; components are string-lessp.
2016 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2017 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2018 ;; if dired-actual-switches contained `t'.
2024 components-2
2036 t)
2038 nil)
2041 ;; There should be a builtin split function - inverse to mapconcat.
2043 "Splitting on regexp PAT, turn string STR into a list of substrings.
2044 Optional third arg LIMIT (>= 1) is a limit to the length of the
2045 resulting list.
2046 Thus, if SEP is a regexp that only matches itself,
2048 (mapconcat 'identity (dired-split SEP STRING) SEP)
2050 is always equal to STRING."
2063 start end)
2064 ))
2071 \f
2072 ;;; moving by subdirectories
2074 ;;;###autoload
2076 "Go to previous subdirectory, regardless of level.
2077 When called interactively and not on a subdir line, go to this subdir's line."
2078 ;;(interactive "p")
2082 ;; if on subdir start already, don't stay there!
2092 ;;;###autoload
2094 "Go to end of header line of DIR in this dired buffer.
2095 Return value of point on success, otherwise return nil.
2101 dired-subdir-alist ; table
2102 nil ; predicate
2103 t ; require-match
2110 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2111 ;; at either \r or \n after this function succeeds.
2114 \f
2115 ;;;###autoload
2117 "Mark all files except `.' and `..' in current subdirectory.
2118 If the Dired buffer shows multiple directories, this command
2119 marks the files listed in the subdirectory that point is in."
2124 ;;;###autoload
2126 "Remove all lines of current subdirectory.
2127 Lower levels are unaffected."
2128 ;; With optional REMEMBER-MARKS, return a mark-alist.
2135 buffer-read-only)
2149 ;; Remove DIR from the alist
2153 ;;;###autoload
2155 "Go up ARG levels in the dired tree."
2161 ;;(setq dir (expand-file-name dir))
2165 ;;;###autoload
2167 "Go down in the dired tree."
2181 \f
2182 ;;; hiding
2198 ;;;###autoload
2200 "Hide or unhide the current subdirectory and move to next directory.
2201 Optional prefix arg is a repeat factor.
2211 buffer-read-only)
2212 ;; keep header line visible, hide rest
2221 ;;;###autoload
2223 "Hide all subdirectories, leaving only their header lines.
2224 If there is already something hidden, make everything visible again.
2229 buffer-read-only)
2233 ;; unhide - bombs on \r in filenames
2235 ;; hide
2242 ;; we're somewhere on current dir's line
2250 ;;;###end dired-ins.el
2252 \f
2253 ;; Functions for searching in tags style among marked files.
2255 ;;;###autoload
2257 "Search through all marked files for a match for REGEXP.
2258 Stops when a match is found.
2263 ;;;###autoload
2265 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2266 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2277 buffer-read-only))
2284 \f
2285 ;;;###autoload
2287 "Print the type of FILE, according to the `file' command.
2288 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2289 true then the type of the file linked to by FILE is printed instead."
2301 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2302 ;;; dired-aux.el ends here