| blob | e179a484ac360ae516270b3060a94e67d4cfeb5c |
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009 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 of the License, or
15 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; The parts of dired mode not normally used. This is a space-saving hack
28 ;; to avoid having to load a large mode when all that's wanted are a few
29 ;; functions.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
37 ;; We need macros in dired.el to compile properly,
38 ;; and we call subroutines in it too.
42 "Variable where `dired-create-files' records failing file names.
43 Functions that operate recursively can store additional names
46 ;;; 15K
47 ;;;###begin dired-cmd.el
48 ;; Diffing and compressing
53 ;;;###autoload
55 "Compare file at point with file FILE using `diff'.
56 FILE defaults to the file at the mark. (That's the mark set by
58 The prompted-for file is the first file given to `diff'.
59 With prefix arg, prompt for second argument SWITCHES,
60 which is options for `diff'."
73 current
80 default t)
84 diff-switches
88 ;;;###autoload
90 "Diff this file with its backup file or vice versa.
91 Uses the latest backup, if there are several numerical backups.
92 If this file is a backup, diff it with its original.
93 The backup file is the first file given to `diff'.
94 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
99 diff-switches
101 nil))
104 ;;;###autoload
106 "Mark files with different file attributes in two dired buffers.
107 Compare file attributes of files in the current directory
108 with file attributes in directory DIR2 using PREDICATE on pairs of files
109 with the same name. Mark files for which PREDICATE returns non-nil.
110 Mark files with different names if PREDICATE is nil (or interactively
111 with empty input at the predicate prompt).
113 PREDICATE is a Lisp expression that can refer to the following variables:
115 size1, size2 - file size in bytes
116 mtime1, mtime2 - last modification time in seconds, as a float
117 fa1, fa2 - list of file attributes
118 returned by function `file-attributes'
120 where 1 refers to attribute of file in the current dired buffer
121 and 2 to attribute of file in second dired buffer.
123 Examples of PREDICATE:
125 (> mtime1 mtime2) - mark newer files
126 (not (= size1 size2)) - mark files with different sizes
127 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
128 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
129 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
139 file-list1 file-list2)
145 'cadr
147 file-alist1 file-alist2
148 predicate))
150 'cadr
152 file-alist2 file-alist1
153 predicate)))
155 dir1 nil
160 dir2 nil
169 "Combine LIST1 and LIST2 using a set-difference operation.
170 The result list contains all file items that appear in LIST1 but not LIST2.
171 This is a non-destructive function; it makes a copy of the data if necessary
172 to avoid corrupting the original LIST1 and LIST2.
173 PREDICATE (see `dired-compare-directories') is an additional match
174 condition. Two file items are considered to match if they are equal
175 *and* PREDICATE evaluates to t."
177 list1
193 list)
198 "Return a list of all file names and attributes from DIR.
199 List has a form of (file-name full-file-name (attribute-list))."
204 full-file-name
207 \f
210 "Create initial input value for `touch' command."
221 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
222 ;; refresh their file lines.
223 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
224 ;; PROGRAM is the program used to change the attribute.
225 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
226 ;; ARG describes which files to use, as in dired-get-marked-files.
232 op-symbol arg files))
234 failures)
245 files))
250 nil))))
252 ;;;###autoload
254 "Change the mode of the marked (or next ARG) files.
255 Symbolic modes like `g+w' are allowed."
270 "Change mode of %s to: " nil
276 file
281 ;;;###autoload
283 "Change the group of the marked (or next ARG) files."
289 ;;;###autoload
291 "Change the owner of the marked (or next ARG) files."
297 ;;;###autoload
299 "Change the timestamp of the marked (or next ARG) files.
300 This calls touch."
304 ;; Process all the files in FILES in batches of a convenient size,
305 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
306 ;; Batches are chosen to need less than MAX chars for the file names,
307 ;; allowing 3 extra characters of separator per file name.
310 past
312 failures)
313 ;; Accumulate files as long as they fit in MAX chars,
314 ;; then process the ones accumulated so far.
319 ;; If we have at least 1 pending file
320 ;; and this file won't fit in the length limit, process now.
323 ;; The elements of PENDING are now in forward order.
324 ;; Do the operation and record failures.
326 failures)
327 ;; Transfer the elemens of PENDING onto PAST
328 ;; and clear it out. Now PAST contains the first N files
329 ;; specified (for some N), and FILES contains the rest.
331 pending nil
333 ;; Do (setq pending (cons thisfile pending))
334 ;; but reuse the cons that was in `files'.
342 failures)
343 ;; Now the original list FILES has been put back as it was.
346 ;;;###autoload
348 "Print the marked (or next ARG) files.
349 Uses the shell command coming from variables `lpr-command' and
350 `lpr-switches' as default."
354 "Print %s with: "
359 lpr-switches))
364 ;; Read arguments for a marked-files command that wants a string
365 ;; that is not a file name,
366 ;; perhaps popping up the list of marked files.
367 ;; ARG is the prefix arg and indicates whether the files came from
368 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
369 ;; If the current file was used, the list has but one element and ARG
370 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
373 ;; PROMPT for a string, with INITIAL input and DEFAULT value.
374 ;; Other args are used to give user feedback and pop-up:
375 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
377 nil op-symbol files
380 \f
381 ;;; Cleaning a directory: flagging some backups for deletion.
385 ;;;###autoload
387 "Flag numerical backups for deletion.
388 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
389 Positive prefix arg KEEP overrides `dired-kept-versions';
390 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
393 with a prefix argument."
400 late-retention early-retention)
401 ;; Look at each file.
402 ;; If the file has numeric backup versions,
403 ;; put on dired-file-version-alist an element of the form
404 ;; (FILENAME . VERSION-NUMBER-LIST)
406 ;; Sort each VERSION-NUMBER-LIST,
407 ;; and remove the versions not to be deleted.
415 sorted-v-list)))
419 ;; Look at each file. If it is a numeric backup file,
420 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
424 ;;; Subroutines of dired-clean-directory.
427 ;; Perform FUN with point at the end of each non-directory line.
428 ;; FUN takes one argument, the absolute filename.
443 ;; Only do work if this file is not already in the alist.
445 nil
446 ;; If it looks like file FN has versions, return a list of the versions.
447 ;;That is a list of strings which are file names.
448 ;;The caller may want to flag some of these files for deletion.
453 base-versions
459 dired-file-version-alist)))))))
463 base-version-list)
473 \f
474 ;;; Shell commands
479 "Return a list of all commands associated with current dired files.
480 This function is used to add all related commands retrieved by `mailcap'
481 to the end of the list of defaults just after the default value."
489 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
491 "Read a dired shell command prompting with PROMPT (using `read-shell-command').
492 ARG is the prefix arg and may be used to indicate in the prompt which
493 FILES are affected."
499 nil 'shell files
500 #'read-shell-command
502 nil nil)))
504 ;;;###autoload
506 "Run a shell command COMMAND on the marked files asynchronously.
508 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
509 adds `* &' surrounded by whitespace and executes the command asynchronously.
510 The output appears in the buffer `*Async Shell Command*'."
514 ;; Want to give feedback whether this file or marked files are used:
516 current-prefix-arg
517 files)))
524 ;; The in-background argument is only needed in Emacs 18 where
525 ;; shell-command doesn't understand an appended ampersand `&'.
526 ;;;###autoload
528 "Run a shell command COMMAND on the marked files.
529 If no files are marked or a specific numeric prefix arg is given,
531 The prompt mentions the file(s) or the marker, as appropriate.
533 If there is a `*' in COMMAND, surrounded by whitespace, this runs
534 COMMAND just once with the entire file list substituted there.
536 If there is no `*', but there is a `?' in COMMAND, surrounded by
537 whitespace, this runs COMMAND on each file individually with the
538 file name substituted for `?'.
540 Otherwise, this runs COMMAND on each file individually with the
541 file name added at the end of COMMAND (separated by a space).
543 `*' and `?' when not surrounded by whitespace have no special
544 significance for `dired-do-shell-command', and are passed through
545 normally to the shell, but you must confirm first. To pass `*' by
548 If COMMAND produces output, it goes to a separate buffer.
550 This feature does not try to redisplay Dired buffers afterward, as
551 there's no telling what files COMMAND may have changed.
554 When COMMAND runs, its working directory is the top-level directory
555 of the Dired buffer, so output files usually are created there
556 instead of in a subdir.
558 In a noninteractive call (from Lisp code), you must specify
559 the list of file names explicitly with the FILE-LIST argument, which
560 can be produced by `dired-get-marked-files', for example."
561 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
562 ;;actual work and can be redefined for customization.
566 ;; Want to give feedback whether this file or marked files are used:
569 current-prefix-arg
570 files)
571 current-prefix-arg
572 files)))
577 ;; Get confirmation for wildcards that may have been meant
578 ;; to control substitution of a file name or the file name list.
592 nil
593 file-list)
594 ;; execute the shell command
598 ;; Might use {,} for bash or csh:
607 ;; "Make up a shell command line from COMMAND and FILE-LIST.
608 ;; If ON-EACH is t, COMMAND should be applied to each file, else
609 ;; simply concat all files and apply COMMAND to this.
610 ;; FILE-LIST's elements will be quoted for the shell."
611 ;; Might be redefined for smarter things and could then use RAW-ARG
612 ;; (coming from interactive P and currently ignored) to decide what to do.
613 ;; Smart would be a way to access basename or extension of file names.
622 retval))
627 file-list dired-mark-separator)))
632 ;; This is an extra function so that it can be redefined by ange-ftp.
633 ;;;###autoload
640 ;; Return nil for sake of nconc in dired-bunch-files.
641 nil)
642 \f
645 ; "Display MSG while running PROGRAM, and check for output.
646 ;Remaining arguments are strings passed as command arguments to PROGRAM.
647 ; On error, insert output
648 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
649 ; Caller can cons up a list of failed args.
650 ;Else returns nil for success."
654 ;; Get a clean buffer for error output:
667 nil))))
668 \f
669 ;; Commands that delete or redisplay part of the dired buffer.
690 ;;;###autoload
692 "Kill all marked lines (not the files).
693 With a prefix argument, kill that many lines starting with the current line.
694 \(A negative argument kills backward.)
695 If you use this command with a prefix argument to kill the line
696 for a file that is a directory, which you have inserted in the
697 Dired buffer as a subdirectory, then it deletes that subdirectory
698 from the buffer as well.
699 To kill an entire subdirectory \(without killing its line in the
700 parent directory), go to its directory header line and use this
701 command with a prefix argument (the value does not matter)."
702 ;; Returns count of killed lines. FMT="" suppresses message.
720 count))))
722 ;;;###end dired-cmd.el
723 \f
724 ;;; 30K
725 ;;;###begin dired-cp.el
728 ;; Compress or uncompress the current file.
729 ;; Return nil for success, offending filename else.
735 ;; Remove any preexisting entry for the name NEW-FILE.
740 ;; Now replace the current line with an entry for NEW-FILE.
743 from-file)))
749 ;; For .z, try gunzip. It might be an old gzip file,
750 ;; or it might be from compact? pack? (which?) but gunzip handles both.
755 ;; This item controls naming for compression.
757 "Control changes in file name suffixes for compression and uncompression.
758 Each element specifies one transformation rule, and has the form:
759 (REGEXP NEW-SUFFIX PROGRAM)
760 The rule applies when the old file name matches REGEXP.
761 The new file name is computed by deleting the part that matches REGEXP
762 (as well as anything after that), then adding NEW-SUFFIX in its place.
763 If PROGRAM is non-nil, the rule is an uncompression rule,
764 and uncompression is done by running PROGRAM.
767 ;;;###autoload
769 ;; Compress or uncompress FILE.
770 ;; Return the name of the compressed or uncompressed file.
771 ;; Return nil if no change in files.
773 suffix newname
775 ;; See if any suffix rule matches this file name.
781 ;; If so, compute desired new name.
788 nil)
790 ;; We found an uncompression rule.
793 newname))
795 ;;; We don't recognize the file as compressed, so compress it.
796 ;;; Try gzip; if we don't have that, use compress.
802 out-name)))
807 ;; Rename the compressed file to NEWNAME
808 ;; if it hasn't got that name already.
812 newname)
813 out-name)))
817 ;; Don't use NEWNAME with `compress'.
819 \f
821 ;; Request confirmation from the user that the operation described
822 ;; by OP-SYMBOL is to be performed on the marked files.
823 ;; Confirmation consists in a y-or-n question with a file list
824 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
825 ;; The files used are determined by ARG (as in dired-get-marked-files).
828 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
829 ;; is marked pops up a window. That will help the user see
830 ;; it isn't the current line file.
839 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
840 ; and display failures.
842 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
843 ; the short form of the filename) for a failure and probably logs a
844 ; detailed error explanation using function `dired-log'.
846 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
847 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
848 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
849 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
851 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
863 ;; end this bunch of errors:
867 failures)))))
874 ;; None of these keys quit - use C-g for that.
875 ))
877 ;;;###autoload
879 "Query user and return nil or t.
880 Store answer in symbol VAR (which must initially be bound to nil).
881 Format PROMPT with ARGS.
882 Binding variable `help-form' will help the user who types the help key."
896 result elt)
897 ;; Actually it looks nicer without cursor-in-echo-area - you can
898 ;; look at the dired buffer instead of at the prompt to decide.
906 ;; Display the question with the answer.
910 \f
911 ;;;###autoload
913 "Compress or uncompress marked (or next ARG) files."
917 ;; Commands for Emacs Lisp files - load and byte compile
920 ;; Return nil for success, offending file name else.
922 elc-file buffer-read-only failure)
937 nil)))
939 ;;;###autoload
941 "Byte compile marked (or next ARG) Emacs Lisp files."
946 ;; Return nil for success, offending file name else.
952 nil
956 ;;;###autoload
958 "Load the marked (or next ARG) Emacs Lisp files."
962 ;;;###autoload
964 "Redisplay all marked (or next ARG) files.
965 If on a subdir line, redisplay that subdirectory. In that case,
966 a prefix arg lets you edit the `ls' switches used for the new listing.
968 Dired remembers switches specified with a prefix arg, so that reverting
969 the buffer will not reset them. However, using `dired-undo' to re-insert
970 or delete subdirectories can bypass this machinery. Hence, you sometimes
971 may have to reset some subdirectory switches after a `dired-undo'.
972 You can reset all subdirectory switches to the default using
974 See Info node `(emacs)Subdir switches' for more details."
975 ;; Moves point if the next ARG files are redisplayed.
981 dir
985 dired-subdir-switches
986 dired-actual-switches)))))
988 ;; message much faster than making dired-map-over-marks show progress
994 arg)
999 "Set `dired-switches-alist' to nil and revert dired buffer."
1003 \f
1005 ;; Delete the current line, and insert an entry for FILE.
1006 ;; If FILE is nil, then just delete the current line.
1007 ;; Keeps any marks that may be present in column one (doing this
1008 ;; here is faster than with dired-add-entry's optional arg).
1009 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1017 ;; Replace space by old marker without moving point.
1018 ;; Faster than goto+insdel inside a save-excursion?
1022 ;;;###autoload
1029 ;; Add a new entry for FILENAME, optionally marking it
1030 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
1031 ;; Note that this adds the entry `out of order' if files sorted by
1032 ;; time, etc.
1033 ;; At least this version inserts in the right subdirectory (if present).
1034 ;; And it skips "." or ".." (see `dired-trivial-filenames').
1035 ;; Hidden subdirs are exposed if a file is added there.
1037 ;; Entry is always for files, even if they happen to also be directories
1042 reason)
1047 reason
1054 ;; We are already where we should be, except when
1055 ;; point is before the subdir line or its total line.
1059 ;; else try to find correct place to insert
1064 ;; found - skip subdir and `total' line
1065 ;; and uninteresting files like . and ..
1066 ;; This better not moves into the next subdir!
1068 ;; not found
1073 ;; Don't expand `.'. Show just the file name within directory.
1079 ;; Put in desired marker char.
1084 ;; Compensate for a bug in ange-ftp.
1085 ;; It inserts the file's absolute name, rather than
1086 ;; the relative one. That may be hard to fix since it
1087 ;; is probably controlled by something in ftp.
1110 ;; return nil if all went well
1111 nil))
1117 ;; Return pos of first file line of DIR, skipping header and total
1118 ;; or wildcard lines.
1119 ;; Important: never moves into the next subdir.
1120 ;; DIR is assumed to be unhidden.
1129 ;;;###autoload
1142 ;;;###autoload
1144 "Create or update the line for FILE in all Dired buffers it would belong in."
1150 ;; Relist the line for FILE, or just add it if it did not exist.
1151 ;; FILE must be an absolute file name.
1153 ;; If cursor is already on FILE's line delete-region will cause
1154 ;; save-excursion to fail because of floating makers,
1155 ;; moving point to beginning of line. Sigh.
1164 \f
1165 ;;; Copy, move/rename, making hard and symbolic links
1168 "Non-nil if Dired should ask about making backups before overwriting files.
1169 Special value `always' suppresses confirmation."
1175 ;; This is a fluid var used in dired-handle-overwrite. It should be
1176 ;; let-bound whenever dired-copy-file etc are called. See
1177 ;; dired-create-files for an example.
1181 ;; Save old version of file TO that is to be overwritten.
1182 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1183 ;; from dired-create-files.
1186 dired-overwrite-confirmed
1190 "Make backup for existing file `%s'? "
1191 to)))
1195 ;;;###autoload
1199 dired-recursive-copies))
1204 preserve-time top recursive)
1206 dirfailed)
1211 ;; This is a directory.
1218 dired-create-files-failures)
1221 nil))))
1227 ;; We used to call set-file-modes here, but on some
1228 ;; Linux kernels, that returns an error on vfat
1229 ;; filesystems
1238 dired-create-files-failures)
1244 ;; Catch errors copying within a directory,
1245 ;; and report them through the dired log mechanism
1246 ;; just as our caller will do for the top level files.
1249 thisfrom thisto
1250 ok-flag preserve-time nil recursive)
1253 dired-create-files-failures)
1257 ;; Not a directory.
1261 ;; It is a symlink
1266 dired-create-files-failures)
1269 ;;;###autoload
1273 ;; Silently rename the visited file of any buffer visiting this file.
1278 ;; See if it's an inserted subdir, and rename that, too.
1286 ;; Update visited file name of all affected buffers
1297 to-dir
1298 buffer-file-name)))
1304 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1305 ;; one of its subdirectories is expanded in this buffer.
1313 ;; ELT's subdir is affected by the rename
1316 ;; if top level directory was renamed, lots of things have to be
1317 ;; updated:
1322 ;; with and without wildcards
1324 to))
1327 ;; try to rename buffer, but just leave old name if new
1328 ;; name would already exist (don't try appending "<%d>")
1331 ;; ... we dired TO now:
1335 ;; Update the headerline and dired-subdir-alist element, as well as
1336 ;; dired-switches-alist element, of directory described by
1337 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1338 ;; describes either DIR itself or a subdir of DIR.
1342 buffer-read-only)
1344 ;; Update subdir headerline in buffer
1347 dir)
1352 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1358 \f
1359 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1363 ;; Create a new file for each from a list of existing files. The user
1364 ;; is queried, dired buffers are updated, and at the end a success or
1365 ;; failure message is displayed
1367 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1369 ;; It is called for each file and must create newfile, the entry of
1370 ;; which will be added. The user will be queried if the file already
1371 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1372 ;; rename), it is FILE-CREATOR's responsibility to update dired
1373 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1374 ;; could not create newfile. The error is caught and logged.
1376 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1377 ;; operation performed. It is used for error logging.
1379 ;; FN-LIST is the list of files to copy (full absolute file names).
1381 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1382 ;; skip. If it skips files for other reasons than a direct user
1383 ;; query, it is supposed to tell why (using dired-log).
1385 ;; Optional MARKER-CHAR is a character with which to mark every
1386 ;; newfile's entry, or t to use the current marker character if the
1387 ;; oldfile was marked.
1406 Type SPC or `y' to overwrite file `%s',
1407 DEL or `n' to skip to next,
1408 ESC or `q' to not overwrite any of the remaining files,
1412 ;; must determine if FROM is marked before file-creator
1413 ;; gets a chance to delete it (in case of a move).
1422 ;; If we get here, file-creator hasn't been aborted
1423 ;; and the old entry (if any) has to be deleted
1424 ;; before adding the new entry.
1432 failures)
1434 operation from to err))))))))
1442 total)
1443 failures))
1449 failures))
1455 skipped))
1460 \f
1462 &optional marker-char op1
1463 how-to)
1464 "Create a new file for each marked file.
1465 Prompts user for target, which is a directory in which to create
1466 the new files. Target may also be a plain file if only one marked
1467 file exists. The way the default for the target directory is
1468 computed depends on the value of `dired-dwim-target-directory'.
1469 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1470 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1471 FILE-CREATOR and OPERATION as in `dired-create-files'.
1472 ARG as in `dired-get-marked-files'.
1473 Optional arg MARKER-CHAR as in `dired-create-files'.
1474 Optional arg OP1 is an alternate form for OPERATION if there is
1475 only one file.
1476 Optional arg HOW-TO determiness how to treat the target.
1477 If HOW-TO is nil, use `file-directory-p' to determine if the
1478 target is a directory. If so, the marked file(s) are created
1479 inside that directory. Otherwise, the target is a plain file;
1480 an error is raised unless there is exactly one marked file.
1481 If HOW-TO is t, target is always treated as a plain file.
1482 Otherwise, HOW-TO should be a function of one argument, TARGET.
1483 If its return value is nil, TARGET is regarded as a plain file.
1484 If it return value is a list, TARGET is a generalized
1485 directory (e.g. some sort of archive). The first element of
1486 this list must be a function with at least four arguments:
1487 operation - as OPERATION above.
1488 rfn-list - list of the relative names for the marked files.
1489 fn-list - list of the absolute names for the marked files.
1490 target - the name of the target itself.
1491 The rest of into-dir are optional arguments.
1492 For any other return value, TARGET is treated as a directory."
1501 target-dir)))
1505 target-dir op-symbol arg rfn-list default)))
1507 ;; Allow DOS/Windows users to change the letter
1508 ;; case of a directory. If we don't test these
1509 ;; conditions up front, file-directory-p below
1510 ;; will return t because the filesystem is
1511 ;; case-insensitive, and Emacs will try to move
1512 ;; foo -> foo/foo, which fails.
1515 dired-one-file
1523 nil
1531 ;; rename-file bombs when moving directories unless we do this:
1534 file-creator operation fn-list
1536 ;; This function uses fluid variable target when called
1537 ;; inside dired-create-files:
1542 marker-char))))
1544 ;; Read arguments for a marked-files command that wants a file name,
1545 ;; perhaps popping up the list of marked files.
1546 ;; ARG is the prefix arg and indicates whether the files came from
1547 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1548 ;; If the current file was used, the list has but one element and ARG
1549 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1550 ;; DEFAULT is the default value to return if the user just hits RET;
1551 ;; if it is omitted or nil, then the name of the directory is used.
1556 nil op-symbol files
1561 ;; Try to guess which target directory the user may want.
1562 ;; If there is a dired buffer displayed in the next window, use
1563 ;; its current subdir, else use current subdir of this dired buffer.
1566 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1574 this-dir)))
1575 \f
1576 ;;;###autoload
1578 "Create a directory called DIRECTORY."
1583 ;; Find the topmost nonexistent parent dir (variable `new')
1595 ;; This may not always be what you want, especially if target is your
1596 ;; home directory and it happens to be a symbolic link, as is often the
1597 ;; case with NFS and automounters. Or if you want to make symlinks
1598 ;; into directories that themselves are only symlinks, also quite
1599 ;; common.
1601 ;; So we don't use this function as value for HOW-TO in
1602 ;; dired-do-symlink, which has the minor disadvantage of
1603 ;; making links *into* a symlinked-dir, when you really wanted to
1604 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1605 ;; just have to remove that symlink by hand before making your marked
1606 ;; symlinks.
1609 "Either nil or a function used by `dired-do-copy' to determine target.
1612 ;;;###autoload
1614 "Copy all marked (or next ARG) files, or copy the current file.
1615 This normally preserves the last-modified date when copying.
1616 When operating on just the current file, you specify the new name.
1617 When operating on multiple or marked files, you specify a directory,
1618 and new copies of these files are made in that directory
1619 with the same names that the files currently have. The default
1620 suggested for the target directory depends on the value of
1621 `dired-dwim-target', which see.
1623 This command copies symbolic links by creating new ones,
1624 like `cp -d'."
1628 "Copy"
1629 arg dired-keep-marker-copy
1630 nil dired-copy-how-to-fn)))
1632 ;;;###autoload
1634 "Make symbolic links to current file or all marked (or next ARG) files.
1635 When operating on just the current file, you specify the new name.
1636 When operating on multiple or marked files, you specify a directory
1637 and new symbolic links are made in that directory
1638 with the same names that the files currently have. The default
1639 suggested for the target directory depends on the value of
1640 `dired-dwim-target', which see.
1647 ;;;###autoload
1649 "Add names (hard links) current file or all marked (or next ARG) files.
1650 When operating on just the current file, you specify the new name.
1651 When operating on multiple or marked files, you specify a directory
1652 and new hard links are made in that directory
1653 with the same names that the files currently have. The default
1654 suggested for the target directory depends on the value of
1655 `dired-dwim-target', which see."
1662 ;; error is caught in -create-files
1664 ;; Update the link count
1667 ;;;###autoload
1669 "Rename current file or all marked (or next ARG) files.
1670 When renaming just the current file, you specify the new name.
1671 When renaming multiple or marked files, you specify a directory.
1672 This command also renames any buffers that are visiting the files.
1673 The default suggested for the target directory depends on the value
1674 of `dired-dwim-target', which see."
1678 ;;;###end dired-cp.el
1679 \f
1680 ;;; 5K
1681 ;;;###begin dired-re.el
1684 ;; Create a new file for each marked file using regexps.
1685 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1686 ;; ARG as in dired-get-marked-files.
1687 ;; Matches each marked file against REGEXP and constructs the new
1688 ;; filename from NEWNAME (like in function replace-match).
1689 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1690 ;; instead of only the non-directory part of the file.
1691 ;; Optional arg MARKER-CHAR as in dired-create-files.
1696 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1697 `!' to %s all remaining matches with no more questions."
1701 ;; Function to construct new filename using REGEXP and NEWNAME:
1706 ;; must bind help-form directly around call to
1707 ;; dired-query
1711 operation-prompt
1712 from
1713 to)
1714 to)
1716 operation from regexp)))))
1717 ;; not whole-name, replace non-directory part only
1728 operation-prompt
1731 to)
1734 rename-regexp-query)
1736 file-creator operation fn-list regexp-name-constructor marker-char)))
1739 ;; Prompt user about performing OPERATION.
1740 ;; Read and return list of: regexp newname arg whole-name.
1753 ;;;###autoload
1755 "Rename selected files whose names match REGEXP to NEWNAME.
1757 With non-zero prefix argument ARG, the command operates on the next ARG
1758 files. Otherwise, it operates on all the marked files, or the current
1759 file if none are marked.
1761 As each match is found, the user must type a character saying
1764 REGEXP defaults to the last regexp used.
1766 With a zero prefix arg, renaming by regexp affects the absolute file name.
1767 Normally, only the non-directory part of the file name is used and changed."
1773 ;;;###autoload
1775 "Copy selected files whose names match REGEXP to NEWNAME.
1776 See function `dired-do-rename-regexp' for more info."
1782 arg regexp newname whole-name dired-keep-marker-copy)))
1784 ;;;###autoload
1786 "Hardlink selected files whose names match REGEXP to NEWNAME.
1787 See function `dired-do-rename-regexp' for more info."
1793 ;;;###autoload
1795 "Symlink selected files whose names match REGEXP to NEWNAME.
1796 See function `dired-do-rename-regexp' for more info."
1804 ;; Perform FILE-CREATOR on the non-directory part of marked files
1805 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1806 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1809 file-creator
1810 operation
1818 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1819 `!' to %s all remaining matches with no more questions."
1826 to))))
1827 dired-keep-marker-rename)))
1832 basename-constructor operation arg))
1834 ;;;###autoload
1836 "Rename all marked (or next ARG) files to upper case."
1840 ;;;###autoload
1842 "Rename all marked (or next ARG) files to lower case."
1846 ;;;###end dired-re.el
1847 \f
1848 ;;; 13K
1849 ;;;###begin dired-ins.el
1851 ;;;###autoload
1853 switches no-error-if-not-dir-p)
1854 "Insert this subdirectory into the same dired buffer.
1856 else inserts it at its natural place (as `ls -lR' would have done).
1857 With a prefix arg, you may edit the ls switches used for this listing.
1858 You can add `R' to the switches to expand the whole tree starting at
1859 this subdirectory.
1860 This function takes some pains to conform to `ls -lR' output.
1862 Dired remembers switches specified with a prefix arg, so that reverting
1863 the buffer will not reset them. However, using `dired-undo' to re-insert
1864 or delete subdirectories can bypass this machinery. Hence, you sometimes
1865 may have to reset some subdirectory switches after a `dired-undo'.
1866 You can reset all subdirectory switches to the default using
1868 See Info node `(emacs)Subdir switches' for more details."
1875 ;; We don't need a marker for opoint as the subdir is always
1876 ;; inserted *after* opoint.
1881 ;; Push mark so that it's easy to find back. Do this after the
1882 ;; insert message so that the user sees the `Mark set' message.
1885 ;;;###autoload
1887 "Insert this subdirectory into the same dired buffer.
1888 If it is already present, overwrites previous entry,
1889 else inserts it at its natural place (as `ls -lR' would have done).
1890 With a prefix arg, you may edit the `ls' switches used for this listing.
1891 You can add `R' to the switches to expand the whole tree starting at
1892 this subdirectory.
1893 This function takes some pains to conform to `ls -lR' output."
1894 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1895 ;; Prospero where dired-ls does the right thing, but
1896 ;; file-directory-p has not been redefined.
1910 switches-have-R mark-alist case-fold-search buffer-read-only)
1913 ;; case-fold-search is nil now, so we can test for capital `R':
1915 ;; avoid duplicated subdirs
1918 ;; If subdir is already present, remove it and remember its marks
1942 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1943 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1956 ;; all switches that make a difference to dired-get-filename:
1960 ;; Add new DIR at NEW-MARKER. Sort alist.
1965 ;; Keep the alist sorted on buffer position.
1973 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1974 Interactively, you can kill DIRNAME as well by using a prefix argument.
1975 In interactive use, the command prompts for DIRNAME.
1977 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1978 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1989 m-alist))
1992 ;; Find pos for new subdir, according to tree order.
1993 ;;(goto-char (point-max))
2001 ;; Insert NEW-DIR after DIR
2003 alist nil)))
2005 ;; want a separating newline between subdirs
2012 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2013 ;; Move to that buffer position. Return a mark-alist.
2016 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2025 ;; Insert ls output after point.
2026 ;; Return the boundary of the inserted text (as list of BEG and END).
2031 dired-subdir-switches
2034 ;; If doing the top level directory of the buffer,
2035 ;; redo it as specified in dired-directory.
2041 ;; Point is at the correct subdir alist position for ELT,
2042 ;; BEG-END is the subdir-region (as list of begin and end).
2044 ;; update its position (should actually be unchanged)
2047 ;; The hook may depend on the subdir-alist containing the just
2048 ;; inserted subdir, so run it after dired-alist-add:
2056 ;; hook may add or delete lines, but the subdir boundary
2057 ;; marker floats
2061 ;; Lexicographic order on file name components, like `ls -lR':
2062 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2063 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2064 ;; or DIR1 and DIR2 are in the same parentdir and their last
2065 ;; components are string-lessp.
2066 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2067 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2068 ;; if dired-actual-switches contained `t'.
2074 components-2
2086 t)
2088 nil)
2091 ;; There should be a builtin split function - inverse to mapconcat.
2093 "Splitting on regexp PAT, turn string STR into a list of substrings.
2094 Optional third arg LIMIT (>= 1) is a limit to the length of the
2095 resulting list.
2096 Thus, if SEP is a regexp that only matches itself,
2098 (mapconcat 'identity (dired-split SEP STRING) SEP)
2100 is always equal to STRING."
2113 start end)
2114 ))
2121 \f
2122 ;;; moving by subdirectories
2124 ;;;###autoload
2126 "Go to previous subdirectory, regardless of level.
2127 When called interactively and not on a subdir line, go to this subdir's line."
2128 ;;(interactive "p")
2132 ;; if on subdir start already, don't stay there!
2142 ;;;###autoload
2144 "Go to end of header line of DIR in this dired buffer.
2145 Return value of point on success, otherwise return nil.
2151 dired-subdir-alist ; table
2152 nil ; predicate
2153 t ; require-match
2160 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2161 ;; at either \r or \n after this function succeeds.
2164 \f
2165 ;;;###autoload
2167 "Mark all files except `.' and `..' in current subdirectory.
2168 If the Dired buffer shows multiple directories, this command
2169 marks the files listed in the subdirectory that point is in."
2174 ;;;###autoload
2176 "Remove all lines of current subdirectory.
2177 Lower levels are unaffected."
2178 ;; With optional REMEMBER-MARKS, return a mark-alist.
2185 buffer-read-only)
2199 ;; Remove DIR from the alist
2203 ;;;###autoload
2205 "Go up ARG levels in the dired tree."
2211 ;;(setq dir (expand-file-name dir))
2215 ;;;###autoload
2217 "Go down in the dired tree."
2231 \f
2232 ;;; hiding
2248 ;;;###autoload
2250 "Hide or unhide the current subdirectory and move to next directory.
2251 Optional prefix arg is a repeat factor.
2261 buffer-read-only)
2262 ;; keep header line visible, hide rest
2271 ;;;###autoload
2273 "Hide all subdirectories, leaving only their header lines.
2274 If there is already something hidden, make everything visible again.
2279 buffer-read-only)
2283 ;; unhide - bombs on \r in filenames
2285 ;; hide
2292 ;; we're somewhere on current dir's line
2300 ;;;###end dired-ins.el
2302 \f
2303 ;; Search only in file names in the Dired buffer.
2306 "Non-nil to Isearch in file names only.
2307 If t, Isearch in Dired always matches only file names.
2308 If `dwim', Isearch matches file names when initial point position is on
2309 a file name. Otherwise, it searches the whole buffer without restrictions."
2319 "Toggle file names searching on or off.
2320 When on, Isearch skips matches outside file names using the predicate
2321 `dired-isearch-filter-filenames' that matches only at file names.
2322 When off, it uses the original predicate."
2326 dired-isearch-filter-predicate-orig
2331 ;;;###autoload
2333 "Set up isearch to search in Dired file names.
2334 Intended to be added to `isearch-mode-hook'."
2346 "Clean up the Dired file name search after terminating isearch."
2353 "Test whether the current search hit is a visible file name.
2354 Return non-nil if the text from BEG to END is part of a file
2355 name (has the text property `dired-filename') and is visible."
2360 t)))
2362 ;;;###autoload
2364 "Search for a string using Isearch only in file names in the Dired buffer."
2369 ;;;###autoload
2371 "Search for a regexp using Isearch only in file names in the Dired buffer."
2376 \f
2377 ;; Functions for searching in tags style among marked files.
2379 ;;;###autoload
2381 "Search for a string through all marked files using Isearch."
2386 ;;;###autoload
2388 "Search for a regexp through all marked files using Isearch."
2393 ;;;###autoload
2395 "Search through all marked files for a match for REGEXP.
2396 Stops when a match is found.
2401 ;;;###autoload
2403 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2404 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2415 buffer-read-only))
2422 \f
2423 ;;;###autoload
2425 "Print the type of FILE, according to the `file' command.
2426 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2427 true then the type of the file linked to by FILE is printed instead."
2440 ;; Local Variables:
2441 ;; byte-compile-dynamic: t
2442 ;; generated-autoload-file: "dired.el"
2443 ;; End:
2445 ;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2446 ;;; dired-aux.el ends here