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