1 ;;; riece.el --- IRC client for Emacsen
2 ;; Copyright (C) 1998-2003 Daiki Ueno
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
6 ;; Keywords: IRC, riece
8 ;; This file is part of Riece.
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)
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.
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.
27 (require 'riece-display)
28 (require 'riece-server)
29 (require 'riece-compat)
30 (require 'riece-commands)
31 (require 'riece-addon)
32 (require 'riece-signal)
34 (autoload 'derived-mode-class "derived")
36 (defvar riece-channel-list-mode-map (make-sparse-keymap))
37 (defvar riece-user-list-mode-map (make-sparse-keymap))
39 (defvar riece-dialogue-mode-map
40 (let ((keymap (make-keymap)))
41 (suppress-keymap keymap 'nodigit)
44 (defvar riece-command-mode-map (make-keymap))
45 (defvar riece-command-map (make-sparse-keymap))
47 (defvar riece-command-mode-syntax-table nil)
49 (put 'riece-command-mode 'mode-class 'special)
50 (put 'riece-dialogue-mode 'mode-class 'special)
51 (put 'riece-others-mode 'derived-mode-parent 'riece-dialogue-mode)
52 (put 'riece-channel-list-mode 'mode-class 'special)
53 (put 'riece-user-list-mode 'mode-class 'special)
54 (put 'riece-channel-mode 'derived-mode-parent 'riece-dialogue-mode)
56 (defvar riece-buffer-alist
57 '((riece-command-buffer "*Command*" riece-command-mode)
58 (riece-dialogue-buffer "*Dialogue*" riece-dialogue-mode)
59 (riece-others-buffer "*Others*" riece-others-mode)
60 (riece-channel-list-buffer "*Channels*" riece-channel-list-mode)
61 (riece-user-list-buffer " *Users*" riece-user-list-mode)
62 (riece-temp-buffer " *Temp*")
63 (riece-debug-buffer " *Debug*")))
65 (defvar riece-select-keys
66 `("#" riece-command-switch-to-channel-by-number
67 "1" riece-command-switch-to-channel-by-number-1
68 "2" riece-command-switch-to-channel-by-number-2
69 "3" riece-command-switch-to-channel-by-number-3
70 "4" riece-command-switch-to-channel-by-number-4
71 "5" riece-command-switch-to-channel-by-number-5
72 "6" riece-command-switch-to-channel-by-number-6
73 "7" riece-command-switch-to-channel-by-number-7
74 "8" riece-command-switch-to-channel-by-number-8
75 "9" riece-command-switch-to-channel-by-number-9
76 "0" riece-command-switch-to-channel-by-number-10
77 ,(concat riece-command-prefix "1")
78 riece-command-switch-to-channel-by-number-11
79 ,(concat riece-command-prefix "2")
80 riece-command-switch-to-channel-by-number-12
81 ,(concat riece-command-prefix "3")
82 riece-command-switch-to-channel-by-number-13
83 ,(concat riece-command-prefix "4")
84 riece-command-switch-to-channel-by-number-14
85 ,(concat riece-command-prefix "5")
86 riece-command-switch-to-channel-by-number-15
87 ,(concat riece-command-prefix "6")
88 riece-command-switch-to-channel-by-number-16
89 ,(concat riece-command-prefix "7")
90 riece-command-switch-to-channel-by-number-17
91 ,(concat riece-command-prefix "8")
92 riece-command-switch-to-channel-by-number-18
93 ,(concat riece-command-prefix "9")
94 riece-command-switch-to-channel-by-number-19
95 ,(concat riece-command-prefix "0")
96 riece-command-switch-to-channel-by-number-20))
98 ;;; Keymap macros. -- borrowed from `gnus-util.el'.
99 (defmacro riece-local-set-keys (&rest plist)
100 "Set the keys in PLIST in the current keymap."
101 `(riece-define-keys-1 (current-local-map) ',plist))
103 (defmacro riece-define-keys (keymap &rest plist)
104 "Assign KEYMAP keys from PLIST."
105 `(riece-define-keys-1 ',keymap ',plist))
107 (defmacro riece-define-keys-safe (keymap &rest plist)
108 "Assign KEYMAP keys from PLIST without overwriting previous definitions."
109 `(riece-define-keys-1 ',keymap ',plist t))
111 (put 'riece-define-keys 'lisp-indent-function 1)
112 (put 'riece-define-keys-safe 'lisp-indent-function 1)
113 (put 'riece-local-set-keys 'lisp-indent-function 1)
115 (defun riece-define-keys-1 (keymap plist &optional safe)
116 "Assign KEYMAP keys from PLIST.
117 If optional argument SAFE is nil, overwrite previous definitions."
119 (error "Can't set keys in a null keymap"))
122 (setq keymap (symbol-value keymap)))
125 (set (car keymap) nil)
126 (define-prefix-command (car keymap))
127 (define-key (symbol-value (nth 2 keymap))
128 (if (symbolp (nth 1 keymap))
129 (symbol-value (nth 1 keymap))
132 (setq keymap (symbol-value (car keymap)))))
135 (if (symbolp (setq key (car plist)))
136 (setq key (symbol-value key)))
137 (setq plist (cdr plist))
139 (eq (lookup-key keymap key) 'undefined))
140 (define-key keymap key (car plist))
142 (setq plist (cdr plist)))))
145 (riece-define-keys riece-dialogue-mode-map
148 [backspace] scroll-down
151 [home] beginning-of-buffer
154 "/" riece-command-raw
156 "<" beginning-of-buffer
157 "^" riece-command-list-addons
158 "\C-ta" riece-command-toggle-away
159 "c" riece-command-select-command-buffer
160 "f" riece-command-finger
161 "\C-tf" riece-command-toggle-freeze
162 "\C-to" riece-command-toggle-own-freeze
163 "\C-tO" riece-command-toggle-others-buffer-mode
164 "\C-tu" riece-command-toggle-user-list-buffer-mode
165 "\C-tc" riece-command-toggle-channel-buffer-mode
166 "\C-tC" riece-command-toggle-channel-list-buffer-mode
167 "\C-tl" riece-command-change-layout
168 "i" riece-command-invite
169 "j" riece-command-join
170 "\C-k" riece-command-kick
171 "l" riece-command-list
172 "M" riece-command-change-mode
173 "n" riece-command-change-nickname
174 "N" riece-command-names
176 "O" riece-command-open-server
177 "C" riece-command-close-server
178 "M" riece-command-universal-server-name-argument
179 "p" riece-command-enter-message-to-user
180 "q" riece-command-quit
181 "r" riece-command-configure-windows
182 "x" riece-command-copy-region
183 "t" riece-command-topic
184 "w" riece-command-who
185 "z" riece-command-suspend-resume)
187 (riece-define-keys riece-command-mode-map
188 "\r" riece-command-enter-message
189 [(control return)] riece-command-enter-message-as-notice
190 [tab] riece-command-complete-user)
192 (riece-define-keys (riece-command-map riece-command-prefix
193 riece-command-mode-map)
194 "\177" riece-command-scroll-down
195 [delete] riece-command-scroll-down
196 [backspace] riece-command-scroll-down
197 " " riece-command-scroll-up
198 [home] riece-command-beginning-of-buffer
199 "$" riece-command-end-of-buffer
200 [end] riece-command-end-of-buffer
201 ">" riece-command-next-channel
202 "<" riece-command-previous-channel
203 "\C-j" riece-command-next-channel
204 "\C-n" riece-command-names
205 "l" riece-command-list
206 "\C-m" riece-command-change-mode
207 "o" riece-command-set-operators
208 "\C-p" riece-command-part
209 "r" riece-command-configure-windows
210 "v" riece-command-set-speakers
212 (set-keymap-parent riece-command-map riece-dialogue-mode-map)
214 (riece-define-keys riece-user-list-mode-map
215 "o" riece-command-set-operators
216 "v" riece-command-set-voices
217 "f" riece-command-finger
218 " " riece-command-user-list-scroll-up
219 "\177" riece-command-user-list-scroll-down
220 [delete] riece-command-user-list-scroll-down
221 [backspace] riece-command-user-list-scroll-down
222 "c" riece-command-select-command-buffer)
224 (riece-define-keys riece-channel-list-mode-map
225 ">" riece-command-next-channel
226 "<" riece-command-previous-channel
228 "c" riece-command-select-command-buffer)
230 (riece-define-keys-1 riece-dialogue-mode-map riece-select-keys)
231 (riece-define-keys-1 riece-channel-list-mode-map riece-select-keys))
233 (defun riece-read-variables-files (&optional file)
234 "Read variables FILEs."
235 (or (file-directory-p riece-directory)
236 (make-directory riece-directory))
237 (let ((files (if file
238 (setq riece-variables-file file
239 riece-variables-files (list file))
240 riece-variables-files)))
243 (load (expand-file-name (car files)))
245 (setq files (cdr files)))))
247 (defvar print-quoted)
248 (defvar print-escape-multibyte)
249 (defun riece-save-variables-files ()
250 "Save current settings to `riece-variables-file'."
251 (with-temp-file riece-saved-variables-file
252 (let ((print-quoted t)
254 print-escape-multibyte
257 (variables riece-saved-forms))
259 (prin1 `(setq ,(car variables)
260 ',(symbol-value (car variables)))
263 (setq variables (cdr variables)))))
264 (setq riece-save-variables-are-dirty nil))
267 (defun riece (&optional confirm)
268 "Connect to the IRC server and start chatting.
269 If optional argument CONFIRM is non-nil, ask which IRC server to connect."
271 (riece-read-variables-files (if noninteractive
272 (car command-line-args-left)))
273 (run-hooks 'riece-after-load-startup-hook)
274 (if (riece-server-opened)
275 (riece-command-configure-windows)
276 (modify-frame-parameters (selected-frame)
277 (list (cons 'riece-window-configuration
278 (current-window-configuration))))
279 (setq riece-addon-dependencies (riece-resolve-addons
280 (copy-sequence riece-addons)))
281 (let ((pointer riece-addon-dependencies))
283 (riece-insinuate-addon (car (car pointer)) riece-debug)
284 (setq pointer (cdr pointer))))
285 (if (or confirm (null riece-server))
286 (setq riece-server (completing-read "Server: " riece-server-alist)))
287 (if (stringp riece-server)
288 (setq riece-server (riece-server-name-to-server riece-server)))
289 (riece-create-buffers)
290 (switch-to-buffer riece-command-buffer)
291 (riece-display-connect-signals)
292 (riece-redisplay-buffers)
293 (riece-open-server riece-server "")
294 ;; If no server process is available, exit.
295 (if (null riece-server-process-alist)
297 (let ((server-list riece-startup-server-list))
299 (riece-command-open-server (car server-list))
300 (setq server-list (cdr server-list))))
301 (let ((channel-list riece-startup-channel-list)
304 (setq server (riece-identity-server
305 (riece-parse-identity (car channel-list))))
306 (unless (riece-server-opened server)
307 (riece-command-open-server server))
308 (setq channel-list (cdr channel-list))))
309 (let ((pointer riece-addon-dependencies))
311 (unless (get (car (car pointer)) 'riece-addon-default-disabled)
312 (riece-enable-addon (car (car pointer)) riece-debug))
313 (setq pointer (cdr pointer))))
314 (run-hooks 'riece-startup-hook)
315 (message "%s" (substitute-command-keys
316 "Type \\[describe-mode] for help")))))
319 (if riece-save-variables-are-dirty
320 (riece-save-variables-files))
321 (while riece-buffer-list
322 (if (and (get-buffer (car riece-buffer-list))
323 (buffer-live-p (car riece-buffer-list)))
324 (funcall riece-buffer-dispose-function (car riece-buffer-list)))
325 (setq riece-buffer-list (cdr riece-buffer-list)))
326 (riece-clear-signal-slots)
327 (setq riece-server nil
328 riece-current-channels nil
329 riece-current-channel nil
330 riece-channel-buffer nil
331 riece-channel-buffer-alist nil
332 riece-user-indicator nil
333 riece-long-channel-indicator "None"
334 riece-channel-list-indicator "No channel"
335 riece-away-indicator "-"
336 riece-operator-indicator "-"
337 riece-channel-status-indicator "-"
338 riece-freeze-indicator "-")
339 (modify-frame-parameters (selected-frame)
340 (list (list 'riece-window-configuration)))
341 (delete-other-windows)
342 (run-hooks 'riece-exit-hook))
344 (defun riece-command-mode ()
345 "Major mode for Riece. Normal edit function are available.
346 Typing Return or Linefeed enters the current line in the dialogue.
347 The following special commands are available:
348 For a list of the generic commands type \\[riece-command-generic] ? RET.
349 \\{riece-command-mode-map}"
351 (kill-all-local-variables)
353 ;; Make `truncate-partial-width-windows' buffer local and set it to
354 ;; nil. This causes `truncate-lines' to directly control line
356 (make-local-variable 'truncate-partial-width-windows)
357 (setq truncate-partial-width-windows nil)
359 (make-local-variable 'riece-mode-line-buffer-identification)
360 (setq riece-away-indicator "-"
361 riece-operator-indicator "-"
362 riece-channel-status-indicator "-"
363 major-mode 'riece-command-mode
365 riece-mode-line-buffer-identification
368 riece-operator-indicator
369 riece-channel-status-indicator
373 riece-channel-indicator)
374 mode-line-buffer-identification
375 (riece-mode-line-buffer-identification
376 riece-mode-line-buffer-identification)
378 (riece-simplify-mode-line-format)
379 (use-local-map riece-command-mode-map)
381 (unless riece-command-mode-syntax-table
382 (setq riece-command-mode-syntax-table
383 (copy-syntax-table (syntax-table)))
384 (set-syntax-table riece-command-mode-syntax-table)
386 (lambda (c) (modify-syntax-entry c "w"))
389 (run-hooks 'riece-command-mode-hook))
391 (defun riece-dialogue-mode ()
392 "Major mode for displaying the IRC dialogue.
393 All normal editing commands are turned off.
394 Instead, these commands are available:
395 \\{riece-dialogue-mode-map}"
396 (kill-all-local-variables)
397 (make-local-variable 'riece-freeze)
398 (make-local-variable 'riece-freeze-indicator)
400 ;; Make `truncate-partial-width-windows' buffer local and set it to
401 ;; nil. This causes `truncate-lines' to directly control line truncation.
402 (make-local-variable 'truncate-partial-width-windows)
403 (setq truncate-partial-width-windows nil)
405 (make-local-variable 'riece-mode-line-buffer-identification)
406 (setq riece-freeze riece-default-freeze
407 riece-away-indicator "-"
408 riece-operator-indicator "-"
409 riece-channel-status-indicator "-"
410 major-mode 'riece-dialogue-mode
412 riece-mode-line-buffer-identification
415 riece-operator-indicator
416 riece-freeze-indicator
417 riece-channel-status-indicator
419 riece-channel-list-indicator " ")
420 mode-line-buffer-identification
421 (riece-mode-line-buffer-identification
422 riece-mode-line-buffer-identification)
425 (riece-simplify-mode-line-format)
426 (use-local-map riece-dialogue-mode-map)
427 (buffer-disable-undo)
428 (run-hooks 'riece-dialogue-mode-hook))
430 (define-derived-mode riece-others-mode riece-dialogue-mode
432 "Major mode for displaying the IRC others message except current channel.
433 All normal editing commands are turned off.
434 Instead, these commands are available:
435 \\{riece-others-mode-map}")
437 (define-derived-mode riece-channel-mode riece-dialogue-mode
439 "Major mode for displaying the IRC current channel buffer.
440 All normal editing commands are turned off.
441 Instead, these commands are available:
442 \\{riece-channel-mode-map}"
443 (make-local-variable 'riece-channel-buffer-window-point)
444 (make-local-variable 'riece-mode-line-buffer-identification)
445 (setq riece-mode-line-buffer-identification
448 riece-operator-indicator
449 riece-freeze-indicator
450 riece-channel-status-indicator
452 riece-long-channel-indicator)
453 mode-line-buffer-identification
454 (riece-mode-line-buffer-identification
455 riece-mode-line-buffer-identification)))
457 (defun riece-channel-list-mode ()
458 "Major mode for displaying channel list.
459 All normal editing commands are turned off."
460 (kill-all-local-variables)
461 (buffer-disable-undo)
463 ;; Make `truncate-partial-width-windows' buffer local and set it to
464 ;; nil. This causes `truncate-lines' to directly control line truncation.
465 (make-local-variable 'truncate-partial-width-windows)
466 (setq truncate-partial-width-windows nil)
468 (make-local-variable 'riece-mode-line-buffer-identification)
469 (setq major-mode 'riece-channel-list-mode
471 riece-mode-line-buffer-identification '("Riece: ")
472 mode-line-buffer-identification
473 (riece-mode-line-buffer-identification
474 riece-mode-line-buffer-identification)
477 (make-local-hook 'riece-update-buffer-functions)
478 (add-hook 'riece-update-buffer-functions
479 'riece-update-channel-list-buffer nil t)
480 (use-local-map riece-channel-list-mode-map)
481 (run-hooks 'riece-channel-list-mode-hook))
483 (defun riece-user-list-mode ()
484 "Major mode for displaying members in the IRC current channel buffer.
485 All normal editing commands are turned off.
486 Instead, these commands are available:
487 \\{riece-user-list-mode-map}"
488 (kill-all-local-variables)
489 (buffer-disable-undo)
491 ;; Make `truncate-partial-width-windows' buffer local and set it to
492 ;; nil. This causes `truncate-lines' to directly control line truncation.
493 (make-local-variable 'truncate-partial-width-windows)
494 (setq truncate-partial-width-windows nil)
496 (make-local-variable 'riece-mode-line-buffer-identification)
497 (setq major-mode 'riece-user-list-mode
499 riece-mode-line-buffer-identification
500 '("Riece: " riece-long-channel-indicator " ")
501 mode-line-buffer-identification
502 (riece-mode-line-buffer-identification
503 riece-mode-line-buffer-identification)
506 (if (boundp 'transient-mark-mode)
507 (set (make-local-variable 'transient-mark-mode) t))
508 (make-local-hook 'riece-update-buffer-functions)
509 (add-hook 'riece-update-buffer-functions
510 'riece-update-user-list-buffer nil t)
511 (use-local-map riece-user-list-mode-map)
512 (run-hooks 'riece-user-list-mode-hook))
514 (defun riece-create-buffers ()
515 (let ((alist riece-buffer-alist))
518 (set-buffer (apply #'riece-get-buffer-create
520 (set (car (car alist)) (current-buffer))
521 (unless (or (null (nth 2 (car alist)))
522 (eq major-mode (nth 2 (car alist))))
523 (funcall (nth 2 (car alist))))
524 (setq alist (cdr alist))))))
526 (defvar reporter-prompt-for-summary-p)
527 (defun riece-submit-bug-report (&optional recent-messages recent-keys)
528 "Submit via mail a bug report on Riece."
529 ;; This strange form ensures that (recent-keys) is the value before
530 ;; the bug subject string is read.
531 (interactive (list (riece-recent-messages 20) (recent-keys)))
532 (message "Querying server version...")
533 (let ((pointer riece-server-process-alist)
536 (when (riece-server-process-opened (cdr (car pointer)))
537 (process-send-string (cdr (car pointer)) "VERSION\r\n")
539 (with-current-buffer (process-buffer (cdr (car pointer)))
540 riece-real-nickname))
543 (format "PRIVMSG %s :\1VERSION\1\r\n" nickname))))
544 (setq pointer (cdr pointer))))
546 (message "Querying server version...done")
548 (let ((reporter-prompt-for-summary-p t))
550 (error "Please turn on riece-debug and restart Riece."))
551 (reporter-submit-bug-report
557 "This bug report will be sent to the Riece Development Team,
558 not to your local site managers!!
560 Please write in Japanese or English, because the Riece maintainers do
561 not have translators to read other languages for them.
563 Please describe as succinctly as possible:
565 \t- What you thought should have happened.
566 \t- Precisely what you were doing at the time.
568 Also include a reliable recipe for triggering the bug, as well as
569 any lisp back-traces that you may have.
570 \(setq stack-trace-on-error t\), or \(setq debug-on-error t\) if you
571 are familiar with the debugger, to get a lisp back-trace.")
572 (delete-other-windows)
574 (goto-char (point-max))
578 (save-window-excursion
580 (riece-command-list-addons)
581 (search-forward "\n\n")
582 (buffer-substring (point-min) (point)))))
583 (insert "Recent messages from servers:\n"
584 "--------------------------")
585 (let ((pointer riece-server-process-alist))
587 (insert "\n- \"" (car (car pointer)) "\", \n"
588 (format "%S" (if (equal (car (car pointer)) "")
590 (cdr (assoc (car (car pointer))
591 riece-server-alist))))
593 (if (riece-server-process-opened (cdr (car pointer)))
595 (set-buffer (process-buffer (cdr (car pointer))))
596 (goto-char (point-max))
597 (beginning-of-line -60)
598 (buffer-substring (point) (point-max)))
600 (setq pointer (cdr pointer))))
601 (insert "\n\nRecent debug messages:\n"
602 "-----------------------------------\n"
603 (with-current-buffer riece-debug-buffer
605 ;; Insert recent keystrokes.
606 (insert "\n\nRecent keystrokes:\n"
607 "-----------------\n\n")
608 (let ((before-keys (point)))
609 (insert (key-description recent-keys))
611 (narrow-to-region before-keys (point))
612 (goto-char before-keys)
613 (while (progn (move-to-column 50) (not (eobp)))
614 (search-forward " " nil t)
616 ;; Insert recent minibuffer messages.
617 (insert "\n\nRecent messages (most recent first):\n"
618 "-----------------------------------\n"
623 ;;; riece.el ends here