1 ;;; mh-speed.el --- MH-E speedbar support
3 ;; Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 3 of the License, or
15 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
27 ;; Future versions should only use flists.
41 (defvar mh-speed-refresh-flag nil
)
42 (defvar mh-speed-last-selected-folder nil
)
43 (defvar mh-speed-folder-map
(make-hash-table :test
#'equal
))
44 (defvar mh-speed-flists-cache
(make-hash-table :test
#'equal
))
45 (defvar mh-speed-flists-process nil
)
46 (defvar mh-speed-flists-timer nil
)
47 (defvar mh-speed-partial-line
"")
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
))))
65 (defvar mh-folder-speedbar-menu-items
67 ["Visit Folder" mh-speed-view
69 (set-buffer speedbar-buffer
)
70 (get-text-property (mh-line-beginning-position) 'mh-folder
))]
71 ["Expand Nested Folders" mh-speed-expand-folder
72 (and (get-text-property (mh-line-beginning-position) 'mh-children-p
)
73 (not (get-text-property (mh-line-beginning-position) 'mh-expanded
)))]
74 ["Contract Nested Folders" mh-speed-contract-folder
75 (and (get-text-property (mh-line-beginning-position) 'mh-children-p
)
76 (get-text-property (mh-line-beginning-position) 'mh-expanded
))]
77 ["Refresh Speedbar" mh-speed-refresh t
])
78 "Extra menu items for speedbar.")
80 (defvar mh-show-speedbar-menu-items mh-folder-speedbar-menu-items
)
81 (defvar mh-letter-speedbar-menu-items mh-folder-speedbar-menu-items
)
87 (defvar mh-folder-speedbar-key-map
(speedbar-make-specialized-keymap)
88 "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
)
101 ;;; Speedbar Commands
105 (defalias 'mh-speed-contract-folder
'mh-speed-toggle
)
107 (defalias 'mh-speed-expand-folder
'mh-speed-toggle
)
109 (defun mh-speed-refresh ()
110 "Regenerates the list of folders in the speedbar.
112 Run this command if you've added or deleted a folder, or want to
113 update the unseen message count before the next automatic
117 (mh-speed-invalidate-map ""))
119 (defun mh-speed-stealth-update (&optional force
)
121 With non-nil FORCE, the update is always carried out."
122 (cond ((save-excursion (set-buffer speedbar-buffer
)
123 (get-text-property (point-min) 'mh-level
))
124 ;; Execute this hook and *don't* run anything else
125 (mh-speed-update-current-folder force
)
127 ;; Otherwise on to your regular programming
130 (defun mh-speed-toggle (&rest args
)
131 "Toggle the display of child folders in the speedbar.
132 The optional ARGS from speedbar are ignored."
134 (declare (ignore args
))
136 (let ((parent (get-text-property (point) 'mh-folder
))
137 (kids-p (get-text-property (point) 'mh-children-p
))
138 (expanded (get-text-property (point) 'mh-expanded
))
139 (level (get-text-property (point) 'mh-level
))
142 (speedbar-with-writable
143 (cond ((not kids-p
) nil
)
146 (setq start-region
(point))
147 (while (and (get-text-property (point) 'mh-level
)
148 (> (get-text-property (point) 'mh-level
) level
))
149 (let ((folder (get-text-property (point) 'mh-folder
)))
150 (when (gethash folder mh-speed-folder-map
)
151 (set-marker (gethash folder mh-speed-folder-map
) nil
)
152 (remhash folder mh-speed-folder-map
)))
154 (delete-region start-region
(point))
156 (speedbar-change-expand-button-char ?
+)
158 (mh-line-beginning-position) (1+ (line-beginning-position))
162 (mh-speed-add-buttons parent
(1+ level
))
164 (speedbar-change-expand-button-char ?-
)
166 (mh-line-beginning-position) (1+ (line-beginning-position))
167 `(mh-expanded t
)))))))
169 (defun mh-speed-view (&rest args
)
170 "Visits the selected folder just as if you had used \\<mh-folder-mode-map>\\[mh-visit-folder].
171 The optional ARGS from speedbar are ignored."
173 (declare (ignore args
))
174 (let* ((folder (get-text-property (mh-line-beginning-position) 'mh-folder
))
175 (range (and (stringp folder
)
176 (mh-read-range "Scan" folder t nil nil
177 mh-interpret-number-as-range-flag
))))
178 (when (stringp folder
)
179 (speedbar-with-attached-buffer
180 (mh-visit-folder folder range
)
181 (delete-other-windows)))))
188 (defun mh-folder-speedbar-buttons (buffer)
189 "Interface function to create MH-E speedbar buffer.
190 BUFFER is the MH-E buffer for which the speedbar buffer is to be
192 (unless (get-text-property (point-min) 'mh-level
)
194 (clrhash mh-speed-folder-map
)
195 (speedbar-make-tag-line 'bracket ?
+ 'mh-speed-toggle nil
" " 'ignore nil
196 'mh-speedbar-folder
0)
198 (setf (gethash nil mh-speed-folder-map
)
199 (set-marker (or (gethash nil mh-speed-folder-map
) (make-marker))
200 (1+ (mh-line-beginning-position))))
202 (mh-line-beginning-position) (1+ (line-beginning-position))
203 `(mh-folder nil mh-expanded nil mh-children-p t mh-level
0))
204 (mh-speed-stealth-update t
)
205 (when (> mh-speed-update-interval
0)
206 (mh-speed-flists nil
))))
209 (defalias 'mh-show-speedbar-buttons
'mh-folder-speedbar-buttons
)
211 (defalias 'mh-letter-speedbar-buttons
'mh-folder-speedbar-buttons
)
213 (defmacro mh-speed-select-attached-frame
()
214 "Compatibility macro to handle speedbar versions 0.11a and 0.14beta4."
215 (cond ((fboundp 'dframe-select-attached-frame
)
216 '(dframe-select-attached-frame speedbar-frame
))
217 ((boundp 'speedbar-attached-frame
)
218 '(select-frame speedbar-attached-frame
))
219 (t (error "Installed speedbar version not supported by MH-E"))))
221 (defun mh-speed-update-current-folder (force)
222 "Update speedbar highlighting of the current folder.
223 The function tries to be smart so that work done is minimized.
224 The currently highlighted folder is cached and no highlighting
225 happens unless it changes.
226 Also highlighting is suspended while the speedbar frame is selected.
227 Otherwise you get the disconcerting behavior of folders popping open
228 on their own when you are trying to navigate around in the speedbar
231 The update is always carried out if FORCE is non-nil."
232 (let* ((lastf (selected-frame))
233 (newcf (save-excursion
234 (mh-speed-select-attached-frame)
235 (prog1 (mh-speed-extract-folder-name (buffer-name))
236 (select-frame lastf
))))
237 (lastb (current-buffer))
238 (case-fold-search t
))
240 (and mh-speed-refresh-flag
(not (eq lastf speedbar-frame
)))
242 (equal (substring newcf
0 1) "+")
243 (not (equal newcf mh-speed-last-selected-folder
))))
244 (setq mh-speed-refresh-flag nil
)
245 (select-frame speedbar-frame
)
246 (set-buffer speedbar-buffer
)
248 ;; Remove highlight from previous match...
249 (mh-speed-highlight mh-speed-last-selected-folder
'mh-speedbar-folder
)
251 ;; If we found a match highlight it...
252 (when (mh-speed-goto-folder newcf
)
253 (mh-speed-highlight newcf
'mh-speedbar-selected-folder
))
255 (setq mh-speed-last-selected-folder newcf
)
256 (speedbar-position-cursor-on-line)
257 (set-window-point (frame-first-window speedbar-frame
) (point))
259 (select-frame lastf
))
260 (when (eq lastf speedbar-frame
)
261 (setq mh-speed-refresh-flag t
))))
263 (defun mh-speed-highlight (folder face
)
264 "Set FOLDER to FACE."
266 (speedbar-with-writable
267 (goto-char (gethash folder mh-speed-folder-map
(point)))
269 (if (re-search-forward "([1-9][0-9]*/[0-9]+)" (mh-line-end-position) t
)
270 (setq face
(mh-speed-bold-face face
))
271 (setq face
(mh-speed-normal-face face
)))
273 (when (re-search-forward "\\[.\\] " (mh-line-end-position) t
)
274 (put-text-property (point) (mh-line-end-position) 'face face
)))))
276 (defun mh-speed-normal-face (face)
277 "Return normal face for given FACE."
278 (cond ((eq face
'mh-speedbar-folder-with-unseen-messages
)
280 ((eq face
'mh-speedbar-selected-folder-with-unseen-messages
)
281 'mh-speedbar-selected-folder
)
284 (defun mh-speed-bold-face (face)
285 "Return bold face for given FACE."
286 (cond ((eq face
'mh-speedbar-folder
)
287 'mh-speedbar-folder-with-unseen-messages
)
288 ((eq face
'mh-speedbar-selected-folder
)
289 'mh-speedbar-selected-folder-with-unseen-messages
)
292 (defun mh-speed-goto-folder (folder)
293 "Move point to line containing FOLDER.
294 The function will expand out parent folders of FOLDER if needed."
295 (let ((prefix folder
)
298 (while (and (not (gethash prefix mh-speed-folder-map
)) last-slash
)
299 (setq last-slash
(mh-search-from-end ?
/ prefix
))
300 (when (integerp last-slash
)
301 (push (substring prefix
(1+ last-slash
)) suffix-list
)
302 (setq prefix
(substring prefix
0 last-slash
))))
303 (let ((prefix-position (gethash prefix mh-speed-folder-map
)))
305 (goto-char prefix-position
)
306 (goto-char (point-min))
308 (unless (get-text-property (point) 'mh-expanded
)
310 (goto-char (gethash prefix mh-speed-folder-map
))))
312 ;; We always need atleast one toggle. We need two if the directory list
313 ;; is stale since a folder was added.
314 (when (equal prefix
(get-text-property (mh-line-beginning-position)
317 (unless (get-text-property (point) 'mh-expanded
)
319 (setq prefix
(format "%s/%s" prefix
(pop suffix-list
)))
320 (goto-char (gethash prefix mh-speed-folder-map
(point))))
322 (equal folder
(get-text-property (point) 'mh-folder
))))
324 (defun mh-speed-extract-folder-name (buffer)
325 "Given an MH-E BUFFER find the folder that should be highlighted.
326 Do the right thing for the different kinds of buffers that MH-E
330 (cond ((eq major-mode
'mh-folder-mode
)
332 ((eq major-mode
'mh-show-mode
)
333 (set-buffer mh-show-folder-buffer
)
335 ((eq major-mode
'mh-letter-mode
)
336 (when (string-match mh-user-path buffer-file-name
)
337 (let* ((rel-path (substring buffer-file-name
(match-end 0)))
338 (directory-end (mh-search-from-end ?
/ rel-path
)))
340 (format "+%s" (substring rel-path
0 directory-end
)))))))))
342 (defun mh-speed-add-buttons (folder level
)
343 "Add speedbar button for FOLDER which is at indented by LEVEL amount."
344 (let ((folder-list (mh-sub-folders folder
)))
347 (let* ((folder-name (format "%s%s%s" (or folder
"+")
348 (if folder
"/" "") (car f
)))
349 (counts (gethash folder-name mh-speed-flists-cache
)))
350 (speedbar-with-writable
351 (speedbar-make-tag-line
352 'bracket
(if (cdr f
) ?
+ ?
)
357 (format " (%s/%s)" (car counts
) (cdr counts
))
360 (if (and counts
(> (car counts
) 0))
361 'mh-speedbar-folder-with-unseen-messages
366 (setf (gethash folder-name mh-speed-folder-map
)
367 (set-marker (or (gethash folder-name mh-speed-folder-map
)
369 (1+ (mh-line-beginning-position))))
371 (mh-line-beginning-position) (1+ (mh-line-beginning-position))
372 `(mh-folder ,folder-name
374 mh-children-p
,(not (not (cdr f
)))
375 ,@(if counts
`(mh-count
376 (,(car counts
) .
,(cdr counts
))) ())
377 mh-level
,level
))))))
380 (defvar mh-speed-current-folder nil
)
381 (defvar mh-speed-flists-folder nil
)
383 (defmacro mh-process-kill-without-query
(process)
384 "PROCESS can be killed without query on Emacs exit.
385 Avoid using `process-kill-without-query' if possible since it is
387 (if (fboundp 'set-process-query-on-exit-flag
)
388 `(set-process-query-on-exit-flag ,process nil
)
389 `(process-kill-without-query ,process
)))
392 (defun mh-speed-flists (force &rest folders
)
393 "Execute flists -recurse and update message counts.
394 If FORCE is non-nil the timer is reset.
396 Any number of optional FOLDERS can be specified. If specified,
397 flists is run only for that one folder."
398 (interactive (list t
))
400 (when mh-speed-flists-timer
401 (mh-cancel-timer mh-speed-flists-timer
)
402 (setq mh-speed-flists-timer nil
))
403 (when (and (processp mh-speed-flists-process
)
404 (not (eq (process-status mh-speed-flists-process
) 'exit
)))
405 (set-process-filter mh-speed-flists-process t
)
406 (kill-process mh-speed-flists-process
)
407 (setq mh-speed-partial-line
"")
408 (setq mh-speed-flists-process nil
)))
409 (setq mh-speed-flists-folder folders
)
410 (unless mh-speed-flists-timer
411 (setq mh-speed-flists-timer
413 nil
(if (> mh-speed-update-interval
0)
414 mh-speed-update-interval
417 (unless (and (processp mh-speed-flists-process
)
418 (not (eq (process-status mh-speed-flists-process
)
420 (setq mh-speed-current-folder
422 (if mh-speed-flists-folder
423 (substring (car (reverse mh-speed-flists-folder
)) 1)
425 (call-process (expand-file-name "folder" mh-progs
)
426 nil
'(t nil
) nil
"-fast")
427 (buffer-substring (point-min) (1- (point-max)))))
429 (setq mh-speed-flists-process
430 (apply #'start-process
"*flists*" nil
431 (expand-file-name "flists" mh-progs
)
432 (if mh-speed-flists-folder
"-noall" "-all")
433 "-sequence" (symbol-name mh-unseen-seq
)
434 (or mh-speed-flists-folder
'("-recurse"))))
435 ;; Run flists on all folders the next time around...
436 (setq mh-speed-flists-folder nil
)
437 (mh-process-kill-without-query mh-speed-flists-process
)
438 (set-process-filter mh-speed-flists-process
439 'mh-speed-parse-flists-output
)))))))
441 ;; Copied from mh-make-folder-list-filter...
442 ;; XXX Refactor to use mh-make-folder-list-filer?
443 (defun mh-speed-parse-flists-output (process output
)
444 "Parse the incremental results from flists.
445 PROCESS is the flists process and OUTPUT is the results that must
447 (let ((prevailing-match-data (match-data))
449 line-end line folder unseen total
)
451 (while (setq line-end
(string-match "\n" output position
))
452 (setq line
(format "%s%s"
453 mh-speed-partial-line
454 (substring output position line-end
))
455 mh-speed-partial-line
"")
456 (multiple-value-setq (folder unseen total
)
457 (mh-parse-flist-output-line line mh-speed-current-folder
))
458 (when (and folder unseen total
459 (let ((old-pair (gethash folder mh-speed-flists-cache
)))
460 (or (not (equal (car old-pair
) unseen
))
461 (not (equal (cdr old-pair
) total
)))))
462 (setf (gethash folder mh-speed-flists-cache
) (cons unseen total
))
464 (when (buffer-live-p (get-buffer speedbar-buffer
))
465 (set-buffer speedbar-buffer
)
466 (speedbar-with-writable
467 (when (get-text-property (point-min) 'mh-level
)
468 (let ((pos (gethash folder mh-speed-folder-map
))
472 (goto-char (mh-line-beginning-position))
474 ((null (get-text-property (point) 'mh-count
))
475 (goto-char (mh-line-end-position))
476 (setq face
(get-text-property (1- (point)) 'face
))
477 (insert (format " (%s/%s)" unseen total
))
478 (mh-speed-highlight 'unknown face
)
479 (goto-char (mh-line-beginning-position))
480 (add-text-properties (point) (1+ (point))
481 `(mh-count (,unseen .
,total
))))
482 ((not (equal (get-text-property (point) 'mh-count
)
483 (cons unseen total
)))
484 (goto-char (mh-line-end-position))
485 (setq face
(get-text-property (1- (point)) 'face
))
486 (re-search-backward " " (mh-line-beginning-position) t
)
487 (delete-region (point) (mh-line-end-position))
488 (insert (format " (%s/%s)" unseen total
))
489 (mh-speed-highlight 'unknown face
)
490 (goto-char (mh-line-beginning-position))
493 `(mh-count (,unseen .
,total
))))))))))))
494 (setq position
(1+ line-end
)))
495 (set-match-data prevailing-match-data
))
496 (setq mh-speed-partial-line
(substring output position
))))
499 (defun mh-speed-invalidate-map (folder)
500 "Remove FOLDER from various optimization caches."
501 (interactive (list ""))
503 (set-buffer speedbar-buffer
)
504 (let* ((speedbar-update-flag nil
)
505 (last-slash (mh-search-from-end ?
/ folder
))
506 (parent (if last-slash
(substring folder
0 last-slash
) nil
))
507 (parent-position (gethash parent mh-speed-folder-map
))
509 (when parent-position
510 (let ((parent-kids (mh-sub-folders parent
)))
511 (cond ((null parent-kids
)
512 (setq parent-change ?
+))
513 ((and (null (cdr parent-kids
))
514 (equal (if last-slash
515 (substring folder
(1+ last-slash
))
516 (substring folder
1))
518 (setq parent-change ?
))))
519 (goto-char parent-position
)
520 (when (equal (get-text-property (mh-line-beginning-position) 'mh-folder
)
522 (when (get-text-property (mh-line-beginning-position) 'mh-expanded
)
525 (speedbar-with-writable
526 (mh-speedbar-change-expand-button-char parent-change
)
528 (mh-line-beginning-position) (1+ (mh-line-beginning-position))
529 `(mh-children-p ,(equal parent-change ?
+)))))
530 (mh-speed-highlight mh-speed-last-selected-folder
'mh-speedbar-folder
)
531 (setq mh-speed-last-selected-folder nil
)
532 (setq mh-speed-refresh-flag t
)))
533 (when (equal folder
"")
534 (mh-clear-sub-folders-cache)))))
536 ;; Make it slightly more general to allow for [ ] buttons to be
538 (defun mh-speedbar-change-expand-button-char (char)
539 "Change the expansion button character to CHAR for the current line."
542 (if (re-search-forward "\\[.\\]" (mh-line-end-position) t
)
543 (speedbar-with-writable
546 (insert-char char
1 t
)
547 (put-text-property (point) (1- (point)) 'invisible nil
)
548 ;; make sure we fix the image on the text here.
549 (mh-funcall-if-exists
550 speedbar-insert-image-button-maybe
(- (point) 2) 3)))))
553 (defun mh-speed-add-folder (folder)
554 "Add FOLDER since it is being created.
555 The function invalidates the latest ancestor that is present."
557 (set-buffer speedbar-buffer
)
558 (let ((speedbar-update-flag nil
)
559 (last-slash (mh-search-from-end ?
/ folder
))
564 (setq ancestor
(substring ancestor
0 last-slash
))
565 (setq ancestor-pos
(gethash ancestor mh-speed-folder-map
))
567 (return-from while-loop
))
568 (setq last-slash
(mh-search-from-end ?
/ ancestor
))))
569 (unless ancestor-pos
(setq ancestor nil
))
570 (goto-char (or ancestor-pos
(gethash nil mh-speed-folder-map
)))
571 (speedbar-with-writable
572 (mh-speedbar-change-expand-button-char ?
+)
574 (mh-line-beginning-position) (1+ (mh-line-beginning-position))
576 (when (get-text-property (mh-line-beginning-position) 'mh-expanded
)
578 (setq mh-speed-refresh-flag t
))))
583 ;; indent-tabs-mode: nil
584 ;; sentence-end-double-space: nil
587 ;; arch-tag: d38ddcd4-3c00-4e37-99bf-8b89dda7b32c
588 ;;; mh-speed.el ends here