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-addon-dependencies (riece-resolve-addons
 202                                     (cons addon
 203                                           (mapcar #'car
 204                                                   riece-addon-dependencies)))))
 205   (if (get addon 'riece-addon-insinuated)
 206       (if verbose
 207           (message "Add-on %S is already insinuated" addon))
 208     (funcall (intern (concat (symbol-name addon) "-insinuate")))
 209     (put addon 'riece-addon-insinuated t)
 210     (if verbose
 211         (message "Add-on %S is insinuated" addon))))
 212
 213 (defun riece-uninstall-addon (addon &optional verbose)
 214   (if (not (get addon 'riece-addon-insinuated))
 215       (if verbose
 216           (message "Add-on %S is not insinuated" addon))
 217     (let ((entry (assq addon riece-addon-dependencies))
 218           (enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 219       (if entry
 220           (if (cdr entry)
 221               (if (= (length (cdr entry)) 1)
 222                   (error "%S depends %S" (car (cdr entry)) addon)
 223                 (error "%s depends %S" (mapconcat #'identity (cdr entry) ",")
 224                        addon))
 225             (if (and enabled
 226                      (symbol-value enabled))
 227                 (riece-disable-addon addon verbose))
 228             (funcall (or (intern-soft (concat (symbol-name addon)
 229                                               "-uninstall"))
 230                          #'ignore))
 231             (setq riece-addon-dependencies
 232                   (delq entry riece-addon-dependencies))
 233             (put addon 'riece-addon-insinuated nil)))
 234       (if verbose
 235           (message "Add-on %S is uninstalled" addon)))))
 236
 237 (defun riece-enable-addon (addon &optional verbose)
 238   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 239     (if (null enabled)
 240         (if verbose
 241             (message "Add-on %S doesn't support enable/disable" addon))
 242       (if (symbol-value enabled)
 243           (if verbose
 244               (message "Add-on %S is already enabled" addon))
 245         (funcall (intern (concat (symbol-name addon) "-enable")))
 246         (if verbose
 247             (message "Add-on %S enabled" addon))))))
 248
 249 (defun riece-disable-addon (addon &optional verbose)
 250   (let ((enabled (intern-soft (concat (symbol-name addon) "-enabled"))))
 251     (if (null enabled)
 252         (if verbose
 253             (message "Add-on %S doesn't support enable/disable" addon))
 254       (if (symbol-value enabled)
 255           (progn
 256             (funcall (intern (concat (symbol-name addon) "-disable")))
 257             (if verbose
 258                 (message "Add-on %S disabled" addon)))
 259         (if verbose
 260             (message "Add-on %S is already enabled" addon))))))
 261
 262 (put 'riece-addon-list-mode 'font-lock-defaults
 263      '(riece-addon-list-font-lock-keywords t))
 264
 265 (defun riece-addon-list-mode ()
 266   "Major mode for displaying addon list.
 267 All normal editing commands are turned off."
 268   (kill-all-local-variables)
 269   (buffer-disable-undo)
 270   (setq major-mode 'riece-addon-list-mode
 271         mode-name "AddOns"
 272         mode-line-buffer-identification
 273         (riece-mode-line-buffer-identification '("Riece: %12b"))
 274         truncate-lines t
 275         buffer-read-only t)
 276   (use-local-map riece-addon-list-mode-map)
 277   (make-local-variable 'font-lock-defaults)
 278   (setq font-lock-defaults '(riece-addon-list-font-lock-keywords t))
 279   ;; In XEmacs, auto-initialization of font-lock is not effective
 280   ;; if buffer-file-name is not set.
 281   (font-lock-set-defaults)
 282   (run-hooks 'riece-addon-list-mode-hook))
 283
 284 (defun riece-command-list-addons ()
 285   (interactive)
 286   (set-buffer (riece-get-buffer-create "*AddOns*" 'riece-addon-list-mode))
 287   (riece-addon-list-mode)
 288   (let ((inhibit-read-only t)
 289         buffer-read-only
 290         (pointer riece-addon-dependencies)
 291         module-description-alist
 292         description enabled point)
 293     (while pointer
 294
 295       (setq description (intern-soft (concat (symbol-name (car (car pointer)))
 296                                              "-description"))
 297             module-description-alist
 298             (cons (cons (car (car pointer))
 299                         (if description
 300                             (symbol-value description)
 301                           "(no description)"))
 302                   module-description-alist)
 303             pointer (cdr pointer)))
 304     (setq pointer riece-addon-modules)
 305     (while pointer
 306       (unless (assq (car (car pointer))
 307                     module-description-alist)
 308         (setq module-description-alist
 309               (cons (car pointer) module-description-alist)))
 310       (setq pointer (cdr pointer)))
 311     (erase-buffer)
 312     (riece-kill-all-overlays)
 313     (setq pointer (sort module-description-alist
 314                         (lambda (entry1 entry2)
 315                           (string-lessp (symbol-name (car entry1))
 316                                         (symbol-name (car entry2))))))
 317     (while pointer
 318       (setq enabled (intern-soft (concat (symbol-name (car (car pointer)))
 319                                          "-enabled")))
 320       (setq point (point))
 321       (insert (format "%c %S: %s\n"
 322                       (if (not (get (car (car pointer))
 323                                     'riece-addon-insinuated))
 324                           ?
 325                         (if (null enabled)
 326                             ?!
 327                           (if (symbol-value enabled)
 328                               ?+
 329                             ?-)))
 330                       (car (car pointer))
 331                       (cdr (car pointer))))
 332       (put-text-property point (point) 'riece-addon (car (car pointer)))
 333       (setq pointer (cdr pointer)))
 334     (insert "
 335 Symbols in the leftmost column:
 336
 337   +     The add-on is enabled.
 338   -     The add-on is disabled.
 339   !     The add-on doesn't support enable/disable operation.
 340         The add-on is not insinuated.
 341 ")
 342     (insert (substitute-command-keys "
 343 Useful keys:
 344
 345   `\\[riece-command-enable-addon]' to enable the current add-on.
 346   `\\[riece-command-disable-addon]' to disable the current add-on.
 347 "))
 348     (goto-char (point-min))
 349     (pop-to-buffer (current-buffer))
 350     (delete-other-windows)))
 351
 352 (defun riece-command-enable-addon (addon)
 353   (interactive
 354    (list
 355     (or (if (eq major-mode 'riece-addon-list-mode)
 356             (get-text-property (point) 'riece-addon))
 357         (intern-soft
 358          (completing-read "Add-on: "
 359                           (mapcar (lambda (dependency)
 360                                     (list (symbol-name (car dependency))))
 361                                   riece-addon-dependencies)
 362                           (lambda (pointer)
 363                             (let ((enabled
 364                                    (intern-soft (concat (car pointer)
 365                                                         "-enabled"))))
 366                               (and enabled
 367                                    (null (symbol-value enabled)))))
 368                           t)))))
 369   (riece-enable-addon addon t)
 370   (when (eq major-mode 'riece-addon-list-mode)
 371     (riece-command-list-addons)
 372     (let ((point (point-min)))
 373       (while (and (not (eq (get-text-property point 'riece-addon) addon))
 374                   (setq point (next-single-property-change point
 375                                                            'riece-addon))))
 376       (if point
 377           (goto-char point)))))
 378
 379 (defun riece-command-disable-addon (addon)
 380   (interactive
 381    (list
 382     (or (if (eq major-mode 'riece-addon-list-mode)
 383             (get-text-property (point) 'riece-addon))
 384         (intern-soft
 385          (completing-read "Add-on: "
 386                           (mapcar (lambda (dependency)
 387                                     (list (symbol-name (car dependency))))
 388                                   riece-addon-dependencies)
 389                           (lambda (pointer)
 390                             (let ((enabled
 391                                    (intern-soft (concat (car pointer)
 392                                                         "-enabled"))))
 393                               (and enabled
 394                                    (symbol-value enabled))))
 395                           t)))))
 396   (riece-disable-addon addon t)
 397   (when (eq major-mode 'riece-addon-list-mode)
 398     (riece-command-list-addons)
 399     (let ((point (point-min)))
 400       (while (and (not (eq (get-text-property point 'riece-addon) addon))
 401                   (setq point (next-single-property-change point
 402                                                            'riece-addon))))
 403       (if point
 404           (goto-char point)))))
 405
 406 (defun riece-command-insinuate-addon (addon)
 407   (interactive
 408    (list
 409     (or (if (eq major-mode 'riece-addon-list-mode)
 410             (get-text-property (point) 'riece-addon))
 411         (intern-soft
 412          (completing-read "Add-on: "
 413                           (mapcar (lambda (dependency)
 414                                     (list (symbol-name (car dependency))))
 415                                   riece-addon-modules)
 416                           (lambda (pointer)
 417                             (get (car pointer) 'riece-addon-insinuated))
 418                           t)))))
 419   (riece-insinuate-addon addon t)
 420   (when (eq major-mode 'riece-addon-list-mode)
 421     (riece-command-list-addons)
 422     (let ((point (point-min)))
 423       (while (and (not (eq (get-text-property point 'riece-addon) addon))
 424                   (setq point (next-single-property-change point
 425                                                            'riece-addon))))
 426       (if point
 427           (goto-char point)))))
 428
 429 (defun riece-command-uninstall-addon (addon)
 430   (interactive
 431    (list
 432     (or (if (eq major-mode 'riece-addon-list-mode)
 433             (get-text-property (point) 'riece-addon))
 434         (intern-soft
 435          (completing-read "Add-on: "
 436                           (mapcar (lambda (dependency)
 437                                     (list (symbol-name (car dependency))))
 438                                   riece-addon-dependencies)
 439                           nil t)))))
 440   (riece-uninstall-addon addon t)
 441   (when (eq major-mode 'riece-addon-list-mode)
 442     (riece-command-list-addons)
 443     (let ((point (point-min)))
 444       (while (and (not (eq (get-text-property point 'riece-addon) addon))
 445                   (setq point (next-single-property-change point
 446                                                            'riece-addon))))
 447       (if point
 448           (goto-char point)))))
 449
 450 (provide 'riece-addon)
 451
 452 ;;; riece-addon.el ends here