Add inhibit-auto-revert macro

* doc/lispref/backups.texi (Reverting):
Add inhibit-auto-revert-buffers and inhibit-auto-revert.

* etc/NEWS: Add inhibit-auto-revert-buffers and inhibit-auto-revert.
Fix typos.

* lisp/autorevert.el (inhibit-auto-revert-buffers): New variable.
(inhibit-auto-revert): New macro.
(auto-revert-active-p, auto-revert-handler):
Check `inhibit-auto-revert-buffers'.

* lisp/dired.el (dired--inhibit-auto-revert): Remove.
(dired-buffer-stale-p): Don't set it.
(dired-map-over-marks, dired-internal-do-deletions):
Use `inhibit-auto-revert.

* test/lisp/autorevert-tests.el
(auto-revert-test08-auto-revert-inhibit-auto-revert)
(auto-revert-test08-auto-revert-inhibit-auto-revert-remote): New tests.

1 files changed, 62 insertions, 71 deletions

diff --git a/lisp/dired.el b/lisp/dired.el
index 2eb6546107a..91163186443 100644
--- a/lisp/dired.el
+++ b/lisp/dired.el
@@ -944,9 +944,6 @@ Return value is the number of files marked, or nil if none were marked."
                           ""))))
     (and (> count 0) count)))
 
