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