* riece.el (riece-buffer-alist): Rename *Commands* -> *Command*.
[riece] / lisp / riece-misc.el
1 ;;; riece-misc.el --- miscellaneous functions (not inlined)
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-coding)
29 (require 'riece-identity)
30 (require 'riece-version)
31 (require 'riece-channel)
32 (require 'riece-server)
33 (require 'riece-user)
34 (require 'riece-mode)
35
36 (defun riece-get-buffer-create (name &optional init-major-mode)
37   (let ((buffer (get-buffer name)))
38     (unless (and buffer
39                  (or (null init-major-mode)
40                      (eq (with-current-buffer buffer
41                            major-mode)
42                          init-major-mode)))
43       (setq buffer (generate-new-buffer name)))
44     (unless (memq buffer riece-buffer-list)
45       (setq riece-buffer-list (cons buffer riece-buffer-list)))
46     buffer))
47
48 (defun riece-scan-property-region (property start end function)
49   (catch 'done
50     (while t
51       ;; Search for the beginning of the property region.
52       (unless (get-text-property start property)
53         (setq start (next-single-property-change start property nil end)))
54       (if (= start end)
55           (throw 'done nil))
56       ;; Search for the end of the property region.
57       (let ((region-end (next-single-property-change start property nil end)))
58         (if (= region-end end)
59             (throw 'done nil))
60         (funcall function start region-end)
61         (setq start region-end)))))
62
63 (defun riece-insert (buffers string)
64   (unless (listp buffers)
65     (setq buffers (list buffers)))
66   (while buffers
67     (run-hooks 'riece-before-insert-functions)
68     (save-excursion
69       (set-buffer (car buffers))
70       (let ((inhibit-read-only t)
71             buffer-read-only
72             (start (goto-char (point-max))))
73         (insert (format-time-string "%H:%M") " " string)
74         (if (and (not (riece-frozen (current-buffer)))
75                  (get-buffer-window (current-buffer)))
76             (set-window-point (get-buffer-window (current-buffer))
77                               (point)))
78         (run-hook-with-args 'riece-after-insert-functions start (point))))
79     (setq buffers (cdr buffers))))
80
81 (defun riece-insert-change (buffer message)
82   (riece-insert buffer (concat riece-change-prefix message)))
83
84 (defun riece-insert-notice (buffer message)
85   (riece-insert buffer (concat riece-notice-prefix message)))
86
87 (defun riece-insert-wallops (buffer message)
88   (riece-insert buffer (concat riece-wallops-prefix message)))
89
90 (defun riece-insert-error (buffer message)
91   (riece-insert buffer (concat riece-error-prefix message)))
92
93 (defun riece-insert-info (buffer message)
94   (riece-insert buffer (concat riece-info-prefix message)))
95
96 (defun riece-frozen (buffer)
97   (with-current-buffer buffer
98     riece-freeze))
99
100 (defun riece-own-frozen (buffer)
101   (with-current-buffer buffer
102     (eq riece-freeze 'own)))
103
104 (defun riece-channel-p (string)
105   "Return t if STRING is a channel.
106 \(i.e. it matches `riece-channel-regexp')"
107   (string-match (concat "^" riece-channel-regexp) string))
108
109 (defun riece-user-p (string)
110   "Return t if STRING is a user.
111 \(i.e. it matches `riece-user-regexp')"
112   (string-match (concat "^" riece-user-regexp) string))
113
114 (defun riece-current-nickname ()
115   "Return the current nickname."
116   (riece-with-server-buffer (riece-current-server-name)
117     (if riece-real-nickname
118         (riece-make-identity riece-real-nickname riece-server-name))))
119
120 (defun riece-split-parameters (string)
121   (if (eq ?: (aref string 0))
122       (list (substring string 1))
123     (let (parameters)
124       (catch 'done
125         (while (string-match "^\\([^ ]+\\) +" string)
126           (setq parameters (nconc parameters (list (match-string 1 string)))
127                 string (substring string (match-end 0)))
128           (and (not (equal "" string)) (eq ?: (aref string 0))
129                (setq string (substring string 1))
130                (throw 'done nil))))
131       (or (equal "" string)
132           (setq parameters (nconc parameters (list string))))
133       parameters)))
134
135 (defun riece-concat-channel-topic (target string)
136   (riece-with-server-buffer (riece-identity-server target)
137     (let ((topic (riece-channel-get-topic (riece-identity-prefix target))))
138       (if (or (null topic)
139               (equal topic ""))
140           string
141         (concat string ": " topic)))))
142
143 (defun riece-concat-channel-modes (target string)
144   (riece-with-server-buffer (riece-identity-server target)
145     (let ((modes (riece-channel-get-modes (riece-identity-prefix target))))
146       (if modes
147           (concat string " ["
148                   (mapconcat
149                    (lambda (mode)
150                      (if (riece-mode-parameter mode)
151                          (format "%c(%s)"
152                                  (riece-mode-flag mode)
153                                  (riece-mode-parameter mode))
154                        (char-to-string (riece-mode-flag mode))))
155                    modes "")
156                   "]")
157         string))))
158
159 (defun riece-concat-message (string message)
160   (if (or (null message)
161           (equal message ""))
162       string
163     (concat string " (" message ")")))
164
165 (defun riece-concat-server-name (string)
166   (if (equal riece-server-name "")
167       string
168     (concat string " (from " riece-server-name ")")))
169
170 (defun riece-concat-user-status (status string)
171   (if status
172       (concat string " [" (mapconcat #'identity status ", ") "]")
173     string))
174
175 (defun riece-prefix-user-at-host (prefix)
176   (if (string-match "!" prefix)
177       (substring prefix (match-end 0))
178     prefix))
179
180 (defun riece-prefix-nickname (prefix)
181   (if (string-match "!" prefix)
182       (substring prefix 0 (match-beginning 0))
183     prefix))
184
185 (defun riece-parse-user-at-host (user-at-host)
186   (if (memq (aref user-at-host 0) '(?^ ?= ?~ ?- ?+))
187       (progn
188         (if (memq (aref user-at-host 0) '(?^ ?=))
189             (setq riece-user-at-host-type 'fake)
190           (if (memq (aref user-at-host 0) '(?~ ?-))
191               (setq riece-user-at-host-type 'not-verified)
192             (if (eq (aref user-at-host 0) ?+)
193                 (setq riece-user-at-host-type 'ok))))
194         (substring user-at-host 1))
195     (setq riece-user-at-host-type 'ok)
196     user-at-host))
197
198 (defun riece-strip-user-at-host (user-at-host)
199   (if (memq (aref user-at-host 0) '(?^ ?= ?~ ?- ?+))
200       (substring user-at-host 1)
201     user-at-host))
202
203 (defun riece-get-users-on-server (server-name)
204   (delq nil (mapcar (lambda (identity)
205                       (if (riece-user-p (riece-identity-prefix identity))
206                           identity))
207                     (riece-get-identities-on-server server-name))))
208
209 (defun riece-get-identities-on-server (server-name)
210   (riece-with-server-buffer server-name
211     (let (identities)
212       (mapatoms
213        (lambda (atom)
214          (setq identities
215                (cons (riece-make-identity (symbol-name atom) server-name)
216                      identities)))
217        riece-obarray)
218       identities)))
219
220 (defun riece-check-channel-commands-are-usable (&optional channel)
221    (unless riece-current-channel
222      (error (substitute-command-keys
223              "Type \\[riece-command-join] to join a channel")))
224    (if (and channel
225             (not (riece-channel-p (riece-identity-prefix
226                                    riece-current-channel))))
227        (error "Not on a channel")))
228
229 (provide 'riece-misc)
230
231 ;;; riece-misc.el ends here