-(defvar-local dired--inhibit-auto-revert nil
-  "A non-nil value prevents `auto-revert-mode' from reverting the buffer.")
-
 (defmacro dired-map-over-marks (body arg &optional show-progress
                                      distinguish-one-marked)
   "Eval BODY with point on each marked line.  Return a list of BODY's results.
@@ -983,48 +980,48 @@ marked file, return (t FILENAME) instead of (FILENAME)."
   ;;endless loop.
   ;;This warning should not apply any longer, sk  2-Sep-1991 14:10.
   `(prog1
-       (let ((dired--inhibit-auto-revert t)
-             (inhibit-read-only t)
-             case-fold-search found results)
-         (if (and ,arg (not (eq ,arg 'marked)))
-             (if (integerp ,arg)
-                 (progn ;; no save-excursion, want to move point.
-                   (dired-repeat-over-lines
-                    ,arg
-                    (lambda ()
-                      (if ,show-progress (sit-for 0))
-                      (setq results (cons ,body results))))
-                   (when (< ,arg 0)
-                     (setq results (nreverse results)))
-                   results)
-               ;; non-nil, non-integer, non-marked ARG means use current file:
-               (list ,body))
-           (let ((regexp (dired-marker-regexp)) next-position)
-             (save-excursion
-               (goto-char (point-min))
-               ;; remember position of next marked file before BODY
-               ;; can insert lines before the just found file,
-               ;; confusing us by finding the same marked file again
-               ;; and again and...
-               (setq next-position (and (re-search-forward regexp nil t)
-                                        (point-marker))
-                     found (not (null next-position)))
-               (while next-position
-                 (goto-char next-position)
-                 (if ,show-progress (sit-for 0))
-                 (setq results (cons ,body results))
-                 ;; move after last match
-                 (goto-char next-position)
-                 (forward-line 1)
-                 (set-marker next-position nil)
-                 (setq next-position (and (re-search-forward regexp nil t)
-                                          (point-marker)))))
-             (if (and ,distinguish-one-marked (= (length results) 1))
-                 (setq results (cons t results)))
-             (if found
-                 results
-               (unless (eq ,arg 'marked)
-                 (list ,body))))))
+       (inhibit-auto-revert
+         (let ((inhibit-read-only t)
+               case-fold-search found results)
+           (if (and ,arg (not (eq ,arg 'marked)))
+               (if (integerp ,arg)
+                   (progn       ;; no save-excursion, want to move point.
+                     (dired-repeat-over-lines
+                      ,arg
+                      (lambda ()
+                        (if ,show-progress (sit-for 0))
+                        (setq results (cons ,body results))))
+                     (when (< ,arg 0)
+                       (setq results (nreverse results)))
+                     results)
+                 ;; non-nil, non-integer, non-marked ARG means use current file:
+                 (list ,body))
+             (let ((regexp (dired-marker-regexp)) next-position)
+               (save-excursion
+                 (goto-char (point-min))
+                 ;; remember position of next marked file before BODY
+                 ;; can insert lines before the just found file,
+                 ;; confusing us by finding the same marked file again
+                 ;; and again and...
+                 (setq next-position (and (re-search-forward regexp nil t)
+                                          (point-marker))
+                       found (not (null next-position)))
+                 (while next-position
+                   (goto-char next-position)
+                   (if ,show-progress (sit-for 0))
+                   (setq results (cons ,body results))
+                   ;; move after last match
+                   (goto-char next-position)
+                   (forward-line 1)
+                   (set-marker next-position nil)
+                   (setq next-position (and (re-search-forward regexp nil t)
+                                            (point-marker)))))
+               (if (and ,distinguish-one-marked (= (length results) 1))
+                   (setq results (cons t results)))
+               (if found
+                   results
+                 (unless (eq ,arg 'marked)
+                   (list ,body)))))))
      ;; save-excursion loses, again
      (dired-move-to-filename)))
 
@@ -1294,12 +1291,6 @@ This feature is used by Auto Revert mode."
          ;; Do not auto-revert when the dired buffer can be currently
          ;; written by the user as in `wdired-mode'.
          buffer-read-only
-         ;; When a dired operation using dired-map-over-marks is in
-         ;; progress, dired--inhibit-auto-revert is bound to some
-         ;; non-nil value and we must not auto-revert because that could
-         ;; change the order of files leading to skipping or
-         ;; double-processing (see bug#75626).
-         (not dired--inhibit-auto-revert)
          (dired-directory-changed-p dirname))))
 
 (defcustom dired-auto-revert-buffer nil
@@ -4089,26 +4080,26 @@ non-empty directories is allowed."
             (while l
               (goto-char (marker-position (cdr (car l))))
               (dired-move-to-filename)
-              (let ((inhibit-read-only t)
-                    ;; Temporarily prevent auto-revert while deleting
-                    ;; entry in the dired buffer (bug#71264).
-                    (dired--inhibit-auto-revert t))
-                (condition-case err
-                    (let ((fn (car (car l))))
-                      (dired-delete-file fn dired-recursive-deletes trash)
-                      ;; if we get here, removing worked
-                      (setq succ (1+ succ))
-                      (progress-reporter-update progress-reporter succ)
-                      (dired-fun-in-all-buffers
-                       (file-name-directory fn) (file-name-nondirectory fn)
-                       #'dired-delete-entry fn)
-                      ;; For when FN's directory name is different
-                      ;; from the current buffer's dired-directory.
-                      (dired-delete-entry fn))
-                  (quit (throw '--delete-cancel (message "OK, canceled")))
-                  (error ;; catch errors from failed deletions
-                   (dired-log "%s: %s\n" (car err) (error-message-string err))
-                   (setq failures (cons (car (car l)) failures)))))
+              ;; Temporarily prevent auto-revert while deleting entry in
+              ;; the dired buffer (bug#71264).
+              (inhibit-auto-revert
+                (let ((inhibit-read-only t))
+                  (condition-case err
+                      (let ((fn (car (car l))))
+                        (dired-delete-file fn dired-recursive-deletes trash)
+                        ;; if we get here, removing worked
+                        (setq succ (1+ succ))
+                        (progress-reporter-update progress-reporter succ)
+                        (dired-fun-in-all-buffers
+                         (file-name-directory fn) (file-name-nondirectory fn)
+                         #'dired-delete-entry fn)
+                        ;; For when FN's directory name is different
+                        ;; from the current buffer's dired-directory.
+                        (dired-delete-entry fn))
+                    (quit (throw '--delete-cancel (message "OK, canceled")))
+                    (error ;; catch errors from failed deletions
+                     (dired-log "%s: %s\n" (car err) (error-message-string err))
+                     (setq failures (cons (car (car l)) failures))))))
               (setq l (cdr l)))
             (if (not failures)
                 (progress-reporter-done progress-reporter)