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