| blob | 0942c6d1dffc8bb9ee90b4bdd24dc2715e40d5f6 |
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 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 2, 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.
42 ;;; 15K
43 ;;;###begin dired-cmd.el
44 ;; Diffing and compressing
49 ;;;###autoload
51 "Compare file at point with file FILE using `diff'.
52 FILE defaults to the file at the mark. (That's the mark set by
54 The prompted-for file is the first file given to `diff'.
55 With prefix arg, prompt for second argument SWITCHES,
56 which is options for `diff'."
69 current
76 default t)
80 diff-switches
84 ;;;###autoload
86 "Diff this file with its backup file or vice versa.
87 Uses the latest backup, if there are several numerical backups.
88 If this file is a backup, diff it with its original.
89 The backup file is the first file given to `diff'.
90 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
95 diff-switches
97 nil))
100 ;;;###autoload
102 "Mark files with different file attributes in two dired buffers.
103 Compare file attributes of files in the current directory
104 with file attributes in directory DIR2 using PREDICATE on pairs of files
105 with the same name. Mark files for which PREDICATE returns non-nil.
106 Mark files with different names if PREDICATE is nil (or interactively
107 with empty input at the predicate prompt).
109 PREDICATE is a Lisp expression that can refer to the following variables:
111 size1, size2 - file size in bytes
112 mtime1, mtime2 - last modification time in seconds, as a float
113 fa1, fa2 - list of file attributes
114 returned by function `file-attributes'
116 where 1 refers to attribute of file in the current dired buffer
117 and 2 to attribute of file in second dired buffer.
119 Examples of PREDICATE:
121 (> mtime1 mtime2) - mark newer files
122 (not (= size1 size2)) - mark files with different sizes
123 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
124 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
125 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
135 file-list1 file-list2)
141 'cadr
143 file-alist1 file-alist2
144 predicate))
146 'cadr
148 file-alist2 file-alist1
149 predicate)))
151 dir1 nil
156 dir2 nil
165 "Combine LIST1 and LIST2 using a set-difference operation.
166 The result list contains all file items that appear in LIST1 but not LIST2.
167 This is a non-destructive function; it makes a copy of the data if necessary
168 to avoid corrupting the original LIST1 and LIST2.
169 PREDICATE (see `dired-compare-directories') is an additional match
170 condition. Two file items are considered to match if they are equal
171 *and* PREDICATE evaluates to t."
173 list1
189 list)
194 "Return a list of all file names and attributes from DIR.
195 List has a form of (file-name full-file-name (attribute-list))"
200 full-file-name
203 \f
206 "Create initial input value for `touch' command."
217 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
218 ;; refresh their file lines.
219 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
220 ;; PROGRAM is the program used to change the attribute.
221 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
222 ;; ARG describes which files to use, as in dired-get-marked-files.
228 op-symbol arg files))
230 failures)
241 files))
246 nil))))
248 ;;;###autoload
250 "Change the mode of the marked (or next ARG) files.
251 This calls chmod, thus symbolic modes like `g+w' are allowed."
255 ;;;###autoload
257 "Change the group of the marked (or next ARG) files."
263 ;;;###autoload
265 "Change the owner of the marked (or next ARG) files."
271 ;;;###autoload
273 "Change the timestamp of the marked (or next ARG) files.
274 This calls touch."
278 ;; Process all the files in FILES in batches of a convenient size,
279 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
280 ;; Batches are chosen to need less than MAX chars for the file names,
281 ;; allowing 3 extra characters of separator per file name.
284 past
286 failures)
287 ;; Accumulate files as long as they fit in MAX chars,
288 ;; then process the ones accumulated so far.
293 ;; If we have at least 1 pending file
294 ;; and this file won't fit in the length limit, process now.
297 ;; The elements of PENDING are now in forward order.
298 ;; Do the operation and record failures.
300 failures)
301 ;; Transfer the elemens of PENDING onto PAST
302 ;; and clear it out. Now PAST contains the first N files
303 ;; specified (for some N), and FILES contains the rest.
305 pending nil
307 ;; Do (setq pending (cons thisfile pending))
308 ;; but reuse the cons that was in `files'.
316 failures)
317 ;; Now the original list FILES has been put back as it was.
320 ;;;###autoload
322 "Print the marked (or next ARG) files.
323 Uses the shell command coming from variables `lpr-command' and
324 `lpr-switches' as default."
328 "Print %s with: "
333 lpr-switches))
338 ;; Read arguments for a marked-files command that wants a string
339 ;; that is not a file name,
340 ;; perhaps popping up the list of marked files.
341 ;; ARG is the prefix arg and indicates whether the files came from
342 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
343 ;; If the current file was used, the list has but one element and ARG
344 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
347 ;; PROMPT for a string, with INITIAL input.
348 ;; Other args are used to give user feedback and pop-up:
349 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
351 nil op-symbol files
354 \f
355 ;;; Cleaning a directory: flagging some backups for deletion.
359 ;;;###autoload
361 "Flag numerical backups for deletion.
362 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
363 Positive prefix arg KEEP overrides `dired-kept-versions';
364 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
367 with a prefix argument."
374 late-retention early-retention)
375 ;; Look at each file.
376 ;; If the file has numeric backup versions,
377 ;; put on dired-file-version-alist an element of the form
378 ;; (FILENAME . VERSION-NUMBER-LIST)
380 ;; Sort each VERSION-NUMBER-LIST,
381 ;; and remove the versions not to be deleted.
389 sorted-v-list)))
393 ;; Look at each file. If it is a numeric backup file,
394 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
398 ;;; Subroutines of dired-clean-directory.
401 ;; Perform FUN with point at the end of each non-directory line.
402 ;; FUN takes one argument, the absolute filename.
417 ;; Only do work if this file is not already in the alist.
419 nil
420 ;; If it looks like file FN has versions, return a list of the versions.
421 ;;That is a list of strings which are file names.
422 ;;The caller may want to flag some of these files for deletion.
427 base-versions
433 dired-file-version-alist)))))))
437 base-version-list)
447 \f
448 ;;; Shell commands
451 ;; "Read a dired shell command prompting with PROMPT (using read-string).
452 ;;ARG is the prefix arg and may be used to indicate in the prompt which
453 ;; files are affected.
454 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
456 nil 'shell files
461 ;; The in-background argument is only needed in Emacs 18 where
462 ;; shell-command doesn't understand an appended ampersand `&'.
463 ;;;###autoload
465 "Run a shell command COMMAND on the marked files.
466 If no files are marked or a specific numeric prefix arg is given,
468 The prompt mentions the file(s) or the marker, as appropriate.
470 If there is a `*' in COMMAND, surrounded by whitespace, this runs
471 COMMAND just once with the entire file list substituted there.
473 If there is no `*', but there is a `?' in COMMAND, surrounded by
474 whitespace, this runs COMMAND on each file individually with the
475 file name substituted for `?'.
477 Otherwise, this runs COMMAND on each file individually with the
478 file name added at the end of COMMAND (separated by a space).
480 `*' and `?' when not surrounded by whitespace have no special
481 significance for `dired-do-shell-command', and are passed through
482 normally to the shell, but you must confirm first. To pass `*' by
485 If COMMAND produces output, it goes to a separate buffer.
487 This feature does not try to redisplay Dired buffers afterward, as
488 there's no telling what files COMMAND may have changed.
491 When COMMAND runs, its working directory is the top-level directory of
492 the Dired buffer, so output files usually are created there instead of
493 in a subdir.
495 In a noninteractive call (from Lisp code), you must specify
496 the list of file names explicitly with the FILE-LIST argument, which
497 can be produced by `dired-get-marked-files', for example."
498 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
499 ;;actual work and can be redefined for customization.
503 ;; Want to give feedback whether this file or marked files are used:
506 current-prefix-arg
507 files)
508 current-prefix-arg
509 files)))
514 ;; Get confirmation for wildcards that may have been meant
515 ;; to control substitution of a file name or the file name list.
529 nil
530 file-list)
531 ;; execute the shell command
535 ;; Might use {,} for bash or csh:
544 ;; "Make up a shell command line from COMMAND and FILE-LIST.
545 ;; If ON-EACH is t, COMMAND should be applied to each file, else
546 ;; simply concat all files and apply COMMAND to this.
547 ;; FILE-LIST's elements will be quoted for the shell."
548 ;; Might be redefined for smarter things and could then use RAW-ARG
549 ;; (coming from interactive P and currently ignored) to decide what to do.
550 ;; Smart would be a way to access basename or extension of file names.
559 retval))
564 file-list dired-mark-separator)))
569 ;; This is an extra function so that it can be redefined by ange-ftp.
570 ;;;###autoload
577 ;; Return nil for sake of nconc in dired-bunch-files.
578 nil)
579 \f
580 ;; In Emacs 19 this will return program's exit status.
581 ;; This is a separate function so that ange-ftp can redefine it.
583 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
584 ;Remaining arguments are strings passed as command arguments to PROGRAM."
585 ;; Look for a handler for default-directory in case it is a remote file name.
590 program discard arguments)
594 ; "Display MSG while running PROGRAM, and check for output.
595 ;Remaining arguments are strings passed as command arguments to PROGRAM.
596 ; On error, insert output
597 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
598 ; Caller can cons up a list of failed args.
599 ;Else returns nil for success."
603 ;; Get a clean buffer for error output:
617 nil))))
618 \f
619 ;; Commands that delete or redisplay part of the dired buffer.
640 ;;;###autoload
642 "Kill all marked lines (not the files).
643 With a prefix argument, kill that many lines starting with the current line.
644 \(A negative argument kills backward.)
645 If you use this command with a prefix argument to kill the line
646 for a file that is a directory, which you have inserted in the
647 Dired buffer as a subdirectory, then it deletes that subdirectory
648 from the buffer as well.
649 To kill an entire subdirectory \(without killing its line in the
650 parent directory), go to its directory header line and use this
651 command with a prefix argument (the value does not matter)."
652 ;; Returns count of killed lines. FMT="" suppresses message.
670 count))))
672 ;;;###end dired-cmd.el
673 \f
674 ;;; 30K
675 ;;;###begin dired-cp.el
678 ;; Compress or uncompress the current file.
679 ;; Return nil for success, offending filename else.
685 ;; Remove any preexisting entry for the name NEW-FILE.
690 ;; Now replace the current line with an entry for NEW-FILE.
693 from-file)))
699 ;; For .z, try gunzip. It might be an old gzip file,
700 ;; or it might be from compact? pack? (which?) but gunzip handles both.
705 ;; This item controls naming for compression.
707 "Control changes in file name suffixes for compression and uncompression.
708 Each element specifies one transformation rule, and has the form:
709 (REGEXP NEW-SUFFIX PROGRAM)
710 The rule applies when the old file name matches REGEXP.
711 The new file name is computed by deleting the part that matches REGEXP
712 (as well as anything after that), then adding NEW-SUFFIX in its place.
713 If PROGRAM is non-nil, the rule is an uncompression rule,
714 and uncompression is done by running PROGRAM.
717 ;;;###autoload
719 ;; Compress or uncompress FILE.
720 ;; Return the name of the compressed or uncompressed file.
721 ;; Return nil if no change in files.
723 suffix newname
725 ;; See if any suffix rule matches this file name.
731 ;; If so, compute desired new name.
738 nil)
740 ;; We found an uncompression rule.
743 newname))
745 ;;; We don't recognize the file as compressed, so compress it.
746 ;;; Try gzip; if we don't have that, use compress.
752 out-name)))
757 ;; Rename the compressed file to NEWNAME
758 ;; if it hasn't got that name already.
762 newname)
763 out-name)))
767 ;; Don't use NEWNAME with `compress'.
769 \f
771 ;; Request confirmation from the user that the operation described
772 ;; by OP-SYMBOL is to be performed on the marked files.
773 ;; Confirmation consists in a y-or-n question with a file list
774 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
775 ;; The files used are determined by ARG (as in dired-get-marked-files).
778 ;; Pass t for DISTINGUISH-ONE-MARKED so that a single file which
779 ;; is marked pops up a window. That will help the user see
780 ;; it isn't the current line file.
789 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
790 ; and display failures.
792 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
793 ; the short form of the filename) for a failure and probably logs a
794 ; detailed error explanation using function `dired-log'.
796 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
797 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
798 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
799 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
801 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
813 ;; end this bunch of errors:
817 failures)))))
824 ;; None of these keys quit - use C-g for that.
825 ))
827 ;;;###autoload
829 ;; Query user and return nil or t.
830 ;; Store answer in symbol VAR (which must initially be bound to nil).
831 ;; Format PROMPT with ARGS.
832 ;; Binding variable help-form will help the user who types the help key.
846 result elt)
847 ;; Actually it looks nicer without cursor-in-echo-area - you can
848 ;; look at the dired buffer instead of at the prompt to decide.
857 ;; Display the question with the answer.
861 \f
862 ;;;###autoload
864 "Compress or uncompress marked (or next ARG) files."
868 ;; Commands for Emacs Lisp files - load and byte compile
871 ;; Return nil for success, offending file name else.
873 elc-file buffer-read-only failure)
888 nil)))
890 ;;;###autoload
892 "Byte compile marked (or next ARG) Emacs Lisp files."
897 ;; Return nil for success, offending file name else.
903 nil
907 ;;;###autoload
909 "Load the marked (or next ARG) Emacs Lisp files."
913 ;;;###autoload
915 "Redisplay all marked (or next ARG) files.
916 If on a subdir line, redisplay that subdirectory. In that case,
917 a prefix arg lets you edit the `ls' switches used for the new listing.
919 Dired remembers switches specified with a prefix arg, so that reverting
920 the buffer will not reset them. However, using `dired-undo' to re-insert
921 or delete subdirectories can bypass this machinery. Hence, you sometimes
922 may have to reset some subdirectory switches after a `dired-undo'.
923 You can reset all subdirectory switches to the default using
925 See Info node `(emacs)Subdir switches' for more details."
926 ;; Moves point if the next ARG files are redisplayed.
932 dir
936 dired-subdir-switches
937 dired-actual-switches)))))
939 ;; message much faster than making dired-map-over-marks show progress
945 arg)
950 "Set `dired-switches-alist' to nil and revert dired buffer."
954 \f
956 ;; Delete the current line, and insert an entry for FILE.
957 ;; If FILE is nil, then just delete the current line.
958 ;; Keeps any marks that may be present in column one (doing this
959 ;; here is faster than with dired-add-entry's optional arg).
960 ;; Does not update other dired buffers. Use dired-relist-entry for that.
968 ;; Replace space by old marker without moving point.
969 ;; Faster than goto+insdel inside a save-excursion?
973 ;;;###autoload
980 ;; Add a new entry for FILENAME, optionally marking it
981 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
982 ;; Note that this adds the entry `out of order' if files sorted by
983 ;; time, etc.
984 ;; At least this version inserts in the right subdirectory (if present).
985 ;; And it skips "." or ".." (see `dired-trivial-filenames').
986 ;; Hidden subdirs are exposed if a file is added there.
988 ;; Entry is always for files, even if they happen to also be directories
993 reason)
998 reason
1005 ;; We are already where we should be, except when
1006 ;; point is before the subdir line or its total line.
1010 ;; else try to find correct place to insert
1015 ;; found - skip subdir and `total' line
1016 ;; and uninteresting files like . and ..
1017 ;; This better not moves into the next subdir!
1019 ;; not found
1024 ;; Don't expand `.'. Show just the file name within directory.
1030 ;; Put in desired marker char.
1035 ;; Compensate for a bug in ange-ftp.
1036 ;; It inserts the file's absolute name, rather than
1037 ;; the relative one. That may be hard to fix since it
1038 ;; is probably controlled by something in ftp.
1061 ;; return nil if all went well
1062 nil))
1068 ;; Return pos of first file line of DIR, skipping header and total
1069 ;; or wildcard lines.
1070 ;; Important: never moves into the next subdir.
1071 ;; DIR is assumed to be unhidden.
1072 ;; Will probably be redefined for VMS etc.
1081 ;;;###autoload
1094 ;;;###autoload
1096 "Create or update the line for FILE in all Dired buffers it would belong in."
1102 ;; Relist the line for FILE, or just add it if it did not exist.
1103 ;; FILE must be an absolute file name.
1105 ;; If cursor is already on FILE's line delete-region will cause
1106 ;; save-excursion to fail because of floating makers,
1107 ;; moving point to beginning of line. Sigh.
1116 \f
1117 ;;; Copy, move/rename, making hard and symbolic links
1120 "*Non-nil if Dired should ask about making backups before overwriting files.
1121 Special value `always' suppresses confirmation."
1130 ;; Save old version of file TO that is to be overwritten.
1131 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1132 ;; from dired-create-files.
1135 dired-overwrite-confirmed
1139 "Make backup for existing file `%s'? "
1140 to)))
1145 ;;;###autoload
1150 dired-recursive-copies)
1155 preserve-time top recursive)
1161 ;; This is a directory.
1171 ok-flag preserve-time nil recursive)
1173 ;; Not a directory.
1176 ;; It is a symlink
1180 ;;;###autoload
1184 ;; Silently rename the visited file of any buffer visiting this file.
1189 ;; See if it's an inserted subdir, and rename that, too.
1197 ;; Update visited file name of all affected buffers
1208 to-dir
1209 buffer-file-name)))
1215 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1216 ;; one of its subdirectories is expanded in this buffer.
1224 ;; ELT's subdir is affected by the rename
1227 ;; if top level directory was renamed, lots of things have to be
1228 ;; updated:
1233 ;; with and without wildcards
1235 to))
1238 ;; try to rename buffer, but just leave old name if new
1239 ;; name would already exist (don't try appending "<%d>")
1242 ;; ... we dired TO now:
1246 ;; Update the headerline and dired-subdir-alist element, as well as
1247 ;; dired-switches-alist element, of directory described by
1248 ;; alist-element ELT to reflect the moving of DIR to TO. Thus, ELT
1249 ;; describes either DIR itself or a subdir of DIR.
1253 buffer-read-only)
1255 ;; Update subdir headerline in buffer
1258 dir)
1263 ;; Update buffer-local dired-subdir-alist and dired-switches-alist
1269 \f
1270 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1274 ;; Create a new file for each from a list of existing files. The user
1275 ;; is queried, dired buffers are updated, and at the end a success or
1276 ;; failure message is displayed
1278 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1280 ;; It is called for each file and must create newfile, the entry of
1281 ;; which will be added. The user will be queried if the file already
1282 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1283 ;; rename), it is FILE-CREATOR's responsibility to update dired
1284 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1285 ;; could not create newfile. The error is caught and logged.
1287 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1288 ;; operation performed. It is used for error logging.
1290 ;; FN-LIST is the list of files to copy (full absolute file names).
1292 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1293 ;; skip. If it skips files for other reasons than a direct user
1294 ;; query, it is supposed to tell why (using dired-log).
1296 ;; Optional MARKER-CHAR is a character with which to mark every
1297 ;; newfile's entry, or t to use the current marker character if the
1298 ;; oldfile was marked.
1318 Type SPC or `y' to overwrite file `%s',
1319 DEL or `n' to skip to next,
1320 ESC or `q' to not overwrite any of the remaining files,
1324 ;; must determine if FROM is marked before file-creator
1325 ;; gets a chance to delete it (in case of a move).
1334 ;; If we get here, file-creator hasn't been aborted
1335 ;; and the old entry (if any) has to be deleted
1336 ;; before adding the new entry.
1345 operation from to err))))))))
1346 fn-list))
1353 failures))
1359 skipped))
1364 \f
1366 &optional marker-char op1
1367 how-to)
1368 "Create a new file for each marked file.
1369 Prompts user for target, which is a directory in which to create
1370 the new files. Target may be a plain file if only one marked
1371 file exists. The way the default for the target directory is
1372 computed depends on the value of `dired-dwim-target-directory'.
1373 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1374 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1375 FILE-CREATOR and OPERATION as in `dired-create-files'.
1376 ARG as in `dired-get-marked-files'.
1377 Optional arg MARKER-CHAR as in `dired-create-files'.
1378 Optional arg OP1 is an alternate form for OPERATION if there is
1379 only one file.
1380 Optional arg HOW-TO is used to set the value of the into-dir variable
1381 which determines how to treat target.
1382 If into-dir is set to nil then target is not regarded as a directory,
1383 there must be exactly one marked file, else error.
1384 Else if into-dir is set to a list, then target is a generalized
1385 directory (e.g. some sort of archive). The first element of into-dir
1386 must be a function with at least four arguments:
1387 operation as OPERATION above.
1388 rfn-list a list of the relative names for the marked files.
1389 fn-list a list of the absolute names for the marked files.
1390 target.
1391 The rest of into-dir are optional arguments.
1392 Else into-dir is not a list. Target is a directory.
1393 The marked file(s) are created inside the target directory.
1395 If HOW-TO is not given (or nil), then into-dir is set to true if
1396 target is a directory and otherwise to nil.
1397 Else if HOW-TO is t, then into-dir is set to nil.
1398 Else HOW-TO is assumed to be a function of one argument, target,
1399 that looks at target and returns a value for the into-dir
1400 variable. The function `dired-into-dir-with-symlinks' is provided
1401 for the case (common when creating symlinks) that symbolic
1402 links to directories are not to be considered as directories
1403 (as `file-directory-p' would if HOW-TO had been nil)."
1412 target-dir)))
1416 target-dir op-symbol arg rfn-list default)))
1418 ;; Allow DOS/Windows users to change the letter
1419 ;; case of a directory. If we don't test these
1420 ;; conditions up front, file-directory-p below
1421 ;; will return t because the filesystem is
1422 ;; case-insensitive, and Emacs will try to move
1423 ;; foo -> foo/foo, which fails.
1426 dired-one-file
1434 nil
1442 ;; rename-file bombs when moving directories unless we do this:
1445 file-creator operation fn-list
1447 ;; This function uses fluid variable target when called
1448 ;; inside dired-create-files:
1453 marker-char))))
1455 ;; Read arguments for a marked-files command that wants a file name,
1456 ;; perhaps popping up the list of marked files.
1457 ;; ARG is the prefix arg and indicates whether the files came from
1458 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1459 ;; If the current file was used, the list has but one element and ARG
1460 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1461 ;; DEFAULT is the default value to return if the user just hits RET;
1462 ;; if it is omitted or nil, then the name of the directory is used.
1467 nil op-symbol files
1472 ;; Try to guess which target directory the user may want.
1473 ;; If there is a dired buffer displayed in the next window, use
1474 ;; its current subdir, else use current subdir of this dired buffer.
1477 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1485 this-dir)))
1486 \f
1487 ;;;###autoload
1489 "Create a directory called DIRECTORY."
1500 ;; This may not always be what you want, especially if target is your
1501 ;; home directory and it happens to be a symbolic link, as is often the
1502 ;; case with NFS and automounters. Or if you want to make symlinks
1503 ;; into directories that themselves are only symlinks, also quite
1504 ;; common.
1506 ;; So we don't use this function as value for HOW-TO in
1507 ;; dired-do-symlink, which has the minor disadvantage of
1508 ;; making links *into* a symlinked-dir, when you really wanted to
1509 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1510 ;; just have to remove that symlink by hand before making your marked
1511 ;; symlinks.
1514 "nil or a function used by `dired-do-copy' to determine target.
1517 ;;;###autoload
1519 "Copy all marked (or next ARG) files, or copy the current file.
1520 This normally preserves the last-modified date when copying.
1521 When operating on just the current file, you specify the new name.
1522 When operating on multiple or marked files, you specify a directory,
1523 and new copies of these files are made in that directory
1524 with the same names that the files currently have. The default
1525 suggested for the target directory depends on the value of
1526 `dired-dwim-target', which see."
1530 "Copy"
1531 arg dired-keep-marker-copy
1532 nil dired-copy-how-to-fn)))
1534 ;;;###autoload
1536 "Make symbolic links to current file or all marked (or next ARG) files.
1537 When operating on just the current file, you specify the new name.
1538 When operating on multiple or marked files, you specify a directory
1539 and new symbolic links are made in that directory
1540 with the same names that the files currently have. The default
1541 suggested for the target directory depends on the value of
1542 `dired-dwim-target', which see."
1547 ;;;###autoload
1549 "Add names (hard links) current file or all marked (or next ARG) files.
1550 When operating on just the current file, you specify the new name.
1551 When operating on multiple or marked files, you specify a directory
1552 and new hard links are made in that directory
1553 with the same names that the files currently have. The default
1554 suggested for the target directory depends on the value of
1555 `dired-dwim-target', which see."
1562 ;; error is caught in -create-files
1564 ;; Update the link count
1567 ;;;###autoload
1569 "Rename current file or all marked (or next ARG) files.
1570 When renaming just the current file, you specify the new name.
1571 When renaming multiple or marked files, you specify a directory.
1572 This command also renames any buffers that are visiting the files.
1573 The default suggested for the target directory depends on the value
1574 of `dired-dwim-target', which see."
1578 ;;;###end dired-cp.el
1579 \f
1580 ;;; 5K
1581 ;;;###begin dired-re.el
1584 ;; Create a new file for each marked file using regexps.
1585 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1586 ;; ARG as in dired-get-marked-files.
1587 ;; Matches each marked file against REGEXP and constructs the new
1588 ;; filename from NEWNAME (like in function replace-match).
1589 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1590 ;; instead of only the non-directory part of the file.
1591 ;; Optional arg MARKER-CHAR as in dired-create-files.
1596 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1597 `!' to %s all remaining matches with no more questions."
1601 ;; Function to construct new filename using REGEXP and NEWNAME:
1606 ;; must bind help-form directly around call to
1607 ;; dired-query
1611 operation-prompt
1612 from
1613 to)
1614 to)
1616 operation from regexp)))))
1617 ;; not whole-name, replace non-directory part only
1628 operation-prompt
1631 to)
1634 rename-regexp-query)
1636 file-creator operation fn-list regexp-name-constructor marker-char)))
1639 ;; Prompt user about performing OPERATION.
1640 ;; Read and return list of: regexp newname arg whole-name.
1653 ;;;###autoload
1655 "Rename selected files whose names match REGEXP to NEWNAME.
1657 With non-zero prefix argument ARG, the command operates on the next ARG
1658 files. Otherwise, it operates on all the marked files, or the current
1659 file if none are marked.
1661 As each match is found, the user must type a character saying
1664 REGEXP defaults to the last regexp used.
1666 With a zero prefix arg, renaming by regexp affects the absolute file name.
1667 Normally, only the non-directory part of the file name is used and changed."
1673 ;;;###autoload
1675 "Copy selected files whose names match REGEXP to NEWNAME.
1676 See function `dired-do-rename-regexp' for more info."
1682 arg regexp newname whole-name dired-keep-marker-copy)))
1684 ;;;###autoload
1686 "Hardlink selected files whose names match REGEXP to NEWNAME.
1687 See function `dired-do-rename-regexp' for more info."
1693 ;;;###autoload
1695 "Symlink selected files whose names match REGEXP to NEWNAME.
1696 See function `dired-do-rename-regexp' for more info."
1704 ;; Perform FILE-CREATOR on the non-directory part of marked files
1705 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1706 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1709 file-creator
1710 operation
1718 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1719 `!' to %s all remaining matches with no more questions."
1726 to))))
1727 dired-keep-marker-rename)))
1732 basename-constructor operation arg))
1734 ;;;###autoload
1736 "Rename all marked (or next ARG) files to upper case."
1740 ;;;###autoload
1742 "Rename all marked (or next ARG) files to lower case."
1746 ;;;###end dired-re.el
1747 \f
1748 ;;; 13K
1749 ;;;###begin dired-ins.el
1751 ;;;###autoload
1753 switches no-error-if-not-dir-p)
1754 "Insert this subdirectory into the same dired buffer.
1756 else inserts it at its natural place (as `ls -lR' would have done).
1757 With a prefix arg, you may edit the ls switches used for this listing.
1758 You can add `R' to the switches to expand the whole tree starting at
1759 this subdirectory.
1760 This function takes some pains to conform to `ls -lR' output.
1762 Dired remembers switches specified with a prefix arg, so that reverting
1763 the buffer will not reset them. However, using `dired-undo' to re-insert
1764 or delete subdirectories can bypass this machinery. Hence, you sometimes
1765 may have to reset some subdirectory switches after a `dired-undo'.
1766 You can reset all subdirectory switches to the default using
1768 See Info node `(emacs)Subdir switches' for more details."
1775 ;; We don't need a marker for opoint as the subdir is always
1776 ;; inserted *after* opoint.
1781 ;; Push mark so that it's easy to find back. Do this after the
1782 ;; insert message so that the user sees the `Mark set' message.
1785 ;;;###autoload
1787 "Insert this subdirectory into the same dired buffer.
1788 If it is already present, overwrites previous entry,
1789 else inserts it at its natural place (as `ls -lR' would have done).
1790 With a prefix arg, you may edit the `ls' switches used for this listing.
1791 You can add `R' to the switches to expand the whole tree starting at
1792 this subdirectory.
1793 This function takes some pains to conform to `ls -lR' output."
1794 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1795 ;; Prospero where dired-ls does the right thing, but
1796 ;; file-directory-p has not been redefined.
1810 switches-have-R mark-alist case-fold-search buffer-read-only)
1813 ;; case-fold-search is nil now, so we can test for capital `R':
1815 ;; avoid duplicated subdirs
1818 ;; If subdir is already present, remove it and remember its marks
1841 ;; This is a separate function for dired-vms.
1843 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1844 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1857 ;; all switches that make a difference to dired-get-filename:
1861 ;; Add new DIR at NEW-MARKER. Sort alist.
1866 ;; Keep the alist sorted on buffer position.
1874 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1875 Interactively, you can kill DIRNAME as well by using a prefix argument.
1876 In interactive use, the command prompts for DIRNAME.
1878 When called from Lisp, if REMEMBER-MARKS is non-nil, return an alist
1879 of marked files. If KILL-ROOT is non-nil, kill DIRNAME as well."
1890 m-alist))
1893 ;; Find pos for new subdir, according to tree order.
1894 ;;(goto-char (point-max))
1902 ;; Insert NEW-DIR after DIR
1904 alist nil)))
1906 ;; want a separating newline between subdirs
1913 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1914 ;; Move to that buffer position. Return a mark-alist.
1917 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1926 ;; Insert ls output after point.
1927 ;; Return the boundary of the inserted text (as list of BEG and END).
1932 dired-subdir-switches
1935 ;; If doing the top level directory of the buffer,
1936 ;; redo it as specified in dired-directory.
1942 ;; Point is at the correct subdir alist position for ELT,
1943 ;; BEG-END is the subdir-region (as list of begin and end).
1945 ;; update its position (should actually be unchanged)
1948 ;; The hook may depend on the subdir-alist containing the just
1949 ;; inserted subdir, so run it after dired-alist-add:
1957 ;; hook may add or delete lines, but the subdir boundary
1958 ;; marker floats
1962 ;; Lexicographic order on file name components, like `ls -lR':
1963 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1964 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1965 ;; or DIR1 and DIR2 are in the same parentdir and their last
1966 ;; components are string-lessp.
1967 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1968 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1969 ;; if dired-actual-switches contained `t'.
1975 components-2
1987 t)
1989 nil)
1992 ;; There should be a builtin split function - inverse to mapconcat.
1994 "Splitting on regexp PAT, turn string STR into a list of substrings.
1995 Optional third arg LIMIT (>= 1) is a limit to the length of the
1996 resulting list.
1997 Thus, if SEP is a regexp that only matches itself,
1999 (mapconcat 'identity (dired-split SEP STRING) SEP)
2001 is always equal to STRING."
2014 start end)
2015 ))
2022 \f
2023 ;;; moving by subdirectories
2025 ;;;###autoload
2027 "Go to previous subdirectory, regardless of level.
2028 When called interactively and not on a subdir line, go to this subdir's line."
2029 ;;(interactive "p")
2033 ;; if on subdir start already, don't stay there!
2043 ;;;###autoload
2045 "Go to end of header line of DIR in this dired buffer.
2046 Return value of point on success, otherwise return nil.
2052 dired-subdir-alist ; table
2053 nil ; predicate
2054 t ; require-match
2061 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
2062 ;; at either \r or \n after this function succeeds.
2065 \f
2066 ;;;###autoload
2068 "Mark all files except `.' and `..' in current subdirectory.
2069 If the Dired buffer shows multiple directories, this command
2070 marks the files listed in the subdirectory that point is in."
2075 ;;;###autoload
2077 "Remove all lines of current subdirectory.
2078 Lower levels are unaffected."
2079 ;; With optional REMEMBER-MARKS, return a mark-alist.
2086 buffer-read-only)
2100 ;; Remove DIR from the alist
2104 ;;;###autoload
2106 "Go up ARG levels in the dired tree."
2112 ;;(setq dir (expand-file-name dir))
2116 ;;;###autoload
2118 "Go down in the dired tree."
2132 \f
2133 ;;; hiding
2149 ;;;###autoload
2151 "Hide or unhide the current subdirectory and move to next directory.
2152 Optional prefix arg is a repeat factor.
2162 buffer-read-only)
2163 ;; keep header line visible, hide rest
2172 ;;;###autoload
2174 "Hide all subdirectories, leaving only their header lines.
2175 If there is already something hidden, make everything visible again.
2180 buffer-read-only)
2184 ;; unhide - bombs on \r in filenames
2186 ;; hide
2193 ;; we're somewhere on current dir's line
2201 ;;;###end dired-ins.el
2203 \f
2204 ;; Functions for searching in tags style among marked files.
2206 ;;;###autoload
2208 "Search through all marked files for a match for REGEXP.
2209 Stops when a match is found.
2214 ;;;###autoload
2216 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2217 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2228 buffer-read-only))
2235 \f
2236 ;;;###autoload
2238 "Print the type of FILE, according to the `file' command.
2239 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2240 true then the type of the file linked to by FILE is printed instead."
2252 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2253 ;;; dired-aux.el ends here