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., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, 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 "s" riece-command-save-variables
183 "x" riece-command-copy-region
184 "t" riece-command-topic
185 "w" riece-command-who
186 "z" riece-command-suspend-resume)
188 (riece-define-keys riece-command-mode-map
189 "\r" riece-command-enter-message
190 [(control return)] riece-command-enter-message-as-notice
191 [tab] riece-command-complete-user)
193 (riece-define-keys (riece-command-map riece-command-prefix
194 riece-command-mode-map)
195 "\177" riece-command-scroll-down
196 [delete] riece-command-scroll-down
197 [backspace] riece-command-scroll-down
198 " " riece-command-scroll-up
199 [home] riece-command-beginning-of-buffer
200 "$" riece-command-end-of-buffer
201 [end] riece-command-end-of-buffer
202 ">" riece-command-next-channel
203 "<" riece-command-previous-channel
204 "\C-j" riece-command-next-channel
205 "\C-n" riece-command-names
206 "l" riece-command-list
207 "\C-m" riece-command-change-mode
208 "o" riece-command-set-operators
209 "\C-p" riece-command-part
210 "r" riece-command-configure-windows
211 "v" riece-command-set-speakers
213 (set-keymap-parent riece-command-map riece-dialogue-mode-map)
215 (riece-define-keys riece-user-list-mode-map
216 "o" riece-command-set-operators
217 "v" riece-command-set-voices
218 "f" riece-command-finger
219 " " riece-command-user-list-scroll-up
220 "\177" riece-command-user-list-scroll-down
221 [delete] riece-command-user-list-scroll-down
222 [backspace] riece-command-user-list-scroll-down
223 "c" riece-command-select-command-buffer)
225 (riece-define-keys riece-channel-list-mode-map
226 ">" riece-command-next-channel
227 "<" riece-command-previous-channel
229 "c" riece-command-select-command-buffer)
231 (riece-define-keys-1 riece-dialogue-mode-map riece-select-keys)
232 (riece-define-keys-1 riece-channel-list-mode-map riece-select-keys))
234 (defun riece-read-variables-files (&optional file)
235 "Read variables FILEs."
236 (or (file-directory-p riece-directory)
237 (make-directory riece-directory))
238 (let ((files (if file
239 (setq riece-variables-file file
240 riece-variables-files (list file))
241 riece-variables-files)))
244 (load (expand-file-name (car files)))
246 (setq files (cdr files)))))
248 (defvar print-quoted)
249 (defvar print-escape-multibyte)
250 (defun riece-save-variables-files ()
251 "Save current settings to `riece-saved-variables-file'."
252 (message (riece-mcat "Saving %s...") riece-saved-variables-file)
253 (with-temp-file riece-saved-variables-file
254 (insert ";;; This file is generated automatically by " riece-version ".\n"
255 ";;; Do not edit this file!\n\n")
256 (let ((print-quoted t)
258 print-escape-multibyte
261 (variables riece-saved-forms))
263 (prin1 `(setq ,(car variables)
264 ',(symbol-value (car variables)))
267 (setq variables (cdr variables)))))
268 (message (riece-mcat "Saving %s...done") riece-saved-variables-file)
269 (setq riece-save-variables-are-dirty nil))
272 (defun riece (&optional confirm)
273 "Connect to the IRC server and start chatting.
274 If optional argument CONFIRM is non-nil, ask which IRC server to connect."
276 (riece-read-variables-files (if noninteractive
277 (car command-line-args-left)))
278 (run-hooks 'riece-after-load-startup-hook)
279 (if (riece-server-opened)
280 (riece-command-configure-windows)
281 (modify-frame-parameters (selected-frame)
282 (list (cons 'riece-window-configuration
283 (current-window-configuration))))
284 (setq riece-addon-dependencies (riece-resolve-addons
285 (copy-sequence riece-addons)))
286 (let ((pointer riece-addon-dependencies))
288 (riece-insinuate-addon (car (car pointer)) riece-debug)
289 (setq pointer (cdr pointer))))
290 (if (or confirm (null riece-server))
291 (setq riece-server (completing-read (riece-mcat "Server: ")
292 riece-server-alist)))
293 (if (stringp riece-server)
294 (setq riece-server (riece-server-name-to-server riece-server)))
295 (riece-create-buffers)
296 (switch-to-buffer riece-command-buffer)
297 (riece-display-connect-signals)
298 (riece-redisplay-buffers)
299 (riece-open-server riece-server "")
300 ;; If no server process is available, exit.
301 (if (null riece-server-process-alist)
303 (let ((server-list riece-startup-server-list))
305 (riece-command-open-server (car server-list))
306 (setq server-list (cdr server-list))))
307 (let ((channel-list riece-startup-channel-list)
310 (setq server (riece-identity-server
311 (riece-parse-identity (car channel-list))))
312 (unless (riece-server-opened server)
313 (riece-command-open-server server))
314 (setq channel-list (cdr channel-list))))
315 (let ((pointer riece-addon-dependencies))
317 (unless (get (car (car pointer)) 'riece-addon-default-disabled)
318 (riece-enable-addon (car (car pointer)) riece-debug))
319 (setq pointer (cdr pointer))))
320 (run-hooks 'riece-startup-hook)
321 (message "%s" (substitute-command-keys
322 (riece-mcat "Type \\[describe-mode] for help"))))))
325 (if riece-save-variables-are-dirty
326 (riece-save-variables-files))
327 (while riece-buffer-list
328 (if (and (get-buffer (car riece-buffer-list))
329 (buffer-live-p (car riece-buffer-list)))
330 (funcall riece-buffer-dispose-function (car riece-buffer-list)))
331 (setq riece-buffer-list (cdr riece-buffer-list)))
332 (riece-clear-signal-slots)
333 (setq riece-server nil
334 riece-current-channels nil
335 riece-current-channel nil
336 riece-channel-buffer nil
337 riece-channel-buffer-alist nil
338 riece-user-indicator nil
339 riece-long-channel-indicator (riece-mcat "None")
340 riece-channel-list-indicator (riece-mcat "No channel")
341 riece-away-indicator "-"
342 riece-operator-indicator "-"
343 riece-channel-status-indicator "-"
344 riece-freeze-indicator "-")
345 (modify-frame-parameters (selected-frame)
346 (list (list 'riece-window-configuration)))
347 (delete-other-windows)
348 (run-hooks 'riece-exit-hook))
350 (defun riece-command-mode ()
351 "Major mode for Riece. Normal edit function are available.
352 Typing Return or Linefeed enters the current line in the dialogue.
353 The following special commands are available:
354 For a list of the generic commands type \\[riece-command-generic] ? RET.
355 \\{riece-command-mode-map}"
357 (kill-all-local-variables)
359 ;; Make `truncate-partial-width-windows' buffer local and set it to
360 ;; nil. This causes `truncate-lines' to directly control line
362 (make-local-variable 'truncate-partial-width-windows)
363 (setq truncate-partial-width-windows nil)
365 (make-local-variable 'riece-mode-line-buffer-identification)
366 (setq riece-away-indicator "-"
367 riece-operator-indicator "-"
368 riece-channel-status-indicator "-"
369 major-mode 'riece-command-mode
371 riece-mode-line-buffer-identification
374 riece-operator-indicator
375 riece-channel-status-indicator
379 riece-channel-indicator)
380 mode-line-buffer-identification
381 (riece-mode-line-buffer-identification
382 riece-mode-line-buffer-identification)
384 (riece-simplify-mode-line-format)
385 (use-local-map riece-command-mode-map)
387 (unless riece-command-mode-syntax-table
388 (setq riece-command-mode-syntax-table
389 (copy-syntax-table (syntax-table)))
390 (set-syntax-table riece-command-mode-syntax-table)
392 (lambda (c) (modify-syntax-entry c "w"))
395 (run-hooks 'riece-command-mode-hook))
397 (defun riece-dialogue-mode ()
398 "Major mode for displaying the IRC dialogue.
399 All normal editing commands are turned off.
400 Instead, these commands are available:
401 \\{riece-dialogue-mode-map}"
402 (kill-all-local-variables)
403 (make-local-variable 'riece-freeze)
404 (make-local-variable 'riece-freeze-indicator)
406 ;; Make `truncate-partial-width-windows' buffer local and set it to
407 ;; nil. This causes `truncate-lines' to directly control line truncation.
408 (make-local-variable 'truncate-partial-width-windows)
409 (setq truncate-partial-width-windows nil)
411 (make-local-variable 'riece-mode-line-buffer-identification)
412 (setq riece-freeze riece-default-freeze
413 riece-away-indicator "-"
414 riece-operator-indicator "-"
415 riece-channel-status-indicator "-"
416 major-mode 'riece-dialogue-mode
418 riece-mode-line-buffer-identification
421 riece-operator-indicator
422 riece-freeze-indicator
423 riece-channel-status-indicator
425 riece-channel-list-indicator " ")
426 mode-line-buffer-identification
427 (riece-mode-line-buffer-identification
428 riece-mode-line-buffer-identification)
431 (riece-simplify-mode-line-format)
432 (use-local-map riece-dialogue-mode-map)
433 (buffer-disable-undo)
434 (run-hooks 'riece-dialogue-mode-hook))
436 (define-derived-mode riece-others-mode riece-dialogue-mode
438 "Major mode for displaying the IRC others message except current channel.
439 All normal editing commands are turned off.
440 Instead, these commands are available:
441 \\{riece-others-mode-map}")
443 (define-derived-mode riece-channel-mode riece-dialogue-mode
445 "Major mode for displaying the IRC current channel buffer.
446 All normal editing commands are turned off.
447 Instead, these commands are available:
448 \\{riece-channel-mode-map}"
449 (make-local-variable 'riece-channel-buffer-window-point)
450 (make-local-variable 'riece-mode-line-buffer-identification)
451 (setq riece-mode-line-buffer-identification
454 riece-operator-indicator
455 riece-freeze-indicator
456 riece-channel-status-indicator
458 riece-long-channel-indicator)
459 mode-line-buffer-identification
460 (riece-mode-line-buffer-identification
461 riece-mode-line-buffer-identification)))
463 (defun riece-channel-list-mode ()
464 "Major mode for displaying channel list.
465 All normal editing commands are turned off."
466 (kill-all-local-variables)
467 (buffer-disable-undo)
469 ;; Make `truncate-partial-width-windows' buffer local and set it to
470 ;; nil. This causes `truncate-lines' to directly control line truncation.
471 (make-local-variable 'truncate-partial-width-windows)
472 (setq truncate-partial-width-windows nil)
474 (make-local-variable 'riece-mode-line-buffer-identification)
475 (setq major-mode 'riece-channel-list-mode
477 riece-mode-line-buffer-identification '("Riece: ")
478 mode-line-buffer-identification
479 (riece-mode-line-buffer-identification
480 riece-mode-line-buffer-identification)
483 (make-local-hook 'riece-update-buffer-functions)
484 (add-hook 'riece-update-buffer-functions
485 'riece-update-channel-list-buffer nil t)
486 (use-local-map riece-channel-list-mode-map)
487 (run-hooks 'riece-channel-list-mode-hook))
489 (defun riece-user-list-mode ()
490 "Major mode for displaying members in the IRC current channel buffer.
491 All normal editing commands are turned off.
492 Instead, these commands are available:
493 \\{riece-user-list-mode-map}"
494 (kill-all-local-variables)
495 (buffer-disable-undo)
497 ;; Make `truncate-partial-width-windows' buffer local and set it to
498 ;; nil. This causes `truncate-lines' to directly control line truncation.
499 (make-local-variable 'truncate-partial-width-windows)
500 (setq truncate-partial-width-windows nil)
502 (make-local-variable 'riece-mode-line-buffer-identification)
503 (setq major-mode 'riece-user-list-mode
505 riece-mode-line-buffer-identification
506 '("Riece: " riece-long-channel-indicator " ")
507 mode-line-buffer-identification
508 (riece-mode-line-buffer-identification
509 riece-mode-line-buffer-identification)
512 (if (boundp 'transient-mark-mode)
513 (set (make-local-variable 'transient-mark-mode) t))
514 (make-local-hook 'riece-update-buffer-functions)
515 (add-hook 'riece-update-buffer-functions
516 'riece-update-user-list-buffer nil t)
517 (use-local-map riece-user-list-mode-map)
518 (run-hooks 'riece-user-list-mode-hook))
520 (defun riece-create-buffers ()
521 (let ((alist riece-buffer-alist))
524 (set-buffer (apply #'riece-get-buffer-create
526 (set (car (car alist)) (current-buffer))
527 (unless (or (null (nth 2 (car alist)))
528 (eq major-mode (nth 2 (car alist))))
529 (funcall (nth 2 (car alist))))
530 (setq alist (cdr alist))))))
532 (defvar reporter-prompt-for-summary-p)
533 (defun riece-submit-bug-report (&optional recent-messages recent-keys)
534 "Submit via mail a bug report on Riece."
535 ;; This strange form ensures that (recent-keys) is the value before
536 ;; the bug subject string is read.
537 (interactive (list (riece-recent-messages 20) (recent-keys)))
538 (message "Querying server version...")
539 (let ((pointer riece-server-process-alist)
542 (when (riece-server-process-opened (cdr (car pointer)))
543 (process-send-string (cdr (car pointer)) "VERSION\r\n")
545 (with-current-buffer (process-buffer (cdr (car pointer)))
546 riece-real-nickname))
549 (format "PRIVMSG %s :\1VERSION\1\r\n" nickname))))
550 (setq pointer (cdr pointer))))
552 (message "Querying server version...done")
554 (let ((reporter-prompt-for-summary-p t))
556 (error "Please turn on riece-debug and restart Riece."))
557 (reporter-submit-bug-report
563 "This bug report will be sent to the Riece Development Team,
564 not to your local site managers!!
566 Please write in Japanese or English, because the Riece maintainers do
567 not have translators to read other languages for them.
569 Please describe as succinctly as possible:
571 \t- What you thought should have happened.
572 \t- Precisely what you were doing at the time.
574 Also include a reliable recipe for triggering the bug, as well as
575 any lisp back-traces that you may have.
576 \(setq stack-trace-on-error t\), or \(setq debug-on-error t\) if you
577 are familiar with the debugger, to get a lisp back-trace.")
578 (delete-other-windows)
580 (goto-char (point-max))
584 (save-window-excursion
586 (riece-command-list-addons)
587 (search-forward "\n\n")
588 (buffer-substring (point-min) (point)))))
589 (insert "Recent messages from servers:\n"
590 "--------------------------")
591 (let ((pointer riece-server-process-alist))
593 (insert "\n- \"" (car (car pointer)) "\", \n"
594 (format "%S" (if (equal (car (car pointer)) "")
596 (cdr (assoc (car (car pointer))
597 riece-server-alist))))
599 (if (riece-server-process-opened (cdr (car pointer)))
601 (set-buffer (process-buffer (cdr (car pointer))))
602 (goto-char (point-max))
603 (beginning-of-line -60)
604 (buffer-substring (point) (point-max)))
606 (setq pointer (cdr pointer))))
607 (insert "\n\nRecent debug messages:\n"
608 "-----------------------------------\n"
609 (with-current-buffer riece-debug-buffer
611 ;; Insert recent keystrokes.
612 (insert "\n\nRecent keystrokes:\n"
613 "-----------------\n\n")
614 (let ((before-keys (point)))
615 (insert (key-description recent-keys))
617 (narrow-to-region before-keys (point))
618 (goto-char before-keys)
619 (while (progn (move-to-column 50) (not (eobp)))
620 (search-forward " " nil t)
622 ;; Insert recent minibuffer messages.
623 (insert "\n\nRecent messages (most recent first):\n"
624 "-----------------------------------\n"
629 ;;; riece.el ends here