X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/6a84b1a2f5a7e7512799a49e0d2b7b1066c8036d..aef88a00d364bbb208acff2d9b66b2a1eb6cf8f5:/lisp/wdired.el diff --git a/lisp/wdired.el b/lisp/wdired.el index 4ba97d6ab6..013e14ec7f 100644 --- a/lisp/wdired.el +++ b/lisp/wdired.el @@ -1,17 +1,17 @@ ;;; wdired.el --- Rename files editing their names in dired buffers -;; Copyright (C) 2001, 2004 Free Software Foundation, Inc. +;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. ;; Filename: wdired.el -;; Author: Juan León Lahoz García -;; Version: 1.91 +;; Author: Juan León Lahoz García +;; Version: 2.0 ;; Keywords: dired, environment, files, renaming ;; This file is part of GNU Emacs. ;; GNU Emacs is free software; you can redistribute it and/or ;; modify it under the terms of the GNU General Public License as -;; published by the Free Software Foundation; either version 2, or (at +;; published by the Free Software Foundation; either version 3, or (at ;; your option) any later version. ;; This program is distributed in the hope that it will be useful, but @@ -21,8 +21,8 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to the -;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, -;; Boston, MA 02111-1307, USA. +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: @@ -30,17 +30,17 @@ ;; renaming files. ;; ;; Have you ever wished to use C-x r t (string-rectangle), M-% -;; (query-replace), M-c (capitalize-word), etc to change the name of -;; the files in a "dired" buffer? Now you can do this. All the power -;; of emacs commands are available to renaming files! -;; +;; (query-replace), M-c (capitalize-word), etc... to change the name of +;; 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 ;; 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 ;; renaming takes effect and you are back to dired mode. ;; -;; Another things you can do with wdired: +;; Another things you can do with WDired: ;; ;; - To move files to another directory (by typing their path, ;; absolute or relative, as a part of the new filename). @@ -49,21 +49,16 @@ ;; ;; - To change the permission bits of the filenames (in systems with a ;; working unix-alike `dired-chmod-program'). See and customize the -;; variable `wdired-allow-to-change-permissions'. To change a single +;; variable `wdired-allow-to-change-permissions'. To change a single ;; char (toggling between its two more usual values) you can press -;; the space bar over it or left-click the mouse. To set any char to +;; the space bar over it or left-click the mouse. To set any char to ;; an specific value (this includes the SUID, SGID and STI bits) you -;; can use the key labeled as the letter you want. Please note that +;; can use the key labeled as the letter you want. Please note that ;; permissions of the links cannot be changed in that way, because ;; the change would affect to their targets, and this would not be ;; WYSIWYG :-). ;; ;; - To mark files for deletion, by deleting their whole filename. -;; -;; I do not have a URL to hang wdired, but you can use the one below -;; to find the latest version: -;; -;; http://groups.google.com/groups?as_ugroup=gnu.emacs.sources&as_q=wdired ;;; Installation: @@ -75,21 +70,19 @@ ;; (require 'wdired) ;; (define-key dired-mode-map "r" 'wdired-change-to-wdired-mode) ;; -;; This is recommended way for faster emacs startup time and lower -;; memory consumption, but remind to add these lines before dired.el -;; gets loaded (i.e., near the beginning of your .emacs file): +;; This is the recommended way for faster Emacs startup time and lower +;; memory consumption: ;; ;; (autoload 'wdired-change-to-wdired-mode "wdired") -;; (add-hook 'dired-load-hook +;; (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 make changes to -;; the default behavior. +;; Type "M-x customize-group RET wdired" if you want to make changes +;; to the default behavior. ;;; Usage: @@ -103,91 +96,39 @@ ;;; Change Log: -;; From 1.9 to 1.91 -;; -;; - Fixed a bug (introduced in 1.9) so now files can be marked for -;; deletion again, by deleting their whole filename. - -;; From 1.8 to 1.9 -;; -;; - Another alternative way of editing permissions allowed, see -;; `wdired-allow-to-change-permissions' for details. -;; -;; - Now wdired doesn`t relies in regexp so much. As a consequence of -;; this, you can add newlines to filenames and symlinks targets -;; (although this is not very usual, IMHO). Please note that dired -;; (at least in Emacs 21.1 and previous) does not work very well -;; with filenames with newlines in them, so RET is deactivated in -;; wdired mode. But you can activate it if you want. -;; -;; - Now `upcase-word' `capitalize-word' and `downcase-word' are not -;; advised to work better with wdired mode, but the keys binded to -;; them use wdired versions of that commands. -;; -;; - Now "undo" actions are not inherited from wdired mode when -;; changing to dired mode. -;; -;; - Code and documentation cleanups. -;; -;; - Fixed a bug that was making wdired to fail on users with -;; `dired-backup-overwrite' set to t. -;; -;; - C-c C-[ now abort changes. - -;; From 1.7 to 1.8 -;; -;; - Now permission (access-control) bits of the files can be changed. -;; Please see the commentary section and the custom variable -;; `wdired-allow-to-change-permissions' for details. -;; -;; - Added another possible value for the variable -;; `wdired-always-move-to-filename-beginning', useful to change -;; permission bits of several files without the cursor jumping to -;; filenames when changing lines. - -;; From 0.1 to 1.7 - -;; - I've moved the list of changes to another file, because it was -;; huge. Ask me for it or search older versions in google. - -;;; TODO: - -;; - Make it to work in XEmacs. Any volunteer? +;; Google is your friend (previous versions with complete changelogs +;; were posted to gnu.emacs.sources) ;;; Code: -(eval-when-compile - (require 'advice) - (defvar make-symbolic-link) ;Avoid a compilation warning in NTEmacs - (defvar dired-backup-overwrite) ; Only in emacs 20.x this is a custom var - (set (make-local-variable 'byte-compile-dynamic) t)) +(defvar dired-backup-overwrite) ; Only in Emacs 20.x this is a custom var -(eval-and-compile - (require 'dired) - (autoload 'dired-do-create-files-regexp "dired-aux") - (autoload 'dired-call-process "dired-aux")) +(eval-when-compile (require 'cl)) +(require 'dired) +(autoload 'dired-do-create-files-regexp "dired-aux") +(autoload 'dired-call-process "dired-aux") (defgroup wdired nil "Mode to rename files by editing their names in dired buffers." :group 'dired) (defcustom wdired-use-interactive-rename nil - "*If t, confirmation is required before actually rename the files. -Confirmation is required also for overwriting files. If nil, no -confirmation is required for change the file names, and the variable -`wdired-is-ok-overwrite' is used to see if it is ok to overwrite files -without asking." + "If non-nil, WDired requires confirmation before actually renaming files. +If nil, WDired doesn't require confirmation to change the file names, +and the variable `wdired-confirm-overwrite' controls whether it is ok +to overwrite files without asking." :type 'boolean :group 'wdired) -(defcustom wdired-is-ok-overwrite nil - "*If non-nil the renames can overwrite files without asking. -This variable is used only if `wdired-use-interactive-rename' is nil." +(defcustom wdired-confirm-overwrite t + "If nil the renames can overwrite files without asking. +This variable has no effect at all if `wdired-use-interactive-rename' +is not nil." :type 'boolean :group 'wdired) -(defcustom wdired-always-move-to-filename-beginning nil - "*If t the \"up\" and \"down\" movement is done as in dired mode. +(defcustom wdired-use-dired-vertical-movement nil + "If t, the \"up\" and \"down\" movement works as in Dired mode. That is, always move the point to the beginning of the filename at line. If `sometimes, only move to the beginning of filename if the point is @@ -200,34 +141,21 @@ If nil, \"up\" and \"down\" movement is done as in any other buffer." (other :tag "As in dired mode" t)) :group 'wdired) -(defcustom wdired-advise-functions t - "*If t some editing commands are advised when wdired is loaded. -The advice only has effect in wdired mode. These commands are -`query-replace' `query-replace-regexp' `replace-string', and the -advice makes them to ignore read-only regions, so no attempts to -modify these regions are done by them, and so they don't end -prematurely. - -Setting this to nil does not unadvise the functions, if they are -already advised, but new Emacs will not advise them." - :type 'boolean - :group 'wdired) - (defcustom wdired-allow-to-redirect-links t - "*If non-nil, the target of the symbolic links can be changed also. + "If non-nil, the target of the symbolic links are editable. In systems without symbolic links support, this variable has no effect at all." :type 'boolean :group 'wdired) (defcustom wdired-allow-to-change-permissions nil - "*If non-nil, the permissions bits of the files can be changed also. + "If non-nil, the permissions bits of the files are editable. If t, to change a single bit, put the cursor over it and press the space bar, or left click over it. You can also hit the letter you want to set: if this value is allowed, the character in the buffer will be changed. Anyway, the point is advanced one position, so, for example, -you can keep the \"x\" key pressed to give execution permissions to +you can keep the key pressed to give execution permissions to everybody to that file. If `advanced, the bits are freely editable. You can use @@ -235,70 +163,66 @@ If `advanced, the bits are freely editable. You can use newlines), but if you want your changes to be useful, you better put a intelligible value. -Anyway, the real change of the permissions is done with the external +Anyway, the real change of the permissions is done by the external program `dired-chmod-program', which must exist." :type '(choice (const :tag "Not allowed" nil) - (const :tag "Toggle/set bits" t) + (const :tag "Toggle/set bits" t) (other :tag "Bits freely editable" advanced)) :group 'wdired) -(define-key dired-mode-map [menu-bar immediate wdired-change-to-wdired-mode] - '("Edit File Names" . wdired-change-to-wdired-mode)) - -(defvar wdired-mode-map nil) -(unless wdired-mode-map - (setq wdired-mode-map (make-sparse-keymap)) - (define-key wdired-mode-map "\C-x\C-s" 'wdired-finish-edit) - (define-key wdired-mode-map "\C-c\C-c" 'wdired-finish-edit) - (define-key wdired-mode-map "\C-c\C-k" 'wdired-abort-changes) - (define-key wdired-mode-map "\C-c\C-[" 'wdired-abort-changes) - (define-key wdired-mode-map [return] 'wdired-newline) - (define-key wdired-mode-map "\C-j" 'wdired-newline) - (define-key wdired-mode-map "\C-o" 'wdired-newline) - (define-key wdired-mode-map [up] 'wdired-previous-line) - (define-key wdired-mode-map "\C-p" 'wdired-previous-line) - (define-key wdired-mode-map [down] 'wdired-next-line) - (define-key wdired-mode-map "\C-n" 'wdired-next-line) - (define-key wdired-mode-map [menu-bar wdired] - (cons "WDired" (make-sparse-keymap "WDired"))) - (define-key wdired-mode-map [menu-bar wdired wdired-customize] - '("Options" . wdired-customize)) - (define-key wdired-mode-map [menu-bar wdired dashes] +(defvar wdired-mode-map + (let ((map (make-sparse-keymap))) + (define-key map "\C-x\C-s" 'wdired-finish-edit) + (define-key map "\C-c\C-c" 'wdired-finish-edit) + (define-key map "\C-c\C-k" 'wdired-abort-changes) + (define-key map "\C-c\C-[" 'wdired-abort-changes) + (define-key map "\C-m" 'ignore) + (define-key map "\C-j" 'ignore) + (define-key map "\C-o" 'ignore) + (define-key map [up] 'wdired-previous-line) + (define-key map "\C-p" 'wdired-previous-line) + (define-key map [down] 'wdired-next-line) + (define-key map "\C-n" 'wdired-next-line) + + (define-key map [menu-bar wdired] + (cons "WDired" (make-sparse-keymap "WDired"))) + (define-key map [menu-bar wdired wdired-customize] + '("Options" . wdired-customize)) + (define-key map [menu-bar wdired dashes] '("--")) - (define-key wdired-mode-map [menu-bar wdired wdired-abort-changes] - '("Abort Changes" . wdired-abort-changes)) - (define-key wdired-mode-map [menu-bar wdired wdired-finish-edit] - '("Validate Changes" . wdired-finish-edit)) - (substitute-key-definition 'upcase-word 'wdired-upcase-word - wdired-mode-map global-map) - (substitute-key-definition 'capitalize-word 'wdired-capitalize-word - wdired-mode-map global-map) - (substitute-key-definition 'downcase-word 'wdired-downcase-word - wdired-mode-map global-map)) - -(defvar wdired-mode-hooks nil - "Hooks run when changing to wdired mode.") - -(defvar wdired-load-hooks nil - "Hooks run after loading wdired code.") + (define-key map [menu-bar wdired wdired-abort-changes] + '(menu-item "Abort Changes" wdired-abort-changes + :help "Abort changes and return to dired mode")) + (define-key map [menu-bar wdired wdired-finish-edit] + '("Commit Changes" . wdired-finish-edit)) + + (define-key map [remap upcase-word] 'wdired-upcase-word) + (define-key map [remap capitalize-word] 'wdired-capitalize-word) + (define-key map [remap downcase-word] 'wdired-downcase-word) + + map)) + +(defvar wdired-mode-hook nil + "Hooks run when changing to WDired mode.") ;; Local variables (put here to avoid compilation gripes) (defvar wdired-col-perm) ;; Column where the permission bits start (defvar wdired-old-content) +(defvar wdired-old-point) (defun wdired-mode () "\\File Names Editing mode. -Press \\[wdired-finish-edit] to make the changes to take effect and -exit. To abort the edit, use \\[wdired-abort-changes]. +Press \\[wdired-finish-edit] to make the changes to take effect +and exit. To abort the edit, use \\[wdired-abort-changes]. -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 `customize-group' -wdired. +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. -Editing things out of the filenames, or adding or deleting lines is -not allowed, because the rest of the buffer is read-only." +The only editable texts in a WDired buffer are filenames, +symbolic link targets, and filenames permission." (interactive) (error "This mode can be enabled only by `wdired-change-to-wdired-mode'")) (put 'wdired-mode 'mode-class 'special) @@ -307,21 +231,26 @@ not allowed, because the rest of the buffer is read-only." ;;;###autoload (defun wdired-change-to-wdired-mode () "Put a dired buffer in a mode in which filenames are editable. -In this mode the names of the files can be changed, and after -typing C-c C-c the files and directories in disk are renamed. +\\ +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. See `wdired-mode'." (interactive) + (or (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) (use-local-map wdired-mode-map) - (menu-bar-mode (or menu-bar-mode -1)) ;Force redisplay menu + (force-mode-line-update) (setq buffer-read-only nil) (dired-unadvertise default-directory) - (make-local-hook 'kill-buffer-hook) (add-hook 'kill-buffer-hook 'wdired-check-kill-buffer nil t) (setq major-mode 'wdired-mode) - (setq mode-name "Edit filenames") + (setq mode-name "Editable Dired") (setq revert-buffer-function 'wdired-revert) ;; I temp disable undo for performance: since I'm going to clear the ;; undo list, it can save more than a 9% of time with big @@ -335,8 +264,10 @@ See `wdired-mode'." (buffer-enable-undo) ; Performance hack. See above. (set-buffer-modified-p nil) (setq buffer-undo-list nil) - (run-hooks wdired-mode-hooks) - (message "Press C-c C-c when finished")) + (run-mode-hooks 'wdired-mode-hook) + (message "%s" (substitute-command-keys + "Press \\[wdired-finish-edit] when finished \ +or \\[wdired-abort-changes] to abort changes"))) ;; Protect the buffer so only the filenames can be changed, and put @@ -349,24 +280,27 @@ See `wdired-mode'." filename) (while (not (eobp)) (setq filename (dired-get-filename nil t)) - (if (and filename (not (string-match "/\\.\\.?$" filename))) - (progn - (dired-move-to-filename) - (put-text-property (- (point) 2) (1- (point)) 'old-name filename) - (put-text-property b-protection (1- (point)) 'read-only t) - (setq b-protection (dired-move-to-end-of-filename t)))) - (put-text-property (point) (1+ (point)) 'end-name t) + (when (and filename + (not (member (file-name-nondirectory filename) '("." "..")))) + (dired-move-to-filename) + ;; The rear-nonsticky property below shall ensure that text preceding + ;; the filename can't be modified. + (add-text-properties + (1- (point)) (point) `(old-name ,filename rear-nonsticky (read-only))) + (put-text-property b-protection (point) 'read-only t) + (setq b-protection (dired-move-to-end-of-filename t)) + (put-text-property (point) (1+ (point)) 'end-name t)) (forward-line)) (put-text-property b-protection (point-max) 'read-only t)))) ;; This code is a copy of some dired-get-filename lines. (defsubst wdired-normalize-filename (file) (setq file + ;; FIXME: shouldn't we check for a `b' argument or somesuch before + ;; doing such unquoting? --Stef (read (concat - "\"" (or (dired-string-replace-match - "\\([^\\]\\|\\`\\)\"" file - "\\1\\\\\"" nil t) - file) + "\"" (replace-regexp-in-string + "\\([^\\]\\|\\`\\)\"" "\\1\\\\\"" file) "\""))) (and file buffer-file-coding-system (not file-name-coding-system) @@ -376,22 +310,26 @@ See `wdired-mode'." (defun wdired-get-filename (&optional no-dir old) "Return the filename at line. -Similar to `dired-get-filename' but it doesn't relies in regexps. It -relies in wdired buffer's properties. Optional arg NO-DIR with value +Similar to `dired-get-filename' but it doesn't rely on regexps. It +relies on WDired buffer's properties. Optional arg NO-DIR with value non-nil means don't include directory. Optional arg OLD with value non-nil means return old filename." + ;; FIXME: Use dired-get-filename's new properties. (let (beg end file) (save-excursion - (setq end (progn (end-of-line) (point))) + (setq end (line-end-position)) (beginning-of-line) (setq beg (next-single-property-change (point) 'old-name nil end)) - (if (not (eq beg end)) - (progn - (if old - (setq file (get-text-property beg 'old-name)) - (setq end (next-single-property-change (1+ beg) 'end-name)) - (setq file (buffer-substring-no-properties (+ 2 beg) end))) - (and file (setq file (wdired-normalize-filename file))))) + (unless (eq beg end) + (if old + (setq file (get-text-property beg 'old-name)) + ;; In the following form changed `(1+ beg)' to `beg' so that + ;; the filename end is found even when the filename is empty. + ;; Fixes error and spurious newlines when marking files for + ;; deletion. + (setq end (next-single-property-change beg 'end-name)) + (setq file (buffer-substring-no-properties (1+ beg) end))) + (and file (setq file (wdired-normalize-filename file)))) (if (or no-dir old) file (and file (> (length file) 0) @@ -400,18 +338,20 @@ non-nil means return old filename." (defun wdired-change-to-dired-mode () "Change the mode back to dired." + (or (eq major-mode 'wdired-mode) + (error "Not a Wdired buffer")) (let ((inhibit-read-only t)) - (remove-text-properties (point-min) (point-max) - '(read-only nil local-map nil))) - (put-text-property 1 2 'front-sticky nil) + (remove-text-properties + (point-min) (point-max) + '(front-sticky nil rear-nonsticky nil read-only nil keymap nil))) (use-local-map dired-mode-map) - (menu-bar-mode (or menu-bar-mode -1)) ;Force redisplay menu + (force-mode-line-update) (setq buffer-read-only t) (setq major-mode 'dired-mode) (setq mode-name "Dired") (dired-advertise) (remove-hook 'kill-buffer-hook 'wdired-check-kill-buffer t) - (setq revert-buffer-function 'dired-revert)) + (set (make-local-variable 'revert-buffer-function) 'dired-revert)) (defun wdired-abort-changes () @@ -419,75 +359,78 @@ non-nil means return old filename." (interactive) (let ((inhibit-read-only t)) (erase-buffer) - (insert wdired-old-content)) + (insert wdired-old-content) + (goto-char wdired-old-point)) (wdired-change-to-dired-mode) (set-buffer-modified-p nil) - (setq buffer-undo-list nil)) + (setq buffer-undo-list nil) + (message "Changes aborted")) (defun wdired-finish-edit () "Actually rename files based on your editing in the Dired buffer." (interactive) (wdired-change-to-dired-mode) - (let ((overwrite (or wdired-is-ok-overwrite 1)) + (let ((overwrite (or (not wdired-confirm-overwrite) 1)) (changes nil) (files-deleted nil) (errors 0) file-ori file-new tmp-value) (save-excursion - (if (and wdired-allow-to-redirect-links - (fboundp 'make-symbolic-link)) - (progn - (setq tmp-value (wdired-do-symlink-changes)) - (setq errors (cdr tmp-value)) - (setq changes (car tmp-value)))) - (if (and wdired-allow-to-change-permissions - (boundp 'wdired-col-perm)) ; could have been changed - (progn - (setq tmp-value (wdired-do-perm-changes)) - (setq errors (+ errors (cdr tmp-value))) - (setq changes (or changes (car tmp-value))))) + (when (and wdired-allow-to-redirect-links + (fboundp 'make-symbolic-link)) + (setq tmp-value (wdired-do-symlink-changes)) + (setq errors (cdr tmp-value)) + (setq changes (car tmp-value))) + (when (and wdired-allow-to-change-permissions + (boundp 'wdired-col-perm)) ; could have been changed + (setq tmp-value (wdired-do-perm-changes)) + (setq errors (+ errors (cdr tmp-value))) + (setq changes (or changes (car tmp-value)))) (goto-char (point-max)) (while (not (bobp)) (setq file-ori (wdired-get-filename nil t)) - (if file-ori - (setq file-new (wdired-get-filename))) - (if (and file-ori (not (equal file-new file-ori))) - (progn - (setq changes t) - (if (not file-new) ;empty filename! - (setq files-deleted (cons file-ori files-deleted)) - (progn - (setq file-new (substitute-in-file-name file-new)) - (if wdired-use-interactive-rename - (wdired-search-and-rename file-ori file-new) - (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)))))))) + (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)))))) (forward-line -1))) (if changes (revert-buffer) ;The "revert" is necessary to re-sort the buffer - (let ((buffer-read-only nil)) + (let ((inhibit-read-only t)) (remove-text-properties (point-min) (point-max) '(old-name nil end-name nil old-link nil end-link nil end-perm nil old-perm nil perm-changed nil)) (message "(No changes to be performed)"))) - (if files-deleted - (wdired-flag-for-deletion files-deleted)) - (if (> errors 0) - (dired-log-summary (format "%d rename actions failed" errors) nil))) + (when files-deleted + (wdired-flag-for-deletion files-deleted)) + (when (> errors 0) + (dired-log-summary (format "%d rename actions failed" errors) nil))) (set-buffer-modified-p nil) (setq buffer-undo-list nil)) -;; Renames a file, searching it in a modified dired buffer, in order +;; Rename a file, searching it in a modified dired buffer, in order ;; to be able to use `dired-do-create-files-regexp' and get its -;; "benefits" +;; "benefits". (defun wdired-search-and-rename (filename-ori filename-new) (save-excursion (goto-char (point-max)) @@ -507,10 +450,9 @@ non-nil means return old filename." (dired-do-create-files-regexp (function dired-rename-file) "Move" 1 ".*" filename-new nil t)) - (progn - (forward-line -1) - (beginning-of-line) - (setq exit-while (= 1 (point))))))))) + (forward-line -1) + (beginning-of-line) + (setq exit-while (bobp))))))) ;; marks a list of files for deletion (defun wdired-flag-for-deletion (filenames-ori) @@ -522,17 +464,19 @@ non-nil means return old filename." (forward-line))))) (defun wdired-customize () - "Customize wdired options." + "Customize WDired options." (interactive) (customize-apropos "wdired" 'groups)) (defun wdired-revert (&optional arg noconfirm) - "Discard changes in the buffer and update the changes in the disk." + "Discard changes in the buffer and update it based on changes on disk. +Optional arguments are ignored." (wdired-change-to-dired-mode) (revert-buffer) (wdired-change-to-wdired-mode)) (defun wdired-check-kill-buffer () + ;; FIXME: Can't we use the normal mechanism for that? --Stef (if (and (buffer-modified-p) (not (y-or-n-p "Buffer changed. Discard changes and kill buffer? "))) @@ -540,12 +484,12 @@ non-nil means return old filename." (defun wdired-next-line (arg) "Move down lines then position at filename or the current column. -See `wdired-always-move-to-filename-beginning'. Optional prefix ARG +See `wdired-use-dired-vertical-movement'. Optional prefix ARG says how many lines to move; default is one line." (interactive "p") (next-line arg) - (if (or (eq wdired-always-move-to-filename-beginning t) - (and wdired-always-move-to-filename-beginning + (if (or (eq wdired-use-dired-vertical-movement t) + (and wdired-use-dired-vertical-movement (< (current-column) (save-excursion (dired-move-to-filename) (current-column))))) @@ -553,22 +497,17 @@ says how many lines to move; default is one line." (defun wdired-previous-line (arg) "Move up lines then position at filename or the current column. -See `wdired-always-move-to-filename-beginning'. Optional prefix ARG +See `wdired-use-dired-vertical-movement'. Optional prefix ARG says how many lines to move; default is one line." (interactive "p") (previous-line arg) - (if (or (eq wdired-always-move-to-filename-beginning t) - (and wdired-always-move-to-filename-beginning + (if (or (eq wdired-use-dired-vertical-movement t) + (and wdired-use-dired-vertical-movement (< (current-column) (save-excursion (dired-move-to-filename) (current-column))))) (dired-move-to-filename))) -;; dired doesn't works well with newlines, so ... -(defun wdired-newline () - "Do nothing." - (interactive)) - ;; Put the needed properties to allow the user to change links' targets (defun wdired-preprocess-symlinks () (let ((inhibit-read-only t)) @@ -582,7 +521,10 @@ says how many lines to move; default is one line." (1- (match-beginning 1)) 'old-link (match-string-no-properties 1)) (put-text-property (match-end 1) (1+ (match-end 1)) 'end-link t) - (put-text-property (1- (match-beginning 1)) + (put-text-property (1- (match-beginning 1)) + (match-beginning 1) + 'rear-nonsticky '(read-only)) + (put-text-property (match-beginning 1) (match-end 1) 'read-only nil))) (forward-line) (beginning-of-line))))) @@ -603,9 +545,8 @@ If OLD, return the old target. If MOVE, move point before it." (and target (wdired-normalize-filename target)))) - ;; Perform the changes in the target of the changed links. -(defun wdired-do-symlink-changes() +(defun wdired-do-symlink-changes () (let ((changes nil) (errors 0) link-to-ori link-to-new link-from) @@ -613,156 +554,104 @@ If OLD, return the old target. If MOVE, move point before it." (while (setq link-to-new (wdired-get-previous-link)) (setq link-to-ori (wdired-get-previous-link t t)) (setq link-from (wdired-get-filename nil t)) - (if (not (equal link-to-new link-to-ori)) - (progn - (setq changes t) - (if (equal link-to-new "") ;empty filename! - (setq link-to-new "/dev/null")) - (condition-case err - (progn - (delete-file link-from) - (make-symbolic-link - (substitute-in-file-name link-to-new) link-from)) - (error - (setq errors (1+ errors)) - (dired-log (concat "Link `" link-from "' to `" - link-to-new "' failed:\n%s\n") - err)))))) + (unless (equal link-to-new link-to-ori) + (setq changes t) + (if (equal link-to-new "") ;empty filename! + (setq link-to-new "/dev/null")) + (condition-case err + (progn + (delete-file link-from) + (make-symbolic-link + (substitute-in-file-name link-to-new) link-from)) + (error + (setq errors (1+ errors)) + (dired-log (concat "Link `" link-from "' to `" + link-to-new "' failed:\n%s\n") + err))))) (cons changes errors))) ;; Perform a "case command" skipping read-only words. (defun wdired-xcase-word (command arg) (if (< arg 0) (funcall command arg) - (progn - (while (> arg 0) - (condition-case err - (progn - (funcall command 1) - (setq arg (1- arg))) - (error - (if (not (forward-word 1)) - (setq arg 0)))))))) + (while (> arg 0) + (condition-case err + (progn + (funcall command 1) + (setq arg (1- arg))) + (error + (if (forward-word) + ;; Skip any non-word characters to avoid triggering a read-only + ;; error which would cause skipping the next word characters too. + (skip-syntax-forward "^w") + (setq arg 0))))))) (defun wdired-downcase-word (arg) - "Wdired version of `downcase-word'. + "WDired version of `downcase-word'. Like original function but it skips read-only words." (interactive "p") (wdired-xcase-word 'downcase-word arg)) (defun wdired-upcase-word (arg) - "Wdired version of `upcase-word'. + "WDired version of `upcase-word'. Like original function but it skips read-only words." (interactive "p") (wdired-xcase-word 'upcase-word arg)) (defun wdired-capitalize-word (arg) - "Wdired version of `capitalize-word'. + "WDired version of `capitalize-word'. Like original function but it skips read-only words." (interactive "p") (wdired-xcase-word 'capitalize-word arg)) -;; The following code is related to advice some interactive functions -;; to make some editing commands in wdired mode not to fail trying to -;; change read-only text. Notice that some advises advice and unadvise -;; them-self to another functions: search-forward and -;; re-search-forward. This is to keep these functions advised only -;; when is necessary. Since they are built-in commands used heavily in -;; lots of places, to have it permanently advised would cause some -;; performance loss. - - -(defun wdired-add-skip-in-replace (command) - "Advice COMMAND to skip matches while they have read-only properties. -This is useful to avoid \"read-only\" errors in search and replace -commands. This advice only has effect in wdired mode." - (eval - `(defadvice ,command (around wdired-discard-read-only activate) - ,(format "Make %s to work better with wdired,\n%s." command - "skipping read-only matches when invoked without argument") - ad-do-it - (if (eq major-mode 'wdired-mode) - (while (and ad-return-value - (text-property-any - (max 1 (1- (match-beginning 0))) (match-end 0) - 'read-only t)) - ad-do-it)) - ad-return-value))) - - -(defun wdired-add-replace-advice (command) - "Advice COMMAND to skip matches while they have read-only properties. -This is useful to avoid \"read-only\" errors in search and replace -commands. This advice only has effect in wdired mode." - (eval - `(defadvice ,command (around wdired-grok-read-only activate) - ,(format "Make %s to work better with wdired,\n%s." command - "skipping read-only matches when invoked without argument") - (if (eq major-mode 'wdired-mode) - (progn - (wdired-add-skip-in-replace 'search-forward) - (wdired-add-skip-in-replace 're-search-forward) - (unwind-protect - ad-do-it - (progn - (ad-remove-advice 'search-forward - 'around 'wdired-discard-read-only) - (ad-remove-advice 're-search-forward - 'around 'wdired-discard-read-only) - (ad-update 'search-forward) - (ad-update 're-search-forward)))) - ad-do-it) - ad-return-value))) - - -(if wdired-advise-functions - (progn - (mapcar 'wdired-add-replace-advice - '(query-replace query-replace-regexp replace-string)))) - ;; The following code deals with changing the access bits (or ;; permissions) of the files. -(defvar wdired-perm-mode-map nil) -(unless wdired-perm-mode-map - (setq wdired-perm-mode-map (copy-keymap wdired-mode-map)) - (define-key wdired-perm-mode-map " " 'wdired-toggle-bit) - (define-key wdired-perm-mode-map "r" 'wdired-set-bit) - (define-key wdired-perm-mode-map "w" 'wdired-set-bit) - (define-key wdired-perm-mode-map "x" 'wdired-set-bit) - (define-key wdired-perm-mode-map "-" 'wdired-set-bit) - (define-key wdired-perm-mode-map "S" 'wdired-set-bit) - (define-key wdired-perm-mode-map "s" 'wdired-set-bit) - (define-key wdired-perm-mode-map "T" 'wdired-set-bit) - (define-key wdired-perm-mode-map "t" 'wdired-set-bit) - (define-key wdired-perm-mode-map "s" 'wdired-set-bit) - (define-key wdired-perm-mode-map "l" 'wdired-set-bit) - (define-key wdired-perm-mode-map [down-mouse-1] 'wdired-mouse-toggle-bit)) - -;; Put a local-map to the permission bits of the files, and store the +(defvar wdired-perm-mode-map + (let ((map (make-sparse-keymap))) + (define-key map " " 'wdired-toggle-bit) + (define-key map "r" 'wdired-set-bit) + (define-key map "w" 'wdired-set-bit) + (define-key map "x" 'wdired-set-bit) + (define-key map "-" 'wdired-set-bit) + (define-key map "S" 'wdired-set-bit) + (define-key map "s" 'wdired-set-bit) + (define-key map "T" 'wdired-set-bit) + (define-key map "t" 'wdired-set-bit) + (define-key map "s" 'wdired-set-bit) + (define-key map "l" 'wdired-set-bit) + (define-key map [down-mouse-1] 'wdired-mouse-toggle-bit) + map)) + +;; Put a keymap property to the permission bits of the files, and store the ;; original name and permissions as a property -(defun wdired-preprocess-perms() - (let ((inhibit-read-only t) - filename) +(defun wdired-preprocess-perms () + (let ((inhibit-read-only t)) (set (make-local-variable 'wdired-col-perm) nil) (save-excursion (goto-char (point-min)) (while (not (eobp)) - (if (and (not (looking-at dired-re-sym)) - (setq filename (wdired-get-filename))) - (progn - (re-search-forward dired-re-perms) - (or wdired-col-perm - (setq wdired-col-perm (- (current-column) 9))) - (if (eq wdired-allow-to-change-permissions 'advanced) - (put-text-property (match-beginning 0) (match-end 0) - 'read-only nil) - (put-text-property (1+ (match-beginning 0)) (match-end 0) - 'local-map wdired-perm-mode-map)) - (put-text-property (match-end 0) (1+ (match-end 0)) 'end-perm t) - (put-text-property (match-beginning 0) (1+ (match-beginning 0)) - 'old-perm (match-string-no-properties 0)))) + (when (and (not (looking-at dired-re-sym)) + (wdired-get-filename) + (re-search-forward dired-re-perms (line-end-position) 'eol)) + (let ((begin (match-beginning 0)) + (end (match-end 0))) + (unless wdired-col-perm + (setq wdired-col-perm (- (current-column) 9))) + (if (eq wdired-allow-to-change-permissions 'advanced) + (progn + (put-text-property begin end 'read-only nil) + ;; make first permission bit writable + (put-text-property + (1- begin) begin 'rear-nonsticky '(read-only))) + ;; avoid that keymap applies to text following permissions + (add-text-properties + (1+ begin) end + `(keymap ,wdired-perm-mode-map rear-nonsticky (keymap)))) + (put-text-property end (1+ end) 'end-perm t) + (put-text-property + begin (1+ begin) 'old-perm (match-string-no-properties 0)))) (forward-line) (beginning-of-line))))) @@ -784,14 +673,15 @@ commands. This advice only has effect in wdired mode." (let ((new-bit (char-to-string last-command-char)) (inhibit-read-only t) (pos-prop (- (point) (- (current-column) wdired-col-perm)))) - (put-text-property 0 1 'local-map wdired-perm-mode-map new-bit) + (put-text-property 0 1 'keymap wdired-perm-mode-map new-bit) (put-text-property 0 1 'read-only t new-bit) (insert new-bit) (delete-char 1) - (put-text-property pos-prop (1- pos-prop) 'perm-changed t)) + (put-text-property (1- pos-prop) pos-prop 'perm-changed t) + (put-text-property (1- (point)) (point) 'rear-nonsticky '(keymap))) (forward-char 1))) -(defun wdired-toggle-bit() +(defun wdired-toggle-bit () "Toggle the permission bit at point." (interactive) (let ((inhibit-read-only t) @@ -802,11 +692,12 @@ commands. This advice only has effect in wdired mode." (if (= (% (- (current-column) wdired-col-perm) 3) 0) "r" (if (= (% (- (current-column) wdired-col-perm) 3) 1) "w" "x")))) - (put-text-property 0 1 'local-map wdired-perm-mode-map new-bit) + (put-text-property 0 1 'keymap wdired-perm-mode-map new-bit) (put-text-property 0 1 'read-only t new-bit) (insert new-bit) (delete-char 1) - (put-text-property pos-prop (1- pos-prop) 'perm-changed t))) + (put-text-property (1- pos-prop) pos-prop 'perm-changed t) + (put-text-property (1- (point)) (point) 'rear-nonsticky '(keymap)))) (defun wdired-mouse-toggle-bit (event) "Toggle the permission bit that was left clicked." @@ -850,30 +741,31 @@ commands. This advice only has effect in wdired mode." (setq perms-ori (get-text-property (point) 'old-perm)) (setq perms-new (buffer-substring-no-properties (point) (next-single-property-change (point) 'end-perm))) - (if (not (equal perms-ori perms-new)) - (progn - (setq changes t) - (setq filename (wdired-get-filename nil t)) - (if (= (length perms-new) 10) - (progn - (setq perm-tmp - (int-to-string (wdired-perms-to-number perms-new))) - (if (not (equal 0 (dired-call-process dired-chmod-program - t perm-tmp filename))) - (progn - (setq errors (1+ errors)) - (dired-log (concat dired-chmod-program " " perm-tmp - " `" filename "' failed\n\n"))))) - (setq errors (1+ errors)) - (dired-log (concat "Cannot parse permission `" perms-new - "' for file `" filename "'\n\n"))))) + (unless (equal perms-ori perms-new) + (setq changes t) + (setq filename (wdired-get-filename nil t)) + (if (= (length perms-new) 10) + (progn + (setq perm-tmp + (int-to-string (wdired-perms-to-number perms-new))) + (unless (equal 0 (dired-call-process dired-chmod-program + t perm-tmp filename)) + (setq errors (1+ errors)) + (dired-log (concat dired-chmod-program " " perm-tmp + " `" filename "' failed\n\n")))) + (setq errors (1+ errors)) + (dired-log (concat "Cannot parse permission `" perms-new + "' for file `" filename "'\n\n")))) (goto-char (next-single-property-change (1+ (point)) prop-wanted nil (point-max)))) (cons changes errors))) (provide 'wdired) -(run-hooks wdired-load-hooks) - -;;; wdired.el ends here +;; Local Variables: +;; coding: latin-1 +;; byte-compile-dynamic: t +;; End: +;; arch-tag: bc00902e-526f-4305-bc7f-8862a559184f +;;; wdired.el ends here