Merge from origin/emacs-24
[emacs.git] / lisp / erc / erc-track.el
blob1a9aee199a3d2f29e1397c595a4295d6c27144ed
1 ;;; erc-track.el --- Track modified channel buffers -*- lexical-binding:t -*-
3 ;; Copyright (C) 2002-2015 Free Software Foundation, Inc.
5 ;; Author: Mario Lang <mlang@delysid.org>
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: comm, faces
8 ;; URL: http://www.emacswiki.org/cgi-bin/wiki.pl?ErcChannelTracking
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/>.
25 ;;; Commentary:
27 ;; Highlights keywords and pals (friends), and hides or highlights fools
28 ;; (using a dark color). Add to your init file:
30 ;; (require 'erc-track)
31 ;; (erc-track-mode 1)
33 ;; Todo:
34 ;; * Add extensibility so that custom functions can track
35 ;; custom modification types.
37 (eval-when-compile (require 'cl-lib))
38 (require 'erc)
39 (require 'erc-compat)
40 (require 'erc-match)
42 ;;; Code:
44 (defgroup erc-track nil
45 "Track active buffers and show activity in the mode line."
46 :group 'erc)
48 (defcustom erc-track-enable-keybindings 'ask
49 "Whether to enable the ERC track keybindings, namely:
50 `C-c C-SPC' and `C-c C-@', which both do the same thing.
52 The default is to check to see whether these keys are used
53 already: if not, then enable the ERC track minor mode, which
54 provides these keys. Otherwise, do not touch the keys.
56 This can alternatively be set to either t or nil, which indicate
57 respectively always to enable ERC track minor mode or never to
58 enable ERC track minor mode.
60 The reason for using this default value is to both (1) adhere to
61 the Emacs development guidelines which say not to touch keys of
62 the form C-c C-<something> and also (2) to meet the expectations
63 of long-time ERC users, many of whom rely on these keybindings."
64 :group 'erc-track
65 :type '(choice (const :tag "Ask, if used already" ask)
66 (const :tag "Enable" t)
67 (const :tag "Disable" nil)))
69 (defcustom erc-track-visibility t
70 "Where do we look for buffers to determine their visibility?
71 The value of this variable determines, when a buffer is considered
72 visible or invisible. New messages in invisible buffers are tracked,
73 while switching to visible buffers when they are tracked removes them
74 from the list. See also `erc-track-when-inactive'.
76 Possible values are:
78 t - all frames
79 visible - all visible frames
80 nil - only the selected frame
81 selected-visible - only the selected frame if it is visible
83 Activity means that there was no user input in the last 10 seconds."
84 :group 'erc-track
85 :type '(choice (const :tag "All frames" t)
86 (const :tag "All visible frames" visible)
87 (const :tag "Only the selected frame" nil)
88 (const :tag "Only the selected frame if it is visible"
89 selected-visible)))
91 (defcustom erc-track-exclude nil
92 "A list targets (channel names or query targets) which should not be tracked."
93 :group 'erc-track
94 :type '(repeat string))
96 (defcustom erc-track-remove-disconnected-buffers nil
97 "If true, remove buffers associated with a server that is
98 disconnected from `erc-modified-channels-alist'."
99 :group 'erc-track
100 :type 'boolean)
102 (defcustom erc-track-exclude-types '("NICK" "333" "353")
103 "List of message types to be ignored.
104 This list could look like '(\"JOIN\" \"PART\").
106 By default, exclude changes of nicknames (NICK), display of who
107 set the channel topic (333), and listing of users on the current
108 channel (353)."
109 :group 'erc-track
110 :type 'erc-message-type)
112 (defcustom erc-track-exclude-server-buffer nil
113 "If true, don't perform tracking on the server buffer; this is
114 useful for excluding all the things like MOTDs from the server and
115 other miscellaneous functions."
116 :group 'erc-track
117 :type 'boolean)
119 (defcustom erc-track-shorten-start 1
120 "This number specifies the minimum number of characters a channel name in
121 the mode-line should be reduced to."
122 :group 'erc-track
123 :type 'number)
125 (defcustom erc-track-shorten-cutoff 4
126 "All channel names longer than this value will be shortened."
127 :group 'erc-track
128 :type 'number)
130 (defcustom erc-track-shorten-aggressively nil
131 "If non-nil, channel names will be shortened more aggressively.
132 Usually, names are not shortened if this will save only one character.
133 Example: If there are two channels, #linux-de and #linux-fr, then
134 normally these will not be shortened. When shortening aggressively,
135 however, these will be shortened to #linux-d and #linux-f.
137 If this variable is set to `max', then channel names will be shortened
138 to the max. Usually, shortened channel names will remain unique for a
139 given set of existing channels. When shortening to the max, the shortened
140 channel names will be unique for the set of active channels only.
141 Example: If there are two active channels #emacs and #vi, and two inactive
142 channels #electronica and #folk, then usually the active channels are
143 shortened to #em and #v. When shortening to the max, however, #emacs is
144 not compared to #electronica -- only to #vi, therefore it can be shortened
145 even more and the result is #e and #v.
147 This setting is used by `erc-track-shorten-names'."
148 :group 'erc-track
149 :type '(choice (const :tag "No" nil)
150 (const :tag "Yes" t)
151 (const :tag "Max" max)))
153 (defcustom erc-track-shorten-function 'erc-track-shorten-names
154 "This function will be used to reduce the channel names before display.
155 It takes one argument, CHANNEL-NAMES which is a list of strings.
156 It should return a list of strings of the same number of elements.
157 If nil instead of a function, shortening is disabled."
158 :group 'erc-track
159 :type '(choice (const :tag "Disabled")
160 function))
162 (defcustom erc-track-list-changed-hook nil
163 "Hook that is run whenever the contents of
164 `erc-modified-channels-alist' changes.
166 This is useful for people that don't use the default mode-line
167 notification but instead use a separate mechanism to provide
168 notification of channel activity."
169 :group 'erc-track
170 :type 'hook)
172 (defcustom erc-track-use-faces t
173 "Use faces in the mode-line.
174 The faces used are the same as used for text in the buffers.
175 \(e.g. `erc-pal-face' is used if a pal sent a message to that channel.)"
176 :group 'erc-track
177 :type 'boolean)
179 (defcustom erc-track-faces-priority-list
180 '(erc-error-face
181 (erc-nick-default-face erc-current-nick-face)
182 erc-current-nick-face
183 erc-keyword-face
184 (erc-nick-default-face erc-pal-face)
185 erc-pal-face
186 erc-nick-msg-face
187 erc-direct-msg-face
188 (erc-button erc-default-face)
189 (erc-nick-default-face erc-dangerous-host-face)
190 erc-dangerous-host-face
191 erc-nick-default-face
192 (erc-nick-default-face erc-default-face)
193 erc-default-face
194 erc-action-face
195 (erc-nick-default-face erc-fool-face)
196 erc-fool-face
197 erc-notice-face
198 erc-input-face
199 erc-prompt-face)
200 "A list of faces used to highlight active buffer names in the mode line.
201 If a message contains one of the faces in this list, the buffer name will
202 be highlighted using that face. The first matching face is used."
203 :group 'erc-track
204 :type '(repeat (choice face
205 (repeat :tag "Combination" face))))
207 (defcustom erc-track-priority-faces-only nil
208 "Only track text highlighted with a priority face.
209 If you would like to ignore changes in certain channels where there
210 are no faces corresponding to your `erc-track-faces-priority-list', set
211 this variable. You can set a list of channel name strings, so those
212 will be ignored while all other channels will be tracked as normal.
213 Other options are 'all, to apply this to all channels or nil, to disable
214 this feature.
216 Note: If you have a lot of faces listed in `erc-track-faces-priority-list',
217 setting this variable might not be very useful."
218 :group 'erc-track
219 :type '(choice (const nil)
220 (repeat string)
221 (const all)))
223 (defcustom erc-track-faces-normal-list
224 '((erc-button erc-default-face)
225 (erc-nick-default-face erc-dangerous-host-face)
226 erc-dangerous-host-face
227 erc-nick-default-face
228 (erc-nick-default-face erc-default-face)
229 erc-default-face
230 erc-action-face)
231 "A list of faces considered to be part of normal conversations.
232 This list is used to highlight active buffer names in the mode line.
234 If a message contains one of the faces in this list, and the
235 previous mode line face for this buffer is also in this list, then
236 the buffer name will be highlighted using the face from the
237 message. This gives a rough indication that active conversations
238 are occurring in these channels.
240 The effect may be disabled by setting this variable to nil."
241 :group 'erc-track
242 :type '(repeat (choice face
243 (repeat :tag "Combination" face))))
245 (defcustom erc-track-position-in-mode-line 'before-modes
246 "Where to show modified channel information in the mode-line.
248 Setting this variable only has effects in GNU Emacs versions above 21.3.
250 Choices are:
251 'before-modes - add to the beginning of `mode-line-modes',
252 'after-modes - add to the end of `mode-line-modes',
253 t - add to the end of `global-mode-string',
254 nil - don't add to mode line."
255 :group 'erc-track
256 :type '(choice (const :tag "Just before mode information" before-modes)
257 (const :tag "Just after mode information" after-modes)
258 (const :tag "After all other information" t)
259 (const :tag "Don't display in mode line" nil))
260 :set (lambda (sym val)
261 (set sym val)
262 (when (and (boundp 'erc-track-mode)
263 erc-track-mode)
264 (erc-track-remove-from-mode-line)
265 (erc-track-add-to-mode-line val))))
267 (defun erc-modified-channels-object (strings)
268 "Generate a new `erc-modified-channels-object' based on STRINGS."
269 (if strings
270 (if (featurep 'xemacs)
271 (let ((e-m-c-s '("[")))
272 (push (cons (extent-at 0 (car strings)) (car strings))
273 e-m-c-s)
274 (dolist (string (cdr strings))
275 (push "," e-m-c-s)
276 (push (cons (extent-at 0 string) string)
277 e-m-c-s))
278 (push "] " e-m-c-s)
279 (reverse e-m-c-s))
280 (concat (if (eq erc-track-position-in-mode-line 'after-modes)
281 "[" " [")
282 (mapconcat 'identity (nreverse strings) ",")
283 (if (eq erc-track-position-in-mode-line 'before-modes)
284 "] " "]")))
285 (if (featurep 'xemacs) '() "")))
287 (defvar erc-modified-channels-object (erc-modified-channels-object nil)
288 "Internal object used for displaying modified channels in the mode line.")
290 (put 'erc-modified-channels-object 'risky-local-variable t); allow properties
292 (defvar erc-modified-channels-alist nil
293 "An ALIST used for tracking channel modification activity.
294 Each element looks like (BUFFER COUNT FACE) where BUFFER is a buffer
295 object of the channel the entry corresponds to, COUNT is a number
296 indicating how often activity was noticed, and FACE is the face to use
297 when displaying the buffer's name. See `erc-track-faces-priority-list',
298 and `erc-track-showcount'.
300 Entries in this list should only happen for buffers where activity occurred
301 while the buffer was not visible.")
303 (defcustom erc-track-showcount nil
304 "If non-nil, count of unseen messages will be shown for each channel."
305 :type 'boolean
306 :group 'erc-track)
308 (defcustom erc-track-showcount-string ":"
309 "The string to display between buffer name and the count in the mode line.
310 The default is a colon, resulting in \"#emacs:9\"."
311 :type 'string
312 :group 'erc-track)
314 (defcustom erc-track-switch-from-erc t
315 "If non-nil, `erc-track-switch-buffer' will return to the last non-erc buffer
316 when there are no more active channels."
317 :type 'boolean
318 :group 'erc-track)
320 (defcustom erc-track-switch-direction 'oldest
321 "Direction `erc-track-switch-buffer' should switch.
323 importance - find buffer with the most important message
324 oldest - find oldest active buffer
325 newest - find newest active buffer
326 leastactive - find buffer with least unseen messages
327 mostactive - find buffer with most unseen messages.
329 If set to 'importance, the importance is determined by position
330 in `erc-track-faces-priority-list', where first is most
331 important."
332 :group 'erc-track
333 :type '(choice (const importance)
334 (const oldest)
335 (const newest)
336 (const leastactive)
337 (const mostactive)))
340 (defun erc-track-remove-from-mode-line ()
341 "Remove `erc-track-modified-channels' from the mode-line"
342 (when (boundp 'mode-line-modes)
343 (setq mode-line-modes
344 (remove '(t erc-modified-channels-object) mode-line-modes)))
345 (when (consp global-mode-string)
346 (setq global-mode-string
347 (delq 'erc-modified-channels-object global-mode-string))))
349 (defun erc-track-add-to-mode-line (position)
350 "Add `erc-track-modified-channels' to POSITION in the mode-line.
351 See `erc-track-position-in-mode-line' for possible values."
352 ;; CVS Emacs has a new format string, and global-mode-string
353 ;; is very far to the right.
354 (cond ((and (eq position 'before-modes)
355 (boundp 'mode-line-modes))
356 (add-to-list 'mode-line-modes
357 '(t erc-modified-channels-object)))
358 ((and (eq position 'after-modes)
359 (boundp 'mode-line-modes))
360 (add-to-list 'mode-line-modes
361 '(t erc-modified-channels-object) t))
362 ((eq position t)
363 (when (not global-mode-string)
364 (setq global-mode-string '(""))) ; Padding for mode-line wart
365 (add-to-list 'global-mode-string
366 'erc-modified-channels-object
367 t))))
369 ;;; Shortening of names
371 (defun erc-track-shorten-names (channel-names)
372 "Call `erc-unique-channel-names' with the correct parameters.
373 This function is a good value for `erc-track-shorten-function'.
374 The list of all channels is returned by `erc-all-buffer-names'.
375 CHANNEL-NAMES is the list of active channel names.
376 Only channel names longer than `erc-track-shorten-cutoff' are
377 actually shortened, and they are only shortened to a minimum
378 of `erc-track-shorten-start' characters."
379 (erc-unique-channel-names
380 (erc-all-buffer-names)
381 channel-names
382 (lambda (s)
383 (> (length s) erc-track-shorten-cutoff))
384 erc-track-shorten-start))
386 (defvar erc-default-recipients)
388 (defun erc-all-buffer-names ()
389 "Return all channel or query buffer names.
390 Note that we cannot use `erc-channel-list' with a nil argument,
391 because that does not return query buffers."
392 (save-excursion
393 (let (result)
394 (dolist (buf (buffer-list))
395 (set-buffer buf)
396 (when (or (eq major-mode 'erc-mode) (eq major-mode 'erc-dcc-chat-mode))
397 (setq result (cons (buffer-name) result))))
398 result)))
400 (defun erc-unique-channel-names (all active &optional predicate start)
401 "Return a list of unique channel names.
402 ALL is the list of all channel and query buffer names.
403 ACTIVE is the list of active buffer names.
404 PREDICATE is a predicate that should return non-nil if a name needs
405 no shortening.
406 START is the minimum length of the name used."
407 (if (eq 'max erc-track-shorten-aggressively)
408 ;; Return the unique substrings of all active channels.
409 (erc-unique-substrings active predicate start)
410 ;; Otherwise, determine the unique substrings of all channels, and
411 ;; for every active channel, return the corresponding substring.
412 ;; Given the names of the active channels, we now need to find the
413 ;; corresponding short name from the list of all substrings. To
414 ;; avoid problems when there are two channels and one is a
415 ;; substring of the other (notorious examples are #hurd and
416 ;; #hurd-bunny), every candidate gets the longest possible
417 ;; substring.
418 (let ((all-substrings (sort
419 (erc-unique-substrings all predicate start)
420 (lambda (a b) (> (length a) (length b)))))
421 result)
422 (dolist (channel active)
423 (let ((substrings all-substrings)
424 candidate
425 winner)
426 (while (and substrings (not winner))
427 (setq candidate (car substrings)
428 substrings (cdr substrings))
429 (when (and (string= candidate
430 (substring channel
432 (min (length candidate)
433 (length channel))))
434 (not (member candidate result)))
435 (setq winner candidate)))
436 (setq result (cons winner result))))
437 (nreverse result))))
439 (defun erc-unique-substrings (strings &optional predicate start)
440 "Return a list of unique substrings of STRINGS."
441 (if (or (not (numberp start))
442 (< start 0))
443 (setq start 2))
444 (mapcar
445 (lambda (str)
446 (let* ((others (delete str (copy-sequence strings)))
447 (maxlen (length str))
448 (i (min start
449 (length str)))
450 candidate
451 done)
452 (if (and (functionp predicate) (not (funcall predicate str)))
453 ;; do not shorten if a predicate exists and it returns nil
455 ;; Start with smallest substring candidate, ie. length 1.
456 ;; Then check all the others and see whether any of them starts
457 ;; with the same substring. While there is such another
458 ;; element in the list, increase the length of the candidate.
459 (while (not done)
460 (if (> i maxlen)
461 (setq done t)
462 (setq candidate (substring str 0 i)
463 done (not (erc-unique-substring-1 candidate others))))
464 (setq i (1+ i)))
465 (if (and (= (length candidate) (1- maxlen))
466 (not erc-track-shorten-aggressively))
468 candidate))))
469 strings))
471 (defun erc-unique-substring-1 (candidate others)
472 "Return non-nil when any string in OTHERS starts with CANDIDATE."
473 (let (result other (maxlen (length candidate)))
474 (while (and others
475 (not result))
476 (setq other (car others)
477 others (cdr others))
478 (when (and (>= (length other) maxlen)
479 (string= candidate (substring other 0 maxlen)))
480 (setq result other)))
481 result))
483 ;;; Test:
485 (cl-assert
486 (and
487 ;; verify examples from the doc strings
488 (equal (let ((erc-track-shorten-aggressively nil))
489 (erc-unique-channel-names
490 '("#emacs" "#vi" "#electronica" "#folk")
491 '("#emacs" "#vi")))
492 '("#em" "#vi")) ; emacs is different from electronica
493 (equal (let ((erc-track-shorten-aggressively t))
494 (erc-unique-channel-names
495 '("#emacs" "#vi" "#electronica" "#folk")
496 '("#emacs" "#vi")))
497 '("#em" "#v")) ; vi is shortened by one letter
498 (equal (let ((erc-track-shorten-aggressively 'max))
499 (erc-unique-channel-names
500 '("#emacs" "#vi" "#electronica" "#folk")
501 '("#emacs" "#vi")))
502 '("#e" "#v")) ; emacs need not be different from electronica
503 (equal (let ((erc-track-shorten-aggressively nil))
504 (erc-unique-channel-names
505 '("#linux-de" "#linux-fr")
506 '("#linux-de" "#linux-fr")))
507 '("#linux-de" "#linux-fr")) ; shortening by one letter is too aggressive
508 (equal (let ((erc-track-shorten-aggressively t))
509 (erc-unique-channel-names
510 '("#linux-de" "#linux-fr")
511 '("#linux-de" "#linux-fr")))
512 '("#linux-d" "#linux-f")); now we want to be aggressive
513 ;; specific problems
514 (equal (let ((erc-track-shorten-aggressively nil))
515 (erc-unique-channel-names
516 '("#dunnet" "#lisp" "#sawfish" "#fsf" "#guile"
517 "#testgnome" "#gnu" "#fsbot" "#hurd" "#hurd-bunny"
518 "#emacs")
519 '("#hurd-bunny" "#hurd" "#sawfish" "#lisp")))
520 '("#hurd-" "#hurd" "#s" "#l"))
521 (equal (let ((erc-track-shorten-aggressively nil))
522 (erc-unique-substrings
523 '("#emacs" "#vi" "#electronica" "#folk")))
524 '("#em" "#vi" "#el" "#f"))
525 (equal (let ((erc-track-shorten-aggressively t))
526 (erc-unique-substrings
527 '("#emacs" "#vi" "#electronica" "#folk")))
528 '("#em" "#v" "#el" "#f"))
529 (equal (let ((erc-track-shorten-aggressively nil))
530 (erc-unique-channel-names
531 '("#emacs" "#burse" "+linux.de" "#starwars"
532 "#bitlbee" "+burse" "#ratpoison")
533 '("+linux.de" "#starwars" "#burse")))
534 '("+l" "#s" "#bu"))
535 (equal (let ((erc-track-shorten-aggressively nil))
536 (erc-unique-channel-names
537 '("fsbot" "#emacs" "deego")
538 '("fsbot")))
539 '("fs"))
540 (equal (let ((erc-track-shorten-aggressively nil))
541 (erc-unique-channel-names
542 '("fsbot" "#emacs" "deego")
543 '("fsbot")
544 (lambda (s)
545 (> (length s) 4))
547 '("f"))
548 (equal (let ((erc-track-shorten-aggressively nil))
549 (erc-unique-channel-names
550 '("fsbot" "#emacs" "deego")
551 '("fsbot")
552 (lambda (s)
553 (> (length s) 4))
555 '("fs"))
556 (let ((erc-track-shorten-aggressively nil))
557 (equal (erc-unique-channel-names '("deego" "#hurd" "#hurd-bunny" "#emacs")
558 '("#hurd" "#hurd-bunny"))
559 '("#hurd" "#hurd-")))
560 ;; general examples
561 (let ((erc-track-shorten-aggressively t))
562 (and (equal (erc-unique-substring-1 "abc" '("ab" "abcd")) "abcd")
563 (not (erc-unique-substring-1 "a" '("xyz" "xab")))
564 (equal (erc-unique-substrings '("abc" "xyz" "xab"))
565 '("ab" "xy" "xa"))
566 (equal (erc-unique-substrings '("abc" "abcdefg"))
567 '("abc" "abcd"))))
568 (let ((erc-track-shorten-aggressively nil))
569 (and (equal (erc-unique-substring-1 "abc" '("ab" "abcd")) "abcd")
570 (not (erc-unique-substring-1 "a" '("xyz" "xab")))
571 (equal (erc-unique-substrings '("abc" "xyz" "xab"))
572 '("abc" "xyz" "xab"))
573 (equal (erc-unique-substrings '("abc" "abcdefg"))
574 '("abc" "abcd"))))))
576 ;;; Minor mode
578 ;; Play nice with other IRC clients (and Emacs development rules) by
579 ;; making this a minor mode
581 (defvar erc-track-minor-mode-map (make-sparse-keymap)
582 "Keymap for rcirc track minor mode.")
584 (define-key erc-track-minor-mode-map (kbd "C-c C-@") 'erc-track-switch-buffer)
585 (define-key erc-track-minor-mode-map (kbd "C-c C-SPC")
586 'erc-track-switch-buffer)
588 ;;;###autoload
589 (define-minor-mode erc-track-minor-mode
590 "Toggle mode line display of ERC activity (ERC Track minor mode).
591 With a prefix argument ARG, enable ERC Track minor mode if ARG is
592 positive, and disable it otherwise. If called from Lisp, enable
593 the mode if ARG is omitted or nil.
595 ERC Track minor mode is a global minor mode. It exists for the
596 sole purpose of providing the C-c C-SPC and C-c C-@ keybindings.
597 Make sure that you have enabled the track module, otherwise the
598 keybindings will not do anything useful."
599 :init-value nil
600 :lighter ""
601 :keymap erc-track-minor-mode-map
602 :global t
603 :group 'erc-track)
605 (defun erc-track-minor-mode-maybe (&optional buffer)
606 "Enable `erc-track-minor-mode', depending on `erc-track-enable-keybindings'."
607 (when (and (not erc-track-minor-mode)
608 ;; don't start the minor mode until we have an ERC
609 ;; process running, because we don't want to prompt the
610 ;; user while starting Emacs
611 (or (and (buffer-live-p buffer)
612 (with-current-buffer buffer (eq major-mode 'erc-mode)))
613 (erc-buffer-list)))
614 (cond ((eq erc-track-enable-keybindings 'ask)
615 (let ((key (or (and (key-binding (kbd "C-c C-SPC")) "C-SPC")
616 (and (key-binding (kbd "C-c C-@")) "C-@"))))
617 (if key
618 (if (y-or-n-p
619 (concat "The C-c " key " binding is in use;"
620 " override it for tracking? "))
621 (progn
622 (message (concat "Will change it; set"
623 " `erc-track-enable-keybindings'"
624 " to disable this message"))
625 (sleep-for 3)
626 (erc-track-minor-mode 1))
627 (message (concat "Not changing it; set"
628 " `erc-track-enable-keybindings'"
629 " to disable this message"))
630 (sleep-for 3))
631 (erc-track-minor-mode 1))))
632 ((eq erc-track-enable-keybindings t)
633 (erc-track-minor-mode 1))
634 (t nil))))
636 ;;; Module
638 ;;;###autoload (autoload 'erc-track-mode "erc-track" nil t)
639 (define-erc-module track nil
640 "This mode tracks ERC channel buffers with activity."
641 ;; Enable:
642 ((when (boundp 'erc-track-when-inactive)
643 (if erc-track-when-inactive
644 (progn
645 (if (featurep 'xemacs)
646 (defadvice switch-to-buffer (after erc-update-when-inactive
647 (&rest args) activate)
648 (erc-user-is-active))
649 (add-hook 'window-configuration-change-hook 'erc-user-is-active))
650 (add-hook 'erc-send-completed-hook 'erc-user-is-active)
651 (add-hook 'erc-server-001-functions 'erc-user-is-active))
652 (erc-track-add-to-mode-line erc-track-position-in-mode-line)
653 (erc-update-mode-line)
654 (if (featurep 'xemacs)
655 (defadvice switch-to-buffer (after erc-update (&rest args) activate)
656 (erc-modified-channels-update))
657 (add-hook 'window-configuration-change-hook
658 'erc-window-configuration-change))
659 (add-hook 'erc-insert-post-hook 'erc-track-modified-channels)
660 (add-hook 'erc-disconnected-hook 'erc-modified-channels-update))
661 ;; enable the tracking keybindings
662 (add-hook 'erc-connect-pre-hook 'erc-track-minor-mode-maybe)
663 (erc-track-minor-mode-maybe)))
664 ;; Disable:
665 ((when (boundp 'erc-track-when-inactive)
666 (erc-track-remove-from-mode-line)
667 (if erc-track-when-inactive
668 (progn
669 (if (featurep 'xemacs)
670 (ad-disable-advice 'switch-to-buffer 'after
671 'erc-update-when-inactive)
672 (remove-hook 'window-configuration-change-hook
673 'erc-user-is-active))
674 (remove-hook 'erc-send-completed-hook 'erc-user-is-active)
675 (remove-hook 'erc-server-001-functions 'erc-user-is-active)
676 (remove-hook 'erc-timer-hook 'erc-user-is-active))
677 (if (featurep 'xemacs)
678 (ad-disable-advice 'switch-to-buffer 'after 'erc-update)
679 (remove-hook 'window-configuration-change-hook
680 'erc-window-configuration-change))
681 (remove-hook 'erc-disconnected-hook 'erc-modified-channels-update)
682 (remove-hook 'erc-insert-post-hook 'erc-track-modified-channels))
683 ;; disable the tracking keybindings
684 (remove-hook 'erc-connect-pre-hook 'erc-track-minor-mode-maybe)
685 (when erc-track-minor-mode
686 (erc-track-minor-mode -1)))))
688 (defcustom erc-track-when-inactive nil
689 "Enable channel tracking even for visible buffers, if you are
690 inactive."
691 :group 'erc-track
692 :type 'boolean
693 :set (lambda (sym val)
694 (if erc-track-mode
695 (progn
696 (erc-track-disable)
697 (set sym val)
698 (erc-track-enable))
699 (set sym val))))
701 ;;; Visibility
703 (defvar erc-buffer-activity nil
704 "Last time the user sent something.")
706 (defvar erc-buffer-activity-timeout 10
707 "How many seconds of inactivity by the user
708 to consider when `erc-track-visibility' is set to
709 only consider active buffers visible.")
711 (defun erc-user-is-active (&rest _ignore)
712 "Set `erc-buffer-activity'."
713 (when erc-server-connected
714 (setq erc-buffer-activity (erc-current-time))
715 (erc-track-modified-channels)))
717 (defun erc-track-get-buffer-window (buffer frame-param)
718 (if (eq frame-param 'selected-visible)
719 (if (eq (frame-visible-p (selected-frame)) t)
720 (get-buffer-window buffer nil)
721 nil)
722 (get-buffer-window buffer frame-param)))
724 (defun erc-buffer-visible (buffer)
725 "Return non-nil when the buffer is visible."
726 (if erc-track-when-inactive
727 (when erc-buffer-activity; could be nil
728 (and (erc-track-get-buffer-window buffer erc-track-visibility)
729 (<= (erc-time-diff erc-buffer-activity (erc-current-time))
730 erc-buffer-activity-timeout)))
731 (erc-track-get-buffer-window buffer erc-track-visibility)))
733 ;;; Tracking the channel modifications
735 (defun erc-window-configuration-change ()
736 (unless (minibuffer-window-active-p (minibuffer-window))
737 ;; delay this until command has finished to make sure window is
738 ;; actually visible before clearing activity
739 (add-hook 'post-command-hook 'erc-modified-channels-update)))
741 (defvar erc-modified-channels-update-inside nil
742 "Variable to prevent running `erc-modified-channels-update' multiple
743 times. Without it, you cannot debug `erc-modified-channels-display',
744 because the debugger also causes changes to the window-configuration.")
746 (defun erc-modified-channels-update (&rest _args)
747 "This function updates the information in `erc-modified-channels-alist'
748 according to buffer visibility. It calls
749 `erc-modified-channels-display' at the end. This should usually be
750 called via `window-configuration-change-hook'.
751 ARGS are ignored."
752 (interactive)
753 (unless erc-modified-channels-update-inside
754 (let ((erc-modified-channels-update-inside t)
755 (removed-channel nil))
756 (mapc (lambda (elt)
757 (let ((buffer (car elt)))
758 (when (or (not (bufferp buffer))
759 (not (buffer-live-p buffer))
760 (erc-buffer-visible buffer)
761 (and erc-track-remove-disconnected-buffers
762 (not (with-current-buffer buffer
763 erc-server-connected))))
764 (setq removed-channel t)
765 (erc-modified-channels-remove-buffer buffer))))
766 erc-modified-channels-alist)
767 (when removed-channel
768 (erc-modified-channels-display)))
769 (remove-hook 'post-command-hook 'erc-modified-channels-update)))
771 (defvar erc-track-mouse-face (if (featurep 'xemacs)
772 'modeline-mousable
773 'mode-line-highlight)
774 "The face to use when mouse is over channel names in the mode line.")
776 (defun erc-make-mode-line-buffer-name (string buffer &optional faces count)
777 "Return STRING as a button that switches to BUFFER when clicked.
778 If FACES are provided, color STRING with them."
779 ;; We define a new sparse keymap every time, because 1. this data
780 ;; structure is very small, the alternative would require us to
781 ;; defvar a keymap, 2. the user is not interested in customizing it
782 ;; (really?), 3. the defun needs to switch to BUFFER, so we would
783 ;; need to save that value somewhere.
784 (let ((map (make-sparse-keymap))
785 (name (if erc-track-showcount
786 (concat string
787 erc-track-showcount-string
788 (int-to-string count))
789 (copy-sequence string))))
790 (define-key map (vector 'mode-line 'mouse-2)
791 (lambda (e)
792 (interactive "e")
793 (save-selected-window
794 (select-window
795 (posn-window (event-start e)))
796 (switch-to-buffer buffer))))
797 (define-key map (vector 'mode-line 'mouse-3)
798 (lambda (e)
799 (interactive "e")
800 (save-selected-window
801 (select-window
802 (posn-window (event-start e)))
803 (switch-to-buffer-other-window buffer))))
804 (put-text-property 0 (length name) 'local-map map name)
805 (put-text-property
806 0 (length name)
807 'help-echo (concat "mouse-2: switch to buffer, "
808 "mouse-3: switch to buffer in other window")
809 name)
810 (put-text-property 0 (length name) 'mouse-face erc-track-mouse-face name)
811 (when (and faces erc-track-use-faces)
812 (put-text-property 0 (length name) 'face faces name))
813 name))
815 (defun erc-modified-channels-display ()
816 "Set `erc-modified-channels-object'
817 according to `erc-modified-channels-alist'.
818 Use `erc-make-mode-line-buffer-name' to create buttons."
819 (cond ((or (eq 'mostactive erc-track-switch-direction)
820 (eq 'leastactive erc-track-switch-direction))
821 (erc-track-sort-by-activest))
822 ((eq 'importance erc-track-switch-direction)
823 (erc-track-sort-by-importance)))
824 (run-hooks 'erc-track-list-changed-hook)
825 (when erc-track-position-in-mode-line
826 (let* ((oldobject erc-modified-channels-object)
827 (strings
828 (when erc-modified-channels-alist
829 ;; erc-modified-channels-alist contains all the data we need. To
830 ;; better understand what is going on, we split things up into
831 ;; four lists: BUFFERS, COUNTS, SHORT-NAMES, and FACES. These
832 ;; four lists we use to create a new
833 ;; `erc-modified-channels-object' using
834 ;; `erc-make-mode-line-buffer-name'.
835 (let* ((buffers (mapcar 'car erc-modified-channels-alist))
836 (counts (mapcar 'cadr erc-modified-channels-alist))
837 (faces (mapcar 'cddr erc-modified-channels-alist))
838 (long-names (mapcar #'(lambda (buf)
839 (or (buffer-name buf)
840 ""))
841 buffers))
842 (short-names (if (functionp erc-track-shorten-function)
843 (funcall erc-track-shorten-function
844 long-names)
845 long-names))
846 strings)
847 (while buffers
848 (when (car short-names)
849 (setq strings (cons (erc-make-mode-line-buffer-name
850 (car short-names)
851 (car buffers)
852 (car faces)
853 (car counts))
854 strings)))
855 (setq short-names (cdr short-names)
856 buffers (cdr buffers)
857 counts (cdr counts)
858 faces (cdr faces)))
859 strings)))
860 (newobject (erc-modified-channels-object strings)))
861 (unless (equal-including-properties oldobject newobject)
862 (setq erc-modified-channels-object newobject)
863 (force-mode-line-update t)))))
865 (defun erc-modified-channels-remove-buffer (buffer)
866 "Remove BUFFER from `erc-modified-channels-alist'."
867 (interactive "bBuffer: ")
868 (setq erc-modified-channels-alist
869 (delete (assq buffer erc-modified-channels-alist)
870 erc-modified-channels-alist))
871 (when (called-interactively-p 'interactive)
872 (erc-modified-channels-display)))
874 (defun erc-track-find-face (faces)
875 "Return the face to use in the mode line from the faces in FACES.
876 If `erc-track-faces-priority-list' is set, the one from FACES who
877 is first in that list will be used. If nothing matches or if
878 `erc-track-faces-priority-list' is not set, the default mode-line
879 faces will be used.
881 If `erc-track-faces-normal-list' is non-nil, use it to produce a
882 blinking effect that indicates channel activity when the first
883 element in FACES and the highest-ranking face among the rest of
884 FACES are both members of `erc-track-faces-normal-list'.
886 If one of the faces is a list, then it will be ranked according
887 to its highest-tanking face member. A list of faces including
888 that member will take priority over just the single member
889 element."
890 (let ((choice (catch 'face
891 (dolist (candidate erc-track-faces-priority-list)
892 (when (member candidate faces)
893 (throw 'face candidate)))))
894 (no-first (and erc-track-faces-normal-list
895 (catch 'face
896 (dolist (candidate erc-track-faces-priority-list)
897 (when (member candidate (cdr faces))
898 (throw 'face candidate)))))))
899 (cond ((null choice)
900 nil)
901 ((and (member choice erc-track-faces-normal-list)
902 (member no-first erc-track-faces-normal-list))
903 no-first)
905 choice))))
907 (defun erc-track-modified-channels ()
908 "Hook function for `erc-insert-post-hook' to check if the current
909 buffer should be added to the mode line as a hidden, modified
910 channel. Assumes it will only be called when current-buffer
911 is in `erc-mode'."
912 (let ((this-channel (or (erc-default-target)
913 (buffer-name (current-buffer)))))
914 (if (and (not (erc-buffer-visible (current-buffer)))
915 (not (member this-channel erc-track-exclude))
916 (not (and erc-track-exclude-server-buffer
917 (erc-server-buffer-p)))
918 (not (erc-message-type-member
919 (or (erc-find-parsed-property)
920 (point-min))
921 erc-track-exclude-types)))
922 ;; If the active buffer is not visible (not shown in a
923 ;; window), and not to be excluded, determine the kinds of
924 ;; faces used in the current message, and unless the user
925 ;; wants to ignore changes in certain channels where there
926 ;; are no faces corresponding to `erc-track-faces-priority-list',
927 ;; and the faces in the current message are found in said
928 ;; priority list, add the buffer to the erc-modified-channels-alist,
929 ;; if it is not already there. If the buffer is already on the list
930 ;; (in the car), change its face attribute (in the cddr) if
931 ;; necessary. See `erc-modified-channels-alist' for the
932 ;; exact data structure used.
933 (let ((faces (erc-faces-in (buffer-string))))
934 (unless (and
935 (or (eq erc-track-priority-faces-only 'all)
936 (member this-channel erc-track-priority-faces-only))
937 (not (catch 'found
938 (dolist (f faces)
939 (when (member f erc-track-faces-priority-list)
940 (throw 'found t))))))
941 (if (not (assq (current-buffer) erc-modified-channels-alist))
942 ;; Add buffer, faces and counts
943 (setq erc-modified-channels-alist
944 (cons (cons (current-buffer)
945 (cons 1 (erc-track-find-face faces)))
946 erc-modified-channels-alist))
947 ;; Else modify the face for the buffer, if necessary.
948 (when faces
949 (let* ((cell (assq (current-buffer)
950 erc-modified-channels-alist))
951 (old-face (cddr cell))
952 (new-face (erc-track-find-face
953 (if old-face
954 (cons old-face faces)
955 faces))))
956 (setcdr cell (cons (1+ (cadr cell)) new-face)))))
957 ;; And display it
958 (erc-modified-channels-display)))
959 ;; Else if the active buffer is the current buffer, remove it
960 ;; from our list.
961 (when (and (or (erc-buffer-visible (current-buffer))
962 (and this-channel
963 (member this-channel erc-track-exclude)))
964 (assq (current-buffer) erc-modified-channels-alist))
965 ;; Remove it from mode-line if buffer is visible or
966 ;; channel was added to erc-track-exclude recently.
967 (erc-modified-channels-remove-buffer (current-buffer))
968 (erc-modified-channels-display)))))
970 (defun erc-faces-in (str)
971 "Return a list of all faces used in STR."
972 (let ((i 0)
973 (m (length str))
974 (faces (erc-list (get-text-property 0 'face str)))
975 cur)
976 (while (and (setq i (next-single-property-change i 'face str m))
977 (not (= i m)))
978 (and (setq cur (get-text-property i 'face str))
979 (not (member cur faces))
980 (push cur faces)))
981 faces))
983 (cl-assert
984 (let ((str "is bold"))
985 (put-text-property 3 (length str)
986 'face '(bold erc-current-nick-face)
987 str)
988 (erc-faces-in str)))
990 ;;; Buffer switching
992 (defvar erc-track-last-non-erc-buffer nil
993 "Stores the name of the last buffer you were in before activating
994 `erc-track-switch-buffers'")
996 (defun erc-track-sort-by-activest ()
997 "Sort erc-modified-channels-alist by activity.
998 That means the number of unseen messages in a channel."
999 (setq erc-modified-channels-alist
1000 (sort erc-modified-channels-alist
1001 (lambda (a b) (> (nth 1 a) (nth 1 b))))))
1003 (defun erc-track-face-priority (face)
1004 "Return a number indicating the priority of FACE in
1005 `erc-track-faces-priority-list'. Lower number means higher
1006 priority.
1008 If face is not in `erc-track-faces-priority-list', it will have a
1009 higher number than any other face in that list."
1010 (let ((count 0))
1011 (catch 'done
1012 (dolist (item erc-track-faces-priority-list)
1013 (if (equal item face)
1014 (throw 'done t)
1015 (setq count (1+ count)))))
1016 count))
1018 (defun erc-track-sort-by-importance ()
1019 "Sort erc-modified-channels-alist by importance.
1020 That means the position of the face in `erc-track-faces-priority-list'."
1021 (setq erc-modified-channels-alist
1022 (sort erc-modified-channels-alist
1023 (lambda (a b) (< (erc-track-face-priority (cddr a))
1024 (erc-track-face-priority (cddr b)))))))
1026 (defun erc-track-get-active-buffer (arg)
1027 "Return the buffer name of ARG in `erc-modified-channels-alist'.
1028 Negative arguments index in the opposite direction. This direction is
1029 relative to `erc-track-switch-direction'"
1030 (let ((dir erc-track-switch-direction)
1031 offset)
1032 (when (< arg 0)
1033 (setq dir (pcase dir
1034 (`oldest 'newest)
1035 (`newest 'oldest)
1036 (`mostactive 'leastactive)
1037 (`leastactive 'mostactive)
1038 (`importance 'oldest)))
1039 (setq arg (- arg)))
1040 (setq offset (pcase dir
1041 ((or `oldest `leastactive)
1042 (- (length erc-modified-channels-alist) arg))
1043 (_ (1- arg))))
1044 ;; normalize out of range user input
1045 (cond ((>= offset (length erc-modified-channels-alist))
1046 (setq offset (1- (length erc-modified-channels-alist))))
1047 ((< offset 0)
1048 (setq offset 0)))
1049 (car (nth offset erc-modified-channels-alist))))
1051 (defun erc-track-switch-buffer (arg)
1052 "Switch to the next active ERC buffer, or if there are no active buffers,
1053 switch back to the last non-ERC buffer visited. Next is defined by
1054 `erc-track-switch-direction', a negative argument will reverse this."
1055 (interactive "p")
1056 (if (not erc-track-mode)
1057 (message (concat "Enable the ERC track module if you want to use the"
1058 " tracking minor mode"))
1059 (cond (erc-modified-channels-alist
1060 ;; if we're not in erc-mode, set this buffer to return to
1061 (unless (eq major-mode 'erc-mode)
1062 (setq erc-track-last-non-erc-buffer (current-buffer)))
1063 ;; and jump to the next active channel
1064 (switch-to-buffer (erc-track-get-active-buffer arg)))
1065 ;; if no active channels, switch back to what we were doing before
1066 ((and erc-track-last-non-erc-buffer
1067 erc-track-switch-from-erc
1068 (buffer-live-p erc-track-last-non-erc-buffer))
1069 (switch-to-buffer erc-track-last-non-erc-buffer)))))
1071 (provide 'erc-track)
1073 ;;; erc-track.el ends here
1075 ;; Local Variables:
1076 ;; indent-tabs-mode: t
1077 ;; tab-width: 8
1078 ;; End: