Re: make-progress-reporter suggestions: 'modeline and customizable progress-reporter--pulse-characters

[Michael Albinus <michael.albinus@gmx.de>]

[-- Attachment #1: Type: text/plain, Size: 1425 bytes --]

Ted Zlatanov <tzz@lifelogs.com> writes:

> How about (showing both proposed use cases)
>
> (setq pr1 (make-progress-reporter 'modeline))
> (setq pr4 (make-progress-reporter 'modeline 0 100))
> (while t 
>   (progress-reporter-update pr1)
>   (progress-reporter-update pr4))
>
> to work in conjunction with a %/ in the modeline?  The idea is that it
> is guaranteed to be 1 or log10(max)+2 characters (non-numeric or
> numeric) wide in this mode and it won't make any noise in the echo area.

As proof of concept the appended patch. I don't use a special "%/"
format in the modeline; instead of there is `mode-line-progress-reporter'
which can be placed somewhere in `mode-line-format' (I've done it after
`mode-line-remote').

You call

(setq pr (make-progress-reporter))
(while t (progress-reporter-update pr))

No text in `make-progress-reporter' would be the modeline indicator;
a text based progress reporter still writes in the minibuffer:

(setq pr (make-progress-reporter ""))
(while t (progress-reporter-update pr))

> Another suggestion for progress-reporter--pulse-characters for both
> modeline and regular use: there are some Unicode glyphs which could be
> used if the font supports them:
> http://en.wikipedia.org/wiki/Harvey_Balls#Harvey_Balls_in_Unicode
>
> Maybe progress-reporter--pulse-characters could be customizable with
> some presets like the above.

That's for later.

> Ted

Best regards, Michael.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Type: text/x-patch, Size: 2481 bytes --]

=== modified file 'lisp/bindings.el'
--- lisp/bindings.el	2011-01-25 04:08:28 +0000
+++ lisp/bindings.el	2011-02-17 20:37:34 +0000
@@ -254,9 +254,13 @@
   "Mode-line flag to show if default-directory for current buffer is remote.")
 ;;;###autoload
 (put 'mode-line-remote 'risky-local-variable t)
-
 (make-variable-buffer-local 'mode-line-remote)
 
+(defvar mode-line-progress-reporter nil
+  "Mode-line control for spinning progress-reporter.")
+;;;###autoload
+(put 'mode-line-progress-reporter 'risky-local-variable t)
+
 ;; Actual initialization is below.
 (defvar mode-line-position nil
   "Mode-line control for displaying the position in the buffer.
@@ -326,6 +330,7 @@
 	 'mode-line-client
 	 'mode-line-modified
 	 'mode-line-remote
+	 'mode-line-progress-reporter
 	 'mode-line-frame-identification
 	 'mode-line-buffer-identification
 	 (propertize "   " 'help-echo help-echo)

=== modified file 'lisp/subr.el'
--- lisp/subr.el	2011-02-01 21:37:12 +0000
+++ lisp/subr.el	2011-02-17 21:31:24 +0000
@@ -3486,7 +3486,7 @@
 	    (>= value (car reporter))) ; For numerical reporter
     (progress-reporter-do-update reporter value)))
 
-(defun make-progress-reporter (message &optional min-value max-value
+(defun make-progress-reporter (&optional message min-value max-value
 				       current-value min-change min-time)
   "Return progress reporter object for use with `progress-reporter-update'.
 
@@ -3553,6 +3553,7 @@
 	 (min-value    (aref parameters 1))
 	 (max-value    (aref parameters 2))
 	 (text         (aref parameters 3))
+	 (min-time     (aref parameters 5))
 	 (current-time (float-time))
 	 (enough-time-passed
 	  ;; See if enough time has passed since the last update.
@@ -3591,10 +3592,20 @@
 	   (let ((index (mod (1+ (car reporter)) 4))
 		 (message-log-max nil))
 	     (setcar reporter index)
-	     (message "%s %s"
-		      text
-		      (aref progress-reporter--pulse-characters
-			    index)))))))
+	     (if text
+		 ;; Write into the minibuffer
+		 (message "%s %s"
+			  text
+			  (aref progress-reporter--pulse-characters
+				index))
+	       ;; Update modeline
+	       (let ((mode-line-progress-reporter
+		      (list (propertize
+			     (aref progress-reporter--pulse-characters index)
+			     'mouse-face 'mode-line-highlight)))
+		     mode-line-remote)
+		 (force-mode-line-update)
+		 (sit-for min-time t))))))))
 
 (defun progress-reporter-done (reporter)
   "Print reporter's message followed by word \"done\" in echo area."