* Riece: Version 0.0.4 released.
[riece] / lisp / riece.el
1 ;;; riece.el --- IRC client for Emacsen
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 (if (featurep 'xemacs)
28     (require 'riece-xemacs)
29   (require 'riece-emacs))
30
31 (require 'riece-filter)
32 (require 'riece-display)
33 (require 'riece-server)
34 (require 'riece-compat)
35 (require 'riece-commands)
36
37 (defvar riece-channel-list-mode-map (make-sparse-keymap))
38 (defvar riece-user-list-mode-map (make-sparse-keymap))
39
40 (defvar riece-dialogue-mode-map
41   (let ((keymap (make-keymap)))
42     (suppress-keymap keymap 'nodigit)
43     keymap))
44
45 (defvar riece-command-mode-map (make-keymap))
46 (defvar riece-command-map (make-sparse-keymap))
47
48 (defvar riece-command-mode-syntax-table nil)
49
50 (put 'riece-command-mode 'mode-class 'special)
51 (put 'riece-dialogue-mode 'mode-class 'special)
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)
55 (put 'riece-others-mode 'derived-mode-parent 'riece-dialogue-mode)
56
57 (defvar riece-buffer-mode-alist
58   '((riece-dialogue-buffer . riece-dialogue-mode)
59     (riece-others-buffer . riece-others-mode)
60     (riece-channel-list-buffer . riece-channel-list-mode)
61     (riece-private-buffer . riece-dialogue-mode)
62     (riece-wallops-buffer)))
63     
64 (defvar riece-select-keys
65   '("1" riece-command-switch-to-channel-by-number-1
66     "2" riece-command-switch-to-channel-by-number-2
67     "3" riece-command-switch-to-channel-by-number-3
68     "4" riece-command-switch-to-channel-by-number-4
69     "5" riece-command-switch-to-channel-by-number-5
70     "6" riece-command-switch-to-channel-by-number-6
71     "7" riece-command-switch-to-channel-by-number-7
72     "8" riece-command-switch-to-channel-by-number-8
73     "9" riece-command-switch-to-channel-by-number-9
74     "0" riece-command-switch-to-channel-by-number-10
75     "\C-c1" riece-command-switch-to-channel-by-number-11
76     "\C-c2" riece-command-switch-to-channel-by-number-12
77     "\C-c3" riece-command-switch-to-channel-by-number-13
78     "\C-c4" riece-command-switch-to-channel-by-number-14
79     "\C-c5" riece-command-switch-to-channel-by-number-15
80     "\C-c6" riece-command-switch-to-channel-by-number-16
81     "\C-c7" riece-command-switch-to-channel-by-number-17
82     "\C-c8" riece-command-switch-to-channel-by-number-18
83     "\C-c9" riece-command-switch-to-channel-by-number-19
84     "\C-c0" riece-command-switch-to-channel-by-number-20))
85
86 ;;; Keymap macros. -- borrowed from `gnus-util.el'.
87 (defmacro riece-local-set-keys (&rest plist)
88   "Set the keys in PLIST in the current keymap."
89   `(riece-define-keys-1 (current-local-map) ',plist))
90
91 (defmacro riece-define-keys (keymap &rest plist)
92   "Assign KEYMAP keys from PLIST."
93   `(riece-define-keys-1 ',keymap ',plist))
94
95 (defmacro riece-define-keys-safe (keymap &rest plist)
96   "Assign KEYMAP keys from PLIST without overwriting previous definitions."
97   `(riece-define-keys-1 ',keymap ',plist t))
98
99 (put 'riece-define-keys 'lisp-indent-function 1)
100 (put 'riece-define-keys-safe 'lisp-indent-function 1)
101 (put 'riece-local-set-keys 'lisp-indent-function 1)
102
103 (defun riece-define-keys-1 (keymap plist &optional safe)
104   "Assign KEYMAP keys from PLIST.
105 If optional argument SAFE is nil, overwrite previous definitions."
106   (unless keymap
107     (error "Can't set keys in a null keymap"))
108   (cond
109    ((symbolp keymap)
110     (setq keymap (symbol-value keymap)))
111    ((keymapp keymap))
112    ((listp keymap)
113     (set (car keymap) nil)
114     (define-prefix-command (car keymap))
115     (define-key (symbol-value (nth 2 keymap)) (nth 1 keymap) (car keymap))
116     (setq keymap (symbol-value (car keymap)))))
117   (let (key)
118     (while plist
119       (if (symbolp (setq key (car plist)))
120           (setq key (symbol-value key)))
121       (setq plist (cdr plist))
122       (if (or (not safe)
123               (eq (lookup-key keymap key) 'undefined))
124           (define-key keymap key (car plist))
125         (car plist))
126       (setq plist (cdr plist)))))
127
128 (when t
129   (riece-define-keys riece-dialogue-mode-map
130     "\177" scroll-down
131     [delete] scroll-down
132     [backspace] scroll-down
133     [return] scroll-up
134     " " scroll-up
135     "$" end-of-buffer
136     "/" riece-command-raw
137     ">" end-of-buffer
138     "<" beginning-of-buffer
139     "\C-ta" riece-command-toggle-away
140     "c" riece-command-select-command-buffer
141     "f" riece-command-finger
142     "\C-tf" riece-command-toggle-freeze
143     "\C-to" riece-command-toggle-own-freeze
144     "\C-tu" riece-command-toggle-user-list-buffer-mode
145     "\C-tc" riece-command-toggle-channel-buffer-mode
146     "\C-tC" riece-command-toggle-channel-list-buffer-mode
147     "i" riece-command-invite
148     "j" riece-command-join
149     "\C-k" riece-command-kick
150     "l" riece-command-list
151     "m" riece-dialogue-enter-message
152     "M" riece-command-change-mode
153     "n" riece-command-change-nickname
154     "\C-n" riece-command-names
155     "o" other-window
156     "O" riece-command-open-server
157     "C" riece-command-close-server
158     "M" riece-command-universal-server-name-argument
159     "q" riece-command-quit
160     "r" riece-command-configure-windows
161     "x" riece-command-copy-region
162     "t" riece-command-topic
163     "w" riece-command-who)
164
165   (riece-define-keys riece-command-mode-map
166     "\r" riece-command-enter-message
167     [(control return)] riece-command-enter-message-as-notice)
168
169   (riece-define-keys (riece-command-map "\C-c" riece-command-mode-map)
170     "\177" riece-command-scroll-down
171     [delete] riece-command-scroll-down
172     [backspace] riece-command-scroll-down
173     " " riece-command-scroll-up
174     "$" riece-command-end-of-buffer
175     ">" riece-command-next-channel
176     "<" riece-command-previous-channel
177     "\C-j" riece-command-next-channel
178     "\C-n" riece-command-names
179     "l" riece-command-list
180     "\C-m" riece-command-change-mode
181     "o" riece-command-set-operators
182     "\C-p" riece-command-part
183     "r" riece-command-configure-windows
184     "v" riece-command-set-speakers)
185   (set-keymap-parent riece-command-map riece-dialogue-mode-map)
186
187   (riece-define-keys riece-user-list-mode-map
188     "o" riece-command-set-operators
189     "v" riece-command-set-voices
190     "f" riece-command-finger
191     " " riece-command-nick-scroll-up
192     "\177" riece-command-nick-scroll-down
193     [delete] riece-command-nick-scroll-down
194     [backspace] riece-command-nick-scroll-down
195     "c" riece-command-select-command-buffer)
196
197   (riece-define-keys riece-channel-list-mode-map
198     ">" riece-command-next-channel
199     "<" riece-command-previous-channel
200     "o" other-window
201     "c" riece-command-select-command-buffer)
202
203   (riece-define-keys-1 riece-dialogue-mode-map riece-select-keys)
204   (riece-define-keys-1 riece-channel-list-mode-map riece-select-keys))
205
206 (defun riece-read-variables-files (&optional file)
207   "Read variables FILEs."
208   (or (file-directory-p riece-directory)
209       (make-directory riece-directory))
210   (let ((files (if file
211                    (setq riece-variables-file file
212                          riece-variables-files (list file))
213                  riece-variables-files)))
214     (while files
215       (condition-case nil
216           (load (expand-file-name (car files)))
217         (file-error nil))
218       (setq files (cdr files)))))
219
220 (defvar print-quoted)
221 (defvar print-escape-multibyte)
222 (defun riece-save-variables-files ()
223   "Save current settings to `riece-variables-file'."
224   (with-temp-file riece-saved-variables-file
225     (let ((print-quoted t)
226           (print-readably t)
227           print-escape-multibyte
228           print-level
229           print-length
230           (variables riece-saved-forms))
231       (while variables
232         (prin1 `(setq ,(car variables)
233                       ',(symbol-value (car variables)))
234                (current-buffer))
235         (insert "\n")
236         (setq variables (cdr variables)))))
237   (setq riece-save-variables-are-dirty nil))
238
239 ;;;###autoload
240 (defun riece (&optional confirm)
241   "Connect to the IRC server and start chatting.
242 If optional argument CONFIRM is non-nil, ask which IRC server to connect.
243 If already connected, just pop up the windows."
244   (interactive "P")
245   (riece-read-variables-files (if noninteractive
246                                   (car command-line-args-left)))
247   (riece-insinuate-addons riece-addons)
248   (run-hooks 'riece-after-load-startup-hook)
249   (if (riece-server-opened)
250       (riece-configure-windows)
251     (switch-to-buffer (riece-get-buffer-create riece-command-buffer))
252     (unless (eq major-mode 'riece-command-mode)
253       (riece-command-mode))
254     (if (or confirm (null riece-server))
255         (setq riece-server (completing-read "Server: " riece-server-alist)))
256     (if (stringp riece-server)
257         (setq riece-server (riece-server-name-to-server riece-server)))
258     (riece-open-server riece-server)
259     (riece-create-buffers)
260     (riece-configure-windows)
261     (let ((channel-list riece-startup-channel-list))
262       (while channel-list
263         (if (listp (car channel-list))
264             (riece-command-join (car (car channel-list))
265                                 (cadr (car channel-list)))
266           (riece-command-join (car channel-list)))
267         (setq channel-list (cdr channel-list))))
268     (run-hooks 'riece-startup-hook)
269     (message "%s" (substitute-command-keys
270                    "Type \\[describe-mode] for help"))))
271
272 (defun riece-exit ()
273   (setq riece-server nil)
274   (if riece-save-variables-are-dirty
275       (riece-save-variables-files))
276   (riece-clear-system)
277   (run-hooks 'riece-exit-hook))
278
279 (defun riece-command-mode ()
280   "Major mode for Riece.  Normal edit function are available.
281 Typing Return or Linefeed enters the current line in the dialogue.
282 The following special commands are available:
283 For a list of the generic commands type \\[riece-command-generic] ? RET.
284 \\{riece-command-mode-map}"
285   (interactive)
286   (kill-all-local-variables)
287
288   (setq riece-away-indicator "-"
289         riece-operator-indicator "-"
290         major-mode 'riece-command-mode
291         mode-name "Commands"
292         mode-line-buffer-identification
293         (riece-mode-line-buffer-identification
294          '("Riece: "
295            riece-away-indicator
296            riece-operator-indicator
297            riece-freeze-indicator
298            " "
299            riece-user-indicator
300            " "
301            riece-current-channel)))
302   (riece-simplify-mode-line-format)
303   (use-local-map riece-command-mode-map)
304
305   (unless riece-command-mode-syntax-table
306     (setq riece-command-mode-syntax-table
307           (copy-syntax-table (syntax-table)))
308     (set-syntax-table riece-command-mode-syntax-table)
309     (mapcar
310      (lambda (c) (modify-syntax-entry c "w"))
311      "^[]{}'`"))
312
313   (run-hooks 'riece-command-mode-hook))
314   
315 (defun riece-dialogue-mode ()
316   "Major mode for displaying the IRC dialogue.
317 All normal editing commands are turned off.
318 Instead, these commands are available:
319 \\{riece-dialogue-mode-map}"
320   (kill-all-local-variables)
321
322   (make-local-variable 'riece-freeze)
323   (make-local-variable 'tab-stop-list)
324
325   (setq riece-freeze riece-default-freeze
326         riece-away-indicator "-"
327         riece-operator-indicator "-"
328         major-mode 'riece-dialogue-mode
329         mode-name "Dialogue"
330         mode-line-buffer-identification
331         (riece-mode-line-buffer-identification
332          '("Riece: "
333            riece-away-indicator
334            riece-operator-indicator
335            riece-freeze-indicator
336            " "
337            riece-channel-list-indicator " "))
338         buffer-read-only t
339         tab-stop-list riece-tab-stop-list)
340   (riece-update-status-indicators)
341   (riece-simplify-mode-line-format)
342   (use-local-map riece-dialogue-mode-map)
343   (buffer-disable-undo)
344   (run-hooks 'riece-dialogue-mode-hook))
345
346 (define-derived-mode riece-others-mode riece-dialogue-mode
347   "Others"
348   "Major mode for displaying the IRC others message except current channel.
349 All normal editing commands are turned off.
350 Instead, these commands are available:
351 \\{riece-others-mode-map}")
352
353 (define-derived-mode riece-channel-mode riece-dialogue-mode
354   "Channel"
355   "Major mode for displaying the IRC current channel buffer.
356 All normal editing commands are turned off.
357 Instead, these commands are available:
358 \\{riece-channel-mode-map}"
359   (setq mode-line-buffer-identification
360         (riece-mode-line-buffer-identification
361          '("Riece: "
362            riece-away-indicator
363            riece-operator-indicator
364            riece-freeze-indicator
365            " "
366            riece-channel-indicator))))
367
368 (defun riece-channel-list-mode ()
369   "Major mode for displaying channel list.
370 All normal editing commands are turned off."
371   (kill-all-local-variables)
372   (setq major-mode 'riece-channel-list-mode
373         mode-name "Channels"
374         mode-line-buffer-identification
375         (riece-mode-line-buffer-identification '("Riece: "))
376         truncate-lines t
377         buffer-read-only t)
378   (use-local-map riece-channel-list-mode-map)
379   (run-hooks 'riece-channel-list-mode-hook))
380
381 (defun riece-user-list-mode ()
382   "Major mode for displaying members in the IRC current channel buffer.
383 All normal editing commands are turned off.
384 Instead, these commands are available:
385 \\{riece-user-list-mode-map}"
386   (kill-all-local-variables)
387   (setq major-mode 'riece-user-list-mode
388         mode-name "User list"
389         mode-line-buffer-identification
390         (riece-mode-line-buffer-identification
391          '("Riece: " riece-channel-indicator " "))
392         truncate-lines t
393         buffer-read-only t)
394   (if (boundp 'transient-mark-mode)
395       (set (make-local-variable 'transient-mark-mode) t))
396   (use-local-map riece-user-list-mode-map)
397   (run-hooks 'riece-user-list-mode-hook))
398
399 (defun riece-create-buffers ()
400   (let ((alist riece-buffer-mode-alist))
401     (while alist
402       (save-excursion
403         (set-buffer (riece-get-buffer-create
404                      (symbol-value (car (car alist)))))
405         (unless (or (null (cdr (car alist)))
406                     (eq major-mode (cdr (car alist))))
407           (funcall (cdr (car alist))))
408         (setq alist (cdr alist))))))
409
410 (defun riece-load-and-build-addon-dependencies (addons)
411   (let ((load-path (cons riece-addon-directory load-path))
412         dependencies)
413     (while addons
414       (require (car addons))            ;error will be reported here
415       (let* ((requires
416               (funcall (or (intern-soft
417                             (concat (symbol-name (car addons)) "-requires"))
418                            #'ignore)))
419              (pointer requires)
420              entry)
421         ;; Increment succs' pred count.
422         (if (setq entry (assq (car addons) dependencies))
423             (setcar (cdr entry) (+ (length requires) (nth 1 entry)))
424           (setq dependencies (cons (list (car addons) (length requires))
425                                    dependencies)))
426         ;; Merge pred's succs.
427         (while pointer
428           (if (setq entry (assq (car pointer) dependencies))
429               (setcdr (cdr entry)
430                       (cons (car addons) (nthcdr 2 entry)))
431             (setq dependencies (cons (list (car pointer) 0 (car addons))
432                                      dependencies)))
433           (setq pointer (cdr pointer))))
434       (setq addons (cdr addons)))
435     dependencies))
436
437 (defun riece-insinuate-addons (addons)
438   (let ((pointer addons)
439         dependencies queue)
440     ;; Uniquify, first.
441     (while pointer
442       (if (memq (car pointer) (cdr pointer))
443           (setcar pointer nil))
444       (setq pointer (cdr pointer)))
445     (setq dependencies (riece-load-and-build-addon-dependencies
446                         (delq nil addons))
447           pointer dependencies)
448     ;; Sort them.
449     (while pointer
450       (if (zerop (nth 1 (car pointer)))
451           (setq dependencies (delq (car pointer) dependencies)
452                 queue (cons (car pointer) queue)))
453       (setq pointer (cdr pointer)))
454     (setq addons nil)
455     (while queue
456       (setq addons (cons (car (car queue)) addons)
457             pointer (nthcdr 2 (car queue)))
458       (while pointer
459         (let* ((entry (assq (car pointer) dependencies))
460                (count (1- (nth 1 entry))))
461           (if (zerop count)
462               (progn
463                 (setq dependencies (delq entry dependencies)
464                       queue (nconc queue (list entry))))
465             (setcar (cdr entry) count)))
466         (setq pointer (cdr pointer)))
467       (setq queue (cdr queue)))
468     (if dependencies
469         (error "Circular add-on dependency found"))
470     (while addons
471       (require (car addons))            ;implicit dependency
472       (funcall (intern (concat (symbol-name (car addons)) "-insinuate")))
473       (setq addons (cdr addons)))))
474
475 (provide 'riece)
476
477 ;;; riece.el ends here