| blob | 6bef35963cd811bee219ba0962aa92d5c6df5b97 |
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
472 "Return a list of default commands for `dired-read-shell-command'."
477 ;; All unique MIME types from file extensions
481 files)))
483 ;; All MIME info lists
486 all-mime-type)))
488 ;; Intersection of mime-infos from different mime-types;
489 ;; or just the first MIME info for a single MIME type
496 mi1))
500 ;; Command strings from `viewer' field of the MIME info
505 ;; Replace mailcap's `%s' placeholder
506 ;; with dired's `?' placeholder
509 ;; Remove the final filename placeholder
511 nil t))))
512 common-mime-info))))
513 commands))
516 ;; "Read a dired shell command prompting with PROMPT (using read-string).
517 ;;ARG is the prefix arg and may be used to indicate in the prompt which
518 ;; files are affected.
519 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
521 nil 'shell files
524 nil 'shell-command-history
527 ;; The in-background argument is only needed in Emacs 18 where
528 ;; shell-command doesn't understand an appended ampersand `&'.
529 ;;;###autoload
531 "Run a shell command COMMAND on the marked files.
532 If no files are marked or a specific numeric prefix arg is given,
534 The prompt mentions the file(s) or the marker, as appropriate.
536 If there is a `*' in COMMAND, surrounded by whitespace, this runs
537 COMMAND just once with the entire file list substituted there.
539 If there is no `*', but there is a `?' in COMMAND, surrounded by
540 whitespace, this runs COMMAND on each file individually with the
541 file name substituted for `?'.
543 Otherwise, this runs COMMAND on each file individually with the
544 file name added at the end of COMMAND (separated by a space).
546 `*' and `?' when not surrounded by whitespace have no special
547 significance for `dired-do-shell-command', and are passed through
548 normally to the shell, but you must confirm first. To pass `*' by
551 If COMMAND produces output, it goes to a separate buffer.
553 This feature does not try to redisplay Dired buffers afterward, as
554 there's no telling what files COMMAND may have changed.
557 When COMMAND runs, its working directory is the top-level directory of
558 the Dired buffer, so output files usually are created there instead of
559 in a subdir.
561 In a noninteractive call (from Lisp code), you must specify
562 the list of file names explicitly with the FILE-LIST argument, which
563 can be produced by `dired-get-marked-files', for example."
564 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
565 ;;actual work and can be redefined for customization.
569 ;; Want to give feedback whether this file or marked files are used:
572 current-prefix-arg
573 files)
574 current-prefix-arg
575 files)))
580 ;; Get confirmation for wildcards that may have been meant
581 ;; to control substitution of a file name or the file name list.
595 nil
596 file-list)
597 ;; execute the shell command
601 ;; Might use {,} for bash or csh:
610 ;; "Make up a shell command line from COMMAND and FILE-LIST.
611 ;; If ON-EACH is t, COMMAND should be applied to each file, else
612 ;; simply concat all files and apply COMMAND to this.
613 ;; FILE-LIST's elements will be quoted for the shell."
614 ;; Might be redefined for smarter things and could then use RAW-ARG
615 ;; (coming from interactive P and currently ignored) to decide what to do.
616 ;; Smart would be a way to access basename or extension of file names.
625 retval))
630 file-list dired-mark-separator)))
635 ;; This is an extra function so that it can be redefined by ange-ftp.
636 ;;;###autoload
643 ;; Return nil for sake of nconc in dired-bunch-files.
644 nil)
645 \f
648 ; "Display MSG while running PROGRAM, and check for output.
649 ;Remaining arguments are strings passed as command arguments to PROGRAM.
650 ; On error, insert output
651 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
652 ; Caller can cons up a list of failed args.
653 ;Else returns nil for success."
657 ;; Get a clean buffer for error output:
670 nil))))
671 \f
672 ;; Commands that delete or redisplay part of the dired buffer.
693 ;;;###autoload
695 "Kill all marked lines (not the files).
696 With a prefix argument, kill that many lines starting with the current line.
697 \(A negative argument kills backward.)
698 If you use this command with a prefix argument to kill the line
699 for a file that is a directory, which you have inserted in the
700 Dired buffer as a subdirectory, then it deletes that subdirectory
701 from the buffer as well.
702 To kill an entire subdirectory \(without killing its line in the
703 parent directory), go to its directory header line and use this
704 command with a prefix argument (the value does not matter)."
705 ;; Returns count of killed lines. FMT="" suppresses message.
723 count))))
725 ;;;###end dired-cmd.el
726 \f
727 ;;; 30K
728 ;;;###begin dired-cp.el
731 ;; Compress or uncompress the current file.
732 ;; Return nil for success, offending filename else.
738 ;; Remove any preexisting entry for the name NEW-FILE.
743 ;; Now replace the current line with an entry for NEW-FILE.
746 from-file)))
752 ;; For .z, try gunzip. It might be an old gzip file,
753 ;; or it might be from compact? pack? (which?) but gunzip handles both.
758 ;; This item controls naming for compression.
760 "Control changes in file name suffixes for compression and uncompression.
761 Each element specifies one transformation rule, and has the form:
762 (REGEXP NEW-SUFFIX PROGRAM)
763 The rule applies when the old file name matches REGEXP.
764 The new file name is computed by deleting the part that matches REGEXP
765 (as well as anything after that), then adding NEW-SUFFIX in its place.
766 If PROGRAM is non-nil, the rule is an uncompression rule,
767 and uncompression is done by running PROGRAM.
770 ;;;###autoload
772 ;; Compress or uncompress FILE.
773 ;; Return the name of the compressed or uncompressed file.
774 ;; Return nil if no change in files.
776 suffix newname
778 ;; See if any suffix rule matches this file name.
784 ;; If so, compute desired new name.
791 nil)
793 ;; We found an uncompression rule.
796 newname))
798 ;;; We don't recognize the file as compressed, so compress it.
799 ;;; Try gzip; if we don't have that, use compress.
805 out-name)))
810 ;; Rename the compressed file to NEWNAME
811 ;; if it hasn't got that name already.
815 newname)
816 out-name)))
820 ;; Don't use NEWNAME with `compress'.
822 \f
824 ;; Request confirmation from the user that the operation described
825 ;; by OP-SYMBOL is to be performed on the marked files.
826 ;; Confirmation consists in a y-or-n question with a file list
827 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
828 ;; The files used are determined by ARG (as in dired-get-marked-files).
831 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
832 ;; is marked pops up a window. That will help the user see
833 ;; it isn't the current line file.
842 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
843 ; and display failures.
845 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
846 ; the short form of the filename) for a failure and probably logs a
847 ; detailed error explanation using function `dired-log'.
849 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
850 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
851 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
852 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
854 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
866 ;; end this bunch of errors:
870 failures)))))
877 ;; None of these keys quit - use C-g for that.
878 ))
880 ;;;###autoload
882 ;; Query user and return nil or t.
883 ;; Store answer in symbol VAR (which must initially be bound to nil).
884 ;; Format PROMPT with ARGS.
885 ;; Binding variable help-form will help the user who types the help key.
899 result elt)
900 ;; Actually it looks nicer without cursor-in-echo-area - you can
901 ;; look at the dired buffer instead of at the prompt to decide.
910 ;; Display the question with the answer.
914 \f
915 ;;;###autoload
917 "Compress or uncompress marked (or next ARG) files."
921 ;; Commands for Emacs Lisp files - load and byte compile
924 ;; Return nil for success, offending file name else.
926 elc-file buffer-read-only failure)
941 nil)))
943 ;;;###autoload
945 "Byte compile marked (or next ARG) Emacs Lisp files."
950 ;; Return nil for success, offending file name else.
956 nil
960 ;;;###autoload
962 "Load the marked (or next ARG) Emacs Lisp files."
966 ;;;###autoload
968 "Redisplay all marked (or next ARG) files.
969 If on a subdir line, redisplay that subdirectory. In that case,
970 a prefix arg lets you edit the `ls' switches used for the new listing.
972 Dired remembers switches specified with a prefix arg, so that reverting
973 the buffer will not reset them. However, using `dired-undo' to re-insert
974 or delete subdirectories can bypass this machinery. Hence, you sometimes
975 may have to reset some subdirectory switches after a `dired-undo'.
976 You can reset all subdirectory switches to the default using
978 See Info node `(emacs)Subdir switches' for more details."
979 ;; Moves point if the next ARG files are redisplayed.
985 dir
989 dired-subdir-switches
990 dired-actual-switches)))))
992 ;; message much faster than making dired-map-over-marks show progress
998 arg)
1003 "Set `dired-switches-alist' to nil and revert dired buffer."
1007 \f
1009 ;; Delete the current line, and insert an entry for FILE.
1010 ;; If FILE is nil, then just delete the current line.
1011 ;; Keeps any marks that may be present in column one (doing this
1012 ;; here is faster than with dired-add-entry's optional arg).
1013 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1021 ;; Replace space by old marker without moving point.
1022 ;; Faster than goto+insdel inside a save-excursion?
1026 ;;;###autoload
1033 ;; Add a new entry for FILENAME, optionally marking it
1034 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
1035 ;; Note that this adds the entry `out of order' if files sorted by
1036 ;; time, etc.
1037 ;; At least this version inserts in the right subdirectory (if present).
1038 ;; And it skips "." or ".." (see `dired-trivial-filenames').
1039 ;; Hidden subdirs are exposed if a file is added there.
1041 ;; Entry is always for files, even if they happen to also be directories
1046 reason)
1051 reason
1058 ;; We are already where we should be, except when
1059 ;; point is before the subdir line or its total line.
1063 ;; else try to find correct place to insert
1068 ;; found - skip subdir and `total' line
1069 ;; and uninteresting files like . and ..
1070 ;; This better not moves into the next subdir!
1072 ;; not found
1077 ;; Don't expand `.'. Show just the file name within directory.
1083 ;; Put in desired marker char.
1088 ;; Compensate for a bug in ange-ftp.
1089 ;; It inserts the file's absolute name, rather than
1090 ;; the relative one. That may be hard to fix since it
1091 ;; is probably controlled by something in ftp.
1114 ;; return nil if all went well
1115 nil))
1121 ;; Return pos of first file line of DIR, skipping header and total
1122 ;; or wildcard lines.
1123 ;; Important: never moves into the next subdir.
1124 ;; DIR is assumed to be unhidden.
1125 ;; Will probably be redefined for VMS etc.
1134 ;;;###autoload
1147 ;;;###autoload
1149 "Create or update the line for FILE in all Dired buffers it would belong in."
1155 ;; Relist the line for FILE, or just add it if it did not exist.
1156 ;; FILE must be an absolute file name.
1158 ;; If cursor is already on FILE's line delete-region will cause
1159 ;; save-excursion to fail because of floating makers,
1160 ;; moving point to beginning of line. Sigh.
1169 \f
1170 ;;; Copy, move/rename, making hard and symbolic links
1173 "*Non-nil if Dired should ask about making backups before overwriting files.
1174 Special value `always' suppresses confirmation."
1183 ;; Save old version of file TO that is to be overwritten.
1184 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1185 ;; from dired-create-files.
1188 dired-overwrite-confirmed
1192 "Make backup for existing file `%s'? "
1193 to)))
1198 ;;;###autoload
1202 dired-recursive-copies))
1207 preserve-time top recursive)
1209 dirfailed)
1214 ;; This is a directory.
1221 dired-create-files-failures)
1224 nil))))
1235 dired-create-files-failures)
1241 ;; Catch errors copying within a directory,
1242 ;; and report them through the dired log mechanism
1243 ;; just as our caller will do for the top level files.
1246 thisfrom thisto
1247 ok-flag preserve-time nil recursive)
1250 dired-create-files-failures)
1254 ;; Not a directory.
1258 ;; It is a symlink
1263 dired-create-files-failures)
1266 ;;;###autoload
1270 ;; Silently rename the visited file of any buffer visiting this file.
1275 ;; See if it's an inserted subdir, and rename that, too.
1283 ;; Update visited file name of all affected buffers
1294 to-dir
1295 buffer-file-name)))
1301 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1302 ;; one of its subdirectories is expanded in this buffer.
1310 ;; ELT's subdir is affected by the rename
1313 ;; if top level directory was renamed, lots of things have to be
1314 ;; updated:
1319 ;; with and without wildcards
1321 to))
1324 ;; try to rename buffer, but just leave old name if new
1325 ;; name would already exist (don't try appending "<%d>")
1328 ;; ... we dired TO now:
1332 ;; Update the headerline and dired-subdir-alist element, as well as
1333 ;; dired-switches-alist element, of directory described by
1334 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1335 ;; describes either DIR itself or a subdir of DIR.
1339 buffer-read-only)
1341 ;; Update subdir headerline in buffer
1344 dir)
1349 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1355 \f
1356 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1360 ;; Create a new file for each from a list of existing files. The user
1361 ;; is queried, dired buffers are updated, and at the end a success or
1362 ;; failure message is displayed
1364 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1366 ;; It is called for each file and must create newfile, the entry of
1367 ;; which will be added. The user will be queried if the file already
1368 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1369 ;; rename), it is FILE-CREATOR's responsibility to update dired
1370 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1371 ;; could not create newfile. The error is caught and logged.
1373 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1374 ;; operation performed. It is used for error logging.
1376 ;; FN-LIST is the list of files to copy (full absolute file names).
1378 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1379 ;; skip. If it skips files for other reasons than a direct user
1380 ;; query, it is supposed to tell why (using dired-log).
1382 ;; Optional MARKER-CHAR is a character with which to mark every
1383 ;; newfile's entry, or t to use the current marker character if the
1384 ;; oldfile was marked.
1405 Type SPC or `y' to overwrite file `%s',
1406 DEL or `n' to skip to next,
1407 ESC or `q' to not overwrite any of the remaining files,
1411 ;; must determine if FROM is marked before file-creator
1412 ;; gets a chance to delete it (in case of a move).
1421 ;; If we get here, file-creator hasn't been aborted
1422 ;; and the old entry (if any) has to be deleted
1423 ;; before adding the new entry.
1431 failures)
1433 operation from to err))))))))
1434 fn-list))
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 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 is used to set the value of the into-dir variable
1477 which determines how to treat target.
1478 If into-dir is set to nil then target is not regarded as a directory,
1479 there must be exactly one marked file, else error.
1480 Else if into-dir is set to a list, then target is a generalized
1481 directory (e.g. some sort of archive). The first element of into-dir
1482 must be a function with at least four arguments:
1483 operation as OPERATION above.
1484 rfn-list a list of the relative names for the marked files.
1485 fn-list a list of the absolute names for the marked files.
1486 target.
1487 The rest of into-dir are optional arguments.
1488 Else into-dir is not a list. Target is a directory.
1489 The marked file(s) are created inside the target directory.
1491 If HOW-TO is not given (or nil), then into-dir is set to true if
1492 target is a directory and otherwise to nil.
1493 Else if HOW-TO is t, then into-dir is set to nil.
1494 Else HOW-TO is assumed to be a function of one argument, target,
1495 that looks at target and returns a value for the into-dir
1496 variable. The function `dired-into-dir-with-symlinks' is provided
1497 for the case (common when creating symlinks) that symbolic
1498 links to directories are not to be considered as directories
1499 (as `file-directory-p' would if HOW-TO had been nil)."
1508 target-dir)))
1512 target-dir op-symbol arg rfn-list default)))
1514 ;; Allow DOS/Windows users to change the letter
1515 ;; case of a directory. If we don't test these
1516 ;; conditions up front, file-directory-p below
1517 ;; will return t because the filesystem is
1518 ;; case-insensitive, and Emacs will try to move
1519 ;; foo -> foo/foo, which fails.
1522 dired-one-file
1530 nil
1538 ;; rename-file bombs when moving directories unless we do this:
1541 file-creator operation fn-list
1543 ;; This function uses fluid variable target when called
1544 ;; inside dired-create-files:
1549 marker-char))))
1551 ;; Read arguments for a marked-files command that wants a file name,
1552 ;; perhaps popping up the list of marked files.
1553 ;; ARG is the prefix arg and indicates whether the files came from
1554 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1555 ;; If the current file was used, the list has but one element and ARG
1556 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1557 ;; DEFAULT is the default value to return if the user just hits RET;
1558 ;; if it is omitted or nil, then the name of the directory is used.
1563 nil op-symbol files
1568 ;; Try to guess which target directory the user may want.
1569 ;; If there is a dired buffer displayed in the next window, use
1570 ;; its current subdir, else use current subdir of this dired buffer.
1573 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1581 this-dir)))
1582 \f
1583 ;;;###autoload
1585 "Create a directory called DIRECTORY."
1590 ;; Find the topmost nonexistent parent dir (variable `new')
1602 ;; This may not always be what you want, especially if target is your
1603 ;; home directory and it happens to be a symbolic link, as is often the
1604 ;; case with NFS and automounters. Or if you want to make symlinks
1605 ;; into directories that themselves are only symlinks, also quite
1606 ;; common.
1608 ;; So we don't use this function as value for HOW-TO in
1609 ;; dired-do-symlink, which has the minor disadvantage of
1610 ;; making links *into* a symlinked-dir, when you really wanted to
1611 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1612 ;; just have to remove that symlink by hand before making your marked
1613 ;; symlinks.
1616 "nil or a function used by `dired-do-copy' to determine target.
1619 ;;;###autoload
1621 "Copy all marked (or next ARG) files, or copy the current file.
1622 This normally preserves the last-modified date when copying.
1623 When operating on just the current file, you specify the new name.
1624 When operating on multiple or marked files, you specify a directory,
1625 and new copies of these files are made in that directory
1626 with the same names that the files currently have. The default
1627 suggested for the target directory depends on the value of
1628 `dired-dwim-target', which see.
1630 This command copies symbolic links by creating new ones,
1631 like `cp -d'."
1635 "Copy"
1636 arg dired-keep-marker-copy
1637 nil dired-copy-how-to-fn)))
1639 ;;;###autoload
1641 "Make symbolic links to current file or all marked (or next ARG) files.
1642 When operating on just the current file, you specify the new name.
1643 When operating on multiple or marked files, you specify a directory
1644 and new symbolic links are made in that directory
1645 with the same names that the files currently have. The default
1646 suggested for the target directory depends on the value of
1647 `dired-dwim-target', which see.
1654 ;;;###autoload
1656 "Add names (hard links) current file or all marked (or next ARG) files.
1657 When operating on just the current file, you specify the new name.
1658 When operating on multiple or marked files, you specify a directory
1659 and new hard links are made in that directory
1660 with the same names that the files currently have. The default
1661 suggested for the target directory depends on the value of
1662 `dired-dwim-target', which see."
1669 ;; error is caught in -create-files
1671 ;; Update the link count
1674 ;;;###autoload
1676 "Rename current file or all marked (or next ARG) files.
1677 When renaming just the current file, you specify the new name.
1678 When renaming multiple or marked files, you specify a directory.
1679 This command also renames any buffers that are visiting the files.
1680 The default suggested for the target directory depends on the value
1681 of `dired-dwim-target', which see."
1685 ;;;###end dired-cp.el
1686 \f
1687 ;;; 5K
1688 ;;;###begin dired-re.el
1691 ;; Create a new file for each marked file using regexps.
1692 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1693 ;; ARG as in dired-get-marked-files.
1694 ;; Matches each marked file against REGEXP and constructs the new
1695 ;; filename from NEWNAME (like in function replace-match).
1696 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1697 ;; instead of only the non-directory part of the file.
1698 ;; Optional arg MARKER-CHAR as in dired-create-files.
1703 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1704 `!' to %s all remaining matches with no more questions."
1708 ;; Function to construct new filename using REGEXP and NEWNAME:
1713 ;; must bind help-form directly around call to
1714 ;; dired-query
1718 operation-prompt
1719 from
1720 to)
1721 to)
1723 operation from regexp)))))
1724 ;; not whole-name, replace non-directory part only
1735 operation-prompt
1738 to)
1741 rename-regexp-query)
1743 file-creator operation fn-list regexp-name-constructor marker-char)))
1746 ;; Prompt user about performing OPERATION.
1747 ;; Read and return list of: regexp newname arg whole-name.
1760 ;;;###autoload
1762 "Rename selected files whose names match REGEXP to NEWNAME.
1764 With non-zero prefix argument ARG, the command operates on the next ARG
1765 files. Otherwise, it operates on all the marked files, or the current
1766 file if none are marked.
1768 As each match is found, the user must type a character saying
1771 REGEXP defaults to the last regexp used.
1773 With a zero prefix arg, renaming by regexp affects the absolute file name.
1774 Normally, only the non-directory part of the file name is used and changed."
1780 ;;;###autoload
1782 "Copy selected files whose names match REGEXP to NEWNAME.
1783 See function `dired-do-rename-regexp' for more info."
1789 arg regexp newname whole-name dired-keep-marker-copy)))
1791 ;;;###autoload
1793 "Hardlink selected files whose names match REGEXP to NEWNAME.
1794 See function `dired-do-rename-regexp' for more info."
1800 ;;;###autoload
1802 "Symlink selected files whose names match REGEXP to NEWNAME.
1803 See function `dired-do-rename-regexp' for more info."
1811 ;; Perform FILE-CREATOR on the non-directory part of marked files
1812 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1813 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1816 file-creator
1817 operation
1825 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1826 `!' to %s all remaining matches with no more questions."
1833 to))))
1834 dired-keep-marker-rename)))
1839 basename-constructor operation arg))
1841 ;;;###autoload
1843 "Rename all marked (or next ARG) files to upper case."
1847 ;;;###autoload
1849 "Rename all marked (or next ARG) files to lower case."
1853 ;;;###end dired-re.el
1854 \f
1855 ;;; 13K
1856 ;;;###begin dired-ins.el
1858 ;;;###autoload
1860 switches no-error-if-not-dir-p)
1861 "Insert this subdirectory into the same dired buffer.
1863 else inserts it at its natural place (as `ls -lR' would have done).
1864 With a prefix arg, you may edit the ls switches used for this listing.
1865 You can add `R' to the switches to expand the whole tree starting at
1866 this subdirectory.
1867 This function takes some pains to conform to `ls -lR' output.
1869 Dired remembers switches specified with a prefix arg, so that reverting
1870 the buffer will not reset them. However, using `dired-undo' to re-insert
1871 or delete subdirectories can bypass this machinery. Hence, you sometimes
1872 may have to reset some subdirectory switches after a `dired-undo'.
1873 You can reset all subdirectory switches to the default using
1875 See Info node `(emacs)Subdir switches' for more details."
1882 ;; We don't need a marker for opoint as the subdir is always
1883 ;; inserted *after* opoint.
1888 ;; Push mark so that it's easy to find back. Do this after the
1889 ;; insert message so that the user sees the `Mark set' message.
1892 ;;;###autoload
1894 "Insert this subdirectory into the same dired buffer.
1895 If it is already present, overwrites previous entry,
1896 else inserts it at its natural place (as `ls -lR' would have done).
1897 With a prefix arg, you may edit the `ls' switches used for this listing.
1898 You can add `R' to the switches to expand the whole tree starting at
1899 this subdirectory.
1900 This function takes some pains to conform to `ls -lR' output."
1901 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1902 ;; Prospero where dired-ls does the right thing, but
1903 ;; file-directory-p has not been redefined.
1917 switches-have-R mark-alist case-fold-search buffer-read-only)
1920 ;; case-fold-search is nil now, so we can test for capital `R':
1922 ;; avoid duplicated subdirs
1925 ;; If subdir is already present, remove it and remember its marks
1948 ;; This is a separate function for dired-vms.
1950 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1951 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1964 ;; all switches that make a difference to dired-get-filename:
1968 ;; Add new DIR at NEW-MARKER. Sort alist.
1973 ;; Keep the alist sorted on buffer position.
1981 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1982 Interactively, you can kill DIRNAME as well by using a prefix argument.
1983 In interactive use, the command prompts for DIRNAME.
1985 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1986 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1997 m-alist))
2000 ;; Find pos for new subdir, according to tree order.
2001 ;;(goto-char (point-max))
2009 ;; Insert NEW-DIR after DIR
2011 alist nil)))
2013 ;; want a separating newline between subdirs
2020 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2021 ;; Move to that buffer position. Return a mark-alist.
2024 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2033 ;; Insert ls output after point.
2034 ;; Return the boundary of the inserted text (as list of BEG and END).
2039 dired-subdir-switches
2042 ;; If doing the top level directory of the buffer,
2043 ;; redo it as specified in dired-directory.
2049 ;; Point is at the correct subdir alist position for ELT,
2050 ;; BEG-END is the subdir-region (as list of begin and end).
2052 ;; update its position (should actually be unchanged)
2055 ;; The hook may depend on the subdir-alist containing the just
2056 ;; inserted subdir, so run it after dired-alist-add:
2064 ;; hook may add or delete lines, but the subdir boundary
2065 ;; marker floats
2069 ;; Lexicographic order on file name components, like `ls -lR':
2070 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2071 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2072 ;; or DIR1 and DIR2 are in the same parentdir and their last
2073 ;; components are string-lessp.
2074 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2075 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2076 ;; if dired-actual-switches contained `t'.
2082 components-2
2094 t)
2096 nil)
2099 ;; There should be a builtin split function - inverse to mapconcat.
2101 "Splitting on regexp PAT, turn string STR into a list of substrings.
2102 Optional third arg LIMIT (>= 1) is a limit to the length of the
2103 resulting list.
2104 Thus, if SEP is a regexp that only matches itself,
2106 (mapconcat 'identity (dired-split SEP STRING) SEP)
2108 is always equal to STRING."
2121 start end)
2122 ))
2129 \f
2130 ;;; moving by subdirectories
2132 ;;;###autoload
2134 "Go to previous subdirectory, regardless of level.
2135 When called interactively and not on a subdir line, go to this subdir's line."
2136 ;;(interactive "p")
2140 ;; if on subdir start already, don't stay there!
2150 ;;;###autoload
2152 "Go to end of header line of DIR in this dired buffer.
2153 Return value of point on success, otherwise return nil.
2159 dired-subdir-alist ; table
2160 nil ; predicate
2161 t ; require-match
2168 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2169 ;; at either \r or \n after this function succeeds.
2172 \f
2173 ;;;###autoload
2175 "Mark all files except `.' and `..' in current subdirectory.
2176 If the Dired buffer shows multiple directories, this command
2177 marks the files listed in the subdirectory that point is in."
2182 ;;;###autoload
2184 "Remove all lines of current subdirectory.
2185 Lower levels are unaffected."
2186 ;; With optional REMEMBER-MARKS, return a mark-alist.
2193 buffer-read-only)
2207 ;; Remove DIR from the alist
2211 ;;;###autoload
2213 "Go up ARG levels in the dired tree."
2219 ;;(setq dir (expand-file-name dir))
2223 ;;;###autoload
2225 "Go down in the dired tree."
2239 \f
2240 ;;; hiding
2256 ;;;###autoload
2258 "Hide or unhide the current subdirectory and move to next directory.
2259 Optional prefix arg is a repeat factor.
2269 buffer-read-only)
2270 ;; keep header line visible, hide rest
2279 ;;;###autoload
2281 "Hide all subdirectories, leaving only their header lines.
2282 If there is already something hidden, make everything visible again.
2287 buffer-read-only)
2291 ;; unhide - bombs on \r in filenames
2293 ;; hide
2300 ;; we're somewhere on current dir's line
2308 ;;;###end dired-ins.el
2310 \f
2311 ;; Functions for searching in tags style among marked files.
2313 ;;;###autoload
2315 "Search through all marked files for a match for REGEXP.
2316 Stops when a match is found.
2321 ;;;###autoload
2323 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2324 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2335 buffer-read-only))
2342 \f
2343 ;;;###autoload
2345 "Print the type of FILE, according to the `file' command.
2346 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2347 true then the type of the file linked to by FILE is printed instead."
2359 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2360 ;;; dired-aux.el ends here