7895d8b26c156ad1038ebd74daaa4065708b0481
[riece] / lisp / riece-channel.el
1 ;;; riece-channel.el --- a channel object
2 ;; Copyright (C) 1998-2003 Daiki Ueno
3
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Created: 1998-09-28
6 ;; Keywords: IRC, riece
7
8 ;; This file is part of Riece.
9
10 ;; This program is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; This program is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Code:
26
27 (require 'riece-options)
28 (require 'riece-identity)
29
30 ;;; String representation of a channel:
31 (defconst riece-channel-regexp "^[+&#!]")
32 (defconst riece-channel-modeless-regexp "^[+!]")
33
34 (defun riece-channel-p (string)
35   "Return t if STRING is a channel.
36 \(i.e. it matches `riece-channel-regexp')"
37   (string-match riece-channel-regexp string))
38
39 (defun riece-channel-modeless-p (string)
40   "Return t if STRING is a modeless channel.
41 \(i.e. it matches `riece-channel-modeless-regexp')"
42   (string-match riece-channel-modeless-regexp string))
43
44 ;;; Channel object:
45 (defun riece-find-channel (name)
46   "Get a channel object named NAME from the server buffer."
47   (riece-with-server-buffer
48    (let ((symbol (intern-soft (riece-identity-canonicalize-prefix
49                                (riece-identity-prefix name))
50                               riece-obarray)))
51      (if symbol
52          (symbol-value symbol)))))
53
54 (defun riece-forget-channel (name)
55   (riece-with-server-buffer
56    (let ((symbol (intern-soft (riece-identity-canonicalize-prefix
57                                (riece-identity-prefix name)))))
58      (when symbol
59        (makunbound symbol)
60        (unintern (symbol-name symbol) riece-obarray)))))
61
62 (defun riece-make-channel (&optional users operators speakers
63                                      topic modes banned invited uninvited
64                                      key)
65   "Make an instance of channel object.
66 Arguments are appropriate to channel users, operators, speakers
67 \(+v), topic, modes, banned users, invited users, uninvited users, and
68 the channel key, respectively."
69   (vector users operators speakers topic modes banned invited uninvited))
70
71 (defun riece-get-channel (name)
72   (riece-with-server-buffer
73    (let ((symbol (intern-soft (riece-identity-canonicalize-prefix
74                                (riece-identity-prefix name))
75                               riece-obarray)))
76      (if symbol
77          (symbol-value symbol)
78        (set (intern (riece-identity-canonicalize-prefix
79                      (riece-identity-prefix name))
80                     riece-obarray)
81             (riece-make-channel))))))
82
83 (defun riece-channel-users (channel)
84   "Return the users of CHANNEL."
85   (aref channel 0))
86
87 (defun riece-channel-operators (channel)
88   "Return the operators of CHANNEL."
89   (aref channel 1))
90
91 (defun riece-channel-speakers (channel)
92   "Return the speakers of CHANNEL."
93   (aref channel 2))
94
95 (defun riece-channel-topic (channel)
96   "Return the topic of CHANNEL."
97   (aref channel 3))
98
99 (defun riece-channel-modes (channel)
100   "Return the modes of CHANNEL."
101   (aref channel 4))
102
103 (defun riece-channel-banned (channel)
104   "Return the banned users of CHANNEL."
105   (aref channel 5))
106
107 (defun riece-channel-invited (channel)
108   "Return the invited users of CHANNEL."
109   (aref channel 6))
110
111 (defun riece-channel-uninvited (channel)
112   "Return the uninvited users of CHANNEL."
113   (aref channel 7))
114
115 (defun riece-channel-key (channel)
116   "Return the key of CHANNEL."
117   (aref channel 8))
118
119 (defun riece-channel-set-users (channel value)
120   "Set the users of CHANNEL to VALUE."
121   (aset channel 0 value))
122
123 (defun riece-channel-set-operators (channel value)
124   "Set the operators of CHANNEL to VALUE."
125   (aset channel 1 value))
126
127 (defun riece-channel-set-speakers (channel value)
128   "Set the speakers of CHANNEL to VALUE."
129   (aset channel 2 value))
130
131 (defun riece-channel-set-topic (channel value)
132   "Set the topic of CHANNEL to VALUE."
133   (aset channel 3 value))
134
135 (defun riece-channel-set-modes (channel value)
136   "Set the modes of CHANNEL to VALUE."
137   (aset channel 4 value))
138
139 (defun riece-channel-set-banned (channel value)
140   "Set the banned users of CHANNEL to VALUE."
141   (aset channel 5 value))
142
143 (defun riece-channel-set-invited (channel value)
144   "Set the invited users of CHANNEL to VALUE."
145   (aset channel 6 value))
146
147 (defun riece-channel-set-uninvited (channel value)
148   "Set the uninvited users of CHANNEL to VALUE."
149   (aset channel 7 value))
150
151 (defun riece-channel-set-key (channel value)
152   "Set the key of CHANNEL to VALUE."
153   (aset channel 8 value))
154
155 (defun riece-channel-get-users (&optional name)
156   "Return channel's users as list."
157   (riece-channel-users
158    (riece-get-channel (or name riece-current-channel))))
159
160 (defun riece-channel-get-operators (&optional name)
161   "Return channel's operators as list."
162   (riece-channel-operators
163    (riece-get-channel (or name riece-current-channel))))
164
165 (defun riece-channel-get-speakers (&optional name)
166   "Return channel's speakers as list."
167   (riece-channel-speakers
168    (riece-get-channel (or name riece-current-channel))))
169
170 (defun riece-channel-get-topic (&optional name)
171   "Return channel's topic."
172   (riece-channel-topic
173    (riece-get-channel (or name riece-current-channel))))
174
175 (defun riece-channel-get-modes (&optional name)
176   "Return channel's modes as list."
177   (riece-channel-modes
178    (riece-get-channel (or name riece-current-channel))))
179
180 (defun riece-channel-get-banned (&optional name)
181   "Return channel's banned users as list."
182   (riece-channel-banned
183    (riece-get-channel (or name riece-current-channel))))
184
185 (defun riece-channel-get-invited (&optional name)
186   "Return channel's invited users as list."
187   (riece-channel-invited
188    (riece-get-channel (or name riece-current-channel))))
189
190 (defun riece-channel-get-uninvited (&optional name)
191   "Return channel's uninvited users as list."
192   (riece-channel-uninvited
193    (riece-get-channel (or name riece-current-channel))))
194
195 (defun riece-channel-get-key (&optional name)
196   "Return channel's key."
197   (riece-channel-key
198    (riece-get-channel (or name riece-current-channel))))
199
200 ;;; Functions called from `riece-handle-mode-message':
201 (defun riece-channel-toggle-mode (name mode flag)
202   "Add or remove channel MODE of channel."
203   (let* ((channel (riece-get-channel (or name riece-current-channel)))
204          (modes (riece-channel-modes channel)))
205     (if flag
206         (unless (memq mode modes)
207           (riece-channel-set-modes channel (cons mode modes)))
208       (if (memq mode modes)
209           (riece-channel-set-modes channel (delq mode modes))))))
210
211 (defun riece-channel-toggle-banned (name pattern flag)
212   "Add or remove banned PATTERN of channel."
213   (let* ((channel (riece-get-channel (or name riece-current-channel)))
214          (banned (riece-channel-banned channel)))
215     (if flag
216         (unless (member pattern banned)
217           (riece-channel-set-banned channel (cons pattern banned)))
218       (if (setq pattern (car (member pattern banned)))
219           (riece-channel-set-banned channel (delq pattern banned))))))
220
221 (defun riece-channel-toggle-invited (name pattern flag)
222   "Add or remove invited PATTERN of channel."
223   (let* ((channel (riece-get-channel (or name riece-current-channel)))
224          (invited (riece-channel-invited channel)))
225     (if flag
226         (unless (member pattern invited)
227           (riece-channel-set-invited channel (cons pattern invited)))
228       (if (setq pattern (car (member pattern invited)))
229           (riece-channel-set-invited channel (delq pattern invited))))))
230
231 (defun riece-channel-toggle-uninvited (name pattern flag)
232   "Add or remove uninvited PATTERN to channel."
233   (let* ((channel (riece-get-channel (or name riece-current-channel)))
234          (uninvited (riece-channel-uninvited channel)))
235     (if flag
236         (unless (member pattern uninvited)
237           (riece-channel-set-uninvited channel (cons pattern uninvited)))
238       (if (setq pattern (car (member pattern uninvited)))
239           (riece-channel-set-uninvited
240            channel (delq pattern uninvited))))))
241
242 (defun riece-channel-toggle-user (name user flag)
243   "Add or remove an user to channel."
244   (let* ((channel (riece-get-channel (or name riece-current-channel)))
245          (users (riece-channel-users channel)))
246     (if flag
247         (unless (member user users)
248           (riece-channel-set-users channel (cons user users)))
249       (if (setq user (car (member user users)))
250           (riece-channel-set-users channel (delq user users))))))
251
252 (defun riece-channel-toggle-operator (name user flag)
253   "Add or remove an operator to channel."
254   (let* ((channel (riece-get-channel (or name riece-current-channel)))
255          (operators (riece-channel-operators channel)))
256     (if flag
257         (unless (member user operators)
258           (riece-channel-set-operators channel (cons user operators)))
259       (if (setq user (car (member user operators)))
260           (riece-channel-set-operators channel (delq user operators))))))
261
262 (defun riece-channel-toggle-speaker (name user flag)
263   "Add or remove an speaker to channel."
264   (let* ((channel (riece-get-channel (or name riece-current-channel)))
265          (speakers (riece-channel-speakers channel)))
266     (if flag
267         (unless (member user speakers)
268           (riece-channel-set-speakers channel (cons user speakers)))
269       (if (setq user (car (member user speakers)))
270           (riece-channel-set-speakers channel (delq user speakers))))))
271
272 (provide 'riece-channel)
273
274 ;;; riece-channel.el ends here