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