| blob | 11cf1e184d831802ff30350334069930f707d43e |
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, 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,
40 ;; and we call subroutines in it too.
44 "Variable where `dired-create-files' records failing file names.
45 Functions that operate recursively can store additional names
48 ;;; 15K
49 ;;;###begin dired-cmd.el
50 ;; Diffing and compressing
55 ;;;###autoload
57 "Compare file at point with file FILE using `diff'.
58 FILE defaults to the file at the mark. (That's the mark set by
60 The prompted-for file is the first file given to `diff'.
61 With prefix arg, prompt for second argument SWITCHES,
62 which is options for `diff'."
75 current
82 default t)
86 diff-switches
90 ;;;###autoload
92 "Diff this file with its backup file or vice versa.
93 Uses the latest backup, if there are several numerical backups.
94 If this file is a backup, diff it with its original.
95 The backup file is the first file given to `diff'.
96 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
101 diff-switches
103 nil))
106 ;;;###autoload
108 "Mark files with different file attributes in two dired buffers.
109 Compare file attributes of files in the current directory
110 with file attributes in directory DIR2 using PREDICATE on pairs of files
111 with the same name. Mark files for which PREDICATE returns non-nil.
112 Mark files with different names if PREDICATE is nil (or interactively
113 with empty input at the predicate prompt).
115 PREDICATE is a Lisp expression that can refer to the following variables:
117 size1, size2 - file size in bytes
118 mtime1, mtime2 - last modification time in seconds, as a float
119 fa1, fa2 - list of file attributes
120 returned by function `file-attributes'
122 where 1 refers to attribute of file in the current dired buffer
123 and 2 to attribute of file in second dired buffer.
125 Examples of PREDICATE:
127 (> mtime1 mtime2) - mark newer files
128 (not (= size1 size2)) - mark files with different sizes
129 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
130 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
131 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
141 file-list1 file-list2)
147 'cadr
149 file-alist1 file-alist2
150 predicate))
152 'cadr
154 file-alist2 file-alist1
155 predicate)))
157 dir1 nil
162 dir2 nil
171 "Combine LIST1 and LIST2 using a set-difference operation.
172 The result list contains all file items that appear in LIST1 but not LIST2.
173 This is a non-destructive function; it makes a copy of the data if necessary
174 to avoid corrupting the original LIST1 and LIST2.
175 PREDICATE (see `dired-compare-directories') is an additional match
176 condition. Two file items are considered to match if they are equal
177 *and* PREDICATE evaluates to t."
179 list1
195 list)
200 "Return a list of all file names and attributes from DIR.
201 List has a form of (file-name full-file-name (attribute-list))"
206 full-file-name
209 \f
212 "Create initial input value for `touch' command."
223 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
224 ;; refresh their file lines.
225 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
226 ;; PROGRAM is the program used to change the attribute.
227 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
228 ;; ARG describes which files to use, as in dired-get-marked-files.
234 op-symbol arg files))
236 failures)
247 files))
252 nil))))
254 ;;;###autoload
256 "Change the mode of the marked (or next ARG) files.
257 Symbolic modes like `g+w' are allowed."
261 "Change mode of %s to: " nil
267 file
272 ;;;###autoload
274 "Change the group of the marked (or next ARG) files."
280 ;;;###autoload
282 "Change the owner of the marked (or next ARG) files."
288 ;;;###autoload
290 "Change the timestamp of the marked (or next ARG) files.
291 This calls touch."
295 ;; Process all the files in FILES in batches of a convenient size,
296 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
297 ;; Batches are chosen to need less than MAX chars for the file names,
298 ;; allowing 3 extra characters of separator per file name.
301 past
303 failures)
304 ;; Accumulate files as long as they fit in MAX chars,
305 ;; then process the ones accumulated so far.
310 ;; If we have at least 1 pending file
311 ;; and this file won't fit in the length limit, process now.
314 ;; The elements of PENDING are now in forward order.
315 ;; Do the operation and record failures.
317 failures)
318 ;; Transfer the elemens of PENDING onto PAST
319 ;; and clear it out. Now PAST contains the first N files
320 ;; specified (for some N), and FILES contains the rest.
322 pending nil
324 ;; Do (setq pending (cons thisfile pending))
325 ;; but reuse the cons that was in `files'.
333 failures)
334 ;; Now the original list FILES has been put back as it was.
337 ;;;###autoload
339 "Print the marked (or next ARG) files.
340 Uses the shell command coming from variables `lpr-command' and
341 `lpr-switches' as default."
345 "Print %s with: "
350 lpr-switches))
355 ;; Read arguments for a marked-files command that wants a string
356 ;; that is not a file name,
357 ;; perhaps popping up the list of marked files.
358 ;; ARG is the prefix arg and indicates whether the files came from
359 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
360 ;; If the current file was used, the list has but one element and ARG
361 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
364 ;; PROMPT for a string, with INITIAL input.
365 ;; Other args are used to give user feedback and pop-up:
366 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
368 nil op-symbol files
371 \f
372 ;;; Cleaning a directory: flagging some backups for deletion.
376 ;;;###autoload
378 "Flag numerical backups for deletion.
379 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
380 Positive prefix arg KEEP overrides `dired-kept-versions';
381 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
384 with a prefix argument."
391 late-retention early-retention)
392 ;; Look at each file.
393 ;; If the file has numeric backup versions,
394 ;; put on dired-file-version-alist an element of the form
395 ;; (FILENAME . VERSION-NUMBER-LIST)
397 ;; Sort each VERSION-NUMBER-LIST,
398 ;; and remove the versions not to be deleted.
406 sorted-v-list)))
410 ;; Look at each file. If it is a numeric backup file,
411 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
415 ;;; Subroutines of dired-clean-directory.
418 ;; Perform FUN with point at the end of each non-directory line.
419 ;; FUN takes one argument, the absolute filename.
434 ;; Only do work if this file is not already in the alist.
436 nil
437 ;; If it looks like file FN has versions, return a list of the versions.
438 ;;That is a list of strings which are file names.
439 ;;The caller may want to flag some of these files for deletion.
444 base-versions
450 dired-file-version-alist)))))))
454 base-version-list)
464 \f
465 ;;; Shell commands
474 "Return a list of default commands for `dired-read-shell-command'."
479 ;; All unique MIME types from file extensions
483 files)))
485 ;; All MIME info lists
488 all-mime-type)))
490 ;; Intersection of mime-infos from different mime-types;
491 ;; or just the first MIME info for a single MIME type
498 mi1))
502 ;; Command strings from `viewer' field of the MIME info
507 ;; Replace mailcap's `%s' placeholder
508 ;; with dired's `?' placeholder
511 ;; Remove the final filename placeholder
513 nil t))))
514 common-mime-info))))
515 commands))
518 ;; "Read a dired shell command prompting with PROMPT (using read-string).
519 ;;ARG is the prefix arg and may be used to indicate in the prompt which
520 ;; files are affected.
521 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
523 nil 'shell files
526 nil 'shell-command-history
529 ;; The in-background argument is only needed in Emacs 18 where
530 ;; shell-command doesn't understand an appended ampersand `&'.
531 ;;;###autoload
533 "Run a shell command COMMAND on the marked files.
534 If no files are marked or a specific numeric prefix arg is given,
536 The prompt mentions the file(s) or the marker, as appropriate.
538 If there is a `*' in COMMAND, surrounded by whitespace, this runs
539 COMMAND just once with the entire file list substituted there.
541 If there is no `*', but there is a `?' in COMMAND, surrounded by
542 whitespace, this runs COMMAND on each file individually with the
543 file name substituted for `?'.
545 Otherwise, this runs COMMAND on each file individually with the
546 file name added at the end of COMMAND (separated by a space).
548 `*' and `?' when not surrounded by whitespace have no special
549 significance for `dired-do-shell-command', and are passed through
550 normally to the shell, but you must confirm first. To pass `*' by
553 If COMMAND produces output, it goes to a separate buffer.
555 This feature does not try to redisplay Dired buffers afterward, as
556 there's no telling what files COMMAND may have changed.
559 When COMMAND runs, its working directory is the top-level directory of
560 the Dired buffer, so output files usually are created there instead of
561 in a subdir.
563 In a noninteractive call (from Lisp code), you must specify
564 the list of file names explicitly with the FILE-LIST argument, which
565 can be produced by `dired-get-marked-files', for example."
566 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
567 ;;actual work and can be redefined for customization.
571 ;; Want to give feedback whether this file or marked files are used:
574 current-prefix-arg
575 files)
576 current-prefix-arg
577 files)))
582 ;; Get confirmation for wildcards that may have been meant
583 ;; to control substitution of a file name or the file name list.
597 nil
598 file-list)
599 ;; execute the shell command
603 ;; Might use {,} for bash or csh:
612 ;; "Make up a shell command line from COMMAND and FILE-LIST.
613 ;; If ON-EACH is t, COMMAND should be applied to each file, else
614 ;; simply concat all files and apply COMMAND to this.
615 ;; FILE-LIST's elements will be quoted for the shell."
616 ;; Might be redefined for smarter things and could then use RAW-ARG
617 ;; (coming from interactive P and currently ignored) to decide what to do.
618 ;; Smart would be a way to access basename or extension of file names.
627 retval))
632 file-list dired-mark-separator)))
637 ;; This is an extra function so that it can be redefined by ange-ftp.
638 ;;;###autoload
645 ;; Return nil for sake of nconc in dired-bunch-files.
646 nil)
647 \f
650 ; "Display MSG while running PROGRAM, and check for output.
651 ;Remaining arguments are strings passed as command arguments to PROGRAM.
652 ; On error, insert output
653 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
654 ; Caller can cons up a list of failed args.
655 ;Else returns nil for success."
659 ;; Get a clean buffer for error output:
672 nil))))
673 \f
674 ;; Commands that delete or redisplay part of the dired buffer.
695 ;;;###autoload
697 "Kill all marked lines (not the files).
698 With a prefix argument, kill that many lines starting with the current line.
699 \(A negative argument kills backward.)
700 If you use this command with a prefix argument to kill the line
701 for a file that is a directory, which you have inserted in the
702 Dired buffer as a subdirectory, then it deletes that subdirectory
703 from the buffer as well.
704 To kill an entire subdirectory \(without killing its line in the
705 parent directory), go to its directory header line and use this
706 command with a prefix argument (the value does not matter)."
707 ;; Returns count of killed lines. FMT="" suppresses message.
725 count))))
727 ;;;###end dired-cmd.el
728 \f
729 ;;; 30K
730 ;;;###begin dired-cp.el
733 ;; Compress or uncompress the current file.
734 ;; Return nil for success, offending filename else.
740 ;; Remove any preexisting entry for the name NEW-FILE.
745 ;; Now replace the current line with an entry for NEW-FILE.
748 from-file)))
754 ;; For .z, try gunzip. It might be an old gzip file,
755 ;; or it might be from compact? pack? (which?) but gunzip handles both.
760 ;; This item controls naming for compression.
762 "Control changes in file name suffixes for compression and uncompression.
763 Each element specifies one transformation rule, and has the form:
764 (REGEXP NEW-SUFFIX PROGRAM)
765 The rule applies when the old file name matches REGEXP.
766 The new file name is computed by deleting the part that matches REGEXP
767 (as well as anything after that), then adding NEW-SUFFIX in its place.
768 If PROGRAM is non-nil, the rule is an uncompression rule,
769 and uncompression is done by running PROGRAM.
772 ;;;###autoload
774 ;; Compress or uncompress FILE.
775 ;; Return the name of the compressed or uncompressed file.
776 ;; Return nil if no change in files.
778 suffix newname
780 ;; See if any suffix rule matches this file name.
786 ;; If so, compute desired new name.
793 nil)
795 ;; We found an uncompression rule.
798 newname))
800 ;;; We don't recognize the file as compressed, so compress it.
801 ;;; Try gzip; if we don't have that, use compress.
807 out-name)))
812 ;; Rename the compressed file to NEWNAME
813 ;; if it hasn't got that name already.
817 newname)
818 out-name)))
822 ;; Don't use NEWNAME with `compress'.
824 \f
826 ;; Request confirmation from the user that the operation described
827 ;; by OP-SYMBOL is to be performed on the marked files.
828 ;; Confirmation consists in a y-or-n question with a file list
829 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
830 ;; The files used are determined by ARG (as in dired-get-marked-files).
833 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
834 ;; is marked pops up a window. That will help the user see
835 ;; it isn't the current line file.
844 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
845 ; and display failures.
847 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
848 ; the short form of the filename) for a failure and probably logs a
849 ; detailed error explanation using function `dired-log'.
851 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
852 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
853 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
854 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
856 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
868 ;; end this bunch of errors:
872 failures)))))
879 ;; None of these keys quit - use C-g for that.
880 ))
882 ;;;###autoload
884 ;; Query user and return nil or t.
885 ;; Store answer in symbol VAR (which must initially be bound to nil).
886 ;; Format PROMPT with ARGS.
887 ;; Binding variable help-form will help the user who types the help key.
901 result elt)
902 ;; Actually it looks nicer without cursor-in-echo-area - you can
903 ;; look at the dired buffer instead of at the prompt to decide.
912 ;; Display the question with the answer.
916 \f
917 ;;;###autoload
919 "Compress or uncompress marked (or next ARG) files."
923 ;; Commands for Emacs Lisp files - load and byte compile
926 ;; Return nil for success, offending file name else.
928 elc-file buffer-read-only failure)
943 nil)))
945 ;;;###autoload
947 "Byte compile marked (or next ARG) Emacs Lisp files."
952 ;; Return nil for success, offending file name else.
958 nil
962 ;;;###autoload
964 "Load the marked (or next ARG) Emacs Lisp files."
968 ;;;###autoload
970 "Redisplay all marked (or next ARG) files.
971 If on a subdir line, redisplay that subdirectory. In that case,
972 a prefix arg lets you edit the `ls' switches used for the new listing.
974 Dired remembers switches specified with a prefix arg, so that reverting
975 the buffer will not reset them. However, using `dired-undo' to re-insert
976 or delete subdirectories can bypass this machinery. Hence, you sometimes
977 may have to reset some subdirectory switches after a `dired-undo'.
978 You can reset all subdirectory switches to the default using
980 See Info node `(emacs)Subdir switches' for more details."
981 ;; Moves point if the next ARG files are redisplayed.
987 dir
991 dired-subdir-switches
992 dired-actual-switches)))))
994 ;; message much faster than making dired-map-over-marks show progress
1000 arg)
1005 "Set `dired-switches-alist' to nil and revert dired buffer."
1009 \f
1011 ;; Delete the current line, and insert an entry for FILE.
1012 ;; If FILE is nil, then just delete the current line.
1013 ;; Keeps any marks that may be present in column one (doing this
1014 ;; here is faster than with dired-add-entry's optional arg).
1015 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1023 ;; Replace space by old marker without moving point.
1024 ;; Faster than goto+insdel inside a save-excursion?
1028 ;;;###autoload
1035 ;; Add a new entry for FILENAME, optionally marking it
1036 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
1037 ;; Note that this adds the entry `out of order' if files sorted by
1038 ;; time, etc.
1039 ;; At least this version inserts in the right subdirectory (if present).
1040 ;; And it skips "." or ".." (see `dired-trivial-filenames').
1041 ;; Hidden subdirs are exposed if a file is added there.
1043 ;; Entry is always for files, even if they happen to also be directories
1048 reason)
1053 reason
1060 ;; We are already where we should be, except when
1061 ;; point is before the subdir line or its total line.
1065 ;; else try to find correct place to insert
1070 ;; found - skip subdir and `total' line
1071 ;; and uninteresting files like . and ..
1072 ;; This better not moves into the next subdir!
1074 ;; not found
1079 ;; Don't expand `.'. Show just the file name within directory.
1085 ;; Put in desired marker char.
1090 ;; Compensate for a bug in ange-ftp.
1091 ;; It inserts the file's absolute name, rather than
1092 ;; the relative one. That may be hard to fix since it
1093 ;; is probably controlled by something in ftp.
1116 ;; return nil if all went well
1117 nil))
1123 ;; Return pos of first file line of DIR, skipping header and total
1124 ;; or wildcard lines.
1125 ;; Important: never moves into the next subdir.
1126 ;; DIR is assumed to be unhidden.
1127 ;; Will probably be redefined for VMS etc.
1136 ;;;###autoload
1149 ;;;###autoload
1151 "Create or update the line for FILE in all Dired buffers it would belong in."
1157 ;; Relist the line for FILE, or just add it if it did not exist.
1158 ;; FILE must be an absolute file name.
1160 ;; If cursor is already on FILE's line delete-region will cause
1161 ;; save-excursion to fail because of floating makers,
1162 ;; moving point to beginning of line. Sigh.
1171 \f
1172 ;;; Copy, move/rename, making hard and symbolic links
1175 "*Non-nil if Dired should ask about making backups before overwriting files.
1176 Special value `always' suppresses confirmation."
1185 ;; Save old version of file TO that is to be overwritten.
1186 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1187 ;; from dired-create-files.
1190 dired-overwrite-confirmed
1194 "Make backup for existing file `%s'? "
1195 to)))
1200 ;;;###autoload
1204 dired-recursive-copies))
1209 preserve-time top recursive)
1211 dirfailed)
1216 ;; This is a directory.
1223 dired-create-files-failures)
1226 nil))))
1237 dired-create-files-failures)
1243 ;; Catch errors copying within a directory,
1244 ;; and report them through the dired log mechanism
1245 ;; just as our caller will do for the top level files.
1248 thisfrom thisto
1249 ok-flag preserve-time nil recursive)
1252 dired-create-files-failures)
1256 ;; Not a directory.
1260 ;; It is a symlink
1265 dired-create-files-failures)
1268 ;;;###autoload
1272 ;; Silently rename the visited file of any buffer visiting this file.
1277 ;; See if it's an inserted subdir, and rename that, too.
1285 ;; Update visited file name of all affected buffers
1296 to-dir
1297 buffer-file-name)))
1303 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1304 ;; one of its subdirectories is expanded in this buffer.
1312 ;; ELT's subdir is affected by the rename
1315 ;; if top level directory was renamed, lots of things have to be
1316 ;; updated:
1321 ;; with and without wildcards
1323 to))
1326 ;; try to rename buffer, but just leave old name if new
1327 ;; name would already exist (don't try appending "<%d>")
1330 ;; ... we dired TO now:
1334 ;; Update the headerline and dired-subdir-alist element, as well as
1335 ;; dired-switches-alist element, of directory described by
1336 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1337 ;; describes either DIR itself or a subdir of DIR.
1341 buffer-read-only)
1343 ;; Update subdir headerline in buffer
1346 dir)
1351 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1357 \f
1358 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1362 ;; Create a new file for each from a list of existing files. The user
1363 ;; is queried, dired buffers are updated, and at the end a success or
1364 ;; failure message is displayed
1366 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1368 ;; It is called for each file and must create newfile, the entry of
1369 ;; which will be added. The user will be queried if the file already
1370 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1371 ;; rename), it is FILE-CREATOR's responsibility to update dired
1372 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1373 ;; could not create newfile. The error is caught and logged.
1375 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1376 ;; operation performed. It is used for error logging.
1378 ;; FN-LIST is the list of files to copy (full absolute file names).
1380 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1381 ;; skip. If it skips files for other reasons than a direct user
1382 ;; query, it is supposed to tell why (using dired-log).
1384 ;; Optional MARKER-CHAR is a character with which to mark every
1385 ;; newfile's entry, or t to use the current marker character if the
1386 ;; oldfile was marked.
1407 Type SPC or `y' to overwrite file `%s',
1408 DEL or `n' to skip to next,
1409 ESC or `q' to not overwrite any of the remaining files,
1413 ;; must determine if FROM is marked before file-creator
1414 ;; gets a chance to delete it (in case of a move).
1423 ;; If we get here, file-creator hasn't been aborted
1424 ;; and the old entry (if any) has to be deleted
1425 ;; before adding the new entry.
1433 failures)
1435 operation from to err))))))))
1436 fn-list))
1444 total)
1445 failures))
1451 failures))
1457 skipped))
1462 \f
1464 &optional marker-char op1
1465 how-to)
1466 "Create a new file for each marked file.
1467 Prompts user for target, which is a directory in which to create
1468 the new files. Target may be a plain file if only one marked
1469 file exists. The way the default for the target directory is
1470 computed depends on the value of `dired-dwim-target-directory'.
1471 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1472 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1473 FILE-CREATOR and OPERATION as in `dired-create-files'.
1474 ARG as in `dired-get-marked-files'.
1475 Optional arg MARKER-CHAR as in `dired-create-files'.
1476 Optional arg OP1 is an alternate form for OPERATION if there is
1477 only one file.
1478 Optional arg HOW-TO is used to set the value of the into-dir variable
1479 which determines how to treat target.
1480 If into-dir is set to nil then target is not regarded as a directory,
1481 there must be exactly one marked file, else error.
1482 Else if into-dir is set to a list, then target is a generalized
1483 directory (e.g. some sort of archive). The first element of into-dir
1484 must be a function with at least four arguments:
1485 operation as OPERATION above.
1486 rfn-list a list of the relative names for the marked files.
1487 fn-list a list of the absolute names for the marked files.
1488 target.
1489 The rest of into-dir are optional arguments.
1490 Else into-dir is not a list. Target is a directory.
1491 The marked file(s) are created inside the target directory.
1493 If HOW-TO is not given (or nil), then into-dir is set to true if
1494 target is a directory and otherwise to nil.
1495 Else if HOW-TO is t, then into-dir is set to nil.
1496 Else HOW-TO is assumed to be a function of one argument, target,
1497 that looks at target and returns a value for the into-dir
1498 variable. The function `dired-into-dir-with-symlinks' is provided
1499 for the case (common when creating symlinks) that symbolic
1500 links to directories are not to be considered as directories
1501 (as `file-directory-p' would if HOW-TO had been nil)."
1510 target-dir)))
1514 target-dir op-symbol arg rfn-list default)))
1516 ;; Allow DOS/Windows users to change the letter
1517 ;; case of a directory. If we don't test these
1518 ;; conditions up front, file-directory-p below
1519 ;; will return t because the filesystem is
1520 ;; case-insensitive, and Emacs will try to move
1521 ;; foo -> foo/foo, which fails.
1524 dired-one-file
1532 nil
1540 ;; rename-file bombs when moving directories unless we do this:
1543 file-creator operation fn-list
1545 ;; This function uses fluid variable target when called
1546 ;; inside dired-create-files:
1551 marker-char))))
1553 ;; Read arguments for a marked-files command that wants a file name,
1554 ;; perhaps popping up the list of marked files.
1555 ;; ARG is the prefix arg and indicates whether the files came from
1556 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1557 ;; If the current file was used, the list has but one element and ARG
1558 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1559 ;; DEFAULT is the default value to return if the user just hits RET;
1560 ;; if it is omitted or nil, then the name of the directory is used.
1565 nil op-symbol files
1570 ;; Try to guess which target directory the user may want.
1571 ;; If there is a dired buffer displayed in the next window, use
1572 ;; its current subdir, else use current subdir of this dired buffer.
1575 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1583 this-dir)))
1584 \f
1585 ;;;###autoload
1587 "Create a directory called DIRECTORY."
1592 ;; Find the topmost nonexistent parent dir (variable `new')
1604 ;; This may not always be what you want, especially if target is your
1605 ;; home directory and it happens to be a symbolic link, as is often the
1606 ;; case with NFS and automounters. Or if you want to make symlinks
1607 ;; into directories that themselves are only symlinks, also quite
1608 ;; common.
1610 ;; So we don't use this function as value for HOW-TO in
1611 ;; dired-do-symlink, which has the minor disadvantage of
1612 ;; making links *into* a symlinked-dir, when you really wanted to
1613 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1614 ;; just have to remove that symlink by hand before making your marked
1615 ;; symlinks.
1618 "nil or a function used by `dired-do-copy' to determine target.
1621 ;;;###autoload
1623 "Copy all marked (or next ARG) files, or copy the current file.
1624 This normally preserves the last-modified date when copying.
1625 When operating on just the current file, you specify the new name.
1626 When operating on multiple or marked files, you specify a directory,
1627 and new copies of these files are made in that directory
1628 with the same names that the files currently have. The default
1629 suggested for the target directory depends on the value of
1630 `dired-dwim-target', which see.
1632 This command copies symbolic links by creating new ones,
1633 like `cp -d'."
1637 "Copy"
1638 arg dired-keep-marker-copy
1639 nil dired-copy-how-to-fn)))
1641 ;;;###autoload
1643 "Make symbolic links to current file or all marked (or next ARG) files.
1644 When operating on just the current file, you specify the new name.
1645 When operating on multiple or marked files, you specify a directory
1646 and new symbolic links are made in that directory
1647 with the same names that the files currently have. The default
1648 suggested for the target directory depends on the value of
1649 `dired-dwim-target', which see.
1656 ;;;###autoload
1658 "Add names (hard links) current file or all marked (or next ARG) files.
1659 When operating on just the current file, you specify the new name.
1660 When operating on multiple or marked files, you specify a directory
1661 and new hard links are made in that directory
1662 with the same names that the files currently have. The default
1663 suggested for the target directory depends on the value of
1664 `dired-dwim-target', which see."
1671 ;; error is caught in -create-files
1673 ;; Update the link count
1676 ;;;###autoload
1678 "Rename current file or all marked (or next ARG) files.
1679 When renaming just the current file, you specify the new name.
1680 When renaming multiple or marked files, you specify a directory.
1681 This command also renames any buffers that are visiting the files.
1682 The default suggested for the target directory depends on the value
1683 of `dired-dwim-target', which see."
1687 ;;;###end dired-cp.el
1688 \f
1689 ;;; 5K
1690 ;;;###begin dired-re.el
1693 ;; Create a new file for each marked file using regexps.
1694 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1695 ;; ARG as in dired-get-marked-files.
1696 ;; Matches each marked file against REGEXP and constructs the new
1697 ;; filename from NEWNAME (like in function replace-match).
1698 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1699 ;; instead of only the non-directory part of the file.
1700 ;; Optional arg MARKER-CHAR as in dired-create-files.
1705 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1706 `!' to %s all remaining matches with no more questions."
1710 ;; Function to construct new filename using REGEXP and NEWNAME:
1715 ;; must bind help-form directly around call to
1716 ;; dired-query
1720 operation-prompt
1721 from
1722 to)
1723 to)
1725 operation from regexp)))))
1726 ;; not whole-name, replace non-directory part only
1737 operation-prompt
1740 to)
1743 rename-regexp-query)
1745 file-creator operation fn-list regexp-name-constructor marker-char)))
1748 ;; Prompt user about performing OPERATION.
1749 ;; Read and return list of: regexp newname arg whole-name.
1762 ;;;###autoload
1764 "Rename selected files whose names match REGEXP to NEWNAME.
1766 With non-zero prefix argument ARG, the command operates on the next ARG
1767 files. Otherwise, it operates on all the marked files, or the current
1768 file if none are marked.
1770 As each match is found, the user must type a character saying
1773 REGEXP defaults to the last regexp used.
1775 With a zero prefix arg, renaming by regexp affects the absolute file name.
1776 Normally, only the non-directory part of the file name is used and changed."
1782 ;;;###autoload
1784 "Copy selected files whose names match REGEXP to NEWNAME.
1785 See function `dired-do-rename-regexp' for more info."
1791 arg regexp newname whole-name dired-keep-marker-copy)))
1793 ;;;###autoload
1795 "Hardlink selected files whose names match REGEXP to NEWNAME.
1796 See function `dired-do-rename-regexp' for more info."
1802 ;;;###autoload
1804 "Symlink selected files whose names match REGEXP to NEWNAME.
1805 See function `dired-do-rename-regexp' for more info."
1813 ;; Perform FILE-CREATOR on the non-directory part of marked files
1814 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1815 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1818 file-creator
1819 operation
1827 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1828 `!' to %s all remaining matches with no more questions."
1835 to))))
1836 dired-keep-marker-rename)))
1841 basename-constructor operation arg))
1843 ;;;###autoload
1845 "Rename all marked (or next ARG) files to upper case."
1849 ;;;###autoload
1851 "Rename all marked (or next ARG) files to lower case."
1855 ;;;###end dired-re.el
1856 \f
1857 ;;; 13K
1858 ;;;###begin dired-ins.el
1860 ;;;###autoload
1862 switches no-error-if-not-dir-p)
1863 "Insert this subdirectory into the same dired buffer.
1865 else inserts it at its natural place (as `ls -lR' would have done).
1866 With a prefix arg, you may edit the ls switches used for this listing.
1867 You can add `R' to the switches to expand the whole tree starting at
1868 this subdirectory.
1869 This function takes some pains to conform to `ls -lR' output.
1871 Dired remembers switches specified with a prefix arg, so that reverting
1872 the buffer will not reset them. However, using `dired-undo' to re-insert
1873 or delete subdirectories can bypass this machinery. Hence, you sometimes
1874 may have to reset some subdirectory switches after a `dired-undo'.
1875 You can reset all subdirectory switches to the default using
1877 See Info node `(emacs)Subdir switches' for more details."
1884 ;; We don't need a marker for opoint as the subdir is always
1885 ;; inserted *after* opoint.
1890 ;; Push mark so that it's easy to find back. Do this after the
1891 ;; insert message so that the user sees the `Mark set' message.
1894 ;;;###autoload
1896 "Insert this subdirectory into the same dired buffer.
1897 If it is already present, overwrites previous entry,
1898 else inserts it at its natural place (as `ls -lR' would have done).
1899 With a prefix arg, you may edit the `ls' switches used for this listing.
1900 You can add `R' to the switches to expand the whole tree starting at
1901 this subdirectory.
1902 This function takes some pains to conform to `ls -lR' output."
1903 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1904 ;; Prospero where dired-ls does the right thing, but
1905 ;; file-directory-p has not been redefined.
1919 switches-have-R mark-alist case-fold-search buffer-read-only)
1922 ;; case-fold-search is nil now, so we can test for capital `R':
1924 ;; avoid duplicated subdirs
1927 ;; If subdir is already present, remove it and remember its marks
1950 ;; This is a separate function for dired-vms.
1952 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1953 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1966 ;; all switches that make a difference to dired-get-filename:
1970 ;; Add new DIR at NEW-MARKER. Sort alist.
1975 ;; Keep the alist sorted on buffer position.
1983 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1984 Interactively, you can kill DIRNAME as well by using a prefix argument.
1985 In interactive use, the command prompts for DIRNAME.
1987 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1988 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1999 m-alist))
2002 ;; Find pos for new subdir, according to tree order.
2003 ;;(goto-char (point-max))
2011 ;; Insert NEW-DIR after DIR
2013 alist nil)))
2015 ;; want a separating newline between subdirs
2022 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2023 ;; Move to that buffer position. Return a mark-alist.
2026 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2035 ;; Insert ls output after point.
2036 ;; Return the boundary of the inserted text (as list of BEG and END).
2041 dired-subdir-switches
2044 ;; If doing the top level directory of the buffer,
2045 ;; redo it as specified in dired-directory.
2051 ;; Point is at the correct subdir alist position for ELT,
2052 ;; BEG-END is the subdir-region (as list of begin and end).
2054 ;; update its position (should actually be unchanged)
2057 ;; The hook may depend on the subdir-alist containing the just
2058 ;; inserted subdir, so run it after dired-alist-add:
2066 ;; hook may add or delete lines, but the subdir boundary
2067 ;; marker floats
2071 ;; Lexicographic order on file name components, like `ls -lR':
2072 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2073 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2074 ;; or DIR1 and DIR2 are in the same parentdir and their last
2075 ;; components are string-lessp.
2076 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2077 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2078 ;; if dired-actual-switches contained `t'.
2084 components-2
2096 t)
2098 nil)
2101 ;; There should be a builtin split function - inverse to mapconcat.
2103 "Splitting on regexp PAT, turn string STR into a list of substrings.
2104 Optional third arg LIMIT (>= 1) is a limit to the length of the
2105 resulting list.
2106 Thus, if SEP is a regexp that only matches itself,
2108 (mapconcat 'identity (dired-split SEP STRING) SEP)
2110 is always equal to STRING."
2123 start end)
2124 ))
2131 \f
2132 ;;; moving by subdirectories
2134 ;;;###autoload
2136 "Go to previous subdirectory, regardless of level.
2137 When called interactively and not on a subdir line, go to this subdir's line."
2138 ;;(interactive "p")
2142 ;; if on subdir start already, don't stay there!
2152 ;;;###autoload
2154 "Go to end of header line of DIR in this dired buffer.
2155 Return value of point on success, otherwise return nil.
2161 dired-subdir-alist ; table
2162 nil ; predicate
2163 t ; require-match
2170 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2171 ;; at either \r or \n after this function succeeds.
2174 \f
2175 ;;;###autoload
2177 "Mark all files except `.' and `..' in current subdirectory.
2178 If the Dired buffer shows multiple directories, this command
2179 marks the files listed in the subdirectory that point is in."
2184 ;;;###autoload
2186 "Remove all lines of current subdirectory.
2187 Lower levels are unaffected."
2188 ;; With optional REMEMBER-MARKS, return a mark-alist.
2195 buffer-read-only)
2209 ;; Remove DIR from the alist
2213 ;;;###autoload
2215 "Go up ARG levels in the dired tree."
2221 ;;(setq dir (expand-file-name dir))
2225 ;;;###autoload
2227 "Go down in the dired tree."
2241 \f
2242 ;;; hiding
2258 ;;;###autoload
2260 "Hide or unhide the current subdirectory and move to next directory.
2261 Optional prefix arg is a repeat factor.
2271 buffer-read-only)
2272 ;; keep header line visible, hide rest
2281 ;;;###autoload
2283 "Hide all subdirectories, leaving only their header lines.
2284 If there is already something hidden, make everything visible again.
2289 buffer-read-only)
2293 ;; unhide - bombs on \r in filenames
2295 ;; hide
2302 ;; we're somewhere on current dir's line
2310 ;;;###end dired-ins.el
2312 \f
2313 ;; Functions for searching in tags style among marked files.
2315 ;;;###autoload
2317 "Search through all marked files for a match for REGEXP.
2318 Stops when a match is found.
2323 ;;;###autoload
2325 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2326 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2337 buffer-read-only))
2344 \f
2345 ;;;###autoload
2347 "Print the type of FILE, according to the `file' command.
2348 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2349 true then the type of the file linked to by FILE is printed instead."
2361 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2362 ;;; dired-aux.el ends here