(substitute-key-definition-key): New function.
[bpt/emacs.git] / lisp / subr.el
index b9e14ad..60e0694 100644 (file)
@@ -1,7 +1,7 @@
 ;;; subr.el --- basic lisp subroutines for Emacs
 
-;; Copyright (C) 1985, 86, 92, 94, 95, 99, 2000, 2001, 2002, 03, 2004
-;;   Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
+;;   2004  Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: internal
@@ -198,7 +198,7 @@ If N is bigger than the length of LIST, return LIST."
     list))
 
 (defun butlast (list &optional n)
-  "Returns a copy of LIST with the last N elements removed."
+  "Return a copy of LIST with the last N elements removed."
   (if (and n (<= n 0)) list
     (nbutlast (copy-sequence list) n)))
 
@@ -367,15 +367,6 @@ but optional second arg NODIGITS non-nil treats them like other chars."
          (define-key map (char-to-string loop) 'digit-argument)
          (setq loop (1+ loop))))))
 
-;Moved to keymap.c
-;(defun copy-keymap (keymap)
-;  "Return a copy of KEYMAP"
-;  (while (not (keymapp keymap))
-;    (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap))))
-;  (if (vectorp keymap)
-;      (copy-sequence keymap)
-;      (copy-alist keymap)))
-
 (defvar key-substitution-in-progress nil
  "Used internally by substitute-key-definition.")
 
@@ -383,7 +374,10 @@ but optional second arg NODIGITS non-nil treats them like other chars."
   "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
-in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP."
+in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
+
+For most uses, it is simpler and safer to use command remappping like this:
+  \(define-key KEYMAP [remap OLDDEF] NEWDEF)"
   ;; Don't document PREFIX in the doc string because we don't want to
   ;; advertise it.  It's meant for recursive calls only.  Here's its
   ;; meaning
