1 ;;; mh-speed.el --- Speedbar interface for MH-E.
3 ;; Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 ;; Author: Satyaki Das <satyaki@theforce.stanford.edu>
6 ;; Maintainer: Bill Wohler <wohler@newt.com>
10 ;; This file is part of GNU Emacs.
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)
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.
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.
28 ;; Future versions should only use flists.
30 ;; Speedbar support for MH-E package.
37 (eval-when-compile (require 'mh-acros
))
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
"")
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
))))
61 ;; Functions called by speedbar to initialize display...
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
)
68 (clrhash mh-speed-folder-map
)
69 (speedbar-make-tag-line 'bracket ?
+ 'mh-speed-toggle nil
" " 'ignore nil
70 'mh-speedbar-folder
0)
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))))
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
))))
83 (defalias 'mh-show-speedbar-buttons
'mh-folder-speedbar-buttons
)
85 (defalias 'mh-letter-speedbar-buttons
'mh-folder-speedbar-buttons
)
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
96 (defvar mh-show-speedbar-key-map mh-folder-speedbar-key-map
)
97 (defvar mh-letter-speedbar-key-map mh-folder-speedbar-key-map
)
99 ;; Menus for speedbar...
100 (defvar mh-folder-speedbar-menu-items
102 ["Visit Folder" mh-speed-view
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.")
115 (defvar mh-show-speedbar-menu-items mh-folder-speedbar-menu-items
)
116 (defvar mh-letter-speedbar-menu-items mh-folder-speedbar-menu-items
)
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"))))
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.
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
))
143 (and mh-speed-refresh-flag
(not (eq lastf speedbar-frame
)))
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
)
151 ;; Remove highlight from previous match...
152 (mh-speed-highlight mh-speed-last-selected-folder
'mh-speedbar-folder
)
154 ;; If we found a match highlight it...
155 (when (mh-speed-goto-folder newcf
)
156 (mh-speed-highlight newcf
'mh-speedbar-selected-folder
))
158 (setq mh-speed-last-selected-folder newcf
)
159 (speedbar-position-cursor-on-line)
160 (set-window-point (frame-first-window speedbar-frame
) (point))
162 (select-frame lastf
))
163 (when (eq lastf speedbar-frame
)
164 (setq mh-speed-refresh-flag t
))))
166 (defun mh-speed-normal-face (face)
167 "Return normal face for given FACE."
168 (cond ((eq face
'mh-speedbar-folder-with-unseen-messages
)
170 ((eq face
'mh-speedbar-selected-folder-with-unseen-messages
)
171 'mh-speedbar-selected-folder
)
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
)
182 (defun mh-speed-highlight (folder face
)
183 "Set FOLDER to FACE."
185 (speedbar-with-writable
186 (goto-char (gethash folder mh-speed-folder-map
(point)))
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
)))
192 (when (re-search-forward "\\[.\\] " (line-end-position) t
)
193 (put-text-property (point) (line-end-position) 'face face
)))))
195 (defun mh-speed-stealth-update (&optional force
)
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
)
203 ;; Otherwise on to your regular programming
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
)
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
)))
219 (goto-char prefix-position
)
220 (goto-char (point-min))
222 (unless (get-text-property (point) 'mh-expanded
)
224 (goto-char (gethash prefix mh-speed-folder-map
))))
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)
231 (unless (get-text-property (point) 'mh-expanded
)
233 (setq prefix
(format "%s/%s" prefix
(pop suffix-list
)))
234 (goto-char (gethash prefix mh-speed-folder-map
(point))))
236 (equal folder
(get-text-property (point) 'mh-folder
))))
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."
243 (cond ((eq major-mode
'mh-folder-mode
)
245 ((eq major-mode
'mh-show-mode
)
246 (set-buffer mh-show-folder-buffer
)
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
)))
253 (format "+%s" (substring rel-path
0 directory-end
)))))))))
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
)))
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
) ?
+ ?
)
270 (format " (%s/%s)" (car counts
) (cdr counts
))
273 (if (and counts
(> (car counts
) 0))
274 'mh-speedbar-folder-with-unseen-messages
279 (setf (gethash folder-name mh-speed-folder-map
)
280 (set-marker (or (gethash folder-name mh-speed-folder-map
)
282 (1+ (line-beginning-position))))
284 (line-beginning-position) (1+ (line-beginning-position))
285 `(mh-folder ,folder-name
287 mh-children-p
,(not (not (cdr f
)))
288 ,@(if counts
`(mh-count
289 (,(car counts
) .
,(cdr counts
))) ())
290 mh-level
,level
))))))
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."
298 (declare (ignore args
))
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
))
306 (speedbar-with-writable
307 (cond ((not kids-p
) nil
)
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
)))
318 (delete-region start-region
(point))
320 (speedbar-change-expand-button-char ?
+)
322 (line-beginning-position) (1+ (line-beginning-position))
326 (mh-speed-add-buttons parent
(1+ level
))
328 (speedbar-change-expand-button-char ?-
)
330 (line-beginning-position) (1+ (line-beginning-position))
331 `(mh-expanded t
)))))))
333 (defalias 'mh-speed-expand-folder
'mh-speed-toggle
)
334 (defalias 'mh-speed-contract-folder
'mh-speed-toggle
)
337 (defun mh-speed-view (&rest args
)
338 "View folder on current line.
339 Optional ARGS are ignored."
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)))))
351 (defvar mh-speed-current-folder nil
)
352 (defvar mh-speed-flists-folder nil
)
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
358 (if (fboundp 'set-process-query-on-exit-flag
)
359 `(set-process-query-on-exit-flag ,process nil
)
360 `(process-kill-without-query ,process
)))
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.
367 Any number of optional FOLDERS can be specified. If specified, flists is run
368 only for that one folder."
369 (interactive (list t
))
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
384 nil
(and mh-speed-run-flists-flag mh-speed-flists-interval
)
386 (unless (and (processp mh-speed-flists-process
)
387 (not (eq (process-status mh-speed-flists-process
)
389 (setq mh-speed-current-folder
391 (if mh-speed-flists-folder
392 (substring (car (reverse mh-speed-flists-folder
)) 1)
394 (call-process (expand-file-name "folder" mh-progs
)
395 nil
'(t nil
) nil
"-fast")
396 (buffer-substring (point-min) (1- (point-max)))))
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
)))))))
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
415 (let ((prevailing-match-data (match-data))
417 line-end line folder unseen total
)
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
))
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
))
440 (goto-char (line-beginning-position))
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))
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
))))
467 (defun mh-speed-invalidate-map (folder)
468 "Remove FOLDER from various optimization caches."
469 (interactive (list ""))
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
))
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))
486 (setq parent-change ?
))))
487 (goto-char parent-position
)
488 (when (equal (get-text-property (line-beginning-position) 'mh-folder
)
490 (when (get-text-property (line-beginning-position) 'mh-expanded
)
493 (speedbar-with-writable
494 (mh-speedbar-change-expand-button-char parent-change
)
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
)))))
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."
510 (mh-speed-invalidate-map ""))
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."
517 (set-buffer speedbar-buffer
)
518 (let ((speedbar-update-flag nil
)
519 (last-slash (mh-search-from-end ?
/ folder
))
524 (setq ancestor
(substring ancestor
0 last-slash
))
525 (setq ancestor-pos
(gethash ancestor mh-speed-folder-map
))
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 ?
+)
534 (line-beginning-position) (1+ (line-beginning-position))
536 (when (get-text-property (line-beginning-position) 'mh-expanded
)
538 (setq mh-speed-refresh-flag t
))))
540 ;; Make it slightly more general to allow for [ ] buttons to be changed to
542 (defun mh-speedbar-change-expand-button-char (char)
543 "Change the expansion button character to CHAR for the current line."
546 (if (re-search-forward "\\[.\\]" (line-end-position) t
)
547 (speedbar-with-writable
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)))))
559 ;;; indent-tabs-mode: nil
560 ;;; sentence-end-double-space: nil
563 ;;; arch-tag: d38ddcd4-3c00-4e37-99bf-8b89dda7b32c
564 ;;; mh-speed.el ends here