* riece-ignore.el (riece-ignore-buffer-name): New user option.
[riece] / lisp / riece-history.el
1 ;;; riece-history.el --- channel history management add-on
2 ;; Copyright (C) 1998-2003 Daiki Ueno
3
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Keywords: IRC, riece
6
7 ;; This file is part of Riece.
8
9 ;; This program is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; This program is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 ;; GNU General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
23
24 ;;; Commentary:
25
26 ;; You can check recently visited channels via `C-c g' in the commands
27 ;; buffer, by adding the following lines to ~/.riece/init.el:
28
29 ;;   (add-hook 'riece-guess-channel-try-functions
30 ;;             'riece-guess-channel-from-history)
31
32 ;;; Code:
33
34 (require 'riece-options)
35 (require 'riece-globals)
36 (require 'riece-highlight)
37 (require 'riece-identity)
38 (require 'ring)
39
40 (defgroup riece-history nil
41   "Channel history"
42   :tag "History"
43   :prefix "riece-"
44   :group 'riece)
45
46 (defcustom riece-channel-history-length 3
47   "Length of riece-channel-history."
48   :type 'integer
49   :group 'riece-history)
50
51 (defface riece-channel-list-history-face
52   '((((class color)
53       (background dark))
54      (:foreground "PaleTurquoise"))
55     (((class color)
56       (background light))
57      (:foreground "SeaGreen3"))
58     (t
59      (:bold t)))
60   "Face used for displaying history channels."
61   :group 'riece-highlight-faces)
62 (defvar riece-channel-list-history-face 'riece-channel-list-history-face)
63
64 (defvar riece-channel-history nil)
65
66 (defun riece-guess-channel-from-history ()
67   (let ((length (ring-length riece-channel-history))
68         (index 0)
69         result)
70     (while (< index length)
71       (setq result (cons (ring-ref riece-channel-history index) result)
72             index (1+ index)))
73     (nreverse result)))
74
75 (defun riece-history-format-identity-for-channel-list-buffer (index identity)
76   (if (and (not (ring-empty-p riece-channel-history))
77            (riece-identity-equal identity (ring-ref riece-channel-history 0)))
78       (concat (format "%2d:+" index)
79               (riece-format-identity identity))))
80
81 (defun riece-history-format-identity-for-channel-list-indicator (index
82                                                                  identity)
83   (if (and (not (ring-empty-p riece-channel-history))
84            (riece-identity-equal identity (ring-ref riece-channel-history 0)))
85       (let ((string (riece-format-identity identity))
86             (start 0))
87         ;; Escape % -> %%.
88         (while (string-match "%" string start)
89           (setq start (1+ (match-end 0))
90                 string (replace-match "%%" nil nil string)))
91         (list (format "%d:" index)
92               (riece-propertize-modeline-string
93                string 'face 'riece-channel-list-history-face)))))
94
95 ;;; (defun riece-history-requires ()
96 ;;;   (if (memq 'riece-guess riece-addons)
97 ;;;       '(riece-guess)))
98
99 (defun riece-history-insinuate ()
100   (add-hook 'riece-startup-hook
101             (lambda ()
102               (setq riece-channel-history
103                     (make-ring riece-channel-history-length))))
104   (add-hook 'riece-exit-hook
105             (lambda ()
106               (setq riece-channel-history nil)))
107   (add-hook 'riece-after-switch-to-channel-functions
108             (lambda (last)
109               (if (and last
110                        (not (riece-identity-equal last riece-current-channel)))
111                   (ring-insert riece-channel-history last))))
112   (add-hook 'riece-format-identity-for-channel-list-buffer-functions
113             'riece-history-format-identity-for-channel-list-buffer)
114   (add-hook 'riece-format-identity-for-channel-list-indicator-functions
115             'riece-history-format-identity-for-channel-list-indicator)
116   (if (memq 'riece-highlight riece-addons)
117       (setq riece-channel-list-mark-face-alist
118             (cons '(?+ . riece-channel-list-history-face)
119                   riece-channel-list-mark-face-alist)))
120 ;;;  (if (memq 'riece-guess riece-addons)
121 ;;;      (add-hook 'riece-guess-channel-try-functions
122 ;;;             'riece-guess-channel-from-history))
123   )
124
125 (provide 'riece-history)
126
127 ;;; riece-history.el ends here
128