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