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)))
63 (defvar riece-shrink-buffer-idle-timer nil
64 "Timer object to periodically shrink channel buffers.")
66 (defvar riece-addons-insinuated nil
67 "Non nil if add-ons are already insinuated.")
69 (defvar riece-select-keys
70 `("#" riece-command-switch-to-channel-by-number
71 "1" riece-command-switch-to-channel-by-number-1
72 "2" riece-command-switch-to-channel-by-number-2
73 "3" riece-command-switch-to-channel-by-number-3
74 "4" riece-command-switch-to-channel-by-number-4
75 "5" riece-command-switch-to-channel-by-number-5
76 "6" riece-command-switch-to-channel-by-number-6
77 "7" riece-command-switch-to-channel-by-number-7
78 "8" riece-command-switch-to-channel-by-number-8
79 "9" riece-command-switch-to-channel-by-number-9
80 "0" riece-command-switch-to-channel-by-number-10
81 ,(concat riece-command-prefix "1")
82 riece-command-switch-to-channel-by-number-11
83 ,(concat riece-command-prefix "2")
84 riece-command-switch-to-channel-by-number-12
85 ,(concat riece-command-prefix "3")
86 riece-command-switch-to-channel-by-number-13
87 ,(concat riece-command-prefix "4")
88 riece-command-switch-to-channel-by-number-14
89 ,(concat riece-command-prefix "5")
90 riece-command-switch-to-channel-by-number-15
91 ,(concat riece-command-prefix "6")
92 riece-command-switch-to-channel-by-number-16
93 ,(concat riece-command-prefix "7")
94 riece-command-switch-to-channel-by-number-17
95 ,(concat riece-command-prefix "8")
96 riece-command-switch-to-channel-by-number-18
97 ,(concat riece-command-prefix "9")
98 riece-command-switch-to-channel-by-number-19
99 ,(concat riece-command-prefix "0")
100 riece-command-switch-to-channel-by-number-20))
102 ;;; Keymap macros. -- borrowed from `gnus-util.el'.
103 (defmacro riece-local-set-keys (&rest plist)
104 "Set the keys in PLIST in the current keymap."
105 `(riece-define-keys-1 (current-local-map) ',plist))
107 (defmacro riece-define-keys (keymap &rest plist)
108 "Assign KEYMAP keys from PLIST."
109 `(riece-define-keys-1 ',keymap ',plist))
111 (defmacro riece-define-keys-safe (keymap &rest plist)
112 "Assign KEYMAP keys from PLIST without overwriting previous definitions."
113 `(riece-define-keys-1 ',keymap ',plist t))
115 (put 'riece-define-keys 'lisp-indent-function 1)
116 (put 'riece-define-keys-safe 'lisp-indent-function 1)
117 (put 'riece-local-set-keys 'lisp-indent-function 1)
119 (defun riece-define-keys-1 (keymap plist &optional safe)
120 "Assign KEYMAP keys from PLIST.
121 If optional argument SAFE is nil, overwrite previous definitions."
123 (error "Can't set keys in a null keymap"))
126 (setq keymap (symbol-value keymap)))
129 (set (car keymap) nil)
130 (define-prefix-command (car keymap))
131 (define-key (symbol-value (nth 2 keymap))
132 (if (symbolp (nth 1 keymap))
133 (symbol-value (nth 1 keymap))
136 (setq keymap (symbol-value (car keymap)))))
139 (if (symbolp (setq key (car plist)))
140 (setq key (symbol-value key)))
141 (setq plist (cdr plist))
143 (eq (lookup-key keymap key) 'undefined))
144 (define-key keymap key (car plist))
146 (setq plist (cdr plist)))))
149 (riece-define-keys riece-dialogue-mode-map
152 [backspace] scroll-down
155 [home] beginning-of-buffer
158 "/" riece-command-raw
160 "<" beginning-of-buffer
161 "^" riece-command-list-addons
162 "\C-ta" riece-command-toggle-away
163 "c" riece-command-select-command-buffer
164 "f" riece-command-finger
165 "\C-tf" riece-command-toggle-freeze
166 "\C-to" riece-command-toggle-own-freeze
167 "\C-tu" riece-command-toggle-user-list-buffer-mode
168 "\C-tc" riece-command-toggle-channel-buffer-mode
169 "\C-tC" riece-command-toggle-channel-list-buffer-mode
170 "\C-tl" riece-command-change-layout
171 "i" riece-command-invite
172 "j" riece-command-join
173 "\C-k" riece-command-kick
174 "l" riece-command-list
175 "M" riece-command-change-mode
176 "n" riece-command-change-nickname
177 "N" riece-command-names
179 "O" riece-command-open-server
180 "C" riece-command-close-server
181 "M" riece-command-universal-server-name-argument
182 "p" riece-command-enter-message-to-user
183 "q" riece-command-quit
184 "r" riece-command-configure-windows
185 "x" riece-command-copy-region
186 "t" riece-command-topic
187 "w" riece-command-who)
189 (riece-define-keys riece-command-mode-map
190 "\r" riece-command-enter-message
191 [(control return)] riece-command-enter-message-as-notice
192 [tab] riece-command-complete-user)
194 (riece-define-keys (riece-command-map riece-command-prefix
195 riece-command-mode-map)
196 "\177" riece-command-scroll-down
197 [delete] riece-command-scroll-down
198 [backspace] riece-command-scroll-down
199 " " riece-command-scroll-up
200 [home] riece-command-beginning-of-buffer
201 "$" riece-command-end-of-buffer
202 [end] riece-command-end-of-buffer
203 ">" riece-command-next-channel
204 "<" riece-command-previous-channel
205 "\C-j" riece-command-next-channel
206 "\C-n" riece-command-names
207 "l" riece-command-list
208 "\C-m" riece-command-change-mode
209 "o" riece-command-set-operators
210 "\C-p" riece-command-part
211 "r" riece-command-configure-windows
212 "v" riece-command-set-speakers
214 (set-keymap-parent riece-command-map riece-dialogue-mode-map)
216 (riece-define-keys riece-user-list-mode-map
217 "o" riece-command-set-operators
218 "v" riece-command-set-voices
219 "f" riece-command-finger
220 " " riece-command-user-list-scroll-up
221 "\177" riece-command-user-list-scroll-down
222 [delete] riece-command-user-list-scroll-down
223 [backspace] riece-command-user-list-scroll-down
224 "c" riece-command-select-command-buffer)
226 (riece-define-keys riece-channel-list-mode-map
227 ">" riece-command-next-channel
228 "<" riece-command-previous-channel
230 "c" riece-command-select-command-buffer)
232 (riece-define-keys-1 riece-dialogue-mode-map riece-select-keys)
233 (riece-define-keys-1 riece-channel-list-mode-map riece-select-keys))
235 (defun riece-read-variables-files (&optional file)
236 "Read variables FILEs."
237 (or (file-directory-p riece-directory)
238 (make-directory riece-directory))
239 (let ((files (if file
240 (setq riece-variables-file file
241 riece-variables-files (list file))
242 riece-variables-files)))
245 (load (expand-file-name (car files)))
247 (setq files (cdr files)))))
249 (defvar print-quoted)
250 (defvar print-escape-multibyte)
251 (defun riece-save-variables-files ()
252 "Save current settings to `riece-variables-file'."
253 (with-temp-file riece-saved-variables-file
254 (let ((print-quoted t)
256 print-escape-multibyte
259 (variables riece-saved-forms))
261 (prin1 `(setq ,(car variables)
262 ',(symbol-value (car variables)))
265 (setq variables (cdr variables)))))
266 (setq riece-save-variables-are-dirty nil))
269 (defun riece (&optional confirm)
270 "Connect to the IRC server and start chatting.
271 If optional argument CONFIRM is non-nil, ask which IRC server to connect."
273 (riece-read-variables-files (if noninteractive
274 (car command-line-args-left)))
275 (run-hooks 'riece-after-load-startup-hook)
276 (if (riece-server-opened)
277 (riece-command-configure-windows)
278 (unless riece-addons-insinuated
279 (setq riece-addons (riece-resolve-addons riece-addons))
280 (let ((pointer riece-addons))
282 (riece-insinuate-addon (car pointer) riece-debug)
283 (setq pointer (cdr pointer))))
284 (setq riece-addons-insinuated t))
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 (if riece-max-buffer-size
291 (setq riece-shrink-buffer-idle-timer
292 (riece-run-with-idle-timer
293 riece-shrink-buffer-idle-time-delay t
295 (let ((buffers riece-buffer-list))
297 (if (buffer-live-p (car buffers))
298 (if (eq (derived-mode-class
299 (with-current-buffer (car buffers)
301 'riece-dialogue-mode)
302 (riece-shrink-buffer (car buffers)))
303 (delq (car buffers) riece-buffer-list))
304 (setq buffers (cdr buffers))))))))
305 (switch-to-buffer riece-command-buffer)
306 (riece-display-connect-signals)
307 (riece-redisplay-buffers)
308 (riece-open-server riece-server "")
309 ;; If no server process is available, exit.
310 (if (null riece-server-process-alist)
312 (let ((server-list riece-startup-server-list))
314 (riece-command-open-server (car server-list))
315 (setq server-list (cdr server-list))))
316 (let ((channel-list riece-startup-channel-list)
319 (setq server (riece-identity-server
320 (riece-parse-identity (car channel-list))))
321 (unless (riece-server-opened server)
322 (riece-command-open-server server))
323 (setq channel-list (cdr channel-list))))
324 (let ((pointer riece-addons))
326 (unless (get (car pointer) 'riece-addon-default-disabled)
327 (riece-enable-addon (car pointer) riece-debug))
328 (setq pointer (cdr pointer))))
329 (run-hooks 'riece-startup-hook)
330 (message "%s" (substitute-command-keys
331 "Type \\[describe-mode] for help")))))
333 (defun riece-shrink-buffer (buffer)
336 (goto-char (point-min))
337 (while (> (buffer-size) riece-max-buffer-size)
338 (let* ((inhibit-read-only t)
341 (end (progn (beginning-of-line
342 (1+ riece-shrink-buffer-remove-lines))
344 (overlays (riece-overlays-in start end)))
346 (riece-delete-overlay (car overlays))
347 (setq overlays (cdr overlays)))
348 (delete-region start end)))))
351 (if riece-save-variables-are-dirty
352 (riece-save-variables-files))
353 (while riece-buffer-list
354 (if (and (get-buffer (car riece-buffer-list))
355 (buffer-live-p (car riece-buffer-list)))
356 (funcall riece-buffer-dispose-function (car riece-buffer-list)))
357 (setq riece-buffer-list (cdr riece-buffer-list)))
358 (if riece-shrink-buffer-idle-timer
359 (riece-cancel-timer riece-shrink-buffer-idle-timer))
360 (riece-clear-signal-slots)
361 (setq riece-server nil
362 riece-current-channels nil
363 riece-current-channel nil
364 riece-channel-buffer nil
365 riece-channel-buffer-alist nil
366 riece-user-indicator nil
367 riece-long-channel-indicator "None"
368 riece-channel-list-indicator "No channel"
369 riece-away-indicator "-"
370 riece-operator-indicator "-"
371 riece-channel-status-indicator "-"
372 riece-freeze-indicator "-")
373 (delete-other-windows)
374 (run-hooks 'riece-exit-hook))
376 (defun riece-command-mode ()
377 "Major mode for Riece. Normal edit function are available.
378 Typing Return or Linefeed enters the current line in the dialogue.
379 The following special commands are available:
380 For a list of the generic commands type \\[riece-command-generic] ? RET.
381 \\{riece-command-mode-map}"
383 (kill-all-local-variables)
385 ;; Make `truncate-partial-width-windows' buffer local and set it to
386 ;; nil. This causes `truncate-lines' to directly control line
388 (make-local-variable 'truncate-partial-width-windows)
389 (setq truncate-partial-width-windows nil)
391 (setq riece-away-indicator "-"
392 riece-operator-indicator "-"
393 riece-channel-status-indicator "-"
394 major-mode 'riece-command-mode
396 mode-line-buffer-identification
397 (riece-mode-line-buffer-identification
400 riece-operator-indicator
401 riece-channel-status-indicator
405 riece-channel-indicator))
407 (riece-simplify-mode-line-format)
408 (use-local-map riece-command-mode-map)
410 (unless riece-command-mode-syntax-table
411 (setq riece-command-mode-syntax-table
412 (copy-syntax-table (syntax-table)))
413 (set-syntax-table riece-command-mode-syntax-table)
415 (lambda (c) (modify-syntax-entry c "w"))
418 (run-hooks 'riece-command-mode-hook))
420 (defun riece-dialogue-mode ()
421 "Major mode for displaying the IRC dialogue.
422 All normal editing commands are turned off.
423 Instead, these commands are available:
424 \\{riece-dialogue-mode-map}"
425 (kill-all-local-variables)
426 (make-local-variable 'riece-freeze)
427 (make-local-variable 'riece-freeze-indicator)
429 ;; Make `truncate-partial-width-windows' buffer local and set it to
430 ;; nil. This causes `truncate-lines' to directly control line truncation.
431 (make-local-variable 'truncate-partial-width-windows)
432 (setq truncate-partial-width-windows nil)
434 (setq riece-freeze riece-default-freeze
435 riece-away-indicator "-"
436 riece-operator-indicator "-"
437 riece-channel-status-indicator "-"
438 major-mode 'riece-dialogue-mode
440 mode-line-buffer-identification
441 (riece-mode-line-buffer-identification
444 riece-operator-indicator
445 riece-freeze-indicator
446 riece-channel-status-indicator
448 riece-channel-list-indicator " "))
451 (riece-simplify-mode-line-format)
452 (use-local-map riece-dialogue-mode-map)
453 (buffer-disable-undo)
454 (run-hooks 'riece-dialogue-mode-hook))
456 (define-derived-mode riece-others-mode riece-dialogue-mode
458 "Major mode for displaying the IRC others message except current channel.
459 All normal editing commands are turned off.
460 Instead, these commands are available:
461 \\{riece-others-mode-map}")
463 (define-derived-mode riece-channel-mode riece-dialogue-mode
465 "Major mode for displaying the IRC current channel buffer.
466 All normal editing commands are turned off.
467 Instead, these commands are available:
468 \\{riece-channel-mode-map}"
469 (make-local-variable 'riece-channel-buffer-window-point)
470 (setq mode-line-buffer-identification
471 (riece-mode-line-buffer-identification
474 riece-operator-indicator
475 riece-freeze-indicator
476 riece-channel-status-indicator
478 riece-long-channel-indicator))))
480 (defun riece-channel-list-mode ()
481 "Major mode for displaying channel list.
482 All normal editing commands are turned off."
483 (kill-all-local-variables)
484 (buffer-disable-undo)
486 ;; Make `truncate-partial-width-windows' buffer local and set it to
487 ;; nil. This causes `truncate-lines' to directly control line truncation.
488 (make-local-variable 'truncate-partial-width-windows)
489 (setq truncate-partial-width-windows nil)
491 (setq major-mode 'riece-channel-list-mode
493 mode-line-buffer-identification
494 (riece-mode-line-buffer-identification '("Riece: "))
497 (make-local-hook 'riece-update-buffer-functions)
498 (add-hook 'riece-update-buffer-functions
499 'riece-update-channel-list-buffer nil t)
500 (use-local-map riece-channel-list-mode-map)
501 (run-hooks 'riece-channel-list-mode-hook))
503 (defun riece-user-list-mode ()
504 "Major mode for displaying members in the IRC current channel buffer.
505 All normal editing commands are turned off.
506 Instead, these commands are available:
507 \\{riece-user-list-mode-map}"
508 (kill-all-local-variables)
509 (buffer-disable-undo)
511 ;; Make `truncate-partial-width-windows' buffer local and set it to
512 ;; nil. This causes `truncate-lines' to directly control line truncation.
513 (make-local-variable 'truncate-partial-width-windows)
514 (setq truncate-partial-width-windows nil)
516 (setq major-mode 'riece-user-list-mode
518 mode-line-buffer-identification
519 (riece-mode-line-buffer-identification
520 '("Riece: " riece-long-channel-indicator " "))
523 (if (boundp 'transient-mark-mode)
524 (set (make-local-variable 'transient-mark-mode) t))
525 (make-local-hook 'riece-update-buffer-functions)
526 (add-hook 'riece-update-buffer-functions
527 'riece-update-user-list-buffer nil t)
528 (use-local-map riece-user-list-mode-map)
529 (run-hooks 'riece-user-list-mode-hook))
531 (defun riece-create-buffers ()
532 (let ((alist riece-buffer-alist))
535 (set-buffer (apply #'riece-get-buffer-create
537 (set (car (car alist)) (current-buffer))
538 (unless (or (null (nth 2 (car alist)))
539 (eq major-mode (nth 2 (car alist))))
540 (funcall (nth 2 (car alist))))
541 (setq alist (cdr alist))))))
543 (defvar reporter-prompt-for-summary-p)
544 (defun riece-submit-bug-report (&optional recent-messages recent-keys)
545 "Submit via mail a bug report on Riece."
546 ;; This strange form ensures that (recent-keys) is the value before
547 ;; the bug subject string is read.
548 (interactive (list (riece-recent-messages 20) (recent-keys)))
549 (message "Querying server version...")
550 (let ((pointer riece-server-process-alist)
553 (when (riece-server-process-opened (cdr (car pointer)))
554 (process-send-string (cdr (car pointer)) "VERSION\r\n")
556 (with-current-buffer (process-buffer (cdr (car pointer)))
557 riece-real-nickname))
560 (format "PRIVMSG %s :\1VERSION\1\r\n" nickname))))
561 (setq pointer (cdr pointer))))
563 (message "Querying server version...done")
565 (let ((reporter-prompt-for-summary-p t))
567 (error "Please turn on riece-debug and restart Riece."))
568 (reporter-submit-bug-report
574 "This bug report will be sent to the Riece Development Team,
575 not to your local site managers!!
577 Please write in Japanese or English, because the Riece maintainers do
578 not have translators to read other languages for them.
580 Please describe as succinctly as possible:
582 \t- What you thought should have happened.
583 \t- Precisely what you were doing at the time.
585 Also include a reliable recipe for triggering the bug, as well as
586 any lisp back-traces that you may have.
587 \(setq stack-trace-on-error t\), or \(setq debug-on-error t\) if you
588 are familiar with the debugger, to get a lisp back-trace.")
589 (delete-other-windows)
591 (goto-char (point-max))
595 (save-window-excursion
597 (riece-command-list-addons)
598 (search-forward "\n\n")
599 (buffer-substring (point-min) (point)))))
600 (insert "Recent messages from servers:\n"
601 "--------------------------")
602 (let ((pointer riece-server-process-alist))
604 (insert "\n- \"" (car (car pointer)) "\", \n"
605 (format "%S" (if (equal (car (car pointer)) "")
607 (cdr (assoc (car (car pointer))
608 riece-server-alist))))
610 (if (riece-server-process-opened (cdr (car pointer)))
612 (set-buffer (process-buffer (cdr (car pointer))))
613 (goto-char (point-max))
614 (beginning-of-line -60)
615 (buffer-substring (point) (point-max)))
617 (setq pointer (cdr pointer))))
618 ;; Insert recent keystrokes.
619 (insert "\n\nRecent keystrokes:\n"
620 "-----------------\n\n")
621 (let ((before-keys (point)))
622 (insert (key-description recent-keys))
624 (narrow-to-region before-keys (point))
625 (goto-char before-keys)
626 (while (progn (move-to-column 50) (not (eobp)))
627 (search-forward " " nil t)
629 ;; Insert recent minibuffer messages.
630 (insert "\n\nRecent messages (most recent first):\n"
631 "-----------------------------------\n"
636 ;;; riece.el ends here