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   (if (get addon 'riece-addon-insinuated)
 196       (if verbose
 197           (message "Add-on %S is alread insinuated" addon))
 198     (funcall (intern (concat (symbol-name addon) "-insinuate")))
 199     (put addon 'riece-addon-insinuated t)
 200     (if verbose
 201         (message "Add-on %S is insinuated" addon))))
 202
 203 (defun riece-enable-addon (addon &optional verbose)
 204   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 205     (if (null enabled)
 206         (if verbose
 207             (message "Add-on %S doesn't support enable/disable" addon))
 208       (if (symbol-value enabled)
 209           (if verbose
 210               (message "Add-on %S is already enabled" addon))
 211         (funcall (intern (concat (symbol-name addon) "-enable")))
 212         (if verbose
 213             (message "Add-on %S enabled" addon))))))
 214
 215 (defun riece-disable-addon (addon &optional verbose)
 216   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 217     (if (null enabled)
 218         (if verbose
 219             (message "Add-on %S doesn't support enable/disable" addon))
 220       (if (symbol-value enabled)
 221           (progn
 222             (funcall (intern (concat (symbol-name addon) "-disable")))
 223             (if verbose
 224                 (message "Add-on %S disabled" addon)))
 225         (if verbose
 226             (message "Add-on %S is already enabled" addon))))))
 227
 228 (put 'riece-addon-list-mode 'font-lock-defaults
 229      '(riece-addon-list-font-lock-keywords t))
 230
 231 (defun riece-addon-list-mode ()
 232   "Major mode for displaying addon list.
 233 All normal editing commands are turned off."
 234   (kill-all-local-variables)
 235   (buffer-disable-undo)
 236   (setq major-mode 'riece-addon-list-mode
 237         mode-name "AddOns"
 238         mode-line-buffer-identification
 239         (riece-mode-line-buffer-identification '("Riece: %12b"))
 240         truncate-lines t
 241         buffer-read-only t)
 242   (use-local-map riece-addon-list-mode-map)
 243   (make-local-variable 'font-lock-defaults)
 244   (setq font-lock-defaults '(riece-addon-list-font-lock-keywords t))
 245   ;; In XEmacs, auto-initialization of font-lock is not effective
 246   ;; if buffer-file-name is not set.
 247   (font-lock-set-defaults)
 248   (run-hooks 'riece-addon-list-mode-hook))
 249
 250 (defun riece-command-list-addons ()
 251   (interactive)
 252   (set-buffer (riece-get-buffer-create "*AddOns*" 'riece-addon-list-mode))
 253   (riece-addon-list-mode)
 254   (let ((inhibit-read-only t)
 255         buffer-read-only
 256         (pointer (sort (copy-sequence riece-addons)
 257                        (lambda (symbol1 symbol2)
 258                                   (string-lessp (symbol-name symbol1)
 259                                                 (symbol-name symbol2)))))
 260         enabled description point)
 261     (erase-buffer)
 262     (riece-kill-all-overlays)
 263     (while pointer
 264       (setq enabled (intern-soft (concat (symbol-name (car pointer))
 265                                          "-enabled"))
 266             description (intern-soft (concat (symbol-name (car pointer))
 267                                              "-description")))
 268       (setq point (point))
 269       (insert (format "%c %S: %s\n"
 270                       (if (not (featurep (car pointer)))
 271                           ??
 272                         (if (null enabled)
 273                             ?!
 274                           (if (symbol-value enabled)
 275                               ?+
 276                             ?-)))
 277                       (car pointer)
 278                       (if description
 279                           (symbol-value description)
 280                         "(no description)")))
 281       (put-text-property point (point) 'riece-addon (car pointer))
 282       (setq pointer (cdr pointer)))
 283     (insert "
 284 Symbols in the leftmost column:
 285
 286   +     The add-on is enabled.
 287   -     The add-on is disabled.
 288   !     The add-on doesn't support enable/disable operation.
 289   ?     The add-on status is unknown.
 290 ")
 291     (insert (substitute-command-keys "
 292 Useful keys:
 293
 294   `\\[riece-command-enable-addon]' to enable the current add-on.
 295   `\\[riece-command-disable-addon]' to disable the current add-on.
 296 "))
 297     (goto-char (point-min))
 298     (pop-to-buffer (current-buffer))
 299     (delete-other-windows)))
 300
 301 (defun riece-command-enable-addon (addon)
 302   (interactive
 303    (list
 304     (or (if (eq major-mode 'riece-addon-list-mode)
 305             (get-text-property (point) 'riece-addon))
 306         (intern-soft
 307          (completing-read "Add-on: "
 308                           (mapcar (lambda (addon)
 309                                     (list (symbol-name addon)))
 310                                   riece-addons)
 311                           (lambda (pointer)
 312                             (let ((enabled
 313                                    (intern-soft (concat (car pointer)
 314                                                         "-enabled"))))
 315                               (and enabled
 316                                    (null (symbol-value enabled)))))
 317                           t)))))
 318   (riece-enable-addon addon t)
 319   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 320     (if (and (eq major-mode 'riece-addon-list-mode)
 321              (get-text-property (point) 'riece-addon)
 322              enabled (symbol-value enabled))
 323         (save-excursion
 324           (beginning-of-line)
 325           (let ((point (point))
 326                 (inhibit-read-only t)
 327                 buffer-read-only)
 328             (delete-char 1)
 329             (insert "+")
 330             (put-text-property point (point) 'riece-addon addon))))))
 331
 332 (defun riece-command-disable-addon (addon)
 333   (interactive
 334    (list
 335     (or (if (eq major-mode 'riece-addon-list-mode)
 336             (get-text-property (point) 'riece-addon))
 337         (intern-soft
 338          (completing-read "Add-on: "
 339                           (mapcar (lambda (addon)
 340                                     (list (symbol-name addon)))
 341                                   riece-addons)
 342                           (lambda (pointer)
 343                             (let ((enabled
 344                                    (intern-soft (concat (car pointer)
 345                                                         "-enabled"))))
 346                               (and enabled
 347                                    (symbol-value enabled))))
 348                           t)))))
 349   (riece-disable-addon addon t)
 350   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 351     (if (and (eq major-mode 'riece-addon-list-mode)
 352              (get-text-property (point) 'riece-addon)
 353              enabled (null (symbol-value enabled)))
 354         (save-excursion
 355           (beginning-of-line)
 356           (let ((point (point))
 357                 (inhibit-read-only t)
 358                 buffer-read-only)
 359             (delete-char 1)
 360             (insert "-")
 361             (put-text-property point (point) 'riece-addon addon))))))
 362
 363 (provide 'riece-addon)
 364
 365 ;;; riece-addon.el ends here