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