* lisp/printing.el (pr-menu-bind): Doc fix.

[emacs.git] / lisp / erc / erc-track.el

;;; erc-track.el --- Track modified channel buffers

;; Copyright (C) 2002, 2003, 2004, 2005, 2006,
;;   2007, 2008, 2009, 2010 Free Software Foundation, Inc.

;; Author: Mario Lang <mlang@delysid.org>
;; Keywords: comm, faces
;; URL: http://www.emacswiki.org/cgi-bin/wiki.pl?ErcChannelTracking

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; Highlights keywords and pals (friends), and hides or highlights fools
;; (using a dark color).  Add to your ~/.emacs:

;; (require 'erc-track)
;; (erc-track-mode 1)

;; Todo:
;; * Add extensibility so that custom functions can track
;;   custom modification types.

(eval-when-compile (require 'cl))
(require 'erc)
(require 'erc-compat)
(require 'erc-match)

;;; Code:

(defgroup erc-track nil
  "Track active buffers and show activity in the modeline."
  :group 'erc)

(defcustom erc-track-enable-keybindings 'ask
  "Whether to enable the ERC track keybindings, namely:
`C-c C-SPC' and `C-c C-@', which both do the same thing.

The default is to check to see whether these keys are used
already: if not, then enable the ERC track minor mode, which
provides these keys.  Otherwise, do not touch the keys.

This can alternatively be set to either t or nil, which indicate
respectively always to enable ERC track minor mode or never to
enable ERC track minor mode.

The reason for using this default value is to both (1) adhere to
the Emacs development guidelines which say not to touch keys of
the form C-c C-<something> and also (2) to meet the expectations
of long-time ERC users, many of whom rely on these keybindings."
  :group 'erc-track
  :type '(choice (const :tag "Ask, if used already" ask)
                 (const :tag "Enable" t)
                 (const :tag "Disable" nil)))

(defcustom erc-track-visibility t
  "Where do we look for buffers to determine their visibility?
The value of this variable determines, when a buffer is considered
visible or invisible.  New messages in invisible buffers are tracked,
while switching to visible buffers when they are tracked removes them
from the list.  See also `erc-track-when-inactive'.

Possible values are:

t                - all frames
visible          - all visible frames
nil              - only the selected frame
selected-visible - only the selected frame if it is visible

Activity means that there was no user input in the last 10 seconds."
  :group 'erc-track
  :type  '(choice (const :tag "All frames" t)
                  (const :tag "All visible frames" visible)
                  (const :tag "Only the selected frame" nil)
                  (const :tag "Only the selected frame if it was active"
                         active)))

(defcustom erc-track-exclude nil
  "A list targets (channel names or query targets) which should not be tracked."
  :group 'erc-track
  :type '(repeat string))

(defcustom erc-track-remove-disconnected-buffers nil
  "*If true, remove buffers associated with a server that is
disconnected from `erc-modified-channels-alist'."
  :group 'erc-track
  :type 'boolean)

(defcustom erc-track-exclude-types '("NICK" "333" "353")
  "*List of message types to be ignored.
This list could look like '(\"JOIN\" \"PART\").

By default, exclude changes of nicknames (NICK), display of who
set the channel topic (333), and listing of users on the current
channel (353)."
  :group 'erc-track
  :type 'erc-message-type)

(defcustom erc-track-exclude-server-buffer nil
  "*If true, don't perform tracking on the server buffer; this is
useful for excluding all the things like MOTDs from the server and
other miscellaneous functions."
  :group 'erc-track
  :type 'boolean)

(defcustom erc-track-shorten-start 1
  "This number specifies the minimum number of characters a channel name in
the mode-line should be reduced to."
  :group 'erc-track
  :type 'number)

(defcustom erc-track-shorten-cutoff 4
  "All channel names longer than this value will be shortened."
  :group 'erc-track
  :type 'number)

(defcustom erc-track-shorten-aggressively nil
  "*If non-nil, channel names will be shortened more aggressively.
Usually, names are not shortened if this will save only one character.
Example: If there are two channels, #linux-de and #linux-fr, then
normally these will not be shortened.  When shortening aggressively,
however, these will be shortened to #linux-d and #linux-f.

If this variable is set to `max', then channel names will be shortened
to the max.  Usually, shortened channel names will remain unique for a
given set of existing channels.  When shortening to the max, the shortened
channel names will be unique for the set of active channels only.
Example: If there are two active channels #emacs and #vi, and two inactive
channels #electronica and #folk, then usually the active channels are
shortened to #em and #v.  When shortening to the max, however, #emacs is
not compared to #electronica -- only to #vi, therefore it can be shortened
even more and the result is #e and #v.

This setting is used by `erc-track-shorten-names'."
  :group 'erc-track
  :type '(choice (const :tag "No" nil)
                 (const :tag "Yes" t)
                 (const :tag "Max" max)))

(defcustom erc-track-shorten-function 'erc-track-shorten-names
  "*This function will be used to reduce the channel names before display.
It takes one argument, CHANNEL-NAMES which is a list of strings.
It should return a list of strings of the same number of elements.
If nil instead of a function, shortening is disabled."
  :group 'erc-track
  :type '(choice (const :tag "Disabled")
                 function))

(defcustom erc-track-list-changed-hook nil
  "Hook that is run whenever the contents of
`erc-modified-channels-alist' changes.

This is useful for people that don't use the default mode-line
notification but instead use a separate mechanism to provide
notification of channel activity."
  :group 'erc-track
  :type 'hook)

(defcustom erc-track-use-faces t
  "*Use faces in the mode-line.
The faces used are the same as used for text in the buffers.
\(e.g. `erc-pal-face' is used if a pal sent a message to that channel.)"
  :group 'erc-track
  :type 'boolean)

(defcustom erc-track-faces-priority-list
  '(erc-error-face
    (erc-nick-default-face erc-current-nick-face)
    erc-current-nick-face
    erc-keyword-face
    (erc-nick-default-face erc-pal-face)
    erc-pal-face
    erc-nick-msg-face
    erc-direct-msg-face
    (erc-button erc-default-face)
    (erc-nick-default-face erc-dangerous-host-face)
    erc-dangerous-host-face
    erc-nick-default-face
    (erc-nick-default-face erc-default-face)
    erc-default-face
    erc-action-face
    (erc-nick-default-face erc-fool-face)
    erc-fool-face
    erc-notice-face
    erc-input-face
    erc-prompt-face)
  "A list of faces used to highlight active buffer names in the modeline.
If a message contains one of the faces in this list, the buffer name will
be highlighted using that face.  The first matching face is used."
  :group 'erc-track
  :type '(repeat (choice face
                         (repeat :tag "Combination" face))))

(defcustom erc-track-priority-faces-only nil
  "Only track text highlighted with a priority face.
If you would like to ignore changes in certain channels where there
are no faces corresponding to your `erc-track-faces-priority-list', set
this variable.  You can set a list of channel name strings, so those
will be ignored while all other channels will be tracked as normal.
Other options are 'all, to apply this to all channels or nil, to disable
this feature.

Note: If you have a lot of faces listed in `erc-track-faces-priority-list',
setting this variable might not be very useful."
  :group 'erc-track
  :type '(choice (const nil)
                 (repeat string)
                 (const all)))

(defcustom erc-track-faces-normal-list
  '((erc-button erc-default-face)
    (erc-nick-default-face erc-dangerous-host-face)
    erc-dangerous-host-face
    erc-nick-default-face
    (erc-nick-default-face erc-default-face)
    erc-default-face
    erc-action-face)
  "A list of faces considered to be part of normal conversations.
This list is used to highlight active buffer names in the modeline.

If a message contains one of the faces in this list, and the
previous modeline face for this buffer is also in this list, then
the buffer name will be highlighted using the face from the
message.  This gives a rough indication that active conversations
are occurring in these channels.

The effect may be disabled by setting this variable to nil."
  :group 'erc-track
  :type '(repeat (choice face
                         (repeat :tag "Combination" face))))

(defcustom erc-track-position-in-mode-line 'before-modes
  "Where to show modified channel information in the mode-line.

Setting this variable only has effects in GNU Emacs versions above 21.3.

Choices are:
'before-modes - add to the beginning of `mode-line-modes',
'after-modes  - add to the end of `mode-line-modes',
t             - add to the end of `global-mode-string',
nil           - don't add to mode line."
  :group 'erc-track
  :type '(choice (const :tag "Just before mode information" before-modes)
                 (const :tag "Just after mode information" after-modes)
                 (const :tag "After all other information" t)
                 (const :tag "Don't display in mode line" nil))
  :set (lambda (sym val)
         (set sym val)
         (when (and (boundp 'erc-track-mode)
                    erc-track-mode)
           (erc-track-remove-from-mode-line)
           (erc-track-add-to-mode-line val))))

(defun erc-modified-channels-object (strings)
  "Generate a new `erc-modified-channels-object' based on STRINGS.
If STRINGS is nil, we initialize `erc-modified-channels-object' to
an appropriate initial value for this flavor of Emacs."
  (if strings
      (if (featurep 'xemacs)
          (let ((e-m-c-s '("[")))
            (push (cons (extent-at 0 (car strings)) (car strings))
                  e-m-c-s)
            (dolist (string (cdr strings))
              (push "," e-m-c-s)
              (push (cons (extent-at 0 string) string)
                    e-m-c-s))
            (push "] " e-m-c-s)
            (reverse e-m-c-s))
        (concat (if (eq erc-track-position-in-mode-line 'after-modes)
                    "[" " [")
                (mapconcat 'identity (nreverse strings) ",")
                (if (eq erc-track-position-in-mode-line 'before-modes)
                    "] " "]")))
    (if (featurep 'xemacs) '() "")))

(defvar erc-modified-channels-object (erc-modified-channels-object nil)
  "Internal object used for displaying modified channels in the mode line.")

(put 'erc-modified-channels-object 'risky-local-variable t); allow properties

(defvar erc-modified-channels-alist nil
  "An ALIST used for tracking channel modification activity.
Each element looks like (BUFFER COUNT FACE) where BUFFER is a buffer
object of the channel the entry corresponds to, COUNT is a number
indicating how often activity was noticed, and FACE is the face to use
when displaying the buffer's name.  See `erc-track-faces-priority-list',
and `erc-track-showcount'.

Entries in this list should only happen for buffers where activity occurred
while the buffer was not visible.")

(defcustom erc-track-showcount nil
  "If non-nil, count of unseen messages will be shown for each channel."
  :type 'boolean
  :group 'erc-track)

(defcustom erc-track-showcount-string ":"
  "The string to display between buffer name and the count in the mode line.
The default is a colon, resulting in \"#emacs:9\"."
  :type 'string
  :group 'erc-track)

(defcustom erc-track-switch-from-erc t
  "If non-nil, `erc-track-switch-buffer' will return to the last non-erc buffer
when there are no more active channels."
  :type 'boolean
  :group 'erc-track)

(defcustom erc-track-switch-direction 'oldest
  "Direction `erc-track-switch-buffer' should switch.

  importance  -  find buffer with the most important message
  oldest      -  find oldest active buffer
  newest      -  find newest active buffer
  leastactive -  find buffer with least unseen messages
  mostactive  -  find buffer with most unseen messages.

If set to 'importance, the importance is determined by position
in `erc-track-faces-priority-list', where first is most
important."
  :group 'erc-track
  :type '(choice (const importance)
                 (const oldest)
                 (const newest)
                 (const leastactive)
                 (const mostactive)))


(defun erc-track-remove-from-mode-line ()
  "Remove `erc-track-modified-channels' from the mode-line"
  (when (boundp 'mode-line-modes)
    (setq mode-line-modes
          (remove '(t erc-modified-channels-object) mode-line-modes)))
  (when (consp global-mode-string)
    (setq global-mode-string
          (delq 'erc-modified-channels-object global-mode-string))))

(defun erc-track-add-to-mode-line (position)
  "Add `erc-track-modified-channels' to POSITION in the mode-line.
See `erc-track-position-in-mode-line' for possible values."
  ;; CVS Emacs has a new format string, and global-mode-string
  ;; is very far to the right.
  (cond ((and (eq position 'before-modes)
              (boundp 'mode-line-modes))
         (add-to-list 'mode-line-modes
                      '(t erc-modified-channels-object)))
        ((and (eq position 'after-modes)
              (boundp 'mode-line-modes))
         (add-to-list 'mode-line-modes
                      '(t erc-modified-channels-object) t))
        ((eq position t)
         (when (not global-mode-string)
           (setq global-mode-string '(""))) ; Padding for mode-line wart
         (add-to-list 'global-mode-string
                      'erc-modified-channels-object
                      t))))

;;; Shortening of names

(defun erc-track-shorten-names (channel-names)
  "Call `erc-unique-channel-names' with the correct parameters.
This function is a good value for `erc-track-shorten-function'.
The list of all channels is returned by `erc-all-buffer-names'.
CHANNEL-NAMES is the list of active channel names.
Only channel names longer than `erc-track-shorten-cutoff' are
actually shortened, and they are only shortened to a minimum
of `erc-track-shorten-start' characters."
  (erc-unique-channel-names
   (erc-all-buffer-names)
   channel-names
   (lambda (s)
     (> (length s) erc-track-shorten-cutoff))
   erc-track-shorten-start))

(defvar erc-default-recipients)

(defun erc-all-buffer-names ()
  "Return all channel or query buffer names.
Note that we cannot use `erc-channel-list' with a nil argument,
because that does not return query buffers."
  (save-excursion
    (let (result)
      (dolist (buf (buffer-list))
        (set-buffer buf)
        (when (or (eq major-mode 'erc-mode) (eq major-mode 'erc-dcc-chat-mode))
          (setq result (cons (buffer-name) result))))
      result)))

(defun erc-unique-channel-names (all active &optional predicate start)
  "Return a list of unique channel names.
ALL is the list of all channel and query buffer names.
ACTIVE is the list of active buffer names.
PREDICATE is a predicate that should return non-nil if a name needs
  no shortening.
START is the minimum length of the name used."
  (if (eq 'max erc-track-shorten-aggressively)
      ;; Return the unique substrings of all active channels.
      (erc-unique-substrings active predicate start)
    ;; Otherwise, determine the unique substrings of all channels, and
    ;; for every active channel, return the corresponding substring.
    ;; Given the names of the active channels, we now need to find the
    ;; corresponding short name from the list of all substrings.  To
    ;; avoid problems when there are two channels and one is a
    ;; substring of the other (notorious examples are #hurd and
    ;; #hurd-bunny), every candidate gets the longest possible
    ;; substring.
    (let ((all-substrings (sort
                           (erc-unique-substrings all predicate start)
                           (lambda (a b) (> (length a) (length b)))))
          result)
      (dolist (channel active)
        (let ((substrings all-substrings)
              candidate
              winner)
          (while (and substrings (not winner))
            (setq candidate (car substrings)
                  substrings (cdr substrings))
            (when (and (string= candidate
                                (substring channel
                                           0
                                           (min (length candidate)
                                                (length channel))))
                       (not (member candidate result)))
              (setq winner candidate)))
          (setq result (cons winner result))))
      (nreverse result))))

(defun erc-unique-substrings (strings &optional predicate start)
  "Return a list of unique substrings of STRINGS."
  (if (or (not (numberp start))
          (< start 0))
      (setq start 2))
  (mapcar
   (lambda (str)
     (let* ((others (delete str (copy-sequence strings)))
            (maxlen (length str))
            (i (min start
                    (length str)))
            candidate
            done)
       (if (and (functionp predicate) (not (funcall predicate str)))
           ;; do not shorten if a predicate exists and it returns nil
           str
         ;; Start with smallest substring candidate, ie. length 1.
         ;; Then check all the others and see whether any of them starts
         ;; with the same substring.  While there is such another
         ;; element in the list, increase the length of the candidate.
         (while (not done)
           (if (> i maxlen)
               (setq done t)
             (setq candidate (substring str 0 i)
                   done (not (erc-unique-substring-1 candidate others))))
           (setq i (1+ i)))
         (if (and (= (length candidate) (1- maxlen))
                  (not erc-track-shorten-aggressively))
             str
           candidate))))
   strings))

(defun erc-unique-substring-1 (candidate others)
  "Return non-nil when any string in OTHERS starts with CANDIDATE."
  (let (result other (maxlen (length candidate)))
    (while (and others
                (not result))
      (setq other (car others)
            others (cdr others))
      (when (and (>= (length other) maxlen)
                 (string= candidate (substring other 0 maxlen)))
        (setq result other)))
    result))

;;; Test:

(assert
 (and
  ;; verify examples from the doc strings
  (equal (let ((erc-track-shorten-aggressively nil))
           (erc-unique-channel-names
            '("#emacs" "#vi" "#electronica" "#folk")
            '("#emacs" "#vi")))
         '("#em" "#vi"))         ; emacs is different from electronica
  (equal (let ((erc-track-shorten-aggressively t))
           (erc-unique-channel-names
            '("#emacs" "#vi" "#electronica" "#folk")
            '("#emacs" "#vi")))
         '("#em" "#v"))                ; vi is shortened by one letter
  (equal (let ((erc-track-shorten-aggressively 'max))
           (erc-unique-channel-names
            '("#emacs" "#vi" "#electronica" "#folk")
            '("#emacs" "#vi")))
         '("#e" "#v"))  ; emacs need not be different from electronica
  (equal (let ((erc-track-shorten-aggressively nil))
           (erc-unique-channel-names
            '("#linux-de" "#linux-fr")
            '("#linux-de" "#linux-fr")))
         '("#linux-de" "#linux-fr")) ; shortening by one letter is too aggressive
  (equal (let ((erc-track-shorten-aggressively t))
           (erc-unique-channel-names
            '("#linux-de" "#linux-fr")
            '("#linux-de" "#linux-fr")))
         '("#linux-d" "#linux-f")); now we want to be aggressive
  ;; specific problems
  (equal (let ((erc-track-shorten-aggressively nil))
           (erc-unique-channel-names
            '("#dunnet" "#lisp" "#sawfish" "#fsf" "#guile"
              "#testgnome" "#gnu" "#fsbot" "#hurd" "#hurd-bunny"
              "#emacs")
            '("#hurd-bunny" "#hurd" "#sawfish" "#lisp")))
         '("#hurd-" "#hurd" "#s" "#l"))
  (equal (let ((erc-track-shorten-aggressively nil))
           (erc-unique-substrings
            '("#emacs" "#vi" "#electronica" "#folk")))
         '("#em" "#vi" "#el" "#f"))
  (equal (let ((erc-track-shorten-aggressively t))
           (erc-unique-substrings
            '("#emacs" "#vi" "#electronica" "#folk")))
         '("#em" "#v" "#el" "#f"))
  (equal (let ((erc-track-shorten-aggressively nil))
           (erc-unique-channel-names
            '("#emacs" "#burse" "+linux.de" "#starwars"
              "#bitlbee" "+burse" "#ratpoison")
            '("+linux.de" "#starwars" "#burse")))
         '("+l" "#s" "#bu"))
  (equal (let ((erc-track-shorten-aggressively nil))
           (erc-unique-channel-names
            '("fsbot" "#emacs" "deego")
            '("fsbot")))
         '("fs"))
  (equal (let ((erc-track-shorten-aggressively nil))
           (erc-unique-channel-names
            '("fsbot" "#emacs" "deego")
            '("fsbot")
            (lambda (s)
              (> (length s) 4))
            1))
         '("f"))
  (equal (let ((erc-track-shorten-aggressively nil))
           (erc-unique-channel-names
            '("fsbot" "#emacs" "deego")
            '("fsbot")
            (lambda (s)
              (> (length s) 4))
            2))
         '("fs"))
  (let ((erc-track-shorten-aggressively nil))
    (equal (erc-unique-channel-names '("deego" "#hurd" "#hurd-bunny" "#emacs")
                                     '("#hurd" "#hurd-bunny"))
           '("#hurd" "#hurd-")))
  ;; general examples
  (let ((erc-track-shorten-aggressively t))
    (and (equal (erc-unique-substring-1 "abc" '("ab" "abcd")) "abcd")
         (not (erc-unique-substring-1 "a" '("xyz" "xab")))
         (equal (erc-unique-substrings '("abc" "xyz" "xab"))
                '("ab" "xy" "xa"))
         (equal (erc-unique-substrings '("abc" "abcdefg"))
                '("abc" "abcd"))))
  (let ((erc-track-shorten-aggressively nil))
    (and (equal (erc-unique-substring-1 "abc" '("ab" "abcd")) "abcd")
         (not (erc-unique-substring-1 "a" '("xyz" "xab")))
         (equal (erc-unique-substrings '("abc" "xyz" "xab"))
                '("abc" "xyz" "xab"))
         (equal (erc-unique-substrings '("abc" "abcdefg"))
                '("abc" "abcd"))))))

;;; Minor mode

;; Play nice with other IRC clients (and Emacs development rules) by
;; making this a minor mode

(defvar erc-track-minor-mode-map (make-sparse-keymap)
  "Keymap for rcirc track minor mode.")

(define-key erc-track-minor-mode-map (kbd "C-c C-@") 'erc-track-switch-buffer)
(define-key erc-track-minor-mode-map (kbd "C-c C-SPC")
  'erc-track-switch-buffer)

;;;###autoload
(define-minor-mode erc-track-minor-mode
  "Global minor mode for tracking ERC buffers and showing activity in the
mode line.

This exists for the sole purpose of providing the C-c C-SPC and
C-c C-@ keybindings.  Make sure that you have enabled the track
module, otherwise the keybindings will not do anything useful."
  :init-value nil
  :lighter ""
  :keymap erc-track-minor-mode-map
  :global t
  :group 'erc-track)

(defun erc-track-minor-mode-maybe (&optional buffer)
  "Enable `erc-track-minor-mode', depending on `erc-track-enable-keybindings'."
  (when (and (not erc-track-minor-mode)
             ;; don't start the minor mode until we have an ERC
             ;; process running, because we don't want to prompt the
             ;; user while starting Emacs
             (or (and (buffer-live-p buffer)
                      (with-current-buffer buffer (eq major-mode 'erc-mode)))
                 (erc-buffer-list)))
    (cond ((eq erc-track-enable-keybindings 'ask)
           (let ((key (or (and (key-binding (kbd "C-c C-SPC")) "C-SPC")
                          (and (key-binding (kbd "C-c C-@")) "C-@"))))
             (if key
                 (if (y-or-n-p
                      (concat "The C-c " key " binding is in use;"
                              " override it for tracking? "))
                     (progn
                       (message (concat "Will change it; set"
                                        " `erc-track-enable-keybindings'"
                                        " to disable this message"))
                       (sleep-for 3)
                       (erc-track-minor-mode 1))
                   (message (concat "Not changing it; set"
                                    " `erc-track-enable-keybindings'"
                                    " to disable this message"))
                   (sleep-for 3))
               (erc-track-minor-mode 1))))
          ((eq erc-track-enable-keybindings t)
           (erc-track-minor-mode 1))
          (t nil))))

;;; Module

;;;###autoload (autoload 'erc-track-mode "erc-track" nil t)
(define-erc-module track nil
  "This mode tracks ERC channel buffers with activity."
  ;; Enable:
  ((when (boundp 'erc-track-when-inactive)
     (if erc-track-when-inactive
         (progn
           (if (featurep 'xemacs)
               (defadvice switch-to-buffer (after erc-update-when-inactive
                                                  (&rest args) activate)
                 (erc-user-is-active))
             (add-hook 'window-configuration-change-hook 'erc-user-is-active))
           (add-hook 'erc-send-completed-hook 'erc-user-is-active)
           (add-hook 'erc-server-001-functions 'erc-user-is-active))
       (erc-track-add-to-mode-line erc-track-position-in-mode-line)
       (setq erc-modified-channels-object (erc-modified-channels-object nil))
       (erc-update-mode-line)
       (if (featurep 'xemacs)
           (defadvice switch-to-buffer (after erc-update (&rest args) activate)
             (erc-modified-channels-update))
         (add-hook 'window-configuration-change-hook
                   'erc-modified-channels-update))
       (add-hook 'erc-insert-post-hook 'erc-track-modified-channels)
       (add-hook 'erc-disconnected-hook 'erc-modified-channels-update))
     ;; enable the tracking keybindings
     (add-hook 'erc-connect-pre-hook 'erc-track-minor-mode-maybe)
     (erc-track-minor-mode-maybe)))
  ;; Disable:
  ((when (boundp 'erc-track-when-inactive)
     (erc-track-remove-from-mode-line)
     (if erc-track-when-inactive
         (progn
           (if (featurep 'xemacs)
               (ad-disable-advice 'switch-to-buffer 'after
                                  'erc-update-when-inactive)
             (remove-hook 'window-configuration-change-hook
                          'erc-user-is-active))
           (remove-hook 'erc-send-completed-hook 'erc-user-is-active)
           (remove-hook 'erc-server-001-functions 'erc-user-is-active)
           (remove-hook 'erc-timer-hook 'erc-user-is-active))
       (if (featurep 'xemacs)
           (ad-disable-advice 'switch-to-buffer 'after 'erc-update)
         (remove-hook 'window-configuration-change-hook
                      'erc-modified-channels-update))
       (remove-hook 'erc-disconnected-hook 'erc-modified-channels-update)
       (remove-hook 'erc-insert-post-hook 'erc-track-modified-channels))
     ;; disable the tracking keybindings
     (remove-hook 'erc-connect-pre-hook 'erc-track-minor-mode-maybe)
     (when erc-track-minor-mode
       (erc-track-minor-mode -1)))))

(defcustom erc-track-when-inactive nil
  "Enable channel tracking even for visible buffers, if you are
inactive."
  :group 'erc-track
  :type 'boolean
  :set (lambda (sym val)
         (if erc-track-mode
             (progn
               (erc-track-disable)
               (set sym val)
               (erc-track-enable))
           (set sym val))))

;;; Visibility

(defvar erc-buffer-activity nil
  "Last time the user sent something.")

(defvar erc-buffer-activity-timeout 10
  "How many seconds of inactivity by the user
to consider when `erc-track-visibility' is set to
only consider active buffers visible.")

(defun erc-user-is-active (&rest ignore)
  "Set `erc-buffer-activity'."
  (when erc-server-connected
    (setq erc-buffer-activity (erc-current-time))
    (erc-track-modified-channels)))

(defun erc-track-get-buffer-window (buffer frame-param)
  (if (eq frame-param 'selected-visible)
      (if (eq (frame-visible-p (selected-frame)) t)
          (get-buffer-window buffer nil)
        nil)
    (get-buffer-window buffer frame-param)))

(defun erc-buffer-visible (buffer)
  "Return non-nil when the buffer is visible."
  (if erc-track-when-inactive
      (when erc-buffer-activity; could be nil
        (and (erc-track-get-buffer-window buffer erc-track-visibility)
             (<= (erc-time-diff erc-buffer-activity (erc-current-time))
                 erc-buffer-activity-timeout)))
    (erc-track-get-buffer-window buffer erc-track-visibility)))

;;; Tracking the channel modifications

(defvar erc-modified-channels-update-inside nil
  "Variable to prevent running `erc-modified-channels-update' multiple
times.  Without it, you cannot debug `erc-modified-channels-display',
because the debugger also cases changes to the window-configuration.")

(defun erc-modified-channels-update (&rest args)
  "This function updates the information in `erc-modified-channels-alist'
according to buffer visibility.  It calls
`erc-modified-channels-display' at the end. This should usually be
called via `window-configuration-change-hook'.
ARGS are ignored."
  (interactive)
  (unless erc-modified-channels-update-inside
    (let ((erc-modified-channels-update-inside t)
          (removed-channel nil))
      (mapc (lambda (elt)
              (let ((buffer (car elt)))
                (when (or (not (bufferp buffer))
                          (not (buffer-live-p buffer))
                          (erc-buffer-visible buffer)
                          (and erc-track-remove-disconnected-buffers
                               (not (with-current-buffer buffer
                                      erc-server-connected))))
                  (setq removed-channel t)
                  (erc-modified-channels-remove-buffer buffer))))
            erc-modified-channels-alist)
      (when removed-channel
      (erc-modified-channels-display)
        (force-mode-line-update t)))))

(defvar erc-track-mouse-face (if (featurep 'xemacs)
                                 'modeline-mousable
                               'mode-line-highlight)
  "The face to use when mouse is over channel names in the mode line.")

(defun erc-make-mode-line-buffer-name (string buffer &optional faces count)
  "Return STRING as a button that switches to BUFFER when clicked.
If FACES are provided, color STRING with them."
  ;; We define a new sparse keymap every time, because 1. this data
  ;; structure is very small, the alternative would require us to
  ;; defvar a keymap, 2. the user is not interested in customizing it
  ;; (really?), 3. the defun needs to switch to BUFFER, so we would
  ;; need to save that value somewhere.
  (let ((map (make-sparse-keymap))
        (name (if erc-track-showcount
                  (concat string
                          erc-track-showcount-string
                          (int-to-string count))
                (copy-sequence string))))
    (define-key map (vector 'mode-line 'mouse-2)
      `(lambda (e)
         (interactive "e")
         (save-selected-window
           (select-window
            (posn-window (event-start e)))
           (switch-to-buffer ,buffer))))
    (define-key map (vector 'mode-line 'mouse-3)
      `(lambda (e)
         (interactive "e")
         (save-selected-window
           (select-window
            (posn-window (event-start e)))
           (switch-to-buffer-other-window ,buffer))))
    (put-text-property 0 (length name) 'local-map map name)
    (put-text-property
     0 (length name)
     'help-echo (concat "mouse-2: switch to buffer, "
                        "mouse-3: switch to buffer in other window")
     name)
    (put-text-property 0 (length name) 'mouse-face erc-track-mouse-face name)
    (when (and faces erc-track-use-faces)
      (put-text-property 0 (length name) 'face faces name))
    name))

(defun erc-modified-channels-display ()
  "Set `erc-modified-channels-object'
according to `erc-modified-channels-alist'.
Use `erc-make-mode-line-buffer-name' to create buttons."
  (cond ((or (eq 'mostactive erc-track-switch-direction)
             (eq 'leastactive erc-track-switch-direction))
         (erc-track-sort-by-activest))
        ((eq 'importance erc-track-switch-direction)
         (erc-track-sort-by-importance)))
  (run-hooks 'erc-track-list-changed-hook)
  (unless (eq erc-track-position-in-mode-line nil)
  (if (null erc-modified-channels-alist)
      (setq erc-modified-channels-object (erc-modified-channels-object nil))
    ;; erc-modified-channels-alist contains all the data we need.  To
    ;; better understand what is going on, we split things up into
    ;; four lists: BUFFERS, COUNTS, SHORT-NAMES, and FACES.  These
    ;; four lists we use to create a new
    ;; `erc-modified-channels-object' using
    ;; `erc-make-mode-line-buffer-name'.
    (let* ((buffers (mapcar 'car erc-modified-channels-alist))
           (counts (mapcar 'cadr erc-modified-channels-alist))
           (faces (mapcar 'cddr erc-modified-channels-alist))
           (long-names (mapcar #'(lambda (buf)
                                   (or (buffer-name buf)
                                       ""))
                               buffers))
           (short-names (if (functionp erc-track-shorten-function)
                            (funcall erc-track-shorten-function
                                     long-names)
                          long-names))
           strings)
      (while buffers
        (when (car short-names)
          (setq strings (cons (erc-make-mode-line-buffer-name
                               (car short-names)
                               (car buffers)
                               (car faces)
                               (car counts))
                              strings)))
        (setq short-names (cdr short-names)
              buffers (cdr buffers)
              counts (cdr counts)
              faces (cdr faces)))
      (when (featurep 'xemacs)
        (erc-modified-channels-object nil))
      (setq erc-modified-channels-object
            (erc-modified-channels-object strings))))))

(defun erc-modified-channels-remove-buffer (buffer)
  "Remove BUFFER from `erc-modified-channels-alist'."
  (interactive "bBuffer: ")
  (setq erc-modified-channels-alist
        (delete (assq buffer erc-modified-channels-alist)
                erc-modified-channels-alist))
  (when (interactive-p)
    (erc-modified-channels-display)))

(defun erc-track-find-face (faces)
  "Return the face to use in the modeline from the faces in FACES.
If `erc-track-faces-priority-list' is set, the one from FACES who
is first in that list will be used.  If nothing matches or if
`erc-track-faces-priority-list' is not set, the default mode-line
faces will be used.

If `erc-track-faces-normal-list' is non-nil, use it to produce a
blinking effect that indicates channel activity when the first
element in FACES and the highest-ranking face among the rest of
FACES are both members of `erc-track-faces-normal-list'.

If one of the faces is a list, then it will be ranked according
to its highest-tanking face member.  A list of faces including
that member will take priority over just the single member
element."
  (let ((choice (catch 'face
                  (dolist (candidate erc-track-faces-priority-list)
                    (when (member candidate faces)
                      (throw 'face candidate)))))
        (no-first (and erc-track-faces-normal-list
                       (catch 'face
                         (dolist (candidate erc-track-faces-priority-list)
                           (when (member candidate (cdr faces))
                             (throw 'face candidate)))))))
    (cond ((null choice)
           nil)
          ((and (member choice erc-track-faces-normal-list)
                (member no-first erc-track-faces-normal-list))
           no-first)
          (t
           choice))))

(defun erc-track-modified-channels ()
  "Hook function for `erc-insert-post-hook' to check if the current
buffer should be added to the modeline as a hidden, modified
channel.  Assumes it will only be called when current-buffer
is in `erc-mode'."
  (let ((this-channel (or (erc-default-target)
                          (buffer-name (current-buffer)))))
    (if (and (not (erc-buffer-visible (current-buffer)))
             (not (member this-channel erc-track-exclude))
             (not (and erc-track-exclude-server-buffer
                       (erc-server-buffer-p)))
             (not (erc-message-type-member
                   (or (erc-find-parsed-property)
                       (point-min))
                   erc-track-exclude-types)))
        ;; If the active buffer is not visible (not shown in a
        ;; window), and not to be excluded, determine the kinds of
        ;; faces used in the current message, and unless the user
        ;; wants to ignore changes in certain channels where there
        ;; are no faces corresponding to `erc-track-faces-priority-list',
        ;; and the faces in the current message are found in said
        ;; priority list, add the buffer to the erc-modified-channels-alist,
        ;; if it is not already there.  If the buffer is already on the list
        ;; (in the car), change its face attribute (in the cddr) if
        ;; necessary.  See `erc-modified-channels-alist' for the
        ;; exact data structure used.
        (let ((faces (erc-faces-in (buffer-string))))
          (unless (and
                   (or (eq erc-track-priority-faces-only 'all)
                       (member this-channel erc-track-priority-faces-only))
                   (not (catch 'found
                          (dolist (f faces)
                            (when (member f erc-track-faces-priority-list)
                              (throw 'found t))))))
            (if (not (assq (current-buffer) erc-modified-channels-alist))
                ;; Add buffer, faces and counts
                (setq erc-modified-channels-alist
                      (cons (cons (current-buffer)
                                  (cons 1 (erc-track-find-face faces)))
                            erc-modified-channels-alist))
              ;; Else modify the face for the buffer, if necessary.
              (when faces
                (let* ((cell (assq (current-buffer)
                                   erc-modified-channels-alist))
                       (old-face (cddr cell))
                       (new-face (erc-track-find-face
                                  (if old-face
                                      (cons old-face faces)
                                    faces))))
                  (setcdr cell (cons (1+ (cadr cell)) new-face)))))
            ;; And display it
            (erc-modified-channels-display)))
      ;; Else if the active buffer is the current buffer, remove it
      ;; from our list.
      (when (and (or (erc-buffer-visible (current-buffer))
                (and this-channel
                     (member this-channel erc-track-exclude)))
                 (assq (current-buffer) erc-modified-channels-alist))
        ;; Remove it from mode-line if buffer is visible or
        ;; channel was added to erc-track-exclude recently.
        (erc-modified-channels-remove-buffer (current-buffer))
        (erc-modified-channels-display)))))

(defun erc-faces-in (str)
  "Return a list of all faces used in STR."
  (let ((i 0)
        (m (length str))
        (faces (erc-list (get-text-property 0 'face str)))
        cur)
    (while (and (setq i (next-single-property-change i 'face str m))
                (not (= i m)))
      (when (setq cur (get-text-property i 'face str))
        (add-to-list 'faces cur)))
    faces))

(assert
 (let ((str "is bold"))
   (put-text-property 3 (length str)
                      'face '(bold erc-current-nick-face)
                      str)
   (erc-faces-in str)))

;;; Buffer switching

(defvar erc-track-last-non-erc-buffer nil
  "Stores the name of the last buffer you were in before activating
`erc-track-switch-buffers'")

(defun erc-track-sort-by-activest ()
  "Sort erc-modified-channels-alist by activity.
That means the number of unseen messages in a channel."
  (setq erc-modified-channels-alist
        (sort erc-modified-channels-alist
              (lambda (a b) (> (nth 1 a) (nth 1 b))))))

(defun erc-track-face-priority (face)
  "Return a number indicating the priority of FACE in
`erc-track-faces-priority-list'.  Lower number means higher
priority.

If face is not in `erc-track-faces-priority-list', it will have a
higher number than any other face in that list."
  (let ((count 0))
    (catch 'done
      (dolist (item erc-track-faces-priority-list)
        (if (equal item face)
            (throw 'done t)
          (setq count (1+ count)))))
    count))

(defun erc-track-sort-by-importance ()
  "Sort erc-modified-channels-alist by importance.
That means the position of the face in `erc-track-faces-priority-list'."
  (setq erc-modified-channels-alist
        (sort erc-modified-channels-alist
              (lambda (a b) (< (erc-track-face-priority (cddr a))
                               (erc-track-face-priority (cddr b)))))))

(defun erc-track-get-active-buffer (arg)
  "Return the buffer name of ARG in `erc-modified-channels-alist'.
Negative arguments index in the opposite direction.  This direction is
relative to `erc-track-switch-direction'"
  (let ((dir erc-track-switch-direction)
        offset)
    (when (< arg 0)
      (setq dir (case dir
                  (oldest      'newest)
                  (newest      'oldest)
                  (mostactive  'leastactive)
                  (leastactive 'mostactive)
                  (importance  'oldest)))
      (setq arg (- arg)))
    (setq offset (case dir
                   ((oldest leastactive)
                    (- (length erc-modified-channels-alist) arg))
                   (t (1- arg))))
    ;; normalise out of range user input
    (cond ((>= offset (length erc-modified-channels-alist))
           (setq offset (1- (length erc-modified-channels-alist))))
          ((< offset 0)
           (setq offset 0)))
    (car (nth offset erc-modified-channels-alist))))

(defun erc-track-switch-buffer (arg)
  "Switch to the next active ERC buffer, or if there are no active buffers,
switch back to the last non-ERC buffer visited.  Next is defined by
`erc-track-switch-direction', a negative argument will reverse this."
  (interactive "p")
  (if (not erc-track-mode)
      (message (concat "Enable the ERC track module if you want to use the"
                       " tracking minor mode"))
    (cond (erc-modified-channels-alist
           ;; if we're not in erc-mode, set this buffer to return to
           (unless (eq major-mode 'erc-mode)
             (setq erc-track-last-non-erc-buffer (current-buffer)))
           ;; and jump to the next active channel
           (switch-to-buffer (erc-track-get-active-buffer arg)))
          ;; if no active channels, switch back to what we were doing before
          ((and erc-track-last-non-erc-buffer
                erc-track-switch-from-erc
                (buffer-live-p erc-track-last-non-erc-buffer))
           (switch-to-buffer erc-track-last-non-erc-buffer)))))

(provide 'erc-track)

;;; erc-track.el ends here
;;
;; Local Variables:
;; indent-tabs-mode: t
;; tab-width: 8
;; End:

;; arch-tag: 11b439f5-e5d7-4c6c-bb3f-eda98f9b0ac1