Update FSF's address.
[riece] / lisp / riece-user.el
1 ;;; riece-user.el --- a user object
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., 51 Franklin Street, Fifth Floor,
22 ;; Boston, MA 02110-1301, USA.
23
24 ;;; Code:
25
26 (require 'riece-identity)
27 (require 'riece-mode)
28 (require 'riece-cache)
29
30 ;;; User object:
31 (defun riece-find-user (name)
32   "Get a user object named NAME from the server buffer."
33   (riece-cache-get riece-user-cache name)
34   (let ((symbol (intern-soft (riece-identity-canonicalize-prefix name)
35                              riece-user-obarray)))
36     (if symbol
37         (symbol-value symbol))))
38
39 (defun riece-forget-user (name)
40   (riece-cache-delete riece-user-cache name)
41   (let ((symbol (intern-soft (riece-identity-canonicalize-prefix name))))
42     (when symbol
43       (makunbound symbol)
44       (unintern (symbol-name symbol) riece-user-obarray))))
45
46 (defun riece-rename-user (old-name new-name)
47   (riece-cache-delete riece-user-cache old-name)
48   (riece-cache-set riece-user-cache new-name new-name)
49   (unless (equal (riece-identity-canonicalize-prefix old-name)
50                  (riece-identity-canonicalize-prefix new-name))
51     (let ((symbol (intern-soft (riece-identity-canonicalize-prefix old-name)
52                                riece-user-obarray)))
53       (when symbol
54         (set (intern (riece-identity-canonicalize-prefix new-name)
55                      riece-user-obarray)
56              (symbol-value symbol))
57         (makunbound symbol)
58         (unintern (symbol-name symbol) riece-user-obarray)))))
59
60 (defun riece-make-user (channels user-at-host modes away operator)
61   "Make an instance of user object.
62 Arguments are appropriate to joined channels, user-at-host, mode, and
63 away status, respectively."
64   (vector channels user-at-host modes away operator))
65
66 (defun riece-get-user (name)
67   (let ((symbol (intern-soft (riece-identity-canonicalize-prefix name)
68                              riece-user-obarray)))
69      (if symbol
70          (progn
71            (riece-cache-get riece-user-cache name)
72            (symbol-value symbol))
73        (riece-cache-set riece-user-cache name name)
74        (set (intern (riece-identity-canonicalize-prefix name)
75                     riece-user-obarray)
76             (riece-make-user nil nil nil nil nil)))))
77
78 (defun riece-user-channels (user)
79   "Return joined channels of USER."
80   (aref user 0))
81
82 (defun riece-user-user-at-host (user)
83   "Return the user-at-host of USER."
84   (aref user 1))
85
86 (defun riece-user-modes (user)
87   "Return the modes of USER."
88   (aref user 2))
89
90 (defun riece-user-away (user)
91   "Return t, if USER has been marked as away."
92   (aref user 3))
93
94 (defun riece-user-operator (user)
95   "Return t, if USER has operator privilege."
96   (aref user 4))
97
98 (defun riece-user-set-channels (user value)
99   "Set the joined channels of USER to VALUE."
100   (aset user 0 value))
101
102 (defun riece-user-set-user-at-host (user value)
103   "Set the user-at-host of USER to VALUE."
104   (aset user 1 value))
105
106 (defun riece-user-set-modes (user value)
107   "Set the modes of USER to VALUE."
108   (aset user 2 value))
109
110 (defun riece-user-set-away (user value)
111   "Set the away status of USER to VALUE."
112   (aset user 3 value))
113
114 (defun riece-user-set-operator (user value)
115   "Set the operator status of USER to VALUE."
116   (aset user 4 value))
117
118 (defun riece-user-get-channels (name)
119   (riece-user-channels (riece-get-user name)))
120
121 (defun riece-user-get-user-at-host (name)
122   (riece-user-user-at-host (riece-get-user name)))
123
124 (defun riece-user-get-modes (name)
125   (riece-user-modes (riece-get-user name)))
126
127 (defun riece-user-get-away (name)
128   (riece-user-away (riece-get-user name)))
129
130 (defun riece-user-get-operator (name)
131   (riece-user-operator (riece-get-user name)))
132
133 (defun riece-user-toggle-channel (name channel flag)
134   "Add or remove the joined channel of user."
135   (let* ((user (riece-get-user name))
136          (channels (riece-user-channels user)))
137     (if flag
138         (unless (member channel channels)
139           (riece-user-set-channels user (cons channel channels)))
140       (if (setq channel (car (member channel channels)))
141           (riece-user-set-channels user (delq channel channels))))))
142
143 (defun riece-user-toggle-mode (name mode flag)
144   "Add or remove user MODE of user."
145   (let* ((user (riece-get-user name))
146          (modes (riece-user-modes user))
147          (old (riece-mode-assoc (riece-mode-flag mode) modes)))
148     (if flag
149         (unless old
150           (riece-user-set-modes user (cons mode modes)))
151       (if old
152           (riece-user-set-modes user (delq mode modes))))))
153
154 (defun riece-user-toggle-away (name flag)
155   (riece-user-set-away (riece-get-user name) flag))
156
157 (defun riece-user-toggle-operator (name flag)
158   (riece-user-set-operator (riece-get-user name) flag))
159
160 (provide 'riece-user)
161
162 ;;; riece-user.el ends here