cgit.sxemacs.org Git - riece/blob - lisp/riece-addon.el

   1 ;;; riece-addon.el --- add-on management
   2 ;; Copyright (C) 1998-2004 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 'font-lock)
  28 (require 'riece-options)
  29 (require 'riece-compat)
  30 (require 'riece-misc)
  31 (require 'riece-addon-modules)
  32
  33 (defgroup riece-addon-list nil
  34   "Add-on listing."
  35   :tag "Addon list"
  36   :prefix "riece-addon-list-"
  37   :group 'riece)
  38
  39 (defgroup riece-addon-list-faces nil
  40   "Faces for riece-addon-list-mode."
  41   :tag "Faces"
  42   :prefix "riece-addon-list-"
  43   :group 'riece-addon-list)
  44
  45 (defface riece-addon-list-enabled-face
  46   '((((class color) (background dark))
  47      (:foreground "PaleTurquoise" :bold t))
  48     (t
  49      (:bold t)))
  50   "Face used for displaying the enabled addon."
  51   :group 'riece-addon-list-faces)
  52 (defvar riece-addon-list-enabled-face 'riece-addon-list-enabled-face)
  53
  54 (defface riece-addon-list-disabled-face
  55   '((((class color) (background dark))
  56      (:foreground "PaleTurquoise" :italic t))
  57     (t
  58      ()))
  59   "Face used for displaying the disabled addon."
  60   :group 'riece-addon-list-faces)
  61 (defvar riece-addon-list-disabled-face 'riece-addon-list-disabled-face)
  62
  63 (defface riece-addon-list-unsupported-face
  64   '((((class color) (background dark))
  65      (:foreground "PaleTurquoise"))
  66     (t
  67      ()))
  68   "Face used for displaying the unsupported addon."
  69   :group 'riece-addon-list-faces)
  70 (defvar riece-addon-list-unsupported-face 'riece-addon-list-unsupported-face)
  71
  72 (defface riece-addon-list-uninstalled-face
  73   '((t
  74      (:italic t)))
  75   "Face used for displaying the uninstalled addon."
  76   :group 'riece-addon-list-faces)
  77 (defvar riece-addon-list-uninstalled-face 'riece-addon-list-uninstalled-face)
  78
  79 (defface riece-addon-list-unloaded-face
  80   '((t
  81      (:italic t :inverse-video t)))
  82   "Face used for displaying the unloaded addon."
  83   :group 'riece-addon-list-faces)
  84 (defvar riece-addon-list-unloaded-face 'riece-addon-list-unloaded-face)
  85
  86 (defface riece-addon-list-description-face
  87   '((((class color)
  88       (background dark))
  89      (:foreground "lightyellow"))
  90     (((class color)
  91       (background light))
  92      (:foreground "blue4"))
  93     (t
  94      ()))
  95   "Face used for displaying the description addon."
  96   :group 'riece-addon-list-faces)
  97 (defvar riece-addon-list-description-face 'riece-addon-list-description-face)
  98
  99 (defcustom riece-addon-list-mark-face-alist
 100   '((?+ . riece-addon-list-enabled-face)
 101     (?- . riece-addon-list-disabled-face)
 102     (?! . riece-addon-list-unsupported-face)
 103     (?? . riece-addon-list-uninstalled-face)
 104     (?  . riece-addon-list-unloaded-face))
 105   "An alist mapping marks on riece-addon-list-buffer to faces."
 106   :type 'list
 107   :group 'riece-addon-list)
 108
 109 (defcustom riece-addon-list-font-lock-keywords
 110   '(("^\\([-+! ] [^:]+\\): \\(.*\\)"
 111      (1 (cdr (assq (aref (match-string 1) 0)
 112                    riece-addon-list-mark-face-alist)))
 113      (2 riece-addon-list-description-face)))
 114   "Default expressions to addon in riece-addon-list-mode."
 115   :type '(repeat (list string))
 116   :group 'riece-addon-list)
 117
 118 (defvar riece-addon-list-mode-map
 119   (let ((keymap (make-sparse-keymap)))
 120     (define-key keymap "+" 'riece-command-enable-addon)
 121     (define-key keymap "-" 'riece-command-disable-addon)
 122     (define-key keymap "i" 'riece-command-insinuate-addon)
 123     (define-key keymap "u" 'riece-command-uninstall-addon)
 124     (define-key keymap "U" 'riece-command-unload-addon)
 125     (define-key keymap "n" 'next-line)
 126     (define-key keymap "p" 'previous-line)
 127     (define-key keymap " " 'scroll-up)
 128     (define-key keymap [delete] 'scroll-down)
 129     (define-key keymap "q" 'bury-buffer)
 130     keymap))
 131
 132 (defun riece-load-and-build-addon-dependencies (addons)
 133   (let ((load-path (cons riece-addon-directory load-path))
 134         dependencies)
 135     (while addons
 136       (require (car addons))            ;error will be reported here
 137       (let* ((requires-function
 138               (intern-soft
 139                (concat (symbol-name (car addons)) "-requires")))
 140              (requires
 141               (if (and requires-function
 142                        (fboundp requires-function))
 143                   (funcall requires-function)))
 144              (pointer requires)
 145              entry)
 146         ;; Increment succs' pred count.
 147         (if (setq entry (assq (car addons) dependencies))
 148             (setcar (cdr entry) (+ (length requires) (nth 1 entry)))
 149           (setq dependencies (cons (list (car addons) (length requires))
 150                                    dependencies)))
 151         ;; Merge pred's succs.
 152         (while pointer
 153           (if (setq entry (assq (car pointer) dependencies))
 154               (setcdr (cdr entry) (cons (car addons) (nthcdr 2 entry)))
 155             (setq dependencies (cons (list (car pointer) 0 (car addons))
 156                                      dependencies)))
 157           (setq pointer (cdr pointer))))
 158       (setq addons (cdr addons)))
 159     dependencies))
 160
 161 (defun riece-sort-addon-dependencies (dependencies)
 162   (let ((pointer dependencies)
 163         addons queue)
 164     (while pointer
 165       (if (zerop (nth 1 (car pointer)))
 166           (setq dependencies (delq (car pointer) dependencies)
 167                 queue (cons (car pointer) queue)))
 168       (setq pointer (cdr pointer)))
 169     (while queue
 170       (setq addons (cons (cons (car (car queue)) (nthcdr 2 (car queue)))
 171                          addons)
 172             pointer (nthcdr 2 (car queue)))
 173       (while pointer
 174         (let* ((entry (assq (car pointer) dependencies))
 175                (count (1- (nth 1 entry))))
 176           (if (zerop count)
 177               (setq dependencies (delq entry dependencies)
 178                     queue (nconc queue (list entry)))
 179             (setcar (cdr entry) count)))
 180         (setq pointer (cdr pointer)))
 181       (setq queue (cdr queue)))
 182     (if dependencies
 183         (error "Circular add-on dependency found: %S" dependencies))
 184     (nreverse addons)))
 185
 186 (defun riece-resolve-addons (addons)
 187   ;; Add files in riece-addon-directory to addons.
 188   (if (file-directory-p riece-addon-directory)
 189       (setq addons (nconc
 190                     addons
 191                     (mapcar
 192                      (lambda (name)
 193                        (unless (file-directory-p
 194                                 (expand-file-name name riece-addon-directory))
 195                          (intern (file-name-sans-extension name))))
 196                      (directory-files riece-addon-directory nil "\\`[^.]")))))
 197   ;; Sort & uniquify.
 198   (setq addons (sort addons (lambda (symbol1 symbol2)
 199                               (string-lessp (symbol-name symbol1)
 200                                             (symbol-name symbol2)))))
 201   (let ((pointer addons))
 202     (while pointer
 203       (if (memq (car pointer) (cdr pointer))
 204           (setcar pointer nil))
 205       (setq pointer (cdr pointer)))
 206     (delq nil addons))
 207   ;; Build & resolve dependencies.
 208   (riece-sort-addon-dependencies
 209    (riece-load-and-build-addon-dependencies addons)))
 210
 211 (defun riece-insinuate-addon-1 (addon verbose)
 212   (if (get addon 'riece-addon-insinuated)
 213       (if verbose
 214           (message "Add-on %S is already insinuated" addon))
 215     (require addon)
 216     (funcall (intern (concat (symbol-name addon) "-insinuate")))
 217     (put addon 'riece-addon-insinuated t)
 218     (if verbose
 219         (message "Add-on %S is insinuated" addon))
 220     (unless (get addon 'riece-addon-default-disabled)
 221       (riece-enable-addon addon t))))
 222
 223 (defun riece-insinuate-addon (addon &optional verbose)
 224   (unless (assq addon riece-addon-dependencies)
 225     (setq riece-addons (cons addon riece-addons)
 226           riece-save-variables-are-dirty t
 227           riece-addon-dependencies
 228           (riece-resolve-addons
 229            (cons addon (mapcar #'car riece-addon-dependencies)))))
 230   (let ((pointer riece-addon-dependencies))
 231     (while pointer
 232       (unless (get (car (car pointer)) 'riece-addon-insinuated)
 233         (riece-insinuate-addon-1 (car (car pointer)) verbose))
 234       (if (eq (car (car pointer)) addon)
 235           (setq pointer nil)
 236         (setq pointer (cdr pointer))))))
 237
 238 (defun riece-uninstall-addon (addon &optional verbose)
 239   (if (not (get addon 'riece-addon-insinuated))
 240       (if verbose
 241           (message "Add-on %S is not insinuated" addon))
 242     (let ((entry (assq addon riece-addon-dependencies))
 243           (enabled (intern-soft (concat (symbol-name addon) "-enabled")))
 244           (uninstall (intern-soft (concat (symbol-name addon) "-uninstall"))))
 245       (if entry
 246           (if (cdr entry)
 247               (if (= (length (cdr entry)) 1)
 248                   (error "%S depends on %S" (car (cdr entry)) addon)
 249                 (error "%s depend on %S"
 250                        (mapconcat #'symbol-name (cdr entry) ", ")
 251                        addon))
 252             (if (and enabled
 253                      (boundp enabled)
 254                      (symbol-value enabled))
 255                 (riece-disable-addon addon verbose))
 256             (if (and uninstall
 257                      (fboundp uninstall))
 258                 (funcall uninstall))
 259             (setq riece-addon-dependencies
 260                   (delq entry riece-addon-dependencies))
 261             (remprop addon 'riece-addon-insinuated)
 262             (setq riece-addons (delq addon riece-addons)
 263                   riece-save-variables-are-dirty t
 264                   riece-addon-dependencies
 265                   (riece-resolve-addons
 266                    (delq addon (mapcar #'car riece-addon-dependencies))))))
 267       (if verbose
 268           (message "Add-on %S is uninstalled" addon)))))
 269
 270 (defun riece-enable-addon (addon &optional verbose)
 271   (unless (get addon 'riece-addon-insinuated)
 272     (error "Add-on %S is not insinuated" addon))
 273   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 274     (if (or (null enabled)
 275             (not (boundp enabled)))
 276         (if verbose
 277             (message "Add-on %S doesn't support enable/disable" addon))
 278       (if (symbol-value enabled)
 279           (if verbose
 280               (message "Add-on %S is already enabled" addon))
 281         (funcall (intern (concat (symbol-name addon) "-enable")))
 282         (if verbose
 283             (message "Add-on %S enabled" addon))))))
 284
 285 (defun riece-disable-addon (addon &optional verbose)
 286   (unless (get addon 'riece-addon-insinuated)
 287     (error "Add-on %S is not insinuated" addon))
 288   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 289     (if (or (null enabled)
 290             (not (boundp enabled)))
 291         (if verbose
 292             (message "Add-on %S doesn't support enable/disable" addon))
 293       (if (symbol-value enabled)
 294           (progn
 295             (funcall (intern (concat (symbol-name addon) "-disable")))
 296             (if verbose
 297                 (message "Add-on %S disabled" addon)))
 298         (if verbose
 299             (message "Add-on %S is already enabled" addon))))))
 300
 301 (put 'riece-addon-list-mode 'font-lock-defaults
 302      '(riece-addon-list-font-lock-keywords t))
 303
 304 (defun riece-addon-list-mode ()
 305   "Major mode for displaying addon list.
 306 All normal editing commands are turned off."
 307   (kill-all-local-variables)
 308   (buffer-disable-undo)
 309   (setq major-mode 'riece-addon-list-mode
 310         mode-name "AddOns"
 311         mode-line-buffer-identification
 312         (riece-mode-line-buffer-identification '("Riece: %12b"))
 313         truncate-lines t
 314         buffer-read-only t)
 315   (use-local-map riece-addon-list-mode-map)
 316   (make-local-variable 'font-lock-defaults)
 317   (setq font-lock-defaults '(riece-addon-list-font-lock-keywords t))
 318   ;; In XEmacs, auto-initialization of font-lock is not effective
 319   ;; if buffer-file-name is not set.
 320   (font-lock-set-defaults)
 321   (run-hooks 'riece-addon-list-mode-hook))
 322
 323 (defun riece-command-list-addons ()
 324   (interactive)
 325   (set-buffer (riece-get-buffer-create "*AddOn*" 'riece-addon-list-mode))
 326   (riece-addon-list-mode)
 327   (let ((inhibit-read-only t)
 328         buffer-read-only
 329         (pointer riece-addon-dependencies)
 330         module-description-alist
 331         description enabled point)
 332     (while pointer
 333       (setq description (intern-soft (concat (symbol-name (car (car pointer)))
 334                                              "-description"))
 335             module-description-alist
 336             (cons (cons (car (car pointer))
 337                         (if (and description
 338                                  (boundp description))
 339                             (symbol-value description)
 340                           "(no description)"))
 341                   module-description-alist)
 342             pointer (cdr pointer)))
 343     (setq pointer riece-addon-modules)
 344     (while pointer
 345       (unless (assq (car (car pointer))
 346                     module-description-alist)
 347         (setq module-description-alist
 348               (cons (car pointer) module-description-alist)))
 349       (setq pointer (cdr pointer)))
 350     (erase-buffer)
 351     (riece-kill-all-overlays)
 352     (setq pointer (sort module-description-alist
 353                         (lambda (entry1 entry2)
 354                           (string-lessp (symbol-name (car entry1))
 355                                         (symbol-name (car entry2))))))
 356     (while pointer
 357       (setq enabled (intern-soft (concat (symbol-name (car (car pointer)))
 358                                          "-enabled")))
 359       (setq point (point))
 360       (insert (format "%c %S: %s\n"
 361                       (if (not (featurep (car (car pointer))))
 362                           ?
 363                         (if (not (get (car (car pointer))
 364                                       'riece-addon-insinuated))
 365                             ??
 366                           (if (null enabled)
 367                               ?!
 368                             (if (symbol-value enabled)
 369                                 ?+
 370                               ?-))))
 371                       (car (car pointer))
 372                       (cdr (car pointer))))
 373       (put-text-property point (point) 'riece-addon (car (car pointer)))
 374       (setq pointer (cdr pointer)))
 375     (insert "
 376 Symbols in the leftmost column:
 377
 378   +     The add-on is enabled.
 379   -     The add-on is disabled.
 380   !     The add-on doesn't support enable/disable operation.
 381   ?     The add-on is not insinuated.
 382         The add-on is not loaded.
 383 ")
 384     (insert (substitute-command-keys "
 385 Useful keys:
 386
 387   `\\[riece-command-enable-addon]' to enable the current add-on.
 388   `\\[riece-command-disable-addon]' to disable the current add-on.
 389 "))
 390     (goto-char (point-min))
 391     (pop-to-buffer (current-buffer))
 392     (delete-other-windows)))
 393
 394 (defun riece-addon-list-set-point (addon)
 395   (let ((point (point-min)))
 396     (while (and (not (eq (get-text-property point 'riece-addon) addon))
 397                 (setq point (next-single-property-change point
 398                                                          'riece-addon))))
 399     (if point
 400         (goto-char point))))
 401
 402 (defun riece-command-enable-addon (addon)
 403   (interactive
 404    (list
 405     (or (if (eq major-mode 'riece-addon-list-mode)
 406             (get-text-property (point) 'riece-addon))
 407         (intern-soft
 408          (completing-read "Add-on: "
 409                           (mapcar (lambda (dependency)
 410                                     (list (symbol-name (car dependency))))
 411                                   riece-addon-dependencies)
 412                           (lambda (pointer)
 413                             (let ((enabled
 414                                    (intern-soft (concat (car pointer)
 415                                                         "-enabled"))))
 416                               (and enabled
 417                                    (null (symbol-value enabled)))))
 418                           t)))))
 419   (riece-enable-addon addon t)
 420   (when (eq major-mode 'riece-addon-list-mode)
 421     (riece-command-list-addons)
 422     (riece-addon-list-set-point addon)))
 423
 424 (defun riece-command-disable-addon (addon)
 425   (interactive
 426    (list
 427     (or (if (eq major-mode 'riece-addon-list-mode)
 428             (get-text-property (point) 'riece-addon))
 429         (intern-soft
 430          (completing-read "Add-on: "
 431                           (mapcar (lambda (dependency)
 432                                     (list (symbol-name (car dependency))))
 433                                   riece-addon-dependencies)
 434                           (lambda (pointer)
 435                             (let ((enabled
 436                                    (intern-soft (concat (car pointer)
 437                                                         "-enabled"))))
 438                               (and enabled
 439                                    (symbol-value enabled))))
 440                           t)))))
 441   (riece-disable-addon addon t)
 442   (when (eq major-mode 'riece-addon-list-mode)
 443     (riece-command-list-addons)
 444     (riece-addon-list-set-point addon)))
 445
 446 (defun riece-command-insinuate-addon (addon)
 447   (interactive
 448    (list
 449     (or (if (eq major-mode 'riece-addon-list-mode)
 450             (get-text-property (point) 'riece-addon))
 451         (intern-soft
 452          (completing-read "Add-on: "
 453                           (mapcar (lambda (dependency)
 454                                     (list (symbol-name (car dependency))))
 455                                   riece-addon-modules)
 456                           (lambda (pointer)
 457                             (not (get (car pointer) 'riece-addon-insinuated)))
 458                           t)))))
 459   (riece-insinuate-addon addon t)
 460   (when (eq major-mode 'riece-addon-list-mode)
 461     (riece-command-list-addons)
 462     (riece-addon-list-set-point addon)))
 463
 464 (defun riece-command-uninstall-addon (addon)
 465   (interactive
 466    (list
 467     (or (if (eq major-mode 'riece-addon-list-mode)
 468             (get-text-property (point) 'riece-addon))
 469         (intern-soft
 470          (completing-read "Add-on: "
 471                           (mapcar (lambda (dependency)
 472                                     (list (symbol-name (car dependency))))
 473                                   riece-addon-dependencies)
 474                           (lambda (pointer)
 475                             (get (car pointer) 'riece-addon-insinuated))
 476                           t)))))
 477   (riece-uninstall-addon addon t)
 478   (when (eq major-mode 'riece-addon-list-mode)
 479     (riece-command-list-addons)
 480     (riece-addon-list-set-point addon)))
 481
 482 (defun riece-command-unload-addon (addon)
 483   (interactive
 484    (list
 485     (or (if (eq major-mode 'riece-addon-list-mode)
 486             (get-text-property (point) 'riece-addon))
 487         (intern-soft
 488          (completing-read "Add-on: "
 489                           (mapcar (lambda (dependency)
 490                                     (list (symbol-name (car dependency))))
 491                                   riece-addon-dependencies)
 492                           (lambda (pointer)
 493                             (get (car pointer) 'riece-addon-insinuated))
 494                           t)))))
 495   (riece-uninstall-addon addon t)
 496   (if (get addon 'riece-addon-not-unloadable)
 497       (message "Add-on %S is not allowed to unload" addon)
 498     (unload-feature addon)
 499     (message "Add-on %S is unloaded" addon))
 500   (when (eq major-mode 'riece-addon-list-mode)
 501     (riece-command-list-addons)
 502     (riece-addon-list-set-point addon)))
 503
 504 (provide 'riece-addon)
 505
 506 ;;; riece-addon.el ends here