@@ -393,126 +387,54 @@ in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP."
   ;; original key, with PREFIX added at the front.
   (or prefix (setq prefix ""))
   (let* ((scan (or oldmap keymap))
-        (vec1 (vector nil))
-        (prefix1 (vconcat prefix vec1))
+        (prefix1 (vconcat prefix [nil]))
         (key-substitution-in-progress
          (cons scan key-substitution-in-progress)))
     ;; Scan OLDMAP, finding each char or event-symbol that
     ;; has any definition, and act on it with hack-key.
-    (while (consp scan)
-      (if (consp (car scan))
-         (let ((char (car (car scan)))
-               (defn (cdr (car scan))))
-           ;; The inside of this let duplicates exactly
-           ;; the inside of the following let that handles array elements.
-           (aset vec1 0 char)
-           (aset prefix1 (length prefix) char)
-           (let (inner-def skipped)
-             ;; Skip past menu-prompt.
-             (while (stringp (car-safe defn))
-               (setq skipped (cons (car defn) skipped))
-               (setq defn (cdr defn)))
-             ;; Skip past cached key-equivalence data for menu items.
-             (and (consp defn) (consp (car defn))
-                  (setq defn (cdr defn)))
-             (setq inner-def defn)
-             ;; Look past a symbol that names a keymap.
-             (while (and (symbolp inner-def)
-                         (fboundp inner-def))
-               (setq inner-def (symbol-function inner-def)))
-             (if (or (eq defn olddef)
-                     ;; Compare with equal if definition is a key sequence.
-                     ;; That is useful for operating on function-key-map.
-                     (and (or (stringp defn) (vectorp defn))
-                          (equal defn olddef)))
-                 (define-key keymap prefix1 (nconc (nreverse skipped) newdef))
-               (if (and (keymapp defn)
-                        ;; Avoid recursively scanning
-                        ;; where KEYMAP does not have a submap.
-                        (let ((elt (lookup-key keymap prefix1)))
-                          (or (null elt)
-                              (keymapp elt)))
-                        ;; Avoid recursively rescanning keymap being scanned.
-                        (not (memq inner-def
-                                   key-substitution-in-progress)))
-                   ;; If this one isn't being scanned already,
-                   ;; scan it now.
-                   (substitute-key-definition olddef newdef keymap
-                                              inner-def
-                                              prefix1)))))
-       (if (vectorp (car scan))
-           (let* ((array (car scan))
-                  (len (length array))
-                  (i 0))
-             (while (< i len)
-               (let ((char i) (defn (aref array i)))
-                 ;; The inside of this let duplicates exactly
-                 ;; the inside of the previous let.
-                 (aset vec1 0 char)
-                 (aset prefix1 (length prefix) char)
-                 (let (inner-def skipped)
-                   ;; Skip past menu-prompt.
-                   (while (stringp (car-safe defn))
-                     (setq skipped (cons (car defn) skipped))
-                     (setq defn (cdr defn)))
-                   (and (consp defn) (consp (car defn))
-                        (setq defn (cdr defn)))
-                   (setq inner-def defn)
-                   (while (and (symbolp inner-def)
-                               (fboundp inner-def))
-                     (setq inner-def (symbol-function inner-def)))
-                   (if (or (eq defn olddef)
-                           (and (or (stringp defn) (vectorp defn))
-                                (equal defn olddef)))
-                       (define-key keymap prefix1
-                         (nconc (nreverse skipped) newdef))
-                     (if (and (keymapp defn)
-                              (let ((elt (lookup-key keymap prefix1)))
-                                (or (null elt)
-                                    (keymapp elt)))
-                              (not (memq inner-def
-                                         key-substitution-in-progress)))
-                         (substitute-key-definition olddef newdef keymap
-                                                    inner-def
-                                                    prefix1)))))
-               (setq i (1+ i))))
-         (if (char-table-p (car scan))
-             (map-char-table
-              (function (lambda (char defn)
-                          (let ()
-                            ;; The inside of this let duplicates exactly
-                            ;; the inside of the previous let,
-                            ;; except that it uses set-char-table-range
-                            ;; instead of define-key.
-                            (aset vec1 0 char)
-                            (aset prefix1 (length prefix) char)
-                            (let (inner-def skipped)
-                              ;; Skip past menu-prompt.
-                              (while (stringp (car-safe defn))
-                                (setq skipped (cons (car defn) skipped))
-                                (setq defn (cdr defn)))
-                              (and (consp defn) (consp (car defn))
-                                   (setq defn (cdr defn)))
-                              (setq inner-def defn)
-                              (while (and (symbolp inner-def)
-                                          (fboundp inner-def))
-                                (setq inner-def (symbol-function inner-def)))
-                              (if (or (eq defn olddef)
-                                      (and (or (stringp defn) (vectorp defn))
-                                           (equal defn olddef)))
-                                  (define-key keymap prefix1
-                                    (nconc (nreverse skipped) newdef))
-                                (if (and (keymapp defn)
-                                         (let ((elt (lookup-key keymap prefix1)))
-                                           (or (null elt)
-                                               (keymapp elt)))
-                                         (not (memq inner-def
-                                                    key-substitution-in-progress)))
-                                    (substitute-key-definition olddef newdef keymap
-                                                               inner-def
-                                                               prefix1)))))))
-              (car scan)))))
-      (setq scan (cdr scan)))))
+    (map-keymap
+     (lambda (char defn)
+       (aset prefix1 (length prefix) char)
+       (substitute-key-definition-key defn olddef newdef prefix1 keymap))
+     scan)))
+
+(defun substitute-key-definition-key (defn olddef newdef prefix keymap)
+  (let (inner-def skipped menu-item)
+    ;; Find the actual command name within the binding.
+    (if (eq (car-safe defn) 'menu-item)
+       (setq menu-item defn defn (nth 2 defn))
+      ;; Skip past menu-prompt.
+      (while (stringp (car-safe defn))
+       (push (pop defn) skipped))
+      ;; Skip past cached key-equivalence data for menu items.
+      (if (consp (car-safe defn))
+         (setq defn (cdr defn))))
+    (if (or (eq defn olddef)
+           ;; Compare with equal if definition is a key sequence.
+           ;; That is useful for operating on function-key-map.
+           (and (or (stringp defn) (vectorp defn))
+                (equal defn olddef)))
+       (define-key keymap prefix
+         (if menu-item
+             (let ((copy (copy-sequence menu-item)))
+               (setcar (nthcdr 2 copy) newdef)
+               copy)
+           (nconc (nreverse skipped) newdef)))
+      ;; Look past a symbol that names a keymap.
+      (setq inner-def
+           (condition-case nil (indirect-function defn) (error defn)))
+      ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
+      ;; avoid autoloading a keymap.  This is mostly done to preserve the
+      ;; original non-autoloading behavior of pre-map-keymap times.
+      (if (and (keymapp inner-def)
+              ;; Avoid recursively scanning
+              ;; where KEYMAP does not have a submap.
+              (let ((elt (lookup-key keymap prefix)))
+                (or (null elt) (natnump elt) (keymapp elt)))
+              ;; Avoid recursively rescanning keymap being scanned.
+              (not (memq inner-def key-substitution-in-progress)))
+         ;; If this one isn't being scanned already, scan it now.
+         (substitute-key-definition olddef newdef keymap inner-def prefix)))))
 
 (defun define-key-after (keymap key definition &optional after)
   "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
@@ -566,7 +488,7 @@ The order of bindings in a keymap matters when it is used as a menu."
 (defmacro kbd (keys)
   "Convert KEYS to the internal Emacs key representation.
 KEYS should be a string constant in the format used for
-saving keyboard macros (see `insert-kbd-macro')."
+saving keyboard macros (see `edmacro-mode')."
   (read-kbd-macro keys))
 
 (put 'keyboard-translate-table 'char-table-extra-slots 0)
@@ -641,10 +563,14 @@ The normal global definition of the character C-x indirects to this keymap.")
           (get (car obj) 'event-symbol-elements))))
 
 (defun event-modifiers (event)
-  "Returns a list of symbols representing the modifier keys in event EVENT.
+  "Return a list of symbols representing the modifier keys in event EVENT.
 The elements of the list may include `meta', `control',
 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
-and `down'."
+and `down'.
+EVENT may be an event or an event type.  If EVENT is a symbol
+that has never been used in an event that has been read as input
+in the current Emacs session, then this function can return nil,
+even when EVENT actually has modifiers."
   (let ((type event))
     (if (listp type)
        (setq type (car type)))
@@ -654,35 +580,37 @@ and `down'."
            (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
                                               ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
        (if (not (zerop (logand type ?\M-\^@)))
-           (setq list (cons 'meta list)))
+           (push 'meta list))
        (if (or (not (zerop (logand type ?\C-\^@)))
                (< char 32))
-           (setq list (cons 'control list)))
+           (push 'control list))
        (if (or (not (zerop (logand type ?\S-\^@)))
                (/= char (downcase char)))
-           (setq list (cons 'shift list)))
+           (push 'shift list))
        (or (zerop (logand type ?\H-\^@))
-           (setq list (cons 'hyper list)))
+           (push 'hyper list))
        (or (zerop (logand type ?\s-\^@))
-           (setq list (cons 'super list)))
+           (push 'super list))
        (or (zerop (logand type ?\A-\^@))
-           (setq list (cons 'alt list)))
+           (push 'alt list))
        list))))
 
 (defun event-basic-type (event)
-  "Returns the basic type of the given event (all modifiers removed).
-The value is a printing character (not upper case) or a symbol."
+  "Return the basic type of the given event (all modifiers removed).
+The value is a printing character (not upper case) or a symbol.
+EVENT may be an event or an event type.  If EVENT is a symbol
+that has never been used in an event that has been read as input
+in the current Emacs session, then this function may return nil."
   (if (consp event)
       (setq event (car event)))
   (if (symbolp event)
       (car (get event 'event-symbol-elements))
-    (let ((base (logand event (1- (lsh 1 18)))))
+    (let ((base (logand event (1- ?\A-\^@))))
       (downcase (if (< base 32) (logior base 64) base)))))
 
 (defsubst mouse-movement-p (object)
   "Return non-nil if OBJECT is a mouse movement event."
-  (and (consp object)
-       (eq (car object) 'mouse-movement)))
+  (eq (car-safe object) 'mouse-movement))
 
 (defsubst event-start (event)
   "Return the starting position of EVENT.
@@ -851,9 +779,11 @@ and `event-end' functions."
 (make-obsolete 'dot-min 'point-min     "before 19.15")
 (make-obsolete 'dot-marker 'point-marker "before 19.15")
 (make-obsolete 'buffer-flush-undo 'buffer-disable-undo "before 19.15")
-(make-obsolete 'baud-rate "use the baud-rate variable instead." "before 19.15")
+(make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
 (make-obsolete 'compiled-function-p 'byte-code-function-p "before 19.15")
 (make-obsolete 'define-function 'defalias "20.1")
+(make-obsolete 'focus-frame "it does nothing." "19.32")
+(make-obsolete 'unfocus-frame "it does nothing." "19.32")
 
 (defun insert-string (&rest args)
   "Mocklisp-compatibility insert function.
@@ -870,8 +800,8 @@ is converted into a string by expressing it in decimal."
   "Return the value of the `baud-rate' variable."
   baud-rate)
 
-(defalias 'focus-frame 'ignore)
-(defalias 'unfocus-frame 'ignore)
+(defalias 'focus-frame 'ignore "")
+(defalias 'unfocus-frame 'ignore "")
 
 \f
 ;;;; Obsolescence declarations for variables.
@@ -1186,8 +1116,8 @@ Optional args SENTINEL and FILTER specify the sentinel and filter
 ;; compatibility
 
 (make-obsolete 'process-kill-without-query
-               "use `process-query-on-exit-flag'\nor `set-process-query-on-exit-flag'."
-               "21.5")
+               "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
+               "21.4")
 (defun process-kill-without-query (process &optional flag)
   "Say no query needed if PROCESS is running when Emacs is exited.
 Optional second argument if non-nil says to require a query.
@@ -1333,9 +1263,11 @@ Optional DEFAULT is a default password to use instead of empty input."
   (let ((n nil))
     (when default
       (setq prompt
-           (if (string-match "\\(\\):[^:]*" prompt)
-               (replace-match (format " [%s]" default) t t prompt 1)
-             (concat prompt (format " [%s] " default)))))
+           (if (string-match "\\(\\):[ \t]*\\'" prompt)
+               (replace-match (format " (default %s)" default) t t prompt 1)
+             (replace-regexp-in-string "[ \t]*\\'"
+                                       (format " (default %s) " default)
+                                       prompt t t))))
     (while
        (progn
          (let ((str (read-from-minibuffer prompt nil nil nil nil
@@ -1596,7 +1528,8 @@ On other systems, this variable is normally always nil.")
 
 ;; This should probably be written in C (i.e., without using `walk-windows').
 (defun get-buffer-window-list (buffer &optional minibuf frame)
-  "Return windows currently displaying BUFFER, or nil if none.
+  "Return list of all windows displaying BUFFER, or nil if none.
+BUFFER can be a buffer or a buffer name.
 See `walk-windows' for the meaning of MINIBUF and FRAME."
   (let ((buffer (if (bufferp buffer) buffer (get-buffer buffer))) windows)
     (walk-windows (function (lambda (window)
@@ -1704,8 +1637,8 @@ If UNDO is present and non-nil, it is a function that will be called
 (defun insert-buffer-substring-no-properties (buffer &optional start end)
   "Insert before point a substring of BUFFER, without text properties.
 BUFFER may be a buffer or a buffer name.
-Arguments START and END are character numbers specifying the substring.
-They default to the beginning and the end of BUFFER."
+Arguments START and END are character positions specifying the substring.
+They default to the values of (point-min) and (point-max) in BUFFER."
   (let ((opoint (point)))
     (insert-buffer-substring buffer start end)
     (let ((inhibit-read-only t))
@@ -1714,8 +1647,8 @@ They default to the beginning and the end of BUFFER."
 (defun insert-buffer-substring-as-yank (buffer &optional start end)
   "Insert before point a part of BUFFER, stripping some text properties.
 BUFFER may be a buffer or a buffer name.
-Arguments START and END are character numbers specifying the substring.
-They default to the beginning and the end of BUFFER.
+Arguments START and END are character positions specifying the substring.
+They default to the values of (point-min) and (point-max) in BUFFER.
 Strip text properties from the inserted text according to
 `yank-excluded-properties'."
   ;; Since the buffer text should not normally have yank-handler properties,
@@ -1794,12 +1727,29 @@ See also `with-temp-buffer'."
   "Execute the forms in BODY with WINDOW as the selected window.
 The value returned is the value of the last form in BODY.
 This does not alter the buffer list ordering.
+This function saves and restores the selected window, as well as
+the selected window in each frame.  If the previously selected
+window of some frame is no longer live at the end of BODY, that
+frame's selected window is left alone.  If the selected window is
+no longer live, then whatever window is selected at the end of
+BODY remains selected.
 See also `with-temp-buffer'."
   (declare (indent 1) (debug t))
-  `(let ((save-selected-window-window (selected-window)))
+  ;; Most of this code is a copy of save-selected-window.
+  `(let ((save-selected-window-window (selected-window))
+        ;; It is necessary to save all of these, because calling
+        ;; select-window changes frame-selected-window for whatever
+        ;; frame that window is in.
+        (save-selected-window-alist
+         (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
+                 (frame-list))))
      (unwind-protect
         (progn (select-window ,window 'norecord)
                ,@body)
+       (dolist (elt save-selected-window-alist)
+        (and (frame-live-p (car elt))
+             (window-live-p (cadr elt))
+             (set-frame-selected-window (car elt) (cadr elt))))
        (if (window-live-p save-selected-window-window)
           (select-window save-selected-window-window 'norecord)))))
 
@@ -1851,8 +1801,7 @@ Use a MESSAGE of \"\" to temporarily clear the echo area."
 See also `with-temp-file' and `with-output-to-string'."
   (declare (indent 0) (debug t))
   (let ((temp-buffer (make-symbol "temp-buffer")))
-    `(let ((,temp-buffer
-           (get-buffer-create (generate-new-buffer-name " *temp*"))))
+    `(let ((,temp-buffer (generate-new-buffer " *temp*")))
        (unwind-protect
           (with-current-buffer ,temp-buffer
             ,@body)
@@ -1872,7 +1821,10 @@ See also `with-temp-file' and `with-output-to-string'."
         (kill-buffer nil)))))
 
 (defmacro with-local-quit (&rest body)
-  "Execute BODY with `inhibit-quit' temporarily bound to nil."
+  "Execute BODY, allowing quits to terminate BODY but not escape further.
+When a quit terminates BODY, `with-local-quit' requests another quit when
+it finishes.  That quit will be processed in turn, the next time quitting
+is again allowed."
   (declare (debug t) (indent 0))
   `(condition-case nil
        (let ((inhibit-quit nil))
@@ -1905,9 +1857,14 @@ in BODY."
 (make-variable-buffer-local 'delayed-mode-hooks)
 (put 'delay-mode-hooks 'permanent-local t)
 
+(defvar after-change-major-mode-hook nil
+  "Normal hook run at the very end of major mode functions.")
+
 (defun run-mode-hooks (&rest hooks)
   "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
 Execution is delayed if `delay-mode-hooks' is non-nil.
+If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
+after running the mode hooks.
 Major mode functions should use this."
   (if delay-mode-hooks
       ;; Delaying case.
@@ -1916,10 +1873,13 @@ Major mode functions should use this."
     ;; Normal case, just run the hook as before plus any delayed hooks.
     (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
     (setq delayed-mode-hooks nil)
-    (apply 'run-hooks hooks)))
+    (apply 'run-hooks hooks)
+    (run-hooks 'after-change-major-mode-hook)))
 
 (defmacro delay-mode-hooks (&rest body)
   "Execute BODY, but delay any `run-mode-hooks'.
+These hooks will be executed by the first following call to
+`run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
 Only affects hooks run in the current buffer."
   (declare (debug t))
   `(progn
@@ -1937,6 +1897,27 @@ Uses the `derived-mode-parent' property of the symbol to trace backwards."
                (setq parent (get parent 'derived-mode-parent))))
     parent))
 
+(defun find-tag-default ()
+  "Determine default tag to search for, based on text at point.
+If there is no plausible default, return nil."
+  (save-excursion
+    (while (looking-at "\\sw\\|\\s_")
+      (forward-char 1))
+    (if (or (re-search-backward "\\sw\\|\\s_"
+                               (save-excursion (beginning-of-line) (point))
+                               t)
+           (re-search-forward "\\(\\sw\\|\\s_\\)+"
+                              (save-excursion (end-of-line) (point))
+                              t))
+       (progn (goto-char (match-end 0))
+              (buffer-substring-no-properties
+                (point)
+                (progn (forward-sexp -1)
+                       (while (looking-at "\\s'")
+                         (forward-char 1))
+                       (point))))
+      nil)))
+
 (defmacro with-syntax-table (table &rest body)
   "Evaluate BODY with syntax table of current buffer set to TABLE.
 The syntax table of the current buffer is saved, BODY is evaluated, and the
@@ -2062,7 +2043,7 @@ likely to have undesired semantics.")
 ;; expression leads to the equivalent implementation that if SEPARATORS
 ;; is defaulted, OMIT-NULLS is treated as t.
 (defun split-string (string &optional separators omit-nulls)
-  "Splits STRING into substrings bounded by matches for SEPARATORS.
+  "Split STRING into substrings bounded by matches for SEPARATORS.
 
 The beginning and end of STRING, and each match for SEPARATORS, are
 splitting points.  The substrings matching SEPARATORS are removed, and
@@ -2272,13 +2253,13 @@ which in most cases is shared with all other buffers in the same major mode."
 
 (defun global-unset-key (key)
   "Remove global binding of KEY.
-KEY is a string representing a sequence of keystrokes."
+KEY is a string or vector representing a sequence of keystrokes."
   (interactive "kUnset key globally: ")
   (global-set-key key nil))
 
 (defun local-unset-key (key)
   "Remove local binding of KEY.
-KEY is a string representing a sequence of keystrokes."
+KEY is a string or vector representing a sequence of keystrokes."
   (interactive "kUnset key locally: ")
   (if (current-local-map)
       (local-set-key key nil))
@@ -2591,5 +2572,132 @@ The properties used on SYMBOL are `composefunc', `sendfunc',
   (put symbol 'abortfunc (or abortfunc 'kill-buffer))
   (put symbol 'hookvar (or hookvar 'mail-send-hook)))
 
-;;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
+;; Standardized progress reporting
+
+;; Progress reporter has the following structure:
+;;
+;;     (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
+;;                           MIN-VALUE
+;;                           MAX-VALUE
+;;                           MESSAGE
+;;                           MIN-CHANGE
+;;                           MIN-TIME])
+;;
+;; This weirdeness is for optimization reasons: we want
+;; `progress-reporter-update' to be as fast as possible, so
+;; `(car reporter)' is better than `(aref reporter 0)'.
+;;
+;; NEXT-UPDATE-TIME is a float.  While `float-time' loses a couple
+;; digits of precision, it doesn't really matter here.  On the other
+;; hand, it greatly simplifies the code.
+
+(defsubst progress-reporter-update (reporter value)
+  "Report progress of an operation in the echo area.
+However, if the change since last echo area update is too small
+or not enough time has passed, then do nothing (see
+`make-progress-reporter' for details).
+
+First parameter, REPORTER, should be the result of a call to
+`make-progress-reporter'.  Second, VALUE, determines the actual
+progress of operation; it must be between MIN-VALUE and MAX-VALUE
+as passed to `make-progress-reporter'.
+
+This function is very inexpensive, you may not bother how often
+you call it."
+  (when (>= value (car reporter))
+    (progress-reporter-do-update reporter value)))
+
+(defun make-progress-reporter (message min-value max-value
+                                      &optional current-value
+                                      min-change min-time)
+  "Return progress reporter object usage with `progress-reporter-update'.
+
+MESSAGE is shown in the echo area.  When at least 1% of operation
+is complete, the exact percentage will be appended to the
+MESSAGE.  When you call `progress-reporter-done', word \"done\"
+is printed after the MESSAGE.  You can change MESSAGE of an
+existing progress reporter with `progress-reporter-force-update'.
+
+MIN-VALUE and MAX-VALUE designate starting (0% complete) and
+final (100% complete) states of operation.  The latter should be
+larger; if this is not the case, then simply negate all values.
+Optional CURRENT-VALUE specifies the progress by the moment you
+call this function.  You should omit it or set it to nil in most
+cases since it defaults to MIN-VALUE.
+
+Optional MIN-CHANGE determines the minimal change in percents to
+report (default is 1%.)  Optional MIN-TIME specifies the minimal
+time before echo area updates (default is 0.2 seconds.)  If
+`float-time' function is not present, then time is not tracked
+at all.  If OS is not capable of measuring fractions of seconds,
+then this parameter is effectively rounded up."
+
+  (unless min-time
+    (setq min-time 0.2))
+  (let ((reporter
+        (cons min-value ;; Force a call to `message' now
+              (vector (if (and (fboundp 'float-time)
+                               (>= min-time 0.02))
+                          (float-time) nil)
+                      min-value
+                      max-value
+                      message
+                      (if min-change (max (min min-change 50) 1) 1)
+                      min-time))))
+    (progress-reporter-update reporter (or current-value min-value))
+    reporter))
+
+(defun progress-reporter-force-update (reporter value &optional new-message)
+  "Report progress of an operation in the echo area unconditionally.
+
+First two parameters are the same as for
+`progress-reporter-update'.  Optional NEW-MESSAGE allows you to
+change the displayed message."
+  (let ((parameters (cdr reporter)))
+    (when new-message
+      (aset parameters 3 new-message))
+    (when (aref parameters 0)
+      (aset parameters 0 (float-time)))
+    (progress-reporter-do-update reporter value)))
+
+(defun progress-reporter-do-update (reporter value)
+  (let* ((parameters   (cdr reporter))
+        (min-value    (aref parameters 1))
+        (max-value    (aref parameters 2))
+        (one-percent  (/ (- max-value min-value) 100.0))
+        (percentage   (truncate (/ (- value min-value) one-percent)))
+        (update-time  (aref parameters 0))
+        (current-time (float-time))
+        (enough-time-passed
+         ;; See if enough time has passed since the last update.
+         (or (not update-time)
+             (when (>= current-time update-time)
+               ;; Calculate time for the next update
+               (aset parameters 0 (+ update-time (aref parameters 5)))))))
+    ;;
+    ;; Calculate NEXT-UPDATE-VALUE.  If we are not going to print
+    ;; message this time because not enough time has passed, then use
+    ;; 1 instead of MIN-CHANGE.  This makes delays between echo area
+    ;; updates closer to MIN-TIME.
+    (setcar reporter
+           (min (+ min-value (* (+ percentage
+                                   (if enough-time-passed
+                                       (aref parameters 4) ;; MIN-CHANGE
+                                     1))
+                                one-percent))
+                max-value))
+    (when (integerp value)
+      (setcar reporter (ceiling (car reporter))))
+    ;;
+    ;; Only print message if enough time has passed
+    (when enough-time-passed
+      (if (> percentage 0)
+         (message "%s%d%%" (aref parameters 3) percentage)
+       (message "%s" (aref parameters 3))))))
+
+(defun progress-reporter-done (reporter)
+  "Print reporter's message followed by word \"done\" in echo area."
+  (message "%sdone" (aref (cdr reporter) 3)))
+
+;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
 ;;; subr.el ends here