X-Git-Url: https://git.hcoop.net/bpt/emacs.git/blobdiff_plain/142e26a72e9b8bbbec23c6bf7234e9f2544b5f89..d3e4228575e9ba9e99dc4a7dae788280ffcc4566:/lisp/wdired.el diff --git a/lisp/wdired.el b/lisp/wdired.el index 91db7aeb2e..b893e8f6f2 100644 --- a/lisp/wdired.el +++ b/lisp/wdired.el @@ -1,6 +1,6 @@ ;;; wdired.el --- Rename files editing their names in dired buffers -;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. +;; Copyright (C) 2004-2012 Free Software Foundation, Inc. ;; Filename: wdired.el ;; Author: Juan León Lahoz García @@ -32,7 +32,7 @@ ;; the files in a "dired" buffer? Now you can do this. All the power ;; of Emacs commands are available to renaming files! ;; -;; This package provides a function that makes the filenames of a a +;; This package provides a function that makes the filenames of a ;; dired buffer editable, by changing the buffer mode (which inhibits ;; all of the commands of dired mode). Here you can edit the names of ;; one or more files and directories, and when you press C-c C-c, the @@ -58,39 +58,13 @@ ;; ;; - To mark files for deletion, by deleting their whole filename. -;;; Installation: - -;; Add this file (byte-compiling it is recommended) to your load-path. -;; Then add one of these set of lines (or similar ones) to your config: -;; -;; This is the easy way: -;; -;; (require 'wdired) -;; (define-key dired-mode-map "r" 'wdired-change-to-wdired-mode) -;; -;; This is the recommended way for faster Emacs startup time and lower -;; memory consumption: -;; -;; (autoload 'wdired-change-to-wdired-mode "wdired") -;; (eval-after-load "dired" -;; '(lambda () -;; (define-key dired-mode-map "r" 'wdired-change-to-wdired-mode) -;; (define-key dired-mode-map -;; [menu-bar immediate wdired-change-to-wdired-mode] -;; '("Edit File Names" . wdired-change-to-wdired-mode)))) -;; -;; Type "M-x customize-group RET wdired" if you want to make changes -;; to the default behavior. - ;;; Usage: -;; Then, you can start editing the names of the files by typing "r" -;; (or whatever key you choose, or M-x wdired-change-to-wdired-mode). -;; Use C-c C-c when finished or C-c C-k to abort. You can use also the -;; menu options: in dired mode, "Edit File Names" under "Immediate". -;; While editing the names, a new submenu "WDired" is available at top -;; level. You can customize the behavior of this package from this -;; menu. +;; You can edit the names of the files by typing C-x C-q or by +;; executing M-x wdired-change-to-wdired-mode. Use C-c C-c when +;; finished or C-c C-k to abort. While editing filenames, a new +;; submenu "WDired" is available at top level. You can customize the +;; behavior of this package from this menu. ;;; Change Log: @@ -101,7 +75,6 @@ (defvar dired-backup-overwrite) ; Only in Emacs 20.x this is a custom var -(eval-when-compile (require 'cl)) (require 'dired) (autoload 'dired-do-create-files-regexp "dired-aux") @@ -210,14 +183,21 @@ program `dired-chmod-program', which must exist." (defun wdired-mode () - "\\File Names Editing mode. + "Writable Dired (WDired) mode. +\\ +In WDired mode, you can edit the names of the files in the +buffer, the target of the links, and the permission bits of the +files. + +Type \\[wdired-finish-edit] to exit WDired mode, returning to +Dired mode, and make your edits \"take effect\" by modifying the +file and directory names, link targets, and/or file permissions +on disk. If you delete the filename of a file, it is flagged for +deletion in the Dired buffer. -Press \\[wdired-finish-edit] to make the changes to take effect -and exit. To abort the edit, use \\[wdired-abort-changes]. +Type \\[wdired-abort-changes] to abort your edits and exit WDired mode. -In this mode you can edit the names of the files, the target of -the links and the permission bits of the files. You can use -\\[customize-group] RET wdired to customize WDired behavior. +Type \\[customize-group] RET wdired to customize WDired behavior. The only editable texts in a WDired buffer are filenames, symbolic link targets, and filenames permission." @@ -228,20 +208,23 @@ symbolic link targets, and filenames permission." ;;;###autoload (defun wdired-change-to-wdired-mode () - "Put a dired buffer in a mode in which filenames are editable. + "Put a Dired buffer in Writable Dired (WDired) mode. \\ -This mode allows the user to change the names of the files, and after -typing \\[wdired-finish-edit] Emacs renames the files and directories -in disk. +In WDired mode, you can edit the names of the files in the +buffer, the target of the links, and the permission bits of the +files. After typing \\[wdired-finish-edit], Emacs modifies the files and +directories to reflect your edits. See `wdired-mode'." (interactive) - (or (eq major-mode 'dired-mode) - (error "Not a Dired buffer")) + (unless (eq major-mode 'dired-mode) + (error "Not a Dired buffer")) (set (make-local-variable 'wdired-old-content) (buffer-substring (point-min) (point-max))) (set (make-local-variable 'wdired-old-point) (point)) (set (make-local-variable 'query-replace-skip-read-only) t) + (set (make-local-variable 'isearch-filter-predicate) + 'wdired-isearch-filter-read-only) (use-local-map wdired-mode-map) (force-mode-line-update) (setq buffer-read-only nil) @@ -267,11 +250,16 @@ See `wdired-mode'." "Press \\[wdired-finish-edit] when finished \ or \\[wdired-abort-changes] to abort changes"))) +(defun wdired-isearch-filter-read-only (beg end) + "Skip matches that have a read-only property." + (and (isearch-filter-visible beg end) + (not (text-property-not-all (min beg end) (max beg end) + 'read-only nil)))) ;; Protect the buffer so only the filenames can be changed, and put ;; properties so filenames (old and new) can be easily found. (defun wdired-preprocess-files () - (put-text-property 1 2 'front-sticky t) + (put-text-property (point-min) (1+ (point-min))'front-sticky t) (save-excursion (goto-char (point-min)) (let ((b-protection (point)) @@ -368,11 +356,12 @@ non-nil means return old filename." "Actually rename files based on your editing in the Dired buffer." (interactive) (wdired-change-to-dired-mode) - (let ((overwrite (or (not wdired-confirm-overwrite) 1)) - (changes nil) - (files-deleted nil) + (let ((changes nil) (errors 0) - file-ori file-new tmp-value) + files-deleted + files-renamed + some-file-names-unchanged + file-old file-new tmp-value) (save-excursion (when (and wdired-allow-to-redirect-links (fboundp 'make-symbolic-link)) @@ -386,33 +375,32 @@ non-nil means return old filename." (setq changes (or changes (car tmp-value)))) (goto-char (point-max)) (while (not (bobp)) - (setq file-ori (wdired-get-filename nil t)) - (when file-ori - (setq file-new (wdired-get-filename))) - (when (and file-ori (not (equal file-new file-ori))) - (setq changes t) - (if (not file-new) ;empty filename! - (setq files-deleted (cons file-ori files-deleted)) - (setq file-new (substitute-in-file-name file-new)) - (if wdired-use-interactive-rename - (wdired-search-and-rename file-ori file-new) - ;; If dired-rename-file autoloads dired-aux while - ;; dired-backup-overwrite is locally bound, - ;; dired-backup-overwrite won't be initialized. - ;; So we must ensure dired-aux is loaded. - (require 'dired-aux) - (condition-case err - (let ((dired-backup-overwrite nil)) - (dired-rename-file file-ori file-new - overwrite)) - (error - (setq errors (1+ errors)) - (dired-log (concat "Rename `" file-ori "' to `" - file-new "' failed:\n%s\n") - err)))))) + (setq file-old (wdired-get-filename nil t)) + (when file-old + (setq file-new (wdired-get-filename)) + (if (equal file-new file-old) + (setq some-file-names-unchanged t) + (setq changes t) + (if (not file-new) ;empty filename! + (push file-old files-deleted) + (push (cons file-old (substitute-in-file-name file-new)) + files-renamed)))) (forward-line -1))) + (when files-renamed + (setq errors (+ errors (wdired-do-renames files-renamed)))) (if changes - (revert-buffer) ;The "revert" is necessary to re-sort the buffer + (progn + ;; If we are displaying a single file (rather than the + ;; contents of a directory), change dired-directory if that + ;; file was renamed. (This ought to be generalized to + ;; handle the multiple files case, but that's less trivial). + (when (and (stringp dired-directory) + (not (file-directory-p dired-directory)) + (null some-file-names-unchanged) + (= (length files-renamed) 1)) + (setq dired-directory (cdr (car files-renamed)))) + ;; Re-sort the buffer. + (revert-buffer)) (let ((inhibit-read-only t)) (remove-text-properties (point-min) (point-max) '(old-name nil end-name nil old-link nil @@ -426,6 +414,67 @@ non-nil means return old filename." (set-buffer-modified-p nil) (setq buffer-undo-list nil)) +(defun wdired-do-renames (renames) + "Perform RENAMES in parallel." + (let ((residue ()) + (progress nil) + (errors 0) + (overwrite (or (not wdired-confirm-overwrite) 1))) + (while (or renames + ;; We've done one round through the renames, we have found + ;; some residue, but we also made some progress, so maybe + ;; some of the residue were resolved: try again. + (prog1 (setq renames residue) + (setq progress nil) + (setq residue nil))) + (let* ((rename (pop renames)) + (file-new (cdr rename))) + (cond + ((rassoc file-new renames) + (error "Trying to rename 2 files to the same name")) + ((assoc file-new renames) + ;; Renaming to a file name that already exists but will itself be + ;; renamed as well. Let's wait until that one gets renamed. + (push rename residue)) + ((and (assoc file-new residue) + ;; Make sure the file really exists: if it doesn't it's + ;; not really a conflict. It might be a temp-file generated + ;; specifically to break a circular renaming. + (file-exists-p file-new)) + ;; Renaming to a file name that already exists, needed to be renamed, + ;; but whose renaming could not be performed right away. + (if (or progress renames) + ;; There's still a chance the conflict will be resolved. + (push rename residue) + ;; We have not made any progress and we've reached the end of + ;; the renames, so we really have a circular conflict, and we + ;; have to forcefully break the cycle. + (message "Circular renaming: using temporary file name") + (let ((tmp (make-temp-name file-new))) + (push (cons (car rename) tmp) renames) + (push (cons tmp file-new) residue)))) + (t + (setq progress t) + (let ((file-ori (car rename))) + (if wdired-use-interactive-rename + (wdired-search-and-rename file-ori file-new) + ;; If dired-rename-file autoloads dired-aux while + ;; dired-backup-overwrite is locally bound, + ;; dired-backup-overwrite won't be initialized. + ;; So we must ensure dired-aux is loaded. + (require 'dired-aux) + (condition-case err + (let ((dired-backup-overwrite nil)) + (dired-rename-file file-ori file-new + overwrite)) + (error + (setq errors (1+ errors)) + (dired-log (concat "Rename `" file-ori "' to `" + file-new "' failed:\n%s\n") + err))))))))) + errors)) + + (defun wdired-exit () "Exit wdired and return to dired mode. Just return to dired mode if there are no changes. Otherwise, @@ -449,14 +498,13 @@ and proceed depending on the answer." (save-excursion (goto-char (point-max)) (forward-line -1) - (let ((exit-while nil) + (let ((done nil) curr-filename) - (while (not exit-while) - (setq curr-filename (wdired-get-filename)) - (if (and curr-filename - (equal (substitute-in-file-name curr-filename) filename-new)) + (while (and (not done) (not (bobp))) + (setq curr-filename (wdired-get-filename nil t)) + (if (equal curr-filename filename-ori) (progn - (setq exit-while t) + (setq done t) (let ((inhibit-read-only t)) (dired-move-to-filename) (search-forward (wdired-get-filename t) nil t) @@ -464,9 +512,7 @@ and proceed depending on the answer." (dired-do-create-files-regexp (function dired-rename-file) "Move" 1 ".*" filename-new nil t)) - (forward-line -1) - (beginning-of-line) - (setq exit-while (bobp))))))) + (forward-line -1)))))) ;; marks a list of files for deletion (defun wdired-flag-for-deletion (filenames-ori) @@ -482,7 +528,7 @@ and proceed depending on the answer." (interactive) (customize-apropos "wdired" 'groups)) -(defun wdired-revert (&optional arg noconfirm) +(defun wdired-revert (&optional _arg _noconfirm) "Discard changes in the buffer and update it based on changes on disk. Optional arguments are ignored." (wdired-change-to-dired-mode) @@ -494,7 +540,7 @@ Optional arguments are ignored." (if (and (buffer-modified-p) (not (y-or-n-p "Buffer changed. Discard changes and kill buffer? "))) - (error "Error."))) + (error "Error"))) (defun wdired-next-line (arg) "Move down lines then position at filename or the current column. @@ -590,7 +636,7 @@ If OLD, return the old target. If MOVE, move point before it." (if (< arg 0) (funcall command arg) (while (> arg 0) - (condition-case err + (condition-case nil (progn (funcall command 1) (setq arg (1- arg))) @@ -683,9 +729,9 @@ Like original function but it skips read-only words." (defun wdired-set-bit () "Set a permission bit character." (interactive) - (if (wdired-perm-allowed-in-pos last-command-char + (if (wdired-perm-allowed-in-pos last-command-event (- (current-column) wdired-col-perm)) - (let ((new-bit (char-to-string last-command-char)) + (let ((new-bit (char-to-string last-command-event)) (inhibit-read-only t) (pos-prop (- (point) (- (current-column) wdired-col-perm)))) (put-text-property 0 1 'keymap wdired-perm-mode-map new-bit) @@ -782,5 +828,4 @@ Like original function but it skips read-only words." ;; byte-compile-dynamic: t ;; End: -;; arch-tag: bc00902e-526f-4305-bc7f-8862a559184f ;;; wdired.el ends here