| blob | a67b11fb6a6b54cbcb86f2d39c79b3f66d669f0f |
1 ;;; dired-aux.el --- less commonly used parts of dired
3 ;; Copyright (C) 1985-1986, 1992, 1994, 1998, 2000-2015 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>.
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: files
9 ;; Package: emacs
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; The parts of dired mode not normally used. This is a space-saving hack
29 ;; to avoid having to load a large mode when all that's wanted are a few
30 ;; functions.
32 ;; Rewritten in 1990/1991 to add tree features, file marking and
33 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
34 ;; Finished up by rms in 1992.
36 ;;; Code:
38 ;; We need macros in dired.el to compile properly,
39 ;; and we call subroutines in it too.
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 If called interactively, prompt for FILE. If the file at point
58 has a backup file, use that as the default. If the file at point
59 is a backup file, use its original. If the mark is active
60 in Transient Mark mode, use the file at the mark as the default.
64 FILE is the first file given to `diff'. The file at point
65 is the second file given to `diff'.
67 With prefix arg, prompt for second argument SWITCHES, which is
68 the string of command switches for the third argument of `diff'."
71 ;; Get the latest existing backup file or its original.
75 ;; Get the file at the mark.
81 ;; Use it as default if it's not the same as the current file,
82 ;; and the target dir is current or there is a default file.
86 default-file))
87 default-file))
100 target-dir default t))
104 diff-switches
118 ;;;###autoload
120 "Diff this file with its backup file or vice versa.
121 Uses the latest backup, if there are several numerical backups.
122 If this file is a backup, diff it with its original.
123 The backup file is the first file given to `diff'.
124 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
129 diff-switches
131 nil))
134 ;;;###autoload
136 "Mark files with different file attributes in two dired buffers.
137 Compare file attributes of files in the current directory
138 with file attributes in directory DIR2 using PREDICATE on pairs of files
139 with the same name. Mark files for which PREDICATE returns non-nil.
140 Mark files with different names if PREDICATE is nil (or interactively
141 with empty input at the predicate prompt).
143 PREDICATE is a Lisp expression that can refer to the following variables:
145 size1, size2 - file size in bytes
146 mtime1, mtime2 - last modification time in seconds, as a float
147 fa1, fa2 - list of file attributes
148 returned by function `file-attributes'
150 where 1 refers to attribute of file in the current dired buffer
151 and 2 to attribute of file in second dired buffer.
153 Examples of PREDICATE:
155 (> mtime1 mtime2) - mark newer files
156 (not (= size1 size2)) - mark files with different sizes
157 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
158 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
159 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
170 target-dir target-dir t)))
175 file-list1 file-list2)
181 'cadr
183 file-alist1 file-alist2
184 predicate))
186 'cadr
188 file-alist2 file-alist1
189 predicate)))
191 dir1 nil
196 dir2 nil
205 "Combine LIST1 and LIST2 using a set-difference operation.
206 The result list contains all file items that appear in LIST1 but not LIST2.
207 This is a non-destructive function; it makes a copy of the data if necessary
208 to avoid corrupting the original LIST1 and LIST2.
209 PREDICATE (see `dired-compare-directories') is an additional match
210 condition. Two file items are considered to match if they are equal
211 *and* PREDICATE evaluates to t."
213 list1
232 )))))
234 list)
239 "Return a list of all file names and attributes from DIR.
240 List has a form of (file-name full-file-name (attribute-list))."
245 full-file-name
248 \f
249 ;;; Change file attributes
252 ;; Change file attributes (group, owner, timestamp) of marked files and
253 ;; refresh their file lines.
254 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
255 ;; PROGRAM is the program used to change the attribute.
256 ;; OP-SYMBOL is the type of operation (for use in `dired-mark-pop-up').
257 ;; ARG describes which files to use, as in `dired-get-marked-files'.
259 ;; The source of default file attributes is the file at point.
264 "%Y%m%d%H%M.%S"
272 " (default now): "
275 arg files default
281 failures)
288 ;; Use `eq' instead of `equal'
289 ;; to detect empty input (bug#12399).
296 files))
301 nil))))
303 ;;;###autoload
305 "Change the mode of the marked (or next ARG) files.
306 Symbolic modes like `g+w' are allowed.
307 Type M-n to pull the file attributes of the file at point
308 into the minibuffer."
311 ;; The source of default file attributes is the file at point.
325 "Change mode of %s to: "
327 num-modes)
329 ;; Use `eq' instead of `equal'
330 ;; to detect empty input (bug#12399).
332 ;; We used to treat empty input as DEFAULT, but that is not
333 ;; such a good idea (Bug#9361).
340 file
345 ;;;###autoload
347 "Change the group of the marked (or next ARG) files.
348 Type M-n to pull the file attributes of the file at point
349 into the minibuffer."
355 ;;;###autoload
357 "Change the owner of the marked (or next ARG) files.
358 Type M-n to pull the file attributes of the file at point
359 into the minibuffer."
365 ;;;###autoload
367 "Change the timestamp of the marked (or next ARG) files.
368 This calls touch.
369 Type M-n to pull the file attributes of the file at point
370 into the minibuffer."
374 ;; Process all the files in FILES in batches of a convenient size,
375 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
376 ;; Batches are chosen to need less than MAX chars for the file names,
377 ;; allowing 3 extra characters of separator per file name.
380 past
382 failures)
383 ;; Accumulate files as long as they fit in MAX chars,
384 ;; then process the ones accumulated so far.
389 ;; If we have at least 1 pending file
390 ;; and this file won't fit in the length limit, process now.
393 ;; The elements of PENDING are now in forward order.
394 ;; Do the operation and record failures.
396 failures)
397 ;; Transfer the elements of PENDING onto PAST
398 ;; and clear it out. Now PAST contains the first N files
399 ;; specified (for some N), and FILES contains the rest.
401 pending nil
403 ;; Do (setq pending (cons thisfile pending))
404 ;; but reuse the cons that was in `files'.
412 failures)
413 ;; Now the original list FILES has been put back as it was.
418 ;;;###autoload
420 "Print the marked (or next ARG) files.
421 Uses the shell command coming from variables `lpr-command' and
422 `lpr-switches' as default."
430 lpr-switches)
431 lpr-switches))
433 "Print %s with: "
438 lpr-switches))
445 "Read args for a Dired marked-files command, prompting with PROMPT.
446 Return the user input (a string).
448 INITIAL, if non-nil, is the initial minibuffer input.
449 OP-SYMBOL is an operation symbol (see `dired-no-confirm').
450 ARG is normally the prefix argument for the calling command;
451 it is passed as the first argument to `dired-mark-prompt'.
452 FILES should be a list of marked files' names.
454 Optional arg DEFAULT-VALUE is a default value or list of default
455 values, passed as the seventh arg to `completing-read'.
457 Optional arg COLLECTION is a collection of possible completions,
458 passed as the second arg to `completing-read'."
460 'completing-read
462 collection nil nil initial nil default-value nil))
463 \f
464 ;;; Cleaning a directory: flagging some backups for deletion.
468 ;;;###autoload
470 "Flag numerical backups for deletion.
471 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
472 Positive prefix arg KEEP overrides `dired-kept-versions';
473 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
476 with a prefix argument."
483 late-retention early-retention)
484 ;; Look at each file.
485 ;; If the file has numeric backup versions,
486 ;; put on dired-file-version-alist an element of the form
487 ;; (FILENAME . VERSION-NUMBER-LIST)
489 ;; Sort each VERSION-NUMBER-LIST,
490 ;; and remove the versions not to be deleted.
498 sorted-v-list)))
502 ;; Look at each file. If it is a numeric backup file,
503 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
507 ;;; Subroutines of dired-clean-directory.
510 ;; Perform FUN with point at the end of each non-directory line.
511 ;; FUN takes one argument, the absolute filename.
528 ;; Only do work if this file is not already in the alist.
530 nil
531 ;; If it looks like file FN has versions, return a list of the versions.
532 ;;That is a list of strings which are file names.
533 ;;The caller may want to flag some of these files for deletion.
538 base-versions
544 dired-file-version-alist)))))))
548 base-version-list)
558 \f
559 ;;; Shell commands
564 "Return a list of all commands associated with current dired files.
565 This function is used to add all related commands retrieved by `mailcap'
566 to the end of the list of defaults just after the default value."
574 ;; This is an extra function so that you can redefine it, e.g., to use gmhist.
576 "Read a dired shell command.
578 which is replaced by the value returned by `dired-mark-prompt',
579 with ARG and FILES as its arguments. FILES should be a list of
580 file names. The result is used as the prompt.
582 This normally reads using `read-shell-command', but if the
583 `dired-x' package is loaded, use `dired-guess-shell-command' to
584 offer a smarter default choice of shell command."
596 ;;;###autoload
598 "Run a shell command COMMAND on the marked files asynchronously.
600 Like `dired-do-shell-command', but adds `&' at the end of COMMAND
601 to execute it asynchronously.
603 When operating on multiple files, asynchronous commands
604 are executed in the background on each file in parallel.
605 In shell syntax this means separating the individual commands
606 with `&'. However, when COMMAND ends in `;' or `;&' then commands
607 are executed in the background on each file sequentially waiting
608 for each command to terminate before running the next command.
609 In shell syntax this means separating the individual commands with `;'.
611 The output appears in the buffer `*Async Shell Command*'."
615 ;; Want to give feedback whether this file or marked files are used:
617 current-prefix-arg
618 files)))
623 ;;;###autoload
625 "Run a shell command COMMAND on the marked files.
626 If no files are marked or a numeric prefix arg is given,
628 The prompt mentions the file(s) or the marker, as appropriate.
630 If there is a `*' in COMMAND, surrounded by whitespace, this runs
631 COMMAND just once with the entire file list substituted there.
633 If there is no `*', but there is a `?' in COMMAND, surrounded by
634 whitespace, this runs COMMAND on each file individually with the
635 file name substituted for `?'.
637 Otherwise, this runs COMMAND on each file individually with the
638 file name added at the end of COMMAND (separated by a space).
640 `*' and `?' when not surrounded by whitespace have no special
641 significance for `dired-do-shell-command', and are passed through
642 normally to the shell, but you must confirm first.
644 If you want to use `*' as a shell wildcard with whitespace around
646 `*' in the shell, but avoids Dired's special handling.
648 If COMMAND ends in `&', `;', or `;&', it is executed in the
649 background asynchronously, and the output appears in the buffer
650 `*Async Shell Command*'. When operating on multiple files and COMMAND
651 ends in `&', the shell command is executed on each file in parallel.
652 However, when COMMAND ends in `;' or `;&' then commands are executed
653 in the background on each file sequentially waiting for each command
654 to terminate before running the next command. You can also use
655 `dired-do-async-shell-command' that automatically adds `&'.
657 Otherwise, COMMAND is executed synchronously, and the output
658 appears in the buffer `*Shell Command Output*'.
660 This feature does not try to redisplay Dired buffers afterward, as
661 there's no telling what files COMMAND may have changed.
664 When COMMAND runs, its working directory is the top-level directory
665 of the Dired buffer, so output files usually are created there
666 instead of in a subdir.
668 In a noninteractive call (from Lisp code), you must specify
669 the list of file names explicitly with the FILE-LIST argument, which
670 can be produced by `dired-get-marked-files', for example."
671 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
672 ;;actual work and can be redefined for customization.
676 ;; Want to give feedback whether this file or marked files are used:
678 current-prefix-arg
679 files)))
684 ;; Get confirmation for wildcards that may have been meant
685 ;; to control substitution of a file name or the file name list.
701 nil
702 file-list)
703 ;; execute the shell command
707 ;; Might use {,} for bash or csh:
716 ;; "Make up a shell command line from COMMAND and FILE-LIST.
717 ;; If ON-EACH is t, COMMAND should be applied to each file, else
718 ;; simply concat all files and apply COMMAND to this.
719 ;; FILE-LIST's elements will be quoted for the shell."
720 ;; Might be redefined for smarter things and could then use RAW-ARG
721 ;; (coming from interactive P and currently ignored) to decide what to do.
722 ;; Smart would be a way to access basename or extension of file names.
726 command))
730 command))
739 retval))
746 file-list dired-mark-separator)))
752 ;; This is an extra function so that it can be redefined by ange-ftp.
753 ;;;###autoload
760 ;; Return nil for sake of nconc in dired-bunch-files.
761 nil)
762 \f
765 ; "Display MSG while running PROGRAM, and check for output.
766 ;Remaining arguments are strings passed as command arguments to PROGRAM.
767 ; On error, insert output
768 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
769 ; Caller can cons up a list of failed args.
770 ;Else returns nil for success."
774 ;; Get a clean buffer for error output:
787 nil))))
788 \f
789 ;; Commands that delete or redisplay part of the dired buffer.
792 "Kill the current line (not the files).
793 With a prefix argument, kill that many lines starting with the current line.
794 \(A negative argument kills backward.)"
813 ;;;###autoload
815 "Kill all marked lines (not the files).
816 With a prefix argument, kill that many lines starting with the current line.
817 \(A negative argument kills backward.)
818 If you use this command with a prefix argument to kill the line
819 for a file that is a directory, which you have inserted in the
820 Dired buffer as a subdirectory, then it deletes that subdirectory
821 from the buffer as well.
822 To kill an entire subdirectory \(without killing its line in the
823 parent directory), go to its directory header line and use this
824 command with a prefix argument (the value does not matter)."
825 ;; Returns count of killed lines. FMT="" suppresses message.
843 count))))
845 ;;;###end dired-cmd.el
846 \f
847 ;;; 30K
848 ;;;###begin dired-cp.el
851 ;; Compress or uncompress the current file.
852 ;; Return nil for success, offending filename else.
858 ;; Remove any preexisting entry for the name NEW-FILE.
861 ;; Now replace the current line with an entry for NEW-FILE.
864 from-file)))
870 ;; For .z, try gunzip. It might be an old gzip file,
871 ;; or it might be from compact? pack? (which?) but gunzip handles both.
877 ;; This item controls naming for compression.
879 "Control changes in file name suffixes for compression and uncompression.
880 Each element specifies one transformation rule, and has the form:
881 (REGEXP NEW-SUFFIX PROGRAM)
882 The rule applies when the old file name matches REGEXP.
883 The new file name is computed by deleting the part that matches REGEXP
884 (as well as anything after that), then adding NEW-SUFFIX in its place.
885 If PROGRAM is non-nil, the rule is an uncompression rule,
886 and uncompression is done by running PROGRAM.
889 ;;;###autoload
891 ;; Compress or uncompress FILE.
892 ;; Return the name of the compressed or uncompressed file.
893 ;; Return nil if no change in files.
895 suffix newname
897 ;; See if any suffix rule matches this file name.
903 ;; If so, compute desired new name.
910 nil)
912 ;; We found an uncompression rule.
915 newname))
917 ;;; We don't recognize the file as compressed, so compress it.
918 ;;; Try gzip; if we don't have that, use compress.
924 out-name)))
929 ;; Rename the compressed file to NEWNAME
930 ;; if it hasn't got that name already.
934 newname)
935 out-name)))
939 ;; Don't use NEWNAME with `compress'.
941 \f
943 ;; Request confirmation from the user that the operation described
944 ;; by OP-SYMBOL is to be performed on the marked files.
945 ;; Confirmation consists in a y-or-n question with a file list
946 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
947 ;; The files used are determined by ARG (as in dired-get-marked-files).
950 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
951 ;; is marked pops up a window. That will help the user see
952 ;; it isn't the current line file.
961 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
962 ; and display failures.
964 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
965 ; the short form of the filename) for a failure and probably logs a
966 ; detailed error explanation using function `dired-log'.
968 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
969 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
970 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
971 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
973 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
985 ;; end this bunch of errors:
989 failures)))))
991 ;;;###autoload
993 "Format PROMPT with ARGS, query user, and store the result in SYM.
994 The return value is either nil or t.
996 The user may type y or SPC to accept once; n or DEL to skip once;
997 ! to accept this and subsequent queries; or q or ESC to decline
998 this and subsequent queries.
1000 If SYM is already bound to a non-nil value, this function may
1001 return automatically without querying the user. If SYM is !,
1002 return t; if SYM is q or ESC, return nil."
1019 \f
1020 ;;;###autoload
1022 "Compress or uncompress marked (or next ARG) files."
1026 ;; Commands for Emacs Lisp files - load and byte compile
1029 ;; Return nil for success, offending file name else.
1031 elc-file buffer-read-only failure)
1046 nil)))
1048 ;;;###autoload
1050 "Byte compile marked (or next ARG) Emacs Lisp files."
1055 ;; Return nil for success, offending file name else.
1061 nil
1065 ;;;###autoload
1067 "Load the marked (or next ARG) Emacs Lisp files."
1071 ;;;###autoload
1073 "Redisplay all marked (or next ARG) files.
1074 If on a subdir line, redisplay that subdirectory. In that case,
1075 a prefix arg lets you edit the `ls' switches used for the new listing.
1077 Dired remembers switches specified with a prefix arg, so that reverting
1078 the buffer will not reset them. However, using `dired-undo' to re-insert
1079 or delete subdirectories can bypass this machinery. Hence, you sometimes
1080 may have to reset some subdirectory switches after a `dired-undo'.
1081 You can reset all subdirectory switches to the default using
1083 See Info node `(emacs)Subdir switches' for more details."
1084 ;; Moves point if the next ARG files are redisplayed.
1090 dir
1094 dired-subdir-switches
1095 dired-actual-switches)))))
1097 ;; message much faster than making dired-map-over-marks show progress
1101 ;; Postpone readin hook till we map
1102 ;; over all marked files (Bug#6810).
1106 arg)
1112 "Set `dired-switches-alist' to nil and revert dired buffer."
1116 \f
1118 ;; Delete the current line, and insert an entry for FILE.
1119 ;; If FILE is nil, then just delete the current line.
1120 ;; Keeps any marks that may be present in column one (doing this
1121 ;; here is faster than with dired-add-entry's optional arg).
1122 ;; Does not update other dired buffers. Use dired-relist-entry for that.
1130 ;; Replace space by old marker without moving point.
1131 ;; Faster than goto+insdel inside a save-excursion?
1135 ;;;###autoload
1146 "Add a new dired entry for FILENAME.
1147 Optionally mark it with MARKER-CHAR (a character, else uses
1148 `dired-marker-char'). Note that this adds the entry `out of order'
1149 if files are sorted by time, etc.
1150 Skips files that match `dired-trivial-filenames'.
1151 Exposes hidden subdirectories if a file is added there.
1153 If `dired-x' is loaded and `dired-omit-mode' is enabled, skips
1154 files matching `dired-omit-regexp'."
1157 ;; Avoid calling ls for files that are going to be omitted anyway.
1163 filename)
1168 filename
1170 ;; Do it!
1173 ;; Entry is always for files, even if they happen to also be directories
1177 reason)
1182 reason
1189 ;; We are already where we should be, except when
1190 ;; point is before the subdir line or its total line.
1194 ;; else try to find correct place to insert
1198 ;; Point is at end of subdir line.
1200 ;; found - skip subdir and `total' line
1201 ;; and uninteresting files like . and ..
1202 ;; This better not move into the next subdir!
1204 ;; not found
1209 ;; Don't expand `.'.
1210 ;; Show just the file name within directory.
1213 directory
1217 ;; Put in desired marker char.
1221 dired-marker-char)))
1223 ;; Compensate for a bug in ange-ftp.
1224 ;; It inserts the file's absolute name, rather than
1225 ;; the relative one. That may be hard to fix since it
1226 ;; is probably controlled by something in ftp.
1242 ;; The subdir-alist is not affected...
1250 ;; return nil if all went well
1251 nil))
1255 ;; Don't do it (dired-omit-mode).
1256 ;; Return t for success (perhaps we should return file-exists-p).
1257 t))
1260 ;; Return pos of first file line of DIR, skipping header and total
1261 ;; or wildcard lines.
1262 ;; Important: never moves into the next subdir.
1263 ;; DIR is assumed to be unhidden.
1272 ;;;###autoload
1285 ;;;###autoload
1287 "Create or update the line for FILE in all Dired buffers it would belong in."
1293 ;; Relist the line for FILE, or just add it if it did not exist.
1294 ;; FILE must be an absolute file name.
1296 ;; If cursor is already on FILE's line delete-region will cause
1297 ;; save-excursion to fail because of floating makers,
1298 ;; moving point to beginning of line. Sigh.
1307 \f
1308 ;;; Copy, move/rename, making hard and symbolic links
1311 "Non-nil if Dired should ask about making backups before overwriting files.
1312 Special value `always' suppresses confirmation."
1318 ;; This is a fluid var used in dired-handle-overwrite. It should be
1319 ;; let-bound whenever dired-copy-file etc are called. See
1320 ;; dired-create-files for an example.
1324 ;; Save old version of file TO that is to be overwritten.
1325 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1326 ;; from dired-create-files.
1329 dired-overwrite-confirmed
1333 "Make backup for existing file `%s'? "
1334 to)))
1338 ;;;###autoload
1342 dired-recursive-copies))
1347 preserve-time top recursive)
1360 ;; It is a symlink
1365 dired-create-files-failures)
1368 ;;;###autoload
1372 ;; Silently rename the visited file of any buffer visiting this file.
1377 ;; See if it's an inserted subdir, and rename that, too.
1385 ;; Update visited file name of all affected buffers
1395 to-dir
1396 buffer-file-name)))
1402 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1403 ;; one of its subdirectories is expanded in this buffer.
1411 ;; ELT's subdir is affected by the rename
1414 ;; if top level directory was renamed, lots of things have to be
1415 ;; updated:
1420 ;; with and without wildcards
1422 to))
1425 ;; try to rename buffer, but just leave old name if new
1426 ;; name would already exist (don't try appending "<%d>")
1429 ;; ... we dired TO now:
1433 ;; Update the headerline and dired-subdir-alist element, as well as
1434 ;; dired-switches-alist element, of directory described by
1435 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1436 ;; describes either DIR itself or a subdir of DIR.
1440 buffer-read-only)
1442 ;; Update subdir headerline in buffer
1445 dir)
1450 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1456 \f
1457 ;; Bound in dired-create-files
1461 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1464 "Create one or more new files from a list of existing files FN-LIST.
1465 This function also handles querying the user, updating Dired
1466 buffers, and displaying a success or failure message.
1468 FILE-CREATOR should be a function. It is called once for each
1469 file in FN-LIST, and must create a new file, querying the user
1470 and updating Dired buffers as necessary. It should accept three
1471 arguments: the old file name, the new name, and an argument
1472 OK-IF-ALREADY-EXISTS with the same meaning as in `copy-file'.
1474 OPERATION should be a capitalized string describing the operation
1475 performed (e.g. `Copy'). It is used for error logging.
1477 FN-LIST is the list of files to copy (full absolute file names).
1479 NAME-CONSTRUCTOR should be a function accepting a single
1480 argument, the name of an old file, and returning either the
1481 corresponding new file name or nil to skip.
1483 If optional argument MARKER-CHAR is non-nil, mark each
1484 newly-created file's Dired entry with the character MARKER-CHAR,
1485 or with the current marker character if MARKER-CHAR is t."
1503 Type SPC or `y' to overwrite file `%s',
1504 DEL or `n' to skip to next,
1505 ESC or `q' to not overwrite any of the remaining files,
1509 ;; must determine if FROM is marked before file-creator
1510 ;; gets a chance to delete it (in case of a move).
1515 ;; Handle the `dired-copy-file' file-creator specially
1516 ;; When copying a directory to another directory or
1517 ;; possibly to itself or one of its subdirectories.
1518 ;; e.g "~/foo/" => "~/test/"
1519 ;; or "~/foo/" =>"~/foo/"
1520 ;; or "~/foo/ => ~/foo/bar/")
1521 ;; In this case the 'name-constructor' have set the destination
1522 ;; TO to "~/test/foo" because the old emacs23 behavior
1523 ;; of `copy-directory' was to not create the subdirectory
1524 ;; and instead copy the contents.
1525 ;; With the new behavior of `copy-directory'
1526 ;; (similar to the `cp' shell command) we don't
1527 ;; need such a construction of the target directory,
1528 ;; so modify the destination TO to "~/test/" instead of "~/test/foo/".
1534 ;; If DESTNAME is a subdirectory of FROM, not a symlink,
1535 ;; and the method in use is copying, signal an error.
1540 from to)))
1545 ;; If we get here, file-creator hasn't been aborted
1546 ;; and the old entry (if any) has to be deleted
1547 ;; before adding the new entry.
1555 failures)
1557 operation from to err))))))))
1565 total)
1566 failures))
1572 failures))
1578 skipped))
1583 \f
1585 &optional marker-char op1
1586 how-to)
1587 "Create a new file for each marked file.
1588 Prompt user for a target directory in which to create the new
1589 files. The target may also be a non-directory file, if only
1590 one file is marked. The initial suggestion for target is the
1591 Dired buffer's current directory (or, if `dired-dwim-target' is
1592 non-nil, the current directory of a neighboring Dired window).
1593 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1594 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1595 FILE-CREATOR and OPERATION as in `dired-create-files'.
1596 ARG as in `dired-get-marked-files'.
1597 Optional arg MARKER-CHAR as in `dired-create-files'.
1598 Optional arg OP1 is an alternate form for OPERATION if there is
1599 only one file.
1600 Optional arg HOW-TO determines how to treat the target.
1601 If HOW-TO is nil, use `file-directory-p' to determine if the
1602 target is a directory. If so, the marked file(s) are created
1603 inside that directory. Otherwise, the target is a plain file;
1604 an error is raised unless there is exactly one marked file.
1605 If HOW-TO is t, target is always treated as a plain file.
1606 Otherwise, HOW-TO should be a function of one argument, TARGET.
1607 If its return value is nil, TARGET is regarded as a plain file.
1608 If it return value is a list, TARGET is a generalized
1609 directory (e.g. some sort of archive). The first element of
1610 this list must be a function with at least four arguments:
1611 operation - as OPERATION above.
1612 rfn-list - list of the relative names for the marked files.
1613 fn-list - list of the absolute names for the marked files.
1614 target - the name of the target itself.
1615 The rest of into-dir are optional arguments.
1616 For any other return value, TARGET is treated as a directory."
1625 target-dir)))
1634 target-dir op-symbol arg rfn-list default))))
1636 ;; Allow DOS/Windows users to change the letter
1637 ;; case of a directory. If we don't test these
1638 ;; conditions up front, file-directory-p below
1639 ;; will return t because the filesystem is
1640 ;; case-insensitive, and Emacs will try to move
1641 ;; foo -> foo/foo, which fails.
1644 dired-one-file
1652 nil
1660 ;; rename-file bombs when moving directories unless we do this:
1663 file-creator operation fn-list
1665 ;; This function uses fluid variable target when called
1666 ;; inside dired-create-files:
1671 marker-char))))
1673 ;; Read arguments for a marked-files command that wants a file name,
1674 ;; perhaps popping up the list of marked files.
1675 ;; ARG is the prefix arg and indicates whether the files came from
1676 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1677 ;; If the current file was used, the list has but one element and ARG
1678 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1679 ;; DEFAULT is the default value to return if the user just hits RET;
1680 ;; if it is omitted or nil, then the name of the directory is used.
1685 nil op-symbol files
1690 ;; Try to guess which target directory the user may want.
1691 ;; If there is a dired buffer displayed in one of the next windows,
1692 ;; use its current subdir, else use current subdir of this dired buffer.
1695 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1706 this-dir)))
1709 ;; Return a list of default values for file-reading functions in Dired.
1710 ;; This list may contain directories from Dired buffers in other windows.
1711 ;; `fn-list' is a list of file names used to build a list of defaults.
1712 ;; When nil or more than one element, a list of defaults will
1713 ;; contain only directory names. `target-dir' is a directory name
1714 ;; to exclude from the returned list, for the case when this
1715 ;; directory name is already presented in initial input.
1716 ;; For Dired operations that support `dired-dwim-target',
1717 ;; the argument `target-dir' should have the value returned
1718 ;; from `dired-dwim-target-directory'.
1723 dired-dirs)
1724 ;; Get a list of directories of visible buffers in dired-mode.
1729 ;; Force the current dir to be the first in the list.
1732 ;; Remove the target dir (if specified) or the current dir from
1733 ;; default values, because it should be already in initial input.
1735 ;; Return a list of default values.
1737 ;; For one file operation, provide a list that contains
1738 ;; other directories, other directories with the appended filename
1739 ;; and the current directory with the appended filename, e.g.
1740 ;; 1. /TARGET-DIR/
1741 ;; 2. /TARGET-DIR/FILENAME
1742 ;; 3. /CURRENT-DIR/FILENAME
1751 ;; For multi-file operation, return only a list of other directories.
1752 dired-dirs)))
1754 \f
1755 ;;;###autoload
1757 "Create a directory called DIRECTORY.
1758 If DIRECTORY already exists, signal an error."
1765 ;; Find the topmost nonexistent parent dir (variable `new')
1777 ;; This may not always be what you want, especially if target is your
1778 ;; home directory and it happens to be a symbolic link, as is often the
1779 ;; case with NFS and automounters. Or if you want to make symlinks
1780 ;; into directories that themselves are only symlinks, also quite
1781 ;; common.
1783 ;; So we don't use this function as value for HOW-TO in
1784 ;; dired-do-symlink, which has the minor disadvantage of
1785 ;; making links *into* a symlinked-dir, when you really wanted to
1786 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1787 ;; just have to remove that symlink by hand before making your marked
1788 ;; symlinks.
1791 "Either nil or a function used by `dired-do-copy' to determine target.
1794 ;;;###autoload
1796 "Copy all marked (or next ARG) files, or copy the current file.
1797 When operating on just the current file, prompt for the new name.
1799 When operating on multiple or marked files, prompt for a target
1800 directory, and make the new copies in that directory, with the
1801 same names as the original files. The initial suggestion for the
1802 target directory is the Dired buffer's current directory (or, if
1803 `dired-dwim-target' is non-nil, the current directory of a
1804 neighboring Dired window).
1806 If `dired-copy-preserve-time' is non-nil, this command preserves
1807 the modification time of each old file in the copy, similar to
1810 This command copies symbolic links by creating new ones, similar
1815 "Copy"
1816 arg dired-keep-marker-copy
1817 nil dired-copy-how-to-fn)))
1819 ;;;###autoload
1821 "Make symbolic links to current file or all marked (or next ARG) files.
1822 When operating on just the current file, you specify the new name.
1823 When operating on multiple or marked files, you specify a directory
1824 and new symbolic links are made in that directory
1825 with the same names that the files currently have. The default
1826 suggested for the target directory depends on the value of
1827 `dired-dwim-target', which see.
1834 ;;;###autoload
1836 "Add names (hard links) current file or all marked (or next ARG) files.
1837 When operating on just the current file, you specify the new name.
1838 When operating on multiple or marked files, you specify a directory
1839 and new hard links are made in that directory
1840 with the same names that the files currently have. The default
1841 suggested for the target directory depends on the value of
1842 `dired-dwim-target', which see."
1849 ;; error is caught in -create-files
1851 ;; Update the link count
1854 ;;;###autoload
1856 "Rename current file or all marked (or next ARG) files.
1857 When renaming just the current file, you specify the new name.
1858 When renaming multiple or marked files, you specify a directory.
1859 This command also renames any buffers that are visiting the files.
1860 The default suggested for the target directory depends on the value
1861 of `dired-dwim-target', which see."
1865 ;;;###end dired-cp.el
1866 \f
1867 ;;; 5K
1868 ;;;###begin dired-re.el
1873 ;; Create a new file for each marked file using regexps.
1874 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1875 ;; ARG as in dired-get-marked-files.
1876 ;; Matches each marked file against REGEXP and constructs the new
1877 ;; filename from NEWNAME (like in function replace-match).
1878 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1879 ;; instead of only the non-directory part of the file.
1880 ;; Optional arg MARKER-CHAR as in dired-create-files.
1884 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1885 `!' to %s all remaining matches with no more questions."
1889 ;; Function to construct new filename using REGEXP and NEWNAME:
1894 ;; must bind help-form directly around call to
1895 ;; dired-query
1899 operation-prompt
1900 from
1901 to)
1902 to)
1904 operation from regexp)))))
1905 ;; not whole-name, replace non-directory part only
1916 operation-prompt
1919 to)
1922 rename-regexp-query)
1924 file-creator operation fn-list regexp-name-constructor marker-char)))
1927 ;; Prompt user about performing OPERATION.
1928 ;; Read and return list of: regexp newname arg whole-name.
1942 ;;;###autoload
1944 "Rename selected files whose names match REGEXP to NEWNAME.
1946 With non-zero prefix argument ARG, the command operates on the next ARG
1947 files. Otherwise, it operates on all the marked files, or the current
1948 file if none are marked.
1950 As each match is found, the user must type a character saying
1953 REGEXP defaults to the last regexp used.
1955 With a zero prefix arg, renaming by regexp affects the absolute file name.
1956 Normally, only the non-directory part of the file name is used and changed."
1962 ;;;###autoload
1964 "Copy selected files whose names match REGEXP to NEWNAME.
1965 See function `dired-do-rename-regexp' for more info."
1971 arg regexp newname whole-name dired-keep-marker-copy)))
1973 ;;;###autoload
1975 "Hardlink selected files whose names match REGEXP to NEWNAME.
1976 See function `dired-do-rename-regexp' for more info."
1982 ;;;###autoload
1984 "Symlink selected files whose names match REGEXP to NEWNAME.
1985 See function `dired-do-rename-regexp' for more info."
1995 ;; Perform FILE-CREATOR on the non-directory part of marked files
1996 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1997 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
2000 file-creator
2001 operation
2009 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
2010 `!' to %s all remaining matches with no more questions."
2017 to))))
2018 dired-keep-marker-rename)))
2023 basename-constructor operation arg))
2025 ;;;###autoload
2027 "Rename all marked (or next ARG) files to upper case."
2031 ;;;###autoload
2033 "Rename all marked (or next ARG) files to lower case."
2037 ;;;###end dired-re.el
2038 \f
2039 ;;; 13K
2040 ;;;###begin dired-ins.el
2042 ;;;###autoload
2044 switches no-error-if-not-dir-p)
2045 "Insert this subdirectory into the same dired buffer.
2047 else inserts it at its natural place (as `ls -lR' would have done).
2048 With a prefix arg, you may edit the ls switches used for this listing.
2049 You can add `R' to the switches to expand the whole tree starting at
2050 this subdirectory.
2051 This function takes some pains to conform to `ls -lR' output.
2053 Dired remembers switches specified with a prefix arg, so that reverting
2054 the buffer will not reset them. However, using `dired-undo' to re-insert
2055 or delete subdirectories can bypass this machinery. Hence, you sometimes
2056 may have to reset some subdirectory switches after a `dired-undo'.
2057 You can reset all subdirectory switches to the default using
2059 See Info node `(emacs)Subdir switches' for more details."
2066 ;; We don't need a marker for opoint as the subdir is always
2067 ;; inserted *after* opoint.
2073 t))
2075 ;; Push mark so that it's easy to find back. Do this after the
2076 ;; insert message so that the user sees the `Mark set' message.
2079 ;;;###autoload
2081 "Insert this subdirectory into the same Dired buffer.
2082 If it is already present, overwrite the previous entry;
2083 otherwise, insert it at its natural place (as `ls -lR' would
2084 have done).
2085 With a prefix arg, you may edit the `ls' switches used for this listing.
2086 You can add `R' to the switches to expand the whole tree starting at
2087 this subdirectory.
2088 This function takes some pains to conform to `ls -lR' output."
2089 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
2090 ;; Prospero where dired-ls does the right thing, but
2091 ;; file-directory-p has not been redefined.
2105 switches-have-R mark-alist case-fold-search buffer-read-only)
2108 ;; case-fold-search is nil now, so we can test for capital `R':
2110 ;; avoid duplicated subdirs
2113 ;; If subdir is already present, remove it and remember its marks
2137 ;; Check that it is valid to insert DIRNAME with SWITCHES.
2138 ;; Signal an error if invalid (e.g. user typed `i' on `..').
2151 ;; all switches that make a difference to dired-get-filename:
2155 ;; Add new DIR at NEW-MARKER. Sort alist.
2160 ;; Keep the alist sorted on buffer position.
2168 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
2169 Interactively, you can kill DIRNAME as well by using a prefix argument.
2170 In interactive use, the command prompts for DIRNAME.
2172 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
2173 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
2184 m-alist))
2187 ;; Find pos for new subdir, according to tree order.
2188 ;;(goto-char (point-max))
2195 ;; Insert NEW-DIR after DIR
2197 alist nil)))
2199 ;; want a separating newline between subdirs
2206 ;; Erase an already present subdir (given by ELEMENT) from buffer.
2207 ;; Move to that buffer position. Return a mark-alist.
2210 ;; Are at beginning of subdir (and inside it!). Now determine its end:
2219 ;; Insert ls output after point.
2220 ;; Return the boundary of the inserted text (as list of BEG and END).
2225 dired-subdir-switches
2228 ;; If doing the top level directory of the buffer,
2229 ;; redo it as specified in dired-directory.
2235 ;; Point is at the correct subdir alist position for ELT,
2236 ;; BEG-END is the subdir-region (as list of begin and end).
2238 ;; update its position (should actually be unchanged)
2241 ;; The hook may depend on the subdir-alist containing the just
2242 ;; inserted subdir, so run it after dired-alist-add:
2250 ;; hook may add or delete lines, but the subdir boundary
2251 ;; marker floats
2255 ;; Lexicographic order on file name components, like `ls -lR':
2256 ;; DIR1 < DIR2 if DIR1 comes *before* DIR2 in an `ls -lR' listing,
2257 ;; i.e., if DIR1 is a (grand)parent dir of DIR2,
2258 ;; or DIR1 and DIR2 are in the same parentdir and their last
2259 ;; components are string-lessp.
2260 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
2261 ;; string-lessp could arguably be replaced by file-newer-than-file-p
2262 ;; if dired-actual-switches contained t.
2268 components-2
2280 t)
2282 nil)
2285 ;; There should be a builtin split function - inverse to mapconcat.
2287 "Splitting on regexp PAT, turn string STR into a list of substrings.
2288 Optional third arg LIMIT (>= 1) is a limit to the length of the
2289 resulting list.
2290 Thus, if SEP is a regexp that only matches itself,
2292 (mapconcat 'identity (dired-split SEP STRING) SEP)
2294 is always equal to STRING."
2307 start end)
2308 ))
2315 \f
2316 ;;; moving by subdirectories
2318 ;;;###autoload
2320 "Go to previous subdirectory, regardless of level.
2321 When called interactively and not on a subdir line, go to this subdir's line."
2322 ;;(interactive "p")
2326 ;; if on subdir start already, don't stay there!
2336 ;;;###autoload
2338 "Go to end of header line of DIR in this dired buffer.
2339 Return value of point on success, otherwise return nil.
2345 dired-subdir-alist ; table
2346 nil ; predicate
2347 t ; require-match
2354 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2355 ;; at either \r or \n after this function succeeds.
2358 \f
2359 ;;;###autoload
2361 "Mark all files except `.' and `..' in current subdirectory.
2362 If the Dired buffer shows multiple directories, this command
2363 marks the files listed in the subdirectory that point is in."
2368 ;;;###autoload
2370 "Remove all lines of current subdirectory.
2371 Lower levels are unaffected."
2372 ;; With optional REMEMBER-MARKS, return a mark-alist.
2379 buffer-read-only)
2393 ;; Remove DIR from the alist
2397 ;;;###autoload
2399 "Go up ARG levels in the dired tree."
2405 ;;(setq dir (expand-file-name dir))
2409 ;;;###autoload
2411 "Go down in the dired tree."
2425 \f
2426 ;;; hiding
2442 ;;;###autoload
2444 "Hide or unhide the current subdirectory and move to next directory.
2445 Optional prefix arg is a repeat factor.
2455 buffer-read-only)
2456 ;; keep header line visible, hide rest
2465 ;;;###autoload
2467 "Hide all subdirectories, leaving only their header lines.
2468 If there is already something hidden, make everything visible again.
2473 buffer-read-only)
2477 ;; unhide - bombs on \r in filenames
2479 ;; hide
2486 ;; we're somewhere on current dir's line
2494 ;;;###end dired-ins.el
2496 \f
2497 ;; Search only in file names in the Dired buffer.
2500 "Non-nil to Isearch in file names only.
2501 If t, Isearch in Dired always matches only file names.
2502 If `dwim', Isearch matches file names when initial point position is on
2503 a file name. Otherwise, it searches the whole buffer without restrictions."
2511 "Toggle file names searching on or off.
2512 When on, Isearch skips matches outside file names using the predicate
2513 `dired-isearch-filter-filenames' that matches only at file names.
2514 When off, it uses the original predicate."
2515 nil nil nil
2518 #'dired-isearch-filter-filenames
2526 ;;;###autoload
2528 "Set up isearch to search in Dired file names.
2529 Intended to be added to `isearch-mode-hook'."
2538 "Clean up the Dired file name search after terminating isearch."
2544 "Test whether the current search hit is a file name.
2545 Return non-nil if the text from BEG to END is part of a file
2546 name (has the text property `dired-filename')."
2550 ;;;###autoload
2552 "Search for a string using Isearch only in file names in the Dired buffer."
2557 ;;;###autoload
2559 "Search for a regexp using Isearch only in file names in the Dired buffer."
2564 \f
2565 ;; Functions for searching in tags style among marked files.
2567 ;;;###autoload
2569 "Search for a string through all marked files using Isearch."
2574 ;;;###autoload
2576 "Search for a regexp through all marked files using Isearch."
2581 ;;;###autoload
2583 "Search through all marked files for a match for REGEXP.
2584 Stops when a match is found.
2589 ;;;###autoload
2591 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2592 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2603 buffer-read-only))
2610 \f
2611 ;;;###autoload
2613 "Print the type of FILE, according to the `file' command.
2614 If you give a prefix to this command, and FILE is a symbolic
2615 link, then the type of the file linked to by FILE is printed
2616 instead."
2629 ;; Local Variables:
2630 ;; byte-compile-dynamic: t
2631 ;; generated-autoload-file: "dired.el"
2632 ;; End:
2634 ;;; dired-aux.el ends here