1 ;;; mh-speed.el --- MH-E speedbar support
3 ;; Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
6 ;; Author: Satyaki Das <satyaki@theforce.stanford.edu>
7 ;; Maintainer: Bill Wohler <wohler@newt.com>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; Future versions should only use flists.
42 (defvar mh-speed-refresh-flag nil
)
43 (defvar mh-speed-last-selected-folder nil
)
44 (defvar mh-speed-folder-map
(make-hash-table :test
#'equal
))
45 (defvar mh-speed-flists-cache
(make-hash-table :test
#'equal
))
46 (defvar mh-speed-flists-process nil
)
47 (defvar mh-speed-flists-timer nil
)
48 (defvar mh-speed-partial-line
"")
54 (unless (member 'mh-speed-stealth-update
55 (cdr (assoc "files" speedbar-stealthy-function-list
)))
56 ;; Is changing constant lists in elisp safe?
57 (setq speedbar-stealthy-function-list
58 (copy-tree speedbar-stealthy-function-list
))
59 (push 'mh-speed-stealth-update
60 (cdr (assoc "files" speedbar-stealthy-function-list
))))
66 (defvar mh-folder-speedbar-menu-items
68 ["Visit Folder" mh-speed-view
70 (set-buffer speedbar-buffer
)
71 (get-text-property (mh-line-beginning-position) 'mh-folder
))]
72 ["Expand Nested Folders" mh-speed-expand-folder
73 (and (get-text-property (mh-line-beginning-position) 'mh-children-p
)
74 (not (get-text-property (mh-line-beginning-position) 'mh-expanded
)))]
75 ["Contract Nested Folders" mh-speed-contract-folder
76 (and (get-text-property (mh-line-beginning-position) 'mh-children-p
)
77 (get-text-property (mh-line-beginning-position) 'mh-expanded
))]
78 ["Refresh Speedbar" mh-speed-refresh t
])
79 "Extra menu items for speedbar.")
81 (defvar mh-show-speedbar-menu-items mh-folder-speedbar-menu-items
)
82 (defvar mh-letter-speedbar-menu-items mh-folder-speedbar-menu-items
)
88 (defvar mh-folder-speedbar-key-map
(speedbar-make-specialized-keymap)
89 "Specialized speedbar keymap for MH-E buffers.")
91 (gnus-define-keys mh-folder-speedbar-key-map
92 "+" mh-speed-expand-folder
93 "-" mh-speed-contract-folder
97 (defvar mh-show-speedbar-key-map mh-folder-speedbar-key-map
)
98 (defvar mh-letter-speedbar-key-map mh-folder-speedbar-key-map
)
102 ;;; Speedbar Commands
106 (defalias 'mh-speed-contract-folder
'mh-speed-toggle
)
108 (defalias 'mh-speed-expand-folder
'mh-speed-toggle
)
110 (defun mh-speed-refresh ()
111 "Regenerates the list of folders in the speedbar.
113 Run this command if you've added or deleted a folder, or want to
114 update the unseen message count before the next automatic
118 (mh-speed-invalidate-map ""))
120 (defun mh-speed-stealth-update (&optional force
)
122 With non-nil FORCE, the update is always carried out."
123 (cond ((save-excursion (set-buffer speedbar-buffer
)
124 (get-text-property (point-min) 'mh-level
))
125 ;; Execute this hook and *don't* run anything else
126 (mh-speed-update-current-folder force
)
128 ;; Otherwise on to your regular programming
131 (defun mh-speed-toggle (&rest args
)
132 "Toggle the display of child folders in the speedbar.
133 The optional ARGS from speedbar are ignored."
135 (declare (ignore args
))
137 (let ((parent (get-text-property (point) 'mh-folder
))
138 (kids-p (get-text-property (point) 'mh-children-p
))
139 (expanded (get-text-property (point) 'mh-expanded
))
140 (level (get-text-property (point) 'mh-level
))
143 (speedbar-with-writable
144 (cond ((not kids-p
) nil
)
147 (setq start-region
(point))
148 (while (and (get-text-property (point) 'mh-level
)
149 (> (get-text-property (point) 'mh-level
) level
))
150 (let ((folder (get-text-property (point) 'mh-folder
)))
151 (when (gethash folder mh-speed-folder-map
)
152 (set-marker (gethash folder mh-speed-folder-map
) nil
)
153 (remhash folder mh-speed-folder-map
)))
155 (delete-region start-region
(point))
157 (speedbar-change-expand-button-char ?
+)
159 (mh-line-beginning-position) (1+ (line-beginning-position))
163 (mh-speed-add-buttons parent
(1+ level
))
165 (speedbar-change-expand-button-char ?-
)
167 (mh-line-beginning-position) (1+ (line-beginning-position))
168 `(mh-expanded t
)))))))
170 (defun mh-speed-view (&rest args
)
171 "Visits the selected folder just as if you had used \\<mh-folder-mode-map>\\[mh-visit-folder].
172 The optional ARGS from speedbar are ignored."
174 (declare (ignore args
))
175 (let* ((folder (get-text-property (mh-line-beginning-position) 'mh-folder
))
176 (range (and (stringp folder
)
177 (mh-read-range "Scan" folder t nil nil
178 mh-interpret-number-as-range-flag
))))
179 (when (stringp folder
)
180 (speedbar-with-attached-buffer
181 (mh-visit-folder folder range
)
182 (delete-other-windows)))))
189 (defun mh-folder-speedbar-buttons (buffer)
190 "Interface function to create MH-E speedbar buffer.
191 BUFFER is the MH-E buffer for which the speedbar buffer is to be
193 (unless (get-text-property (point-min) 'mh-level
)
195 (clrhash mh-speed-folder-map
)
196 (speedbar-make-tag-line 'bracket ?
+ 'mh-speed-toggle nil
" " 'ignore nil
197 'mh-speedbar-folder
0)
199 (setf (gethash nil mh-speed-folder-map
)
200 (set-marker (or (gethash nil mh-speed-folder-map
) (make-marker))
201 (1+ (mh-line-beginning-position))))
203 (mh-line-beginning-position) (1+ (line-beginning-position))
204 `(mh-folder nil mh-expanded nil mh-children-p t mh-level
0))
205 (mh-speed-stealth-update t
)
206 (when (> mh-speed-update-interval
0)
207 (mh-speed-flists nil
))))
210 (defalias 'mh-show-speedbar-buttons
'mh-folder-speedbar-buttons
)
212 (defalias 'mh-letter-speedbar-buttons
'mh-folder-speedbar-buttons
)
214 (defmacro mh-speed-select-attached-frame
()
215 "Compatibility macro to handle speedbar versions 0.11a and 0.14beta4."
216 (cond ((fboundp 'dframe-select-attached-frame
)
217 '(dframe-select-attached-frame speedbar-frame
))
218 ((boundp 'speedbar-attached-frame
)
219 '(select-frame speedbar-attached-frame
))
220 (t (error "Installed speedbar version not supported by MH-E"))))
222 (defun mh-speed-update-current-folder (force)
223 "Update speedbar highlighting of the current folder.
224 The function tries to be smart so that work done is minimized.
225 The currently highlighted folder is cached and no highlighting
226 happens unless it changes.
227 Also highlighting is suspended while the speedbar frame is selected.
228 Otherwise you get the disconcerting behavior of folders popping open
229 on their own when you are trying to navigate around in the speedbar
232 The update is always carried out if FORCE is non-nil."
233 (let* ((lastf (selected-frame))
234 (newcf (save-excursion
235 (mh-speed-select-attached-frame)
236 (prog1 (mh-speed-extract-folder-name (buffer-name))
237 (select-frame lastf
))))
238 (lastb (current-buffer))
239 (case-fold-search t
))
241 (and mh-speed-refresh-flag
(not (eq lastf speedbar-frame
)))
243 (equal (substring newcf
0 1) "+")
244 (not (equal newcf mh-speed-last-selected-folder
))))
245 (setq mh-speed-refresh-flag nil
)
246 (select-frame speedbar-frame
)
247 (set-buffer speedbar-buffer
)
249 ;; Remove highlight from previous match...
250 (mh-speed-highlight mh-speed-last-selected-folder
'mh-speedbar-folder
)
252 ;; If we found a match highlight it...
253 (when (mh-speed-goto-folder newcf
)
254 (mh-speed-highlight newcf
'mh-speedbar-selected-folder
))
256 (setq mh-speed-last-selected-folder newcf
)
257 (speedbar-position-cursor-on-line)
258 (set-window-point (frame-first-window speedbar-frame
) (point))
260 (select-frame lastf
))
261 (when (eq lastf speedbar-frame
)
262 (setq mh-speed-refresh-flag t
))))
264 (defun mh-speed-highlight (folder face
)
265 "Set FOLDER to FACE."
267 (speedbar-with-writable
268 (goto-char (gethash folder mh-speed-folder-map
(point)))
270 (if (re-search-forward "([1-9][0-9]*/[0-9]+)" (mh-line-end-position) t
)
271 (setq face
(mh-speed-bold-face face
))
272 (setq face
(mh-speed-normal-face face
)))
274 (when (re-search-forward "\\[.\\] " (mh-line-end-position) t
)
275 (put-text-property (point) (mh-line-end-position) 'face face
)))))
277 (defun mh-speed-normal-face (face)
278 "Return normal face for given FACE."
279 (cond ((eq face
'mh-speedbar-folder-with-unseen-messages
)
281 ((eq face
'mh-speedbar-selected-folder-with-unseen-messages
)
282 'mh-speedbar-selected-folder
)
285 (defun mh-speed-bold-face (face)
286 "Return bold face for given FACE."
287 (cond ((eq face
'mh-speedbar-folder
)
288 'mh-speedbar-folder-with-unseen-messages
)
289 ((eq face
'mh-speedbar-selected-folder
)
290 'mh-speedbar-selected-folder-with-unseen-messages
)
293 (defun mh-speed-goto-folder (folder)
294 "Move point to line containing FOLDER.
295 The function will expand out parent folders of FOLDER if needed."
296 (let ((prefix folder
)
299 (while (and (not (gethash prefix mh-speed-folder-map
)) last-slash
)
300 (setq last-slash
(mh-search-from-end ?
/ prefix
))
301 (when (integerp last-slash
)
302 (push (substring prefix
(1+ last-slash
)) suffix-list
)
303 (setq prefix
(substring prefix
0 last-slash
))))
304 (let ((prefix-position (gethash prefix mh-speed-folder-map
)))
306 (goto-char prefix-position
)
307 (goto-char (point-min))
309 (unless (get-text-property (point) 'mh-expanded
)
311 (goto-char (gethash prefix mh-speed-folder-map
))))
313 ;; We always need atleast one toggle. We need two if the directory list
314 ;; is stale since a folder was added.
315 (when (equal prefix
(get-text-property (mh-line-beginning-position)
318 (unless (get-text-property (point) 'mh-expanded
)
320 (setq prefix
(format "%s/%s" prefix
(pop suffix-list
)))
321 (goto-char (gethash prefix mh-speed-folder-map
(point))))
323 (equal folder
(get-text-property (point) 'mh-folder
))))
325 (defun mh-speed-extract-folder-name (buffer)
326 "Given an MH-E BUFFER find the folder that should be highlighted.
327 Do the right thing for the different kinds of buffers that MH-E
331 (cond ((eq major-mode
'mh-folder-mode
)
333 ((eq major-mode
'mh-show-mode
)
334 (set-buffer mh-show-folder-buffer
)
336 ((eq major-mode
'mh-letter-mode
)
337 (when (string-match mh-user-path buffer-file-name
)
338 (let* ((rel-path (substring buffer-file-name
(match-end 0)))
339 (directory-end (mh-search-from-end ?
/ rel-path
)))
341 (format "+%s" (substring rel-path
0 directory-end
)))))))))
343 (defun mh-speed-add-buttons (folder level
)
344 "Add speedbar button for FOLDER which is at indented by LEVEL amount."
345 (let ((folder-list (mh-sub-folders folder
)))
348 (let* ((folder-name (format "%s%s%s" (or folder
"+")
349 (if folder
"/" "") (car f
)))
350 (counts (gethash folder-name mh-speed-flists-cache
)))
351 (speedbar-with-writable
352 (speedbar-make-tag-line
353 'bracket
(if (cdr f
) ?
+ ?
)
358 (format " (%s/%s)" (car counts
) (cdr counts
))
361 (if (and counts
(> (car counts
) 0))
362 'mh-speedbar-folder-with-unseen-messages
367 (setf (gethash folder-name mh-speed-folder-map
)
368 (set-marker (or (gethash folder-name mh-speed-folder-map
)
370 (1+ (mh-line-beginning-position))))
372 (mh-line-beginning-position) (1+ (mh-line-beginning-position))
373 `(mh-folder ,folder-name
375 mh-children-p
,(not (not (cdr f
)))
376 ,@(if counts
`(mh-count
377 (,(car counts
) .
,(cdr counts
))) ())
378 mh-level
,level
))))))
381 (defvar mh-speed-current-folder nil
)
382 (defvar mh-speed-flists-folder nil
)
384 (defmacro mh-process-kill-without-query
(process)
385 "PROCESS can be killed without query on Emacs exit.
386 Avoid using `process-kill-without-query' if possible since it is
388 (if (fboundp 'set-process-query-on-exit-flag
)
389 `(set-process-query-on-exit-flag ,process nil
)
390 `(process-kill-without-query ,process
)))
393 (defun mh-speed-flists (force &rest folders
)
394 "Execute flists -recurse and update message counts.
395 If FORCE is non-nil the timer is reset.
397 Any number of optional FOLDERS can be specified. If specified,
398 flists is run only for that one folder."
399 (interactive (list t
))
401 (when mh-speed-flists-timer
402 (mh-cancel-timer mh-speed-flists-timer
)
403 (setq mh-speed-flists-timer nil
))
404 (when (and (processp mh-speed-flists-process
)
405 (not (eq (process-status mh-speed-flists-process
) 'exit
)))
406 (set-process-filter mh-speed-flists-process t
)
407 (kill-process mh-speed-flists-process
)
408 (setq mh-speed-partial-line
"")
409 (setq mh-speed-flists-process nil
)))
410 (setq mh-speed-flists-folder folders
)
411 (unless mh-speed-flists-timer
412 (setq mh-speed-flists-timer
414 nil
(if (> mh-speed-update-interval
0)
415 mh-speed-update-interval
418 (unless (and (processp mh-speed-flists-process
)
419 (not (eq (process-status mh-speed-flists-process
)
421 (setq mh-speed-current-folder
423 (if mh-speed-flists-folder
424 (substring (car (reverse mh-speed-flists-folder
)) 1)
426 (call-process (expand-file-name "folder" mh-progs
)
427 nil
'(t nil
) nil
"-fast")
428 (buffer-substring (point-min) (1- (point-max)))))
430 (setq mh-speed-flists-process
431 (apply #'start-process
"*flists*" nil
432 (expand-file-name "flists" mh-progs
)
433 (if mh-speed-flists-folder
"-noall" "-all")
434 "-sequence" (symbol-name mh-unseen-seq
)
435 (or mh-speed-flists-folder
'("-recurse"))))
436 ;; Run flists on all folders the next time around...
437 (setq mh-speed-flists-folder nil
)
438 (mh-process-kill-without-query mh-speed-flists-process
)
439 (set-process-filter mh-speed-flists-process
440 'mh-speed-parse-flists-output
)))))))
442 ;; Copied from mh-make-folder-list-filter...
443 ;; XXX Refactor to use mh-make-folder-list-filer?
444 (defun mh-speed-parse-flists-output (process output
)
445 "Parse the incremental results from flists.
446 PROCESS is the flists process and OUTPUT is the results that must
448 (let ((prevailing-match-data (match-data))
450 line-end line folder unseen total
)
452 (while (setq line-end
(string-match "\n" output position
))
453 (setq line
(format "%s%s"
454 mh-speed-partial-line
455 (substring output position line-end
))
456 mh-speed-partial-line
"")
457 (multiple-value-setq (folder unseen total
)
459 (mh-parse-flist-output-line line mh-speed-current-folder
)))
460 (when (and folder unseen total
461 (let ((old-pair (gethash folder mh-speed-flists-cache
)))
462 (or (not (equal (car old-pair
) unseen
))
463 (not (equal (cdr old-pair
) total
)))))
464 (setf (gethash folder mh-speed-flists-cache
) (cons unseen total
))
466 (when (buffer-live-p (get-buffer speedbar-buffer
))
467 (set-buffer speedbar-buffer
)
468 (speedbar-with-writable
469 (when (get-text-property (point-min) 'mh-level
)
470 (let ((pos (gethash folder mh-speed-folder-map
))
474 (goto-char (mh-line-beginning-position))
476 ((null (get-text-property (point) 'mh-count
))
477 (goto-char (mh-line-end-position))
478 (setq face
(get-text-property (1- (point)) 'face
))
479 (insert (format " (%s/%s)" unseen total
))
480 (mh-speed-highlight 'unknown face
)
481 (goto-char (mh-line-beginning-position))
482 (add-text-properties (point) (1+ (point))
483 `(mh-count (,unseen .
,total
))))
484 ((not (equal (get-text-property (point) 'mh-count
)
485 (cons unseen total
)))
486 (goto-char (mh-line-end-position))
487 (setq face
(get-text-property (1- (point)) 'face
))
488 (re-search-backward " " (mh-line-beginning-position) t
)
489 (delete-region (point) (mh-line-end-position))
490 (insert (format " (%s/%s)" unseen total
))
491 (mh-speed-highlight 'unknown face
)
492 (goto-char (mh-line-beginning-position))
495 `(mh-count (,unseen .
,total
))))))))))))
496 (setq position
(1+ line-end
)))
497 (set-match-data prevailing-match-data
))
498 (setq mh-speed-partial-line
(substring output position
))))
501 (defun mh-speed-invalidate-map (folder)
502 "Remove FOLDER from various optimization caches."
503 (interactive (list ""))
505 (set-buffer speedbar-buffer
)
506 (let* ((speedbar-update-flag nil
)
507 (last-slash (mh-search-from-end ?
/ folder
))
508 (parent (if last-slash
(substring folder
0 last-slash
) nil
))
509 (parent-position (gethash parent mh-speed-folder-map
))
511 (when parent-position
512 (let ((parent-kids (mh-sub-folders parent
)))
513 (cond ((null parent-kids
)
514 (setq parent-change ?
+))
515 ((and (null (cdr parent-kids
))
516 (equal (if last-slash
517 (substring folder
(1+ last-slash
))
518 (substring folder
1))
520 (setq parent-change ?
))))
521 (goto-char parent-position
)
522 (when (equal (get-text-property (mh-line-beginning-position) 'mh-folder
)
524 (when (get-text-property (mh-line-beginning-position) 'mh-expanded
)
527 (speedbar-with-writable
528 (mh-speedbar-change-expand-button-char parent-change
)
530 (mh-line-beginning-position) (1+ (mh-line-beginning-position))
531 `(mh-children-p ,(equal parent-change ?
+)))))
532 (mh-speed-highlight mh-speed-last-selected-folder
'mh-speedbar-folder
)
533 (setq mh-speed-last-selected-folder nil
)
534 (setq mh-speed-refresh-flag t
)))
535 (when (equal folder
"")
536 (mh-clear-sub-folders-cache)))))
538 ;; Make it slightly more general to allow for [ ] buttons to be
540 (defun mh-speedbar-change-expand-button-char (char)
541 "Change the expansion button character to CHAR for the current line."
544 (if (re-search-forward "\\[.\\]" (mh-line-end-position) t
)
545 (speedbar-with-writable
548 (insert-char char
1 t
)
549 (put-text-property (point) (1- (point)) 'invisible nil
)
550 ;; make sure we fix the image on the text here.
551 (mh-funcall-if-exists
552 speedbar-insert-image-button-maybe
(- (point) 2) 3)))))
555 (defun mh-speed-add-folder (folder)
556 "Add FOLDER since it is being created.
557 The function invalidates the latest ancestor that is present."
559 (set-buffer speedbar-buffer
)
560 (let ((speedbar-update-flag nil
)
561 (last-slash (mh-search-from-end ?
/ folder
))
566 (setq ancestor
(substring ancestor
0 last-slash
))
567 (setq ancestor-pos
(gethash ancestor mh-speed-folder-map
))
569 (return-from while-loop
))
570 (setq last-slash
(mh-search-from-end ?
/ ancestor
))))
571 (unless ancestor-pos
(setq ancestor nil
))
572 (goto-char (or ancestor-pos
(gethash nil mh-speed-folder-map
)))
573 (speedbar-with-writable
574 (mh-speedbar-change-expand-button-char ?
+)
576 (mh-line-beginning-position) (1+ (mh-line-beginning-position))
578 (when (get-text-property (mh-line-beginning-position) 'mh-expanded
)
580 (setq mh-speed-refresh-flag t
))))
585 ;; indent-tabs-mode: nil
586 ;; sentence-end-double-space: nil
589 ;; arch-tag: d38ddcd4-3c00-4e37-99bf-8b89dda7b32c
590 ;;; mh-speed.el ends here