bf2831011450484b70d2f3d2b1385dea8b24d4b4
[riece] / lisp / riece-message.el
1 ;;; riece-message.el --- generate and display message line
2 ;; Copyright (C) 1999-2003 Daiki Ueno
3
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Keywords: message
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 ;;; Code:
25
26 (eval-when-compile (require 'riece-inlines))
27
28 (require 'riece-identity)
29 (require 'riece-channel)
30 (require 'riece-user)
31 (require 'riece-display)
32 (require 'riece-misc)
33
34 (defgroup riece-message nil
35   "Messages"
36   :tag "Message"
37   :prefix "riece-"
38   :group 'riece)
39
40 (defcustom riece-message-make-open-bracket-function
41   #'riece-message-make-open-bracket
42   "Function which makes `open-bracket' string for each message."
43   :type 'function
44   :group 'riece-message)
45
46 (defcustom riece-message-make-close-bracket-function
47   #'riece-message-make-close-bracket
48   "Function which makes `close-bracket' string for each message."
49   :type 'function
50   :group 'riece-message)
51
52 (defcustom riece-message-make-name-function
53   #'riece-message-make-name
54   "Function which makes local identity for each message."
55   :type 'function
56   :group 'riece-message)
57
58 (defcustom riece-message-make-global-name-function
59   #'riece-message-make-global-name
60   "Function which makes global identity for each message."
61   :type 'function
62   :group 'riece-message)
63
64 (defun riece-message-make-open-bracket (message)
65   "Makes `open-bracket' string for MESSAGE."
66   (if (riece-message-own-p message)
67       ">"
68     (if (eq (riece-message-type message) 'notice)
69         "{"
70       (if (riece-message-private-p message)
71           "="
72         (if (riece-message-external-p message)
73             "("
74           "<")))))
75
76 (defun riece-message-make-close-bracket (message)
77   "Makes `close-bracket' string for MESSAGE."
78   (if (riece-message-own-p message)
79       "<"
80     (if (eq (riece-message-type message) 'notice)
81         "}"
82       (if (riece-message-private-p message)
83           "="
84         (if (riece-message-external-p message)
85             ")"
86           ">")))))
87
88 (defun riece-message-make-name (message)
89   "Makes local identity for MESSAGE."
90   (riece-identity-prefix
91    (if (and (riece-message-private-p message)
92             (riece-message-own-p message))
93        (riece-message-target message)
94      (riece-message-speaker message))))
95
96 (defun riece-message-make-global-name (message)
97   "Makes global identity for MESSAGE."
98   (if (riece-message-private-p message)
99       (if (riece-message-own-p message)
100           (riece-identity-prefix (riece-message-target message))
101         (riece-identity-prefix (riece-message-speaker message)))
102     (concat (riece-identity-prefix (riece-message-target message)) ":"
103             (riece-identity-prefix (riece-message-speaker message)))))
104
105 (defun riece-message-buffer (message)
106   "Return the buffer where MESSAGE should appear."
107   (let* ((target (if (riece-identity-equal
108                       (riece-message-target message)
109                       (riece-current-nickname))
110                      (riece-message-speaker message)
111                    (riece-message-target message)))
112          (entry (riece-identity-assoc target riece-channel-buffer-alist)))
113     (unless entry
114       (riece-join-channel target)
115       ;; If you are not joined any channel,
116       ;; switch to the target immediately.
117       (unless riece-current-channel
118         (riece-switch-to-channel target))
119       (riece-redisplay-buffers)
120       (setq entry (riece-identity-assoc target riece-channel-buffer-alist)))
121     (cdr entry)))
122
123 (defun riece-message-parent-buffers (message buffer)
124   "Return the parents of BUFFER where MESSAGE should appear.
125 Normally they are *Dialogue* and/or *Others*."
126   (if (or (and buffer (riece-frozen buffer))
127           (and riece-current-channel
128                (not (riece-identity-equal
129                      (riece-message-target message)
130                      riece-current-channel))))
131       (list riece-dialogue-buffer riece-others-buffer)
132     riece-dialogue-buffer))
133
134 (defun riece-display-message (message)
135   "Display MESSAGE object."
136   (let ((open-bracket
137          (funcall riece-message-make-open-bracket-function message))
138         (close-bracket
139          (funcall riece-message-make-close-bracket-function message))
140         (name
141          (funcall riece-message-make-name-function message))
142         (global-name
143          (funcall riece-message-make-global-name-function message))
144         (buffer (riece-message-buffer message))
145         parent-buffers)
146     (when (and buffer
147                (riece-message-own-p message)
148                (riece-own-frozen buffer))
149       (with-current-buffer buffer
150         (setq riece-freeze nil))
151       (riece-update-status-indicators))
152     (setq parent-buffers (riece-message-parent-buffers message buffer))
153     (riece-insert buffer
154                   (concat open-bracket name close-bracket
155                           " " (riece-message-text message) "\n"))
156     (riece-insert parent-buffers
157                   (concat
158                    (riece-concat-server-name
159                     (concat open-bracket global-name close-bracket
160                             " " (riece-message-text message)))
161                    "\n"))
162     (run-hook-with-args 'riece-after-display-message-functions message)))
163
164 (defun riece-make-message (speaker target text &optional type own-p)
165   "Make an instance of message object.
166 Arguments are appropriate to the sender, the receiver, and text
167 content, respectively.
168 Optional 4th argument TYPE specifies the type of the message.
169 Currently possible values are `action' and `notice'.
170 Optional 5th argument is the flag to indicate that this message is not
171 from the network."
172   (vector speaker target text type own-p))
173
174 (defun riece-message-speaker (message)
175   "Return the sender of MESSAGE."
176   (aref message 0))
177
178 (defun riece-message-target (message)
179   "Return the receiver of MESSAGE."
180   (aref message 1))
181
182 (defun riece-message-text (message)
183   "Return the text part of MESSAGE."
184   (aref message 2))
185
186 (defun riece-message-type (message)
187   "Return the type of MESSAGE.
188 Currently possible values are `action' and `notice'."
189   (aref message 3))
190
191 (defun riece-message-own-p (message)
192   "Return t if MESSAGE is not from the network."
193   (aref message 4))
194
195 (defun riece-message-private-p (message)
196   "Return t if MESSAGE is a private message."
197   (if (riece-message-own-p message)
198       (not (riece-channel-p (riece-message-target message)))
199     (riece-identity-equal
200      (riece-message-target message)
201      (riece-current-nickname))))
202
203 (defun riece-message-external-p (message)
204   "Return t if MESSAGE is from outside the channel."
205   (not (riece-identity-member
206         (riece-message-target message)
207         (mapcar #'riece-make-identity
208                 (riece-user-get-channels (riece-message-speaker message))))))
209
210 (defun riece-own-channel-message (message &optional channel type)
211   "Display MESSAGE as you sent to CHNL."
212   (riece-display-message
213    (riece-make-message (riece-current-nickname)
214                        (or channel riece-current-channel)
215                        message type t)))
216
217 (provide 'riece-message)
218
219 ;;; riece-message.el ends here