| blob | 8ebd796c2bde331647bb80a406850870057cb421 |
1 ;;; dired-aux.el --- less commonly used parts of dired -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
7 ;; Maintainer: FSF
8 ;; Keywords: files
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 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."
259 "Change mode of %s to: " nil
265 file
270 ;;;###autoload
272 "Change the group of the marked (or next ARG) files."
278 ;;;###autoload
280 "Change the owner of the marked (or next ARG) files."
286 ;;;###autoload
288 "Change the timestamp of the marked (or next ARG) files.
289 This calls touch."
293 ;; Process all the files in FILES in batches of a convenient size,
294 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
295 ;; Batches are chosen to need less than MAX chars for the file names,
296 ;; allowing 3 extra characters of separator per file name.
299 past
301 failures)
302 ;; Accumulate files as long as they fit in MAX chars,
303 ;; then process the ones accumulated so far.
308 ;; If we have at least 1 pending file
309 ;; and this file won't fit in the length limit, process now.
312 ;; The elements of PENDING are now in forward order.
313 ;; Do the operation and record failures.
315 failures)
316 ;; Transfer the elemens of PENDING onto PAST
317 ;; and clear it out. Now PAST contains the first N files
318 ;; specified (for some N), and FILES contains the rest.
320 pending nil
322 ;; Do (setq pending (cons thisfile pending))
323 ;; but reuse the cons that was in `files'.
331 failures)
332 ;; Now the original list FILES has been put back as it was.
335 ;;;###autoload
337 "Print the marked (or next ARG) files.
338 Uses the shell command coming from variables `lpr-command' and
339 `lpr-switches' as default."
343 "Print %s with: "
348 lpr-switches))
353 ;; Read arguments for a marked-files command that wants a string
354 ;; that is not a file name,
355 ;; perhaps popping up the list of marked files.
356 ;; ARG is the prefix arg and indicates whether the files came from
357 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
358 ;; If the current file was used, the list has but one element and ARG
359 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
362 ;; PROMPT for a string, with INITIAL input.
363 ;; Other args are used to give user feedback and pop-up:
364 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
366 nil op-symbol files
369 \f
370 ;;; Cleaning a directory: flagging some backups for deletion.
374 ;;;###autoload
376 "Flag numerical backups for deletion.
377 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
378 Positive prefix arg KEEP overrides `dired-kept-versions';
379 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
382 with a prefix argument."
389 late-retention early-retention)
390 ;; Look at each file.
391 ;; If the file has numeric backup versions,
392 ;; put on dired-file-version-alist an element of the form
393 ;; (FILENAME . VERSION-NUMBER-LIST)
395 ;; Sort each VERSION-NUMBER-LIST,
396 ;; and remove the versions not to be deleted.
404 sorted-v-list)))
408 ;; Look at each file. If it is a numeric backup file,
409 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
413 ;;; Subroutines of dired-clean-directory.
416 ;; Perform FUN with point at the end of each non-directory line.
417 ;; FUN takes one argument, the absolute filename.
432 ;; Only do work if this file is not already in the alist.
434 nil
435 ;; If it looks like file FN has versions, return a list of the versions.
436 ;;That is a list of strings which are file names.
437 ;;The caller may want to flag some of these files for deletion.
442 base-versions
448 dired-file-version-alist)))))))
452 base-version-list)
462 \f
463 ;;; Shell commands
468 "Return a list of all commands associted with current dired files.
469 This function is used to add all related commands retieved by `mailcap'
470 to the end of the list of defaults just after the default value."
478 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
480 "Read a dired shell command prompting with PROMPT (using read-shell-command).
481 ARG is the prefix arg and may be used to indicate in the prompt which
482 FILES are affected."
488 nil 'shell files
489 #'read-shell-command
491 nil nil)))
493 ;; The in-background argument is only needed in Emacs 18 where
494 ;; shell-command doesn't understand an appended ampersand `&'.
495 ;;;###autoload
497 "Run a shell command COMMAND on the marked files.
498 If no files are marked or a specific numeric prefix arg is given,
500 The prompt mentions the file(s) or the marker, as appropriate.
502 If there is a `*' in COMMAND, surrounded by whitespace, this runs
503 COMMAND just once with the entire file list substituted there.
505 If there is no `*', but there is a `?' in COMMAND, surrounded by
506 whitespace, this runs COMMAND on each file individually with the
507 file name substituted for `?'.
509 Otherwise, this runs COMMAND on each file individually with the
510 file name added at the end of COMMAND (separated by a space).
512 `*' and `?' when not surrounded by whitespace have no special
513 significance for `dired-do-shell-command', and are passed through
514 normally to the shell, but you must confirm first. To pass `*' by
517 If COMMAND produces output, it goes to a separate buffer.
519 This feature does not try to redisplay Dired buffers afterward, as
520 there's no telling what files COMMAND may have changed.
523 When COMMAND runs, its working directory is the top-level directory of
524 the Dired buffer, so output files usually are created there instead of
525 in a subdir.
527 In a noninteractive call (from Lisp code), you must specify
528 the list of file names explicitly with the FILE-LIST argument, which
529 can be produced by `dired-get-marked-files', for example."
530 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
531 ;;actual work and can be redefined for customization.
535 ;; Want to give feedback whether this file or marked files are used:
538 current-prefix-arg
539 files)
540 current-prefix-arg
541 files)))
546 ;; Get confirmation for wildcards that may have been meant
547 ;; to control substitution of a file name or the file name list.
561 nil
562 file-list)
563 ;; execute the shell command
567 ;; Might use {,} for bash or csh:
576 ;; "Make up a shell command line from COMMAND and FILE-LIST.
577 ;; If ON-EACH is t, COMMAND should be applied to each file, else
578 ;; simply concat all files and apply COMMAND to this.
579 ;; FILE-LIST's elements will be quoted for the shell."
580 ;; Might be redefined for smarter things and could then use RAW-ARG
581 ;; (coming from interactive P and currently ignored) to decide what to do.
582 ;; Smart would be a way to access basename or extension of file names.
591 retval))
596 file-list dired-mark-separator)))
601 ;; This is an extra function so that it can be redefined by ange-ftp.
602 ;;;###autoload
609 ;; Return nil for sake of nconc in dired-bunch-files.
610 nil)
611 \f
614 ; "Display MSG while running PROGRAM, and check for output.
615 ;Remaining arguments are strings passed as command arguments to PROGRAM.
616 ; On error, insert output
617 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
618 ; Caller can cons up a list of failed args.
619 ;Else returns nil for success."
623 ;; Get a clean buffer for error output:
636 nil))))
637 \f
638 ;; Commands that delete or redisplay part of the dired buffer.
659 ;;;###autoload
661 "Kill all marked lines (not the files).
662 With a prefix argument, kill that many lines starting with the current line.
663 \(A negative argument kills backward.)
664 If you use this command with a prefix argument to kill the line
665 for a file that is a directory, which you have inserted in the
666 Dired buffer as a subdirectory, then it deletes that subdirectory
667 from the buffer as well.
668 To kill an entire subdirectory \(without killing its line in the
669 parent directory), go to its directory header line and use this
670 command with a prefix argument (the value does not matter)."
671 ;; Returns count of killed lines. FMT="" suppresses message.
689 count))))
691 ;;;###end dired-cmd.el
692 \f
693 ;;; 30K
694 ;;;###begin dired-cp.el
697 ;; Compress or uncompress the current file.
698 ;; Return nil for success, offending filename else.
704 ;; Remove any preexisting entry for the name NEW-FILE.
709 ;; Now replace the current line with an entry for NEW-FILE.
712 from-file)))
718 ;; For .z, try gunzip. It might be an old gzip file,
719 ;; or it might be from compact? pack? (which?) but gunzip handles both.
724 ;; This item controls naming for compression.
726 "Control changes in file name suffixes for compression and uncompression.
727 Each element specifies one transformation rule, and has the form:
728 (REGEXP NEW-SUFFIX PROGRAM)
729 The rule applies when the old file name matches REGEXP.
730 The new file name is computed by deleting the part that matches REGEXP
731 (as well as anything after that), then adding NEW-SUFFIX in its place.
732 If PROGRAM is non-nil, the rule is an uncompression rule,
733 and uncompression is done by running PROGRAM.
736 ;;;###autoload
738 ;; Compress or uncompress FILE.
739 ;; Return the name of the compressed or uncompressed file.
740 ;; Return nil if no change in files.
742 suffix newname
744 ;; See if any suffix rule matches this file name.
750 ;; If so, compute desired new name.
757 nil)
759 ;; We found an uncompression rule.
762 newname))
764 ;;; We don't recognize the file as compressed, so compress it.
765 ;;; Try gzip; if we don't have that, use compress.
771 out-name)))
776 ;; Rename the compressed file to NEWNAME
777 ;; if it hasn't got that name already.
781 newname)
782 out-name)))
786 ;; Don't use NEWNAME with `compress'.
788 \f
790 ;; Request confirmation from the user that the operation described
791 ;; by OP-SYMBOL is to be performed on the marked files.
792 ;; Confirmation consists in a y-or-n question with a file list
793 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
794 ;; The files used are determined by ARG (as in dired-get-marked-files).
797 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
798 ;; is marked pops up a window. That will help the user see
799 ;; it isn't the current line file.
808 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
809 ; and display failures.
811 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
812 ; the short form of the filename) for a failure and probably logs a
813 ; detailed error explanation using function `dired-log'.
815 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
816 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
817 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
818 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
820 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
832 ;; end this bunch of errors:
836 failures)))))
843 ;; None of these keys quit - use C-g for that.
844 ))
846 ;;;###autoload
848 ;; Query user and return nil or t.
849 ;; Store answer in symbol VAR (which must initially be bound to nil).
850 ;; Format PROMPT with ARGS.
851 ;; Binding variable help-form will help the user who types the help key.
865 result elt)
866 ;; Actually it looks nicer without cursor-in-echo-area - you can
867 ;; look at the dired buffer instead of at the prompt to decide.
876 ;; Display the question with the answer.
880 \f
881 ;;;###autoload
883 "Compress or uncompress marked (or next ARG) files."
887 ;; Commands for Emacs Lisp files - load and byte compile
890 ;; Return nil for success, offending file name else.
892 elc-file buffer-read-only failure)
907 nil)))
909 ;;;###autoload
911 "Byte compile marked (or next ARG) Emacs Lisp files."
916 ;; Return nil for success, offending file name else.
922 nil
926 ;;;###autoload
928 "Load the marked (or next ARG) Emacs Lisp files."
932 ;;;###autoload
934 "Redisplay all marked (or next ARG) files.
935 If on a subdir line, redisplay that subdirectory. In that case,
936 a prefix arg lets you edit the `ls' switches used for the new listing.
938 Dired remembers switches specified with a prefix arg, so that reverting
939 the buffer will not reset them. However, using `dired-undo' to re-insert
940 or delete subdirectories can bypass this machinery. Hence, you sometimes
941 may have to reset some subdirectory switches after a `dired-undo'.
942 You can reset all subdirectory switches to the default using
944 See Info node `(emacs)Subdir switches' for more details."
945 ;; Moves point if the next ARG files are redisplayed.
951 dir
955 dired-subdir-switches
956 dired-actual-switches)))))
958 ;; message much faster than making dired-map-over-marks show progress
964 arg)
969 "Set `dired-switches-alist' to nil and revert dired buffer."
973 \f
975 ;; Delete the current line, and insert an entry for FILE.
976 ;; If FILE is nil, then just delete the current line.
977 ;; Keeps any marks that may be present in column one (doing this
978 ;; here is faster than with dired-add-entry's optional arg).
979 ;; Does not update other dired buffers. Use dired-relist-entry for that.
987 ;; Replace space by old marker without moving point.
988 ;; Faster than goto+insdel inside a save-excursion?
992 ;;;###autoload
999 ;; Add a new entry for FILENAME, optionally marking it
1000 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
1001 ;; Note that this adds the entry `out of order' if files sorted by
1002 ;; time, etc.
1003 ;; At least this version inserts in the right subdirectory (if present).
1004 ;; And it skips "." or ".." (see `dired-trivial-filenames').
1005 ;; Hidden subdirs are exposed if a file is added there.
1007 ;; Entry is always for files, even if they happen to also be directories
1012 reason)
1017 reason
1024 ;; We are already where we should be, except when
1025 ;; point is before the subdir line or its total line.
1029 ;; else try to find correct place to insert
1034 ;; found - skip subdir and `total' line
1035 ;; and uninteresting files like . and ..
1036 ;; This better not moves into the next subdir!
1038 ;; not found
1043 ;; Don't expand `.'. Show just the file name within directory.
1049 ;; Put in desired marker char.
1054 ;; Compensate for a bug in ange-ftp.
1055 ;; It inserts the file's absolute name, rather than
1056 ;; the relative one. That may be hard to fix since it
1057 ;; is probably controlled by something in ftp.
1080 ;; return nil if all went well
1081 nil))
1087 ;; Return pos of first file line of DIR, skipping header and total
1088 ;; or wildcard lines.
1089 ;; Important: never moves into the next subdir.
1090 ;; DIR is assumed to be unhidden.
1091 ;; Will probably be redefined for VMS etc.
1100 ;;;###autoload
1113 ;;;###autoload
1115 "Create or update the line for FILE in all Dired buffers it would belong in."
1121 ;; Relist the line for FILE, or just add it if it did not exist.
1122 ;; FILE must be an absolute file name.
1124 ;; If cursor is already on FILE's line delete-region will cause
1125 ;; save-excursion to fail because of floating makers,
1126 ;; moving point to beginning of line. Sigh.
1135 \f
1136 ;;; Copy, move/rename, making hard and symbolic links
1139 "*Non-nil if Dired should ask about making backups before overwriting files.
1140 Special value `always' suppresses confirmation."
1146 ;; This is a fluid var used in dired-handle-overwrite. It should be
1147 ;; let-bound whenever dired-copy-file etc are called. See
1148 ;; dired-create-files for an example.
1152 ;; Save old version of file TO that is to be overwritten.
1153 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1154 ;; from dired-create-files.
1157 dired-overwrite-confirmed
1161 "Make backup for existing file `%s'? "
1162 to)))
1166 ;;;###autoload
1170 dired-recursive-copies))
1175 preserve-time top recursive)
1177 dirfailed)
1182 ;; This is a directory.
1189 dired-create-files-failures)
1192 nil))))
1203 dired-create-files-failures)
1209 ;; Catch errors copying within a directory,
1210 ;; and report them through the dired log mechanism
1211 ;; just as our caller will do for the top level files.
1214 thisfrom thisto
1215 ok-flag preserve-time nil recursive)
1218 dired-create-files-failures)
1222 ;; Not a directory.
1226 ;; It is a symlink
1231 dired-create-files-failures)
1234 ;;;###autoload
1238 ;; Silently rename the visited file of any buffer visiting this file.
1243 ;; See if it's an inserted subdir, and rename that, too.
1251 ;; Update visited file name of all affected buffers
1262 to-dir
1263 buffer-file-name)))
1269 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1270 ;; one of its subdirectories is expanded in this buffer.
1278 ;; ELT's subdir is affected by the rename
1281 ;; if top level directory was renamed, lots of things have to be
1282 ;; updated:
1287 ;; with and without wildcards
1289 to))
1292 ;; try to rename buffer, but just leave old name if new
1293 ;; name would already exist (don't try appending "<%d>")
1296 ;; ... we dired TO now:
1300 ;; Update the headerline and dired-subdir-alist element, as well as
1301 ;; dired-switches-alist element, of directory described by
1302 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1303 ;; describes either DIR itself or a subdir of DIR.
1307 buffer-read-only)
1309 ;; Update subdir headerline in buffer
1312 dir)
1317 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1323 \f
1324 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1328 ;; Create a new file for each from a list of existing files. The user
1329 ;; is queried, dired buffers are updated, and at the end a success or
1330 ;; failure message is displayed
1332 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1334 ;; It is called for each file and must create newfile, the entry of
1335 ;; which will be added. The user will be queried if the file already
1336 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1337 ;; rename), it is FILE-CREATOR's responsibility to update dired
1338 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1339 ;; could not create newfile. The error is caught and logged.
1341 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1342 ;; operation performed. It is used for error logging.
1344 ;; FN-LIST is the list of files to copy (full absolute file names).
1346 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1347 ;; skip. If it skips files for other reasons than a direct user
1348 ;; query, it is supposed to tell why (using dired-log).
1350 ;; Optional MARKER-CHAR is a character with which to mark every
1351 ;; newfile's entry, or t to use the current marker character if the
1352 ;; oldfile was marked.
1371 Type SPC or `y' to overwrite file `%s',
1372 DEL or `n' to skip to next,
1373 ESC or `q' to not overwrite any of the remaining files,
1377 ;; must determine if FROM is marked before file-creator
1378 ;; gets a chance to delete it (in case of a move).
1387 ;; If we get here, file-creator hasn't been aborted
1388 ;; and the old entry (if any) has to be deleted
1389 ;; before adding the new entry.
1397 failures)
1399 operation from to err))))))))
1407 total)
1408 failures))
1414 failures))
1420 skipped))
1425 \f
1427 &optional marker-char op1
1428 how-to)
1429 "Create a new file for each marked file.
1430 Prompts user for target, which is a directory in which to create
1431 the new files. Target may be a plain file if only one marked
1432 file exists. The way the default for the target directory is
1433 computed depends on the value of `dired-dwim-target-directory'.
1434 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1435 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1436 FILE-CREATOR and OPERATION as in `dired-create-files'.
1437 ARG as in `dired-get-marked-files'.
1438 Optional arg MARKER-CHAR as in `dired-create-files'.
1439 Optional arg OP1 is an alternate form for OPERATION if there is
1440 only one file.
1441 Optional arg HOW-TO is used to set the value of the into-dir variable
1442 which determines how to treat target.
1443 If into-dir is set to nil then target is not regarded as a directory,
1444 there must be exactly one marked file, else error.
1445 Else if into-dir is set to a list, then target is a generalized
1446 directory (e.g. some sort of archive). The first element of into-dir
1447 must be a function with at least four arguments:
1448 operation as OPERATION above.
1449 rfn-list a list of the relative names for the marked files.
1450 fn-list a list of the absolute names for the marked files.
1451 target.
1452 The rest of into-dir are optional arguments.
1453 Else into-dir is not a list. Target is a directory.
1454 The marked file(s) are created inside the target directory.
1456 If HOW-TO is not given (or nil), then into-dir is set to true if
1457 target is a directory and otherwise to nil.
1458 Else if HOW-TO is t, then into-dir is set to nil.
1459 Else HOW-TO is assumed to be a function of one argument, target,
1460 that looks at target and returns a value for the into-dir
1461 variable. The function `dired-into-dir-with-symlinks' is provided
1462 for the case (common when creating symlinks) that symbolic
1463 links to directories are not to be considered as directories
1464 (as `file-directory-p' would if HOW-TO had been nil)."
1473 target-dir)))
1477 target-dir op-symbol arg rfn-list default)))
1479 ;; Allow DOS/Windows users to change the letter
1480 ;; case of a directory. If we don't test these
1481 ;; conditions up front, file-directory-p below
1482 ;; will return t because the filesystem is
1483 ;; case-insensitive, and Emacs will try to move
1484 ;; foo -> foo/foo, which fails.
1487 dired-one-file
1495 nil
1503 ;; rename-file bombs when moving directories unless we do this:
1506 file-creator operation fn-list
1508 ;; This function uses fluid variable target when called
1509 ;; inside dired-create-files:
1514 marker-char))))
1516 ;; Read arguments for a marked-files command that wants a file name,
1517 ;; perhaps popping up the list of marked files.
1518 ;; ARG is the prefix arg and indicates whether the files came from
1519 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1520 ;; If the current file was used, the list has but one element and ARG
1521 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1522 ;; DEFAULT is the default value to return if the user just hits RET;
1523 ;; if it is omitted or nil, then the name of the directory is used.
1528 nil op-symbol files
1533 ;; Try to guess which target directory the user may want.
1534 ;; If there is a dired buffer displayed in the next window, use
1535 ;; its current subdir, else use current subdir of this dired buffer.
1538 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1546 this-dir)))
1547 \f
1548 ;;;###autoload
1550 "Create a directory called DIRECTORY."
1555 ;; Find the topmost nonexistent parent dir (variable `new')
1567 ;; This may not always be what you want, especially if target is your
1568 ;; home directory and it happens to be a symbolic link, as is often the
1569 ;; case with NFS and automounters. Or if you want to make symlinks
1570 ;; into directories that themselves are only symlinks, also quite
1571 ;; common.
1573 ;; So we don't use this function as value for HOW-TO in
1574 ;; dired-do-symlink, which has the minor disadvantage of
1575 ;; making links *into* a symlinked-dir, when you really wanted to
1576 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1577 ;; just have to remove that symlink by hand before making your marked
1578 ;; symlinks.
1581 "nil or a function used by `dired-do-copy' to determine target.
1584 ;;;###autoload
1586 "Copy all marked (or next ARG) files, or copy the current file.
1587 This normally preserves the last-modified date when copying.
1588 When operating on just the current file, you specify the new name.
1589 When operating on multiple or marked files, you specify a directory,
1590 and new copies of these files are made in that directory
1591 with the same names that the files currently have. The default
1592 suggested for the target directory depends on the value of
1593 `dired-dwim-target', which see.
1595 This command copies symbolic links by creating new ones,
1596 like `cp -d'."
1600 "Copy"
1601 arg dired-keep-marker-copy
1602 nil dired-copy-how-to-fn)))
1604 ;;;###autoload
1606 "Make symbolic links to current file or all marked (or next ARG) files.
1607 When operating on just the current file, you specify the new name.
1608 When operating on multiple or marked files, you specify a directory
1609 and new symbolic links are made in that directory
1610 with the same names that the files currently have. The default
1611 suggested for the target directory depends on the value of
1612 `dired-dwim-target', which see.
1619 ;;;###autoload
1621 "Add names (hard links) current file or all marked (or next ARG) files.
1622 When operating on just the current file, you specify the new name.
1623 When operating on multiple or marked files, you specify a directory
1624 and new hard links are made in that directory
1625 with the same names that the files currently have. The default
1626 suggested for the target directory depends on the value of
1627 `dired-dwim-target', which see."
1634 ;; error is caught in -create-files
1636 ;; Update the link count
1639 ;;;###autoload
1641 "Rename current file or all marked (or next ARG) files.
1642 When renaming just the current file, you specify the new name.
1643 When renaming multiple or marked files, you specify a directory.
1644 This command also renames any buffers that are visiting the files.
1645 The default suggested for the target directory depends on the value
1646 of `dired-dwim-target', which see."
1650 ;;;###end dired-cp.el
1651 \f
1652 ;;; 5K
1653 ;;;###begin dired-re.el
1656 ;; Create a new file for each marked file using regexps.
1657 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1658 ;; ARG as in dired-get-marked-files.
1659 ;; Matches each marked file against REGEXP and constructs the new
1660 ;; filename from NEWNAME (like in function replace-match).
1661 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1662 ;; instead of only the non-directory part of the file.
1663 ;; Optional arg MARKER-CHAR as in dired-create-files.
1668 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1669 `!' to %s all remaining matches with no more questions."
1673 ;; Function to construct new filename using REGEXP and NEWNAME:
1678 ;; must bind help-form directly around call to
1679 ;; dired-query
1683 operation-prompt
1684 from
1685 to)
1686 to)
1688 operation from regexp)))))
1689 ;; not whole-name, replace non-directory part only
1700 operation-prompt
1703 to)
1706 rename-regexp-query)
1708 file-creator operation fn-list regexp-name-constructor marker-char)))
1711 ;; Prompt user about performing OPERATION.
1712 ;; Read and return list of: regexp newname arg whole-name.
1725 ;;;###autoload
1727 "Rename selected files whose names match REGEXP to NEWNAME.
1729 With non-zero prefix argument ARG, the command operates on the next ARG
1730 files. Otherwise, it operates on all the marked files, or the current
1731 file if none are marked.
1733 As each match is found, the user must type a character saying
1736 REGEXP defaults to the last regexp used.
1738 With a zero prefix arg, renaming by regexp affects the absolute file name.
1739 Normally, only the non-directory part of the file name is used and changed."
1745 ;;;###autoload
1747 "Copy selected files whose names match REGEXP to NEWNAME.
1748 See function `dired-do-rename-regexp' for more info."
1754 arg regexp newname whole-name dired-keep-marker-copy)))
1756 ;;;###autoload
1758 "Hardlink selected files whose names match REGEXP to NEWNAME.
1759 See function `dired-do-rename-regexp' for more info."
1765 ;;;###autoload
1767 "Symlink selected files whose names match REGEXP to NEWNAME.
1768 See function `dired-do-rename-regexp' for more info."
1776 ;; Perform FILE-CREATOR on the non-directory part of marked files
1777 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1778 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1781 file-creator
1782 operation
1790 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1791 `!' to %s all remaining matches with no more questions."
1798 to))))
1799 dired-keep-marker-rename)))
1804 basename-constructor operation arg))
1806 ;;;###autoload
1808 "Rename all marked (or next ARG) files to upper case."
1812 ;;;###autoload
1814 "Rename all marked (or next ARG) files to lower case."
1818 ;;;###end dired-re.el
1819 \f
1820 ;;; 13K
1821 ;;;###begin dired-ins.el
1823 ;;;###autoload
1825 switches no-error-if-not-dir-p)
1826 "Insert this subdirectory into the same dired buffer.
1828 else inserts it at its natural place (as `ls -lR' would have done).
1829 With a prefix arg, you may edit the ls switches used for this listing.
1830 You can add `R' to the switches to expand the whole tree starting at
1831 this subdirectory.
1832 This function takes some pains to conform to `ls -lR' output.
1834 Dired remembers switches specified with a prefix arg, so that reverting
1835 the buffer will not reset them. However, using `dired-undo' to re-insert
1836 or delete subdirectories can bypass this machinery. Hence, you sometimes
1837 may have to reset some subdirectory switches after a `dired-undo'.
1838 You can reset all subdirectory switches to the default using
1840 See Info node `(emacs)Subdir switches' for more details."
1847 ;; We don't need a marker for opoint as the subdir is always
1848 ;; inserted *after* opoint.
1853 ;; Push mark so that it's easy to find back. Do this after the
1854 ;; insert message so that the user sees the `Mark set' message.
1857 ;;;###autoload
1859 "Insert this subdirectory into the same dired buffer.
1860 If it is already present, overwrites previous entry,
1861 else inserts it at its natural place (as `ls -lR' would have done).
1862 With a prefix arg, you may edit the `ls' switches used for this listing.
1863 You can add `R' to the switches to expand the whole tree starting at
1864 this subdirectory.
1865 This function takes some pains to conform to `ls -lR' output."
1866 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1867 ;; Prospero where dired-ls does the right thing, but
1868 ;; file-directory-p has not been redefined.
1882 switches-have-R mark-alist case-fold-search buffer-read-only)
1885 ;; case-fold-search is nil now, so we can test for capital `R':
1887 ;; avoid duplicated subdirs
1890 ;; If subdir is already present, remove it and remember its marks
1913 ;; This is a separate function for dired-vms.
1915 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1916 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1929 ;; all switches that make a difference to dired-get-filename:
1933 ;; Add new DIR at NEW-MARKER. Sort alist.
1938 ;; Keep the alist sorted on buffer position.
1946 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1947 Interactively, you can kill DIRNAME as well by using a prefix argument.
1948 In interactive use, the command prompts for DIRNAME.
1950 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1951 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1962 m-alist))
1965 ;; Find pos for new subdir, according to tree order.
1966 ;;(goto-char (point-max))
1974 ;; Insert NEW-DIR after DIR
1976 alist nil)))
1978 ;; want a separating newline between subdirs
1985 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1986 ;; Move to that buffer position. Return a mark-alist.
1989 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1998 ;; Insert ls output after point.
1999 ;; Return the boundary of the inserted text (as list of BEG and END).
2004 dired-subdir-switches
2007 ;; If doing the top level directory of the buffer,
2008 ;; redo it as specified in dired-directory.
2014 ;; Point is at the correct subdir alist position for ELT,
2015 ;; BEG-END is the subdir-region (as list of begin and end).
2017 ;; update its position (should actually be unchanged)
2020 ;; The hook may depend on the subdir-alist containing the just
2021 ;; inserted subdir, so run it after dired-alist-add:
2029 ;; hook may add or delete lines, but the subdir boundary
2030 ;; marker floats
2034 ;; Lexicographic order on file name components, like `ls -lR':
2035 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2036 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2037 ;; or DIR1 and DIR2 are in the same parentdir and their last
2038 ;; components are string-lessp.
2039 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2040 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2041 ;; if dired-actual-switches contained `t'.
2047 components-2
2059 t)
2061 nil)
2064 ;; There should be a builtin split function - inverse to mapconcat.
2066 "Splitting on regexp PAT, turn string STR into a list of substrings.
2067 Optional third arg LIMIT (>= 1) is a limit to the length of the
2068 resulting list.
2069 Thus, if SEP is a regexp that only matches itself,
2071 (mapconcat 'identity (dired-split SEP STRING) SEP)
2073 is always equal to STRING."
2086 start end)
2087 ))
2094 \f
2095 ;;; moving by subdirectories
2097 ;;;###autoload
2099 "Go to previous subdirectory, regardless of level.
2100 When called interactively and not on a subdir line, go to this subdir's line."
2101 ;;(interactive "p")
2105 ;; if on subdir start already, don't stay there!
2115 ;;;###autoload
2117 "Go to end of header line of DIR in this dired buffer.
2118 Return value of point on success, otherwise return nil.
2124 dired-subdir-alist ; table
2125 nil ; predicate
2126 t ; require-match
2133 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2134 ;; at either \r or \n after this function succeeds.
2137 \f
2138 ;;;###autoload
2140 "Mark all files except `.' and `..' in current subdirectory.
2141 If the Dired buffer shows multiple directories, this command
2142 marks the files listed in the subdirectory that point is in."
2147 ;;;###autoload
2149 "Remove all lines of current subdirectory.
2150 Lower levels are unaffected."
2151 ;; With optional REMEMBER-MARKS, return a mark-alist.
2158 buffer-read-only)
2172 ;; Remove DIR from the alist
2176 ;;;###autoload
2178 "Go up ARG levels in the dired tree."
2184 ;;(setq dir (expand-file-name dir))
2188 ;;;###autoload
2190 "Go down in the dired tree."
2204 \f
2205 ;;; hiding
2221 ;;;###autoload
2223 "Hide or unhide the current subdirectory and move to next directory.
2224 Optional prefix arg is a repeat factor.
2234 buffer-read-only)
2235 ;; keep header line visible, hide rest
2244 ;;;###autoload
2246 "Hide all subdirectories, leaving only their header lines.
2247 If there is already something hidden, make everything visible again.
2252 buffer-read-only)
2256 ;; unhide - bombs on \r in filenames
2258 ;; hide
2265 ;; we're somewhere on current dir's line
2273 ;;;###end dired-ins.el
2275 \f
2276 ;; Functions for searching in tags style among marked files.
2278 ;;;###autoload
2280 "Search through all marked files for a match for REGEXP.
2281 Stops when a match is found.
2286 ;;;###autoload
2288 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2289 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2300 buffer-read-only))
2307 \f
2308 ;;;###autoload
2310 "Print the type of FILE, according to the `file' command.
2311 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2312 true then the type of the file linked to by FILE is printed instead."
2324 ;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2325 ;;; dired-aux.el ends here