| blob | 0709e0cfe1ce340953d746d0b0b0783ebf877905 |
1 ;;; dired-aux.el --- less commonly used parts of dired -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1998, 2000, 2001, 2004
4 ;; 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., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, 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'."
71 diff-switches
75 ;;;###autoload
77 "Diff this file with its backup file or vice versa.
78 Uses the latest backup, if there are several numerical backups.
79 If this file is a backup, diff it with its original.
80 The backup file is the first file given to `diff'.
81 With prefix arg, prompt for argument SWITCHES which is options for `diff'."
86 diff-switches
88 nil))
92 "Mark files with different file attributes in two dired buffers.
93 Compare file attributes of files in the current directory
94 with file attributes in directory DIR2 using PREDICATE on pairs of files
95 with the same name. Mark files for which PREDICATE returns non-nil.
96 Mark files with different names if PREDICATE is nil (or interactively
97 when the user enters empty input at the predicate prompt).
99 PREDICATE is a Lisp expression that can refer to the following variables:
101 size1, size2 - file size in bytes
102 mtime1, mtime2 - last modification time in seconds, as a float
103 fa1, fa2 - list of file attributes
104 returned by function `file-attributes'
106 where 1 refers to attribute of file in the current dired buffer
107 and 2 to attribute of file in second dired buffer.
109 Examples of PREDICATE:
111 (> mtime1 mtime2) - mark newer files
112 (not (= size1 size2)) - mark files with different sizes
113 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
114 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
115 (= (nth 3 fa1) (nth 3 fa2)))) and GID."
125 'cadr
127 file-alist1 file-alist2
128 predicate)))
130 'cadr
132 file-alist2 file-alist1
133 predicate))))
135 dir1 nil
140 dir2 nil
149 "Combine LIST1 and LIST2 using a set-difference operation.
150 The result list contains all file items that appear in LIST1 but not LIST2.
151 This is a non-destructive function; it makes a copy of the data if necessary
152 to avoid corrupting the original LIST1 and LIST2.
153 PREDICATE (see `dired-compare-directories') is an additional match
154 condition. Two file items are considered to match if they are equal
155 *and* PREDICATE evaluates to t."
157 list1
173 list)
178 "Return a list of all file names and attributes from DIR.
179 List has a form of (file-name full-file-name (attribute-list))"
184 full-file-name
187 \f
189 ;; Change file attributes (mode, group, owner, timestamp) of marked files and
190 ;; refresh their file lines.
191 ;; ATTRIBUTE-NAME is a string describing the attribute to the user.
192 ;; PROGRAM is the program used to change the attribute.
193 ;; OP-SYMBOL is the type of operation (for use in dired-mark-pop-up).
194 ;; ARG describes which files to use, as in dired-get-marked-files.
199 nil op-symbol arg files))
201 failures)
212 files))
217 nil))))
219 ;;;###autoload
221 "Change the mode of the marked (or next ARG) files.
222 This calls chmod, thus symbolic modes like `g+w' are allowed."
226 ;;;###autoload
228 "Change the group of the marked (or next ARG) files."
234 ;;;###autoload
236 "Change the owner of the marked (or next ARG) files."
243 "Change the timestamp of the marked (or next ARG) files.
244 This calls touch."
248 ;; Process all the files in FILES in batches of a convenient size,
249 ;; by means of (FUNCALL FUNCTION ARGS... SOME-FILES...).
250 ;; Batches are chosen to need less than MAX chars for the file names,
251 ;; allowing 3 extra characters of separator per file name.
254 past
256 failures)
257 ;; Accumulate files as long as they fit in MAX chars,
258 ;; then process the ones accumulated so far.
263 ;; If we have at least 1 pending file
264 ;; and this file won't fit in the length limit, process now.
267 ;; The elements of PENDING are now in forward order.
268 ;; Do the operation and record failures.
270 failures)
271 ;; Transfer the elemens of PENDING onto PAST
272 ;; and clear it out. Now PAST contains the first N files
273 ;; specified (for some N), and FILES contains the rest.
275 pending nil
277 ;; Do (setq pending (cons thisfile pending))
278 ;; but reuse the cons that was in `files'.
286 failures)
287 ;; Now the original list FILES has been put back as it was.
290 ;;;###autoload
292 "Print the marked (or next ARG) files.
293 Uses the shell command coming from variables `lpr-command' and
294 `lpr-switches' as default."
298 "Print %s with: "
303 lpr-switches))
308 ;; Read arguments for a marked-files command that wants a string
309 ;; that is not a file name,
310 ;; perhaps popping up the list of marked files.
311 ;; ARG is the prefix arg and indicates whether the files came from
312 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
313 ;; If the current file was used, the list has but one element and ARG
314 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
317 ;; PROMPT for a string, with INITIAL input.
318 ;; Other args are used to give user feedback and pop-up:
319 ;; OP-SYMBOL of command, prefix ARG, marked FILES.
321 nil op-symbol files
324 \f
325 ;;; Cleaning a directory: flagging some backups for deletion.
330 "Flag numerical backups for deletion.
331 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
332 Positive prefix arg KEEP overrides `dired-kept-versions';
333 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
336 with a prefix argument."
343 late-retention early-retention)
344 ;; Look at each file.
345 ;; If the file has numeric backup versions,
346 ;; put on dired-file-version-alist an element of the form
347 ;; (FILENAME . VERSION-NUMBER-LIST)
349 ;; Sort each VERSION-NUMBER-LIST,
350 ;; and remove the versions not to be deleted.
358 sorted-v-list)))
362 ;; Look at each file. If it is a numeric backup file,
363 ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
367 ;;; Subroutines of dired-clean-directory.
370 ;; Perform FUN with point at the end of each non-directory line.
371 ;; FUN takes one argument, the absolute filename.
386 ;; Only do work if this file is not already in the alist.
388 nil
389 ;; If it looks like file FN has versions, return a list of the versions.
390 ;;That is a list of strings which are file names.
391 ;;The caller may want to flag some of these files for deletion.
396 base-versions
402 dired-file-version-alist)))))))
406 base-version-list)
416 \f
417 ;;; Shell commands
420 ;; "Read a dired shell command prompting with PROMPT (using read-string).
421 ;;ARG is the prefix arg and may be used to indicate in the prompt which
422 ;; files are affected.
423 ;;This is an extra function so that you can redefine it, e.g., to use gmhist."
425 nil 'shell files
430 ;; The in-background argument is only needed in Emacs 18 where
431 ;; shell-command doesn't understand an appended ampersand `&'.
432 ;;;###autoload
434 "Run a shell command COMMAND on the marked files.
435 If no files are marked or a specific numeric prefix arg is given,
437 The prompt mentions the file(s) or the marker, as appropriate.
439 If there is a `*' in COMMAND, surrounded by whitespace, this runs
440 COMMAND just once with the entire file list substituted there.
442 If there is no `*', but there is a `?' in COMMAND, surrounded by
443 whitespace, this runs COMMAND on each file individually with the
444 file name substituted for `?'.
446 Otherwise, this runs COMMAND on each file individually with the
447 file name added at the end of COMMAND (separated by a space).
449 `*' and `?' when not surrounded by whitespace have no special
450 significance for `dired-do-shell-command', and are passed through
451 normally to the shell, but you must confirm first. To pass `*' by
454 If COMMAND produces output, it goes to a separate buffer.
456 This feature does not try to redisplay Dired buffers afterward, as
457 there's no telling what files COMMAND may have changed.
460 When COMMAND runs, its working directory is the top-level directory of
461 the Dired buffer, so output files usually are created there instead of
462 in a subdir.
464 In a noninteractive call (from Lisp code), you must specify
465 the list of file names explicitly with the FILE-LIST argument."
466 ;;Functions dired-run-shell-command and dired-shell-stuff-it do the
467 ;;actual work and can be redefined for customization.
471 ;; Want to give feedback whether this file or marked files are used:
474 current-prefix-arg
475 files)
476 current-prefix-arg
477 files)))
482 ;; Get confirmation for wildcards that may have been meant
483 ;; to control substitution of a file name or the file name list.
497 nil
498 file-list)
499 ;; execute the shell command
503 ;; Might use {,} for bash or csh:
512 ;; "Make up a shell command line from COMMAND and FILE-LIST.
513 ;; If ON-EACH is t, COMMAND should be applied to each file, else
514 ;; simply concat all files and apply COMMAND to this.
515 ;; FILE-LIST's elements will be quoted for the shell."
516 ;; Might be redefined for smarter things and could then use RAW-ARG
517 ;; (coming from interactive P and currently ignored) to decide what to do.
518 ;; Smart would be a way to access basename or extension of file names.
527 retval))
532 file-list dired-mark-separator)))
537 ;; This is an extra function so that it can be redefined by ange-ftp.
544 ;; Return nil for sake of nconc in dired-bunch-files.
545 nil)
546 \f
547 ;; In Emacs 19 this will return program's exit status.
548 ;; This is a separate function so that ange-ftp can redefine it.
550 ; "Run PROGRAM with output to current buffer unless DISCARD is t.
551 ;Remaining arguments are strings passed as command arguments to PROGRAM."
552 ;; Look for a handler for default-directory in case it is a remote file name.
557 program discard arguments)
561 ; "Display MSG while running PROGRAM, and check for output.
562 ;Remaining arguments are strings passed as command arguments to PROGRAM.
563 ; On error, insert output
564 ; in a log buffer and return the offending ARGUMENTS or PROGRAM.
565 ; Caller can cons up a list of failed args.
566 ;Else returns nil for success."
570 ;; Get a clean buffer for error output:
584 nil))))
585 \f
586 ;; Commands that delete or redisplay part of the dired buffer.
607 ;;;###autoload
609 "Kill all marked lines (not the files).
610 With a prefix argument, kill that many lines starting with the current line.
611 \(A negative argument kills lines before the current line.)
612 To kill an entire subdirectory, go to its directory header line
613 and use this command with a prefix argument (the value does not matter)."
614 ;; Returns count of killed lines. FMT="" suppresses message.
630 ;; else kill unmarked lines
641 count))))
643 ;;;###end dired-cmd.el
644 \f
645 ;;; 30K
646 ;;;###begin dired-cp.el
649 ;; Compress or uncompress the current file.
650 ;; Return nil for success, offending filename else.
656 ;; Remove any preexisting entry for the name NEW-FILE.
661 ;; Now replace the current line with an entry for NEW-FILE.
664 from-file)))
670 ;; For .z, try gunzip. It might be an old gzip file,
671 ;; or it might be from compact? pack? (which?) but gunzip handles both.
676 ;; This item controls naming for compression.
678 "Control changes in file name suffixes for compression and uncompression.
679 Each element specifies one transformation rule, and has the form:
680 (REGEXP NEW-SUFFIX PROGRAM)
681 The rule applies when the old file name matches REGEXP.
682 The new file name is computed by deleting the part that matches REGEXP
683 (as well as anything after that), then adding NEW-SUFFIX in its place.
684 If PROGRAM is non-nil, the rule is an uncompression rule,
685 and uncompression is done by running PROGRAM.
688 ;;;###autoload
690 ;; Compress or uncompress FILE.
691 ;; Return the name of the compressed or uncompressed file.
692 ;; Return nil if no change in files.
694 suffix newname
696 ;; See if any suffix rule matches this file name.
702 ;; If so, compute desired new name.
709 nil)
711 ;; We found an uncompression rule.
714 newname))
716 ;;; We don't recognize the file as compressed, so compress it.
717 ;;; Try gzip; if we don't have that, use compress.
725 ;; Rename the compressed file to NEWNAME
726 ;; if it hasn't got that name already.
730 newname)
731 out-name)))
735 ;; Don't use NEWNAME with `compress'.
737 \f
739 ;; Request confirmation from the user that the operation described
740 ;; by OP-SYMBOL is to be performed on the marked files.
741 ;; Confirmation consists in a y-or-n question with a file list
742 ;; pop-up unless OP-SYMBOL is a member of `dired-no-confirm'.
743 ;; The files used are determined by ARG (as in dired-get-marked-files).
754 ; "Map FUN over marked files (with second ARG like in dired-map-over-marks)
755 ; and display failures.
757 ; FUN takes zero args. It returns non-nil (the offending object, e.g.
758 ; the short form of the filename) for a failure and probably logs a
759 ; detailed error explanation using function `dired-log'.
761 ; OP-SYMBOL is a symbol describing the operation performed (e.g.
762 ; `compress'). It is used with `dired-mark-pop-up' to prompt the user
763 ; (e.g. with `Compress * [2 files]? ') and to display errors (e.g.
764 ; `Failed to compress 1 of 2 files - type W to see why ("foo")')
766 ; SHOW-PROGRESS if non-nil means redisplay dired after each file."
778 ;; end this bunch of errors:
782 failures)))))
789 ;; None of these keys quit - use C-g for that.
790 ))
793 ;; Query user and return nil or t.
794 ;; Store answer in symbol VAR (which must initially be bound to nil).
795 ;; Format PROMPT with ARGS.
796 ;; Binding variable help-form will help the user who types the help key.
810 result elt)
811 ;; Actually it looks nicer without cursor-in-echo-area - you can
812 ;; look at the dired buffer instead of at the prompt to decide.
822 \f
823 ;;;###autoload
825 "Compress or uncompress marked (or next ARG) files."
829 ;; Commands for Emacs Lisp files - load and byte compile
832 ;; Return nil for success, offending file name else.
834 elc-file buffer-read-only failure)
849 nil)))
851 ;;;###autoload
853 "Byte compile marked (or next ARG) Emacs Lisp files."
858 ;; Return nil for success, offending file name else.
864 nil
868 ;;;###autoload
870 "Load the marked (or next ARG) Emacs Lisp files."
874 ;;;###autoload
876 "Redisplay all marked (or next ARG) files.
877 If on a subdir line, redisplay that subdirectory. In that case,
878 a prefix arg lets you edit the `ls' switches used for the new listing."
879 ;; Moves point if the next ARG files are redisplayed.
886 ;; message much faster than making dired-map-over-marks show progress
892 arg)
895 \f
897 ;; Delete the current line, and insert an entry for FILE.
898 ;; If FILE is nil, then just delete the current line.
899 ;; Keeps any marks that may be present in column one (doing this
900 ;; here is faster than with dired-add-entry's optional arg).
901 ;; Does not update other dired buffers. Use dired-relist-entry for that.
909 ;; Replace space by old marker without moving point.
910 ;; Faster than goto+insdel inside a save-excursion?
914 ;;;###autoload
921 ;; Add a new entry for FILENAME, optionally marking it
922 ;; with MARKER-CHAR (a character, else dired-marker-char is used).
923 ;; Note that this adds the entry `out of order' if files sorted by
924 ;; time, etc.
925 ;; At least this version inserts in the right subdirectory (if present).
926 ;; And it skips "." or ".." (see `dired-trivial-filenames').
927 ;; Hidden subdirs are exposed if a file is added there.
929 ;; Entry is always for files, even if they happen to also be directories
934 reason)
939 reason
946 ;; We are already where we should be, except when
947 ;; point is before the subdir line or its total line.
951 ;; else try to find correct place to insert
956 ;; found - skip subdir and `total' line
957 ;; and uninteresting files like . and ..
958 ;; This better not moves into the next subdir!
960 ;; not found
965 ;; Don't expand `.'. Show just the file name within directory.
971 ;; Put in desired marker char.
976 ;; Compensate for a bug in ange-ftp.
977 ;; It inserts the file's absolute name, rather than
978 ;; the relative one. That may be hard to fix since it
979 ;; is probably controlled by something in ftp.
1002 ;; return nil if all went well
1003 nil))
1009 ;; Return pos of first file line of DIR, skipping header and total
1010 ;; or wildcard lines.
1011 ;; Important: never moves into the next subdir.
1012 ;; DIR is assumed to be unhidden.
1013 ;; Will probably be redefined for VMS etc.
1022 ;;;###autoload
1035 ;;;###autoload
1037 "Create or update the line for FILE in all Dired buffers it would belong in."
1043 ;; Relist the line for FILE, or just add it if it did not exist.
1044 ;; FILE must be an absolute file name.
1046 ;; If cursor is already on FILE's line delete-region will cause
1047 ;; save-excursion to fail because of floating makers,
1048 ;; moving point to beginning of line. Sigh.
1057 \f
1058 ;;; Copy, move/rename, making hard and symbolic links
1061 "*Decide whether recursive copies are allowed.
1062 nil means no recursive copies.
1063 `always' means copy recursively without asking.
1064 `top' means ask for each directory at top level.
1065 Anything else means ask for each directory."
1074 "*Non-nil if Dired should ask about making backups before overwriting files.
1075 Special value `always' suppresses confirmation."
1084 ;; Save old version of file TO that is to be overwritten.
1085 ;; `dired-overwrite-confirmed' and `overwrite-backup-query' are fluid vars
1086 ;; from dired-create-files.
1089 dired-overwrite-confirmed
1094 to))))
1099 ;;;###autoload
1104 dired-recursive-copies)
1109 preserve-time top recursive)
1123 ok-flag preserve-time nil recursive)
1128 ;;;###autoload
1132 ;; Silently rename the visited file of any buffer visiting this file.
1137 ;; See if it's an inserted subdir, and rename that, too.
1145 ;; Update visited file name of all affected buffers
1156 to-dir
1157 buffer-file-name)))
1163 ;; Rename DIR to TO in headerlines and dired-subdir-alist, if DIR or
1164 ;; one of its subdirectories is expanded in this buffer.
1172 ;; ELT's subdir is affected by the rename
1175 ;; if top level directory was renamed, lots of things have to be
1176 ;; updated:
1181 ;; with and without wildcards
1183 to))
1186 ;; try to rename buffer, but just leave old name if new
1187 ;; name would already exist (don't try appending "<%d>")
1190 ;; ... we dired TO now:
1194 ;; Update the headerline and dired-subdir-alist element of directory
1195 ;; described by alist-element ELT to reflect the moving of DIR to TO.
1196 ;; Thus, ELT describes either DIR itself or a subdir of DIR.
1200 buffer-read-only)
1202 ;; Update subdir headerline in buffer
1205 dir)
1210 ;; Update buffer-local dired-subdir-alist
1214 \f
1215 ;; The basic function for half a dozen variations on cp/mv/ln/ln -s.
1219 ;; Create a new file for each from a list of existing files. The user
1220 ;; is queried, dired buffers are updated, and at the end a success or
1221 ;; failure message is displayed
1223 ;; FILE-CREATOR must accept three args: oldfile newfile ok-if-already-exists
1225 ;; It is called for each file and must create newfile, the entry of
1226 ;; which will be added. The user will be queried if the file already
1227 ;; exists. If oldfile is removed by FILE-CREATOR (i.e, it is a
1228 ;; rename), it is FILE-CREATOR's responsibility to update dired
1229 ;; buffers. FILE-CREATOR must abort by signaling a file-error if it
1230 ;; could not create newfile. The error is caught and logged.
1232 ;; OPERATION (a capitalized string, e.g. `Copy') describes the
1233 ;; operation performed. It is used for error logging.
1235 ;; FN-LIST is the list of files to copy (full absolute file names).
1237 ;; NAME-CONSTRUCTOR returns a newfile for every oldfile, or nil to
1238 ;; skip. If it skips files for other reasons than a direct user
1239 ;; query, it is supposed to tell why (using dired-log).
1241 ;; Optional MARKER-CHAR is a character with which to mark every
1242 ;; newfile's entry, or t to use the current marker character if the
1243 ;; oldfile was marked.
1263 Type SPC or `y' to overwrite file `%s',
1264 DEL or `n' to skip to next,
1265 ESC or `q' to not overwrite any of the remaining files,
1269 ;; must determine if FROM is marked before file-creator
1270 ;; gets a chance to delete it (in case of a move).
1279 ;; If we get here, file-creator hasn't been aborted
1280 ;; and the old entry (if any) has to be deleted
1281 ;; before adding the new entry.
1290 operation from to err))))))))
1291 fn-list))
1298 failures))
1304 skipped))
1309 \f
1311 &optional marker-char op1
1312 how-to)
1313 "Create a new file for each marked file.
1314 Prompts user for target, which is a directory in which to create
1315 the new files. Target may be a plain file if only one marked
1316 file exists. The way the default for the target directory is
1317 computed depends on the value of `dired-dwim-target-directory'.
1318 OP-SYMBOL is the symbol for the operation. Function `dired-mark-pop-up'
1319 will determine whether pop-ups are appropriate for this OP-SYMBOL.
1320 FILE-CREATOR and OPERATION as in `dired-create-files'.
1321 ARG as in `dired-get-marked-files'.
1322 Optional arg MARKER-CHAR as in `dired-create-files'.
1323 Optional arg OP1 is an alternate form for OPERATION if there is
1324 only one file.
1325 Optional arg HOW-TO is used to set the value of the into-dir variable
1326 which determines how to treat target.
1327 If into-dir is set to nil then target is not regarded as a directory,
1328 there must be exactly one marked file, else error.
1329 Else if into-dir is set to a list, then target is a generalized
1330 directory (e.g. some sort of archive). The first element of into-dir
1331 must be a function with at least four arguments:
1332 operation as OPERATION above.
1333 rfn-list a list of the relative names for the marked files.
1334 fn-list a list of the absolute names for the marked files.
1335 target.
1336 The rest of into-dir are optional arguments.
1337 Else into-dir is not a list. Target is a directory.
1338 The marked file(s) are created inside the target directory.
1340 If HOW-TO is not given (or nil), then into-dir is set to true if
1341 target is a directory and otherwise to nil.
1342 Else if HOW-TO is t, then into-dir is set to nil.
1343 Else HOW-TO is assumed to be a function of one argument, target,
1344 that looks at target and returns a value for the into-dir
1345 variable. The function `dired-into-dir-with-symlinks' is provided
1346 for the case (common when creating symlinks) that symbolic
1347 links to directories are not to be considered as directories
1348 (as `file-directory-p' would if HOW-TO had been nil)."
1357 target-dir)))
1361 target-dir op-symbol arg rfn-list default)))
1363 ;; Allow DOS/Windows users to change the letter
1364 ;; case of a directory. If we don't test these
1365 ;; conditions up front, file-directory-p below
1366 ;; will return t because the filesystem is
1367 ;; case-insensitive, and Emacs will try to move
1368 ;; foo -> foo/foo, which fails.
1371 dired-one-file
1379 nil
1387 ;; rename-file bombs when moving directories unless we do this:
1390 file-creator operation fn-list
1392 ;; This function uses fluid variable target when called
1393 ;; inside dired-create-files:
1398 marker-char))))
1400 ;; Read arguments for a marked-files command that wants a file name,
1401 ;; perhaps popping up the list of marked files.
1402 ;; ARG is the prefix arg and indicates whether the files came from
1403 ;; marks (ARG=nil) or a repeat factor (integerp ARG).
1404 ;; If the current file was used, the list has but one element and ARG
1405 ;; does not matter. (It is non-nil, non-integer in that case, namely '(4)).
1406 ;; DEFAULT is the default value to return if the user just hits RET;
1407 ;; if it is omitted or nil, then the name of the directory is used.
1412 nil op-symbol files
1417 ;; Try to guess which target directory the user may want.
1418 ;; If there is a dired buffer displayed in the next window, use
1419 ;; its current subdir, else use current subdir of this dired buffer.
1422 ;; non-dired buffer may want to profit from this function, e.g. vm-uudecode
1430 this-dir)))
1431 \f
1432 ;;;###autoload
1434 "Create a directory called DIRECTORY."
1445 ;; This may not always be what you want, especially if target is your
1446 ;; home directory and it happens to be a symbolic link, as is often the
1447 ;; case with NFS and automounters. Or if you want to make symlinks
1448 ;; into directories that themselves are only symlinks, also quite
1449 ;; common.
1451 ;; So we don't use this function as value for HOW-TO in
1452 ;; dired-do-symlink, which has the minor disadvantage of
1453 ;; making links *into* a symlinked-dir, when you really wanted to
1454 ;; *overwrite* that symlink. In that (rare, I guess) case, you'll
1455 ;; just have to remove that symlink by hand before making your marked
1456 ;; symlinks.
1459 "nil or a function used by `dired-do-copy' to determine target.
1462 ;;;###autoload
1464 "Copy all marked (or next ARG) files, or copy the current file.
1465 This normally preserves the last-modified date when copying.
1466 When operating on just the current file, you specify the new name.
1467 When operating on multiple or marked files, you specify a directory,
1468 and new copies of these files are made in that directory
1469 with the same names that the files currently have. The default
1470 suggested for the target directory depends on the value of
1471 `dired-dwim-target', which see."
1476 arg dired-keep-marker-copy
1477 nil dired-copy-how-to-fn)))
1479 ;;;###autoload
1481 "Make symbolic links to current file or all marked (or next ARG) files.
1482 When operating on just the current file, you specify the new name.
1483 When operating on multiple or marked files, you specify a directory
1484 and new symbolic links are made in that directory
1485 with the same names that the files currently have. The default
1486 suggested for the target directory depends on the value of
1487 `dired-dwim-target', which see."
1492 ;;;###autoload
1494 "Add names (hard links) current file or all marked (or next ARG) files.
1495 When operating on just the current file, you specify the new name.
1496 When operating on multiple or marked files, you specify a directory
1497 and new hard links are made in that directory
1498 with the same names that the files currently have. The default
1499 suggested for the target directory depends on the value of
1500 `dired-dwim-target', which see."
1507 ;; error is caught in -create-files
1509 ;; Update the link count
1512 ;;;###autoload
1514 "Rename current file or all marked (or next ARG) files.
1515 When renaming just the current file, you specify the new name.
1516 When renaming multiple or marked files, you specify a directory.
1517 This command also renames any buffers that are visiting the files.
1518 The default suggested for the target directory depends on the value
1519 of `dired-dwim-target', which see."
1523 ;;;###end dired-cp.el
1524 \f
1525 ;;; 5K
1526 ;;;###begin dired-re.el
1529 ;; Create a new file for each marked file using regexps.
1530 ;; FILE-CREATOR and OPERATION as in dired-create-files.
1531 ;; ARG as in dired-get-marked-files.
1532 ;; Matches each marked file against REGEXP and constructs the new
1533 ;; filename from NEWNAME (like in function replace-match).
1534 ;; Optional arg WHOLE-NAME means match/replace the whole file name
1535 ;; instead of only the non-directory part of the file.
1536 ;; Optional arg MARKER-CHAR as in dired-create-files.
1541 Type SPC or `y' to %s one match, DEL or `n' to skip to next,
1542 `!' to %s all remaining matches with no more questions."
1546 ;; Function to construct new filename using REGEXP and NEWNAME:
1551 ;; must bind help-form directly around call to
1552 ;; dired-query
1556 operation-prompt
1557 from
1558 to)
1559 to)
1561 operation from regexp)))))
1562 ;; not whole-name, replace non-directory part only
1573 operation-prompt
1576 to)
1579 rename-regexp-query)
1581 file-creator operation fn-list regexp-name-constructor marker-char)))
1584 ;; Prompt user about performing OPERATION.
1585 ;; Read and return list of: regexp newname arg whole-name.
1598 ;;;###autoload
1600 "Rename selected files whose names match REGEXP to NEWNAME.
1602 With non-zero prefix argument ARG, the command operates on the next ARG
1603 files. Otherwise, it operates on all the marked files, or the current
1604 file if none are marked.
1606 As each match is found, the user must type a character saying
1609 REGEXP defaults to the last regexp used.
1611 With a zero prefix arg, renaming by regexp affects the absolute file name.
1612 Normally, only the non-directory part of the file name is used and changed."
1618 ;;;###autoload
1620 "Copy selected files whose names match REGEXP to NEWNAME.
1621 See function `dired-do-rename-regexp' for more info."
1627 arg regexp newname whole-name dired-keep-marker-copy)))
1629 ;;;###autoload
1631 "Hardlink selected files whose names match REGEXP to NEWNAME.
1632 See function `dired-do-rename-regexp' for more info."
1638 ;;;###autoload
1640 "Symlink selected files whose names match REGEXP to NEWNAME.
1641 See function `dired-do-rename-regexp' for more info."
1649 ;; Perform FILE-CREATOR on the non-directory part of marked files
1650 ;; using function BASENAME-CONSTRUCTOR, with query for each file.
1651 ;; OPERATION like in dired-create-files, ARG as in dired-get-marked-files.
1654 file-creator
1655 operation
1663 Type SPC or `y' to %s one file, DEL or `n' to skip to next,
1664 `!' to %s all remaining matches with no more questions."
1671 to))))
1672 dired-keep-marker-rename)))
1677 basename-constructor operation arg))
1679 ;;;###autoload
1681 "Rename all marked (or next ARG) files to upper case."
1685 ;;;###autoload
1687 "Rename all marked (or next ARG) files to lower case."
1691 ;;;###end dired-re.el
1692 \f
1693 ;;; 13K
1694 ;;;###begin dired-ins.el
1696 ;;;###autoload
1698 switches no-error-if-not-dir-p)
1699 "Insert this subdirectory into the same dired buffer.
1701 else inserts it at its natural place (as `ls -lR' would have done).
1702 With a prefix arg, you may edit the ls switches used for this listing.
1703 You can add `R' to the switches to expand the whole tree starting at
1704 this subdirectory.
1705 This function takes some pains to conform to `ls -lR' output."
1711 ;; We don't need a marker for opoint as the subdir is always
1712 ;; inserted *after* opoint.
1717 ;; Push mark so that it's easy to find back. Do this after the
1718 ;; insert message so that the user sees the `Mark set' message.
1721 ;;;###autoload
1723 "Insert this subdirectory into the same dired buffer.
1724 If it is already present, overwrites previous entry,
1725 else inserts it at its natural place (as `ls -lR' would have done).
1726 With a prefix arg, you may edit the `ls' switches used for this listing.
1727 You can add `R' to the switches to expand the whole tree starting at
1728 this subdirectory.
1729 This function takes some pains to conform to `ls -lR' output."
1730 ;; NO-ERROR-IF-NOT-DIR-P needed for special filesystems like
1731 ;; Prospero where dired-ls does the right thing, but
1732 ;; file-directory-p has not been redefined.
1743 switches-have-R mark-alist case-fold-search buffer-read-only)
1744 ;; case-fold-search is nil now, so we can test for capital `R':
1746 ;; avoid duplicated subdirs
1749 ;; If subdir is already present, remove it and remember its marks
1758 ;; This is a separate function for dired-vms.
1760 ;; Check that it is valid to insert DIRNAME with SWITCHES.
1761 ;; Signal an error if invalid (e.g. user typed `i' on `..').
1772 x))))
1773 ;; all switches that make a difference to dired-get-filename:
1777 ;; Add new DIR at NEW-MARKER. Sort alist.
1782 ;; Keep the alist sorted on buffer position.
1790 "Kill all proper subdirs of DIRNAME, excluding DIRNAME itself.
1791 With optional arg REMEMBER-MARKS, return an alist of marked files."
1802 m-alist))
1805 ;; Find pos for new subdir, according to tree order.
1806 ;;(goto-char (point-max))
1814 ;; Insert NEW-DIR after DIR
1816 alist nil)))
1818 ;; want a separating newline between subdirs
1825 ;; Erase an already present subdir (given by ELEMENT) from buffer.
1826 ;; Move to that buffer position. Return a mark-alist.
1829 ;; Are at beginning of subdir (and inside it!). Now determine its end:
1838 ;; Insert ls output after point.
1839 ;; Return the boundary of the inserted text (as list of BEG and END).
1847 ;; If doing the top level directory of the buffer,
1848 ;; redo it as specified in dired-directory.
1855 ;; Point is at the correct subdir alist position for ELT,
1856 ;; BEG-END is the subdir-region (as list of begin and end).
1858 ;; update its position (should actually be unchanged)
1861 ;; The hook may depend on the subdir-alist containing the just
1862 ;; inserted subdir, so run it after dired-alist-add:
1870 ;; hook may add or delete lines, but the subdir boundary
1871 ;; marker floats
1875 ;; Lexicographic order on file name components, like `ls -lR':
1876 ;; DIR1 < DIR2 iff DIR1 comes *before* DIR2 in an `ls -lR' listing,
1877 ;; i.e., iff DIR1 is a (grand)parent dir of DIR2,
1878 ;; or DIR1 and DIR2 are in the same parentdir and their last
1879 ;; components are string-lessp.
1880 ;; Thus ("/usr/" "/usr/bin") and ("/usr/a/" "/usr/b/") are tree-lessp.
1881 ;; string-lessp could arguably be replaced by file-newer-than-file-p
1882 ;; if dired-actual-switches contained `t'.
1888 components-2
1900 t)
1902 nil)
1905 ;; There should be a builtin split function - inverse to mapconcat.
1907 "Splitting on regexp PAT, turn string STR into a list of substrings.
1908 Optional third arg LIMIT (>= 1) is a limit to the length of the
1909 resulting list.
1910 Thus, if SEP is a regexp that only matches itself,
1912 (mapconcat 'identity (dired-split SEP STRING) SEP)
1914 is always equal to STRING."
1927 start end)
1928 ))
1935 \f
1936 ;;; moving by subdirectories
1938 ;;;###autoload
1940 "Go to previous subdirectory, regardless of level.
1941 When called interactively and not on a subdir line, go to this subdir's line."
1942 ;;(interactive "p")
1946 ;; if on subdir start already, don't stay there!
1956 ;;;###autoload
1958 "Go to end of header line of DIR in this dired buffer.
1959 Return value of point on success, otherwise return nil.
1965 dired-subdir-alist ; table
1966 nil ; predicate
1967 t ; require-match
1974 ;; dired-subdir-hidden-p and dired-add-entry depend on point being
1975 ;; at either \r or \n after this function succeeds.
1978 \f
1979 ;;;###autoload
1981 "Mark all files except `.' and `..' in current subdirectory.
1982 If the Dired buffer shows multiple directories, this command
1983 marks the files listed in the subdirectory that point is in."
1988 ;;;###autoload
1990 "Remove all lines of current subdirectory.
1991 Lower levels are unaffected."
1992 ;; With optional REMEMBER-MARKS, return a mark-alist.
1996 buffer-read-only cur-dir)
2008 ;; Remove DIR from the alist
2012 ;;;###autoload
2014 "Go up ARG levels in the dired tree."
2020 ;;(setq dir (expand-file-name dir))
2024 ;;;###autoload
2026 "Go down in the dired tree."
2040 \f
2041 ;;; hiding
2057 ;;;###autoload
2059 "Hide or unhide the current subdirectory and move to next directory.
2060 Optional prefix arg is a repeat factor.
2069 buffer-read-only)
2070 ;; keep header line visible, hide rest
2078 ;;;###autoload
2080 "Hide all subdirectories, leaving only their header lines.
2081 If there is already something hidden, make everything visible again.
2089 ;; unhide - bombs on \r in filenames
2091 ;; hide
2098 ;; we're somewhere on current dir's line
2105 ;;;###end dired-ins.el
2107 \f
2108 ;; Functions for searching in tags style among marked files.
2110 ;;;###autoload
2112 "Search through all marked files for a match for REGEXP.
2113 Stops when a match is found.
2118 ;;;###autoload
2120 "Do `query-replace-regexp' of FROM with TO, on all marked files.
2121 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
2129 buffer-read-only))
2136 \f
2137 ;;;###autoload
2139 "Print the type of FILE, according to the `file' command.
2140 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
2141 true then the type of the file linked to by FILE is printed instead."
2153 ;;; arch-tag: 4b508de9-a153-423d-8d3f-a1bbd86f4f60
2154 ;;; dired-aux.el ends here