Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-428
[bpt/emacs.git] / lisp / mh-e / mh-speed.el
1 ;;; mh-speed.el --- Speedbar interface for MH-E.
2
3 ;; Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
4
5 ;; Author: Satyaki Das <satyaki@theforce.stanford.edu>
6 ;; Maintainer: Bill Wohler <wohler@newt.com>
7 ;; Keywords: mail
8 ;; See: mh-e.el
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
26
27 ;;; Commentary:
28 ;; Future versions should only use flists.
29
30 ;; Speedbar support for MH-E package.
31
32 ;;; Change Log:
33
34 ;;; Code:
35
36 ;; Requires
37 (eval-when-compile (require 'mh-acros))
38 (mh-require-cl)
39 (require 'mh-e)
40 (require 'speedbar)
41 (require 'timer)
42
43 ;; Global variables
44 (defvar mh-speed-refresh-flag nil)
45 (defvar mh-speed-last-selected-folder nil)
46 (defvar mh-speed-folder-map (make-hash-table :test #'equal))
47 (defvar mh-speed-flists-cache (make-hash-table :test #'equal))
48 (defvar mh-speed-flists-process nil)
49 (defvar mh-speed-flists-timer nil)
50 (defvar mh-speed-partial-line "")
51
52 ;; Add our stealth update function
53 (unless (member 'mh-speed-stealth-update
54 (cdr (assoc "files" speedbar-stealthy-function-list)))
55 ;; Is changing constant lists in elisp safe?
56 (setq speedbar-stealthy-function-list
57 (copy-tree speedbar-stealthy-function-list))
58 (push 'mh-speed-stealth-update
59 (cdr (assoc "files" speedbar-stealthy-function-list))))
60
61 ;; Functions called by speedbar to initialize display...
62 ;;;###mh-autoload
63 (defun mh-folder-speedbar-buttons (buffer)
64 "Interface function to create MH-E speedbar buffer.
65 BUFFER is the MH-E buffer for which the speedbar buffer is to be created."
66 (unless (get-text-property (point-min) 'mh-level)
67 (erase-buffer)
68 (clrhash mh-speed-folder-map)
69 (speedbar-make-tag-line 'bracket ?+ 'mh-speed-toggle nil " " 'ignore nil
70 'mh-speedbar-folder 0)
71 (forward-line -1)
72 (setf (gethash nil mh-speed-folder-map)
73 (set-marker (or (gethash nil mh-speed-folder-map) (make-marker))
74 (1+ (line-beginning-position))))
75 (add-text-properties
76 (line-beginning-position) (1+ (line-beginning-position))
77 `(mh-folder nil mh-expanded nil mh-children-p t mh-level 0))
78 (mh-speed-stealth-update t)
79 (when mh-speed-run-flists-flag
80 (mh-speed-flists nil))))
81
82 ;;;###mh-autoload
83 (defalias 'mh-show-speedbar-buttons 'mh-folder-speedbar-buttons)
84 ;;;###mh-autoload
85 (defalias 'mh-letter-speedbar-buttons 'mh-folder-speedbar-buttons)
86
87 ;; Keymaps for speedbar...
88 (defvar mh-folder-speedbar-key-map (speedbar-make-specialized-keymap)
89 "Specialized speedbar keymap for MH-E buffers.")
90 (gnus-define-keys mh-folder-speedbar-key-map
91 "+" mh-speed-expand-folder
92 "-" mh-speed-contract-folder
93 "\r" mh-speed-view
94 "r" mh-speed-refresh)
95
96 (defvar mh-show-speedbar-key-map mh-folder-speedbar-key-map)
97 (defvar mh-letter-speedbar-key-map mh-folder-speedbar-key-map)
98
99 ;; Menus for speedbar...
100 (defvar mh-folder-speedbar-menu-items
101 '("--"
102 ["Visit Folder" mh-speed-view
103 (save-excursion
104 (set-buffer speedbar-buffer)
105 (get-text-property (line-beginning-position) 'mh-folder))]
106 ["Expand Nested Folders" mh-speed-expand-folder
107 (and (get-text-property (line-beginning-position) 'mh-children-p)
108 (not (get-text-property (line-beginning-position) 'mh-expanded)))]
109 ["Contract Nested Folders" mh-speed-contract-folder
110 (and (get-text-property (line-beginning-position) 'mh-children-p)
111 (get-text-property (line-beginning-position) 'mh-expanded))]
112 ["Refresh Speedbar" mh-speed-refresh t])
113 "Extra menu items for speedbar.")
114
115 (defvar mh-show-speedbar-menu-items mh-folder-speedbar-menu-items)
116 (defvar mh-letter-speedbar-menu-items mh-folder-speedbar-menu-items)
117
118 (defmacro mh-speed-select-attached-frame ()
119 "Compatibility macro to handle speedbar versions 0.11a and 0.14beta4."
120 (cond ((fboundp 'dframe-select-attached-frame)
121 '(dframe-select-attached-frame speedbar-frame))
122 ((boundp 'speedbar-attached-frame)
123 '(select-frame speedbar-attached-frame))
124 (t (error "Installed speedbar version not supported by MH-E"))))
125
126 (defun mh-speed-update-current-folder (force)
127 "Update speedbar highlighting of the current folder.
128 The function tries to be smart so that work done is minimized. The currently
129 highlighted folder is cached and no highlighting happens unless it changes.
130 Also highlighting is suspended while the speedbar frame is selected.
131 Otherwise you get the disconcerting behavior of folders popping open on their
132 own when you are trying to navigate around in the speedbar buffer.
133
134 The update is always carried out if FORCE is non-nil."
135 (let* ((lastf (selected-frame))
136 (newcf (save-excursion
137 (mh-speed-select-attached-frame)
138 (prog1 (mh-speed-extract-folder-name (buffer-name))
139 (select-frame lastf))))
140 (lastb (current-buffer))
141 (case-fold-search t))
142 (when (or force
143 (and mh-speed-refresh-flag (not (eq lastf speedbar-frame)))
144 (and (stringp newcf)
145 (equal (substring newcf 0 1) "+")
146 (not (equal newcf mh-speed-last-selected-folder))))
147 (setq mh-speed-refresh-flag nil)
148 (select-frame speedbar-frame)
149 (set-buffer speedbar-buffer)
150
151 ;; Remove highlight from previous match...
152 (mh-speed-highlight mh-speed-last-selected-folder 'mh-speedbar-folder)
153
154 ;; If we found a match highlight it...
155 (when (mh-speed-goto-folder newcf)
156 (mh-speed-highlight newcf 'mh-speedbar-selected-folder))
157
158 (setq mh-speed-last-selected-folder newcf)
159 (speedbar-position-cursor-on-line)
160 (set-window-point (frame-first-window speedbar-frame) (point))
161 (set-buffer lastb)
162 (select-frame lastf))
163 (when (eq lastf speedbar-frame)
164 (setq mh-speed-refresh-flag t))))
165
166 (defun mh-speed-normal-face (face)
167 "Return normal face for given FACE."
168 (cond ((eq face 'mh-speedbar-folder-with-unseen-messages)
169 'mh-speedbar-folder)
170 ((eq face 'mh-speedbar-selected-folder-with-unseen-messages)
171 'mh-speedbar-selected-folder)
172 (t face)))
173
174 (defun mh-speed-bold-face (face)
175 "Return bold face for given FACE."
176 (cond ((eq face 'mh-speedbar-folder)
177 'mh-speedbar-folder-with-unseen-messages)
178 ((eq face 'mh-speedbar-selected-folder)
179 'mh-speedbar-selected-folder-with-unseen-messages)
180 (t face)))
181
182 (defun mh-speed-highlight (folder face)
183 "Set FOLDER to FACE."
184 (save-excursion
185 (speedbar-with-writable
186 (goto-char (gethash folder mh-speed-folder-map (point)))
187 (beginning-of-line)
188 (if (re-search-forward "([1-9][0-9]*/[0-9]+)" (line-end-position) t)
189 (setq face (mh-speed-bold-face face))
190 (setq face (mh-speed-normal-face face)))
191 (beginning-of-line)
192 (when (re-search-forward "\\[.\\] " (line-end-position) t)
193 (put-text-property (point) (line-end-position) 'face face)))))
194
195 (defun mh-speed-stealth-update (&optional force)
196 "Do stealth update.
197 With non-nil FORCE, the update is always carried out."
198 (cond ((save-excursion (set-buffer speedbar-buffer)
199 (get-text-property (point-min) 'mh-level))
200 ;; Execute this hook and *don't* run anything else
201 (mh-speed-update-current-folder force)
202 nil)
203 ;; Otherwise on to your regular programming
204 (t t)))
205
206 (defun mh-speed-goto-folder (folder)
207 "Move point to line containing FOLDER.
208 The function will expand out parent folders of FOLDER if needed."
209 (let ((prefix folder)
210 (suffix-list ())
211 (last-slash t))
212 (while (and (not (gethash prefix mh-speed-folder-map)) last-slash)
213 (setq last-slash (mh-search-from-end ?/ prefix))
214 (when (integerp last-slash)
215 (push (substring prefix (1+ last-slash)) suffix-list)
216 (setq prefix (substring prefix 0 last-slash))))
217 (let ((prefix-position (gethash prefix mh-speed-folder-map)))
218 (if prefix-position
219 (goto-char prefix-position)
220 (goto-char (point-min))
221 (mh-speed-toggle)
222 (unless (get-text-property (point) 'mh-expanded)
223 (mh-speed-toggle))
224 (goto-char (gethash prefix mh-speed-folder-map))))
225 (while suffix-list
226 ;; We always need atleast one toggle. We need two if the directory list
227 ;; is stale since a folder was added.
228 (when (equal prefix (get-text-property (line-beginning-position)
229 'mh-folder))
230 (mh-speed-toggle)
231 (unless (get-text-property (point) 'mh-expanded)
232 (mh-speed-toggle)))
233 (setq prefix (format "%s/%s" prefix (pop suffix-list)))
234 (goto-char (gethash prefix mh-speed-folder-map (point))))
235 (beginning-of-line)
236 (equal folder (get-text-property (point) 'mh-folder))))
237
238 (defun mh-speed-extract-folder-name (buffer)
239 "Given an MH-E BUFFER find the folder that should be highlighted.
240 Do the right thing for the different kinds of buffers that MH-E uses."
241 (save-excursion
242 (set-buffer buffer)
243 (cond ((eq major-mode 'mh-folder-mode)
244 mh-current-folder)
245 ((eq major-mode 'mh-show-mode)
246 (set-buffer mh-show-folder-buffer)
247 mh-current-folder)
248 ((eq major-mode 'mh-letter-mode)
249 (when (string-match mh-user-path buffer-file-name)
250 (let* ((rel-path (substring buffer-file-name (match-end 0)))
251 (directory-end (mh-search-from-end ?/ rel-path)))
252 (when directory-end
253 (format "+%s" (substring rel-path 0 directory-end)))))))))
254
255 (defun mh-speed-add-buttons (folder level)
256 "Add speedbar button for FOLDER which is at indented by LEVEL amount."
257 (let ((folder-list (mh-sub-folders folder)))
258 (mapc
259 (lambda (f)
260 (let* ((folder-name (format "%s%s%s" (or folder "+")
261 (if folder "/" "") (car f)))
262 (counts (gethash folder-name mh-speed-flists-cache)))
263 (speedbar-with-writable
264 (speedbar-make-tag-line
265 'bracket (if (cdr f) ?+ ? )
266 'mh-speed-toggle nil
267 (format "%s%s"
268 (car f)
269 (if counts
270 (format " (%s/%s)" (car counts) (cdr counts))
271 ""))
272 'mh-speed-view nil
273 (if (and counts (> (car counts) 0))
274 'mh-speedbar-folder-with-unseen-messages
275 'mh-speedbar-folder)
276 level)
277 (save-excursion
278 (forward-line -1)
279 (setf (gethash folder-name mh-speed-folder-map)
280 (set-marker (or (gethash folder-name mh-speed-folder-map)
281 (make-marker))
282 (1+ (line-beginning-position))))
283 (add-text-properties
284 (line-beginning-position) (1+ (line-beginning-position))
285 `(mh-folder ,folder-name
286 mh-expanded nil
287 mh-children-p ,(not (not (cdr f)))
288 ,@(if counts `(mh-count
289 (,(car counts) . ,(cdr counts))) ())
290 mh-level ,level))))))
291 folder-list)))
292
293 ;;;###mh-autoload
294 (defun mh-speed-toggle (&rest args)
295 "Toggle the display of child folders.
296 The otional ARGS are ignored and there for compatibilty with speedbar."
297 (interactive)
298 (declare (ignore args))
299 (beginning-of-line)
300 (let ((parent (get-text-property (point) 'mh-folder))
301 (kids-p (get-text-property (point) 'mh-children-p))
302 (expanded (get-text-property (point) 'mh-expanded))
303 (level (get-text-property (point) 'mh-level))
304 (point (point))
305 start-region)
306 (speedbar-with-writable
307 (cond ((not kids-p) nil)
308 (expanded
309 (forward-line)
310 (setq start-region (point))
311 (while (and (get-text-property (point) 'mh-level)
312 (> (get-text-property (point) 'mh-level) level))
313 (let ((folder (get-text-property (point) 'mh-folder)))
314 (when (gethash folder mh-speed-folder-map)
315 (set-marker (gethash folder mh-speed-folder-map) nil)
316 (remhash folder mh-speed-folder-map)))
317 (forward-line))
318 (delete-region start-region (point))
319 (forward-line -1)
320 (speedbar-change-expand-button-char ?+)
321 (add-text-properties
322 (line-beginning-position) (1+ (line-beginning-position))
323 '(mh-expanded nil)))
324 (t
325 (forward-line)
326 (mh-speed-add-buttons parent (1+ level))
327 (goto-char point)
328 (speedbar-change-expand-button-char ?-)
329 (add-text-properties
330 (line-beginning-position) (1+ (line-beginning-position))
331 `(mh-expanded t)))))))
332
333 (defalias 'mh-speed-expand-folder 'mh-speed-toggle)
334 (defalias 'mh-speed-contract-folder 'mh-speed-toggle)
335
336 ;;;###mh-autoload
337 (defun mh-speed-view (&rest args)
338 "View folder on current line.
339 Optional ARGS are ignored."
340 (interactive)
341 (declare (ignore args))
342 (let* ((folder (get-text-property (line-beginning-position) 'mh-folder))
343 (range (and (stringp folder)
344 (mh-read-range "Scan" folder t nil nil
345 mh-interpret-number-as-range-flag))))
346 (when (stringp folder)
347 (speedbar-with-attached-buffer
348 (mh-visit-folder folder range)
349 (delete-other-windows)))))
350
351 (defvar mh-speed-current-folder nil)
352 (defvar mh-speed-flists-folder nil)
353
354 (defmacro mh-process-kill-without-query (process)
355 "PROCESS can be killed without query on Emacs exit.
356 Avoid using `process-kill-without-query' if possible since it is now
357 obsolete."
358 (if (fboundp 'set-process-query-on-exit-flag)
359 `(set-process-query-on-exit-flag ,process nil)
360 `(process-kill-without-query ,process)))
361
362 ;;;###mh-autoload
363 (defun mh-speed-flists (force &rest folders)
364 "Execute flists -recurse and update message counts.
365 If FORCE is non-nil the timer is reset.
366
367 Any number of optional FOLDERS can be specified. If specified, flists is run
368 only for that one folder."
369 (interactive (list t))
370 (when force
371 (when mh-speed-flists-timer
372 (cancel-timer mh-speed-flists-timer)
373 (setq mh-speed-flists-timer nil))
374 (when (and (processp mh-speed-flists-process)
375 (not (eq (process-status mh-speed-flists-process) 'exit)))
376 (set-process-filter mh-speed-flists-process t)
377 (kill-process mh-speed-flists-process)
378 (setq mh-speed-partial-line "")
379 (setq mh-speed-flists-process nil)))
380 (setq mh-speed-flists-folder folders)
381 (unless mh-speed-flists-timer
382 (setq mh-speed-flists-timer
383 (run-at-time
384 nil (and mh-speed-run-flists-flag mh-speed-flists-interval)
385 (lambda ()
386 (unless (and (processp mh-speed-flists-process)
387 (not (eq (process-status mh-speed-flists-process)
388 'exit)))
389 (setq mh-speed-current-folder
390 (concat
391 (if mh-speed-flists-folder
392 (substring (car (reverse mh-speed-flists-folder)) 1)
393 (with-temp-buffer
394 (call-process (expand-file-name "folder" mh-progs)
395 nil '(t nil) nil "-fast")
396 (buffer-substring (point-min) (1- (point-max)))))
397 "+"))
398 (setq mh-speed-flists-process
399 (apply #'start-process "*flists*" nil
400 (expand-file-name "flists" mh-progs)
401 (if mh-speed-flists-folder "-noall" "-all")
402 "-sequence" (symbol-name mh-unseen-seq)
403 (or mh-speed-flists-folder '("-recurse"))))
404 ;; Run flists on all folders the next time around...
405 (setq mh-speed-flists-folder nil)
406 (mh-process-kill-without-query mh-speed-flists-process)
407 (set-process-filter mh-speed-flists-process
408 'mh-speed-parse-flists-output)))))))
409
410 ;; Copied from mh-make-folder-list-filter...
411 (defun mh-speed-parse-flists-output (process output)
412 "Parse the incremental results from flists.
413 PROCESS is the flists process and OUTPUT is the results that must be handled
414 next."
415 (let ((prevailing-match-data (match-data))
416 (position 0)
417 line-end line folder unseen total)
418 (unwind-protect
419 (while (setq line-end (string-match "\n" output position))
420 (setq line (format "%s%s"
421 mh-speed-partial-line
422 (substring output position line-end))
423 mh-speed-partial-line "")
424 (multiple-value-setq (folder unseen total)
425 (mh-parse-flist-output-line line mh-speed-current-folder))
426 (when (and folder unseen total
427 (let ((old-pair (gethash folder mh-speed-flists-cache)))
428 (or (not (equal (car old-pair) unseen))
429 (not (equal (cdr old-pair) total)))))
430 (setf (gethash folder mh-speed-flists-cache) (cons unseen total))
431 (save-excursion
432 (when (buffer-live-p (get-buffer speedbar-buffer))
433 (set-buffer speedbar-buffer)
434 (speedbar-with-writable
435 (when (get-text-property (point-min) 'mh-level)
436 (let ((pos (gethash folder mh-speed-folder-map))
437 face)
438 (when pos
439 (goto-char pos)
440 (goto-char (line-beginning-position))
441 (cond
442 ((null (get-text-property (point) 'mh-count))
443 (goto-char (line-end-position))
444 (setq face (get-text-property (1- (point)) 'face))
445 (insert (format " (%s/%s)" unseen total))
446 (mh-speed-highlight 'unknown face)
447 (goto-char (line-beginning-position))
448 (add-text-properties (point) (1+ (point))
449 `(mh-count (,unseen . ,total))))
450 ((not (equal (get-text-property (point) 'mh-count)
451 (cons unseen total)))
452 (goto-char (line-end-position))
453 (setq face (get-text-property (1- (point)) 'face))
454 (re-search-backward " " (line-beginning-position) t)
455 (delete-region (point) (line-end-position))
456 (insert (format " (%s/%s)" unseen total))
457 (mh-speed-highlight 'unknown face)
458 (goto-char (line-beginning-position))
459 (add-text-properties
460 (point) (1+ (point))
461 `(mh-count (,unseen . ,total))))))))))))
462 (setq position (1+ line-end)))
463 (set-match-data prevailing-match-data))
464 (setq mh-speed-partial-line (substring output position))))
465
466 ;;;###mh-autoload
467 (defun mh-speed-invalidate-map (folder)
468 "Remove FOLDER from various optimization caches."
469 (interactive (list ""))
470 (save-excursion
471 (set-buffer speedbar-buffer)
472 (let* ((speedbar-update-flag nil)
473 (last-slash (mh-search-from-end ?/ folder))
474 (parent (if last-slash (substring folder 0 last-slash) nil))
475 (parent-position (gethash parent mh-speed-folder-map))
476 (parent-change nil))
477 (when parent-position
478 (let ((parent-kids (mh-sub-folders parent)))
479 (cond ((null parent-kids)
480 (setq parent-change ?+))
481 ((and (null (cdr parent-kids))
482 (equal (if last-slash
483 (substring folder (1+ last-slash))
484 (substring folder 1))
485 (caar parent-kids)))
486 (setq parent-change ? ))))
487 (goto-char parent-position)
488 (when (equal (get-text-property (line-beginning-position) 'mh-folder)
489 parent)
490 (when (get-text-property (line-beginning-position) 'mh-expanded)
491 (mh-speed-toggle))
492 (when parent-change
493 (speedbar-with-writable
494 (mh-speedbar-change-expand-button-char parent-change)
495 (add-text-properties
496 (line-beginning-position) (1+ (line-beginning-position))
497 `(mh-children-p ,(equal parent-change ?+)))))
498 (mh-speed-highlight mh-speed-last-selected-folder 'mh-speedbar-folder)
499 (setq mh-speed-last-selected-folder nil)
500 (setq mh-speed-refresh-flag t)))
501 (when (equal folder "")
502 (clrhash mh-sub-folders-cache)))))
503
504 (defun mh-speed-refresh ()
505 "Refresh the speedbar.
506 Use this function to refresh the speedbar if folders have been added or
507 deleted or message ranges have been updated outside of MH-E."
508 (interactive)
509 (mh-speed-flists t)
510 (mh-speed-invalidate-map ""))
511
512 ;;;###mh-autoload
513 (defun mh-speed-add-folder (folder)
514 "Add FOLDER since it is being created.
515 The function invalidates the latest ancestor that is present."
516 (save-excursion
517 (set-buffer speedbar-buffer)
518 (let ((speedbar-update-flag nil)
519 (last-slash (mh-search-from-end ?/ folder))
520 (ancestor folder)
521 (ancestor-pos nil))
522 (block while-loop
523 (while last-slash
524 (setq ancestor (substring ancestor 0 last-slash))
525 (setq ancestor-pos (gethash ancestor mh-speed-folder-map))
526 (when ancestor-pos
527 (return-from while-loop))
528 (setq last-slash (mh-search-from-end ?/ ancestor))))
529 (unless ancestor-pos (setq ancestor nil))
530 (goto-char (or ancestor-pos (gethash nil mh-speed-folder-map)))
531 (speedbar-with-writable
532 (mh-speedbar-change-expand-button-char ?+)
533 (add-text-properties
534 (line-beginning-position) (1+ (line-beginning-position))
535 `(mh-children-p t)))
536 (when (get-text-property (line-beginning-position) 'mh-expanded)
537 (mh-speed-toggle))
538 (setq mh-speed-refresh-flag t))))
539
540 ;; Make it slightly more general to allow for [ ] buttons to be changed to
541 ;; [+].
542 (defun mh-speedbar-change-expand-button-char (char)
543 "Change the expansion button character to CHAR for the current line."
544 (save-excursion
545 (beginning-of-line)
546 (if (re-search-forward "\\[.\\]" (line-end-position) t)
547 (speedbar-with-writable
548 (backward-char 2)
549 (delete-char 1)
550 (insert-char char 1 t)
551 (put-text-property (point) (1- (point)) 'invisible nil)
552 ;; make sure we fix the image on the text here.
553 (mh-funcall-if-exists
554 speedbar-insert-image-button-maybe (- (point) 2) 3)))))
555
556 (provide 'mh-speed)
557
558 ;;; Local Variables:
559 ;;; indent-tabs-mode: nil
560 ;;; sentence-end-double-space: nil
561 ;;; End:
562
563 ;;; arch-tag: d38ddcd4-3c00-4e37-99bf-8b89dda7b32c
564 ;;; mh-speed.el ends here