1 ;;; riece-addon.el --- add-on management
2 ;; Copyright (C) 1998-2004 Daiki Ueno
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
6 ;; Keywords: IRC, riece
8 ;; This file is part of Riece.
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)
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.
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.
28 (require 'riece-options)
29 (require 'riece-compat)
31 (require 'riece-addon-modules)
33 (defgroup riece-addon-list nil
36 :prefix "riece-addon-list-"
39 (defgroup riece-addon-list-faces nil
40 "Faces for riece-addon-list-mode."
42 :prefix "riece-addon-list-"
43 :group 'riece-addon-list)
45 (defface riece-addon-list-enabled-face
46 '((((class color) (background dark))
47 (:foreground "PaleTurquoise" :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)
54 (defface riece-addon-list-disabled-face
55 '((((class color) (background dark))
56 (:foreground "PaleTurquoise" :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)
63 (defface riece-addon-list-unsupported-face
64 '((((class color) (background dark))
65 (:foreground "PaleTurquoise"))
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)
72 (defface riece-addon-list-uninstalled-face
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)
79 (defface riece-addon-list-unloaded-face
81 (:italic t :inverse-video t)))
82 "Face used for displaying the unloaded addon."
83 :group 'riece-addon-list-faces)
84 (defvar riece-addon-list-unloaded-face 'riece-addon-list-unloaded-face)
86 (defface riece-addon-list-description-face
89 (:foreground "lightyellow"))
92 (:foreground "blue4"))
95 "Face used for displaying the description addon."
96 :group 'riece-addon-list-faces)
97 (defvar riece-addon-list-description-face 'riece-addon-list-description-face)
99 (defcustom riece-addon-list-mark-face-alist
100 '((?+ . riece-addon-list-enabled-face)
101 (?- . riece-addon-list-disabled-face)
102 (?! . riece-addon-list-unsupported-face)
103 (?? . riece-addon-list-uninstalled-face)
104 (? . riece-addon-list-unloaded-face))
105 "An alist mapping marks on riece-addon-list-buffer to faces."
107 :group 'riece-addon-list)
109 (defcustom riece-addon-list-font-lock-keywords
110 '(("^\\([-+!? ] \\S-+\\)\\s-+\\(.*\\)"
111 (1 (cdr (assq (aref (match-string 1) 0)
112 riece-addon-list-mark-face-alist)))
113 (2 riece-addon-list-description-face)))
114 "Default expressions to addon in riece-addon-list-mode."
115 :type '(repeat (list string))
116 :group 'riece-addon-list)
118 (defvar riece-addon-list-mode-map
119 (let ((keymap (make-sparse-keymap)))
120 (define-key keymap "+" 'riece-command-enable-addon)
121 (define-key keymap "-" 'riece-command-disable-addon)
122 (define-key keymap "i" 'riece-command-insinuate-addon)
123 (define-key keymap "u" 'riece-command-uninstall-addon)
124 (define-key keymap "U" 'riece-command-unload-addon)
125 (define-key keymap "n" 'next-line)
126 (define-key keymap "p" 'previous-line)
127 (define-key keymap " " 'scroll-up)
128 (define-key keymap [delete] 'scroll-down)
129 (define-key keymap "q" 'bury-buffer)
132 (defun riece-load-and-build-addon-dependencies (addons)
133 (let ((load-path (cons riece-addon-directory load-path))
136 (require (car addons)) ;error will be reported here
137 (let* ((requires-function
139 (concat (symbol-name (car addons)) "-requires")))
141 (if (and requires-function
142 (fboundp requires-function))
143 (funcall requires-function)))
146 ;; Increment succs' pred count.
147 (if (setq entry (assq (car addons) dependencies))
148 (setcar (cdr entry) (+ (length requires) (nth 1 entry)))
149 (setq dependencies (cons (list (car addons) (length requires))
151 ;; Merge pred's succs.
153 (if (setq entry (assq (car pointer) dependencies))
154 (setcdr (cdr entry) (cons (car addons) (nthcdr 2 entry)))
155 (setq dependencies (cons (list (car pointer) 0 (car addons))
157 (setq pointer (cdr pointer))))
158 (setq addons (cdr addons)))
161 (defun riece-sort-addon-dependencies (dependencies)
162 (let ((pointer dependencies)
165 (if (zerop (nth 1 (car pointer)))
166 (setq dependencies (delq (car pointer) dependencies)
167 queue (cons (car pointer) queue)))
168 (setq pointer (cdr pointer)))
170 (setq addons (cons (cons (car (car queue)) (nthcdr 2 (car queue)))
172 pointer (nthcdr 2 (car queue)))
174 (let* ((entry (assq (car pointer) dependencies))
175 (count (1- (nth 1 entry))))
177 (setq dependencies (delq entry dependencies)
178 queue (nconc queue (list entry)))
179 (setcar (cdr entry) count)))
180 (setq pointer (cdr pointer)))
181 (setq queue (cdr queue)))
183 (error "Circular add-on dependency found: %S" dependencies))
186 (defun riece-resolve-addons (addons)
187 ;; Add files in riece-addon-directory to addons.
188 (if (file-directory-p riece-addon-directory)
193 (unless (file-directory-p
194 (expand-file-name name riece-addon-directory))
195 (intern (file-name-sans-extension name))))
196 (directory-files riece-addon-directory nil "\\`[^.]")))))
198 (setq addons (sort addons (lambda (symbol1 symbol2)
199 (string-lessp (symbol-name symbol1)
200 (symbol-name symbol2)))))
201 (let ((pointer addons))
203 (if (memq (car pointer) (cdr pointer))
204 (setcar pointer nil))
205 (setq pointer (cdr pointer)))
207 ;; Build & resolve dependencies.
208 (riece-sort-addon-dependencies
209 (riece-load-and-build-addon-dependencies addons)))
211 (defun riece-insinuate-addon-1 (addon verbose)
212 (if (get addon 'riece-addon-insinuated)
214 (message "Add-on %S is already insinuated" addon))
216 (funcall (intern (concat (symbol-name addon) "-insinuate")))
217 (put addon 'riece-addon-insinuated t)
219 (message "Add-on %S is insinuated" addon))
220 (unless (get addon 'riece-addon-default-disabled)
221 (riece-enable-addon addon t))))
223 (defun riece-insinuate-addon (addon &optional verbose)
224 (unless (assq addon riece-addon-dependencies)
225 (setq riece-addons (cons addon riece-addons)
226 riece-save-variables-are-dirty t
227 riece-addon-dependencies
228 (riece-resolve-addons
229 (cons addon (mapcar #'car riece-addon-dependencies)))))
230 (let ((pointer riece-addon-dependencies)
233 (unless (get (car (car pointer)) 'riece-addon-insinuated)
234 (setq addons (cons (car (car pointer)) addons)))
235 (if (eq (car (car pointer)) addon)
237 (setq pointer (cdr pointer))))
238 (setq addons (nreverse addons))
239 (if (and (> (length addon) 1)
241 (not (y-or-n-p (format "%s will be insinuated. Continue?"
242 (mapconcat #'symbol-name addons ", ")))))
243 (error "Insinuate operation was cancelled"))
245 (riece-insinuate-addon-1 (car addons) verbose)
246 (setq addons (cdr addons)))))
248 (defun riece-uninstall-addon (addon &optional verbose)
249 (if (not (get addon 'riece-addon-insinuated))
251 (message "Add-on %S is not insinuated" addon))
252 (let ((entry (assq addon riece-addon-dependencies))
253 (uninstall (intern-soft (concat (symbol-name addon) "-uninstall"))))
256 (if (= (length (cdr entry)) 1)
257 (error "%S depends on %S" (car (cdr entry)) addon)
258 (error "%s depend on %S"
259 (mapconcat #'symbol-name (cdr entry) ", ")
261 (riece-disable-addon addon verbose)
265 (setq riece-addon-dependencies
266 (delq entry riece-addon-dependencies))
267 (put addon 'riece-addon-insinuated nil)
268 (setq riece-addons (delq addon riece-addons)
269 riece-save-variables-are-dirty t
270 riece-addon-dependencies
271 (riece-resolve-addons
272 (delq addon (mapcar #'car riece-addon-dependencies))))))
274 (message "Add-on %S is uninstalled" addon)))))
276 (defun riece-enable-addon (addon &optional verbose)
277 (unless (get addon 'riece-addon-insinuated)
278 (error "Add-on %S is not insinuated" addon))
279 (let ((enable (intern-soft (concat (symbol-name addon) "-enable"))))
280 (if (or (null enable)
281 (not (fboundp enable)))
283 (message "Add-on %S doesn't support enable/disable" addon))
284 (if (get addon 'riece-addon-enabled)
286 (message "Add-on %S is already enabled" addon))
288 (put addon 'riece-addon-enabled t)
290 (message "Add-on %S enabled" addon))))))
292 (defun riece-disable-addon (addon &optional verbose)
293 (unless (get addon 'riece-addon-insinuated)
294 (error "Add-on %S is not insinuated" addon))
295 (let ((disable (intern-soft (concat (symbol-name addon) "-disable"))))
296 (if (or (null disable)
297 (not (fboundp disable)))
299 (message "Add-on %S doesn't support enable/disable" addon))
300 (if (get addon 'riece-addon-enabled)
303 (put addon 'riece-addon-enabled nil)
305 (message "Add-on %S disabled" addon)))
307 (message "Add-on %S is already enabled" addon))))))
309 (put 'riece-addon-list-mode 'font-lock-defaults
310 '(riece-addon-list-font-lock-keywords t))
312 (defun riece-addon-list-mode ()
313 "Major mode for displaying addon list.
314 All normal editing commands are turned off."
315 (kill-all-local-variables)
316 (buffer-disable-undo)
317 (setq major-mode 'riece-addon-list-mode
319 mode-line-buffer-identification
320 (riece-mode-line-buffer-identification '("Riece: %12b"))
323 (use-local-map riece-addon-list-mode-map)
324 (make-local-variable 'font-lock-defaults)
325 (setq font-lock-defaults '(riece-addon-list-font-lock-keywords t))
326 ;; In XEmacs, auto-initialization of font-lock is not effective
327 ;; if buffer-file-name is not set.
328 (font-lock-set-defaults)
329 (run-hooks 'riece-addon-list-mode-hook))
331 (defun riece-command-list-addons ()
333 (set-buffer (riece-get-buffer-create "*AddOn*" 'riece-addon-list-mode))
334 (riece-addon-list-mode)
335 (let ((inhibit-read-only t)
337 (pointer riece-addon-dependencies)
338 module-description-alist
339 description enable point)
341 (setq description (intern-soft (concat (symbol-name (car (car pointer)))
343 module-description-alist
344 (cons (cons (car (car pointer))
346 (boundp description))
347 (symbol-value description)
349 module-description-alist)
350 pointer (cdr pointer)))
351 (setq pointer riece-addon-modules)
353 (unless (assq (car (car pointer))
354 module-description-alist)
355 (setq module-description-alist
356 (cons (car pointer) module-description-alist)))
357 (setq pointer (cdr pointer)))
359 (riece-kill-all-overlays)
360 (setq pointer (sort module-description-alist
361 (lambda (entry1 entry2)
362 (string-lessp (symbol-name (car entry1))
363 (symbol-name (car entry2))))))
365 (setq enable (intern-soft (concat (symbol-name (car (car pointer)))
368 (insert (format "%c %-15S %s\n"
369 (if (not (featurep (car (car pointer))))
371 (if (not (get (car (car pointer))
372 'riece-addon-insinuated))
374 (if (or (null enable)
375 (not (fboundp enable)))
377 (if (get (car (car pointer)) 'riece-addon-enabled)
381 (cdr (car pointer))))
382 (put-text-property point (point) 'riece-addon (car (car pointer)))
383 (setq pointer (cdr pointer)))
385 Symbols in the leftmost column:
387 + The add-on is enabled.
388 - The add-on is disabled.
389 ! The add-on doesn't support enable/disable operation.
390 ? The add-on is not insinuated.
391 The add-on is not loaded.
393 (insert (substitute-command-keys "
396 `\\[riece-command-enable-addon]' to enable the current add-on.
397 `\\[riece-command-disable-addon]' to disable the current add-on.
398 `\\[riece-command-insinuate-addon]' to insinuate the add-on.
399 `\\[riece-command-uninstall-addon]' to uninstall the current add-on.
400 `\\[riece-command-unload-addon]' to unload the current add-on.
402 (goto-char (point-min))
403 (pop-to-buffer (current-buffer))
404 (delete-other-windows)))
406 (defun riece-addon-list-set-point (addon)
407 (let ((point (point-min)))
408 (while (and (not (eq (get-text-property point 'riece-addon) addon))
409 (setq point (next-single-property-change point
414 (defun riece-command-enable-addon (addon)
417 (or (if (eq major-mode 'riece-addon-list-mode)
418 (get-text-property (point) 'riece-addon))
420 (completing-read "Add-on: "
421 (mapcar (lambda (dependency)
422 (list (symbol-name (car dependency))))
423 riece-addon-dependencies)
426 (intern-soft (concat (car pointer)
429 (null (symbol-value enabled)))))
431 (riece-enable-addon addon t)
432 (when (eq major-mode 'riece-addon-list-mode)
433 (riece-command-list-addons)
434 (riece-addon-list-set-point addon)))
436 (defun riece-command-disable-addon (addon)
439 (or (if (eq major-mode 'riece-addon-list-mode)
440 (get-text-property (point) 'riece-addon))
442 (completing-read "Add-on: "
443 (mapcar (lambda (dependency)
444 (list (symbol-name (car dependency))))
445 riece-addon-dependencies)
448 (intern-soft (concat (car pointer)
451 (symbol-value enabled))))
453 (riece-disable-addon addon t)
454 (when (eq major-mode 'riece-addon-list-mode)
455 (riece-command-list-addons)
456 (riece-addon-list-set-point addon)))
458 (defun riece-command-insinuate-addon (addon)
461 (or (if (eq major-mode 'riece-addon-list-mode)
462 (get-text-property (point) 'riece-addon))
464 (completing-read "Add-on: "
465 (mapcar (lambda (dependency)
466 (list (symbol-name (car dependency))))
469 (not (get (car pointer) 'riece-addon-insinuated)))
471 (riece-insinuate-addon addon 'ask)
472 (when (eq major-mode 'riece-addon-list-mode)
473 (riece-command-list-addons)
474 (riece-addon-list-set-point addon)))
476 (defun riece-command-uninstall-addon (addon)
479 (or (if (eq major-mode 'riece-addon-list-mode)
480 (get-text-property (point) 'riece-addon))
482 (completing-read "Add-on: "
483 (mapcar (lambda (dependency)
484 (list (symbol-name (car dependency))))
485 riece-addon-dependencies)
487 (get (car pointer) 'riece-addon-insinuated))
489 (riece-uninstall-addon addon t)
490 (when (eq major-mode 'riece-addon-list-mode)
491 (riece-command-list-addons)
492 (riece-addon-list-set-point addon)))
494 (defun riece-command-unload-addon (addon)
497 (or (if (eq major-mode 'riece-addon-list-mode)
498 (get-text-property (point) 'riece-addon))
500 (completing-read "Add-on: "
501 (mapcar (lambda (dependency)
502 (list (symbol-name (car dependency))))
503 riece-addon-dependencies)
505 (get (car pointer) 'riece-addon-insinuated))
507 (riece-uninstall-addon addon t)
508 (if (get addon 'riece-addon-not-unloadable)
509 (message "Add-on %S is not allowed to unload" addon)
510 (unload-feature addon)
511 (message "Add-on %S is unloaded" addon))
512 (when (eq major-mode 'riece-addon-list-mode)
513 (riece-command-list-addons)
514 (riece-addon-list-set-point addon)))
516 (provide 'riece-addon)
518 ;;; riece-addon.el ends here