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
  32 (defgroup riece-addon-list nil
  33   "Add-on management"
  34   :tag "Addon"
  35   :prefix "riece-"
  36   :group 'riece)
  37
  38 (defgroup riece-addon-list-faces nil
  39   "Faces for riece-addon-list-mode"
  40   :tag "Faces"
  41   :prefix "riece-addon-list"
  42   :group 'riece-addon)
  43
  44 (defface riece-addon-list-enabled-face
  45   '((((class color) (background dark))
  46      (:foreground "PaleTurquoise" :bold t))
  47     (t
  48      (:bold t)))
  49   "Face used for displaying the enabled addon."
  50   :group 'riece-addon-list-faces)
  51 (defvar riece-addon-list-enabled-face 'riece-addon-list-enabled-face)
  52
  53 (defface riece-addon-list-disabled-face
  54   '((((class color) (background dark))
  55      (:foreground "PaleTurquoise" :italic t))
  56     (t
  57      (:italic t)))
  58   "Face used for displaying the disabled addon."
  59   :group 'riece-addon-list-faces)
  60 (defvar riece-addon-list-disabled-face 'riece-addon-list-disabled-face)
  61
  62 (defface riece-addon-list-unsupported-face
  63   '((((class color) (background dark))
  64      (:foreground "PaleTurquoise"))
  65     (t
  66      ()))
  67   "Face used for displaying the unsupported addon."
  68   :group 'riece-addon-list-faces)
  69 (defvar riece-addon-list-unsupported-face 'riece-addon-list-unsupported-face)
  70
  71 (defface riece-addon-list-unknown-face
  72   '((t
  73      (:foreground "red")))
  74   "Face used for displaying the unknown addon."
  75   :group 'riece-addon-list-faces)
  76 (defvar riece-addon-list-unknown-face 'riece-addon-list-unknown-face)
  77
  78 (defface riece-addon-list-description-face
  79   '((((class color)
  80       (background dark))
  81      (:foreground "lightyellow"))
  82     (((class color)
  83       (background light))
  84      (:foreground "blue4"))
  85     (t
  86      ()))
  87   "Face used for displaying the description addon."
  88   :group 'riece-addon-list-faces)
  89 (defvar riece-addon-list-description-face 'riece-addon-list-description-face)
  90
  91 (defcustom riece-addon-list-mark-face-alist
  92   '((?+ . riece-addon-list-enabled-face)
  93     (?- . riece-addon-list-disabled-face)
  94     (?! . riece-addon-list-unsupported-face)
  95     (?? . riece-addon-list-unknown-face))
  96   "An alist mapping marks on riece-addon-list-buffer to faces."
  97   :type 'list
  98   :group 'riece-addon-list)
  99
 100 (defcustom riece-addon-list-font-lock-keywords
 101   '(("^\\([-+!?] [^:]+\\): \\(.*\\)"
 102      (1 (cdr (assq (aref (match-string 1) 0)
 103                    riece-addon-list-mark-face-alist)))
 104      (2 riece-addon-list-description-face)))
 105   "Default expressions to addon in riece-addon-list-mode."
 106   :type '(repeat (list string))
 107   :group 'riece-addon-list)
 108
 109 (defvar riece-addon-list-mode-map
 110   (let ((keymap (make-sparse-keymap)))
 111     (define-key keymap "+" 'riece-command-enable-addon)
 112     (define-key keymap "-" 'riece-command-disable-addon)
 113     (define-key keymap "n" 'next-line)
 114     (define-key keymap "p" 'previous-line)
 115     (define-key keymap " " 'scroll-up)
 116     (define-key keymap [delete] 'scroll-down)
 117     (define-key keymap "q" 'bury-buffer)
 118     keymap))
 119
 120 (defun riece-load-and-build-addon-dependencies (addons)
 121   (let ((load-path (cons riece-addon-directory load-path))
 122         dependencies)
 123     (while addons
 124       (require (car addons))            ;error will be reported here
 125       (let* ((requires
 126               (funcall (or (intern-soft
 127                             (concat (symbol-name (car addons)) "-requires"))
 128                            #'ignore)))
 129              (pointer requires)
 130              entry)
 131         ;; Increment succs' pred count.
 132         (if (setq entry (assq (car addons) dependencies))
 133             (setcar (cdr entry) (+ (length requires) (nth 1 entry)))
 134           (setq dependencies (cons (list (car addons) (length requires))
 135                                    dependencies)))
 136         ;; Merge pred's succs.
 137         (while pointer
 138           (if (setq entry (assq (car pointer) dependencies))
 139               (setcdr (cdr entry)
 140                       (cons (car addons) (nthcdr 2 entry)))
 141             (setq dependencies (cons (list (car pointer) 0 (car addons))
 142                                      dependencies)))
 143           (setq pointer (cdr pointer))))
 144       (setq addons (cdr addons)))
 145     dependencies))
 146
 147 (defun riece-resolve-addon-dependencies (addons)
 148   (let ((pointer addons)
 149         dependencies queue)
 150     ;; Uniquify, first.
 151     (while pointer
 152       (if (memq (car pointer) (cdr pointer))
 153           (setcar pointer nil))
 154       (setq pointer (cdr pointer)))
 155     (setq dependencies (riece-load-and-build-addon-dependencies
 156                         (delq nil addons))
 157           pointer dependencies)
 158     ;; Sort them.
 159     (while pointer
 160       (if (zerop (nth 1 (car pointer)))
 161           (setq dependencies (delq (car pointer) dependencies)
 162                 queue (cons (car pointer) queue)))
 163       (setq pointer (cdr pointer)))
 164     (setq addons nil)
 165     (while queue
 166       (setq addons (cons (car (car queue)) addons)
 167             pointer (nthcdr 2 (car queue)))
 168       (while pointer
 169         (let* ((entry (assq (car pointer) dependencies))
 170                (count (1- (nth 1 entry))))
 171           (if (zerop count)
 172               (progn
 173                 (setq dependencies (delq entry dependencies)
 174                       queue (nconc queue (list entry))))
 175             (setcar (cdr entry) count)))
 176         (setq pointer (cdr pointer)))
 177       (setq queue (cdr queue)))
 178     (if dependencies
 179         (error "Circular add-on dependency found"))
 180     (nreverse addons)))
 181
 182 (defun riece-resolve-addons (addons)
 183   (riece-resolve-addon-dependencies
 184    (if (file-directory-p riece-addon-directory)
 185        (append addons
 186                (mapcar
 187                 (lambda (name)
 188                   (unless (file-directory-p
 189                            (expand-file-name name riece-addon-directory))
 190                     (intern (file-name-sans-extension name))))
 191                 (directory-files riece-addon-directory nil "\\`[^.]" t)))
 192      addons)))
 193
 194 (defun riece-insinuate-addon (addon &optional verbose)
 195   (require addon)               ;implicit dependency
 196   (funcall (intern (concat (symbol-name addon) "-insinuate")))
 197   (if verbose
 198       (message "Add-on %S is insinuated" addon)))
 199
 200 (defun riece-enable-addon (addon &optional verbose)
 201   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 202     (if (null enabled)
 203         (if verbose
 204             (message "Add-on %S doesn't support enable/disable" addon))
 205       (if (symbol-value enabled)
 206           (if verbose
 207               (message "Can't enable add-on %S" addon))
 208         (funcall (intern (concat (symbol-name addon) "-enable")))
 209         (if verbose
 210             (message "Add-on %S enabled" addon))))))
 211
 212 (defun riece-disable-addon (addon &optional verbose)
 213   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 214     (if (null enabled)
 215         (if verbose
 216             (message "Add-on %S doesn't support enable/disable" addon))
 217       (if (symbol-value enabled)
 218           (progn
 219             (funcall (intern (concat (symbol-name addon) "-disable")))
 220             (if verbose
 221                 (message "Add-on %S disabled" addon)))
 222         (if verbose
 223             (message "Can't disable add-on %S" addon))))))
 224
 225 (put 'riece-addon-list-mode 'font-lock-defaults
 226      '(riece-addon-list-font-lock-keywords t))
 227
 228 (defun riece-addon-list-mode ()
 229   "Major mode for displaying addon list.
 230 All normal editing commands are turned off."
 231   (kill-all-local-variables)
 232   (buffer-disable-undo)
 233   (setq major-mode 'riece-addon-list-mode
 234         mode-name "AddOns"
 235         mode-line-buffer-identification
 236         (riece-mode-line-buffer-identification '("Riece: %12b"))
 237         truncate-lines t
 238         buffer-read-only t)
 239   (use-local-map riece-addon-list-mode-map)
 240   (make-local-variable 'font-lock-defaults)
 241   (setq font-lock-defaults '(riece-addon-list-font-lock-keywords t))
 242   ;; In XEmacs, auto-initialization of font-lock is not affective
 243   ;; when buffer-file-name is not set.
 244   (font-lock-set-defaults)
 245   (run-hooks 'riece-addon-list-mode-hook))
 246
 247 (defun riece-command-list-addons ()
 248   (interactive)
 249   (set-buffer (riece-get-buffer-create "*AddOns*" 'riece-addon-list-mode))
 250   (riece-addon-list-mode)
 251   (let ((inhibit-read-only t)
 252         buffer-read-only
 253         (pointer (sort (copy-sequence riece-addons)
 254                        (lambda (symbol1 symbol2)
 255                                   (string-lessp (symbol-name symbol1)
 256                                                 (symbol-name symbol2)))))
 257         enabled description point)
 258     (erase-buffer)
 259     (riece-kill-all-overlays)
 260     (while pointer
 261       (setq enabled (intern-soft (concat (symbol-name (car pointer))
 262                                          "-enabled"))
 263             description (intern-soft (concat (symbol-name (car pointer))
 264                                              "-description")))
 265       (setq point (point))
 266       (insert (format "%c %S: %s\n"
 267                       (if (not (featurep (car pointer)))
 268                           ??
 269                         (if (null enabled)
 270                             ?!
 271                           (if (symbol-value enabled)
 272                               ?+
 273                             ?-)))
 274                       (car pointer)
 275                       (if description
 276                           (symbol-value description)
 277                         "(no description)")))
 278       (put-text-property point (point) 'riece-addon (car pointer))
 279       (setq pointer (cdr pointer)))
 280     (insert "
 281 Symbols in the leftmost column:
 282
 283   +     The add-on is enabled.
 284   -     The add-on is disabled.
 285   !     The add-on doesn't support enable/disable operation.
 286   ?     The add-on status is unknown.
 287 ")
 288     (insert (substitute-command-keys "
 289 Useful keys:
 290
 291   `\\[riece-command-enable-addon]' to enable the current add-on.
 292   `\\[riece-command-disable-addon]' to disable the current add-on.
 293 "))
 294     (goto-char (point-min))
 295     (pop-to-buffer (current-buffer))
 296     (delete-other-windows)))
 297
 298 (defun riece-command-enable-addon (addon)
 299   (interactive
 300    (list
 301     (or (if (eq major-mode 'riece-addon-list-mode)
 302             (get-text-property (point) 'riece-addon))
 303         (intern-soft
 304          (completing-read "Add-on: "
 305                           (mapcar (lambda (addon)
 306                                     (list (symbol-name addon)))
 307                                   riece-addons)
 308                           (lambda (pointer)
 309                             (let ((enabled
 310                                    (intern-soft (concat (car pointer)
 311                                                         "-enabled"))))
 312                               (and enabled
 313                                    (null (symbol-value enabled)))))
 314                           t)))))
 315   (riece-enable-addon addon t)
 316   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 317     (if (and (eq major-mode 'riece-addon-list-mode)
 318              (get-text-property (point) 'riece-addon)
 319              enabled (symbol-value enabled))
 320         (save-excursion
 321           (beginning-of-line)
 322           (let ((point (point))
 323                 (inhibit-read-only t)
 324                 buffer-read-only)
 325             (delete-char 1)
 326             (insert "+")
 327             (put-text-property point (point) 'riece-addon addon))))))
 328
 329 (defun riece-command-disable-addon (addon)
 330   (interactive
 331    (list
 332     (or (if (eq major-mode 'riece-addon-list-mode)
 333             (get-text-property (point) 'riece-addon))
 334         (intern-soft
 335          (completing-read "Add-on: "
 336                           (mapcar (lambda (addon)
 337                                     (list (symbol-name addon)))
 338                                   riece-addons)
 339                           (lambda (pointer)
 340                             (let ((enabled
 341                                    (intern-soft (concat (car pointer)
 342                                                         "-enabled"))))
 343                               (and enabled
 344                                    (symbol-value enabled))))
 345                           t)))))
 346   (riece-disable-addon addon t)
 347   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 348     (if (and (eq major-mode 'riece-addon-list-mode)
 349              (get-text-property (point) 'riece-addon)
 350              enabled (null (symbol-value enabled)))
 351         (save-excursion
 352           (beginning-of-line)
 353           (let ((point (point))
 354                 (inhibit-read-only t)
 355                 buffer-read-only)
 356             (delete-char 1)
 357             (insert "-")
 358             (put-text-property point (point) 'riece-addon addon))))))
 359
 360 (provide 'riece-addon)
 361
 362 ;;; riece-addon.el ends here